Operation::getId() - Code Metrics - Inspection of "Added support for operationId and response definit..." - vanderlee/PHPSwaggerGen - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 37902c...ffb897 )

by Martijn

created 2016-10-08 18:50 UTC

Operation::getId() A

↳ Parent: Operation

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

namespace SwaggerGen\Swagger;

/**
 * Describes a Swagger Operation object, which describes a method call of a
 * specific endpoint.
 *
 * @package    SwaggerGen
 * @author     Martijn van der Lee <[email protected]>
 * @copyright  2014-2015 Martijn van der Lee
 * @license    https://opensource.org/licenses/MIT MIT
 */
class Operation extends AbstractDocumentableObject
{

	private $tags = array();
	private $summary;
	private $description;
	private $operationid;

	private $consumes = array();
	private $produces = array();

	/**
	 * @var IParameter[]
	 */
	private $parameters = array();
	private $responses = array();
	private $schemes = array();
	private $deprecated = false;
	private $security = array();
	private $operationId = null;

	public function getConsumes()
	{
		return $this->consumes;
	}

	public function __construct(AbstractObject $parent, $summary = null, Tag $tag = null)
	{
		parent::__construct($parent);
		$this->summary = $summary;
		if ($tag) {
			$this->tags[] = $tag->getName();
		}
	}

	/**
	 * @param string $command
	 * @param string $data
	 * @return \SwaggerGen\Swagger\AbstractObject|boolean
	 */
	public function handleCommand($command, $data = null)
	{
		switch (strtolower($command)) {
			// string
			case 'summary':
			case 'description':
				$this->$command = $data;
				return $this;

			// string[]
			case 'tags':
			case 'schemes':
				$this->$command = array_merge($this->$command, self::wordSplit($data));
				return $this;

			// MIME[]
			case 'consumes':
			case 'produces':

				$this->$command = array_merge($this->$command, self::translateMimeTypes(self::wordSplit($data)));
				return $this;

			// boolean
			case 'deprecated':
				$this->deprecated = true;
				return $this;

			case 'error':

				$code = self::wordShift($data);
				$reasoncode = Response::getCode($code);
				if ($reasoncode === null) {
					throw new \SwaggerGen\Exception("Invalid error code: '$code'");
				}
				$description = $data;
				$Error = new Error($this, $reasoncode, $description);
				$this->responses[$reasoncode] = $Error;
				return $Error;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

			case 'errors':
				foreach (self::wordSplit($data) as $code) {
					$reasoncode = Response::getCode($code);
					if ($reasoncode === null) {
						throw new \SwaggerGen\Exception("Invalid error code: '$code'");
					}
					$this->responses[$reasoncode] = new Error($this, $reasoncode);
				}
				return $this;

			case 'path':
			case 'query':
			case 'query?':
			case 'header':
			case 'header?':
			case 'form':
			case 'form?':
				$in = rtrim($command, '?');
				$Parameter = new Parameter($this, $in, $data, substr($command, -1) !== '?');
				$this->parameters[$Parameter->getName()] = $Parameter;
				return $Parameter;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

			case 'body':
			case 'body?':
				$Parameter = new BodyParameter($this, $data, substr($command, -1) !== '?');
				$this->parameters[$Parameter->getName()] = $Parameter;
				return $Parameter;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

			case 'response':
				$code = self::wordShift($data);
				$reasoncode = Response::getCode($code);
				if ($reasoncode === null) {
					throw new \SwaggerGen\Exception("Invalid response code: '$code'");
				}
				$definition = self::wordShift($data);
				$description = $data;
				$Response = new Response($this, $reasoncode, $definition, $description);
				$this->responses[$reasoncode] = $Response;
				return $Response;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

			case 'require':

				$name = self::wordShift($data);
				if (empty($name)) {
					throw new \SwaggerGen\Exception('Empty security requirement name');
				}
				$scopes = self::wordSplit($data);
				sort($scopes);
				$this->security[] = array(
					$name => empty($scopes) ? array() : $scopes,
				);
				return $this;

			case 'id':
				$operationId = self::trim($data);
				if ($this->getSwagger()->hasOperationId($operationId)) {
					throw new \SwaggerGen\Exception("Duplicate operation id '{$operationId}'");
				}
				$this->operationId = $operationId;
				return $this;
		}

		return parent::handleCommand($command, $data);
	}

