vanderlee / PHPSwaggerGen

SwaggerGen/Parser/AbstractPreprocessor.php

Indentation +119 added lines, -119 removed lines

@@ -13,123 +13,123 @@
 abstract class AbstractPreprocessor
 {
 
-    private $defines = [];
-    private $stack = [];
-
-    public function __construct()
-    {
-        $this->resetDefines();
-    }
-
-    public function resetDefines(): void
-    {
-        $this->defines = [];
-    }
-
-    public function addDefines(array $defines): void
-    {
-        $this->defines = array_merge($this->defines, $defines);
-    }
-
-    public function define($name, $value = 1): void
-    {
-        $this->defines[$name] = $value;
-    }
-
-    public function undefine($name): void
-    {
-        unset($this->defines[$name]);
-    }
-
-    public function preprocessFile($filename)
-    {
-        return $this->preprocess(file_get_contents($filename));
-    }
-
-    public function preprocess($content)
-    {
-        $this->stack = [];
-
-        return $this->parseContent($content);
-    }
-
-    abstract protected function parseContent($content);
-
-    protected function handle($command, $expression): bool
-    {
-        switch (strtolower($command)) {
-            case 'if':
-                $name = self::wordShift($expression);
-                $state = $this->getState();
-                if (empty($expression)) {
-                    $this->stack[] = $state && !empty($this->defines[$name]);
-                } else {
-                    $this->stack[] = $state && isset($this->defines[$name]) && $this->defines[$name] == $expression;
-                }
-                break;
-
-            case 'ifdef':
-                $this->stack[] = $this->getState() && isset($this->defines[$expression]);
-                break;
-
-            case 'ifndef':
-                $this->stack[] = $this->getState() && !isset($this->defines[$expression]);
-                break;
-
-            case 'else':
-                $state = $this->getState();
-                array_pop($this->stack);
-                $this->stack[] = !$state;
-                break;
-
-            case 'elif':
-                $name = self::wordShift($expression);
-                $state = $this->getState();
-                array_pop($this->stack);
-                if (empty($expression)) {
-                    $this->stack[] = !$state && !empty($this->defines[$name]);
-                } else {
-                    $this->stack[] = !$state && isset($this->defines[$name]) && $this->defines[$name] == $expression;
-                }
-                break;
-
-            case 'define':
-                $name = self::wordShift($expression);
-                $this->defines[$name] = $expression;
-                break;
-
-            case 'undef':
-                unset($this->defines[$expression]);
-                break;
-
-            case 'endif':
-                array_pop($this->stack);
-                break;
-
-            default:
-                return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * Get the first word from a string and remove it from the string.
-     *
-     * @param string $data
-     * @return boolean|string
-     */
-    private static function wordShift(&$data)
-    {
-        if (preg_match('~^(\S+)\s*(.*)$~', $data, $matches) === 1) {
-            $data = $matches[2];
-            return $matches[1];
-        }
-        return false;
-    }
-
-    protected function getState(): bool
-    {
-        return empty($this->stack) || end($this->stack);
-    }
+	private $defines = [];
+	private $stack = [];
+
+	public function __construct()
+	{
+		$this->resetDefines();
+	}
+
+	public function resetDefines(): void
+	{
+		$this->defines = [];
+	}
+
+	public function addDefines(array $defines): void
+	{
+		$this->defines = array_merge($this->defines, $defines);
+	}
+
+	public function define($name, $value = 1): void
+	{
+		$this->defines[$name] = $value;
+	}
+
+	public function undefine($name): void
+	{
+		unset($this->defines[$name]);
+	}
+
+	public function preprocessFile($filename)
+	{
+		return $this->preprocess(file_get_contents($filename));
+	}
+
+	public function preprocess($content)
+	{
+		$this->stack = [];
+
+		return $this->parseContent($content);
+	}
+
+	abstract protected function parseContent($content);
+
+	protected function handle($command, $expression): bool
+	{
+		switch (strtolower($command)) {
+			case 'if':
+				$name = self::wordShift($expression);
+				$state = $this->getState();
+				if (empty($expression)) {
+					$this->stack[] = $state && !empty($this->defines[$name]);
+				} else {
+					$this->stack[] = $state && isset($this->defines[$name]) && $this->defines[$name] == $expression;
+				}
+				break;
+
+			case 'ifdef':
+				$this->stack[] = $this->getState() && isset($this->defines[$expression]);
+				break;
+
+			case 'ifndef':
+				$this->stack[] = $this->getState() && !isset($this->defines[$expression]);
+				break;
+
+			case 'else':
+				$state = $this->getState();
+				array_pop($this->stack);
+				$this->stack[] = !$state;
+				break;
+
+			case 'elif':
+				$name = self::wordShift($expression);
+				$state = $this->getState();
+				array_pop($this->stack);
+				if (empty($expression)) {
+					$this->stack[] = !$state && !empty($this->defines[$name]);
+				} else {
+					$this->stack[] = !$state && isset($this->defines[$name]) && $this->defines[$name] == $expression;
+				}
+				break;
+
+			case 'define':
+				$name = self::wordShift($expression);
+				$this->defines[$name] = $expression;
+				break;
+
+			case 'undef':
+				unset($this->defines[$expression]);
+				break;
+
+			case 'endif':
+				array_pop($this->stack);
+				break;
+
+			default:
+				return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * Get the first word from a string and remove it from the string.
+	 *
+	 * @param string $data
+	 * @return boolean|string
+	 */
+	private static function wordShift(&$data)
+	{
+		if (preg_match('~^(\S+)\s*(.*)$~', $data, $matches) === 1) {
+			$data = $matches[2];
+			return $matches[1];
+		}
+		return false;
+	}
+
+	protected function getState(): bool
+	{
+		return empty($this->stack) || end($this->stack);
+	}
 }

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;
+		}
+	}
 
-    protected function parseContent($content): string
-    {
-        $pattern = '/@' . preg_quote($this->getPrefix(), '/') . '\\\\([a-z]+)\\s*(.*)$/';
+	protected function parseContent($content): string
+	{
+		$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 = [];
-                                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 = [];
+								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;
+	}
 
-    public function getPrefix()
-    {
-        return $this->prefix;
-    }
+	public function getPrefix()
+	{
+		return $this->prefix;
+	}
 
-    public function setPrefix($prefix): void
-    {
-        $this->prefix = $prefix;
-    }
+	public function setPrefix($prefix): void
+	{
+		$this->prefix = $prefix;
+	}
 
 }

SwaggerGen/Parser/Php/Parser.php

Indentation +357 added lines, -357 removed lines

@@ -22,365 +22,365 @@
 class Parser extends AbstractEntity implements IParser
 {
 
-    const COMMENT_TAG = 'rest';
+	const COMMENT_TAG = 'rest';
 
 // transient
-    /** @var Statement[] */
-    public $statements = [];
-    /**
-     * @var ParserClass[]
-     */
-    public $classes = [];
-    /**
-     * @var ParserFunction[]
-     */
-    public $Functions = [];
-    /**
-     * Directories available to all parse calls
-     *
-     * @var string[]
-     */
-    protected $common_dirs = [];
+	/** @var Statement[] */
+	public $statements = [];
+	/**
+	 * @var ParserClass[]
+	 */
+	public $classes = [];
+	/**
+	 * @var ParserFunction[]
+	 */
+	public $Functions = [];
+	/**
+	 * Directories available to all parse calls
+	 *
+	 * @var string[]
+	 */
+	protected $common_dirs = [];
 // States
-    private $current_file;
-    private $files_queued = [];
-    private $files_done = [];
-    private $dirs = [];
-    /**
-     * @var Statement[]|null
-     */
-    private $lastStatements = [];
-    /**
-     * @var AbstractPreprocessor
-     */
-    private $Preprocessor;
-
-    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): void
-    {
-        foreach ($dirs as $dir) {
-            $this->common_dirs[] = realpath($dir);
-        }
-    }
-
-    /**
-     * @throws Exception
-     */
-    public function parse($file, array $dirs = [], array $defines = []): array
-    {
-        $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();
-    }
-
-    private function parseFiles(array $files, array $defines = []): void
-    {
-        $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, true)) {
-                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) {
-                array_push($this->statements, ...$this->lastStatements);
-                $this->lastStatements = [];
-            }
-        }
-
-        $this->current_file = null;
-    }
-
-    private function parseTokens($source): void
-    {
-        $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 = [];
-                    break;
-
-                case T_FUNCTION:
-                    $Function = new ParserFunction($this, $tokens, $this->lastStatements);
-                    $this->Functions[strtolower($Function->name)] = $Function;
-                    $this->lastStatements = [];
-                    break;
-
-                case T_COMMENT:
-                    array_push($this->statements, ...$this->lastStatements);
-                    $this->lastStatements = [];
-                    $statements = $this->tokenToStatements($token);
-                    $this->queueClassesFromComments($statements);
-                    array_push($this->statements, ...$statements);
-                    break;
-
-                case T_DOC_COMMENT:
-                    array_push($this->statements, ...$this->lastStatements);
-                    $statements = $this->tokenToStatements($token);
-                    $this->queueClassesFromComments($statements);
-                    $this->lastStatements = $statements;
-                    break;
-            }
-
-            $token = next($tokens);
-        }
-    }
-
-    /**
-     * Convert a T_*_COMMENT string to an array of Statements
-     * @param array $token
-     * @return Statement[]
-     */
-    public function tokenToStatements($token): array
-    {
-        [, $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) {
-                [, $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;
-    }
-
-    /**
-     * Add to the queue any classes based on the commands.
-     * @param Statement[] $Statements
-     */
-    public function queueClassesFromComments(array $Statements): void
-    {
-        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]);
-                }
-            }
-        }
-    }
-
-    public function queueClass($classname): void
-    {
-        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, true)) {
-                    return;
-                }
-
-                if (is_file($realpath)) {
-                    $this->files_queued[] = $realpath;
-                    return;
-                }
-            }
-        }
-
-        // assume it's a class;
-    }
-
-    /**
-     * Inherit the statements
-     * @param ParserClass $class
-     */
-    private function inherit(ParserClass $class): void
-    {
-        $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): array
-    {
-        $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);
-                                array_push($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);
-                        array_push($output, ...$Function->statements);
-                    } else {
-                        throw new Exception("Function '{$match[1]}' not found");
-                    }
-                }
-            } else {
-                $output[] = $Statement;
-            }
-        }
-
-        return $output;
-    }
-
-    private function extractStatements(): array
-    {
-        // Core comments
-        $statements = $this->statements;
-
-        // Functions
-        foreach ($this->Functions as $Function) {
-            if ($Function->hasCommand('method')) {
-                array_push($statements, ...$Function->statements);
-            }
-        }
-
-        // Classes
-        foreach ($this->classes as $class) {
-            array_push($statements, ...$class->statements);
-            foreach ($class->methods as $method) {
-                if ($method->hasCommand('method')) {
-                    array_push($statements, ...$method->statements);
-                }
-            }
-        }
-
-        return $statements;
-    }
+	private $current_file;
+	private $files_queued = [];
+	private $files_done = [];
+	private $dirs = [];
+	/**
+	 * @var Statement[]|null
+	 */
+	private $lastStatements = [];
+	/**
+	 * @var AbstractPreprocessor
+	 */
+	private $Preprocessor;
+
+	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): void
+	{
+		foreach ($dirs as $dir) {
+			$this->common_dirs[] = realpath($dir);
+		}
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public function parse($file, array $dirs = [], array $defines = []): array
+	{
+		$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();
+	}
+
+	private function parseFiles(array $files, array $defines = []): void
+	{
+		$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, true)) {
+				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) {
+				array_push($this->statements, ...$this->lastStatements);
+				$this->lastStatements = [];
+			}
+		}
+
+		$this->current_file = null;
+	}
+
+	private function parseTokens($source): void
+	{
+		$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 = [];
+					break;
+
+				case T_FUNCTION:
+					$Function = new ParserFunction($this, $tokens, $this->lastStatements);
+					$this->Functions[strtolower($Function->name)] = $Function;
+					$this->lastStatements = [];
+					break;
+
+				case T_COMMENT:
+					array_push($this->statements, ...$this->lastStatements);
+					$this->lastStatements = [];
+					$statements = $this->tokenToStatements($token);
+					$this->queueClassesFromComments($statements);
+					array_push($this->statements, ...$statements);
+					break;
+
+				case T_DOC_COMMENT:
+					array_push($this->statements, ...$this->lastStatements);
+					$statements = $this->tokenToStatements($token);
+					$this->queueClassesFromComments($statements);
+					$this->lastStatements = $statements;
+					break;
+			}
+
+			$token = next($tokens);
+		}
+	}
+
+	/**
+	 * Convert a T_*_COMMENT string to an array of Statements
+	 * @param array $token
+	 * @return Statement[]
+	 */
+	public function tokenToStatements($token): array
+	{
+		[, $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) {
+				[, $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;
+	}
+
+	/**
+	 * Add to the queue any classes based on the commands.
+	 * @param Statement[] $Statements
+	 */
+	public function queueClassesFromComments(array $Statements): void
+	{
+		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]);
+				}
+			}
+		}
+	}
+
+	public function queueClass($classname): void
+	{
+		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, true)) {
+					return;
+				}
+
+				if (is_file($realpath)) {
+					$this->files_queued[] = $realpath;
+					return;
+				}
+			}
+		}
+
+		// assume it's a class;
+	}
+
+	/**
+	 * Inherit the statements
+	 * @param ParserClass $class
+	 */
+	private function inherit(ParserClass $class): void
+	{
+		$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): array
+	{
+		$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);
+								array_push($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);
+						array_push($output, ...$Function->statements);
+					} else {
+						throw new Exception("Function '{$match[1]}' not found");
+					}
+				}
+			} else {
+				$output[] = $Statement;
+			}
+		}
+
+		return $output;
+	}
+
+	private function extractStatements(): array
+	{
+		// Core comments
+		$statements = $this->statements;
+
+		// Functions
+		foreach ($this->Functions as $Function) {
+			if ($Function->hasCommand('method')) {
+				array_push($statements, ...$Function->statements);
+			}
+		}
+
+		// Classes
+		foreach ($this->classes as $class) {
+			array_push($statements, ...$class->statements);
+			foreach ($class->methods as $method) {
+				if ($method->hasCommand('method')) {
+					array_push($statements, ...$method->statements);
+				}
+			}
+		}
+
+		return $statements;
+	}
 
 }

SwaggerGen/Parser/Php/Entity/AbstractEntity.php

Indentation +22 added lines, -22 removed lines

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

SwaggerGen/Parser/Php/Entity/ParserClass.php

Indentation +107 added lines, -107 removed lines

@@ -15,111 +15,111 @@
 class ParserClass extends AbstractEntity
 {
 
-    /**
-     * @var string
-     */
-    public $name;
-
-    /**
-     * @var ParserFunction[]
-     */
-    public $methods = [];
-
-    /**
-     * @var string
-     */
-    public $extends;
-
-    /**
-     * @var string[]
-     */
-    public $implements = [];
-    private $lastStatements = [];
-
-    public function __construct(Parser $Parser, &$tokens, $statements)
-    {
-        $lastStatements = [];
-
-        if ($statements) {
-            $this->statements = array_merge($this->statements, $statements);
-        }
-
-        $depth = 0;
-
-        $mode = T_CLASS;
-
-        $token = current($tokens);
-        while ($token) {
-            switch ($token[0]) {
-                case T_STRING:
-                    switch ($mode) {
-                        case T_CLASS:
-                            $this->name = $token[1];
-                            $mode = null;
-                            break;
-
-                        case T_EXTENDS:
-                            $Parser->queueClass($token[1]);
-                            $this->extends = $token[1];
-                            $mode = null;
-                            break;
-
-                        case T_IMPLEMENTS:
-                            $Parser->queueClass($token[1]);
-                            $this->implements[] = $token[1];
-                            break;
-                    }
-                    break;
-
-                case '{':
-                case T_CURLY_OPEN:
-                case T_DOLLAR_OPEN_CURLY_BRACES:
-                case T_STRING_VARNAME:
-                    $mode = null;
-                    ++$depth;
-                    break;
-
-                case '}':
-                    --$depth;
-                    if ($depth === 0) {
-                        array_push($this->statements, ...$lastStatements);
-                        return;
-                    }
-                    break;
-
-                case T_FUNCTION:
-                    $Method = new ParserFunction($Parser, $tokens, $lastStatements);
-                    $this->methods[strtolower($Method->name)] = $Method;
-                    $lastStatements = [];
-                    break;
-
-                case T_EXTENDS:
-                    $mode = T_EXTENDS;
-                    break;
-
-                case T_IMPLEMENTS:
-                    $mode = T_IMPLEMENTS;
-                    break;
-
-                case T_COMMENT:
-                    array_push($this->statements, ...$lastStatements);
-                    $lastStatements = [];
-                    $statements = $Parser->tokenToStatements($token);
-                    $Parser->queueClassesFromComments($statements);
-                    array_push($this->statements, ...$statements);
-                    break;
-
-                case T_DOC_COMMENT:
-                    array_push($this->statements, ...$lastStatements);
-                    $statements = $Parser->tokenToStatements($token);
-                    $Parser->queueClassesFromComments($statements);
-                    $lastStatements = $statements;
-                    break;
-            }
-
-            $token = next($tokens);
-        }
-
-        array_push($this->statements, ...$lastStatements);
-    }
+	/**
+	 * @var string
+	 */
+	public $name;
+
+	/**
+	 * @var ParserFunction[]
+	 */
+	public $methods = [];
+
+	/**
+	 * @var string
+	 */
+	public $extends;
+
+	/**
+	 * @var string[]
+	 */
+	public $implements = [];
+	private $lastStatements = [];
+
+	public function __construct(Parser $Parser, &$tokens, $statements)
+	{
+		$lastStatements = [];
+
+		if ($statements) {
+			$this->statements = array_merge($this->statements, $statements);
+		}
+
+		$depth = 0;
+
+		$mode = T_CLASS;
+
+		$token = current($tokens);
+		while ($token) {
+			switch ($token[0]) {
+				case T_STRING:
+					switch ($mode) {
+						case T_CLASS:
+							$this->name = $token[1];
+							$mode = null;
+							break;
+
+						case T_EXTENDS:
+							$Parser->queueClass($token[1]);
+							$this->extends = $token[1];
+							$mode = null;
+							break;
+
+						case T_IMPLEMENTS:
+							$Parser->queueClass($token[1]);
+							$this->implements[] = $token[1];
+							break;
+					}
+					break;
+
+				case '{':
+				case T_CURLY_OPEN:
+				case T_DOLLAR_OPEN_CURLY_BRACES:
+				case T_STRING_VARNAME:
+					$mode = null;
+					++$depth;
+					break;
+
+				case '}':
+					--$depth;
+					if ($depth === 0) {
+						array_push($this->statements, ...$lastStatements);
+						return;
+					}
+					break;
+
+				case T_FUNCTION:
+					$Method = new ParserFunction($Parser, $tokens, $lastStatements);
+					$this->methods[strtolower($Method->name)] = $Method;
+					$lastStatements = [];
+					break;
+
+				case T_EXTENDS:
+					$mode = T_EXTENDS;
+					break;
+
+				case T_IMPLEMENTS:
+					$mode = T_IMPLEMENTS;
+					break;
+
+				case T_COMMENT:
+					array_push($this->statements, ...$lastStatements);
+					$lastStatements = [];
+					$statements = $Parser->tokenToStatements($token);
+					$Parser->queueClassesFromComments($statements);
+					array_push($this->statements, ...$statements);
+					break;
+
+				case T_DOC_COMMENT:
+					array_push($this->statements, ...$lastStatements);
+					$statements = $Parser->tokenToStatements($token);
+					$Parser->queueClassesFromComments($statements);
+					$lastStatements = $statements;
+					break;
+			}
+
+			$token = next($tokens);
+		}
+
+		array_push($this->statements, ...$lastStatements);
+	}
 }

