README

此类可用于管理 API 请求的状态。

要求

要使用此 PHP 类，您需要准备一些东西。

• php 8.0
• composer

如何使用 APIHandler？

要求 APIHandler

如果您已经初始化了 composer，您可以在终端中运行此命令以下载 APIHandler。

$ composer require jessesoeteman/api-handler

要求自动加载器和 APIHandler

您需要在代码中包含自动加载器，然后才能使用 APIReturn 类。

require __DIR__ . '/vendor/autoload.php';

use APIHandler\APIHandler;

基本用法

声明类

首先，您需要初始化类。该类需要一个参数，告诉以下请求类型之一

• get_request
• post_request

在这个例子中，我们将使用 GET 请求。

$apiHandler = new APIHandler(get_request);

如果请求类型不正确，类将输出并退出

{
    "status": "error",
    "errors": [
        "Request method needs to be ...."
    ]
}

错误处理

假设发生了一个错误，我们可以在错误数组中添加该错误。第一个参数可以是字符串或数组，它包含您要添加的错误。第二个参数是布尔值（默认为 false），如果布尔值为 true，则脚本将输出 JSON 对象并退出。

$apiHandler->addError("error 1");
$apiHandler->addError("error 2");

$apiHandler->addError("error 3", true); // <-- Exits here

$apiHandler->addError("error 4");

$apiHandler->addError("error 1");
$apiHandler->addError("error 2");
$apiHandler->addError("error 3");

$apiHandler->APIExitOnError(); // <-- Exits here

$apiHandler->addError("error 4");
$apiHandler->addData([]);
$apiHandler->APIExit();

$apiHandler->addError("error 1");
$apiHandler->addError("error 2");
$apiHandler->addError("error 3");

$apiHandler->addData([]);

$apiHandler->APIExit(); // <-- Exits here

在上面的 3 个示例中，类将输出以下内容并退出脚本

{
    "status": "error",
    "errors": [
        "error 1",
        "error 2",
        "error 3",
    ]
}

成功请求

如果请求成功且没有发生错误，类将输出成功消息

if (false) {
    $apiHandler->addError("error 1"); // Error wont be added.
}
$apiHandler->APIExitOnError(); // <-- Does not exit because there is no error.

$apiHandler->addData({});
$apiHandler->addData([]);
$apiHandler->addData("Hello World!");

$apiHandler->APIExit(); // <-- Exits here

此示例将产生以下输出

{
    "status": "success",
    "data": [
        {},
        [],
        "Hello World!"
    ]
}

许可证

该项目采用 MIT 许可证 - 有关详细信息，请参阅 LICENSE 文件