Actualización

This commit is contained in:
Xes
2025-04-10 12:24:57 +02:00
parent 8969cc929d
commit 45420b6f0d
39760 changed files with 4303286 additions and 0 deletions

View File

@@ -0,0 +1,45 @@
<?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.
*
* @var EventArgs|null
*/
private static $_emptyEventArgsInstance;
/**
* 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
*
* @return EventArgs
*/
public static function getEmptyInstance()
{
if (! self::$_emptyEventArgsInstance) {
self::$_emptyEventArgsInstance = new EventArgs();
}
return self::$_emptyEventArgsInstance;
}
}

View File

@@ -0,0 +1,156 @@
<?php
namespace Doctrine\Common;
use Doctrine\Deprecations\Deprecation;
use function spl_object_hash;
/**
* 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
{
/**
* Map of registered listeners.
* <event> => <listeners>
*
* @var array<string, object[]>
*/
private $listeners = [];
/**
* 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.
*
* @return void
*/
public function dispatchEvent($eventName, ?EventArgs $eventArgs = null)
{
if (! isset($this->listeners[$eventName])) {
return;
}
$eventArgs = $eventArgs ?? EventArgs::getEmptyInstance();
foreach ($this->listeners[$eventName] as $listener) {
$listener->$eventName($eventArgs);
}
}
/**
* Gets the listeners of a specific event.
*
* @param string|null $event The name of the event.
*
* @return object[]|array<string, object[]> The event listeners for the specified event, or all event listeners.
* @psalm-return ($event is null ? array<string, object[]> : object[])
*/
public function getListeners($event = null)
{
if ($event === null) {
Deprecation::trigger(
'doctrine/event-manager',
'https://github.com/doctrine/event-manager/pull/50',
'Calling %s without an event name is deprecated. Call getAllListeners() instead.',
__METHOD__
);
return $this->getAllListeners();
}
return $this->listeners[$event] ?? [];
}
/**
* Gets all listeners keyed by event name.
*
* @return array<string, object[]> The event listeners for the specified event, or all event listeners.
*/
public function getAllListeners(): array
{
return $this->listeners;
}
/**
* Checks whether an event has any registered listeners.
*
* @param string $event
*
* @return bool TRUE if the specified event has any listeners, FALSE otherwise.
*/
public function hasListeners($event)
{
return ! empty($this->listeners[$event]);
}
/**
* 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.
*
* @return void
*/
public function addEventListener($events, $listener)
{
// Picks the hash code related to that listener
$hash = spl_object_hash($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][$hash] = $listener;
}
}
/**
* Removes an event listener from the specified events.
*
* @param string|string[] $events
* @param object $listener
*
* @return void
*/
public function removeEventListener($events, $listener)
{
// Picks the hash code related to that listener
$hash = spl_object_hash($listener);
foreach ((array) $events as $event) {
unset($this->listeners[$event][$hash]);
}
}
/**
* Adds an EventSubscriber. The subscriber is asked for all the events it is
* interested in and added as a listener for these events.
*
* @param EventSubscriber $subscriber The subscriber.
*
* @return void
*/
public function addEventSubscriber(EventSubscriber $subscriber)
{
$this->addEventListener($subscriber->getSubscribedEvents(), $subscriber);
}
/**
* Removes an EventSubscriber. The subscriber is asked for all the events it is
* interested in and removed as a listener for these events.
*
* @param EventSubscriber $subscriber The subscriber.
*
* @return void
*/
public function removeEventSubscriber(EventSubscriber $subscriber)
{
$this->removeEventListener($subscriber->getSubscribedEvents(), $subscriber);
}
}

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();
}