Skip to content

Added a note about the class option of the services defined via factories #5018

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

Merged
merged 4 commits into from
Mar 14, 2015
Merged

Added a note about the class option of the services defined via factories #5018

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
27ca372
Added a note about the class option of the services defined via facto…
javiereguiluz Feb 19, 2015
477da91
Minor rewording
javiereguiluz Feb 19, 2015
90956cc
Minor rewording
javiereguiluz Feb 19, 2015
2551322
Rewording
javiereguiluz Feb 19, 2015
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
8 changes: 8 additions & 0 deletions components/dependency_injection/factories.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,14 @@ class:

$container->setDefinition('newsletter_manager', $definition);

.. note::

When creating a service through a factory, the value chosen for the ``class``
Copy link
Contributor

Choose a reason for hiding this comment

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

when using a factory to create services, the ....

Copy link
Member Author

Choose a reason for hiding this comment

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

Much better! Thanks.

option has no effect on the resulting service, since the actual class name
only depends on the object returned by the factory. However, the configured
Copy link
Member

Choose a reason for hiding this comment

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

I would split the first sentence:

When using a factory to create services, the value chosen for the class option has no effect on the result srvice. The actual name only depend on the object that is returned by the factory. [...]

Copy link
Member Author

Choose a reason for hiding this comment

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

👍 Short sentences are always better. Fixed. Thanks!

class may be used by compiler passes and therefore should be set to a
Copy link
Member

Choose a reason for hiding this comment

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

[...] the configured class name [...]

sensible value.

When you specify the class to use for the factory (via ``factory_class``)
the method will be called statically. If the factory itself should be instantiated
and the resulting object's method called, configure the factory itself as a service.
Expand Down