Schema::parse() - Code Metrics - Inspection of "Casts object to string before passing to collectio..." - gossi/swagger - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#7)

by Jacob

created 2016-08-04 23:01 UTC

Schema::parse() B

↳ Parent: Schema

Complexity

Conditions	5
Paths	8

Size

Total Lines	28
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	20
CRAP Score	5.0026

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
c	3
b	1
f	0
dl	0
loc	28
ccs	20
cts	21
cp	0.9524
rs	8.439
cc	5
eloc	20
nc	8
nop	1
crap	5.0026

<?php
namespace gossi\swagger;

use gossi\swagger\collections\Definitions;
use gossi\swagger\parts\DescriptionPart;
use gossi\swagger\parts\ExtensionPart;
use gossi\swagger\parts\ExternalDocsPart;
use gossi\swagger\parts\ItemsPart;
use gossi\swagger\parts\RefPart;
use gossi\swagger\parts\TypePart;
use phootwork\collection\ArrayList;
use phootwork\collection\CollectionUtils;
use phootwork\collection\Map;
use phootwork\lang\Arrayable;

class Schema extends AbstractModel implements Arrayable {

	use RefPart;
	use TypePart;
	use DescriptionPart;
	use ItemsPart;
	use ExternalDocsPart;
	use ExtensionPart;

	/** @var string */
	private $discriminator;

	/** @var bool */
	private $readOnly = false;

	/** @var string */
	private $title;

	private $xml;


	/** @var string */
	private $example;

	/** @var ArrayList|bool */
	private $required;

	/** @var Definitions */
	private $properties;

	/** @var ArrayList */
	private $allOf;

	/** @var Schema */
	private $additionalProperties;

	public function __construct($contents = null) {
		$this->parse($contents === null ? new Map() : $contents);
	}

	private function parse($contents = []) {
		$data = CollectionUtils::toMap($contents);

		$this->title = $data->get('title');
		$this->discriminator = $data->get('discriminator');
		$this->readOnly = $data->has('readOnly') && $data->get('readOnly');
		$this->example = $data->get('example');
		$this->required = $data->get('required');
		$this->properties = new Definitions($data->get('properties'));
		if ($data->has('additionalProperties')) {
			$this->additionalProperties = new self($data->get('additionalProperties'));
		}

		$this->allOf = new ArrayList();
		if ($data->has('allOf')) {
			foreach ($data->get('allOf') as $schema) {
				$this->allOf->add(new self($schema));
			}
		}

		// parts
		$this->parseRef($data);
		$this->parseType($data);
		$this->parseDescription($data);
		$this->parseItems($data);
		$this->parseExternalDocs($data);
		$this->parseExtensions($data);
	}

	public function toArray() {
		return $this->export('title', 'discriminator', 'description', 'readOnly', 'example',
				'externalDocs', $this->getTypeExportFields(), 'items', 'required',
				'properties', 'additionalProperties', 'allOf');
	}

	/**
	 *
	 * @return bool|array
	 */
	public function getRequired() {
		return $this->required;
	}

	/**
	 *
	 * @param bool|array $required
	 * @return $this
	 */
	public function setRequired($required) {
		$this->required = $required;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
		return $this;
	}

	/**
	 *
	 * @return string
	 */
	public function getDiscriminator() {
		return $this->discriminator;
	}

	/**
	 *
	 * @param string $discriminator
	 */
	public function setDiscriminator($discriminator) {
		$this->discriminator = $discriminator;
		return $this;
	}

	/**
	 *
	 * @return bool
	 */
	public function isReadOnly() {
		return $this->readOnly;
	}

	/**
	 *
	 * @param bool $readOnly
	 */
	public function setReadOnly($readOnly) {
		$this->readOnly = $readOnly;
		return $this;
	}

	/**
	 *
	 * @return string
	 */
	public function getExample() {
		return $this->example;
	}

	/**
	 *
	 * @param string $example
	 */
	public function setExample($example) {
		$this->example = $example;
		return $this;
	}

	/**
	 *
	 * @return string
	 */
	public function getTitle() {
		return $this->title;
	}

	/**
	 *
	 * @param string $title
	 * @return $this
	 */
	public function setTitle($title) {
		$this->title = $title;
		return $this;
	}

	/**
	 *
	 * @return Definitions
	 */
	public function getProperties() {
		return $this->properties;
	}

	/**
	 *
	 * @return ArrayList
	 */
	public function getAllOf() {
		return $this->allOf;
	}

	/**
	 *
	 * @return Schema
	 */
	public function getAdditionalProperties() {
		if ($this->additionalProperties === null) {
			$this->additionalProperties = new self();
		}
		return $this->additionalProperties;
	}

}


