Gitee
\
App
HttpController
Api
Lib
Process
Redis
Composer
Autoload
CaBundle
Command
Config
Console
DependencyResolver
Operation
Downloader
EventDispatcher
Exception
Installer
IO
Json
Package
Archiver
Comparer
Dumper
LinkConstraint
Loader
Version
Plugin
Capability
Question
Repository
Pear
Vcs
Script
SelfUpdate
Semver
Constraint
Spdx
Util
XdebugHandler
Cron
Tests
EasySwoole
FastRoute
DataGenerator
Dispatcher
RouteParser
JsonSchema
Constraints
TypeCheck
Entity
Exception
Iterator
Uri
Retrievers
PhpParser
Builder
Comment
ErrorHandler
Lexer
Node
Expr
AssignOp
BinaryOp
Cast
Name
Scalar
MagicConst
Stmt
TraitUseAdaptation
NodeVisitor
Parser
PrettyPrinter
Serializer
Unserializer
Psr
Log
Test
Seld
JsonLint
PharUtils
SuperClosure
Analyzer
Visitor
Exception
Swoole
Connection
Coroutine
Http
Http2
Mysql
Http
Http2
Mysql
Redis
Server
WebSocket
Symfony
Component
Console
Command
CommandLoader
DependencyInjection
Descriptor
Event
EventListener
Exception
Formatter
Helper
Input
Logger
Output
Question
Style
Tester
Tests
Command
CommandLoader
DependencyInjection
Descriptor
EventListener
Fixtures
Formatter
Helper
Input
Logger
Output
Style
Tester
Filesystem
Exception
Tests
Fixtures
MockStream
Finder
Comparator
Exception
Iterator
Tests
Comparator
Iterator
Process
Exception
Pipes
Tests
Polyfill
Ctype
Mbstring
Php56
Util

\Composer\ScriptEvent

The script event class

Summary

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

$propagationStopped

$propagationStopped : boolean

Type

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

$composer

$composer : \Composer\Composer

Type

\Composer\Composer — The composer instance

$devMode

$devMode : boolean

Type

boolean — Dev mode flag

Methods

__construct()

__construct(string  $name, \Composer\Composer  $composer, \Composer\IO\IOInterface  $io, boolean  $devMode = false, array  $args = array(), array  $flags = array())

Constructor.

Parameters

string $name

The event name
\Composer\Composer $composer

The composer object
\Composer\IO\IOInterface $io

The IOInterface object
boolean $devMode

Whether or not we are in dev mode
array $args

Arguments passed by the user
array $flags

Optional flags to pass data not as argument

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

getComposer()

getComposer() : \Composer\Composer

Returns the composer instance.

Returns

\Composer\Composer

isDevMode()

isDevMode() : boolean

Return the dev mode flag

Returns

boolean