laravel-api-response-formatter/laravel-api-response-formatter.php at main · yudha-dev/laravel-api-response-formatter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<?php

namespace App\Helpers;

/**
 * Format response.
 */
class ResponseFormatter
{
    const CODE_SUCCESS = 200;
    const CODE_ERROR = 400;
    const CODE_UNAUTHORIZED = 401;
    const CODE_NOT_FOUND = 404;
    const CODE_FAILED = 500;
    /**
     * API Response
     *
     * @var array
     */
    protected static $response = [
        'meta' => [
            'code' => 200,
            'status' => 'success',
            'message' => null,
        ],
        'data' => null,
    ];

    protected static function setResponse($data = null, $message = null, $code = self::CODE_SUCCESS)
    {
        self::$response['meta']['code'] = $code;
        self::$response['meta']['message'] = $message;
        self::$response['data'] = $data;

        return response()->json(self::$response, self::$response['meta']['code']);
    }

    /**
     * Give success response.
     */
    public static function success($data = null, $message = null)
    {
        self::$response['meta']['status'] = 'success';
        return self::setResponse($data, $message);
    }

    /**
     * Give error response.
     */
    public static function error($data = null, $message = null, $code = self::CODE_ERROR)
    {
        self::$response['meta']['status'] = 'error';
        return self::setResponse($data, $message, $code);
    }

    /**
     * Give unauthorized response.
     */
    public static function unauthorized($data = null, $message = null, $code = self::CODE_UNAUTHORIZED)
    {
        self::$response['meta']['status'] = 'unauthorized';
        return self::setResponse($data, $message, $code);
    }

    /**
     * Give not found response.
     */
    public static function notFound($data = null, $message = null, $code = self::CODE_NOT_FOUND)
    {
        self::$response['meta']['status'] = 'not found';
        return self::setResponse($data, $message, $code);
    }

    /**
     * Give failed response.
     */
    public static function failed($data = null, $message = null, $code = self::CODE_FAILED)
    {
        self::$response['meta']['status'] = 'failed';
        return self::setResponse($data, $message, $code);
    }
}