ExtensionInterface.php 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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\DependencyInjection\Extension;
  11. use Symfony\Component\DependencyInjection\ContainerBuilder;
  12. /**
  13. * ExtensionInterface is the interface implemented by container extension classes.
  14. *
  15. * @author Fabien Potencier <fabien@symfony.com>
  16. */
  17. interface ExtensionInterface
  18. {
  19. /**
  20. * Loads a specific configuration.
  21. *
  22. * @param array $configs An array of configuration values
  23. * @param ContainerBuilder $container A ContainerBuilder instance
  24. *
  25. * @throws \InvalidArgumentException When provided tag is not defined in this extension
  26. */
  27. public function load(array $configs, ContainerBuilder $container);
  28. /**
  29. * Returns the namespace to be used for this extension (XML namespace).
  30. *
  31. * @return string The XML namespace
  32. */
  33. public function getNamespace();
  34. /**
  35. * Returns the base path for the XSD files.
  36. *
  37. * @return string The XSD base path
  38. */
  39. public function getXsdValidationBasePath();
  40. /**
  41. * Returns the recommended alias to use in XML.
  42. *
  43. * This alias is also the mandatory prefix to use when using YAML.
  44. *
  45. * @return string The alias
  46. */
  47. public function getAlias();
  48. }