Logger::setDisplay() - Code Metrics - gctools-outilsgc/gcconnex - Measure and Improve Code Quality continuously with Scrutinizer

Logger::setDisplay() A
last analyzed 2021-05-27 17:40 UTC

↳ Parent: Logger

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	3
ccs	0
cts	3
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
namespace Elgg;

/**
 * WARNING: API IN FLUX. DO NOT USE DIRECTLY.
 *
 * Use the elgg_* versions instead.
 *
 * @access private
 *
 * @package    Elgg.Core
 * @subpackage Logging
 * @since      1.9.0
 */
class Logger {

	const OFF = 0;
	const ERROR = 400;
	const WARNING = 300;
	const NOTICE = 250;
	const INFO = 200;

	protected static $levels = array(
		0 => 'OFF',
		200 => 'INFO',
		250 => 'NOTICE',
		300 => 'WARNING',
		400 => 'ERROR',
	);

	/** @var int $level The logging level */
	protected $level = self::ERROR;

	/** @var bool $display Display to user? */
	protected $display = false;

	/** @var \Elgg\PluginHooksService $hooks */
	protected $hooks;

	/** @var \stdClass Global Elgg configuration */
	private $CONFIG;

	/**
	 * Constructor
	 *
	 * @param \Elgg\PluginHooksService $hooks Hooks service
	 */
	public function __construct(\Elgg\PluginHooksService $hooks) {
		global $CONFIG;
		
		$this->CONFIG = $CONFIG;
		$this->hooks = $hooks;
	}

	/**
	 * Set the logging level
	 *
	 * @param int $level The logging level
	 * @return void
	 */
	public function setLevel($level) {
		// @todo Elgg has used string constants for logging levels
		if (is_string($level)) {
			$levelStringsToInts = array_flip(self::$levels);
			$level = $levelStringsToInts[$level];
		}
		$this->level = $level;
	}

	/**
	 * Get the current logging level
	 * 
	 * @return int
	 */
	public function getLevel() {
		return $this->level;
	}

	/**
	 * Set whether the logging should be displayed to the user
	 *
	 * Whether data is actually displayed to the user depends on this setting
	 * and other factors such as whether we are generating a JavaScript or CSS
	 * file.
	 *
	 * @param bool $display Whether to display logging
	 * @return void
	 */
	public function setDisplay($display) {
		$this->display = $display;
	}

	/**
	 * Add a message to the log
	 *
	 * @param string $message The message to log
	 * @param int    $level   The logging level
	 * @return bool Whether the messages was logged
	 */
	public function log($message, $level = self::NOTICE) {
		if ($this->level == self::OFF || $level < $this->level) {
			return false;
		}

		if (!array_key_exists($level, self::$levels)) {
			return false;
		}

		$levelString = self::$levels[$level];

		// notices and below never displayed to user
		$display = $this->display && $level > self::NOTICE;

		$this->process("$levelString: $message", $display, $level);

		return true;
	}

	/**
	 * Log message at the ERROR level
	 *
	 * @param string $message The message to log
	 * @return bool
	 */
	public function error($message) {
		return $this->log($message, self::ERROR);
	}

	/**
	 * Log message at the WARNING level
	 *
	 * @param string $message The message to log
	 * @return bool
	 */
	public function warn($message) {
		return $this->log($message, self::WARNING);
	}

	/**
	 * Log message at the NOTICE level
	 *
	 * @param string $message The message to log
	 * @return bool
	 */
	public function notice($message) {
		return $this->log($message, self::NOTICE);
	}

	/**
	 * Log message at the INFO level
	 *
	 * @param string $message The message to log
	 * @return bool
	 */
	public function info($message) {
		return $this->log($message, self::INFO);
	}

	/**
	 * Dump data to log or screen
	 *
	 * @param mixed $data    The data to log
	 * @param bool  $display Whether to include this in the HTML page
	 * @return void
	 */
	public function dump($data, $display = true) {
		$this->process($data, $display, self::ERROR);
	}

	/**
	 * Process logging data
	 *
	 * @param mixed $data    The data to process
	 * @param bool  $display Whether to display the data to the user. Otherwise log it.
	 * @param int   $level   The logging level for this data
	 * @return void
	 */
	protected function process($data, $display, $level) {
		

		// plugin can return false to stop the default logging method
		$params = array(
			'level' => $level,
			'msg' => $data,
			'display' => $display,
			'to_screen' => $display,
		);

		if (!$this->hooks->trigger('debug', 'log', $params, true)) {
			return;
		}

		// Do not want to write to screen before page creation has started.
		// This is not fool-proof but probably fixes 95% of the cases when logging
		// results in data sent to the browser before the page is begun.
		if (!isset($this->CONFIG->pagesetupdone)) {
			$display = false;
		}

		// Do not want to write to JS or CSS pages
		if (elgg_in_context('js') || elgg_in_context('css')) {
			$display = false;
		}

		// don't display in simplecache requests
		$path = substr(current_page_url(), strlen(elgg_get_site_url()));
		if (preg_match('~^(cache|action)/~', $path)) {
			$display = false;
		}

		if ($display == true) {

			echo '<pre class="elgg-logger-data">';
			echo htmlspecialchars(print_r($data, true), ENT_QUOTES, 'UTF-8');
			echo '</pre>';
		} else {
			error_log(print_r($data, true));
		}
	}
}



