Download the PHP package dcarbone/simple-consul-php without Composer

On this page you can find all versions of the php package dcarbone/simple-consul-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of dcarbone/simple-consul-php

Informations about the package simple-consul-php

php-consul-api

Tests

PHP client for the Consul HTTP API

This library is loosely based upon the official GO client.

PHP Compatibility

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
v3.x 0.9-current
dev-main 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.

V3 Breaking Changes

There are a couple breaking changes between v2 and v3:

  1. The FakeMap class has been removed.
  2. The FakeSlice class has been removed.
  3. The ReadableDuration class has been removed.
  4. All models now have parameterized constructors.
    • The preferred construction style in v3 is constructor named parameters.
    • Legacy construction via associative arrays (new Model(data: [...])) is deprecated and will be removed in v4.
  5. All of that Transcoding nonsense has been removed.
  6. The root Config class may no longer be constructed with a map. You must use constructor parameters.
  7. Map-like fields are represented in PHP as associative arrays (for example, array<string,mixed>); some JSON object inputs may still be accepted as \stdClass at setter boundaries.

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.

Method Naming Note

Unlike the Go SDK, this client generally uses a single base method with an optional $opts argument instead of duplicated *Opts method variants.

Model Construction (v3)

Use named constructor parameters for normal model creation.

Associative-array construction through $data remains available for legacy code paths but is deprecated and scheduled for removal in v4.

Current Clients

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 simple-consul-php with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
ext-json Version *
dcarbone/gotime Version ^v1.0.1
dcarbone/gohttp Version ^v1.0.0
guzzlehttp/guzzle Version ^7.4
guzzlehttp/psr7 Version ^2.4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package dcarbone/simple-consul-php contains the following files

Loading the files please wait ...