Sunrise\Http\Router\Annotation\OpenApi\Parameter

Complexity

Total Complexity

1

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	toArray()	0	12	1

<?php declare(strict_types=1);

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Fenric <anatoly@fenric.ru>
 * @copyright Copyright (c) 2018, Anatoly Fenric
 * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE
 * @link https://github.com/sunrise-php/http-router
 */

namespace Sunrise\Http\Router\Annotation\OpenApi;

/**
 * @Annotation
 *
 * @Target({"ANNOTATION"})
 */
final class Parameter
{

    /**
     * @Required
     *
     * @Enum({"cookie", "header", "query"})
     *
     * @var string
     */
    public $in;

    /**
     * @Required
     *
     * @var string
     */
    public $name;

    /**
     * @var string
     */
    public $description = '';

    /**
     * @var bool
     */
    public $deprecated = false;

    /**
     * @var bool
     */
    public $required = false;

    /**
     * @var bool
     */
    public $allowEmptyValue = false;

    /**
     * @return array
     */
    public function toArray() : array
    {
        $result = [
            'in' => $this->in,
            'name' => $this->name,
            'description' => $this->description,
            'deprecated' => $this->deprecated,
            'required' => $this->required,
            'allowEmptyValue' => $this->allowEmptyValue,
        ];

        return $result;
    }
}