vanderlee / PHPSwaggerGen

SwaggerGen/Swagger/Path.php

Indentation +97 added lines, -97 removed lines

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

Spacing +1 added lines, -1 removed lines

@@ -82,7 +82,7 @@
     public function toArray(): array
     {
         $methods = self::$methods;
-        uksort($this->operations, static function ($a, $b) use ($methods) {
+        uksort($this->operations, static function($a, $b) use ($methods) {
             return array_search($a, $methods, true) - array_search($b, $methods, true);
         });
 

SwaggerGen/Swagger/Schema.php

Indentation +83 added lines, -83 removed lines

@@ -17,88 +17,88 @@
 class Schema extends AbstractDocumentableObject implements IDefinition
 {
 
-    /**
-     * @var string
-     */
-    private $description;
-
-    /**
-     * @var string
-     */
-    private $title;
-
-    /**
-     * @var bool
-     */
-    private $readOnly;
-
-    /**
-     * @var AbstractType
-     */
-    private $type;
-
-    /**
-     * @param string $description
-     * @throws Exception
-     */
-    public function __construct(AbstractObject $parent, $definition = 'object', $description = null)
-    {
-        parent::__construct($parent);
-
-        // Check if definition set
-        if ($this->getSwagger()->hasDefinition($definition)) {
-            $this->type = new Type\ReferenceObjectType($this, $definition);
-        } else {
-            $this->type = Type\AbstractType::typeFactory($this, $definition);
-        }
-
-        $this->description = $description;
-    }
-
-    /**
-     * @param string $command
-     * @param string $data
-     * @return AbstractObject|boolean
-     * @throws Exception
-     */
-    public function handleCommand($command, $data = null)
-    {
-        // Pass through to Type
-        if ($this->type && $this->type->handleCommand($command, $data)) {
-            return $this;
-        }
-
-        // handle all the rest manually
-        switch (strtolower($command)) {
-            case 'description':
-                $this->description = $data;
-                return $this;
-
-            case 'title':
-                $this->title = $data;
-                return $this;
-        }
-
-        return parent::handleCommand($command, $data);
-    }
-
-    public function toArray(): array
-    {
-        return self::arrayFilterNull(array_merge($this->type->toArray(), array(
-            'title' => empty($this->title) ? null : $this->title,
-            'description' => empty($this->description) ? null : $this->description,
-            'readOnly' => $this->readOnly
-        ), parent::toArray()));
-    }
-
-    public function __toString()
-    {
-        return __CLASS__;
-    }
-
-    public function setReadOnly(): void
-    {
-        $this->readOnly = true;
-    }
+	/**
+	 * @var string
+	 */
+	private $description;
+
+	/**
+	 * @var string
+	 */
+	private $title;
+
+	/**
+	 * @var bool
+	 */
+	private $readOnly;
+
+	/**
+	 * @var AbstractType
+	 */
+	private $type;
+
+	/**
+	 * @param string $description
+	 * @throws Exception
+	 */
+	public function __construct(AbstractObject $parent, $definition = 'object', $description = null)
+	{
+		parent::__construct($parent);
+
+		// Check if definition set
+		if ($this->getSwagger()->hasDefinition($definition)) {
+			$this->type = new Type\ReferenceObjectType($this, $definition);
+		} else {
+			$this->type = Type\AbstractType::typeFactory($this, $definition);
+		}
+
+		$this->description = $description;
+	}
+
+	/**
+	 * @param string $command
+	 * @param string $data
+	 * @return AbstractObject|boolean
+	 * @throws Exception
+	 */
+	public function handleCommand($command, $data = null)
+	{
+		// Pass through to Type
+		if ($this->type && $this->type->handleCommand($command, $data)) {
+			return $this;
+		}
+
+		// handle all the rest manually
+		switch (strtolower($command)) {
+			case 'description':
+				$this->description = $data;
+				return $this;
+
+			case 'title':
+				$this->title = $data;
+				return $this;
+		}
+
+		return parent::handleCommand($command, $data);
+	}
+
+	public function toArray(): array
+	{
+		return self::arrayFilterNull(array_merge($this->type->toArray(), array(
+			'title' => empty($this->title) ? null : $this->title,
+			'description' => empty($this->description) ? null : $this->description,
+			'readOnly' => $this->readOnly
+		), parent::toArray()));
+	}
+
+	public function __toString()
+	{
+		return __CLASS__;
+	}
+
+	public function setReadOnly(): void
+	{
+		$this->readOnly = true;
+	}
 
 }

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;
-
-    /**
-     * @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, !str_ends_with($command, '?'));
-                $this->parameters[$parameter->getName()] = $parameter;
-                return $parameter;
-
-            case 'body':
-            case 'body?':
-                $parameter = new BodyParameter($this, $data, !str_ends_with($command, '?'));
-                $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|null
-     */
-    public function getId(): ?string
-    {
-        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;
+
+	/**
+	 * @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, !str_ends_with($command, '?'));
+				$this->parameters[$parameter->getName()] = $parameter;
+				return $parameter;
+
+			case 'body':
+			case 'body?':
+				$parameter = new BodyParameter($this, $data, !str_ends_with($command, '?'));
+				$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|null
+	 */
+	public function getId(): ?string
+	{
+		return $this->operationId;
+	}
+
+	public function __toString()
+	{
+		return __CLASS__ . ' ' . $this->summary;
+	}
 
 }

SwaggerGen/Swagger/BodyParameter.php

Indentation +72 added lines, -72 removed lines

@@ -15,77 +15,77 @@
 class BodyParameter extends AbstractObject implements IParameter
 {
 
-    /**
-     * @var string|boolean
-     */
-    private $name;
-    private $description;
-    private $required;
-
-    /**
-     * @var Schema
-     */
-    private $schema;
-
-    /**
-     * @throws Exception
-     */
-    public function __construct(AbstractObject $parent, $data, $required = false)
-    {
-        parent::__construct($parent);
-
-        $type = self::wordShift($data);
-        if (empty($type)) {
-            throw new Exception('No type definition for body parameter');
-        }
-
-        $this->name = self::wordShift($data);
-        if (empty($this->name)) {
-            throw new Exception('No name for body parameter');
-        }
-
-        $this->description = $data;
-        $this->required = (bool)$required;
-
-        $this->schema = new Schema($this, $type);
-    }
-
-    /**
-     * @param string $command
-     * @param string $data
-     * @return AbstractObject|boolean
-     * @throws Exception
-     */
-    public function handleCommand($command, $data = null)
-    {
-        // Pass through to Type
-        $return = $this->schema->handleCommand($command, $data);
-        if ($return) {
-            return $return;
-        }
-
-        return parent::handleCommand($command, $data);
-    }
-
-    public function toArray(): array
-    {
-        return self::arrayFilterNull(array_merge(array(
-            'name' => $this->name,
-            'in' => 'body',
-            'description' => empty($this->description) ? null : $this->description,
-            'required' => $this->required ? true : null,
-            'schema' => $this->schema->toArray(),
-        ), parent::toArray()));
-    }
-
-    public function __toString()
-    {
-        return __CLASS__ . ' ' . $this->name;
-    }
-
-    public function getName()
-    {
-        return $this->name;
-    }
+	/**
+	 * @var string|boolean
+	 */
+	private $name;
+	private $description;
+	private $required;
+
+	/**
+	 * @var Schema
+	 */
+	private $schema;
+
+	/**
+	 * @throws Exception
+	 */
+	public function __construct(AbstractObject $parent, $data, $required = false)
+	{
+		parent::__construct($parent);
+
+		$type = self::wordShift($data);
+		if (empty($type)) {
+			throw new Exception('No type definition for body parameter');
+		}
+
+		$this->name = self::wordShift($data);
+		if (empty($this->name)) {
+			throw new Exception('No name for body parameter');
+		}
+
+		$this->description = $data;
+		$this->required = (bool)$required;
+
+		$this->schema = new Schema($this, $type);
+	}
+
+	/**
+	 * @param string $command
+	 * @param string $data
+	 * @return AbstractObject|boolean
+	 * @throws Exception
+	 */
+	public function handleCommand($command, $data = null)
+	{
+		// Pass through to Type
+		$return = $this->schema->handleCommand($command, $data);
+		if ($return) {
+			return $return;
+		}
+
+		return parent::handleCommand($command, $data);
+	}
+
+	public function toArray(): array
+	{
+		return self::arrayFilterNull(array_merge(array(
+			'name' => $this->name,
+			'in' => 'body',
+			'description' => empty($this->description) ? null : $this->description,
+			'required' => $this->required ? true : null,
+			'schema' => $this->schema->toArray(),
+		), parent::toArray()));
+	}
+
+	public function __toString()
+	{
+		return __CLASS__ . ' ' . $this->name;
+	}
+
+	public function getName()
+	{
+		return $this->name;
+	}
 
 }

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;
-    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 (str_ends_with($command, '!')) {
-                    $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, !str_ends_with($command, '?'));
-                $this->parameters[$Parameter->getName()] = $Parameter;
-
-                return $Parameter;
-
-            case 'body':
-            case 'body?':
-                $Parameter = new BodyParameter($this, $data, !str_ends_with($command, '?'));
-                $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): bool
-    {
-        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): bool
-    {
-        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;
+	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 (str_ends_with($command, '!')) {
+					$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, !str_ends_with($command, '?'));
+				$this->parameters[$Parameter->getName()] = $Parameter;
+
+				return $Parameter;
+
+			case 'body':
+			case 'body?':
+				$Parameter = new BodyParameter($this, $data, !str_ends_with($command, '?'));
+				$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): bool
+	{
+		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): bool
+	{
+		return isset($this->definitions[$name]);
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	protected function getSwagger(): Swagger
+	{
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	protected function getTypeRegistry(): TypeRegistry
+	{
+		return $this->typeRegistry;
+	}
 
 }

SwaggerGen/Swagger/Response.php

Indentation +172 added lines, -172 removed lines

@@ -16,177 +16,177 @@
 class Response extends AbstractObject
 {
 
-    const OK = 200;
-    const CREATED = 201;
-    const ACCEPTED = 202;
-    const NON_AUTHORITATIVE_INFORMATION = 203;
-    const NO_CONTENT = 204;
-    const RESET_CONTENT = 205;
-    const PARTIAL_CONTENT = 206;
-    const BAD_REQUEST = 400;
-    const UNAUTHORIZED = 401;
-    const PAYMENT_REQUIRED = 402;
-    const FORBIDDEN = 403;
-    const NOT_FOUND = 404;
-    const METHOD_NOT_ALLOWED = 405;
-    const NOT_ACCEPTABLE = 406;
-    const PROXY_AUTHENTICATION_REQUIRED = 407;
-    const REQUEST_TIMEOUT = 408;
-    const CONFLICT = 409;
-    const GONE = 410;
-    const LENGTH_REQUIRED = 411;
-    const PRECONDITION_FAILED = 412;
-    const REQUEST_ENTITY_TOO_LARGE = 413;
-    const REQUEST_URI_TOO_LONG = 414;
-    const UNSUPPORTED_MEDIA_TYPE = 415;
-    const REQUESTED_RANGE_NOT_SATISFIABLE = 416;
-    const EXPECTATION_FAILED = 417;
-    const UNPROCESSABLE_ENTITY = 422;
-    const TOO_MANY_REQUESTS = 429;
-    const INTERNAL_SERVER_ERROR = 500;
-    const NOT_IMPLEMENTED = 501; // When method is supported for none of the resources
-
-    protected static $httpCodes = array(
-        self::OK => 'OK',
-        self::CREATED => 'Created',
-        self::ACCEPTED => 'Accepted',
-        self::NON_AUTHORITATIVE_INFORMATION => 'Non-Authoritative Information',
-        self::NO_CONTENT => 'No Content',
-        self::RESET_CONTENT => 'Reset Content',
-        self::PARTIAL_CONTENT => 'Partial Content',
-        self::BAD_REQUEST => 'Bad Request',
-        self::UNAUTHORIZED => 'Unauthorized',
-        self::PAYMENT_REQUIRED => 'Payment Required',
-        self::FORBIDDEN => 'Forbidden',
-        self::NOT_FOUND => 'Not Found',
-        self::METHOD_NOT_ALLOWED => 'Method Not Allowed',
-        self::NOT_ACCEPTABLE => 'Not Acceptable',
-        self::PROXY_AUTHENTICATION_REQUIRED => 'Proxy Authentication Required',
-        self::REQUEST_TIMEOUT => 'Request Timeout',
-        self::CONFLICT => 'Conflict',
-        self::GONE => 'Gone',
-        self::LENGTH_REQUIRED => 'Length Required',
-        self::PRECONDITION_FAILED => 'Precondition Failed',
-        self::REQUEST_ENTITY_TOO_LARGE => 'Request Entity Too Large',
-        self::REQUEST_URI_TOO_LONG => 'Request-URI Too Long',
-        self::UNSUPPORTED_MEDIA_TYPE => 'Unsupported Media Type',
-        self::REQUESTED_RANGE_NOT_SATISFIABLE => 'Requested Range Not Satisfiable',
-        self::EXPECTATION_FAILED => 'Expectation Failed',
-        self::UNPROCESSABLE_ENTITY => 'Unprocessable Entity',
-        self::TOO_MANY_REQUESTS => 'Too Many Requests',
-        self::INTERNAL_SERVER_ERROR => 'Internal Server Error',
-        self::NOT_IMPLEMENTED => 'Not Implemented',
-    );
-    private $description = '';
-    private $schema;
-
-    /**
-     * @var Header[]
-     */
-    private $Headers = [];
-
-    /**
-     * JSON examples
-     * @var array
-     */
-    private $examples = [];
-
-    /**
-     * @throws Exception
-     */
-    public function __construct(AbstractObject $parent, $code, $definition = null, $description = null)
-    {
-        parent::__construct($parent);
-
-        if ($definition) {
-            $this->schema = new Schema($this, $definition);
-        }
-
-        if (!empty($description)) {
-            $this->description = $description;
-        } elseif (isset(self::$httpCodes[$code])) {
-            $this->description = self::$httpCodes[$code];
-        }
-    }
-
-    public static function getCode($search)
-    {
-        static $lookup = null;
-
-        if (is_numeric($search)) {
-            return (int)$search;
-        }
-
-        // build static lookup table
-        if (!$lookup) {
-            $lookup = [];
-            foreach (self::$httpCodes as $code => $text) {
-                $lookup[preg_replace('/[^a-z]+/', '', strtolower($text))] = $code;
-            }
-        }
-
-        $search = preg_replace('/[^a-z]+/', '', strtolower($search));
-        return $lookup[$search] ?? null;
-    }
-
-    /**
-     * @param string $command
-     * @param string $data
-     * @return AbstractObject|boolean
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     */
-    public function handleCommand($command, $data = null)
-    {
-        switch (strtolower($command)) {
-            case 'header':
-                $type = self::wordShift($data);
-                if (empty($type)) {
-                    throw new Exception('Missing type for header');
-                }
-                $name = self::wordShift($data);
-                if (empty($name)) {
-                    throw new Exception('Missing name for header type \'' . $type . '\'');
-                }
-                $Header = new Header($this, $type, $data);
-                $this->Headers[$name] = $Header;
-                return $Header;
-
-            case 'example':
-                $name = self::wordShift($data);
-                if (empty($name)) {
-                    throw new Exception('Missing name for example');
-                }
-                if ($data === '') {
-                    throw new Exception('Missing content for example `' . $name . '`');
-                }
-                $json = preg_replace_callback('/([^{}:]+)/', static function ($match) {
-                    json_decode($match[1]);
-                    return json_last_error() === JSON_ERROR_NONE ? $match[1] : json_encode($match[1]);
-                }, trim($data));
-                $this->examples[$name] = json_decode($json, true);
-                return $this;
-        }
-
-        return parent::handleCommand($command, $data);
-    }
-
-    public function toArray(): array
-    {
-        return self::arrayFilterNull(array_merge(array(
-            'description' => $this->description,
-            'schema' => $this->schema?->toArray(),
-            'headers' => self::objectsToArray($this->Headers),
-            'examples' => $this->examples,
-        ), parent::toArray()));
-    }
-
-    public function __toString()
-    {
-        return __CLASS__;
-    }
+	const OK = 200;
+	const CREATED = 201;
+	const ACCEPTED = 202;
+	const NON_AUTHORITATIVE_INFORMATION = 203;
+	const NO_CONTENT = 204;
+	const RESET_CONTENT = 205;
+	const PARTIAL_CONTENT = 206;
+	const BAD_REQUEST = 400;
+	const UNAUTHORIZED = 401;
+	const PAYMENT_REQUIRED = 402;
+	const FORBIDDEN = 403;
+	const NOT_FOUND = 404;
+	const METHOD_NOT_ALLOWED = 405;
+	const NOT_ACCEPTABLE = 406;
+	const PROXY_AUTHENTICATION_REQUIRED = 407;
+	const REQUEST_TIMEOUT = 408;
+	const CONFLICT = 409;
+	const GONE = 410;
+	const LENGTH_REQUIRED = 411;
+	const PRECONDITION_FAILED = 412;
+	const REQUEST_ENTITY_TOO_LARGE = 413;
+	const REQUEST_URI_TOO_LONG = 414;
+	const UNSUPPORTED_MEDIA_TYPE = 415;
+	const REQUESTED_RANGE_NOT_SATISFIABLE = 416;
+	const EXPECTATION_FAILED = 417;
+	const UNPROCESSABLE_ENTITY = 422;
+	const TOO_MANY_REQUESTS = 429;
+	const INTERNAL_SERVER_ERROR = 500;
+	const NOT_IMPLEMENTED = 501; // When method is supported for none of the resources
+
+	protected static $httpCodes = array(
+		self::OK => 'OK',
+		self::CREATED => 'Created',
+		self::ACCEPTED => 'Accepted',
+		self::NON_AUTHORITATIVE_INFORMATION => 'Non-Authoritative Information',
+		self::NO_CONTENT => 'No Content',
+		self::RESET_CONTENT => 'Reset Content',
+		self::PARTIAL_CONTENT => 'Partial Content',
+		self::BAD_REQUEST => 'Bad Request',
+		self::UNAUTHORIZED => 'Unauthorized',
+		self::PAYMENT_REQUIRED => 'Payment Required',
+		self::FORBIDDEN => 'Forbidden',
+		self::NOT_FOUND => 'Not Found',
+		self::METHOD_NOT_ALLOWED => 'Method Not Allowed',
+		self::NOT_ACCEPTABLE => 'Not Acceptable',
+		self::PROXY_AUTHENTICATION_REQUIRED => 'Proxy Authentication Required',
+		self::REQUEST_TIMEOUT => 'Request Timeout',
+		self::CONFLICT => 'Conflict',
+		self::GONE => 'Gone',
+		self::LENGTH_REQUIRED => 'Length Required',
+		self::PRECONDITION_FAILED => 'Precondition Failed',
+		self::REQUEST_ENTITY_TOO_LARGE => 'Request Entity Too Large',
+		self::REQUEST_URI_TOO_LONG => 'Request-URI Too Long',
+		self::UNSUPPORTED_MEDIA_TYPE => 'Unsupported Media Type',
+		self::REQUESTED_RANGE_NOT_SATISFIABLE => 'Requested Range Not Satisfiable',
+		self::EXPECTATION_FAILED => 'Expectation Failed',
+		self::UNPROCESSABLE_ENTITY => 'Unprocessable Entity',
+		self::TOO_MANY_REQUESTS => 'Too Many Requests',
+		self::INTERNAL_SERVER_ERROR => 'Internal Server Error',
+		self::NOT_IMPLEMENTED => 'Not Implemented',
+	);
+	private $description = '';
+	private $schema;
+
+	/**
+	 * @var Header[]
+	 */
+	private $Headers = [];
+
+	/**
+	 * JSON examples
+	 * @var array
+	 */
+	private $examples = [];
+
+	/**
+	 * @throws Exception
+	 */
+	public function __construct(AbstractObject $parent, $code, $definition = null, $description = null)
+	{
+		parent::__construct($parent);
+
+		if ($definition) {
+			$this->schema = new Schema($this, $definition);
+		}
+
+		if (!empty($description)) {
+			$this->description = $description;
+		} elseif (isset(self::$httpCodes[$code])) {
+			$this->description = self::$httpCodes[$code];
+		}
+	}
+
+	public static function getCode($search)
+	{
+		static $lookup = null;
+
+		if (is_numeric($search)) {
+			return (int)$search;
+		}
+
+		// build static lookup table
+		if (!$lookup) {
+			$lookup = [];
+			foreach (self::$httpCodes as $code => $text) {
+				$lookup[preg_replace('/[^a-z]+/', '', strtolower($text))] = $code;
+			}
+		}
+
+		$search = preg_replace('/[^a-z]+/', '', strtolower($search));
+		return $lookup[$search] ?? null;
+	}
+
+	/**
+	 * @param string $command
+	 * @param string $data
+	 * @return AbstractObject|boolean
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	public function handleCommand($command, $data = null)
+	{
+		switch (strtolower($command)) {
+			case 'header':
+				$type = self::wordShift($data);
+				if (empty($type)) {
+					throw new Exception('Missing type for header');
+				}
+				$name = self::wordShift($data);
+				if (empty($name)) {
+					throw new Exception('Missing name for header type \'' . $type . '\'');
+				}
+				$Header = new Header($this, $type, $data);
+				$this->Headers[$name] = $Header;
+				return $Header;
+
+			case 'example':
+				$name = self::wordShift($data);
+				if (empty($name)) {
+					throw new Exception('Missing name for example');
+				}
+				if ($data === '') {
+					throw new Exception('Missing content for example `' . $name . '`');
+				}
+				$json = preg_replace_callback('/([^{}:]+)/', static function ($match) {
+					json_decode($match[1]);
+					return json_last_error() === JSON_ERROR_NONE ? $match[1] : json_encode($match[1]);
+				}, trim($data));
+				$this->examples[$name] = json_decode($json, true);
+				return $this;
+		}
+
+		return parent::handleCommand($command, $data);
+	}
+
+	public function toArray(): array
+	{
+		return self::arrayFilterNull(array_merge(array(
+			'description' => $this->description,
+			'schema' => $this->schema?->toArray(),
+			'headers' => self::objectsToArray($this->Headers),
+			'examples' => $this->examples,
+		), parent::toArray()));
+	}
+
+	public function __toString()
+	{
+		return __CLASS__;
+	}
 
 }

SwaggerGen/Swagger/Type/StringType.php

Indentation +194 added lines, -194 removed lines

@@ -15,199 +15,199 @@
 class StringType extends AbstractType
 {
 
-    private static $formats = array(
-        'string' => '',
-        'byte' => 'byte',
-        'binary' => 'binary',
-        'password' => 'password',
-        'enum' => '',
-    );
-
-    /**
-     * Name of the type
-     * @var string
-     */
-    protected $format = '';
-    protected $pattern;
-    protected $default;
-    protected $maxLength;
-    protected $minLength;
-    protected $enum = [];
-
-    /**
-     * @param string $command The comment command
-     * @param string $data Any data added after the command
-     * @return AbstractType|boolean
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     */
-    public function handleCommand($command, $data = null)
-    {
-        switch (strtolower($command)) {
-            case 'default':
-                $this->default = $this->validateDefault($data);
-                return $this;
-
-            case 'pattern':
-                $this->pattern = $data;
-                return $this;
-
-            case 'enum':
-                if ($this->minLength !== null || $this->maxLength !== null) {
-                    throw new Exception("Enumeration not allowed in ranged string: '{$data}'");
-                }
-                $words = self::wordSplit($data);
-                $this->enum = is_array($this->enum) ? array_merge($this->enum, $words) : $words;
-                return $this;
-        }
-
-        return parent::handleCommand($command, $data);
-    }
-
-    /**
-     * Validate a default string value, depending on subtype
-     *
-     * @param string $value the value to validate
-     * @return string the value after validation (might become trimmed)
-     * @throws Exception
-     */
-    protected function validateDefault($value): string
-    {
-        if (empty($value)) {
-            if ($this->format) {
-                $type = $this->format;
-            } else {
-                $type = $this->enum ? 'enum' : 'string';
-            }
-            throw new Exception("Empty {$type} default");
-        }
-
-        if (!empty($this->enum) && !in_array($value, $this->enum, true)) {
-            throw new Exception("Invalid enum default: '{$value}'");
-        }
-
-        if ($this->maxLength !== null && mb_strlen($value) > $this->maxLength) {
-            if ($this->format) {
-                $type = $this->format;
-            } else {
-                $type = $this->enum ? 'enum' : 'string';
-            }
-            throw new Exception("Default {$type} length beyond maximum: '{$value}'");
-        }
-
-        if ($this->minLength !== null && mb_strlen($value) < $this->minLength) {
-            if ($this->format) {
-                $type = $this->format;
-            } else {
-                $type = $this->enum ? 'enum' : 'string';
-            }
-            throw new Exception("Default {$type} length beyond minimum: '{$value}'");
-        }
-
-        return $value;
-    }
-
-    public function toArray(): array
-    {
-        return self::arrayFilterNull(array_merge(array(
-            'type' => 'string',
-            'format' => empty($this->format) ? null : $this->format,
-            'pattern' => $this->pattern,
-            'default' => $this->default,
-            'minLength' => $this->minLength ? (int)$this->minLength : null,
-            'maxLength' => $this->maxLength ? (int)$this->maxLength : null,
-            'enum' => $this->enum,
-        ), parent::toArray()));
-    }
-
-    public function __toString()
-    {
-        return __CLASS__;
-    }
-
-    /**
-     * @throws Exception
-     */
-    protected function parseDefinition($definition): void
-    {
-        $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}'");
-        }
-
-        $this->parseFormat($definition, $match);
-        $this->parseContent($definition, $match);
-        $this->parseRange($definition, $match);
-        $this->parseDefault($definition, $match);
-    }
-
-    /**
-     * @param string $definition
-     * @param string[] $match
-     * @throws Exception
-     */
-    private function parseFormat($definition, $match): void
-    {
-        $type = strtolower($match[1]);
-        if (!isset(self::$formats[$type])) {
-            throw new Exception("Not a string: '{$definition}'");
-        }
-        $this->format = self::$formats[$type];
-    }
-
-    /**
-     * @param string $definition
-     * @param string[] $match
-     */
-    private function parseContent($definition, $match): void
-    {
-        if (strtolower($match[1]) === 'enum') {
-            $this->enum = explode(',', $match[2]);
-        } else {
-            $this->pattern = empty($match[2]) ? null : $match[2];
-        }
-    }
-
-    /**
-     * @param string $definition
-     * @param string[] $match
-     * @throws Exception
-     * @throws Exception
-     */
-    private function parseRange($definition, $match): void
-    {
-
-        if (!empty($match[3])) {
-            if ($match[1] === 'enum') {
-                throw new Exception("Range not allowed in enumeration definition: '{$definition}'");
-            }
-            if ($match[4] === '' && $match[5] === '') {
-                throw new Exception("Empty string range: '{$definition}'");
-            }
-            $exclusiveMinimum = $match[3] === '<';
-            $this->minLength = $match[4] === '' ? null : $match[4];
-            $this->maxLength = $match[5] === '' ? null : $match[5];
-            $exclusiveMaximum = isset($match[6]) ? ($match[6] === '>') : null;
-            if ($this->minLength !== null && $this->maxLength !== null && $this->minLength > $this->maxLength) {
-                self::swap($this->minLength, $this->maxLength);
-                self::swap($exclusiveMinimum, $exclusiveMaximum);
-            }
-            $this->minLength = $this->minLength === null ? null : max(0, $exclusiveMinimum ? $this->minLength + 1 : $this->minLength);
-            $this->maxLength = $this->maxLength === null ? null : max(0, $exclusiveMaximum ? $this->maxLength - 1 : $this->maxLength);
-        }
-    }
-
-    /**
-     * @param string $definition
-     * @param string[] $match
-     * @throws Exception
-     */
-    private function parseDefault($definition, $match): void
-    {
-        $this->default = isset($match[7]) && $match[7] !== '' ? $this->validateDefault($match[7]) : null;
-    }
+	private static $formats = array(
+		'string' => '',
+		'byte' => 'byte',
+		'binary' => 'binary',
+		'password' => 'password',
+		'enum' => '',
+	);
+
+	/**
+	 * Name of the type
+	 * @var string
+	 */
+	protected $format = '';
+	protected $pattern;
+	protected $default;
+	protected $maxLength;
+	protected $minLength;
+	protected $enum = [];
+
+	/**
+	 * @param string $command The comment command
+	 * @param string $data Any data added after the command
+	 * @return AbstractType|boolean
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	public function handleCommand($command, $data = null)
+	{
+		switch (strtolower($command)) {
+			case 'default':
+				$this->default = $this->validateDefault($data);
+				return $this;
+
+			case 'pattern':
+				$this->pattern = $data;
+				return $this;
+
+			case 'enum':
+				if ($this->minLength !== null || $this->maxLength !== null) {
+					throw new Exception("Enumeration not allowed in ranged string: '{$data}'");
+				}
+				$words = self::wordSplit($data);
+				$this->enum = is_array($this->enum) ? array_merge($this->enum, $words) : $words;
+				return $this;
+		}
+
+		return parent::handleCommand($command, $data);
+	}
+
+	/**
+	 * Validate a default string value, depending on subtype
+	 *
+	 * @param string $value the value to validate
+	 * @return string the value after validation (might become trimmed)
+	 * @throws Exception
+	 */
+	protected function validateDefault($value): string
+	{
+		if (empty($value)) {
+			if ($this->format) {
+				$type = $this->format;
+			} else {
+				$type = $this->enum ? 'enum' : 'string';
+			}
+			throw new Exception("Empty {$type} default");
+		}
+
+		if (!empty($this->enum) && !in_array($value, $this->enum, true)) {
+			throw new Exception("Invalid enum default: '{$value}'");
+		}
+
+		if ($this->maxLength !== null && mb_strlen($value) > $this->maxLength) {
+			if ($this->format) {
+				$type = $this->format;
+			} else {
+				$type = $this->enum ? 'enum' : 'string';
+			}
+			throw new Exception("Default {$type} length beyond maximum: '{$value}'");
+		}
+
+		if ($this->minLength !== null && mb_strlen($value) < $this->minLength) {
+			if ($this->format) {
+				$type = $this->format;
+			} else {
+				$type = $this->enum ? 'enum' : 'string';
+			}
+			throw new Exception("Default {$type} length beyond minimum: '{$value}'");
+		}
+
+		return $value;
+	}
+
+	public function toArray(): array
+	{
+		return self::arrayFilterNull(array_merge(array(
+			'type' => 'string',
+			'format' => empty($this->format) ? null : $this->format,
+			'pattern' => $this->pattern,
+			'default' => $this->default,
+			'minLength' => $this->minLength ? (int)$this->minLength : null,
+			'maxLength' => $this->maxLength ? (int)$this->maxLength : null,
+			'enum' => $this->enum,
+		), parent::toArray()));
+	}
+
+	public function __toString()
+	{
+		return __CLASS__;
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	protected function parseDefinition($definition): void
+	{
+		$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}'");
+		}
+
+		$this->parseFormat($definition, $match);
+		$this->parseContent($definition, $match);
+		$this->parseRange($definition, $match);
+		$this->parseDefault($definition, $match);
+	}
+
+	/**
+	 * @param string $definition
+	 * @param string[] $match
+	 * @throws Exception
+	 */
+	private function parseFormat($definition, $match): void
+	{
+		$type = strtolower($match[1]);
+		if (!isset(self::$formats[$type])) {
+			throw new Exception("Not a string: '{$definition}'");
+		}
+		$this->format = self::$formats[$type];
+	}
+
+	/**
+	 * @param string $definition
+	 * @param string[] $match
+	 */
+	private function parseContent($definition, $match): void
+	{
+		if (strtolower($match[1]) === 'enum') {
+			$this->enum = explode(',', $match[2]);
+		} else {
+			$this->pattern = empty($match[2]) ? null : $match[2];
+		}
+	}
+
+	/**
+	 * @param string $definition
+	 * @param string[] $match
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	private function parseRange($definition, $match): void
+	{
+
+		if (!empty($match[3])) {
+			if ($match[1] === 'enum') {
+				throw new Exception("Range not allowed in enumeration definition: '{$definition}'");
+			}
+			if ($match[4] === '' && $match[5] === '') {
+				throw new Exception("Empty string range: '{$definition}'");
+			}
+			$exclusiveMinimum = $match[3] === '<';
+			$this->minLength = $match[4] === '' ? null : $match[4];
+			$this->maxLength = $match[5] === '' ? null : $match[5];
+			$exclusiveMaximum = isset($match[6]) ? ($match[6] === '>') : null;
+			if ($this->minLength !== null && $this->maxLength !== null && $this->minLength > $this->maxLength) {
+				self::swap($this->minLength, $this->maxLength);
+				self::swap($exclusiveMinimum, $exclusiveMaximum);
+			}
+			$this->minLength = $this->minLength === null ? null : max(0, $exclusiveMinimum ? $this->minLength + 1 : $this->minLength);
+			$this->maxLength = $this->maxLength === null ? null : max(0, $exclusiveMaximum ? $this->maxLength - 1 : $this->maxLength);
+		}
+	}
+
+	/**
+	 * @param string $definition
+	 * @param string[] $match
+	 * @throws Exception
+	 */
+	private function parseDefault($definition, $match): void
+	{
+		$this->default = isset($match[7]) && $match[7] !== '' ? $this->validateDefault($match[7]) : null;
+	}
 
 }

Upper-Lower-Casing +3 added lines, -3 removed lines

@@ -80,7 +80,7 @@ 
             } else {
                 $type = $this->enum ? 'enum' : 'string';
             }
-            throw new Exception("Empty {$type} default");
+            throw new Exception("empty {$type} default");
         }
 
         if (!empty($this->enum) && !in_array($value, $this->enum, true)) {
@@ -93,7 +93,7 @@ 
             } else {
                 $type = $this->enum ? 'enum' : 'string';
             }
-            throw new Exception("Default {$type} length beyond maximum: '{$value}'");
+            throw new Exception("default {$type} length beyond maximum: '{$value}'");
         }
 
         if ($this->minLength !== null && mb_strlen($value) < $this->minLength) {
@@ -102,7 +102,7 @@ 
             } else {
                 $type = $this->enum ? 'enum' : 'string';
             }
-            throw new Exception("Default {$type} length beyond minimum: '{$value}'");
+            throw new Exception("default {$type} length beyond minimum: '{$value}'");
         }
 
         return $value;

SwaggerGen/Swagger/Type/AbstractType.php

Indentation +190 added lines, -190 removed lines

@@ -15,195 +15,195 @@
  */
 abstract class AbstractType extends AbstractObject
 {
-    protected const REGEX_START = '/^';
-    protected const REGEX_FORMAT = '([a-z][a-z0-9]*)';
-    protected const REGEX_CONTENT = '(?:\((.*)\))?';
-    protected const REGEX_RANGE = '(?:([[<])(\\d*),(\\d*)([\\]>]))?';
-    protected const REGEX_DEFAULT = '(?:=(.+))?';
-    protected const REGEX_END = '$/i';
-
-    private static $classTypes = array(
-        'integer' => 'Integer',
-        'int' => 'Integer',
-        'int32' => 'Integer',
-        'int64' => 'Integer',
-        'long' => 'Integer',
-        'float' => 'Number',
-        'double' => 'Number',
-        'string' => 'String',
-        'uuid' => 'StringUuid',
-        'byte' => 'String',
-        'binary' => 'String',
-        'password' => 'String',
-        'enum' => 'String',
-        'boolean' => 'Boolean',
-        'bool' => 'Boolean',
-        'array' => 'Array',
-        'csv' => 'Array',
-        'ssv' => 'Array',
-        'tsv' => 'Array',
-        'pipes' => 'Array',
-        'date' => 'Date',
-        'datetime' => 'Date',
-        'date-time' => 'Date',
-        'object' => 'Object',
-        'refobject' => 'ReferenceObject',
-        'allof' => 'AllOf',
-    );
-
-    private $example;
-
-    /**
-     * @param AbstractObject $parent
-     * @param $definition
-     * @constructor
-     */
-    public function __construct(AbstractObject $parent, $definition)
-    {
-        parent::__construct($parent);
-
-        $this->parseDefinition($definition);
-    }
-
-    abstract protected function parseDefinition($definition);
-
-    /**
-     * @param AbstractObject $parent
-     * @param string $definition
-     * @param string $error
-     * @return self
-     * @throws Exception
-     */
-    public static function typeFactory($parent, $definition, $error = "Unparseable schema type definition: '%s'")
-    {
-        // Parse regex
-        $match = [];
-        if (preg_match('/^([a-z]+)/i', $definition, $match) === 1) {
-            $format = strtolower($match[1]);
-        } elseif (preg_match('/^(\[)(?:.*?)\]$/', $definition, $match) === 1) {
-            $format = 'array';
-        } elseif (preg_match('/^(\{)(?:.*?)\}$/', $definition, $match) === 1) {
-            $format = 'object';
-        } else {
-            throw new Exception(sprintf($error, $definition));
-        }
-
-        // Internal type if type known and not overwritten by definition
-        if ($parent->getTypeRegistry()->has($format)) {
-            $class = $parent->getTypeRegistry()->get($format);
-            return new $class($parent, $definition);
-        }
-
-        if (isset(self::$classTypes[$format])) {
-            $type = self::$classTypes[$format];
-            $class = "\\SwaggerGen\\Swagger\\Type\\{$type}Type";
-            return new $class($parent, $definition);
-        }
-
-        return new ReferenceObjectType($parent, $definition);
-    }
-
-    /**
-     * Swap values of two variables.
-     * Used for sorting.
-     * @param mixed $a
-     * @param mixed $b
-     */
-    protected static function swap(&$a, &$b): void
-    {
-        $tmp = $a;
-        $a = $b;
-        $b = $tmp;
-    }
-
-    /**
-     * @param string $list
-     * @return array
-     */
-    protected static function parseList($list): array
-    {
-        $ret = [];
-        while ($item = self::parseListItem($list)) {
-            $ret[] = $item;
-        }
-        return $ret;
-    }
-
-    /**
-     * Extract an item from a comma-separated list of items.
-     *
-     * i.e. `a(x(x,x)),b(x)` returns `a(x(x,x))` and changes `$list` into `b(x)`.
-     * Note: brace nesting is not checked, e.g. `a{b(})` is a valid list item.
-     *
-     * @param string $list the list to parse
-     * @return string the extracted item
-     */
-    protected static function parseListItem(&$list): string
-    {
-        $item = '';
-
-        $depth = 0;
-        $index = 0;
-        while ($index < strlen($list)) {
-            $c = $list[$index++];
-
-            if (str_contains('{([<', $c)) {
-                ++$depth;
-            } elseif (str_contains('})]>', $c)) {
-                --$depth;
-            } elseif ($c === ',' && $depth === 0) {
-                break;
-            }
-
-            $item .= $c;
-        }
-        $list = substr($list, $index);
-
-        return $item;
-    }
-
-    /**
-     * Overwrites default AbstractObject parser, since Types should not handle
-     * extensions themselves.
-     *
-     * @param string $command
-     * @param string $data
-     * @return AbstractType|boolean
-     * @throws Exception
-     */
-    public function handleCommand($command, $data = null)
-    {
-        if (strtolower($command) === 'example') {
-            if ($data === '') {
-                throw new Exception("Missing content for type example");
-            }
-            $json = preg_replace_callback('/([^{}:,]+)/', static function ($match) {
-                json_decode($match[1]);
-                return json_last_error() === JSON_ERROR_NONE ? $match[1] : json_encode($match[1]);
-            }, trim($data));
-            $this->example = json_decode($json, true);
-
-            // In case input contains special chars, the above preg_replace would fail
-            //   Input could be a well-formed json already though
-            if ($this->example === null) {
-                $this->example = json_decode($data, true);
-            }
-            // If all fails, use input as-is
-            if ($this->example === null) {
-                $this->example = $data;
-            }
-
-            return $this;
-        }
-
-        return false;
-    }
-
-    public function toArray(): array
-    {
-        return self::arrayFilterNull(array_merge(array(
-            'example' => $this->example,
-        ), parent::toArray()));
-    }
+	protected const REGEX_START = '/^';
+	protected const REGEX_FORMAT = '([a-z][a-z0-9]*)';
+	protected const REGEX_CONTENT = '(?:\((.*)\))?';
+	protected const REGEX_RANGE = '(?:([[<])(\\d*),(\\d*)([\\]>]))?';
+	protected const REGEX_DEFAULT = '(?:=(.+))?';
+	protected const REGEX_END = '$/i';
+
+	private static $classTypes = array(
+		'integer' => 'Integer',
+		'int' => 'Integer',
+		'int32' => 'Integer',
+		'int64' => 'Integer',
+		'long' => 'Integer',
+		'float' => 'Number',
+		'double' => 'Number',
+		'string' => 'String',
+		'uuid' => 'StringUuid',
+		'byte' => 'String',
+		'binary' => 'String',
+		'password' => 'String',
+		'enum' => 'String',
+		'boolean' => 'Boolean',
+		'bool' => 'Boolean',
+		'array' => 'Array',
+		'csv' => 'Array',
+		'ssv' => 'Array',
+		'tsv' => 'Array',
+		'pipes' => 'Array',
+		'date' => 'Date',
+		'datetime' => 'Date',
+		'date-time' => 'Date',
+		'object' => 'Object',
+		'refobject' => 'ReferenceObject',
+		'allof' => 'AllOf',
+	);
+
+	private $example;
+
+	/**
+	 * @param AbstractObject $parent
+	 * @param $definition
+	 * @constructor
+	 */
+	public function __construct(AbstractObject $parent, $definition)
+	{
+		parent::__construct($parent);
+
+		$this->parseDefinition($definition);
+	}
+
+	abstract protected function parseDefinition($definition);
+
+	/**
+	 * @param AbstractObject $parent
+	 * @param string $definition
+	 * @param string $error
+	 * @return self
+	 * @throws Exception
+	 */
+	public static function typeFactory($parent, $definition, $error = "Unparseable schema type definition: '%s'")
+	{
+		// Parse regex
+		$match = [];
+		if (preg_match('/^([a-z]+)/i', $definition, $match) === 1) {
+			$format = strtolower($match[1]);
+		} elseif (preg_match('/^(\[)(?:.*?)\]$/', $definition, $match) === 1) {
+			$format = 'array';
+		} elseif (preg_match('/^(\{)(?:.*?)\}$/', $definition, $match) === 1) {
+			$format = 'object';
+		} else {
+			throw new Exception(sprintf($error, $definition));
+		}
+
+		// Internal type if type known and not overwritten by definition
+		if ($parent->getTypeRegistry()->has($format)) {
+			$class = $parent->getTypeRegistry()->get($format);
+			return new $class($parent, $definition);
+		}
+
+		if (isset(self::$classTypes[$format])) {
+			$type = self::$classTypes[$format];
+			$class = "\\SwaggerGen\\Swagger\\Type\\{$type}Type";
+			return new $class($parent, $definition);
+		}
+
+		return new ReferenceObjectType($parent, $definition);
+	}
+
+	/**
+	 * Swap values of two variables.
+	 * Used for sorting.
+	 * @param mixed $a
+	 * @param mixed $b
+	 */
+	protected static function swap(&$a, &$b): void
+	{
+		$tmp = $a;
+		$a = $b;
+		$b = $tmp;
+	}
+
+	/**
+	 * @param string $list
+	 * @return array
+	 */
+	protected static function parseList($list): array
+	{
+		$ret = [];
+		while ($item = self::parseListItem($list)) {
+			$ret[] = $item;
+		}
+		return $ret;
+	}
+
+	/**
+	 * Extract an item from a comma-separated list of items.
+	 *
+	 * i.e. `a(x(x,x)),b(x)` returns `a(x(x,x))` and changes `$list` into `b(x)`.
+	 * Note: brace nesting is not checked, e.g. `a{b(})` is a valid list item.
+	 *
+	 * @param string $list the list to parse
+	 * @return string the extracted item
+	 */
+	protected static function parseListItem(&$list): string
+	{
+		$item = '';
+
+		$depth = 0;
+		$index = 0;
+		while ($index < strlen($list)) {
+			$c = $list[$index++];
+
+			if (str_contains('{([<', $c)) {
+				++$depth;
+			} elseif (str_contains('})]>', $c)) {
+				--$depth;
+			} elseif ($c === ',' && $depth === 0) {
+				break;
+			}
+
+			$item .= $c;
+		}
+		$list = substr($list, $index);
+
+		return $item;
+	}
+
+	/**
+	 * Overwrites default AbstractObject parser, since Types should not handle
+	 * extensions themselves.
+	 *
+	 * @param string $command
+	 * @param string $data
+	 * @return AbstractType|boolean
+	 * @throws Exception
+	 */
+	public function handleCommand($command, $data = null)
+	{
+		if (strtolower($command) === 'example') {
+			if ($data === '') {
+				throw new Exception("Missing content for type example");
+			}
+			$json = preg_replace_callback('/([^{}:,]+)/', static function ($match) {
+				json_decode($match[1]);
+				return json_last_error() === JSON_ERROR_NONE ? $match[1] : json_encode($match[1]);
+			}, trim($data));
+			$this->example = json_decode($json, true);
+
+			// In case input contains special chars, the above preg_replace would fail
+			//   Input could be a well-formed json already though
+			if ($this->example === null) {
+				$this->example = json_decode($data, true);
+			}
+			// If all fails, use input as-is
+			if ($this->example === null) {
+				$this->example = $data;
+			}
+
+			return $this;
+		}
+
+		return false;
+	}
+
+	public function toArray(): array
+	{
+		return self::arrayFilterNull(array_merge(array(
+			'example' => $this->example,
+		), parent::toArray()));
+	}
 
 }

SwaggerGen/Swagger/Type/ReferenceObjectType.php

Indentation +43 added lines, -43 removed lines

@@ -15,48 +15,48 @@
 class ReferenceObjectType extends AbstractType
 {
 
-    private $reference;
-
-    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): void
-    {
-        $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;
+
+	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): void
+	{
+		$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;
+	}
 
 }