[TwigBundle] Add default templates directory and option to configure it #24179

yceruto · 2017-09-12T21:23:59Z

Q	A
Branch?	3.4
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	-
License	MIT
Doc PR	-

Feature freeze is coming so this one should be important for the new structure. Moving forward and alternative of #23339 but I'm proposing templates/bundles/<BundleName> instead of templates/bundles/<BundleTwigNamespace> to override bundles templates and easy migration from current app/Resources/<BundleName>/views convention. Also this fix the pending comments.

Summary:

Added new option to configure default path for templates directory:

twig:
    default_path: '%kernel.project_dir%/templates' # default

Added new path convention to override bundle templates <default_path>/bundles/<BundleName>:

# Examples:
templates/bundles/TwigBundle/Exception/error.html.twig - @Twig/Exception/error.html.twig
templates/bundles/FOSUserBundle/layout.html.twig - @FOSUser/layout.html.twig

Current templates in <kernel.root_dir>/Resources/<BundleName>/views have priority over the new one, and both have priority over the bundle views path.

src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php

mvrhov · 2017-09-13T08:50:44Z

Please no overrides dir. just keep it inside a bundles dir. Does it really matter. The one working on code knows.

yceruto · 2017-09-13T10:59:06Z

Changed to bundles directory.

chalasr

We should have a test case for this.

src/Symfony/Bundle/TwigBundle/DependencyInjection/Configuration.php

yceruto · 2017-09-13T13:15:55Z

Tests added.

ro0NL · 2017-09-13T13:22:58Z

Just a question; should we deprecate the old paths (hardcoded in src).

