Skip to content
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

Remove suggestion to change the .class parameters #7090

Closed
wants to merge 3 commits into from
Closed

Remove suggestion to change the .class parameters #7090

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f24b3fe
Remove suggestion to change the `.class` parameters
mpdude Oct 27, 2016
2cf8b1f
Add missing backtick
mpdude Oct 27, 2016
5cd4f79
Use a double colon so the following paragraph is indented as code sec…
mpdude Oct 27, 2016
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
44 changes: 5 additions & 39 deletions bundles/override.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,39 +37,10 @@ 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
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
service. For example, to override the class used for Symfony's ``translator``
service, you would override the ``translator.class`` parameter. Knowing exactly
which parameter to override may take some research. For the translator, the
parameter is defined and used in the ``Resources/config/translation.xml`` file
in the core FrameworkBundle:

.. configuration-block::

.. code-block:: yaml

# app/config/config.yml
parameters:
translator.class: Acme\HelloBundle\Translation\Translator

.. code-block:: xml

<!-- app/config/config.xml -->
<parameters>
<parameter key="translator.class">Acme\HelloBundle\Translation\Translator</parameter>
</parameters>

.. code-block:: php

// app/config/config.php
$container->setParameter('translator.class', 'Acme\HelloBundle\Translation\Translator');

Secondly, if the class is not available as a parameter, you want to make sure the
class is always overridden when your bundle is used or if you need to modify
something beyond just the class name, you should use a compiler pass::
If you want to modify service definitions of another bundle, you can use a compiler
pass to change the class of the service or to modify method calls. In the following
example, the implementing class for the ``original-service-id`` is changed to
``Acme\DemoBundle\YourService`.
Copy link
Member

Choose a reason for hiding this comment

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

this is missing the second backtick after the class name


// src/Acme/DemoBundle/DependencyInjection/Compiler/OverrideServiceCompilerPass.php
namespace Acme\DemoBundle\DependencyInjection\Compiler;
Expand All @@ -86,12 +57,7 @@ something beyond just the class name, you should use a compiler pass::
}
}

In this example you fetch the service definition of the original service, and set
its class name to your own class.

See :doc:`/service_container/compiler_passes` for information on how to use
compiler passes. If you want to do something beyond just overriding the class,
like adding a method call, you can only use the compiler pass method.
For more information on compiler passes, see :doc:`/service_container/compiler_passes`.

Entities & Entity Mapping
-------------------------
Expand Down