Your IP : 216.73.216.81
<?php
declare(strict_types=1);
namespace Laminas\View\Helper;
use Laminas\Mvc\ModuleRouteListener;
use Laminas\Router\RouteMatch;
use Laminas\Router\RouteStackInterface;
use Laminas\View\Exception;
use Traversable;
use function array_merge;
use function func_num_args;
use function get_debug_type;
use function is_array;
use function is_bool;
use function iterator_to_array;
use function sprintf;
/**
* Helper for making easy links and getting urls that depend on the routes and router.
*/
class Url extends AbstractHelper
{
/**
* Router instance.
*
* @var RouteStackInterface|null
*/
protected $router;
/**
* Route matches returned by the router.
*
* @var RouteMatch|null
*/
protected $routeMatch;
/**
* Generates an url given the name of a route.
*
* @see \Laminas\Router\RouteInterface::assemble()
*
* @param string|null $name Name of the route
* @param array $params Parameters for the link
* @param array|Traversable $options Options for the route
* @param bool $reuseMatchedParams Whether to reuse matched parameters
* @return string Url For the link href attribute
* @throws Exception\RuntimeException If no RouteStackInterface was provided.
* @throws Exception\RuntimeException If no RouteMatch was provided.
* @throws Exception\RuntimeException If RouteMatch didn't contain a matched route name.
* @throws Exception\InvalidArgumentException If the params object was not an array or Traversable object.
*/
public function __invoke($name = null, $params = [], $options = [], $reuseMatchedParams = false)
{
if (null === $this->router) {
throw new Exception\RuntimeException('No RouteStackInterface instance provided');
}
if (3 === func_num_args() && is_bool($options)) {
$reuseMatchedParams = $options;
$options = [];
}
if ($name === null) {
if ($this->routeMatch === null) {
throw new Exception\RuntimeException('No RouteMatch instance provided');
}
/** @psalm-suppress RedundantCastGivenDocblockType */
$name = (string) $this->routeMatch->getMatchedRouteName();
if ($name === '') {
throw new Exception\RuntimeException('RouteMatch does not contain a matched route name');
}
}
if (! is_array($params)) {
if (! $params instanceof Traversable) {
throw new Exception\InvalidArgumentException(
'Params is expected to be an array or a Traversable object'
);
}
$params = iterator_to_array($params);
}
if ($reuseMatchedParams && $this->routeMatch !== null) {
$routeMatchParams = $this->routeMatch->getParams();
if (isset($routeMatchParams[ModuleRouteListener::ORIGINAL_CONTROLLER])) {
$routeMatchParams['controller'] = $routeMatchParams[ModuleRouteListener::ORIGINAL_CONTROLLER];
unset($routeMatchParams[ModuleRouteListener::ORIGINAL_CONTROLLER]);
}
if (isset($routeMatchParams[ModuleRouteListener::MODULE_NAMESPACE])) {
unset($routeMatchParams[ModuleRouteListener::MODULE_NAMESPACE]);
}
$params = array_merge($routeMatchParams, $params);
}
$options['name'] = $name;
return (string) $this->router->assemble($params, $options);
}
/**
* Set the router to use for assembling.
*
* @param RouteStackInterface $router
* @return Url
* @throws Exception\InvalidArgumentException For invalid router types.
* @psalm-suppress DocblockTypeContradiction
*/
public function setRouter($router)
{
if (! $router instanceof RouteStackInterface) {
throw new Exception\InvalidArgumentException(sprintf(
'%s expects a %s instance; received %s',
__METHOD__,
RouteStackInterface::class,
get_debug_type($router),
));
}
$this->router = $router;
return $this;
}
/**
* Set route match returned by the router.
*
* @param RouteMatch $routeMatch
* @return Url
*/
public function setRouteMatch($routeMatch)
{
if (! $routeMatch instanceof RouteMatch) {
throw new Exception\InvalidArgumentException(sprintf(
'%s expects a %s instance; received %s',
__METHOD__,
RouteMatch::class,
get_debug_type($routeMatch),
));
}
$this->routeMatch = $routeMatch;
return $this;
}
}