Sunrise\Http\Router\OpenApi\SecurityScheme

Complexity

Total Complexity

10

Size/Duplication

Total Lines	158
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	2

10 Methods

Rating	Name	Duplication	Size	Complexity
A	setIn()	0	3	1
A	__construct()	0	4	1
A	setBearerFormat()	0	3	1
A	setScheme()	0	3	1
A	setName()	0	3	1
A	getComponentName()	0	3	1
A	setDescription()	0	3	1
A	getReferenceName()	0	3	1
A	setOpenIdConnectUrl()	0	3	1
A	setFlows()	0	3	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\OpenApi;

/**
 * OAS Security Scheme Object
 *
 * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#security-scheme-object
 */
class SecurityScheme extends AbstractObject implements ComponentObjectInterface
{

    /**
     * @var string
     */
    private $refName;

    /**
     * @var string
     *
     * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#user-content-securityschemetype
     */
    protected $type;

    /**
     * @var string
     *
     * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#user-content-securityschemedescription
     */
    protected $description;

    /**
     * @var string
     *
     * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#user-content-securityschemename
     */
    protected $name;

    /**
     * @var string
     *
     * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#user-content-securityschemein
     */
    protected $in;

    /**
     * @var string
     *
     * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#user-content-securityschemescheme
     */
    protected $scheme;

    /**
     * @var string
     *
     * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#user-content-securityschemebearerformat
     */
    protected $bearerFormat;

    /**
     * @var OAuthFlows
     *
     * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#user-content-securityschemeflows
     */
    protected $flows;

    /**
     * @var string
     *
     * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#user-content-securityschemeopenidconnecturl
     */
    protected $openIdConnectUrl;

    /**
     * @param string $refName
     * @param string $type
     */
    public function __construct(string $refName, string $type)
    {
        $this->refName = $refName;
        $this->type = $type;
    }

    /**
     * {@inheritDoc}
     */
    public function getComponentName() : string
    {
        return 'securitySchemes';
    }

    /**
     * {@inheritDoc}
     */
    public function getReferenceName() : string
    {
        return $this->refName;
    }

    /**
     * @param string $description
     *
     * @return void
     */
    public function setDescription(string $description) : void
    {
        $this->description = $description;
    }

    /**
     * @param string $name
     *
     * @return void
     */
    public function setName(string $name) : void
    {
        $this->name = $name;
    }

    /**
     * @param string $in
     *
     * @return void
     */
    public function setIn(string $in) : void
    {
        $this->in = $in;
    }

    /**
     * @param string $scheme
     *
     * @return void
     */
    public function setScheme(string $scheme) : void
    {
        $this->scheme = $scheme;
    }

    /**
     * @param string $bearerFormat
     *
     * @return void
     */
    public function setBearerFormat(string $bearerFormat) : void
    {
        $this->bearerFormat = $bearerFormat;
    }

    /**
     * @param OAuthFlows $flows
     *
     * @return void
     */
    public function setFlows(OAuthFlows $flows) : void
    {
        $this->flows = $flows;
    }

    /**
     * @param string $openIdConnectUrl
     *
     * @return void
     */
    public function setOpenIdConnectUrl(string $openIdConnectUrl) : void
    {
        $this->openIdConnectUrl = $openIdConnectUrl;
    }
}