Files
smarty/docs/de/designers/language-builtin-functions/language-function-insert.xml
2005-12-09 19:50:41 +00:00

147 lines
5.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1.5 Maintainer: andreas Status: ready -->
<sect1 id="language.function.insert">
<title>insert (einfügen)</title>
<para>
{insert}-Tags funktionieren ähnlich den <link
linkend="language.function.include">{include}</link>-Tags, werden
aber nicht gecached, falls <link linkend="caching">caching</link>
eingeschaltet ist. Sie werden bei jedem Aufruf des Templates
ausgeführt.
</para>
<informaltable frame="all">
<tgroup cols="5">
<colspec colname="param" align="center" />
<colspec colname="type" align="center" />
<colspec colname="required" align="center" />
<colspec colname="default" align="center" />
<colspec colname="desc" />
<thead>
<row>
<entry>Attribut Name</entry>
<entry>Typ</entry>
<entry>Erforderlich</entry>
<entry>Standardwert</entry>
<entry>Beschreibung</entry>
</row>
</thead>
<tbody>
<row>
<entry>name</entry>
<entry>string</entry>
<entry>Ja</entry>
<entry><emphasis>n/a</emphasis></entry>
<entry>Der Name der Insert-Funktion</entry>
</row>
<row>
<entry>assign</entry>
<entry>string</entry>
<entry>Nein</entry>
<entry><emphasis>n/a</emphasis></entry>
<entry>Name der Template-Variable, in der die Ausgabe der 'insert'-Funktion optional abgelegt wird.</entry>
</row>
<row>
<entry>script</entry>
<entry>string</entry>
<entry>Nein</entry>
<entry><emphasis>n/a</emphasis></entry>
<entry>Name des PHP-Skriptes, das vor Aufruf der 'insert'-Funktion eingebunden werden soll.</entry>
</row>
<row>
<entry>[var ...]</entry>
<entry>[var typ]</entry>
<entry>Nein</entry>
<entry><emphasis>n/a</emphasis></entry>
<entry>Variablen die der 'insert'-Funktion übergeben werden sollen.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
Stellen Sie sich vor, sie hätten ein Template mit einem
Werbebanner. Dieser Banner kann verschiedene Arten von Inhalten
haben: Bilder, HTML, Flash, etc. Deshalb können wir nicht einfach
einen statischen Link verwenden und müssen vermeiden, dass dieser
Inhalt gecached wird. Hier kommt das {insert}-Tag ins Spiel. Das
Template kennt die Variablen '#banner_location_id#' und '#site_id#'
(zum Beispiel aus einer <link
linkend="config.files">Konfigurationsdatei</link>) und soll eine
Funktion aufrufen, die den Inhalt des Banners liefert.
</para>
<example>
<title>Funktion 'insert'</title>
<programlisting>
{* erzeugen des Banners *}
{insert name="getBanner" lid=#banner_location_id# sid=#site_id#}
</programlisting>
</example>
<para>
In diesem Beispiel verwenden wir die Funktion 'getBanner' und
übergeben die Parameter '#banner_location_id#' und '#site_id#'.
Smarty wird daraufhin in Ihrer Applikatiopn nach einer Funktion
namens 'getBanner' suchen und diese mit den Parametern
'#banner_location_id#' und '#site_id#' aufrufen. Allen
'insert'-Funktionen in Ihrer Applikation muss 'insert_'
vorangestellt werden, um Konflikte im Namensraum zu vermeiden. Ihre
'insert_getBanner()'-Funktion sollte etwas mit den übergebenen
Parametern unternehmen und das Resultat zurückgeben. Dieses
Resultat wird an der Stelle des 'insert'-Tags in Ihrem Template
ausgegeben. In diesem Beispiel würde Smarty folgende Funktion
aufrufen: insert_getBanner(array("lid" => "12345","sid" => "67890"))
und die erhaltenen Resultate an Stelle des 'insert'-Tags ausgeben.
</para>
<para>
Falls Sie das 'assign'-Attribut übergeben, wird die Ausgabe des
'insert'-Tags in dieser Variablen abgelegt. Bemerkung: dies ist
nicht sinnvoll, wenn <link linkend="variable.caching">Caching</link>
eingeschaltet ist.
</para>
<para>
Falls Sie das 'script'-Attribut übergeben, wird das angegebene
PHP-Skript vor der Ausführung der {insert}-Funktion eingebunden.
Dies ist nützlich, um die {insert}-Funktion erst in diesem Skript zu
definieren. Der Pfad kann absolut oder relativ zu <link
linkend="variable.trusted.dir">$trusted_dir</link> angegeben werden.
Wenn Sicherheit eingeschaltet ist, muss das Skript in <link
linkend="variable.trusted.dir">$trusted_dir</link> liegen.
</para>
<para>
Als zweites Argument wird der {insert}-Funktion das Smarty-Objekt
selbst übergeben. Damit kann dort auf die Informationen im
Smarty-Objekt zugegriffen werden.
</para>
<note>
<title>Technische Bemerkung</title>
<para>
Es gibt die Möglichkeit, Teile des Templates nicht zu cachen. Wenn
Sie <link linkend="caching">caching</link> eingeschaltet haben,
werden {insert}-Tags nicht gecached. Sie werden jedesmal
ausgeführt, wenn die Seite erstellt wird - selbst innerhalb
gecachter Seiten. Dies funktioniert gut für Dinge wie Werbung
(Banner), Abstimmungen, Wetterberichte, Such-Resultate,
Benutzer-Feedback-Ecke, etc.
</para>
</note>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->