greplab/jsonrpcsmd

使用 JSON-RPC SMD 规范(http://www.simple-is-better.org/json-rpc/jsonrpc20-smd.html)构建可用的服务映射的类。

v0.2.1 2015-01-20 20:38 UTC

This package is not auto-updated.

Last update: 2024-09-28 16:15:27 UTC


README

这个库会反射给定的类,并使用在 simple-is-better.org 发布的提案规范的 v2 版本输出 json。(http://www.simple-is-better.org/json-rpc/jsonrpc20-smd.html)

用法

要开始使用这个库,只需创建一个 Smb 类的实例。这个类是库的核心。你只需要处理这个 Smb。Smb 类只需要知道端点的 URL,即调用将被发送到的位置。你可以通过构造函数传递 URL 或稍后使用 setTarget() 方法设置。但请记住,如果目标未设置,则不能生成 json 映射。

//You can start like this:
$smd = new \Greplab\Jsonrpcsmd\Smd('http://my-website/path/of/the/endpoint');

//Or like that:
$smd = new \Greplab\Jsonrpcsmd\Smd();
$smd->setTarget('http://my-website/path/of/the/endpoint');

规范 URL

如果启用“规范”选项,每个方法将有一个不同的端点,由默认端点 URL 加上服务和方法的名称组成。这对于使用像 firebug 这样的工具来监控 AJAX 调用很有用。这样,每个调用都很容易识别,但需要服务器识别并识别这个最后的部分作为服务和方法的路径。此选项默认禁用。

要更改此设置,请使用:$smd->setUseCanonical(true);

添加类

要索引一个类,简单地执行

$smd->addClass('ClassNameToIndex');

你必须为每个想要索引的类调用此方法。

构建 json 映射

要获取 json 映射,只需将 Smd 实例打印到浏览器中。如果您想在发送到浏览器之前获取 json,请使用 toJson() 方法。

$json = $smd->toJson();
print($json);

许可证

这个库是开源软件,许可协议为 MIT 许可证