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
Public Properties ​
| Property | Description |
|---|---|
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| defaultTarget | craft\log\MonologTarget, null |
| defaultTargets | \Illuminate\Support\Collection<\craft\log\MonologTarget> |
| flushInterval | integer – How many messages should be logged before they are sent to targets. |
| logger | yii\log\Logger – The logger. |
| monologTargetConfig | array – Config to pass to each MonologTarget |
| targets | array, yii\log\Target – The log targets. |
| traceLevel | integer – How many application call stacks should be logged together with each message. |
defaultTarget ​
- Type
- craft\log\MonologTarget, null
- Default value
null- Access
- Read-only
- Since
- 5.0.0
defaultTargets ​
- Type
\Illuminate\Support\Collection<\craft\log\MonologTarget>- Default value
null- Access
- Read-only
monologTargetConfig ​
- Type
- array
- Default value
[]- Since
- 4.0.0
Config to pass to each MonologTarget
Public Methods ​
| Method | Description |
|---|---|
| __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. |
| getDefaultTarget() | Gets the active default target, or one specified by key. |
| getDefaultTargets() | |
| getFlushInterval() | |
| getLogger() | Gets the connected logger. |
| 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. |
getDefaultTarget() ​
- Since
- 5.0.0
Gets the active default target, or one specified by key.
Arguments ​
Returns ​
getDefaultTargets() ​
Returns ​
\Illuminate\Support\Collection<\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.
Protected Methods ​
| Method | Description |
|---|---|
| generateTargetFailErrorMessage() | Generate target error message |
Constants ​
| Constant | Description |
|---|---|
TARGET_CONSOLE | |
TARGET_QUEUE | |
TARGET_WEB |