class Event
Same name in this branch
- 11.1.x vendor/open-telemetry/sdk/Trace/Event.php \OpenTelemetry\SDK\Trace\Event
- 11.1.x vendor/open-telemetry/gen-otlp-protobuf/Opentelemetry/Proto/Trace/V1/Span/Event.php \Opentelemetry\Proto\Trace\V1\Span\Event
- 11.1.x vendor/composer/composer/src/Composer/Script/Event.php \Composer\Script\Event
- 11.1.x vendor/symfony/event-dispatcher-contracts/Event.php \Symfony\Contracts\EventDispatcher\Event
- 11.1.x core/lib/Drupal/Component/EventDispatcher/Event.php \Drupal\Component\EventDispatcher\Event
The base event class
@author Nils Adermann <naderman@naderman.de>
Hierarchy
- class \Composer\EventDispatcher\Event
Expanded class hierarchy of Event
9 files declare their use of Event
- CommandEvent.php in vendor/
composer/ composer/ src/ Composer/ Plugin/ CommandEvent.php - Event.php in vendor/
composer/ composer/ src/ Composer/ Script/ Event.php - Factory.php in vendor/
composer/ composer/ src/ Composer/ Factory.php - InstallerEvent.php in vendor/
composer/ composer/ src/ Composer/ Installer/ InstallerEvent.php - PackageEvent.php in vendor/
composer/ composer/ src/ Composer/ Installer/ PackageEvent.php
3 string references to 'Event'
- DatabaseBackend::schemaDefinition in core/
lib/ Drupal/ Core/ Flood/ DatabaseBackend.php - Defines the schema for the flood table.
- EventDriver::isSupported in vendor/
revolt/ event-loop/ src/ EventLoop/ Driver/ EventDriver.php - PerformanceTestRecorder::onRouteBuilderFinish in core/
lib/ Drupal/ Core/ Test/ PerformanceTestRecorder.php - Records a router rebuild.
File
-
vendor/
composer/ composer/ src/ Composer/ EventDispatcher/ Event.php, line 20
Namespace
Composer\EventDispatcherView source
class Event {
/**
* @var string This event's name
*/
protected $name;
/**
* @var string[] Arguments passed by the user, these will be forwarded to CLI script handlers
*/
protected $args;
/**
* @var mixed[] Flags usable in PHP script handlers
*/
protected $flags;
/**
* @var bool Whether the event should not be passed to more listeners
*/
private $propagationStopped = false;
/**
* Constructor.
*
* @param string $name The event name
* @param string[] $args Arguments passed by the user
* @param mixed[] $flags Optional flags to pass data not as argument
*/
public function __construct(string $name, array $args = [], array $flags = []) {
$this->name = $name;
$this->args = $args;
$this->flags = $flags;
}
/**
* Returns the event's name.
*
* @return string The event name
*/
public function getName() : string {
return $this->name;
}
/**
* Returns the event's arguments.
*
* @return string[] The event arguments
*/
public function getArguments() : array {
return $this->args;
}
/**
* Returns the event's flags.
*
* @return mixed[] The event flags
*/
public function getFlags() : array {
return $this->flags;
}
/**
* Checks if stopPropagation has been called
*
* @return bool Whether propagation has been stopped
*/
public function isPropagationStopped() : bool {
return $this->propagationStopped;
}
/**
* Prevents the event from being passed to further listeners
*/
public function stopPropagation() : void {
$this->propagationStopped = true;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
Event::$args | protected | property | ||
Event::$flags | protected | property | ||
Event::$name | protected | property | ||
Event::$propagationStopped | private | property | ||
Event::getArguments | public | function | Returns the event's arguments. | |
Event::getFlags | public | function | Returns the event's flags. | |
Event::getName | public | function | Returns the event's name. | |
Event::isPropagationStopped | public | function | Checks if stopPropagation has been called | |
Event::stopPropagation | public | function | Prevents the event from being passed to further listeners | |
Event::__construct | public | function | Constructor. | 8 |