awaiskhan18/resman

ResMan是一个PHP类,它提供了一个方便的方式来处理带有标准状态码和响应结构的API响应。它包括处理验证错误、成功响应和失败响应的方法。

v1.0 2023-07-21 11:28 UTC

This package is not auto-updated.

Last update: 2024-09-14 15:37:31 UTC


README

ResMan是一个PHP类,它提供了一个方便的方式来处理带有标准状态码和响应结构的API响应。它包括处理验证错误、成功响应和失败响应的方法。

安装

要在项目中使用ResMan,您可以通过Composer安装它。在终端中运行以下命令

composer require awaiskhan18/resman

使用方法

首先,将ResMan类导入到您的PHP文件中


use Awaiskhan18\ResMan;

处理验证错误

要处理验证错误,您可以使用ResMan类的validationHandler方法。它接受一个验证器对象作为参数,并返回一个带有适当状态码和错误信息的JSON响应。


// Example usage of validationHandler
$validator = Validator::make($data, $rules);

if ($validator->fails()) {
    return ResMan::validationHandler($validator);
}

处理成功响应

要处理成功响应,您可以使用ResMan类的successHandler方法。它接受响应数据和状态描述作为参数,并返回一个带有成功状态码(200)和提供的数据的JSON响应。


// Example usage of successHandler
$data = [
    'user' => [
        'name' => 'John Doe',
        'email' => '[email protected]',
    ],
];

$statusDescription = 'Data retrieved successfully';

return ResMan::successHandler($data, $statusDescription);

常量

ResMan包括以下常量,可用于表示不同的HTTP状态码

ResMan::STATUS_SUCCESS (200) - Represents a successful response.
ResMan::STATUS_ERROR (401) - Represents an error response.

许可

此软件包是开源软件,根据MIT许可证授权。有关更多信息,请参阅LICENSE文件。