F\u00fcr die TYPO3 v9.5 LTS wurde die Symfony Expression Language bei den TypoScript Conditions eingef\u00fchrt. Wem das zu viele Fragezeichen auf einmal sind, dem erkl\u00e4ren wir zun\u00e4chst, um was es sich bei TypoScript Conditions und der Symfony Expression Language handelt. Anschlie\u00dfend zeigen wir wie \u00e4ltere Conditions migriert und somit zukunftsf\u00e4hig gemacht werden.<\/p>\n
TypoScript Conditions kommen wie der Name bereits verr\u00e4t beim TypoScript zum Einsatz. TypoScript ist keine Skriptsprache. TypoScript dient eher als eine Art API (Schnittstelle), zum konfigurieren des zugrunde liegenden PHP-Codes.<\/p>\n
Die TypoScript Conditions (zu Deutsch „Bedingungen“) bieten die M\u00f6glichkeit zu \u00fcberpr\u00fcfen, ob eine Bedingung erf\u00fcllt ist oder nicht. Je nachdem wird weiteres TypoScript verwendet oder nicht.<\/p>\n
... TypoScript ...\r\n\r\n[\u00a0Condition\u00a01\u00a0][\u00a0Condition\u00a02\u00a0]\r\n\r\n...\u00a0TypoScript, dass nur verarbeitet wird, wenn die Bedingungen erf\u00fcllt wurden\u00a0...\r\n\r\n[END]\r\n\r\n... TypoScript ...<\/pre>\nMit den Conditions kann beispielsweise Folgendes gefragt werden:<\/p>\n
Zugegeben sind einige von diesen Fragen nicht f\u00fcr jede Webseite relevant. Es soll lediglich gezeigt werden, dass die M\u00f6glichkeiten der TypoScript Conditions kaum Grenzen kennen. Mit der Einf\u00fchrung der Symfony Expression Language werden sie sogar noch m\u00e4chtiger.<\/p>\n
Symfony ist ein weit verbreitetes PHP-Framework. Es gibt PHP-Entwicklern n\u00fctzliche Werkzeuge an die Hand. So zum Beispiel auch die Expression Language.<\/p>\n
Die Expression Language stellt eine Engine bereit, mit der Ausdr\u00fccke kompiliert und ausgewertet werden k\u00f6nnen. Ein Ausdruck ist ein Einzeiler, der einen Wert zur\u00fcckgibt. Meistens ist dieser Wert vom Typ Boolean, also entweder Wahr oder Falsch.<\/p>\n
Innerhalb von Symfony sieht das dann wie folgt aus.<\/p>\n
$expressionLanguage->evaluate('1 < 2');\u00a0\/\/\u00a0wahr<\/pre>\nDie Expression Language stellt in diesem Fall ‚1 < 2‘ dar. Hierbei handelt es sich um ein simples Beispiel.<\/p>\n
Die Expression Language Syntax\u00a0ist viel umfangreicher. M\u00f6glich sind somit auch:<\/p>\n
$expressionLanguage->evaluate('not\u00a0(\"Schuppenkopfr\u00f6tel\"\u00a0matches\u00a0\"\/Paddyreiher\/\")');\u00a0\/\/\u00a0wahr\r\n\r\n$expressionLanguage->evaluate('11 in 1..10'); \/\/\u00a0falsch\r\n\r\n$expressionLanguage->evaluate('calendar.getWeekday() == \"Freitag\"')); \/\/ Am Freitag wahr, sonst falsch<\/pre>\nDer Ausdruck matches<\/code> erm\u00f6glicht den Vergleich mit s\u00e4mtlichen regul\u00e4ren Ausdr\u00fccken.\u00a0Zudem k\u00f6nnen Eigenschaften und Funktionen von Objekten ausgef\u00fchrt werden.<\/p>\nZu beachten ist, dass ein Schr\u00e4gstrich (\\) innerhalb einer Zeichenkette mit 4 weiteren maskiert werden muss (\\\\\\\\) und sogar mit 8 (\\\\\\\\\\\\\\\\) in einem regul\u00e4ren Ausdruck.\u00a0 Dar\u00fcber hinaus werden Kontrollsequenzen, wie z.B. ein Zeilenumbruch (\\n), normalerweise mit einem Leerzeichen ersetzt. Durch voranstellen eines Weiteren umgekehrten Schr\u00e4gstrichs wird dies vermieden (\\\\n).<\/p>\n
Die hier aufgef\u00fchrten Beispiele sind nur ein kleiner Auszug. Einen umfangreichen \u00dcberblick gibt es in der Dokumentation<\/a>.<\/p>\nTypoScript Conditions in TYPO3 v9.5 LTS<\/h2>\n
Die Symfony Expression Language wurde mit der TYPO3 v9.4 in den Core \u00fcbernommen und steht somit auch in der Long Term Version 9.5 zur Verf\u00fcgung. Die alte Syntax gilt als veraltet und wird nur noch bis zur 10er Version unterst\u00fctzt. Um sein System zukunftsf\u00e4hig zu halten, gilt es die alten Conditions zu migrieren.<\/p>\n
Variablen<\/h3>\n
Schon vor der TYPO3 9 kamen Conditions zum Einsatz. Hier standen dem Integrator eine Vielzahl von Variablen<\/a>\u00a0zur Verf\u00fcgung, wie z.B. die ID der aktuellen Seite oder der Name des angemeldeten Benutzers. Diese gibt es innerhalb der Symfony Expression Language bei TYPO3 wieder, nur die Syntax ist eine andere. Ein paar Beispiele:<\/p>\n\napplicationContext<\/code> – Gibt Aufschluss \u00fcber die aktuelle Umgebung, z.B. „production“ oder „development“.<\/li>\npage<\/code>\u00a0– Alle Eigenschaften der Seite als Array.<\/li>\n{$meineTypoScriptKonstante}<\/code> – erm\u00f6glicht auf den Inhalt der TypoScript-Konstanten zuzugreifen.<\/li>\nfrontend.user.isLoggedIn<\/code> – ist wahr, wenn der Nutzer im Frontend angemeldet ist<\/li>\n- \n
typo3.version<\/code> – aktuelle TYPO3-Version, z.B. 9.5.0-dev<\/p>\n<\/li>\n<\/ul>\nFunktionen<\/h3>\n
Um wirklich alle bisherigen Conditions ersetzen zu k\u00f6nnen, gibt TYPO3 neben den Variablen auch Funktionen an die Hand.<\/p>\n
\ndate()<\/code> – Zugriff auf das aktuelle Datum<\/li>\nlike(\"Heuhaufen\", \"*Nadel\")<\/code>\u00a0 – Schaut, ob die Zeichenkette Nadel im Heuhaufen vorkommt. Das Sternchen (*) wird als Platzhalter f\u00fcr eine beliebige Zeichenkette verwendet.<\/li>\ngetTSFE()<\/code> – Erm\u00f6glicht den Zugriff auf den TypoScriptFrontendController $GLOBALS[‚TSFE‘]<\/li>\nrequest.getQueryParams()<\/code> – Ermittelt alle GET-Parameter.<\/li>\n- \n
site()<\/code> – Gibt die Eigenschaften der aktuellen Seitenkonfiguration zur\u00fcck.<\/p>\n<\/li>\n<\/ul>\nEine \u00dcbersicht aller Variablen und Funktionen, gibt es in der Feature-Beschreibung<\/a>.<\/p>\nAusdr\u00fccke<\/h3>\n
Es folgen nun Beispiele, wie bisherige Conditions mit der neuen Symfony Expression Language aussehen.<\/p>\n
Seitensprache<\/h4>\n\/\/bis\u00a0TYPO3\u00a0v9:\r\n[globalVar\u00a0=\u00a0GP:L\u00a0=\u00a01]\r\n\u00a0\r\n\/\/\u00a0ab\u00a0TYPO3\u00a09.4\u00a0- der L-Parameter entf\u00e4llt, daher \u00dcberpr\u00fcfung der Site-Configuration\r\n[siteLanguage(\"languageId\")\u00a0==\u00a0\"1\"]\r\n\/\/ neben der Id k\u00f6nnen nun auch weitere Eigenschaften abgefragt werden\r\n[siteLanguage(\"title\")\u00a0==\u00a0\"Deutsch\"]<\/pre>\nGet- und Post-Parameter<\/h3>\n\/\/ bis TYPO3 v9.3\r\n[globalVar = GP:tx_myext_myplugin|bla > 0]\r\n\r\n\/\/ ab TYPO3 v9.4 (GET-Parameter oder POST-Parameter)\r\n[request.getQueryParams()['tx_myext_myplugin']['bla'] > 0] || \r\n [request.getParsedBody()['tx_myext_myplugin']['bla'] > 0]<\/pre>\nAktuell gibt es hierzu noch eine Diskussion auf https:\/\/forge.typo3.org\/issues\/88756#change-404466<\/a>. Im jetzigen Zusantand wirft diese Abfrage eine Warnung, wenn das Array [‚tx_myext_myplugin‘] nicht exisitert. Es wird noch diskutiert, ob diese Abfrage zus\u00e4tzlich definiert werden soll oder die \u00dcberpr\u00fcfung bereits automatisch passiert. Danke f\u00fcr den Hinweis Clive.<\/em><\/p>\nEin Workaround ist die Funktion traverse zu nutzen (Danke Florian f\u00fcr den Hinweis). Diese ist ab TYPO3 v9 erh\u00e4ltich (s. TYPO3-Doku<\/a>).<\/p>\n[traverse(request.getQueryParams(), 'tx_myext_myplugin\/bla') > 0 ||\r\n traverse(request.getParsedBody(), 'tx_myext_myplugin\/bla') > 0]<\/pre>\nEbene im Seitenbaum<\/h3>\n\/\/\u00a0bis\u00a0TYPO3\u00a0v9.3\u00a0\r\n[treeLevel\u00a0=\u00a00,2]\u00a0\r\n\r\n\/\/\u00a0ab\u00a0TYPO3\u00a0v9.4\u00a0\r\n[tree.level in\u00a0[0,2]]<\/pre>\nSeite in Rootline<\/h3>\n\/\/\u00a0bis\u00a0TYPO3\u00a0v9.3\u00a0\r\n[PIDinRootline =\u00a05,10]\u00a0\r\n\r\n\/\/\u00a0ab\u00a0TYPO3\u00a0v9.4\u00a0\r\n[5 in tree.rootLineIds || 10 in tree.rootLineIds]<\/pre>\nSeiteneigenschaften<\/h3>\n\/\/ bis TYPO3 v9.3\r\n[page|backend_layout = 1]\r\n\r\n\/\/ ab TYPO3 v9.4\r\n[page[\"backend_layout\"] == '1']<\/pre>\nDomain<\/h3>\n\/\/ bis TYPO3 v9.3\r\n[globalString = IENV:HTTP_HOST = *.mydomain.com]\r\n\r\n\/\/ ab TYPO3 v9.4\r\n[like(request.getNormalizedParams().getHttpHost(), '*.mydomain.com')]<\/pre>\nKonstanten<\/h3>\n\/\/ bis TYPO3 v9.3\r\n[globalVar = LIT:1 = {$meineTypoScriptKonstante}]\r\n\r\n\/\/ ab TYPO3 v9.4\r\n[\"{$meineTypoScriptKonstante}\" == \"1\"]<\/pre>\nNutzer im Backend eingeloggt<\/h3>\n\/\/ bis TYPO3 v9.3\r\n[globalVar = TSFE:beUserLogin > 0]\r\n\r\n\/\/ ab TYPO3 v9.4\r\n[getTSFE().beUserLogin]<\/pre>\nIst heute Freitag?<\/h3>\n\/\/ bis TYPO3 v9.3\r\n[dayofweek = 5]\r\n\r\n\/\/ ab TYPO3 v9.4\r\n[date(\"w\") == 5]<\/pre>\nWeitere Beispiele<\/h4>\n
Wie bereits erw\u00e4hnt sind die M\u00f6glichkeiten der Conditions kaum begrenzt. Weiterf\u00fchrende Links mit zus\u00e4tzlichen Beispielen sind am Ende des Blog-Beitrags zusammengetragen.<\/p>\n
Erweitern der Expression Language<\/h3>\n
Bisher konnten eigene Funktionen via [userFunc = \\Vendor\\Extension\\UserFunc\\MyUserFunc('foo')]<\/code> verwendet werden. Auch die Symfony Expression Language l\u00e4sst sich beliebig erweitern.<\/p>\nDazu wird zun\u00e4chst der eigene Provider in einer aktiven Extension unter Configuration\/ExpressionLanguage.php<\/em> registriert.<\/p>\n<?php\r\n\r\nreturn [\r\n\u00a0\u00a0\u00a0\u00a0'typoscript' => [\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\\Vendor\\Extension\\ExpressionLanguage\\MyConditionProvider::class,\r\n\u00a0\u00a0\u00a0\u00a0]\r\n];<\/pre>\nDie Klasse muss das\u00a0\\TYPO3\\CMS\\Core\\ExpressionLanguage\\ProviderInterface<\/code> umsetzen. Dieses besteht aus den beiden Funktionen\u00a0getExpressionLanguageProviders()<\/code> und\u00a0getExpressionLanguageVariables()<\/code>.\u00a0F\u00fcr die Umsetzung kann von der Klasse \\TYPO3\\CMS\\Core\\ExpressionLanguage\\AbstractProvider<\/code> abgleitet werden.<\/p>\nAls Beispiel schauen wir uns den\u00a0TypoScriptConditionProvider aus dem Core an.<\/p>\n
class TypoScriptConditionProvider extends AbstractProvider\r\n{\r\n public function __construct()\r\n {\r\n $typo3 = new \\stdClass();\r\n $typo3->version = TYPO3_version;\r\n $typo3->branch = TYPO3_branch;\r\n $typo3->devIpMask = trim($GLOBALS['TYPO3_CONF_VARS']['SYS']['devIPmask']);\r\n $this->expressionLanguageVariables = [\r\n 'request' => GeneralUtility::makeInstance(RequestWrapper::class, $GLOBALS['TYPO3_REQUEST'] ?? null),\r\n 'applicationContext' => (string)GeneralUtility::getApplicationContext(),\r\n 'typo3' => $typo3,\r\n ];\r\n $this->expressionLanguageProviders = [\r\n Typo3ConditionFunctionsProvider::class\r\n ];\r\n }\r\n}<\/pre>\nSymfony und TYPO3<\/h2>\n
Die Symfony Expression Language ist eines von vielen Vorz\u00fcgen der neuen TYPO3 9 LTS<\/a>. Wir freuen uns sehr, dass TYPO3 Teile von Symfony \u00fcbernimmt, da wir dieses Framework auch Unabh\u00e4ngig von TYPO3 einsetzen. In unseren Individual-Programmierungen<\/a> setzen wir auf Symfony seit vielen Jahren und haben durchweg positive Erfahrungen gesammelt.<\/p>\n