AS2Secure
[ class tree: AS2Secure ] [ index: AS2Secure ] [ all elements ]

Class: AS2Abstract

Source Location: /AS2Abstract.php

Class Overview


AS2Secure - PHP Lib for AS2 message encoding / decoding


Author(s):

Version:

  • 0.9.0

Copyright:

  • Copyright (c) 2010, Sebastien MALOT

    Last release at : http://www.as2secure.com

    This file is part of AS2Secure Project.

    AS2Secure is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

    AS2Secure is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along with AS2Secure.

Variables

Methods


Child classes:

AS2Message
AS2Secure - PHP Lib for AS2 message encoding / decoding
AS2MDN
AS2Secure - PHP Lib for AS2 message encoding / decoding
AS2Request
AS2Secure - PHP Lib for AS2 message encoding / decoding

Class Details

[line 32]
AS2Secure - PHP Lib for AS2 message encoding / decoding



Tags:

author:  Sebastien MALOT <contact@as2secure.com>
version:  0.9.0
copyright:  

Copyright (c) 2010, Sebastien MALOT

Last release at : http://www.as2secure.com

This file is part of AS2Secure Project.

AS2Secure is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

AS2Secure is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with AS2Secure.

abstract:  
license:  GNU General Public License


[ Top ]


Class Variables

$adapter =  null

[line 34]



Tags:

access:  protected

Type:   mixed


[ Top ]

$filename =  null

[line 36]



Tags:

access:  protected

Type:   mixed


[ Top ]

$files = array()

[line 39]



Tags:

access:  protected

Type:   mixed


[ Top ]

$headers =  null

[line 40]



Tags:

access:  protected

Type:   mixed


[ Top ]

$is_crypted =  false

[line 44]



Tags:

access:  protected

Type:   mixed


[ Top ]

$is_signed =  false

[line 43]



Tags:

access:  protected

Type:   mixed


[ Top ]

$message_id =  ''

[line 41]



Tags:

access:  protected

Type:   mixed


[ Top ]

$mimetype =  null

[line 37]



Tags:

access:  protected

Type:   mixed


[ Top ]

$partner_from =  null

[line 46]



Tags:

access:  protected

Type:   mixed


[ Top ]

$partner_to =  null

[line 47]



Tags:

access:  protected

Type:   mixed


[ Top ]

$path =  null

[line 38]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


static method generateMessageID [line 175]

static void generateMessageID( $partner)



Tags:

access:  protected


Parameters:

   $partner  

[ Top ]

constructor __construct [line 49]

AS2Abstract __construct( $data, [ $params = array()])



Tags:

access:  public


Overridden in child classes as:

AS2Message::__construct()
AS2MDN::__construct()
AS2Request::__construct()

Parameters:

   $data  
   $params  

[ Top ]

method addFile [line 109]

void addFile( $file)



Tags:

access:  public


Overridden in child classes as:

AS2Message::addFile()
Add file to the message

Parameters:

   $file  

[ Top ]

method decode [line 163]

void decode( )



Tags:

access:  public


Overridden in child classes as:

AS2Message::decode()
Decode message extracting files from message
AS2MDN::decode()
Decode MDN stored into path file and set attributes
AS2Request::decode()

[ Top ]

method encode [line 159]

void encode( )



Tags:

access:  public


Overridden in child classes as:

AS2Message::encode()
Build message and encode it (signing and/or crypting)
AS2MDN::encode()
Encode and generate MDN from attributes and message (if exists)
AS2Request::encode()

[ Top ]

method getAuthentication [line 137]

void getAuthentication( )



Tags:

access:  public


Overridden in child classes as:

AS2Message::getAuthentication()
Return the authentication to use to send message to the partner

[ Top ]

method getContent [line 121]

void getContent( )



Tags:

access:  public


[ Top ]

method getFileName [line 117]

void getFileName( )



Tags:

access:  public


[ Top ]

method getFiles [line 113]

void getFiles( )



Tags:

access:  public


Overridden in child classes as:

AS2Message::getFiles()
Return files which compose the message (should contain at least one file)

[ Top ]

method getHeader [line 133]

void getHeader( $token)



Tags:

access:  public


Parameters:

   $token  

[ Top ]

method getHeaders [line 129]

void getHeaders( )



Tags:

access:  public


[ Top ]

method getMessageId [line 147]

void getMessageId( )



Tags:

access:  public


[ Top ]

method getPartnerFrom [line 92]

void getPartnerFrom( )



Tags:

access:  public


[ Top ]

method getPartnerTo [line 100]

void getPartnerTo( )



Tags:

access:  public


[ Top ]

method getPath [line 105]

void getPath( )



Tags:

access:  public


[ Top ]

method getUrl [line 167]

void getUrl( )



Tags:

access:  public


Overridden in child classes as:

AS2Message::getUrl()
Return the url to send message
AS2MDN::getUrl()
Return the url to send message

[ Top ]

method isCrypted [line 151]

void isCrypted( )



Tags:

access:  public


[ Top ]

method isSigned [line 155]

void isSigned( )



Tags:

access:  public


[ Top ]

method setHeaders [line 125]

void setHeaders( $headers)



Tags:

access:  public


Parameters:

   $headers  

[ Top ]

method setMessageId [line 143]

void setMessageId( $id)



Tags:

access:  public


Parameters:

   $id  

[ Top ]

method setPartnerFrom [line 88]

void setPartnerFrom( $partner_from)



Tags:

access:  public


Parameters:

   $partner_from  

[ Top ]

method setPartnerTo [line 96]

void setPartnerTo( $partner_to)



Tags:

access:  public


Parameters:

   $partner_to  

[ Top ]


Documentation generated on Wed, 03 Nov 2010 22:51:30 +0100 by phpDocumentor 1.4.3