horcrux/handleresponse

package to handle response

v1.0 2022-10-08 18:22 UTC

Requires (Dev)

• orchestra/testbench: ^6.25

MIT

• youssefshibl

README

horcrux-handleresponse is small laravel package handle schema of response in laravel

install

composer require horcrux/handleresponse

add config file

php artisan vendor:publish --provider="Horcrux\Handleresponse\HandleresponseServiceProvider" --tag="config"

this will load config file its name "horcruxresponse.php" in config directory the file will be like this

<?php

return [
    'withstatus' => false,
    'default_dirver' => 'default',
    'drivers' => [
        'drivers_name' => [
            'status_key' => 'status',
            'reset_success' => ['data'],
            'reset_error' => ['number', 'message']
        ]
    ]
];

withstatus refere to add status code in the response or not

default_dirver name of default driver or schema you want to use

driver array of drivers you want to use

driver.status_key is status key of state of response true/false

driver.reset_success array of data in success response

driver.reset_error array of data in failed response

using

1- make driver like this

<?php

return [
   'withstatus' => false,
   'default_dirver' => 'profile-api',
   'drivers' => [
       'profile-api' => [
           'status_key' => 'status',
           'reset_success' => [ 'api_number','data'],
           'reset_error' => ['error_number', 'error_message']
       ]
   ]
];

2- make controller and use LaravelResponse

<?php

namespace App\Http\Controllers;

use Horcrux\Handleresponse\Core\Traits\LaravelResponse;
use Illuminate\Http\Request;

class TestController extends Controller
{
   use LaravelResponse;
   public function index()
   {
       return $this->senddata([152 , 'one']);
   }
}

this will return

{ status: true,
  api_number: 152,
  data: "one" }

if you want return error

return $this->senderror([258 , 'user is not found'])

will return

{	
status:	false,
error_number:258,
error_message:"user is not found" }

you can set status code in method like

return $this->senderror([258 , 'user is not found'],500);
// response will return with 500 status code

as well as you can set dirver name if you want to change default driver in some response

return $this->senderror([258 , 'user is not found'],500 , 'other_driver');

another method to change driver

$this->change_driver('other_driver');
return $this->senderror([258 , 'user is not found']);

method to send success only

return $this->sendsuccess();

will return

{status:true}

custom your function

to custom your function make function start with h_ like this

<?php

return [
    'withstatus' => false,
    'default_dirver' => 'profile-api',
    'drivers' => [
        'profile-api' => [
            'status_key' => 'status',
            'reset_success' => ['api_number', 'data'],
            'reset_error' => ['error_number', 'error_message'],
            'h_profile' => ['profile_id', 'profil_name', 'data'],
        ]
    ]
];

to use in in controller make like this

<?php

namespace App\Http\Controllers;

use Horcrux\Handleresponse\Core\Traits\LaravelResponse;

class TestController extends Controller
{
    //
    use LaravelResponse;
    public function index()
    {
        return $this->h_profile([252, 'youssef', [
            'one' => 'one',
            'two' => 'two'
        ]]);
        //return $this->h_profile([data_array], status_code, driver_name)
    }
}

the response will return

{
    profile_id: 252,
    profil_name: "youssef",
    data: { one: "one", two: "two" },
}