Slick\Mvc\Service\UriGenerator

Complexity

Total Complexity

11

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	generate()	0	6	1
A	addTransformer()	0	5	1
A	addDecorator()	0	5	1
A	setRequest()	0	5	1
A	fetchUrl()	0	14	3
A	decorate()	0	6	2
A	setContext()	0	6	2

<?php

/**
 * This file is part of slick/mvc package
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slick\Mvc\Service;

use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\UriInterface;
use Slick\Mvc\Service\UriGenerator\LocationTransformerInterface;
use Slick\Mvc\Service\UriGenerator\UriDecoratorInterface;

/**
 * Uri Generator
 *
 * @package Slick\Mvc\Service
 * @author  Filipe Silva <silvam.filipe@gmail.com>
 */
class UriGenerator implements UriGeneratorInterface
{

    /**
     * @var LocationTransformerInterface[]
     */
    private $transformers = [];

    /**
     * @var UriDecoratorInterface[]
     */
    private $decorators = [];

    /**
     * @var ServerRequestInterface
     */
    private $request;

    /**
     * Generates an URL location from provided data
     *
     * @param string $location Location name, path or identifier
     * @param array $options Filter options
     *
     * @return UriInterface|null
     */
    public function generate($location, array $options = [])
    {
        $uri = $this->fetchUrl($location, $options);
        $this->decorate($uri);
        return $uri;
    }

    /**
     * Adds a location transformer to the transformers stack
     *
     * @param LocationTransformerInterface $transformer
     *
     * @return self|UriGeneratorInterface
     */
    public function addTransformer(LocationTransformerInterface $transformer)
    {
        array_push($this->transformers, $transformer);
        return $this;
    }

    /**
     * Adds an URI decorator to the decorators list
     *
     * @param UriDecoratorInterface $decorator
     * @return mixed
     */
    public function addDecorator(UriDecoratorInterface $decorator)
    {
        array_push($this->decorators, $decorator);
        return $this;
    }

    /**
     * Set the context HTTP request
     *
     * @param ServerRequestInterface $request
     *
     * @return self|UriGeneratorInterface
     */
    public function setRequest(ServerRequestInterface $request)
    {
        $this->request = $request;
        return $this;
    }

    /**
     * Fetch the URI form the list of transformers
     *
     * The URI is the result of the first transformer that returns a
     * UriInterface object.
     *
     * @param string $location Location name, path or identifier
     * @param array $options   Filter options
     *
     * @return null|UriInterface
     */
    private function fetchUrl($location, array $options = [])
    {
        $uri = null;
        foreach ($this->transformers as $transformer) {
            $this->setContext($transformer);
            $object = $transformer->transform($location, $options);

            if ($object instanceof UriInterface) {
                $uri = $object;
                break;
            }
        }
        return $uri;
    }

    /**
     * Applies decorators to the provided URI
     *
     * @param UriInterface|null $uri
     */
    private function decorate(UriInterface $uri = null)
    {
        foreach ($this->decorators as $decorator) {
            $decorator->decorate($uri);
        }
    }

    /**
     * Sets the context HTTP request to provided transformer
     *
     * @param LocationTransformerInterface $transformer
     */
    private function setContext(LocationTransformerInterface $transformer)
    {
        if ($this->request) {
            $transformer->setRequest($this->request);
        }
    }
}