Yiisoft\Profiler\Target\AbstractTarget

Complexity

Total Complexity

16

Size/Duplication

Total Lines	151
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	isEnabled()	0	3	1
A	exclude()	0	5	1
A	isCategoryMatched()	0	20	6
A	include()	0	5	1
A	filterMessages()	0	8	3
A	collect()	0	10	3
A	enable()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Profiler\Target;

use Yiisoft\Profiler\Message;
use Yiisoft\Strings\WildcardPattern;

use function count;

/**
 * Target is the base class for all profiling target classes.
 *
 * A profile target object will filter the messages stored by {@see Profiler} according
 * to its {@see AbstractTarget::include()} and {@see AbstractTarget::exclude()}.
 */
abstract class AbstractTarget implements TargetInterface
{
    /**
     * @var string[] 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, 'Yiisoft\Db\**' will match
     * categories starting with 'Yiisoft\Db\', such as `Yiisoft\Db\Connection`.
     *
     * @see WildcardPattern
     */
    private array $include = [];

    /**
     * @var string[] 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 {@see include()}.
     * 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, 'Yiisoft\Db\**' will match
     * categories starting with 'Yiisoft\Db\', such as `Yiisoft\Db\Connection`.
     *
     * @see WildcardPattern
     */
    private array $exclude = [];

    /**
     * @var bool Whether to enable this log target. Defaults to true.
     */
    private bool $enabled = true;

    /**
     * {@inheritdoc}
     *
     * This method will filter the given messages with {@see include()} and {@see exclude()}.
     * And if requested, it will also export the filtering result to specific medium (e.g. email).
     */
    public function collect(array $messages): void
    {
        if (!$this->enabled) {
            return;
        }

        $messages = $this->filterMessages($messages);

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

    /**
     * @param string[] $include 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, 'Yiisoft\Db\**' will match
     * categories starting with 'Yiisoft\Db\', such as `Yiisoft\Db\Connection`.
     *
     * @see WildcardPattern
     *
     * @return $this
     */
    public function include(array $include): self
    {
        $new = clone $this;
        $new->include = $include;
        return $new;
    }

    /**
     * @param string[] $exclude 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 {@see include()}.
     * 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, 'Yiisoft\Db\**' will match
     * categories starting with 'Yiisoft\Db\', such as `Yiisoft\Db\Connection`.
     *
     * @return $this
     */
    public function exclude(array $exclude): self
    {
        $new = clone $this;
        $new->exclude = $exclude;
        return $new;
    }

    /**
     * Enable or disable target.
     */
    public function enable(bool $value = true): void
    {
        $this->enabled = $value;
    }

    /**
     * Returns target is enabled.
     */
    public function isEnabled(): bool
    {
        return $this->enabled;
    }

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

    /**
     * Filters the given messages according to their categories.
     *
     * @param Message[] $messages Messages to be filtered.
     * The message structure follows that in {@see TargetInterface::collect()}.
     *
     * @return Message[] The filtered messages.
     */
    protected function filterMessages(array $messages): array
    {
        foreach ($messages as $i => $message) {
            if (!$this->isCategoryMatched($message->level())) {
                unset($messages[$i]);
            }
        }
        return $messages;
    }

    private function isCategoryMatched(string $category): bool
    {
        $matched = empty($this->include);

        foreach ($this->include as $pattern) {
            if ((new WildcardPattern($pattern))->match($category)) {
                $matched = true;
                break;
            }
        }

        if ($matched) {
            foreach ($this->exclude as $pattern) {
                if ((new WildcardPattern($pattern))->match($category)) {
                    $matched = false;
                    break;
                }
            }
        }
        return $matched;
    }
}