WriterInitializationEvent
extends EventAbstract
in package
FinalYes
Abstract class representing the base elements of a phpDocumentor event.
Table of Contents
Properties
- $subject : object
- $writer : WriterAbstract|null
Methods
- __construct() : mixed
- Initializes this event with the given subject.
- createInstance() : EventAbstract
- Creates a new instance of a derived object and return that.
- getSubject() : object
- Returns the object that is the subject of this event.
- getWriter() : WriterAbstract|null
- setWriter() : WriterInitializationEvent
- Sets the currently parsed writer in this event.
Properties
$subject
protected
object
$subject
Represents an object that is the subject of this event
$writer
private
WriterAbstract|null
$writer
= null
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
EventAbstractgetSubject()
Returns the object that is the subject of this event.
public
getSubject() : object
Return values
objectgetWriter()
public
getWriter() : WriterAbstract|null
Return values
WriterAbstract|nullsetWriter()
Sets the currently parsed writer in this event.
public
setWriter(WriterAbstract $writer) : WriterInitializationEvent
Parameters
- $writer : WriterAbstract