PackageEvent
extends InstallerEvent
in package
The Package Event.
Tags
Table of Contents
- $args : array<string|int, mixed>
- $flags : array<string|int, mixed>
- $name : string
- $composer : Composer
- $devMode : bool
- $installedRepo : CompositeRepository
- $io : IOInterface
- $operation : OperationInterface
- $operations : array<string|int, OperationInterface>
- $policy : PolicyInterface
- $pool : Pool
- $propagationStopped : bool
- $request : Request
- __construct() : mixed
- Constructor.
- getArguments() : array<string|int, mixed>
- Returns the event's arguments.
- getComposer() : Composer
- getFlags() : array<string|int, mixed>
- Returns the event's flags.
- getInstalledRepo() : CompositeRepository
- getIO() : IOInterface
- getName() : string
- Returns the event's name.
- getOperation() : OperationInterface
- Returns the package instance.
- getOperations() : array<string|int, OperationInterface>
- getPolicy() : PolicyInterface
- getPool() : Pool
- getRequest() : Request
- isDevMode() : bool
- isPropagationStopped() : bool
- Checks if stopPropagation has been called
- stopPropagation() : mixed
- Prevents the event from being passed to further listeners
Properties
$args
protected
array<string|int, mixed>
$args
Arguments passed by the user, these will be forwarded to CLI script handlers
$flags
protected
array<string|int, mixed>
$flags
Flags usable in PHP script handlers
$name
protected
string
$name
This event's name
$composer
private
Composer
$composer
$devMode
private
bool
$devMode
$installedRepo
private
CompositeRepository
$installedRepo
$io
private
IOInterface
$io
$operation
private
OperationInterface
$operation
The package instance
$operations
private
array<string|int, OperationInterface>
$operations
$policy
private
PolicyInterface
$policy
$pool
private
Pool
$pool
$propagationStopped
private
bool
$propagationStopped
= false
Whether the event should not be passed to more listeners
$request
private
Request
$request
Methods
__construct()
Constructor.
public
__construct(string $eventName, Composer $composer, IOInterface $io, bool $devMode, PolicyInterface $policy, Pool $pool, CompositeRepository $installedRepo, Request $request, array<string|int, OperationInterface> $operations, OperationInterface $operation) : mixed
Parameters
- $eventName : string
- $composer : Composer
- $io : IOInterface
- $devMode : bool
- $policy : PolicyInterface
- $pool : Pool
- $installedRepo : CompositeRepository
- $request : Request
- $operations : array<string|int, OperationInterface>
- $operation : OperationInterface
Return values
mixed —getArguments()
Returns the event's arguments.
public
getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —The event arguments
getComposer()
public
getComposer() : Composer
Return values
Composer —getFlags()
Returns the event's flags.
public
getFlags() : array<string|int, mixed>
Return values
array<string|int, mixed> —The event flags
getInstalledRepo()
public
getInstalledRepo() : CompositeRepository
Return values
CompositeRepository —getIO()
public
getIO() : IOInterface
Return values
IOInterface —getName()
Returns the event's name.
public
getName() : string
Return values
string —The event name
getOperation()
Returns the package instance.
public
getOperation() : OperationInterface
Return values
OperationInterface —getOperations()
public
getOperations() : array<string|int, OperationInterface>
Return values
array<string|int, OperationInterface> —getPolicy()
public
getPolicy() : PolicyInterface
Return values
PolicyInterface —getPool()
public
getPool() : Pool
Return values
Pool —getRequest()
public
getRequest() : Request
Return values
Request —isDevMode()
public
isDevMode() : bool
Return values
bool —isPropagationStopped()
Checks if stopPropagation has been called
public
isPropagationStopped() : bool
Return values
bool —Whether propagation has been stopped
stopPropagation()
Prevents the event from being passed to further listeners
public
stopPropagation() : mixed