[Events] Sylius template event forms

[SirDomin]

Q	A
Branch?	1.10
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Related tickets
License	MIT

Introduce sylius template events on forms for easy overwriting templates.

[lchrusciel]

Can you check if the "form" variable is present inside of _context? Also, if some additional attribute is required to call it, lets add it explicitly, to be sure people may use it as in normal form template

E.g

[SirDomin]

yup, that could be done like this, but in sylius plus we are using more than just forms, this way we allow user to use any variable in that event. I think its more customize friendly than sending just the form.

[lchrusciel]

But is the form available straight from the template or behind some additional variable? I

[vvasiloi]

Directly.

[vvasiloi]

Here's some examples of it being used it other places: https://github.com/Sylius/Sylius/search?l=Twig&q=_context

[vvasiloi]

Great initiative! I'm not a fan of before / after hooks, especially in complex templates like forms.
From my experience customizing forms, I rarely wanted to just append / prepend something to a form.
I would rather partition the forms in smaller pieces and display each piece with an event then let the events system do it's job.
Here's a good example of it:

• sylius.shop.layout.header in @SyliusShop/layout.html.twig

  sylius.shop.layout.header:
      blocks:
          header:
              template: "@SyliusShop/_header.html.twig"
              priority: 20
          after_header_legacy:
              template: "@SyliusUi/Block/_legacySonataEvent.html.twig"
              priority: 15
              context:
                  event: sylius.shop.layout.after_header
          menu:
              template: "@SyliusShop/Layout/Header/_menu.html.twig"
              priority: 10

• sylius.shop.layout.header.grid in @SyliusShop/_header.html.twig

  sylius.shop.layout.header.grid:
      blocks:
          logo:
              template: "@SyliusShop/Layout/Header/_logo.html.twig"
              priority: 30
          content:
              template: "@SyliusShop/Layout/Header/_content.html.twig"
              priority: 20
          cart:
              template: "@SyliusShop/Layout/Header/_cart.html.twig"
              priority: 10

• sylius.shop.layout.header.content in @SyliusShop/Layout/Header/_content.html.twig

[lchrusciel]

Looking for @vvasiloi and @GSadee answers we have a consensus on how to do it:

sylius_ui:
    events:
        sylius.admin.channel.form_content:
            blocks:
                content:
                    template: '@SyliusAdmin/Channel/Form/_content.html.twig' # inside of it just enough of HTML to have columns layout
                    priority: 10
        sylius.admin.channel.form_columns:
            blocks:
                first_column:
                    template: '@SyliusAdmin/Channel/Form/_first_column.html.twig' # inside of it just enough of HTML to single column wrapping + new event
                    priority: 20
                second_column:
                    template: '@SyliusAdmin/Channel/Form/_second_column.html.twig' # inside of it just enough of HTML to single column wrapping + new event
                    priority: 10
        sylius.admin.channel.first_form_column:
            blocks:
                general:
                    template: '@SyliusAdmin/Channel/Form/FirstColumn/_general.html.twig' # content from H4 with sylius.ui.general + block below it
                    priority: 20
                money:
                    template: '@SyliusAdmin/Channel/Form/FirstColumn/_money.html.twig' # content from H4 with sylius.ui.money + block below it
                    priority: 10

Probably could be even more granural, but that would be great improvement already IMHO

[GSadee]

The base of this pull-request was changed, you need fetch and reset your local branch
if you want to add new commits to this pull request. Reset before you pull, else commits
may become messed-up.

Unless you added new commits (to this branch) locally that you did not push yet,
execute git fetch origin && git reset "sylius-template-event-forms" to update your local branch.

Feel free to ask for assistance when you get stuck 👍

[vvasiloi]

Suggested change

	sylius.admin.admin_user.first_column:
	sylius.admin.admin_user.form.first_column:

Not including form might create confusion or even name collision in the future.

[GSadee]

Thank you, @SirDomin! 🥇