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

Clarify service parameters usages #3528

Merged
merged 2 commits into from
Feb 11, 2014
Merged

Clarify service parameters usages #3528

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05492b2
Clarify parameters conventions
wouterj Jan 31, 2014
aaddfcd
Applied comment
wouterj Feb 11, 2014
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
13 changes: 10 additions & 3 deletions components/dependency_injection/parameters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ and set a parameter in the container with::

$container->setParameter('mailer.transport', 'sendmail');

.. caution::

The used ``.`` notation is just a
:ref:`Symfony convention <service-naming-conventions>` to make parameters
easier to read. Parameters are just flat key-value elements, they can't be
inherited.
Copy link
Member

Choose a reason for hiding this comment

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

how about can't be organized into a nested array? What do you think - I wasn't totally clear on "inherited".

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, that's better :)

Copy link
Member

Choose a reason for hiding this comment

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

can you make this change real quick? That'll let me merge without any mods :)

Copy link
Member Author

Choose a reason for hiding this comment

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

done


.. note::

You can only set a parameter before the container is compiled. To learn
Expand Down Expand Up @@ -190,9 +197,9 @@ making the class of a service a parameter:
Array Parameters
----------------

Parameters do not need to be flat strings, they can also be arrays. For the XML
format, you need to use the ``type="collection"`` attribute for all parameters that are
arrays.
Parameters do not need to be flat strings, they can also contain array values.
Copy link
Member Author

Choose a reason for hiding this comment

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

changed this to array values, to make it explicitly clear that this isn't a way to inherit parameters.

Copy link
Member

Choose a reason for hiding this comment

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

yea, very nice change

For the XML format, you need to use the ``type="collection"`` attribute for
all parameters that are arrays.

.. configuration-block::

Expand Down
2 changes: 2 additions & 0 deletions contributing/code/standards.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ Naming Conventions
* Don't forget to look at the more verbose :doc:`conventions` document for
more subjective naming considerations.

.. _service-naming-conventions:

Service Naming Conventions
~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down