cometbackup / comet-php-sdk
PHP SDK for the Comet Server API
Installs: 5 388
Dependents: 0
Suggesters: 0
Security: 0
Stars: 9
Watchers: 4
Forks: 2
Open Issues: 1
Requires
- php: >=7.0
- ext-curl: *
- ext-json: *
- guzzlehttp/guzzle: ^6|^7
Requires (Dev)
- phpunit/phpunit: ^8
- dev-master
- v4.37.0
- v4.36.0
- v4.35.0
- v4.34.0
- v4.33.0
- v4.32.0
- v4.31.0
- v4.30.0
- v4.29.0
- v4.28.0
- v4.27.0
- v4.26.0
- v4.25.0
- v4.24.0
- v4.23.0
- v4.22.0
- v4.21.0
- v4.20.0
- v4.19.0
- v4.18.0
- v4.17.0
- v4.16.0
- v4.15.0
- v4.14.0
- v4.13.0
- v4.12.0
- v4.11.0
- v4.10.0
- v4.9.0
- v4.8.0
- v4.7.0
- v4.6.0
- v4.5.0
- v4.4.0
- v4.3.0
- v4.2.0
- v4.1.0
- v4.0.0
- v3.25.0
- v3.24.0
- v3.23.0
- v3.22.0
- v3.21.0
- v3.20.0
- v3.19.0
- v3.18.0
- v3.17.0
- v3.16.0
- v3.15.0
- v3.14.0
- v3.13.0
- v3.12.0
- v3.11.0
- v3.10.0
- v3.9.0
- v3.8.0
- v3.7.0
- v3.6.0
- v3.5.0
- v3.4.0
- v3.3.0
- v3.2.0
- v3.1.0
- v3.0.0
- v2.7.0
- v2.6.0
- v2.5.4
- v2.5.3
- v2.5.2
- v2.5.1
- v2.5.0
- v2.4.0
- v2.3.2
- v2.3.1
- v2.3.0
- v2.2.0
- v2.1.0
- v2.0.0
- v1.1.0
- v1.0.1
- v1.0.0
This package is auto-updated.
Last update: 2024-10-28 23:01:02 UTC
README
The Comet Server API allows you to create and manage customer accounts on your Comet Server.
Comet Licensing Ltd makes this library freely available under the MIT license; you may embed it in any PHP project, either free or commercial, as long as the copyright header comment remains intact in the *.php
files.
Features
- Full coverage of Comet Server API methods, data structures, and constant definitions
- Easy synchronous API requests via the
\Comet\Server
class - PSR-7 support for asynchronous / Promise requests
- PHP 7.x type hints. For PHP 5.x compatibility, please use the last v3.x SDK release.
Version compatibility
This library uses Semantic Versioning. However, large parts of this library are autogenerated from internal protocol descriptions from a specific version of Comet Server; to find the source Comet Server version, check the \Comet\Def::APPLICATION_VERSION
constant.
Newer API libraries can be safely used with older versions of Comet Server, however some features may be unavailable, and any new API properties will be unrecognised and ignored by the Comet Server.
Older API libraries can be safely used with newer versions of Comet Server. Unknown API properties corresponding to new Comet Server features will be preserved via the __unknown_properties
system.
Getting Started
Install via Composer:
composer require cometbackup/comet-php-sdk
List all user accounts:
<?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);
Running package tests
This package uses PHPUnit for testing.
- Copy the
phpunit.xml.dist
file tophpunit.xml
and modify theCOMET_SERVER
variables to point at your test Comet Server - Run
phpunit
Lint all PHP files:
find ./Comet/ -name '*.php' -exec php -l {} \;
Getting Help
Bug reports and pull requests are welcome on GitHub at https://github.com/CometBackup/comet-php-sdk.
You may also submit issues via the ticket system at cometbackup.com.