SwaggerGen/Parser/Php/Entity/ParserFunction.php

Indentation +47 added lines, -47 removed lines

@@ -15,61 +15,61 @@
  */
 class ParserFunction extends AbstractEntity
 {
-    public string|null $name = null;
+	public string|null $name = null;
 
-    public function __construct(Parser $Parser, &$tokens, array $statements = null)
-    {
-        $lastStatements = [];
+	public function __construct(Parser $Parser, &$tokens, array $statements = null)
+	{
+		$lastStatements = [];
 
-        if (!empty($statements)) {
-            $this->statements = array_merge($this->statements, $statements);
-        }
+		if (!empty($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) {
-                        array_push($this->statements, ...$lastStatements);
-                        return;
-                    }
-                    break;
+				case '}':
+					--$depth;
+					if ($depth === 0) {
+						array_push($this->statements, ...$lastStatements);
+						return;
+					}
+					break;
 
-                case T_COMMENT:
-                    array_push($this->statements, ...$lastStatements);
-                    $lastStatements = [];
-                    $statements = $Parser->tokenToStatements($token);
-                    $Parser->queueClassesFromComments($statements);
-                    array_push($this->statements, ...$statements);
-                    break;
+				case T_COMMENT:
+					array_push($this->statements, ...$lastStatements);
+					$lastStatements = [];
+					$statements = $Parser->tokenToStatements($token);
+					$Parser->queueClassesFromComments($statements);
+					array_push($this->statements, ...$statements);
+					break;
 
-                case T_DOC_COMMENT:
-                    array_push($this->statements, ...$lastStatements);
-                    $statements = $Parser->tokenToStatements($token);
-                    $Parser->queueClassesFromComments($statements);
-                    $lastStatements = $statements;
-                    break;
-            }
+				case T_DOC_COMMENT:
+					array_push($this->statements, ...$lastStatements);
+					$statements = $Parser->tokenToStatements($token);
+					$Parser->queueClassesFromComments($statements);
+					$lastStatements = $statements;
+					break;
+			}
 
-            $token = next($tokens);
-        }
+			$token = next($tokens);
+		}
 
-        array_push($this->statements, ...$lastStatements);
-    }
+		array_push($this->statements, ...$lastStatements);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
  */
 class ParserFunction extends AbstractEntity
 {
-    public string|null $name = null;
+    public string | null $name = null;
 
     public function __construct(Parser $Parser, &$tokens, array $statements = null)
     {

SwaggerGen/Parser/Text/Preprocessor.php

Indentation +25 added lines, -25 removed lines

@@ -18,30 +18,30 @@
 class Preprocessor extends AbstractPreprocessor
 {
 
-    protected function parseContent($content): string
-    {
-        $pattern = '/\\s*([a-z]+)\\s*(.*)\\s*/';
-
-        $output = '';
-
-        foreach (preg_split('/(\\R)/m', $content, null, PREG_SPLIT_DELIM_CAPTURE) as $index => $line) {
-            if ($index % 2) {
-                $output .= $line;
-            } else {
-                $match = [];
-                if (preg_match($pattern, $line, $match) === 1) {
-                    if (!$this->handle($match[1], $match[2]) && $this->getState()) {
-                        $output .= $line;
-                    } else {
-                        $output .= '';
-                    }
-                } else {
-                    $output .= $line;
-                }
-            }
-        }
-
-        return $output;
-    }
+	protected function parseContent($content): string
+	{
+		$pattern = '/\\s*([a-z]+)\\s*(.*)\\s*/';
+
+		$output = '';
+
+		foreach (preg_split('/(\\R)/m', $content, null, PREG_SPLIT_DELIM_CAPTURE) as $index => $line) {
+			if ($index % 2) {
+				$output .= $line;
+			} else {
+				$match = [];
+				if (preg_match($pattern, $line, $match) === 1) {
+					if (!$this->handle($match[1], $match[2]) && $this->getState()) {
+						$output .= $line;
+					} else {
+						$output .= '';
+					}
+				} else {
+					$output .= $line;
+				}
+			}
+		}
+
+		return $output;
+	}
 
 }

SwaggerGen/Parser/Text/Parser.php

Indentation +84 added lines, -84 removed lines

@@ -17,99 +17,99 @@
 class Parser implements IParser
 {
 
-    /**
-     * List of directories to scan for class files referenced in the parsed
-     * command statements.
-     *
-     * @var string[]
-     */
-    protected $common_dirs = [];
+	/**
+	 * List of directories to scan for class files referenced in the parsed
+	 * command statements.
+	 *
+	 * @var string[]
+	 */
+	protected $common_dirs = [];
 
-    /**
-     * @var AbstractPreprocessor
-     */
-    private $Preprocessor;
+	/**
+	 * @var AbstractPreprocessor
+	 */
+	private $Preprocessor;
 
-    /**
-     * Create a new text parser and set directories to scan for referenced
-     * class files.
-     *
-     * @param string[] $dirs
-     */
-    public function __construct(array $dirs = [])
-    {
-        foreach ($dirs as $dir) {
-            $this->common_dirs[] = realpath($dir);
-        }
+	/**
+	 * Create a new text parser and set directories to scan for referenced
+	 * class files.
+	 *
+	 * @param string[] $dirs
+	 */
+	public function __construct(array $dirs = [])
+	{
+		foreach ($dirs as $dir) {
+			$this->common_dirs[] = realpath($dir);
+		}
 
-        $this->Preprocessor = new Preprocessor();
-    }
+		$this->Preprocessor = new Preprocessor();
+	}
 
-    /**
-     * Add additional directories to scan for referenced class files.
-     *
-     * @param string[] $dirs
-     */
-    public function addDirs(array $dirs): void
-    {
-        foreach ($dirs as $dir) {
-            $this->common_dirs[] = realpath($dir);
-        }
-    }
+	/**
+	 * Add additional directories to scan for referenced class files.
+	 *
+	 * @param string[] $dirs
+	 */
+	public function addDirs(array $dirs): void
+	{
+		foreach ($dirs as $dir) {
+			$this->common_dirs[] = realpath($dir);
+		}
+	}
 
-    /**
-     * Parse a text file
-     *
-     * @param string $file
-     * @param string[] $dirs
-     * @param string[] $defines
-     * @return Statement[]
-     */
-    public function parse($file, array $dirs = [], array $defines = []): array
-    {
-        return $this->parseText(file_get_contents(realpath($file)), $dirs);
-    }
+	/**
+	 * Parse a text file
+	 *
+	 * @param string $file
+	 * @param string[] $dirs
+	 * @param string[] $defines
+	 * @return Statement[]
+	 */
+	public function parse($file, array $dirs = [], array $defines = []): array
+	{
+		return $this->parseText(file_get_contents(realpath($file)), $dirs);
+	}
 
-    /**
-     * Parse plain text
-     *
-     * @param string $text
-     * @param string[] $dirs
-     * @param string[] $defines
-     * @return Statement[]
-     */
-    public function parseText($text, array $dirs = [], array $defines = []): array
-    {
-        $this->Preprocessor->resetDefines();
-        $this->Preprocessor->addDefines($defines);
-        $text = $this->Preprocessor->preprocess($text);
+	/**
+	 * Parse plain text
+	 *
+	 * @param string $text
+	 * @param string[] $dirs
+	 * @param string[] $defines
+	 * @return Statement[]
+	 */
+	public function parseText($text, array $dirs = [], array $defines = []): array
+	{
+		$this->Preprocessor->resetDefines();
+		$this->Preprocessor->addDefines($defines);
+		$text = $this->Preprocessor->preprocess($text);
 
-        $Statements = [];
+		$Statements = [];
 
-        foreach (preg_split('/\\R/m', $text) as $line => $data) {
-            $data = trim($data);
-            $command = self::wordShift($data);
-            if (!empty($command)) {
-                $Statements[] = new Statement($command, $data, null, $line);
-            }
-        }
+		foreach (preg_split('/\\R/m', $text) as $line => $data) {
+			$data = trim($data);
+			$command = self::wordShift($data);
+			if (!empty($command)) {
+				$Statements[] = new Statement($command, $data, null, $line);
+			}
+		}
 
-        return $Statements;
-    }
+		return $Statements;
+	}
 
-    /**
-     * Get the first word from a string and remove it from the string.
-     *
-     * @param string $data
-     * @return boolean|string
-     */
-    private static function wordShift(&$data)
-    {
-        if (preg_match('~^(\S+)\s*(.*)$~', $data, $matches) === 1) {
-            $data = $matches[2];
-            return $matches[1];
-        }
-        return false;
-    }
+	/**
+	 * Get the first word from a string and remove it from the string.
+	 *
+	 * @param string $data
+	 * @return boolean|string
+	 */
+	private static function wordShift(&$data)
+	{
+		if (preg_match('~^(\S+)\s*(.*)$~', $data, $matches) === 1) {
+			$data = $matches[2];
+			return $matches[1];
+		}
+		return false;
+	}
 
 }

SwaggerGen/StatementException.php

Indentation +20 added lines, -20 removed lines

@@ -16,27 +16,27 @@
 class StatementException extends Exception
 {
 
-    /**
-     * @var Statement
-     */
-    private $statement;
+	/**
+	 * @var Statement
+	 */
+	private $statement;
 
-    /**
-     *
-     * @param string $message
-     * @param int $code
-     * @param Throwable $previous
-     * @param Statement $statement
-     */
-    public function __construct($message = "", $code = 0, $previous = null, $statement = null)
-    {
-        $this->statement = $statement;
+	/**
+	 *
+	 * @param string $message
+	 * @param int $code
+	 * @param Throwable $previous
+	 * @param Statement $statement
+	 */
+	public function __construct($message = "", $code = 0, $previous = null, $statement = null)
+	{
+		$this->statement = $statement;
 
-        parent::__construct($message, $code, $previous);
-    }
+		parent::__construct($message, $code, $previous);
+	}
 
-    public function getStatement(): ?Statement
-    {
-        return $this->statement;
-    }
+	public function getStatement(): ?Statement
+	{
+		return $this->statement;
+	}
 }