Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • Net
  • None
  • PHP
  • system
    • base
    • caching
      • dependencies
    • collections
    • console
    • db
      • ar
      • schema
        • cubrid
        • mssql
        • mysql
        • oci
        • pgsql
        • sqlite
    • i18n
      • gettext
    • logging
    • test
    • utils
    • validators
    • web
      • actions
      • auth
      • filters
      • form
      • helpers
      • renderers
      • services
      • widgets
        • captcha
        • pagers
  • Text
    • Highlighter
  • zii
    • behaviors
    • widgets
      • grid
      • jui

Classes

  • CChainedLogFilter
  • CDbLogRoute
  • CEmailLogRoute
  • CFileLogRoute
  • CLogFilter
  • CLogger
  • CLogRoute
  • CLogRouter
  • CProfileLogRoute
  • CSysLogRoute
  • CWebLogRoute

Interfaces

  • ILogFilter
  • Overview
  • Package
  • Class
  • Tree

Class CLogRouter

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:

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('admin@example.com'),
                ),
            ),
        ),
    ),
)

You can specify multiple routes with different filtering conditions and different targets, even if the routes are of the same type.

CComponent
Extended by CApplicationComponent implements IApplicationComponent
Extended by CLogRouter
Package: system\logging
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/logging/CLogRouter.php
Methods summary
public
# init( )

Initializes this application component. This method is required by the IApplicationComponent interface.

Initializes this application component. This method is required by the IApplicationComponent interface.

Overrides

CApplicationComponent::init()
public array
# getRoutes( )

Returns

array
the currently initialized routes
public
# setRoutes( array $config )

Parameters

$config
array
$config list of route configurations. Each array element represents the configuration for a single route and has the following array structure:
  • class: specifies the class name or alias for the route class.
  • name-value pairs: configure the initial property values of the route.
public
# collectLogs( CEvent $event )

Collects log messages from a logger. This method is an event handler to the CLogger::onFlush() event.

Collects log messages from a logger. This method is an event handler to the CLogger::onFlush() event.

Parameters

$event
CEvent
$event event parameter
public
# processLogs( )

Collects and processes log messages from a logger. This method is an event handler to the CApplication::onEndRequest() event.

Collects and processes log messages from a logger. This method is an event handler to the CApplication::onEndRequest() event.

Since

1.1.0
Methods inherited from CApplicationComponent
getIsInitialized()
Methods inherited from CComponent
__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()
Properties inherited from CApplicationComponent
$behaviors
Magic properties summary
public array $routes
#

The currently initialized routes.

The currently initialized routes.

Magic properties inherited from CApplicationComponent
$isInitialized
API documentation generated by ApiGen 2.8.0