Twig Templates

[JLN]

contentelement.PNG

Ich möchte als template für mein ContentElement den Quellcode in Twig schreiben. Jedoch sobald ich im Controller das template auf siehe Screenshot ändere, wird das template nicht gefunden. (loremipsum.html5 findet er jedoch).

Wie kann ich mit twig arbeiten bzw. die Template richtig rendern lassen?

Controller Path: src/Controller/ContentElement/MyContentElementController.php
Template Path: templates/ce_twig.html5.twig

[Spooky]

Das Template, das du in der Annotation angibst, ist das Template, dass dir in der getResponse Methode übergeben wird, also kein Twig Template, sondern ein Contao FrontendTemplate. Wenn du ein Twig Template verwenden möchtest, musst du das selbst instanzieren.

[JLN]

Das Template, das du in der Annotation angibst, ist das Template, dass dir in der getResponse Methode übergeben wird, also kein Twig Template, sondern ein Contao FrontendTemplate. Wenn du ein Twig Template verwenden möchtest, musst du das selbst instanzieren.

Kannst du ein Beispiel geben zum Twig Template instanzieren?

[Spooky]

Also eigentlich meinte ich rendern. Funktioniert grundsätzlich genau so wie man es bei normalen Route Actions machen würde. zB.:

// src/Controller/ContentElement/MyContentElementController.php
namespace App\Controller\ContentElement;

use Contao\ContentModel;
use Contao\CoreBundle\Controller\ContentElement\AbstractContentElementController;
use Contao\CoreBundle\ServiceAnnotation\ContentElement;
use Contao\Template;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Twig\Environment;

/**
 * @ContentElement(category="texts")
 */
class MyContentElementController extends AbstractContentElementController
{
    private $twig;

    public function __construct(Environment $twig)
    {
        $this->twig = $twig;
    }

    protected function getResponse(Template $template, ContentModel $model, Request $request): ?Response
    {
        return new Response($this->twig->render(
            'my_content_element.html.twig',
            $model->row()
        ));
    }
} 

{# templates/my_content_element.html.twig #}
Hello {{type}}!

Ausgabe im Frontend:

Hello my_content_element!

[JLN]

Danke erstmal für die ausführliche und verständliche Antwort!

Und woran liegt es, dass ich mein erstelltes ContentElement nur sehe, wenn ich mich im Debug Modus befinde?

[Spooky]

Und woran liegt es, dass ich mein erstelltes ContentElement nur sehe, wenn ich mich im Debug Modus befinde?

Wenn du die Konfiguration änderst - darunter fällt auch das Ändern des DCAs oder das registrieren/hinzufügen neuer Inhaltselemente etc. - musst du in der Produktionsumgebung auch den Cache neu aufbauen lassen. Im Debug-Modus nicht.

[JLN]

Wenn du die Konfiguration änderst - darunter fällt auch das Ändern des DCAs oder das registrieren/hinzufügen neuer Inhaltselemente etc. - musst du in der Produktionsumgebung auch den Cache neu aufbauen lassen. Im Debug-Modus nicht.

Wie lässt der Cache sich denn neu aufbauen?

[Spooky]

Auf der Konsole zB.:

vendor/bin/contao-console cache:clear --no-warmup
vendor/bin/contao-console cache:warmup

[JLN]

Auf der Konsole zB.:

vendor/bin/contao-console cache:clear --no-warmup
vendor/bin/contao-console cache:warmup

Funktioniert leider nicht. Woran kann es liegen?

va.PNG

[Spooky]

Entferne das "php " vorne. Du kannst auch einfach ein composer install ausführen. Aber da du sowieso lokal bist: da brauchst du das ja nur zum überprüfen am Schluss, ob alles auch in der Produktionsumgebung funktioniert. Entwickeln tust du ja in der dev Umgebung, also im Debug-Modus, über die .env.local.

[JLN]

Entferne das "php " vorne.

Danke!

[JLN]

Entferne das "php " vorne. Du kannst auch einfach ein composer install ausführen. Aber da du sowieso lokal bist: da brauchst du das ja nur zum überprüfen am Schluss, ob alles auch in der Produktionsumgebung funktioniert. Entwickeln tust du ja in der dev Umgebung, also im Debug-Modus, über die .env.local.

Hab jetzt den Symfony Controller erstellt, der mein gewünschtes Twig Template rendert. Soweit so gut, danke nochmal dafür! Wie kann ich im Backend jedoch nun festlegen welche Felder (Headline, Image, ...) dargestellt werden sobald ich mein neues Element ausgewählt habe?

[Spooky]

Über palettes:

https://docs.contao.org/dev/framewor...ments/#example
https://docs.contao.org/dev/framework/dca/
https://docs.contao.org/dev/reference/dca/palettes/

[JLN]

Über palettes:

https://docs.contao.org/dev/framewor...ments/#example
https://docs.contao.org/dev/framework/dca/
https://docs.contao.org/dev/reference/dca/palettes/

Ich verstehe nicht, wie der Symfony Controller die palette bekommt. Muss ich das in den Annotations angeben?

[Spooky]

Der Name der Palette = der Typ des Inhaltselements. Der Typ des Inhaltselements wird entweder automatisch aus dem Klassennamen ermittelt (siehe Dokumentation) - oder du legst ihn über die Annotation selbst fest.

[JLN]

Der Name der Palette = der Typ des Inhaltselements. Der Typ des Inhaltselements wird entweder automatisch aus dem Klassennamen ermittelt (siehe Dokumentation) - oder du legst ihn über die Annotation selbst fest.

$GLOBALS['TL_DCA']['tl_test'] = [
    'palettes' => [
        'default' => '{title_legend},title,alias,addImage',
    ],
];

test = der festgelegte Name von mir (wird auch so im Contao Backend angezeigt!)
Ändert jedoch leider nichts..

[Spooky]

Halte dich doch an das Beispiel in der Dokumentation: https://docs.contao.org/dev/framewor...ments/#example

[JLN]

Halte dich doch an das Beispiel in der Dokumentation: https://docs.contao.org/dev/framewor...ments/#example

test.PNG
test2.PNG

Muss die Datei im dca-Ordner nen bestimmten Namen haben?

[Spooky]

Steht in der Dokumentation: https://docs.contao.org/dev/framewor...ments/#example

// contao/dca/tl_content.php 

[JLN]

Steht in der Dokumentation: https://docs.contao.org/dev/framewor...ments/#example

// contao/dca/tl_content.php 

So habe ich es auch übernommen, ändert jedoch nichts

[Spooky]

Wenn du dich im Debug-Modus befindest, musst du, bei neu hinzugefügten Dateien, auch den Cache löschen. zB einfach manuell den Ordner var/cache löschen.

[JLN]

Wenn du dich im Debug-Modus befindest, musst du, bei neu hinzugefügten Dateien, auch den Cache löschen. zB einfach manuell den Ordner var/cache löschen.

Ich hab mal $GLOBALS['TL_DCA'] ge-dump'ed und in tl_content -> palettes hineingeschaut, jedoch taucht dort mein Eintrag nicht auf.

[Spooky]

Poste mal deinen gesamten bisherigen Code, mit Angabe wo sich die jeweilige Datei befindet, relativ zum Installationsverzeichnis der Contao Installation.

[JLN]

Poste mal deinen gesamten bisherigen Code, mit Angabe wo sich die jeweilige Datei befindet, relativ zum Installationsverzeichnis der Contao Installation.

src/Controller/ContentElement/MyContentElementController.php

<?php


namespace App\Controller\ContentElement;

use Contao\ContentModel;
use Contao\CoreBundle\Controller\ContentElement\AbstractContentElementController;
use Contao\CoreBundle\ServiceAnnotation\ContentElement;
use Contao\Template;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Twig\Environment;

/**
 * @ContentElement(
 *     "test",
 *     category="Symfony")
 */
class MyContentElementController extends AbstractContentElementController
{

    protected function getResponse(Template $template, ContentModel $model, Request $request): ?Response
    {

        dump($GLOBALS['TL_DCA']);
        $template->text = $model->text;

        return $template->getResponse();
    }
}

dca/tl_content

$GLOBALS['TL_DCA']['tl_content']['palettes']['test'] = 
    '{type_legend},type;{text_legend},text'
; 

templates/ce_test.html5 (Warum muss es eig. html5 sein?)

<h5>Hello World</h5>

Backend -> leer
leer.PNG

[Spooky]

dca/tl_content

Der Pfad dieser Datei muss contao/dca/tl_content.php sein.

[JLN]

Der Pfad dieser Datei muss contao/dca/tl_content.php sein.

Ok das wars. Danke!

[JLN]

Gehen wir nun davon aus, dass ich kein Twig Template rendern möchte, sondern ein normales HTML5-Template (warum genau eig. HTML5 und nicht nur html?)

In Twig

 return new Response($this->twig->render(
            'ce_twig.html.twig',
            ['model' => $model->row()]
        ));

und dann im Twig-Template um den Text (eingegeben im Backend) auszugeben

{{ model.text }}

Wie kann ich das für eine HTML5 Datei umsetzen?

[Spooky]

Gehen wir nun davon aus, dass ich kein Twig Template rendern möchte, sondern ein normales HTML5-Template (warum genau eig. HTML5 und nicht nur html?)

Ist halt so . Historisch war es so, dass Contao früher XHTML & HTML5 ausgeben konnte. Daher gab es auch je nach dem ein Template für XHTML und ein Template für HTML5. Und das wurde über die Dateiextension unterschieden. Heute wird nur mehr HTML5 unterstützt. Die Anforderung, dass die Templates genau so heißen müssen ist aufgrund der Rückwärtskompatibilität aber geblieben.

Wie kann ich das für eine HTML5 Datei umsetzen?

zB

<?= $this->text ?>

Siehe auch https://docs.contao.org/dev/framework/templates/

[JLN]

zB

<?= $this->text ?>

Siehe auch https://docs.contao.org/dev/framework/templates/

Ah ich hatte

<?php $this->text ?>

Worin liegt dort der Unterschied zwischen dem "<?php" und "<?=" ?

[Spooky]

<?= ... ?> ist die Kurzform von <?php echo ... ?>.