Download the PHP package nimiq-community/php-client without Composer
On this page you can find all versions of the php package nimiq-community/php-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nimiq-community/php-client
More information about nimiq-community/php-client
Files in nimiq-community/php-client
Package php-client
Short Description Nimiq RPC Client for PHP
License MIT
Homepage https://github.com/nimiq-community/php-client
Informations about the package php-client
Nimiq PHP Client
PHP implementation of the Nimiq RPC client specs.
Usage
Send requests to a Nimiq node using a NimiqCommunity\RpcClient\NimiqClient
object.
Once we have the client, we can start communicating with the Nimiq node.
If no $config
object is given in constructor it will use same defaults as the Nimiq node defaults.
API
The complete API documentation is available in the /docs
folder.
Check out the Nimiq RPC specs for behind the scene RPC calls.
Installation
The recommended way to install Nimiq PHP Client is with Composer. Composer is a dependency management tool for PHP that allows you to declare the dependencies your project needs and installs them into your project.
You can add Nimiq PHP Client as a dependency using the composer.phar CLI:
Alternatively, you can specify it as a dependency in your project's existing composer.json file:
After installing, you need to require Composer's autoloader:
You can find out more on how to install Composer, configure autoloading, and other best-practices for defining dependencies at getcomposer.org.
Contributions
This implementation was originally contributed by mariofriz.
Please send your contributions as pull requests. Refer to the issue tracker for ideas.
Develop
After cloning the repository, install the dependencies:
All done, happy coding!
Testing
Tests are stored in the /tests
folder and can be run using phpunit:
To run the tests and generate HTML coverage report:
This will generate the report in /coverage
folder. Xdebug is required to generate the coverage report.
Documentation
The documentation in the /docs
folder can generated from the source code:
It will generate a README.md
in Github Markdown format.
License
Apache 2.0