File manager - Edit - /home/opticamezl/www/newok/clickatell.tar
Back
phpunit.xml 0000604 00000000633 15175014357 0006763 0 ustar 00 <?xml version="1.0" encoding="UTF-8"?> <phpunit bootstrap="vendor/autoload.php"> <testsuites> <testsuite name="ClickatellSuite"> <directory suffix="Test.php">test/</directory> </testsuite> </testsuites> <filter> <whitelist> <exclude> <directory>vendor/</directory> </exclude> </whitelist> </filter> </phpunit> src/ClickatellEvent.php 0000604 00000010534 15175014357 0011124 0 ustar 00 <?php /** * The Clickatell SMS Library provides a standardised way of talking to and * receiving replies from the Clickatell API's. * * PHP Version 5.3 * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ namespace Clickatell; /** * This is a wrapper class that is useful for when you want to track commands * for audit or debug purposes. * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ class ClickatellEvent implements TransportInterface { private $request = array(); private $response = array(); private $transport; /** * Construct a new event handler. * * @param TransportInterface $transport The adapter to use */ public function __construct(TransportInterface $transport) { $this->transport = $transport; } /** * Trigger a specific request event * * @param string $event The event name * @param object $args The arguments * * @return ClickatellEvent */ private function request($event, $args) { foreach ($this->request as $callable) { call_user_func_array($callable, array($event, $args)); } return $this; } /** * Trigger a specific response event * * @param string $event The event name * @param object $obj The response * * @return object */ private function response($event, $obj) { foreach ($this->response as $callable) { call_user_func_array($callable, array($event, $obj)); } return $obj; } /** * Add a new event listener for requests. * * @param callable $callable The callback * * @return ClickatellEvent */ public function onRequest($callable) { $this->request[] = $callable; return $this; } /** * Register a response listener. * * @param callable $callable The callback * * @return ClickatellEvent */ public function onResponse($callable) { $this->response[] = $callable; return $this; } /** * {@inheritdoc} */ public function sendMessage($to, $message, $extra = array()) { $event = __FUNCTION__; $args = (object) array( 'to' => $to, 'message' => $message, 'extra' => $extra ); $res = $this->request($event, $args)->transport->sendMessage($args->to, $args->message, $args->extra); return $this->response($event, $res); } /** * {@inheritdoc} */ public function getBalance() { $event = __FUNCTION__; $args = (object) array(); $res = $this->request($event, $args)->transport->getBalance(); return $this->response($event, $res); } /** * {@inheritdoc} */ public function stopMessage($apiMsgId) { $event = __FUNCTION__; $args = (object) array( 'apiMsgId' => $apiMsgId ); $res = $this->request($event, $args)->transport->stopMessage($args->apiMsgId); return $this->response($event, $res); } /** * {@inheritdoc} */ public function queryMessage($apiMsgId) { $event = __FUNCTION__; $args = (object) array( 'apiMsgId' => $apiMsgId ); $res = $this->request($event, $args)->transport->queryMessage($args->apiMsgId); return $this->response($event, $res); } /** * {@inheritdoc} */ public function routeCoverage($msisdn) { $event = __FUNCTION__; $args = (object) array( 'msisdn' => $msisdn ); $res = $this->request($event, $args)->transport->routeCoverage($args->msisdn); return $this->response($event, $res); } /** * {@inheritdoc} */ public function getMessageCharge($apiMsgId) { $event = __FUNCTION__; $args = (object) array( 'apiMsgId' => $apiMsgId ); $res = $this->request($event, $args)->transport->getMessageCharge($args->apiMsgId); return $this->response($event, $res); } } src/TransportInterface.php 0000604 00000004355 15175014357 0011674 0 ustar 00 <?php /** * The Clickatell SMS Library provides a standardised way of talking to and * receiving replies from the Clickatell API's. * * PHP Version 5.3 * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ namespace Clickatell; /** * This interface defines the required function for Transport handlers. * It also specifies the supported API calls. * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ interface TransportInterface { /** * API call for "sendMessage". * * Response format: * id => string|false * to => string * error => string|false * code => string|false * * @param array $to The recipient list * @param string $message Message * @param array $extra Extra parameters (based on Clickatell documents) * * @return array */ public function sendMessage($to, $message, $extra = array()); /** * API call for "getBalance". * * Response format: * balance => int * * @throws Exception * * @return int */ public function getBalance(); /** * API call for "stop message". * * @param string $apiMsgId ApiMsgId to query * * @throws Exception * * @return mixed */ public function stopMessage($apiMsgId); /** * API call for "queryMsg". * * @param string $apiMsgId ApiMsgId to query * * @throws Exception * * @return mixed */ public function queryMessage($apiMsgId); /** * API call for "routeCoverage". * * @param int $msisdn Number to check for coverage * * @throws Exception * * @return mixed */ public function routeCoverage($msisdn); /** * API call for "getMsgCharge". * * @param string $apiMsgId ApiMsgId to query * * @throws Exception * * @return mixed */ public function getMessageCharge($apiMsgId); } src/Decoder.php 0000604 00000006344 15175014357 0007424 0 ustar 00 <?php /** * The Clickatell SMS Library provides a standardised way of talking to and * receiving replies from the Clickatell API's. * * PHP Version 5.3 * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ namespace Clickatell; use Clickatell\Response; use Exception; /** * The response class is a representation of an API response. It provides some * helper methods to extract information from a raw response. * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ class Decoder { private $body; private $status; public function __construct($body, $status) { $this->body = $body; $this->status = $status; } /** * Get the response HTTP status. * * @return int */ public function getStatus() { return $this->status; } /** * Get the response body. * * @return string */ public function getBody() { return $this->body; } /** * Decode the REST response. * * @return stdClass */ public function decodeRest() { $decoded = json_decode($this->body, true); // Check if the decoded response contains a "global error". If the entire // packet failed there is no need to even try handling it further. if (isset($decoded['error'])) { // The assumption here is that every response will behave the same and when it's an // error it will always contain a description and code field. throw new Exception($decoded['error']['description'], $decoded['error']['code']); } return $decoded['data']; } /** * This method takes a CURL response and tries to unwrap it into * a usable object. Since the API is sometimes inconsistent we use * this functions to hide all the problems from the developer. * * @return array */ public function unwrapLegacy() { $lines = explode("\n", trim($this->body, "\n")); $result = array(); foreach ($lines as $line) { preg_match_all("/([A-Za-z]+):((.(?![A-Za-z]+:))*)/", $line, $matches); $row = array(); foreach ($matches[1] as $index => $status) { $row[$status] = trim($matches[2][$index]); } if (isset($row['ERR'])) { $error = explode(",", $row['ERR']); $row['error'] = true; $row['code'] = count($error) == 2 ? $error[0] : 0; $row['error'] = (isset($error[1])) ? trim($error[1]) : $error[0]; unset($row['ERR']); // If this response is a single row response, then we will throw // an exception to alert the user of any failures. if (count($lines) == 1) { throw new Exception($row['error'], $row['code']); } } $result[] = $row; } return count($result) > 1 ? $result : current($result); } } src/Diagnostic.php 0000604 00000004373 15175014360 0010135 0 ustar 00 <?php /** * The Clickatell SMS Library provides a standardised way of talking to and * receiving replies from the Clickatell API's. * * PHP Version 5.3 * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ namespace Clickatell; /** * This diagnostic file maps Clickatell message response codes to error messages. It's * a convenience class. * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ class Diagnostic { /** * @var array */ private static $statusCodes = array( "001" => "The message ID is incorrect or reporting is delayed.", "002" => "The message could not be delivered and has been queued for attempted redelivery.", "003" => "Delivered to the upstream gateway or network (delivered to the recipient).", "004" => "Confirmation of receipt on the handset of the recipient.", "005" => "There was an error with the message, probably caused by the content of the message itself.", "006" => "The message was terminated by a user (stop message command) or by our staff.", "007" => "An error occurred delivering the message to the handset. 008 0x008 OK Message received by gateway.", "009" => "The routing gateway or network has had an error routing the message.", "010" => "Message has expired before we were able to deliver it to the upstream gateway. No charge applies.", "011" => "Message has been queued at the gateway for delivery at a later time (delayed delivery).", "012" => "The message cannot be delivered due to a lack of funds in your account. Please re-purchase credits.", "014" => "Maximum MT limit exceeded The allowable amount for MT messaging has been exceeded.", ); /** * Retrieves a description from a specfied code. * * @param string $code Error code received from API * * @return string */ public static function getStatus($code) { return isset(self::$statusCodes[$code]) ? self::$statusCodes[$code] : "unknown error"; } } src/Callback.php 0000604 00000003140 15175014360 0007534 0 ustar 00 <?php /** * The Clickatell SMS Library provides a standardised way of talking to and * receiving replies from the Clickatell API's. * * PHP Version 5.3 * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ namespace Clickatell; /** * This class provides helper functionality to parse Clickatell MT and MO callbacks. * The callback functional will only trigger if the callback contains the relevant parameters. * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ class Callback { /** * Triggers if a clickatell MT callback has been received by the page. * * @param callable $callable The callable function * * @return boolean */ public static function parseCallback($callable) { $required = array_flip( array( 'apiMsgId', 'cliMsgId', 'to', 'timestamp', 'from', 'status', 'charge' ) ); $values = array_intersect_key($_GET, $required); $diff = array_diff_key($required, $values); // If there are no difference, then it means the callback // passed all the required values. if (empty($diff)) { return call_user_func_array($callable, array($values)); } return false; } } src/Api/ClickatellHttp.php 0000604 00000011157 15175014360 0011467 0 ustar 00 <?php /** * The Clickatell SMS Library provides a standardised way of talking to and * receiving replies from the Clickatell API's. * * PHP Version 5.3 * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ namespace Clickatell\Api; use Clickatell\Clickatell; use Clickatell\Diagnostic; use Exception; /** * The HTTP API usage class. * * @package Clickatell\Api * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ class ClickatellHttp extends Clickatell { private $username; private $password; private $apiId; /** * Construct a new HTTP API connection. * * @param string $username The username * @param string $password The password * @param int $apiId The clickatell API ID */ public function __construct($username, $password, $apiId) { $this->username = $username; $this->password = $password; $this->apiId = $apiId; } /** * {@inheritdoc} */ protected function get($uri, $args, $method = self::HTTP_GET) { $args = array_merge( $args, array( 'user' => $this->username, 'password' => $this->password, 'api_id' => $this->apiId ) ); $query = http_build_query($args); return $this->curl($uri, $query, array(), $method)->unwrapLegacy(); } /** * {@inheritdoc} */ public function sendMessage($to, $message, $extra = array()) { $extra['to'] = implode(",", (array) $to); $extra['text'] = $message; $args = $this->getSendDefaults($extra); try { $response = $this->get('http/sendmsg', $args); } catch (Exception $e) { $response = array( 'error' => $e->getMessage(), 'errorCode' => $e->getCode() ); } !is_int(key($response)) && $response = array($response); $return = array(); // We won't throw any exceptions if an error occurs since we could have // multiple messages in the packet and not all of them might have failed. foreach ($response as $entry) { $return[] = (object) array( 'id' => (isset($entry['ID'])) ? $entry['ID'] : false, 'destination' => (isset($entry['To'])) ? $entry['To'] : $args['to'], 'error' => (isset($entry['error'])) ? $entry['error'] : false, 'errorCode' => (isset($entry['code'])) ? $entry['code'] : false ); } return $return; } /** * {@inheritdoc} */ public function getBalance() { $response = $this->get('http/getbalance', array()); return (object) array( 'balance' => (float) $response['Credit'] ); } /** * {@inheritdoc} */ public function queryMessage($apiMsgId) { return $this->getMessageCharge($apiMsgId); } /** * {@inheritdoc} */ public function routeCoverage($msisdn) { try { $response = $this->get('utils/routeCoverage', array('msisdn' => $msisdn)); return (object) array( 'routable' => true, 'destination' => $msisdn, 'charge' => $response['Charge'] ); } catch (Exception $exception) { return (object) array( 'routable' => false, 'destination' => $msisdn, 'charge' => 0 ); } } /** * {@inheritdoc} */ public function getMessageCharge($apiMsgId) { $response = $this->get('http/getmsgcharge', array('apimsgid' => $apiMsgId)); return (object) array( 'id' => $apiMsgId, 'status' => $response['status'], 'description' => Diagnostic::getStatus($response['status']), 'charge' => (float) $response['charge'] ); } /** * {@inheritdoc} */ public function stopMessage($apiMsgId) { $response = $this->get('http/delmsg', array('apimsgid' => $apiMsgId)); return (object) array( 'id' => $response['ID'], 'status' => $response['Status'], 'description' => Diagnostic::getStatus($response['Status']), ); } } src/Api/ClickatellRest.php 0000604 00000011153 15175014360 0011461 0 ustar 00 <?php /** * The Clickatell SMS Library provides a standardised way of talking to and * receiving replies from the Clickatell API's. * * PHP Version 5.3 * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ namespace Clickatell\Api; use Clickatell\Clickatell; use Clickatell\Diagnostic; /** * The REST API usage class. * * @package Clickatell\Api * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ class ClickatellRest extends Clickatell { private $token; /** * Construct a new REST API connection. * * @param string $token The auth token */ public function __construct($token) { $this->token = $token; } /** * Return the headers that will be used with every REST * request. * * @return array */ private function getHeaders() { return array( "Authorization: Bearer " . $this->token, "Content-Type: application/json", "X-Version: 1", "Accept: application/json" ); } /** * {@inheritdoc} */ protected function get($uri, $args, $method = self::HTTP_GET) { $data = json_encode($args); $response = $this->curl($uri, $data, $this->getHeaders(), $method); return $response->decodeRest(); } /** * {@inheritdoc} */ public function sendMessage($to, $message, $extra = array()) { $extra['to'] = (array) $to; $extra['text'] = $message; $args = $this->getSendDefaults($extra); // The "to" field only accepts strings as numbers. We will take all the // values and map them into strings. $args['to'] = array_map(function ($value) { return (string) $value; }, $args['to']); try { $response = $this->get('rest/message', $args, self::HTTP_POST); } catch (Exception $e) { $response = array( 'error' => $e->getMessage(), 'errorCode' => $e->getCode() ); } $return = array(); // According to the documentation, we can pretty much assume that // a response from "rest/message" will contain a "message" key with an // array of messages in it. foreach ($response['message'] as $entry) { $return[] = (object) array( 'id' => (isset($entry['apiMessageId'])) ? $entry['apiMessageId'] : false, 'destination' => (isset($entry['to'])) ? $entry['to'] : $args['to'], 'error' => (isset($entry['error'])) ? $entry['error']['description'] : false, 'errorCode' => (isset($entry['code'])) ? $entry['error']['code'] : false ); } return $return; } /** * {@inheritdoc} */ public function getBalance() { $response = $this->get('rest/account/balance', array()); return (object) array( 'balance' => (float) $response['balance'] ); } /** * {@inheritdoc} */ public function queryMessage($apiMsgId) { return $this->getMessageCharge($apiMsgId); } /** * {@inheritdoc} */ public function routeCoverage($msisdn) { $response = $this->get('rest/coverage/' . $msisdn, array()); return (object) array( 'routable' => $response['routable'], 'destination' => $response['destination'], 'charge' => (float) $response['minimumCharge'] ); } /** * {@inheritdoc} */ public function getMessageCharge($apiMsgId) { $response = $this->get('rest/message/' . $apiMsgId, array()); return (object) array( 'id' => $response['apiMessageId'], 'status' => $response['messageStatus'], 'description' => Diagnostic::getStatus($response['messageStatus']), 'charge' => (float) $response['charge'] ); } /** * {@inheritdoc} */ public function stopMessage($apiMsgId) { $response = $this->get('rest/message/' . $apiMsgId, array(), self::HTTP_DELETE); return (object) array( 'id' => $response['apiMessageId'], 'status' => $response['messageStatus'], 'description' => Diagnostic::getStatus($response['messageStatus']), ); } } src/Event.php 0000604 00000002501 15175014360 0007121 0 ustar 00 <?php /** * The Clickatell SMS Library provides a standardised way of talking to and * receiving replies from the Clickatell API's. * * PHP Version 5.3 * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ namespace Clickatell; /** * This event class is used by the ClickatellEvent handler. * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ class Event { const SEND_MESSAGE = 0; const GET_BALANCE = 1; const STOP_MESSAGE = 2; const QUERY_MESSAGE = 3; const ROUTE_COVERAGE = 4; const GET_MESSAGE_CHARGE = 5; /** * Construct a new event. * * @param string $event The event name * @param array $args Associative array of arguments */ public function __construct($event, $args) { $this->event = $event; foreach ($args as $key => $value) { $this->$key = $value; } } /** * Get the event name. * * @return string */ public function getEvent() { return $this->event; } } src/Clickatell.php 0000604 00000010126 15175014360 0010111 0 ustar 00 <?php /** * The Clickatell SMS Library provides a standardised way of talking to and * receiving replies from the Clickatell API's. * * PHP Version 5.3 * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ namespace Clickatell; use Clickatell\Response; /** * This is the main messenger class that encapsulates various objects to succesfully * send Clickatell calls and respond in an appropriate manner. The messenger class * enables you to set your own Transport and Translate interfaces. * * @package Clickatell * @author Chris Brand <chris@cainsvault.com> * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License * @link https://github.com/arcturial */ abstract class Clickatell implements TransportInterface { const HTTP_GET = "GET"; const HTTP_POST = "POST"; const HTTP_DELETE = "DELETE"; private $secure = false; /** * This function serves as the "request" or "invoke" function. This will in turn * call the API or whatever resource is required to complete the task. Each adapter * should overwrite this function with the appropriate logic. * * @param string $uri The uri (endpoint) * @param array $args The arguments * @param string $method The desired HTTP method * * @return array */ abstract protected function get($uri, $args, $method = self::HTTP_GET); /** * Merge the defaults with the requested parameters. The sendMessage API * call has many parameters. This call populates some of the defaults for us. * * @param array $parameters The parameters to merge in * * @return array */ protected function getSendDefaults($parameters) { return array_merge( array( 'mo' => 1, 'callback' => 7 ), $parameters ); } /** * Abstract CURL usage. This helps with testing and extendibility * accross multiple API types. * * @param string $uri The endpoint * @param strong $data POST data or query string * @param array $headers Header array * @param string $method HTTP method * * @return Decoder */ protected function curl($uri, $data, $headers = array(), $method = self::HTTP_GET) { // This is the clickatell endpoint. It doesn't really change so // it's safe for us to "hardcode" it here. $host = "api.clickatell.com"; $uri = ltrim($uri, "/"); $uri = ($this->secure ? 'https' : 'http') . '://' . $host . "/" . $uri; $method == "GET" && $uri = $uri . "?" . $data; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $uri); curl_setopt($ch, CURLOPT_HEADER, 0); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); ($method == "POST") && curl_setopt($ch, CURLOPT_POST, 1) && curl_setopt($ch, CURLOPT_POSTFIELDS, $data); $result = curl_exec($ch); $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE); return new Decoder($result, $httpCode); } /** * Triggers if a clickatell MT callback has been received by the page. * * @param Closure $closure The callable function * * @return boolean */ /* public static function parseCallback(Closure $closure) { $required = array_flip( array( 'apiMsgId', 'cliMsgId', 'to', 'timestamp', 'from', 'status', 'charge' ) ); $values = array_intersect_key($_GET, $required); $diff = array_diff_key($required, $values); // If there are no difference, then it means the callback // passed all the required values. if (empty($diff)) { return call_user_func_array($closure, array($values)); } return false; } */ } .travis.yml 0000604 00000000227 15175014360 0006654 0 ustar 00 language: php php: - "5.4" - "5.3" install: - composer install --prefer-source --no-interaction --dev script: - ./vendor/bin/phpunit test/DiagnosticTest.php 0000604 00000002270 15175014360 0011157 0 ustar 00 <?php namespace Clickatell; use PHPUnit_Framework_TestCase; class DiagnosticTest extends PHPUnit_Framework_TestCase { public function testGetError() { $this->assertTrue(strlen(Diagnostic::getStatus("001")) > 0); $this->assertTrue(strlen(Diagnostic::getStatus("002")) > 0); $this->assertTrue(strlen(Diagnostic::getStatus("003")) > 0); $this->assertTrue(strlen(Diagnostic::getStatus("004")) > 0); $this->assertTrue(strlen(Diagnostic::getStatus("005")) > 0); $this->assertTrue(strlen(Diagnostic::getStatus("006")) > 0); $this->assertTrue(strlen(Diagnostic::getStatus("007")) > 0); $this->assertTrue(strlen(Diagnostic::getStatus("008")) > 0); $this->assertTrue(strlen(Diagnostic::getStatus("009")) > 0); $this->assertTrue(strlen(Diagnostic::getStatus("010")) > 0); $this->assertTrue(strlen(Diagnostic::getStatus("011")) > 0); $this->assertTrue(strlen(Diagnostic::getStatus("012")) > 0); $this->assertTrue(strlen(Diagnostic::getStatus("013")) > 0); $this->assertTrue(strlen(Diagnostic::getStatus("014")) > 0); $this->assertSame("unknown error", Diagnostic::getStatus("015")); } } test/Api/ClickatellHttpTest.php 0000604 00000011154 15175014360 0012514 0 ustar 00 <?php namespace Clickatell\Api; use Clickatell\Decoder; use PHPUnit_Framework_TestCase; use ReflectionClass; class ClickatellHttpTest extends PHPUnit_Framework_TestCase { public function testGet() { $uri = "http/sendmsg"; $args = array( 'user' => 'username', 'password' => 'password', 'api_id' => '123456' ); $decoder = $this->getMockBuilder("Clickatell\Decoder") ->setMethods(array("unwrapLegacy")) ->disableOriginalConstructor() ->getMock(); $decoder->expects($this->once()) ->method('unwrapLegacy'); $clickatell = $this->getMockBuilder('Clickatell\Api\ClickatellHttp') ->setMethods(array('curl')) ->setConstructorArgs(array('username', 'password', '123456')) ->getMock(); $clickatell->expects($this->once()) ->method('curl') ->with($uri, http_build_query($args)) ->will($this->returnValue($decoder)); $class = new ReflectionClass($clickatell); $method = $class->getMethod('get'); $method->setAccessible(true); $method->invokeArgs($clickatell, array($uri, array())); } public function testSendMessage() { $default = array( 'to' => "12345,123456", 'text' => 'message', 'mo' => false, 'callback' => true ); $clickatell = $this->getMockBuilder('Clickatell\Api\ClickatellHttp') ->setMethods(array('get')) ->disableOriginalConstructor() ->getMock(); $response = new Decoder('ID: 123456789 To: 12345', 200); $clickatell->expects($this->once()) ->method('get') ->with('http/sendmsg', $default) ->will($this->returnValue($response->unwrapLegacy())); $entries = $clickatell->sendMessage(array(12345, 123456), "message", array('mo' => false)); $this->assertSame("123456789", $entries[0]->id); $this->assertEquals(12345, $entries[0]->destination); $this->assertSame(false, $entries[0]->errorCode); $this->assertSame(false, $entries[0]->error); } public function testGetBalance() { $return = array( 'Credit' => 0.5 ); $clickatell = $this->getMockBuilder('Clickatell\Api\ClickatellHttp') ->setMethods(array('get')) ->disableOriginalConstructor() ->getMock(); $clickatell->expects($this->once()) ->method('get') ->with('http/getbalance', array()) ->will($this->returnValue($return)); $balance = $clickatell->getBalance(); $this->assertSame($return['Credit'], $balance->balance); } public function testQueryMessage() { $clickatell = $this->getMockBuilder('Clickatell\Api\ClickatellHttp') ->setMethods(array('getMessageCharge')) ->disableOriginalConstructor() ->getMock(); $clickatell->expects($this->once()) ->method('getMessageCharge') ->with("12345"); $clickatell->queryMessage("12345"); } public function testGetMessageCharge() { $id = "12345"; $return = array( 'status' => "003", 'charge' => 1.0 ); $clickatell = $this->getMockBuilder('Clickatell\Api\ClickatellHttp') ->setMethods(array('get')) ->disableOriginalConstructor() ->getMock(); $clickatell->expects($this->once()) ->method('get') ->with('http/getmsgcharge', array('apimsgid' => $id)) ->will($this->returnValue($return)); $response = $clickatell->getMessageCharge($id); $this->assertSame($id, $response->id); $this->assertSame($return['status'], $response->status); $this->assertSame($return['charge'], $response->charge); } public function testStopMessage() { $id = "12345"; $return = array( "Status" => "003", "ID" => $id ); $clickatell = $this->getMockBuilder('Clickatell\Api\ClickatellHttp') ->setMethods(array('get')) ->disableOriginalConstructor() ->getMock(); $clickatell->expects($this->once()) ->method('get') ->with('http/delmsg', array('apimsgid' => $id)) ->will($this->returnValue($return)); $response = $clickatell->stopMessage($id); $this->assertSame($id, $response->id); $this->assertSame($return['Status'], $response->status); } } test/DecoderTest.php 0000604 00000002005 15175014360 0010434 0 ustar 00 <?php namespace Clickatell; use PHPUnit_Framework_TestCase; class DecoderTest extends PHPUnit_Framework_TestCase { public function testUnwrapLegacy() { $body = "ERR: 301, Some Error"; $clickatell = new Decoder($body, 200); $this->setExpectedException('Exception', 'Some Error', 301); $return = $clickatell->unwrapLegacy(); } public function testDecodeRest() { $body = json_encode( array( 'data' => true ) ); $clickatell = new Decoder($body, 200); $return = $clickatell->decodeRest(); $this->assertTrue($return); $body = json_encode( array( 'error' => array( 'description' => 'Some Error', 'code' => 301 ) ) ); $clickatell = new Decoder($body, 200); $this->setExpectedException('Exception', 'Some Error', 301); $return = $clickatell->decodeRest(); } } test/ClickatellTest.php 0000604 00000001175 15175014360 0011145 0 ustar 00 <?php namespace Clickatell; use PHPUnit_Framework_TestCase; use ReflectionClass; class ClickatellTest extends PHPUnit_Framework_TestCase { public function testCurl() { $uri = "http/sendmsg"; $args = ""; $clickatell = $this->getMockForAbstractClass('Clickatell\Clickatell'); $class = new ReflectionClass($clickatell); $method = $class->getMethod('curl'); $method->setAccessible(true); $return = $method->invokeArgs($clickatell, array($uri, $args)); $this->assertSame(200, $return->getStatus()); $this->assertTrue(strlen($return->getBody()) > 0); } } composer.lock 0000604 00000063442 15175014360 0007254 0 ustar 00 { "_readme": [ "This file locks the dependencies of your project to a known state", "Read more about it at http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file", "This file is @generated automatically" ], "hash": "03506496a0a2e629a1cc462cf72e4171", "packages": [], "packages-dev": [ { "name": "doctrine/instantiator", "version": "1.0.4", "source": { "type": "git", "url": "https://github.com/doctrine/instantiator.git", "reference": "f976e5de371104877ebc89bd8fecb0019ed9c119" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/doctrine/instantiator/zipball/f976e5de371104877ebc89bd8fecb0019ed9c119", "reference": "f976e5de371104877ebc89bd8fecb0019ed9c119", "shasum": "" }, "require": { "php": ">=5.3,<8.0-DEV" }, "require-dev": { "athletic/athletic": "~0.1.8", "ext-pdo": "*", "ext-phar": "*", "phpunit/phpunit": "~4.0", "squizlabs/php_codesniffer": "2.0.*@ALPHA" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.0.x-dev" } }, "autoload": { "psr-0": { "Doctrine\\Instantiator\\": "src" } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Marco Pivetta", "email": "ocramius@gmail.com", "homepage": "http://ocramius.github.com/" } ], "description": "A small, lightweight utility to instantiate objects in PHP without invoking their constructors", "homepage": "https://github.com/doctrine/instantiator", "keywords": [ "constructor", "instantiate" ], "time": "2014-10-13 12:58:55" }, { "name": "phpunit/php-code-coverage", "version": "2.0.11", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-code-coverage.git", "reference": "53603b3c995f5aab6b59c8e08c3a663d2cc810b7" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/53603b3c995f5aab6b59c8e08c3a663d2cc810b7", "reference": "53603b3c995f5aab6b59c8e08c3a663d2cc810b7", "shasum": "" }, "require": { "php": ">=5.3.3", "phpunit/php-file-iterator": "~1.3", "phpunit/php-text-template": "~1.2", "phpunit/php-token-stream": "~1.3", "sebastian/environment": "~1.0", "sebastian/version": "~1.0" }, "require-dev": { "ext-xdebug": ">=2.1.4", "phpunit/phpunit": "~4.1" }, "suggest": { "ext-dom": "*", "ext-xdebug": ">=2.2.1", "ext-xmlwriter": "*" }, "type": "library", "extra": { "branch-alias": { "dev-master": "2.0.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "include-path": [ "" ], "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sb@sebastian-bergmann.de", "role": "lead" } ], "description": "Library that provides collection, processing, and rendering functionality for PHP code coverage information.", "homepage": "https://github.com/sebastianbergmann/php-code-coverage", "keywords": [ "coverage", "testing", "xunit" ], "time": "2014-08-31 06:33:04" }, { "name": "phpunit/php-file-iterator", "version": "1.3.4", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-file-iterator.git", "reference": "acd690379117b042d1c8af1fafd61bde001bf6bb" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/acd690379117b042d1c8af1fafd61bde001bf6bb", "reference": "acd690379117b042d1c8af1fafd61bde001bf6bb", "shasum": "" }, "require": { "php": ">=5.3.3" }, "type": "library", "autoload": { "classmap": [ "File/" ] }, "notification-url": "https://packagist.org/downloads/", "include-path": [ "" ], "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sb@sebastian-bergmann.de", "role": "lead" } ], "description": "FilterIterator implementation that filters files based on a list of suffixes.", "homepage": "https://github.com/sebastianbergmann/php-file-iterator/", "keywords": [ "filesystem", "iterator" ], "time": "2013-10-10 15:34:57" }, { "name": "phpunit/php-text-template", "version": "1.2.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-text-template.git", "reference": "206dfefc0ffe9cebf65c413e3d0e809c82fbf00a" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/php-text-template/zipball/206dfefc0ffe9cebf65c413e3d0e809c82fbf00a", "reference": "206dfefc0ffe9cebf65c413e3d0e809c82fbf00a", "shasum": "" }, "require": { "php": ">=5.3.3" }, "type": "library", "autoload": { "classmap": [ "Text/" ] }, "notification-url": "https://packagist.org/downloads/", "include-path": [ "" ], "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sb@sebastian-bergmann.de", "role": "lead" } ], "description": "Simple template engine.", "homepage": "https://github.com/sebastianbergmann/php-text-template/", "keywords": [ "template" ], "time": "2014-01-30 17:20:04" }, { "name": "phpunit/php-timer", "version": "1.0.5", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-timer.git", "reference": "19689d4354b295ee3d8c54b4f42c3efb69cbc17c" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/19689d4354b295ee3d8c54b4f42c3efb69cbc17c", "reference": "19689d4354b295ee3d8c54b4f42c3efb69cbc17c", "shasum": "" }, "require": { "php": ">=5.3.3" }, "type": "library", "autoload": { "classmap": [ "PHP/" ] }, "notification-url": "https://packagist.org/downloads/", "include-path": [ "" ], "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sb@sebastian-bergmann.de", "role": "lead" } ], "description": "Utility class for timing", "homepage": "https://github.com/sebastianbergmann/php-timer/", "keywords": [ "timer" ], "time": "2013-08-02 07:42:54" }, { "name": "phpunit/php-token-stream", "version": "1.3.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-token-stream.git", "reference": "f8d5d08c56de5cfd592b3340424a81733259a876" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/f8d5d08c56de5cfd592b3340424a81733259a876", "reference": "f8d5d08c56de5cfd592b3340424a81733259a876", "shasum": "" }, "require": { "ext-tokenizer": "*", "php": ">=5.3.3" }, "require-dev": { "phpunit/phpunit": "~4.2" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.3-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" } ], "description": "Wrapper around PHP's tokenizer extension.", "homepage": "https://github.com/sebastianbergmann/php-token-stream/", "keywords": [ "tokenizer" ], "time": "2014-08-31 06:12:13" }, { "name": "phpunit/phpunit", "version": "4.3.5", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", "reference": "2dab9d593997db4abcf58d0daf798eb4e9cecfe1" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/2dab9d593997db4abcf58d0daf798eb4e9cecfe1", "reference": "2dab9d593997db4abcf58d0daf798eb4e9cecfe1", "shasum": "" }, "require": { "ext-dom": "*", "ext-json": "*", "ext-pcre": "*", "ext-reflection": "*", "ext-spl": "*", "php": ">=5.3.3", "phpunit/php-code-coverage": "~2.0", "phpunit/php-file-iterator": "~1.3.2", "phpunit/php-text-template": "~1.2", "phpunit/php-timer": "~1.0.2", "phpunit/phpunit-mock-objects": "~2.3", "sebastian/comparator": "~1.0", "sebastian/diff": "~1.1", "sebastian/environment": "~1.0", "sebastian/exporter": "~1.0", "sebastian/version": "~1.0", "symfony/yaml": "~2.0" }, "suggest": { "phpunit/php-invoker": "~1.1" }, "bin": [ "phpunit" ], "type": "library", "extra": { "branch-alias": { "dev-master": "4.3.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "include-path": [ "", "../../symfony/yaml/" ], "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de", "role": "lead" } ], "description": "The PHP Unit Testing framework.", "homepage": "http://www.phpunit.de/", "keywords": [ "phpunit", "testing", "xunit" ], "time": "2014-11-11 10:11:09" }, { "name": "phpunit/phpunit-mock-objects", "version": "2.3.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit-mock-objects.git", "reference": "c63d2367247365f688544f0d500af90a11a44c65" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/phpunit-mock-objects/zipball/c63d2367247365f688544f0d500af90a11a44c65", "reference": "c63d2367247365f688544f0d500af90a11a44c65", "shasum": "" }, "require": { "doctrine/instantiator": "~1.0,>=1.0.1", "php": ">=5.3.3", "phpunit/php-text-template": "~1.2" }, "require-dev": { "phpunit/phpunit": "~4.3" }, "suggest": { "ext-soap": "*" }, "type": "library", "extra": { "branch-alias": { "dev-master": "2.3.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sb@sebastian-bergmann.de", "role": "lead" } ], "description": "Mock Object library for PHPUnit", "homepage": "https://github.com/sebastianbergmann/phpunit-mock-objects/", "keywords": [ "mock", "xunit" ], "time": "2014-10-03 05:12:11" }, { "name": "sebastian/comparator", "version": "1.0.1", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/comparator.git", "reference": "e54a01c0da1b87db3c5a3c4c5277ddf331da4aef" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/e54a01c0da1b87db3c5a3c4c5277ddf331da4aef", "reference": "e54a01c0da1b87db3c5a3c4c5277ddf331da4aef", "shasum": "" }, "require": { "php": ">=5.3.3", "sebastian/diff": "~1.1", "sebastian/exporter": "~1.0" }, "require-dev": { "phpunit/phpunit": "~4.1" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.0.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Jeff Welch", "email": "whatthejeff@gmail.com" }, { "name": "Volker Dusch", "email": "github@wallbash.com" }, { "name": "Bernhard Schussek", "email": "bschussek@2bepublished.at" }, { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" } ], "description": "Provides the functionality to compare PHP values for equality", "homepage": "http://www.github.com/sebastianbergmann/comparator", "keywords": [ "comparator", "compare", "equality" ], "time": "2014-05-11 23:00:21" }, { "name": "sebastian/diff", "version": "1.2.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/diff.git", "reference": "5843509fed39dee4b356a306401e9dd1a931fec7" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/5843509fed39dee4b356a306401e9dd1a931fec7", "reference": "5843509fed39dee4b356a306401e9dd1a931fec7", "shasum": "" }, "require": { "php": ">=5.3.3" }, "require-dev": { "phpunit/phpunit": "~4.2" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.2-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Kore Nordmann", "email": "mail@kore-nordmann.de" }, { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" } ], "description": "Diff implementation", "homepage": "http://www.github.com/sebastianbergmann/diff", "keywords": [ "diff" ], "time": "2014-08-15 10:29:00" }, { "name": "sebastian/environment", "version": "1.2.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/environment.git", "reference": "0d9bf79554d2a999da194a60416c15cf461eb67d" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/0d9bf79554d2a999da194a60416c15cf461eb67d", "reference": "0d9bf79554d2a999da194a60416c15cf461eb67d", "shasum": "" }, "require": { "php": ">=5.3.3" }, "require-dev": { "phpunit/phpunit": "~4.3" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.2.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" } ], "description": "Provides functionality to handle HHVM/PHP environments", "homepage": "http://www.github.com/sebastianbergmann/environment", "keywords": [ "Xdebug", "environment", "hhvm" ], "time": "2014-10-22 06:38:05" }, { "name": "sebastian/exporter", "version": "1.0.2", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/exporter.git", "reference": "c7d59948d6e82818e1bdff7cadb6c34710eb7dc0" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/c7d59948d6e82818e1bdff7cadb6c34710eb7dc0", "reference": "c7d59948d6e82818e1bdff7cadb6c34710eb7dc0", "shasum": "" }, "require": { "php": ">=5.3.3" }, "require-dev": { "phpunit/phpunit": "~4.0" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.0.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Jeff Welch", "email": "whatthejeff@gmail.com" }, { "name": "Volker Dusch", "email": "github@wallbash.com" }, { "name": "Bernhard Schussek", "email": "bschussek@2bepublished.at" }, { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" }, { "name": "Adam Harvey", "email": "aharvey@php.net" } ], "description": "Provides the functionality to export PHP variables for visualization", "homepage": "http://www.github.com/sebastianbergmann/exporter", "keywords": [ "export", "exporter" ], "time": "2014-09-10 00:51:36" }, { "name": "sebastian/version", "version": "1.0.3", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/version.git", "reference": "b6e1f0cf6b9e1ec409a0d3e2f2a5fb0998e36b43" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/version/zipball/b6e1f0cf6b9e1ec409a0d3e2f2a5fb0998e36b43", "reference": "b6e1f0cf6b9e1ec409a0d3e2f2a5fb0998e36b43", "shasum": "" }, "type": "library", "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de", "role": "lead" } ], "description": "Library that helps with managing the version number of Git-hosted PHP projects", "homepage": "https://github.com/sebastianbergmann/version", "time": "2014-03-07 15:35:33" }, { "name": "symfony/yaml", "version": "v2.5.7", "target-dir": "Symfony/Component/Yaml", "source": { "type": "git", "url": "https://github.com/symfony/Yaml.git", "reference": "900d38bc8f74a50343ce65dd1c1e9819658ee56b" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/symfony/Yaml/zipball/900d38bc8f74a50343ce65dd1c1e9819658ee56b", "reference": "900d38bc8f74a50343ce65dd1c1e9819658ee56b", "shasum": "" }, "require": { "php": ">=5.3.3" }, "type": "library", "extra": { "branch-alias": { "dev-master": "2.5-dev" } }, "autoload": { "psr-0": { "Symfony\\Component\\Yaml\\": "" } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Symfony Community", "homepage": "http://symfony.com/contributors" }, { "name": "Fabien Potencier", "email": "fabien@symfony.com" } ], "description": "Symfony Yaml Component", "homepage": "http://symfony.com", "time": "2014-11-20 13:22:25" } ], "aliases": [], "minimum-stability": "stable", "stability-flags": [], "prefer-stable": false, "platform": { "php": ">=5.3.3" }, "platform-dev": [] } .gitignore 0000604 00000000047 15175014360 0006533 0 ustar 00 build/ vendor/ /stage.php composer.phar README.md 0000604 00000007734 15175014360 0006034 0 ustar 00 Clickatell SMS Messenger Library ================================ Master: [](http://travis-ci.org/arcturial/clickatell) This library allows easy access to connecting the [Clickatell's](http://www.clickatell.com) different messenging API's. 1. Installation ------------------ This library uses [composer](http://www.getcomposer.org) and can be acquired using the following in your composer.json file. ``` json { "require": { "arcturial/clickatell": "*" } } ``` 2. Usage ------------------ The library currently supports the `ClickatellHttp` and `ClickatellRest` adapters. ### HTTP API ``` php use Clickatell\Api\ClickatellHttp; $clickatell = new ClickatellHttp($username, $password, $apiID); $response = $clickatell->sendMessage(array(1111111111), "My Message"); foreach ($response as $message) { echo $message->id; // Message response fields: // $message->id // $message->destination // $message->error // $message->errorCode } ``` ### REST API ``` php use Clickatell\Api\ClickatellRest; $clickatell = new ClickatellRest($token); $response = $clickatell->sendMessage(array(1111111111), "My Message"); foreach ($response as $message) { echo $message->id; // Message response fields: // $message->id // $message->destination // $message->error // $message->errorCode } ``` ### Sending to multiple numbers The `sendMessage` call `to` parameter can take an array of numbers. If you specify only a single number like `$clickatell->sendMessage(1111111111, "Message")` the library will automatically convert it to an array for your convenience. 3. Supported API calls ------------------ The available calls are defined in the `Clickatell\TransportInterface` interface. ``` php public function sendMessage($to, $message, $extra = array()); public function getBalance(); public function stopMessage($apiMsgId); public function queryMessage($apiMsgId); public function routeCoverage($msisdn); public function getMessageCharge($apiMsgId); ``` 4. Events --------------- The library comes with a `ClickatellEvent` class which is a wrapper for any of the other transports. This class can assist you with debugging or logging API interactions. This class uses the [Proxy Pattern](http://en.wikipedia.org/wiki/Proxy_pattern). ``` php <?php use Clickatell\Api\ClickatellHttp; use Clickatell\ClickatellEvent; use Clickatell\Event; $clickatell = new ClickatellHttp($username, $password, $apiID); $event = new ClickatellEvent($clickatell); $event->onRequest(function ($event, $args) { var_dump($event); var_dump($args->to); var_dump($args->message); var_dump($args->extra); // The parameters in the event object depend on the type of event. // The event constants are available in the Clickatell\Event class. }); $event->onResponse(function ($event, $obj) { var_dump($event); var_dump($obj); // The $obj variable is the same as the response you would get back. So // in the case of sendMessage it will be an array of message responses. }); $event->sendMessage(array(1111111111), "My Message"); ?> ``` 5. Dealing with extra parameters in sendMessage -------------------------------------- For usability purposes the `sendMessage` call focuses on the recipients and the content. In order to specify and of the additional parameters defined in the [Clickatell document](http://www.clickatell.com), you can use the `extra` parameter and pass them as an array. 6. Callbacks --------------- You can listen to clickatell callbacks by using the `Callback::parseCallback();` function. It's a helper function to make sure the required parameters are including in the `$_GET` array. Parameters: apiMsgId, cliMsgId, to, timestamp, from, status, charge Example ``` php use Clickatell\Callback; Callback::parseCallback(function ($values) { // var_dump($values); // Contains: apiMsgId, cliMsgId, to, timestamp, from, status, charge }); ?> ``` composer.json 0000604 00000001104 15175014360 0007260 0 ustar 00 { "name": "arcturial/clickatell", "type": "library", "description": "Standalone PHP library to integrate with the Clickatell SMS gateway", "homepage": "http://www.cainsvault.com", "license": "GNU General Public License", "authors": [ { "name": "Chris Brand", "email": "webmaster@cainsvault.com" } ], "require": { "php": ">=5.3.3" }, "require-dev": { "phpunit/phpunit": "4.3.*" }, "autoload": { "psr-4": { "Clickatell\\": [ "src", "test" ] } } }
| ver. 1.4 |
Github
|
.
| PHP 8.3.23 | Generation time: 0 |
proxy
|
phpinfo
|
Settings