regulate::alpha() - Code Metrics - ProjectCleverWeb/PHP-Color - Measure and Improve Code Quality continuously with Scrutinizer

regulate::alpha() A
last analyzed 2017-09-06 16:56 UTC

↳ Parent: regulate

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php
/**
 * I/O Regulator Class
 * ===================
 * Allows you to reasonably regulate method/function input and output for
 * various types of color values and color arrays.
 */

namespace projectcleverweb\color;

/**
 * I/O Regulator Class
 * ===================
 * Allows you to reasonably regulate method/function input and output for
 * various types of color values and color arrays.
 */
class regulate {
	
	/**
	 * Forces a float to be within the range of 0 and 100.
	 * 
	 * @param  float &$value The value to modify
	 * @return void
	 */
	public static function percent(float &$value) {
		$value = static::max(abs($value), 100);
	}
	
	/**
	 * Forces a float to be within the range of 0 and 255.
	 * 
	 * @param  float &$value The value to modify
	 * @return void
	 */
	public static function rgb(int &$value) {
		$value = static::max(abs($value), 255);
	}
	
	/**
	 * Forces and RGB array to have specific offsets, and max values.
	 * 
	 * @param  array &$rgb_array The RGB array to modify
	 * @return void
	 */
	public static function rgb_array(array &$rgb_array) {

		static::standardize_array($rgb_array, ['r', 'g', 'b']);
		static::rgb($rgb_array['r']);
		static::rgb($rgb_array['g']);
		static::rgb($rgb_array['b']);
	}
	
	/**
	 * Forces a float to be within the range of 0 and 100 or if the offset is
	 * 'h' 0 and 359.
	 * 
	 * @param  float &$value  The value to modify
	 * @param  string $offset The offset that is being modified
	 * @return void
	 */
	public static function hsl(float &$value, string $offset) {
		if (strtolower($offset) == 'h') {
			$value = static::max(abs($value), 359);
		} else {
			static::percent($value);
		}
	}
	
	/**
	 * Forces and HSL array to have specific offsets, and max values.
	 * 
	 * @param  array &$hsl_array The HSL array to modify
	 * @return void
	 */
	public static function hsl_array(array &$hsl_array) {

		static::standardize_array($hsl_array, ['h', 's', 'l']);
		static::hsl($hsl_array['h'], 'h');
		static::hsl($hsl_array['s'], 's');
		static::hsl($hsl_array['l'], 'l');
	}
	
	/**
	 * Forces and HSL array to have specific offsets, and max values.
	 * 
	 * @param  array &$hsl_array The HSL array to modify
	 * @return void
	 */
	public static function hsb_array(array &$hsl_array) {

		static::standardize_array($hsl_array, ['h', 's', 'b']);
		static::hsl($hsl_array['h'], 'h');
		static::hsl($hsl_array['s'], 's');
		static::hsl($hsl_array['b'], 'b');
	}
	
	/**
	 * Forces a float to be within the range of 0 and 100.
	 * 
	 * @param  float &$value The value to modify
	 * @return void
	 */
	public static function cmyk(float &$value) {
		static::percent($value);
	}
	
	
	/**
	 * Forces a float to be within the range of 0 and 100.
	 * 
	 * @param  float &$value The value to modify
	 * @return void
	 */
	public static function alpha(float &$value) {
		static::percent($value);
	}
	
	/**
	 * Forces and CMYK array to have specific offsets, and max values.
	 * 
	 * @param  array &$cmyk_array The CMYK array to modify
	 * @return void
	 */
	public static function cmyk_array(array &$cmyk_array) {
		static::standardize_array($cmyk_array, ['c', 'm', 'y', 'k']);
		static::cmyk($cmyk_array['c']);
		static::cmyk($cmyk_array['m']);
		static::cmyk($cmyk_array['y']);
		static::cmyk($cmyk_array['k']);
	}
	
	/**
	 * Forces hexadecimal strings to be valid, without a "#", and not to be
	 * shorthand.
	 * 
	 * @param  string &$color The color string to modify
	 * @return void
	 */
	public static function hex(string &$color) {
		static::_validate_hex_str($color);
		static::_strip_hash($color);
		static::_expand_shorthand($color);
	}
	
