README

This PHP library helps to generate global standard response in JSON and Array for client (API Client, POS Client, Web Client etc). It is not framework dependent, you are open to use it with any PHP project.

Why to use this library

This library is a standard formatted schema to response, you don't need to make a document for every web service, just refer to this.
This library works logically, you must respect standards.
It is framework free and if you want it to use with any framework then you can. It has Laravel & Lumen build-in support as described below.

Installation

Via composer command

composer require farhanwazir/makeresponse

Or add below line in your composer.json and run composer update command

"farhanwazir/makeresponse" : "1.*"

Laravel & Lumen Configuration

Laravel user's

For Laravel user's can add below line in config/app.php

'providers' => [
    ...
    FarhanWazir\MakeResponse\MakeResponseServiceProvider::class
    ...
]

Do not close config/app, go down inside "aliases"

'aliases' => [
    ...
    'MakeResponse' => FarhanWazir\MakeResponse\Facade\MakeResponse::class
    ...
]

Lumen user's

For Lumen user's can add below line in bootstrap/app.php

$app->register(FarhanWazir\MakeResponse\MakeResponseServiceProvider::class);

Add alias as facade in laravel

if (!class_exists('MakeResponse')) {
    class_alias(FarhanWazir\MakeResponse\Facade\MakeResponse::class, 'MakeResponse');
}

Usage

You just need to call makeResponse() helper function to respond to request. Below listed available methods will help you to explorer MakeResponse.

setStatus(numeric) set numeric value with positive or negative
setMessage(string) set string message not big string, it is for short message
setErrors(sting|array) set string or array for errors
setResult(string|array) set string or array for result parameter of your response
set(status, result, errors, message) set method for set response parameters once
get() get formatted response collection
get()->toArray() convert collection in array
get()->toJson() convert collection in json

Use via helper function

makeResponse($status, $result, $errors, $message, $array);

$status must be numeric positive or negative.
$result string or array. Default null
$errors string or array. Default null
$message one line string. Default null
$array boolean, it is belongs to returning response (in array or json). Default true

Get response example

Example 1: Get formatted response in array

makeResponse(1, ['id' => 1, 'name' => 'Farhan Wazir']);

/** Output
[
    'status' => 1,
    'result' => ['id' => 1, 'name' => 'Farhan Wazir']
]
*/

Example 2: Get formatted response in json

makeResponse()->setStatus(0)->setErrors('You provided input is wrong.')->get();
/** Output
{
    'status' : 0,
    'errors' : ['You provided input is wrong.']
}
*/

//OR
makeResponse(1, ['id' => 1, 'name' => 'Farhan Wazir'], null, null, false);
/** Output
{
    'status' : 1,
    'errors' : ['id' => 1, 'name' => 'Farhan Wazir']
}
*/

Example 3: Verify formatted response to client

//Response will be in array
makeResponse(1);
/** Output
[
    'status' => 1
]
*/

//Response will be in json
makeResponse(1, null, null, null, false);
/** Output
{
    'status' : 1
}
*/

Example 4: Convert response in array

// makeResponse()->toArray() converts into array and same for json by toJson()
makeResponse()->setStatus(0)->setErrors('You provided input is wrong.')->get()->toArray();

Example 5: Direct class call approach

$response = new FarhanWazir\MakeResponse\Response();
$response->setStatus(1)->setMessage('Make you feel comfortable');
$response->setResult( array('id' => 1, 'name' => 'Make Responder') );


print $response->get(); //or $response->get()->toJson();
/** Output
{
    'status' : 1,
    'message' : 'Make you feel comfortable',
    'result' : ['id' => 1, 'name' => 'Make Responder']
}
*/

//convert response in array
print_r($response->get()->toArray());
[
    'status' => 1,
    'message' => 'Make you feel comfortable',
    'result' => ['id' => 1, 'name' => 'Make Responder']
]

Laravel and Lumen user's

You can also use above illustrated example and below is for Laravel and Lumen style:

//Response will be in json
MakeResponse::set(1, ['id' => 1, 'name' => 'Farhan Wazir'])->get();

//Response will be in array
MakeResponse::set(0, null, 'Your input is wrong', 'Input error')->get()->toArray();

farhanwazir / makeresponse

Maintainers

Details