Skip to content

Dispatcher

Type
Class
Namespace
craft\log
Inherits
craft\log\Dispatcher » yii\log\Dispatcher » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.6.0

Class Dispatcher

View source

Public Properties

PropertyDescription
behaviorsyii\base\Behavior – List of behaviors attached to this component.
flushIntervalinteger – How many messages should be logged before they are sent to targets.
loggeryii\log\Logger – The logger.
monologTargetConfigarray – Config to pass to each MonologTarget
targetsarray, yii\log\Target – The log targets.
traceLevelinteger – How many application call stacks should be logged together with each message.

monologTargetConfig

Type
array
Default value
[]
Since
4.0.0

Config to pass to each MonologTarget

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()Constructor.
__get()Returns the value of a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__unset()Sets a component property to be null.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
dispatch()Dispatches the logged messages to targets.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getFlushInterval()
getLogger()Gets the connected logger.
getTargets()
getTraceLevel()
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined for this component.
init()Initializes the object.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
setFlushInterval()
setLogger()Sets the connected logger.
setTraceLevel()
trigger()Triggers an event.

getTargets()

View source

Returns

craft\log\MonologTarget[]

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

Protected Methods

MethodDescription
generateTargetFailErrorMessage()Generate target error message

Constants

ConstantDescription
TARGET_CONSOLE
TARGET_QUEUE
TARGET_WEB