	/**
	 * Forces hexadecimal integers to be within the range of 0x0 and 0xFFFFFF.
	 * 
	 * @param  int  &$value The value to modify
	 * @return void
	 */
	public static function hex_int(int &$value) {
		$value = static::max(abs($value), 0xFFFFFF);
	}
	
	/**
	 * Strips the hash mark (#) off the beginning of a sting if it has one.
	 * 
	 * @param  string &$hex The hex string
	 * @return void
	 */
	public static function _strip_hash(string &$hex) {
		if (is_string($hex) && substr($hex, 0 ,1) == '#') {
			$hex = substr($hex, 1);
		}
	}
	
	/**
	 * Expand a hex strings in short notation (e.g. 000 => 000000)
	 * 
	 * @param  string &$hex_str The hex string to modify
	 * @return void
	 */
	public static function _expand_shorthand(string &$hex_str) {
		if (strlen($hex_str) === 3) {
			$r = $hex_str[0];
$a = "a";
$ab = "ab";
$abc = "abc";
			$g = $hex_str[1];
$a = "a";
$ab = "ab";
$abc = "abc";
			$b = $hex_str[2];
$a = "a";
$ab = "ab";
$abc = "abc";
			$hex_str = $r.$r.$g.$g.$b.$b;
		}
	}
	
	/**
	 * Verify that the hex string is actually a hex string. If not force it to
	 * '000000'
	 * 
	 * @param  string &$hex_str The hex string to modify
	 * @return void

	 */
	public static function _validate_hex_str(string &$hex_str, bool $check_only = FALSE) :bool {
		if (preg_match('/\A#?(?:[0-9a-f]{3}|[0-9a-f]{6})\Z/i', $hex_str)) {
			return TRUE;
		}
		if (!$check_only) {
			error::trigger(error::INVALID_ARGUMENT, sprintf(
				'The input of %s::%s() was not a valid hex string, forcing value to 000000',
				__CLASS__,
				__FUNCTION__
			));
			$hex_str = '000000';
		}
		return FALSE;
	}
	
	/**
	 * Force an array to have specific lower-case keys. If the array is an indexed
	 * array and the keys are provided, convert it to an associative array.
	 * 
	 * @param  array &$array The array to be modified
	 * @return void
	 */
	public static function standardize_array(array &$array, array $keys = []) {
		if (!empty($keys) && array_keys($array) === range(0, count($array) - 1) && count($array) == count($keys)) {
			$array = array_combine($keys, $array);
		} else {
			$array = array_change_key_case($array) + array_fill_keys($keys, 0);
		}
	}
	
	/**
	 * Absolute and divide any number so it fits between 0 and $max
	 * 
	 * @param  float  $number The original number
	 * @param  float  $max    The maximum value $number should be
	 * @return float          The resulting number as a float
	 */
	public static function max(float $number, float $max) :float {
		$max = abs($max);
		if ($number > $max) {
			$number -= floor($number / ($max + 1)) * ($max + 1);
		}
		return $number;
	}
	
	/**
	 * Simple dividing method to handle division by 0
	 * 
	 * @param  float  $number  The number to divide
	 * @param  float  $divisor The number to divide by
	 * @return float           The result
	 */
	public static function div(float $number, float $divisor) :float {
		if ($divisor == 0) {
			return 0;
		}
		return $number / $divisor;
	}
}


1			<?php
2			/**
3			* I/O Regulator Class
4			* ===================
5			* Allows you to reasonably regulate method/function input and output for
6			* various types of color values and color arrays.
7			*/
8
9			namespace projectcleverweb\color;
10
11			/**
12			* I/O Regulator Class
13			* ===================
14			* Allows you to reasonably regulate method/function input and output for
15			* various types of color values and color arrays.
16			*/
17			class regulate {
18
19			/**
20			* Forces a float to be within the range of 0 and 100.
21			*
22			* @param float &$value The value to modify
23			* @return void
24			*/
25	35		public static function percent(float &$value) {
26	35		$value = static::max(abs($value), 100);
27	35		}
28
29			/**
30			* Forces a float to be within the range of 0 and 255.
31			*
32			* @param float &$value The value to modify
33			* @return void
34			*/
35	12		public static function rgb(int &$value) {
36	12		$value = static::max(abs($value), 255);
37	12		}
38
39			/**
40			* Forces and RGB array to have specific offsets, and max values.
41			*
42			* @param array &$rgb_array The RGB array to modify
43			* @return void
44			*/
45	11	View Code Duplication	public static function rgb_array(array &$rgb_array) {
			0 ignored issues – show Duplication introduced 2016-08-11 15:43 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
46	11		static::standardize_array($rgb_array, ['r', 'g', 'b']);
47	11		static::rgb($rgb_array['r']);
48	11		static::rgb($rgb_array['g']);
49	11		static::rgb($rgb_array['b']);
50	11		}
51
52			/**
53			* Forces a float to be within the range of 0 and 100 or if the offset is
54			* 'h' 0 and 359.
55			*
56			* @param float &$value The value to modify
57			* @param string $offset The offset that is being modified
58			* @return void
59			*/
60	29		public static function hsl(float &$value, string $offset) {
61	29		if (strtolower($offset) == 'h') {
62	29		$value = static::max(abs($value), 359);
63			} else {
64	29		static::percent($value);
65			}
66	29		}
67
68			/**
69			* Forces and HSL array to have specific offsets, and max values.
70			*
71			* @param array &$hsl_array The HSL array to modify
72			* @return void
73			*/
74	25	View Code Duplication	public static function hsl_array(array &$hsl_array) {
			0 ignored issues – show Duplication introduced 2016-08-11 15:43 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
75	25		static::standardize_array($hsl_array, ['h', 's', 'l']);
76	25		static::hsl($hsl_array['h'], 'h');
77	25		static::hsl($hsl_array['s'], 's');
78	25		static::hsl($hsl_array['l'], 'l');
79	25		}
80
81			/**
82			* Forces and HSL array to have specific offsets, and max values.
83			*
84			* @param array &$hsl_array The HSL array to modify
85			* @return void
86			*/
87	5	View Code Duplication	public static function hsb_array(array &$hsl_array) {
			0 ignored issues – show Duplication introduced 2016-08-11 15:43 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
88	5		static::standardize_array($hsl_array, ['h', 's', 'b']);
89	5		static::hsl($hsl_array['h'], 'h');
90	5		static::hsl($hsl_array['s'], 's');
91	5		static::hsl($hsl_array['b'], 'b');
92	5		}
93
94			/**
95			* Forces a float to be within the range of 0 and 100.
96			*
97			* @param float &$value The value to modify
98			* @return void
99			*/
100	6		public static function cmyk(float &$value) {
101	6		static::percent($value);
102	6		}
103
104
105			/**
106			* Forces a float to be within the range of 0 and 100.
107			*
108			* @param float &$value The value to modify
109			* @return void
110			*/
111	1		public static function alpha(float &$value) {
112	1		static::percent($value);
113	1		}
114
115			/**
116			* Forces and CMYK array to have specific offsets, and max values.
117			*
118			* @param array &$cmyk_array The CMYK array to modify
119			* @return void
120			*/
121	5		public static function cmyk_array(array &$cmyk_array) {
122	5		static::standardize_array($cmyk_array, ['c', 'm', 'y', 'k']);
123	5		static::cmyk($cmyk_array['c']);
124	5		static::cmyk($cmyk_array['m']);
125	5		static::cmyk($cmyk_array['y']);
126	5		static::cmyk($cmyk_array['k']);
127	5		}
128
129			/**
130			* Forces hexadecimal strings to be valid, without a "#", and not to be
131			* shorthand.
132			*
133			* @param string &$color The color string to modify
134			* @return void
135			*/
136	7		public static function hex(string &$color) {
137	7		static::_validate_hex_str($color);
138	7		static::_strip_hash($color);
139	7		static::_expand_shorthand($color);
140	7		}
141
142			/**
143			* Forces hexadecimal integers to be within the range of 0x0 and 0xFFFFFF.
144			*
145			* @param int &$value The value to modify
146			* @return void
147			*/
148	3		public static function hex_int(int &$value) {
149	3		$value = static::max(abs($value), 0xFFFFFF);
150	3		}
151
152			/**
153			* Strips the hash mark (#) off the beginning of a sting if it has one.
154			*
155			* @param string &$hex The hex string
156			* @return void
157			*/
158	8		public static function _strip_hash(string &$hex) {
159	8		if (is_string($hex) && substr($hex, 0 ,1) == '#') {
160	2		$hex = substr($hex, 1);
161			}
162	8		}
163
164			/**
165			* Expand a hex strings in short notation (e.g. 000 => 000000)
166			*
167			* @param string &$hex_str The hex string to modify
168			* @return void
169			*/
170	8		public static function _expand_shorthand(string &$hex_str) {
171	8		if (strlen($hex_str) === 3) {
172	2		$r = $hex_str[0];
			0 ignored issues – show Coding Style introduced 2016-07-12 20:52 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 7 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
173	2		$g = $hex_str[1];
			0 ignored issues – show Coding Style introduced 2016-07-12 20:52 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 7 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
174	2		$b = $hex_str[2];
			0 ignored issues – show Coding Style introduced 2016-07-12 20:52 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 7 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
175	2		$hex_str = $r.$r.$g.$g.$b.$b;
176			}
177	8		}
178
179			/**
180			* Verify that the hex string is actually a hex string. If not force it to
181			* '000000'
182			*
183			* @param string &$hex_str The hex string to modify
184			* @return void
			0 ignored issues – show Documentation introduced 2016-10-25 17:40 UTC by Report Bug Copy Issue Report Should the return type not be `boolean`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
185			*/
186	8		public static function _validate_hex_str(string &$hex_str, bool $check_only = FALSE) :bool {
187	8		if (preg_match('/\A#?(?:[0-9a-f]{3}\|[0-9a-f]{6})\Z/i', $hex_str)) {
188	8		return TRUE;
189			}
190	2		if (!$check_only) {
191	2		error::trigger(error::INVALID_ARGUMENT, sprintf(
192	2		'The input of %s::%s() was not a valid hex string, forcing value to 000000',
193	2		__CLASS__,
194			__FUNCTION__
195	2		));
196	2		$hex_str = '000000';
197			}
198			return FALSE;
199			}
200
201			/**
202			* Force an array to have specific lower-case keys. If the array is an indexed
203			* array and the keys are provided, convert it to an associative array.
204			*
205	41		* @param array &$array The array to be modified
206	41		* @return void
207	2		*/
208			public static function standardize_array(array &$array, array $keys = []) {
209	40		if (!empty($keys) && array_keys($array) === range(0, count($array) - 1) && count($array) == count($keys)) {
210			$array = array_combine($keys, $array);
211	41		} else {
212			$array = array_change_key_case($array) + array_fill_keys($keys, 0);
213			}
214			}
215
216			/**
217			* Absolute and divide any number so it fits between 0 and $max
218			*
219			* @param float $number The original number
220	46		* @param float $max The maximum value $number should be
221	46		* @return float The resulting number as a float
222	46		*/
223	16		public static function max(float $number, float $max) :float {
224			$max = abs($max);
225	46		if ($number > $max) {
226			$number -= floor($number / ($max + 1)) * ($max + 1);
227			}
228			return $number;
229			}
230
231			/**
232			* Simple dividing method to handle division by 0
233			*
234			* @param float $number The number to divide
235	15		* @param float $divisor The number to divide by
236	15		* @return float The result
237	5		*/
238			public static function div(float $number, float $divisor) :float {
239	15		if ($divisor == 0) {
240			return 0;
241			}
242			return $number / $divisor;
243			}
244			}
245

ProjectCleverWeb / PHP-Color

regulate::alpha() A last analyzed 2017-09-06 16:56 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

regulate::alpha() A
last analyzed 2017-09-06 16:56 UTC