\Composer\ScriptCommandEvent

The Command Event.

Summary

Methods
Properties
Constants
__construct()
getComposer()
getIO()
isDevMode()
getName()
getArguments()
getFlags()
isPropagationStopped()
stopPropagation()
No public properties found
No constants found
No protected methods found
$name
$args
$flags
N/A
No private methods found
$composer
$io
$devMode
$propagationStopped
N/A

Properties

$name

$name : string

Type

string — This event's name

$args

$args : array

Type

array — Arguments passed by the user, these will be forwarded to CLI script handlers

$flags

$flags : array

Type

array — Flags usable in PHP script handlers

$composer

$composer : \Composer\Composer

Type

\Composer\Composer — The composer instance

$devMode

$devMode : boolean

Type

boolean — Dev mode flag

$propagationStopped

$propagationStopped : boolean

Type

boolean — Whether the event should not be passed to more listeners

Methods

__construct()

__construct(string  $name, array  $args = array(), array  $flags = array()) 

Constructor.

Parameters

string $name

The event name

array $args

Arguments passed by the user

array $flags

Optional flags to pass data not as argument

getComposer()

getComposer() : \Composer\Composer

Returns the composer instance.

Returns

\Composer\Composer

isDevMode()

isDevMode() : boolean

Return the dev mode flag

Returns

boolean

getName()

getName() : string

Returns the event's name.

Returns

string —

The event name

getArguments()

getArguments() : array

Returns the event's arguments.

Returns

array —

The event arguments

getFlags()

getFlags() : array

Returns the event's flags.

Returns

array —

The event flags

isPropagationStopped()

isPropagationStopped() : boolean

Checks if stopPropagation has been called

Returns

boolean —

Whether propagation has been stopped

stopPropagation()

stopPropagation() 

Prevents the event from being passed to further listeners