vendor/symfony/routing/Symfony/Component/Routing/Generator/Dumper/GeneratorDumperInterface.php

   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\Generator\Dumper;
  13
  14 use Symfony\Component\Routing\RouteCollection;
  15
  16 /**
  17  * GeneratorDumperInterface is the interface that all generator dumper classes must implement.
  18  *
  19  * @author Fabien Potencier <fabien@symfony.com>
  20  *
  21  * @api
  22  */
  23 interface GeneratorDumperInterface
  24 {
  25     /**
  26      * Dumps a set of routes to a string representation of executable code
  27      * that can then be used to generate a URL of such a route.
  28      *
  29      * @param array $options An array of options
  30      *
  31      * @return string Executable code
  32      */
  33     public function dump(array $options = array());
  34
  35     /**
  36      * Gets the routes to dump.
  37      *
  38      * @return RouteCollection A RouteCollection instance
  39      */
  40     public function getRoutes();
  41 }