Smarty-Templates: Operator-Referenz #

Diese Seite ist für Template-Entwickler, die .stpl-Templates schreiben und die genaue Form eines Operators brauchen. Sie listet jeden Template-Operator, den eine Standardinstallation registriert, nach Bereichen gruppiert, mit seiner .stpl-Form, ob er das Präfix exp_ braucht, wie er seine Eingabe nimmt, und einem Beispiel. Die Regeln hinter den Spalten erklärt Smarty-Templates: Operatoren und Fetch-Funktionen; lesen Sie das zuerst, wenn Ihnen die Wörter „input“ und „param“ unten neu sind.

Die Liste wurde aus dem Code entnommen: aus den Operator-Registrierungen von lib/eztemplate/classes/eztemplateautoload.php, kernel/common/eztemplateautoload.php, kernel/private/eztemplate/eztemplateautoload.php, lib/ezpdf/classes/eztemplateautoload.php, aus [PHP] PHPOperatorList[] von settings/template.ini und aus den autoloads/eztemplateautoload.php der Extensions, die mit der Installation ausgeliefert werden. Der Eingabemodus jedes Operators ist das, was expSmartyRenderer::operatorInputMode() aus den Template-Hinweisen des Operators entscheidet, und für die Operatoren ohne Hinweise das, was expSmartyRenderer::PARAMETER_OPERATORS und [SmartySettings] ParameterOperatorList[] von smarty.ini sagen.

Wie die Tabellen zu lesen sind #

Name in .stpl. Der Name, den Sie nach dem Pipe-Zeichen oder vor die Klammern schreiben. exp_<name>, wo Smarty 5 einen Modifikator gleichen Namens hat (Smartys eigene Modifikatoren gewinnen immer; exp_ führt an ihnen vorbei). Ein Operator, dessen eigener Name mit exp_ beginnt (exp_path, exp_environment), wird mit diesem Namen aufgerufen.

Modus.

• input: Der Operator arbeitet mit seiner Eingabe. $x|op:a:b übergibt $x als Eingabe und a, b als Parameter; op($x, a, b) ist derselbe Aufruf. Ohne Eingabe aufgerufen (ein .tpl-op(a, b) ohne Pipe-Zeichen), schreiben Sie op(null, a, b). Jeder Operator ohne Template-Hinweise ist von dieser Art, darunter fast jeder Operator der Extensions, ausgenommen die Operatoren des Kernels, die nur ihre Parameter lesen (unten), und die, die eine Extension in [SmartySettings] ParameterOperatorList[] von smarty.ini aufführt.
• param: Der Operator liest nur seine Parameter. Der per Pipe übergebene Wert wird zum ersten Parameter, also sind $a|op:b und op($a, b) derselbe Aufruf, in welcher Reihenfolge Sie ihn auch schreiben möchten. Die Funktionsform des .tpl ist die .stpl-Form: {ezhttp('SearchText', 'get')}, {if has_role('Editor')}. Bei den Operatoren des Kernels ohne Template-Hinweise, die von dieser Art sind (ezhttp, has_role, topmenu ...), wird ein null davor, wie in ezhttp(null, 'SearchText', 'get'), die Form, die konvertierte Templates früher hatten, weggelassen, sodass beide Formen funktionieren.

Beispiel. Eine .stpl-Zeile. Wo die eigenen Tests der Template-Engine (eZTemplateOperatorMatrixTest, gegen .stpl geprüft von tests/tests/lib/smarty/expSmartyOperatorParityTest.php) den Fall enthalten, steht die Ausgabe nach →.

Zuerst die Literale, da mehrere Operatoren des .tpl in Smarty Literale sind:

Arrays und Listen (eZTemplateArrayOperator) #

Logik und Vergleich (eZTemplateLogicOperator, eZTemplateControlOperator) #

