PreTransformEvent
extends EventAbstract
in package
Event that happens prior to the execution of all transformations.
Table of Contents
Properties
- $subject : object
- $project : ProjectDescriptor|null
- $transformations : array<string|int, Transformation>
Methods
- __construct() : mixed
- Initializes this event with the given subject.
- createInstance() : EventAbstract
- Creates a new instance of a derived object and return that.
- getProject() : ProjectDescriptor|null
- Returns the descriptor describing the project.
- getSubject() : object
- Returns the object that is the subject of this event.
- getTransformations() : array<string|int, Transformation>
- isPropagationStopped() : bool
- Is propagation stopped?
- setProject() : $this
- Returns the descriptor describing the project.
- setTransformations() : void
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$subject
protected
object
$subject
Represents an object that is the subject of this event
$project
private
ProjectDescriptor|null
$project
= null
$transformations
private
array<string|int, Transformation>
$transformations
= []
Methods
__construct()
Initializes this event with the given subject.
public
__construct(object $subject) : mixed
Parameters
- $subject : object
createInstance()
Creates a new instance of a derived object and return that.
public
static createInstance(object $subject) : EventAbstract
Used as convenience method for fluent interfaces.
Parameters
- $subject : object
Return values
EventAbstractgetProject()
Returns the descriptor describing the project.
public
getProject() : ProjectDescriptor|null
Return values
ProjectDescriptor|nullgetSubject()
Returns the object that is the subject of this event.
public
getSubject() : object
Return values
objectgetTransformations()
public
getTransformations() : array<string|int, Transformation>
Return values
array<string|int, Transformation>isPropagationStopped()
Is propagation stopped?
public
isPropagationStopped() : bool
This will typically only be used by the Dispatcher to determine if the previous listener halted propagation.
Return values
bool —True if the Event is complete and no further listeners should be called. False to continue calling listeners.
setProject()
Returns the descriptor describing the project.
public
setProject(ProjectDescriptor $project) : $this
Parameters
- $project : ProjectDescriptor
Return values
$thissetTransformations()
public
setTransformations(array<string|int, Transformation> $transformations) : void
Parameters
- $transformations : array<string|int, Transformation>
stopPropagation()
Stops the propagation of the event to further event listeners.
public
stopPropagation() : void
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().