From d1d761c7fef69b9075db63687f7e039fe0344f49 Mon Sep 17 00:00:00 2001 From: Francisco Corrales Morales Date: Tue, 20 Sep 2016 10:35:36 -0600 Subject: [PATCH 1/5] Update inheritance.rst The old sentence was confusing. This one works better. --- bundles/inheritance.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/bundles/inheritance.rst b/bundles/inheritance.rst index 90457f54320..3c595985ff5 100644 --- a/bundles/inheritance.rst +++ b/bundles/inheritance.rst @@ -92,8 +92,8 @@ The same goes for routing files and some other resources. The overriding of resources only works when you refer to resources with the ``@FOSUserBundle/Resources/config/routing/security.xml`` method. - If you refer to resources without using the ``@BundleName`` shortcut, they - can't be overridden in this way. + You need to use the ``@BundleName`` shortcut when refering to resources + so they can be successfully overridden. .. caution:: From a25876ce988869bfdeebc54d572ab9a78e2cc467 Mon Sep 17 00:00:00 2001 From: Francisco Corrales Morales Date: Tue, 20 Sep 2016 10:36:35 -0600 Subject: [PATCH 2/5] Update installation.rst Its better to use e.g. here cause that is just an example. Doesn't always going to be in that path. --- bundles/installation.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/bundles/installation.rst b/bundles/installation.rst index 80dfafc008e..6ebb7d43525 100644 --- a/bundles/installation.rst +++ b/bundles/installation.rst @@ -49,7 +49,7 @@ version, include it as the second argument of the `composer require`_ command: B) Enable the Bundle -------------------- -At this point, the bundle is installed in your Symfony project (in +At this point, the bundle is installed in your Symfony project (e.g. ``vendor/friendsofsymfony/``) and the autoloader recognizes its classes. The only thing you need to do now is register the bundle in ``AppKernel``:: @@ -108,14 +108,14 @@ via the ``config:dump-reference`` command: .. code-block:: bash - $ app/console config:dump-reference AsseticBundle + $ bin/console config:dump-reference AsseticBundle Instead of the full bundle name, you can also pass the short name used as the root of the bundle's configuration: .. code-block:: bash - $ app/console config:dump-reference assetic + $ bin/console config:dump-reference assetic The output will look like this: From bb215cb2aed17d7b7472b485979375ae8571236c Mon Sep 17 00:00:00 2001 From: Francisco Corrales Morales Date: Tue, 20 Sep 2016 10:37:34 -0600 Subject: [PATCH 3/5] Update override.rst The word 'or' is clear. / not so much. --- bundles/override.rst | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/bundles/override.rst b/bundles/override.rst index 933adbd1d92..60b7c206cd0 100644 --- a/bundles/override.rst +++ b/bundles/override.rst @@ -37,7 +37,7 @@ If the controller is a service, see the next section on how to override it. Services & Configuration ------------------------ -In order to override/extend a service, there are two options. First, you can +In order to override or extend a service you have two options. First, you can set the parameter holding the service's class name to your own class by setting it in ``app/config/config.yml``. This of course is only possible if the class name is defined as a parameter in the service config of the bundle containing the @@ -105,17 +105,16 @@ associations. Learn more about this feature and its limitations in Forms ----- -In order to override a form type, it has to be registered as a service (meaning -it is tagged as ``form.type``). You can then override it as you would override any -service as explained in `Services & Configuration`_. This, of course, will only -work if the type is referred to by its alias rather than being instantiated, -e.g.:: +Form types are referred to by their fully-qualified class name:: - $builder->add('name', 'custom_type'); + $builder->add('name', CustomType::class); -rather than:: +This means that you cannot override this by creating a sub-class of ``CustomType`` +and registering it as a service and tagging it with ``form.type`` (you *could* +do this in an earlier version). - $builder->add('name', new CustomType()); +Instead, you should use a "form type extension" to modify the existing form type. +For more information, see :doc:`/form/create_form_type_extension`. .. _override-validation: @@ -126,7 +125,7 @@ Symfony loads all validation configuration files from every bundle and combines them into one validation metadata tree. This means you are able to add new constraints to a property, but you cannot override them. -To override this, the 3rd party bundle needs to have configuration for +To overcome this, the 3rd party bundle needs to have configuration for :doc:`validation groups `. For instance, the FOSUserBundle has this configuration. To create your own validation, add the constraints to a new validation group: From ef674dcb68f1b20e3c9d2642354b75f2fea1708a Mon Sep 17 00:00:00 2001 From: Francisco Corrales Morales Date: Tue, 20 Sep 2016 10:38:33 -0600 Subject: [PATCH 4/5] Update prepend_extension.rst Titles use caps. Unnecessary sentence. --- bundles/prepend_extension.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/bundles/prepend_extension.rst b/bundles/prepend_extension.rst index f4a0aff3cc9..4480da98546 100644 --- a/bundles/prepend_extension.rst +++ b/bundles/prepend_extension.rst @@ -2,7 +2,7 @@ single: Configuration; Semantic single: Bundle; Extension configuration -How to Simplify Configuration of multiple Bundles +How to Simplify Configuration of Multiple Bundles ================================================= When building reusable and extensible applications, developers are often @@ -12,9 +12,9 @@ users to choose to remove functionality they are not using. Creating multiple bundles has the drawback that configuration becomes more tedious and settings often need to be repeated for various bundles. -Using the below approach, it is possible to remove the disadvantage of the -multiple bundle approach by enabling a single Extension to prepend the settings -for any bundle. It can use the settings defined in the ``app/config/config.yml`` +It is possible to remove the disadvantage of the multiple bundle approach +by enabling a single Extension to prepend the settings for any bundle. +It can use the settings defined in the ``app/config/config.yml`` to prepend settings just as if they had been written explicitly by the user in the application configuration. From 5fdb433fd567ba0e7c9cb704ba86d7494c930058 Mon Sep 17 00:00:00 2001 From: Francisco Corrales Morales Date: Wed, 21 Sep 2016 10:07:53 -0600 Subject: [PATCH 5/5] Update installation.rst This does only apply to Symfony >= 3.0. --- bundles/installation.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/bundles/installation.rst b/bundles/installation.rst index 6ebb7d43525..36da704abbe 100644 --- a/bundles/installation.rst +++ b/bundles/installation.rst @@ -108,14 +108,14 @@ via the ``config:dump-reference`` command: .. code-block:: bash - $ bin/console config:dump-reference AsseticBundle + $ app/console config:dump-reference AsseticBundle Instead of the full bundle name, you can also pass the short name used as the root of the bundle's configuration: .. code-block:: bash - $ bin/console config:dump-reference assetic + $ app/console config:dump-reference assetic The output will look like this: