vanderlee / PHPSwaggerGen

SwaggerGen/Swagger/Operation.php

Indentation +225 added lines, -225 removed lines

@@ -16,230 +16,230 @@
 class Operation extends AbstractDocumentableObject
 {
 
-    private $tags = array();
-    private $summary;
-    private $description;
-    private $consumes = array();
-    private $produces = array();
-
-    /**
-     * @var IParameter[]
-     */
-    private $parameters = array();
-    private $responses = array();
-    private $schemes = array();
-    private $deprecated = false;
-    private $security = array();
-
-    /**
-     * @var string
-     */
-    private $operationId = null;
-
-    public function getConsumes(): array
-    {
-        return $this->consumes;
-    }
-
-    /**
-     * @param string $summary
-     */
-    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 AbstractObject|boolean
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     */
-    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 Exception("Invalid error code: '$code'");
-                }
-                $description = $data;
-                $Error = new Error($this, $reasoncode, $description);
-                $this->responses[$reasoncode] = $Error;
-                return $Error;
-
-            case 'errors':
-                foreach (self::wordSplit($data) as $code) {
-                    $reasoncode = Response::getCode($code);
-                    if ($reasoncode === null) {
-                        throw new 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;
-
-            case 'body':
-            case 'body?':
-                $parameter = new BodyParameter($this, $data, substr($command, -1) !== '?');
-                $this->parameters[$parameter->getName()] = $parameter;
-                return $parameter;
-
-            case 'param':
-            case 'parameter':
-                $parameter = new ParameterReference($this, $data);
-                $this->parameters[$parameter->getName()] = $parameter;
-                return $this;
-
-            case 'response':
-                $code = self::wordShift($data);
-                $reasoncode = Response::getCode($code);
-                if ($reasoncode === null) {
-                    $reference = $code;
-                    $code = self::wordShift($data);
-                    $reasoncode = Response::getCode($code);
-                    if ($reasoncode === null) {
-                        throw new Exception("Invalid response code: '$reference'");
-                    }
-                    $this->responses[$reasoncode] = new ResponseReference($this, $reference);
-                    return $this;
-                } else {
-                    $definition = self::wordShift($data);
-                    $description = $data;
-                    $Response = new Response($this, $reasoncode, $definition, $description);
-                    $this->responses[$reasoncode] = $Response;
-                    return $Response;
-                }
-
-            case 'require':
-                $name = self::wordShift($data);
-                if (empty($name)) {
-                    throw new 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 Exception("Duplicate operation id '{$operationId}'");
-                }
-                $this->operationId = $operationId;
-                return $this;
-        }
-
-        return parent::handleCommand($command, $data);
-    }
-
-    /**
-     * @throws Exception
-     */
-    public function toArray()
-    {
-        if (empty($this->responses)) {
-            throw new 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 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;
-    }
+	private $tags = array();
+	private $summary;
+	private $description;
+	private $consumes = array();
+	private $produces = array();
+
+	/**
+	 * @var IParameter[]
+	 */
+	private $parameters = array();
+	private $responses = array();
+	private $schemes = array();
+	private $deprecated = false;
+	private $security = array();
+
+	/**
+	 * @var string
+	 */
+	private $operationId = null;
+
+	public function getConsumes(): array
+	{
+		return $this->consumes;
+	}
+
+	/**
+	 * @param string $summary
+	 */
+	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 AbstractObject|boolean
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	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 Exception("Invalid error code: '$code'");
+				}
+				$description = $data;
+				$Error = new Error($this, $reasoncode, $description);
+				$this->responses[$reasoncode] = $Error;
+				return $Error;
+
+			case 'errors':
+				foreach (self::wordSplit($data) as $code) {
+					$reasoncode = Response::getCode($code);
+					if ($reasoncode === null) {
+						throw new 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;
+
+			case 'body':
+			case 'body?':
+				$parameter = new BodyParameter($this, $data, substr($command, -1) !== '?');
+				$this->parameters[$parameter->getName()] = $parameter;
+				return $parameter;
+
+			case 'param':
+			case 'parameter':
+				$parameter = new ParameterReference($this, $data);
+				$this->parameters[$parameter->getName()] = $parameter;
+				return $this;
+
+			case 'response':
+				$code = self::wordShift($data);
+				$reasoncode = Response::getCode($code);
+				if ($reasoncode === null) {
+					$reference = $code;
+					$code = self::wordShift($data);
+					$reasoncode = Response::getCode($code);
+					if ($reasoncode === null) {
+						throw new Exception("Invalid response code: '$reference'");
+					}
+					$this->responses[$reasoncode] = new ResponseReference($this, $reference);
+					return $this;
+				} else {
+					$definition = self::wordShift($data);
+					$description = $data;
+					$Response = new Response($this, $reasoncode, $definition, $description);
+					$this->responses[$reasoncode] = $Response;
+					return $Response;
+				}
+
+			case 'require':
+				$name = self::wordShift($data);
+				if (empty($name)) {
+					throw new 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 Exception("Duplicate operation id '{$operationId}'");
+				}
+				$this->operationId = $operationId;
+				return $this;
+		}
+
+		return parent::handleCommand($command, $data);
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public function toArray()
+	{
+		if (empty($this->responses)) {
+			throw new 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 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;
+	}
 
 }

SwaggerGen/Swagger/Path.php

Indentation +97 added lines, -97 removed lines

@@ -16,102 +16,102 @@
 class Path extends AbstractObject
 {
 
-    private static $methods = array(
-        'get',
-        'put',
-        'post',
-        'delete',
-        'options',
-        'head',
-        'patch',
-    );
-
-    /**
-     * @var Operation[] $operation
-     */
-    private $operations = array();
-
-    /**
-     * @var Tag|null $tag ;
-     */
-    private $tag;
-
-    public function __construct(AbstractObject $parent, ?Tag $Tag = null)
-    {
-        parent::__construct($parent);
-        $this->tag = $Tag;
-    }
-
-    /**
-     * @param string $command
-     * @param string $data
-     * @return AbstractObject|boolean
-     * @throws Exception
-     */
-    public function handleCommand($command, $data = null)
-    {
-        switch (strtolower($command)) {
-            case 'method': // alias
-            case 'operation':
-                $method = strtolower(self::wordShift($data));
-
-                if (!in_array($method, self::$methods)) {
-                    throw new Exception('Unrecognized operation method \'' . $method . '\'');
-                }
-
-                if (isset($this->operations[$method])) {
-                    $Operation = $this->operations[$method];
-                } else {
-                    $summary = $data;
-                    $Operation = new Operation($this, $summary, $this->tag);
-                    $this->operations[$method] = $Operation;
-                }
-
-                return $Operation;
-
-            case 'description':
-                if ($this->tag) {
-                    return $this->tag->handleCommand($command, $data);
-                }
-                break;
-        }
-
-        return parent::handleCommand($command, $data);
-    }
-
-    public function toArray()
-    {
-        $methods = self::$methods;
-        uksort($this->operations, function ($a, $b) use ($methods) {
-            return array_search($a, $methods) - array_search($b, $methods);
-        });
-
-        return self::arrayFilterNull(array_merge(
-            self::objectsToArray($this->operations)
-            , parent::toArray()));
-    }
-
-    public function __toString()
-    {
-        end($this->operations);
-        return __CLASS__ . ' ' . key($this->operations);
-    }
-
-    /**
-     * Check if an operation with the given id is registered to this Path.
-     *
-     * @param string $operationId
-     * @return boolean
-     */
-    public function hasOperationId($operationId)
-    {
-        foreach ($this->operations as $operation) {
-            if ($operation->getId() === $operationId) {
-                return true;
-            }
-        }
-
-        return false;
-    }
+	private static $methods = array(
+		'get',
+		'put',
+		'post',
+		'delete',
+		'options',
+		'head',
+		'patch',
+	);
+
+	/**
+	 * @var Operation[] $operation
+	 */
+	private $operations = array();
+
+	/**
+	 * @var Tag|null $tag ;
+	 */
+	private $tag;
+
+	public function __construct(AbstractObject $parent, ?Tag $Tag = null)
+	{
+		parent::__construct($parent);
+		$this->tag = $Tag;
+	}
+
+	/**
+	 * @param string $command
+	 * @param string $data
+	 * @return AbstractObject|boolean
+	 * @throws Exception
+	 */
+	public function handleCommand($command, $data = null)
+	{
+		switch (strtolower($command)) {
+			case 'method': // alias
+			case 'operation':
+				$method = strtolower(self::wordShift($data));
+
+				if (!in_array($method, self::$methods)) {
+					throw new Exception('Unrecognized operation method \'' . $method . '\'');
+				}
+
+				if (isset($this->operations[$method])) {
+					$Operation = $this->operations[$method];
+				} else {
+					$summary = $data;
+					$Operation = new Operation($this, $summary, $this->tag);
+					$this->operations[$method] = $Operation;
+				}
+
+				return $Operation;
+
+			case 'description':
+				if ($this->tag) {
+					return $this->tag->handleCommand($command, $data);
+				}
+				break;
+		}
+
+		return parent::handleCommand($command, $data);
+	}
+
+	public function toArray()
+	{
+		$methods = self::$methods;
+		uksort($this->operations, function ($a, $b) use ($methods) {
+			return array_search($a, $methods) - array_search($b, $methods);
+		});
+
+		return self::arrayFilterNull(array_merge(
+			self::objectsToArray($this->operations)
+			, parent::toArray()));
+	}
+
+	public function __toString()
+	{
+		end($this->operations);
+		return __CLASS__ . ' ' . key($this->operations);
+	}
+
+	/**
+	 * Check if an operation with the given id is registered to this Path.
+	 *
+	 * @param string $operationId
+	 * @return boolean
+	 */
+	public function hasOperationId($operationId)
+	{
+		foreach ($this->operations as $operation) {
+			if ($operation->getId() === $operationId) {
+				return true;
+			}
+		}
+
+		return false;
+	}
 
 }

SwaggerGen/Swagger/AbstractObject.php

Indentation +157 added lines, -157 removed lines

@@ -16,162 +16,162 @@
 abstract class AbstractObject
 {
 
-    private static $mime_types = array(
-        'fileform' => 'multipart/form-data',
-        'form' => 'application/x-www-form-urlencoded',
-        'json' => 'application/json',
-        'text' => 'text/plain',
-        'utf8' => 'text/plain; charset=utf-8',
-        'yml' => 'application/x-yaml',
-        'yaml' => 'application/x-yaml',
-        'php' => 'text/x-php',
-        'xml' => 'text/xml',
-    );
-
-    /**
-     * @var AbstractObject
-     */
-    private $parent;
-
-    /**
-     * Map of extensions and their (trimmed) values
-     * @var string[]
-     */
-    private $extensions = array();
-
-    public function __construct(?AbstractObject $parent = null)
-    {
-        $this->parent = $parent;
-    }
-
-    /**
-     * @return AbstractObject
-     */
-    protected function getParent()
-    {
-        return $this->parent;
-    }
-
-    protected function getParentClass($classname)
-    {
-        if (is_a($this, $classname)) {
-            return $this;
-        }
-        return $this->parent->getParentClass($classname);
-    }
-
-    /**
-     * @return Swagger
-     */
-    protected function getSwagger()
-    {
-        return $this->parent->getSwagger();
-    }
-
-    /**
-     * @return TypeRegistry
-     */
-    protected function getTypeRegistry()
-    {
-        return $this->parent->getTypeRegistry();
-    }
-
-    /**
-     * @param string $command
-     * @param string $data
-     * @return AbstractObject|boolean
-     */
-    public function handleCommand($command, $data = null)
-    {
-        if (strtolower(substr($command, 0, 2)) === 'x-') {
-            $this->extensions[$command] = empty($data) ? $data : trim($data);
-            return $this;
-        }
-
-        return false;
-    }
-
-    /**
-     * @return array
-     */
-    public function toArray()
-    {
-        return $this->extensions;
-    }
-
-    /**
-     * Translate consumes from shortcuts
-     * @param String[] $mimeTypes
-     * @return String[]
-     */
-    protected static function translateMimeTypes($mimeTypes)
-    {
-        foreach ($mimeTypes as &$mimeType) {
-            if (isset(self::$mime_types[strtolower($mimeType)])) {
-                $mimeType = self::$mime_types[strtolower($mimeType)];
-            }
-        }
-
-        return $mimeTypes;
-    }
-
-    /**
-     * Trim whitespace from a multibyte string
-     * @param string $string
-     * @return string
-     */
-    public static function trim($string)
-    {
-        return mb_ereg_replace('^\s*([\s\S]*?)\s*$', '\1', $string);
-    }
-
-    /**
-     * Filter all items from an array where the value is either null or an
-     * empty array.
-     * @param array $array
-     * @return array
-     */
-    public static function arrayFilterNull($array)
-    {
-        return array_filter($array, function ($value) {
-            return $value !== null && $value !== array();
-        });
-    }
-
-    /**
-     * Recursively call toArray() on all objects to return an array
-     * @param array $array
-     * @return array
-     */
-    public static function objectsToArray($array)
-    {
-        return array_map(function (AbstractObject $item) {
-            return $item->toArray();
-        }, $array);
-    }
-
-    /**
-     * Shifts the first word off a text line and returns it
-     * @param string $data
-     * @return string|bool Either the first word or false if no more words available
-     */
-    public static function wordShift(&$data)
-    {
-        if (preg_match('~^\s*(\S+)\s*(.*)$~s', $data, $matches) === 1) {
-            $data = $matches[2];
-            return $matches[1];
-        }
-        return false;
-    }
-
-    /**
-     * Splits a text line in all it's words
-     * @param string $data
-     * @return string[]
-     */
-    public static function wordSplit($data): array
-    {
-        return array_values(preg_grep('~\S~', preg_split('~\s+~', $data)));
-    }
+	private static $mime_types = array(
+		'fileform' => 'multipart/form-data',
+		'form' => 'application/x-www-form-urlencoded',
+		'json' => 'application/json',
+		'text' => 'text/plain',
+		'utf8' => 'text/plain; charset=utf-8',
+		'yml' => 'application/x-yaml',
+		'yaml' => 'application/x-yaml',
+		'php' => 'text/x-php',
+		'xml' => 'text/xml',
+	);
+
+	/**
+	 * @var AbstractObject
+	 */
+	private $parent;
+
+	/**
+	 * Map of extensions and their (trimmed) values
+	 * @var string[]
+	 */
+	private $extensions = array();
+
+	public function __construct(?AbstractObject $parent = null)
+	{
+		$this->parent = $parent;
+	}
+
+	/**
+	 * @return AbstractObject
+	 */
+	protected function getParent()
+	{
+		return $this->parent;
+	}
+
+	protected function getParentClass($classname)
+	{
+		if (is_a($this, $classname)) {
+			return $this;
+		}
+		return $this->parent->getParentClass($classname);
+	}
+
+	/**
+	 * @return Swagger
+	 */
+	protected function getSwagger()
+	{
+		return $this->parent->getSwagger();
+	}
+
+	/**
+	 * @return TypeRegistry
+	 */
+	protected function getTypeRegistry()
+	{
+		return $this->parent->getTypeRegistry();
+	}
+
+	/**
+	 * @param string $command
+	 * @param string $data
+	 * @return AbstractObject|boolean
+	 */
+	public function handleCommand($command, $data = null)
+	{
+		if (strtolower(substr($command, 0, 2)) === 'x-') {
+			$this->extensions[$command] = empty($data) ? $data : trim($data);
+			return $this;
+		}
+
+		return false;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function toArray()
+	{
+		return $this->extensions;
+	}
+
+	/**
+	 * Translate consumes from shortcuts
+	 * @param String[] $mimeTypes
+	 * @return String[]
+	 */
+	protected static function translateMimeTypes($mimeTypes)
+	{
+		foreach ($mimeTypes as &$mimeType) {
+			if (isset(self::$mime_types[strtolower($mimeType)])) {
+				$mimeType = self::$mime_types[strtolower($mimeType)];
+			}
+		}
+
+		return $mimeTypes;
+	}
+
+	/**
+	 * Trim whitespace from a multibyte string
+	 * @param string $string
+	 * @return string
+	 */
+	public static function trim($string)
+	{
+		return mb_ereg_replace('^\s*([\s\S]*?)\s*$', '\1', $string);
+	}
+
+	/**
+	 * Filter all items from an array where the value is either null or an
+	 * empty array.
+	 * @param array $array
+	 * @return array
+	 */
+	public static function arrayFilterNull($array)
+	{
+		return array_filter($array, function ($value) {
+			return $value !== null && $value !== array();
+		});
+	}
+
+	/**
+	 * Recursively call toArray() on all objects to return an array
+	 * @param array $array
+	 * @return array
+	 */
+	public static function objectsToArray($array)
+	{
+		return array_map(function (AbstractObject $item) {
+			return $item->toArray();
+		}, $array);
+	}
+
+	/**
+	 * Shifts the first word off a text line and returns it
+	 * @param string $data
+	 * @return string|bool Either the first word or false if no more words available
+	 */
+	public static function wordShift(&$data)
+	{
+		if (preg_match('~^\s*(\S+)\s*(.*)$~s', $data, $matches) === 1) {
+			$data = $matches[2];
+			return $matches[1];
+		}
+		return false;
+	}
+
+	/**
+	 * Splits a text line in all it's words
+	 * @param string $data
+	 * @return string[]
+	 */
+	public static function wordSplit($data): array
+	{
+		return array_values(preg_grep('~\S~', preg_split('~\s+~', $data)));
+	}
 
 }

SwaggerGen/Parser/Php/Parser.php

Indentation +366 added lines, -366 removed lines

@@ -20,376 +20,376 @@
 class Parser extends Entity\AbstractEntity implements IParser
 {
 
-    const COMMENT_TAG = 'rest';
+	const COMMENT_TAG = 'rest';
 
 // transient
 
-    private $current_file = null;
-    private $files_queued = [];
-    private $files_done = [];
-    private $dirs = [];
+	private $current_file = null;
+	private $files_queued = [];
+	private $files_done = [];
+	private $dirs = [];
 // States
 
-    /** @var Statement[] */
-    public $statements = [];
-
-    /**
-     * @var Statement[]|null
-     */
-    private $lastStatements = [];
-
-    /**
-     * @var Entity\ParserClass[]
-     */
-    public $Classes = [];
-
-    /**
-     * @var Entity\ParserFunction[]
-     */
-    public $Functions = [];
-
-    /**
-     * @var AbstractPreprocessor
-     */
-    private $Preprocessor;
-
-    /**
-     * Directories available to all parse calls
-     *
-     * @var string[]
-     */
-    protected $common_dirs = [];
-
-    public function __construct(array $dirs = [])
-    {
-        foreach ($dirs as $dir) {
-            $this->common_dirs[] = realpath($dir);
-        }
-
-        $this->Preprocessor = new Preprocessor(self::COMMENT_TAG);
-    }
-
-    public function addDirs(array $dirs)
-    {
-        foreach ($dirs as $dir) {
-            $this->common_dirs[] = realpath($dir);
-        }
-    }
-
-    private function extractStatements()
-    {
-        // Core comments
-        $Statements = $this->statements;
-
-        // Functions
-        foreach ($this->Functions as $Function) {
-            if ($Function->hasCommand('method')) {
-                $Statements = array_merge($Statements, $Function->Statements);
-            }
-        }
-
-        // Classes
-        foreach ($this->Classes as $Class) {
-            $Statements = array_merge($Statements, $Class->Statements);
-            foreach ($Class->Methods as $Method) {
-                if ($Method->hasCommand('method')) {
-                    $Statements = array_merge($Statements, $Method->Statements);
-                }
-            }
-        }
-
-        return $Statements;
-    }
-
-    /**
-     * @throws Exception
-     */
-    public function parse($file, array $dirs = [], array $defines = [])
-    {
-        $this->dirs = $this->common_dirs;
-        foreach ($dirs as $dir) {
-            $this->dirs[] = realpath($dir);
-        }
-
-        $this->parseFiles(array($file), $defines);
-
-        // Inherit classes
-        foreach ($this->Classes as $Class) {
-            $this->inherit($Class);
-        }
-
-        // Expand functions with used and seen functions/methods.
-        foreach ($this->Classes as $Class) {
-            foreach ($Class->Methods as $Method) {
-                $Method->Statements = $this->expand($Method->Statements, $Class);
-            }
-        }
-
-        return $this->extractStatements();
-    }
-
-    /**
-     * Convert a T_*_COMMENT string to an array of Statements
-     * @param array $token
-     * @return Statement[]
-     */
-    public function tokenToStatements($token)
-    {
-        $comment = $token[1];
-        $commentLineNumber = $token[2];
-        $commentLines = [];
-
-        $match = [];
-        if (preg_match('~^/\*\*?\s*(.*)\s*\*\/$~sm', $comment, $match) === 1) {
-            $lines = preg_split('~\n~', $match[0]);
-            foreach ($lines as $line) {
-                if (preg_match('~^\s*\*?\s*(.*?)\s*$~', $line, $match) === 1) {
-                    if (!empty($match[1])) {
-                        $commentLines[] = trim($match[1]);
-                    }
-                }
-            }
-        } elseif (preg_match('~^//\s*(.*)$~', $comment, $match) === 1) {
-            $commentLines[] = trim($match[1]);
-        }
-        // to commands
-        $match = [];
-        $command = null;
-        $data = '';
-        $commandLineNumber = 0;
-        $statements = [];
-        foreach ($commentLines as $lineNumber => $line) {
-            // If new @-command, store any old and start new
-            if ($command !== null && chr(ord($line)) === '@') {
-                $statements[] = new Statement($command, $data, $this->current_file, $commentLineNumber + $commandLineNumber);
-                $command = null;
-                $data = '';
-            }
-
-            if (preg_match('~^@' . preg_quote(self::COMMENT_TAG) . '\\\\([a-z][-a-z]*[?!]?)\\s*(.*)$~', $line, $match) === 1) {
-                $command = $match[1];
-                $data = $match[2];
-                $commandLineNumber = $lineNumber;
-            } elseif ($command !== null) {
-                if ($lineNumber < count($commentLines) - 1) {
-                    $data .= ' ' . $line;
-                } else {
-                    $data .= preg_replace('~\s*\**\/\s*$~', '', $line);
-                }
-            }
-        }
-
-        if ($command !== null) {
-            $statements[] = new Statement($command, $data, $this->current_file, $commentLineNumber + $commandLineNumber);
-        }
-
-        return $statements;
-    }
-
-    public function queueClass($classname)
-    {
-        foreach ($this->dirs as $dir) {
-            $paths = array(
-                $dir . DIRECTORY_SEPARATOR . $classname . '.php',
-                $dir . DIRECTORY_SEPARATOR . $classname . '.class.php',
-            );
-
-            foreach ($paths as $path) {
-                $realpath = realpath($path);
-                if (in_array($realpath, $this->files_done)) {
-                    return;
-                } elseif (is_file($realpath)) {
-                    $this->files_queued[] = $realpath;
-                    return;
-                }
-            }
-        }
-
-        // assume it's a class;
-    }
-
-    /**
-     * Add to the queue any classes based on the commands.
-     * @param Statement[] $Statements
-     */
-    public function queueClassesFromComments(array $Statements)
-    {
-        foreach ($Statements as $Statement) {
-            if (in_array($Statement->getCommand(), array('uses', 'see'))) {
-                $match = [];
-                if (preg_match('~^(\w+)(::|->)?(\w+)?(?:\(\))?$~', $Statement->getData(), $match) === 1) {
-                    if (!in_array($match[1], array('self', '$this'))) {
-                        $this->queueClass($match[1]);
-                    }
-                }
-            }
-        }
-    }
-
-    private function parseTokens($source)
-    {
-        $mode = null;
-        $namespace = '';
-
-        $tokens = token_get_all($source);
-        $token = reset($tokens);
-        while ($token) {
-            switch ($token[0]) {
-                case T_NAMESPACE:
-                    $mode = T_NAMESPACE;
-                    break;
-
-                case T_NS_SEPARATOR:
-                case T_STRING:
-                    if ($mode === T_NAMESPACE) {
-                        $namespace .= $token[1];
-                    }
-                    break;
-
-                case ';':
-                    $mode = null;
-                    break;
-
-                case T_CLASS:
-                case T_INTERFACE:
-                    $Class = new Entity\ParserClass($this, $tokens, $this->lastStatements);
-                    $this->Classes[strtolower($Class->name)] = $Class;
-                    $this->lastStatements = null;
-                    break;
-
-                case T_FUNCTION:
-                    $Function = new Entity\ParserFunction($this, $tokens, $this->lastStatements);
-                    $this->Functions[strtolower($Function->name)] = $Function;
-                    $this->lastStatements = null;
-                    break;
-
-                case T_COMMENT:
-                    if ($this->lastStatements !== null) {
-                        $this->statements = array_merge($this->statements, $this->lastStatements);
-                        $this->lastStatements = null;
-                    }
-                    $Statements = $this->tokenToStatements($token);
-                    $this->queueClassesFromComments($Statements);
-                    $this->statements = array_merge($this->statements, $Statements);
-                    break;
-
-                case T_DOC_COMMENT:
-                    if ($this->lastStatements !== null) {
-                        $this->statements = array_merge($this->statements, $this->lastStatements);
-                    }
-                    $Statements = $this->tokenToStatements($token);
-                    $this->queueClassesFromComments($Statements);
-                    $this->lastStatements = $Statements;
-                    break;
-            }
-
-            $token = next($tokens);
-        }
-    }
-
-    private function parseFiles(array $files, array $defines = [])
-    {
-        $this->files_queued = $files;
-
-        $index = 0;
-        while (($file = array_shift($this->files_queued)) !== null) {
-            $file = realpath($file);
-
-            // @todo Test if this works
-            if (in_array($file, $this->files_done)) {
-                continue;
-            }
-
-            $this->current_file = $file;
-            $this->files_done[] = $file;
-            ++$index;
-
-            $this->Preprocessor->resetDefines();
-            $this->Preprocessor->addDefines($defines);
-            $source = $this->Preprocessor->preprocessFile($file);
-
-            $this->parseTokens($source);
-
-            if ($this->lastStatements !== null) {
-                $this->statements = array_merge($this->statements, $this->lastStatements);
-                $this->lastStatements = null;
-            }
-        }
-
-        $this->current_file = null;
-    }
-
-    /**
-     * Inherit the statements
-     * @param ParserClass $Class
-     */
-    private function inherit(Entity\ParserClass $Class)
-    {
-        $inherits = array_merge(array($Class->extends), $Class->implements);
-        while (($inherit = array_shift($inherits)) !== null) {
-            if (isset($this->Classes[strtolower($inherit)])) {
-                $inheritedClass = $this->Classes[strtolower($inherit)];
-                $this->inherit($inheritedClass);
-
-                foreach ($inheritedClass->Methods as $name => $Method) {
-                    if (!isset($Class->Methods[$name])) {
-                        $Class->Methods[$name] = $Method;
-                    }
-                }
-            }
-        }
-    }
-
-    /**
-     * Expands a set of comments with comments of methods referred to by rest\uses statements.
-     *
-     * @param Statement[] $Statements
-     * @return Statement[]
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     */
-    private function expand(array $Statements, ?ParserClass $Self = null)
-    {
-        $output = [];
-
-        $match = [];
-        foreach ($Statements as $Statement) {
-            if (in_array($Statement->getCommand(), array('uses', 'see'))) {
-                if (preg_match('/^((?:\\w+)|\$this)(?:(::|->)(\\w+))?(?:\\(\\))?$/', strtolower($Statement->getData()), $match) === 1) {
-                    if (count($match) >= 3) {
-                        $Class = null;
-                        if (in_array($match[1], array('$this', 'self', 'static'))) {
-                            $Class = $Self;
-                        } elseif (isset($this->Classes[$match[1]])) {
-                            $Class = $this->Classes[$match[1]];
-                        }
-
-                        if ($Class) {
-                            if (isset($Class->Methods[$match[3]])) {
-                                $Method = $Class->Methods[$match[3]];
-                                $Method->Statements = $this->expand($Method->Statements, $Class);
-                                $output = array_merge($output, $Method->Statements);
-                            } else {
-                                throw new Exception("Method '{$match[3]}' for class '{$match[1]}' not found");
-                            }
-                        } else {
-                            throw new Exception("Class '{$match[1]}' not found");
-                        }
-                    } elseif (isset($this->Functions[$match[1]])) {
-                        $Function = $this->Functions[$match[1]];
-                        $Function->Statements = $this->expand($Function->Statements);
-                        $output = array_merge($output, $Function->Statements);
-                    } else {
-                        throw new Exception("Function '{$match[1]}' not found");
-                    }
-                }
-            } else {
-                $output[] = $Statement;
-            }
-        }
-
-        return $output;
-    }
+	/** @var Statement[] */
+	public $statements = [];
+
+	/**
+	 * @var Statement[]|null
+	 */
+	private $lastStatements = [];
+
+	/**
+	 * @var Entity\ParserClass[]
+	 */
+	public $Classes = [];
+
+	/**
+	 * @var Entity\ParserFunction[]
+	 */
+	public $Functions = [];
+
+	/**
+	 * @var AbstractPreprocessor
+	 */
+	private $Preprocessor;
+
+	/**
+	 * Directories available to all parse calls
+	 *
+	 * @var string[]
+	 */
+	protected $common_dirs = [];
+
+	public function __construct(array $dirs = [])
+	{
+		foreach ($dirs as $dir) {
+			$this->common_dirs[] = realpath($dir);
+		}
+
+		$this->Preprocessor = new Preprocessor(self::COMMENT_TAG);
+	}
+
+	public function addDirs(array $dirs)
+	{
+		foreach ($dirs as $dir) {
+			$this->common_dirs[] = realpath($dir);
+		}
+	}
+
+	private function extractStatements()
+	{
+		// Core comments
+		$Statements = $this->statements;
+
+		// Functions
+		foreach ($this->Functions as $Function) {
+			if ($Function->hasCommand('method')) {
+				$Statements = array_merge($Statements, $Function->Statements);
+			}
+		}
+
+		// Classes
+		foreach ($this->Classes as $Class) {
+			$Statements = array_merge($Statements, $Class->Statements);
+			foreach ($Class->Methods as $Method) {
+				if ($Method->hasCommand('method')) {
+					$Statements = array_merge($Statements, $Method->Statements);
+				}
+			}
+		}
+
+		return $Statements;
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public function parse($file, array $dirs = [], array $defines = [])
+	{
+		$this->dirs = $this->common_dirs;
+		foreach ($dirs as $dir) {
+			$this->dirs[] = realpath($dir);
+		}
+
+		$this->parseFiles(array($file), $defines);
+
+		// Inherit classes
+		foreach ($this->Classes as $Class) {
+			$this->inherit($Class);
+		}
+
+		// Expand functions with used and seen functions/methods.
+		foreach ($this->Classes as $Class) {
+			foreach ($Class->Methods as $Method) {
+				$Method->Statements = $this->expand($Method->Statements, $Class);
+			}
+		}
+
+		return $this->extractStatements();
+	}
+
+	/**
+	 * Convert a T_*_COMMENT string to an array of Statements
+	 * @param array $token
+	 * @return Statement[]
+	 */
+	public function tokenToStatements($token)
+	{
+		$comment = $token[1];
+		$commentLineNumber = $token[2];
+		$commentLines = [];
+
+		$match = [];
+		if (preg_match('~^/\*\*?\s*(.*)\s*\*\/$~sm', $comment, $match) === 1) {
+			$lines = preg_split('~\n~', $match[0]);
+			foreach ($lines as $line) {
+				if (preg_match('~^\s*\*?\s*(.*?)\s*$~', $line, $match) === 1) {
+					if (!empty($match[1])) {
+						$commentLines[] = trim($match[1]);
+					}
+				}
+			}
+		} elseif (preg_match('~^//\s*(.*)$~', $comment, $match) === 1) {
+			$commentLines[] = trim($match[1]);
+		}
+		// to commands
+		$match = [];
+		$command = null;
+		$data = '';
+		$commandLineNumber = 0;
+		$statements = [];
+		foreach ($commentLines as $lineNumber => $line) {
+			// If new @-command, store any old and start new
+			if ($command !== null && chr(ord($line)) === '@') {
+				$statements[] = new Statement($command, $data, $this->current_file, $commentLineNumber + $commandLineNumber);
+				$command = null;
+				$data = '';
+			}
+
+			if (preg_match('~^@' . preg_quote(self::COMMENT_TAG) . '\\\\([a-z][-a-z]*[?!]?)\\s*(.*)$~', $line, $match) === 1) {
+				$command = $match[1];
+				$data = $match[2];
+				$commandLineNumber = $lineNumber;
+			} elseif ($command !== null) {
+				if ($lineNumber < count($commentLines) - 1) {
+					$data .= ' ' . $line;
+				} else {
+					$data .= preg_replace('~\s*\**\/\s*$~', '', $line);
+				}
+			}
+		}
+
+		if ($command !== null) {
+			$statements[] = new Statement($command, $data, $this->current_file, $commentLineNumber + $commandLineNumber);
+		}
+
+		return $statements;
+	}
+
+	public function queueClass($classname)
+	{
+		foreach ($this->dirs as $dir) {
+			$paths = array(
+				$dir . DIRECTORY_SEPARATOR . $classname . '.php',
+				$dir . DIRECTORY_SEPARATOR . $classname . '.class.php',
+			);
+
+			foreach ($paths as $path) {
+				$realpath = realpath($path);
+				if (in_array($realpath, $this->files_done)) {
+					return;
+				} elseif (is_file($realpath)) {
+					$this->files_queued[] = $realpath;
+					return;
+				}
+			}
+		}
+
+		// assume it's a class;
+	}
+
+	/**
+	 * Add to the queue any classes based on the commands.
+	 * @param Statement[] $Statements
+	 */
+	public function queueClassesFromComments(array $Statements)
+	{
+		foreach ($Statements as $Statement) {
+			if (in_array($Statement->getCommand(), array('uses', 'see'))) {
+				$match = [];
+				if (preg_match('~^(\w+)(::|->)?(\w+)?(?:\(\))?$~', $Statement->getData(), $match) === 1) {
+					if (!in_array($match[1], array('self', '$this'))) {
+						$this->queueClass($match[1]);
+					}
+				}
+			}
+		}
+	}
+
+	private function parseTokens($source)
+	{
+		$mode = null;
+		$namespace = '';
+
+		$tokens = token_get_all($source);
+		$token = reset($tokens);
+		while ($token) {
+			switch ($token[0]) {
+				case T_NAMESPACE:
+					$mode = T_NAMESPACE;
+					break;
+
+				case T_NS_SEPARATOR:
+				case T_STRING:
+					if ($mode === T_NAMESPACE) {
+						$namespace .= $token[1];
+					}
+					break;
+
+				case ';':
+					$mode = null;
+					break;
+
+				case T_CLASS:
+				case T_INTERFACE:
+					$Class = new Entity\ParserClass($this, $tokens, $this->lastStatements);
+					$this->Classes[strtolower($Class->name)] = $Class;
+					$this->lastStatements = null;
+					break;
+
+				case T_FUNCTION:
+					$Function = new Entity\ParserFunction($this, $tokens, $this->lastStatements);
+					$this->Functions[strtolower($Function->name)] = $Function;
+					$this->lastStatements = null;
+					break;
+
+				case T_COMMENT:
+					if ($this->lastStatements !== null) {
+						$this->statements = array_merge($this->statements, $this->lastStatements);
+						$this->lastStatements = null;
+					}
+					$Statements = $this->tokenToStatements($token);
+					$this->queueClassesFromComments($Statements);
+					$this->statements = array_merge($this->statements, $Statements);
+					break;
+
+				case T_DOC_COMMENT:
+					if ($this->lastStatements !== null) {
+						$this->statements = array_merge($this->statements, $this->lastStatements);
+					}
+					$Statements = $this->tokenToStatements($token);
+					$this->queueClassesFromComments($Statements);
+					$this->lastStatements = $Statements;
+					break;
+			}
+
+			$token = next($tokens);
+		}
+	}
+
+	private function parseFiles(array $files, array $defines = [])
+	{
+		$this->files_queued = $files;
+
+		$index = 0;
+		while (($file = array_shift($this->files_queued)) !== null) {
+			$file = realpath($file);
+
+			// @todo Test if this works
+			if (in_array($file, $this->files_done)) {
+				continue;
+			}
+
+			$this->current_file = $file;
+			$this->files_done[] = $file;
+			++$index;
+
+			$this->Preprocessor->resetDefines();
+			$this->Preprocessor->addDefines($defines);
+			$source = $this->Preprocessor->preprocessFile($file);
+
+			$this->parseTokens($source);
+
+			if ($this->lastStatements !== null) {
+				$this->statements = array_merge($this->statements, $this->lastStatements);
+				$this->lastStatements = null;
+			}
+		}
+
+		$this->current_file = null;
+	}
+
+	/**
+	 * Inherit the statements
+	 * @param ParserClass $Class
+	 */
+	private function inherit(Entity\ParserClass $Class)
+	{
+		$inherits = array_merge(array($Class->extends), $Class->implements);
+		while (($inherit = array_shift($inherits)) !== null) {
+			if (isset($this->Classes[strtolower($inherit)])) {
+				$inheritedClass = $this->Classes[strtolower($inherit)];
+				$this->inherit($inheritedClass);
+
+				foreach ($inheritedClass->Methods as $name => $Method) {
+					if (!isset($Class->Methods[$name])) {
+						$Class->Methods[$name] = $Method;
+					}
+				}
+			}
+		}
+	}
+
+	/**
+	 * Expands a set of comments with comments of methods referred to by rest\uses statements.
+	 *
+	 * @param Statement[] $Statements
+	 * @return Statement[]
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	private function expand(array $Statements, ?ParserClass $Self = null)
+	{
+		$output = [];
+
+		$match = [];
+		foreach ($Statements as $Statement) {
+			if (in_array($Statement->getCommand(), array('uses', 'see'))) {
+				if (preg_match('/^((?:\\w+)|\$this)(?:(::|->)(\\w+))?(?:\\(\\))?$/', strtolower($Statement->getData()), $match) === 1) {
+					if (count($match) >= 3) {
+						$Class = null;
+						if (in_array($match[1], array('$this', 'self', 'static'))) {
+							$Class = $Self;
+						} elseif (isset($this->Classes[$match[1]])) {
+							$Class = $this->Classes[$match[1]];
+						}
+
+						if ($Class) {
+							if (isset($Class->Methods[$match[3]])) {
+								$Method = $Class->Methods[$match[3]];
+								$Method->Statements = $this->expand($Method->Statements, $Class);
+								$output = array_merge($output, $Method->Statements);
+							} else {
+								throw new Exception("Method '{$match[3]}' for class '{$match[1]}' not found");
+							}
+						} else {
+							throw new Exception("Class '{$match[1]}' not found");
+						}
+					} elseif (isset($this->Functions[$match[1]])) {
+						$Function = $this->Functions[$match[1]];
+						$Function->Statements = $this->expand($Function->Statements);
+						$output = array_merge($output, $Function->Statements);
+					} else {
+						throw new Exception("Function '{$match[1]}' not found");
+					}
+				}
+			} else {
+				$output[] = $Statement;
+			}
+		}
+
+		return $output;
+	}
 
 }