\phpDocumentor\Transformer\EventPreTransformEvent

Event that happens prior to the execution of all transformations.

Summary

Methods
Properties
Constants
__construct()
getSubject()
createInstance()
getProject()
setProject()
setTransformations()
getTransformations()
No public properties found
No constants found
No protected methods found
$subject
N/A
No private methods found
$project
$transformations
N/A

Properties

$subject

$subject : object

Type

object — Represents an object that is the subject of this event

$transformations

$transformations : \phpDocumentor\Transformer\Transformation[]

Type

Transformation[]

Methods

__construct()

__construct(object  $subject) : mixed

Initializes this event with the given subject.

Parameters

object $subject

Returns

mixed —

getSubject()

getSubject() : object

Returns the object that is the subject of this event.

Returns

object —

createInstance()

createInstance(object  $subject) : \phpDocumentor\Event\EventAbstract

Creates a new instance of a derived object and return that.

Used as convenience method for fluent interfaces.

Parameters

object $subject

Returns

\phpDocumentor\Event\EventAbstract —

getProject()

getProject() : ?\phpDocumentor\Descriptor\ProjectDescriptor

Returns the descriptor describing the project.

Returns

?\phpDocumentor\Descriptor\ProjectDescriptor —

setProject()

setProject(\phpDocumentor\Descriptor\ProjectDescriptor  $project) : $this

Returns the descriptor describing the project.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $project

Returns

$this —

setTransformations()

setTransformations(\phpDocumentor\Transformer\Transformation[]  $transformations) : void

Parameters

\phpDocumentor\Transformer\Transformation[] $transformations

getTransformations()

getTransformations() : \phpDocumentor\Transformer\Transformation[]

Returns

\phpDocumentor\Transformer\Transformation[] —