CLogRouter
| Package | system.logging |
|---|---|
| Inheritance | class CLogRouter » CApplicationComponent » CComponent |
| Implements | IApplicationComponent |
| Since | 1.0 |
| Source Code | framework/logging/CLogRouter.php |
CLogRouter manages log routes that record log messages in different media.
For example, a file log route CFileLogRoute records log messages in log files. An email log route CEmailLogRoute sends log messages to specific email addresses. See CLogRoute for more details about different log routes.
Log routes may be configured in application configuration like following:
You can specify multiple routes with different filtering conditions and different targets, even if the routes are of the same type.
For example, a file log route CFileLogRoute records log messages in log files. An email log route CEmailLogRoute sends log messages to specific email addresses. See CLogRoute for more details about different log routes.
Log routes may be configured in application configuration like following:
array(
'preload'=>array('log'), // preload log component when app starts
'components'=>array(
'log'=>array(
'class'=>'CLogRouter',
'routes'=>array(
array(
'class'=>'CFileLogRoute',
'levels'=>'trace, info',
'categories'=>'system.*',
),
array(
'class'=>'CEmailLogRoute',
'levels'=>'error, warning',
'emails'=>array('[email protected]'),
),
),
),
),
)
You can specify multiple routes with different filtering conditions and different targets, even if the routes are of the same type.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| behaviors | array | the behaviors that should be attached to this component. | CApplicationComponent |
| isInitialized | boolean | Checks if this application component has been initialized. | CApplicationComponent |
| routes | array | the currently initialized routes | CLogRouter |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| collectLogs() | Collects log messages from a logger. | CLogRouter |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getIsInitialized() | Checks if this application component has been initialized. | CApplicationComponent |
| getRoutes() | Returns the currently initialized routes | CLogRouter |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| init() | Initializes this application component. | CLogRouter |
| processLogs() | Collects and processes log messages from a logger. | CLogRouter |
| raiseEvent() | Raises an event. | CComponent |
| setRoutes() | Sets list of route configurations. Each array element represents the configuration for a single route and has the following array structure:
| CLogRouter |
Property Details
routes property
public array getRoutes()
public void setRoutes(array $config)
the currently initialized routes
Method Details
collectLogs() method
public void collectLogs(CEvent $event) | ||
| $event | CEvent | event parameter |
Source Code: framework/logging/CLogRouter.php#100 (show)
public function collectLogs($event)
{
$logger=Yii::getLogger();
$dumpLogs=isset($event->params['dumpLogs']) && $event->params['dumpLogs'];
foreach($this->_routes as $route)
{
/* @var $route CLogRoute */
if($route->enabled)
$route->collectLogs($logger,$dumpLogs);
}
}
Collects log messages from a logger. This method is an event handler to the CLogger::onFlush event.
getRoutes() method
public array getRoutes() | ||
| {return} | array | the currently initialized routes |
Source Code: framework/logging/CLogRouter.php#76 (show)
public function getRoutes()
{
return new CMap($this->_routes);
}
init() method
public void init() |
Source Code: framework/logging/CLogRouter.php#60 (show)
public function init()
{
parent::init();
foreach($this->_routes as $name=>$route)
{
$route=Yii::createComponent($route);
$route->init();
$this->_routes[$name]=$route;
}
Yii::getLogger()->attachEventHandler('onFlush',array($this,'collectLogs'));
Yii::app()->attachEventHandler('onEndRequest',array($this,'processLogs'));
}
Initializes this application component. This method is required by the IApplicationComponent interface.
processLogs() method (available since v1.1.0)
public void processLogs() |
Source Code: framework/logging/CLogRouter.php#117 (show)
public function processLogs()
{
$logger=Yii::getLogger();
$logger->flush(true);
}
Collects and processes log messages from a logger. This method is an event handler to the CApplication::onEndRequest event.
setRoutes() method
public void setRoutes(array $config) | ||
| $config | array | list of route configurations. Each array element represents the configuration for a single route and has the following array structure:
|
Source Code: framework/logging/CLogRouter.php#89 (show)
public function setRoutes($config)
{
foreach($config as $name=>$route)
$this->_routes[$name]=$route;
}
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CLogRouter