	public function toArray()
	{
		if (empty($this->responses)) {
			throw new \SwaggerGen\Exception('No response defined for operation');
		}
		ksort($this->responses);

		$tags = array_unique($this->tags);
		sort($tags);

		$schemes = array_unique($this->schemes);
		sort($schemes);

		$consumes = array_unique($this->consumes);
		sort($consumes);

		$produces = array_unique($this->produces);
		sort($produces);

		foreach ($this->security as $security) {
			foreach ($security as $name => $scope) {
				if ($this->getSwagger()->getSecurity($name) === false) {
					throw new \SwaggerGen\Exception("Required security scheme not defined: '{$name}'");
				}
			}
		}

		$parameters = $this->parameters ? array_values($this->parameters) : null;

		return self::arrayFilterNull(array_merge(array(
					'deprecated' => $this->deprecated ? true : null,
					'tags' => $tags,
					'summary' => empty($this->summary) ? null : $this->summary,
					'description' => empty($this->description) ? null : $this->description,
					'operationId' => $this->operationId,
					'consumes' => $consumes,
					'produces' => $produces,
					'parameters' => $parameters ? self::objectsToArray($parameters) : null,
					'schemes' => $schemes,
					'responses' => $this->responses ? self::objectsToArray($this->responses) : null,
					'security' => $this->security,
								), parent::toArray()));
	}

	/**
	 * Return the operation ID
	 * 
	 * @return string
	 */
	public function getId()
	{
		return $this->operationId;
	}

	public function __toString()
	{
		return __CLASS__ . ' ' . $this->summary;
	}

}


