globalxtreme/response

GlobalXtreme 响应模式

v2.0.0 2024-06-10 10:19 UTC

README

Version Total Downloads License

使用 composer 安装

要使用 Composer 安装,只需要求此包的最新版本。

composer require globalxtreme/response

使用方法

  • 使用命令安装自定义常量错误/成功和助手。
    php artisan globalxtreme:response-install 
  • 将助手文件路径 app/Packages/Response/Status/globals.php 复制到 composer.json
    {
        "autoload": {
            "files": [
                "app/Packages/Response/Status/globals.php"
            ]
        }
    } 
  • 您可以在 app/Packages/Response/Status/globals.php 中添加自定义的助手函数用于错误/成功响应
    use App\Packages\Response\Constant\Error;
    
    if (!function_exists("errTestingCustom")) {
        function errTestingCustom($internalMsg = "")
        {
            error(Error::DEFAULT, $internalMsg);
        }
    }
  • 在控制器中使用 response
    use App\Http\Controllers\Controller;
    use App\Models\Custom;
    use GlobalXtreme\Parser\Parser;
    use GlobalXtreme\Response\Response;
    use GlobalXtreme\Response\Status;
    
    class CustomController extends Controller
    {
        public function testing() 
        {
            // Get more than one data
            $customs = Custom::get();
            
            // Display data auto call parser from Response package 
            $results = success($customs);
    
            // Display data using parser class
            $result = success(Parser::get($customs));
    
    
            // Get one data
            $custom = Custom::first();
            
            // Display data auto call parser from Response package
            $result = success($custom);
    
            // Display data using parser class
            $result = success(Parser::first($custom));
    
    
            // Get data with pagination
            $customs = Custom::paginate(10);
            
            // Display data auto call parser from Response package 
            $results = success($customs);
    
            // Display data using parser class and manual process pagination
            $results = success(Parser::get($customs), pagination: pagination($customs));
    
            // Display response using Response::class
            $status = new Status(true);
    
            // You can choose response type json/object
            $results = Response::json($status, $customs);
            $results = Response::object($status, $customs);
        }
    }