Wordlift_Log_Service::log() - Code Metrics - Inspection of "bump to 3.15.4" - insideout10/wordlift-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 20c3c4...b6edec )

by David

created 2017-11-13 14:24 UTC

Wordlift_Log_Service::log() C

↳ Parent: Wordlift_Log_Service

Complexity

Conditions	10
Paths	4

Size

Total Lines	22
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	9
nc	4
nop	2
dl	0
loc	22
rs	6.1368
c	0
b	0
f	0

How to fix Complexity

<?php

/**
 * The Log service.
 *
 * @since 1.0.0
 */
class Wordlift_Log_Service {

	const MESSAGE_TEMPLATE = '%-6s [%-40.40s] %s';

	const ERROR = 4;
	const WARN = 3;
	const INFO = 2;
	const DEBUG = 1;
	const TRACE = 0;

	/**
	 * The class related to the logs.
	 *
	 * @since  1.0.0
	 * @access private
	 * @var string $class_name The class related to the logs.
	 */
	private $class_name;

	/**
	 * The log levels for printing in log lines.
	 *
	 * @var array $levels An array of log levels.
	 */
	private static $levels = array(
		self::TRACE => 'TRACE',
		self::DEBUG => 'DEBUG',
		self::INFO  => 'INFO',
		self::WARN  => 'WARN',
		self::ERROR => 'ERROR',
	);

	/**
	 * A singleton instance for legacy logging.
	 *
	 * @since  3.10.0
	 * @access private
	 * @var \Wordlift_Log_Service $instance A singleton instance for legacy logging.
	 */
	private static $instance = null;

	/**
	 * Create an instance of the Log service.
	 * @since 1.0.0
	 *
	 * @param string $class_name The class related to the logs.
	 */
	public function __construct( $class_name ) {

		$this->class_name = $class_name;

	}

	/**
	 * Get the ROOT logger.
	 *
	 * @since 3.10.0
	 *
	 * @return \Wordlift_Log_Service A singleton instance for legacy logging.
	 */
	public static function get_instance() {

		return self::$instance ?: self::$instance = new Wordlift_Log_Service( 'ROOT' );
	}


	public static function get_logger( $class_name ) {

		return new Wordlift_Log_Service( $class_name );

	}

	/**
	 * Log a message.
	 *
	 * @since 1.0.0
	 *
	 * @param string $level   The log level.
	 * @param string $message The message to log.
	 */
	public function log( $level, $message ) {

		// Bail out if WordLift log level isn't defined, and WP debug is disabled.
		if ( ! defined( 'WL_LOG_LEVEL' ) && $level < self::INFO
			 && ( ! defined( 'WP_DEBUG' ) || false === WP_DEBUG ) ) {
			return;
		}

		// Bail out if the log message is below the minimum log level.
		if ( defined( 'WL_LOG_LEVEL' ) && $level < intval( WL_LOG_LEVEL ) ) {
			return;
		}

		// Bail out if there's a filter and we don't match it.
		if ( defined( 'WL_LOG_FILTER' ) && 1 !== preg_match( "/(^|,)$this->class_name($|,)/", WL_LOG_FILTER ) ) {
			return;
		}

		// Finally log the message.
		error_log( sprintf( self::MESSAGE_TEMPLATE, self::$levels[ $level ], $this->class_name, is_array( $message ) ? implode( ', ', $message ) : $message ) );

	}

	public function error( $message ) {

		$this->log( self::ERROR, $message );

	}

	public function warn( $message ) {

		$this->log( self::WARN, $message );

	}

	public function info( $message ) {

		$this->log( self::INFO, $message );

	}

	public function debug( $message ) {

		$this->log( self::DEBUG, $message );

	}

	public function trace( $message ) {

		$this->log( self::TRACE, $message );

	}

}


1			<?php
2
3			/**
4			* The Log service.
5			*
6			* @since 1.0.0
7			*/
8			class Wordlift_Log_Service {
9
10			const MESSAGE_TEMPLATE = '%-6s [%-40.40s] %s';
11
12			const ERROR = 4;
13			const WARN = 3;
14			const INFO = 2;
15			const DEBUG = 1;
16			const TRACE = 0;
17
18			/**
19			* The class related to the logs.
20			*
21			* @since 1.0.0
22			* @access private
23			* @var string $class_name The class related to the logs.
24			*/
25			private $class_name;
26
27			/**
28			* The log levels for printing in log lines.
29			*
30			* @var array $levels An array of log levels.
31			*/
32			private static $levels = array(
33			self::TRACE => 'TRACE',
34			self::DEBUG => 'DEBUG',
35			self::INFO => 'INFO',
36			self::WARN => 'WARN',
37			self::ERROR => 'ERROR',
38			);
39
40			/**
41			* A singleton instance for legacy logging.
42			*
43			* @since 3.10.0
44			* @access private
45			* @var \Wordlift_Log_Service $instance A singleton instance for legacy logging.
46			*/
47			private static $instance = null;
48
49			/**
50			* Create an instance of the Log service.
51			* @since 1.0.0
52			*
53			* @param string $class_name The class related to the logs.
54			*/
55			public function __construct( $class_name ) {
56
57			$this->class_name = $class_name;
58
59			}
60
61			/**
62			* Get the ROOT logger.
63			*
64			* @since 3.10.0
65			*
66			* @return \Wordlift_Log_Service A singleton instance for legacy logging.
67			*/
68			public static function get_instance() {
69
70			return self::$instance ?: self::$instance = new Wordlift_Log_Service( 'ROOT' );
71			}
72
73
74			public static function get_logger( $class_name ) {
75
76			return new Wordlift_Log_Service( $class_name );
77
78			}
79
80			/**
81			* Log a message.
82			*
83			* @since 1.0.0
84			*
85			* @param string $level The log level.
86			* @param string $message The message to log.
87			*/
88			public function log( $level, $message ) {
89
90			// Bail out if WordLift log level isn't defined, and WP debug is disabled.
91			if ( ! defined( 'WL_LOG_LEVEL' ) && $level < self::INFO
92			&& ( ! defined( 'WP_DEBUG' ) \|\| false === WP_DEBUG ) ) {
93			return;
94			}
95
96			// Bail out if the log message is below the minimum log level.
97			if ( defined( 'WL_LOG_LEVEL' ) && $level < intval( WL_LOG_LEVEL ) ) {
98			return;
99			}
100
101			// Bail out if there's a filter and we don't match it.
102			if ( defined( 'WL_LOG_FILTER' ) && 1 !== preg_match( "/(^\|,)$this->class_name($\|,)/", WL_LOG_FILTER ) ) {
103			return;
104			}
105
106			// Finally log the message.
107			error_log( sprintf( self::MESSAGE_TEMPLATE, self::$levels[ $level ], $this->class_name, is_array( $message ) ? implode( ', ', $message ) : $message ) );
108
109			}
110
111			public function error( $message ) {
112
113			$this->log( self::ERROR, $message );
114
115			}
116
117			public function warn( $message ) {
118
119			$this->log( self::WARN, $message );
120
121			}
122
123			public function info( $message ) {
124
125			$this->log( self::INFO, $message );
126
127			}
128
129			public function debug( $message ) {
130
131			$this->log( self::DEBUG, $message );
132
133			}
134
135			public function trace( $message ) {
136
137			$this->log( self::TRACE, $message );
138
139			}
140
141			}
142

insideout10 / wordlift-plugin

Push — master ( 20c3c4...b6edec )

Wordlift_Log_Service::log() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like