Gedmo Sluggable SlugHandler fix when using native attributes vs annotations

Iwan Luijks

When you have a SlugHandler defined on a property as annotation, take note that when converting those kind of annotations to attributes (even when using RectorPHP) the SlugHandler for the Gedmo library requires using a separate attribute when applicable (besides the Slug attribute, again, when applicable) as handlers is as an option only available when using 

In detail example shown below, starting with the "before" using annotations.

<?php
// The before, using annotations:

use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;

...

/**
 * @ORM\Column(length=128)
 * @Gedmo\Slug(handlers={
 *      @Gedmo\SlugHandler(class="Gedmo\Sluggable\Handler\RelativeSlugHandler", options={
 *          @Gedmo\SlugHandlerOption(name="relationField", value="exchange"),
 *          @Gedmo\SlugHandlerOption(name="relationSlugField", value="slug"),
 *          @Gedmo\SlugHandlerOption(name="separator", value=": ")
 *      })
 * }, fields={"baseSymbol", "symbol"}, unique=true);
 */
private string $slug;

...

Now the version that has the annotations converted (manually or automatically (even using RectorPHP)). Notice the usage of SlugHandler.

<?php
// Converted to attributes, might have been done manually, using RectorPHP, etc.. (the after):

use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;

...

#[ORM\Column(length: 128)]
#[Gedmo\Slug(handlers: [new Gedmo\SlugHandler(class: 'Gedmo\Sluggable\Handler\RelativeSlugHandler', options: [new Gedmo\SlugHandlerOption(name: 'relationField', value: 'exchange'), new Gedmo\SlugHandlerOption(name: 'relationSlugField', value: 'slug'), new Gedmo\SlugHandlerOption(name: 'separator', value: ': ')])], fields: ['baseSymbol', 'symbol'], unique: true)]
private string $slug;

...

The actual working version is shown below, notice the array key/value pairs instead of using Gedmo\SlugHandler instances.

<?php
// The actual working version:

use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;

...

#[ORM\Column(length: 128)]
#[Gedmo\Slug(fields: ['baseSymbol', 'symbol'], unique: true)]
#[Gedmo\SlugHandler(
    class: \Gedmo\Sluggable\Handler\RelativeSlugHandler::class,
    options: [
        'relationField' => 'exchange',
        'relationSlugField' => 'slug',
        'separator' => ': '
    ]
)]
private string $slug;

...

See https://github.com/doctrine-extensions/DoctrineExtensions/blob/main/doc/sluggable.md#some-other-configuration-options-for-slug-annotation-and-attribute for more information.

You should also read: