Template-Operatoren schreiben #

Diese Seite richtet sich an Anwendungsentwickler, die Templates einen neuen Operator geben, etwa {$price|expdemo_money( 'EUR' )}. Ein Operator ist eine PHP-Klasse, die in autoloads/eztemplateautoload.php der Erweiterung registriert ist. Das RAD-Werkzeug Template-Erweiterung (/setup/templateoperator) schreibt Ihnen einen funktionierenden Operator (RAD-Werkzeuge).

Inhalt #

1. Registrierung
2. Die Operator-Klasse
3. Eingabe und Ausgabe
4. Regeln
5. Wann Sie keinen Operator schreiben sollten

Registrierung #

# extension/expdemo/settings/site.ini.append.php
<?php /* #?ini charset="utf-8"?
[TemplateSettings]
ExtensionAutoloadPath[]=expdemo
*/ ?>

<?php
// extension/expdemo/autoloads/eztemplateautoload.php
$eZTemplateOperatorArray = array();
$eZTemplateOperatorArray[] = array(
    'script' => 'extension/expdemo/autoloads/expdemotemplateoperators.php',
    'class' => 'expDemoTemplateOperators',
    'operator_names' => array( 'expdemo_money' ) );

Die mitgelieferte Erweiterung ezstarrating registriert ihre Operatoren auf dieselbe Weise (extension/ezstarrating/autoloads/eztemplateautoload.php).

Die Operator-Klasse #

<?php
class expDemoTemplateOperators
{
    function operatorList()
    {
        return array( 'expdemo_money' );
    }

    function namedParameterPerOperator()
    {
        return true;
    }

    function namedParameterList()
    {
        return array( 'expdemo_money' => array(
            'currency' => array( 'type' => 'string', 'required' => false, 'default' => 'EUR' ) ) );
    }

    function modify( $tpl, $operatorName, $operatorParameters, $rootNamespace, $currentNamespace, &$operatorValue, $namedParameters )
    {
        switch ( $operatorName )
        {
            case 'expdemo_money':
                $operatorValue = number_format( (float)$operatorValue, 2 ) . ' ' . $namedParameters['currency'];
                break;
        }
    }
}

Eingabe und Ausgabe #

• Der per Pipe übergebene Wert ($price|expdemo_money) kommt in $operatorValue an; setzen Sie ihn auf das Ergebnis.
• Benannte Parameter kommen in $namedParameters an, mit angewendeten Standardwerten.
• Ein Operator, der ohne Eingabe verwendet wird ({expdemo_money( 12 )}), erhält null als $operatorValue; deklarieren Sie den Wert als Parameter, wenn er so verwendet wird.

Regeln #

• Geben Sie Werte zurück, kein HTML: Lassen Sie das Template sie ausgeben und mit wash maskieren. Wenn Sie doch HTML zurückgeben müssen, maskieren Sie jeden Teil der Eingabe mit htmlspecialchars().
• Halten Sie Operatoren schnell und frei von Nebenwirkungen; sie laufen bei jedem Rendern und innerhalb von Cache-Blöcken.
• Stellen Sie neuen Operatornamen den Namen Ihrer Erweiterung voran (expdemo_...), damit sie nie kollidieren.
• Generieren Sie die Autoloads neu und leeren Sie die Template-Caches, nachdem Sie einen hinzugefügt haben.

Wann Sie keinen Operator schreiben sollten #

Verwandte Seiten #

• Template-Funktionen und Includes
• Muster für Template-Operatoren
• Templates und Design
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.