\Composer\PluginPreFileDownloadEvent

The pre file download event.

Summary

Methods
Properties
Constants
__construct()
getName()
getArguments()
getFlags()
isPropagationStopped()
stopPropagation()
getRemoteFilesystem()
setRemoteFilesystem()
getProcessedUrl()
No public properties found
No constants found
No protected methods found
$name
$args
$flags
N/A
No private methods found
$propagationStopped
$rfs
$processedUrl
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

$processedUrl

$processedUrl : string

Type

string

Methods

__construct()

__construct(string  $name, \Composer\Util\RemoteFilesystem  $rfs, string  $processedUrl) 

Constructor.

Parameters

string $name

The event name

\Composer\Util\RemoteFilesystem $rfs
string $processedUrl

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

setRemoteFilesystem()

setRemoteFilesystem(\Composer\Util\RemoteFilesystem  $rfs) 

Sets the remote filesystem

Parameters

\Composer\Util\RemoteFilesystem $rfs

getProcessedUrl()

getProcessedUrl() : string

Retrieves the processed URL this remote filesystem will be used for

Returns

string