https://github.com/leafsphp/redis
Redis helper for your PHP apps
https://github.com/leafsphp/redis
leafphp php redis
Last synced: 3 months ago
JSON representation
Redis helper for your PHP apps
- Host: GitHub
- URL: https://github.com/leafsphp/redis
- Owner: leafsphp
- License: mit
- Created: 2021-05-30T14:21:19.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-03T22:10:40.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T09:58:50.396Z (about 1 year ago)
- Topics: leafphp, php, redis
- Language: PHP
- Homepage: https://leafphp.dev/modules/redis/
- Size: 38.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Leaf Redis
[](https://packagist.org/packages/leafs/redis)
[](https://packagist.org/packages/leafs/redis)
[](https://packagist.org/packages/leafs/redis)
Leaf Redis provides a simple interface for interacting with Redis using PHP. It also comes with a bunch of CLI commands for Leaf based frameworks.
## Installation
*To get started, be sure to have redis installed on your machine.*
You can quickly and simply install Leaf Redis with the Leaf CLI:
```bash
leaf install redis
```
Or with composer:
```bash
composer require leafs/redis
```
## Getting Started
To get started with Leaf Redis, you simply need to call the `init` method and pass in any configuration you need.
```php
Leaf\Redis::init();
```
This will initialize a new redis connection, from there, you can call any function you need to call.
### Aloe CLI
Although Leaf Redis can be used outside the Leaf environment, there's more support for Leaf based frameworks. Leaf Redis comes with out of the box support for Aloe CLI which is used in Leaf MVC and Leaf API. To get started, head over to the `leaf` file in the root directory of your Leaf API/Leaf MVC app or wherever aloe CLI is registered and register a new command.
```php
$console->register(\Leaf\Redis::commands());
```
From there you should have access to a bunch of new commands from Leaf redis. The available commands are:
```sh
redis
redis:install Create leaf redis config and .env variables
redis:server Start redis server
```
## Config
As mentioned above, the `init` method takes in an array for configuration. Below is the default config for `init`.
```php
/*
|--------------------------------------------------------------------------
| Redis host
|--------------------------------------------------------------------------
|
| Set the host for redis connection
|
*/
'host' => '127.0.0.1',
/*
|--------------------------------------------------------------------------
| Redis host port
|--------------------------------------------------------------------------
|
| Set the port for redis host
|
*/
'port' => 6379,
/*
|--------------------------------------------------------------------------
| Redis auth
|--------------------------------------------------------------------------
|
| Set the password for redis connection
|
*/
'password' => null,
/*
|--------------------------------------------------------------------------
| Redis session handler
|--------------------------------------------------------------------------
|
| Set redis as session save handler
|
*/
'session' => false,
/*
|--------------------------------------------------------------------------
| Redis connection timeout
|--------------------------------------------------------------------------
|
| Value in seconds (optional, default is 0.0 meaning unlimited)
|
*/
'connection.timeout' => 0.0,
/*
|--------------------------------------------------------------------------
| Redis connection reserved
|--------------------------------------------------------------------------
|
| should be null if $retryInterval is specified
|
*/
'connection.reserved' => null,
/*
|--------------------------------------------------------------------------
| Redis session handler
|--------------------------------------------------------------------------
|
| Connection retry interval in milliseconds.
|
*/
'connection.retryInterval' => 0,
/*
|--------------------------------------------------------------------------
| Redis connection read timeout
|--------------------------------------------------------------------------
|
| Value in seconds (optional, default is 0 meaning unlimited
|
*/
'connection.readTimeout' => 0.0,
/*
|--------------------------------------------------------------------------
| Redis session save_path
|--------------------------------------------------------------------------
|
| Save path for redis session. Leave null to automatically
| generate the session save path. You can also use multiple save urls
| by passing in an array.
|
*/
'session.savePath' => null,
/*
|--------------------------------------------------------------------------
| Redis session save_path options
|--------------------------------------------------------------------------
|
| Options for session save path. You can pass in multiple options in
| the order of the save path above.
|
*/
'session.saveOptions' => [],
```
```php
use Leaf\Redis;
Redis::init([
// you can use multiple hosts
'session.savePath' => ['tcp://host1:6379', 'tcp://host2:6379'],
// the first array is for the first host, second for the second host
'session.saveOptions' => [['weight' => 1], ['weight' => 2]],
]);
```
## Available Methods
### set
This allows you to set a redis entry.
```php
Leaf\Redis::set('key', 'value');
// you can also use arrays to set multiple values at once
Leaf\Redis::set(['key' => 'value', 'key2' => 'value']);
```
### get
This returns a saved redis entry.
```php
$value = Leaf\Redis::get('key');
// You can also get multiple entries at once
$data = Leaf\Redis::get(['key', 'key2']);
// $data => [key => value, key2 => value]
```
### ping
Ping the redis server
```php
Leaf\Redis::ping();
```
## 💬 Stay In Touch
- [Twitter](https://twitter.com/leafphp)
- [Join the forum](https://github.com/leafsphp/leaf/discussions/37)
- [Chat on discord](https://discord.com/invite/Pkrm9NJPE3)
## 📓 Learning Leaf 3
- Leaf has a very easy to understand [documentation](https://leafphp.dev) which contains information on all operations in Leaf.
- You can also check out our [youtube channel](https://www.youtube.com/channel/UCllE-GsYy10RkxBUK0HIffw) which has video tutorials on different topics
- You can also learn from [codelabs](https://codelabs.leafphp.dev) and contribute as well.
## 😇 Contributing
We are glad to have you. All contributions are welcome! To get started, familiarize yourself with our [contribution guide](https://leafphp.dev/community/contributing.html) and you'll be ready to make your first pull request 🚀.
To report a security vulnerability, you can reach out to [@mychidarko](https://twitter.com/mychidarko) or [@leafphp](https://twitter.com/leafphp) on twitter. We will coordinate the fix and eventually commit the solution in this project.
## 🤩 Sponsoring Leaf
Your cash contributions go a long way to help us make Leaf even better for you. You can sponsor Leaf and any of our packages on [open collective](https://opencollective.com/leaf) or check the [contribution page](https://leafphp.dev/support/) for a list of ways to contribute.
And to all our [existing cash/code contributors](https://leafphp.dev#sponsors), we love you all ❤️