README

php-epp2

php-epp2 是用现代 PHP 编写的用于高级可扩展提供协议 (EPP) TCP/SSL 的客户端。

在 GPLv3 许可下发布，请自由贡献（分叉、创建有意义的分支名称、使用该分支名称提交拉取请求）！

目录 由 DocToc 生成

• php-epp2
  • 需求
  • 功能
  • 安装
  • 使用
    • 基本客户端连接
    • 创建帧对象
    • 解析响应
  • 未来
  • 致谢
  • 认可
  • 许可

需求

• PHP 5.5+
• php-ext-intl
• php-ext-openssl

功能

• 现代 PHP 标准
  • PSR-1, PSR-2 & PSR-4
  • 无错误和警告（找到它们，我会修复它！）
• 高级使用（即插即用）
• 简化了套接字和 http(s) 连接的客户端（自动登录/注销，自动注入 clTRID）
• SSL (+本地证书)
• 类似于 XPath 的设置器，用于简化复杂 XML 结构的创建
• 基于 XML 的响应，可以通过 XPath 直接遍历
• RFC 5730, RFC 5731, RFC 5732, RFC 5733, RFC 5734 & RFC 3915
• DNSSEC 支持 RFC 5910

安装

通过 Composer

$ composer require africc/php-epp2

使用

查看 examples 文件夹以获取更完整的使用参考。此外，请查看 whmcs-registrars-coza，这是一个用于 WHMCS 的 co.za 区域 注册商模块，该模块使用此库。

基本客户端连接

这将在 connect() 时自动登录，并在 close() 时注销

<?php
require 'vendor/autoload.php';

use AfriCC\EPP\Client as EPPClient;

$epp_client = new EPPClient([
    'host' => 'epptest.org',
    'username' => 'foo',
    'password' => 'bar',
    'services' => [
        'urn:ietf:params:xml:ns:domain-1.0',
        'urn:ietf:params:xml:ns:contact-1.0'
    ],
    'debug' => true,
]);

try {
    $greeting = $epp_client->connect();
} catch(Exception $e) {
    echo $e->getMessage() . PHP_EOL;
    unset($epp_client);
    exit(1);
}

$epp_client->close();

创建帧对象

setXXX() 表示值只能设置一次，重新调用该方法将覆盖上一个值。

addXXX() 表示可以存在多个值，重新调用该方法将添加值。

<?php
require 'vendor/autoload.php';

use AfriCC\EPP\Frame\Command\Create\Host as CreateHost;

$frame = new CreateHost();
$frame->setHost('ns1.example.com');
$frame->setHost('ns2.example.com');
$frame->addAddr('8.8.8.8');
$frame->addAddr('8.8.4.4');
$frame->addAddr('2a00:1450:4009:809::1001');
echo $frame;

// or send frame to previously established connection
$epp_client->sendFrame($frame);

解析响应

您可以通过传递 XPath 直接访问节点，或者使用 data() 方法，该方法将返回关联数组。

use AfriCC\EPP\Frame\Command\Check\Domain as DomainCheck;
use AfriCC\EPP\Frame\Response;

$frame = new DomainCheck();
$frame->addDomain('example.org');
$frame->addDomain('example.net');
$frame->addDomain('example.com');

$response = $epp_client->request($frame);
if (!($response instanceof Response)) {
    echo 'response error' . PHP_EOL;
    unset($epp_client);
    exit(1);
}

$result = $response->results()[0];

echo $result->code() . PHP_EOL;
echo $result->message() . PHP_EOL;
echo $response->clientTransactionId() . PHP_EOL;
echo $response->serverTransactionId() . PHP_EOL;
$data = $response->data();
if (empty($data) || !is_array($data)) {
    echo 'empty response data' . PHP_EOL;
    unset($epp_client);
    exit(1);
}

foreach ($data['chkData']['cd'] as $cd) {
    printf('Domain: %s, available: %d' . PHP_EOL, $cd['name'], $cd['@name']['avail']);
}

自定义 ObjectSpec

如果您正在使用的注册商使用自定义命名空间名称（例如 NASK），则可以使用自定义 ObjectSpec。客户端始终在解码来自 EPP 服务器的响应时使用指定的 ObjectSpec。

您可以按以下方式使用此功能

use AfriCC\EPP\HTTPClient as EPPClient;
use \AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
use AfriCC\EPP\Frame\Command\Poll;

$objectSpec = new NASKObjectSpec();
$config = [
    'host' => 'https://app.registrar.tld',
    'username' => 'user',
    'password' => 'pass',
    'services' => $objectSpec->services,
    'serviceExtensions' => $objectSpec->serviceExtensions,
];

$epp_client = new EPPClient($config, $objectSpec);

$frame = new Poll($epp_client->getObjectSpec());

或者，您可以创建带有自定义 ObjectSpec 的帧

use AfriCC\EPP\Extension\NASK\Update\Future as UpdateFuture;
use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;

$frame = new UpdateFuture(new NASKObjectSpec());
$frame->setFuture('example7.pl');
$frame->changeRegistrant('mak21');
$frame->changeAuthInfo('2fooBAR');
echo $frame;

您还可以创建具有不同 ObjectSpec 的不同客户端，然后您可以在创建任何请求帧时使用 getObjectSpec 方法。

use AfriCC\EPP\ObjectSpec as DefaultObjectSpec;
use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
use AfriCC\EPP\Client as EPPClient;
use AfriCC\EPP\HTTPClient as HTTPEPPClient;
use AfriCC\EPP\Frame\Command\Poll;

//...
$nask_objectspec = new NASKObjectSpec();
$default_objectspec = new DefaultObjectSpec();

$nask_client = new HTTPEPPClient($nask_config, $nask_objectspec);
$http_client = new HTTPEPPClient($http_config, $default_objectspec);
$socket_client = new EPPClient($socket_config, $default_objectspec);
$nask_socket_client = new EPPClient($nask_socket_config, $nask_objectspec);

$nask_poll = new Poll($nask_client->getObjectSpec());
$default_poll = new Poll($socket_client->getObjectSpec());

您还可以通过 setObjectSpec 方法动态更改客户端的 objectSpec。

use AfriCC\EPP\ObjectSpec as DefaultObjectSpec;
use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
use AfriCC\EPP\Client as EPPClient;

//...
$nask_objectspec = new NASKObjectSpec();
$default_objectspec = new DefaultObjectSpec();

$variable_client = new EPPClient($socket_config, $default_objectspec);

//calls to getObjectSpec will return default objectSpec and responses
//will be parsed using default ObjectSpec

$variable_client->setObjectSpec($nask_objectspec);

//calls to getObjectSpec will return NASK objectSpec and responses
//will be parsed using NASK ObjectSpec

未来

• 更严格的响应解析
• 更严格的请求验证
• 使其服务器端可用（与 apache mod_epp 一起使用）

致谢

• Günter Grodotzki
• 所有贡献者

认可

• Gavin Brown（Net_EPP 的原始作者）
• Net_EPP 的所有贡献者

许可

php-epp2 在 GPLv3 许可下发布。请参阅附带文件中的LICENSE，以获取详细信息。