SwaggerGen::define() - Code Metrics - Inspection of "Minor code style fixes" - vanderlee/PHPSwaggerGen - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (ffa084)

by Martijn

created 2018-04-17 12:49 UTC

SwaggerGen::define() A

↳ Parent: SwaggerGen

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace SwaggerGen;

/**
 * Main class of SwaggerGen which serves as a facade for the entire library.
 *
 * Copyright (c) 2014-2015 Martijn van der Lee
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @package    SwaggerGen
 * @author     Martijn van der Lee <[email protected]>
 * @copyright  2014-2015 Martijn van der Lee
 * @license    https://opensource.org/licenses/MIT MIT
 */
class SwaggerGen
{

	const FORMAT_ARRAY = '';
	const FORMAT_JSON = 'json';
	const FORMAT_JSON_PRETTY = 'json+';
	const FORMAT_YAML = 'yaml';

	private $host;
	private $basePath;
	private $dirs = array();
	private $defines = array();

	/**
	 * @var TypeRegistry
	 */
	private $typeRegistry = null;

	/**
	 * Create a new SwaggerGen instance
	 * 
	 * @param string $host
	 * @param string $basePath
	 * @param string[] $dirs
	 * @param TypeRegistry $typeRegistry
	 */
	public function __construct($host = '', $basePath = '', $dirs = array(), $typeRegistry = null)
	{
		$this->host = $host;
		$this->basePath = $basePath;
		$this->dirs = $dirs;
		$this->typeRegistry = $typeRegistry;
	}
	
	/**
	 * Set a new type registry
	 * 
	 * @param TypeRegistry $typeRegistry
	 */
	public function setTypeRegistry($typeRegistry = null)
	{
		$this->typeRegistry = $typeRegistry;
	}

	public function define($name, $value = 1)
	{
		$this->defines[$name] = $value;
	}

	public function undefine($name)
	{
		unset($this->defines[$name]);
	}

	/**
	 * @param string $file
	 * @param string[] $dirs
	 * @return Php\Entity\Statement[]
	 */
	private function parsePhpFile($file, $dirs)
	{
		$Parser = new Parser\Php\Parser();
		return $Parser->parse($file, $dirs, $this->defines);
	}

	/**
	 * @param string $file
	 * @param string[] $dirs
	 * @return Php\Entity\Statement[]
	 */
	private function parseTextFile($file, $dirs)
	{
		$Parser = new Parser\Text\Parser();
		return $Parser->parse($file, $dirs, $this->defines);
	}

	/**
	 * @param string $text
	 * @param string[] $dirs
	 * @return Php\Entity\Statement[]
	 */
	private function parseText($text, $dirs)
	{
		$Parser = new Parser\Text\Parser();
		return $Parser->parseText($text, $dirs, $this->defines);
	}

	/**
	 * Creates Swagger\Swagger object and populates it with statements
	 *
	 * This effectively converts the linear list of statements into parse-tree
	 * like structure, performing some checks (like rejecting unknown
	 * subcommands) during the process. Returned Swagger\Swagger object is
	 * ready for serialization with {@see Swagger\Swagger::toArray}
	 *
	 * @param string $host
	 * @param string $basePath
	 * @param Statement[] $statements
	 * @return Swagger\Swagger
	 * @throws StatementException
	 */
	public function parseStatements($host, $basePath, $statements)
	{
		$swagger = new Swagger\Swagger($host, $basePath, $this->typeRegistry);

		$stack = array($swagger); /* @var Swagger\AbstractObject[] $stack */
		foreach ($statements as $statement) {
			try {
				$top = end($stack);

				do {
					$result = $top->handleCommand($statement->getCommand(), $statement->getData());

					if ($result) {
						if ($result !== $top) {
							// Remove all similar classes from array first!
							$classname = get_class($result);
							$stack = array_filter($stack, function($class) use($classname) {
								return !(is_a($class, $classname));
							});

							$stack[] = $result;
						}
					} else {
						$top = prev($stack);
					}
				} while (!$result && $top);
			} catch (\SwaggerGen\Exception $e) {
				throw new \SwaggerGen\StatementException($e->getMessage(), $e->getCode(), $e, $statement);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			}

			if (!$result && !$top) {
				$messages = array("Unsupported or unknown command: {$statement->getCommand()} {$statement->getData()}");

				$stacktrace = array();
				foreach ($stack as $object) {
					$stacktrace[] = (string) $object;
				}
				$messages[] = join(", \n", $stacktrace);

				throw new \SwaggerGen\StatementException(join('. ', $messages), 0, null, $statement);
			}
		}

		return $swagger;
	}

