LogManager::_checkConsistency() - Code Metrics - Inspection of "Add logger" - FloKnapp/faulancer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 40c839...4a6871 )

by Flo

created 2017-11-02 13:21 UTC

LogManager::_checkConsistency() C

↳ Parent: LogManager

Complexity

Conditions	12
Paths	55

Size

Total Lines	78
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	78
c	0
b	0
f	0
rs	5.1746
cc	12
eloc	40
nc	55
nop	0

How to fix Long Method Complexity

<?php

namespace Faulancer\Log;

use Faulancer\Exception\LogFileInvalidException;
use Faulancer\Exception\LogTypeNotSupportedException;
use Faulancer\Service\Config;
use Faulancer\Log\Writer\DefaultWriter;
use Faulancer\ServiceLocator\ServiceLocator;

/**
 * Class Logger | Logger.php
 *
 * @package Faulancer\Log
 * @author  Florian Knapp <[email protected]>
 */
class LogManager
{

    const LEVEL_INFO    = 'info';
    const LEVEL_DEBUG   = 'debug';
    const LEVEL_WARN    = 'warn';
    const LEVEL_ERROR   = 'error';

    /** @var static */
    private static $instance;

    /** @var ServiceLocator */
    private static $serviceLocator;

    /** @var array */
    protected static $levels = [
        self::LEVEL_INFO,
        self::LEVEL_DEBUG,
        self::LEVEL_WARN,
        self::LEVEL_ERROR
    ];

    /** @var bool */
    protected static $fileSystemChecked = false;

    /** @var array */
    protected static $logFiles = [];

    /**
     * @return static
     */
    public static function instance()
    {
        if (!self::$instance) {
            self::$instance       = new static();
            self::$serviceLocator = ServiceLocator::instance();
        }

        return self::$instance;
    }

    /**
     * @param string $message
     * @param string $level
     * @param string $writer
     *
     * @return bool
     */
    public static function log(string $message = '', string $level = self::LEVEL_INFO, string $writer = '')
    {
        if (!self::$fileSystemChecked) {
            self::_checkConsistency();
        }

        /** @var Config $config */
        $config = self::$serviceLocator->get(Config::class);

        if (!empty($writer) && class_exists($writer)) {
            $writer = new $writer($config, debug_backtrace());
        } else {
            $writer = new DefaultWriter($config, debug_backtrace());
        }

        return $writer->write(self::$logFiles[$level], $message, $level);
    }

    /**
     * Check for filesystem consistency
     *
     * @return bool
     * @throws LogTypeNotSupportedException
     */
    private static function _checkConsistency()
    {
        /** @var Config $config */
        $config  = self::$serviceLocator->get(Config::class);
        $appRoot = realpath($config->get('projectRoot'));
        $logDirs = $config->get('log');

        if ($logDirs === null) {
            return true;
        }

        $hasInfoTypeInConf = false;

        if (in_array('info', array_keys($logDirs))) {
            $hasInfoTypeInConf = true;
        }

        foreach ($logDirs as $level => $path) {

            if (!in_array($level, self::$levels, true)) {

                throw new LogTypeNotSupportedException(
                    'Log type "' . $level . '" is currently not supported.'
                    . 'Please use one of the following log types:' . PHP_EOL
                    . implode(", ", self::$levels)
                );

            }

            $lastDirectorySeparator = strrpos($path, '/');

            if ($lastDirectorySeparator === false) {
                throw new LogFileInvalidException(
                    'You have to define the logfile path as an absolute path beginning from your project root'
                    . ' (i.e. if "/var/www/vhosts/app" is your project root set the logfile path to "/logs/{$level}.log")'
                );
            }

            $logDir = substr($path, 0, $lastDirectorySeparator);

            if (!is_dir($appRoot . $logDir)) {
                mkdir($appRoot . $logDir, 0774, true);
            }

            $file     = substr($path, $lastDirectorySeparator, strlen($path));
            $fullPath = $appRoot . $logDir . $file;
            $fileType = strrpos($fullPath, '.');

            if ($fileType !== false) {
                $fileType = substr($fullPath, $fileType, strlen($fullPath));
            }

            if (!file_exists($fullPath)) {
                file_put_contents($fullPath, '');
                chmod($fullPath, 0744);
            }

            if (!$hasInfoTypeInConf && !file_exists($appRoot . $logDir . '/info' . $fileType)) {

                file_put_contents($appRoot . $logDir . '/info' . $fileType, '');
                chmod($appRoot . $logDir . '/info' . $fileType, 0744);

                self::$logFiles[self::LEVEL_INFO] = $appRoot . $logDir . '/info' . $fileType;

            } else if (!$hasInfoTypeInConf) {

                self::$logFiles[self::LEVEL_INFO] = $appRoot . $logDir . '/info' . $fileType;

            }

            self::$logFiles[$level] = $fullPath;

        }

        self::$fileSystemChecked = true;

        return true;
    }

}

