Mercurial > hg > cmmr2012-drupal-site
diff vendor/symfony-cmf/routing/PagedRouteProviderInterface.php @ 0:c75dbcec494b
Initial commit from drush-created site
author | Chris Cannam |
---|---|
date | Thu, 05 Jul 2018 14:24:15 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/vendor/symfony-cmf/routing/PagedRouteProviderInterface.php Thu Jul 05 14:24:15 2018 +0000 @@ -0,0 +1,59 @@ +<?php + +/* + * This file is part of the Symfony CMF package. + * + * (c) 2011-2015 Symfony CMF + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/** + * This file is part of the Symfony CMF package. + * + * (c) 2011-2014 Symfony CMF + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +/* + * This file is part of the Symfony CMF package. + * + * (c) 2011-2015 Symfony CMF + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Cmf\Component\Routing; + +/** + * Interface for a provider which allows to retrieve a limited amount of routes. + */ +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(); +}