cond und first_set lesen nur ihre Parameter. Per Pipe aufgerufen, wird der übergebene Wert zum ersten Parameter: $a|first_set:'d' ist „der erste von $a, 'd', der gesetzt ist“, und $a|cond:'x':'y' verwendet $a als Bedingung. Ein .tpl-$a|first_set('d') ignoriert $a und ist immer 'd'; der Konverter schreibt es als first_set('d'), um das beizubehalten. Smartys eigene ==, !=, &&, ||, ! und ?: funktionieren auch, aber eq vergleicht so wie das .tpl ({if eq(1, '1')} ist wahr; mehrere Parameter müssen alle gleich sein).

Typen (eZTemplateTypeOperator) #

Alle lesen ihre Parameter: is_set($x) und $x|is_set sind dasselbe.

Arithmetik (eZTemplateArithmeticOperator) #

Smartys +, -, *, / und % eignen sich für Zahlen ebenfalls.

Zeichenketten (eZTemplateStringOperator, eZTemplateTextOperator, eZTemplateNl2BrOperator) #

indent und nl2br geben als Hinweis an, dass ihre Eingabe ein Parameter ist, lesen sie aber zur Laufzeit als ihre Eingabe; die Brücke führt sie in expSmartyRenderer::INPUT_AT_RUN_TIME auf.

PHP-Zeichenkettenfunktionen (eZTemplateStringsOperator) #

Einundsechzig PHP-Zeichenkettenfunktionen sind Operatoren (PHP-Zeichenkettenfunktionen als Template-Operatoren). Alle sind input-Operatoren: Der per Pipe übergebene Wert ist das Subjekt der PHP-Funktion.

{$text|exp_substr:0:5}
{if $text|str_contains:'Expo'}...{/if}
{'%s has %d items'|sprintf:$name:$count}
{1234567.891|exp_number_format:2:'.':','}
{$node.data_map.success_text.data_text|exp_strip_tags}
{(first_set($form.parent.parent.vars, $form.parent.vars))|expattr:'name'|ristring:'_':'-'}

Smartys eigene substr, strlen, strip_tags und number_format sind die PHP-Funktionen mit derselben Reihenfolge der Parameter, also drucken die Namen ohne Präfix meist dasselbe; die Namen mit Präfix sind das, was der Konverter schreibt, und das, was garantiert so arbeitet wie im .tpl.

Prüfsummen und Einheiten (eZTemplateDigestOperator, eZTemplateUnitOperator) #

Datum und Locale (eZTemplateLocaleOperator) #

Abrufen und Attribute (eZTemplateExecuteOperator, eZTemplateAttributeOperator) #

Mehr zu fetch(): Fetch-Funktionen.

Bilder (eZTemplateImageOperator) #

Eine Extension, die einen Operator gleichen Namens registriert, ersetzt den des Kernels: In einem Siteaccess mit sevenx_themes_media ist image der Operator des Themes (ein input-Operator, geschrieben image(null, ...)).

Rollen und Richtlinien (eZTemplateRoleOperator) #

Sie lesen nur ihre Parameter (der aktuelle Benutzer ist die Voreinstellung): Schreiben Sie sie wie im .tpl. Ein per Pipe übergebener Wert wird zum ersten Parameter, also fragt $current_user|has_role:'Editor' nach einer Rolle, die nach dem Benutzer benannt ist; schreiben Sie has_role('Editor'). Einzelheiten: Rollen- und Richtlinienprüfungen in Templates.

Extensions, Installation und Umgebung (lib und kernel) #

URLs, Einstellungen und die Anfrage (eZURLOperator, eZi18nOperator) #

ezhttp und ezhttp_hasvariable nehmen den Namen und den Typ (post, get, session, cookie) als ihre Parameter. Sie haben keine Template-Hinweise; die Brücke kennt sie als Operatoren, die nur ihre Parameter lesen (expSmartyRenderer::PARAMETER_OPERATORS), also funktioniert die Funktionsform des .tpl: {ezhttp('SearchText', 'get')}. 'SearchText'|ezhttp:'get' ist derselbe Aufruf, und ezhttp(null, 'SearchText', 'get'), das konvertierte Templates früher schrieben, funktioniert weiterhin. Escapen Sie, was er zurückgibt: {ezhttp('SearchText', 'get')|wash}.

