GeneratorDumperInterface.php 929 B

12345678910111213141516171819202122232425262728293031323334353637
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Routing\Generator\Dumper;
  11. use Symfony\Component\Routing\RouteCollection;
  12. /**
  13. * GeneratorDumperInterface is the interface that all generator dumper classes must implement.
  14. *
  15. * @author Fabien Potencier <fabien@symfony.com>
  16. */
  17. interface GeneratorDumperInterface
  18. {
  19. /**
  20. * Dumps a set of routes to a string representation of executable code
  21. * that can then be used to generate a URL of such a route.
  22. *
  23. * @return string Executable code
  24. */
  25. public function dump(array $options = []);
  26. /**
  27. * Gets the routes to dump.
  28. *
  29. * @return RouteCollection A RouteCollection instance
  30. */
  31. public function getRoutes();
  32. }