README

This service provider for Silex allows developers to easily configure and expose Predis enabling them to use Redis in their applications.

Getting started

Supposing that the skeleton of your application is ready, you simply need to register this service provider by specifying the parameters and options needed to access Redis:

$app->register(new Predis\Silex\ClientServiceProvider(), [
    'predis.parameters' => 'tcp://127.0.0.1:6379',
    'predis.options'    => [
        'prefix'  => 'silex:',
        'profile' => '3.0',
    ],
]);

This will register one instance of Predis\Client accessible from anywhere in your application by using $app['predis']. Both predis.parameters and predis.options are optional and they accept the same values accepted by the constructor of Predis\Client (see the documentation of Predis).

Certain applications might need more than one client to reach different servers or configured with different options. In such cases you must use Predis\Silex\ClientsServiceProvider providing a list of clients with their own parameters and options using predis.clients:

$app->register(new Predis\Silex\ClientsServiceProvider(), [
    'predis.clients' => [
        'client1' => 'tcp://127.0.0.1:6379',
        'client2' => [
            'host' => '127.0.0.1',
            'port' => 6380,
        ],
        'client3' => [
            'parameters' => 'tcp://127.0.0.1:6381',
            'options' => [
                'profile' => 'dev',
                'prefix'  => 'silex:',
            ],
        ],
    ),
]);

Clients will be exposed to your application using $app['predis'][$alias] where $alias is the key used to populate the items of predis.clients. Optionally, it is possible to set a default client by specifying its alias in predis.default_client making it accessible simply by invoking methods of Predis\Client directly against $app['predis']. Client instances are lazily initialized upon the first access.

NOTE: this is not the same as using a cluster of nodes or replication as it will only create and set up independent client instances. Cluster and replication thus work with both single and multiple client configurations, you just need to provide the needed parameters and options for each instance of Predis\Client.

You can find more details on how to use this provider in the examples directory or the test suite.

Reporting bugs and contributing code

Contributions are highly appreciated either in the form of pull requests for new features, bug fixes or just bug reports. We only ask you to adhere to a basic set of rules before submitting your changes or filing bugs on the issue tracker to make it easier for everyone to stay consistent while working on the project.

Project links

Author

Daniele Alessandri (github) (twitter)

Contributors

Jérôme Macias (github)

License

The code for Predis ServiceProvider is distributed under the terms of the MIT license.

predis / service-provider

Maintainers

Details