www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/dependency-injection/Extension/ExtensionInterface.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\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      * @param array            $configs   An array of configuration values
  27      * @param ContainerBuilder $container A ContainerBuilder instance
  28      *
  29      * @throws \InvalidArgumentException When provided tag is not defined in this extension
  30      */
  31     public function load(array $configs, ContainerBuilder $container);
  32
  33     /**
  34      * Returns the namespace to be used for this extension (XML namespace).
  35      *
  36      * @return string The XML namespace
  37      */
  38     public function getNamespace();
  39
  40     /**
  41      * Returns the base path for the XSD files.
  42      *
  43      * @return string The XSD base path
  44      */
  45     public function getXsdValidationBasePath();
  46
  47     /**
  48      * Returns the recommended alias to use in XML.
  49      *
  50      * This alias is also the mandatory prefix to use when using YAML.
  51      *
  52      * @return string The alias
  53      */
  54     public function getAlias();
  55 }