razonyang/jsend

JSend port for PHP

1.0.0 2019-08-20 09:35 UTC

Requires

• php: ^7.1

Requires (Dev)

• phpunit/phpunit: ^7

BSD-3-Clause

• Razon Yang

• jsend
• rest-api
• restful-api

README

The package is a PHP's implementation of JSend specification.

Installation

composer require razonyang/jsend

Usage

// generates resposne payload.
$payload = PayloadFactory::success($data); // success payload.
// $payload = PayloadFactory::fail($data); // fail payload.
// $payload = PayloadFactory::error($message, $code, $data); // error payload, the code and data are optional.

// if the factory is not suite for your case, creates payload instance directly.
// $payload = (new Payload())->setStatus($status)->setData($data);

// sends response.
echo $payload->toString($options); // the options the second parameter of json_encode, default to JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES

// the payload can also be formatted like this(same effect as above):
// echo json_encode($payload->toArray(), JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);

Integration

• Yii2 JSend - JSend port for Yii2