vanderlee / PHPSwaggerGen

SwaggerGen/Swagger/Swagger.php

Indentation +374 added lines, -374 removed lines

@@ -16,379 +16,379 @@
 class Swagger extends AbstractDocumentableObject
 {
 
-    private $swagger = '2.0';
-    private $host;
-    private $basePath;
-
-    /**
-     * @var TypeRegistry
-     */
-    private $typeRegistry;
-
-    /**
-     * @var Info $Info
-     */
-    private $info;
-    private $schemes = [];
-    private $consumes = [];
-    private $produces = [];
-
-    /**
-     * @var Path[] $Paths
-     */
-    private $paths = [];
-
-    /**
-     * @var Schema[] $definitions
-     */
-    private $definitions = [];
-
-    /**
-     * @var IParameter[] $parameters
-     */
-    private $parameters = [];
-
-    /**
-     * @var Response[] $responses
-     */
-    private $responses = [];
-
-    /**
-     * @var Tag[] $Tags
-     */
-    private $tags = [];
-
-    /**
-     * Default tag for new endpoints/operations. Set by the api command.
-     *
-     * @var Tag
-     */
-    private $defaultTag = null;
-    private $securityDefinitions = [];
-    private $security = [];
-
-    /**
-     * @param string $host
-     * @param string $basePath
-     * @param TypeRegistry $typeRegistry
-     */
-    public function __construct($host = null, $basePath = null, $typeRegistry = null)
-    {
-        parent::__construct();
-
-        $this->host = $host;
-        $this->basePath = $basePath;
-
-        $this->info = new Info($this);
-
-        $this->typeRegistry = $typeRegistry ?: new TypeRegistry;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected function getSwagger(): Swagger
-    {
-        return $this;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected function getTypeRegistry(): TypeRegistry
-    {
-        return $this->typeRegistry;
-    }
-
-    /**
-     * Return all consumes
-     *
-     * @return array
-     * @todo Deprecate in favour of a getConsume($name);
-     */
-    public function getConsumes(): array
-    {
-        return $this->consumes;
-    }
-
-    /**
-     * Return the named security if it exists, otherwise return FALSE
-     *
-     * @param string $name
-     *
-     * @return boolean|SecurityScheme
-     */
-    public function getSecurity($name)
-    {
-        return $this->securityDefinitions[$name] ?? false;
-    }
-
-    /**
-     * @param string $command
-     * @param string $data
-     *
-     * @return AbstractObject|boolean
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     */
-    public function handleCommand($command, $data = null)
-    {
-        switch (strtolower($command)) {
-            // pass to Info
-            case 'title':
-            case 'description':
-            case 'version':
-            case 'terms': // alias
-            case 'tos': // alias
-            case 'termsofservice':
-            case 'contact':
-            case 'license':
-                return $this->info->handleCommand($command, $data);
-
-            // string[]
-            case 'scheme':
-            case 'schemes':
-                $this->schemes = array_unique(array_merge($this->schemes, self::wordSplit($data)));
-
-                return $this;
-
-            // MIME[]
-            case 'consume':
-            case 'consumes':
-                $this->consumes = array_merge($this->consumes, self::translateMimeTypes(self::wordSplit($data)));
-
-                return $this;
-
-            case 'produce':
-            case 'produces':
-                $this->produces = array_merge($this->produces, self::translateMimeTypes(self::wordSplit($data)));
-
-                return $this;
-
-            case 'model':
-            case 'model!':
-            case 'definition':
-            case 'definition!':
-                $name = self::wordShift($data);
-                if (empty($name)) {
-                    throw new Exception('Missing definition name');
-                }
-                $typeDef = self::wordShift($data);
-                if (empty($typeDef)) {
-                    $typeDef = 'object';
-                }
-
-                $definition = new Schema($this, $typeDef);
-                if (substr($command, -1) === '!') {
-                    $definition->setReadOnly();
-                }
-                $this->definitions[$name] = $definition;
-
-                return $definition;
-
-            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 'response':
-                $name = self::wordShift($data);
-                $definition = self::wordShift($data);
-                $description = $data;
-                if (empty($description)) {
-                    throw new Exception('Response definition missing description');
-                }
-                $Response = new Response($this, $name, $definition === 'null' ? null : $definition, $description);
-                $this->responses[$name] = $Response;
-
-                return $Response;
-
-            case 'api': // alias
-            case 'tag':
-                $tagname = self::wordShift($data);
-                if (empty($tagname)) {
-                    throw new Exception('Missing tag name');
-                }
-
-                $Tag = null;
-                foreach ($this->tags as $T) {
-                    if ($T->getName() === $tagname) {
-                        $Tag = $T;
-                        break;
-                    }
-                }
-                if (!$Tag) {
-                    $Tag = new Tag($this, $tagname, $data);
-                    $this->tags[] = $Tag;
-                }
-
-                // backwards compatibility
-                if ($command === 'api') {
-                    $this->defaultTag = $Tag;
-                }
-
-                return $Tag;
-
-            case 'endpoint':
-                $path = self::wordShift($data);
-                if (false === $path) {
-                    $path = '/';
-                } else if ($path[0] !== '/') {
-                    $path = '/' . $path;
-                }
-
-                $Tag = null;
-                if (($tagname = self::wordShift($data)) !== false) {
-                    foreach ($this->tags as $T) {
-                        if (strtolower($T->getName()) === strtolower($tagname)) {
-                            $Tag = $T;
-                            break;
-                        }
-                    }
-                    if (!$Tag) {
-                        $Tag = new Tag($this, $tagname, $data);
-                        $this->tags[] = $Tag;
-                    }
-                }
-
-                if (!isset($this->paths[$path])) {
-                    $this->paths[$path] = new Path($this, $Tag ?: $this->defaultTag);
-                }
-
-                return $this->paths[$path];
-
-            case 'security':
-                $name = self::wordShift($data);
-                if (empty($name)) {
-                    throw new Exception('Missing security name');
-                }
-                $type = self::wordShift($data);
-                if (empty($type)) {
-                    throw new Exception('Missing security type');
-                }
-                $SecurityScheme = new SecurityScheme($this, $type, $data);
-                $this->securityDefinitions[$name] = $SecurityScheme;
-
-                return $SecurityScheme;
-
-            case 'require':
-                $name = self::wordShift($data);
-                if (empty($name)) {
-                    throw new Exception('Missing require name');
-                }
-                $scopes = self::wordSplit($data);
-                sort($scopes);
-                $this->security[] = [
-                    $name => empty($scopes) ? [] : $scopes,
-                ];
-
-                return $this;
-        }
-
-        return parent::handleCommand($command, $data);
-    }
-
-    /**
-     * @inheritDoc
-     * @throws Exception
-     * @throws Exception
-     */
-    public function toArray(): array
-    {
-        if (empty($this->paths)) {
-            throw new Exception('No path defined');
-        }
-
-        $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 => $scopes) {
-                if (!isset($this->securityDefinitions[$name])) {
-                    throw new Exception('Required security scheme not defined: \'' . $name . '\'');
-                }
-            }
-        }
-
-        return self::arrayFilterNull(array_merge([
-            'swagger' => $this->swagger,
-            'info' => $this->info->toArray(),
-            'host' => empty($this->host) ? null : $this->host,
-            'basePath' => empty($this->basePath) ? null : $this->basePath,
-            'consumes' => $consumes,
-            'produces' => $produces,
-            'schemes' => $schemes,
-            'paths' => self::objectsToArray($this->paths),
-            'definitions' => self::objectsToArray($this->definitions),
-            'parameters' => self::objectsToArray($this->parameters),
-            'responses' => self::objectsToArray($this->responses),
-            'securityDefinitions' => self::objectsToArray($this->securityDefinitions),
-            'security' => $this->security,
-            'tags' => self::objectsToArray($this->tags),
-        ], parent::toArray()));
-    }
-
-    public function __toString()
-    {
-        return __CLASS__;
-    }
-
-    /**
-     * Check if an operation with the given id exists.
-     *
-     * @param string $operationId
-     *
-     * @return boolean
-     */
-    public function hasOperationId($operationId)
-    {
-        foreach ($this->paths as $path) {
-            if ($path->hasOperationId($operationId)) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Check if a definition with the given name exists
-     *
-     * @param string $name
-     *
-     * @return boolean
-     */
-    public function hasDefinition($name)
-    {
-        return isset($this->definitions[$name]);
-    }
+	private $swagger = '2.0';
+	private $host;
+	private $basePath;
+
+	/**
+	 * @var TypeRegistry
+	 */
+	private $typeRegistry;
+
+	/**
+	 * @var Info $Info
+	 */
+	private $info;
+	private $schemes = [];
+	private $consumes = [];
+	private $produces = [];
+
+	/**
+	 * @var Path[] $Paths
+	 */
+	private $paths = [];
+
+	/**
+	 * @var Schema[] $definitions
+	 */
+	private $definitions = [];
+
+	/**
+	 * @var IParameter[] $parameters
+	 */
+	private $parameters = [];
+
+	/**
+	 * @var Response[] $responses
+	 */
+	private $responses = [];
+
+	/**
+	 * @var Tag[] $Tags
+	 */
+	private $tags = [];
+
+	/**
+	 * Default tag for new endpoints/operations. Set by the api command.
+	 *
+	 * @var Tag
+	 */
+	private $defaultTag = null;
+	private $securityDefinitions = [];
+	private $security = [];
+
+	/**
+	 * @param string $host
+	 * @param string $basePath
+	 * @param TypeRegistry $typeRegistry
+	 */
+	public function __construct($host = null, $basePath = null, $typeRegistry = null)
+	{
+		parent::__construct();
+
+		$this->host = $host;
+		$this->basePath = $basePath;
+
+		$this->info = new Info($this);
+
+		$this->typeRegistry = $typeRegistry ?: new TypeRegistry;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	protected function getSwagger(): Swagger
+	{
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	protected function getTypeRegistry(): TypeRegistry
+	{
+		return $this->typeRegistry;
+	}
+
+	/**
+	 * Return all consumes
+	 *
+	 * @return array
+	 * @todo Deprecate in favour of a getConsume($name);
+	 */
+	public function getConsumes(): array
+	{
+		return $this->consumes;
+	}
+
+	/**
+	 * Return the named security if it exists, otherwise return FALSE
+	 *
+	 * @param string $name
+	 *
+	 * @return boolean|SecurityScheme
+	 */
+	public function getSecurity($name)
+	{
+		return $this->securityDefinitions[$name] ?? false;
+	}
+
+	/**
+	 * @param string $command
+	 * @param string $data
+	 *
+	 * @return AbstractObject|boolean
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	public function handleCommand($command, $data = null)
+	{
+		switch (strtolower($command)) {
+			// pass to Info
+			case 'title':
+			case 'description':
+			case 'version':
+			case 'terms': // alias
+			case 'tos': // alias
+			case 'termsofservice':
+			case 'contact':
+			case 'license':
+				return $this->info->handleCommand($command, $data);
+
+			// string[]
+			case 'scheme':
+			case 'schemes':
+				$this->schemes = array_unique(array_merge($this->schemes, self::wordSplit($data)));
+
+				return $this;
+
+			// MIME[]
+			case 'consume':
+			case 'consumes':
+				$this->consumes = array_merge($this->consumes, self::translateMimeTypes(self::wordSplit($data)));
+
+				return $this;
+
+			case 'produce':
+			case 'produces':
+				$this->produces = array_merge($this->produces, self::translateMimeTypes(self::wordSplit($data)));
+
+				return $this;
+
+			case 'model':
+			case 'model!':
+			case 'definition':
+			case 'definition!':
+				$name = self::wordShift($data);
+				if (empty($name)) {
+					throw new Exception('Missing definition name');
+				}
+				$typeDef = self::wordShift($data);
+				if (empty($typeDef)) {
+					$typeDef = 'object';
+				}
+
+				$definition = new Schema($this, $typeDef);
+				if (substr($command, -1) === '!') {
+					$definition->setReadOnly();
+				}
+				$this->definitions[$name] = $definition;
+
+				return $definition;
+
+			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 'response':
+				$name = self::wordShift($data);
+				$definition = self::wordShift($data);
+				$description = $data;
+				if (empty($description)) {
+					throw new Exception('Response definition missing description');
+				}
+				$Response = new Response($this, $name, $definition === 'null' ? null : $definition, $description);
+				$this->responses[$name] = $Response;
+
+				return $Response;
+
+			case 'api': // alias
+			case 'tag':
+				$tagname = self::wordShift($data);
+				if (empty($tagname)) {
+					throw new Exception('Missing tag name');
+				}
+
+				$Tag = null;
+				foreach ($this->tags as $T) {
+					if ($T->getName() === $tagname) {
+						$Tag = $T;
+						break;
+					}
+				}
+				if (!$Tag) {
+					$Tag = new Tag($this, $tagname, $data);
+					$this->tags[] = $Tag;
+				}
+
+				// backwards compatibility
+				if ($command === 'api') {
+					$this->defaultTag = $Tag;
+				}
+
+				return $Tag;
+
+			case 'endpoint':
+				$path = self::wordShift($data);
+				if (false === $path) {
+					$path = '/';
+				} else if ($path[0] !== '/') {
+					$path = '/' . $path;
+				}
+
+				$Tag = null;
+				if (($tagname = self::wordShift($data)) !== false) {
+					foreach ($this->tags as $T) {
+						if (strtolower($T->getName()) === strtolower($tagname)) {
+							$Tag = $T;
+							break;
+						}
+					}
+					if (!$Tag) {
+						$Tag = new Tag($this, $tagname, $data);
+						$this->tags[] = $Tag;
+					}
+				}
+
+				if (!isset($this->paths[$path])) {
+					$this->paths[$path] = new Path($this, $Tag ?: $this->defaultTag);
+				}
+
+				return $this->paths[$path];
+
+			case 'security':
+				$name = self::wordShift($data);
+				if (empty($name)) {
+					throw new Exception('Missing security name');
+				}
+				$type = self::wordShift($data);
+				if (empty($type)) {
+					throw new Exception('Missing security type');
+				}
+				$SecurityScheme = new SecurityScheme($this, $type, $data);
+				$this->securityDefinitions[$name] = $SecurityScheme;
+
+				return $SecurityScheme;
+
+			case 'require':
+				$name = self::wordShift($data);
+				if (empty($name)) {
+					throw new Exception('Missing require name');
+				}
+				$scopes = self::wordSplit($data);
+				sort($scopes);
+				$this->security[] = [
+					$name => empty($scopes) ? [] : $scopes,
+				];
+
+				return $this;
+		}
+
+		return parent::handleCommand($command, $data);
+	}
+
+	/**
+	 * @inheritDoc
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	public function toArray(): array
+	{
+		if (empty($this->paths)) {
+			throw new Exception('No path defined');
+		}
+
+		$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 => $scopes) {
+				if (!isset($this->securityDefinitions[$name])) {
+					throw new Exception('Required security scheme not defined: \'' . $name . '\'');
+				}
+			}
+		}
+
+		return self::arrayFilterNull(array_merge([
+			'swagger' => $this->swagger,
+			'info' => $this->info->toArray(),
+			'host' => empty($this->host) ? null : $this->host,
+			'basePath' => empty($this->basePath) ? null : $this->basePath,
+			'consumes' => $consumes,
+			'produces' => $produces,
+			'schemes' => $schemes,
+			'paths' => self::objectsToArray($this->paths),
+			'definitions' => self::objectsToArray($this->definitions),
+			'parameters' => self::objectsToArray($this->parameters),
+			'responses' => self::objectsToArray($this->responses),
+			'securityDefinitions' => self::objectsToArray($this->securityDefinitions),
+			'security' => $this->security,
+			'tags' => self::objectsToArray($this->tags),
+		], parent::toArray()));
+	}
+
+	public function __toString()
+	{
+		return __CLASS__;
+	}
+
+	/**
+	 * Check if an operation with the given id exists.
+	 *
+	 * @param string $operationId
+	 *
+	 * @return boolean
+	 */
+	public function hasOperationId($operationId)
+	{
+		foreach ($this->paths as $path) {
+			if ($path->hasOperationId($operationId)) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Check if a definition with the given name exists
+	 *
+	 * @param string $name
+	 *
+	 * @return boolean
+	 */
+	public function hasDefinition($name)
+	{
+		return isset($this->definitions[$name]);
+	}
 
 }

SwaggerGen/SwaggerGen.php

Indentation +210 added lines, -210 removed lines

@@ -38,215 +38,215 @@
 class SwaggerGen
 {
 
-    const FORMAT_ARRAY = '';
-    const FORMAT_JSON = 'json';
-    const FORMAT_JSON_PRETTY = 'json+';
-    const FORMAT_YAML = 'yaml';
-
-    private $host;
-    private $basePath;
-    private $dirs;
-    private $defines = [];
-
-    /**
-     * @var TypeRegistry
-     */
-    private $typeRegistry;
-
-    /**
-     * Create a new SwaggerGen instance
-     *
-     * @param string $host
-     * @param string $basePath
-     * @param string[] $dirs
-     * @param TypeRegistry $typeRegistry
-     */
-    public function __construct($host = '', $basePath = '', $dirs = [], $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;
-    }
-
-    /**
-     * @param string $name
-     */
-    public function define($name, $value = 1)
-    {
-        $this->defines[$name] = $value;
-    }
-
-    /**
-     * @param string $name
-     */
-    public function undefine($name)
-    {
-        unset($this->defines[$name]);
-    }
-
-    /**
-     * @param string $file
-     * @param string[] $dirs
-     * @return Statement[]
-     * @throws Exception
-     */
-    private function parsePhpFile(string $file, array $dirs): array
-    {
-        return (new Parser())->parse($file, $dirs, $this->defines);
-    }
-
-    /**
-     * @param string $file
-     * @param string[] $dirs
-     * @return Statement[]
-     */
-    private function parseTextFile($file, $dirs)
-    {
-        return (new TextParser())->parse($file, $dirs, $this->defines);
-    }
-
-    /**
-     * @param string $text
-     * @param string[] $dirs
-     * @return Statement[]
-     */
-    private function parseText(string $text, array $dirs): array
-    {
-        return (new TextParser())->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
-     * @throws StatementException
-     */
-    public function parseStatements($host, $basePath, $statements)
-    {
-        $swagger = new Swagger($host, $basePath, $this->typeRegistry);
-
-        $stack = array($swagger);
-        /* @var 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, static function ($class) use ($classname) {
-                                return !(is_a($class, $classname));
-                            });
-
-                            $stack[] = $result;
-                        }
-                    } else {
-                        $top = prev($stack);
-                    }
-                } while (!$result && $top);
-            } catch (Exception $e) {
-                throw new StatementException($e->getMessage(), $e->getCode(), $e, $statement);
-            }
-
-            if (!$result && !$top) {
-                $messages = array("Unsupported or unknown command: {$statement->getCommand()} {$statement->getData()}");
-
-                $stacktrace = [];
-                foreach ($stack as $object) {
-                    $stacktrace[] = (string)$object;
-                }
-                $messages[] = implode(', ' . PHP_EOL, $stacktrace);
-
-                throw new StatementException(implode('. ', $messages), 0, null, $statement);
-            }
-        }
-
-        return $swagger;
-    }
-
-    /**
-     * Get Swagger 2.x output
-     *
-     * @param string[] $files
-     * @param string[] $dirs
-     * @param string $format
-     * @return array|false|string
-     * @throws Exception
-     * @throws StatementException
-     */
-    public function getSwagger(array $files, array $dirs = [], string $format = self::FORMAT_ARRAY)
-    {
-        $dirs = array_merge($this->dirs, $dirs);
-
-        $statements = [];
-        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[] = $fileStatements;
-        }
-        $statements = array_merge(...$statements);
-
-        $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, static function (&$value) {
-                    if (is_object($value)) {
-                        $value = (array)$value;
-                    }
-                });
-                $output = yaml_emit($output, YAML_UTF8_ENCODING, YAML_LN_BREAK);
-                break;
-        }
-
-        return $output;
-    }
+	const FORMAT_ARRAY = '';
+	const FORMAT_JSON = 'json';
+	const FORMAT_JSON_PRETTY = 'json+';
+	const FORMAT_YAML = 'yaml';
+
+	private $host;
+	private $basePath;
+	private $dirs;
+	private $defines = [];
+
+	/**
+	 * @var TypeRegistry
+	 */
+	private $typeRegistry;
+
+	/**
+	 * Create a new SwaggerGen instance
+	 *
+	 * @param string $host
+	 * @param string $basePath
+	 * @param string[] $dirs
+	 * @param TypeRegistry $typeRegistry
+	 */
+	public function __construct($host = '', $basePath = '', $dirs = [], $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;
+	}
+
+	/**
+	 * @param string $name
+	 */
+	public function define($name, $value = 1)
+	{
+		$this->defines[$name] = $value;
+	}
+
+	/**
+	 * @param string $name
+	 */
+	public function undefine($name)
+	{
+		unset($this->defines[$name]);
+	}
+
+	/**
+	 * @param string $file
+	 * @param string[] $dirs
+	 * @return Statement[]
+	 * @throws Exception
+	 */
+	private function parsePhpFile(string $file, array $dirs): array
+	{
+		return (new Parser())->parse($file, $dirs, $this->defines);
+	}
+
+	/**
+	 * @param string $file
+	 * @param string[] $dirs
+	 * @return Statement[]
+	 */
+	private function parseTextFile($file, $dirs)
+	{
+		return (new TextParser())->parse($file, $dirs, $this->defines);
+	}
+
+	/**
+	 * @param string $text
+	 * @param string[] $dirs
+	 * @return Statement[]
+	 */
+	private function parseText(string $text, array $dirs): array
+	{
+		return (new TextParser())->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
+	 * @throws StatementException
+	 */
+	public function parseStatements($host, $basePath, $statements)
+	{
+		$swagger = new Swagger($host, $basePath, $this->typeRegistry);
+
+		$stack = array($swagger);
+		/* @var 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, static function ($class) use ($classname) {
+								return !(is_a($class, $classname));
+							});
+
+							$stack[] = $result;
+						}
+					} else {
+						$top = prev($stack);
+					}
+				} while (!$result && $top);
+			} catch (Exception $e) {
+				throw new StatementException($e->getMessage(), $e->getCode(), $e, $statement);
+			}
+
+			if (!$result && !$top) {
+				$messages = array("Unsupported or unknown command: {$statement->getCommand()} {$statement->getData()}");
+
+				$stacktrace = [];
+				foreach ($stack as $object) {
+					$stacktrace[] = (string)$object;
+				}
+				$messages[] = implode(', ' . PHP_EOL, $stacktrace);
+
+				throw new StatementException(implode('. ', $messages), 0, null, $statement);
+			}
+		}
+
+		return $swagger;
+	}
+
+	/**
+	 * Get Swagger 2.x output
+	 *
+	 * @param string[] $files
+	 * @param string[] $dirs
+	 * @param string $format
+	 * @return array|false|string
+	 * @throws Exception
+	 * @throws StatementException
+	 */
+	public function getSwagger(array $files, array $dirs = [], string $format = self::FORMAT_ARRAY)
+	{
+		$dirs = array_merge($this->dirs, $dirs);
+
+		$statements = [];
+		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[] = $fileStatements;
+		}
+		$statements = array_merge(...$statements);
+
+		$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, static function (&$value) {
+					if (is_object($value)) {
+						$value = (array)$value;
+					}
+				});
+				$output = yaml_emit($output, YAML_UTF8_ENCODING, YAML_LN_BREAK);
+				break;
+		}
+
+		return $output;
+	}
 
 }

Spacing +4 added lines, -4 removed lines

@@ -157,7 +157,7 @@ 
                         if ($result !== $top) {
                             // Remove all similar classes from array first!
                             $classname = get_class($result);
-                            $stack = array_filter($stack, static function ($class) use ($classname) {
+                            $stack = array_filter($stack, static function($class) use ($classname) {
                                 return !(is_a($class, $classname));
                             });
 
@@ -176,7 +176,7 @@ 
 
                 $stacktrace = [];
                 foreach ($stack as $object) {
-                    $stacktrace[] = (string)$object;
+                    $stacktrace[] = (string) $object;
                 }
                 $messages[] = implode(', ' . PHP_EOL, $stacktrace);
 
@@ -237,9 +237,9 @@ 
                 if (!function_exists('yaml_emit')) {
                     throw new Exception('YAML extension not installed.');
                 }
-                array_walk_recursive($output, static function (&$value) {
+                array_walk_recursive($output, static function(&$value) {
                     if (is_object($value)) {
-                        $value = (array)$value;
+                        $value = (array) $value;
                     }
                 });
                 $output = yaml_emit($output, YAML_UTF8_ENCODING, YAML_LN_BREAK);

SwaggerGen/Parser/Php/Preprocessor.php

Indentation +57 added lines, -57 removed lines

@@ -18,72 +18,72 @@
 class Preprocessor extends AbstractPreprocessor
 {
 
-    private $prefix = 'rest';
+	private $prefix = 'rest';
 
-    public function __construct($prefix = null)
-    {
-        parent::__construct();
-        if (!empty($prefix)) {
-            $this->prefix = $prefix;
-        }
-    }
+	public function __construct($prefix = null)
+	{
+		parent::__construct();
+		if (!empty($prefix)) {
+			$this->prefix = $prefix;
+		}
+	}
 
-    public function getPrefix()
-    {
-        return $this->prefix;
-    }
+	public function getPrefix()
+	{
+		return $this->prefix;
+	}
 
-    public function setPrefix($prefix)
-    {
-        $this->prefix = $prefix;
-    }
+	public function setPrefix($prefix)
+	{
+		$this->prefix = $prefix;
+	}
 
-    protected function parseContent($content)
-    {
-        $pattern = '/@' . preg_quote($this->getPrefix(), '/') . '\\\\([a-z]+)\\s*(.*)$/';
+	protected function parseContent($content)
+	{
+		$pattern = '/@' . preg_quote($this->getPrefix(), '/') . '\\\\([a-z]+)\\s*(.*)$/';
 
-        $output_file = '';
+		$output_file = '';
 
-        foreach (token_get_all($content) as $token) {
-            $output = '';
+		foreach (token_get_all($content) as $token) {
+			$output = '';
 
-            if (is_array($token)) {
-                switch ($token[0]) {
-                    case T_DOC_COMMENT:
-                    case T_COMMENT:
-                        foreach (preg_split('/(\\R)/m', $token[1], -1, PREG_SPLIT_DELIM_CAPTURE) as $index => $line) {
-                            if ($index % 2) {
-                                $output .= $line;
-                            } else {
-                                $match = array();
-                                if (preg_match($pattern, $line, $match) === 1) {
-                                    if (!$this->handle($match[1], $match[2]) && $this->getState()) {
-                                        $output .= $line;
-                                    } else {
-                                        $output .= str_replace('@' . $this->getPrefix() . '\\', '@!' . $this->getPrefix() . '\\', $line);
-                                    }
-                                } else {
-                                    $output .= $line;
-                                }
-                            }
-                        }
-                        break;
+			if (is_array($token)) {
+				switch ($token[0]) {
+					case T_DOC_COMMENT:
+					case T_COMMENT:
+						foreach (preg_split('/(\\R)/m', $token[1], -1, PREG_SPLIT_DELIM_CAPTURE) as $index => $line) {
+							if ($index % 2) {
+								$output .= $line;
+							} else {
+								$match = array();
+								if (preg_match($pattern, $line, $match) === 1) {
+									if (!$this->handle($match[1], $match[2]) && $this->getState()) {
+										$output .= $line;
+									} else {
+										$output .= str_replace('@' . $this->getPrefix() . '\\', '@!' . $this->getPrefix() . '\\', $line);
+									}
+								} else {
+									$output .= $line;
+								}
+							}
+						}
+						break;
 
-                    default:
-                        $output .= $token[1];
-                }
-            } else {
-                $output .= $token;
-            }
+					default:
+						$output .= $token[1];
+				}
+			} else {
+				$output .= $token;
+			}
 
-            if ($this->getState()) {
-                $output_file .= $output;
-            } else {
-                $output_file .= '/* ' . $output . ' */';
-            }
-        }
+			if ($this->getState()) {
+				$output_file .= $output;
+			} else {
+				$output_file .= '/* ' . $output . ' */';
+			}
+		}
 
-        return $output_file;
-    }
+		return $output_file;
+	}
 
 }

SwaggerGen/Parser/Php/Entity/ParserFunction.php

Indentation +62 added lines, -62 removed lines

@@ -16,77 +16,77 @@
 class ParserFunction extends AbstractEntity
 {
 
-    public $name = null;
-    private $lastStatements = null;
+	public $name = null;
+	private $lastStatements = null;
 
-    public function __construct(Parser $Parser, &$tokens, $Statements)
-    {
-        if ($Statements) {
-            $this->Statements = array_merge($this->Statements, $Statements);
-        }
+	public function __construct(Parser $Parser, &$tokens, $Statements)
+	{
+		if ($Statements) {
+			$this->Statements = array_merge($this->Statements, $Statements);
+		}
 
-        $depth = 0;
+		$depth = 0;
 
-        $token = current($tokens);
-        while ($token) {
-            switch ($token[0]) {
-                case T_STRING:
-                    if (empty($this->name)) {
-                        $this->name = $token[1];
-                    }
-                    break;
+		$token = current($tokens);
+		while ($token) {
+			switch ($token[0]) {
+				case T_STRING:
+					if (empty($this->name)) {
+						$this->name = $token[1];
+					}
+					break;
 
-                case '{':
-                case T_CURLY_OPEN:
-                case T_DOLLAR_OPEN_CURLY_BRACES:
-                case T_STRING_VARNAME:
-                    ++$depth;
-                    break;
+				case '{':
+				case T_CURLY_OPEN:
+				case T_DOLLAR_OPEN_CURLY_BRACES:
+				case T_STRING_VARNAME:
+					++$depth;
+					break;
 
-                case '}':
-                    --$depth;
-                    if ($depth == 0) {
-                        if ($this->lastStatements) {
-                            $this->Statements = array_merge($this->Statements, $this->lastStatements);
-                            $this->lastStatements = null;
-                        }
-                        return;
-                    }
-                    break;
+				case '}':
+					--$depth;
+					if ($depth == 0) {
+						if ($this->lastStatements) {
+							$this->Statements = array_merge($this->Statements, $this->lastStatements);
+							$this->lastStatements = null;
+						}
+						return;
+					}
+					break;
 
-                case T_COMMENT:
-                    if ($this->lastStatements) {
-                        $this->Statements = array_merge($this->Statements, $this->lastStatements);
-                        $this->lastStatements = null;
-                    }
-                    $Statements = $Parser->tokenToStatements($token);
-                    $Parser->queueClassesFromComments($Statements);
-                    $this->Statements = array_merge($this->Statements, $Statements);
-                    break;
+				case T_COMMENT:
+					if ($this->lastStatements) {
+						$this->Statements = array_merge($this->Statements, $this->lastStatements);
+						$this->lastStatements = null;
+					}
+					$Statements = $Parser->tokenToStatements($token);
+					$Parser->queueClassesFromComments($Statements);
+					$this->Statements = array_merge($this->Statements, $Statements);
+					break;
 
-                case T_DOC_COMMENT:
-                    if ($this->lastStatements) {
-                        $this->Statements = array_merge($this->Statements, $this->lastStatements);
-                    }
-                    $Statements = $Parser->tokenToStatements($token);
-                    $Parser->queueClassesFromComments($Statements);
-                    $this->lastStatements = $Statements;
-                    break;
-            }
+				case T_DOC_COMMENT:
+					if ($this->lastStatements) {
+						$this->Statements = array_merge($this->Statements, $this->lastStatements);
+					}
+					$Statements = $Parser->tokenToStatements($token);
+					$Parser->queueClassesFromComments($Statements);
+					$this->lastStatements = $Statements;
+					break;
+			}
 
-            $token = next($tokens);
-        }
+			$token = next($tokens);
+		}
 
-        if ($this->lastStatements) {
-            $this->Statements = array_merge($this->Statements, $this->lastStatements);
-            $this->lastStatements = null;
-        }
-    }
+		if ($this->lastStatements) {
+			$this->Statements = array_merge($this->Statements, $this->lastStatements);
+			$this->lastStatements = null;
+		}
+	}
 
-    public function getStatements(): array
-    {
-        // inherit
-        return $this->Statements;
-    }
+	public function getStatements(): array
+	{
+		// inherit
+		return $this->Statements;
+	}
 
 }

SwaggerGen/Parser/Php/Entity/AbstractEntity.php

Indentation +25 added lines, -25 removed lines

@@ -15,30 +15,30 @@
 class AbstractEntity
 {
 
-    /**
-     * @var Statement[]
-     */
-    public $Statements = array();
-
-    /**
-     * Returns true if a statement with the specified command exists.
-     * @param string $command
-     * @return boolean
-     */
-    public function hasCommand($command): bool
-    {
-        foreach ($this->Statements as $Statement) {
-            if ($Statement->getCommand() === $command) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    public function getStatements(): array
-    {
-        return $this->Statements;
-    }
+	/**
+	 * @var Statement[]
+	 */
+	public $Statements = array();
+
+	/**
+	 * Returns true if a statement with the specified command exists.
+	 * @param string $command
+	 * @return boolean
+	 */
+	public function hasCommand($command): bool
+	{
+		foreach ($this->Statements as $Statement) {
+			if ($Statement->getCommand() === $command) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	public function getStatements(): array
+	{
+		return $this->Statements;
+	}
 
 }

SwaggerGen/Parser/Php/Parser.php

Indentation +364 added lines, -364 removed lines

@@ -20,374 +20,374 @@
 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)
-    {
-        list($comment, $commentLineNumber) = $token;
-        $commentLines = [];
-
-        $match = [];
-        if (preg_match('~^/\*\*?\s*(.*)\s*\*\/$~sm', $comment, $match) === 1) {
-            $lines = explode("\n", $match[0]);
-            foreach ($lines as $line) {
-                if ((preg_match('~^\s*\*?\s*(.*?)\s*$~', $line, $match) === 1)
-                    && !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) {
-                list($command, $data) = $match;
-                $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;
-                }
-
-                if (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)
-                    && !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)
+	{
+		list($comment, $commentLineNumber) = $token;
+		$commentLines = [];
+
+		$match = [];
+		if (preg_match('~^/\*\*?\s*(.*)\s*\*\/$~sm', $comment, $match) === 1) {
+			$lines = explode("\n", $match[0]);
+			foreach ($lines as $line) {
+				if ((preg_match('~^\s*\*?\s*(.*?)\s*$~', $line, $match) === 1)
+					&& !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) {
+				list($command, $data) = $match;
+				$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;
+				}
+
+				if (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)
+					&& !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;
+	}
 
 }