sircamp/response

一个允许您拥有类似 Bootstrap 的 REST 响应对象的包

1.5 2015-09-03 07:05 UTC

This package is not auto-updated.

Last update: 2024-09-28 17:33:18 UTC


README

此包允许您使用类似 Bootstrap 的 Alert(如:信息、警告、错误、成功)来拥有一个“类似 Bootstrap”的 REST 响应对象。

使用此包,您只需将正确的响应对象返回到您的视图或您的 REST 响应中,您可以在不使用任何 IF 语句的情况下设置正确的 Bootstrap 警报类型。此外,在您创建的每个响应对象中,您可以设置一条消息和一个包含所有数据的 data 负载数组。

安装

在您的根项目目录中输入

composer require sircamp/response

根据您的 composer.json 文件,您将获得正确的版本(稳定或开发版)

用法

在每个使用 Sircamp\Response 对象的文件中,您必须添加正确的命名空间。

use Sircamp\Response\InfoResponse as InfoResponse;
use Sircamp\Response\WarningResponse as WarningResponse;
use Sircamp\Response\SuccessResponse as SuccessResponse;
use Sircamp\Response\DangerResponse as DangerResponse;

new Response

要创建新的 Response 对象(例如 InfoResponse),您需要两个参数。

一个字符串消息,可以是空的,以及一个名为 data 的数组。

data 数组可以包含您想要的所有内容,对象、字符串等等。

请注意,每种类型的对象都会自动设置 type 字符串参数

  • 对于 InfoResponsetype 属性设置为 info
  • 对于 WarningResponsetype 属性设置为 warning
  • 对于 SuccessResponsetype 属性设置为 success
  • 对于 DangerResponsetype 属性设置为 danger
$data = [
    'object' => new Object('example'),
    'number' => 1,
    'string' => "hello world"
    //etc
];

$message = "I want to say hello world";

$infoResponse = new InfoResponse($data,$message);

getType

此方法返回对象实例的类型

$infoResponse->getType();

setType

此方法设置对象类型

$infoResponse->setType($type);

getMessage

此方法返回对象的消息属性

$infoResponse->getMessage();

setMessage

此方法设置对象的消息属性

$message = "I want to say hello world";
$infoResponse->setMessage($message);

getData

此方法返回对象的数据属性

$infoResponse->getData();

setData

此方法设置对象的数据属性。默认情况下,$data 参数是一个关联数组,包含变量混合

$data = [
    'object' => new Object('example'),
    'number' => 1,
    'string' => "hello world"
    //etc
];
$infoResponse->setData($data);

addAllowedType

这是一个静态方法,允许您添加自定义响应类型。如果您添加自定义类型,您可以在运行时创建一个新的扩展自定义类(具有您希望的类型)。

要创建匿名运行时类,您必须具有 PHP 7

$type = "custom";
BaseResponse::addAllowedType($type);