mirror of
https://github.com/smarty-php/smarty.git
synced 2025-10-16 05:55:20 +02:00
73 lines
2.2 KiB
XML
73 lines
2.2 KiB
XML
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
||
|
|
<!-- $Revision$ -->
|
||
|
|
<sect1 id="plugins.inserts"><title>Inserts</title>
|
||
|
|
<para>
|
||
|
|
Insert plugins are used to implement functions that are invoked by
|
||
|
|
<link linkend="language.function.insert"><command>insert</command></link>
|
||
|
|
tags in the template.
|
||
|
|
</para>
|
||
|
|
<funcsynopsis>
|
||
|
|
<funcprototype>
|
||
|
|
<funcdef>string <function>smarty_insert_<replaceable>name</replaceable></function></funcdef>
|
||
|
|
<paramdef>array <parameter>$params</parameter></paramdef>
|
||
|
|
<paramdef>object <parameter>&$smarty</parameter></paramdef>
|
||
|
|
</funcprototype>
|
||
|
|
</funcsynopsis>
|
||
|
|
<para>
|
||
|
|
The first parameter to the function is an associative array of
|
||
|
|
attributes passed to the insert. Either access those values directly,
|
||
|
|
e.g. <varname>$params['start']</varname> or use
|
||
|
|
<varname>extract($params)</varname> to import them into the symbol
|
||
|
|
table.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
The insert function is supposed to return the result which will be
|
||
|
|
substituted in place of the <command>insert</command> tag in the
|
||
|
|
template.
|
||
|
|
</para>
|
||
|
|
<example>
|
||
|
|
<title>insert plugin</title>
|
||
|
|
<programlisting>
|
||
|
|
<?php
|
||
|
|
/*
|
||
|
|
* Smarty plugin
|
||
|
|
* -------------------------------------------------------------
|
||
|
|
* File: insert.time.php
|
||
|
|
* Type: time
|
||
|
|
* Name: time
|
||
|
|
* Purpose: Inserts current date/time according to format
|
||
|
|
* -------------------------------------------------------------
|
||
|
|
*/
|
||
|
|
function smarty_insert_time($params, &$smarty)
|
||
|
|
{
|
||
|
|
if (empty($params['format'])) {
|
||
|
|
$smarty->trigger_error("insert time: missing 'format' parameter");
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
$datetime = strftime($params['format']);
|
||
|
|
return $datetime;
|
||
|
|
}
|
||
|
|
?></programlisting>
|
||
|
|
</example>
|
||
|
|
</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
|
||
|
|
-->
|