class PreFileDownloadEvent extends Event (View source)

The pre file download event.

Properties

protected string $name from Event
protected array $args from Event
protected array $flags from Event

Methods

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

Constructor.

string
getName()

Returns the event's name.

from Event
array
getArguments()

Returns the event's arguments.

from Event
array
getFlags()

Returns the event's flags.

from Event
bool
isPropagationStopped()

Checks if stopPropagation has been called

from Event
stopPropagation()

Prevents the event from being passed to further listeners

from Event
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

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

Constructor.

Parameters

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

string getName()

Returns the event's name.

Return Value

string The event name

array getArguments()

Returns the event's arguments.

Return Value

array The event arguments

array getFlags()

Returns the event's flags.

Return Value

array The event flags

bool isPropagationStopped()

Checks if stopPropagation has been called

Return Value

bool Whether propagation has been stopped

stopPropagation()

Prevents the event from being passed to further listeners

RemoteFilesystem getRemoteFilesystem()

Returns the remote filesystem

Return Value

RemoteFilesystem

setRemoteFilesystem(RemoteFilesystem $rfs)

Sets the remote filesystem

Parameters

RemoteFilesystem $rfs

string getProcessedUrl()

Retrieves the processed URL this remote filesystem will be used for

Return Value

string