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

main_peripheral::serialize() A
last analyzed 2017-09-06 16:56 UTC

↳ Parent: main_peripheral

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/**
 * Handles the "extra" functionality for the main class.
 */

namespace projectcleverweb\color;

/**
 * Handles the "extra" functionality for the main class.
 */
abstract class main_peripheral implements \Serializable, \JsonSerializable {
	
	/**
	 * Makes sure cloning works as expected
	 * 
	 * @return void
	 */
	public function __clone() {
		$this->color = clone $this->color;
		$this->cache = clone $this->cache;
	}
	
	/**
	 * Custom serialize function
	 * 
	 * @return string This instance serialized as an RGB string
	 */
	public function serialize() :string {
		return $this->color->serialize();
	}
	
	/**
	 * Custom unserialize function
	 * 
	 * @param  string $serialized This instance serialized as an RGB string
	 * @return void
	 */
	public function unserialize($serialized) {
		$unserialized = (array) json_decode((string) $serialized);
		regulate::rgb_array($unserialized);
		$this->set($unserialized, 'rgb');
	}
	
	/**
	 * Custom JSON serialize function
	 * 
	 * @return string This instance serialized as an JSON RGB string

	 */
	public function jsonSerialize() :array {
		return $this->color->jsonSerialize();
	}
	
	protected function get_scheme(string $scheme_name, string $return_type = 'hex', $scheme_class) :array {
// $a must always be passed; it's default value is never used.
function someFunction($a = 5, $b) { }
		if (!is_null($cached = $this->cache->get(get_class($scheme_class).'_'.$scheme_name.'_'.$return_type, $this->hex()))) {
			return $cached;
		}
		$result = static::_scheme($scheme_name, [$scheme_class, strtolower($return_type)], $this->hsl(3));
		$this->cache->set(get_class($scheme_class).'_'.$scheme_name.'_'.$return_type, $this->hex(), $result);
		return $result;
	}
	
	/**
	 * Handles scheme generator callbacks
	 * 
	 * @param  string $scheme_name The name of the scheme algorithm to use
	 * @param  string $callback    The return type callback

	 * @param  array  $hsl         The base color as an HSL array
	 * @return array               The resulting scheme in the proper format, OR an empty array on failure.
	 */
	protected static function _scheme(string $scheme_name, array $callback, array $hsl) :array {
		if (is_callable($callback)) {
			return call_user_func($callback, $hsl['h'], $hsl['s'], $hsl['l'], $scheme_name);
		}
		error::trigger(error::INVALID_ARGUMENT, sprintf(
			'The $callback "%s" is not a valid callback',
			print_r($callback, 1),
			__CLASS__,
			__FUNCTION__
		));
		return [];
	}
	
	/**
	 * Set whether or not caching should be active.
	 * 
	 * @param  bool $active If TRUE caching is turned on, otherwise cashing is turned off.
	 * @return void
	 */
	public function cache(bool $active = TRUE) {
		$this->cache->active = $active;
	}
	
	/**
	 * Reset the cache for this instance
	 * 
	 * @return void
	 */
	public function reset_cache() {
		$this->cache->reset();
	}
}


1			<?php
2			/**
3			* Handles the "extra" functionality for the main class.
4			*/
5
6			namespace projectcleverweb\color;
7
8			/**
9			* Handles the "extra" functionality for the main class.
10			*/
11			abstract class main_peripheral implements \Serializable, \JsonSerializable {
12
13			/**
14			* Makes sure cloning works as expected
15			*
16			* @return void
17			*/
18			public function __clone() {
19			$this->color = clone $this->color;
20			$this->cache = clone $this->cache;
21			}
22
23			/**
24			* Custom serialize function
25			*
26			* @return string This instance serialized as an RGB string
27			*/
28			public function serialize() :string {
29			return $this->color->serialize();
30			}
31
32			/**
33			* Custom unserialize function
34			*
35			* @param string $serialized This instance serialized as an RGB string
36			* @return void
37			*/
38			public function unserialize($serialized) {
39			$unserialized = (array) json_decode((string) $serialized);
40			regulate::rgb_array($unserialized);
41			$this->set($unserialized, 'rgb');
42			}
43
44			/**
45			* Custom JSON serialize function
46			*
47			* @return string This instance serialized as an JSON RGB string
			0 ignored issues – show Documentation introduced 2016-08-16 15:18 UTC by Report Bug Copy Issue Report Should the return type not be `array`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. 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. If the return type contains the type array, this check recommends the use of a more specific type like `String[]` or `array<String>`. Loading history...
48			*/
49			public function jsonSerialize() :array {
50			return $this->color->jsonSerialize();
51			}
52
53			protected function get_scheme(string $scheme_name, string $return_type = 'hex', $scheme_class) :array {
			0 ignored issues – show Coding Style introduced 2017-09-06 16:56 UTC by Report Bug Copy Issue Report Parameters which have default values should be placed at the end. If you place a parameter with a default value before a parameter with a default value, the default value of the first parameter will never be used as it will always need to be passed anyway: // $a must always be passed; it's default value is never used. function someFunction($a = 5, $b) { } Loading history...
54			if (!is_null($cached = $this->cache->get(get_class($scheme_class).'_'.$scheme_name.'_'.$return_type, $this->hex()))) {
55			return $cached;
56			}
57			$result = static::_scheme($scheme_name, [$scheme_class, strtolower($return_type)], $this->hsl(3));
58			$this->cache->set(get_class($scheme_class).'_'.$scheme_name.'_'.$return_type, $this->hex(), $result);
59			return $result;
60			}
61
62			/**
63			* Handles scheme generator callbacks
64			*
65			* @param string $scheme_name The name of the scheme algorithm to use
66			* @param string $callback The return type callback
			0 ignored issues – show Documentation introduced 2016-09-22 18:37 UTC by Report Bug Copy Issue Report Should the type for parameter `$callback` not be `array`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. In addition it looks for parameters that have the generic type `array` and suggests a stricter type like `array<String>`. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
67			* @param array $hsl The base color as an HSL array
68			* @return array The resulting scheme in the proper format, OR an empty array on failure.
69			*/
70			protected static function _scheme(string $scheme_name, array $callback, array $hsl) :array {
71			if (is_callable($callback)) {
72			return call_user_func($callback, $hsl['h'], $hsl['s'], $hsl['l'], $scheme_name);
73			}
74			error::trigger(error::INVALID_ARGUMENT, sprintf(
75			'The $callback "%s" is not a valid callback',
76			print_r($callback, 1),
77			__CLASS__,
78			__FUNCTION__
79			));
80			return [];
81			}
82
83			/**
84			* Set whether or not caching should be active.
85			*
86			* @param bool $active If TRUE caching is turned on, otherwise cashing is turned off.
87			* @return void
88			*/
89			public function cache(bool $active = TRUE) {
90			$this->cache->active = $active;
91			}
92
93			/**
94			* Reset the cache for this instance
95			*
96			* @return void
97			*/
98			public function reset_cache() {
99			$this->cache->reset();
100			}
101			}
102

ProjectCleverWeb / PHP-Color

main_peripheral::serialize() A last analyzed 2017-09-06 16:56 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

main_peripheral::serialize() A
last analyzed 2017-09-06 16:56 UTC