Просмотр файла engine/classes/lib/Twig/ExtensionInterface.php

Размер файла: 2.04Kb
  1. <?php
  2.  
  3. /*
  4. * This file is part of Twig.
  5. *
  6. * (c) 2009 Fabien Potencier
  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. * Interface implemented by extension classes.
  14. *
  15. * @author Fabien Potencier <fabien@symfony.com>
  16. */
  17. interface Twig_ExtensionInterface
  18. {
  19. /**
  20. * Initializes the runtime environment.
  21. *
  22. * This is where you can load some file that contains filter functions for instance.
  23. *
  24. * @param Twig_Environment $environment The current Twig_Environment instance
  25. */
  26. public function initRuntime(Twig_Environment $environment);
  27.  
  28. /**
  29. * Returns the token parser instances to add to the existing list.
  30. *
  31. * @return array An array of Twig_TokenParserInterface or Twig_TokenParserBrokerInterface instances
  32. */
  33. public function getTokenParsers();
  34.  
  35. /**
  36. * Returns the node visitor instances to add to the existing list.
  37. *
  38. * @return Twig_NodeVisitorInterface[] An array of Twig_NodeVisitorInterface instances
  39. */
  40. public function getNodeVisitors();
  41.  
  42. /**
  43. * Returns a list of filters to add to the existing list.
  44. *
  45. * @return array An array of filters
  46. */
  47. public function getFilters();
  48.  
  49. /**
  50. * Returns a list of tests to add to the existing list.
  51. *
  52. * @return array An array of tests
  53. */
  54. public function getTests();
  55.  
  56. /**
  57. * Returns a list of functions to add to the existing list.
  58. *
  59. * @return array An array of functions
  60. */
  61. public function getFunctions();
  62.  
  63. /**
  64. * Returns a list of operators to add to the existing list.
  65. *
  66. * @return array An array of operators
  67. */
  68. public function getOperators();
  69.  
  70. /**
  71. * Returns a list of global variables to add to the existing list.
  72. *
  73. * @return array An array of global variables
  74. */
  75. public function getGlobals();
  76.  
  77. /**
  78. * Returns the name of the extension.
  79. *
  80. * @return string The extension name
  81. */
  82. public function getName();
  83. }