Ie trigger in case of if (file_exists($dir = $container->getParameter('kernel.root_dir').'/Resources/views')) { etc. Wouldnt that me more concise?

Only if not configured as path already of course.

fabpot · 2017-09-13T14:15:34Z

Thank you @yceruto.

…n to configure it (yceruto) This PR was merged into the 3.4 branch. Discussion ---------- [TwigBundle] Add default templates directory and option to configure it | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Feature freeze is coming so this one should be important for the new structure. Moving forward and alternative of #23339 but I'm proposing `templates/bundles/<BundleName>` instead of `templates/bundles/<BundleTwigNamespace>` to override bundles templates and easy migration from current `app/Resources/<BundleName>/views` convention. Also this fix the pending comments. Summary: * Added new option to configure default path for templates directory: ```yaml twig: default_path: '%kernel.project_dir%/templates' # default ``` * Added new path convention to override bundle templates `<default_path>/bundles/<BundleName>`: ``` # Examples: templates/bundles/TwigBundle/Exception/error.html.twig - @Twig/Exception/error.html.twig templates/bundles/FOSUserBundle/layout.html.twig - @FOSUser/layout.html.twig ``` Current templates in `<kernel.root_dir>/Resources/<BundleName>/views` have priority over the new one, and both have priority over the bundle `views` path. Commits ------- a1b391f Add default templates directory and option to configure it

fabpot · 2017-09-13T18:13:46Z

Just tested on 2 of my projects, and it works perfectly.

Tobion · 2017-09-17T02:55:40Z

I agree with @ro0NL that we should deprecate the old /Resources/<BundleName>/views.

it's not good to have different ways for the same thing as makes things inconsistent
there should be a configuration for the new path instead of hardcoding it as it makes things self-explaining, esp. if you add that to the default config file. for the same reason we removed auto-registration of commands in favor of having an explicit import (psr-4 loading and autoconfiguration or not).

ro0NL · 2017-09-17T06:29:04Z

@Tobion at time of posting i didnt realize we need to support both variants; legacy and new projects.

#24227 (comment)

I think also related is we dont want to force users switching to a new structure for no real benefit. But the fact you can mix&match can be confusing for sure! So yes, i think the current approach is a bit too pragmatic.

Technically we're fine :)

This PR was merged into the 3.4 branch. Discussion ---------- Add default_path option reference symfony/symfony#24179 Commits ------- 66fd357 Minor tweaks af245fc Add default_path option reference

nesl247 · 2017-12-28T19:55:31Z

Can anyone tell me if this was tested / supposed to work with Form templates? Doesn't seem to be working.

Specifically templates in templates/bundles/BundleName/Form/something.html.twig does not override the original. In my case this is for https://github.com/excelwebzone/EWZRecaptchaBundle but I'm guessing this would apply to any Form templates.

xabbuh · 2018-01-02T19:37:23Z

@nesl247 please open a new issue if you think you discovered a bug

nesl247 · 2018-01-03T03:36:30Z

Will do. Wasn't sure if I should or not as I'm not sure if it's working as intended or a bug.

anyt · 2019-01-18T15:28:59Z

Hi @yceruto,
Am I understand right,
When I have an old reference to the template, with colon notation, it's not possible to override template in a /templates folder by design. Should override be done in src/Resources/.. folder only?
So to use /templates folder to override, the only option I have - rename all the template references?

Asking, because we have more than 2k templates references, and renaming could cause new bugs, but maintaining two folders for override templates at the same time is confusing for developers.

yceruto · 2019-01-18T16:03:07Z

When I have an old reference to the template, with colon notation, it's not possible to override template in a /templates folder by design. Should override be done in src/Resources/.. folder only?
So to use /templates folder to override, the only option I have - rename all the template references?

That's correct.

Asking, because we have more than 2k templates references, and renaming could cause new bugs, but maintaining two folders for override templates at the same time is confusing for developers.

Since 4.2 src/Resources/views/ is deprecated but still works as Twig's path and has priority over templates/dir, so first, you can change the notation of the template name without breaking the loading process (thus, changing the loader and making use Twig features), and then, move them to templates/ shouldn't break anything either (it's just an exchange of paths).

carsonbot added Status: Needs Review TwigBundle Feature labels Sep 12, 2017

yceruto changed the base branch from master to 3.4 September 12, 2017 21:24

nicolas-grekas added this to the 3.4 milestone Sep 13, 2017

ro0NL reviewed Sep 13, 2017

View reviewed changes

src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php Outdated Show resolved Hide resolved

yceruto force-pushed the templates branch from 9738e67 to 7eea465 Compare September 13, 2017 10:52

chalasr reviewed Sep 13, 2017

View reviewed changes

src/Symfony/Bundle/TwigBundle/DependencyInjection/Configuration.php Outdated Show resolved Hide resolved

yceruto force-pushed the templates branch 2 times, most recently from 80a66f7 to c8e1327 Compare September 13, 2017 13:06

Add default templates directory and option to configure it

a1b391f

yceruto force-pushed the templates branch from c8e1327 to a1b391f Compare September 13, 2017 13:21

fabpot mentioned this pull request Sep 13, 2017

[TwigBundle] Added auto namespacing for new templates directory structure #23339

Closed

fabpot approved these changes Sep 13, 2017

View reviewed changes

chalasr approved these changes Sep 13, 2017

View reviewed changes

fabpot merged commit a1b391f into symfony:3.4 Sep 13, 2017

yceruto deleted the templates branch September 13, 2017 14:17

yceruto mentioned this pull request Sep 15, 2017

[DX] A simpler way to define custom error pages #24049

Closed

jvasseur mentioned this pull request Sep 24, 2017

[TwigBundle] Template override path isn't Symfony Flex-friendly #24310

Closed

Haehnchen mentioned this pull request Oct 9, 2017

[3.4] Improved the overriding of templates Haehnchen/idea-php-symfony2-plugin#1043

Open

fabpot mentioned this pull request Oct 18, 2017

Release v3.4.0-BETA1 #24609

Merged

fabpot mentioned this pull request Oct 19, 2017

Release v4.0.0-BETA1 #24612

Merged

yceruto mentioned this pull request Oct 24, 2017

Add default_path option reference symfony/symfony-docs#8549

Merged

emodric mentioned this pull request Nov 6, 2017

Add twig.default_path container parameter #24839

Closed

nesl247 mentioned this pull request Jan 3, 2018

Form templates overrides do not work in /templates #25661

Closed

peterrehm mentioned this pull request Nov 23, 2018

[Bug][Templating][Twig] Impossible to override templates of bundles #29299

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TwigBundle] Add default templates directory and option to configure it #24179

[TwigBundle] Add default templates directory and option to configure it #24179

yceruto commented Sep 12, 2017 •

edited

Loading

mvrhov commented Sep 13, 2017 •

edited

Loading

yceruto commented Sep 13, 2017

chalasr left a comment

yceruto commented Sep 13, 2017

ro0NL commented Sep 13, 2017 •

edited

Loading

fabpot commented Sep 13, 2017

fabpot commented Sep 13, 2017

Tobion commented Sep 17, 2017 •

edited

Loading

ro0NL commented Sep 17, 2017 •

edited

Loading

nesl247 commented Dec 28, 2017 •

edited

Loading

xabbuh commented Jan 2, 2018

nesl247 commented Jan 3, 2018

anyt commented Jan 18, 2019 •

edited

Loading

yceruto commented Jan 18, 2019 •

edited

Loading

[TwigBundle] Add default templates directory and option to configure it #24179

[TwigBundle] Add default templates directory and option to configure it #24179

Conversation

yceruto commented Sep 12, 2017 • edited Loading

mvrhov commented Sep 13, 2017 • edited Loading

yceruto commented Sep 13, 2017

chalasr left a comment

Choose a reason for hiding this comment

yceruto commented Sep 13, 2017

ro0NL commented Sep 13, 2017 • edited Loading

fabpot commented Sep 13, 2017

fabpot commented Sep 13, 2017

Tobion commented Sep 17, 2017 • edited Loading

ro0NL commented Sep 17, 2017 • edited Loading

nesl247 commented Dec 28, 2017 • edited Loading

xabbuh commented Jan 2, 2018

nesl247 commented Jan 3, 2018

anyt commented Jan 18, 2019 • edited Loading

yceruto commented Jan 18, 2019 • edited Loading

yceruto commented Sep 12, 2017 •

edited

Loading

mvrhov commented Sep 13, 2017 •

edited

Loading

ro0NL commented Sep 13, 2017 •

edited

Loading

Tobion commented Sep 17, 2017 •

edited

Loading

ro0NL commented Sep 17, 2017 •

edited

Loading

nesl247 commented Dec 28, 2017 •

edited

Loading

anyt commented Jan 18, 2019 •

edited

Loading

yceruto commented Jan 18, 2019 •

edited

Loading