BeforeDirectFileDownloadEvent
extends Event
in package
This event is triggered when a user tries to download a file directly.
Tags
Table of Contents
Properties
- $errorMessage : string|null
- $path : string
- $propagationStopped : bool
- $successful : bool
Methods
- __construct() : mixed
- Compatibility constructor
- getErrorMessage() : string|null
- Get the error message, if any
- getPath() : string
- isPropagationStopped() : bool
- {@inheritDoc}
- isSuccessful() : bool
- setErrorMessage() : void
- setSuccessful() : void
- Set if the event was successful
- stopPropagation() : void
- Stops the propagation of the event to further event listeners
Properties
$errorMessage
private
string|null
$errorMessage
= null
$path
private
string
$path
$propagationStopped
private
bool
$propagationStopped
= false
Tags
$successful
private
bool
$successful
= true
Methods
__construct()
Compatibility constructor
public
__construct(string $path) : mixed
Parameters
- $path : string
Tags
getErrorMessage()
Get the error message, if any
public
getErrorMessage() : string|null
Tags
Return values
string|nullgetPath()
public
getPath() : string
Tags
Return values
stringisPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Return values
boolisSuccessful()
public
isSuccessful() : bool
Tags
Return values
boolsetErrorMessage()
public
setErrorMessage(string $errorMessage) : void
Parameters
- $errorMessage : string
Tags
setSuccessful()
Set if the event was successful
public
setSuccessful(bool $successful) : void
Parameters
- $successful : bool
Tags
stopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void