[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /*
   4   * This file is part of the Symfony package.
   5   *
   6   * (c) Fabien Potencier <fabien@symfony.com>
   7   *
   8   * For the full copyright and license information, please view the LICENSE
   9   * file that was distributed with this source code.
  10   */
  11  
  12  namespace Symfony\Component\Routing;
  13  
  14  use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  15  use Symfony\Component\Routing\Matcher\UrlMatcherInterface;
  16  
  17  /**
  18   * RouterInterface is the interface that all Router classes must implement.
  19   *
  20   * This interface is the concatenation of UrlMatcherInterface and UrlGeneratorInterface.
  21   *
  22   * @author Fabien Potencier <fabien@symfony.com>
  23   */
  24  interface RouterInterface extends UrlMatcherInterface, UrlGeneratorInterface
  25  {
  26      /**
  27       * Gets the RouteCollection instance associated with this Router.
  28       *
  29       * WARNING: This method should never be used at runtime as it is SLOW.
  30       *          You might use it in a cache warmer though.
  31       *
  32       * @return RouteCollection A RouteCollection instance
  33       */
  34      public function getRouteCollection();
  35  }