Giter VIP home page Giter VIP logo

jsend's Introduction

JSend

Build Status Code Climate Test Coverage

A tiny PHP library that generates JSON responses based on the original JSend specification.

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.

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

Installation

Install JSend via Composer:

$ composer require evandarwin/jsend

Usage

You can use JSend like so:

<?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:

{
  "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
<?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.

jsend's People

Contributors

evandarwin avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.