Skip to content

Commit fb59524

Browse files
authored
format PhpRedis name (#9235)
1 parent 768cdd1 commit fb59524

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

redis.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
- [Configuration](#configuration)
55
- [Clusters](#clusters)
66
- [Predis](#predis)
7-
- [phpredis](#phpredis)
7+
- [PhpRedis](#phpredis)
88
- [Interacting With Redis](#interacting-with-redis)
99
- [Transactions](#transactions)
1010
- [Pipelining Commands](#pipelining-commands)
@@ -15,9 +15,9 @@
1515

1616
[Redis](https://redis.io) is an open source, advanced key-value store. It is often referred to as a data structure server since keys can contain [strings](https://redis.io/topics/data-types#strings), [hashes](https://redis.io/topics/data-types#hashes), [lists](https://redis.io/topics/data-types#lists), [sets](https://redis.io/topics/data-types#sets), and [sorted sets](https://redis.io/topics/data-types#sorted-sets).
1717

18-
Before using Redis with Laravel, we encourage you to install and use the [phpredis](https://github.com/phpredis/phpredis) PHP extension via PECL. The extension is more complex to install compared to "user-land" PHP packages but may yield better performance for applications that make heavy use of Redis. If you are using [Laravel Sail](/docs/{{version}}/sail), this extension is already installed in your application's Docker container.
18+
Before using Redis with Laravel, we encourage you to install and use the [PhpRedis](https://github.com/phpredis/phpredis) PHP extension via PECL. The extension is more complex to install compared to "user-land" PHP packages but may yield better performance for applications that make heavy use of Redis. If you are using [Laravel Sail](/docs/{{version}}/sail), this extension is already installed in your application's Docker container.
1919

20-
If you are unable to install the phpredis extension, you may install the `predis/predis` package via Composer. Predis is a Redis client written entirely in PHP and does not require any additional extensions:
20+
If you are unable to install the PhpRedis extension, you may install the `predis/predis` package via Composer. Predis is a Redis client written entirely in PHP and does not require any additional extensions:
2121

2222
```shell
2323
composer require predis/predis
@@ -148,16 +148,16 @@ In addition to the default `host`, `port`, `database`, and `password` server con
148148
<a name="the-redis-facade-alias"></a>
149149
#### The Redis Facade Alias
150150

151-
Laravel's `config/app.php` configuration file contains an `aliases` array which defines all of the class aliases that will be registered by the framework. By default, no `Redis` alias is included because it would conflict with the `Redis` class name provided by the phpredis extension. If you are using the Predis client and would like to add a `Redis` alias, you may add it to the `aliases` array in your application's `config/app.php` configuration file:
151+
Laravel's `config/app.php` configuration file contains an `aliases` array which defines all of the class aliases that will be registered by the framework. By default, no `Redis` alias is included because it would conflict with the `Redis` class name provided by the PhpRedis extension. If you are using the Predis client and would like to add a `Redis` alias, you may add it to the `aliases` array in your application's `config/app.php` configuration file:
152152

153153
'aliases' => Facade::defaultAliases()->merge([
154154
'Redis' => Illuminate\Support\Facades\Redis::class,
155155
])->toArray(),
156156

157157
<a name="phpredis"></a>
158-
### phpredis
158+
### PhpRedis
159159

160-
By default, Laravel will use the phpredis extension to communicate with Redis. The client that Laravel will use to communicate with Redis is dictated by the value of the `redis.client` configuration option, which typically reflects the value of the `REDIS_CLIENT` environment variable:
160+
By default, Laravel will use the PhpRedis extension to communicate with Redis. The client that Laravel will use to communicate with Redis is dictated by the value of the `redis.client` configuration option, which typically reflects the value of the `REDIS_CLIENT` environment variable:
161161

162162
'redis' => [
163163

@@ -166,7 +166,7 @@ By default, Laravel will use the phpredis extension to communicate with Redis. T
166166
// Rest of Redis configuration...
167167
],
168168

169-
In addition to the default `scheme`, `host`, `port`, `database`, and `password` server configuration options, phpredis supports the following additional connection parameters: `name`, `persistent`, `persistent_id`, `prefix`, `read_timeout`, `retry_interval`, `timeout`, and `context`. You may add any of these options to your Redis server configuration in the `config/database.php` configuration file:
169+
In addition to the default `scheme`, `host`, `port`, `database`, and `password` server configuration options, PhpRedis supports the following additional connection parameters: `name`, `persistent`, `persistent_id`, `prefix`, `read_timeout`, `retry_interval`, `timeout`, and `context`. You may add any of these options to your Redis server configuration in the `config/database.php` configuration file:
170170

171171
'default' => [
172172
'host' => env('REDIS_HOST', 'localhost'),
@@ -181,9 +181,9 @@ In addition to the default `scheme`, `host`, `port`, `database`, and `password`
181181
],
182182

183183
<a name="phpredis-serialization"></a>
184-
#### phpredis Serialization & Compression
184+
#### PhpRedis Serialization & Compression
185185

186-
The phpredis extension may also be configured to use a variety of serialization and compression algorithms. These algorithms can be configured via the `options` array of your Redis configuration:
186+
The PhpRedis extension may also be configured to use a variety of serializers and compression algorithms. These algorithms can be configured via the `options` array of your Redis configuration:
187187

188188
'redis' => [
189189

@@ -197,7 +197,7 @@ The phpredis extension may also be configured to use a variety of serialization
197197
// Rest of Redis configuration...
198198
],
199199

200-
Currently supported serialization algorithms include: `Redis::SERIALIZER_NONE` (default), `Redis::SERIALIZER_PHP`, `Redis::SERIALIZER_JSON`, `Redis::SERIALIZER_IGBINARY`, and `Redis::SERIALIZER_MSGPACK`.
200+
Currently supported serializers include: `Redis::SERIALIZER_NONE` (default), `Redis::SERIALIZER_PHP`, `Redis::SERIALIZER_JSON`, `Redis::SERIALIZER_IGBINARY`, and `Redis::SERIALIZER_MSGPACK`.
201201

202202
Supported compression algorithms include: `Redis::COMPRESSION_NONE` (default), `Redis::COMPRESSION_LZF`, `Redis::COMPRESSION_ZSTD`, and `Redis::COMPRESSION_LZ4`.
203203

0 commit comments

Comments
 (0)