Skip to content

Add data migration matcher

Matchers in data migrations enable you to select which data from the Repository to export.

In addition to the built-in matchers, you can create custom matchers for content.

The following example creates a matcher for Section identifiers.

Create normalizer

To do this, first add a normalizer which handles the conversion between objects and the YAML format used for data migration.

Matchers are instances of FilteringCriterion, so a custom normalizer needs to denormalize into an instance of FilteringCriterion.

Normalizers

To learn more about normalizers, refer to Symfony documentation.

Create the normalizer in src/Migrations/Matcher/SectionIdentifierNormalizer.php:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<?php

namespace App\Migrations\Matcher;

use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
use Ibexa\Bundle\Migration\Serializer\Normalizer\Criterion\AbstractCriterionNormalizer;
use Ibexa\Contracts\Core\Repository\Values\Filter\FilteringCriterion;
use Webmozart\Assert\Assert;

class SectionIdentifierNormalizer extends AbstractCriterionNormalizer
{
    public function __construct()
    {
        parent::__construct('section_identifier');
    }

    /**
     * @param array<mixed> $data
     * @param array<mixed> $context
     */
    protected function createCriterion(array $data, string $type, ?string $format, array $context): FilteringCriterion
    {
        Assert::keyExists($data, 'value');

        return new Criterion\SectionIdentifier($data['value']);
    }

    public function supportsNormalization($data, string $format = null): bool
    {
        return $data instanceof Criterion\SectionIdentifier;
    }
}

Register the normalizer as a service:

1
2
3
    App\Migrations\Matcher\SectionIdentifierNormalizer:
        tags:
            - { name: 'ibexa.migrations.serializer.normalizer' }

Normalizer order

User-defined normalizers are always executed before the built-in ones. However, you can additionally set the priority of your normalizers.

Check the priorities of all normalization services by using:

1
php bin/console debug:container --tag ibexa.migrations.serializer.normalizer

Create generator

Additionally, if you want to export data using the ibexa:migrations:generate command, you need a generator. Create the generator in src/Migrations/Matcher/SectionIdentifierGenerator.php:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
<?php

declare(strict_types=1);

namespace App\Migrations\Matcher;

use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
use Ibexa\Migration\Generator\CriterionGenerator\GeneratorInterface;

final class SectionIdentifierGenerator implements GeneratorInterface
{
    public static function getMatchProperty(): string
    {
        return 'section_identifier';
    }

    public function generate($value): Criterion
    {
        return new Criterion\SectionIdentifier($value);
    }
}

Register the generator as a service:

1
2
3
    App\Migrations\Matcher\SectionIdentifierGenerator:
        tags:
            - { name: 'ibexa.migrations.generator.criterion_generator.content' }