smarty/docs/en/designers/language-variables/language-variables-smarty.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
  <sect1 id="language.variables.smarty">
   <title>{$smarty} reserved variable</title>
   <para>
    The reserved {$smarty} variable can be used to access several
    special template variables. The full list of them follows.
   </para>

   <sect2 id="language.variables.smarty.request">
    <title>Request variables</title>
     <para>
      The request variables such as get, post, cookies, server,
      environment, and session variables can be accessed as demonstrated
      in the examples below:
     </para>
     <example>
      <title>displaying request variables</title>
      <programlisting>
<![CDATA[
{* display value of page from URL (GET) http://www.example.com/index.php?page=foo *}
{$smarty.get.page}

{* display the variable "page" from a form (POST) *}
{$smarty.post.page}

{* display the value of the cookie "username" *}
{$smarty.cookies.username}

{* display the server variable "SERVER_NAME" *}
{$smarty.server.SERVER_NAME}

{* display the system environment variable "PATH" *}
{$smarty.env.PATH}

{* display the php session variable "id" *}
{$smarty.session.id}

{* display the variable "username" from merged get/post/cookies/server/env *}
{$smarty.request.username}
]]>
      </programlisting>
     </example>
     <note>
      <para>
	      For historical reasons {$SCRIPT_NAME} can be accessed
	      directly though {$smarty.server.SCRIPT_NAME} is the
	      proposed way to access this value.
      </para>
     </note>
		  </sect2>

  <sect2 id="language.variables.smarty.now">
			<title>{$smarty.now}</title>
			<para>
			 The current timestamp can be accessed with {$smarty.now}. The
			 number reflects the number of seconds passed since the so-called
			 Epoch (January 1, 1970) and can be passed directly to
			 date_format modifier for display purposes.
			</para>
   <example>
    <title>using {$smarty.now}</title>
    <programlisting>
<![CDATA[
{* use the date_format modifier to show current date and time *}
{$smarty.now|date_format:"%Y-%m-%d %H:%M:%S"}
]]>
    </programlisting>
   </example>
		</sect2>
  <sect2 id="language.variables.smarty.const">
			<title>{$smarty.const}</title>
			<para>
		 	You can access PHP constant values directly.
			</para>
   <example>
    <title>using {$smarty.const}</title>
    <programlisting>
<![CDATA[
{$smarty.const._MY_CONST_VAL}
]]>
    </programlisting>
   </example>
		</sect2>

		<sect2 id="language.variables.smarty.capture">
			<title>{$smarty.capture}</title>
			<para>
		 	The output captured via {capture}..{/capture} construct can be
		 	accessed using {$smarty} variable. See section on
		 	<link linkend="language.function.capture">capture</link> for an example.
			</para>
		</sect2>

		<sect2 id="language.variables.smarty.config">
			<title>{$smarty.config}</title>
			<para>
			 {$smarty} variable can be used to refer to loaded config variables.
			 {$smarty.config.foo} is a synonym for {#foo#}. See the section on
			 <link linkend="language.function.config.load">config_load</link> for an example.
			</para>
		</sect2>

  <sect2 id="language.variables.smarty.loops">
			<title>{$smarty.section}, {$smarty.foreach}</title>
			<para>
		 	{$smarty} variable can be used to refer to 'section' and
		 	'foreach' loop properties. See docs for
		 	<link linkend="language.function.section">section</link> and
			 <link linkend="language.function.foreach">foreach</link>.
			</para>
		</sect2>

		<sect2 id="language.variables.smarty.template">
			<title>{$smarty.template}</title>
			<para>
    This variable contains the name of the current template being
    processed.
			</para>
		</sect2>
		<sect2 id="language.variables.smarty.version">
			<title>{$smarty.version}</title>
			<para>
    This variable contains the version of Smarty the template was compiled with.
			</para>
		</sect2>
		<sect2 id="language.variables.smarty.ldelim">
			<title>{$smarty.ldelim}</title>
			<para>
    This variable is used for printing the left-delimiter value literally.
    See also <link linkend="language.function.ldelim">{ldelim},{rdelim}</link>.
			</para>
		</sect2>
		<sect2 id="language.variables.smarty.rdelim">
			<title>{$smarty.rdelim}</title>
			<para>
    This variable is used for printing the right-delimiter value literally.
    See also <link linkend="language.function.ldelim">{ldelim},{rdelim}</link>.
			</para>
		</sect2>

</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
-->