You are here

interface ExtensionInterface in Service Container 7

Same name and namespace in other branches
  1. 7.2 modules/providers/service_container_symfony/lib/Symfony/Component/DependencyInjection/Extension/ExtensionInterface.php \Symfony\Component\DependencyInjection\Extension\ExtensionInterface

ExtensionInterface is the interface implemented by container extension classes.

@author Fabien Potencier <fabien@symfony.com>

@api

Hierarchy

Expanded class hierarchy of ExtensionInterface

All classes that implement ExtensionInterface

2 files declare their use of ExtensionInterface
ContainerBuilder.php in modules/providers/service_container_symfony/lib/Symfony/Component/DependencyInjection/ContainerBuilder.php
ProjectExtension.php in modules/providers/service_container_symfony/lib/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/ProjectExtension.php

File

modules/providers/service_container_symfony/lib/Symfony/Component/DependencyInjection/Extension/ExtensionInterface.php, line 23

Namespace

Symfony\Component\DependencyInjection\Extension
View source
interface ExtensionInterface {

  /**
   * Loads a specific configuration.
   *
   * @param array            $config    An array of configuration values
   * @param ContainerBuilder $container A ContainerBuilder instance
   *
   * @throws \InvalidArgumentException When provided tag is not defined in this extension
   *
   * @api
   */
  public function load(array $config, ContainerBuilder $container);

  /**
   * Returns the namespace to be used for this extension (XML namespace).
   *
   * @return string The XML namespace
   *
   * @api
   */
  public function getNamespace();

  /**
   * Returns the base path for the XSD files.
   *
   * @return string The XSD base path
   *
   * @api
   */
  public function getXsdValidationBasePath();

  /**
   * Returns the recommended alias to use in XML.
   *
   * This alias is also the mandatory prefix to use when using YAML.
   *
   * @return string The alias
   *
   * @api
   */
  public function getAlias();

}

Members

Namesort descending Modifiers Type Description Overrides
ExtensionInterface::getAlias public function Returns the recommended alias to use in XML. 2
ExtensionInterface::getNamespace public function Returns the namespace to be used for this extension (XML namespace). 2
ExtensionInterface::getXsdValidationBasePath public function Returns the base path for the XSD files. 2
ExtensionInterface::load public function Loads a specific configuration. 1