Base | --SendResponse
Located in File: Program_Root/sdk/protocol/send/SendResponse.php
This class represents a Response on a sent SMS message received from the gateway.
Magnus Rosenquist, Zyneo
Class Variable Summary |
$STATUS_FAIL
Constant for defining this Response as failed. Default Value:
|
$STATUS_SUCCESS
Constant for defining this Response as successful Default Value:
|
$__currentTag
Current tag when processing the XML Default Value:
|
$__errorCode
Error code for the Response Default Value:
|
$__errorMsg
Error message for the Response Default Value:
|
$__messageId
Message id for this Response Default Value:
|
$__raw
Raw data representing the Response (XML) Default Value:
|
$__status
Status of the Response Default Value:
|
$__type
Type of Response Default Value:
|
Inherited Class Variable Summary | |||||||||||||||||||||
Inherited From Class Base
|
Method Summary |
void constructor SendResponse ( [$xml = ""] )
Creates a new SendResponse, if param $xml is provided the response is parsed. If $xml is omitted, an empty SendResponse is created. |
void characterData ( $parser, $data )
|
void endElement ( $parser, $name )
|
int getErrorCode ( )
Returns the error-code for the message if unsuccessful send. |
string getErrorMessage ( )
Returns the error-message for the message if unsuccessful send. |
string getMessageId ( )
Returns the message-id for the message if successful send. |
string getResponseType ( )
Returns the response-type for the sent message |
string getStatus ( )
Returns the status of the response which is one of STATUS_SUCCESS or STATUS_FAIL. |
void parse ( )
Parses the response from the gateway. |
void parseAttributes ( $attrs )
Parses the attributes for the current tag |
void setErrorCode ( $code )
Sets the error-code for the message in case of failure. |
void setErrorMessage ( $msg )
Sets the error-message for the message in case of failure. |
void setMessageId ( $id )
Sets the message-id for the message |
void setResponseType ( $type )
Sets the response type for the message |
void setStatus ( $status )
Sets the status of the response |
void startElement ( $parser, $name, $attrs )
|
string toXML ( )
Serializes the response into an XML string. |
Inherited Method Summary |
Inherited From Class Base
|
Method Detail |
void SendResponse( [string $xml = ""])
Creates a new SendResponse, if param $xml is provided the response is parsed. If $xml is omitted, an empty SendResponse is created.- string $xml: optional response from gateway.
[ Top ]
void characterData( mixed $parser, mixed $data)
[ Top ]
void endElement( mixed $parser, mixed $name)
[ Top ]
int getErrorCode( )
Returns the error-code for the message if unsuccessful send.[ Top ]
string getErrorMessage( )
Returns the error-message for the message if unsuccessful send.[ Top ]
string getMessageId( )
Returns the message-id for the message if successful send.[ Top ]
string getResponseType( )
Returns the response-type for the sent message[ Top ]
string getStatus( )
Returns the status of the response which is one of STATUS_SUCCESS or STATUS_FAIL.status
[ Top ]
void parse( )
Parses the response from the gateway.[ Top ]
void parseAttributes( mixed $attrs)
Parses the attributes for the current tag[ Top ]
void setErrorCode( int $code)
Sets the error-code for the message in case of failure.- int $code: code
[ Top ]
void setErrorMessage( string $msg)
Sets the error-message for the message in case of failure.- string $msg:
[ Top ]
void setMessageId( string $id)
Sets the message-id for the message- string $id:
[ Top ]
void setResponseType( string $type)
Sets the response type for the message- string $type:
[ Top ]
void setStatus( string $status)
Sets the status of the response- string $status:
[ Top ]
void startElement( mixed $parser, mixed $name, mixed $attrs)
[ Top ]
string toXML( )
Serializes the response into an XML string.[ Top ]
Variable Detail |
[ Top ]
[ Top ]
[ Top ]
[ Top ]
[ Top ]
[ Top ]
[ Top ]
[ Top ]
[ Top ]