2017 © Pedro Peláez
 

project jsend

Basic JSend interface for PHP projects.

image

evandarwin/jsend

Basic JSend interface for PHP projects.

  • Monday, February 8, 2016
  • by EvanDarwin
  • Repository
  • 1 Watchers
  • 0 Stars
  • 3,972 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 7 Versions
  • 9 % Grown

The README.md

JSend

Build Status Code Climate Test Coverage, (*1)

A tiny PHP library that generates JSON responses based on the original JSend specification., (*2)

The specification has been slightly modified to make use for APIs, in which the are now optional code and message attributes. Both are meant to be human readable, and will not show up if not supplied., (*3)

Version 2.x requires PHP 7.2+ If you need support for PHP >= 5.6, use the 1.x branch., (*4)

Installation

Install JSend via Composer:, (*5)

$ composer require evandarwin/jsend

Usage

You can use JSend like so:, (*6)

<?php
use EvanDarwin\JSend\JSendBuilder;

$builder = new JSendBuilder();

// This will return a JSendResponse
$response = $builder->success()
                    ->data(['id' => 3])
                    ->code(12)
                    ->message("Hello")
                    ->get();

// Output the JSON
header('Content-Type: application/json');
echo $response->getResponse();

And the response will be formed like so:, (*7)

{
  "status": "success",
  "message": "Hello",
  "code": 12,
  "data": {
    "id": 3
  }
}

Alternative statuses include: - fail - For when the user has done something wrong, and they should fix it before requesting again. - error - An internal server error or something that's not the issue of the user's request, (*8)

<?php
use EvanDarwin\JSend\JSendBuilder;

// These alternatives statuses can be set like so
$builder = new JSendBuilder();

// For failure
$builder->failed()->get();

// For error
$builder->error()->get();

License

Licensed under the MIT license. See the LICENSE file for information., (*9)

The Versions

08/02 2016

dev-master

9999999-dev

Basic JSend interface for PHP projects.

  Sources   Download

MIT

The Development Requires

json jsend

08/02 2016

1.2.0

1.2.0.0

Basic JSend interface for PHP projects.

  Sources   Download

MIT

The Development Requires

json jsend

11/05 2015

1.1.0

1.1.0.0

Basic JSend interface for PHP projects.

  Sources   Download

MIT

The Development Requires

json jsend

25/04 2015

1.0.2

1.0.2.0

Basic JSend interface for PHP projects.

  Sources   Download

MIT

json jsend

05/03 2015

1.0.1.1

1.0.1.1

Basic JSend interface for PHP projects.

  Sources   Download

MIT

json jsend

05/03 2015

1.0.1

1.0.1.0

Basic JSend interface for PHP projects.

  Sources   Download

MIT

json jsend

05/03 2015

1.0.0

1.0.0.0

Basic JSend interface for PHP projects.

  Sources   Download

MIT

json jsend