ezurl, ezroot, ezdesign und ezimage drucken die Adresse standardmäßig in doppelten Anführungszeichen (href={...|ezurl}); :'no' lässt die Anführungszeichen weg, :'single' verwendet einfache. Ist ezurlmultisite aktiv, übernehmen dessen eigene Operatoren diese zehn Namen mit denselben Formen.

Inhalte, Menüs und Text (kernel/common) #

Keiner davon hat Template-Hinweise. Die input-Operatoren arbeiten mit dem per Pipe übergebenen Wert; als Funktion ohne Eingabe schreiben Sie zuerst null, mit den Parametern des .tpl. Die param-Operatoren lesen nur ihre Parameter (expSmartyRenderer::PARAMETER_OPERATORS): Schreiben Sie sie wie im .tpl.

siteaccess_url, siteaccess_menu und siteaccess_menu_key geben an, dass sie keine Eingabe nehmen ('input' => false), also sind sie param-Operatoren: siteaccess_url(a, b) und a|siteaccess_url:b sind dasselbe.

PHP-Funktionen aus template.ini #

[PHP] PHPOperatorList[] von settings/template.ini macht PHP-Funktionen zu Operatoren: urlencode, urldecode, rawurlencode und rawurldecode in einer Standardinstallation. Sie sind param-Operatoren mit einem Parameter:

<a href="/search?q={$text|rawurlencode}">...</a>

Operatoren der ausgelieferten Extensions #

Operatoren, die die autoloads/eztemplateautoload.php einer Extension registriert, gibt es nur in einem Siteaccess, in dem die Extension aktiv ist. Von den Extensions, die mit der Installation ausgeliefert werden, gibt nur ezurlmultisite seinen Operatoren Template-Hinweise (dieselben wie die URL-Operatoren des Kernels); jeder andere Extension-Operator ist ein input-Operator: $x|op:a übergibt $x als seine Eingabe, und ein .tpl-Aufruf ohne Pipe-Zeichen wird in einem .stpl als op(null, ...) geschrieben. Einen Operator ohne Hinweise, der nur seine Parameter liest, macht eine Extension mit [SmartySettings] ParameterOperatorList[] in ihrer smarty.ini.append.php zu einem param-Operator (siehe Operatoren und Funktionen schreiben).

Echte Zeilen aus der Media-Portierung, alles input-Operatoren, ohne Eingabe aufgerufen:

<h3 class="title"><a href="{exp_path(null, $location)}">{ng_render_field(null, $content.fields.title)}</a></h3>
<article {item_params(null, $toolbar_macros, $content, $location)} class="view-type view-type-{$view_type}">
{$__loop1 = fieldRelations(null, $content, 'authors')}

Ein Operatorname, der mit exp_ beginnt und registriert ist (exp_path, exp_url, exp_config, exp_can_login_to_siteaccess, exp_environment ...), ist dieser Operator. Nur bei einem Namen, der nicht registriert ist, wird das Präfix entfernt: exp_count ist count, exp_implode ist implode. Daher kann exp_path nie für einen Operator namens path stehen; für diesen schreiben Sie path.

Helfer der Brücke (keine Operatoren) #

expattr, expvar, expvoid, expslice, expsectionloop, exprange, expsequence, expcolumn sind Modifikatoren der Brücke selbst; siehe Die Helfer der Brücke.

Die Operatoren Ihrer Installation finden #

Die Tabellen decken ab, was mit der Installation ausgeliefert wird. Ihre eigenen Extensions fügen Operatoren auf dieselbe Weise hinzu: Suchen Sie nach operator_names in extension/*/autoloads/eztemplateautoload.php der im Siteaccess aktiven Extensions. Um den Modus eines Operators herauszufinden, suchen Sie in seiner Klasse nach operatorTemplateHints(): keine, oder 'input-as-parameter' => 'always', bedeutet input; 'input-as-parameter' => true oder 'input' => false bedeutet param. Einen Operator schreiben, der in beiden Engines funktioniert: Operatoren und Funktionen für .stpl schreiben.

Verwandte Seiten #

• Smarty-Templates: Operatoren und Fetch-Funktionen: die Regeln hinter dieser Seite
• Template-Funktionen und Blöcke
• Problembehebung und FAQ