themallen/jsend

JSend 是一个库,旨在通过使用超级简单的 JSend 规范,使 RESTful 响应的数据输出变得简单且容易。

dev-master 2015-01-06 23:34 UTC

This package is not auto-updated.

Last update: 2024-09-24 02:59:32 UTC


README

JSend

这个轻量级的 JSend 库的构建是因为我需要一个简单的方法来编写 REST 查询的响应。我希望使用一个简单明了的标准,并在 JSend 中找到了一个。我尽力为其创建了一个类似 jQuery 的流畅接口。基本上,一切都是可链式的,并且变异器是获取/设置的混合体。

待办事项:将 jSend 输出传递给 jSend 构造函数的能力几乎肯定是一个好主意。在许多情况下,它们将由 JavaScript 处理,但有时多个 PHP 进程可能需要相互发送 JSON。

更新

  • 增加了安全前缀。

安装

对于 composer,将 "themallen/jsend": "dev-master" 添加到您的 require 对象中。

对于其他人,只需将仓库通过 git clone 复制到您希望的目标文件夹,并将其添加到您正在使用的任何 include_path 或自动加载解决方案中。例如,在 codeigniter 中,您将安装到 application/libraries 文件夹。

示例使用

手动配置 jSend

您只需使用变异器并传递所需的数据。由于 __toString() 自动进行 json_encode,因此您可以直接在响应中输出对象。

    <?php
       $jSend = new \themallen\JSend();

       echo $jSend->data(array(...))
             ->message('some message');
             ->status('success');
             ->output();

快捷函数

您不必是 Ruby 开发者也能欣赏一行的代码。 JSend 有一些快捷方法,可以轻松生成常见的消息格式。快捷方式是可链式的,因此只要您不需要太多花哨的操作,您就可以一行创建并输出 jSend 对象。

  • success($data) 将状态设置为 success 并将任何输入传递到 data 字段。
       echo (new JSend())->success(array(...));
  • fail 将状态设置为 fail 并将任何输入传递到 message 字段。
       echo (new JSend())->fail('You messed up!');
  • error 将状态设置为 error 并将任何输入传递到 message 字段。
       echo (new JSend())->error('We messed up!');

从 jSend 中获取值。

您可以使用任何变异器方法来访问属性值。

       $jSend = new \themallen\JSend();

       echo $jSend->data(array('messageId' => $generator->makeAnId()))
                   ->message('some message');
                   ->status('success');
                   ->output();
       $db->store($jSend->data()['messageId']);

贡献

如果您想使这个项目变得更好,请随时提交一个 pull request!即使是测试或其他一些内容也会非常棒。

许可证

我几乎把我制作的所有东西都考虑在 Don't Be a Dick 许可证下。