Skip to content

Latest commit

 

History

History
125 lines (88 loc) · 3.81 KB

processors.md

File metadata and controls

125 lines (88 loc) · 3.81 KB

Processors

Processors process data: send an email, persist to storage, add to queue etc.

Default processors

When your resource is a Doctrine entity, there are default processors which are already configured to your operations.

As it uses the Doctrine repository configured on your resource, it will automatically flush data for you.

Operation Processor
create Sylius\Resource\Doctrine\Common\State\PersistProcessor
update Sylius\Resource\Doctrine\Common\State\PersistProcessor
delete Sylius\Resource\Doctrine\Common\State\RemoveProcessor
bulk delete Sylius\Resource\Doctrine\Common\State\RemoveProcessor

Custom processors

Custom processors are useful to customize your logic to send an email, persist data to storage, add to queue and for an advanced usage such as an hexagonal architecture.

Example #1: Sending an email after persisting data

As an example, send an email after customer registration

// src/Sylius/State/Processor/CreateCustomerProcessor.php

namespace App\Sylius\State\Processor;

use Sylius\Component\Customer\Model\CustomerInterface;
use Sylius\Resource\Doctrine\Common\State\PersistProcessor;
use Sylius\Resource\State\ProcessorInterface;

final class CreateCustomerProcessor implements ProcessorInterface
{
    public function __construct(
        private CommandBusInterface $commandBus,
        private PersistProcessor $decorated,
    ) {
    }

    public function process(mixed $data, Operation $operation, Context $context): mixed
    {
        Assert::isInstanceOf($data, Customer::class);
        
        $this->decorated->process($data, $operation, $context);

        // Here your logic to send a registration email.
        $this->commandBus->dispatch(new SendRegistrationEmailCommand(new CustomerId($data->id)));

        return null;
    }
}

Use this processor on your operation.

// src/Entity/Customer.php

namespace App\Entity\Customer;

use App\Sylius\State\Processor\CreateCustomerProcessor;

#[Resource]
#[Create(processor: CreateCustomerProcessor::class)]
final class BoardGameResource implements ResourceInterface

Example #2: Use a custom delete processor

As another example, let's configure a DeleteBoardGameProcessor on a BoardGameResource which is not a Doctrine entity.

// src/BoardGameBlog/Infrastructure/Sylius/State/Processor/DeleteBoardGameProcessor.php

namespace App\BoardGameBlog\Infrastructure\Sylius\State\Processor;

final class DeleteBoardGameProcessor implements ProcessorInterface
{
    public function __construct(
        private CommandBusInterface $commandBus,
    ) {
    }

    public function process(mixed $data, Operation $operation, Context $context): mixed
    {
        Assert::isInstanceOf($data, BoardGameResource::class);

        $this->commandBus->dispatch(new DeleteBoardGameCommand(new BoardGameId($data->id)));

        return null;
    }
}

Use this processor on your operation.

// src/BoardGameBlog/Infrastructure/Sylius/Resource/BoardGameResource.php

namespace App\BoardGameBlog\Infrastructure\Sylius\Resource;

#[Resource(
    alias: 'app.board_game',
    section: 'admin',
    formType: BoardGameType::class,
    templatesDir: 'crud',
    routePrefix: '/admin',
)]
#[Delete(processor: DeleteBoardGameProcessor::class)]
final class BoardGameResource implements ResourceInterface

Go back to the documentation's index

> Next chapter: Responders