cometbackup/comet-php-sdk

Comet Server API 的 PHP SDK


README

@CometBackup on Twitter MIT License Packagist

Comet Server API 允许您在您的 Comet 服务器上创建和管理客户账户。

Comet Licensing Ltd 在 MIT 许可证 下免费提供此库;您可以在任何 PHP 项目中嵌入它,无论是免费还是商业的,只要在 *.php 文件中保持版权头注释完整。

功能

  • 全面覆盖 Comet Server API 方法、数据结构和常量定义
  • 通过 \Comet\Server 类轻松进行同步 API 请求
  • 支持异步/ Promise 请求的 PSR-7
  • PHP 7.x 类型提示。为了与 PHP 5.x 兼容,请使用 最后一个 v3.x SDK 发布版本

版本兼容性

此库使用 语义版本控制。然而,此库的大部分内容是从特定版本的 Comet 服务器内部协议描述自动生成的;要找到源 Comet 服务器版本,请检查 \Comet\Def::APPLICATION_VERSION 常量。

可以使用较新的 API 库与较旧的 Comet 服务器版本一起使用,但某些功能可能不可用,并且任何新的 API 属性都将不会被 Comet 服务器识别和忽略。

可以使用较旧的 API 库与较新的 Comet 服务器版本一起使用。对应于新 Comet 服务器功能的未知 API 属性将通过 __unknown_properties 系统保留。

入门

通过 Composer 安装

composer require cometbackup/comet-php-sdk

列出所有用户账户

<?php

require 'vendor/autoload.php'; // Load Composer classes

$server = new \Comet\Server("http://127.0.0.1:8060/", "admin", "admin");

$accounts = $server->AdminListUsers();

var_dump($accounts);

运行包测试

此包使用 PHPUnit 进行测试。

  1. phpunit.xml.dist 文件复制到 phpunit.xml,并修改 COMET_SERVER 变量以指向您的测试 Comet 服务器
  2. 运行 phpunit

检查所有 PHP 文件

find ./Comet/ -name '*.php' -exec php -l {} \;

获取帮助

欢迎在 GitHub 上提交错误报告和拉取请求 https://github.com/CometBackup/comet-php-sdk

您还可以通过 cometbackup.com 的票据系统提交问题。