Zicht\Bundle\UrlBundle\Twig\UrlExtension

Complexity

Total Complexity

13

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Test Coverage

Coverage

93.55%

Importance

Changes	11
Bugs	2	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	staticRef()	0	17	4
A	getFunctions()	0	6	1
A	internalToPublicAliasing()	0	3	1
A	getName()	0	3	1
A	getFilters()	0	4	1
A	objectUrl()	0	16	4

<?php
/**
 * @author Gerard van Helden <gerard@zicht.nl>
 * @copyright Zicht Online <http://zicht.nl>
 */

namespace Zicht\Bundle\UrlBundle\Twig;

use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Zicht\Bundle\UrlBundle\Exception\UnsupportedException;

/**
 * Provides some twig utilities.
 */
class UrlExtension extends \Twig_Extension
{
    protected $provider;
    protected $aliasing;

    /**
     * Construct the extension with the passed object as provider. The provider is typically a DelegatingProvider
     * that delegates to all registered url providers.
     *
     * @param \Zicht\Bundle\UrlBundle\Url\Provider $provider
     * @param \Zicht\Bundle\UrlBundle\Aliasing\Aliasing $aliasing
     */
    public function __construct($provider, $aliasing = null)
    {
        $this->provider = $provider;
        $this->aliasing = $aliasing;
    }

    /**
     * @{inheritDoc}
     */
    public function getFilters()
    {
        return array(
            new \Twig_SimpleFilter('internal_to_public_aliasing', array($this, 'internalToPublicAliasing')),
        );
    }

    /**
     * Takes a HTML sting and replaces all internal urls with aliased public urls, i.e. /nl/page/42 -> /nl/bring-your-towel
     *
     * @param string $html
     * @return string
     *
     * @deprecated Should no longer be used, the aliasing is now handled by a response listener.
     */
    public function internalToPublicAliasing($html)
    {
        return $html;
    }

    /**
     * @{inheritDoc}
     */
    public function getFunctions()
    {
        return array(
            'object_url'       => new \Twig_SimpleFunction('object_url', [$this, 'objectUrl']),
            'static_ref'       => new \Twig_SimpleFunction('static_ref', [$this, 'staticRef']),
            'static_reference' => new \Twig_SimpleFunction('static_reference', [$this, 'staticRef'])
        );
    }


    /**
     * Returns an url based on the passed object.
     *
     * @param object $object
     * @param mixed $defaultIfNotFound
     * @param array $routerParams
     * @param bool $referenceType
     * @return string
     */
    public function objectUrl($object, $defaultIfNotFound = null, array $routerParams = [], $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)
    {
        try {
            $ret = $this->provider->url($object, $routerParams, $referenceType);

It seems like $referenceType can also be of type integer; however, parameter $referenceType of Zicht\Bundle\UrlBundle\Url\Provider::url() does only seem to accept boolean, maybe add an additional type check?

        } catch (UnsupportedException $e) {
            if (null === $defaultIfNotFound) {
                throw $e;
            } else {
                if (true === $defaultIfNotFound) {
                    $ret = (string)$object;
                } else {
                    $ret = $defaultIfNotFound;
                }
            }
        }
        return $ret;
    }

    /**
     * Returns a static reference, i.e. an url that is provided based on a simple string.
     *
     * @param string $name
     * @param array  $params
     *
     * @return string
     */
    public function staticRef($name, $params = null)
    {
        $name = (string)$name;
        if (!isset($this->static_refs[$name])) {
            try {
                $this->static_refs[$name] = $this->provider->url($name);
            } catch (UnsupportedException $e) {
                $this->static_refs[$name] = '/[static_reference: '. $name . ']';
            }
        }

        $ret = $this->static_refs[$name];
        if ($params) {
            $ret .= '?' . http_build_query($params, 0, '&');
        }

        return $ret;
    }
    private $static_refs = array();


    /**
     * Returns the name of the extension.
     *
     * @return string The extension name
     */
    public function getName()
    {
        return 'zicht_url';
    }
}