experteam/api-redis-bundle

REDIS functionality bundle for APIs.

3.2.2 2024-03-12 00:47 UTC

Requires

• php: >=8.1
• ext-json: *
• ext-redis: *
• doctrine/doctrine-bundle: ^2.8
• doctrine/orm: ^2.14
• experteam/api-base-bundle: ^3.3.0
• snc/redis-bundle: ^4.3
• stof/doctrine-extensions-bundle: ^1.6
• symfony/dependency-injection: 6.3.*|6.4.*
• symfony/http-kernel: 6.3.*|6.4.*
• symfony/messenger: 6.3.*|6.4.*
• symfony/serializer: 6.3.*|6.4.*

Requires (Dev)

• symfony/config: 6.3.*|6.4.*
• symfony/dotenv: 6.3.*|6.4.*
• symfony/flex: ^2
• symfony/phpunit-bridge: 6.3.*|6.4.*
• symfony/property-access: 6.3.*|6.4.*

MIT

• Experteam

README

Redis Services for APIs in Symfony 5.1+
It includes:

• Redis Client: Predis client wrapper for writing and reading in redis.
• Redis Transport: Service to save entities in redis and dispatch message queues.

Install

1. Run de following composer command:
   

composer require experteam/api-redis-bundle

1. Create the configuration file through any of the following options:
   
   

   a. Manually copy the example file in the package root to the folder config/packages/.
   
   b. Copy the vendor_copy.php file to the root of the project and configure the scripts in the composer.json file:

   "scripts": {
        "vendor-scripts": [
            "@php vendor_copy.php -s vendor/experteam/api-redis-bundle/experteam_api_redis.yaml.example -d config/packages/experteam_api_redis.yaml --not-overwrite --ignore-no-source"
        ],
        "post-install-cmd": [
            "@vendor-scripts"
        ],
        "post-update-cmd": [
            "@vendor-scripts"
        ]
    },
   

2. Edit the bundle configuration file config/packages/experteam_api_redis.yaml:
   

experteam_api_redis:
    serialize_groups:
        save: read
        message: read
    elk_logger:
        save: true
        message: true
    entities:
        [Entity Namespace]:
            prefix: [prefix]
            save: false
            message: true
            message_class: [Message Class Namespace]    #required only if message equal true
        [Entity Namespace]:
            prefix: [prefix]
            save: true
            save_method: getId     #optional (default getId)
            message: false

Update

Run de following composer command:

composer update experteam/api-redis-bundle

License

MIT license.