8000 [DI] Added _instanceof example by greg0ire · Pull Request #8496 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

[DI] Added _instanceof example #8496

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 1 commit into from
Oct 13, 2017
Merged

[DI] Added _instanceof example #8496

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
57 changes: 56 additions & 1 deletion service_container/3.3-di-changes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ which means it's always safe to upgrade across minor versions.
All of the new features are **optional**: they are not enabled by default, so you
need to actually change your configuration files to use them.

.. _`service-33-default_definition`:

The new Default services.yml File
---------------------------------

Expand Down Expand Up @@ -411,7 +413,7 @@ In general, the new best practice is to use normal constructor dependency inject
4) Auto-tagging with autoconfigure
----------------------------------

The last big change is the ``autoconfigure`` key, which is set to ``true`` under
The fourth big change is the ``autoconfigure`` key, which is set to ``true`` under
``_defaults``. Thanks to this, the container will auto-tag services registered in
this file. For example, suppose you want to create an event subscriber. First, you
create the class::
Expand Down Expand Up @@ -468,6 +470,59 @@ Many autoconfigured tags have an optional priority. If you need to specify a pri
(or any other optional tag attribute), no problem! Just :ref:`manually configure your service <services-manually-wire-args>`
and add the tag. Your tag will take precedence over the one added by auto-configuration.

5) Auto-configure with _instanceof
----------------------------------

And the final big change is ``_instanceof``. It acts as a default definition
template (see `service-33-default_definition`_), but only for services whose
class matches a defined one.

This can be very useful when many services share some tag that cannot be
inherited from an abstract definition:

.. configuration-block::

.. code-block:: yaml

# app/config/services.yml
services:
# ...

_instanceof:
class: AppBundle\Domain\LoaderInterface
public: true
tags: ['app.domain_loader']

.. code-block:: xml

<!-- app/config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/services
http://symfony.com/schema/dic/services/services-1.0.xsd">

<services>
<!-- ... -->

<instanceof id="AppBundle\Domain\LoaderInterface" public="true">
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Here I replaced class by id

<tag name="app.domain_loader" />
</instanceof>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Here I fixed a closing tag

</services>
</container>

.. code-block:: php

// app/config/services.php
use AppBundle\Domain\LoaderInterface;

// ...

/* This method returns a child definition to define the default
configuration of the given class or interface */
$container->registerForAutoconfiguration(LoaderInterface::class)
Copy link
Member

Choose a reason for hiding this comment

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

this call is not about the _instanceof. It is about registering custom logic for services using autoconfigure.

The new PHP DSL has a syntax to define the _instanceof conditionals. The old syntax does not, because it uses the ContainerBuilder directly and so cannot provide file-scoped features.

->addTag('app.domain_loader');

What about Performance
----------------------

Expand Down
0