[RTM] Draft of Contao controllers #1376

aschempp · 2018-02-18T18:30:24Z

Abstract controllers that implement the same features as the abstract ContentElement and Module classes did.

leofeyer · 2018-02-20T14:11:57Z

The PR should be targeted against the master branch.

aschempp · 2018-04-09T14:50:26Z

I have just updated this PR to make our fragments actually useful. The problem of inline fragment renderer is that it creates a subrequest without any of the current request information. It create a GET request even if the master request is POST, respectively drops POST parameters and much more.

Our fragments work different than the Symfony core, that's why it makes sense to inherit the master request in our case. It is still very much possible to keep the existing behavior by simply overriding the renderer in the tag configuration.

Toflar · 2018-04-09T14:53:52Z

Our fragments work different than the Symfony core, that's why it makes sense to inherit the master request in our case. It is still very much possible to keep the existing behavior by simply overriding the renderer in the tag configuration.

That's correct. Reviewed and concept approved. But tests need to be fixed 😄

aschempp · 2018-04-10T07:04:16Z

@contao/developers any other feedback? Can we agree that we want this implementation before I spend more time on fixing tests?

Toflar · 2018-04-10T08:01:07Z

I've got it on my list, will review today :)

Toflar

I've reviewed. Excellent work and definitely must be merged. I've added a few comments that I think should be addressed first though 😄

Toflar · 2018-04-11T10:32:09Z

src/Controller/ContentElement/AbstractContentElementController.php

+
+        $template->inColumn = $section;
+
+        if (is_array($classes = $request->attributes->get('classes'))) {


\is_array()

Should be a task of php-cs-fixer, no?

Jup… see 5cdc39a

Toflar · 2018-04-11T10:32:59Z

src/Controller/FrontendController/AbstractFrontendModuleController.php

+
+        $template = new BackendTemplate('be_wildcard');
+
+        $template->wildcard = '### ' . strtoupper($GLOBALS['TL_LANG']['FMD'][$this->getType()][0]) . ' ###';


Can't we use our translator here?

Changed in 9059847

Toflar · 2018-04-11T10:34:27Z

src/DependencyInjection/Compiler/RegisterFragmentsPass.php

@@ -77,6 +78,10 @@ protected function registerFragments(ContainerBuilder $container, string $tag):
                    $preHandlers[$identifier] = $reference;
                }

