Zemit\Events\EventsAwareTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

96.15%

Importance

Changes	3
Bugs	1	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setEventsManager()	0	3	1
A	getEventsManager()	0	4	1
A	setEventsPrefix()	0	3	1
A	getEventsPrefix()	0	14	1
A	fire()	0	10	2

<?php

/**
 * This file is part of the Zemit Framework.
 *
 * (c) Zemit Team <contact@zemit.com>
 *
 * For the full copyright and license information, please view the LICENSE.txt
 * file that was distributed with this source code.
 */

namespace Zemit\Events;

use Phalcon\Di\Di;
use Phalcon\Events\ManagerInterface;
use Zemit\Support\Helper;
use Zemit\Support\Slug;

/**
 * The EventsAwareTrait provides methods for managing events within a class.
 */
trait EventsAwareTrait
{
    /**
     * Event prefix to use as a component
     * my-component:beforeSomeTask
     * my-component:afterSomeTask
     */
    public static ?string $eventsPrefix;
    
    /**
     * The event manager responsible for handling and triggering events.
     */
    protected ?ManagerInterface $eventsManager;
    
    /**
     * Set the events manager
     */
    public function setEventsManager(ManagerInterface $manager): void
    {
        $this->eventsManager = $manager;
    }
    
    /**
     * Get the events manager.
     */
    public function getEventsManager(): ?ManagerInterface
    {
        $this->eventsManager ??= Di::getDefault()->get('eventsManager');
        return $this->eventsManager;
    }
    
    
    /**
     * Get the event component prefix
     *
     * @return string|null The event component prefix, or null if not set
     */
    public static function getEventsPrefix(): ?string
    {
        self::$eventsPrefix ??= Helper::slugify(
            Helper::uncamelize(
                basename(
                    str_replace(
                        '\\',
                        '/',
                        __CLASS__
                    )
                )
            )
        );
        return self::$eventsPrefix;
    }
    
    /**
     * Sets the events prefix.
     *
     * @param string|null $eventsPrefix The prefix to be used for events. Pass null to remove the prefix.
     *
     * @return void
     */
    public static function setEventsPrefix(?string $eventsPrefix): void
    {
        self::$eventsPrefix = $eventsPrefix;
    }
    
    /**
     * Fire an event.
     *
     * @param string $task The task to execute.
     * @param mixed|null $data The optional data to pass to the event.
     * @param bool $cancelable Whether the event is cancelable or not. Defaults to false.
     *
     * @return mixed
     */
    public function fire(string $task, mixed $data = null, bool $cancelable = false): mixed
    {
        $eventType = $this->getEventsPrefix() . ':' . $task;
        $eventsManager = $this->getEventsManager();
        
        if (!$eventsManager instanceof ManagerInterface) {
            throw new \InvalidArgumentException("Events manager must be an instance of '" . ManagerInterface::class . "'.");
        }
        
        return $eventsManager->fire($eventType, $this, $data, $cancelable);
    }
}