1		<?php
2
3		namespace SwaggerGen\Swagger;
4
5		/**
6		* Describes a Swagger Operation object, which describes a method call of a
7		* specific endpoint.
8		*
9		* @package SwaggerGen
10		* @author Martijn van der Lee <[email protected]>
11		* @copyright 2014-2015 Martijn van der Lee
12		* @license https://opensource.org/licenses/MIT MIT
13		*/
14		class Operation extends AbstractDocumentableObject
15		{
16
17		private $tags = array();
18		private $summary;
19		private $description;
20		private $operationid;
		0 ignored issues – show Unused Code introduced 2016-10-08 18:53 UTC by Report Bug Copy Issue Report The property `$operationid` 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...
21		private $consumes = array();
22		private $produces = array();
23
24		/**
25		* @var IParameter[]
26		*/
27		private $parameters = array();
28		private $responses = array();
29		private $schemes = array();
30		private $deprecated = false;
31		private $security = array();
32		private $operationId = null;
33
34		public function getConsumes()
35		{
36		return $this->consumes;
37		}
38
39		public function __construct(AbstractObject $parent, $summary = null, Tag $tag = null)
40		{
41		parent::__construct($parent);
42		$this->summary = $summary;
43		if ($tag) {
44		$this->tags[] = $tag->getName();
45		}
46		}
47
48		/**
49		* @param string $command
50		* @param string $data
51		* @return \SwaggerGen\Swagger\AbstractObject\|boolean
52		*/
53		public function handleCommand($command, $data = null)
54		{
55		switch (strtolower($command)) {
56		// string
57		case 'summary':
58		case 'description':
59		$this->$command = $data;
60		return $this;
61
62		// string[]
63		case 'tags':
64		case 'schemes':
65		$this->$command = array_merge($this->$command, self::wordSplit($data));
66		return $this;
67
68		// MIME[]
69		case 'consumes':
70	View Code Duplication	case 'produces':
		0 ignored issues – show Duplication introduced 2016-09-14 12:39 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
71		$this->$command = array_merge($this->$command, self::translateMimeTypes(self::wordSplit($data)));
72		return $this;
73
74		// boolean
75		case 'deprecated':
76		$this->deprecated = true;
77		return $this;
78
79	View Code Duplication	case 'error':
		0 ignored issues – show Duplication introduced 2016-10-08 18:53 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
80		$code = self::wordShift($data);
81		$reasoncode = Response::getCode($code);
82		if ($reasoncode === null) {
83		throw new \SwaggerGen\Exception("Invalid error code: '$code'");
84		}
85		$description = $data;
86		$Error = new Error($this, $reasoncode, $description);
87		$this->responses[$reasoncode] = $Error;
88		return $Error;
		0 ignored issues – show Bug Best Practice introduced 2016-10-04 19:39 UTC by Report Bug Copy Issue Report The return type of `return $Error;` (`SwaggerGen\Swagger\Error`) is incompatible with the return type of the parent method `SwaggerGen\Swagger\Abstr...leObject::handleCommand` of type `SwaggerGen\Swagger\Exter...ocumentableObject\|false`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
89
90		case 'errors':
91		foreach (self::wordSplit($data) as $code) {
92		$reasoncode = Response::getCode($code);
93		if ($reasoncode === null) {
94		throw new \SwaggerGen\Exception("Invalid error code: '$code'");
95		}
96		$this->responses[$reasoncode] = new Error($this, $reasoncode);
97		}
98		return $this;
99
100		case 'path':
101		case 'query':
102		case 'query?':
103		case 'header':
104		case 'header?':
105		case 'form':
106		case 'form?':
107		$in = rtrim($command, '?');
108		$Parameter = new Parameter($this, $in, $data, substr($command, -1) !== '?');
109		$this->parameters[$Parameter->getName()] = $Parameter;
110		return $Parameter;
		0 ignored issues – show Bug Best Practice introduced 2016-10-04 19:39 UTC by Report Bug Copy Issue Report The return type of `return $Parameter;` (`SwaggerGen\Swagger\Parameter`) is incompatible with the return type of the parent method `SwaggerGen\Swagger\Abstr...leObject::handleCommand` of type `SwaggerGen\Swagger\Exter...ocumentableObject\|false`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
111
112		case 'body':
113		case 'body?':
114		$Parameter = new BodyParameter($this, $data, substr($command, -1) !== '?');
115		$this->parameters[$Parameter->getName()] = $Parameter;
116		return $Parameter;
		0 ignored issues – show Bug Best Practice introduced 2016-10-04 19:39 UTC by Report Bug Copy Issue Report The return type of `return $Parameter;` (`SwaggerGen\Swagger\BodyParameter`) is incompatible with the return type of the parent method `SwaggerGen\Swagger\Abstr...leObject::handleCommand` of type `SwaggerGen\Swagger\Exter...ocumentableObject\|false`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
117
118		case 'response':
119		$code = self::wordShift($data);
120		$reasoncode = Response::getCode($code);
121		if ($reasoncode === null) {
122		throw new \SwaggerGen\Exception("Invalid response code: '$code'");
123		}
124		$definition = self::wordShift($data);
125		$description = $data;
126		$Response = new Response($this, $reasoncode, $definition, $description);
127		$this->responses[$reasoncode] = $Response;
128		return $Response;
		0 ignored issues – show Bug Best Practice introduced 2016-10-04 19:39 UTC by Report Bug Copy Issue Report The return type of `return $Response;` (`SwaggerGen\Swagger\Response`) is incompatible with the return type of the parent method `SwaggerGen\Swagger\Abstr...leObject::handleCommand` of type `SwaggerGen\Swagger\Exter...ocumentableObject\|false`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
129
130	View Code Duplication	case 'require':
		0 ignored issues – show Duplication introduced 2016-09-14 12:39 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
131		$name = self::wordShift($data);
132		if (empty($name)) {
133		throw new \SwaggerGen\Exception('Empty security requirement name');
134		}
135		$scopes = self::wordSplit($data);
136		sort($scopes);
137		$this->security[] = array(
138		$name => empty($scopes) ? array() : $scopes,
139		);
140		return $this;
141
142		case 'id':
143		$operationId = self::trim($data);
144		if ($this->getSwagger()->hasOperationId($operationId)) {
145		throw new \SwaggerGen\Exception("Duplicate operation id '{$operationId}'");
146		}
147		$this->operationId = $operationId;
148		return $this;
149		}
150
151		return parent::handleCommand($command, $data);
152		}
153
154		public function toArray()
155		{
156		if (empty($this->responses)) {
157		throw new \SwaggerGen\Exception('No response defined for operation');
158		}
159		ksort($this->responses);
160
161		$tags = array_unique($this->tags);
162		sort($tags);
163
164		$schemes = array_unique($this->schemes);
165		sort($schemes);
166
167		$consumes = array_unique($this->consumes);
168		sort($consumes);
169
170		$produces = array_unique($this->produces);
171		sort($produces);
172
173		foreach ($this->security as $security) {
174		foreach ($security as $name => $scope) {
175		if ($this->getSwagger()->getSecurity($name) === false) {
176		throw new \SwaggerGen\Exception("Required security scheme not defined: '{$name}'");
177		}
178		}
179		}
180
181		$parameters = $this->parameters ? array_values($this->parameters) : null;
182
183		return self::arrayFilterNull(array_merge(array(
184		'deprecated' => $this->deprecated ? true : null,
185		'tags' => $tags,
186		'summary' => empty($this->summary) ? null : $this->summary,
187		'description' => empty($this->description) ? null : $this->description,
188		'operationId' => $this->operationId,
189		'consumes' => $consumes,
190		'produces' => $produces,
191		'parameters' => $parameters ? self::objectsToArray($parameters) : null,
192		'schemes' => $schemes,
193		'responses' => $this->responses ? self::objectsToArray($this->responses) : null,
194		'security' => $this->security,
195		), parent::toArray()));
196		}
197
198		/**
199		* Return the operation ID
200		*
201		* @return string
202		*/
203		public function getId()
204		{
205		return $this->operationId;
206		}
207
208		public function __toString()
209		{
210		return __CLASS__ . ' ' . $this->summary;
211		}
212
213		}
214

vanderlee / PHPSwaggerGen

Push — master ( 37902c...ffb897 )

Operation::getId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like