Documentation

BundleInterface extends ContainerAwareInterface

BundleInterface.

Tags
author

Fabien Potencier fabien@symfony.com

Table of Contents

boot()  : mixed
Boots the Bundle.
build()  : mixed
Builds the bundle.
getContainerExtension()  : ExtensionInterface|null
Returns the container extension that should be implicitly loaded.
getName()  : string
Returns the bundle name (the class short name).
getNamespace()  : string
Gets the Bundle namespace.
getParent()  : string
Returns the bundle name that this bundle overrides.
getPath()  : string
Gets the Bundle directory path.
shutdown()  : mixed
Shutdowns the Bundle.

Methods

boot()

Boots the Bundle.

public boot() : mixed
Return values
mixed —

build()

Builds the bundle.

public build(ContainerBuilder $container) : mixed

It is only ever called once when the cache is empty.

Parameters
$container : ContainerBuilder
Return values
mixed —

getContainerExtension()

Returns the container extension that should be implicitly loaded.

public getContainerExtension() : ExtensionInterface|null
Return values
ExtensionInterface|null —

The default extension or null if there is none

getName()

Returns the bundle name (the class short name).

public getName() : string
Return values
string —

The Bundle name

getNamespace()

Gets the Bundle namespace.

public getNamespace() : string
Return values
string —

The Bundle namespace

getParent()

Returns the bundle name that this bundle overrides.

public getParent() : string

Despite its name, this method does not imply any parent/child relationship between the bundles, just a way to extend and override an existing bundle.

Tags
deprecated

This method is deprecated as of 3.4 and will be removed in 4.0.

Return values
string —

The Bundle name it overrides or null if no parent

getPath()

Gets the Bundle directory path.

public getPath() : string

The path should always be returned as a Unix path (with /).

Return values
string —

The Bundle absolute path

shutdown()

Shutdowns the Bundle.

public shutdown() : mixed
Return values
mixed —

Search results