detain/osrs-toolkit-php

OpenSRS PHP 工具包

4.0.1 2016-02-25 18:50 UTC

This package is auto-updated.

Last update: 2024-09-02 19:41:13 UTC


README

构建这些库的目的是为了帮助简化 OpenSRS API 的实现。它不仅为开发应用程序提供了起点,以便快速集成,还集成了新的通信标记语言,如 JSON 和 YAML。

支持

我们的支持团队将能够帮助解决以下概述的一般连接问题:(http://domains.opensrs.guide/docs/troubleshooting

如果您在这个工具包提供的示例中发现了错误,请与 OpenSRS 支持联系,并提供 XML 输出和响应。然而,我们无法帮助您解决与您的网站托管服务提供商的 PHP 配置问题,也无法帮助解决您开发的额外 PHP 代码。如果您需要这方面的帮助,请与网站开发者合作。

需求

此 PHP 库目前支持以 JSON 和 YAML 格式传递数据(它也被扩展到以 XML 和数组格式传递数据)。

OpenSRS PHP Toolkit 需要

注意:最好使用 PHP 5.3+,因为 json_encode 和 json_decode 是在该版本及更高版本中标准化的。如果需要 PHP 5 的早期版本,则需要使用 PECL 上的 php-json 库:http://pecl.php.net/package/json

安装

composer require opensrs/osrs-toolkit-php 

配置

要配置您的 OpenSRS API 设置,请复制示例配置文件 openSRS_config.php.template 并使用您自己的 OpenSRS API 设置进行修改。在使用之前,请确保已经包含您的配置文件。有关更多详细信息,请参阅以下有关引导的章节。

有关更详细的配置信息,请参阅(https://github.com/OpenSRS/osrs-toolkit-php/wiki/Configuration

引导

您可以通过使用 composer 自动加载器和您的 OpenSRS 配置文件来引导 OpenSRS 工具包。例如,如果您的 OpenSRS 配置文件保存为 config/openSRS_config.php,则可以通过运行以下命令进行引导:

require_once('vendor/autoload.php');
require_once('config/openSRS_config.php');

使用工具包

require_once('vendor/autoload.php');
require_once('config/openSRS_config.php');

try {
    $request = new Request();
    $response = $request->process('array', $data);

    // dump raw results
    var_dump($response->resultRaw);

} catch (\OpenSRS\Exception $e){
    // handle exception(s)
}

有关可用的请求和属性,请参阅 OpenSRS API 文档页面

向后兼容性

对于 v4.0.0 之前的用户,已包括向后兼容性,因此您可以继续像以前一样使用工具包。

require_once ("your_root_path/opensrs/openSRS_loader.php");

$data = array (
    "func" => "lookupLookupDomain",
    "data" => array (
        "domain" => "google.com",
    )
);

$osrsHandler = processOpenSRS ("array", $data);

var_dump($osrsHandler);

文档

OpenSRS API 文档页面

OpenSRS/osrs-toolkit-php Wiki