Files
smarty/docs/en/designers/language-modifiers/language-modifier-default.xml
2006-09-26 19:28:45 +00:00

111 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="language.modifier.default">
<title>default</title>
<para>
This is used to set a default value for a variable. If the variable
is unset or an empty string, the given default value is printed instead.
Default takes the one argument.
</para>
<para>
<note>
<para>
With <ulink url="&url.php-manual;error_reporting">
<varname>error_reporting(E_ALL)</varname></ulink>,
undeclared variables will always throw an error within the template.
This function is useful for replacing null or zero length strings.
</para>
</note>
</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>Parameter Position</entry>
<entry>Type</entry>
<entry>Required</entry>
<entry>Default</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>string</entry>
<entry>No</entry>
<entry><emphasis>empty</emphasis></entry>
<entry>This is the default value to output if the
variable is empty.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<example>
<title>default</title>
<programlisting role="php">
<![CDATA[
<?php
$smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.');
$smarty->assign('email', '');
?>
]]>
</programlisting>
<para>
Where template is:
</para>
<programlisting>
<![CDATA[
{$articleTitle|default:'no title'}
{$myTitle|default:'no title'}
{$email|default:'No email address available'}
]]>
</programlisting>
<para>
Will output:
</para>
<screen>
<![CDATA[
Dealers Will Hear Car Talk at Noon.
no title
No email address available
]]>
</screen>
</example>
<para>
See also the
<link linkend="tips.default.var.handling">default variable handling</link>
and the
<link linkend="tips.blank.var.handling">blank variable handling</link> pages.
</para>
</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
-->