1			<?php
2
3			namespace Faulancer\Log;
4
5			use Faulancer\Exception\LogFileInvalidException;
6			use Faulancer\Exception\LogTypeNotSupportedException;
7			use Faulancer\Service\Config;
8			use Faulancer\Log\Writer\DefaultWriter;
9			use Faulancer\ServiceLocator\ServiceLocator;
10
11			/**
12			* Class Logger \| Logger.php
13			*
14			* @package Faulancer\Log
15			* @author Florian Knapp <[email protected]>
16			*/
17			class LogManager
18			{
19
20			const LEVEL_INFO = 'info';
21			const LEVEL_DEBUG = 'debug';
22			const LEVEL_WARN = 'warn';
23			const LEVEL_ERROR = 'error';
24
25			/** @var static */
26			private static $instance;
27
28			/** @var ServiceLocator */
29			private static $serviceLocator;
30
31			/** @var array */
32			protected static $levels = [
33			self::LEVEL_INFO,
34			self::LEVEL_DEBUG,
35			self::LEVEL_WARN,
36			self::LEVEL_ERROR
37			];
38
39			/** @var bool */
40			protected static $fileSystemChecked = false;
41
42			/** @var array */
43			protected static $logFiles = [];
44
45			/**
46			* @return static
47			*/
48			public static function instance()
49			{
50			if (!self::$instance) {
51			self::$instance = new static();
52			self::$serviceLocator = ServiceLocator::instance();
53			}
54
55			return self::$instance;
56			}
57
58			/**
59			* @param string $message
60			* @param string $level
61			* @param string $writer
62			*
63			* @return bool
64			*/
65			public static function log(string $message = '', string $level = self::LEVEL_INFO, string $writer = '')
66			{
67			if (!self::$fileSystemChecked) {
68			self::_checkConsistency();
69			}
70
71			/** @var Config $config */
72			$config = self::$serviceLocator->get(Config::class);
73
74			if (!empty($writer) && class_exists($writer)) {
75			$writer = new $writer($config, debug_backtrace());
76			} else {
77			$writer = new DefaultWriter($config, debug_backtrace());
78			}
79
80			return $writer->write(self::$logFiles[$level], $message, $level);
81			}
82
83			/**
84			* Check for filesystem consistency
85			*
86			* @return bool
87			* @throws LogTypeNotSupportedException
88			*/
89			private static function _checkConsistency()
90			{
91			/** @var Config $config */
92			$config = self::$serviceLocator->get(Config::class);
93			$appRoot = realpath($config->get('projectRoot'));
94			$logDirs = $config->get('log');
95
96			if ($logDirs === null) {
97			return true;
98			}
99
100			$hasInfoTypeInConf = false;
101
102			if (in_array('info', array_keys($logDirs))) {
103			$hasInfoTypeInConf = true;
104			}
105
106			foreach ($logDirs as $level => $path) {
107
108			if (!in_array($level, self::$levels, true)) {
109
110			throw new LogTypeNotSupportedException(
111			'Log type "' . $level . '" is currently not supported.'
112			. 'Please use one of the following log types:' . PHP_EOL
113			. implode(", ", self::$levels)
114			);
115
116			}
117
118			$lastDirectorySeparator = strrpos($path, '/');
119
120			if ($lastDirectorySeparator === false) {
121			throw new LogFileInvalidException(
122			'You have to define the logfile path as an absolute path beginning from your project root'
123			. ' (i.e. if "/var/www/vhosts/app" is your project root set the logfile path to "/logs/{$level}.log")'
124			);
125			}
126
127			$logDir = substr($path, 0, $lastDirectorySeparator);
128
129			if (!is_dir($appRoot . $logDir)) {
130			mkdir($appRoot . $logDir, 0774, true);
131			}
132
133			$file = substr($path, $lastDirectorySeparator, strlen($path));
134			$fullPath = $appRoot . $logDir . $file;
135			$fileType = strrpos($fullPath, '.');
136
137			if ($fileType !== false) {
138			$fileType = substr($fullPath, $fileType, strlen($fullPath));
139			}
140
141			if (!file_exists($fullPath)) {
142			file_put_contents($fullPath, '');
143			chmod($fullPath, 0744);
144			}
145
146			if (!$hasInfoTypeInConf && !file_exists($appRoot . $logDir . '/info' . $fileType)) {
147
148			file_put_contents($appRoot . $logDir . '/info' . $fileType, '');
149			chmod($appRoot . $logDir . '/info' . $fileType, 0744);
150
151			self::$logFiles[self::LEVEL_INFO] = $appRoot . $logDir . '/info' . $fileType;
152
153			} else if (!$hasInfoTypeInConf) {
154
155			self::$logFiles[self::LEVEL_INFO] = $appRoot . $logDir . '/info' . $fileType;
156
157			}
158
159			self::$logFiles[$level] = $fullPath;
160
161			}
162
163			self::$fileSystemChecked = true;
164
165			return true;
166			}
167
168			}

FloKnapp / faulancer

Push — master ( 40c839...4a6871 )

LogManager::_checkConsistency() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like