1		<?php
2		namespace gossi\swagger;
3
4		use gossi\swagger\collections\Definitions;
5		use gossi\swagger\parts\DescriptionPart;
6		use gossi\swagger\parts\ExtensionPart;
7		use gossi\swagger\parts\ExternalDocsPart;
8		use gossi\swagger\parts\ItemsPart;
9		use gossi\swagger\parts\RefPart;
10		use gossi\swagger\parts\TypePart;
11		use phootwork\collection\ArrayList;
12		use phootwork\collection\CollectionUtils;
13		use phootwork\collection\Map;
14		use phootwork\lang\Arrayable;
15
16		class Schema extends AbstractModel implements Arrayable {
17
18		use RefPart;
19		use TypePart;
20		use DescriptionPart;
21		use ItemsPart;
22		use ExternalDocsPart;
23		use ExtensionPart;
24
25		/** @var string */
26		private $discriminator;
27
28		/** @var bool */
29		private $readOnly = false;
30
31		/** @var string */
32		private $title;
33
34		private $xml;
		0 ignored issues – show Unused Code introduced 2015-12-09 00:07 UTC by Report Bug Copy Issue Report The property `$xml` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
35
36		/** @var string */
37		private $example;
38
39		/** @var ArrayList\|bool */
40		private $required;
41
42		/** @var Definitions */
43		private $properties;
44
45		/** @var ArrayList */
46		private $allOf;
47
48		/** @var Schema */
49		private $additionalProperties;
50
51	9	public function __construct($contents = null) {
52	9	$this->parse($contents === null ? new Map() : $contents);
53	9	}
54
55	9	private function parse($contents = []) {
56	9	$data = CollectionUtils::toMap($contents);
57
58	9	$this->title = $data->get('title');
59	9	$this->discriminator = $data->get('discriminator');
60	9	$this->readOnly = $data->has('readOnly') && $data->get('readOnly');
61	9	$this->example = $data->get('example');
62	9	$this->required = $data->get('required');
63	9	$this->properties = new Definitions($data->get('properties'));
64	9	if ($data->has('additionalProperties')) {
65		$this->additionalProperties = new self($data->get('additionalProperties'));
66		}
67
68	9	$this->allOf = new ArrayList();
69	9	if ($data->has('allOf')) {
70	3	foreach ($data->get('allOf') as $schema) {
71	3	$this->allOf->add(new self($schema));
72		}
73		}
74
75		// parts
76	9	$this->parseRef($data);
77	9	$this->parseType($data);
78	9	$this->parseDescription($data);
79	9	$this->parseItems($data);
80	9	$this->parseExternalDocs($data);
81	9	$this->parseExtensions($data);
82	9	}
83
84	9	public function toArray() {
85	9	return $this->export('title', 'discriminator', 'description', 'readOnly', 'example',
86	9	'externalDocs', $this->getTypeExportFields(), 'items', 'required',
87	9	'properties', 'additionalProperties', 'allOf');
88		}
89
90		/**
91		*
92		* @return bool\|array
93		*/
94		public function getRequired() {
95		return $this->required;
96		}
97
98		/**
99		*
100		* @param bool\|array $required
101		* @return $this
102		*/
103		public function setRequired($required) {
104		$this->required = $required;
		0 ignored issues – show Documentation Bug introduced 2015-12-09 00:07 UTC by Report Bug Copy Issue Report It seems like `$required` can also be of type `array`. However, the property `$required` is declared as type `object<phootwork\collection\ArrayList>\|boolean`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
105		return $this;
106		}
107
108		/**
109		*
110		* @return string
111		*/
112		public function getDiscriminator() {
113		return $this->discriminator;
114		}
115
116		/**
117		*
118		* @param string $discriminator
119		*/
120		public function setDiscriminator($discriminator) {
121		$this->discriminator = $discriminator;
122		return $this;
123		}
124
125		/**
126		*
127		* @return bool
128		*/
129		public function isReadOnly() {
130		return $this->readOnly;
131		}
132
133		/**
134		*
135		* @param bool $readOnly
136		*/
137		public function setReadOnly($readOnly) {
138		$this->readOnly = $readOnly;
139		return $this;
140		}
141
142		/**
143		*
144		* @return string
145		*/
146		public function getExample() {
147		return $this->example;
148		}
149
150		/**
151		*
152		* @param string $example
153		*/
154		public function setExample($example) {
155		$this->example = $example;
156		return $this;
157		}
158
159		/**
160		*
161		* @return string
162		*/
163		public function getTitle() {
164		return $this->title;
165		}
166
167		/**
168		*
169		* @param string $title
170		* @return $this
171		*/
172		public function setTitle($title) {
173		$this->title = $title;
174		return $this;
175		}
176
177		/**
178		*
179		* @return Definitions
180		*/
181		public function getProperties() {
182		return $this->properties;
183		}
184
185		/**
186		*
187		* @return ArrayList
188		*/
189		public function getAllOf() {
190		return $this->allOf;
191		}
192
193		/**
194		*
195		* @return Schema
196		*/
197		public function getAdditionalProperties() {
198		if ($this->additionalProperties === null) {
199		$this->additionalProperties = new self();
200		}
201		return $this->additionalProperties;
202		}
203
204		}
205

gossi / swagger

Pull Request — master (#7)

Schema::parse() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like