annotate vendor/symfony/dependency-injection/Extension/ExtensionInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 1fec387a4317
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\DependencyInjection\Extension;
Chris@0 13
Chris@0 14 use Symfony\Component\DependencyInjection\ContainerBuilder;
Chris@0 15
Chris@0 16 /**
Chris@0 17 * ExtensionInterface is the interface implemented by container extension classes.
Chris@0 18 *
Chris@0 19 * @author Fabien Potencier <fabien@symfony.com>
Chris@0 20 */
Chris@0 21 interface ExtensionInterface
Chris@0 22 {
Chris@0 23 /**
Chris@0 24 * Loads a specific configuration.
Chris@0 25 *
Chris@0 26 * @throws \InvalidArgumentException When provided tag is not defined in this extension
Chris@0 27 */
Chris@0 28 public function load(array $configs, ContainerBuilder $container);
Chris@0 29
Chris@0 30 /**
Chris@0 31 * Returns the namespace to be used for this extension (XML namespace).
Chris@0 32 *
Chris@0 33 * @return string The XML namespace
Chris@0 34 */
Chris@0 35 public function getNamespace();
Chris@0 36
Chris@0 37 /**
Chris@0 38 * Returns the base path for the XSD files.
Chris@0 39 *
Chris@0 40 * @return string The XSD base path
Chris@0 41 */
Chris@0 42 public function getXsdValidationBasePath();
Chris@0 43
Chris@0 44 /**
Chris@0 45 * Returns the recommended alias to use in XML.
Chris@0 46 *
Chris@0 47 * This alias is also the mandatory prefix to use when using YAML.
Chris@0 48 *
Chris@0 49 * @return string The alias
Chris@0 50 */
Chris@0 51 public function getAlias();
Chris@0 52 }