Sunrise\Http\Router\Annotation\Route

Complexity

Total Complexity

44

Size/Duplication

Total Lines	430
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	0	Features	0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	assertParamsContainValidHost()	0	5	3
A	assertParamsContainValidMethods()	0	12	5
A	getMethods()	0	3	1
A	assertParamsContainValidMiddlewares()	0	18	5
A	assertParamsContainValidPath()	0	5	3
A	assertParamsContainValidTags()	0	12	4
A	assertParamsContainValidSummary()	0	5	2
A	assertParamsContainValidAttributes()	0	5	2
A	getDescription()	0	3	1
A	getTags()	0	3	1
A	assertParamsContainValidPriority()	0	5	2
A	getSummary()	0	3	1
A	getName()	0	3	1
A	getPriority()	0	3	1
A	__construct()	0	38	2
A	assertParamsContainValidName()	0	5	3
A	getHost()	0	3	1
A	getMiddlewares()	0	3	1
A	getPath()	0	3	1
A	getAttributes()	0	3	1
A	assertParamsContainValidDescription()	0	5	3

<?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;

/**
 * Import classes
 */
use Psr\Http\Server\MiddlewareInterface;
use Sunrise\Http\Router\Exception\InvalidAnnotationParameterException;
use Sunrise\Http\Router\Exception\InvalidDescriptorArgumentException;
use Sunrise\Http\Router\RouteDescriptorInterface;

/**
 * Import functions
 */
use function is_array;
use function is_int;
use function is_null;
use function is_string;
use function is_subclass_of;
use function implode;

/**
 * Annotation for a route description
 *
 * @Annotation
 *
 * @Target({"CLASS"})
 */
final class Route implements RouteDescriptorInterface
{

    /**
     * A route name
     *
     * @var string
     *
     * @deprecated 2.6.0 The public property will be closed at the near time. Please use getters.
     */
    public $name;

    /**
     * A route host
     *
     * @var null|string
     */
    private $host;

    /**
     * A route path
     *
     * @var string
     *
     * @deprecated 2.6.0 The public property will be closed at the near time. Please use getters.
     */
    public $path;

    /**
     * A route methods
     *
     * @var array
     *
     * @deprecated 2.6.0 The public property will be closed at the near time. Please use getters.
     */
    public $methods;

    /**
     * A route middlewares
     *
     * @var array
     *
     * @deprecated 2.6.0 The public property will be closed at the near time. Please use getters.
     */
    public $middlewares;

    /**
     * A route attributes
     *
     * @var array
     *
     * @deprecated 2.6.0 The public property will be closed at the near time. Please use getters.
     */
    public $attributes;

    /**
     * A route summary
     *
     * @var string
     *
     * @since 2.4.0
     *
     * @deprecated 2.6.0 The public property will be closed at the near time. Please use getters.
     */
    public $summary;

    /**
     * A route description
     *
     * @var array|string
     *
     * @since 2.4.0
     *
     * @deprecated 2.6.0 The public property will be closed at the near time. Please use getters.
     */
    public $description;

    /**
     * A route tags
     *
     * @var array
     *
     * @since 2.4.0
     *
     * @deprecated 2.6.0 The public property will be closed at the near time. Please use getters.
     */
    public $tags;

    /**
     * A route priority
     *
     * @var int
     *
     * @deprecated 2.6.0 The public property will be closed at the near time. Please use getters.
     */
    public $priority;

    /**
     * Constructor of the annotation
     *
     * @param array $params
     *
     * @throws InvalidDescriptorArgumentException
     */
    public function __construct(array $params)
    {
        $params += [
            'host' => null,
            'middlewares' => [],
            'attributes' => [],
            'summary' => '',
            'description' => '',
            'tags' => [],
            'priority' => 0,
        ];

        $this->assertParamsContainValidName($params);
        $this->assertParamsContainValidHost($params);
        $this->assertParamsContainValidPath($params);
        $this->assertParamsContainValidMethods($params);
        $this->assertParamsContainValidMiddlewares($params);
        $this->assertParamsContainValidAttributes($params);
        $this->assertParamsContainValidSummary($params);
        $this->assertParamsContainValidDescription($params);
        $this->assertParamsContainValidTags($params);
        $this->assertParamsContainValidPriority($params);

        // Opportunity for concatenation...
        if (is_array($params['description'])) {
            $params['description'] = implode($params['description']);
        }

        $this->name = $params['name'];

The property Sunrise\Http\Router\Annotation\Route::$name has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

        $this->host = $params['host'];
        $this->path = $params['path'];

The property Sunrise\Http\Router\Annotation\Route::$path has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

        $this->methods = $params['methods'];

The property Sunrise\Http\Router\Annotation\Route::$methods has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

        $this->middlewares = $params['middlewares'];

The property Sunrise\Http\Router\Annotation\Route::$middlewares has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

        $this->attributes = $params['attributes'];

The property Sunrise\Http\Router\Annotation\Route::$attributes has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

        $this->summary = $params['summary'];

The property Sunrise\Http\Router\Annotation\Route::$summary has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

        $this->description = $params['description'];

The property Sunrise\Http\Router\Annotation\Route::$description has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

        $this->tags = $params['tags'];

The property Sunrise\Http\Router\Annotation\Route::$tags has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

        $this->priority = $params['priority'];

The property Sunrise\Http\Router\Annotation\Route::$priority has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

    }

    /**
     * {@inheritDoc}
     *
     * @since 2.6.0
     */
    public function getName() : string
    {
        return $this->name;

The property Sunrise\Http\Router\Annotation\Route::$name has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

    }

    /**
     * {@inheritDoc}
     *
     * @since 2.6.0
     */
    public function getHost() : ?string
    {
        return $this->host;
    }

