LogEvent

Extends \phpDocumentor\Event\DebugEvent

Logging event for phpDocumentor where information is output to the log or stdout.

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

package

Default

Methods

Initializes this event with the given subject.

__construct(object $subject) 
inherited

Arguments

$subject

object

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

createInstance(object $subject) : static
inherited static

Used as convenience method for fluent interfaces.

Arguments

$subject

object

Response

static

Returns the context for this event.

getContext() : array<mixed,string>
inherited

Response

array<mixed,string>

Returns the message that was provided with this event.

getMessage() : string
inherited

Response

string

Returns the priority level associated with this logging event.

getPriority() : integer
inherited

Response

integer

Returns the object that is the subject of this event.

getSubject() : object
inherited

Response

object

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

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

Arguments

$context

array<mixed,string>

Response

self

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

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

Arguments

$message

string

Response

\phpDocumentor\Event\DebugEvent

Set the priority level for this event.

setPriority(integer $priority) : \phpDocumentor\Event\LogEvent
see \phpDocumentor\Event\LogLevel

for the constants used in determining the logging levels.

Arguments

$priority

integer

Response

\phpDocumentor\Event\LogEvent

Properties

Default priority level for these events is DEBUG

priority : integer
inherited
var

Default priority level for these events is DEBUG

Type(s)

integer

Message to display with the debugging event

message : string
inherited
var

Message to display with the debugging event

Type(s)

string

Extra parameters to insert into the message after translation

context : array<mixed,string>
inherited
var

Extra parameters to insert into the message after translation

Type(s)

array<mixed,string>

Represents an object that is the subject of this event

subject : object
inherited
var

Represents an object that is the subject of this event

Type(s)

object