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\HttpKernel\Bundle;

    13 

    14 use Symfony\Component\DependencyInjection\ContainerBuilder;

    15 

    16 /**

    17  * BundleInterface.

    18  *

    19  * @author Fabien Potencier <fabien@symfony.com>

    20  *

    21  * @api

    22  */

    23 interface BundleInterface

    24 {

    25     /**

    26      * Boots the Bundle.

    27      *

    28      * @api

    29      */

    30     function boot();

    31 

    32     /**

    33      * Shutdowns the Bundle.

    34      *

    35      * @api

    36      */

    37     function shutdown();

    38 

    39     /**

    40      * Builds the bundle.

    41      *

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

    43      *

    44      * @param ContainerBuilder $container A ContainerBuilder instance

    45      *

    46      * @api

    47      */

    48     function build(ContainerBuilder $container);

    49 

    50     /**

    51      * Returns the container extension that should be implicitly loaded.

    52      *

    53      * @return ExtensionInterface|null The default extension or null if there is none

    54      *

    55      * @api

    56      */

    57     function getContainerExtension();

    58 

    59     /**

    60      * Returns the bundle parent name.

    61      *

    62      * @return string The Bundle parent name it overrides or null if no parent

    63      *

    64      * @api

    65      */

    66     function getParent();

    67 

    68     /**

    69      * Returns the bundle name (the class short name).

    70      *

    71      * @return string The Bundle name

    72      *

    73      * @api

    74      */

    75     function getName();

    76 

    77     /**

    78      * Gets the Bundle namespace.

    79      *

    80      * @return string The Bundle namespace

    81      *

    82      * @api

    83      */

    84     function getNamespace();

    85 

    86     /**

    87      * Gets the Bundle directory path.

    88      *

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

    90      *

    91      * @return string The Bundle absolute path

    92      *

    93      * @api

    94      */

    95     function getPath();

    96 }