Yiisoft\Router\Attribute\Options

Complexity

Total Complexity

2

Size/Duplication

Total Lines	36
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getRoute()	0	3	1
A	__construct()	0	18	1

<?php

declare(strict_types=1);

namespace Yiisoft\Router\Attribute;

use Attribute;
use Stringable;
use Yiisoft\Http\Method;
use Yiisoft\Router\Route;

This use statement conflicts with another class in this namespace, Yiisoft\Router\Attribute\Route. Consider defining an alias.

#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
final class Options implements RouteAttributeInterface
{
    private Route $route;

    /**
     * @param array<string,scalar|Stringable|null> $defaults Parameter default values indexed by parameter names.
     * @param bool $override Marks route as override. When added it will replace existing route with the same name.
     * @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.
     * It is useful to avoid invoking one of the parent group middleware for
     * a certain route.
     */
    public function __construct(
        string $pattern,
        ?string $name = null,
        array $middlewares = [],
        array $defaults = [],
        array $hosts = [],
        bool $override = false,
        array $disabledMiddlewares = []
    ) {
        $this->route = new Route(
            methods: [Method::OPTIONS],
            pattern: $pattern,
            name: $name,
            middlewareDefinitions: $middlewares,
            defaults: $defaults,
            hosts: $hosts,
            override: $override,
            disabledMiddlewareDefinitions: $disabledMiddlewares
        );
    }

    public function getRoute(): Route
    {
        return $this->route;
    }
}