www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony-cmf/routing/PagedRouteProviderInterface.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony CMF package.
   5  *
   6  * (c) 2011-2015 Symfony CMF
   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 /**
  13  * This file is part of the Symfony CMF package.
  14  *
  15  * (c) 2011-2014 Symfony CMF
  16  *
  17  * For the full copyright and license information, please view the LICENSE
  18  * file that was distributed with this source code.
  19  */
  20 /*
  21  * This file is part of the Symfony CMF package.
  22  *
  23  * (c) 2011-2015 Symfony CMF
  24  *
  25  * For the full copyright and license information, please view the LICENSE
  26  * file that was distributed with this source code.
  27  */
  28
  29 namespace Symfony\Cmf\Component\Routing;
  30
  31 /**
  32  * Interface for a provider which allows to retrieve a limited amount of routes.
  33  */
  34 interface PagedRouteProviderInterface extends RouteProviderInterface
  35 {
  36     /**
  37      * Find an amount of routes with an offset and possible a limit.
  38      *
  39      * In case you want to iterate over all routes, you want to avoid to load
  40      * all routes at once.
  41      *
  42      * @param int $offset
  43      *                    The sequence will start with that offset in the list of all routes.
  44      * @param int $length [optional]
  45      *                    The sequence will have that many routes in it. If no length is
  46      *                    specified all routes are returned.
  47      *
  48      * @return \Symfony\Component\Routing\Route[]
  49      *                                            Routes keyed by the route name.
  50      */
  51     public function getRoutesPaged($offset, $length = null);
  52
  53     /**
  54      * Determines the total amount of routes.
  55      *
  56      * @return int
  57      */
  58     public function getRoutesCount();
  59 }