Class HttpSimpleClient

Simple client interface for HTTP service only.

tschiemer\Aspsms\Http\HttpSimpleClient

Namespace: tschiemer\Aspsms\Http
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/Http/HttpSimpleClient.php

Methods summary
`public`	# `__construct( assoc $options = array() )` Constructor Constructor Sets up simple client and client/driver, thus taking any parameters for these to where any parameters for the driver must be fields of the base field 'httpclient' eg new HttpSimpleClient(array( 'userkey' => 'k', 'password' => 'p', 'originator' => 'o', 'httpclient' => array('method'=>'POST', .. ) )); Parameters `$options` `assoc` $options See AbstractSimpleClient::__construct() `tschiemer\Aspsms\Http\HttpClient::__construct()` Overrides `tschiemer\Aspsms\AbstractSimpleClient::__construct()`
`public Aspsms\AstractClient`	# `driver( Aspsms\Request & $request )` Get driver for simple client. Get driver for simple client. Parameters `$request` `Aspsms\Request` $request Returns `Aspsms\AstractClient`
`public array`	# `getVersion( )` Request: Get Http Service version. Request: Get Http Service version. Returns `array` Associative array with fields 'all','version','build' and corresponding meaning.
`public string`	# `getStatusDescription( string\|integer $statusCode )` Request: Get description to given status code. Request: Get description to given status code. Parameters `$statusCode` `string\|integer` $statusCode Returns `string`
`public boolean`	# `sendMyToken( string $phoneNr, string $reference, string $verificationCode, string $message = '', integer $minutes = 5, boolean $case_sensitive = 0 )` Request: Send a token a predefined token to recipients. Request: Send a token a predefined token to recipients. 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 `$phoneNr` `string` $phoneNr Recipient phone number `$reference` `string` $reference Your reference number `$verificationCode` `string` $verificationCode Required verification code to send `$message` `string` $message Message to send code with. `$minutes` `integer` $minutes Validity of token in minutes (default 5) `$case_sensitive` `boolean` $case_sensitive Is given code case sensitive? Returns `boolean` Request success?
`public boolean`	# `sendGeneratedToken( string $phoneNr, string $reference, string $message = '', string $mask = '######', integer $minutes = 5, boolean $case_sensitive = 0 )` Request: Send a token as generated by ASPSMS.COM, optionally give token mask. Request: Send a token as generated by ASPSMS.COM, optionally give token mask. 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. 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 `$phoneNr` `string` $phoneNr Recipient phone number `$reference` `string` $reference Your reference number `$message` `string` $message Message to send code with. `$mask` `string` $mask Token code mask to use (# -> number, A -> Alphabetical) `$minutes` `integer` $minutes Validity of token in minutes (default 5) `$case_sensitive` `boolean` $case_sensitive Is given code case sensitive? Returns `boolean` Request success?
`public boolean`	# `validateToken( string $phoneNr, string $reference, string $verificationCode )` Request: attempt to validate token. Request: attempt to validate token. NOTE: If a token have been successfully validated, any future attempts (no matter the verification code use) succeed. Parameters `$phoneNr` `string` $phoneNr Recipient phone number `$reference` `string` $reference Your reference number `$verificationCode` `string` $verificationCode Required verification code to validate Returns `boolean` Is given verification code for use valid?

Methods inherited from tschiemer\Aspsms\AbstractSimpleClient
`callbacks(), checkOriginator(), clear(), deferTime(), deferUntil(), flash(), getAffiliateId(), getCallbackURL(), getCreditBalance(), getDeliveryStatus(), getLastRequest(), getLastResponse(), getLastStatusCode(), getOriginator(), requestOriginatorUnlockCode(), send(), sendText(), sendWapPush(), set(), setAffiliateId(), setAuth(), setCallbackURL(), setOriginator(), unlockOriginator()`

Properties summary
`public SoapClient`	`$driver`		#

Properties inherited from tschiemer\Aspsms\AbstractSimpleClient
`$affiliateId, $currentRequest, $lastRequest, $lastResponse, $originator, $password, $urls, $userkey`

Namespaces

Classes

Class HttpSimpleClient

Parameters

See

Overrides

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns