tag stable 2.4.0

Co-authored-by: Lynn Club <lynncho@live.com>
Co-authored-by: Lynn Club <10293848+lynnclub@users.noreply.github.com>
Co-authored-by: Till Krüss <tillkruss@users.noreply.github.com>

.codespellrc

@@ -0,0 +1,6 @@
+[codespell]
+skip=./.git
+check-hidden=
+check-filenames=
+builtin=clear,rare,informal,usage,code,names
+ignore-words-list=master,masters,slave,slaves,whitelist,cas,exat,smove,SUGGET,sugget,ro,DOF,dof

.coveralls.yml

@@ -0,0 +1 @@
+coverage_clover: build/logs/clover-*.xml

.editorconfig

@@ -0,0 +1,27 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+block_comment_start = /*
+block_comment = *
+block_comment_end = */
+
+[*.php]
+max_line_length = 150
+
+[*.{md,yml,yaml,neon,sh}]
+indent_size = 2
+
+[VERSION]
+insert_final_newline = false
+
+[tests/**.php]
+max_line_length = unset
+
+[{src/ClientInterface.php,src/ClientContextInterface.php}]
+max_line_length = unset

.gitattributes

@@ -0,0 +1,20 @@
+* text=auto
+
+/.github export-ignore
+/bin export-ignore
+/examples export-ignore
+/tests export-ignore
+/.codespellrc export-ignore linguist-language=INI
+/.coveralls.yml export-ignore
+/.editorconfig export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/.php-cs-fixer.dist.php export-ignore
+/CHANGELOG.md export-ignore linguist-documentation
+/CONTRIBUTING.md export-ignore linguist-documentation
+/FAQ.md export-ignore linguist-documentation
+/VERSION export-ignore
+/phpunit.relay.xml export-ignore
+/phpunit.xml.dist export-ignore
+/phpstan.dist.neon export-ignore
+/phpstan-tests.dist.neon export-ignore

.github/CODEOWNERS

@@ -0,0 +1,14 @@
+# Default
+*                                     @tillkruss
+
+# Redis commands
+src/Command/Redis/*                   @predis/team @tillkruss
+
+# Redis Stack
+src/Command/Redis/Json/*              @predis/team
+src/Command/Redis/Search/*            @predis/team
+src/Command/Redis/TopK/*              @predis/team
+src/Command/Redis/TDigest/*           @predis/team
+src/Command/Redis/BloomFilter/*       @predis/team
+src/Command/Redis/CuckooFilter/*      @predis/team
+src/Command/Redis/CountMinSketch/*    @predis/team

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,6 @@
+The Predis code of conduct is derived from the Ruby code of conduct. Any violations of the code of conduct may be reported to [Till Krüss](https://till.im):
+
+- Participants will be tolerant of opposing views.
+- Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+- When interpreting the words and actions of others, participants should always assume good intentions.
+- Behavior that can be reasonably considered harassment will not be tolerated.

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: tillkruss
+custom: "https://www.paypal.me/tillkruss"

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Run command '...'
+2. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Versions (please complete the following information):**
+- Predis: [e.g. 1.1.2]
+- PHP [e.g. 8.0.0]
+- Redis Server [e.g. 6.0.0]
+- OS [e.g. Ubuntu 20.10]
+
+**Code sample**
+If applicable, a small snippet of code that reproduces the issue.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/docker-compose.yml

@@ -0,0 +1,73 @@
+---
+
+services:
+
+  redis-official:
+    image: ${REDIS_IMAGE_NAME:-redis:7.4}
+    container_name: redis-standalone
+    healthcheck:
+      test: [ "CMD", "redis-cli", "PING" ]
+      interval: 10s
+      timeout: 5s
+      retries: 3
+    ports:
+      - "6379:6379"
+    profiles:
+      - all
+      - official
+      - standalone
+
+  redis-clients:
+    image: ${REDIS_IMAGE_NAME:-redislabs/client-libs-test:7.4.2}
+    container_name: redis-standalone
+    environment:
+      - TLS_ENABLED=yes
+      - REDIS_CLUSTER=no
+      - PORT=6379
+      - TLS_PORT=6666
+    command: ${REDIS_EXTRA_ARGS:---enable-debug-command yes --enable-module-command yes --tls-auth-clients optional --save ""}
+    ports:
+      - 6379:6379
+      - 6666:6666 # TLS port
+    volumes:
+      - "./dockers/standalone:/redis/work"
+    profiles:
+      - all
+      - clients
+      - standalone
+
+  redis-cluster:
+    image: ${REDIS_IMAGE_NAME:-redislabs/client-libs-test:7.4.2}
+    container_name: redis-cluster
+    environment:
+      - REDIS_CLUSTER=yes
+      - NODES=6
+      - REPLICAS=1
+      - TLS_ENABLED=yes
+      - PORT=16379
+      - TLS_PORT=27379
+    command: ${REDIS_EXTRA_ARGS:---enable-debug-command yes --enable-module-command yes --tls-auth-clients optional --save ""}
+    ports:
+      - "6372-6377:16379-16384"
+    volumes:
+      - "./dockers/cluster:/redis/work"
+    profiles:
+      - all
+      - clients
+      - cluster
+
+  redis-stack:
+    image: ${REDIS_STACK_IMAGE_NAME:-redislabs/client-libs-test:rs-7.4.0-v2}
+    container_name: redis-stack
+    ports:
+      - "6479:6379"
+    environment:
+      - REDIS_CLUSTER=no
+      - PORT=6379
+    command: ${REDIS_EXTRA_ARGS:---enable-debug-command yes --enable-module-command yes --save ""}
+    volumes:
+      - "./dockers/redis-stack:/redis/work"
+    profiles:
+      - all
+      - clients
+      - stack

.github/release-drafter-config.yml

@@ -0,0 +1,49 @@
+name-template: 'v$NEXT_MINOR_VERSION'
+tag-template: 'v$NEXT_MINOR_VERSION'
+change-template: '- $TITLE (#$NUMBER)'
+
+autolabeler:
+  - label: 'maintenance'
+    files:
+      - '*.md'
+      - '.github/*'
+  - label: 'bug'
+    branch:
+      - '/bug-.+'
+  - label: 'maintenance'
+    branch:
+      - '/maintenance-.+'
+  - label: 'feature'
+    branch:
+      - '/feature-.+'
+
+categories:
+  - title: 'Breaking Changes'
+    labels:
+      - 'breakingchange'
+  - title: 'Experimental Features'
+    labels:
+      - 'experimental'
+  - title: 'New Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: 'Bug Fixes'
+    labels:
+      - 'fix'
+      - 'bugfix'
+      - 'bug'
+      - 'BUG'
+  - title: 'Maintenance'
+    label: 'maintenance'
+
+exclude-labels:
+  - 'skip-changelog'
+
+template: |
+  $CHANGES
+
+  ## Contributors
+  We'd like to thank all the contributors who worked on this release!
+
+  $CONTRIBUTORS

.github/workflows/README.md

@@ -0,0 +1,9 @@
+# Workflows
+
+## Delete runs by workflow name
+
+```bash
+gh run list --workflow 'redis-server-tests.yml' --limit 1000 --json databaseId \
+  | jq '.[].databaseId' \
+  | xargs -I % gh api --silent -X DELETE /repos/predis/predis/actions/runs/%
+```

.github/workflows/linters.yml

@@ -0,0 +1,196 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow
+
+name: Linters
+
+on:
+  push:
+    branches:
+      - main
+      - v2.**
+  pull_request: null
+
+permissions: {}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  byte_level:
+    name: Byte-level
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Check file permissions
+        run: test "$(find . -type f -not -path './.git/*' -executable)" = "./bin/create-command-test"
+
+      - name: "Find non-printable ASCII characters"
+        run: |
+          ! LC_ALL=C.UTF-8 find . -type f -name '*.php' -print0 \
+            | xargs --null -- grep --perl-regexp --with-filename --line-number '[^ -~ü]'
+
+  syntax_errors:
+    name: Syntax errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "8.1"
+          coverage: none
+          tools: parallel-lint
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Check source code for syntax errors
+        run: composer exec -- parallel-lint bin/ examples/ src/ tests/
+
+  static_analysis:
+    name: Static Analysis
+    needs:
+      - byte_level
+      - syntax_errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "8.2"
+          coverage: none
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Validate Composer configuration
+        run: composer validate --no-interaction --strict
+
+      - name: Install dependencies
+        uses: ramsey/composer-install@v2
+        with:
+          dependency-versions: highest
+
+      - name: Check PSR-4 mapping
+        run: composer dump-autoload --no-interaction --optimize --strict-psr
+
+      - name: Perform static analysis
+        run: composer run phpstan
+
+      - name: Perform static analysis on tests
+        run: composer run phpstan -- --configuration=phpstan-tests.dist.neon
+
+  coding_standards:
+    name: Coding Standards
+    needs:
+      - byte_level
+      - syntax_errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "8.1"
+          coverage: none
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Check EditorConfig configuration
+        run: test -f .editorconfig
+
+      - name: Check adherence to EditorConfig
+        uses: greut/eclint-action@v0
+
+      - name: Install dependencies
+        uses: ramsey/composer-install@v2
+        with:
+          dependency-versions: highest
+
+      - name: Check coding style
+        run: composer exec -- php-cs-fixer fix --diff --dry-run --allow-risky=yes --using-cache=no
+
+      - name: Search for TODO-s and FIXME-s
+        run: |
+          ! git grep --extended-regexp --ignore-case '\b(TODO|FIXME)\b' -- ':/' ':!tests/*' ':!*/linters\.yml'
+
+  exported_files:
+    name: Exported files
+    needs:
+      - byte_level
+      - syntax_errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Check exported files
+        run: |
+          EXPECTED="LICENSE,README.md,autoload.php,composer.json"
+          CURRENT="$(
+              git archive HEAD \
+                  | tar --list --exclude="src" --exclude="src/*" --exclude="bin" --exclude="bin/*" \
+                  | paste --serial --delimiters=","
+          )"
+          echo "CURRENT =${CURRENT}"
+          echo "EXPECTED=${EXPECTED}"
+          test "${CURRENT}" = "${EXPECTED}"
+
+  spelling:
+    name: Spelling
+    needs:
+      - byte_level
+      - syntax_errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Cache pip
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-codespell
+
+      - name: Install codespell
+        run: pip install --user 'codespell>=2.2'
+
+      - name: Search for misspellings
+        run: $(python -m site --user-base)/bin/codespell
+
+  changelog:
+
+    name: Changelog
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    if: >-
+      github.event_name == 'pull_request' &&
+      !contains(github.event.head_commit.message, 'nochangelog') &&
+      !contains(github.event.head_commit.message, 'no-changelog') &&
+      !contains(github.event.head_commit.message, 'no changelog') &&
+      !contains(github.event.pull_request.labels.*.name, 'no-changelog')
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Check for CHANGELOG entry
+        env:
+          TARGET: ${{ github.event.pull_request.base.ref }}
+        run:  |
+          FILES_CHANGED=$(git diff --name-only origin/$TARGET...HEAD | grep -E 'CHANGELOG\.md' -c)
+          if [ "$FILES_CHANGED" != "1" ]; then
+            echo "CHANGELOG.md was not updated";
+            exit 1;
+          fi;

.github/workflows/release-drafter.yml

@@ -0,0 +1,25 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  update_release_draft:
+
+    name: Update release draft
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - uses: release-drafter/release-drafter@v5
+        with:
+          config-name: release-drafter-config.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/tests.yml

@@ -0,0 +1,183 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+      - v2.**
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  predis:
+    name: PHP ${{ matrix.php }} (Redis ${{ matrix.redis }})
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php:
+          - '7.2'
+          - '8.0'
+          - '8.3'
+          - '8.4'
+        redis:
+          - '4.0'
+          - '6.2'
+          - '7.2'
+          - '7.4'
+          - '8.0'
+
+    steps:
+
+      - name: Resolve container name
+        run: |
+          # Mapping of original redis versions to client test containers
+          declare -A redis_clients_version_mapping=(
+            ["8.0"]="8.0-RC2-pre"
+            ["7.4"]="7.4.2"
+            ["7.2"]="7.2.7"
+            ["6.2"]="6.2.17"
+          )
+
+          # Mapping of redis version to stack version
+          declare -A redis_stack_version_mapping=(
+            ["7.4"]="rs-7.4.0-v3"
+            ["7.2"]="rs-7.2.0-v15"
+            ["6.2"]="rs-6.2.6-v19"
+          )
+
+          if [[ -v redis_clients_version_mapping[${{ matrix.redis }}] ]]; then
+            echo "REDIS_IMAGE_NAME=redislabs/client-libs-test:${redis_clients_version_mapping[${{ matrix.redis }}]}" >> $GITHUB_ENV
+            echo "REDIS_STACK_IMAGE_NAME=redislabs/client-libs-test:${redis_stack_version_mapping[${{ matrix.redis }}]}" >> $GITHUB_ENV
+            echo "DOCKER_SERVICE=redis-clients" >> $GITHUB_ENV
+
+            redis_major_version=$(echo "${{ matrix.redis }}" | grep -oP '^\d+')
+
+            # Some configuration options available since Redis > 7
+            if (( redis_major_version < 7 )); then
+              echo "REDIS_EXTRA_ARGS="--tls-auth-clients optional --save ''"" >> $GITHUB_ENV
+            else
+              # Since 8.0 modules are bundled with core
+              echo "REDIS_STACK_SERVER_PORT=6379" >> $GITHUB_ENV
+            fi
+
+          else
+            echo "REDIS_IMAGE_NAME=redis:${{ matrix.redis }}" >> $GITHUB_ENV
+            echo "DOCKER_SERVICE=redis-official" >> $GITHUB_ENV
+          fi
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Start Redis standalone image
+        uses: hoverkraft-tech/compose-action@v2.0.1
+        with:
+          compose-file: .github/docker-compose.yml
+          services: ${{ env.DOCKER_SERVICE }}
+
+      - name: Start Redis stack image
+        id: stack_infra
+        uses: hoverkraft-tech/compose-action@v2.0.1
+        if: ${{ matrix.redis >= '6.2' && matrix.redis < '8.0' }}
+        with:
+          compose-file: .github/docker-compose.yml
+          services: redis-stack
+
+      - name: Start Redis cluster image
+        id: cluster_infra
+        uses: hoverkraft-tech/compose-action@v2.0.1
+        if: ${{ matrix.redis > '4.0' }}
+        with:
+          compose-file: .github/docker-compose.yml
+          services: redis-cluster
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: relay
+          coverage: ${{ (matrix.php == '8.4' && matrix.redis == '7.4') && 'xdebug' || 'none' }}
+
+      - name: Install Composer dependencies
+        uses: ramsey/composer-install@v2
+        with:
+          dependency-versions: highest
+          composer-options: ${{ matrix.php == '8.0' && '--ignore-platform-reqs' || '' }}
+
+      - name: Run tests
+        if: ${{ matrix.php != '8.4' || matrix.redis != '7.4' }}
+        run: vendor/bin/phpunit
+
+      - name: Run tests with coverage
+        if: ${{ matrix.php == '8.4' && matrix.redis == '7.4' }}
+        run: vendor/bin/phpunit --coverage-php build/cov/coverage-predis.cov --coverage-filter ./src
+
+      - name: Run tests using Relay
+        if: ${{ matrix.php != '8.4' && matrix.redis >= '6.2' }}
+        run: vendor/bin/phpunit -c phpunit.relay.xml
+
+      - name: Run tests using Relay with coverage
+        if: ${{ matrix.php == '8.4' && matrix.redis == '7.4' }}
+        run: vendor/bin/phpunit -c phpunit.relay.xml --coverage-php build/cov/coverage-relay.cov --coverage-filter ./src
+
+      - name: Run stack tests
+        if: ${{ (matrix.php != '8.4' || matrix.redis != '7.4') && matrix.redis >= '6.2' }}
+        run: vendor/bin/phpunit --group realm-stack
+
+      - name: Run stack tests with coverage
+        if: ${{ matrix.php == '8.4' && matrix.redis == '7.4' && steps.stack_infra.conclusion == 'success' }}
+        run: vendor/bin/phpunit --group realm-stack --coverage-php build/cov/coverage-stack.cov --coverage-filter ./src
+        env:
+          REDIS_STACK_SERVER_PORT: 6479
+
+      - name: Run stack tests using Relay
+        if: ${{ matrix.php != '8.4' && matrix.redis == '7.4' }}
+        run: vendor/bin/phpunit --group realm-stack -c phpunit.relay.xml
+
+      - name: Run stack tests using Relay with coverage
+        if: ${{ matrix.php == '8.4' && matrix.redis == '7.4' }}
+        run: vendor/bin/phpunit --group realm-stack -c phpunit.relay.xml --coverage-php build/cov/coverage-stack-relay.cov --coverage-filter ./src
+        env:
+          REDIS_STACK_SERVER_PORT: 6479
+
+      - name: Run tests against cluster
+        if: ${{ (matrix.php != '8.4' || matrix.redis != '7.4') && steps.cluster_infra.conclusion == 'success' }}
+        run: |
+          vendor/bin/phpunit --group cluster
+
+      - name: Run tests against cluster with coverage
+        if: ${{ matrix.php == '8.4' && matrix.redis == '7.4' && steps.cluster_infra.conclusion == 'success' }}
+        run: |
+          vendor/bin/phpunit --group cluster --coverage-php build/cov/coverage-cluster.cov --coverage-filter ./src
+
+      - name: Run tests against cluster using Relay
+        if: ${{ matrix.php != '8.4' && matrix.redis == '7.4' }}
+        run: |
+          vendor/bin/phpunit -c phpunit.relay.xml --group cluster
+
+      - name: Merge coverage reports
+        if: ${{ matrix.php == '8.4' && matrix.redis == '7.4' }}
+        run: php vendor/bin/phpcov merge --clover build/logs/clover.xml build/cov
+
+      - name: Send coverage to Coveralls
+        uses: coverallsapp/github-action@v2
+        if: ${{ matrix.php == '8.4' && matrix.redis == '7.4' }}
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel: true
+
+  finish:
+    name: Finish Coverall
+    needs: predis
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@v2
+        with:
+          parallel-finished: true

.gitignore

@@ -1,2 +1,8 @@
+/build
+/vendor
+.php-version
+.php_cs.cache
+.phpunit.result.cache
+.php-cs-fixer.cache
+composer.lock
 phpunit.xml
-experiments/

.php-cs-fixer.dist.php

@@ -0,0 +1,43 @@
+<?php
+
+$PREDIS_HEADER = <<<EOS
+This file is part of the Predis package.
+
+(c) 2009-2020 Daniele Alessandri
+(c) 2021-2025 Till Krüss
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+EOS;
+
+$fixer = new PhpCsFixer\Config;
+
+$fixer->setParallelConfig(
+    \PhpCsFixer\Runner\Parallel\ParallelConfigFactory::detect()
+);
+
+$fixer->setRules([
+    '@PHP71Migration' => true,
+    'header_comment' => ['header' => $PREDIS_HEADER],
+    '@Symfony' => true,
+    'phpdoc_separation' => false,
+    'phpdoc_annotation_without_dot' => false,
+    'no_superfluous_phpdoc_tags' => false,
+    'no_unneeded_curly_braces' => false,
+    'no_unneeded_braces' => false,
+    'global_namespace_import' => true,
+    'yoda_style' => false,
+    'single_line_throw' => false,
+    'concat_space' => ['spacing' => 'one'],
+    'increment_style' => false,
+    'trailing_comma_in_multiline' => ['after_heredoc' => true, 'elements' => ['array_destructuring', 'arrays']]
+])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in(__DIR__ . '/bin')
+            ->in(__DIR__ . '/examples')
+            ->in(__DIR__ . '/src')
+            ->in(__DIR__ . '/tests')
+    );
+
+return $fixer;

.travis.yml

@@ -1,9 +0,0 @@
-language: php
-php:
-  - 5.3
-  - 5.4
-branches:
-  only:
-    - master
-    - v0.7
-script: phpunit -c phpunit.xml.travisci

CHANGELOG.md

@@ -1,349 +1,300 @@
-v0.7.0 (2011-12-11)
-===============================================================================
-
-- Predis now adheres to the PSR-0 standard which means that there is no more a
-  single file holding all the classes of the library, but multiple files (one
-  for each class). You can use any PSR-0 compatible autoloader to load Predis
-  or just leverage the default one shipped with the library by requiring the
-  `Predis/Autoloader.php` and call `Predis\Autoloader::register()`.
-
-- The default server profile for Redis is now 2.4. The `dev` profile supports
-  all the features of Redis 2.6 (currently unstable) such as Lua scripting.
-
-- Support for long aliases (method names) for Redis commands has been dropped.
-
-- Redis 1.0 is no more supported. From now on Predis will use only the unified
-  protocol to serialize commands.
-
-- It is possible to prefix keys transparently on a client-level basis with the
-  new `prefix` client option.
-
-- An external connection factory is used to initialize new connection instances
-  and developers can now register their own connection classes using the new
-  `connections` client option.
-
-- It is possible to connect locally to Redis using UNIX domain sockets. Just
-  use `unix:///path/to/redis.sock` or a named array just like in the following
-  example: `array('scheme' => 'unix', 'path' => '/path/to/redis.sock');`.
-
-- If the `phpiredis` extension is loaded by PHP, it is now possible to use an
-  alternative connection class that leverages it to make Predis faster on many
-  cases, especially when dealing with big multibulk replies, with the the only
-  downside that persistent connections are not supported. Please refer to the
-  documentation to see how to activate this class using the new `connections`
-  client option.
-
-- Predis is capable to talk with Webdis, albeit with some limitations such as
-  the lack of pipelining and transactions, just by using the `http` scheme in
-  in the connection parameters. All is needed is PHP with the `curl` and the
-  `phpiredis` extensions loaded.
-
-- Way too many changes in the public API to make a list here, we just tried to
-  make all the Redis commands compatible with previous releases of v0.6 so that
-  you do not have to worry if you are simply using Predis as a client. Probably
-  the only breaking changes that should be mentioned here are:
-
-  - `throw_on_error` has been renamed to `throw_errors` and it is a connection
-    parameter instead of a client option, along with `iterable_multibulk`.
-
-  - `key_distribution` has been removed from the client options. To customize
-    the distribution strategy you must provide a callable object to the new
-    `cluster` client option to configure and then return a new instance of
-    `Predis\Network\IConnectionCluster`.
-
-  - `Predis\Client::create()` has been removed. Just use the constructor to set
-    up a new instance of `Predis\Client`.
-
-  - `Predis\Client::pipelineSafe()` was deprecated in Predis v0.6.1 and now has
-    finally removed. Use `Predis\Client::pipeline(array('safe' => true))`.
-
-  - `Predis\Client::rawCommand()` has been removed due to inconsistencies with
-    the underlying connection abstractions. You can still get the raw resource
-    out of a connection with `Predis\Network\IConnectionSingle::getResource()`
-    so that you can talk directly with Redis.
-
-- The `Predis\MultiBulkCommand` class has been merged into `Predis\Command` and
-  thus removed. Serialization of commands is now a competence of connections.
-
-- The `Predis\IConnection` interface has been splitted into two new interfaces:
-  `Predis\Network\IConnectionSingle and `Predis\Network\IConnectionCluster`.
-
-- The constructor of `Predis\Client` now accepts more type of arguments such as
-  instances of `Predis\IConnectionParameters` and `Predis\Network\IConnection`.
-
-
-v0.6.6 (2011-04-01)
-===============================================================================
-
-- Switched to Redis 2.2 as the default server profile (there are no changes
-  that would break compatibility with previous releases). Long command names
-  are no more supported by default but if you need them you can still require
-  Predis_Compatibility.php to avoid breaking compatibility.
-
-- Added a `VERSION` constant to `Predis\Client`.
-
-- Some performance improvements for multibulk replies (parsing them is about
-  16% faster than the previous version). A few core classes have been heavily
-  optimized to reduce overhead when creating new instances.
-
-- Predis now uses by default a new protocol reader, more lightweight and
-  faster than the default handler-based one. Users can revert to the old
-  protocol reader with the 'reader' client option set to `composable`.
-  This client option can also accept custom reader classes implementing the
-  new `Predis\IResponseReader` interface.
-
-- Added support for connecting to Redis using UNIX domain sockets (ISSUE #25).
-
-- The `read_write_timeout` connection parameter can now be set to 0 or false
-  to disable read and write timeouts on connections. The old behaviour of -1
-  is still intact.
-
-- `ZUNIONSTORE` and `ZINTERSTORE` can accept an array to specify a list of the
-  source keys to be used to populate the destination key.
-
-- `MGET`, `SINTER`, `SUNION` and `SDIFF` can accept an array to specify a list
-  of keys. `SINTERSTORE`, `SUNIONSTORE` and `SDIFFSTORE` can also accept an
-  array to specify the list of source keys.
-
-- `SUBSCRIBE` and `PSUBSCRIBE` can accept a list of channels for subscription.
-
-- __FIX__: some client-side clean-ups for `MULTI/EXEC` were handled incorrectly
-  in a couple of corner cases (ISSUE #27).
-
-
-v0.6.5 (2011-02-12)
-===============================================================================
-
-- __FIX__: due to an untested internal change introduced in v0.6.4, a wrong
-  handling of bulk reads of zero-length values was producing protocol
-  desynchronization errors (ISSUE #20).
-
-
-v0.6.4 (2011-02-12)
-===============================================================================
-
-- Various performance improvements (15% ~ 25%) especially when dealing with
-  long multibulk replies or when using clustered connections.
-
-- Added the `on_retry` option to `Predis\MultiExecBlock` that can be used to
-  specify an external callback (or any callable object) that gets invoked
-  whenever a transaction is aborted by the server.
-
-- Added inline (p)subscribtion via options when initializing an instance of
-  `Predis\PubSubContext`.
-
-
-v0.6.3 (2011-01-01)
-===============================================================================
-
-- New commands available in the Redis v2.2 profile (dev):
-  - Strings: `SETRANGE`, `GETRANGE`, `SETBIT`, `GETBIT`
-  - Lists  : `BRPOPLPUSH`
-
-- The abstraction for `MULTI/EXEC` transactions has been dramatically improved
-  by providing support for check-and-set (CAS) operations when using Redis >=
-  2.2. Aborted transactions can also be optionally replayed in automatic up
-  to a user-defined number of times, after which a `Predis\AbortedMultiExec`
-  exception is thrown.
-
-
-v0.6.2 (2010-11-28)
-===============================================================================
-
-- Minor internal improvements and clean ups.
-
-- New commands available in the Redis v2.2 profile (dev):
-  - Strings: `STRLEN`
-  - Lists  : `LINSERT`, `RPUSHX`, `LPUSHX`
-  - ZSets  : `ZREVRANGEBYSCORE`
-  - Misc.  : `PERSIST`
-
-- WATCH also accepts a single array parameter with the keys that should be
-  monitored during a transaction.
-
-- Improved the behaviour of `Predis\MultiExecBlock` in certain corner cases.
-
-- Improved parameters checking for the SORT command.
-
-- __FIX__: the `STORE` parameter for the `SORT` command didn't work correctly
-  when using `0` as the target key (ISSUE #13).
-
-- __FIX__: the methods for `UNWATCH` and `DISCARD` do not break anymore method
-  chaining with `Predis\MultiExecBlock`.
-
-
-v0.6.1 (2010-07-11)
-===============================================================================
-
-- Minor internal improvements and clean ups.
-
-- New commands available in the Redis v2.2 profile (dev):
-  - Misc.  : `WATCH`, `UNWATCH`
-
-- Optional modifiers for `ZRANGE`, `ZREVRANGE` and `ZRANGEBYSCORE` queries are
-  supported using an associative array passed as the last argument of their
-  respective methods.
-
-- The `LIMIT` modifier for `ZRANGEBYSCORE` can be specified using either:
-  - an indexed array: `array($offset, $count)`
-  - an associative array: `array('offset' => $offset, 'count' => $count)`
-
-- The method `Predis\Client::__construct()` now accepts also instances of
-  `Predis\ConnectionParameters`.
-
-- `Predis\MultiExecBlock` and `Predis\PubSubContext` now throw an exception
-  when trying to create their instances using a profile that does not
-  support the required Redis commands or when the client is connected to
-  a cluster of connections.
-
-- Various improvements to `Predis\MultiExecBlock`:
-  - fixes and more consistent behaviour across various usage cases.
-  - support for `WATCH` and `UNWATCH` when using the current development
-    profile (Redis v2.2) and aborted transactions.
-
-- New signature for `Predis\Client::multiExec()` which is now able to accept
-  an array of options for the underlying instance of `Predis\MultiExecBlock`.
-  Backwards compatibility with previous releases of Predis is ensured.
-
-- New signature for `Predis\Client::pipeline()` which is now able to accept
-  an array of options for the underlying instance of Predis\CommandPipeline.
-  Backwards compatibility with previous releases of Predis is ensured.
-  The method `Predis\Client::pipelineSafe()` is to be considered deprecated.
-
-- __FIX__: The `WEIGHT` modifier for `ZUNIONSTORE` and `ZINTERSTORE` was
-  handled incorrectly with more than two weights specified.
-
-
-v0.6.0 (2010-05-24)
-===============================================================================
-
-- Switched to the new multi-bulk request protocol for all of the commands
-  in the Redis 1.2 and Redis 2.0 profiles. Inline and bulk requests are now
-  deprecated as they will be removed in future releases of Redis.
-
-- The default server profile is `2.0` (targeting Redis 2.0.x). If you are
-  using older versions of Redis, it is highly recommended that you specify
-  which server profile the client should use (e.g. `1.2` when connecting
-  to instances of Redis 1.2.x).
-
-- Support for Redis 1.0 is now optional and it is provided by requiring
-  'Predis_Compatibility.php' before creating an instance of Predis\Client.
-
-- New commands added to the Redis 2.0 profile since Predis 0.5.1:
-  - Strings: `SETEX`, `APPEND`, `SUBSTR`
-  - ZSets  : `ZCOUNT`, `ZRANK`, `ZUNIONSTORE`, `ZINTERSTORE`, `ZREMBYRANK`,
-             `ZREVRANK`
-  - Hashes : `HSET`, `HSETNX`, `HMSET`, `HINCRBY`, `HGET`, `HMGET`, `HDEL`,
-             `HEXISTS`, `HLEN`, `HKEYS`, `HVALS`, `HGETALL`
-  - PubSub : `PUBLISH`, `SUBSCRIBE`, `UNSUBSCRIBE`
-  - Misc.  : `DISCARD`, `CONFIG`
-
-- Introduced client-level options with the new `Predis\ClientOptions` class.
-  Options can be passed to the constructor of `Predis\Client` in its second
-  argument as an array or an instance of Predis\ClientOptions. For brevity's
-  sake and compatibility with older versions, the constructor still accepts
-  an instance of `Predis\RedisServerProfile` in its second argument. The
-  currently supported client options are:
-
-  - `profile` [default: `2.0` as of Predis 0.6.0]: specifies which server
-    profile to use when connecting to Redis. This option accepts an instance
-    of `Predis\RedisServerProfile` or a string that indicates the version.
-
-  - `key_distribution` [default: `Predis\Distribution\HashRing`]: specifies
-    which key distribution strategy to use to distribute keys among the
-    servers that compose a cluster. This option accepts an instance of
-    `Predis\Distribution\IDistributionStrategy` so that users can implement
-    their own key distribution strategy. `Predis\Distribution\KetamaPureRing`
-    is an alternative distribution strategy providing a pure-PHP implementation
-    of the same algorithm used by libketama.
-
-  - `throw_on_error` [default: `TRUE`]: server errors can optionally be handled
-    "silently": instead of throwing an exception, the client returns an error
-    response type.
-
-  - `iterable_multibulk` [EXPERIMENTAL - default: `FALSE`]: in addition to the
-    classic way of fetching a whole multibulk reply into an array, the client
-    can now optionally stream a multibulk reply down to the user code by using
-    PHP iterators. It is just a little bit slower, but it can save a lot of
-    memory in certain scenarios.
-
-- New parameters for connections:
-
-  - `alias` [default: not set]: every connection can now be identified by an
-    alias that is useful to get a specific connections when connected to a
-    cluster of Redis servers.
-  - `weight` [default: not set]: allows to balance keys asymmetrically across
-    multiple servers. This is useful when you have servers with different
-    amounts of memory to distribute the load of your keys accordingly.
-  - `connection_async` [default: `FALSE`]: estabilish connections to servers
-    in a non-blocking way, so that the client is not blocked while the socket
-    resource performs the actual connection.
-  - `connection_persistent` [default: `FALSE`]: the underlying socket resource
-    is left open when a script ends its lifecycle. Persistent connections can
-    lead to unpredictable or strange behaviours, so they should be used with
-    extreme care.
-
-- Introduced the `Predis\Pipeline\IPipelineExecutor` interface. Classes that
-  implements this interface are used internally by the `Predis\CommandPipeline`
-  class to change the behaviour of the pipeline when writing/reading commands
-  from one or multiple servers. Here is the list of the default executors:
-
-  - `Predis\Pipeline\StandardExecutor`: exceptions generated by server errors
-    might be thrown depending on the options passed to the client (see the
-    `throw_on_error` client option). Instead, protocol or network errors always
-    throw exceptions. This is the default executor for single and clustered
-    connections and shares the same behaviour of Predis 0.5.x.
-  - `Predis\Pipeline\SafeExecutor`: exceptions generated by server, protocol
-    or network errors are not thrown but returned in the response array as
-    instances of `Predis\ResponseError` or `Predis\CommunicationException`.
-  - `Predis\Pipeline\SafeClusterExecutor`: this executor shares the same
-    behaviour of `Predis\Pipeline\SafeExecutor` but it is geared towards
-    clustered connections.
-
-- Support for PUB/SUB is handled by the new `Predis\PubSubContext` class, which
-  could also be used to build a callback dispatcher for PUB/SUB scenarios.
-
-- When connected to a cluster of connections, it is now possible to get a
-  new `Predis\Client` instance for a single connection of the cluster by
-  passing its alias/index to the new `Predis\Client::getClientFor()` method.
-
-- `Predis\CommandPipeline` and `Predis\MultiExecBlock` return their instances
-  when invokink commands, thus allowing method chaining in pipelines and
-  multi-exec blocks.
-
-- `Predis\MultiExecBlock` can handle the new `DISCARD` command.
-
-- Connections now support float values for the `connection_timeout` parameter
-  to express timeouts with a microsecond resolution.
-
-- __FIX__: TCP connections now respect the read/write timeout parameter when
-  reading the payload of server responses. Previously, `stream_get_contents()`
-  was being used internally to read data from a connection but it looks like
-  PHP does not honour the specified timeout for socket streams when inside
-  this function.
-
-- __FIX__: The `GET` parameter for the `SORT` command now accepts also multiple
-  key patterns by passing an array of strings. (ISSUE #1).
-
-* __FIX__: Replies to the `DEL` command return the number of elements deleted
-  by the server and not 0 or 1 interpreted as a boolean response. (ISSUE #4).
-
-
-v0.5.1 (2010-01-23)
-===============================================================================
-
-* `RPOPLPUSH` has been changed from bulk command to inline command in Redis
-  1.2.1, so `ListPopLastPushHead` now extends `InlineCommand`. The old behavior
-  is still available via the `ListPopLastPushHeadBulk` class so that you can
-  override the server profile if you need the old (and uncorrect) behaviour
-  when connecting to a Redis 1.2.0 instance.
-
-* Added missing support for `BGREWRITEAOF` for Redis >= 1.2.0.
-
-* Implemented a factory method for the `RedisServerProfile` class to ease the
-  creation of new server profile instances based on a version string.
-
-
-v0.5.0 (2010-01-09)
-===============================================================================
-* First versioned release of Predis
+## Changelog
+
+## v2.4.0 (2025-04-30)
+### Added
+- Added new hash-field expiration commands (#1520)
+- Added missing `FT._LIST` and `BITFIELD_RO` commands (#1521)
+
+### Changed
+- Update `WATCH` command to accept `string|string[]` (#1476)
+- Optimize cluster slotmap with compact slot range object (#1493)
+
+### Fixed
+- Fixed `EVAL_RO` cluster support (#1449)
+- Fixed PHP 8.4 compatibility with `stream_context_set_option()` (#1503)
+- Prevent named arguments runtime failure (#1509)
+- Mark `GEOSEARCH` as read-only to ensure execution on replica (#1481)
+- Fixed protocol loss during redis cluster `MOVED` / `ASK` (#1530)
+
+### Maintenance
+- Added CI testing with Redis 8.0 (#1510)
+- Added test coverage for compatibility with Redis 8.0 (#1513)
+- Use parallel on PHP-CS-Fixer (#1489)
+
+## v2.3.0 (2024-11-21)
+### Added
+- Added `GeoShapeField` field (#1467)
+- Added hash expiration commands (#1456)
+- Added support for time series `IGNORE` filter (#1458)
+- Added `XREAD` commands (#1459)
+- Added `NOVALUES` argument support to `HSCAN` (#1459)
+- Added support for search `INDEXMISSING` and `INDEXEMPTY` arguments (#1464)
+
+### Changed
+- Explicitly mark nullable parameters as nullable (#1448)
+- Filter out available replicas based on link status flag (#1440)
+- Respect `prefix` for `ZPOPMIN`, `ZPOPMAX`, `ZMSCORE`, `LMOVE`, `BLMOVE`, `SMISMEMBER` and `GEOSEARCH` (#1451, #1453, #1455, #1468)
+- Updated test infrastructure (#1510)
+
+### Fixed
+- Fixed Relay support when using Redis Cluster (#1397)
+- Fixed `cmsincrby()` type annotation (#1333)
+- Fixed `set()` type annotation (#1394)
+- Fixed operator precedence in connection factory (#1405)
+- Fixed a bug with `null` arguments in `set()` method (#1470, #1471)
+
+## v2.2.2 (2023-09-13)
+
+### Added
+- Added `client_info` client parameter
+- Added support for `CLUSTER` container command
+
+### Fixed
+- Fixed `EXPIRETIME` not using `prefix`
+- Disabled `CLIENT SETINFO` calls by default
+
+## v2.2.1 (2023-08-15)
+
+### Added
+- Added support for `WAITAOF` command (#1357)
+- Added support for `SHUTDOWN` command (#1359)
+- Added support for `FUNCTION` command (#1332)
+- Added support for new optional `PEXPIRE`, `PEXPIREAT` and `COMMAND`
+- Added missing Redis Stack commands to `KeyPrefixProcessor` (#1358)
+
+### Changed
+- Set client name and version when establishing a connection (#1347)
+
+## v2.2.0 (2023-06-14)
+
+Predis v2.2.0 introduces official support for [Redis Stack](https://redis.io/docs/stack/) as well as a [Relay](https://github.com/cachewerk/relay) integration for substantially [faster read performance](https://github.com/predis/predis/wiki/Using-Relay).
+
+### Added
+- Added support for [Relay](https://github.com/predis/predis/wiki/Using-Relay) (#1263)
+- Added support for `FCALL_RO` command (#1191)
+- Added support for Redis `JSON`, `Bloom`, `Search` and `TimeSeries`  module (#1253)
+- Added support for `ACL SETUSER, GETUSER, DRYRUN` commands (#1193)
+
+### Changed
+- Minor code style and type-hint changes (#1311)
+
+### Fixed
+- Fixed prefixes for `XTRIM` and `XREVRANGE` commands (#1230)
+- Fixed `fclose()` being called on invalid stream resource (#1199)
+- Fixed `BitByte` and `ExpireOptions` traits skip processing on null values (#1169)
+- Fixed missing `@return` annotations (#1265)
+- Fixed `GETDEL` prefixing (#1306)
+
+## v2.1.2 (2023-03-02)
+
+### Added
+- Added stream commands to `KeyPrefixProcessor` (#1051)
+- Added `ReplicationStrategy::$loadBalancing` option to disable replica reads (#1168)
+- Added support for `FCALL` and `FUNCTIONS` commands (#1049)
+- Added support for `PEXPIRETIME` command (#1031)
+- Added support for `EXPIRETIME` command (#1029)
+- Added support for `EVAL_RO` command (#1032)
+- Added support for `LCS` command (#1035)
+- Added support for `SORT_RO` command (#1044)
+- Added support for `SINTERCARD` command (#1027)
+- Added support for `EVALSHA_RO` command (#1034)
+- Added support for new arguments for `BITPOS` and `BITCOUNT` commands (#1045)
+- Added support for new arguments for `EXPIRE` and `EXPIREAT` commands (#1046)
+
+### Bug Fixes
+- Fixed deprecated function call syntax
+
+### Deprecated
+- Further deprecated phpiredis and webdis integration (#1179)
+
+### Maintenance
+- Applied coding standards
+- Pass PHPStan level 2
+
+## v2.1.1 (2023-01-17)
+
+### Bug Fixes
+- Fix `@template` in `Predis\Client` (#1017)
+- Fix support options array in `ZINTERSTORE` and `ZUNIONSTORE` (#1018)
+
+### Deprecated
+- Deprecated phpiredis and webdis connections
+
+## v2.1.0 (2023-01-16)
+
+### New Features
+- Implemented `GETEX` command (#872)
+- Implemented `GETDEL` command (#869)
+- Implemented `COPY` command (#866)
+- Implemented `FAILOVER` command (#875)
+- Implemented `LMOVE` command (#863)
+- Implemented `LMPOP` command (#1013)
+- Implemented `HRANDFIELD` command (#870)
+- Implemented `SMISMEMBER` command (#871)
+- Implemented `ZMPOP` command (#831)
+- Implemented `BLMOVE` command (#865)
+- Implemented `BLMPOP` command (#1015)
+- Implemented `BZMPOP` command (#833)
+- Implemented `BZPOPMIN` command (#862)
+- Implemented `BZPOPMAX` command (#864)
+- Implemented `ZUNION` command (#860)
+- Implemented `ZINTER` command (#859)
+- Implemented `ZINTERCARD` command (#861)
+- Implemented `ZRANGESTORE` command (#829)
+- Implemented `ZDIFFSTORE` command (#828)
+- Implemented `ZDIFF` command (#826)
+- Implemented `ZRANDMEMBER` command (#825)
+- Implemented `ZMSCORE` (#823)
+- Implemented `GEOSEARCH` command (#867)
+- Implemented `GEOSEARCHSTORE` command (#873)
+
+### Bug Fixes
+- Added annotations to suppress PHP 8.1 return type deprecation warning (#810)
+
+### Maintenance
+- Added mixin annotations for traits (#835)
+
+## v2.0.3 (2022-10-11)
+
+- Improved PHP 8.2 support
+- Call `is_resource()` before reading/writing
+- Added partial support for Redis Stream commands
+- Fixed Sentinel authentication issue
+
+## v2.0.2 (2022-09-06)
+
+- Fixed PHP 8.2 deprecation notice: Use of "static" in callables
+
+## v2.0.1 (2022-09-04)
+
+- Added retry interval to `RedisCluster` with a default of `10ms`
+- Avoid PHP 8.2 warning in `Connection\Parameters`
+- Fixed Sentinel reconnect issue in long-running PHP processes
+
+## v2.0.0 (2022-06-08)
+
+- Dropped support for PHP 7.1 and older
+
+- Accepted values for some client options have changed, this is the new list of
+  accepted values:
+
+  - `aggregate`: callable returning an aggregate connection.
+  - `cluster`: string value (`predis`, `redis`), callable returning an aggregate
+    connection.
+  - `replication`: string value (`predis`, `sentinel`), callable returning an
+    aggregate connection.
+  - `commands`: command factory, named array mapping command IDs to PHP classes,
+    callable returning a command factory or a named array.
+  - `connections`: connection factory, callable object returning a connection
+    factory, named array mapping URI schemes to PHP classes, string identifying
+    a supported combination of configurations for the connection factory.
+  - `prefix`: string value, command processor, callable.
+  - `exceptions`: boolean.
+
+  Note that both the `cluster` and `replication` options now return a closure
+  acting as initializer instead of an aggregate connection instance.
+
+- The `connections` client option now accepts certain string values identifying
+  certain combinations of configurations for the connection factory. Currently
+  this is used to provide a short way to configure Predis to load our phpiredis
+  based connection backends simply, accepted values are:
+
+  - `phpiredis-stream` maps `Phpiredis\Connection\PhpiredisStreamConnection` to
+    `tcp`, `redis`, `unix` URI schemes.
+  - `phpiredis-socket` maps `Phpiredis\Connection\PhpiredisSocketConnection` to
+    `tcp`, `redis`, `unix` URI schemes.
+  - `phpiredis-stream` is simply an alias of `phpiredis-stream`.
+
+- Added the new `Predis\Cluster\Hash\PhpiredisCRC16` class using ext-phpiredis
+  to speed-up the generation of the CRC16 hash of keys for redis-cluster. Predis
+  automatically uses this class when ext-phpiredis is loaded, but it is possible
+  to configure the hash generator using the new `crc16` client option (accepted
+  values `predis`, `phpiredis` or an hash generator instance).
+
+- Replication backends now use the `role` parameter instead of `alias` in order
+  to distinguish the role of a connection. Accepted values are `master`, `slave`
+  and, for redis-sentinel, `sentinel`. This led to a redesign of how connections
+  can be retrieved from replication backends: the method getConnectionById() now
+  retrieves a connection only by its ID (ip:port pair), to get a connection by
+  its alias there is the new method getConnectionByAlias(). This method is not
+  supported by the redis-sentinel backend due to its dynamic nature (connections
+  are retrieved and initialized at runtime from sentinels) but it is possible to
+  get a single connection from the pool by using its ID. It is also possible to
+  retrieve a connection by role using the method getConnectionByRole().
+
+- The concept of connection ID (ip:port pair) and connection alias (the `alias`
+  parameter) in `Predis\Connection\Cluster\PredisCluster` has been separated.
+  This change does not affect distribution and it is safe for existing clusters.
+
+- Client option classes now live in the `Predis\Configuration\Option` namespace.
+
+- Classes for Redis commands have been moved into the new `Predis\Command\Redis`
+  namespace and each class name mirrors the respective Redis command ID.
+
+- The concept of server profiles is gone, the library now uses a single command
+  factory to create instances of commands classes. The `profile` option has been
+  replaced by the `commands` option accepting `Predis\Command\FactoryInterface`
+  to customize the underlying command factory. The default command factory class
+  used by Predis is `Predis\Command\RedisFactory` and it still allows developers
+  to define or override commands with their own implementations. In addition to
+  that, `Predis\Command\RedisFactory` relies on a convention-over-configuration
+  approach by looking for a suitable class with the same name as the command ID
+  in the `Predis\Command\Redis` when the internal class map does not contain a
+  class associated.
+
+- The method `Predis\Client::getClientFor($connectionID)` has been replaced by
+  `getClientBy($selector, $value, $callable = null)` which is more flexible as
+  it is not limited to picking a connection from the underlying replication or
+  cluster backend by ID, but allows users to specify a `$selector` that can be
+  either `id` (the old behavior), `key`, `slot` or `command`. The client uses
+  duck-typing instead of type-checking to verify that the underlying connection
+  implements a method that matches the specified selector which means that some
+  selectors may not be available to all kinds of connection backends.
+
+- The method `Predis\Client::getConnectionById($connectionID)` has been removed.
+
+- Changed the signature for the constructor of `Predis\Command\RawCommand`.
+
+- The `Predis\Connection\Aggregate` namespace has been split into two separate
+  namespaces for cluster backends (`Predis\Connection\Cluster`) and replication
+  backends (`Predis\Connection\Replication`).
+
+- The method `Predis\Connection\AggregateConnectionInterface::getConnection()`
+  has been renamed to `getConnectionByCommand()`.
+
+- The methods `switchToMaster()` and `switchToSlave()` have been promoted to be
+  part of `Predis\Connection\Replication\ReplicationInterface` while the method
+  `switchTo($connection)` has been removed from it.
+
+- The method `Predis\Connection\Cluster\PredisCluster::executeCommandOnNodes()`
+  has been removed as it is possible to achieve the same by iterating over the
+  connection or, even better, over the client instance in order to execute the
+  same command against all of the registered connections.
+
+- The class `Predis\CommunicationException` now uses the correct default types
+  for the `$message` (string) and `$code` (integer) parameters.
+
+- The method `onConnectionError()` in `Predis\Connection\AbstractConnection`
+  class now passes the second argument as an integer value `0` as its default
+  value instead of `null`.
+
+- Support Pub/Sub and Pipelines when using replication
+
+- The class `Predis\Transaction\AbortedMultiExecException` now uses the correct
+  default types for the `$code` (integer) parameter.
+
+- __FIX__: using `strval` in `getScanOptions()` method, part of
+  `Predis\Collection\Iterator\CursorBasedIterator` to make sure we retrieve the
+  string value of `$this->match` and not passing `null` to `strlen()` function.
+
+- __FIX__: the value returned from `getArgument()` in `isReadOperation()` method,
+  part of `Predis\Replication\ReplicationStrategy` class, is checked to not pass
+  `null` to `sha1` function.
+
+- __FIX__: the value returned from `getArgument()` in `parseResponse()`method,
+  part of `Predis\Command\Redis\SENTINEL` class, is checked to not pass `null`
+  to `strtolower()` function.
+
+## v2.0.0-beta.1 (2022-05-26)
+
+Same as v2.0.0

FAQ.PERFORMANCES.md

@@ -1,79 +0,0 @@
-# Some frequently asked questions about the performances of Predis #
-____________________________________________
-
-
-### Predis is a pure-PHP implementation: it can not be fast enough! ###
-
-It really depends, but most of the times the answer is: _yes, it is fast enough_. I will give you
-a couple of easy numbers using a single Predis client with PHP 5.3.5 (custom build) and Redis 2.2
-(localhost) under Ubuntu 11.04 (running on a Intel Q6600):
-
-    19600 SET/sec using 12 bytes for both key and value
-    18900 GET/sec while retrieving the very same values
-    0.200 seconds to fetch 30000 keys using _KEYS *_.
-
-How does it compare with a nice C-based extension such as [__phpredis__](http://github.com/nicolasff/phpredis)?
-
-    30500 SET/sec using 12 bytes for both key and value
-    31000 GET/sec while retrieving the very same values
-    0.030 seconds to fetch 30000 keys using "KEYS *"".
-
-Wow, __phpredis__ looks so much faster! Well we are comparing a C extension with a pure-PHP library so
-lower numbers are quite expected, but there is a fundamental flaw in them: is this really how you are
-going to use Redis in your application? Are you really going to send thousands of commands in a for-loop
-for each page request using a single client instance? If so, well I guess you are probably doing something
-wrong. Also, if you need to SET or GET multiple keys you should definitely use commands such as MSET and
-MGET. You can also use pipelining to get more performances when this technique can be used.
-
-There is one more thing. We have tested the overhead of Predis by connecting on a localhost instance of
-Redis, but how these numbers change when we hit the network by connecting to instances of Redis that
-reside on other servers?
-
-    Using Predis:
-    3600 SET/sec using 12 bytes for both key and value
-    3600 GET/sec while retrieving the very same values
-    0.210 seconds to fetch 30000 keys using "KEYS *".
-
-    Using phpredis:
-    4000 SET/sec using 12 bytes for both key and value
-    4000 GET/sec while retrieving the very same values
-    0.051 seconds to fetch 30000 keys using "KEYS *".
-
-There you go, you get almost the same average numbers and the reason is quite simple: network latency
-is a real performance killer and you cannot do (almost) anything about that. As a disclaimer, please
-remember that we are measuring the overhead of client libraries implementations and the effects of the
-network round-trip time, we are not really measuring how fast Redis is. Redis shines the best with
-thousands of concurrent clients doing requests! Also, actual performances should be measured according
-to how your application will use Redis.
-
-
-### I am convinced, but performances for multi-bulk replies (e.g. _KEYS *_) are still worse ###
-
-Fair enough, but there is actually an option for you if you need even more speed and it consists on
-installing __[phpiredis](http://github.com/seppo0010/phpiredis)__ (note the additional _i_ in the
-name) and let Predis using it. __phpiredis__ is a C-based extension that wraps __hiredis__ (the
-official Redis C client library) with a thin layer that exposes its features to PHP. You will now
-get the benefits of a faster protocol parser just by adding a single line of code in your application:
-
-    $client = new Predis\Client('tcp://127.0.0.1', array(
-        'connections' => array('tcp' => 'Predis\Network\PhpiredisConnection')
-    ));
-
-As simple as it is, nothing will really change in the way you use the library in your application. So,
-how fast is it now? There are not much improvements for inline or short bulk replies (e.g. _SET_ or
-_GET_), but the speed for parsing multi-bulk replies is now on par with phpredis:
-
-    Using Predis with a phpiredis-based connection to fetch 30000 keys using _KEYS *_:
-
-    0.031 seconds from a local Redis instance
-    0.058 seconds from a remote Redis instance
-
-
-### If I need to install a C extension to get better performances, why not using phpredis? ###
-
-Good question. Generically speaking, if you need absolute uber-speed using localhost instances of Redis
-and you do not care about abstractions built around some Redis features such as MULTI / EXEC, or if you
-do not need any kind of extensibility or guaranteed backwards compatibility with different versions of
-Redis (Predis currently supports from 1.2 up to 2.2, and even the current development version), then
-using __phpredis__ can make sense for you. Otherwise, Predis is for you. Using __phpiredis__ gives you
-a nice speed bump, but it is not mandatory.

FAQ.md

@@ -1,58 +1,97 @@
-# Some frequently asked questions about Predis #
-____________________________________________
+# Frequently asked questions about Predis #
 
+## What is the point of Predis? ##
 
-### What is the point of Predis? ###
+The main point of Predis is about offering a highly customizable and extensible client for Redis,
+that can be easily extended by developers while still being reasonably fast. With Predis you can
+swap almost any class with your own custom implementation: you can have custom connection classes,
+new distribution strategies for client-side sharding, or handlers to replace or add Redis commands.
+All of this can be achieved without messing with the source code of the library and directly in your
+own application. Given the fast pace at which Redis is developed and adds new features, this can be
+a great asset since it allows developers to add new and still missing features or commands or change
+the standard behaviour of the library without the need to break dependencies in production code (at
+least to some degree).
 
-The main point of Predis is about offering a highly customizable client for Redis that can be easily
-extended by developers while still being reasonabily fast. With Predis you can swap almost any class
-used internally with your own custom implementation: you can build connection classes, or new
-distribution strategies for client-side sharding, or class handlers to replace existing commands or
-add new ones. All of this can be achieved without messing with the source code of the library and
-directly in your own application. Given the fast pace at which Redis is developed and adds new
-features, this can be a great asset that allows you to add new and still missing features or commands,
-or change the behaviour of the library without the need to break your dependencies in production code
-(well, at least to some degree).
+## Does Predis support UNIX domain sockets and persistent connections? ##
 
+Yes. Obviously persistent connections actually work only when using PHP configured as a persistent
+process reused by the web server (see [PHP-FPM](http://php-fpm.org)).
 
-### How about performances? ###
+## Does Predis support SSL-encrypted connections? ##
 
-Please refer to the dedicated __FAQ.PERFORMANCES__ file.
+Yes. Encrypted connections are mostly useful when connecting to Redis instances exposed by various
+cloud hosting providers without the need to configure an SSL proxy, but you should also take into
+account the general performances degradation especially during the connect() operation when the TLS
+handshake must be performed to secure the connection. Persistent SSL-encrypted connections may help
+in that respect, but they are supported only when running on PHP >= 7.0.0.
 
+## Does Predis support transparent (de)serialization of values? ##
 
-### Why PHP 5.3? ###
+When using [Relay](https://github.com/cachewerk/relay) as the underlying client, several
+serialization and compression algorithms are supported. This slightly increases CPU usage,
+but significantly reduces bytes sent over the network and Redis memory usage.
 
-Seriously, are you still using PHP 5.2 to build new applications? I assume that if you are throwing Redis
-in the mix, then you are probably coding something new after all. PHP 5.3 is faster, less memory hungry
-and has a few nice features such as namespaces and closures (kind of). More importantly, PHP 5.2 is not
-even officially supported anymore (aside from security patches). PHP 5.3 is not the future of PHP, but
-its current present. Furthermore, most of the existing frameworks out there are also making the switch
-with their respective new major versions. If you still insist on using PHP 5.2, you can get any recent
-backported release of Predis 0.6.x, or just use a different library.
+Without Relay, Predis will not serialize data and will never do that by default. The reason
+behind this decision is that serialization is usually something that developers prefer to
+customize depending on their needs and can not be easily generalized when using Redis because
+of the many possible access patterns for your data. This does not mean that it is impossible
+to have such a feature since you can leverage the extensibility of this library to define
+your own serialization-aware commands. You can find more details about how to do that
+[on this issue](http://github.com/predis/predis/issues/29#issuecomment-1202624).
 
+## How can I force Predis to connect to Redis before sending any command? ##
 
-### Why so many files for just one library? ###
+Explicitly connecting to Redis is usually not needed since the client initializes connections lazily
+only when they are needed. Admittedly, this behavior can be inconvenient in certain scenarios when
+you absolutely need to perform an upfront check to determine if the server is up and running and
+eventually catch exceptions on failures. Forcing the client to open the underlying connection can be
+done by invoking `Predis\Client::connect()`:
 
-Before v0.7, Predis used the one-big-file approach to distribute the library. As much as you prefer having
-just one file for everything, this kind of solution is actually not that good. Predis now complies with the
-[PSR-0](http://groups.google.com/group/php-standards/web/psr-0-final-proposal) standard to play nice with
-the major recent frameworks and libraries, so it needs an autoloader function to be defined. If you still
-want to have just one file grouping all the classes for whatever reason, then the __bin/create-single-file.php__
-script in the repository can generate it for you. There is also the __bin/create-phar.php__ script that
-generates a single [Phar archive](http://www.php.net/manual/en/intro.phar.php) of the whole library.
+```php
+$client = new Predis\Client();
 
+try {
+    $client->connect();
+} catch (Predis\Connection\ConnectionException $exception) {
+    // We could not connect to Redis! Your handling code goes here.
+}
 
-### Does Predis support UNIX domain sockets and persistent connections? ###
+$client->info();
+```
 
-Yes. Obviously, persistent connections actually work when using PHP configured as a persistent process that
-gets recycled between requests (see [PHP-FPM](http://php-fpm.org/)).
+## How Predis abstracts Redis commands? ##
 
+The approach used to implement Redis commands is quite simple: by default each command follows the
+same signature as defined on the [Redis documentation](http://redis.io/commands) which makes things
+pretty easy if you already know how Redis works or you need to look up how to use certain commands.
+Alternatively, variadic commands can accept an array for keys or values (depending on the command)
+instead of a list of arguments. Commands such as [`RPUSH`](http://redis.io/commands/rpush) and
+[`HMSET`](http://redis.io/commands/hmset) are great examples:
 
-### Does Predis support transparent (de)serialization of values? ###
+```php
+$client->rpush('my:list', 'value1', 'value2', 'value3');             // plain method arguments
+$client->rpush('my:list', ['value1', 'value2', 'value3']);           // single argument array
 
-No, and it will not ever do that for you by default. The reason behind this decision is that serialization
-is usually something that developers prefer to customize depending on their needs and can not be easily
-generalized when using Redis because of the many possible access patterns for the data. This does not
-mean that it is impossible to have such a feature, you can leverage Predis' extensibility to define your
-own serialization-aware commands. See [here](http://github.com/nrk/predis/issues/29#issuecomment-1202624)
-for more details on how to implement such a feature with a practical example.
+$client->hmset('my:hash', 'field1', 'value1', 'field2', 'value2');   // plain method arguments
+$client->hmset('my:hash', ['field1'=>'value1', 'field2'=>'value2']); // single named array
+```
+
+An exception to this rule is [`SORT`](http://redis.io/commands/sort) for which modifiers are passed
+[using a named array](tests/Predis/Command/KeySortTest.php#L54-L75).
+
+## When should I use Relay? ##
+
+If you care about performance, __always__. [Relay][relay] is free to use.
+
+## When should I use PhpRedis? ###
+
+Predis is fast enough when Redis is located on the same machine as PHP.
+
+[PhpRedis][phpredis] and [Relay][relay] perform significantly better when network I/O is involved,
+due to its ability to compress data by ~75%. Fewer bytes and received sent over the network
+[means faster operations][performance], and potentially cost savings when network traffic isn't
+free (e.g. AWS ElastiCache Inter-AZ transfer costs).
+
+[phpredis]: https://github.com/phpredis/phpredis
+[relay]: [https://github.com/phpredis/phpredis](https://github.com/cachewerk/relay)
+[performance]: https://akalongman.medium.com/phpredis-vs-predis-comparison-on-real-production-data-a819b48cbadb

LICENSE

@@ -1,22 +1,22 @@
-Copyright (c) 2009-2011 Daniele Alessandri
+MIT License
 
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without
-restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following
-conditions:
+Copyright (c) 2009-2020 Daniele Alessandri (original work)
+Copyright (c) 2021-2024 Till Krüss (modified work)
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,147 +1,331 @@
 # Predis #
 
-Predis is a flexible and feature-complete PHP (>= 5.3) client library for the Redis key-value store.
+[![Software license][ico-license]](LICENSE)
+[![Latest stable][ico-version-stable]][link-releases]
+[![Latest development][ico-version-dev]][link-releases]
+[![Monthly installs][ico-downloads-monthly]][link-downloads]
+[![Build status][ico-build]][link-actions]
+[![Coverage Status][ico-coverage]][link-coverage]
 
-For a list of frequently asked questions about Predis, see the __FAQ__ file in the root of the repository.
-For a version compatible with PHP 5.2 you must use the backported version from the latest release in the
-0.6.x series. More details are available on the [official wiki](http://wiki.github.com/nrk/predis) of the
-project,
+A flexible and feature-complete [Redis](http://redis.io) / [Valkey](https://github.com/valkey-io/valkey) client for PHP 7.2 and newer.
+
+More details about this project can be found on the [frequently asked questions](FAQ.md).
 
 
 ## Main features ##
 
-- Complete support for Redis from __1.2__ to __2.4__ and the current development versions using different
-  server profiles.
-- Client-side sharding with support for consistent hashing or custom distribution strategies.
-- Command pipelining on single and aggregated connections.
-- Transparent key prefixing strategy capable of handling any command known that has keys in its arguments.
-- Abstraction for Redis transactions (Redis >= 2.0) with support for CAS operations (Redis >= 2.2).
-- Connections to Redis instances are automatically and lazily estabilished upon the first call to a command.
-- Ability to connect to Redis using TCP/IP or UNIX domain sockets with support for persistent connections.
-- Ability to use alternative connection classes to use different types of network or protocol backends.
-- Flexible system to define and register your own set of commands or server profiles to client instances.
+- Support for Redis from __3.0__ to __8.0__.
+- Support for clustering using client-side sharding and pluggable keyspace distributors.
+- Support for [redis-cluster](http://redis.io/topics/cluster-tutorial) (Redis >= 3.0).
+- Support for master-slave replication setups and [redis-sentinel](http://redis.io/topics/sentinel).
+- Transparent key prefixing of keys using a customizable prefix strategy.
+- Command pipelining on both single nodes and clusters (client-side sharding only).
+- Abstraction for Redis transactions (Redis >= 2.0) and CAS operations (Redis >= 2.2).
+- Abstraction for Lua scripting (Redis >= 2.6) and automatic switching between `EVALSHA` or `EVAL`.
+- Abstraction for `SCAN`, `SSCAN`, `ZSCAN` and `HSCAN` (Redis >= 2.8) based on PHP iterators.
+- Connections are established lazily by the client upon the first command and can be persisted.
+- Connections can be established via TCP/IP (also TLS/SSL-encrypted) or UNIX domain sockets.
+- Support for custom connection classes for providing different network or protocol backends.
+- Flexible system for defining custom commands and override the default ones.
 
 
-## How to use Predis ##
+## How to _install_ and use Predis ##
 
-Predis is available on [Packagist](http://packagist.org/packages/predis/predis) for an easy installation
-using [Composer](http://packagist.org/about-composer). Composer helps you manage dependencies for your
-projects and libraries without much hassle which makes it the preferred way to get up and running with
-new applications. Alternatively, the library is available on [PearHub](http://pearhub.org/projects/predis)'s
-channel for a more traditional installation via PEAR. Zip and tar.gz archives are also downloadable from
-GitHub by browsing the list of [tagged releases](http://github.com/nrk/predis/tags).
+This library can be found on [Packagist](http://packagist.org/packages/predis/predis) for an easier
+management of projects dependencies using [Composer](http://packagist.org/about-composer).
+Compressed archives of each release are [available on GitHub](https://github.com/predis/predis/releases).
+
+```shell
+composer require predis/predis
+```
 
 
 ### Loading the library ###
 
-To automatically load all of its files, Predis relies on the autoloading features of PHP and complies
-with the [PSR-0 standard](http://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md) for
-interoperability with most of the major frameworks and libraries. Everything is transparently handled
-for you when installing the library using Composer, but you can also leverage its own autoloader class
-if you are going to use it in a project or script without any PSR-0 compliant autoloading facility:
+Predis relies on the autoloading features of PHP to load its files when needed and complies with the
+[PSR-4 standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md).
+Autoloading is handled automatically when dependencies are managed through Composer, but it is also
+possible to leverage its own autoloader in projects or scripts lacking any autoload facility:
 
-``` php
-<?php
-require PREDIS_BASE_PATH . '/Autoloader.php';
+```php
+// Prepend a base path if Predis is not available in your "include_path".
+require 'Predis/Autoloader.php';
 
 Predis\Autoloader::register();
 ```
 
-You can create a single [Phar](http://www.php.net/manual/en/intro.phar.php) archive from the repository
-just by launching the `bin/create-phar.php` executable script. The generated Phar archive ships with a
-stub defining an autoloader function for Predis, so you just need to require the Phar to be able to use
-the library.
 
-Alternatively you can generate a single PHP file that holds every class, just like older versions of
-Predis, using the `bin/create-single-file.php` executable sript. In this way you can load Predis in your
-scripts simply by using functions such as `require` and `include`, but this practice is not encouraged.
+### Connecting to Redis ###
 
+When creating a client instance without passing any connection parameter, Predis assumes `127.0.0.1`
+and `6379` as default host and port. The default timeout for the `connect()` operation is 5 seconds:
 
-### Connecting to a local instance of Redis ###
-
-When connecting to local instance of Redis (`127.0.0.1` on port `6379`), you do not have to specify any
-additional parameter to create a new client instance:
-
-``` php
-<?php
-$redis = new Predis\Client();
-$redis->set('foo', 'bar');
-$value = $redis->get('foo');
+```php
+$client = new Predis\Client();
+$client->set('foo', 'bar');
+$value = $client->get('foo');
 ```
 
-However you can use an URI string or a named array to specify the needed connection parameters:
+Connection parameters can be supplied either in the form of URI strings or named arrays. The latter
+is the preferred way to supply parameters, but URI strings can be useful when parameters are read
+from non-structured or partially-structured sources:
 
-``` php
-<?php
-$redis = new Predis\Client('tcp://10.0.0.1:6379');
-
-// is equivalent to:
-
-$redis = new Predis\Client(array(
+```php
+// Parameters passed using a named array:
+$client = new Predis\Client([
     'scheme' => 'tcp',
     'host'   => '10.0.0.1',
     'port'   => 6379,
-));
+]);
+
+// Same set of parameters, passed using an URI string:
+$client = new Predis\Client('tcp://10.0.0.1:6379');
 ```
 
+Password protected servers can be accessed by adding `password` to the parameters set. When ACLs are
+enabled on Redis >= 6.0, both `username` and `password` are required for user authentication.
 
-### Pipelining multiple commands to multiple instances of Redis with client-side sharding ###
+It is also possible to connect to local instances of Redis using UNIX domain sockets, in this case
+the parameters must use the `unix` scheme and specify a path for the socket file:
 
-Pipelining helps with performances when there is the need to send many commands to a server in one go.
-Furthermore, pipelining works transparently even on aggregated connections. To achieve this, Predis
-supports client-side sharding using consistent-hashing on keys while clustered connections are supported
-natively by the client class.
+```php
+$client = new Predis\Client(['scheme' => 'unix', 'path' => '/path/to/redis.sock']);
+$client = new Predis\Client('unix:/path/to/redis.sock');
+```
 
-``` php
-<?php
-$redis = new Predis\Client(array(
-    array('host' => '10.0.0.1', 'port' => 6379),
-    array('host' => '10.0.0.2', 'port' => 6379)
-));
+The client can leverage TLS/SSL encryption to connect to secured remote Redis instances without the
+need to configure an SSL proxy like stunnel. This can be useful when connecting to nodes running on
+various cloud hosting providers. Encryption can be enabled with using the `tls` scheme and an array
+of suitable [options](http://php.net/manual/context.ssl.php) passed via the `ssl` parameter:
 
-$replies = $redis->pipeline(function($pipe) {
+```php
+// Named array of connection parameters:
+$client = new Predis\Client([
+  'scheme' => 'tls',
+  'ssl'    => ['cafile' => 'private.pem', 'verify_peer' => true],
+]);
+
+// Same set of parameters, but using an URI string:
+$client = new Predis\Client('tls://127.0.0.1?ssl[cafile]=private.pem&ssl[verify_peer]=1');
+```
+
+The connection schemes [`redis`](http://www.iana.org/assignments/uri-schemes/prov/redis) (alias of
+`tcp`) and [`rediss`](http://www.iana.org/assignments/uri-schemes/prov/rediss) (alias of `tls`) are
+also supported, with the difference that URI strings containing these schemes are parsed following
+the rules described on their respective IANA provisional registration documents.
+
+The actual list of supported connection parameters can vary depending on each connection backend so
+it is recommended to refer to their specific documentation or implementation for details.
+
+Predis can aggregate multiple connections when providing an array of connection parameters and the
+appropriate option to instruct the client about how to aggregate them (clustering, replication or a
+custom aggregation logic). Named arrays and URI strings can be mixed when providing configurations
+for each node:
+
+```php
+$client = new Predis\Client([
+    'tcp://10.0.0.1?alias=first-node', ['host' => '10.0.0.2', 'alias' => 'second-node'],
+], [
+    'cluster' => 'predis',
+]);
+```
+
+See the [aggregate connections](#aggregate-connections) section of this document for more details.
+
+Connections to Redis are lazy meaning that the client connects to a server only if and when needed.
+While it is recommended to let the client do its own stuff under the hood, there may be times when
+it is still desired to have control of when the connection is opened or closed: this can easily be
+achieved by invoking `$client->connect()` and `$client->disconnect()`. Please note that the effect
+of these methods on aggregate connections may differ depending on each specific implementation.
+
+
+### Client configuration ###
+
+Many aspects and behaviors of the client can be configured by passing specific client options to the
+second argument of `Predis\Client::__construct()`:
+
+```php
+$client = new Predis\Client($parameters, ['prefix' => 'sample:']);
+```
+
+Options are managed using a mini DI-alike container and their values can be lazily initialized only
+when needed. The client options supported by default in Predis are:
+
+  - `prefix`: prefix string applied to every key found in commands.
+  - `exceptions`: whether the client should throw or return responses upon Redis errors.
+  - `connections`: list of connection backends or a connection factory instance.
+  - `cluster`: specifies a cluster backend (`predis`, `redis` or callable).
+  - `replication`: specifies a replication backend (`predis`, `sentinel` or callable).
+  - `aggregate`: configures the client with a custom aggregate connection (callable).
+  - `parameters`: list of default connection parameters for aggregate connections.
+  - `commands`: specifies a command factory instance to use through the library.
+
+Users can also provide custom options with values or callable objects (for lazy initialization) that
+are stored in the options container for later use through the library.
+
+
+### Aggregate connections ###
+
+Aggregate connections are the foundation upon which Predis implements clustering and replication and
+they are used to group multiple connections to single Redis nodes and hide the specific logic needed
+to handle them properly depending on the context. Aggregate connections usually require an array of
+connection parameters along with the appropriate client option when creating a new client instance.
+
+#### Cluster ####
+
+Predis can be configured to work in clustering mode with a traditional client-side sharding approach
+to create a cluster of independent nodes and distribute the keyspace among them. This approach needs
+some sort of external health monitoring of nodes and requires the keyspace to be rebalanced manually
+when nodes are added or removed:
+
+```php
+$parameters = ['tcp://10.0.0.1', 'tcp://10.0.0.2', 'tcp://10.0.0.3'];
+$options    = ['cluster' => 'predis'];
+
+$client = new Predis\Client($parameters);
+```
+
+Along with Redis 3.0, a new supervised and coordinated type of clustering was introduced in the form
+of [redis-cluster](http://redis.io/topics/cluster-tutorial). This kind of approach uses a different
+algorithm to distribute the keyspaces, with Redis nodes coordinating themselves by communicating via
+a gossip protocol to handle health status, rebalancing, nodes discovery and request redirection. In
+order to connect to a cluster managed by redis-cluster, the client requires a list of its nodes (not
+necessarily complete since it will automatically discover new nodes if necessary) and the `cluster`
+client options set to `redis`:
+
+```php
+$parameters = ['tcp://10.0.0.1', 'tcp://10.0.0.2', 'tcp://10.0.0.3'];
+$options    = ['cluster' => 'redis'];
+
+$client = new Predis\Client($parameters, $options);
+```
+
+#### Replication ####
+
+The client can be configured to operate in a single master / multiple slaves setup to provide better
+service availability. When using replication, Predis recognizes read-only commands and sends them to
+a random slave in order to provide some sort of load-balancing and switches to the master as soon as
+it detects a command that performs any kind of operation that would end up modifying the keyspace or
+the value of a key. Instead of raising a connection error when a slave fails, the client attempts to
+fall back to a different slave among the ones provided in the configuration.
+
+The basic configuration needed to use the client in replication mode requires one Redis server to be
+identified as the master (this can be done via connection parameters by setting the `role` parameter
+to `master`) and one or more slaves (in this case setting `role` to `slave` for slaves is optional):
+
+```php
+$parameters = ['tcp://10.0.0.1?role=master', 'tcp://10.0.0.2', 'tcp://10.0.0.3'];
+$options    = ['replication' => 'predis'];
+
+$client = new Predis\Client($parameters, $options);
+```
+
+The above configuration has a static list of servers and relies entirely on the client's logic, but
+it is possible to rely on [`redis-sentinel`](http://redis.io/topics/sentinel) for a more robust HA
+environment with sentinel servers acting as a source of authority for clients for service discovery.
+The minimum configuration required by the client to work with redis-sentinel is a list of connection
+parameters pointing to a bunch of sentinel instances, the `replication` option set to `sentinel` and
+the `service` option set to the name of the service:
+
+```php
+$sentinels = ['tcp://10.0.0.1', 'tcp://10.0.0.2', 'tcp://10.0.0.3'];
+$options   = ['replication' => 'sentinel', 'service' => 'mymaster'];
+
+$client = new Predis\Client($sentinels, $options);
+```
+
+If the master and slave nodes are configured to require an authentication from clients, a password
+must be provided via the global `parameters` client option. This option can also be used to specify
+a different database index. The client options array would then look like this:
+
+```php
+$options = [
+    'replication' => 'sentinel',
+    'service' => 'mymaster',
+    'parameters' => [
+        'password' => $secretpassword,
+        'database' => 10,
+    ],
+];
+```
+
+While Predis is able to distinguish commands performing write and read-only operations, `EVAL` and
+`EVALSHA` represent a corner case in which the client switches to the master node because it cannot
+tell when a Lua script is safe to be executed on slaves. While this is indeed the default behavior,
+when certain Lua scripts do not perform write operations it is possible to provide an hint to tell
+the client to stick with slaves for their execution:
+
+```php
+$parameters = ['tcp://10.0.0.1?role=master', 'tcp://10.0.0.2', 'tcp://10.0.0.3'];
+$options    = ['replication' => function () {
+    // Set scripts that won't trigger a switch from a slave to the master node.
+    $strategy = new Predis\Replication\ReplicationStrategy();
+    $strategy->setScriptReadOnly($LUA_SCRIPT);
+
+    return new Predis\Connection\Replication\MasterSlaveReplication($strategy);
+}];
+
+$client = new Predis\Client($parameters, $options);
+$client->eval($LUA_SCRIPT, 0);             // Sticks to slave using `eval`...
+$client->evalsha(sha1($LUA_SCRIPT), 0);    // ... and `evalsha`, too.
+```
+
+The [`examples`](examples/) directory contains a few scripts that demonstrate how the client can be
+configured and used to leverage replication in both basic and complex scenarios.
+
+
+### Command pipelines ###
+
+Pipelining can help with performances when many commands need to be sent to a server by reducing the
+latency introduced by network round-trip timings. Pipelining also works with aggregate connections.
+The client can execute the pipeline inside a callable block or return a pipeline instance with the
+ability to chain commands thanks to its fluent interface:
+
+```php
+// Executes a pipeline inside the given callable block:
+$responses = $client->pipeline(function ($pipe) {
     for ($i = 0; $i < 1000; $i++) {
         $pipe->set("key:$i", str_pad($i, 4, '0', 0));
         $pipe->get("key:$i");
     }
 });
+
+// Returns a pipeline that can be chained thanks to its fluent interface:
+$responses = $client->pipeline()->set('foo', 'bar')->get('foo')->execute();
 ```
 
 
-### Overriding standard connection classes with custom ones ###
+### Transactions ###
 
-Predis allows developers to create new connection classes to add support for new protocols or override
-the existing ones and provide a different implementation compared to the default classes. This can be
-obtained by subclassing the `Predis\Network\IConnectionSingle` interface.
+The client provides an abstraction for Redis transactions based on `MULTI` and `EXEC` with a similar
+interface to command pipelines:
 
-``` php
-<?php
-class MyConnectionClass implements Predis\Network\IConnectionSingle
-{
-    // implementation goes here
-}
+```php
+// Executes a transaction inside the given callable block:
+$responses = $client->transaction(function ($tx) {
+    $tx->set('foo', 'bar');
+    $tx->get('foo');
+});
 
-// Let Predis automatically use your own class to handle connections identified by the tcp scheme.
-$client = new Predis\Client('tcp://127.0.0.1', array(
-    'connections' => array('tcp' => 'MyConnectionClass')
-));
+// Returns a transaction that can be chained thanks to its fluent interface:
+$responses = $client->transaction()->set('foo', 'bar')->get('foo')->execute();
 ```
 
-The classes contained in the `Predis\Network` namespace give you a better insight with actual code on
-how to create new connection classes.
+This abstraction can perform check-and-set operations thanks to `WATCH` and `UNWATCH` and provides
+automatic retries of transactions aborted by Redis when `WATCH`ed keys are touched. For an example
+of a transaction using CAS you can see [the following example](examples/transaction_using_cas.php).
 
 
-### Defining and registering new commands on the client at runtime ###
+### Adding new commands ###
 
-Let's suppose Redis just added the support for a brand new feature associated with a new command. If
-you want to start using the above mentioned new feature right away without messing with Predis source
-code or waiting for it to find its way into a stable Predis release, then you can start off by creating
-a new class that matches the command type and its behaviour and then bind it to a client instance at
-runtime. Actually, it is easier done than said:
+While we try to update Predis to stay up to date with all the commands available in Redis, you might
+prefer to stick with an old version of the library or provide a different way to filter arguments or
+parse responses for specific commands. To achieve that, Predis provides the ability to implement new
+command classes to define or override commands in the default command factory used by the client:
 
-``` php
-<?php
-class BrandNewRedisCommand extends Predis\Commands\Command
+```php
+// Define a new command by extending Predis\Command\Command:
+class BrandNewRedisCommand extends Predis\Command\Command
 {
     public function getId()
     {
@@ -149,72 +333,134 @@ class BrandNewRedisCommand extends Predis\Commands\Command
     }
 }
 
-$redis = new Predis\Client();
-$redis->getProfile()->defineCommand('newcmd', 'BrandNewRedisCommand');
-$redis->newcmd();
+// Inject your command in the current command factory:
+$client = new Predis\Client($parameters, [
+    'commands' => [
+        'newcmd' => 'BrandNewRedisCommand',
+    ],
+]);
+
+$response = $client->newcmd();
+```
+
+There is also a method to send raw commands without filtering their arguments or parsing responses.
+Users must provide the list of arguments for the command as an array, following the signatures as
+defined by the [Redis documentation for commands](http://redis.io/commands):
+
+```php
+$response = $client->executeRaw(['SET', 'foo', 'bar']);
 ```
 
 
-## Test suite ##
+### Script commands ###
 
-__ATTENTION__: Do not ever run the test suite shipped with Predis against instances of Redis running in
-production environments or containing data you are interested in!
+While it is possible to leverage [Lua scripting](http://redis.io/commands/eval) on Redis 2.6+ using
+directly [`EVAL`](http://redis.io/commands/eval) and [`EVALSHA`](http://redis.io/commands/evalsha),
+Predis offers script commands as an higher level abstraction built upon them to make things simple.
+Script commands can be registered in the command factory used by the client and are accessible as if
+they were plain Redis commands, but they define Lua scripts that get transmitted to the server for
+remote execution. Internally they use [`EVALSHA`](http://redis.io/commands/evalsha) by default and
+identify a script by its SHA1 hash to save bandwidth, but [`EVAL`](http://redis.io/commands/eval)
+is used as a fall back when needed:
 
-Predis has a comprehensive test suite covering every aspect of the library. The suite performs integration
-tests against a running instance of Redis (>= 2.4.0 is required) to verify the correct behaviour of the
-implementation of each command and automatically skips commands not defined in the selected version of
-Redis. If you do not have Redis up and running, integration tests can be disabled. By default, the test
-suite is configured to execute integration tests using the server profile for Redis v2.4 (which is the
-current stable version of Redis). You can optionally run the suite against a Redis instance built from
-the `unstable` branch with the development profile by changing the `REDIS_SERVER_VERSION` to `dev` in
-the `phpunit.xml` file. More details about testing Predis are available in `tests/README.md`.
+```php
+// Define a new script command by extending Predis\Command\ScriptCommand:
+class ListPushRandomValue extends Predis\Command\ScriptCommand
+{
+    public function getKeysCount()
+    {
+        return 1;
+    }
 
-Predis uses Travis CI for continuous integration. You can find the results of the test suite and the build
-history [on its project page](http://travis-ci.org/nrk/predis).
+    public function getScript()
+    {
+        return <<<LUA
+math.randomseed(ARGV[1])
+local rnd = tostring(math.random())
+redis.call('lpush', KEYS[1], rnd)
+return rnd
+LUA;
+    }
+}
+
+// Inject the script command in the current command factory:
+$client = new Predis\Client($parameters, [
+    'commands' => [
+        'lpushrand' => 'ListPushRandomValue',
+    ],
+]);
+
+$response = $client->lpushrand('random_values', $seed = mt_rand());
+```
 
 
-## Contributing ##
+### Customizable connection backends ###
 
-If you want to work on Predis, it is highly recommended that you first run the test suite in order to
-check that everything is OK, and report strange behaviours or bugs. When modifying Predis please make
-sure that no warnings or notices are emitted by PHP by running the interpreter in your development
-environment with the `error_reporting` variable set to `E_ALL | E_STRICT`.
+Predis can use different connection backends to connect to Redis. The builtin Relay integration
+leverages the [Relay](https://github.com/cachewerk/relay) extension for PHP for major performance
+gains, by caching a partial replica of the Redis dataset in PHP shared runtime memory.
 
-The recommended way to contribute to Predis is to fork the project on GitHub, create new topic branches
-on your newly created repository to fix or add features (possibly with tests covering your modifications)
-and then open a new pull request with a description of the applied changes. Obviously you can use any
-other Git hosting provider of your preference.
+```php
+$client = new Predis\Client('tcp://127.0.0.1', [
+    'connections' => 'relay',
+]);
+```
+
+Developers can create their own connection classes to support whole new network backends, extend
+existing classes or provide completely different implementations. Connection classes must implement
+`Predis\Connection\NodeConnectionInterface` or extend `Predis\Connection\AbstractConnection`:
+
+```php
+class MyConnectionClass implements Predis\Connection\NodeConnectionInterface
+{
+    // Implementation goes here...
+}
+
+// Use MyConnectionClass to handle connections for the `tcp` scheme:
+$client = new Predis\Client('tcp://127.0.0.1', [
+    'connections' => ['tcp' => 'MyConnectionClass'],
+]);
+```
+
+For a more in-depth insight on how to create new connection backends you can refer to the actual
+implementation of the standard connection classes available in the `Predis\Connection` namespace.
 
 
-## Dependencies ##
+## Development ##
 
-- PHP >= 5.3.2
-- PHPUnit >= 3.5.0 (needed to run the test suite)
 
-## Links ##
+### Reporting bugs and contributing code ###
 
-### Project ###
-- [Source code](http://github.com/nrk/predis/)
-- [Wiki](http://wiki.github.com/nrk/predis/)
-- [Issue tracker](http://github.com/nrk/predis/issues)
+Contributions to Predis 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 issue and pull request templates.
 
-### Related ###
-- [Redis](http://redis.io/)
-- [PHP](http://php.net/)
-- [PHPUnit](http://www.phpunit.de/)
-- [Git](http://git-scm.com/)
 
-## Author ##
+### Test suite ###
 
-- [Daniele Alessandri](mailto:suppakilla@gmail.com) ([twitter](http://twitter.com/JoL1hAHN))
+__ATTENTION__: Do not ever run the test suite shipped with Predis against instances of Redis running
+in production environments or containing data you are interested in!
 
-## Contributors ##
+Predis has a comprehensive test suite covering every aspect of the library and that can optionally
+perform integration tests against a running instance of Redis (required >= 2.4.0 in order to verify
+the correct behavior of the implementation of each command. Integration tests for unsupported Redis
+commands are automatically skipped. If you do not have Redis up and running, integration tests can
+be disabled. See [the tests README](tests/README.md) for more details about testing this library.
 
-- [Lorenzo Castelli](http://github.com/lcastelli)
-- [Jordi Boggiano](http://github.com/Seldaek) ([twitter](http://twitter.com/seldaek))
-- [Sebastian Waisbrot](http://github.com/seppo0010) ([twitter](http://twitter.com/seppo0010))
-  for his work on extending [phpiredis](http://github.com/seppo0010/phpiredis) for Predis
+Predis uses GitHub Actions for continuous integration and the history for past and current builds can be
+found [on its actions page](https://github.com/predis/predis/actions).
 
-## License ##
+### License ###
 
-The code for Predis is distributed under the terms of the MIT license (see LICENSE).
+The code for Predis is distributed under the terms of the MIT license (see [LICENSE](LICENSE)).
+
+[ico-license]: https://img.shields.io/github/license/predis/predis.svg?style=flat-square
+[ico-version-stable]: https://img.shields.io/github/v/tag/predis/predis?label=stable&style=flat-square
+[ico-version-dev]: https://img.shields.io/github/v/tag/predis/predis?include_prereleases&label=pre-release&style=flat-square
+[ico-downloads-monthly]: https://img.shields.io/packagist/dm/predis/predis.svg?style=flat-square
+[ico-build]: https://img.shields.io/github/actions/workflow/status/predis/predis/tests.yml?branch=main&style=flat-square
+[ico-coverage]: https://img.shields.io/coverallsCoverage/github/predis/predis?style=flat-square
+
+[link-releases]: https://github.com/predis/predis/releases
+[link-actions]: https://github.com/predis/predis/actions
+[link-downloads]: https://packagist.org/packages/predis/predis/stats
+[link-coverage]: https://coveralls.io/github/predis/predis

TODO

@@ -1,4 +0,0 @@
-* Documentation! The README is obviously not enought to show how to use Predis
-  as it does not cover all of its features.
-
-* [v0.8] Implement smart and transparent support for redis-cluster.

VERSION

@@ -1 +1 @@
-0.7.0
+2.4.0

autoload.php

@@ -3,12 +3,10 @@
 /*
  * This file is part of the Predis package.
  *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 
-require __DIR__.'/lib/Predis/Autoloader.php';
+require __DIR__.'/src/Autoloader.php';
 
 Predis\Autoloader::register();

bin/create-command-test

@@ -4,8 +4,6 @@
 /*
  * This file is part of the Predis package.
  *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
@@ -13,11 +11,11 @@
 // -------------------------------------------------------------------------- //
 // This script can be used to automatically generate a file with the scheleton
 // of a test case to test a Redis command by specifying the name of the class
-// in the Predis\Commands namespace (only classes in this namespace are valid).
+// in the Predis\Command namespace (only classes in this namespace are valid).
 // For example, to generate a test case for SET (which is represented by the
-// Predis\Commands\StringSet class):
+// Predis\Command\Redis\StringSet class):
 //
-//   $ ./bin/generate-command-test.php --class=StringSet
+//   $ ./bin/generate-command-test --class=StringSet
 //
 // Here is a list of optional arguments:
 //
@@ -33,18 +31,23 @@
 // is explicitly specified.
 // -------------------------------------------------------------------------- //
 
-use Predis\Commands\ICommand;
-use Predis\Commands\IPrefixable;
+use Predis\Command\CommandInterface;
+use Predis\Command\PrefixableCommandInterface;
 
 class CommandTestCaseGenerator
 {
     private $options;
 
-    public function __construct(Array $options)
+    public function __construct(array $options)
     {
         if (!isset($options['class'])) {
             throw new RuntimeException("Missing 'class' option.");
         }
+
+        if (!isset($options['realm'])) {
+            throw new RuntimeException("Missing 'realm' option.");
+        }
+
         $this->options = $options;
     }
 
@@ -61,7 +64,7 @@ class CommandTestCaseGenerator
 
         $options = array(
             'overwrite' => false,
-            'tests' => __DIR__.'/../tests',
+            'tests' => __DIR__.'/../tests/Predis',
         );
 
         foreach ($getops as $option => $value) {
@@ -92,16 +95,20 @@ class CommandTestCaseGenerator
             throw new RuntimeException("Missing 'class' option.");
         }
 
-        $options['fqn'] = "Predis\\Commands\\{$options['class']}";
-        $options['path'] = "Predis/Commands/{$options['class']}.php";
+        if (!isset($options['realm'])) {
+            throw new RuntimeException("Missing 'realm' option.");
+        }
 
-        $source = __DIR__.'/../lib/'.$options['path'];
+        $options['fqn'] = "Predis\\Command\\Redis\\{$options['class']}";
+        $options['path'] = "Command/Redis/{$options['class']}.php";
+
+        $source = __DIR__.'/../src/'.$options['path'];
         if (!file_exists($source)) {
             throw new RuntimeException("Cannot find class file for {$options['fqn']} in $source.");
         }
 
         if (!isset($options['output'])) {
-            $options['output'] = sprintf("%s/%s", $options['tests'], str_replace('.php', 'Test.php', $options['path']));
+            $options['output'] = sprintf("%s/%s", $options['tests'], str_replace('.php', '_Test.php', $options['path']));
         }
 
         return new self($options);
@@ -109,17 +116,11 @@ class CommandTestCaseGenerator
 
     protected function getTestRealm()
     {
-        if (isset($this->options['realm'])) {
-            if (!$this->options['realm']) {
-                throw new RuntimeException('Invalid value for realm has been sepcified (empty).');
-            }
-            return $this->options['realm'];
+        if (empty($this->options['realm'])) {
+            throw new RuntimeException('Invalid value for realm has been specified (empty).');
         }
 
-        $class = array_pop(explode('\\', $this->options['fqn']));
-        list($realm,) = preg_split('/([[:upper:]][[:lower:]]+)/', $class, 2, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
-
-        return strtolower($realm);
+        return $this->options['realm'];
     }
 
     public function generate()
@@ -129,11 +130,16 @@ class CommandTestCaseGenerator
         if (!$reflection->isInstantiable()) {
             throw new RuntimeException("Class $class must be instantiable, abstract classes or interfaces are not allowed.");
         }
-        if (!$reflection->implementsInterface('Predis\Commands\ICommand')) {
-            throw new RuntimeException("Class $class must implement the Predis\Commands\ICommand interface.");
+
+        if (!$reflection->implementsInterface('Predis\Command\CommandInterface')) {
+            throw new RuntimeException("Class $class must implement Predis\Command\CommandInterface.");
         }
 
+        /*
+         * @var CommandInterface
+         */
         $instance = $reflection->newInstance();
+
         $buffer = $this->getTestCaseBuffer($instance);
 
         return $buffer;
@@ -148,11 +154,12 @@ class CommandTestCaseGenerator
         file_put_contents($options['output'], $this->generate());
     }
 
-    protected function getTestCaseBuffer(ICommand $instance)
+    protected function getTestCaseBuffer(CommandInterface $instance)
     {
         $id = $instance->getId();
         $fqn = get_class($instance);
-        $class = array_pop(explode('\\', $fqn)) . "Test";
+        $fqnParts = explode('\\', $fqn);
+        $class = array_pop($fqnParts) . "Test";
         $realm = $this->getTestRealm();
 
         $buffer =<<<PHP
@@ -161,26 +168,22 @@ class CommandTestCaseGenerator
 /*
  * This file is part of the Predis package.
  *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 
-namespace Predis\Commands;
-
-use \PHPUnit_Framework_TestCase as StandardTestCase;
+namespace Predis\Command\Redis;
 
 /**
  * @group commands
  * @group realm-$realm
  */
-class $class extends CommandTestCase
+class $class extends PredisCommandTestCase
 {
     /**
      * {@inheritdoc}
      */
-    protected function getExpectedCommand()
+    protected function getExpectedCommand(): string
     {
         return '$fqn';
     }
@@ -188,7 +191,7 @@ class $class extends CommandTestCase
     /**
      * {@inheritdoc}
      */
-    protected function getExpectedId()
+    protected function getExpectedId(): string
     {
         return '$id';
     }
@@ -196,7 +199,7 @@ class $class extends CommandTestCase
     /**
      * @group disconnected
      */
-    public function testFilterArguments()
+    public function testFilterArguments(): void
     {
         \$this->markTestIncomplete('This test has not been implemented yet.');
 
@@ -212,7 +215,7 @@ class $class extends CommandTestCase
     /**
      * @group disconnected
      */
-    public function testParseResponse()
+    public function testParseResponse(): void
     {
         \$this->markTestIncomplete('This test has not been implemented yet.');
 
@@ -226,13 +229,13 @@ class $class extends CommandTestCase
 
 PHP;
 
-        if ($instance instanceof IPrefixable) {
+        if ($instance instanceof PrefixableCommandInterface) {
             $buffer .=<<<PHP
 
     /**
      * @group disconnected
      */
-    public function testPrefixKeys()
+    public function testPrefixKeys(): void
     {
         \$this->markTestIncomplete('This test has not been implemented yet.');
 
@@ -245,6 +248,17 @@ PHP;
         \$this->assertSame(\$expected, \$command->getArguments());
     }
 
+    /**
+     * @group disconnected
+     */
+    public function testPrefixKeysIgnoredOnEmptyArguments(): void
+    {
+        \$command = \$this->getCommand();
+        \$command->prefixKeys('prefix:');
+
+        \$this->assertSame(array(), \$command->getArguments());
+    }
+
 PHP;
         }
 

bin/create-phar.php

@@ -1,71 +0,0 @@
-#!/usr/bin/env php
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-// -------------------------------------------------------------------------- //
-// In order to be able to execute this script to create a Phar archive of Predis,
-// the Phar module must be loaded and the "phar.readonly" directive php.ini must
-// be set to "off". You can change the values in the $options array to customize
-// the creation of the Phar archive to better suit your needs.
-// -------------------------------------------------------------------------- //
-
-$options = array(
-    'name'           => 'predis',
-    'project_path'   => __DIR__ . '/../lib/',
-    'compression'    => Phar::NONE,
-    'append_version' => true,
-);
-
-function getPharFilename($options)
-{
-    $filename = $options['name'];
-
-    // NOTE: do not consider "append_version" with Phar compression do to a bug in
-    // Phar::compress() when renaming phar archives containing dots in their name.
-    if ($options['append_version'] && $options['compression'] === Phar::NONE) {
-        $versionFile = @fopen(__DIR__ . '/../VERSION', 'r');
-
-        if ($versionFile === false) {
-            throw new Exception("Could not locate the VERSION file.");
-        }
-
-        $version = trim(fgets($versionFile));
-        fclose($versionFile);
-        $filename .= "_$version";
-    }
-
-    return "$filename.phar";
-}
-
-function getPharStub($options)
-{
-    return <<<EOSTUB
-<?php
-Phar::mapPhar('predis.phar');
-spl_autoload_register(function(\$class) {
-    if (strpos(\$class, 'Predis\\\\') === 0) {
-        \$file = 'phar://predis.phar/'.strtr(\$class, '\\\', '/').'.php';
-        if (file_exists(\$file)) {
-            require \$file;
-            return true;
-        }
-    }
-});
-__HALT_COMPILER();
-EOSTUB;
-}
-
-// -------------------------------------------------------------------------- //
-
-$phar = new Phar(getPharFilename($options));
-$phar->compress($options['compression']);
-$phar->setStub(getPharStub($options));
-$phar->buildFromDirectory($options['project_path']);

bin/create-single-file.php

@@ -1,605 +0,0 @@
-#!/usr/bin/env php
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-// -------------------------------------------------------------------------- //
-// This script can be used to automatically glue all the .php files of Predis
-// into a single monolithic script file that can be used without an autoloader,
-// just like the other previous versions of the library.
-//
-// Much of its complexity is due to the fact that we cannot simply join PHP
-// files, but namespaces and classes definitions must follow a precise order
-// when dealing with subclassing and inheritance.
-//
-// The current implementation is pretty naïve, but it should do for now.
-// -------------------------------------------------------------------------- //
-
-class CommandLine
-{
-    public static function getOptions()
-    {
-        $parameters = array(
-            's:'  => 'source:',
-            'o:'  => 'output:',
-            'e:'  => 'exclude:',
-            'E:'  => 'exclude-classes:',
-        );
-
-        $getops = getopt(implode(array_keys($parameters)), $parameters);
-
-        $options = array(
-            'source'  => __DIR__ . "/../lib/",
-            'output'  => PredisFile::NS_ROOT . '.php',
-            'exclude' => array(),
-        );
-
-        foreach ($getops as $option => $value) {
-            switch ($option) {
-                case 's':
-                case 'source':
-                    $options['source'] = $value;
-                    break;
-
-                case 'o':
-                case 'output':
-                    $options['output'] = $value;
-                    break;
-
-                case 'E':
-                case 'exclude-classes':
-                    $options['exclude'] = @file($value, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES) ?: $value;
-                    break;
-
-                case 'e':
-                case 'exclude':
-                    $options['exclude'] = is_array($value) ? $value : array($value);
-                    break;
-            }
-        }
-
-        return $options;
-    }
-}
-
-class PredisFile
-{
-    const NS_ROOT = 'Predis';
-
-    private $namespaces;
-
-    public function __construct()
-    {
-        $this->namespaces = array();
-    }
-
-    public static function from($libraryPath, Array $exclude = array())
-    {
-        $nsroot = self::NS_ROOT;
-        $predisFile = new PredisFile();
-        $libIterator = new RecursiveDirectoryIterator("$libraryPath$nsroot");
-
-        foreach (new RecursiveIteratorIterator($libIterator) as $classFile)
-        {
-            if (!$classFile->isFile()) {
-                continue;
-            }
-
-            $namespace = strtr(str_replace($libraryPath, '', $classFile->getPath()), '/', '\\');
-
-            if (in_array(sprintf('%s\\%s', $namespace, $classFile->getBasename('.php')), $exclude)) {
-                continue;
-            }
-
-            $phpNamespace = $predisFile->getNamespace($namespace);
-
-            if ($phpNamespace === false) {
-                $phpNamespace = new PhpNamespace($namespace);
-                $predisFile->addNamespace($phpNamespace);
-            }
-
-            $phpClass = new PhpClass($phpNamespace, $classFile);
-        }
-
-        return $predisFile;
-    }
-
-    public function addNamespace(PhpNamespace $namespace)
-    {
-        if (isset($this->namespaces[(string)$namespace])) {
-            throw new InvalidArgumentException("Duplicated namespace");
-        }
-        $this->namespaces[(string)$namespace] = $namespace;
-    }
-
-    public function getNamespaces()
-    {
-        return $this->namespaces;
-    }
-
-    public function getNamespace($namespace)
-    {
-        if (!isset($this->namespaces[$namespace])) {
-            return false;
-        }
-
-        return $this->namespaces[$namespace];
-    }
-
-    public function getClassByFQN($classFqn)
-    {
-        if (($nsLastPos = strrpos($classFqn, '\\')) !== false) {
-            $namespace = $this->getNamespace(substr($classFqn, 0, $nsLastPos));
-            if ($namespace === false) {
-                return null;
-            }
-            $className = substr($classFqn, $nsLastPos + 1);
-
-            return $namespace->getClass($className);
-        }
-
-        return null;
-    }
-
-    private function calculateDependencyScores(&$classes, $fqn)
-    {
-        if (!isset($classes[$fqn])) {
-            $classes[$fqn] = 0;
-        }
-
-        $classes[$fqn] += 1;
-
-        if (($phpClass = $this->getClassByFQN($fqn)) === null) {
-            throw new RuntimeException(
-                "Cannot found the class $fqn which is required by other subclasses. Are you missing a file?"
-            );
-        }
-
-        foreach ($phpClass->getDependencies() as $fqn) {
-            $this->calculateDependencyScores($classes, $fqn);
-        }
-    }
-
-    private function getDependencyScores()
-    {
-        $classes = array();
-
-        foreach ($this->getNamespaces() as $phpNamespace) {
-            foreach ($phpNamespace->getClasses() as $phpClass) {
-                $this->calculateDependencyScores($classes, $phpClass->getFQN());
-            }
-        }
-
-        return $classes;
-    }
-
-    private function getOrderedNamespaces($dependencyScores)
-    {
-        $namespaces = array_fill_keys(array_unique(
-            array_map(
-                function($fqn) { return PhpNamespace::extractName($fqn); },
-                array_keys($dependencyScores)
-            )
-        ), 0);
-
-        foreach ($dependencyScores as $classFqn => $score) {
-            $namespaces[PhpNamespace::extractName($classFqn)] += $score;
-        }
-
-        arsort($namespaces);
-
-        return array_keys($namespaces);
-    }
-
-    private function getOrderedClasses(PhpNamespace $phpNamespace, $classes)
-    {
-        $nsClassesFQNs = array_map(function($cl) { return $cl->getFQN(); }, $phpNamespace->getClasses());
-        $nsOrderedClasses = array();
-
-        foreach ($nsClassesFQNs as $nsClassFQN) {
-            $nsOrderedClasses[$nsClassFQN] = $classes[$nsClassFQN];
-        }
-
-        arsort($nsOrderedClasses);
-
-        return array_keys($nsOrderedClasses);
-    }
-
-    public function getPhpCode()
-    {
-        $buffer = array("<?php\n\n", PhpClass::LICENSE_HEADER, "\n\n");
-        $classes = $this->getDependencyScores();
-        $namespaces = $this->getOrderedNamespaces($classes);
-
-        foreach ($namespaces as $namespace) {
-            $phpNamespace = $this->getNamespace($namespace);
-
-            // generate namespace directive
-            $buffer[] = $phpNamespace->getPhpCode();
-            $buffer[] = "\n";
-
-            // generate use directives
-            $useDirectives = $phpNamespace->getUseDirectives();
-            if (count($useDirectives) > 0) {
-                $buffer[] = $useDirectives->getPhpCode();
-                $buffer[] = "\n";
-            }
-
-            // generate classes bodies
-            $nsClasses = $this->getOrderedClasses($phpNamespace, $classes);
-            foreach ($nsClasses as $classFQN) {
-                $buffer[] = $this->getClassByFQN($classFQN)->getPhpCode();
-                $buffer[] = "\n\n";
-            }
-
-            $buffer[] = "/* " . str_repeat("-", 75) . " */";
-            $buffer[] = "\n\n";
-        }
-
-        return implode($buffer);
-    }
-
-    public function saveTo($outputFile)
-    {
-        // TODO: add more sanity checks
-        if ($outputFile === null || $outputFile === '') {
-            throw new InvalidArgumentException('You must specify a valid output file');
-        }
-        file_put_contents($outputFile, $this->getPhpCode());
-    }
-}
-
-class PhpNamespace implements IteratorAggregate
-{
-    private $namespace;
-    private $classes;
-
-    public function __construct($namespace)
-    {
-        $this->namespace = $namespace;
-        $this->classes = array();
-        $this->useDirectives = new PhpUseDirectives($this);
-    }
-
-    public static function extractName($fqn)
-    {
-        $nsSepLast = strrpos($fqn, '\\');
-        if ($nsSepLast === false) {
-            return $fqn;
-        }
-        $ns = substr($fqn, 0, $nsSepLast);
-
-        return $ns !== '' ? $ns : null;
-    }
-
-    public function addClass(PhpClass $class)
-    {
-        $this->classes[$class->getName()] = $class;
-    }
-
-    public function getClass($className)
-    {
-        if (isset($this->classes[$className])) {
-            return $this->classes[$className];
-        }
-    }
-
-    public function getClasses()
-    {
-        return array_values($this->classes);
-    }
-
-    public function getIterator()
-    {
-        return new \ArrayIterator($this->getClasses());
-    }
-
-    public function getUseDirectives()
-    {
-        return $this->useDirectives;
-    }
-
-    public function getPhpCode()
-    {
-        return "namespace $this->namespace;\n";
-    }
-
-    public function __toString()
-    {
-        return $this->namespace;
-    }
-}
-
-class PhpUseDirectives implements Countable, IteratorAggregate
-{
-    private $use;
-    private $aliases;
-    private $namespace;
-
-    public function __construct(PhpNamespace $namespace)
-    {
-        $this->use = array();
-        $this->aliases = array();
-        $this->namespace = $namespace;
-    }
-
-    public function add($use, $as = null)
-    {
-        if (in_array($use, $this->use)) {
-            return;
-        }
-
-        $this->use[] = $use;
-        $this->aliases[$as ?: PhpClass::extractName($use)] = $use;
-    }
-
-    public function getList()
-    {
-        return $this->use;
-    }
-
-    public function getIterator()
-    {
-        return new \ArrayIterator($this->getList());
-    }
-
-    public function getPhpCode()
-    {
-        $reducer = function($str, $use) { return $str .= "use $use;\n"; };
-
-        return array_reduce($this->getList(), $reducer, '');
-    }
-
-    public function getNamespace()
-    {
-        return $this->namespace;
-    }
-
-    public function getFQN($className)
-    {
-        if (($nsSepFirst = strpos($className, '\\')) === false) {
-            if (isset($this->aliases[$className])) {
-                return $this->aliases[$className];
-            }
-
-            return (string)$this->getNamespace() . "\\$className";
-        }
-
-        if ($nsSepFirst != 0) {
-            throw new InvalidArgumentException("Partially qualified names are not supported");
-        }
-
-        return $className;
-    }
-
-    public function count()
-    {
-        return count($this->use);
-    }
-}
-
-class PhpClass
-{
-    const LICENSE_HEADER = <<<LICENSE
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-LICENSE;
-
-    private $namespace;
-    private $file;
-    private $body;
-    private $implements;
-    private $extends;
-    private $name;
-
-    public function __construct(PhpNamespace $namespace, SplFileInfo $classFile)
-    {
-        $this->namespace = $namespace;
-        $this->file = $classFile;
-        $this->implements = array();
-        $this->extends = array();
-
-        $this->extractData();
-        $namespace->addClass($this);
-    }
-
-    public static function extractName($fqn)
-    {
-        $nsSepLast = strrpos($fqn, '\\');
-        if ($nsSepLast === false) {
-            return $fqn;
-        }
-
-        return substr($fqn, $nsSepLast + 1);
-    }
-
-    private function extractData()
-    {
-        $useDirectives = $this->getNamespace()->getUseDirectives();
-
-        $useExtractor = function($m) use($useDirectives) {
-            $useDirectives->add(($namespacedPath = $m[1]));
-        };
-
-        $classBuffer = stream_get_contents(fopen($this->getFile()->getPathname(), 'r'));
-
-        $classBuffer = str_replace(self::LICENSE_HEADER, '', $classBuffer);
-
-        $classBuffer = preg_replace('/<\?php\s?\\n\s?/', '', $classBuffer);
-        $classBuffer = preg_replace('/\s?\?>\n?/ms', '', $classBuffer);
-        $classBuffer = preg_replace('/namespace\s+[\w\d_\\\\]+;\s?/', '', $classBuffer);
-        $classBuffer = preg_replace_callback('/use\s+([\w\d_\\\\]+)(\s+as\s+.*)?;\s?\n?/', $useExtractor, $classBuffer);
-
-        $this->body = trim($classBuffer);
-
-        $this->extractHierarchy();
-    }
-
-    private function extractHierarchy()
-    {
-        $implements = array();
-        $extends =  array();
-
-        $extractor = function($iterator, $callback) {
-            $className = '';
-            $iterator->seek($iterator->key() + 1);
-
-            while ($iterator->valid()) {
-                $token = $iterator->current();
-
-                if (is_string($token)) {
-                    if (preg_match('/\s?,\s?/', $token)) {
-                        $callback(trim($className));
-                        $className = '';
-                    }
-                    else if ($token == '{') {
-                        $callback(trim($className));
-                        return;
-                    }
-                }
-
-                switch ($token[0]) {
-                    case T_NS_SEPARATOR:
-                        $className .= '\\';
-                        break;
-
-                    case T_STRING:
-                        $className .= $token[1];
-                        break;
-
-                    case T_IMPLEMENTS:
-                    case T_EXTENDS:
-                        $callback(trim($className));
-                        $iterator->seek($iterator->key() - 1);
-                        return;
-                }
-
-                $iterator->next();
-            }
-        };
-
-        $tokens = token_get_all("<?php\n" . trim($this->getPhpCode()));
-        $iterator = new ArrayIterator($tokens);
-
-        while ($iterator->valid()) {
-            $token = $iterator->current();
-            if (is_string($token)) {
-                $iterator->next();
-                continue;
-            }
-
-            switch ($token[0]) {
-                case T_CLASS:
-                case T_INTERFACE:
-                    $iterator->seek($iterator->key() + 2);
-                    $tk = $iterator->current();
-                    $this->name = $tk[1];
-                    break;
-
-                case T_IMPLEMENTS:
-                    $extractor($iterator, function($fqn) use (&$implements) {
-                        $implements[] = $fqn;
-                    });
-                    break;
-
-                case T_EXTENDS:
-                    $extractor($iterator, function($fqn) use (&$extends) {
-                        $extends[] = $fqn;
-                    });
-                    break;
-            }
-
-            $iterator->next();
-        }
-
-        $this->implements = $this->guessFQN($implements);
-        $this->extends = $this->guessFQN($extends);
-    }
-
-    public function guessFQN($classes)
-    {
-        $useDirectives = $this->getNamespace()->getUseDirectives();
-        return array_map(array($useDirectives, 'getFQN'), $classes);
-    }
-
-    public function getImplementedInterfaces($all = false)
-    {
-        if ($all) {
-            return $this->implements;
-        }
-
-        return array_filter(
-            $this->implements,
-            function ($cn) { return strpos($cn, 'Predis\\') === 0; }
-        );
-    }
-
-    public function getExtendedClasses($all = false)
-    {
-        if ($all) {
-            return $this->extemds;
-        }
-
-        return array_filter(
-            $this->extends,
-            function ($cn) { return strpos($cn, 'Predis\\') === 0; }
-        );
-    }
-
-    public function getDependencies($all = false)
-    {
-        return array_merge(
-            $this->getImplementedInterfaces($all),
-            $this->getExtendedClasses($all)
-        );
-    }
-
-    public function getNamespace()
-    {
-        return $this->namespace;
-    }
-
-    public function getFile()
-    {
-        return $this->file;
-    }
-
-    public function getName()
-    {
-        return $this->name;
-    }
-
-    public function getFQN()
-    {
-        return (string)$this->getNamespace() . '\\' . $this->name;
-    }
-
-    public function getPhpCode()
-    {
-        return $this->body;
-    }
-
-    public function __toString()
-    {
-        return "class " . $this->getName() . '{ ... }';
-    }
-}
-
-/* -------------------------------------------------------------------------- */
-
-$options = CommandLine::getOptions();
-$predisFile = PredisFile::from($options['source'], $options['exclude']);
-$predisFile->saveTo($options['output']);

composer.json

@@ -1,21 +1,52 @@
 {
     "name": "predis/predis",
     "type": "library",
-    "description": "Flexible and feature-complete PHP client library for Redis",
+    "description": "A flexible and feature-complete Redis/Valkey client for PHP.",
     "keywords": ["nosql", "redis", "predis"],
-    "homepage": "http://github.com/nrk/predis",
+    "homepage": "http://github.com/predis/predis",
     "license": "MIT",
+    "support": {
+        "issues": "https://github.com/predis/predis/issues"
+    },
     "authors": [
         {
-            "name": "Daniele Alessandri",
-            "email": "suppakilla@gmail.com",
-            "homepage": "http://clorophilla.net"
+            "name": "Till Krüss",
+            "homepage": "https://till.im",
+            "role": "Maintainer"
+        }
+    ],
+    "funding": [
+        {
+            "type": "github",
+            "url": "https://github.com/sponsors/tillkruss"
         }
     ],
     "require": {
-        "php": ">=5.3.0"
+        "php": "^7.2 || ^8.0"
+    },
+    "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.3",
+        "phpstan/phpstan": "^1.9",
+        "phpunit/phpunit": "^8.0 || ^9.4",
+        "phpunit/phpcov": "^6.0 || ^8.0"
+    },
+    "suggest": {
+        "ext-relay": "Faster connection with in-memory caching (>=0.6.2)"
+    },
+    "scripts": {
+        "phpstan": "phpstan analyse",
+        "style": "php-cs-fixer fix --diff --dry-run",
+        "style:fix": "php-cs-fixer fix"
     },
     "autoload": {
-        "psr-0": {"Predis": "lib/"}
-    }
+        "psr-4": {
+            "Predis\\": "src/"
+        }
+    },
+    "config": {
+        "sort-packages": true,
+        "preferred-install": "dist"
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }

examples/Commands/Json/json_debug_memory.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of JSON.DEBUG command usage:
+
+// 1. Set JSON object
+$client = new Client();
+
+$client->jsonset('key', '$', '{"key1":"value1","key2":"value2"}');
+
+// 2. Dump information about json memory usage in bytes
+$response = $client->jsondebug->memory('key', '$');
+
+echo 'Response:' . "\n";
+print_r($response);

examples/Commands/Search/ft_aggregate.php

@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\Search\AggregateArguments;
+use Predis\Command\Argument\Search\CreateArguments;
+use Predis\Command\Argument\Search\SchemaFields\AbstractField;
+use Predis\Command\Argument\Search\SchemaFields\NumericField;
+use Predis\Command\Argument\Search\SchemaFields\TextField;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.AGGREGATE command usage:
+
+// 1. Create index
+$client = new Client();
+
+$ftCreateArguments = (new CreateArguments())->prefix(['user:']);
+$schema = [
+    new TextField('name'),
+    new TextField('country'),
+    new NumericField('dob', '', AbstractField::SORTABLE),
+];
+
+$client->ftcreate('idx', $schema, $ftCreateArguments);
+
+// 2. Add documents
+$client->hset('user:0', 'name', 'Vlad', 'country', 'Ukraine', 'dob', 813801600);
+$client->hset('user:1', 'name', 'Vlad', 'country', 'Israel', 'dob', 782265600);
+$client->hset('user:2', 'name', 'Vlad', 'country', 'Ukraine', 'dob', 813801600);
+
+// 3. Execute aggregation query
+$ftAggregateArguments = (new AggregateArguments())
+    ->apply('year(@dob)', 'birth')
+    ->groupBy('@country', '@birth')
+    ->reduce('COUNT', true, 'country_birth_Vlad_count')
+    ->sortBy(0, '@birth', 'DESC');
+
+$response = $client->ftaggregate('idx', '@name: "Vlad"', $ftAggregateArguments);
+
+// Response grouped by user country and birth year, with users count in each group, sorted by birth year from DESC.
+echo 'Response:' . "\n";
+print_r($response);

examples/Commands/Search/ft_alter.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\Search\SchemaFields\TextField;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.ALTER command usage:
+
+// 1. Create index
+$client = new Client();
+
+$schema = [
+    new TextField('text_field'),
+];
+$client->ftcreate('index_alter', $schema);
+
+echo 'Default index attributes:' . "\n";
+$defaultAttributes = $client->ftinfo('index_alter');
+print_r($defaultAttributes[7]);
+
+// 2. Add additional attribute to existing index
+$schema = [
+    new TextField('new_field_name'),
+];
+
+$client->ftalter('index_alter', $schema);
+
+echo 'Updated index attributes:' . "\n";
+$updatedAttributes = $client->ftinfo('index_alter');
+print_r($updatedAttributes[7]);

examples/Commands/Search/ft_config_help.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.CONFIG HELP command usage:
+
+// 1. Dump helpful information about FT.CONFIG MAXEXPANSIONS option
+$client = new Client();
+
+echo 'Response:' . "\n";
+print_r(
+    $client->ftconfig->help('MAXEXPANSIONS')
+);

examples/Commands/Search/ft_config_set_get.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.CONFIG SET command usage:
+
+// 1. Change default timeout setting
+$client = new Client();
+
+echo 'Response:' . "\n";
+
+print_r(
+    $client->ftconfig->set('TIMEOUT', 42)
+);
+print_r(
+    $client->ftconfig->get('TIMEOUT')
+);

examples/Commands/Search/ft_cursor_del.php

@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\Search\AggregateArguments;
+use Predis\Command\Argument\Search\CreateArguments;
+use Predis\Command\Argument\Search\SchemaFields\AbstractField;
+use Predis\Command\Argument\Search\SchemaFields\NumericField;
+use Predis\Command\Argument\Search\SchemaFields\TextField;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.CURSOR DEL command usage
+
+// 1. Create index
+$client = new Client();
+
+$ftCreateArguments = (new CreateArguments())->prefix(['user:']);
+$schema = [
+    new TextField('name'),
+    new TextField('country'),
+    new NumericField('dob', '', AbstractField::SORTABLE),
+];
+
+$client->ftcreate('index_cursor_del', $schema, $ftCreateArguments);
+
+// 2. Add documents
+$client->hset('user:0', 'name', 'Vlad', 'country', 'Ukraine', 'dob', 813801600);
+$client->hset('user:1', 'name', 'Vlad', 'country', 'Israel', 'dob', 782265600);
+$client->hset('user:2', 'name', 'Vlad', 'country', 'Ukraine', 'dob', 813801600);
+
+// 3. Execute aggregation query
+$ftAggregateArguments = (new AggregateArguments())
+    ->apply('year(@dob)', 'birth')
+    ->groupBy('@country', '@birth')
+    ->reduce('COUNT', true, 'country_birth_Vlad_count')
+    ->sortBy(0, '@birth', 'DESC')
+    ->withCursor(1);
+
+[$_, $cursor] = $client->ftaggregate('index_cursor_del', '@name: "Vlad"', $ftAggregateArguments);
+
+// 4. Explicitly remove returned cursor
+$client->ftcursor->del('index_cursor_del', $cursor);
+
+echo "Cursor with cursorId - {$cursor} was removed";

examples/Commands/Search/ft_cursor_read.php

@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\Search\AggregateArguments;
+use Predis\Command\Argument\Search\CreateArguments;
+use Predis\Command\Argument\Search\SchemaFields\AbstractField;
+use Predis\Command\Argument\Search\SchemaFields\NumericField;
+use Predis\Command\Argument\Search\SchemaFields\TextField;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.CURSOR READ command usage
+
+// 1. Create index
+$client = new Client();
+
+$ftCreateArguments = (new CreateArguments())->prefix(['user:']);
+$schema = [
+    new TextField('name'),
+    new TextField('country'),
+    new NumericField('dob', '', AbstractField::SORTABLE),
+];
+
+$client->ftcreate('index_cursor_read', $schema, $ftCreateArguments);
+
+// 2. Add documents
+$client->hset('user:0', 'name', 'Vlad', 'country', 'Ukraine', 'dob', 813801600);
+$client->hset('user:1', 'name', 'Vlad', 'country', 'Israel', 'dob', 782265600);
+$client->hset('user:2', 'name', 'Vlad', 'country', 'Ukraine', 'dob', 813801600);
+
+// 3. Execute aggregation query
+$ftAggregateArguments = (new AggregateArguments())
+    ->apply('year(@dob)', 'birth')
+    ->groupBy('@country', '@birth')
+    ->reduce('COUNT', true, 'country_birth_Vlad_count')
+    ->sortBy(0, '@birth', 'DESC')
+    ->withCursor(1);
+
+[$response, $cursor] = $client->ftaggregate('index_cursor_read', '@name: "Vlad"', $ftAggregateArguments);
+
+// 4. Processing response in loop until cursorId exists
+$actualResponse = [];
+$cursors = [];
+
+while ($cursor) {
+    $actualResponse[] = $response[1];
+    $cursors[] = $cursor;
+    [$response, $cursor] = $client->ftcursor->read('index_cursor_read', $cursor);
+}
+
+echo "Response: \n";
+print_r($actualResponse);

examples/Commands/Search/ft_explain.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\Search\SchemaFields\TextField;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.EXPLAIN command usage:
+
+// 1. Create index
+$client = new Client();
+
+$schema = [
+    new TextField('text_field'),
+];
+$client->ftcreate('index_explain', $schema);
+
+// 2. Run query explanations
+$response = $client->ftexplain('index_explain', '(foo bar)|(hello world) @date:[100 200]|@date:[500 +inf]');
+
+echo 'Response:' . "\n";
+print_r($response);

examples/Commands/Search/ft_profile.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\Search\ProfileArguments;
+use Predis\Command\Argument\Search\SchemaFields\TextField;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.PROFILE command usage:
+
+// 1. Create index
+$client = new Client();
+
+$schema = [
+    new TextField('text_field'),
+];
+$client->ftcreate('index_profile', $schema);
+
+// 2. Create FT.PROFILE command arguments
+$arguments = (new ProfileArguments())
+                ->search()
+                ->query('query');
+
+// 3. Run profile query
+$response = $client->ftprofile('index_profile', $arguments);
+
+echo 'Response:' . "\n";
+print_r($response);

examples/Commands/Search/ft_spellcheck.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\Search\SchemaFields\TextField;
+use Predis\Command\Argument\Search\SpellcheckArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.SPELLCHECK command usage:
+
+// 1. Create index
+$client = new Client();
+
+$schema = [
+    new TextField('text_field'),
+];
+$client->ftcreate('index_spellcheck', $schema);
+
+// 2. Add dictionary with terms
+$client->ftdictadd('dict', 'hello', 'help');
+
+// 3. Perform spelling correction query
+$response = $client->ftspellcheck(
+    'index_spellcheck',
+    'held',
+    (new SpellcheckArguments())->distance(2)->terms('dict')
+);
+
+echo 'Response:' . "\n";
+print_r($response);

examples/Commands/Search/ft_sug_add_get_del_len.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\Search\SugAddArguments;
+use Predis\Command\Argument\Search\SugGetArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.SUGADD, FT.SUGGET, FT.SUGDEL, FT.SUGLEN commands usage:
+
+// 1. Add suggestion to key with payload
+$client = new Client();
+
+$client->ftsugadd('key', 'hello', 2, (new SugAddArguments())->payload('payload'));
+
+echo 'Suggestions dictionary length: ' . $client->ftsuglen('key') . "\n";
+
+// 2. Perform fuzzy search by prefix to get previous suggestion with payload
+$response = $client->ftsugget('key', 'hellp', (new SugGetArguments())->fuzzy()->withPayloads());
+
+echo 'Suggestion for "hellp" prefix:' . "\n";
+print_r($response);
+
+// 3. Removes previous suggestion from key
+$client->ftsugdel('key', 'hello');
+$response = $client->ftsugget('key', 'hello');
+
+echo 'Suggestions, after removing "hello" suggestion:' . "\n";
+print_r($response);

examples/Commands/Search/ft_syndump.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\Search\SchemaFields\TextField;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.SYNDUMP command usage:
+
+// 1. Create index
+$client = new Client();
+
+$schema = [
+    new TextField('text_field'),
+];
+$client->ftcreate('index_syndump', $schema);
+
+// 2. Add synonyms group with terms
+$client->ftsynupdate('index_syndump', 'synonym1', null, 'term1', 'term2');
+
+// 3. Dump terms with synonyms
+$response = $client->ftsyndump('index_syndump');
+
+echo 'Response:' . "\n";
+print_r($response);

examples/Commands/Search/ft_synupdate.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\Search\SchemaFields\TextField;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.SYNUPDATE command usage:
+
+// 1. Create index
+$client = new Client();
+
+$schema = [
+    new TextField('text_field'),
+];
+$client->ftcreate('index_synupdate', $schema);
+
+// 2. Add synonyms into synonym group
+$response = $client->ftsynupdate('index_synupdate', 'synonym1', null, 'term1', 'term2');
+
+echo 'Response:' . "\n";
+print_r($response);

examples/Commands/Search/ft_tagvals.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\Search\CreateArguments;
+use Predis\Command\Argument\Search\SchemaFields\TagField;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.TAGVALS command usage:
+
+// 1. Create index
+$client = new Client();
+
+$schema = [
+    new TagField('tag_field'),
+];
+$client->ftcreate('index_tagvals', $schema, (new CreateArguments())->prefix(['prefix:']));
+
+// 2. Add indexed tags
+$client->hset('prefix:1', 'tag_field', 'Hello, World');
+$client->hset('prefix:2', 'tag_field', 'Hey, World');
+
+// 3. Unique tags value query
+$response = $client->fttagvals('index_tagvals', 'tag_field');
+
+echo 'Response:' . "\n";
+print_r($response);

examples/Commands/TimeSeries/ts_add.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\AddArguments;
+use Predis\Command\Argument\TimeSeries\CommonArguments;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.ADD command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->retentionMsecs(60000)
+    ->duplicatePolicy(CommonArguments::POLICY_MAX)
+    ->labels('sensor_id', 2, 'area_id', 32);
+
+$client->tscreate('temperature:2:32', $arguments);
+
+// 2. Add sample into newly created time series
+$addArguments = (new AddArguments())
+    ->retentionMsecs(31536000000);
+
+$response = $client->tsadd('temperature:2:32', 123123123123, 27, $addArguments);
+
+echo "Timeseries was added with timestamp: {$response}";

examples/Commands/TimeSeries/ts_alter.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\AlterArguments;
+use Predis\Command\Argument\TimeSeries\CommonArguments;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.ALTER command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->retentionMsecs(60000)
+    ->duplicatePolicy(CommonArguments::POLICY_MAX)
+    ->labels('sensor_id', 2, 'area_id', 32);
+
+$response = $client->tscreate('temperature:2:32', $arguments);
+
+echo "Time series creation status: {$response}\n";
+
+// 2. Update Duplicate policy for time series above
+$arguments = (new AlterArguments())
+    ->duplicatePolicy(CommonArguments::POLICY_FIRST);
+
+$response = $client->tsalter('temperature:2:32', $arguments);
+$output = ($response == 'OK') ? 'Duplicate policy was successfully updated' : $response;
+
+echo $output;

examples/Commands/TimeSeries/ts_create.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CommonArguments;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.CREATE command usage:
+
+// Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->retentionMsecs(60000)
+    ->duplicatePolicy(CommonArguments::POLICY_MAX)
+    ->labels('sensor_id', 2, 'area_id', 32);
+
+$response = $client->tscreate('temperature:2:32', $arguments);
+
+echo "Time series creation status: {$response}";

examples/Commands/TimeSeries/ts_createrule.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.CREATERULE command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->labels('type', 'temp', 'location', 'TLV');
+
+$createResponse = $client->tscreate('temp:TLV', $arguments);
+echo "Original time series creation status: {$createResponse}\n";
+
+$createResponse = $client->tscreate('dailyAvgTemp:TLV', $arguments);
+echo "Compacted time series creation status: {$createResponse}\n";
+
+$createRuleResponse = $client->tscreaterule('temp:TLV', 'dailyAvgTemp:TLV', 'avg', 1000);
+echo "Compacted rule for compacted time series creation status: {$createRuleResponse}\n";

examples/Commands/TimeSeries/ts_decrby.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\AddArguments;
+use Predis\Command\Argument\TimeSeries\CommonArguments;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+use Predis\Command\Argument\TimeSeries\DecrByArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.DECRBY command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->retentionMsecs(60000)
+    ->duplicatePolicy(CommonArguments::POLICY_MAX)
+    ->labels('sensor_id', 2, 'area_id', 32);
+
+$client->tscreate('temperature:2:32', $arguments);
+
+// 2. Add sample into newly created time series
+$addArguments = (new AddArguments())
+    ->retentionMsecs(31536000000);
+
+$response = $client->tsadd('temperature:2:32', 123123123123, 27, $addArguments);
+
+echo "Timeseries was added with timestamp: {$response}\n";
+
+// 3. Increasing value and timestamp
+$client->tsdecrby('temperature:2:32', 1, (new DecrByArguments())->timestamp(123123123124));
+$response = $client->tsget('temperature:2:32');
+
+echo "Decreased value to - {$response[1]} and timestamp to {$response[0]}";

examples/Commands/TimeSeries/ts_del.php

@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CommonArguments;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.GET command usage:
+// 1. Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->retentionMsecs(60000)
+    ->duplicatePolicy(CommonArguments::POLICY_MAX)
+    ->labels('sensor_id', 2, 'area_id', 32);
+
+$client->tscreate('temperature:2:32', $arguments);
+
+// 2. Add samples into time series
+$client->tsadd('temperature:2:32', 123123123123, 27);
+$client->tsadd('temperature:2:32', 123123123124, 28);
+$client->tsadd('temperature:2:32', 123123123125, 29);
+
+$response = $client->tsget('temperature:2:32');
+
+echo "Sample with highest timestamp - {$response[0]} and value {$response[1]}\n";
+
+// 3. Removes 2 samples with the highest timestamps
+$response = $client->tsdel('temperature:2:32', 123123123124, 123123123125);
+
+echo "Removed {$response} samples from timeseries.\n";
+
+// 3. Retrieve a timestamp with the highest timestamp
+$response = $client->tsget('temperature:2:32');
+
+echo "New sample with highest timestamp - {$response[0]} and value {$response[1]}";

examples/Commands/TimeSeries/ts_deleterule.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.CREATERULE command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->labels('type', 'temp', 'location', 'TLV');
+
+$createResponse = $client->tscreate('temp:TLV', $arguments);
+echo "Original time series creation status: {$createResponse}\n";
+
+$createResponse = $client->tscreate('dailyAvgTemp:TLV', $arguments);
+echo "Compacted time series creation status: {$createResponse}\n";
+
+$createRuleResponse = $client->tscreaterule('temp:TLV', 'dailyAvgTemp:TLV', 'avg', 1000);
+echo "Compacted rule for compacted time series creation status: {$createRuleResponse}\n";
+
+// 2. Remove compaction rule
+$deleteRuleResponse = $client->tsdeleterule('temp:TLV', 'dailyAvgTemp:TLV');
+echo "Compacted rule for compacted time series deletion status: {$deleteRuleResponse}\n";

examples/Commands/TimeSeries/ts_get.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CommonArguments;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.GET command usage:
+// 1. Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->retentionMsecs(60000)
+    ->duplicatePolicy(CommonArguments::POLICY_MAX)
+    ->labels('sensor_id', 2, 'area_id', 32);
+
+$client->tscreate('temperature:2:32', $arguments);
+
+// 2. Add samples into time series
+$client->tsadd('temperature:2:32', 123123123123, 27);
+$client->tsadd('temperature:2:32', 123123123124, 28);
+$client->tsadd('temperature:2:32', 123123123125, 29);
+
+// 3. Retrieve a timestamp with highest timestamp
+$response = $client->tsget('temperature:2:32');
+
+echo "Sample with highest timestamp - {$response[0]} and value - {$response[1]}";

examples/Commands/TimeSeries/ts_incrby.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\AddArguments;
+use Predis\Command\Argument\TimeSeries\CommonArguments;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+use Predis\Command\Argument\TimeSeries\IncrByArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.INCRBY command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->retentionMsecs(60000)
+    ->duplicatePolicy(CommonArguments::POLICY_MAX)
+    ->labels('sensor_id', 2, 'area_id', 32);
+
+$client->tscreate('temperature:2:32', $arguments);
+
+// 2. Add sample into newly created time series
+$addArguments = (new AddArguments())
+    ->retentionMsecs(31536000000);
+
+$response = $client->tsadd('temperature:2:32', 123123123123, 27, $addArguments);
+
+echo "Timeseries was added with timestamp: {$response}\n";
+
+// 3. Increasing value and timestamp
+$client->tsincrby('temperature:2:32', 1, (new IncrByArguments())->timestamp(123123123124));
+$response = $client->tsget('temperature:2:32');
+
+echo "Increased value to - {$response[1]} and timestamp to {$response[0]}";

examples/Commands/TimeSeries/ts_info.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CommonArguments;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.CREATE command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->retentionMsecs(60000)
+    ->duplicatePolicy(CommonArguments::POLICY_MAX)
+    ->labels('sensor_id', 2, 'area_id', 32);
+
+$client->tscreate('temperature:2:32', $arguments);
+
+// 2. Show info about given time series
+print_r($client->tsinfo('temperature:2:32'));

examples/Commands/TimeSeries/ts_madd.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CommonArguments;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.MADD command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->retentionMsecs(60000)
+    ->duplicatePolicy(CommonArguments::POLICY_MAX)
+    ->labels('sensor_id', 2, 'area_id', 32);
+
+$client->tscreate('temperature:2:32', $arguments);
+$client->tscreate('temperature:2:33', $arguments);
+
+// 2. Add samples into few time series
+$response = $client->tsmadd('temperature:2:32', 123123123123, 27, 'temperature:2:33', 123123123124, 28);
+$stringResponse = implode(', ', $response);
+
+echo "Samples was added to time series - timestamps: {$stringResponse}";

examples/Commands/TimeSeries/ts_mget.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CommonArguments;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+use Predis\Command\Argument\TimeSeries\MGetArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.MGET command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->retentionMsecs(60000)
+    ->duplicatePolicy(CommonArguments::POLICY_MAX)
+    ->labels('type', 'temp', 'sensor_id', 2, 'area_id', 32);
+
+$client->tscreate('temperature:2:32', $arguments);
+$client->tscreate('temperature:2:33', $arguments);
+
+// 2. Add samples into time series
+$client->tsadd('temperature:2:32', 123123123123, 27);
+$client->tsadd('temperature:2:33', 123123123124, 27);
+
+// 3. Get sample from multiple time series matching given filter expression, with selected labels only
+$response = $client->tsmget((new MGetArguments())->selectedLabels('type'), 'type=temp');
+
+echo "Sample from time series, with label = 'type':\n";
+print_r($response);

examples/Commands/TimeSeries/ts_mrange.php

@@ -0,0 +1,48 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+use Predis\Command\Argument\TimeSeries\MRangeArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.MRANGE command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$response = $client->tscreate('stock:A', (new CreateArguments())->labels('type', 'stock', 'name', 'A'));
+echo "Time series A creation status: {$response}\n";
+
+$response = $client->tscreate('stock:B', (new CreateArguments())->labels('type', 'stock', 'name', 'B'));
+echo "Time series B creation status: {$response}\n";
+
+// 2. Add samples into both time series
+$response = $client->tsmadd('stock:A', 1000, 100, 'stock:A', 1010, 110, 'stock:A', 1020, 120);
+$stringResponse = implode(', ', $response);
+echo "Added samples into time series A with following timestamps: {$stringResponse}\n";
+
+$response = $client->tsmadd('stock:B', 1000, 120, 'stock:B', 1010, 110, 'stock:B', 1020, 100);
+$stringResponse = implode(', ', $response);
+echo "Added samples into time series B with following timestamps: {$stringResponse}\n";
+
+// 3. Query range across both time series filtered by "type" and grouped by max type
+$mrangeArguments = (new MRangeArguments())
+    ->withLabels()
+    ->filter('type=stock')
+    ->groupBy('type', 'max');
+
+$response = $client->tsmrange('-', '+', $mrangeArguments);
+
+echo "Response:\n";
+print_r($response);

examples/Commands/TimeSeries/ts_mrevrange.php

@@ -0,0 +1,48 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+use Predis\Command\Argument\TimeSeries\MRangeArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.MREVRANGE command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$response = $client->tscreate('stock:A', (new CreateArguments())->labels('type', 'stock', 'name', 'A'));
+echo "Time series A creation status: {$response}\n";
+
+$response = $client->tscreate('stock:B', (new CreateArguments())->labels('type', 'stock', 'name', 'B'));
+echo "Time series B creation status: {$response}\n";
+
+// 2. Add samples into both time series
+$response = $client->tsmadd('stock:A', 1000, 100, 'stock:A', 1010, 110, 'stock:A', 1020, 120);
+$stringResponse = implode(', ', $response);
+echo "Added samples into time series A with following timestamps: {$stringResponse}\n";
+
+$response = $client->tsmadd('stock:B', 1000, 120, 'stock:B', 1010, 110, 'stock:B', 1020, 100);
+$stringResponse = implode(', ', $response);
+echo "Added samples into time series B with following timestamps: {$stringResponse}\n";
+
+// 3. Query range across both time series filtered by "type" and grouped by max type
+$mrangeArguments = (new MRangeArguments())
+    ->withLabels()
+    ->filter('type=stock')
+    ->groupBy('type', 'max');
+
+$response = $client->tsmrevrange('-', '+', $mrangeArguments);
+
+echo "Response:\n";
+print_r($response);

examples/Commands/TimeSeries/ts_queryindex.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.QUERYINDEX command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->labels('type', 'temp', 'location', 'TLV');
+
+$createResponse = $client->tscreate('temp:TLV', $arguments);
+echo "Time series with location TLV creation status: {$createResponse}\n";
+
+$anotherArguments = (new CreateArguments())
+    ->labels('type', 'temp', 'location', 'JER');
+
+$createResponse = $client->tscreate('temp:JER', $anotherArguments);
+echo "Time series with location JER creation status: {$createResponse}\n";
+
+echo "Returns all keys with location=TLV:\n";
+print_r($client->tsqueryindex('location=TLV'));

examples/Commands/TimeSeries/ts_range.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+use Predis\Command\Argument\TimeSeries\RangeArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.RANGE command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$createArguments = (new CreateArguments())->labels('type', 'temp', 'location', 'TLV');
+$createResponse = $client->tscreate('temp:TLV', $createArguments);
+
+echo "Time series creation status: {$createResponse}\n";
+
+// 2. Add samples into time series
+$maddResponse = $client->tsmadd('temp:TLV', 1000, 30, 'temp:TLV', 1010, 35, 'temp:TLV', 1020, 9999, 'temp:TLV', 1030, 40);
+$stringResponse = implode(', ', $maddResponse);
+
+echo "Samples was added with following timestamps: {$stringResponse}\n";
+
+// 3. Query samples by values in the given range
+$rangeArguments = (new RangeArguments())->filterByValue(-100, 100);
+$rangeResponse = $client->tsrange('temp:TLV', '-', '+', $rangeArguments);
+
+echo "Samples with temperature in range -100 to 100 degrees:\n";
+print_r($rangeResponse);

examples/Commands/TimeSeries/ts_revrange.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+use Predis\Command\Argument\TimeSeries\RangeArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.REVRANGE command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$createArguments = (new CreateArguments())->labels('type', 'temp', 'location', 'TLV');
+$createResponse = $client->tscreate('temp:TLV', $createArguments);
+
+echo "Time series creation status: {$createResponse}\n";
+
+// 2. Add samples into time series
+$maddResponse = $client->tsmadd('temp:TLV', 1000, 30, 'temp:TLV', 1010, 35, 'temp:TLV', 1020, 9999, 'temp:TLV', 1030, 40);
+$stringResponse = implode(', ', $maddResponse);
+
+echo "Samples was added with following timestamps: {$stringResponse}\n";
+
+// 3. Query samples by values in the given range
+$rangeArguments = (new RangeArguments())->filterByValue(-100, 100);
+$rangeResponse = $client->tsrevrange('temp:TLV', '-', '+', $rangeArguments);
+
+echo "Samples with temperature in range -100 to 100 degrees in reverse order:\n";
+print_r($rangeResponse);

examples/Commands/acl_dry_run.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+
+require __DIR__ . '/../shared.php';
+
+// Example of ACL DRYRUN command usage:
+
+// 1. Set user with permissions to call only 'SET' command.
+$client = new Client($single_server);
+$response = $client->acl->setUser('Test_dry', '+SET', '~*');
+$created = ($response == 'OK') ? 'Yes' : 'No';
+
+echo "User with username 'Test' was created: {$created}. Permissions only to use SET command\n";
+
+// 2. Dry run 'SET' command under 'Test_dry' user
+$response = $client->acl->dryRun('Test_dry', 'SET', 'foo', 'bar');
+
+echo 'Dry run "SET" command.' . "\n";
+echo 'Response: ' . $response . "\n";
+
+// 3. Dry run 'GET' command under 'Test_dry' user
+$response = $client->acl->dryRun('Test_dry', 'GET', 'foo');
+
+echo 'Dry run "GET" command.' . "\n";
+echo 'Response: ' . $response;

examples/Commands/acl_get_user.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+
+require __DIR__ . '/../shared.php';
+
+// Example of ACL GETUSER command usage:
+
+// 1. Set user
+$client = new Client($single_server);
+$response = $client->acl->setUser('Test');
+
+// 2. Retrieve user rules:
+
+echo 'Rules: ' . "\n";
+print_r(
+    $client->acl->getUser('Test')
+);

examples/Commands/acl_set_user.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+
+require __DIR__ . '/../shared.php';
+
+// Example of ACL SETUSER command usage:
+
+// 1. Set user
+$client = new Client($single_server);
+$response = $client->acl->setUser('Test');
+$created = ($response == 'OK') ? 'Yes' : 'No';
+
+echo "User with username 'Test' was created: {$created}";

examples/Commands/fcall_ro.php

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+
+require __DIR__ . '/../shared.php';
+
+// Example of FCALL_RO command usage:
+
+// 1. Set key-value pair
+$client = new Client($single_server);
+$client->set('foo', 'bar');
+
+echo "Set key 'foo' with value 'bar'\n";
+
+// 2. Load redis function with 'no-writes' flag
+$client->function->load(
+    "#!lua name=mylib
+                redis.register_function{
+                    function_name='myfunc',
+                    callback=function(keys, args) return redis.call('GET', keys[1]) end,
+                    flags={'no-writes'}
+                }"
+);
+
+echo 'Loaded custom function that perform GET command against provided key.' . "\n";
+
+// 3. Call function above with given key
+$response = $client->fcall_ro('myfunc', ['foo']);
+
+echo "Function returned value against provided key 'foo' is '{$response}'";
+
+// 4. Delete test library
+$client->function->delete('mylib');

examples/Commands/waitaof.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+
+require __DIR__ . '/../shared.php';
+
+// Example of WAITAOF command usage:
+
+// 1. Enable appendonly mode if it's not (command works only in appendonly mode)
+$client = new Client($single_server);
+$info = $client->info();
+$enabled = false;
+
+if ($info['Persistence']['aof_enabled'] === '0') {
+    $client->config('set', 'appendonly', 'yes');
+    $enabled = true;
+}
+
+// 2. Set key value pair
+$response = $client->set('foo', 'bar');
+echo "Key-value pair set status: {$response}\n";
+
+// 3. Run WAITAOF command to make sure that all previous writes was fsynced
+$response = $client->waitaof(1, 0, 0);
+
+echo "Quantity of local instances that was fsynced - {$response[0]}, quantity of replicas - {$response[1]}";
+
+// 4. Disable appendonly mode if it was enabled during script execution
+if ($enabled) {
+    $client->config('set', 'appendonly', 'no');
+}

examples/CustomDistributionStrategy.php

@@ -1,82 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-require 'SharedConfigurations.php';
-
-// Developers can customize the distribution strategy used by the client
-// to distribute keys among a cluster of servers simply by creating a class
-// that implements the Predis\Distribution\IDistributionStrategy interface.
-
-use Predis\Distribution\IDistributionStrategy;
-use Predis\Network\PredisCluster;
-
-class NaiveDistributionStrategy implements IDistributionStrategy
-{
-    private $nodes;
-    private $nodesCount;
-
-    public function __constructor()
-    {
-        $this->nodes = array();
-        $this->nodesCount = 0;
-    }
-
-    public function add($node, $weight = null)
-    {
-        $this->nodes[] = $node;
-        $this->nodesCount++;
-    }
-
-    public function remove($node)
-    {
-        $this->nodes = array_filter($this->nodes, function($n) use($node) {
-            return $n !== $node;
-        });
-
-        $this->nodesCount = count($this->nodes);
-    }
-
-    public function get($key)
-    {
-        $count = $this->nodesCount;
-        if ($count === 0) {
-            throw new RuntimeException('No connections');
-        }
-
-        return $this->nodes[$count > 1 ? abs(crc32($key) % $count) : 0];
-    }
-
-    public function generateKey($value)
-    {
-        return crc32($value);
-    }
-}
-
-$options = array(
-    'cluster' => function() {
-        $distributor = new NaiveDistributionStrategy();
-        return new PredisCluster($distributor);
-    },
-);
-
-$client = new Predis\Client($multiple_servers, $options);
-
-for ($i = 0; $i < 100; $i++) {
-    $client->set("key:$i", str_pad($i, 4, '0', 0));
-    $client->get("key:$i");
-}
-
-$server1 = $client->getClientFor('first')->info();
-$server2 = $client->getClientFor('second')->info();
-
-printf("Server '%s' has %d keys while server '%s' has %d keys.\n",
-    'first', $server1['db15']['keys'], 'second', $server2['db15']['keys']
-);

examples/DispatcherLoop.php

@@ -1,78 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-require 'SharedConfigurations.php';
-
-/*
-This is a basic example on how to use the Predis\DispatcherLoop class.
-
-To see this example in action you can just use redis-cli and publish some
-messages to the 'events' and 'control' channel, e.g.:
-
-./redis-cli
-PUBLISH events first
-PUBLISH events second
-PUBLISH events third
-PUBLISH control terminate_dispatcher
-*/
-
-// Create a client and disable r/w timeout on the socket
-$client = new Predis\Client($single_server + array('read_write_timeout' => 0));
-
-// Create a Predis\DispatcherLoop instance and attach a bunch of callbacks.
-$dispatcher = new Predis\PubSub\DispatcherLoop($client);
-
-// Demonstrate how to use a callable class as a callback for Predis\DispatcherLoop.
-class EventsListener implements Countable
-{
-    private $events;
-
-    public function __construct()
-    {
-        $this->events = array();
-    }
-
-    public function count()
-    {
-        return count($this->events);
-    }
-
-    public function getEvents()
-    {
-        return $this->events;
-    }
-
-    public function __invoke($payload)
-    {
-        $this->events[] = $payload;
-    }
-}
-
-// Attach our callable class to the dispatcher.
-$dispatcher->attachCallback('events', ($events = new EventsListener()));
-
-// Attach a function to control the dispatcher loop termination with a message.
-$dispatcher->attachCallback('control', function($payload) use ($dispatcher) {
-    if ($payload === 'terminate_dispatcher') {
-        $dispatcher->stop();
-    }
-});
-
-// Run the dispatcher loop until the callback attached to the 'control' channel
-// receives 'terminate_dispatcher' as a message.
-$dispatcher->run();
-
-// Display our achievements!
-echo "We received {$events->count()} messages!\n";
-
-// Say goodbye :-)
-$info = $client->info();
-print_r("Goodbye from Redis v{$info['redis_version']}!\n");

examples/KeyPrefixes.php

@@ -1,37 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-require 'SharedConfigurations.php';
-
-// Predis ships with a KeyPrefixProcessor class that is used to transparently
-// prefix each key before sending commands to Redis, even for complex commands
-// such as SORT, ZUNIONSTORE and ZINTERSTORE. Key prefixes are useful to create
-// user-level namespaces for you keyspace, thus eliminating the need for separate
-// logical databases.
-
-$client = new Predis\Client($single_server, array('prefix' => 'nrk:'));
-
-$client->mset(array('foo' => 'bar', 'lol' => 'wut'));
-var_dump($client->mget('foo', 'lol'));
-/*
-array(2) {
-  [0]=> string(3) "bar"
-  [1]=> string(3) "wut"
-}
-*/
-
-var_dump($client->keys('*'));
-/*
-array(2) {
-  [0]=> string(7) "nrk:foo"
-  [1]=> string(7) "nrk:lol"
-}
-*/

examples/MultipleSetAndGet.php

@@ -1,38 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-require 'SharedConfigurations.php';
-
-// redis can set keys and their relative values in one go
-// using MSET, then the same values can be retrieved with
-// a single command using MGET.
-
-$mkv = array(
-    'usr:0001' => 'First user',
-    'usr:0002' => 'Second user',
-    'usr:0003' => 'Third user'
-);
-
-$client = new Predis\Client($single_server);
-
-$client->mset($mkv);
-$retval = $client->mget(array_keys($mkv));
-
-print_r($retval);
-
-/* OUTPUT:
-Array
-(
-    [0] => First user
-    [1] => Second user
-    [2] => Third user
-)
-*/

examples/PipelineContext.php

@@ -1,47 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-require 'SharedConfigurations.php';
-
-// When you have a whole set of consecutive commands to send to
-// a redis server, you can use a pipeline to improve performances.
-
-$client = new Predis\Client($single_server);
-
-$replies = $client->pipeline(function($pipe) {
-    $pipe->ping();
-    $pipe->flushdb();
-    $pipe->incrby('counter', 10);
-    $pipe->incrby('counter', 30);
-    $pipe->exists('counter');
-    $pipe->get('counter');
-    $pipe->mget('does_not_exist', 'counter');
-});
-
-print_r($replies);
-
-/* OUTPUT:
-Array
-(
-    [0] => 1
-    [1] => 1
-    [2] => 10
-    [3] => 40
-    [4] => 1
-    [5] => 40
-    [6] => Array
-        (
-            [0] =>
-            [1] => 40
-        )
-
-)
-*/

examples/ServerSideScripting.php

@@ -1,49 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-require 'SharedConfigurations.php';
-
-// This example will not work with versions of Redis < 2.6.
-//
-// Additionally to the EVAL command defined in the current development profile, the new
-// Predis\Commands\ScriptedCommand base class can be used to build an higher abstraction
-// for our "scripted" commands so that they will appear just like any other command on
-// the client-side. This is a quick example used to implement INCREX.
-
-use Predis\Commands\ScriptedCommand;
-
-class IncrementExistingKey extends ScriptedCommand
-{
-    public function getKeysCount()
-    {
-        return 1;
-    }
-
-    public function getScript()
-    {
-        return
-<<<LUA
-    local cmd = redis.call
-    if cmd('exists', KEYS[1]) == 1 then
-        return cmd('incr', KEYS[1])
-    end
-LUA;
-    }
-}
-
-$client = new Predis\Client($single_server, 'dev');
-
-$client->getProfile()->defineCommand('increx', 'IncrementExistingKey');
-
-$client->set('foo', 10);
-
-var_dump($client->increx('foo'));       // int(11)
-var_dump($client->increx('bar'));       // NULL

examples/SharedConfigurations.php

@@ -1,33 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-require __DIR__.'/../autoload.php';
-
-$single_server = array(
-    'host'     => '127.0.0.1',
-    'port'     => 6379,
-    'database' => 15
-);
-
-$multiple_servers = array(
-    array(
-       'host'     => '127.0.0.1',
-       'port'     => 6379,
-       'database' => 15,
-       'alias'    => 'first',
-    ),
-    array(
-       'host'     => '127.0.0.1',
-       'port'     => 6380,
-       'database' => 15,
-       'alias'    => 'second',
-    ),
-);

examples/SimpleDebuggableConnection.php

@@ -1,89 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-require 'SharedConfigurations.php';
-
-use Predis\ConnectionParameters;
-use Predis\Commands\ICommand;
-use Predis\Network\StreamConnection;
-
-class SimpleDebuggableConnection extends StreamConnection
-{
-    private $tstart = 0;
-    private $debugBuffer = array();
-
-    public function connect()
-    {
-        $this->tstart = microtime(true);
-
-        parent::connect();
-    }
-
-    private function storeDebug(ICommand $command, $direction)
-    {
-        $firtsArg  = $command->getArgument(0);
-        $timestamp = round(microtime(true) - $this->tstart, 4);
-
-        $debug  = $command->getId();
-        $debug .= isset($firtsArg) ? " $firtsArg " : ' ';
-        $debug .= "$direction $this";
-        $debug .= " [{$timestamp}s]";
-
-        $this->debugBuffer[] = $debug;
-    }
-
-    public function writeCommand(ICommand $command)
-    {
-        parent::writeCommand($command);
-
-        $this->storeDebug($command, '->');
-    }
-
-    public function readResponse(ICommand $command)
-    {
-        $reply = parent::readResponse($command);
-        $this->storeDebug($command, '<-');
-
-        return $reply;
-    }
-
-    public function getDebugBuffer()
-    {
-        return $this->debugBuffer;
-    }
-}
-
-$options = array(
-    'connections' => array(
-        'tcp' => 'SimpleDebuggableConnection',
-    ),
-);
-
-$client = new Predis\Client($single_server, $options);
-$client->set('foo', 'bar');
-$client->get('foo');
-$client->info();
-
-print_r($client->getConnection()->getDebugBuffer());
-
-/* OUTPUT:
-Array
-(
-    [0] => SELECT 15 -> 127.0.0.1:6379 [0.0008s]
-    [1] => SELECT 15 <- 127.0.0.1:6379 [0.0012s]
-    [2] => SET foo -> 127.0.0.1:6379 [0.0014s]
-    [3] => SET foo <- 127.0.0.1:6379 [0.0014s]
-    [4] => GET foo -> 127.0.0.1:6379 [0.0016s]
-    [5] => GET foo <- 127.0.0.1:6379 [0.0018s]
-    [6] => INFO -> 127.0.0.1:6379 [0.002s]
-    [7] => INFO <- 127.0.0.1:6379 [0.0025s]
-)
-*/

examples/SimpleSetAndGet.php

@@ -1,25 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-require 'SharedConfigurations.php';
-
-// simple set and get scenario
-
-$client = new Predis\Client($single_server);
-
-$client->set('library', 'predis');
-$retval = $client->get('library');
-
-var_dump($retval);
-
-/* OUTPUT
-string(6) "predis"
-*/

examples/custom_cluster_distributor.php

@@ -0,0 +1,118 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+// Developers can implement Predis\Distribution\DistributorInterface to create
+// their own distributors used by the client to distribute keys among a cluster
+// of servers.
+
+use Predis\Cluster\Distributor\DistributorInterface;
+use Predis\Cluster\Hash\HashGeneratorInterface;
+use Predis\Cluster\PredisStrategy;
+use Predis\Connection\Cluster\PredisCluster;
+
+class NaiveDistributor implements DistributorInterface, HashGeneratorInterface
+{
+    private $nodes;
+    private $nodesCount;
+
+    public function __construct()
+    {
+        $this->nodes = [];
+        $this->nodesCount = 0;
+    }
+
+    public function add($node, $weight = null)
+    {
+        $this->nodes[] = $node;
+        ++$this->nodesCount;
+    }
+
+    public function remove($node)
+    {
+        $this->nodes = array_filter($this->nodes, function ($n) use ($node) {
+            return $n !== $node;
+        });
+
+        $this->nodesCount = count($this->nodes);
+    }
+
+    public function getSlot($hash)
+    {
+        return $this->nodesCount > 1 ? abs($hash % $this->nodesCount) : 0;
+    }
+
+    public function getBySlot($slot)
+    {
+        return $this->nodes[$slot] ?? null;
+    }
+
+    public function getByHash($hash)
+    {
+        if (!$this->nodesCount) {
+            throw new RuntimeException('No connections.');
+        }
+
+        $slot = $this->getSlot($hash);
+        $node = $this->getBySlot($slot);
+
+        return $node;
+    }
+
+    public function get($value)
+    {
+        $hash = $this->hash($value);
+        $node = $this->getByHash($hash);
+
+        return $node;
+    }
+
+    public function hash($value)
+    {
+        return crc32($value);
+    }
+
+    public function getHashGenerator()
+    {
+        return $this;
+    }
+}
+
+$options = [
+    'cluster' => function () {
+        $distributor = new NaiveDistributor();
+        $strategy = new PredisStrategy($distributor);
+        $cluster = new PredisCluster($strategy);
+
+        return $cluster;
+    },
+];
+
+$client = new Predis\Client($multiple_servers, $options);
+
+for ($i = 0; $i < 100; ++$i) {
+    $client->set("key:$i", str_pad($i, 4, '0', 0));
+    $client->get("key:$i");
+}
+
+$server1 = $client->getClientBy('alias', 'first')->info();
+$server2 = $client->getClientBy('alias', 'second')->info();
+
+if (isset($server1['Keyspace'], $server2['Keyspace'])) {
+    $server1 = $server1['Keyspace'];
+    $server2 = $server2['Keyspace'];
+}
+
+printf("Server '%s' has %d keys while server '%s' has %d keys.\n",
+    'first', $server1['db15']['keys'], 'second', $server2['db15']['keys']
+);

examples/debuggable_connection.php

@@ -0,0 +1,93 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+// This is an example of how you can easily extend an existing connection class
+// and trace the execution of commands for debugging purposes. This can be quite
+// useful as a starting point to understand how your application interacts with
+// Redis.
+
+use Predis\Command\CommandInterface;
+use Predis\Connection\StreamConnection;
+
+class SimpleDebuggableConnection extends StreamConnection
+{
+    private $tstart = 0;
+    private $debugBuffer = [];
+
+    public function connect()
+    {
+        $this->tstart = microtime(true);
+
+        parent::connect();
+    }
+
+    private function storeDebug(CommandInterface $command, $direction)
+    {
+        $firtsArg = $command->getArgument(0);
+        $timestamp = round(microtime(true) - $this->tstart, 4);
+
+        $debug = $command->getId();
+        $debug .= isset($firtsArg) ? " $firtsArg " : ' ';
+        $debug .= "$direction $this";
+        $debug .= " [{$timestamp}s]";
+
+        $this->debugBuffer[] = $debug;
+    }
+
+    public function writeRequest(CommandInterface $command)
+    {
+        parent::writeRequest($command);
+
+        $this->storeDebug($command, '->');
+    }
+
+    public function readResponse(CommandInterface $command)
+    {
+        $response = parent::readResponse($command);
+        $this->storeDebug($command, '<-');
+
+        return $response;
+    }
+
+    public function getDebugBuffer()
+    {
+        return $this->debugBuffer;
+    }
+}
+
+$options = [
+    'connections' => [
+        'tcp' => 'SimpleDebuggableConnection',
+    ],
+];
+
+$client = new Predis\Client($single_server, $options);
+$client->set('foo', 'bar');
+$client->get('foo');
+$client->info();
+
+var_export($client->getConnection()->getDebugBuffer());
+
+/* OUTPUT:
+array (
+    0 => 'SELECT 15 -> 127.0.0.1:6379 [0.0008s]',
+    1 => 'SELECT 15 <- 127.0.0.1:6379 [0.001s]',
+    2 => 'SET foo -> 127.0.0.1:6379 [0.001s]',
+    3 => 'SET foo <- 127.0.0.1:6379 [0.0011s]',
+    4 => 'GET foo -> 127.0.0.1:6379 [0.0013s]',
+    5 => 'GET foo <- 127.0.0.1:6379 [0.0015s]',
+    6 => 'INFO -> 127.0.0.1:6379 [0.0019s]',
+    7 => 'INFO <- 127.0.0.1:6379 [0.0022s]',
+)
+*/

examples/dispatcher_loop.php

@@ -0,0 +1,80 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+// This is a basic example on how to use the Predis\DispatcherLoop class.
+//
+// To see this example in action you can just use redis-cli and publish some
+// messages to the 'events' and 'control' channel, e.g.:
+
+// ./redis-cli
+// PUBLISH events first
+// PUBLISH events second
+// PUBLISH events third
+// PUBLISH control terminate_dispatcher
+
+// Create a client and disable r/w timeout on the socket
+$client = new Predis\Client($single_server + ['read_write_timeout' => 0]);
+
+// Return an initialized PubSub consumer instance from the client.
+$pubsub = $client->pubSubLoop();
+
+// Create a dispatcher loop instance and attach a bunch of callbacks.
+$dispatcher = new Predis\PubSub\DispatcherLoop($pubsub);
+
+// Demonstrate how to use a callable class as a callback for the dispatcher loop.
+class EventsListener implements Countable
+{
+    private $events;
+
+    public function __construct()
+    {
+        $this->events = [];
+    }
+
+    public function count()
+    {
+        return count($this->events);
+    }
+
+    public function getEvents()
+    {
+        return $this->events;
+    }
+
+    public function __invoke($payload, $dispatcher)
+    {
+        $this->events[] = $payload;
+    }
+}
+
+// Attach our callable class to the dispatcher.
+$dispatcher->attachCallback('events', $events = new EventsListener());
+
+// Attach a function to control the dispatcher loop termination with a message.
+$dispatcher->attachCallback('control', function ($payload, $dispatcher) {
+    if ($payload === 'terminate_dispatcher') {
+        $dispatcher->stop();
+    }
+});
+
+// Run the dispatcher loop until the callback attached to the 'control' channel
+// receives 'terminate_dispatcher' as a message.
+$dispatcher->run();
+
+// Display our achievements!
+echo "We received {$events->count()} messages!", PHP_EOL;
+
+// Say goodbye :-)
+$version = redis_version($client->info());
+echo "Goodbye from Redis $version!", PHP_EOL;

examples/executing_redis_commands.php

@@ -0,0 +1,63 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+$client = new Predis\Client($single_server);
+
+// Plain old SET and GET example...
+$client->set('library', 'predis');
+$response = $client->get('library');
+
+var_export($response);
+echo PHP_EOL;
+/* OUTPUT: 'predis' */
+
+// Redis has the MSET and MGET commands to set or get multiple keys in one go,
+// cases like this Predis accepts arguments for variadic commands both as a list
+// of arguments or an array containing all of the keys and/or values.
+$mkv = [
+    'uid:0001' => '1st user',
+    'uid:0002' => '2nd user',
+    'uid:0003' => '3rd user',
+];
+
+$client->mset($mkv);
+$response = $client->mget(array_keys($mkv));
+
+var_export($response);
+echo PHP_EOL;
+/* OUTPUT:
+array (
+    0 => '1st user',
+    1 => '2nd user',
+    2 => '3rd user',
+)
+*/
+
+// Predis can also send "raw" commands to Redis. The difference between sending
+// commands to Redis the usual way and the "raw" way is that in the latter case
+// their arguments are not filtered nor responses coming from Redis are parsed.
+
+$response = $client->executeRaw([
+    'MGET', 'uid:0001', 'uid:0002', 'uid:0003',
+]);
+
+var_export($response);
+echo PHP_EOL;
+/* OUTPUT:
+array (
+    0 => '1st user',
+    1 => '2nd user',
+    2 => '3rd user',
+)
+*/

examples/key_prefixing.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+// Predis can prefix keys found in commands arguments before sending commands to
+// Redis, even for complex commands such as SORT, ZUNIONSTORE and ZINTERSTORE.
+// Prefixing keys can be useful to create user-level namespaces for you keyspace
+// thus reducing the need for separate logical databases in certain scenarios.
+
+$client = new Predis\Client($single_server, ['prefix' => 'nrk:']);
+
+$client->mset(['foo' => 'bar', 'lol' => 'wut']);
+var_export($client->mget('foo', 'lol'));
+/*
+array (
+    0 => 'bar',
+    1 => 'wut',
+)
+*/
+
+var_export($client->keys('*'));
+/*
+array (
+    0 => 'nrk:foo',
+    1 => 'nrk:lol',
+)
+*/

examples/lua_scripting_abstraction.php

@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+// This example will not work with versions of Redis < 2.6.
+//
+// Additionally to the EVAL command, the Predis\Command\ScriptCommand class can
+// be used to leverage an higher level abstraction for Lua scripting that makes
+// scripts appear just like any other command on the client-side. This is basic
+// example on how a script-based INCREX command can be defined:
+
+use Predis\Command\ScriptCommand;
+
+class IncrementExistingKeysBy extends ScriptCommand
+{
+    public function getKeysCount()
+    {
+        // Tell Predis to use all the arguments but the last one as arguments
+        // for KEYS. The last one will be used to populate ARGV.
+        return -1;
+    }
+
+    public function getScript()
+    {
+        return <<<LUA
+local cmd, insert = redis.call, table.insert
+local increment, results = ARGV[1], { }
+
+for idx, key in ipairs(KEYS) do
+    if cmd('exists', key) == 1 then
+        insert(results, idx, cmd('incrby', key, increment))
+    else
+        insert(results, idx, false)
+    end
+end
+
+return results
+LUA;
+    }
+}
+
+$client = new Predis\Client($single_server, [
+    'commands' => [
+        'increxby' => 'IncrementExistingKeysBy',
+    ],
+]);
+
+$client->mset('foo', 10, 'foobar', 100);
+
+var_export($client->increxby('foo', 'foofoo', 'foobar', 50));
+
+/*
+array (
+    0 => 60,
+    1 => NULL,
+    2 => 150,
+)
+*/

examples/monitor_consumer.php

@@ -3,21 +3,22 @@
 /*
  * This file is part of the Predis package.
  *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 
-require 'SharedConfigurations.php';
+require __DIR__ . '/shared.php';
 
-// This is a basic example on how to use the Predis\MonitorContext class.
-// You can use redis-cli to send commands to the same Redis instance your client is
+// This is a basic example on how to use the Predis\Monitor\Consumer class. You
+// can use redis-cli to send commands to the same Redis instance your client is
 // connected to, and then type "ECHO QUIT_MONITOR" in redis-cli when you want to
 // exit the monitor loop and terminate this script in a graceful way.
 
 // Create a client and disable r/w timeout on the socket.
-$client = new Predis\Client($single_server + array('read_write_timeout' => 0));
+$client = new Predis\Client($single_server + ['read_write_timeout' => 0]);
 
 // Use only one instance of DateTime, we will update the timestamp later.
 $timestamp = new DateTime();
@@ -25,20 +26,20 @@ $timestamp = new DateTime();
 foreach (($monitor = $client->monitor()) as $event) {
     $timestamp->setTimestamp((int) $event->timestamp);
 
-    // If we notice a ECHO command with the message QUIT_MONITOR, we close the
-    // monitor context and then break the loop.
+    // If we notice a ECHO command with the message QUIT_MONITOR, we stop the
+    // monitor consumer and then break the loop.
     if ($event->command === 'ECHO' && $event->arguments === '"QUIT_MONITOR"') {
-        echo "Exiting the monitor loop...\n";
-        $monitor->closeContext();
+        echo 'Exiting the monitor loop...', PHP_EOL;
+        $monitor->stop();
         break;
     }
 
-    echo "* Received {$event->command} on DB {$event->database} at {$timestamp->format(DateTime::W3C)}\n";
+    echo "* Received {$event->command} on DB {$event->database} at {$timestamp->format(DateTime::W3C)}", PHP_EOL;
     if (isset($event->arguments)) {
-        echo "    Arguments: {$event->arguments}\n";
+        echo "    Arguments: {$event->arguments}", PHP_EOL;
     }
 }
 
 // Say goodbye :-)
-$info = $client->info();
-print_r("Goodbye from Redis v{$info['redis_version']}!\n");
+$version = redis_version($client->info());
+echo "Goodbye from Redis $version!", PHP_EOL;

examples/pipelining_commands.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+// When you have a whole set of consecutive commands to send to a redis server,
+// you can use a pipeline to dramatically improve performances. Pipelines can
+// greatly reduce the effects of network round-trips.
+
+$client = new Predis\Client($single_server);
+
+$responses = $client->pipeline(function ($pipe) {
+    $pipe->flushdb();
+    $pipe->incrby('counter', 10);
+    $pipe->incrby('counter', 30);
+    $pipe->exists('counter');
+    $pipe->get('counter');
+    $pipe->mget('does_not_exist', 'counter');
+});
+
+var_export($responses);
+
+/* OUTPUT:
+array (
+    0 => Predis\Response\Status::__set_state(array(
+        'payload' => 'OK',
+    )),
+    1 => 10,
+    2 => 40,
+    3 => true,
+    4 => '40',
+    5 => array (
+        0 => NULL,
+        1 => '40',
+    ),
+)
+*/

examples/pubsub_consumer.php

@@ -3,59 +3,58 @@
 /*
  * This file is part of the Predis package.
  *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 
-require 'SharedConfigurations.php';
+require __DIR__ . '/shared.php';
 
-// Redis 2.0 features new commands that allow clients to subscribe for
-// events published on certain channels (PUBSUB).
+// Starting from Redis 2.0 clients can subscribe and listen for events published
+// on certain channels using a Publish/Subscribe (PUB/SUB) approach.
 
 // Create a client and disable r/w timeout on the socket
-$client = new Predis\Client($single_server + array('read_write_timeout' => 0));
+$client = new Predis\Client($single_server + ['read_write_timeout' => 0]);
 
-// Initialize a new pubsub context
-$pubsub = $client->pubSub();
+// Initialize a new pubsub consumer.
+$pubsub = $client->pubSubLoop();
 
 // Subscribe to your channels
 $pubsub->subscribe('control_channel', 'notifications');
 
-// Start processing the pubsup messages. Open a terminal and use redis-cli
+// Start processing the pubsub messages. Open a terminal and use redis-cli
 // to push messages to the channels. Examples:
-//   ./redis-cli PUBLISH notifications "this is a test"
-//   ./redis-cli PUBLISH control_channel quit_loop
+//   redis-cli PUBLISH notifications "this is a test"
+//   redis-cli PUBLISH control_channel quit_loop
 foreach ($pubsub as $message) {
     switch ($message->kind) {
         case 'subscribe':
-            echo "Subscribed to {$message->channel}\n";
+            echo "Subscribed to {$message->channel}", PHP_EOL;
             break;
 
         case 'message':
             if ($message->channel == 'control_channel') {
                 if ($message->payload == 'quit_loop') {
-                    echo "Aborting pubsub loop...\n";
+                    echo 'Aborting pubsub loop...', PHP_EOL;
                     $pubsub->unsubscribe();
+                } else {
+                    echo "Received an unrecognized command: {$message->payload}.", PHP_EOL;
                 }
-                else {
-                    echo "Received an unrecognized command: {$message->payload}.\n";
-                }
-            }
-            else {
-                echo "Received the following message from {$message->channel}:\n",
-                     "  {$message->payload}\n\n";
+            } else {
+                echo "Received the following message from {$message->channel}:",
+                PHP_EOL, "  {$message->payload}", PHP_EOL, PHP_EOL;
             }
             break;
     }
 }
 
-// Always unset the pubsub context instance when you are done! The
+// Always unset the pubsub consumer instance when you are done! The
 // class destructor will take care of cleanups and prevent protocol
 // desynchronizations between the client and the server.
 unset($pubsub);
 
 // Say goodbye :-)
-$info = $client->info();
-print_r("Goodbye from Redis v{$info['redis_version']}!\n");
+$version = redis_version($client->info());
+echo "Goodbye from Redis $version!", PHP_EOL;

examples/redis_collections_iterators.php

@@ -0,0 +1,99 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+use Predis\Collection\Iterator;
+
+// Starting with Redis 2.8, clients can iterate incrementally over collections
+// without blocking the server like it happens when a command such as KEYS is
+// executed on a Redis instance storing millions of keys. These commands are:
+//
+//   - SCAN (iterates over the keyspace)
+//   - SSCAN (iterates over members of a set)
+//   - ZSCAN (iterates over members and ranks of a sorted set)
+//   - HSCAN (iterates over fields and values of an hash).
+
+// Predis provides a specialized abstraction for each command based on standard
+// SPL iterators making it possible to easily consume SCAN-based iterations in
+// your PHP code.
+//
+// See http://redis.io/commands/scan for more details.
+//
+
+$client = new Predis\Client($single_server);
+
+// Prepare some keys for our example
+$client->del('predis:set', 'predis:zset', 'predis:hash');
+for ($i = 0; $i < 5; ++$i) {
+    $client->sadd('predis:set', "member:$i");
+    $client->zadd('predis:zset', -$i, "member:$i");
+    $client->hset('predis:hash', "field:$i", "value:$i");
+}
+
+// === Keyspace iterator based on SCAN ===
+echo 'Scan the keyspace matching only our prefixed keys:', PHP_EOL;
+foreach (new Iterator\Keyspace($client, 'predis:*') as $key) {
+    echo " - $key", PHP_EOL;
+}
+
+/* OUTPUT
+Scan the keyspace matching only our prefixed keys:
+    - predis:zset
+    - predis:set
+    - predis:hash
+*/
+
+// === Set iterator based on SSCAN ===
+echo 'Scan members of `predis:set`:', PHP_EOL;
+foreach (new Iterator\SetKey($client, 'predis:set') as $member) {
+    echo " - $member", PHP_EOL;
+}
+
+/* OUTPUT
+Scan members of `predis:set`:
+    - member:1
+    - member:4
+    - member:0
+    - member:3
+    - member:2
+*/
+
+// === Sorted set iterator based on ZSCAN ===
+echo 'Scan members and ranks of `predis:zset`:', PHP_EOL;
+foreach (new Iterator\SortedSetKey($client, 'predis:zset') as $member => $rank) {
+    echo " - $member [rank: $rank]", PHP_EOL;
+}
+
+/* OUTPUT
+Scan members and ranks of `predis:zset`:
+    - member:4 [rank: -4]
+    - member:3 [rank: -3]
+    - member:2 [rank: -2]
+    - member:1 [rank: -1]
+    - member:0 [rank: 0]
+*/
+
+// === Hash iterator based on HSCAN ===
+echo 'Scan fields and values of `predis:hash`:', PHP_EOL;
+foreach (new Iterator\HashKey($client, 'predis:hash') as $field => $value) {
+    echo " - $field => $value", PHP_EOL;
+}
+
+/* OUTPUT
+Scan fields and values of `predis:hash`:
+    - field:0 => value:0
+    - field:1 => value:1
+    - field:2 => value:2
+    - field:3 => value:3
+    - field:4 => value:4
+*/

examples/relay_compression.php

@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+// Enable igbinary serializer as well as LZ4 compression
+$options = [
+    'serializer' => 'igbinary',
+    'compression' => 'lz4',
+];
+
+$client = new Predis\Client($single_server + $options, [
+    'connections' => 'relay',
+]);
+
+$quote = (object) [
+    'author' => 'Jean-Luc Picard',
+    'text' => 'I look forward to your report Mr. Broccoli.',
+];
+
+// Serialize object and apply LZ4 compression, then write key to Redis
+$client->set('quote', $client->pack($quote));
+
+// NOTE: In Predis v3.x serialization and compression will happen
+// automatically without the need to call `pack()` and `unpack()`
+
+// Retrieve raw binary value from Redis
+$raw = $client->get('quote');
+
+// Decompress and unserialize binary value
+$data = $client->unpack($raw);
+
+var_dump($quote == $data); // true
+
+var_dump($data);
+
+/*
+object(stdClass)#11 (2) {
+    ["author"]=>string(15) "Jean-Luc Picard"
+    ["text"]=>string(43) "I look forward to your report Mr. Broccoli."
+}
+*/

examples/relay_connection.php

@@ -0,0 +1,55 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+$options = [
+    'timeout' => 1.0,
+    'read_write_timeout' => 1.0,
+
+    // Relay specific options
+    'cache' => true,
+    // 'compression' => 'lz4',
+    // 'serializer' => 'igbinary',
+];
+
+$client = new Predis\Client($single_server + $options, [
+    'connections' => 'relay',
+]);
+
+// Write key to Redis
+$client->set('torpedo', mt_rand());
+
+// Retrieve key from Redis
+$client->get('torpedo');
+
+// Retrieve key from Relay (without talking to Redis)
+// This key is now available to all PHP workers in this FPM pool
+$client->get('torpedo');
+
+// For debugging only:
+var_export(
+    $client->getConnection()->getClient()->_getKeys()
+);
+
+/*
+array (
+    'torpedo' => array (
+        0 => array (
+            'type' => 'string',
+            'local-len' => 10,
+            'remote-len' => 10,
+            'size' => 10,
+        ),
+    ),
+)
+*/

examples/relay_events.php

@@ -0,0 +1,61 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+$key = null;
+
+$client = new Predis\Client($single_server, [
+    'connections' => 'relay',
+]);
+
+/** @var Predis\Connection\RelayConnection $relay */
+$relay = $client->getConnection();
+
+// establish connection
+$client->ping();
+
+// register `FLUSH*` callback
+$relay->onFlushed(
+    static function (Relay\Event $event) use (&$key) {
+        echo 'Redis was flushed, unsetting $key...' . PHP_EOL;
+        $key = null;
+    }
+);
+
+// register `INVALIDATE` callback
+$relay->onInvalidated(
+    static function (Relay\Event $event) use (&$key) {
+        if ($event->key === 'library') {
+            echo "The `{$event->key}` key was invalidated, unsetting \$key..." . PHP_EOL;
+            $key = null;
+        }
+    }
+);
+
+// Write key to Redis
+$client->set('library', mt_rand());
+
+// Retrieve key once from Redis, then cached in Relay and $key
+$key = $client->get('library');
+
+while (true) {
+    echo '$key is: ' . var_export($key, true) . PHP_EOL;
+
+    // To trigger our event callbacks, we need to either interact with Relay:
+    $client->get(mt_rand());
+
+    // ... or alternatively dispatch events directly on Relay:
+    $relay->dispatchEvents();
+
+    sleep(1);
+}

examples/relay_pubsub_consumer.php

@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+// Create a Relay client and disable r/w timeout on the connection
+$client = new Predis\Client(
+    $single_server + ['read_write_timeout' => 0],
+    ['connections' => 'relay']
+);
+
+// Initialize a new pubsub consumer.
+$pubsub = $client->pubSubLoop();
+
+// When using Relay you cannot use foreach-loops to iterate
+// over messages instead use a callback function
+$poorMansKafka = function ($message, $client) {
+    switch ($message->kind) {
+        case 'subscribe':
+            echo "Subscribed to {$message->channel}", PHP_EOL;
+            break;
+
+        case 'message':
+        case 'pmessage':
+            if ($message->channel == 'control_channel') {
+                if ($message->payload == 'quit_loop') {
+                    echo 'Aborting pubsub loop...', PHP_EOL;
+                    $client->unsubscribe();
+                } else {
+                    echo "Received an unrecognized command: {$message->payload}.", PHP_EOL;
+                }
+            } else {
+                echo "Received the message from `{$message->channel}` channel:",
+                PHP_EOL, "  {$message->payload}", PHP_EOL, PHP_EOL;
+            }
+    }
+};
+
+// Subscribe to your channels and start processing the messages.
+$pubsub->subscribe('control_channel', 'notifications', $poorMansKafka);
+
+// Open a terminal and use redis-cli to push messages to the channels. Examples:
+//   redis-cli PUBLISH notifications "this is a test"
+//   redis-cli PUBLISH control_channel quit_loop
+
+// When using Relay, there is no need to unset the pubsub consumer instance when you are done
+
+// Say goodbye :-)
+$version = redis_version($client->info());
+echo "Goodbye from Redis $version!", PHP_EOL;

examples/replication_complex.php

@@ -0,0 +1,83 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+// Predis allows to set Lua scripts as read-only operations for replication.
+// This works for both EVAL and EVALSHA and also for the client-side abstraction
+// built upon them (Predis\Command\ScriptCommand). This example shows a slightly
+// more complex configuration that injects a new script command in the command
+// factory used by the client and marks it as a read-only operation so that it
+// will be executed on slaves.
+
+use Predis\Command\ScriptCommand;
+use Predis\Connection\Replication\MasterSlaveReplication;
+use Predis\Replication\ReplicationStrategy;
+
+// ------------------------------------------------------------------------- //
+
+// Define a new script command that returns all the fields of a variable number
+// of hashes with a single roundtrip.
+
+class HashMultipleGetAll extends ScriptCommand
+{
+    public const BODY = <<<LUA
+local hashes = {}
+for _, key in pairs(KEYS) do
+    table.insert(hashes, key)
+    table.insert(hashes, redis.call('hgetall', key))
+end
+return hashes
+LUA;
+
+    public function getScript()
+    {
+        return self::BODY;
+    }
+}
+
+// ------------------------------------------------------------------------- //
+
+$parameters = [
+    'tcp://127.0.0.1:6381?role=master&database=15',
+    'tcp://127.0.0.1:6382?role=slave&alias=slave-01&database=15',
+];
+
+$options = [
+    'commands' => [
+        'hmgetall' => 'HashMultipleGetAll',
+    ],
+    'replication' => function () {
+        $strategy = new ReplicationStrategy();
+        $strategy->setScriptReadOnly(HashMultipleGetAll::BODY);
+
+        $replication = new MasterSlaveReplication($strategy);
+
+        return $replication;
+    },
+];
+
+// ------------------------------------------------------------------------- //
+
+$client = new Predis\Client($parameters, $options);
+
+// Execute the following commands on the master server using redis-cli:
+// $ ./redis-cli HMSET metavars foo bar hoge piyo
+// $ ./redis-cli HMSET servers master host1 slave host2
+
+$hashes = $client->hmgetall('metavars', 'servers');
+
+$replication = $client->getConnection();
+$stillOnSlave = $replication->getCurrent() === $replication->getConnectionByAlias('slave-01');
+
+echo 'Is still on slave? ', $stillOnSlave ? 'YES!' : 'NO!', PHP_EOL;
+var_export($hashes);

examples/replication_sentinel.php

@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+// Predis supports redis-sentinel to provide high availability in master / slave
+// scenarios. The only but relevant difference with a basic replication scenario
+// is that sentinel servers can manage the master server and its slaves based on
+// their state, which means that they are able to provide an authoritative and
+// updated configuration to clients thus avoiding static configurations for the
+// replication servers and their roles.
+
+// Instead of connection parameters pointing to redis nodes, we provide a list
+// of instances of redis-sentinel. Users should always provide a timeout value
+// low enough to not hinder operations just in case a sentinel is unreachable
+// but Predis uses a default value of 100 milliseconds for sentinel parameters
+// without an explicit timeout value.
+//
+// NOTE: in real-world scenarios sentinels should be running on different hosts!
+$sentinels = [
+    'tcp://127.0.0.1:5380?timeout=0.100',
+    'tcp://127.0.0.1:5381?timeout=0.100',
+    'tcp://127.0.0.1:5382?timeout=0.100',
+];
+
+$client = new Predis\Client($sentinels, [
+    'replication' => 'sentinel',
+    'service' => 'mymaster',
+]);
+
+// Read operation.
+$exists = $client->exists('foo') ? 'yes' : 'no';
+$current = $client->getConnection()->getCurrent()->getParameters();
+echo "Does 'foo' exist on {$current->role}? $exists.", PHP_EOL;
+
+// Write operation.
+$client->set('foo', 'bar');
+$current = $client->getConnection()->getCurrent()->getParameters();
+echo "Now 'foo' has been set to 'bar' on {$current->role}!", PHP_EOL;
+
+// Read operation.
+$bar = $client->get('foo');
+$current = $client->getConnection()->getCurrent()->getParameters();
+echo "We fetched 'foo' from {$current->role} and its value is '$bar'.", PHP_EOL;
+
+/* OUTPUT:
+Does 'foo' exist on slave-127.0.0.1:6381? yes.
+Now 'foo' has been set to 'bar' on master!
+We fetched 'foo' from master and its value is 'bar'.
+*/

examples/replication_simple.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+// Predis supports master / slave replication scenarios where write operations
+// are performed on the master server and read operations are executed against
+// one of the slaves. The behavior of commands or EVAL scripts can be customized
+// at will. As soon as a write operation is performed the client switches to the
+// master server for all the subsequent requests (either reads and writes).
+//
+// This example must be executed using the second Redis server configured as the
+// slave of the first one (see the "SLAVEOF" command).
+//
+
+$parameters = [
+    'tcp://127.0.0.1:6381?role=master&database=15',
+    'tcp://127.0.0.1:6382?role=slave&database=15',
+];
+
+$options = ['replication' => 'predis'];
+
+$client = new Predis\Client($parameters, $options);
+
+// Read operation.
+$exists = $client->exists('foo') ? 'yes' : 'no';
+$current = $client->getConnection()->getCurrent()->getParameters();
+echo "Does 'foo' exist on {$current->role}? $exists.", PHP_EOL;
+
+// Write operation.
+$client->set('foo', 'bar');
+$current = $client->getConnection()->getCurrent()->getParameters();
+echo "Now 'foo' has been set to 'bar' on {$current->role}!", PHP_EOL;
+
+// Read operation.
+$bar = $client->get('foo');
+$current = $client->getConnection()->getCurrent()->getParameters();
+echo "We fetched 'foo' from {$current->role} and its value is '$bar'.", PHP_EOL;
+
+/* OUTPUT:
+Does 'foo' exist on slave? yes.
+Now 'foo' has been set to 'bar' on master!
+We fetched 'foo' from master and its value is 'bar'.
+*/

examples/session_handler.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__ . '/shared.php';
+
+// This example demonstrates how to use Predis to save PHP sessions on Redis.
+//
+// The value of `session.gc_maxlifetime` in `php.ini` will be used by default as
+// the TTL for keys holding session data but this value can be overridden when
+// creating the session handler instance using the `gc_maxlifetime` option.
+//
+// NOTE: this class requires PHP >= 5.4 but can be used on PHP 5.3 if a polyfill
+// for SessionHandlerInterface is provided either by you or an external package
+// like `symfony/http-foundation`.
+//
+// See http://www.php.net/class.sessionhandlerinterface.php for more details.
+//
+
+if (!interface_exists('SessionHandlerInterface')) {
+    exit('ATTENTION: the session handler implemented by Predis requires PHP >= 5.4.0 ' .
+        "or a polyfill for SessionHandlerInterface provided by an external package.\n");
+}
+
+// Instantiate a new client just like you would normally do. Using a prefix for
+// keys will effectively prefix all session keys with the specified string.
+$client = new Predis\Client($single_server, ['prefix' => 'sessions:']);
+
+// Set `gc_maxlifetime` to specify a time-to-live of 5 seconds for session keys.
+$handler = new Predis\Session\Handler($client, ['gc_maxlifetime' => 5]);
+
+// Register the session handler.
+$handler->register();
+
+// We just set a fixed session ID only for the sake of our example.
+session_id('example_session_id');
+
+session_start();
+
+if (isset($_SESSION['foo'])) {
+    echo "Session has `foo` set to {$_SESSION['foo']}", PHP_EOL;
+} else {
+    $_SESSION['foo'] = $value = mt_rand();
+    echo "Empty session, `foo` has been set with $value", PHP_EOL;
+}

examples/shared.php

@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+if (PHP_SAPI !== 'cli') {
+    exit('Example scripts are meant to be executed locally via CLI.');
+}
+
+require __DIR__ . '/../autoload.php';
+
+function redis_version($info)
+{
+    if (isset($info['Server']['redis_version'])) {
+        return $info['Server']['redis_version'];
+    } elseif (isset($info['redis_version'])) {
+        return $info['redis_version'];
+    } else {
+        return 'unknown version';
+    }
+}
+
+$single_server = [
+    'host' => '127.0.0.1',
+    'port' => 6379,
+    'database' => 15,
+];
+
+$multiple_servers = [
+    [
+        'host' => '127.0.0.1',
+        'port' => 6379,
+        'database' => 15,
+        'alias' => 'first',
+    ],
+    [
+        'host' => '127.0.0.1',
+        'port' => 6380,
+        'database' => 15,
+        'alias' => 'second',
+    ],
+];

examples/transaction_using_cas.php

@@ -3,13 +3,14 @@
 /*
  * This file is part of the Predis package.
  *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2025 Till Krüss
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 
-require 'SharedConfigurations.php';
+require __DIR__ . '/shared.php';
 
 // This is an implementation of an atomic client-side ZPOP using the support for
 // check-and-set (CAS) operations with MULTI/EXEC transactions, as described in
@@ -19,22 +20,23 @@ require 'SharedConfigurations.php';
 //
 // ./redis-cli
 // SELECT 15
-// ZADD zset 1 a
-// ZADD zset 2 b
-// ZADD zset 3 c
+// ZADD zset 1 a 2 b 3 c
+//
+// Then execute this script four times and see its output.
+//
 
 function zpop($client, $key)
 {
     $element = null;
-    $options = array(
-        'cas'   => true,    // Initialize with support for CAS operations
+    $options = [
+        'cas' => true,      // Initialize with support for CAS operations
         'watch' => $key,    // Key that needs to be WATCHed to detect changes
         'retry' => 3,       // Number of retries on aborted transactions, after
-                            // which the client bails out with an exception.
-    );
+        // which the client bails out with an exception.
+    ];
 
-    $client->multiExec($options, function($tx) use ($key, &$element) {
-        @list($element) = $tx->zrange($key, 0, 0);
+    $client->transaction($options, function ($tx) use ($key, &$element) {
+        @[$element] = $tx->zrange($key, 0, 0);
 
         if (isset($element)) {
             $tx->multi();   // With CAS, MULTI *must* be explicitly invoked.
@@ -48,4 +50,4 @@ function zpop($client, $key)
 $client = new Predis\Client($single_server);
 $zpopped = zpop($client, 'zset');
 
-echo isset($zpopped) ? "ZPOPed $zpopped" : "Nothing to ZPOP!", "\n";
+echo isset($zpopped) ? "ZPOPed $zpopped" : 'Nothing to ZPOP!', PHP_EOL;

lib/Predis/Autoloader.php

@@ -1,57 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace Predis;
-
-/**
- * Implements a lightweight PSR-0 compliant autoloader.
- *
- * @author Eric Naeseth <eric@thumbtack.com>
- */
-class Autoloader
-{
-    private $baseDir;
-    private $prefix;
-
-    /**
-     * @param string $baseDirectory Base directory where the source files are located.
-     */
-    public function __construct($baseDirectory = null)
-    {
-        $this->baseDir = $baseDirectory ?: dirname(__FILE__);
-        $this->prefix = __NAMESPACE__ . '\\';
-    }
-
-    /**
-     * Registers the autoloader class with the PHP SPL autoloader.
-     */
-    public static function register()
-    {
-        spl_autoload_register(array(new self, 'autoload'));
-    }
-
-    /**
-     * Loads a class from a file using its fully qualified name.
-     *
-     * @param string $className Fully qualified name of a class.
-     */
-    public function autoload($className)
-    {
-        if (0 !== strpos($className, $this->prefix)) {
-            return;
-        }
-
-        $relativeClassName = substr($className, strlen($this->prefix));
-        $classNameParts = explode('\\', $relativeClassName);
-
-        require_once $this->baseDir.DIRECTORY_SEPARATOR.implode(DIRECTORY_SEPARATOR, $classNameParts).'.php';
-    }
-}

lib/Predis/Client.php

@@ -1,393 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace Predis;
-
-use Predis\Commands\ICommand;
-use Predis\Options\IClientOptions;
-use Predis\Network\IConnection;
-use Predis\Network\IConnectionSingle;
-use Predis\Profiles\IServerProfile;
-use Predis\Options\ClientOptions;
-use Predis\Profiles\ServerProfile;
-use Predis\PubSub\PubSubContext;
-use Predis\Pipeline\PipelineContext;
-use Predis\Transaction\MultiExecContext;
-
-/**
- * Main class that exposes the most high-level interface to interact with Redis.
- *
- * @author Daniele Alessandri <suppakilla@gmail.com>
- */
-class Client
-{
-    const VERSION = '0.7.0';
-
-    private $options;
-    private $profile;
-    private $connection;
-    private $connections;
-
-    /**
-     * Initializes a new client with optional connection parameters and client options.
-     *
-     * @param mixed $parameters Connection parameters for one or multiple servers.
-     * @param mixed $options Options that specify certain behaviours for the client.
-     */
-    public function __construct($parameters = null, $options = null)
-    {
-        $options = $this->filterOptions($options);
-        $this->options = $options;
-        $this->profile = $options->profile;
-        $this->connections = $options->connections;
-        $this->connection = $this->initializeConnection($parameters);
-    }
-
-    /**
-     * Creates an instance of Predis\Options\ClientOptions from various types of
-     * arguments (string, array, Predis\Profiles\ServerProfile) or returns the
-     * passed object if it is an instance of Predis\Options\ClientOptions.
-     *
-     * @param mixed $options Client options.
-     * @return ClientOptions
-     */
-    protected function filterOptions($options)
-    {
-        if ($options === null) {
-            return new ClientOptions();
-        }
-        if (is_array($options)) {
-            return new ClientOptions($options);
-        }
-        if ($options instanceof IClientOptions) {
-            return $options;
-        }
-        if ($options instanceof IServerProfile || is_string($options)) {
-            return new ClientOptions(array('profile' => $options));
-        }
-
-        throw new \InvalidArgumentException("Invalid type for client options");
-    }
-
-    /**
-     * Initializes one or multiple connection (cluster) objects from various
-     * types of arguments (string, array) or returns the passed object if it
-     * implements the Predis\Network\IConnection interface.
-     *
-     * @param mixed $parameters Connection parameters or instance.
-     * @return IConnection
-     */
-    protected function initializeConnection($parameters)
-    {
-        if ($parameters instanceof IConnection) {
-            return $parameters;
-        }
-        if (is_array($parameters) && isset($parameters[0])) {
-            return $this->connections->createCluster($this->options->cluster, $parameters, $this->profile);
-        }
-
-        return $this->connections->create($parameters, $this->profile);
-    }
-
-    /**
-     * Returns the server profile used by the client.
-     *
-     * @return IServerProfile
-     */
-    public function getProfile()
-    {
-        return $this->profile;
-    }
-
-    /**
-     * Returns the client options specified upon initialization.
-     *
-     * @return ClientOptions
-     */
-    public function getOptions()
-    {
-        return $this->options;
-    }
-
-    /**
-     * Returns the connection factory object used by the client.
-     *
-     * @return IConnectionFactory
-     */
-    public function getConnectionFactory()
-    {
-        return $this->connections;
-    }
-
-    /**
-     * Returns a new instance of a client for the specified connection when the
-     * client is connected to a cluster. The new instance will use the same
-     * options of the original client.
-     *
-     * @return Client
-     */
-    public function getClientFor($connectionAlias)
-    {
-        if (($connection = $this->getConnection($connectionAlias)) === null) {
-            throw new \InvalidArgumentException("Invalid connection alias: '$connectionAlias'");
-        }
-
-        return new Client($connection, $this->options);
-    }
-
-    /**
-     * Opens the connection to the server.
-     */
-    public function connect()
-    {
-        $this->connection->connect();
-    }
-
-    /**
-     * Disconnects from the server.
-     */
-    public function disconnect()
-    {
-        $this->connection->disconnect();
-    }
-
-    /**
-     * Disconnects from the server.
-     *
-     * This method is an alias of disconnect().
-     */
-    public function quit()
-    {
-        $this->disconnect();
-    }
-
-    /**
-     * Checks if the underlying connection is connected to Redis.
-     *
-     * @return Boolean True means that the connection is open.
-     *                 False means that the connection is closed.
-     */
-    public function isConnected()
-    {
-        return $this->connection->isConnected();
-    }
-
-    /**
-     * Returns the underlying connection instance or, when connected to a cluster,
-     * one of the connection instances identified by its alias.
-     *
-     * @param string $id The alias of a connection when connected to a cluster.
-     * @return IConnection
-     */
-    public function getConnection($id = null)
-    {
-        if (isset($id)) {
-            if (!Helpers::isCluster($this->connection)) {
-                $message = 'Retrieving connections by alias is supported only with clustered connections';
-                throw new NotSupportedException($message);
-            }
-            return $this->connection->getConnectionById($id);
-        }
-
-        return $this->connection;
-    }
-
-    /**
-     * Dinamically invokes a Redis command with the specified arguments.
-     *
-     * @param string $method The name of a Redis command.
-     * @param array $arguments The arguments for the command.
-     * @return mixed
-     */
-    public function __call($method, $arguments)
-    {
-        $command = $this->profile->createCommand($method, $arguments);
-        return $this->connection->executeCommand($command);
-    }
-
-    /**
-     * Creates a new instance of the specified Redis command.
-     *
-     * @param string $method The name of a Redis command.
-     * @param array $arguments The arguments for the command.
-     * @return ICommand
-     */
-    public function createCommand($method, $arguments = array())
-    {
-        return $this->profile->createCommand($method, $arguments);
-    }
-
-    /**
-     * Executes the specified Redis command.
-     *
-     * @param ICommand $command A Redis command.
-     * @return mixed
-     */
-    public function executeCommand(ICommand $command)
-    {
-        return $this->connection->executeCommand($command);
-    }
-
-    /**
-     * Executes the specified Redis command on all the nodes of a cluster.
-     *
-     * @param ICommand $command A Redis command.
-     * @return array
-     */
-    public function executeCommandOnShards(ICommand $command)
-    {
-        if (Helpers::isCluster($this->connection)) {
-            $replies = array();
-
-            foreach ($this->connection as $connection) {
-                $replies[] = $connection->executeCommand($command);
-            }
-
-            return $replies;
-        }
-
-        return array($this->connection->executeCommand($command));
-    }
-
-    /**
-     * Calls the specified initializer method on $this with 0, 1 or 2 arguments.
-     *
-     * TODO: Invert $argv and $initializer.
-     *
-     * @param array $argv Arguments for the initializer.
-     * @param string $initializer The initializer method.
-     * @return mixed
-     */
-    private function sharedInitializer($argv, $initializer)
-    {
-        switch (count($argv)) {
-            case 0:
-                return $this->$initializer();
-
-            case 1:
-                list($arg0) = $argv;
-                return is_array($arg0) ? $this->$initializer($arg0) : $this->$initializer(null, $arg0);
-
-            case 2:
-                list($arg0, $arg1) = $argv;
-                return $this->$initializer($arg0, $arg1);
-
-            default:
-                return $this->$initializer($this, $argv);
-        }
-    }
-
-    /**
-     * Creates a new pipeline context and returns it, or returns the results of
-     * a pipeline executed inside the optionally provided callable object.
-     *
-     * @param mixed $arg,... Options for the context, a callable object, or both.
-     * @return PipelineContext|array
-     */
-    public function pipeline(/* arguments */)
-    {
-        return $this->sharedInitializer(func_get_args(), 'initPipeline');
-    }
-
-    /**
-     * Pipeline context initializer.
-     *
-     * @param array $options Options for the context.
-     * @param mixed $callable Optional callable object used to execute the context.
-     * @return PipelineContext|array
-     */
-    protected function initPipeline(Array $options = null, $callable = null)
-    {
-        $pipeline = new PipelineContext($this, $options);
-        return $this->pipelineExecute($pipeline, $callable);
-    }
-
-    /**
-     * Executes a pipeline context when a callable object is passed.
-     *
-     * @param array $options Options of the context initialization.
-     * @param mixed $callable Optional callable object used to execute the context.
-     * @return PipelineContext|array
-     */
-    private function pipelineExecute(PipelineContext $pipeline, $callable)
-    {
-        return isset($callable) ? $pipeline->execute($callable) : $pipeline;
-    }
-
-    /**
-     * Creates a new transaction context and returns it, or returns the results of
-     * a transaction executed inside the optionally provided callable object.
-     *
-     * @param mixed $arg,... Options for the context, a callable object, or both.
-     * @return MultiExecContext|array
-     */
-    public function multiExec(/* arguments */)
-    {
-        return $this->sharedInitializer(func_get_args(), 'initMultiExec');
-    }
-
-    /**
-     * Transaction context initializer.
-     *
-     * @param array $options Options for the context.
-     * @param mixed $callable Optional callable object used to execute the context.
-     * @return MultiExecContext|array
-     */
-    protected function initMultiExec(Array $options = null, $callable = null)
-    {
-        $transaction = new MultiExecContext($this, $options ?: array());
-        return isset($callable) ? $transaction->execute($callable) : $transaction;
-    }
-
-    /**
-     * Creates a new Publish / Subscribe context and returns it, or executes it
-     * inside the optionally provided callable object.
-     *
-     * @param mixed $arg,... Options for the context, a callable object, or both.
-     * @return MultiExecContext|array
-     */
-    public function pubSub(/* arguments */)
-    {
-        return $this->sharedInitializer(func_get_args(), 'initPubSub');
-    }
-
-    /**
-     * Publish / Subscribe context initializer.
-     *
-     * @param array $options Options for the context.
-     * @param mixed $callable Optional callable object used to execute the context.
-     * @return PubSubContext
-     */
-    protected function initPubSub(Array $options = null, $callable = null)
-    {
-        $pubsub = new PubSubContext($this, $options);
-
-        if (!isset($callable)) {
-            return $pubsub;
-        }
-
-        foreach ($pubsub as $message) {
-            if (call_user_func($callable, $pubsub, $message) === false) {
-                $pubsub->closeContext();
-            }
-        }
-    }
-
-    /**
-     * Returns a new monitor context.
-     *
-     * @return MonitorContext
-     */
-    public function monitor()
-    {
-        return new MonitorContext($this);
-    }
-}

lib/Predis/Commands/Command.php

@@ -1,170 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace Predis\Commands;
-
-use Predis\Helpers;
-use Predis\Distribution\INodeKeyGenerator;
-
-/**
- * Base class for Redis commands.
- *
- * @author Daniele Alessandri <suppakilla@gmail.com>
- */
-abstract class Command implements ICommand
-{
-    private $hash;
-    private $arguments = array();
-
-    /**
-     * Returns a filtered array of the arguments.
-     *
-     * @param array $arguments List of arguments.
-     * @return array
-     */
-    protected function filterArguments(Array $arguments)
-    {
-        return $arguments;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setArguments(Array $arguments)
-    {
-        $this->arguments = $this->filterArguments($arguments);
-        unset($this->hash);
-    }
-
-    /**
-     * Sets the arguments array without filtering.
-     *
-     * @param array $arguments List of arguments.
-     */
-    public function setRawArguments(Array $arguments)
-    {
-        $this->arguments = $arguments;
-        unset($this->hash);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getArguments()
-    {
-        return $this->arguments;
-    }
-
-    /**
-     * Gets the argument from the arguments list at the specified index.
-     *
-     * @param array $arguments Position of the argument.
-     */
-    public function getArgument($index = 0)
-    {
-        if (isset($this->arguments[$index]) === true) {
-            return $this->arguments[$index];
-        }
-    }
-
-    /**
-     * Checks if the command can return an hash for client-side sharding.
-     *
-     * @return Boolean
-     */
-    protected function canBeHashed()
-    {
-        return isset($this->arguments[0]);
-    }
-
-    /**
-     * Checks if the specified array of keys will generate the same hash.
-     *
-     * @param array $keys Array of keys.
-     * @return Boolean
-     */
-    protected function checkSameHashForKeys(Array $keys)
-    {
-        if (($count = count($keys)) === 0) {
-            return false;
-        }
-
-        $currentKey = Helpers::extractKeyTag($keys[0]);
-
-        for ($i = 1; $i < $count; $i++) {
-            $nextKey = Helpers::extractKeyTag($keys[$i]);
-            if ($currentKey !== $nextKey) {
-                return false;
-            }
-            $currentKey = $nextKey;
-        }
-
-        return true;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getHash(INodeKeyGenerator $distributor)
-    {
-        if (isset($this->hash)) {
-            return $this->hash;
-        }
-
-        if ($this->canBeHashed()) {
-            $key = Helpers::extractKeyTag($this->arguments[0]);
-            $this->hash = $distributor->generateKey($key);
-
-            return $this->hash;
-        }
-
-        return null;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function parseResponse($data)
-    {
-        return $data;
-    }
-
-    /**
-     * Helper function used to reduce a list of arguments to a string.
-     *
-     * @param string $accumulator Temporary string.
-     * @param string $argument Current argument.
-     * @return string
-     */
-    protected function toStringArgumentReducer($accumulator, $argument)
-    {
-        if (strlen($argument) > 32) {
-            $argument = substr($argument, 0, 32) . '[...]';
-        }
-        $accumulator .= " $argument";
-
-        return $accumulator;
-    }
-
-    /**
-     * Returns a partial string representation of the command with its arguments.
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return array_reduce(
-            $this->getArguments(),
-            array($this, 'toStringArgumentReducer'),
-            $this->getId()
-        );
-    }
-}

lib/Predis/Commands/ConnectionAuth.php

@@ -1,35 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace Predis\Commands;
-
-/**
- * @link http://redis.io/commands/auth
- * @author Daniele Alessandri <suppakilla@gmail.com>
- */
-class ConnectionAuth extends Command
-{
-    /**
-     * {@inheritdoc}
-     */
-    public function getId()
-    {
-        return 'AUTH';
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function canBeHashed()
-    {
-        return false;
-    }
-}

lib/Predis/Commands/ConnectionEcho.php

@@ -1,35 +0,0 @@
-<?php
-
-/*
- * This file is part of the Predis package.
- *
- * (c) Daniele Alessandri <suppakilla@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace Predis\Commands;
-
-/**
- * @link http://redis.io/commands/echo
- * @author Daniele Alessandri <suppakilla@gmail.com>
- */
-class ConnectionEcho extends Command
-{
-    /**
-     * {@inheritdoc}
-     */
-    public function getId()
-    {
-        return 'ECHO';
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function canBeHashed()
-    {
-        return false;
-    }
-}