smarty/docs/en/programmers/api-functions/api-trigger-error.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry id="api.trigger.error">
 <refnamediv>
  <refname>trigger_error()</refname>
  <refpurpose>output an error message</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>void</type><methodname>trigger_error</methodname>
   <methodparam><type>string</type><parameter>error_msg</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam>
  </methodsynopsis>
  <para>
   This function can be used to output an error message using Smarty.
   <parameter>level</parameter> parameter can be one of the values
   used for the PHP
   <ulink url="&url.php-manual;trigger_error">trigger_error()</ulink>
   function, i.e. E_USER_NOTICE,
   E_USER_WARNING, etc. By default it's E_USER_WARNING.
  </para>
   <para>
    See also
    <link linkend="variable.error.reporting">$error_reporting</link>,
    <link linkend="chapter.debugging.console">debugging</link>
    and
    <link linkend="smarty.php.errors">Troubleshooting</link>.
 </para>
 </refsect1>
</refentry>
<!-- 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
-->