	/**
	 * Get Swagger 2.x output
	 *
	 * @param string[] $files
	 * @param string[] $dirs
	 * @param string $format
	 * @return type
	 * @throws \SwaggerGen\Exception
	 */
	public function getSwagger($files, $dirs = array(), $format = self::FORMAT_ARRAY)
	{
		$dirs = array_merge($this->dirs, $dirs);

		$statements = array();
		foreach ($files as $file) {
			switch (pathinfo($file, PATHINFO_EXTENSION)) {
				case 'php':
					$fileStatements = $this->parsePhpFile($file, $dirs);
					break;

				case 'txt':
					$fileStatements = $this->parseTextFile($file, $dirs);
					break;

				default:
					$fileStatements = $this->parseText($file, $dirs);
					break;
			}

			$statements = array_merge($statements, $fileStatements);
		}

		$output = $this->parseStatements($this->host, $this->basePath, $statements)->toArray();

		switch ($format) {
			case self::FORMAT_JSON:
				$output = json_encode($output);
				break;

			case self::FORMAT_JSON_PRETTY:
				$flags = (defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 0); // Since PHP 5.4.0
				$output = json_encode($output, $flags);
				break;

			case self::FORMAT_YAML:
				if (!function_exists('yaml_emit')) {
					throw new Exception('YAML extension not installed.');
				}
				array_walk_recursive($output, function(&$value) {
					if (is_object($value)) {
						$value = (array) $value;
					}
				});
				$output = yaml_emit($output, YAML_UTF8_ENCODING, YAML_LN_BREAK);
				break;
		}

		return $output;
	}

}


