Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Use the short Yaml syntax for service definition #7860

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.

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

Closed
wants to merge 3 commits into from

Conversation

GuilhemN
Copy link
Contributor

@GuilhemN GuilhemN commented Apr 30, 2017

Fix #7441

@@ -16,8 +16,7 @@ to be used for a specific purpose. Take the following example:

# app/config/services.yml
services:
app.twig_extension:
class: AppBundle\Twig\AppExtension
AppBundle\Twig\AppExtension:
public: false
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I hesitated to use _defaults here to be able to remove this line and use the short syntax, wdyt?

Copy link
Member

Choose a reason for hiding this comment

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

I'd say, let's not add the "defaults" until we decide what to do with that new option.

AppBundle\Twig\AppExtension:
tags: [twig.extension]

versionadded:: 3.3
Copy link
Member

Choose a reason for hiding this comment

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

To make versionadded a RST directive, you must include the two .. at the beginning: .. versionadded::

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Indeed, thanks. I also fixed it a few lines above.


.. versionadded:: 3.3
Support for the short syntax for service definition in the YAML format
was introduced in Symfony 3.3.
Copy link
Member

Choose a reason for hiding this comment

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

I think this should be moved to service_container, after #7807 is merged. I did not have that note there.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree I didn't realize I added it in tags.rst... I remove it and paste it here to not lose it.

.. tip::

    In YAML format, you may define a service with a simple array of tags as long
    as you don't need additional attributes. The following definitions are
    equivalent.

    .. code-block:: yaml

        services:

            # Compact syntax
            AppBundle\Twig\AppExtension: [twig.extension]

            # Verbose syntax
            AppBundle\Twig\AppExtension:
                tags: [twig.extension]

    .. versionadded:: 3.3
        Support for the short syntax for service definition in the YAML format
        was introduced in Symfony 3.3.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually rethinking about it, does it make sense? We don't talk about tags in service_container.

Copy link
Member

Choose a reason for hiding this comment

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

Don't we already have a place where we explain the difference?

Copy link
Contributor Author

@GuilhemN GuilhemN May 5, 2017

Choose a reason for hiding this comment

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

I don't think so, it was requested by #7441.

Copy link
Member

Choose a reason for hiding this comment

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

Hm, not sure if we really need this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Won't this be confusing for people who try to use it in lower versions because of our exemples using this syntax ?

Copy link
Member

Choose a reason for hiding this comment

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

Do we talk about different things? Do you mean the versionadded directive? Otherwise I don't see the problem as the changes were only merged into the master branch.

@GuilhemN GuilhemN changed the title Document the short Yaml syntax for service definition Use the short Yaml syntax for service definition May 2, 2017
@xabbuh
Copy link
Member

xabbuh commented May 4, 2017

Thank you @GuilhemN.

@xabbuh xabbuh closed this in dc9ac9b May 4, 2017
@GuilhemN GuilhemN deleted the SHORTSYNTAX branch May 4, 2017 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants