vanderlee / PHPSwaggerGen

SwaggerGen/Parser/Php/Entity/ParserClass.php

Indentation +115 added lines, -115 removed lines

@@ -15,120 +15,120 @@
 class ParserClass extends AbstractEntity
 {
 
-    /**
-     * @var string
-     */
-    public $name = null;
-
-    /**
-     * @var ParserFunction[]
-     */
-    public $Methods = [];
-
-    /**
-     * @var string
-     */
-    public $extends = null;
-
-    /**
-     * @var string[]
-     */
-    public $implements = [];
-    private $lastStatements = null;
-
-    public function __construct(Parser $Parser, &$tokens, $Statements)
-    {
-        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) {
-                        if ($this->lastStatements) {
-                            $this->Statements = array_merge($this->Statements, $this->lastStatements);
-                            $this->lastStatements = null;
-                        }
-                        return;
-                    }
-                    break;
-
-                case T_FUNCTION:
-                    $Method = new ParserFunction($Parser, $tokens, $this->lastStatements);
-                    $this->Methods[strtolower($Method->name)] = $Method;
-                    $this->lastStatements = null;
-                    break;
-
-                case T_EXTENDS:
-                    $mode = T_EXTENDS;
-                    break;
-
-                case T_IMPLEMENTS:
-                    $mode = T_IMPLEMENTS;
-                    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;
-            }
-
-            $token = next($tokens);
-        }
-
-        if ($this->lastStatements) {
-            $this->Statements = array_merge($this->Statements, $this->lastStatements);
-            $this->lastStatements = null;
-        }
-    }
+	/**
+	 * @var string
+	 */
+	public $name = null;
+
+	/**
+	 * @var ParserFunction[]
+	 */
+	public $Methods = [];
+
+	/**
+	 * @var string
+	 */
+	public $extends = null;
+
+	/**
+	 * @var string[]
+	 */
+	public $implements = [];
+	private $lastStatements = null;
+
+	public function __construct(Parser $Parser, &$tokens, $Statements)
+	{
+		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) {
+						if ($this->lastStatements) {
+							$this->Statements = array_merge($this->Statements, $this->lastStatements);
+							$this->lastStatements = null;
+						}
+						return;
+					}
+					break;
+
+				case T_FUNCTION:
+					$Method = new ParserFunction($Parser, $tokens, $this->lastStatements);
+					$this->Methods[strtolower($Method->name)] = $Method;
+					$this->lastStatements = null;
+					break;
+
+				case T_EXTENDS:
+					$mode = T_EXTENDS;
+					break;
+
+				case T_IMPLEMENTS:
+					$mode = T_IMPLEMENTS;
+					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;
+			}
+
+			$token = next($tokens);
+		}
+
+		if ($this->lastStatements) {
+			$this->Statements = array_merge($this->Statements, $this->lastStatements);
+			$this->lastStatements = 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)
-    {
-        $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)
+	{
+		$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/IParser.php

Indentation +1 added lines, -1 removed lines

@@ -13,5 +13,5 @@
 interface IParser
 {
 
-    public function parse($file, array $dirs = []);
+	public function parse($file, array $dirs = []);
 }

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()
-    {
-        return $this->statement;
-    }
+	public function getStatement()
+	{
+		return $this->statement;
+	}
 }

SwaggerGen/Swagger/SecurityScheme.php

Indentation +127 added lines, -127 removed lines

@@ -16,132 +16,132 @@
 class SecurityScheme extends AbstractObject
 {
 
-    /**
-     * 'basic', 'apikey' or 'oauth2'
-     * @var string
-     */
-    private $type;
-
-    /**
-     * @var string
-     */
-    private $description;
-    private $name;
-    private $in;
-    private $flow;
-    private $authorizationUrl;
-    private $tokenUrl;
-
-    /**
-     * Map of scope-name => description
-     * @var []
-     */
-    private $scopes = [];
-
-    /**
-     * Create a new SecurityScheme object
-     * @param AbstractObject $parent
-     * @param string $type
-     * @param string $data
-     * @throws Exception
-     */
-    public function __construct(AbstractObject $parent, $type, $data = null)
-    {
-        parent::__construct($parent);
-
-        if (!in_array(strtolower($type), array('basic', 'apikey', 'oauth2'))) {
-            throw new Exception("Security scheme type must be either 'basic', 'apiKey' or 'oauth2', not '{$type}'");
-        }
-        $this->type = strtolower($type);
-
-        switch ($this->type) {
-            case 'basic':
-                $this->description = $data;
-                break;
-
-            case 'apikey':
-                $this->name = self::wordShift($data);
-
-                $in = strtolower(self::wordShift($data));
-                if (!in_array($in, array('query', 'header'))) {
-                    throw new Exception("ApiKey in must be either 'query' or 'header', not '{$in}'");
-                }
-                $this->in = $in;
-
-                $this->description = $data;
-                break;
-
-            case 'oauth2':
-                $flow = strtolower(self::wordShift($data));
-                if (!in_array($flow, array('implicit', 'password', 'application', 'accesscode'))) {
-                    throw new Exception("OAuth2 flow must be either 'implicit', 'password', 'application' or 'accesscode', not '{$flow}'");
-                }
-                $this->flow = $flow;
-
-                if (in_array($flow, array('implicit', 'accesscode'))) {
-                    $authUrl = self::wordShift($data);
-                    if (!filter_var($authUrl, FILTER_VALIDATE_URL)) {
-                        throw new Exception("OAuth2 authorization URL invalid: '{$authUrl}'");
-                    }
-                    $this->authorizationUrl = $authUrl;
-                }
-
-                if (in_array($flow, array('password', 'application', 'accesscode'))) {
-                    $tokenUrl = self::wordShift($data);
-                    if (!filter_var($tokenUrl, FILTER_VALIDATE_URL)) {
-                        throw new Exception("OAuth2 token URL invalid: '{$tokenUrl}'");
-                    }
-                    $this->tokenUrl = $tokenUrl;
-                }
-
-                $this->description = $data;
-                break;
-        }
-    }
-
-    /**
-     * @param string $command
-     * @param string $data
-     * @return AbstractObject|boolean
-     * @throws Exception
-     */
-    public function handleCommand($command, $data = null)
-    {
-        switch (strtolower($command)) {
-            case 'description':
-                $this->description = $data;
-                return $this;
-
-            case 'scope':
-                if ($this->type !== 'oauth2') {
-                    throw new Exception("Cannot set scope on type '{$this->type}'");
-                }
-
-                $name = self::wordShift($data);
-                $this->scopes[$name] = $data;
-                return $this;
-        }
-
-        return parent::handleCommand($command, $data);
-    }
-
-    public function toArray(): array
-    {
-        return self::arrayFilterNull(array_merge(array(
-            'type' => $this->type === 'apikey' ? 'apiKey' : $this->type,
-            'description' => empty($this->description) ? null : $this->description,
-            'name' => $this->name,
-            'in' => $this->in,
-            'flow' => $this->flow === 'accesscode' ? 'accessCode' : $this->flow,
-            'authorizationUrl' => $this->authorizationUrl,
-            'tokenUrl' => $this->tokenUrl,
-            'scopes' => $this->scopes,
-        ), parent::toArray()));
-    }
-
-    public function __toString()
-    {
-        return __CLASS__ . ' ' . $this->type;
-    }
+	/**
+	 * 'basic', 'apikey' or 'oauth2'
+	 * @var string
+	 */
+	private $type;
+
+	/**
+	 * @var string
+	 */
+	private $description;
+	private $name;
+	private $in;
+	private $flow;
+	private $authorizationUrl;
+	private $tokenUrl;
+
+	/**
+	 * Map of scope-name => description
+	 * @var []
+	 */
+	private $scopes = [];
+
+	/**
+	 * Create a new SecurityScheme object
+	 * @param AbstractObject $parent
+	 * @param string $type
+	 * @param string $data
+	 * @throws Exception
+	 */
+	public function __construct(AbstractObject $parent, $type, $data = null)
+	{
+		parent::__construct($parent);
+
+		if (!in_array(strtolower($type), array('basic', 'apikey', 'oauth2'))) {
+			throw new Exception("Security scheme type must be either 'basic', 'apiKey' or 'oauth2', not '{$type}'");
+		}
+		$this->type = strtolower($type);
+
+		switch ($this->type) {
+			case 'basic':
+				$this->description = $data;
+				break;
+
+			case 'apikey':
+				$this->name = self::wordShift($data);
+
+				$in = strtolower(self::wordShift($data));
+				if (!in_array($in, array('query', 'header'))) {
+					throw new Exception("ApiKey in must be either 'query' or 'header', not '{$in}'");
+				}
+				$this->in = $in;
+
+				$this->description = $data;
+				break;
+
+			case 'oauth2':
+				$flow = strtolower(self::wordShift($data));
+				if (!in_array($flow, array('implicit', 'password', 'application', 'accesscode'))) {
+					throw new Exception("OAuth2 flow must be either 'implicit', 'password', 'application' or 'accesscode', not '{$flow}'");
+				}
+				$this->flow = $flow;
+
+				if (in_array($flow, array('implicit', 'accesscode'))) {
+					$authUrl = self::wordShift($data);
+					if (!filter_var($authUrl, FILTER_VALIDATE_URL)) {
+						throw new Exception("OAuth2 authorization URL invalid: '{$authUrl}'");
+					}
+					$this->authorizationUrl = $authUrl;
+				}
+
+				if (in_array($flow, array('password', 'application', 'accesscode'))) {
+					$tokenUrl = self::wordShift($data);
+					if (!filter_var($tokenUrl, FILTER_VALIDATE_URL)) {
+						throw new Exception("OAuth2 token URL invalid: '{$tokenUrl}'");
+					}
+					$this->tokenUrl = $tokenUrl;
+				}
+
+				$this->description = $data;
+				break;
+		}
+	}
+
+	/**
+	 * @param string $command
+	 * @param string $data
+	 * @return AbstractObject|boolean
+	 * @throws Exception
+	 */
+	public function handleCommand($command, $data = null)
+	{
+		switch (strtolower($command)) {
+			case 'description':
+				$this->description = $data;
+				return $this;
+
+			case 'scope':
+				if ($this->type !== 'oauth2') {
+					throw new Exception("Cannot set scope on type '{$this->type}'");
+				}
+
+				$name = self::wordShift($data);
+				$this->scopes[$name] = $data;
+				return $this;
+		}
+
+		return parent::handleCommand($command, $data);
+	}
+
+	public function toArray(): array
+	{
+		return self::arrayFilterNull(array_merge(array(
+			'type' => $this->type === 'apikey' ? 'apiKey' : $this->type,
+			'description' => empty($this->description) ? null : $this->description,
+			'name' => $this->name,
+			'in' => $this->in,
+			'flow' => $this->flow === 'accesscode' ? 'accessCode' : $this->flow,
+			'authorizationUrl' => $this->authorizationUrl,
+			'tokenUrl' => $this->tokenUrl,
+			'scopes' => $this->scopes,
+		), parent::toArray()));
+	}
+
+	public function __toString()
+	{
+		return __CLASS__ . ' ' . $this->type;
+	}
 
 }

SwaggerGen/Swagger/Operation.php

Indentation +225 added lines, -225 removed lines

@@ -16,230 +16,230 @@
 class Operation extends AbstractDocumentableObject
 {
 
-    private $tags = [];
-    private $summary;
-    private $description;
-    private $consumes = [];
-    private $produces = [];
-
-    /**
-     * @var IParameter[]
-     */
-    private $parameters = [];
-    private $responses = [];
-    private $schemes = [];
-    private $deprecated = false;
-    private $security = [];
-
-    /**
-     * @var string
-     */
-    private $operationId = null;
-
-    /**
-     * @param string $summary
-     */
-    public function __construct(AbstractObject $parent, $summary = null, ?Tag $tag = null)
-    {
-        parent::__construct($parent);
-        $this->summary = $summary;
-        if ($tag) {
-            $this->tags[] = $tag->getName();
-        }
-    }
-
-    public function getConsumes(): array
-    {
-        return $this->consumes;
-    }
-
-    /**
-     * @param string $command
-     * @param string $data
-     * @return AbstractObject|boolean
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     */
-    public function handleCommand($command, $data = null)
-    {
-        switch (strtolower($command)) {
-            // string
-            case 'summary':
-            case 'description':
-                $this->$command = $data;
-                return $this;
-
-            // string[]
-            case 'tags':
-            case 'schemes':
-                $this->$command = array_merge($this->$command, self::wordSplit($data));
-                return $this;
-
-            // MIME[]
-            case 'consumes':
-            case 'produces':
-                $this->$command = array_merge($this->$command, self::translateMimeTypes(self::wordSplit($data)));
-                return $this;
-
-            // boolean
-            case 'deprecated':
-                $this->deprecated = true;
-                return $this;
-
-            case 'error':
-                $code = self::wordShift($data);
-                $reasoncode = Response::getCode($code);
-                if ($reasoncode === null) {
-                    throw new Exception("Invalid error code: '$code'");
-                }
-                $description = $data;
-                $Error = new Error($this, $reasoncode, $description);
-                $this->responses[$reasoncode] = $Error;
-                return $Error;
-
-            case 'errors':
-                foreach (self::wordSplit($data) as $code) {
-                    $reasoncode = Response::getCode($code);
-                    if ($reasoncode === null) {
-                        throw new Exception("Invalid error code: '$code'");
-                    }
-                    $this->responses[$reasoncode] = new Error($this, $reasoncode);
-                }
-                return $this;
-
-            case 'path':
-            case 'query':
-            case 'query?':
-            case 'header':
-            case 'header?':
-            case 'form':
-            case 'form?':
-                $in = rtrim($command, '?');
-                $parameter = new Parameter($this, $in, $data, substr($command, -1) !== '?');
-                $this->parameters[$parameter->getName()] = $parameter;
-                return $parameter;
-
-            case 'body':
-            case 'body?':
-                $parameter = new BodyParameter($this, $data, substr($command, -1) !== '?');
-                $this->parameters[$parameter->getName()] = $parameter;
-                return $parameter;
-
-            case 'param':
-            case 'parameter':
-                $parameter = new ParameterReference($this, $data);
-                $this->parameters[$parameter->getName()] = $parameter;
-                return $this;
-
-            case 'response':
-                $code = self::wordShift($data);
-                $reasoncode = Response::getCode($code);
-                if ($reasoncode === null) {
-                    $reference = $code;
-                    $code = self::wordShift($data);
-                    $reasoncode = Response::getCode($code);
-                    if ($reasoncode === null) {
-                        throw new Exception("Invalid response code: '$reference'");
-                    }
-                    $this->responses[$reasoncode] = new ResponseReference($this, $reference);
-                    return $this;
-                }
-
-                $definition = self::wordShift($data);
-                $description = $data;
-                $Response = new Response($this, $reasoncode, $definition, $description);
-                $this->responses[$reasoncode] = $Response;
-                return $Response;
-
-            case 'require':
-                $name = self::wordShift($data);
-                if (empty($name)) {
-                    throw new Exception('Empty security requirement name');
-                }
-                $scopes = self::wordSplit($data);
-                sort($scopes);
-                $this->security[] = array(
-                    $name => empty($scopes) ? [] : $scopes,
-                );
-                return $this;
-
-            case 'id':
-                $operationId = self::trim($data);
-                if ($this->getSwagger()->hasOperationId($operationId)) {
-                    throw new Exception("Duplicate operation id '{$operationId}'");
-                }
-                $this->operationId = $operationId;
-                return $this;
-        }
-
-        return parent::handleCommand($command, $data);
-    }
-
-    /**
-     * @throws Exception
-     */
-    public function toArray(): array
-    {
-        if (empty($this->responses)) {
-            throw new Exception('No response defined for operation');
-        }
-        ksort($this->responses);
-
-        $tags = array_unique($this->tags);
-        sort($tags);
-
-        $schemes = array_unique($this->schemes);
-        sort($schemes);
-
-        $consumes = array_unique($this->consumes);
-        sort($consumes);
-
-        $produces = array_unique($this->produces);
-        sort($produces);
-
-        foreach ($this->security as $security) {
-            foreach ($security as $name => $scope) {
-                if ($this->getSwagger()->getSecurity($name) === false) {
-                    throw new Exception("Required security scheme not defined: '{$name}'");
-                }
-            }
-        }
-
-        $parameters = $this->parameters ? array_values($this->parameters) : null;
-
-        return self::arrayFilterNull(array_merge(array(
-            'deprecated' => $this->deprecated ? true : null,
-            'tags' => $tags,
-            'summary' => empty($this->summary) ? null : $this->summary,
-            'description' => empty($this->description) ? null : $this->description,
-            'operationId' => $this->operationId,
-            'consumes' => $consumes,
-            'produces' => $produces,
-            'parameters' => $parameters ? self::objectsToArray($parameters) : null,
-            'schemes' => $schemes,
-            'responses' => $this->responses ? self::objectsToArray($this->responses) : null,
-            'security' => $this->security,
-        ), parent::toArray()));
-    }
-
-    /**
-     * Return the operation ID
-     *
-     * @return string
-     */
-    public function getId()
-    {
-        return $this->operationId;
-    }
-
-    public function __toString()
-    {
-        return __CLASS__ . ' ' . $this->summary;
-    }
+	private $tags = [];
+	private $summary;
+	private $description;
+	private $consumes = [];
+	private $produces = [];
+
+	/**
+	 * @var IParameter[]
+	 */
+	private $parameters = [];
+	private $responses = [];
+	private $schemes = [];
+	private $deprecated = false;
+	private $security = [];
+
+	/**
+	 * @var string
+	 */
+	private $operationId = null;
+
+	/**
+	 * @param string $summary
+	 */
+	public function __construct(AbstractObject $parent, $summary = null, ?Tag $tag = null)
+	{
+		parent::__construct($parent);
+		$this->summary = $summary;
+		if ($tag) {
+			$this->tags[] = $tag->getName();
+		}
+	}
+
+	public function getConsumes(): array
+	{
+		return $this->consumes;
+	}
+
+	/**
+	 * @param string $command
+	 * @param string $data
+	 * @return AbstractObject|boolean
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	public function handleCommand($command, $data = null)
+	{
+		switch (strtolower($command)) {
+			// string
+			case 'summary':
+			case 'description':
+				$this->$command = $data;
+				return $this;
+
+			// string[]
+			case 'tags':
+			case 'schemes':
+				$this->$command = array_merge($this->$command, self::wordSplit($data));
+				return $this;
+
+			// MIME[]
+			case 'consumes':
+			case 'produces':
+				$this->$command = array_merge($this->$command, self::translateMimeTypes(self::wordSplit($data)));
+				return $this;
+
+			// boolean
+			case 'deprecated':
+				$this->deprecated = true;
+				return $this;
+
+			case 'error':
+				$code = self::wordShift($data);
+				$reasoncode = Response::getCode($code);
+				if ($reasoncode === null) {
+					throw new Exception("Invalid error code: '$code'");
+				}
+				$description = $data;
+				$Error = new Error($this, $reasoncode, $description);
+				$this->responses[$reasoncode] = $Error;
+				return $Error;
+
+			case 'errors':
+				foreach (self::wordSplit($data) as $code) {
+					$reasoncode = Response::getCode($code);
+					if ($reasoncode === null) {
+						throw new Exception("Invalid error code: '$code'");
+					}
+					$this->responses[$reasoncode] = new Error($this, $reasoncode);
+				}
+				return $this;
+
+			case 'path':
+			case 'query':
+			case 'query?':
+			case 'header':
+			case 'header?':
+			case 'form':
+			case 'form?':
+				$in = rtrim($command, '?');
+				$parameter = new Parameter($this, $in, $data, substr($command, -1) !== '?');
+				$this->parameters[$parameter->getName()] = $parameter;
+				return $parameter;
+
+			case 'body':
+			case 'body?':
+				$parameter = new BodyParameter($this, $data, substr($command, -1) !== '?');
+				$this->parameters[$parameter->getName()] = $parameter;
+				return $parameter;
+
+			case 'param':
+			case 'parameter':
+				$parameter = new ParameterReference($this, $data);
+				$this->parameters[$parameter->getName()] = $parameter;
+				return $this;
+
+			case 'response':
+				$code = self::wordShift($data);
+				$reasoncode = Response::getCode($code);
+				if ($reasoncode === null) {
+					$reference = $code;
+					$code = self::wordShift($data);
+					$reasoncode = Response::getCode($code);
+					if ($reasoncode === null) {
+						throw new Exception("Invalid response code: '$reference'");
+					}
+					$this->responses[$reasoncode] = new ResponseReference($this, $reference);
+					return $this;
+				}
+
+				$definition = self::wordShift($data);
+				$description = $data;
+				$Response = new Response($this, $reasoncode, $definition, $description);
+				$this->responses[$reasoncode] = $Response;
+				return $Response;
+
+			case 'require':
+				$name = self::wordShift($data);
+				if (empty($name)) {
+					throw new Exception('Empty security requirement name');
+				}
+				$scopes = self::wordSplit($data);
+				sort($scopes);
+				$this->security[] = array(
+					$name => empty($scopes) ? [] : $scopes,
+				);
+				return $this;
+
+			case 'id':
+				$operationId = self::trim($data);
+				if ($this->getSwagger()->hasOperationId($operationId)) {
+					throw new Exception("Duplicate operation id '{$operationId}'");
+				}
+				$this->operationId = $operationId;
+				return $this;
+		}
+
+		return parent::handleCommand($command, $data);
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public function toArray(): array
+	{
+		if (empty($this->responses)) {
+			throw new Exception('No response defined for operation');
+		}
+		ksort($this->responses);
+
+		$tags = array_unique($this->tags);
+		sort($tags);
+
+		$schemes = array_unique($this->schemes);
+		sort($schemes);
+
+		$consumes = array_unique($this->consumes);
+		sort($consumes);
+
+		$produces = array_unique($this->produces);
+		sort($produces);
+
+		foreach ($this->security as $security) {
+			foreach ($security as $name => $scope) {
+				if ($this->getSwagger()->getSecurity($name) === false) {
+					throw new Exception("Required security scheme not defined: '{$name}'");
+				}
+			}
+		}
+
+		$parameters = $this->parameters ? array_values($this->parameters) : null;
+
+		return self::arrayFilterNull(array_merge(array(
+			'deprecated' => $this->deprecated ? true : null,
+			'tags' => $tags,
+			'summary' => empty($this->summary) ? null : $this->summary,
+			'description' => empty($this->description) ? null : $this->description,
+			'operationId' => $this->operationId,
+			'consumes' => $consumes,
+			'produces' => $produces,
+			'parameters' => $parameters ? self::objectsToArray($parameters) : null,
+			'schemes' => $schemes,
+			'responses' => $this->responses ? self::objectsToArray($this->responses) : null,
+			'security' => $this->security,
+		), parent::toArray()));
+	}
+
+	/**
+	 * Return the operation ID
+	 *
+	 * @return string
+	 */
+	public function getId()
+	{
+		return $this->operationId;
+	}
+
+	public function __toString()
+	{
+		return __CLASS__ . ' ' . $this->summary;
+	}
 
 }

SwaggerGen/Swagger/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;
-    }
-
-    /**
-     * 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]);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected function getSwagger(): Swagger
-    {
-        return $this;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected function getTypeRegistry(): TypeRegistry
-    {
-        return $this->typeRegistry;
-    }
+	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;
+	}
+
+	/**
+	 * 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]);
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	protected function getSwagger(): Swagger
+	{
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	protected function getTypeRegistry(): TypeRegistry
+	{
+		return $this->typeRegistry;
+	}
 
 }

SwaggerGen/Swagger/Type/ReferenceObjectType.php

Indentation +43 added lines, -43 removed lines

@@ -15,48 +15,48 @@
 class ReferenceObjectType extends AbstractType
 {
 
-    private $reference = null;
-
-    public function toArray(): array
-    {
-        return self::arrayFilterNull(array_merge(array(
-            '$ref' => '#/definitions/' . $this->reference,
-        ), parent::toArray()));
-    }
-
-    public function __toString()
-    {
-        return __CLASS__ . ' ' . $this->reference;
-    }
-
-    /**
-     * @throws Exception
-     */
-    protected function parseDefinition($definition)
-    {
-        $definition = self::trim($definition);
-
-        $match = [];
-        if (preg_match(self::REGEX_START . self::REGEX_FORMAT . self::REGEX_CONTENT . self::REGEX_RANGE . self::REGEX_DEFAULT . self::REGEX_END, $definition, $match) !== 1) {
-            throw new Exception('Unparseable string definition: \'' . $definition . '\'');
-        }
-
-        $type = strtolower($match[1]);
-
-        $reference = null;
-        if ($type === 'refobject') {
-            if (isset($match[2])) {
-                $reference = $match[2];
-            }
-        } else {
-            $reference = $match[1];
-        }
-
-        if (empty($reference)) {
-            throw new Exception('Referenced object name missing: \'' . $definition . '\'');
-        }
-
-        $this->reference = $reference;
-    }
+	private $reference = null;
+
+	public function toArray(): array
+	{
+		return self::arrayFilterNull(array_merge(array(
+			'$ref' => '#/definitions/' . $this->reference,
+		), parent::toArray()));
+	}
+
+	public function __toString()
+	{
+		return __CLASS__ . ' ' . $this->reference;
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	protected function parseDefinition($definition)
+	{
+		$definition = self::trim($definition);
+
+		$match = [];
+		if (preg_match(self::REGEX_START . self::REGEX_FORMAT . self::REGEX_CONTENT . self::REGEX_RANGE . self::REGEX_DEFAULT . self::REGEX_END, $definition, $match) !== 1) {
+			throw new Exception('Unparseable string definition: \'' . $definition . '\'');
+		}
+
+		$type = strtolower($match[1]);
+
+		$reference = null;
+		if ($type === 'refobject') {
+			if (isset($match[2])) {
+				$reference = $match[2];
+			}
+		} else {
+			$reference = $match[1];
+		}
+
+		if (empty($reference)) {
+			throw new Exception('Referenced object name missing: \'' . $definition . '\'');
+		}
+
+		$this->reference = $reference;
+	}
 
 }

SwaggerGen/Swagger/Type/ObjectType.php

Indentation +255 added lines, -255 removed lines

@@ -15,286 +15,286 @@
 class ObjectType extends AbstractType
 {
 
-    /** @noinspection PhpRegExpUnsupportedModifierInspection */
-    const REGEX_OBJECT_CONTENT = '(?:(\{)(.*)\})?';
-    const REGEX_PROP_START = '/^';
-    const REGEX_PROP_NAME = '([^?!:]+)';
-    /** @noinspection PhpRegExpUnsupportedModifierInspection */
-    const REGEX_PROP_REQUIRED = '([\?!])?';
-    const REGEX_PROP_ASSIGN = ':';
-    const REGEX_PROP_DEFINITION = '(.+)';
-    /** @noinspection PhpRegExpUnsupportedModifierInspection
-     * @noinspection PhpRegExpInvalidDelimiterInspection
-     */
-    const REGEX_PROP_ADDITIONAL = '\.\.\.(!|.+)?';
-    const REGEX_PROP_END = '$/';
+	/** @noinspection PhpRegExpUnsupportedModifierInspection */
+	const REGEX_OBJECT_CONTENT = '(?:(\{)(.*)\})?';
+	const REGEX_PROP_START = '/^';
+	const REGEX_PROP_NAME = '([^?!:]+)';
+	/** @noinspection PhpRegExpUnsupportedModifierInspection */
+	const REGEX_PROP_REQUIRED = '([\?!])?';
+	const REGEX_PROP_ASSIGN = ':';
+	const REGEX_PROP_DEFINITION = '(.+)';
+	/** @noinspection PhpRegExpUnsupportedModifierInspection
+	 * @noinspection PhpRegExpInvalidDelimiterInspection
+	 */
+	const REGEX_PROP_ADDITIONAL = '\.\.\.(!|.+)?';
+	const REGEX_PROP_END = '$/';
 
-    private $minProperties = null;
-    private $maxProperties = null;
-    private $discriminator = null;
-    private $additionalProperties = null;
-    private $required = [];
+	private $minProperties = null;
+	private $maxProperties = null;
+	private $discriminator = null;
+	private $additionalProperties = null;
+	private $required = [];
 
-    /**
-     * @var Property[]
-     */
-    private $properties = [];
+	/**
+	 * @var Property[]
+	 */
+	private $properties = [];
 
-    /**
-     * @var Property
-     */
-    private $mostRecentProperty = null;
+	/**
+	 * @var Property
+	 */
+	private $mostRecentProperty = null;
 
-    /**
-     * @param string $command The comment command
-     * @param string $data Any data added after the command
-     * @return AbstractType|boolean
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @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)) {
-            // type name description...
-            case 'additionalproperties':
-                $value = self::wordShift($data);
-                if (is_bool($value)) {
-                    $type = $value;
-                } else if ($value === 'false') {
-                    $type = false;
-                } else if ($value === 'true') {
-                    $type = true;
-                } else {
-                    $type = self::typeFactory($this, $value, "Unparseable additional properties definition: '%s'");
-                }
-                $this->setAdditionalProperties($type);
-                return $this;
-            case 'discriminator':
-                $discriminator = self::wordShift($data);
-                $this->setDiscriminator($discriminator);
-                return $this;
-            case 'property':
-            case 'property?':
-            case 'property!':
-                $definition = self::wordShift($data);
-                if (empty($definition)) {
-                    throw new Exception("Missing property definition");
-                }
+	/**
+	 * @param string $command The comment command
+	 * @param string $data Any data added after the command
+	 * @return AbstractType|boolean
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @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)) {
+			// type name description...
+			case 'additionalproperties':
+				$value = self::wordShift($data);
+				if (is_bool($value)) {
+					$type = $value;
+				} else if ($value === 'false') {
+					$type = false;
+				} else if ($value === 'true') {
+					$type = true;
+				} else {
+					$type = self::typeFactory($this, $value, "Unparseable additional properties definition: '%s'");
+				}
+				$this->setAdditionalProperties($type);
+				return $this;
+			case 'discriminator':
+				$discriminator = self::wordShift($data);
+				$this->setDiscriminator($discriminator);
+				return $this;
+			case 'property':
+			case 'property?':
+			case 'property!':
+				$definition = self::wordShift($data);
+				if (empty($definition)) {
+					throw new Exception("Missing property definition");
+				}
 
-                $name = self::wordShift($data);
-                if (empty($name)) {
-                    throw new Exception("Missing property name: '{$definition}'");
-                }
+				$name = self::wordShift($data);
+				if (empty($name)) {
+					throw new Exception("Missing property name: '{$definition}'");
+				}
 
-                $readOnly = null;
-                $required = false;
-                $propertySuffix = substr($command, -1);
-                if ($propertySuffix === '!') {
-                    $readOnly = true;
-                } else if ($propertySuffix !== '?') {
-                    $required = true;
-                }
+				$readOnly = null;
+				$required = false;
+				$propertySuffix = substr($command, -1);
+				if ($propertySuffix === '!') {
+					$readOnly = true;
+				} else if ($propertySuffix !== '?') {
+					$required = true;
+				}
 
-                if (($name === $this->discriminator) && !$required) {
-                    throw new Exception("Discriminator must be a required property, "
-                        . "property '{$name}' is not required");
-                }
+				if (($name === $this->discriminator) && !$required) {
+					throw new Exception("Discriminator must be a required property, "
+						. "property '{$name}' is not required");
+				}
 
-                unset($this->required[$name]);
-                if ($required) {
-                    $this->required[$name] = true;
-                }
+				unset($this->required[$name]);
+				if ($required) {
+					$this->required[$name] = true;
+				}
 
-                $this->mostRecentProperty = new Property($this, $definition, $data, $readOnly);
-                $this->properties[$name] = $this->mostRecentProperty;
-                return $this;
+				$this->mostRecentProperty = new Property($this, $definition, $data, $readOnly);
+				$this->properties[$name] = $this->mostRecentProperty;
+				return $this;
 
-            case 'min':
-                $this->minProperties = (int)$data;
-                if ($this->minProperties < 0) {
-                    throw new Exception("Minimum less than zero: '{$data}'");
-                }
-                if ($this->maxProperties !== null && $this->minProperties > $this->maxProperties) {
-                    throw new Exception("Minimum greater than maximum: '{$data}'");
-                }
-                $this->minProperties = (int)$data;
-                return $this;
+			case 'min':
+				$this->minProperties = (int)$data;
+				if ($this->minProperties < 0) {
+					throw new Exception("Minimum less than zero: '{$data}'");
+				}
+				if ($this->maxProperties !== null && $this->minProperties > $this->maxProperties) {
+					throw new Exception("Minimum greater than maximum: '{$data}'");
+				}
+				$this->minProperties = (int)$data;
+				return $this;
 
-            case 'max':
-                $this->maxProperties = (int)$data;
-                if ($this->minProperties !== null && $this->minProperties > $this->maxProperties) {
-                    throw new Exception("Maximum less than minimum: '{$data}'");
-                }
-                if ($this->maxProperties < 0) {
-                    throw new Exception("Maximum less than zero: '{$data}'");
-                }
-                return $this;
-        }
+			case 'max':
+				$this->maxProperties = (int)$data;
+				if ($this->minProperties !== null && $this->minProperties > $this->maxProperties) {
+					throw new Exception("Maximum less than minimum: '{$data}'");
+				}
+				if ($this->maxProperties < 0) {
+					throw new Exception("Maximum less than zero: '{$data}'");
+				}
+				return $this;
+		}
 
-        // Pass through to most recent Property
-        if ($this->mostRecentProperty && $this->mostRecentProperty->handleCommand($command, $data)) {
-            return $this;
-        }
+		// Pass through to most recent Property
+		if ($this->mostRecentProperty && $this->mostRecentProperty->handleCommand($command, $data)) {
+			return $this;
+		}
 
-        return parent::handleCommand($command, $data);
-    }
+		return parent::handleCommand($command, $data);
+	}
 
-    /**
-     * @param AbstractType|bool $type
-     * @return void
-     * @throws Exception
-     */
-    private function setAdditionalProperties($type)
-    {
-        if ($this->additionalProperties !== null) {
-            throw new Exception('Additional properties may only be set once');
-        }
-        $this->additionalProperties = $type;
-    }
+	/**
+	 * @param AbstractType|bool $type
+	 * @return void
+	 * @throws Exception
+	 */
+	private function setAdditionalProperties($type)
+	{
+		if ($this->additionalProperties !== null) {
+			throw new Exception('Additional properties may only be set once');
+		}
+		$this->additionalProperties = $type;
+	}
 
-    /**
-     * @param string|false $discriminator
-     * @throws Exception
-     * @throws Exception
-     */
-    private function setDiscriminator($discriminator)
-    {
-        if (!empty($this->discriminator)) {
-            throw new Exception("Discriminator may only be set once, "
-                . "trying to change it "
-                . "from '{$this->discriminator}' "
-                . "to '{$discriminator}'");
-        }
-        if (isset($this->properties[$discriminator]) && empty($this->required[$discriminator])) {
-            throw new Exception("Discriminator must be a required property, "
-                . "property '{$discriminator}' is not required");
-        }
-        $this->discriminator = $discriminator;
-    }
+	/**
+	 * @param string|false $discriminator
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	private function setDiscriminator($discriminator)
+	{
+		if (!empty($this->discriminator)) {
+			throw new Exception("Discriminator may only be set once, "
+				. "trying to change it "
+				. "from '{$this->discriminator}' "
+				. "to '{$discriminator}'");
+		}
+		if (isset($this->properties[$discriminator]) && empty($this->required[$discriminator])) {
+			throw new Exception("Discriminator must be a required property, "
+				. "property '{$discriminator}' is not required");
+		}
+		$this->discriminator = $discriminator;
+	}
 
-    public function toArray(): array
-    {
-        return self::arrayFilterNull(array_merge(array(
-            'type' => 'object',
-            'required' => array_keys($this->required),
-            'properties' => self::objectsToArray($this->properties),
-            'minProperties' => $this->minProperties,
-            'maxProperties' => $this->maxProperties,
-            'discriminator' => $this->discriminator,
-            'additionalProperties' => $this->additionalProperties instanceof AbstractType ? $this->additionalProperties->toArray() : $this->additionalProperties,
-        ), parent::toArray()));
-    }
+	public function toArray(): array
+	{
+		return self::arrayFilterNull(array_merge(array(
+			'type' => 'object',
+			'required' => array_keys($this->required),
+			'properties' => self::objectsToArray($this->properties),
+			'minProperties' => $this->minProperties,
+			'maxProperties' => $this->maxProperties,
+			'discriminator' => $this->discriminator,
+			'additionalProperties' => $this->additionalProperties instanceof AbstractType ? $this->additionalProperties->toArray() : $this->additionalProperties,
+		), parent::toArray()));
+	}
 
-    public function __toString()
-    {
-        return __CLASS__;
-    }
+	public function __toString()
+	{
+		return __CLASS__;
+	}
 
-    /**
-     * @throws Exception
-     */
-    protected function parseDefinition($definition)
-    {
-        $definition = self::trim($definition);
+	/**
+	 * @throws Exception
+	 */
+	protected function parseDefinition($definition)
+	{
+		$definition = self::trim($definition);
 
-        $match = [];
-        if (preg_match(self::REGEX_START . self::REGEX_FORMAT . self::REGEX_CONTENT . self::REGEX_RANGE . self::REGEX_END, $definition, $match) === 1) {
-            $match[1] = strtolower($match[1]);
-        } elseif (preg_match(self::REGEX_START . self::REGEX_OBJECT_CONTENT . self::REGEX_RANGE . self::REGEX_END, $definition, $match) === 1) {
-            $match[1] = 'object';
-        } else {
-            throw new Exception('Unparseable object definition: \'' . $definition . '\'');
-        }
+		$match = [];
+		if (preg_match(self::REGEX_START . self::REGEX_FORMAT . self::REGEX_CONTENT . self::REGEX_RANGE . self::REGEX_END, $definition, $match) === 1) {
+			$match[1] = strtolower($match[1]);
+		} elseif (preg_match(self::REGEX_START . self::REGEX_OBJECT_CONTENT . self::REGEX_RANGE . self::REGEX_END, $definition, $match) === 1) {
+			$match[1] = 'object';
+		} else {
+			throw new Exception('Unparseable object definition: \'' . $definition . '\'');
+		}
 
-        $this->parseFormat($definition, $match);
-        $this->parseProperties($definition, $match);
-        $this->parseRange($definition, $match);
-    }
+		$this->parseFormat($definition, $match);
+		$this->parseProperties($definition, $match);
+		$this->parseRange($definition, $match);
+	}
 
-    /**
-     * @param string $definition
-     * @param string[] $match
-     * @throws Exception
-     */
-    private function parseFormat($definition, $match)
-    {
-        if (strtolower($match[1]) !== 'object') {
-            throw new Exception("Not an object: '{$definition}'");
-        }
-    }
+	/**
+	 * @param string $definition
+	 * @param string[] $match
+	 * @throws Exception
+	 */
+	private function parseFormat($definition, $match)
+	{
+		if (strtolower($match[1]) !== 'object') {
+			throw new Exception("Not an object: '{$definition}'");
+		}
+	}
 
-    /**
-     * @param string $definition
-     * @param string[] $match
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     */
-    private function parseProperties($definition, $match)
-    {
-        if (empty($match[2])) {
-            return;
-        }
+	/**
+	 * @param string $definition
+	 * @param string[] $match
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	private function parseProperties($definition, $match)
+	{
+		if (empty($match[2])) {
+			return;
+		}
 
-        while (($property = self::parseListItem($match[2])) !== '') {
-            $prop_match = [];
-            if (preg_match(self::REGEX_PROP_START . self::REGEX_PROP_ADDITIONAL . self::REGEX_PROP_END, $property, $prop_match) === 1) {
-                if (empty($prop_match[1])) {
-                    $this->setAdditionalProperties(true);
-                } else if ($prop_match[1] === '!') {
-                    $this->setAdditionalProperties(false);
-                } else {
-                    $this->setAdditionalProperties(self::typeFactory($this, $prop_match[1], "Unparseable additional properties definition: '...%s'"));
-                }
-                continue;
-            }
-            if (preg_match(self::REGEX_PROP_START . self::REGEX_PROP_NAME . self::REGEX_PROP_REQUIRED . self::REGEX_PROP_ASSIGN . self::REGEX_PROP_DEFINITION . self::REGEX_PROP_END, $property, $prop_match) !== 1) {
-                throw new Exception("Unparseable property definition: '{$property}'");
-            }
-            $this->properties[$prop_match[1]] = new Property($this, $prop_match[3]);
-            if ($prop_match[2] !== '!' && $prop_match[2] !== '?') {
-                $this->required[$prop_match[1]] = true;
-            }
-        }
+		while (($property = self::parseListItem($match[2])) !== '') {
+			$prop_match = [];
+			if (preg_match(self::REGEX_PROP_START . self::REGEX_PROP_ADDITIONAL . self::REGEX_PROP_END, $property, $prop_match) === 1) {
+				if (empty($prop_match[1])) {
+					$this->setAdditionalProperties(true);
+				} else if ($prop_match[1] === '!') {
+					$this->setAdditionalProperties(false);
+				} else {
+					$this->setAdditionalProperties(self::typeFactory($this, $prop_match[1], "Unparseable additional properties definition: '...%s'"));
+				}
+				continue;
+			}
+			if (preg_match(self::REGEX_PROP_START . self::REGEX_PROP_NAME . self::REGEX_PROP_REQUIRED . self::REGEX_PROP_ASSIGN . self::REGEX_PROP_DEFINITION . self::REGEX_PROP_END, $property, $prop_match) !== 1) {
+				throw new Exception("Unparseable property definition: '{$property}'");
+			}
+			$this->properties[$prop_match[1]] = new Property($this, $prop_match[3]);
+			if ($prop_match[2] !== '!' && $prop_match[2] !== '?') {
+				$this->required[$prop_match[1]] = true;
+			}
+		}
 
-    }
+	}
 
-    /**
-     * @param string $definition
-     * @param string[] $match
-     * @throws Exception
-     */
-    private function parseRange($definition, $match)
-    {
-        if (!empty($match[3])) {
-            if ($match[4] === '' && $match[5] === '') {
-                throw new Exception("Empty object range: '{$definition}'");
-            }
+	/**
+	 * @param string $definition
+	 * @param string[] $match
+	 * @throws Exception
+	 */
+	private function parseRange($definition, $match)
+	{
+		if (!empty($match[3])) {
+			if ($match[4] === '' && $match[5] === '') {
+				throw new Exception("Empty object range: '{$definition}'");
+			}
 
-            $exclusiveMinimum = $match[3] == '<';
-            $this->minProperties = $match[4] === '' ? null : (int)$match[4];
-            $this->maxProperties = $match[5] === '' ? null : (int)$match[5];
-            $exclusiveMaximum = isset($match[6]) ? ($match[6] == '>') : null;
-            if ($this->minProperties && $this->maxProperties && $this->minProperties > $this->maxProperties) {
-                self::swap($this->minProperties, $this->maxProperties);
-                self::swap($exclusiveMinimum, $exclusiveMaximum);
-            }
-            $this->minProperties = $this->minProperties === null ? null : max(0, $exclusiveMinimum ? $this->minProperties + 1 : $this->minProperties);
-            $this->maxProperties = $this->maxProperties === null ? null : max(0, $exclusiveMaximum ? $this->maxProperties - 1 : $this->maxProperties);
-        }
-    }
+			$exclusiveMinimum = $match[3] == '<';
+			$this->minProperties = $match[4] === '' ? null : (int)$match[4];
+			$this->maxProperties = $match[5] === '' ? null : (int)$match[5];
+			$exclusiveMaximum = isset($match[6]) ? ($match[6] == '>') : null;
+			if ($this->minProperties && $this->maxProperties && $this->minProperties > $this->maxProperties) {
+				self::swap($this->minProperties, $this->maxProperties);
+				self::swap($exclusiveMinimum, $exclusiveMaximum);
+			}
+			$this->minProperties = $this->minProperties === null ? null : max(0, $exclusiveMinimum ? $this->minProperties + 1 : $this->minProperties);
+			$this->maxProperties = $this->maxProperties === null ? null : max(0, $exclusiveMaximum ? $this->maxProperties - 1 : $this->maxProperties);
+		}
+	}
 
 }

Spacing +5 added lines, -5 removed lines

@@ -120,18 +120,18 @@ 
                 return $this;
 
             case 'min':
-                $this->minProperties = (int)$data;
+                $this->minProperties = (int) $data;
                 if ($this->minProperties < 0) {
                     throw new Exception("Minimum less than zero: '{$data}'");
                 }
                 if ($this->maxProperties !== null && $this->minProperties > $this->maxProperties) {
                     throw new Exception("Minimum greater than maximum: '{$data}'");
                 }
-                $this->minProperties = (int)$data;
+                $this->minProperties = (int) $data;
                 return $this;
 
             case 'max':
-                $this->maxProperties = (int)$data;
+                $this->maxProperties = (int) $data;
                 if ($this->minProperties !== null && $this->minProperties > $this->maxProperties) {
                     throw new Exception("Maximum less than minimum: '{$data}'");
                 }
@@ -285,8 +285,8 @@ 
             }
 
             $exclusiveMinimum = $match[3] == '<';
-            $this->minProperties = $match[4] === '' ? null : (int)$match[4];
-            $this->maxProperties = $match[5] === '' ? null : (int)$match[5];
+            $this->minProperties = $match[4] === '' ? null : (int) $match[4];
+            $this->maxProperties = $match[5] === '' ? null : (int) $match[5];
             $exclusiveMaximum = isset($match[6]) ? ($match[6] == '>') : null;
             if ($this->minProperties && $this->maxProperties && $this->minProperties > $this->maxProperties) {
                 self::swap($this->minProperties, $this->maxProperties);