Gitee
\
Cilex
Provider
phpDocumentor
Command
Helper
Phar
Project
Compiler
Linker
Pass
Configuration
Merger
Annotation
Console
Input
Output
Descriptor
Builder
Reflector
Tags
Cache
Example
Exception
Filter
Interfaces
ProjectDescriptor
Tag
BaseTypes
Type
Validator
Event
Parser
Command
Project
Configuration
Event
Exception
Util
Partials
Exception
Plugin
Core
Descriptor
Validator
Constraints
Classes
Functions
Property
Functions
Transformer
Behaviour
Tag
Writer
Xml
Xslt
Graphs
Writer
LegacyNamespaceConverter
Tests
Scrybe
Command
Manual
Converter
Definition
Exception
Format
Exception
Metadata
TableOfContents
RestructuredText
Directives
Roles
Visitors
Template
Twig
Writer
Transformer
Behaviour
Command
Project
Template
Configuration
Transformations
Event
Exception
Router
Matcher
UrlGenerator
Standard
Template
Writer
Exception
Translator

\phpDocumentor\EventLogEvent

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.

Summary

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

Properties

$message

$message : string

Type

string — Message to display with the debugging event

$priority

$priority : integer

Type

integer — Default priority level for these events is INFO

$context

$context : array<mixed,string>

Type

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

$subject

$subject : object

Type

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

Methods

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>

__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

setPriority()

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

Set the priority level for this event.

Parameters

integer $priority

Returns

\phpDocumentor\Event\LogEvent