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

Class: AS2MDN

Source Location: /AS2MDN.php

Class Overview

AS2Abstract
   |
   --AS2MDN

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

Constants

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

$attributes =  null

[line 51]

Valid tokens :

action-mode : "manual-action" | "automatic-action" sending-mode : "MDN-sent-manually" | "MDN-sent-automatically" disposition-type : "processed" | "failed" disposition-modifier : ( "error" | "warning" ) | disposition-modifier-extension disposition-modifier-extension : (cf : AS2Exception values) encoded-message-digest : (base64 format + digest-alg-id = "sha1" | "md5") reporting-ua : user-agent




Tags:

access:  protected

Type:   mixed


[ Top ]

$message =  ''

[line 36]

Human readable message



Tags:

access:  protected

Type:   mixed


[ Top ]

$url =  ''

[line 38]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 70]

AS2MDN __construct( [ $data = null], [ $params = array()])



Tags:

access:  public


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

Parameters:

   $data  
   $params  

[ Top ]

method decode [line 272]

void decode( )

Decode MDN stored into path file and set attributes



Tags:

access:  public


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

[ Top ]

method encode [line 185]

void encode( [object $message = null])

Encode and generate MDN from attributes and message (if exists)



Tags:

access:  public


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

Parameters:

object   $message   The refering message

[ Top ]

method getAttribute [line 167]

string getAttribute( string $key)

Return an attribute fromcomputer readable message



Tags:

access:  public


Parameters:

string   $key   Token

[ Top ]

method getAttributes [line 176]

array getAttributes( )

Return the computer readable message



Tags:

access:  public


[ Top ]

method getMessage [line 146]

string getMessage( )

Return the human readable message



Tags:

access:  public


[ Top ]

method getUrl [line 311]

string getUrl( )

Return the url to send message



Tags:

access:  public


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

[ Top ]

method setAttribute [line 156]

void setAttribute( string $key, string $value)

Set attribute for computer readable message



Tags:

access:  public


Parameters:

string   $key   Token
string   $value   Value

[ Top ]

method setMessage [line 137]

void setMessage( string $message)

Set the human readable message



Tags:

access:  public


Parameters:

string   $message   The message to set

[ Top ]

method __toString [line 128]

string __toString( )

Return the human readable message



Tags:

access:  public


[ Top ]


Class Constants

ACTION_AUTO =  'automatic-action'

[line 57]

Refers to RFC 4130

http://rfclibrary.hosting.com/rfc/rfc4130/rfc4130-34.asp



[ Top ]

ACTION_MANUAL =  'manual-action'

[line 58]


[ Top ]

MODIFIER_ERROR =  'error'

[line 66]


[ Top ]

MODIFIER_WARNING =  'warning'

[line 67]


[ Top ]

SENDING_AUTO =  'MDN-sent-automatically'

[line 60]


[ Top ]

SENDING_MANUAL =  'MDN-sent-manually'

[line 61]


[ Top ]

TYPE_FAILED =  'failed'

[line 64]


[ Top ]

TYPE_PROCESSED =  'processed'

[line 63]


[ Top ]



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