interface PagedRouteProviderInterface in Zircon Profile 8

Interface for a provider which allows to retrieve a limited amount of routes.

Hierarchy

• interface \Symfony\Cmf\Component\Routing\RouteProviderInterface
  • interface \Symfony\Cmf\Component\Routing\PagedRouteProviderInterface

1 file declares its use of PagedRouteProviderInterface

RouteProvider.php in core/lib/Drupal/Core/Routing/RouteProvider.php

Contains \Drupal\Core\Routing\RouteProvider.

File

vendor/symfony-cmf/routing/PagedRouteProviderInterface.php, line 17

Namespace

Symfony\Cmf\Component\Routing

interface PagedRouteProviderInterface extends RouteProviderInterface {

  /**
   * Find an amount of routes with an offset and possible a limit.
   *
   * In case you want to iterate over all routes, you want to avoid to load
   * all routes at once.
   *
   * @param int $offset
   *   The sequence will start with that offset in the list of all routes.
   * @param int $length [optional]
   *   The sequence will have that many routes in it. If no length is
   *   specified all routes are returned.
   *
   * @return \Symfony\Component\Routing\Route[]
   *   Routes keyed by the route name.
   */
  public function getRoutesPaged($offset, $length = null);

  /**
   * Determines the total amount of routes.
   *
   * @return int
   */
  public function getRoutesCount();

}

Members

Name	Modifiers	Type	Description	Overrides
PagedRouteProviderInterface::getRoutesCount	public	function	Determines the total amount of routes.	1
PagedRouteProviderInterface::getRoutesPaged	public	function	Find an amount of routes with an offset and possible a limit.	1
RouteProviderInterface::getRouteByName	public	function	Find the route using the provided route name.	2
RouteProviderInterface::getRouteCollectionForRequest	public	function	Finds routes that may potentially match the request.	2
RouteProviderInterface::getRoutesByNames	public	function	Find many routes by their names using the provided list of names.	2