class ContainerBuilder extends Container implements TaggedContainerInterface
ContainerBuilder is a DI container that provides an API to easily describe services.
__construct(ParameterBagInterface $parameterBag = null) | from Container | |
compile() Compiles the container. | ||
bool | isFrozen() Returns true if the container parameter bag are frozen. | from Container |
ParameterBagInterface | getParameterBag() Gets the service container parameter bag. | from Container |
mixed | getParameter(string $name) Gets a parameter. | from Container |
bool | hasParameter(string $name) Checks if a parameter exists. | from Container |
setParameter(string $name, mixed $value) Sets a parameter. | from Container | |
set(string $id, object $service) Sets a service. | ||
bool | has(string $id) Returns true if the given service is defined. | |
object | get(string $id, int $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE) Gets a service. | |
bool | initialized(string $id) Returns true if the given service has actually been initialized. | from Container |
reset() Resets shared services from the container. | from Container | |
array | getServiceIds() Gets all service ids. | |
static string | camelize(string $id) Camelizes a string. | from Container |
static string | underscore(string $id) A string to underscore. | from Container |
setResourceTracking(bool $track) Sets the track resources flag. | ||
bool | isTrackingResources() Checks if resources are tracked. | |
setProxyInstantiator(InstantiatorInterface $proxyInstantiator) Sets the instantiator to be used when fetching proxies. | ||
registerExtension(ExtensionInterface $extension) Registers an extension. | ||
ExtensionInterface | getExtension(string $name) Returns an extension by alias or namespace. | |
ExtensionInterface[] | getExtensions() Returns all registered extensions. | |
bool | hasExtension(string $name) Checks if we have an extension. | |
ResourceInterface[] | getResources() Returns an array of resources loaded to build this configuration. | |
$this | addResource(ResourceInterface $resource) Adds a resource for this configuration. | |
$this | setResources(array $resources) Sets the resources for this configuration. | |
$this | addObjectResource(object $object) Adds the object class hierarchy as resources. | |
$this | addClassResource(ReflectionClass $class) Adds the given class hierarchy as resources. | |
$this | loadFromExtension(string $extension, array $values = array()) Loads the configuration for an extension. | |
$this | addCompilerPass(CompilerPassInterface $pass, $type = PassConfig::TYPE_BEFORE_OPTIMIZATION) Adds a compiler pass. | |
PassConfig | getCompilerPassConfig() Returns the compiler pass config which can then be modified. | |
Compiler | getCompiler() Returns the compiler. | |
removeDefinition(string $id) Removes a service definition. | ||
merge(ContainerBuilder $container) Merges a ContainerBuilder with the current ContainerBuilder configuration. | ||
array | getExtensionConfig(string $name) Returns the configuration array for the given extension. | |
prependExtensionConfig(string $name, array $config) Prepends a config array to the configs of the given extension. | ||
addAliases(array $aliases) Adds the service aliases. | ||
setAliases(array $aliases) Sets the service aliases. | ||
setAlias(string $alias, string|Alias $id) Sets an alias for an existing service. | ||
removeAlias(string $alias) Removes an alias. | ||
bool | hasAlias(string $id) Returns true if an alias exists under the given identifier. | |
Alias[] | getAliases() Gets all defined aliases. | |
Alias | getAlias(string $id) Gets an alias. | |
Definition | register(string $id, string $class = null) Registers a service definition. | |
addDefinitions(array $definitions) Adds the service definitions. | ||
setDefinitions(array $definitions) Sets the service definitions. | ||
Definition[] | getDefinitions() Gets all service definitions. | |
Definition | setDefinition(string $id, Definition $definition) Sets a service definition. | |
bool | hasDefinition(string $id) Returns true if a service definition exists under the given identifier. | |
Definition | getDefinition(string $id) Gets a service definition. | |
Definition | findDefinition(string $id) Gets a service definition by id or alias. | |
mixed | resolveServices(mixed $value) Replaces service references by the real service instance and evaluates expressions. | |
array | findTaggedServiceIds(string $name) Returns service ids for a given tag. | |
array | findTags() Returns all tags the defined services use. | |
string[] | findUnusedTags() Returns all tags not queried by findTaggedServiceIds. | |
addExpressionLanguageProvider(ExpressionFunctionProviderInterface $provider) | ||
ExpressionFunctionProviderInterface[] | getExpressionLanguageProviders() | |
string | resolveEnvPlaceholders(mixed $value, string|null $format = null, array $usedEnvs = null) Resolves env parameter placeholders in a string or an array. | |
int[] | getEnvCounters() Get statistics about env usage. | |
static array | getServiceConditionals(mixed $value) Returns the Service Conditionals. |
Compiles the container.
This method passes the container to compiler passes whose job is to manipulate and optimize the container.
The main compiler passes roughly do four things:
Returns true if the container parameter bag are frozen.
Gets the service container parameter bag.
Gets a parameter.
Checks if a parameter exists.
Sets a parameter.
Sets a service.
Returns true if the given service is defined.
Gets a service.
Returns true if the given service has actually been initialized.
Resets shared services from the container.
The container is not intended to be used again after being reset in a normal workflow. This method is meant as a way to release references for ref-counting. A subsequent call to ContainerInterface::get will recreate a new instance of the shared service.
Gets all service ids.
Camelizes a string.
A string to underscore.
Sets the track resources flag.
If you are not using the loaders and therefore don't want to depend on the Config component, set this flag to false.
Checks if resources are tracked.
Sets the instantiator to be used when fetching proxies.
Registers an extension.
Returns an extension by alias or namespace.
Returns all registered extensions.
Checks if we have an extension.
Returns an array of resources loaded to build this configuration.
Adds a resource for this configuration.
Sets the resources for this configuration.
Adds the object class hierarchy as resources.
Adds the given class hierarchy as resources.
Loads the configuration for an extension.
Adds a compiler pass.
Returns the compiler pass config which can then be modified.
Returns the compiler.
Removes a service definition.
Merges a ContainerBuilder with the current ContainerBuilder configuration.
Service definitions overrides the current defined ones.
But for parameters, they are overridden by the current ones. It allows the parameters passed to the container constructor to have precedence over the loaded ones.
$container = new ContainerBuilder(array('foo' => 'bar')); $loader = new LoaderXXX($container); $loader->load('resource_name'); $container->register('foo', new stdClass());
In the above example, even if the loaded resource defines a foo parameter, the value will still be 'bar' as defined in the ContainerBuilder constructor.
Returns the configuration array for the given extension.
Prepends a config array to the configs of the given extension.
Adds the service aliases.
Sets the service aliases.
Sets an alias for an existing service.
Removes an alias.
Returns true if an alias exists under the given identifier.
Gets all defined aliases.
Gets an alias.
Registers a service definition.
This methods allows for simple registration of service definition with a fluid interface.
Adds the service definitions.
Sets the service definitions.
Gets all service definitions.
Sets a service definition.
Returns true if a service definition exists under the given identifier.
Gets a service definition.
Gets a service definition by id or alias.
The method "unaliases" recursively to return a Definition instance.
Replaces service references by the real service instance and evaluates expressions.
Returns service ids for a given tag.
Example:
$container->register('foo')->addTag('my.tag', array('hello' => 'world'));
$serviceIds = $container->findTaggedServiceIds('my.tag'); foreach ($serviceIds as $serviceId => $tags) { foreach ($tags as $tag) { echo $tag['hello']; } }
Returns all tags the defined services use.
Returns all tags not queried by findTaggedServiceIds.
Resolves env parameter placeholders in a string or an array.
Get statistics about env usage.
Returns the Service Conditionals.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/DependencyInjection/ContainerBuilder.html