Download the PHP package dcarbone/php-consul-api without Composer
On this page you can find all versions of the php package dcarbone/php-consul-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dcarbone/php-consul-api
More information about dcarbone/php-consul-api
Files in dcarbone/php-consul-api
Package php-consul-api
Short Description PHP client for the Consul HTTP API
License Apache-2.0
Homepage https://github.com/dcarbone/php-consul-api
Informations about the package php-consul-api
php-consul-api
PHP client for the Consul HTTP API
This library is loosely based upon the official GO client.
Version Compatibility
PHPConsulAPI Version | Consul Version |
---|---|
0.3.x | 0.6.4 |
0.6.x | 0.7-0.8 |
v1.x | 0.9-current |
v2.x | 0.9-current |
dev-master | current |
Newer versions of the api lib will probably work in a limited capacity with older versions of Consul, but no guarantee is made and backwards compatibility issues will not be addressed.
Composer
This lib is designed to be used with Composer
Require Entry:
Configuration
First, construct a Config. This class is modeled quite closely after the Config Struct present in the Consul API Subpackage.
Default Configuration
If you have defined some of the Consul Environment Variables on your hosts then it would probably be easiest to simply execute the following:
Advanced Configuration
You may alternatively define values yourself:
Configuration Note:
By default, this client will attempt to locate a series of environment variables to describe much of the above configuration properties. See here for a list of the env var names.
For more advanced client configuration, such as proxy configuration, you must construct your own GuzzleHttp client prior to constructing a PHPConsulAPI Config object.
As an example:
When constructing your client, if you are using the GuzzleHttp\Client
object directly or derivative thereof, you may
pass any option listed in the Guzzle Request Options.
Consul
Next, construct a Consul object:
NOTE: If you do not create your own config object, Config::newDefaultConfig() and attempt to locate a suitable HTTP Client.
Once constructed, you interact with each Consul API via it's corresponding Client class:
...as an example.
Current Clients
- ACL
- Agent
- Catalog
- Coordinate
- Event
- Health
- KV
- Operator
- Session
- Status
More will be added as time goes on!
Tests
The testing suite is still in it's infancy, however it is being tested directly against an actual Consul agent. They will be back-filled as time allows. Future plans are to set up a simple cluster to provide a more real-world testing scenario.
All versions of php-consul-api with dependencies
ext-json Version *
dcarbone/gotime Version v0.5.*
dcarbone/gohttp Version v0.3.*
guzzlehttp/guzzle Version ^7.4
guzzlehttp/psr7 Version ^2.4