graphicode/standard

the standard utlities for graphicode laravel team

v3.1 2024-11-29 12:15 UTC

This package is auto-updated.

Last update: 2025-05-29 01:38:51 UTC


README


---

requirements

  • php >=8.0
  • laravel framework >=10.10

----

installation

Use this command to try the package now:

    composer require graphicode/standard v3.0

publish lang files:

    php artisan vendor:publish --tag="gcstandard-lang"

---

ApiResponse Trait

this trait used to make cleen api responses.

preparing your controller to use the trait:

<?php

namespace App\Http\Controllers;

use Graphicode\Standard\Traits\ApiResponses;

class TestController extends Controller
{
    use ApiResponses;

    public function index()
    {
        return $this->okResponse(data: [], message: "hello, api");
    }
}



Available methods:

    /**
    * 200 Ok response
    *
    * @param $data
    * @param $message
    **/
    return $this->okResponse(data: "data", message: "message");

    /**
    * 201 resource created
    *
    * @param $data
    * @param $message
    **/
    return $this->createdResponse(data: "data", message: "message");

    /**
    * 400 bad response
    *
    * @param $data
    * @param $message
    **/
    return $this->badResponse(data: "data", message: "message");

    /**
    * 201 unauthorized
    *
    * @param $data
    * @param $message
    **/
    return $this->unauthenticatedResponse(data: "data", message: "message");