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

Class: AS2Message

Source Location: /AS2Message.php

Class Overview

AS2Abstract
   |
   --AS2Message

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


Inherited Variables

Inherited Methods


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.

license:  GNU General Public License


[ Top ]


Class Variables

$mic_checksum =  false

[line 34]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 36]

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



Tags:

access:  public


Overrides AS2Abstract::__construct() (parent method not documented)

Parameters:

   $data  
   $params  

[ Top ]

method addFile [line 68]

boolean addFile( string $data, [string $mimetype = ''], [ $filename = ''], [boolean $is_file = true], [string $encoding = 'base64'])

Add file to the message



Tags:

access:  public


Overrides AS2Abstract::addFile() (parent method not documented)

Parameters:

string   $data   The content or the file
string   $mimetype   The mimetype of the message
boolean   $is_file   If file
string   $encoding   The encoding to use for transfert
   $filename  

[ Top ]

method decode [line 248]

array decode( )

Decode message extracting files from message



Tags:

return:  List of files extracted
access:  public


Overrides AS2Abstract::decode() (parent method not documented)

[ Top ]

method encode [line 130]

void encode( )

Build message and encode it (signing and/or crypting)



Tags:

access:  public


Overrides AS2Abstract::encode() (parent method not documented)

[ Top ]

method generateMDN [line 261]

object The generateMDN( [object $exception = null])

Generate a MDN from the message



Tags:

return:  MDN generated
access:  public


Parameters:

object   $exception   The exception if error handled

[ Top ]

method getAuthentication [line 120]

array getAuthentication( )

Return the authentication to use to send message to the partner



Tags:

access:  public


Overrides AS2Abstract::getAuthentication() (parent method not documented)

[ Top ]

method getFiles [line 93]

array getFiles( )

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



Tags:

access:  public


Overrides AS2Abstract::getFiles() (parent method not documented)

[ Top ]

method getMicChecksum [line 102]

string getMicChecksum( )

Return the last calculated checksum



Tags:

access:  public


[ Top ]

method getUrl [line 111]

string getUrl( )

Return the url to send message



Tags:

access:  public


Overrides AS2Abstract::getUrl() (parent method not documented)

[ Top ]


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