Micro\Plugin\Http\HttpLoggerPluginConfiguration

Complexity

Total Complexity

6

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getErrorLoggerName()	0	3	1
A	getErrorLogFormat()	0	3	1
A	getWeight()	0	3	1
A	getRequestHeadersSecuredList()	0	6	1
A	getAccessLoggerName()	0	3	1
A	getAccessLogFormat()	0	3	1

<?php

declare(strict_types=1);

/*
 *  This file is part of the Micro framework package.
 *
 *  (c) Stanislau Komar <kost@micro-php.net>
 *
 *  For the full copyright and license information, please view the LICENSE
 *  file that was distributed with this source code.
 */

namespace Micro\Plugin\Http;

use Micro\Framework\Kernel\Configuration\PluginConfiguration;
use Micro\Plugin\Logger\LoggerPluginConfiguration;

/**
 * @author Stanislau Komar <kost@micro-php.net>
 */
class HttpLoggerPluginConfiguration extends PluginConfiguration implements HttpLoggerPluginConfigurationInterface
{
    public const CFG_LOGGER_ACCESS = 'MICRO_HTTP_LOGGER_ACCESS';
    public const CFG_LOGGER_ERROR = 'MICRO_HTTP_LOGGER_ERROR';
    public const CFG_LOGGER_HEADERS_SECURED = 'MICRO_HTTP_LOGGER_HEADERS_SECURED';
    public const CFG_LOGGER_HEADERS_SECURED_DEFAULT = 'Authorization';
    public const CFG_DECORATION_WEIGHT = 'MICRO_HTTP_LOGGER_DECORATION_WEIGHT';
    public const CFG_HTTP_LOGGER_ACCESS_FORMAT = 'MICRO_HTTP_LOGGER_ACCESS_FORMAT';
    public const CFG_HTTP_LOGGER_ERROR_FORMAT = 'MICRO_HTTP_LOGGER_ERROR_FORMAT';
    public const LOGGER_ERROR_FORMAT_DEFAULT = '{{remote_addr}} - {{remote_user}} [{{status}}] "{{request}}"';
    public const LOGGER_ACCESS_FORMAT_DEFAULT = '{{remote_addr}} - {{remote_user}} [{{status}}] "{{request}}" {{request_header.http-referer}} {{request_header.user-agent}}';
    public const DECORATION_DEFAULT = 1000;

    public function getAccessLoggerName(): string
    {
        return (string) $this->configuration->get(self::CFG_LOGGER_ACCESS, LoggerPluginConfiguration::LOGGER_NAME_DEFAULT);
    }

    public function getErrorLoggerName(): string
    {
        return (string) $this->configuration->get(self::CFG_LOGGER_ERROR, LoggerPluginConfiguration::LOGGER_NAME_DEFAULT);
    }

    public function getWeight(): int
    {
        return (int) $this->configuration->get(self::CFG_DECORATION_WEIGHT, self::DECORATION_DEFAULT, false);
    }

    public function getErrorLogFormat(): string
    {
        return $this->configuration->get(self::CFG_HTTP_LOGGER_ERROR_FORMAT, self::LOGGER_ERROR_FORMAT_DEFAULT, false);
    }

    public function getAccessLogFormat(): string
    {
        return $this->configuration->get(self::CFG_HTTP_LOGGER_ACCESS_FORMAT, self::LOGGER_ACCESS_FORMAT_DEFAULT, false);
    }

    public function getRequestHeadersSecuredList(): array
    {
        return $this->explodeStringToArray(
            $this->configuration->get(
                self::CFG_LOGGER_HEADERS_SECURED,
                self::CFG_LOGGER_HEADERS_SECURED_DEFAULT
            )
        );
    }
}