nekofar/slim-jsend

Slim Framework response helper for JSend specification.

v1.0.0-alpha.21 2023-07-01 17:52 UTC

Requires

• php: >=8.1
• ext-json: *
• slim/http: ^1.3
• slim/psr7: ^1.6
• slim/slim: ^4.11

Requires (Dev)

• nekofar/dev-tools: ^3.1
• phpstan/phpstan-phpunit: ^1.0
• phpstan/phpstan-strict-rules: ^1.0
• roave/security-advisories: dev-latest

MIT

• Milad Nekofar

README

Slim Framework response helper for JSend specification.

Installation

To get started, install the package using composer:

composer require nekofar/slim-jsend

Requires Slim Framework 4 and PHP 8.1 or newer.

Usage

use Nekofar\Slim\JSend\ResponseFactoryDecorator;

$responseFactoryDecorator = new ResponseFactoryDecorator(/* ... */);
$response = $responseFactoryDecorator->createResponse();

// Set success payload
$response = $response->withSuccessPayload($data);
echo $response->getBody()->getContents(); // The response body

The resulting response will have the HTTP status code 200 OK and the JSON payload in the JSend format:

{
  "status": "success",
  "data": {
    /* Your data here */
  }
}

Contributing

Please see CONTRIBUTING for details.

License

The MIT License (MIT). Please see License File for more information.