Class Response

(line 17)
Base
   |
   --Response

Located in File: Program_Root/sdk/protocol/receive/Response.php


$Id: Response.php,v 1.1.1.1 2003/03/27 10:27:43 maro Exp $

This class represents a response to a received SMS or Notification.


Class Variable Summary
$STATUS_FAIL
Constant for defining this response as failed
Default Value: -> "fail"<-
$STATUS_SUCCESS
Constant for defining this response as successful
Default Value: -> "success"<-
$__errorCode
Error code for this response
Default Value: -><-
$__errorMessage
Error message for this response
Default Value: -><-
$__status
Current status of this response
Default Value: -><-

Inherited Class Variable Summary
Inherited From Class Base
Variable Default Value Description
Base::$clazz -> <-
Base::$logFile -> _DEBUG_FILE <-
Base::$loglevel -> _DEBUG_LEVEL <- debug - logstatements above and including 'debug' are printed.
Base::$loglevels ->array ("debug" => 0, "info" => 1, "warn" => 2, "fatal" => 3) <-
Base::$logoutput -> _DEBUG_OUTPUT <- 0 - log to screen
Base::$method -> <-

Method Summary
void constructor Response ( )
Creates a new Response, status defaulting to STATUS_SUCCCESS.
void setErrorCode ( $code )
When status = STATUS_FAIL, set an error-code.
void setErrorMessage ( $msg )
When status = STATUS_FAIL, set an error-message
void setStatus ( $status )
Sets status for this response, use STATUS_SUCCESS or STATUS_FAIL to set valid status.
string toXML ( )
Serializes this Response into an XML string.
Inherited Method Summary
Inherited From Class Base
Function Description
Base::Base()
Base::dbg()
Base::formatLongDate()
Base::formatLongDateTime()
Base::formatShortDate()
Base::formatShortDateTime()
Base::logDebug()
Base::logFatal()
Base::logInfo()
Base::logWarn()
Base::registerClass()
Base::registerMethod()
Base::setLoglevel()
Base::toFile()
Base::toScreen()

Method Detail

Constructor Response

(line 37)

void Response( )

Creates a new Response, status defaulting to STATUS_SUCCCESS.
Function Info:

[ Top ]


setErrorCode

(line 57)

void setErrorCode( string $code)

When status = STATUS_FAIL, set an error-code.
Function Parameters:
- string $code:
Function Info:

[ Top ]


setErrorMessage

(line 66)

void setErrorMessage( string $msg)

When status = STATUS_FAIL, set an error-message
Function Parameters:
- string $msg:
Function Info:

[ Top ]


setStatus

(line 48)

void setStatus( string $status)

Sets status for this response, use STATUS_SUCCESS or STATUS_FAIL to set valid status.
Function Parameters:
- string $status:
Function Info:

[ Top ]


toXML

(line 75)

string toXML( )

Serializes this Response into an XML string.
Function Info:

[ Top ]



Variable Detail

$STATUS_FAIL

(line 25)
Data type: mixed
Constant for defining this response as failed

[ Top ]

$STATUS_SUCCESS

(line 22)
Data type: mixed
Constant for defining this response as successful

[ Top ]

$__errorCode

(line 30)
Data type: mixed
Error code for this response

[ Top ]

$__errorMessage

(line 32)
Data type: mixed
Error message for this response

[ Top ]

$__status

(line 28)
Data type: mixed
Current status of this response

[ Top ]



Documention generated on Mon, 31 Mar 2003 10:17:45 +0200 by phpDocumentor 1.2.0rc1