cvs: phpdoc /en/reference/errorfunc/functions set-error-handler.xml

irchtml Sat Apr 10 13:51:08 2004 EDT Modified files: /phpdoc/en/reference/errorfunc/functions set-error-handler.xml Log: Bug #27941: signature of the error handler function is not documented http://cvs.php.net/diff.php/phpdoc/en/reference/errorfunc/functions/set-error-handler.xml?r1=1.19&r2=1.20&ty=u Index: phpdoc/en/reference/errorfunc/functions/set-error-handler.xml diff -u phpdoc/en/reference/errorfunc/functions/set-error-handler.xml:1.19 phpdoc/en/reference/errorfunc/functions/set-error-handler.xml:1.20 --- phpdoc/en/reference/errorfunc/functions/set-error-handler.xml:1.19 Sat Feb 7 14:02:34 2004 +++ phpdoc/en/reference/errorfunc/functions/set-error-handler.xml Sat Apr 10 13:51:08 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.19 $ --> +<!-- $Revision: 1.20 $ --> <!-- splitted from ./en/functions/errorfunc.xml, last change in rev 1.1 --> <refentry id="function.set-error-handler"> <refnamediv> @@ -31,7 +31,7 @@ linkend="ini.error-reporting">error_reporting</link> ini setting controls which errors are shown. Without this mask set the <parameter>error_handler</parameter> will be called for every error - unregardless to the setting of the <link + regardless to the setting of the <link linkend="ini.error-reporting">error_reporting</link> setting. </para> <para> @@ -40,7 +40,65 @@ parameters are supplied: the filename in which the error occurred, the line number in which the error occurred, and the context in which the error occurred (an array that points to the active symbol table at the - point the error occurred). + point the error occurred). The function can be shown as: + <methodsynopsis> + <methodname><replaceable>handler</replaceable></methodname> + <methodparam><type>int</type><parameter>errno</parameter></methodparam> + <methodparam><type>string</type><parameter>errstr</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>errfile</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>errline</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>errcontext</parameter></methodparam> + </methodsynopsis> + <variablelist> + <varlistentry> + <term><parameter>errno</parameter></term> + <listitem> + <simpara> + The first parameter, <replaceable>errno</replaceable>, contains the + level of the error raised, as an integer. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>errstr</parameter></term> + <listitem> + <simpara> + The second parameter, <parameter>errstr</parameter>, contains the + error message, as a string. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>errfile</parameter></term> + <listitem> + <simpara> + The third parameter is optional, <parameter>errfile</parameter>, + which contains the filename that the error was raised in, as a string. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>errline</parameter></term> + <listitem> + <simpara> + The fourth parameter is optional, <parameter>errline</parameter>, + which contains the line number the error was raised at, as an integer. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>errcontext</parameter></term> + <listitem> + <simpara> + The fifth parameter is optional, <parameter>errcontext</parameter>, + which is an array that points to the active symbol table at the point + the error occurred. In other words, <parameter>errcontext</parameter> + will contain an array of every variable that existed in the scope the + error was triggered in. + </simpara> + </listitem> + </varlistentry> + </variablelist> </para> <note> <simpara>