Class Request

(line 21)
Base
   |
   --Request

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


$Id: Request.php,v 1.1.1.1 2003/03/27 10:27:42 maro Exp $

This class represents a 'request' sent from the gateway. A request can either be an incoming SMS or an incoming notification for an SMS.


Class Variable Summary
$TYPE_NOT
Constant for defining this request as a Notification
Default Value: -> "notification"<-
$TYPE_SMS
Constant for defining this request as an SMS
Default Value: -> "sms"<-
$__currentTag
Current tag processing when parsing XML
Default Value: -><-
$__raw
Raw response data (XML)
Default Value: -><-
$__request
The request object
Default Value: -><-
$__type
Request type
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 Request ( $input )
Creates a new Request object with the desired content ($input) and parses the XML.
void attrNot ( $attrs )
Manages attributes concerning Notifications
void attrSMS ( $attrs )
Manages attributes concerning SMS
void characterData ( $parser, $data )
Parses character data
void charNotification ( $data )
Parses character data for a Notification, for now it is empty.
void charSMS ( $data )
Parses character data for an SMS
void endElement ( $parser, $name )
string getRawData ( )
Returns the request in it's raw XML-form
mixed getRequest ( )
Returns the request as the object contained in the request, which can be an Sms or a Notification. To find out which use 'getRequestType'.
string getRequestType ( )
Returns the type for this request, one of 'sms' and 'notification'
void parse ( )
Parses the incoming XML-request.
void parseAttributes ( $attrs )
Parses attributes for a tag.
void startElement ( $parser, $name, $attrs )
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 Request

(line 44)

void Request( string $input)

Creates a new Request object with the desired content ($input) and parses the XML.
Function Parameters:
- string $input: xml string containing the request.
Function Info:

[ Top ]


attrNot

(line 191)

void attrNot( mixed $attrs)

Manages attributes concerning Notifications
Function Info:

[ Top ]


attrSMS

(line 170)

void attrSMS( mixed $attrs)

Manages attributes concerning SMS
Function Info:

[ Top ]


characterData

(line 124)

void characterData( mixed $parser, mixed $data)

Parses character data
Function Info:

[ Top ]


charNotification

(line 151)

void charNotification( mixed $data)

Parses character data for a Notification, for now it is empty.
Function Info:

[ Top ]


charSMS

(line 135)

void charSMS( mixed $data)

Parses character data for an SMS
Function Info:

[ Top ]


endElement

(line 116)

void endElement( mixed $parser, mixed $name)


Function Info:

[ Top ]


getRawData

(line 55)

string getRawData( )

Returns the request in it's raw XML-form
Function Info:
return - xml request

[ Top ]


getRequest

(line 63)

mixed getRequest( )

Returns the request as the object contained in the request, which can be an Sms or a Notification. To find out which use 'getRequestType'.
Function Info:
return - either an Sms object or a Notification
see - Notification
see - Sms

[ Top ]


getRequestType

(line 68)

string getRequestType( )

Returns the type for this request, one of 'sms' and 'notification'
Function Info:
return - the request type.

[ Top ]


parse

(line 73)

void parse( )

Parses the incoming XML-request.
Function Info:

[ Top ]


parseAttributes

(line 159)

void parseAttributes( mixed $attrs)

Parses attributes for a tag.
Function Info:

[ Top ]


startElement

(line 98)

void startElement( mixed $parser, mixed $name, mixed $attrs)


Function Info:

[ Top ]



Variable Detail

$TYPE_NOT

(line 28)
Data type: mixed
Constant for defining this request as a Notification

[ Top ]

$TYPE_SMS

(line 25)
Data type: mixed
Constant for defining this request as an SMS

[ Top ]

$__currentTag

(line 37)
Data type: mixed
Current tag processing when parsing XML

[ Top ]

$__raw

(line 33)
Data type: mixed
Raw response data (XML)

[ Top ]

$__request

(line 35)
Data type: mixed
The request object

[ Top ]

$__type

(line 31)
Data type: mixed
Request type

[ Top ]



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