README

Simple driver setup for CraftCMS components queue, cache or session for CraftCMS v4 and v5.

Available components and drivers

Note

Craft's default queue driver is the database. Do not configure the queue component in the app.php if you want to make use of the database queue driver.

Craft v4: https://craftcms.com/docs/4.x/config/app.html#queue
Craft v5: https://craftcms.com/docs/5.x/reference/config/app.html#queue

Installation

composer require jobverplanke/craftcms-components

Make sure that the yiisoft/yii2-redis package is installed when utilizing Redis

composer require yiisoft/yii2-redis

Configuration

To make use of a different driver per component is a breeze. Just specify the desired driver for the component you want to use in the components config array in either config/app.php or config/app.web.php (session only).

Database configuration

In order to use the database driver, configure CraftCMS as followed

Cache component

// .env
CRAFT_CACHE_DRIVER=database

// config/app.php

use craft\helpers\App;
use Verplanke\CraftComponents\Components\Cache;

return [
    'components' => [
        'cache' => fn () => Cache::driver(App::env('CRAFT_CACHE_DRIVER')),
    ],
];

Queue component

// .env
CRAFT_QUEUE_DRIVER=database

// config/app.php

use craft\helpers\App;
use Verplanke\CraftComponents\Components\Queue;

return [
    'components' => [
        'queue' => Queue::driver(App::env('CRAFT_QUEUE_DRIVER')),
    ],
];

Session component

// .env
CRAFT_SESSION_DRIVER=database

// config/app.web.php

use craft\helpers\App;
use Verplanke\CraftComponents\Components\Session;

return [
    'components' => [
        'session' => fn () => Session::driver(App::env('CRAFT_SESSION_DRIVER')),
    ],
];

Redis configuration

If you want to use the Redis driver for a specific component, make sure Redis is configured

1. Add the Redis component to the app.php, see example below
2. Enable Redis by adding the following environment variables
   • REDIS_URL= OR REDIS_HOST, REDIS_PORT and REDIS_PASSWORD

Note

REDIS_URL takes precedence over REDIS_HOST, REDIS_PORT and REDIS_PASSWORD.

// config/app.php

use Verplanke\CraftComponents\Components\Redis;

return [
    'components' => [
        'redis' => Redis::connect(),
    ],
];

Cache component

// .env
CRAFT_CACHE_DRIVER=redis

// config/app.php

use craft\helpers\App;
use Verplanke\CraftComponents\Components\Cache;

return [
    'components' => [
        'cache' => fn () => Cache::driver(App::env('CRAFT_CACHE_DRIVER')),
    ],
];

Queue component

// .env
CRAFT_QUEUE_DRIVER=redis

// config/app.php

use craft\helpers\App;
use Verplanke\CraftComponents\Components\Queue;

return [
    'components' => [
        'queue' => Queue::driver(App::env('CRAFT_QUEUE_DRIVER')),
    ],
];

Session component

// .env
CRAFT_SESSION_DRIVER=redis

// config/app.web.php

use craft\helpers\App;
use Verplanke\CraftComponents\Components\Session;

return [
    'components' => [
        'session' => fn () => Session::driver(App::env('CRAFT_SESSION_DRIVER')),
    ],
];

Environment Variable Configuration

The following environment variables are available for further configuration of the components
It's recommended to leave the following set to false when using Heroku. Heroku issue and Github issue

• REDIS_SSL
• REDIS_SSL_VERIFY_PEER
• REDIS_SSL_VERIFY_PEER_NAME