    /**
     * {@inheritDoc}
     *
     * @since 2.6.0
     */
    public function getPath() : string
    {
        return $this->path;

The property Sunrise\Http\Router\Annotation\Route::$path has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

    }

    /**
     * {@inheritDoc}
     *
     * @since 2.6.0
     */
    public function getMethods() : array
    {
        return $this->methods;

The property Sunrise\Http\Router\Annotation\Route::$methods has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

    }

    /**
     * {@inheritDoc}
     *
     * @since 2.6.0
     */
    public function getMiddlewares() : array
    {
        return $this->middlewares;

The property Sunrise\Http\Router\Annotation\Route::$middlewares has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

    }

    /**
     * {@inheritDoc}
     *
     * @since 2.6.0
     */
    public function getAttributes() : array
    {
        return $this->attributes;

The property Sunrise\Http\Router\Annotation\Route::$attributes has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

    }

    /**
     * {@inheritDoc}
     *
     * @since 2.6.0
     */
    public function getSummary() : string
    {
        return $this->summary;

The property Sunrise\Http\Router\Annotation\Route::$summary has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

    }

    /**
     * {@inheritDoc}
     *
     * @since 2.6.0
     */
    public function getDescription() : string
    {
        return $this->description;

The property Sunrise\Http\Router\Annotation\Route::$description has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

The expression return $this->description could return the type array which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritDoc}
     *
     * @since 2.6.0
     */
    public function getTags() : array
    {
        return $this->tags;

The property Sunrise\Http\Router\Annotation\Route::$tags has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

    }

    /**
     * {@inheritDoc}
     *
     * @since 2.6.0
     */
    public function getPriority() : int
    {
        return $this->priority;

The property Sunrise\Http\Router\Annotation\Route::$priority has been deprecated: 2.6.0 The public property will be closed at the near time. Please use getters.

    }

    /**
     * @param array $params
     *
     * @return void
     *
     * @throws InvalidDescriptorArgumentException
     */
    private function assertParamsContainValidName(array $params) : void
    {
        if (empty($params['name']) || !is_string($params['name'])) {
            throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                '@Route.name must be not an empty string.'
            );
        }
    }

    /**
     * @param array $params
     *
     * @return void
     *
     * @throws InvalidDescriptorArgumentException
     */
    private function assertParamsContainValidHost(array $params) : void
    {
        if (!is_null($params['host']) && !is_string($params['host'])) {
            throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                '@Route.host must be null or string.'
            );
        }
    }

    /**
     * @param array $params
     *
     * @return void
     *
     * @throws InvalidDescriptorArgumentException
     */
    private function assertParamsContainValidPath(array $params) : void
    {
        if (empty($params['path']) || !is_string($params['path'])) {
            throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                '@Route.path must be not an empty string.'
            );
        }
    }

    /**
     * @param array $params
     *
     * @return void
     *
     * @throws InvalidDescriptorArgumentException
     */
    private function assertParamsContainValidMethods(array $params) : void
    {
        if (empty($params['methods']) || !is_array($params['methods'])) {
            throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                '@Route.methods must be not an empty array.'
            );
        }

        foreach ($params['methods'] as $method) {
            if (!is_string($method)) {
                throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                    '@Route.methods must contain only strings.'
                );
            }
        }
    }

    /**
     * @param array $params
     *
     * @return void
     *
     * @throws InvalidDescriptorArgumentException
     */
    private function assertParamsContainValidMiddlewares(array $params) : void
    {
        if (!is_array($params['middlewares'])) {
            throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                '@Route.middlewares must be an array.'
            );
        }

        foreach ($params['middlewares'] as $middleware) {
            if (!is_string($middleware)) {
                throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                    '@Route.middlewares must contain only strings.'
                );
            }

            if (!is_subclass_of($middleware, MiddlewareInterface::class)) {
                throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                    '@Route.middlewares contains a nonexistent or non-middleware class.'
                );
            }
        }
    }

    /**
     * @param array $params
     *
     * @return void
     *
     * @throws InvalidDescriptorArgumentException
     */
    private function assertParamsContainValidAttributes(array $params) : void
    {
        if (!is_array($params['attributes'])) {
            throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                '@Route.attributes must be an array.'
            );
        }
    }

    /**
     * @param array $params
     *
     * @return void
     *
     * @throws InvalidDescriptorArgumentException
     */
    private function assertParamsContainValidSummary(array $params) : void
    {
        if (!is_string($params['summary'])) {
            throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                '@Route.summary must be a string.'
            );
        }
    }

    /**
     * @param array $params
     *
     * @return void
     *
     * @throws InvalidDescriptorArgumentException
     */
    private function assertParamsContainValidDescription(array $params) : void
    {
        if (!is_array($params['description']) && !is_string($params['description'])) {
            throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                '@Route.description must be an array or a string.'
            );
        }
    }

    /**
     * @param array $params
     *
     * @return void
     *
     * @throws InvalidDescriptorArgumentException
     */
    private function assertParamsContainValidTags(array $params) : void
    {
        if (!is_array($params['tags'])) {
            throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                '@Route.tags must be an array.'
            );
        }

        foreach ($params['tags'] as $middleware) {
            if (!is_string($middleware)) {
                throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                    '@Route.tags must contain only strings.'
                );
            }
        }
    }

    /**
     * @param array $params
     *
     * @return void
     *
     * @throws InvalidDescriptorArgumentException
     */
    private function assertParamsContainValidPriority(array $params) : void
    {
        if (!is_int($params['priority'])) {
            throw new InvalidAnnotationParameterException(

The class Sunrise\Http\Router\Exception\InvalidAnnotationParameterException has been deprecated: 2.6.0 The exception will be removed at the near time.

                '@Route.priority must be an integer.'
            );
        }
    }
}