cycle / entity-behavior

src/Hook.php

<?php

declare(strict_types=1);

namespace Cycle\ORM\Entity\Behavior;

use Cycle\ORM\Entity\Behavior\Schema\BaseModifier;
use Cycle\ORM\Entity\Behavior\Listener\Hook as Listener;
use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
use Doctrine\Common\Annotations\Annotation\Target;
use JetBrains\PhpStorm\ArrayShape;

/**
 * Hook allows easy listening for any event using callable.
 * The callback function can be a static function in the entity itself or in any other class.
 * As the first parameter, the callback function accepts an event in which
 * you can get the entity class and work with him.
 * The behavior has two parameters:
 *    - callable - callback function
 *    - events - string or array. One or several events during which callable will be called
 *
 * @Annotation
 * @NamedArgumentConstructor()
 * @Target({"CLASS"})
 */
#[\Attribute(\Attribute::TARGET_CLASS), NamedArgumentConstructor]
final class Hook extends BaseModifier
{
    /** @var callable */
    private $callable;

    /**
     * @psalm-param callable $callable Callable
     * @psalm-param class-string|non-empty-array<class-string> $events Listen events
     */
    public function __construct(
        callable $callable,
        private array|string $events,
    ) {
        $this->callable = $callable;

        if (\is_string($events)) {

The condition is_string($events) is always false.

            $this->events = [$events];
        }
    }

    protected function getListenerClass(): string
    {
        return Listener::class;
    }

    #[ArrayShape(['callable' => 'callable', 'events' => 'array'])]
    protected function getListenerArgs(): array
    {
        return [
            'callable' => $this->callable,
            'events' => $this->events,
        ];
    }
}