symfony 3.1 Check if a bundle is installed

Question

I'm developing a bundle who has a dependency on another one.

In order to handle the case that the base bundle has not been installed I'll like to perform a "bundle_exists()" function inside a controller.

The question is: How can I have a list of installed bundles or How can I check for the name (eventually also the version) of a bundle.

Thanks.

List of included bundles you can find in app/AppKernel.php file — Thomas Shelby, Aug 11 '16 at 08:15
have you declared the bundle as dependency in the composer.json files of your bundle? — Matteo, Aug 11 '16 at 08:42
Possible duplicate of [How do I get a list of bundles in symfony2?](http://stackoverflow.com/questions/9990961/how-do-i-get-a-list-of-bundles-in-symfony2) — gp_sflover, Aug 11 '16 at 09:29
To handle the case add dependencies to composer file of the bundle. — malcolm, Aug 11 '16 at 09:54

score 8 · Answer 1 · answered Aug 11 '16 at 08:53

8

In addition to @Rooneyl's answer:

The best place to do such a check is inside your DI extension (e.g. AcmeDemoExtension). This is executed once the container is build and dumped to cache. There is no need to check such thing on each request (the container doesn't change while it's cached anyway), it'll only slow down your cache.

// ...
class AcmeDemoExtension extends Extension
{
    public function load(array $configs, ContainerBuilder $container)
    {
        $bundles = $container->getParameter('bundles');
        if (!isset($bundles['YourDependentBundle'])) {
            throw new \InvalidArgumentException(
                'The bundle ... needs to be registered in order to use AcmeDemoBundle.'
            );
        }
    }
}

answered Aug 11 '16 at 08:53

Wouter J

41,455
15
107
112

Can this be used to ensure that a bundle is registered before another one in AppKernel ? – Christophe Willemsen Jan 02 '17 at 05:29
@ChristopheWillemsen no. But the order of registration should never influence anything – Wouter J Jan 02 '17 at 12:03
I agree, some projects though have such enforcements (like Akeneo Enterprise), which can then come in loop as an integrator to other solutions. Thanks for your reply. Have a nice day and best wishes – Christophe Willemsen Jan 02 '17 at 12:42
In Symfony 4.x the parameter is `kernel.bundles`. – hvtilborg Apr 29 '19 at 06:56

Rooneyl · Accepted Answer · 2016-08-11T09:27:50.267

6

Your class needs to have access to the container object (either by extending or DI).
Then you can do;

$this->container->getParameter('kernel.bundles');

This will give you a list of bundles installed.

Update;
If you are in a controller that extends the Symfony\Bundle\FrameworkBundle\Controller\Controller or in a command class that extends Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand, you can just get the parameter.

$this->getParameter('kernel.bundles').

Else @Wouter J's answer is your best answer.

edited Aug 11 '16 at 09:27

answered Aug 11 '16 at 08:18

Rooneyl

7,802
6
52
81

2

Extending sounds really scary and it's better to inject the parameter instead of injecting the complete container. – Wouter J Aug 11 '16 at 08:54
@WouterJ, fair point (I'll give you an upvote) - I'm just giving options. If this was a controller it would normally extend the main controller (unless set as a service), which in turn extends ContainerAware. – Rooneyl Aug 11 '16 at 09:23

score 1 · Answer 3 · answered Aug 11 '16 at 08:26

1

You can get a list of all Bundles from the Kernel like this:

public function indexAction () 
{
    $arrBundles = $this->get("kernel")->getBundles();

    if (!array_key_exists("MyBundle", $arrBundles))
    {
        // bundle not found
    }

}

answered Aug 11 '16 at 08:26

Veas

160
8

score 0 · Answer 4 · edited May 23 '17 at 11:53

0

From Andrey at this question: How do I get a list of bundles in symfony2?

If you want to call a non static method of registered bundle object (not class) then you can do the following:

$kernel = $this->container->get('kernel');
$bundles = $kernel->getBundles();
$bundles['YourBundleName']->someMethod();

Where 'YourBundleName' is the name of your bundle, which you can get by calling from console:

php app/console config:dump-reference

edited May 23 '17 at 11:53

Community

1
1

answered Aug 11 '16 at 11:09

goto

7,908
10
48
58

Why do you copy/paste an answer from the original to a duplicated question? – gp_sflover Aug 11 '16 at 11:23
if the duplicated flag is not accepted the answer could be usefull. You think I shouldn't have? – goto Aug 11 '16 at 11:33
From the [Help center](http://stackoverflow.com/help/duplicates): "_The fundamental goal of closing duplicate questions is to help people find the right answer by getting all of those answers in one place_" and it's evidently that the question here is: _The question is: How can I have a list of installed bundles?_. I want to add that this question "_does not show any research effort_" because just search with "bundles list" in the symfony2 tag and it appear as first result. Maybe an expert user like @Wouter_J can give us a better explanation. – gp_sflover Aug 11 '16 at 11:51
1

I'm really sorry having duplicated a already answered topic. Surely my low knowledge about Symfony hasn't let me see that the answer was there. Sorry again. Once said this, I find some of the answers given more explanatory than the ones in the previous topic, as an example I can say that the Rooneyl's, Wouter J's and Veas gave me an overall idea. – Carlos Aug 11 '16 at 16:10
I will like to add that sometimes if you don't know how to ask something in a search leads you in a "does not show any research effort" position. Please, don't be so strict with the newbies. – Carlos Aug 11 '16 at 16:21

symfony 3.1 Check if a bundle is installed

4 Answers4