Skip to content

index.md

Latest commit

 

History

History
124 lines (94 loc) · 4.89 KB

index.md

File metadata and controls

124 lines (94 loc) · 4.89 KB
Raw

Prerequisite

CleverAge/ProcessBundle must be installed.

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Open a command console, enter your project directory and install it using composer:

composer require cleverage/cache-process-bundle

Remember to add the following line to config/bundles.php (not required if Symfony Flex is used)

CleverAge\CacheProcessBundle\CleverAgeCacheProcessBundle::class => ['all' => true],

Configuration

The bundle has no semantic configuration. To use the cache tasks, declare at least one cache adapter: a service implementing CleverAge\CacheProcessBundle\Adapter\AdapterInterface (usually CleverAge\CacheProcessBundle\Adapter\Adapter, wrapping any Symfony cache pool), tagged cleverage.cache.adapter with its code (or with the #[AsCacheAdapter] attribute). This code is then used in the adapter option of the tasks.

The tasks are registered as services (non-shared) and are used in your processes by their code, cache_get and cache_set (e.g. task: cache_get, requires cleverage/process-bundle 5.4 or later, see its task definition). Referencing them by their class name (service: '@CleverAge\CacheProcessBundle\Task\GetTask') is deprecated since cleverage/process-bundle 5.4.

Their service id is their class name. Fetching them directly from the service container is deprecated since 2.3 (they will be private in 3.0); their former ids, cleverage_cache_process.task.get and cleverage_cache_process.task.set, are deprecated aliases since 2.3, removed in 3.0.

# config/services.yaml
services:
    app.cleverage_cache_process.adapter.app:
        class: CleverAge\CacheProcessBundle\Adapter\Adapter
        arguments: ['@cache.app', 'app']
        tags:
            - { name: cleverage.cache.adapter, code: app }

No option can be configured under cleverage_cache_process: a key there is ignored. Configuring one is deprecated since 2.3 (an E_USER_DEPRECATED error is triggered when the container is compiled), the keys will be rejected in 3.0.

Custom cache tasks

CleverAge\CacheProcessBundle\Task\AbstractCacheTask can be extended to implement other cache operations. It extends AbstractConfigurableTask, requires the cleverage_cache_process.registry.adapter service (AdapterRegistry) as constructor argument, defines the adapter and key string options (required once merged with the input, see getRequiredOptions()), and provides getMergedOptions() (options merged with the array input, resolved again so that the input values are validated, and key validated) and $this->registry->getAdapter($code).

<?php

declare(strict_types=1);

namespace App\Task;

use CleverAge\CacheProcessBundle\Task\AbstractCacheTask;
use CleverAge\ProcessBundle\Attribute\AsTask;
use CleverAge\ProcessBundle\Model\ProcessState;

#[AsTask(code: 'app_cache_delete')]
class DeleteTask extends AbstractCacheTask
{
    public function execute(ProcessState $state): void
    {
        /** @var array{adapter: string, key: string} $options */
        $options = $this->getMergedOptions($state);

        $this->registry->getAdapter($options['adapter'])->deleteItem($options['key']);
    }
}

Its code is given by the #[AsTask] attribute (cleverage/process-bundle 5.4 or later), prefixed to avoid conflicts with the codes of the bundles. With autoconfiguration, the task is also non-shared and logs in the cleverage_process_task channel. The registry is autowired by its class (since 2.3; before, pass '@cleverage_cache_process.registry.adapter' as argument), so the default App\: resource of a Symfony application is enough, or explicitly:

# config/services.yaml
services:
    App\Task\DeleteTask:
        autowire: true
        autoconfigure: true
delete_from_cache:
    task: app_cache_delete
    options:
        adapter: app
        key: my_key

Reference

Cookbooks

Exceptions

The exceptions named without namespace in the reference pages (e.g. UnexpectedValueException) are the ones of the bundle, CleverAge\CacheProcessBundle\Exception\*: they extend the SPL exceptions of the same name and implement CleverAge\ProcessBundle\Exception\ProcessExceptionInterface, so that all the errors of the process bundles can be caught at once.