1		<?php
2		namespace Elgg;
3
4		/**
5		* WARNING: API IN FLUX. DO NOT USE DIRECTLY.
6		*
7		* Use the elgg_* versions instead.
8		*
9		* @access private
10		*
11		* @package Elgg.Core
12		* @subpackage Logging
13		* @since 1.9.0
14		*/
15		class Logger {
16
17		const OFF = 0;
18		const ERROR = 400;
19		const WARNING = 300;
20		const NOTICE = 250;
21		const INFO = 200;
22
23		protected static $levels = array(
24		0 => 'OFF',
25		200 => 'INFO',
26		250 => 'NOTICE',
27		300 => 'WARNING',
28		400 => 'ERROR',
29		);
30
31		/** @var int $level The logging level */
32		protected $level = self::ERROR;
33
34		/** @var bool $display Display to user? */
35		protected $display = false;
36
37		/** @var \Elgg\PluginHooksService $hooks */
38		protected $hooks;
39
40		/** @var \stdClass Global Elgg configuration */
41		private $CONFIG;
42
43		/**
44		* Constructor
45		*
46		* @param \Elgg\PluginHooksService $hooks Hooks service
47		*/
48	10	public function __construct(\Elgg\PluginHooksService $hooks) {
49	10	global $CONFIG;
50
51	10	$this->CONFIG = $CONFIG;
52	10	$this->hooks = $hooks;
53	10	}
54
55		/**
56		* Set the logging level
57		*
58		* @param int $level The logging level
59		* @return void
60		*/
61	2	public function setLevel($level) {
62		// @todo Elgg has used string constants for logging levels
63	2	if (is_string($level)) {
64		$levelStringsToInts = array_flip(self::$levels);
65		$level = $levelStringsToInts[$level];
66		}
67	2	$this->level = $level;
68	2	}
69
70		/**
71		* Get the current logging level
72		*
73		* @return int
74		*/
75	1	public function getLevel() {
76	1	return $this->level;
77		}
78
79		/**
80		* Set whether the logging should be displayed to the user
81		*
82		* Whether data is actually displayed to the user depends on this setting
83		* and other factors such as whether we are generating a JavaScript or CSS
84		* file.
85		*
86		* @param bool $display Whether to display logging
87		* @return void
88		*/
89		public function setDisplay($display) {
90		$this->display = $display;
91		}
92
93		/**
94		* Add a message to the log
95		*
96		* @param string $message The message to log
97		* @param int $level The logging level
98		* @return bool Whether the messages was logged
99		*/
100	4	public function log($message, $level = self::NOTICE) {
101	4	if ($this->level == self::OFF \|\| $level < $this->level) {
102	4	return false;
103		}
104
105	1	if (!array_key_exists($level, self::$levels)) {
106		return false;
107		}
108
109	1	$levelString = self::$levels[$level];
110
111		// notices and below never displayed to user
112	1	$display = $this->display && $level > self::NOTICE;
113
114	1	$this->process("$levelString: $message", $display, $level);
115
116	1	return true;
117		}
118
119		/**
120		* Log message at the ERROR level
121		*
122		* @param string $message The message to log
123		* @return bool
124		*/
125		public function error($message) {
126		return $this->log($message, self::ERROR);
127		}
128
129		/**
130		* Log message at the WARNING level
131		*
132		* @param string $message The message to log
133		* @return bool
134		*/
135		public function warn($message) {
136		return $this->log($message, self::WARNING);
137		}
138
139		/**
140		* Log message at the NOTICE level
141		*
142		* @param string $message The message to log
143		* @return bool
144		*/
145		public function notice($message) {
146		return $this->log($message, self::NOTICE);
147		}
148
149		/**
150		* Log message at the INFO level
151		*
152		* @param string $message The message to log
153		* @return bool
154		*/
155		public function info($message) {
156		return $this->log($message, self::INFO);
157		}
158
159		/**
160		* Dump data to log or screen
161		*
162		* @param mixed $data The data to log
163		* @param bool $display Whether to include this in the HTML page
164		* @return void
165		*/
166		public function dump($data, $display = true) {
167		$this->process($data, $display, self::ERROR);
168		}
169
170		/**
171		* Process logging data
172		*
173		* @param mixed $data The data to process
174		* @param bool $display Whether to display the data to the user. Otherwise log it.
175		* @param int $level The logging level for this data
176		* @return void
177		*/
178	1	protected function process($data, $display, $level) {
179
180
181		// plugin can return false to stop the default logging method
182		$params = array(
183	1	'level' => $level,
184	1	'msg' => $data,
185	1	'display' => $display,
186	1	'to_screen' => $display,
187	1	);
188
189	1	if (!$this->hooks->trigger('debug', 'log', $params, true)) {
190		return;
191		}
192
193		// Do not want to write to screen before page creation has started.
194		// This is not fool-proof but probably fixes 95% of the cases when logging
195		// results in data sent to the browser before the page is begun.
196	1	if (!isset($this->CONFIG->pagesetupdone)) {
197	1	$display = false;
198	1	}
199
200		// Do not want to write to JS or CSS pages
201	1	if (elgg_in_context('js') \|\| elgg_in_context('css')) {
202		$display = false;
203		}
204
205		// don't display in simplecache requests
206	1	$path = substr(current_page_url(), strlen(elgg_get_site_url()));
207	1	if (preg_match('~^(cache\|action)/~', $path)) {
208		$display = false;
209		}
210
211	1	if ($display == true) {
		0 ignored issues – show Coding Style Best Practice introduced 2017-09-27 16:16 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
212		echo '<pre class="elgg-logger-data">';
213		echo htmlspecialchars(print_r($data, true), ENT_QUOTES, 'UTF-8');
214		echo '</pre>';
215		} else {
216	1	error_log(print_r($data, true));
217		}
218	1	}
219		}
220
221

gctools-outilsgc / gcconnex

Logger::setDisplay() A last analyzed 2021-05-27 17:40 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Logger::setDisplay() A
last analyzed 2021-05-27 17:40 UTC