yii\profile\Target

Complexity

Total Complexity

16

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	collect()	0	11	3
	export()	0	1	?
C	filterMessages()	0	27	13

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\profile;

use yii\base\Component;

/**
 * Target is the base class for all profiling target classes.
 *
 * A profile target object will filter the messages stored by [[Profiler]] according
 * to its [[categories]] and [[except]] properties.
 *
 * For more details and usage information on Target, see the [guide article on profiling & targets](guide:runtime-profiling).
 *
 * @author Paul Klimov <klimov-paul@gmail.com>
 * @since 2.1
 */
abstract class Target extends Component
{
    /**
     * @var bool whether to enable this log target. Defaults to true.
     */
    public $enabled = true;
    /**
     * @var array list of message categories that this target is interested in. Defaults to empty, meaning all categories.
     * You can use an asterisk at the end of a category so that the category may be used to
     * match those categories sharing the same common prefix. For example, 'yii\db\*' will match
     * categories starting with 'yii\db\', such as `yii\db\Connection`.
     */
    public $categories = [];
    /**
     * @var array list of message categories that this target is NOT interested in. Defaults to empty, meaning no uninteresting messages.
     * If this property is not empty, then any category listed here will be excluded from [[categories]].
     * You can use an asterisk at the end of a category so that the category can be used to
     * match those categories sharing the same common prefix. For example, 'yii\db\*' will match
     * categories starting with 'yii\db\', such as `yii\db\Connection`.
     * @see categories
     */
    public $except = [];


    /**
     * Processes the given log messages.
     * This method will filter the given messages with [[levels]] and [[categories]].
     * And if requested, it will also export the filtering result to specific medium (e.g. email).
     * @param array $messages profiling messages to be processed. See [[Logger::messages]] for the structure
     * of each message.
     */
    public function collect(array $messages)
    {
        if (!$this->enabled) {
            return;
        }

        $messages = $this->filterMessages($messages);
        if (count($messages) > 0) {
            $this->export($messages);
        }
    }

    /**
     * Exports profiling messages to a specific destination.
     * Child classes must implement this method.
     * @param array $messages profiling messages to be exported.
     */
    abstract public function export(array $messages);

    /**
     * Filters the given messages according to their categories.
     * @param array $messages messages to be filtered.
     * The message structure follows that in [[Logger::messages]].
     * @return array the filtered messages.
     */
    protected function filterMessages($messages)
    {
        foreach ($messages as $i => $message) {
            $matched = empty($this->categories);
            foreach ($this->categories as $category) {
                if ($message['category'] === $category || !empty($category) && substr_compare($category, '*', -1, 1) === 0 && strpos($message['category'], rtrim($category, '*')) === 0) {
                    $matched = true;
                    break;
                }
            }

            if ($matched) {
                foreach ($this->except as $category) {
                    $prefix = rtrim($category, '*');
                    if (($message['category'] === $category || $prefix !== $category) && strpos($message['category'], $prefix) === 0) {
                        $matched = false;
                        break;
                    }
                }
            }

            if (!$matched) {
                unset($messages[$i]);
            }
        }
        return $messages;
    }
}