[Summary view] [Print] [Text view]

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