Class Request

Shared request object used for request abstraction.

Namespace: tschiemer\Aspsms
Package: aspsms
Copyright: 2013 Philip Tschiemer, <tschiemer@filou.se>
License: v3 http://www.gnu.org/licenses/lgpl-3.0.txt
Version: 1.1.0
Link: https://github.com/tschiemer/aspsms-php
Located at lib/tschiemer/Aspsms/Request.php

Methods summary
`public`	# `__construct( mixed $data = array() )`
`public`	# `setRequestName( mixed $name )`
`public string`	# `getRequestName( )` Getter Getter Returns `string`
`public`	# `set( mixed $key, mixed $value )`
`public`	# `get( mixed $key )`
`public`	# `getFieldsAsArray( )`
`public`	# `getFieldsAsObject( )`
`public`	# `extractArray( mixed $fieldList = array() )`
`public`	# `extractObject( mixed $fieldList = array() )`
`public`	# `setStatusCode( mixed $statusCode )`
`public`	# `setTransactionReferenceNumbers( mixed $trackingnr )`
`public`	# `setRecipients( string\|array $recipients )` Set recipients of message. Set recipients of message. String Format: ("<RECIPIENT_NR>" + {":<TRACKING_NR>"} ";" .. )+ Eg: 00417777777 00417777777;00417777777;004177777777 00417777777:84612004;00417777777:74183874783 Array Format: <TRACKING_NR> => <RECIPIENT_NR> Parameters `$recipients` `string\|array` $recipients
`public`	# `setDeferredDeliveryTime( integer\|string\|DateTime $datetime )` Sets intended delivery time. Sets intended delivery time. Formats: string ddmmyyyyhhmmss int unit timestamp DateTime Parameters `$datetime` `integer\|string\|DateTime` $datetime See \Aspsms\Request::setTimeZone()
`public`	# `setFlashingSMS( boolean $flash )` Parameters `$flash` `boolean` $flash
`public`	# `setTimeZone( integer\|string\|DateTimeZone $timezone )` Sets timezone to use when sending a deferred sms Offset to GMT Sets timezone to use when sending a deferred sms Offset to GMT Parameters `$timezone` `integer\|string\|DateTimeZone` $timezone See `tschiemer\Aspsms\Request::setDeferredDeliveryTime()`
`public`	# `setURLDeliveryNotification( string $url )` Two modes: 1. simple: SMS.URLNonDeliveryNotification = "http://www.mysite.com/sms/notdelivered.asp?ID=" When the TransactionReferenceNumber is e.g. 3152, the URL will be loaded like this: http://www.mysite.com/sms/notdelivered.asp?ID=3152 Two modes: 1. simple: SMS.URLNonDeliveryNotification = "http://www.mysite.com/sms/notdelivered.asp?ID=" When the TransactionReferenceNumber is e.g. 3152, the URL will be loaded like this: http://www.mysite.com/sms/notdelivered.asp?ID=3152 2. detailed: http://www.yourhost.com/Delivered.asp?SCTS=<SCTS>&DSCTS=<DSCTS>&RSN=<RSN>&DST=<DST>&TRN=<TRN> <RCPNT> (Recipient, Mobilenumber) <SCTS> (Servicecenter Timestamp, Submissiondate) <DSCTS> (Delivery Servicecenter Timestamp, Notificationdate) <RSN> (Reasoncode) <DST> (Deliverystatus) <TRN> (Transactionreferencenummer) Parameters `$url` `string` $url
`public`	# `setURLNonDeliveryNotification( string $url )` Parameters `$url` `string` $url See `tschiemer\Aspsms\Request::setURLDeliveryNotification()`
`public`	# `setURLBufferedMessageNotification( string $url )` Parameters `$url` `string` $url See `tschiemer\Aspsms\Request::setURLDeliveryNotification()`
`public`	# `setMessageData( string $data )` Official doc: Official doc: If MessageData is set, the placeholder <VERIFICATIONCODE> will be substituted with the verification code. If MessageData is not defined, or if MessageData does not contain the placeholder <VERIFICATIONCODE>, only the verification code is sent. Parameters `$data` `string` $data
`public`	# `setTokenReference( string $ref )` Official doc: Official doc: Explicitly specifies the verification code to be sent to the user. Parameters `$ref` `string` $ref
`public`	# `setTokenValidity( integer $minutes = 5 )` Official doc: Official doc: Specifies the validity period of a Token in minutes. If not specified, the TokenValidity is 5 minutes by default. Parameters `$minutes` `integer` $minutes
`public`	# `setTokenMask( string $mask )` Official doc: Official doc: Used to have the ASPSMS generate a verification code by mask. The mask can contain the following special characters: # : a digit A : an alphabetic character N : an alphanumeric character All other characters are taken literally. If not specified, the Mask is "NNNN" by default. Parameters `$mask` `string` $mask
`public`	# `setVerificationCode( string $code )` Official doc: Official doc: Explicitly specifies the verification code to be sent to the user. Parameters `$code` `string` $code
`public`	# `setTokenCaseSensitive( boolean $is_sensitive = FALSE )` Official doc: Official doc: Specifies, if the verification code comparison is case sensitive: 1 : case sensitive 0 : not case sensitive If not specified, TokenCaseSensitive is 0 by default. Parameters `$is_sensitive` `boolean` $is_sensitive

Properties summary
`public string`	`$requestName`	`NULL`	# Request name Request name
`public array`	`$fields`	`array()`	#

Namespaces

Classes

Exceptions

Class Request

Returns

Parameters

Parameters

See

Parameters

Parameters

See

Parameters

Parameters

See

Parameters

See

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters