Header::getTyped() - Code Metrics - Inspection of "Use getTyped" - sop/jwx - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (90b318)

by Joni

created 2016-06-08 05:53 UTC

Header::getTyped() A

↳ Parent: Header

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3.0987

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	7
cts	9
cp	0.7778
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	8
nc	3
nop	1
crap	3.0987

<?php

namespace JWX\JWT;

use JWX\JWT\Parameter\JWTParameter;
use JWX\JWT\Parameter\RegisteredJWTParameter;


/**
 * Represents a header used in JWS and JWE.
 */
class Header implements 
	\Countable, \IteratorAggregate

{
	/**
	 * Parameters.
	 *
	 * @var JWTParameter[] $_parameters
	 */
	protected $_parameters;
	
	/**
	 * Constructor
	 *
	 * @param JWTParameter ...$params Parameters
	 */
	public function __construct(JWTParameter ...$params) {
		$this->_parameters = array();
		foreach ($params as $param) {
			$this->_parameters[$param->name()] = $param;
		}
	}
	
	/**
	 * Initialize from an array representing a JSON object.
	 *
	 * @param array $members
	 * @return self
	 */
	public static function fromArray(array $members) {
		$params = array();
		foreach ($members as $name => $value) {
			$params[] = JWTParameter::fromNameAndValue($name, $value);
		}
		return new self(...$params);
	}
	
	/**
	 * Initialize from a JSON.
	 *
	 * @param string $json
	 * @throws \UnexpectedValueException
	 * @return self
	 */
	public static function fromJSON($json) {

		$members = json_decode($json, true, 32, JSON_BIGINT_AS_STRING);
		if (!is_array($members)) {
			throw new \UnexpectedValueException("Invalid JSON.");
		}
		return self::fromArray($members);
	}
	
	/**
	 * Get self with parameters added.
	 *
	 * @param JWTParameter ...$param
	 * @return self
	 */
	public function withParameters(JWTParameter ...$params) {
		$obj = clone $this;
		foreach ($params as $param) {
			$obj->_parameters[$param->name()] = $param;
		}
		return $obj;
	}
	
	/**
	 * Get all parameters.
	 *
	 * @return JWTParameter[]
	 */
	public function parameters() {
		return $this->_parameters;
	}
	
	/**
	 * Whether parameters are present.
	 *
	 * Returns false if any of the given parameters is not set.
	 *
	 * @param string ...$names Parameter names
	 * @return boolean
	 */
	public function has(...$names) {

		foreach ($names as $name) {
			if (!isset($this->_parameters[$name])) {
				return false;
			}
		}
		return true;
	}
	
	/**
	 * Get a parameter.
	 *
	 * @param string $name Parameter name
	 * @throws \LogicException
	 * @return JWTParameter
	 */
	public function get($name) {
		if (!$this->has($name)) {
			throw new \LogicException("Parameter $name doesn't exists.");
		}
		return $this->_parameters[$name];
	}
	
	/**
	 * Get a parameter and check that it's an instance of the expected type.
	 *
	 * @param string $name Parameter name
	 * @throws \RuntimeException
	 * @return JWTParameter
	 */
	public function getTyped($name) {
		$param = $this->get($name);
		if (array_key_exists($name, RegisteredJWTParameter::MAP_NAME_TO_CLASS)) {
			$cls = RegisteredJWTParameter::MAP_NAME_TO_CLASS[$name];
			if (!$param instanceof $cls) {
				throw new \RuntimeException(
					"$cls expected, got " . get_class($param));
			}
		}
		return $param;
	}
	
	/**
	 * Convert to a JSON.
	 *
	 * @return string
	 */
	public function toJSON() {

		if (empty($this->_parameters)) {
			return "";
		}
		$data = array();
		foreach ($this->_parameters as $param) {
			$data[$param->name()] = $param->value();
		}
		return json_encode((object) $data, JSON_UNESCAPED_SLASHES);
	}
	
	/**
	 * Get the number of parameters.
	 *
	 * @see Countable::count()
	 * @return int
	 */
	public function count() {
		return count($this->_parameters);
	}
	
	/**
	 * Get iterator for the parameters.
	 *
	 * @see IteratorAggregate::getIterator()
	 * @return \ArrayIterator
	 */
	public function getIterator() {
		return new \ArrayIterator($this->_parameters);
	}
}


1			<?php
2
3			namespace JWX\JWT;
4
5			use JWX\JWT\Parameter\JWTParameter;
6			use JWX\JWT\Parameter\RegisteredJWTParameter;
7
8
9			/**
10			* Represents a header used in JWS and JWE.
11			*/
12			class Header implements
13			\Countable, \IteratorAggregate
			0 ignored issues – show Coding Style introduced 2016-06-08 05:36 UTC by Report Bug Copy Issue Report Expected 4 spaces before interface name; 1 found Loading history... Coding Style introduced 2016-06-08 05:36 UTC by Report Bug Copy Issue Report Only one interface may be specified per line in a multi-line implements declaration Loading history...
14			{
15			/**
16			* Parameters.
17			*
18			* @var JWTParameter[] $_parameters
19			*/
20			protected $_parameters;
21
22			/**
23			* Constructor
24			*
25			* @param JWTParameter ...$params Parameters
26			*/
27	131		public function __construct(JWTParameter ...$params) {
28	131		$this->_parameters = array();
29	131		foreach ($params as $param) {
30	62		$this->_parameters[$param->name()] = $param;
31	131		}
32	131		}
33
34			/**
35			* Initialize from an array representing a JSON object.
36			*
37			* @param array $members
38			* @return self
39			*/
40	45		public static function fromArray(array $members) {
41	45		$params = array();
42	45		foreach ($members as $name => $value) {
43	45		$params[] = JWTParameter::fromNameAndValue($name, $value);
44	45		}
45	45		return new self(...$params);
46			}
47
48			/**
49			* Initialize from a JSON.
50			*
51			* @param string $json
52			* @throws \UnexpectedValueException
53			* @return self
54			*/
55	33	View Code Duplication	public static function fromJSON($json) {
			0 ignored issues – show Duplication introduced 2016-06-01 09:53 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...
56	33		$members = json_decode($json, true, 32, JSON_BIGINT_AS_STRING);
57	33		if (!is_array($members)) {
58	1		throw new \UnexpectedValueException("Invalid JSON.");
59			}
60	32		return self::fromArray($members);
61			}
62
63			/**
64			* Get self with parameters added.
65			*
66			* @param JWTParameter ...$param
67			* @return self
68			*/
69	32		public function withParameters(JWTParameter ...$params) {
70	32		$obj = clone $this;
71	32		foreach ($params as $param) {
72	32		$obj->_parameters[$param->name()] = $param;
73	32		}
74	32		return $obj;
75			}
76
77			/**
78			* Get all parameters.
79			*
80			* @return JWTParameter[]
81			*/
82	28		public function parameters() {
83	28		return $this->_parameters;
84			}
85
86			/**
87			* Whether parameters are present.
88			*
89			* Returns false if any of the given parameters is not set.
90			*
91			* @param string ...$names Parameter names
92			* @return boolean
93			*/
94	70	View Code Duplication	public function has(...$names) {
			0 ignored issues – show Duplication introduced 2016-06-01 09:53 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...
95	70		foreach ($names as $name) {
96	70		if (!isset($this->_parameters[$name])) {
97	41		return false;
98			}
99	43		}
100	42		return true;
101			}
102
103			/**
104			* Get a parameter.
105			*
106			* @param string $name Parameter name
107			* @throws \LogicException
108			* @return JWTParameter
109			*/
110	37		public function get($name) {
111	37		if (!$this->has($name)) {
112	1		throw new \LogicException("Parameter $name doesn't exists.");
113			}
114	36		return $this->_parameters[$name];
115			}
116
117			/**
118			* Get a parameter and check that it's an instance of the expected type.
119			*
120			* @param string $name Parameter name
121			* @throws \RuntimeException
122			* @return JWTParameter
123			*/
124	4		public function getTyped($name) {
125	4		$param = $this->get($name);
126	4		if (array_key_exists($name, RegisteredJWTParameter::MAP_NAME_TO_CLASS)) {
127	4		$cls = RegisteredJWTParameter::MAP_NAME_TO_CLASS[$name];
128	4		if (!$param instanceof $cls) {
129			throw new \RuntimeException(
130			"$cls expected, got " . get_class($param));
131			}
132	4		}
133	4		return $param;
134			}
135
136			/**
137			* Convert to a JSON.
138			*
139			* @return string
140			*/
141	70	View Code Duplication	public function toJSON() {
			0 ignored issues – show Duplication introduced 2016-06-01 09:53 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...
142	70		if (empty($this->_parameters)) {
143	1		return "";
144			}
145	69		$data = array();
146	69		foreach ($this->_parameters as $param) {
147	69		$data[$param->name()] = $param->value();
148	69		}
149	69		return json_encode((object) $data, JSON_UNESCAPED_SLASHES);
150			}
151
152			/**
153			* Get the number of parameters.
154			*
155			* @see Countable::count()
156			* @return int
157			*/
158	3		public function count() {
159	3		return count($this->_parameters);
160			}
161
162			/**
163			* Get iterator for the parameters.
164			*
165			* @see IteratorAggregate::getIterator()
166			* @return \ArrayIterator
167			*/
168	1		public function getIterator() {
169	1		return new \ArrayIterator($this->_parameters);
170			}
171			}
172

sop / jwx

GitHub Access Token became invalid

Branch — master (90b318)

Header::getTyped() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like