turksoy/responsebuilder

1.0.6 2021-10-14 17:34 UTC

Requires

• php: ^7.1|^8.0
• laravel/framework: >= 5.4

Requires (Dev)

• phpunit/phpunit: ^8.0

MIT

• Hakan Türksoy

• turksoy
• responsebuilder

README

Installation

You can install the package via composer:

composer require turksoy/responsebuilder

Basic Usage

Add in Handler.php

    use Turksoy\ResponseBuilder\Traits\ResponseBuilderExceptionHandler;

class Handler extends ExceptionHandler
{

    use ResponseBuilderExceptionHandler;
    ...
}

    $user = [
        'id'    => 1,
        'name'  => 'hakan',
        'email' => '[e-mail]'
    ];
    
    $token = 'sakljSDAIASDKJERNMWE';

    return reponseBuilder()
        ->result('user',$user)
        ->result('token',$token)
        ->ok();

{
    "meta": {
        "messages": {
            "success": [],
            "warning": [],
            "error": [],
            "validation_error": []
        }
    },
    "payload": {
        "user": {
            "id": 1,
            "name": "hakan",
            "email": "[e-mail]"
        },
        "token": "sakljSDAIASDKJERNMWE"
    }
}

Add in controler use ResponseBuilder;

    return reponseBuilder()
        ->message('error','User not found!')
        ->badRequest();

{
    "meta": {
        "messages": {
            "success": [],
            "warning": [],
            "error": [
                "User not found!"
            ],
            "validation_error": []
        }
    },
    "payload": null
}

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Hakan Türksoy

License

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

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.