1			<?php
2
3			namespace SwaggerGen;
4
5			/**
6			* Main class of SwaggerGen which serves as a facade for the entire library.
7			*
8			* Copyright (c) 2014-2015 Martijn van der Lee
9			*
10			* Permission is hereby granted, free of charge, to any person obtaining a copy
11			* of this software and associated documentation files (the "Software"), to deal
12			* in the Software without restriction, including without limitation the rights
13			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14			* copies of the Software, and to permit persons to whom the Software is
15			* furnished to do so, subject to the following conditions:
16			*
17			* The above copyright notice and this permission notice shall be included in
18			* all copies or substantial portions of the Software.
19			*
20			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26			* THE SOFTWARE.
27			*
28			* @package SwaggerGen
29			* @author Martijn van der Lee <[email protected]>
30			* @copyright 2014-2015 Martijn van der Lee
31			* @license https://opensource.org/licenses/MIT MIT
32			*/
33			class SwaggerGen
34			{
35
36			const FORMAT_ARRAY = '';
37			const FORMAT_JSON = 'json';
38			const FORMAT_JSON_PRETTY = 'json+';
39			const FORMAT_YAML = 'yaml';
40
41			private $host;
42			private $basePath;
43			private $dirs = array();
44			private $defines = array();
45
46			/**
47			* @var TypeRegistry
48			*/
49			private $typeRegistry = null;
50
51			/**
52			* Create a new SwaggerGen instance
53			*
54			* @param string $host
55			* @param string $basePath
56			* @param string[] $dirs
57			* @param TypeRegistry $typeRegistry
58			*/
59			public function __construct($host = '', $basePath = '', $dirs = array(), $typeRegistry = null)
60			{
61			$this->host = $host;
62			$this->basePath = $basePath;
63			$this->dirs = $dirs;
64			$this->typeRegistry = $typeRegistry;
65			}
66
67			/**
68			* Set a new type registry
69			*
70			* @param TypeRegistry $typeRegistry
71			*/
72			public function setTypeRegistry($typeRegistry = null)
73			{
74			$this->typeRegistry = $typeRegistry;
75			}
76
77			public function define($name, $value = 1)
78			{
79			$this->defines[$name] = $value;
80			}
81
82			public function undefine($name)
83			{
84			unset($this->defines[$name]);
85			}
86
87			/**
88			* @param string $file
89			* @param string[] $dirs
90			* @return Php\Entity\Statement[]
91			*/
92			private function parsePhpFile($file, $dirs)
93			{
94			$Parser = new Parser\Php\Parser();
95			return $Parser->parse($file, $dirs, $this->defines);
96			}
97
98			/**
99			* @param string $file
100			* @param string[] $dirs
101			* @return Php\Entity\Statement[]
102			*/
103			private function parseTextFile($file, $dirs)
104			{
105			$Parser = new Parser\Text\Parser();
106			return $Parser->parse($file, $dirs, $this->defines);
107			}
108
109			/**
110			* @param string $text
111			* @param string[] $dirs
112			* @return Php\Entity\Statement[]
113			*/
114			private function parseText($text, $dirs)
115			{
116			$Parser = new Parser\Text\Parser();
117			return $Parser->parseText($text, $dirs, $this->defines);
118			}
119
120			/**
121			* Creates Swagger\Swagger object and populates it with statements
122			*
123			* This effectively converts the linear list of statements into parse-tree
124			* like structure, performing some checks (like rejecting unknown
125			* subcommands) during the process. Returned Swagger\Swagger object is
126			* ready for serialization with {@see Swagger\Swagger::toArray}
127			*
128			* @param string $host
129			* @param string $basePath
130			* @param Statement[] $statements
131			* @return Swagger\Swagger
132			* @throws StatementException
133			*/
134			public function parseStatements($host, $basePath, $statements)
135			{
136			$swagger = new Swagger\Swagger($host, $basePath, $this->typeRegistry);
137
138			$stack = array($swagger); /* @var Swagger\AbstractObject[] $stack */
139			foreach ($statements as $statement) {
140			try {
141			$top = end($stack);
142
143			do {
144			$result = $top->handleCommand($statement->getCommand(), $statement->getData());
145
146			if ($result) {
147			if ($result !== $top) {
148			// Remove all similar classes from array first!
149			$classname = get_class($result);
150			$stack = array_filter($stack, function($class) use($classname) {
151			return !(is_a($class, $classname));
152			});
153
154			$stack[] = $result;
155			}
156			} else {
157			$top = prev($stack);
158			}
159			} while (!$result && $top);
160			} catch (\SwaggerGen\Exception $e) {
161			throw new \SwaggerGen\StatementException($e->getMessage(), $e->getCode(), $e, $statement);
			0 ignored issues – show Documentation introduced 2016-10-15 16:19 UTC by Report Bug Copy Issue Report `$e` is of type `object<SwaggerGen\Exception>`, but the function expects a `object<Throwable>\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
162			}
163
164			if (!$result && !$top) {
165			$messages = array("Unsupported or unknown command: {$statement->getCommand()} {$statement->getData()}");
166
167			$stacktrace = array();
168			foreach ($stack as $object) {
169			$stacktrace[] = (string) $object;
170			}
171			$messages[] = join(", \n", $stacktrace);
172
173			throw new \SwaggerGen\StatementException(join('. ', $messages), 0, null, $statement);
174			}
175			}
176
177			return $swagger;
178			}
179
180			/**
181			* Get Swagger 2.x output
182			*
183			* @param string[] $files
184			* @param string[] $dirs
185			* @param string $format
186			* @return type
187			* @throws \SwaggerGen\Exception
188			*/
189			public function getSwagger($files, $dirs = array(), $format = self::FORMAT_ARRAY)
190			{
191			$dirs = array_merge($this->dirs, $dirs);
192
193			$statements = array();
194			foreach ($files as $file) {
195			switch (pathinfo($file, PATHINFO_EXTENSION)) {
196			case 'php':
197			$fileStatements = $this->parsePhpFile($file, $dirs);
198			break;
199
200			case 'txt':
201			$fileStatements = $this->parseTextFile($file, $dirs);
202			break;
203
204			default:
205			$fileStatements = $this->parseText($file, $dirs);
206			break;
207			}
208
209			$statements = array_merge($statements, $fileStatements);
210			}
211
212			$output = $this->parseStatements($this->host, $this->basePath, $statements)->toArray();
213
214			switch ($format) {
215			case self::FORMAT_JSON:
216			$output = json_encode($output);
217			break;
218
219			case self::FORMAT_JSON_PRETTY:
220			$flags = (defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 0); // Since PHP 5.4.0
221			$output = json_encode($output, $flags);
222			break;
223
224			case self::FORMAT_YAML:
225			if (!function_exists('yaml_emit')) {
226			throw new Exception('YAML extension not installed.');
227			}
228			array_walk_recursive($output, function(&$value) {
229			if (is_object($value)) {
230			$value = (array) $value;
231			}
232			});
233			$output = yaml_emit($output, YAML_UTF8_ENCODING, YAML_LN_BREAK);
234			break;
235			}
236
237			return $output;
238			}
239
240			}
241

vanderlee / PHPSwaggerGen

Branch — master (ffa084)

SwaggerGen::define() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like