vena/jsend4laravel

Simply adds macros to Laravel 4's Response class for JSend-formatting responses.

JSend4Laravel

This is just a simple package to add a few macros to Laravel 4's Response class and extend its json method for JSend-formatted responses., _(*1)

• JSend Specification

Installation

Load the package with composer

Add the package in the require key of your composer.json:, _(*2)

"vena/jsend4laravel": "dev-master"

Update composer to grab the package:, _(*3)

composer update

Add the service provider to the end of your providers array in app/config/app.php:, _(*4)

'providers' => array(
    ...
    'Vena\JSend4Laravel\JSend4LaravelServiceProvider',
);

That's it, no further configuration is necessary., _(*5)

Usage

All macros return a Response object, allowing you to override anything about the response you require. Default HTTP status codes are included and everything eventually goes through the Response::json() method to set the appropriate Content-Type header, but what you do with the Response object is up to you., _(*6)

Response::jsend($data, $httpStatus, $headers)

Wrapper around Response::json(). The response will be sent as JSONP if a 'callback' value is specified in the request input., _(*7)

It's not especially useful to call this by itself, as it will not format the data whatsoever. However, all other JSend4Laravel methods ultimate route through this, which then returns a jsonResponse., _(*8)

• $data: Data to include in the response, defaults to NULL.
• $httpStatus: HTTP status code for the response, defaults to 200.
• $headers: Response headers for the response. JSON responses are always sent with Content-Type: application/json

Returns: Response, _(*9)

Response::jsendSuccess($data, $httpStatus, $headers)

Formats a JSend success response with the supplied data. All parameters are optional., _(*10)

• $data: Data to include in the response, defaults to NULL.
• $httpStatus: HTTP status code for the response, defaults to 200.
• $headers: Response headers for the response.

Returns: Response, _(*11)

Response::jsendFail($data, $httpStatus, $headers)

Formats a JSend fail response. All parameters are optional., _(*12)

• $data: Data to include in the response, defaults to NULL.
• $httpStatus: HTTP status code for the response, defaults to 400.
• $headers: Response headers for the response.

Returns: Response, _(*13)

Response::jsendError($message, $code, $data, $httpStatus, $headers)

Formats a JSend error response with the supplied data., _(*14)

• $message: Required. A meangingful, human-readable message explaining the error.

All other parameters are optional:, _(*15)

• $code: A numeric reference code for the error, if applicable.
• $data: Additional error data to send with the request (stack traces, other debug info). Not included in response if set to NULL (default).
• $httpStatus: HTTP status code for the response, defaults to 400.
• $headers: Response headers for the response.

Returns: Response, _(*16)