Skip to content

Updated the main bundles article for Symfony 4 #8613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Updated the main bundles article for Symfony 4 #8613

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff0b50c
Updated the main bundles article for Smyfony 4
javiereguiluz Nov 10, 2017
78cced6
Made the bundles index page an orphan page to supress RST warnings
javiereguiluz Nov 10, 2017
15cbb13
Changes requested by reviews
javiereguiluz Nov 12, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
207 changes: 40 additions & 167 deletions bundles.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,179 +6,52 @@
The Bundle System
=================

A bundle is similar to a plugin in other software, but even better. The key
difference is that *everything* is a bundle in Symfony, including both the
core framework functionality and the code written for your application.
Bundles are first-class citizens in Symfony. This gives you the flexibility
to use pre-built features packaged in `third-party bundles`_ or to distribute
your own bundles. It makes it easy to pick and choose which features to enable
in your application and to optimize them the way you want.

.. note::

While you'll learn the basics here, an entire article is devoted to the
organization and best practices of :doc:`bundles </bundles/best_practices>`.

A bundle is simply a structured set of files within a directory that implement
a single feature. You might create a BlogBundle, a ForumBundle or
a bundle for user management (many of these exist already as open source
bundles). Each directory contains everything related to that feature, including
PHP files, templates, stylesheets, JavaScript files, tests and anything else.
Every aspect of a feature exists in a bundle and every feature lives in a
bundle.

Bundles used in your applications must be enabled by registering them in
the ``registerBundles()`` method of the ``AppKernel`` class::

// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
new Symfony\Bundle\SecurityBundle\SecurityBundle(),
new Symfony\Bundle\TwigBundle\TwigBundle(),
new Symfony\Bundle\MonologBundle\MonologBundle(),
new Symfony\Bundle\SwiftmailerBundle\SwiftmailerBundle(),
new Symfony\Bundle\DoctrineBundle\DoctrineBundle(),
new Sensio\Bundle\FrameworkExtraBundle\SensioFrameworkExtraBundle(),
new AppBundle\AppBundle(),
);

if (in_array($this->getEnvironment(), array('dev', 'test'))) {
$bundles[] = new Symfony\Bundle\WebProfilerBundle\WebProfilerBundle();
$bundles[] = new Sensio\Bundle\DistributionBundle\SensioDistributionBundle();
$bundles[] = new Sensio\Bundle\GeneratorBundle\SensioGeneratorBundle();
}

return $bundles;
}

With the ``registerBundles()`` method, you have total control over which bundles
are used by your application (including the core Symfony bundles).
.. caution::

In Symfony versions prior to 4.0, it was recommended to organize your own
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not really agree with this sentence. At least, it is a bit confusing as we didn't recommend to use bundles, but there only was a single AppBundle. I think that's not really clear right now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll need more opinions here, but I thought this:

  • Symfony 2: organize your own code in bundles (1 bundle per feature: UserBundle, ProuctBundle, ...)
  • Symfony 3: organize your own code in bundles (just 1 bundle per app: AppBundle)

Saying: "in prior Sf versions we recommended you to organize your own code in bundles" is compatible with that (in my opinion).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @javiereguiluz here. "organize in bundles" doesn't have to refer to multiple bundles

application code using bundles. This is no longer recommended and bundles
should only be used as third-party plugins that add features in your
applications.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"third-party" refers to another party, but it's perfectly fine to use a bundle made by your own company. What about:

This is no longer recommended and bundles should only be used to share code and features between multiple applications.


A bundle is similar to a plugin in other software, but even better. The core
features of Symfony framework are implemented with bundles (FrameworkBundle,
SecurityBundle, DebugBundle, etc.) They are also used to add new features in
your application via `third-party bundles`_.

Bundles used in your applications must be enabled per
:doc:`environment </configuration/environments>` in the ``config/bundles.php``
file::

// config/bundles.php
return [
// 'all' means that the bundle is enabled for any Symfony environment
Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
Symfony\Bundle\SecurityBundle\SecurityBundle::class => ['all' => true],
Symfony\Bundle\TwigBundle\TwigBundle::class => ['all' => true],
Symfony\Bundle\MonologBundle\MonologBundle::class => ['all' => true],
Symfony\Bundle\SwiftmailerBundle\SwiftmailerBundle::class => ['all' => true],
Doctrine\Bundle\DoctrineBundle\DoctrineBundle::class => ['all' => true],
Sensio\Bundle\FrameworkExtraBundle\SensioFrameworkExtraBundle::class => ['all' => true],
// this bundle is enabled only in 'dev' and 'test', so you can't use it in 'prod'
Symfony\Bundle\WebProfilerBundle\WebProfilerBundle::class => ['dev' => true, 'test' => true],
];