+                if (is_a($definition->getClass(), AbstractFragmentController::class, true)) {


That just kills the possibility to have a custom controller that needs to know the fragment options but does not want to extend the AbstractFragmentController. I mean, the purpose of the fragments is that they are fully independent controllers so I think we should work with a FragmentOptionsAwareInterface here, wdyt?

I second that. We should use small(!) interfaces for these tasks.
Brings also the benefit of being able to deprecate one way (old interface) and introduce a new way without changing the API. I guess we will have to alter the mechanics in the future which is easier by adding another interface than having version_compares() and the like.

Added in 43b042d

Toflar · 2018-04-11T10:35:08Z

src/Fragment/ForwardFragmentRenderer.php

+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Fragment\InlineFragmentRenderer;
+
+class ForwardFragmentRenderer extends InlineFragmentRenderer


Would be great if you could add some docs here and explain why this is needed.

Added in 5523f84

dmolineus · 2018-04-11T11:28:35Z

It's a great simplification of such attract controllers would be provided.

I'd prefer not to depend on the Contao template classes though. We could extend the symfony template engine wrapping the Contao templates. Then it's up to the developer to decide which template to use. Migrating later to twig templates would be really easy then.

For example following template syntax could be used:

contao:be:be_main.html5
contao:fe:fe_page.html5

I know it's off topic here but it would be nice to have this feature included when merging this pr.

If you like the idea I'd love to contribute the code. (I already do it in my toolkit library, https://github.com/netzmacht/contao-toolkit/blob/master/src/View/Template/ToolkitTemplateEngine.php)

qzminski · 2018-04-11T15:06:54Z

src/Controller/FrontendController/AbstractFrontendModuleController.php

+     *
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
+    protected function getBackendWildcard(ModuleModel $module, Request $request)


This method should actually be also available for content elements, as some of them may display dynamic data as well.

It should not be in the parent class for sure, because the generated URL is different for different types. Also, none of the core elements have wildcards. What's the reason not to show dynamic data?

And what's the reason to show backend wildcard for frontend modules?

¯\(ツ)/¯

I guess it's also a quick link to edit the module, which does not make sense for an element. There are content elements that change their appearance in the backend, but never to a wildcard. The YouTube element does not generate an iframe but a link to the video for example.

Sometimes the content element (frontend module as well) relies on the frontend page settings, has some jQuery scripts in the template or simply a pagination that is useless in backend. There are also the cases were generated data may simply be not necessary to render in the backend.

The backend wildcard should also be available for content elements. It must not be enabled by default but I don't see a reason why not offer it for developer at all.

aschempp · 2018-05-14T09:04:08Z

I have updated the PR. Most important change is to disable ignore_errors by default. If errors are ignores, it is not possible to handle ResponseException and fragments simply don't show up in the response. I noticed this because I had my own element that tried so use Controller::sentFileToBrowser.

Toflar · 2018-05-14T09:05:31Z

Good find!

leofeyer · 2018-06-01T14:20:14Z

src/Controller/FrontendController/AbstractFrontendModuleController.php

+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+abstract class AbstractFrontendModuleController extends AbstractFragmentController


I just realize that the classes are called ContentElement and Module in Contao, therefore this class should be renamed to AbstractModuleController, shouldn't it?

I dont think so, because there is also a backend module. Imho the old naming is „wrong“.

leofeyer · 2018-06-11T15:43:20Z

Thank you @aschempp.

christian-kolb · 2018-09-21T09:32:15Z

@leofeyer @aschempp @fritzmg @Toflar @qzminski @dmolineus Has someone of you already implemented a frontend module with this or the previous controller in a public repository? I think it would be great to have this linked from the 4.6.0 release blog post. This way more people would get a kickstart and we might see more bundles using it faster 🙂

bytehead · 2018-09-21T09:54:42Z

Something like this?

# app/config/services.yml

services:
    _defaults:
        autowire: true
        autoconfigure: true
        public: false

    # Content Elements
    app.content_element.acme_element:
        class: AppBundle\ContentElement\AcmeElement
        tags:
            - { name: contao.content_element, category: myCategory }
        calls:
            - [ setContainer,[ '@service_container' ] ]

    # Modules
    app.frontend_module.acme_module:
        class: AppBundle\Module\AcmeModule
        tags:
            - { name: contao.frontend_module, category: myCategory }
        calls:
            - [ setContainer,[ '@service_container' ] ]

// src/AppBundle/ContentElement/AcmeElement.php

<?php

declare(strict_types=1);

namespace AppBundle\ContentElement;

use Contao\CoreBundle\Controller\ContentElement\AbstractContentElementController;
use Contao\ModuleModel;
use Contao\Template;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class AcmeElement extends AbstractContentElementController
{
    protected function getResponse(Template $template, ContentModel $model, Request $request): Response
    {
        $template->title = "AcmeElement";

        return new Response($template->parse());
    }
}

// src/AppBundle/Module/AcmeModule.php

<?php

declare(strict_types=1);

namespace AppBundle\Module;

use Contao\CoreBundle\Controller\FrontendModule\AbstractFrontendModuleController;
use Contao\ModuleModel;
use Contao\Template;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class AcmeModule extends AbstractFrontendModuleController
{
    protected function getResponse(Template $template, ModuleModel $model, Request $request): Response
    {
        $template->title = "AcmeModule";

        return new Response($template->parse());
    }
}

qzminski · 2018-09-21T09:57:54Z

@bytehead looks good and similar to mine, I am just not sure if setContainer call in services.yml is really needed. I would rather use service injection here 🤔

bytehead · 2018-09-21T10:04:06Z

They are required indeed: https://github.com/contao/contao/blob/master/core-bundle/src/Controller/FrontendModule/AbstractFrontendModuleController.php#L26

qzminski · 2018-09-21T10:07:04Z

You sure? The class extends Controller which should already have container in it https://github.com/contao/contao/blob/master/core-bundle/src/Controller/AbstractFragmentController.php#L23

bytehead · 2018-09-21T10:09:20Z

Yes, just tested. Probably because AbstractFrontendModuleController is abstract?

qzminski · 2018-09-21T10:21:55Z

Ok that's strange, I would rather expect it to automatically have container set just like described in Symfony docs https://symfony.com/doc/3.4/controller.html#the-base-controller-class-services

Ping @aschempp

aschempp · 2018-09-25T09:24:52Z

¯\(ツ)/¯
I don't know… I guess you should debug that. I'm not very familiar with autowiring and autoconfiguration …

Description ----------- The PR partly reverts 43b5b45c1cb7f246c67026500dc20e8fa6d1593b and fixes the margin of the submit container. Commits ------- 8a857d55 Adjust the login screen again 🤷‍♂️

leofeyer requested a review from Toflar February 18, 2018 21:42

leofeyer changed the base branch from 4.5 to master February 20, 2018 14:11

leofeyer changed the base branch from master to 4.5 February 20, 2018 14:11

leofeyer assigned aschempp Feb 20, 2018

leofeyer added the feature label Feb 20, 2018

leofeyer added this to the 4.6.0 milestone Feb 20, 2018

aschempp added 2 commits February 20, 2018 18:51

Draft of Contao controllers

73cfc90

Implemented classes attribute from content element and frontend module

0a6dc71

aschempp force-pushed the feature/abstract-controller branch from 4312316 to 0a6dc71 Compare February 20, 2018 18:00

leofeyer changed the base branch from 4.5 to master February 21, 2018 08:30

leofeyer changed the title ~~Draft of Contao controllers~~ [WIP] Draft of Contao controllers Feb 21, 2018

leofeyer removed this from the 4.6.0 milestone Feb 21, 2018

Use correct model type and remove todos

f3d6796

aschempp force-pushed the feature/abstract-controller branch from 6bf2b11 to f3d6796 Compare April 9, 2018 11:58

Added a forward renderer to inherit POST parameters etc.

983fad6

aschempp changed the title ~~[WIP] Draft of Contao controllers~~ [RFC] Draft of Contao controllers Apr 10, 2018

Toflar suggested changes Apr 11, 2018

View reviewed changes

qzminski reviewed Apr 11, 2018

View reviewed changes

leofeyer added the test missing label Apr 13, 2018

aschempp added 5 commits April 19, 2018 18:05

CS

5cdc39a

Use the translator service for labels

9059847

Added ForwardFragmentRenderer description

5523f84

Added interface to set fragment options

43b042d

Correctly name controller argument

f8fdf36

Allow to set fragment options in tag and enable error handling

5c68bf9

aschempp force-pushed the feature/abstract-controller branch from d920e2a to 5c68bf9 Compare May 14, 2018 09:02

leofeyer added this to the 4.6.0 milestone May 31, 2018

leofeyer requested changes Jun 1, 2018

View reviewed changes

aschempp added 2 commits June 9, 2018 10:51

Move getResponse method to make model argument more explicit

b90c5d7

Added unit tests, reduced duplicate code and several bugfixes

8fdd0fb

aschempp changed the title ~~[RFC] Draft of Contao controllers~~ [RTM] Draft of Contao controllers Jun 9, 2018

leofeyer removed the test missing label Jun 11, 2018

leofeyer added 2 commits June 11, 2018 17:00

Fix the tests.

2d45938

Fix the coding style.

e0a6102

leofeyer merged commit 5b64c9e into contao:master Jun 11, 2018

aschempp mentioned this pull request Sep 7, 2018

Unknown insert tag flag |uncached contao/contao#48

Closed

fritzmg mentioned this pull request Sep 21, 2018

Partieller Seitencache, No-Cache Blöcke in Templates, vergleichbar mit Seitenindex contao/contao#81

Closed

aschempp deleted the feature/abstract-controller branch September 25, 2018 09:24


		$template->inColumn = $section;

		if (is_array($classes = $request->attributes->get('classes'))) {


		$template = new BackendTemplate('be_wildcard');

		$template->wildcard = '### ' . strtoupper($GLOBALS['TL_LANG']['FMD'][$this->getType()][0]) . ' ###';

[RTM] Draft of Contao controllers #1376

[RTM] Draft of Contao controllers #1376

Conversation

aschempp commented Feb 18, 2018 • edited Loading

leofeyer commented Feb 20, 2018

aschempp commented Apr 9, 2018

Toflar commented Apr 9, 2018

aschempp commented Apr 10, 2018

Toflar commented Apr 10, 2018

Toflar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dmolineus commented Apr 11, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aschempp Apr 18, 2018 • edited by leofeyer Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aschempp commented May 14, 2018

Toflar commented May 14, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leofeyer commented Jun 11, 2018

christian-kolb commented Sep 21, 2018

bytehead commented Sep 21, 2018 • edited Loading

qzminski commented Sep 21, 2018

bytehead commented Sep 21, 2018

qzminski commented Sep 21, 2018

bytehead commented Sep 21, 2018

qzminski commented Sep 21, 2018

aschempp commented Sep 25, 2018 • edited Loading

aschempp commented Feb 18, 2018 •

edited

Loading

aschempp Apr 18, 2018 •

edited by leofeyer

Loading

bytehead commented Sep 21, 2018 •

edited

Loading

aschempp commented Sep 25, 2018 •

edited

Loading