PreFileDownloadEvent
extends Event
in package
The pre file download event.
Tags
Table of Contents
- $args : array<string|int, mixed>
- $flags : array<string|int, mixed>
- $name : string
- $processedUrl : string
- $propagationStopped : bool
- $rfs : RemoteFilesystem
- __construct() : mixed
- Constructor.
- getArguments() : array<string|int, mixed>
- Returns the event's arguments.
- getFlags() : array<string|int, mixed>
- Returns the event's flags.
- getName() : string
- Returns the event's name.
- getProcessedUrl() : string
- Retrieves the processed URL this remote filesystem will be used for
- getRemoteFilesystem() : RemoteFilesystem
- Returns the remote filesystem
- isPropagationStopped() : bool
- Checks if stopPropagation has been called
- setRemoteFilesystem() : mixed
- Sets the remote filesystem
- stopPropagation() : mixed
- Prevents the event from being passed to further listeners
Properties
$args
protected
array<string|int, mixed>
$args
Arguments passed by the user, these will be forwarded to CLI script handlers
$flags
protected
array<string|int, mixed>
$flags
Flags usable in PHP script handlers
$name
protected
string
$name
This event's name
$processedUrl
private
string
$processedUrl
$propagationStopped
private
bool
$propagationStopped
= false
Whether the event should not be passed to more listeners
$rfs
private
RemoteFilesystem
$rfs
Methods
__construct()
Constructor.
public
__construct(string $name, RemoteFilesystem $rfs, string $processedUrl) : mixed
Parameters
- $name : string
-
The event name
- $rfs : RemoteFilesystem
- $processedUrl : string
Return values
mixed —getArguments()
Returns the event's arguments.
public
getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —The event arguments
getFlags()
Returns the event's flags.
public
getFlags() : array<string|int, mixed>
Return values
array<string|int, mixed> —The event flags
getName()
Returns the event's name.
public
getName() : string
Return values
string —The event name
getProcessedUrl()
Retrieves the processed URL this remote filesystem will be used for
public
getProcessedUrl() : string
Return values
string —getRemoteFilesystem()
Returns the remote filesystem
public
getRemoteFilesystem() : RemoteFilesystem
Return values
RemoteFilesystem —isPropagationStopped()
Checks if stopPropagation has been called
public
isPropagationStopped() : bool
Return values
bool —Whether propagation has been stopped
setRemoteFilesystem()
Sets the remote filesystem
public
setRemoteFilesystem(RemoteFilesystem $rfs) : mixed
Parameters
- $rfs : RemoteFilesystem
Return values
mixed —stopPropagation()
Prevents the event from being passed to further listeners
public
stopPropagation() : mixed