annotate vendor/symfony-cmf/routing/PagedRouteProviderInterface.php @ 19:fa3358dc1485 tip

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