Composer API
Class

Composer\Plugin\PreFileDownloadEvent

class PreFileDownloadEvent extends Event

The pre file download event.

Methods

__construct(string $name, RemoteFilesystem $rfs, string $processedUrl)

Constructor.

string getName()

Returns the event's name.

from Event
boolean isPropagationStopped()

Checks if stopPropagation has been called

from Event
stopPropagation()

Prevents the event from being passed to further listeners

from Event
RemoteFilesystem getRemoteFilesystem()

Returns the remote filesystem

setRemoteFilesystem(RemoteFilesystem $rfs)

Sets the remote filesystem

string getProcessedUrl()

Retrieves the processed URL this remote filesystem will be used for

Details

at line 42
public __construct(string $name, RemoteFilesystem $rfs, string $processedUrl)

Constructor.

Parameters

string $name The event name
RemoteFilesystem $rfs
string $processedUrl

in Event at line 47
public string getName()

Returns the event's name.

Return Value

string The event name

in Event at line 57
public boolean isPropagationStopped()

Checks if stopPropagation has been called

Return Value

boolean Whether propagation has been stopped

in Event at line 65
public stopPropagation()

Prevents the event from being passed to further listeners

at line 54
public RemoteFilesystem getRemoteFilesystem()

Returns the remote filesystem

Return Value

RemoteFilesystem

at line 64
public setRemoteFilesystem(RemoteFilesystem $rfs)

Sets the remote filesystem

Parameters

RemoteFilesystem $rfs

at line 74
public string getProcessedUrl()

Retrieves the processed URL this remote filesystem will be used for

Return Value

string