This commit is contained in:
Marek
2026-03-24 00:04:55 +01:00
commit c5229e48ed
4225 changed files with 511461 additions and 0 deletions

View File

@@ -0,0 +1,37 @@
<?php
declare(strict_types=1);
namespace Doctrine\Common;
/**
* EventArgs is the base class for classes containing event data.
*
* This class contains no event data. It is used by events that do not pass state
* information to an event handler when an event is raised. The single empty EventArgs
* instance can be obtained through {@link getEmptyInstance}.
*/
class EventArgs
{
/**
* Single instance of EventArgs.
*/
private static EventArgs|null $emptyEventArgsInstance = null;
/**
* Gets the single, empty and immutable EventArgs instance.
*
* This instance will be used when events are dispatched without any parameter,
* like this: EventManager::dispatchEvent('eventname');
*
* The benefit from this is that only one empty instance is instantiated and shared
* (otherwise there would be instances for every dispatched in the abovementioned form).
*
* @link https://msdn.microsoft.com/en-us/library/system.eventargs.aspx
* @see EventManager::dispatchEvent
*/
public static function getEmptyInstance(): EventArgs
{
return self::$emptyEventArgsInstance ??= new EventArgs();
}
}

View File

@@ -0,0 +1,24 @@
<?php
declare(strict_types=1);
namespace Doctrine\Common;
/**
* Interface for event dispatching.
*
* This minimal interface is suitable for type-hinting in code that only needs
* to dispatch events without configuring listeners.
*/
interface EventDispatcher
{
/**
* Dispatches an event to all registered listeners.
*
* @param string $eventName The name of the event to dispatch. The name of the event is
* the name of the method that is invoked on listeners.
* @param EventArgs|null $eventArgs The event arguments to pass to the event handlers/listeners.
* If not supplied, the single empty EventArgs instance is used.
*/
public function dispatchEvent(string $eventName, EventArgs|null $eventArgs = null): void;
}

View File

@@ -0,0 +1,34 @@
<?php
declare(strict_types=1);
namespace Doctrine\Common;
/**
* Interface for introspecting event listeners.
*
* Provides methods to query registered listeners without modifying them.
*/
interface EventListenerIntrospector extends EventDispatcher
{
/**
* Gets the listeners of a specific event.
*
* @param string $event The name of the event.
*
* @return object[]
*/
public function getListeners(string $event): array;
/**
* Gets all listeners keyed by event name.
*
* @return array<string, object[]>
*/
public function getAllListeners(): array;
/**
* Checks whether an event has any registered listeners.
*/
public function hasListeners(string $event): bool;
}

View File

@@ -0,0 +1,26 @@
<?php
declare(strict_types=1);
namespace Doctrine\Common;
/**
* Interface for registering and unregistering event listeners.
*/
interface EventListenerRegistry extends EventDispatcher
{
/**
* Adds an event listener that listens on the specified events.
*
* @param string|string[] $events The event(s) to listen on.
* @param object $listener The listener object.
*/
public function addEventListener(string|array $events, object $listener): void;
/**
* Removes an event listener from the specified events.
*
* @param string|string[] $events
*/
public function removeEventListener(string|array $events, object $listener): void;
}

View File

@@ -0,0 +1,91 @@
<?php
declare(strict_types=1);
namespace Doctrine\Common;
use function spl_object_id;
/**
* The EventManager is the central point of Doctrine's event listener system.
* Listeners are registered on the manager and events are dispatched through the
* manager.
*/
class EventManager implements EventManagerInterface
{
/**
* Map of registered listeners.
* <event> => <listeners>
*
* @var array<string, object[]>
*/
private array $listeners = [];
/** {@inheritDoc} */
public function dispatchEvent(string $eventName, EventArgs|null $eventArgs = null): void
{
if (! isset($this->listeners[$eventName])) {
return;
}
$eventArgs ??= EventArgs::getEmptyInstance();
foreach ($this->listeners[$eventName] as $listener) {
$listener->$eventName($eventArgs);
}
}
/** {@inheritDoc} */
public function getListeners(string $event): array
{
return $this->listeners[$event] ?? [];
}
/** {@inheritDoc} */
public function getAllListeners(): array
{
return $this->listeners;
}
/** {@inheritDoc} */
public function hasListeners(string $event): bool
{
return ! empty($this->listeners[$event]);
}
/** {@inheritDoc} */
public function addEventListener(string|array $events, object $listener): void
{
// Picks the hash code related to that listener
$oid = spl_object_id($listener);
foreach ((array) $events as $event) {
// Overrides listener if a previous one was associated already
// Prevents duplicate listeners on same event (same instance only)
$this->listeners[$event][$oid] = $listener;
}
}
/** {@inheritDoc} */
public function removeEventListener(string|array $events, object $listener): void
{
// Picks the hash code related to that listener
$oid = spl_object_id($listener);
foreach ((array) $events as $event) {
unset($this->listeners[$event][$oid]);
}
}
/** {@inheritDoc} */
public function addEventSubscriber(EventSubscriber $subscriber): void
{
$this->addEventListener($subscriber->getSubscribedEvents(), $subscriber);
}
/** {@inheritDoc} */
public function removeEventSubscriber(EventSubscriber $subscriber): void
{
$this->removeEventListener($subscriber->getSubscribedEvents(), $subscriber);
}
}

View File

@@ -0,0 +1,13 @@
<?php
declare(strict_types=1);
namespace Doctrine\Common;
/** Provided for convenience, but consider using the individual interfaces directly. */
interface EventManagerInterface extends
EventListenerIntrospector,
EventListenerRegistry,
EventSubscriberRegistry
{
}

View File

@@ -0,0 +1,21 @@
<?php
declare(strict_types=1);
namespace Doctrine\Common;
/**
* An EventSubscriber knows what events it is interested in.
* If an EventSubscriber is added to an EventManager, the manager invokes
* {@link getSubscribedEvents} and registers the subscriber as a listener for all
* returned events.
*/
interface EventSubscriber
{
/**
* Returns an array of events this subscriber wants to listen to.
*
* @return string[]
*/
public function getSubscribedEvents();
}

View File

@@ -0,0 +1,27 @@
<?php
declare(strict_types=1);
namespace Doctrine\Common;
/**
* Interface for registering and unregistering event subscribers.
*/
interface EventSubscriberRegistry extends EventDispatcher
{
/**
* Adds an EventSubscriber.
*
* The subscriber is asked for all the events it is interested in and added
* as a listener for these events.
*/
public function addEventSubscriber(EventSubscriber $subscriber): void;
/**
* Removes an EventSubscriber.
*
* The subscriber is asked for all the events it is interested in and removed
* as a listener for these events.
*/
public function removeEventSubscriber(EventSubscriber $subscriber): void;
}