\phpDocumentor\Transformer\EventWriterInitializationEvent

Abstract class representing the base elements of a phpDocumentor event.

Summary

Methods
Properties
Constants
__construct()
getSubject()
createInstance()
setWriter()
getWriter()
No public properties found
No constants found
No protected methods found
$subject
N/A
No private methods found
$writer
N/A

Properties

$subject

$subject : object

Type

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

$writer

$writer : \phpDocumentor\Transformer\Writer\WriterAbstract|null

Type

WriterAbstract|null

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 —

setWriter()

setWriter(\phpDocumentor\Transformer\Writer\WriterAbstract  $writer) : \phpDocumentor\Transformer\Event\WriterInitializationEvent

Sets the currently parsed writer in this event.

Parameters

\phpDocumentor\Transformer\Writer\WriterAbstract $writer

Returns

\phpDocumentor\Transformer\Event\WriterInitializationEvent —

getWriter()

getWriter() : ?\phpDocumentor\Transformer\Writer\WriterAbstract

Returns

?\phpDocumentor\Transformer\Writer\WriterAbstract —