adaiasmagdiel / easy-response
一个PHP类,旨在简化HTTP响应,使处理请求和提供适当内容变得更加容易。
v1.0.0
2024-04-10 02:04 UTC
Requires (Dev)
- pestphp/pest: ^2.34
README
Easy Response是一个PHP库,旨在简化HTTP响应,使处理请求和提供适当内容变得更加容易。此库提供了一个简单直观的界面来创建和发送HTTP响应,包括HTML、JSON和重定向。
目录
安装
要安装Easy Response,您可以使用Composer。在您的项目目录中运行以下命令:
composer require adaiasmagdiel/easy-response
使用
基本用法
要使用Easy Response,首先需要将库包含到您的项目中。然后,您可以创建一个新的Response
对象,并使用其方法设置响应体、状态码和头信息。最后,您可以使用send
方法发送响应。
<?php require 'vendor/autoload.php'; use AdaiasMagdiel\EasyResponse\Response; $response = new Response(); $response->setBody("Hello, World!") ->setStatusCode(200) ->setHeader("Content-Type", "text/plain"); $response->send();
HTML响应
要发送HTML响应,可以使用html
方法。此方法自动将Content-Type
头设置为text/html
。
$response->html("<h1>Hello, World!</h1>");
JSON响应
对于JSON响应,请使用json
方法。此方法自动将Content-Type
头设置为application/json
。
$response->json(["message" => "Hello, World!"]);
重定向
要将用户重定向到另一个URL,请使用redirect
方法。您可以指定重定向是否为永久(HTTP 301)或临时(HTTP 302)。默认情况下,所有重定向都是临时的。
$response->redirect("https://example.com", true); // Permanent redirect
类概述
构造函数
- $body (字符串): 响应体。
- $statusCode (整数): 响应状态码。
- $headers (数组): 响应头信息。
方法
- getBody(): 获取响应体。
- getStatusCode(): 获取响应状态码。
- getHeaders(): 获取响应头信息。
- setStatusCode(int $statusCode): 设置响应状态码。
- setHeader(string $header, string $value): 设置单个头信息。
- setHeaders(array $headers): 设置多个头信息。
- setBody(string $body): 设置响应体。
- send(): 以状态码、头信息和体发送响应。
- html(string $content): 渲染HTML响应。
- json(array $data): 渲染JSON响应。
- redirect(string $location, bool $permanent = false): 带有可选永久标志的重定向到新位置。
测试
Easy Response包括一系列单元测试,以确保库按预期工作。要运行测试,您可以使用Pest PHP。
./vendor/bin/pest
贡献
欢迎贡献。
许可证
Easy Response遵循MIT许可证。有关更多详细信息,请参阅LICENSE文件。