App\Models\ResponseModel

Complexity

Total Complexity

8

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	3

3 Methods

Rating	Name	Duplication	Size	Complexity
A	success()	0	11	3
A	err()	0	11	3
B	desc()	0	78	2

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\DB;
use Illuminate\Http\Response;

class ResponseModel extends Model
{
    public static function success($statusCode=200, $desc=null, $data=null)
    {
        if (($statusCode>=1000)) {
            $statusCode=200;
        }
        $output=[
             'ret' => $statusCode,
            'desc' => is_null($desc) ? self::desc($statusCode) : $desc,
            'data' => $data
        ];
        return response()->json($output);
    }

    public static function err($statusCode, $desc=null, $data=null)
    {
        if (($statusCode<1000)) {
            $statusCode=1000;
        }
        $output=[
             'ret' => $statusCode,
            'desc' => is_null($desc) ? self::desc($statusCode) : $desc,
            'data' => $data
        ];
        return response()->json($output);
    }

    private static function desc($errCode)
    {
        $errDesc=[

            '200'  => "Successful",
            '201'  => "Partially Successful",
            '403'  => "Forbidden",
            '451'  => "Unavailable For Legal Reasons",

            '1000' => "Unspecified Response", /** Under normal condictions those errors shouldn't been displayed to end users
                                                 *  unless they attempt to do so, some submissions should be intercepted
                                                 *  by the frontend before the request sended
                                                 */
            '1001' => "Internal Sever Error",
            '1002' => "Service Currently Unavailable",
            '1003' => "Missing Params",
            '1004' => "Write/Read Permission Denied",
            '1005' => "Invalid File",
            '1006' => "Invalid length params",
            '1007' => "Invalid parameter passed",
            '1984' => "Ignorance is Strength",

            '2000' => "Account-Related Error",
            '2001' => "Permission Denied",
            '2002' => "Please Login First",
            '2003' => "A user with the same username already exists",
            '2004' => "New passwords do not match",
            '2005' => "Old passwords error",
            '2006' => "Can't find this user",

            '3000' => "Problem-Related Error",
            '3001' => "Problem Not Found",
            '3002' => "Submission Size Limit Exceed(64kb max)",
            '3003' => "Duplicate Problem Solution Submitted",
            '3004' => "Certain Problem Solution not Operatable",
            '3005' => "Copper", // Reserved for Copper in memory of OASIS and those who contributed a lot

            '4000' => "Contest-Related Error",
            '4001' => "Contest Not Found",
            '4002' => "Too Much Problems",
            '4003' => "No Need for Registration",
            '4004' => "Registration Ended",
            '4005' => "Registration Denied",
            '4006' => "AlreadyRegistered",
            '4007' => "A contest cannot be both a public and a practice contest",
            '4008' => "The contest is not over.",
            '4009' => 'Only freeze contest can join scrollboard',
            '4010' => 'Contest Still Under Judging.',

            '5000' => "Status-Related Error",
            '5001' => "Status Not Found",

            '6000' => "Submission-Related Error",
            '6001' => "Cannot Find Available Judgers",
            '6002' => "Sharing Method Not Allowed",
            '6003' => "No Need to Resubmit",

            '7000' => "Group-Related Error",
            '7001' => "Group Not Found",
            '7002' => "Insufficient Clearance",
            '7003' => "No Need to Approve",
            '7004' => "Group Member Not Found",
            '7005' => "Don't play just for fun",//gcode=="create"
            '7006' => "A group with the same gcode already exists",
            '7007' => "Group Problem Tag Exist",
            '7008' => "The group leader cannot leave the group",

            '8000' => "Job-Related Error",
            '8001' => "Job Still Running",

            '9000' => "Abuse-Related Error",
            '9001' => "Abuse Invalid",

            '10000' => "Dojo-Related Error",
            '10001' => "Dojo Cannot Complete",
            '10002' => "Dojo Not Found",
        ];
        return isset($errDesc[$errCode]) ? $errDesc[$errCode] : $errDesc['1000'];
    }
}