Router.php 3.27 KB
Newer Older
w  
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
<?php
/**
 * Router class file.
 *
 * @link http://www.yiiframework.com/
 * @copyright Copyright &copy; 2008-2012 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\logging;

/**
 * Router manages [[Target|log targets]] that record log messages in different media.
 *
 * For example, a [[FileTarget|file log target]] records log messages
 * in files; an [[EmailTarget|email log target]] sends log messages
 * to specific email addresses. Each log target may specify filters on
 * message levels and categories to record specific messages only.
 *
 * Router and the targets it manages may be configured in application configuration,
 * like the following:
 *
 * ~~~
 * array(
 *     // preload log component when application starts
 *     'preload' => array('log'),
 *     'components' => array(
 *         'log' => array(
 *             'class' => '\yii\logging\Router',
 *             'targets' => array(
 *                 'file' => array(
 *                     'class' => '\yii\logging\FileTarget',
 *                     'levels' => 'trace, info',
 *                     'categories' => 'yii\*',
 *                 ),
 *                 'email' => array(
 *                     'class' => '\yii\logging\EmailTarget',
 *                     'levels' => 'error, warning',
 *                     'emails' => array('admin@example.com'),
 *                 ),
 *             ),
 *         ),
 *     ),
 * )
 * ~~~
 *
 * Each log target can have a name and can be referenced via the [[targets]] property
 * as follows:
 *
 * ~~~
Qiang Xue committed
51
 * \Yii::$application->log->targets['file']->enabled = false;
w  
Qiang Xue committed
52 53 54 55 56 57 58
 * ~~~
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class Router extends \yii\base\ApplicationComponent
{
Qiang Xue committed
59
	/**
Qiang Xue committed
60 61
	 * @var Target[] list of log target objects or configurations. If the latter, target objects will
	 * be created in [[init()]] by calling [[\Yii::createObject()]] with the corresponding object configuration.
Qiang Xue committed
62
	 */
Qiang Xue committed
63
	public $targets = array();
w  
Qiang Xue committed
64 65 66 67

	/**
	 * Initializes this application component.
	 * This method is invoked when the Router component is created by the application.
Qiang Xue committed
68 69
	 * The method attaches the [[processLogs]] method to both the [[Logger::flush]] event
	 * and the [[\yii\base\Application::afterRequest]] event.
w  
Qiang Xue committed
70 71 72 73 74
	 */
	public function init()
	{
		parent::init();

Qiang Xue committed
75 76 77
		foreach ($this->targets as $name => $target) {
			if (!$target instanceof Target) {
				$this->targets[$name] = \Yii::createObject($target);
w  
Qiang Xue committed
78 79
			}
		}
Qiang Xue committed
80 81 82 83 84

		\Yii::getLogger()->on('flush', array($this, 'processMessages'));
		if (\Yii::$application !== null) {
			\Yii::$application->on('afterRequest', array($this, 'processMessages'));
		}
w  
Qiang Xue committed
85 86 87 88 89 90 91 92 93 94 95 96
	}

	/**
	 * Retrieves and processes log messages from the system logger.
	 * This method mainly serves the event handler to [[Logger::onFlush]]
	 * and [[\yii\base\Application::onEndRequest]] events.
	 * It will retrieve the available log messages from the [[\Yii::getLogger|system logger]]
	 * and invoke the registered [[targets|log targets]] to do the actual processing.
	 * @param \yii\base\Event $event event parameter
	 */
	public function processMessages($event)
	{
w  
Qiang Xue committed
97
		$messages = \Yii::getLogger()->messages;
Qiang Xue committed
98 99
		$final = $event->name !== 'flush';
		foreach ($this->targets as $target) {
w  
Qiang Xue committed
100
			if ($target->enabled) {
Qiang Xue committed
101
				$target->processMessages($messages, $final);
w  
Qiang Xue committed
102 103 104 105
			}
		}
	}
}