bkdotcom/PHPDebugConsole

<?php

/**
 * This file is part of bdk\PubSub
 *
 * @package   bdk\PubSub
 * @author    Brad Kent <bkfake-github@yahoo.com>
 * @license   http://opensource.org/licenses/MIT MIT
 * @copyright 2014-2024 Brad Kent
 * @since     v3.0
 * @link      http://www.github.com/bkdotcom/PubSub
 */

namespace bdk\PubSub;

/**
 * Represents a basic event
 *
 * Events are passed to event subscribers/listeners
 *
 * @template Subject of mixed
 * @template TKey    of array-key
 * @template TValue  of mixed
 *
 * @template-extends ValueStore<TKey, TValue>
 */
class Event extends ValueStore
{
    /**
     * @var Subject Event subject - usually object or callable
     */
    protected $subject = null;

    /**
     * @var bool Whether event subscribers should be called
     */
    private $propagationStopped = false;

    /**
     * Construct an event with optional subject and values
     *
     * @param Subject            $subject The subject of the event (usually an object)
     * @param array<TKey,TValue> $values  Values to store in the event
     */
    public function __construct($subject = null, array $values = array())
    {
        $this->subject = $subject;
        $this->setValues($values);
    }

    /**
     * Magic Method
     *
     * @return array{
     *    propagationStopped: bool,
     *    subject: class-string|mixed,
     *    values: array<TKey, TValue>,
     * }
     */
    public function __debugInfo()
    {
        return array(
            'propagationStopped' => $this->propagationStopped,
            'subject' => \is_object($this->subject)
                ? \get_class($this->subject)
                : $this->subject,
            'values' => $this->values,
        );
    }

    /**
     * Get Event's "subject"
     *
     * @return Subject Usually the object that published the event
     */
    public function getSubject()
    {
        return $this->subject;
    }

    /**
     * Has propagation been stopped?
     *
     * If stopped, no further event subscribers will be called
     *
     * @see Event::stopPropagation()
     *
     * @return bool Whether propagation is stopped for this event
     */
    public function isPropagationStopped()
    {
        return $this->propagationStopped;
    }

    /**
     * Stops the propagation of the event
     *
     * No further event subscribers will be called
     *
     * @return void
     */
    public function stopPropagation()
    {
        $this->propagationStopped = true;
    }
}