cycle / entity-behavior

src/Schema/BaseModifier.php

<?php

declare(strict_types=1);

namespace Cycle\ORM\Entity\Behavior\Schema;

use Cycle\ORM\Entity\Behavior\Dispatcher\ListenerProvider;
use Cycle\ORM\SchemaInterface;
use Cycle\Schema\Registry;
use Cycle\Schema\SchemaModifierInterface;

abstract class BaseModifier implements SchemaModifierInterface
{
    protected string $role;

    public function compute(Registry $registry): void {}

    public function render(Registry $registry): void {}

    final public function withRole(string $role): static
    {
        $clone = clone $this;
        $clone->role = $role;
        return $clone;
    }

    final public function modifySchema(array &$schema): void
    {
        // todo: compare with default constructor values
        $args = $this->getListenerArgs();
        if ($args === []) {
            $schema[SchemaInterface::LISTENERS][] = $this->getListenerClass();
            return;
        }
        $schema[SchemaInterface::LISTENERS][] = [
            ListenerProvider::DEFINITION_CLASS => $this->getListenerClass(),
            ListenerProvider::DEFINITION_ARGS => $args,
        ];
    }

    /**
     * @return class-string

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

     */
    abstract protected function getListenerClass(): string;

    /**
     * @return array<string, mixed>
     */
    abstract protected function getListenerArgs(): array;
}