Merge pull request #10 from vinkla/patch-1

Add syntax highlighting

Author: tjlytle

README.md

@@ -18,23 +18,31 @@ To use the client library you'll need to have [created a Nexmo account][signup].
 
 To install the PHP client library using Composer:
 
-    composer require nexmo/client
+```bash
+composer require nexmo/client
+```
 
 Alternatively you can clone the repository, however, you'll need to ensure the library is autoloaded by a PSR-0 or PSR-4
 compatible autoloader.
 
-    git clone [email protected]:Nexmo/nexmo-php.git
+```bash
+git clone [email protected]:Nexmo/nexmo-php.git
+```
 
 Usage
 -----
 
 If you're using composer, make sure the autoloader is included in your project's bootstrap file:
 
-    require_once "vendor/autoload.php";
+```php
+require_once "vendor/autoload.php";
+```
 
 Create a client with your API key and secret:
 
-    $client = new Nexmo\Client(new Nexmo\Credentials\Basic(API_KEY, API_SECRET));     
+```php
+$client = new Nexmo\Client(new Nexmo\Credentials\Basic(API_KEY, API_SECRET));     
+```
 
 Examples
 --------
@@ -45,43 +53,57 @@ To use [Nexmo's SMS API][doc_sms] to send an SMS message, call the `$client->mes
 
 The API can be called directly, using a simple array of parameters, the keys match the [parameters of the API][doc_sms].
 
-    $message = $client->message()->send([
-        'to' => NEXMO_TO,
-        'from' => NEXMO_FROM,
-        'text' => 'Test message from the Nexmo PHP Client'
-    ]);
+```php
+$message = $client->message()->send([
+    'to' => NEXMO_TO,
+    'from' => NEXMO_FROM,
+    'text' => 'Test message from the Nexmo PHP Client'
+]);
+```
 
 The API response data can be accessed as array properties of the message. 
 
-    echo "Sent message to " . $message['to'] . ". Balance is now " . $message['remaining-balance'] . PHP_EOL;
+```php
+echo "Sent message to " . $message['to'] . ". Balance is now " . $message['remaining-balance'] . PHP_EOL;
+```
 
 **A message object** is a more expressive way to create and send messages. Each message type can be constructed with the 
 required parameters, and a fluent interface provides access to optional parameters.
 
-    $text = new \Nexmo\Message\Text(NEXMO_TO, NEXMO_FROM, 'Test message using PHP client library');
-    $text->setClientRef('test-message')
-         ->setClass(\Nexmo\Message\Text::CLASS_FLASH);
+```php
+$text = new \Nexmo\Message\Text(NEXMO_TO, NEXMO_FROM, 'Test message using PHP client library');
+$text->setClientRef('test-message')
+     ->setClass(\Nexmo\Message\Text::CLASS_FLASH);
+```
 
 The message object is passed to the same `send` method:
 
-    $client->message()->send($text);
+```php
+$client->message()->send($text);
+```
 
 Once sent, the message object can be used to access the response data.
 
-    echo "Sent message to " . $text->getTo() . ". Balance is now " . $text->getRemainingBalance() . PHP_EOL;
+```php
+echo "Sent message to " . $text->getTo() . ". Balance is now " . $text->getRemainingBalance() . PHP_EOL;
+```
 
 Array access can still be used:
 
-    echo "Sent message to " . $text['to'] . ". Balance is now " . $text['remaining-balance'] . PHP_EOL;
+```php
+echo "Sent message to " . $text['to'] . ". Balance is now " . $text['remaining-balance'] . PHP_EOL;
+```
 
 If the message text had to be sent as multiple messages, by default, the data of the last message is returned. However,
 specific message data can be accessed using array notation, passing an index to a getter, or iterating over the object.
 
-    $text[0]['remaining-balance']
-    $text->getRemainingBalance(0);
-    foreach($text as $index => $data){
-        $data['remaining-balance'];
-    }
+```php
+$text[0]['remaining-balance']
+$text->getRemainingBalance(0);
+foreach($text as $index => $data){
+    $data['remaining-balance'];
+}
+```
 
 The [send example][send_example] also has full working examples.
 
@@ -90,32 +112,40 @@ The [send example][send_example] also has full working examples.
 Inbound messages are [sent to your application as a webhook][doc_inbound], and the client library provides a way to 
 create an inbound message object from a webhook:
 
-    $inbound = \Nexmo\Message\InboundMessage::createFromGlobals();
-    if($inbound->isValid()){
-        error_log($inbound->getBody());
-    } else {
-        error_log('invalid message');
-    }
+```php
+$inbound = \Nexmo\Message\InboundMessage::createFromGlobals();
+if($inbound->isValid()){
+    error_log($inbound->getBody());
+} else {
+    error_log('invalid message');
+}
+```
 
 You can also access the webhook data as an arry:
 
-    $inbound = \Nexmo\Message\InboundMessage::createFromGlobals();
-    error_log($inbound['to']);
+```php
+$inbound = \Nexmo\Message\InboundMessage::createFromGlobals();
+error_log($inbound['to']);
+```
 
 ### Fetching A Message
 
 You can retrieve a message log from the API using the ID of the message:
 
-    $message = $client->message()->search('02000000DA7C52E7');
-    echo "The body of the message was: " . $message->getBody();
+```php
+$message = $client->message()->search('02000000DA7C52E7');
+echo "The body of the message was: " . $message->getBody();
+```
 
 If the message was sent to a Nexmo virtual number, the object will be an instance of `Nexmo\Message\InboundMessage`, if 
 the message was sent from your account, it will be an instance of `Nexmo\Message\Message`. You can also pass a message 
 object to the client:
 
-    $message = new \Nexmo\Message\InboundMessage('02000000DA7C52E7');
-    $client->message()->search($message);
-    echo "The body of the message was: " . $message->getBody();
+```php
+$message = new \Nexmo\Message\InboundMessage('02000000DA7C52E7');
+$client->message()->search($message);
+echo "The body of the message was: " . $message->getBody();
+```
 
 ### Starting a Verification
 
@@ -124,57 +154,71 @@ or implement second factor authentication during signin.
 
 You can start a verification process using a simple array:
 
-    $verification = $client->verify()->start([
-        'number' => '14845551212',
-        'brand'  => 'My App'
-    ]);
-    echo "Started verification with an id of: " . $verification->getRequestId();
+```php
+$verification = $client->verify()->start([
+    'number' => '14845551212',
+    'brand'  => 'My App'
+]);
+echo "Started verification with an id of: " . $verification->getRequestId();
+```
 
 Or you can pass the client a verification object:
 
-    $verification = new \Nexmo\Verify\Verification('14845551212', 'My App');
-    $client->verify()->start($verification);
-    echo "Started verification with an id of: " . $verification->getRequestId();
+```php
+$verification = new \Nexmo\Verify\Verification('14845551212', 'My App');
+$client->verify()->start($verification);
+echo "Started verification with an id of: " . $verification->getRequestId();
+```
 
 ### Controlling a Verification
 
 To cancel an in-progress verification, or to trigger the next attempt to send the confirmation code, you can pass 
 either an exsisting verification object to the client library, or simply use a request ID:
 
-    $client->verify()->trigger('00e6c3377e5348cdaf567e1417c707a5');
-    
-    $verification = new \Nexmo\Verify\Verification('00e6c3377e5348cdaf567e1417c707a5');
-    $client->verify()->cancel($verification);
+```php
+$client->verify()->trigger('00e6c3377e5348cdaf567e1417c707a5');
+
+$verification = new \Nexmo\Verify\Verification('00e6c3377e5348cdaf567e1417c707a5');
+$client->verify()->cancel($verification);
+```
 
 ### Checking A Verification
 
 In the same way, checking a verification requires the code the user provided, and an exiting verification object:
 
-    $verification = new \Nexmo\Verify\Verification('00e6c3377e5348cdaf567e1417c707a5');
-    $client->verify()->check($verification, '1234');
+```php
+$verification = new \Nexmo\Verify\Verification('00e6c3377e5348cdaf567e1417c707a5');
+$client->verify()->check($verification, '1234');
+```
 
 Or a request ID:
 
-    $client->verify()->check('00e6c3377e5348cdaf567e1417c707a5', '1234');
+```php
+$client->verify()->check('00e6c3377e5348cdaf567e1417c707a5', '1234');
+```
 
 ### Searching For A Verification
 
 You can check the status of a verification, or access the results of past verifications using either an exsisting 
 verification object, or a request ID. The verification object will then provide a rich interface:
 
-    $verification = new \Nexmo\Verify\Verification('00e6c3377e5348cdaf567e1417c707a5');
-    $client->verify()->search($verification);
-    
-    echo "Codes checked for verification: " . $verification->getRequestId() . PHP_EOL;
-    foreach($verification->getChecks() as $check){
-        echo $check->getDate()->format('d-m-y') . ' ' . $check->getStatus() . PHP_EOL;
-    }
+```php
+$verification = new \Nexmo\Verify\Verification('00e6c3377e5348cdaf567e1417c707a5');
+$client->verify()->search($verification);
+
+echo "Codes checked for verification: " . $verification->getRequestId() . PHP_EOL;
+foreach($verification->getChecks() as $check){
+    echo $check->getDate()->format('d-m-y') . ' ' . $check->getStatus() . PHP_EOL;
+}
+```
 
 You can also access the raw API response here using array access:
 
-    $verification = new \Nexmo\Verify\Verification('00e6c3377e5348cdaf567e1417c707a5');
-    $client->verify()->search($verification);
-    echo "Verification cost was: " . $verification['price'] . PHP_EOL;
+```php
+$verification = new \Nexmo\Verify\Verification('00e6c3377e5348cdaf567e1417c707a5');
+$client->verify()->search($verification);
+echo "Verification cost was: " . $verification['price'] . PHP_EOL;
+```
 
 API Coverage
 ------------