nathanmac / responder
Simple PHP Responder Utility Library for API Development
Requires
- php: >=5.3.0
- symfony/yaml: ^2.4|^3.0
Requires (Dev)
- illuminate/support: ^5.0
- phpunit/phpunit: 4.*
- satooshi/php-coveralls: 0.6.*
This package is not auto-updated.
Last update: 2024-10-26 16:38:45 UTC
README
Simple PHP Responder Utility Library for API Development
Installation
Begin by installing this package through Composer. Edit your project's composer.json
file to require Nathanmac/Responder
.
"require": {
"Nathanmac/Responder": "2.*"
}
Next, update Composer from the Terminal:
composer update
Laravel Users
If you are a Laravel user, then there is a service provider that you can make use of to automatically prepare the bindings and such.
// app/config/app.php 'providers' => [ '...', 'Nathanmac\Utilities\Responder\ResponderServiceProvider' ];
When this provider is booted, you'll have access to a helpful Responder
facade, which you may use in your controllers.
public function index() { Responder::json($payload); // Array > JSON Responder::xml($payload); // Array > XML Responder::yaml($payload); // Array > YAML Responder::querystr($payload); // Array > Query String Responder::serialize($payload); // Array > Serialized Object Responder::bson($payload); // Array > BSON Responder::msgpack($payload); // Array > MessagePack }
Responder Functions
$responder->json($payload); // Array > JSON $responder->xml($payload); // Array > XML $responder->yaml($payload); // Array > YAML $responder->querystr($payload); // Array > Query String $responder->serialize($payload); // Array > Serialized Object $responder->bson($payload); // Array > BSON $responder->msgpack($payload); // Array > MessagePack
Respond with Automatic Detection
$responder = new Responder(); $body = array( 'message' => array( 'to' => 'Jack Smith', 'from' => 'Jane Doe', 'subject' => 'Hello World', 'body' => 'Hello, whats going on...' ) ); header("Content-Type: {$responder->getContentType()}"); print $responder->payload($body);
Respond with JSON
$responder = new Responder(); $body = array( 'message' => array( 'to' => 'Jack Smith', 'from' => 'Jane Doe', 'subject' => 'Hello World', 'body' => 'Hello, whats going on...' ) ); header('Content-Type: application/json'); print $responder->json($body);
Respond with XML
$responder = new Responder(); $body = array( 'message' => array( 'to' => 'Jack Smith', 'from' => 'Jane Doe', 'subject' => 'Hello World', 'body' => 'Hello, whats going on...' ) ); header('Content-Type: application/xml; charset=utf-8'); print $responder->xml($body);
Respond with Query String
$responder = new Responder(); $body = array( 'to' => 'Jack Smith', 'from' => 'Jane Doe', 'subject' => 'Hello World', 'body' => 'Hello, whats going on...' ); header('Content-Type: application/x-www-form-urlencoded'); print $responder->querystr($body);
Respond with Serialized Object
$responder = new Responder(); $body = array( 'message' => array( 'to' => 'Jack Smith', 'from' => 'Jane Doe', 'subject' => 'Hello World', 'body' => 'Hello, whats going on...' ) ); header('Content-Type: application/vnd.php.serialized'); print $responder->serialize($body);
Respond with YAML
$responder = new Responder(); $body = array( 'message' => array( 'to' => 'Jack Smith', 'from' => 'Jane Doe', 'subject' => 'Hello World', 'body' => 'Hello, whats going on...' ) ); header('Content-Type: application/x-yaml'); print $responder->yaml($body);
Respond with BSON
$responder = new Responder(); $body = array( 'message' => array( 'to' => 'Jack Smith', 'from' => 'Jane Doe', 'subject' => 'Hello World', 'body' => 'Hello, whats going on...' ) ); header('Content-Type: application/bson'); print $responder->bson($body);
Respond with MessagePack
$responder = new Responder(); $body = array( 'message' => array( 'to' => 'Jack Smith', 'from' => 'Jane Doe', 'subject' => 'Hello World', 'body' => 'Hello, whats going on...' ) ); header('Content-Type: application/x-msgpack'); print $responder->msgpack($body);
Custom Responders/Formatters
You can make your own custom responders/formatters by implementing FormatInterface, the below example demostrates the use of a custom responder/formatter.
use Nathanmac\Utilities\Responder\Formats\FormatInterface; /** * Custom Formatter */ class CustomFormatter implements FormatInterface { /** * Generate Payload Data * * @param array $payload * * @return string * * @throws ResponderException */ public function generate($payload) { $payload; // Raw payload array $output = // Process raw payload array to formatted data return $output; // return data string } }
Using the CustomFormatter
use Acme\Formatters\CustomFormatter; $responder = new Responder(); $generated = $responder->generate(['raw' => 'payload', 'data'], new CustomFormatter());
Register the CustomFormatter
use Acme\Formatters\CustomFormatter; $responder = new Responder(); $responder->registerFormat('application/x-custom-format', 'Acme\Formatters\CustomFormatter'); $responder->payload('application/x-custom-format');
Testing
To test the library itself, run the PHPUnit tests:
phpunit tests/