Dispatcher
- Type
- Class
- Namespace
- craft\log
- Inherits
- craft\log\Dispatcher » yii\log\Dispatcher (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 3.6.0
Class Dispatcher
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
| flushInterval (opens new window) | integer (opens new window) – How many messages should be logged before they are sent to targets. |
| logger (opens new window) | yii\log\Logger (opens new window) – The logger. |
| monologTargetConfig | array (opens new window) – Config to pass to each MonologTarget |
| targets (opens new window) | array (opens new window), yii\log\Target (opens new window) – The log targets. |
| traceLevel (opens new window) | integer (opens new window) – How many application call stacks should be logged together with each message. |
# monologTargetConfig
- Type
- array (opens new window)
- Default value
[]- Since
- 4.0.0
Config to pass to each MonologTarget
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns the value of a component property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets the value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| dispatch() (opens new window) | Dispatches the logged messages to targets (opens new window). |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getFlushInterval() (opens new window) | |
| getLogger() (opens new window) | Gets the connected logger. |
| getTargets() | |
| getTraceLevel() (opens new window) | |
| hasEventHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| setFlushInterval() (opens new window) | |
| setLogger() (opens new window) | Sets the connected logger. |
| setTraceLevel() (opens new window) | |
| trigger() (opens new window) | Triggers an event. |
# getTargets()
View source (opens new window)
Returns
# 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 (opens new window)
# Protected Methods
| Method | Description |
|---|---|
| generateTargetFailErrorMessage() (opens new window) | Generate target error message |
# Constants
| Constant | Description |
|---|---|
TARGET_CONSOLE | |
TARGET_QUEUE | |
TARGET_WEB |