RouterBuilder::setPatterns() - Code Metrics - Inspection of "Merge pull request #80 from sunrise-php/release/v2..." - sunrise-php/http-router - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 07b020...fc35ef )

by Anatoly

created 2021-10-12 01:55 UTC

RouterBuilder::setPatterns() A

↳ Parent: RouterBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	2
c	1
b	0
f	0
dl	0
loc	5
ccs	3
cts	3
cp	1
rs	10
cc	1
nc	1
nop	1
crap	1

<?php declare(strict_types=1);

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Fenric <[email protected]>
 * @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;

/**
 * Import classes
 */
use Psr\Container\ContainerInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\SimpleCache\CacheInterface;

/**
 * RouterBuilder
 *
 * @since 2.9.0
 */
final class RouterBuilder
{

    /**
     * @var ContainerInterface|null
     */
    private $container = null;

    /**
     * @var CacheInterface|null
     */
    private $cache = null;

    /**
     * @var string|null
     */
    private $cacheKey = null;

    /**
     * @var array<string, string>|null
     */
    private $patterns = null;

    /**
     * @var array<string, string[]>|null
     */
    private $hosts = null;

    /**
     * @var MiddlewareInterface[]|null
     */
    private $middlewares = null;

    /**
     * @var Loader\ConfigLoader|null
     */
    private $configLoader = null;

    /**
     * @var Loader\DescriptorLoader|null
     */
    private $descriptorLoader = null;

    /**
     * Sets the given container to the builder
     *
     * @param ContainerInterface|null $container
     *
     * @return self
     */
    public function setContainer(?ContainerInterface $container) : self
    {
        $this->container = $container;

        return $this;
    }

    /**
     * Sets the given cache to the builder
     *
     * @param CacheInterface|null $cache
     *
     * @return self
     */
    public function setCache(?CacheInterface $cache) : self
    {
        $this->cache = $cache;

        return $this;
    }

    /**
     * Sets the given cache key to the builder
     *
     * @param string|null $cacheKey
     *
     * @return self
     *
     * @since 2.10.0
     */
    public function setCacheKey(?string $cacheKey) : self
    {
        $this->cacheKey = $cacheKey;

        return $this;
    }

    /**
     * Uses the config loader when building
     *
     * @param string[] $resources
     *
     * @return self
     */
    public function useConfigLoader(array $resources) : self
    {
        $this->configLoader = new Loader\ConfigLoader();
        $this->configLoader->attachArray($resources);

        return $this;
    }

    /**
     * Uses the descriptor loader when building
     *
     * @param string[] $resources
     *
     * @return self
     */
    public function useDescriptorLoader(array $resources) : self
    {
        $this->descriptorLoader = new Loader\DescriptorLoader();
        $this->descriptorLoader->attachArray($resources);

        return $this;
    }

    /**
     * Uses the metadata loader when building
     *
     * Alias to the useDescriptorLoader method.
     *
     * @param string[] $resources
     *
     * @return self
     */
    public function useMetadataLoader(array $resources) : self
    {
        $this->useDescriptorLoader($resources);

        return $this;
    }

    /**
     * Sets the given patterns to the builder
     *
     * @param array<string, string>|null $patterns
     *
     * @return self
     *
     * @since 2.11.0
     */
    public function setPatterns(?array $patterns) : self
    {
        $this->patterns = $patterns;

        return $this;
    }

    /**
     * Sets the given hosts to the builder
     *
     * @param array<string, string[]>|null $hosts
     *
     * @return self
     */
    public function setHosts(?array $hosts) : self
    {
        $this->hosts = $hosts;

        return $this;
    }

    /**
     * Sets the given middlewares to the builder
     *
     * @param MiddlewareInterface[]|null $middlewares
     *
     * @return self
     */
    public function setMiddlewares(?array $middlewares) : self
    {
        $this->middlewares = $middlewares;

        return $this;
    }

    /**
     * Builds the router
     *
     * @return Router
     */
    public function build() : Router
    {
        $router = new Router();

        if (isset($this->configLoader)) {
            $this->configLoader->setContainer($this->container);
                                 setContainer($this->container);
            $router->load($this->configLoader);
            $router->load(/** @scrutinizer ignore-type */ $this->configLoader);
        }

        if (isset($this->descriptorLoader)) {
            $this->descriptorLoader->setContainer($this->container);
                                     setContainer($this->container);
            $this->descriptorLoader->setCache($this->cache);
            $this->descriptorLoader->setCacheKey($this->cacheKey);
            $router->load($this->descriptorLoader);
        }

        if (!empty($this->patterns)) {
            $router->addPatterns($this->patterns);
        }

        if (!empty($this->hosts)) {
            $router->addHosts($this->hosts);
        }

        if (!empty($this->middlewares)) {
            $router->addMiddleware(...$this->middlewares);
        }

        return $router;
    }
}


sunrise-php / http-router

Push — master ( 07b020...fc35ef )

RouterBuilder::setPatterns() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like