symfony/src/Symfony/Framework/WebBundle/Helper/RouterHelper.php

<?php

namespace Symfony\Framework\WebBundle\Helper;

use Symfony\Components\Templating\Helper\Helper;
use Symfony\Components\Routing\Router;

/*
 * This file is part of the Symfony framework.
 *
 * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

/**
 * RouterHelper.
 *
 * @package    Symfony
 * @subpackage Framework_WebBundle
 * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
 */
class RouterHelper extends Helper
{
  protected $generator;

  /**
   * Constructor.
   *
   * @param Router $router A Router instance
   */
  public function __construct(Router $router)
  {
    $this->generator = $router->getGenerator();
  }

  /**
   * Generates a URL from the given parameters.
   *
   * @param  string  $name       The name of the route
   * @param  array   $parameters An array of parameters
   * @param  Boolean $absolute   Whether to generate an absolute URL
   *
   * @return string The generated URL
   */
  public function generate($name, array $parameters = array(), $absolute = false)
  {
    return $this->generator->generate($name, $parameters, $absolute);
  }

  /**
   * Returns the canonical name of this helper.
   *
   * @return string The canonical name
   */
  public function getName()
  {
    return 'router';
  }
}