\phpDocumentor\EventDebugEvent

Event representing some debugging information for phpDocumentor.

The information logged by this event will only be visible if the verbose option is provided to phpDocumentor.

Summary

Methods
Properties
Constants
__construct()
getSubject()
createInstance()
setMessage()
getMessage()
getPriority()
setContext()
getContext()
No public properties found
No constants found
No protected methods found
$subject
$message
$priority
$context
N/A
No private methods found
No private properties found
N/A

Properties

$subject

$subject : object

Type

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

$message

$message : string

Type

string — Message to display with the debugging event

$priority

$priority : integer

Type

integer — Default priority level for these events is DEBUG

$context

$context : array<mixed,string>

Type

array<mixed,string> — Extra parameters to insert into the message after translation

Methods

__construct()

__construct(object  $subject) 

Initializes this event with the given subject.

Parameters

object $subject

getSubject()

getSubject() : object

Returns the object that is the subject of this event.

Returns

object

createInstance()

createInstance(object  $subject) : static

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

Used as convenience method for fluent interfaces.

Parameters

object $subject

Returns

static

setMessage()

setMessage(string  $message) : \phpDocumentor\Event\DebugEvent

Provides the message that is to be shown with this event.

Parameters

string $message

Returns

\phpDocumentor\Event\DebugEvent

getMessage()

getMessage() : string

Returns the message that was provided with this event.

Returns

string

getPriority()

getPriority() : integer

Returns the priority level associated with this logging event.

Returns

integer

setContext()

setContext(array<mixed,string>  $context) : self

Sets additional context (parameters) to use when translating messages.

Parameters

array<mixed,string> $context

Returns

self

getContext()

getContext() : array<mixed,string>

Returns the context for this event.

Returns

array<mixed,string>