class-wc-log-levels.php — WooCommerce 10.8.0-beta.2

woocommerce / includes / class-wc-log-levels.php

woocommerce / includes Last commit date

class-wc-log-levels.php

160 lines

1	<?php
2	/**
3	* Standard log levels
4	*
5	* @version 3.2.0
6	* @package WooCommerce\Classes
7	*/
8
9	defined( 'ABSPATH' ) \|\| exit;
10
11	/**
12	* Log levels class.
13	*/
14	abstract class WC_Log_Levels {
15	/**
16	* Log Levels
17	*
18	* Description of levels:
19	* 'emergency': System is unusable.
20	* 'alert': Action must be taken immediately.
21	* 'critical': Critical conditions.
22	* 'error': Error conditions.
23	* 'warning': Warning conditions.
24	* 'notice': Normal but significant condition.
25	* 'info': Informational messages.
26	* 'debug': Debug-level messages.
27	*
28	* @see @link {https://tools.ietf.org/html/rfc5424}
29	*/
30	const EMERGENCY = 'emergency';
31	const ALERT = 'alert';
32	const CRITICAL = 'critical';
33	const ERROR = 'error';
34	const WARNING = 'warning';
35	const NOTICE = 'notice';
36	const INFO = 'info';
37	const DEBUG = 'debug';
38
39	/**
40	* Level strings mapped to integer severity.
41	*
42	* @var array
43	*/
44	protected static $level_to_severity = array(
45	self::EMERGENCY => 800,
46	self::ALERT => 700,
47	self::CRITICAL => 600,
48	self::ERROR => 500,
49	self::WARNING => 400,
50	self::NOTICE => 300,
51	self::INFO => 200,
52	self::DEBUG => 100,
53	);
54
55	/**
56	* Severity integers mapped to level strings.
57	*
58	* This is the inverse of $level_severity.
59	*
60	* @var array
61	*/
62	protected static $severity_to_level = array(
63	800 => self::EMERGENCY,
64	700 => self::ALERT,
65	600 => self::CRITICAL,
66	500 => self::ERROR,
67	400 => self::WARNING,
68	300 => self::NOTICE,
69	200 => self::INFO,
70	100 => self::DEBUG,
71	);
72
73
74	/**
75	* Validate a level string.
76	*
77	* @param string $level Log level.
78	* @return bool True if $level is a valid level.
79	*/
80	public static function is_valid_level( $level ) {
81	return is_string( $level ) && array_key_exists( strtolower( $level ), self::$level_to_severity );
82	}
83
84	/**
85	* Translate level string to integer.
86	*
87	* @param string $level Log level, options: emergency\|alert\|critical\|error\|warning\|notice\|info\|debug.
88	* @return int 100 (debug) - 800 (emergency) or 0 if not recognized
89	*/
90	public static function get_level_severity( $level ) {
91	return self::is_valid_level( $level ) ? self::$level_to_severity[ strtolower( $level ) ] : 0;
92	}
93
94	/**
95	* Get an associative array with `level name => numerical severity` key/value pairs.
96	*
97	* @return int[]
98	*/
99	public static function get_all_level_severities() {
100	return self::$level_to_severity;
101	}
102
103	/**
104	* Translate severity integer to level string.
105	*
106	* @param int $severity Severity level.
107	* @return bool\|string False if not recognized. Otherwise string representation of level.
108	*/
109	public static function get_severity_level( $severity ) {
110	if ( ! array_key_exists( $severity, self::$severity_to_level ) ) {
111	return false;
112	}
113	return self::$severity_to_level[ $severity ];
114	}
115
116	/**
117	* Get an associative array with `numerical severity => level name` key/value pairs.
118	*
119	* @return string[]
120	*/
121	public static function get_all_severity_levels() {
122	return self::$severity_to_level;
123	}
124
125	/**
126	* Get the UI label for a log level.
127	*
128	* @param string $level Log level, options: emergency\|alert\|critical\|error\|warning\|notice\|info\|debug.
129	*
130	* @return string
131	*/
132	public static function get_level_label( $level ) {
133	$labels = self::get_all_level_labels();
134
135	if ( ! array_key_exists( $level, $labels ) ) {
136	return '';
137	}
138
139	return $labels[ $level ];
140	}
141
142	/**
143	* Get the UI labels for all log levels.
144	*
145	* @return string[]
146	*/
147	public static function get_all_level_labels() {
148	return array(
149	self::EMERGENCY => __( 'Emergency', 'woocommerce' ),
150	self::ALERT => __( 'Alert', 'woocommerce' ),
151	self::CRITICAL => __( 'Critical', 'woocommerce' ),
152	self::ERROR => __( 'Error', 'woocommerce' ),
153	self::WARNING => __( 'Warning', 'woocommerce' ),
154	self::NOTICE => __( 'Notice', 'woocommerce' ),
155	self::INFO => __( 'Info', 'woocommerce' ),
156	self::DEBUG => __( 'Debug', 'woocommerce' ),
157	);
158	}
159	}
160