.. tip::

A bundle can live *anywhere* as long as it can be autoloaded (via the
autoloader configured at ``app/autoload.php``).

Creating a Bundle
-----------------

The Symfony Standard Edition comes with a handy task that creates a fully-functional
bundle for you. Of course, creating a bundle by hand is pretty easy as well.

To show you how simple the bundle system is, create a new bundle called
AcmeTestBundle and enable it.

.. tip::

The ``Acme`` portion is just a dummy name that should be replaced by
some "vendor" name that represents you or your organization (e.g.
ABCTestBundle for some company named ``ABC``).

Start by creating a ``src/Acme/TestBundle/`` directory and adding a new file
called ``AcmeTestBundle.php``::

// src/Acme/TestBundle/AcmeTestBundle.php
namespace Acme\TestBundle;

use Symfony\Component\HttpKernel\Bundle\Bundle;

class AcmeTestBundle extends Bundle
{
}

.. tip::

The name AcmeTestBundle follows the standard
:ref:`Bundle naming conventions <bundles-naming-conventions>`. You could
also choose to shorten the name of the bundle to simply TestBundle by naming
this class TestBundle (and naming the file ``TestBundle.php``).

This empty class is the only piece you need to create the new bundle. Though
commonly empty, this class is powerful and can be used to customize the behavior
of the bundle.

Now that you've created the bundle, enable it via the ``AppKernel`` class::

// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...

// register your bundle
new Acme\TestBundle\AcmeTestBundle(),
);
// ...

return $bundles;
}

And while it doesn't do anything yet, AcmeTestBundle is now ready to be used.

And as easy as this is, Symfony also provides a command-line interface for
generating a basic bundle skeleton:

.. code-block:: terminal

$ php bin/console generate:bundle --namespace=Acme/TestBundle

The bundle skeleton generates a basic controller, template and routing
resource that can be customized. You'll learn more about Symfony's command-line
tools later.

.. tip::

Whenever creating a new bundle or using a third-party bundle, always make
sure the bundle has been enabled in ``registerBundles()``. When using
the ``generate:bundle`` command, this is done for you.

Bundle Directory Structure
--------------------------

The directory structure of a bundle is simple and flexible. By default, the
bundle system follows a set of conventions that help to keep code consistent
between all Symfony bundles. Take a look at AcmeDemoBundle, as it contains some
of the most common elements of a bundle:

``Controller/``
Contains the controllers of the bundle (e.g. ``RandomController.php``).

``DependencyInjection/``
Holds certain Dependency Injection Extension classes, which may import service
configuration, register compiler passes or more (this directory is not
necessary).

``Resources/config/``
Houses configuration, including routing configuration (e.g. ``routes.yaml``).

``Resources/views/``
Holds templates organized by controller name (e.g. ``Random/index.html.twig``).

``Resources/public/``
Contains web assets (images, stylesheets, etc) and is copied or symbolically
linked into the project ``public/`` directory via the ``assets:install`` console
command.

``Tests/``
Holds all tests for the bundle.

A bundle can be as small or large as the feature it implements. It contains
only the files you need and nothing else.

As you move through the guides, you'll learn how to persist objects to a
database, create and validate forms, create translations for your application,
write tests and much more. Each of these has their own place and role within
the bundle.
In a default Symfony application that uses :doc:`Symfony Flex </setup/flex>`,
bundles are enabled/disabled automatically for you when installing/removing
them, so you don't need to look at or edit this ``bundles.php`` file.

Learn more
----------

.. toctree::
:maxdepth: 1
:glob:

bundles/*
* :doc:`/bundles/installation`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And let's remove this link - I'm going to open a PR to remove this entirely

* :doc:`/bundles/remove`
* :doc:`/bundles/override`
* :doc:`/bundles/inheritance`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's stop linking to this - it'll still be findable by Google.

* :doc:`/bundles/best_practices`
* :doc:`/bundles/configuration`
* :doc:`/bundles/extension`
* :doc:`/bundles/prepend_extension`

_`third-party bundles`: https://github.com/search?q=topic%3Asymfony-bundle&type=Repositories
10 changes: 6 additions & 4 deletions bundles/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
:orphan:

Bundles
=======

.. toctree::
:maxdepth: 2

installation
best_practices
inheritance
override
remove
extension
override
inheritance
best_practices
configuration
extension
prepend_extension