cvs: peardoc /en/core/pear/pear-errorstack setdefaultcallback.xml setdefaultlogger.xml seterrormessagetemplate.xml setlogger.xml
setmessagecallback.xml singleton.xml staticgeterrors.xml statichaserrors.xml staticpopcallback.xml staticpush.xml staticpushcallback.xml
| From: | Christophe Gesch� | Date: | Mon, 18 Jul 2005 14:15:19 +0000 |
| Subject: | cvs: peardoc /en/core/pear/pear-errorstack setdefaultcallback.xml setdefaultlogger.xml seterrormessagetemplate.xml setlogger.xml setmessagecallback.xml singleton.xml staticgeterrors.xml statichaserrors.xml staticpopcallback.xml staticpush.xml staticpushcallback.xml |
||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-6518@lists.php.net to get a copy of this message | ||
moosh Mon Jul 18 10:15:19 2005 EDT
Modified files:
/peardoc/en/core/pear/pear-errorstack setdefaultcallback.xml
setdefaultlogger.xml
seterrormessagetemplate.xml
setlogger.xml
setmessagecallback.xml
singleton.xml
staticgeterrors.xml
statichaserrors.xml
staticpopcallback.xml
staticpush.xml
staticpushcallback.xml
Log:
- use entities
- indent
http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml diff -u peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml:1.2 peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml:1.2 Mon Jul 18 03:15:59 2005 +++ peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml Mon Jul 18 10:15:18 2005 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.setdefaultcallback"> <refnamediv> <refname> @@ -40,7 +40,7 @@ <variablelist> <varlistentry> <term> - <type>array|string</type> + <type>&type.array;|&type.string;</type> <parameter>$callback</parameter> </term> <listitem> http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/setdefaultlogger.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/setdefaultlogger.xml diff -u peardoc/en/core/pear/pear-errorstack/setdefaultlogger.xml:1.2 peardoc/en/core/pear/pear-errorstack/setdefaultlogger.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/setdefaultlogger.xml:1.2 Sat Mar 20 02:43:04 2004 +++ peardoc/en/core/pear/pear-errorstack/setdefaultlogger.xml Mon Jul 18 10:15:18 2005 @@ -1,54 +1,65 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.setdefaultlogger"> - <refnamediv> - <refname><function>PEAR_ErrorStack::setDefaultLogger</function></refname> - <refpurpose>Set up a PEAR::Log object for all error stacks that don't have one</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>void <function>PEAR_ErrorStack::setDefaultLogger</function></funcdef> - <paramdef>Log <parameter>&$log</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::setDefaultLogger</function> + </refname> + <refpurpose> + Set up a PEAR::Log object for all + error stacks that don't have one + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.void; + <function>PEAR_ErrorStack::setDefaultLogger</function> + </funcdef> + <paramdef> + Log <parameter>&$log</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.desc"> - &title.desc; - <para>Set up a PEAR::Log object for all error stacks that don't have one</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - <type>Log</type> - <parameter>&$log</parameter> - </term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.desc"> + &title.desc; + <para> + Set up a PEAR::Log object for all + error stacks that don't have one + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + <type>Log</type> + <parameter>&$log</parameter> + </term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.throws"> + &title.throws; + &noexceptions; + </refsect1> - <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/seterrormessagetemplate.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/core/pear/pear-errorstack/seterrormessagetemplate.xml diff -u peardoc/en/core/pear/pear-errorstack/seterrormessagetemplate.xml:1.1 peardoc/en/core/pear/pear-errorstack/seterrormessagetemplate.xml:1.2 --- peardoc/en/core/pear/pear-errorstack/seterrormessagetemplate.xml:1.1 Sat Mar 20 01:16:32 2004 +++ peardoc/en/core/pear/pear-errorstack/seterrormessagetemplate.xml Mon Jul 18 10:15:18 2005 @@ -1,59 +1,76 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="core.pear.pear-errorstack.seterrormessagetemplate"> - <refnamediv> - <refname><function>PEAR_ErrorStack::setErrorMessageTemplate</function></refname> - <refpurpose>Set the Error Message Template array</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>string <function>PEAR_ErrorStack::setErrorMessageTemplate</function></funcdef> - <paramdef>mixed <parameter>$template</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::setErrorMessageTemplate</function> + </refname> + <refpurpose>Set the Error Message Template array</refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.string; + <function>PEAR_ErrorStack::setErrorMessageTemplate</function> + </funcdef> + <paramdef> + &type.mixed; + <parameter>$template</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.desc"> - &title.desc; - <para>The array format must be: <![CDATA[ array(error code => 'message template',...)]]></para> - <para> - Error message parameters passed into <link linkend="core.pear.pear-errorstack.push"><function>push</function></link> - will be used as input for the error message. If the template is 'message %foo% was %bar%', and the - parameters are array('foo' => 'one', 'bar' => 'six'), the error - message returned will be 'message one was six' - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.mixed; - <parameter>$template</parameter> - </term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.note"> - &title.note; - ¬e.notstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.desc"> + &title.desc; + <para> + The array format must be: + <![CDATA[ array(error code => 'message template',...)]]> + </para> + <para> + Error message parameters passed into + <link linkend="core.pear.pear-errorstack.push"> + <function>push</function> + </link> + will be used as input for the error message. + + If the template is 'message %foo% was %bar%', + and the parameters are + array('foo' => 'one', + 'bar' => 'six'), + the error message returned will be + 'message one was six' + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.mixed; + <parameter>$template</parameter> + </term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.note"> + &title.note; + ¬e.notstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/setlogger.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/setlogger.xml diff -u peardoc/en/core/pear/pear-errorstack/setlogger.xml:1.2 peardoc/en/core/pear/pear-errorstack/setlogger.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/setlogger.xml:1.2 Sat Mar 20 02:43:04 2004 +++ peardoc/en/core/pear/pear-errorstack/setlogger.xml Mon Jul 18 10:15:18 2005 @@ -1,53 +1,64 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.setlogger"> - <refnamediv> - <refname><function>PEAR_ErrorStack::setLogger</function></refname> - <refpurpose>Set up a PEAR::Log object for this error stack</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>void <function>PEAR_ErrorStack::setLogger</function></funcdef> - <paramdef>Log <parameter>&$log</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::setLogger</function> + </refname> + <refpurpose> + Set up a PEAR::Log object for this error stack + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.void; + <function>PEAR_ErrorStack::setLogger</function> + </funcdef> + <paramdef> + Log + <parameter>&$log</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.setlogger.desc"> - &title.desc; - <para>Set a PEAR::Log object to use for a specific error stack instance</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setlogger.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - <type>Log</type> - <parameter>&$log</parameter> - </term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setlogger.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setlogger.note"> - &title.note; - ¬e.notstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.setlogger.desc"> + &title.desc; + <para> + Set a PEAR::Log object to use + for a specific error stack instance + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setlogger.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + <type>Log</type> + <parameter>&$log</parameter> + </term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setlogger.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setlogger.note"> + &title.note; + ¬e.notstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/setmessagecallback.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/core/pear/pear-errorstack/setmessagecallback.xml diff -u peardoc/en/core/pear/pear-errorstack/setmessagecallback.xml:1.1 peardoc/en/core/pear/pear-errorstack/setmessagecallback.xml:1.2 --- peardoc/en/core/pear/pear-errorstack/setmessagecallback.xml:1.1 Sat Mar 20 01:16:32 2004 +++ peardoc/en/core/pear/pear-errorstack/setmessagecallback.xml Mon Jul 18 10:15:18 2005 @@ -1,54 +1,64 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="core.pear.pear-errorstack.setmessagecallback"> - <refnamediv> - <refname><function>PEAR_ErrorStack::setMessageCallback</function></refname> - <refpurpose>Set an error code => error message mapping callback</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>void <function>PEAR_ErrorStack::setMessageCallback</function></funcdef> - <paramdef>mixed <parameter>$msgCallback</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - - <refsect1 id="core.pear.pear-errorstack.setmessagecallback.desc"> - &title.desc; - <para>This method sets the callback that can be used to generate error messages for any PEAR_ErrorStack instance</para> - - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setmessagecallback.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.mixed; - <parameter>$msgCallback</parameter> - </term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setmessagecallback.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setmessagecallback.note"> - &title.note; - ¬e.notstatic; - </refsect1> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::setMessageCallback</function> + </refname> + <refpurpose> + Set an error code => error message mapping callback + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.void; + <function>PEAR_ErrorStack::setMessageCallback</function> + </funcdef> + <paramdef> + &type.mixed; + <parameter>$msgCallback</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="core.pear.pear-errorstack.setmessagecallback.desc"> + &title.desc; + <para> + This method sets the callback that + can be used to generate error + messages for any PEAR_ErrorStack instance + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setmessagecallback.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.mixed; + <parameter>$msgCallback</parameter> + </term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setmessagecallback.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setmessagecallback.note"> + &title.note; + ¬e.notstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/singleton.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/en/core/pear/pear-errorstack/singleton.xml diff -u peardoc/en/core/pear/pear-errorstack/singleton.xml:1.3 peardoc/en/core/pear/pear-errorstack/singleton.xml:1.4 --- peardoc/en/core/pear/pear-errorstack/singleton.xml:1.3 Sat Oct 23 17:13:23 2004 +++ peardoc/en/core/pear/pear-errorstack/singleton.xml Mon Jul 18 10:15:18 2005 @@ -1,120 +1,158 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="core.pear.pear-errorstack.singleton"> - <refnamediv> - <refname><function>PEAR_ErrorStack::singleton</function></refname> - <refpurpose>Return a single error stack for this package.</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef><replaceable><link linkend="core.pear.pear-errorstack"><classname>PEAR_ErrorStack</classname></link></replaceable>& <function>PEAR_ErrorStack::singleton</function></funcdef> - <paramdef>string <parameter>$package</parameter></paramdef> - <paramdef>callback <parameter> <optional>$msgCallback = &false;</optional></parameter></paramdef> - <paramdef>callback <parameter> <optional>$contextCallback = &false;</optional></parameter></paramdef> - <paramdef>boolean <parameter> <optional>$throwPEAR_Error = &false;</optional></parameter></paramdef> - <paramdef>string <parameter> <optional>$stackClass = 'PEAR_ErrorStack'</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname><function>PEAR_ErrorStack::singleton</function></refname> + <refpurpose>Return a single error stack for this package.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + <replaceable> + <link linkend="core.pear.pear-errorstack"> + <classname>PEAR_ErrorStack</classname> + </link> + </replaceable>& + <function>PEAR_ErrorStack::singleton</function> + </funcdef> + <paramdef> + &type.string; + <parameter>$package</parameter> + </paramdef> + <paramdef> + &type.callback; + <parameter> <optional>$msgCallback = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.callback; + <parameter> <optional>$contextCallback = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.boolean; + <parameter> <optional>$throwPEAR_Error = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.string; + <parameter> + <optional>$stackClass = 'PEAR_ErrorStack'</optional> + </parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.singleton.bcwarning"> - <title>Backwards Compatibility Warning</title> - <warning> + <refsect1 id="core.pear.pear-errorstack.singleton.bcwarning"> + <title>Backwards Compatibility Warning</title> + <warning> + <para> + As of PEAR 1.3.2, + PEAR_ErrorStack no longer instantiates + and returns an Exception object in PHP5, + and the second-to-last parameter has been removed. + + Code that relies upon this behavior will break. + </para> + </warning> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.singleton.desc"> + &title.desc; + <para> + Note that all parameters are ignored if the + stack for package $package has already been instantiated + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.singleton.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$package</parameter> + </term> + <listitem> <para> - As of PEAR 1.3.2, PEAR_ErrorStack no longer instantiates and returns an Exception object in PHP5, and - the second-to-last parameter has been removed. Code that relies upon this behavior will break. + name of the package this error stack represents </para> - </warning> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.singleton.desc"> - &title.desc; - <para>Note that all parameters are ignored if the stack for package $package has already been instantiated</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.singleton.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$package</parameter> - </term> - <listitem> - <para> - name of the package this error stack represents - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - <type>callback</type> - <parameter>$msgCallback</parameter> - </term> - <listitem> - <para> - callback used for error message generation - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - <type>callback</type> - <parameter>$contextCallback</parameter> - </term> - <listitem> - <para> - callback used for context generation, defaults to <link linkend="core.pear.pear-errorstack.getfileline"><function>getFileLine</function></link> - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.bool; - <parameter>$throwPEAR_Error</parameter> - </term> - <listitem> - <para> - If &true;, then <link linkend="core.pear.pear.raiseerror"><function>PEAR::raiseError</function></link> will be called and a <link linkend="core.pear.pear-error"><classname>PEAR_Error</classname></link> object will be returned - from calls to <link linkend="core.pear.pear-errorstack.push"><function>PEAR_ErrorStack::push</function></link> - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$stackClass</parameter> - </term> - <listitem> - <para> - class to instantiate - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.singleton.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + <type>callback</type> + <parameter>$msgCallback</parameter> + </term> + <listitem> + <para> + callback used for error message generation + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + <type>callback</type> + <parameter>$contextCallback</parameter> + </term> + <listitem> + <para> + callback used for context generation, defaults to <link linkend="core.pear.pear-errorstack.getfileline"><function>getFileLine</function></link> + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.bool; + <parameter>$throwPEAR_Error</parameter> + </term> + <listitem> + <para> + If &true;, then + <link linkend="core.pear.pear.raiseerror"> + <function>PEAR::raiseError</function> + </link> will be called and a + <link linkend="core.pear.pear-error"> + <classname>PEAR_Error</classname> + </link> + object will be returned from calls to + <link linkend="core.pear.pear-errorstack.push"> + <function>PEAR_ErrorStack::push</function> + </link> + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$stackClass</parameter> + </term> + <listitem> + <para> + class to instantiate + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.singleton.throws"> + &title.throws; + &noexceptions; + </refsect1> - <refsect1 id="core.pear.pear-errorstack.singleton.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.singleton.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/staticgeterrors.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/en/core/pear/pear-errorstack/staticgeterrors.xml diff -u peardoc/en/core/pear/pear-errorstack/staticgeterrors.xml:1.3 peardoc/en/core/pear/pear-errorstack/staticgeterrors.xml:1.4 --- peardoc/en/core/pear/pear-errorstack/staticgeterrors.xml:1.3 Sat Oct 23 17:13:23 2004 +++ peardoc/en/core/pear/pear-errorstack/staticgeterrors.xml Mon Jul 18 10:15:18 2005 @@ -1,48 +1,77 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="core.pear.pear-errorstack.staticgeterrors"> - <refnamediv> - <refname><function>PEAR_ErrorStack::staticGetErrors</function></refname> - <refpurpose>Get a list of all errors since last purge, organized by package</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>array <function>PEAR_ErrorStack::staticGetErrors</function></funcdef> - <paramdef>boolean <parameter> <optional>$purge = &false;</optional></parameter></paramdef> - <paramdef>string|false <parameter> <optional>$level = &false;</optional></parameter></paramdef> - <paramdef>boolean <parameter> <optional>$merge = &false;</optional></parameter></paramdef> - <paramdef>array <parameter> <optional>$sortfunc = array('PEAR_ErrorStack', '_sortErrors')</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname><function>PEAR_ErrorStack::staticGetErrors</function></refname> + <refpurpose> + Get a list of all errors since last purge, + organized by package + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef>&type.array; + <function>PEAR_ErrorStack::staticGetErrors</function> + </funcdef> + <paramdef> + &type.boolean; + <parameter> <optional>$purge = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.string;|&false; + <parameter> <optional>$level = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.boolean; + <parameter> <optional>$merge = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.array; + <parameter> + <optional> + $sortfunc = array('PEAR_ErrorStack', '_sortErrors') + </optional> + </parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.staticgeterrors.bcwarning"> - <title>Backwards Compatibility Warning</title> - <warning> - <para> - As of PEAR 1.3.2, the second parameter is a new parameter <varname>$level</varname>. Any code that - relies on $merge being the second parameter will break. - </para> - </warning> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticgeterrors.desc"> - &title.desc; - <para>Static version of <link linkend="core.pear.pear-errorstack.geterrors"><function>PEAR_ErrorStack::getErrors</function></link>, returns all errors from all singleton stacks.</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticgeterrors.param"> - &title.param; + <refsect1 id="core.pear.pear-errorstack.staticgeterrors.bcwarning"> + <title>Backwards Compatibility Warning</title> + <warning> <para> - <variablelist> - <varlistentry> - <term> - &type.bool; - <parameter>$purge</parameter> - </term> - <listitem> - <para> + As of PEAR 1.3.2, + the second parameter is a new parameter <varname>$level</varname>. + + Any code that relies on $merge being the second parameter will break. + </para> + </warning> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticgeterrors.desc"> + &title.desc; + <para> + Static version of + <link linkend="core.pear.pear-errorstack.geterrors"> + <function>PEAR_ErrorStack::getErrors</function> + </link>, + returns all errors from all singleton stacks. + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticgeterrors.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.bool; + <parameter>$purge</parameter> + </term> + <listitem> + <para> Set to purge the error stack of existing errors </para> </listitem> @@ -55,53 +84,56 @@ <parameter>$level</parameter> </term> <listitem> - <para> - Level name to check for a particular severity. Use this to determine whether only a particular - class of errors has occurred, such as whether any warnings have occurred (errors will be ignored) - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.bool; - <parameter>$merge</parameter> - </term> - <listitem> - <para> - Set to return a flat array, not organized by package - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.array; - <parameter>$sortfunc</parameter> - </term> - <listitem> - <para> - Function used to sort a merged array - default sorts by time, and -should be good for most cases - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticgeterrors.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> + <para> + Level name to check for a particular severity. + + Use this to determine whether only a particular + class of errors has occurred, + such as whether any warnings have occurred + + (errors will be ignored) + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.bool; + <parameter>$merge</parameter> + </term> + <listitem> + <para> + Set to return a flat array, not organized by package + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.array; + <parameter>$sortfunc</parameter> + </term> + <listitem> + <para> + Function used to sort a merged array + - default sorts by time, and should be good for most cases + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticgeterrors.throws"> + &title.throws; + &noexceptions; + </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticgeterrors.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticgeterrors.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/statichaserrors.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/en/core/pear/pear-errorstack/statichaserrors.xml diff -u peardoc/en/core/pear/pear-errorstack/statichaserrors.xml:1.3 peardoc/en/core/pear/pear-errorstack/statichaserrors.xml:1.4 --- peardoc/en/core/pear/pear-errorstack/statichaserrors.xml:1.3 Sat Oct 23 17:13:23 2004 +++ peardoc/en/core/pear/pear-errorstack/statichaserrors.xml Mon Jul 18 10:15:18 2005 @@ -1,73 +1,101 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="core.pear.pear-errorstack.statichaserrors"> - <refnamediv> - <refname><function>PEAR_ErrorStack::staticHasErrors</function></refname> - <refpurpose>Determine whether there are any errors on any error stack</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>boolean <function>PEAR_ErrorStack::staticHasErrors</function></funcdef> - <paramdef>string|false <parameter> <optional>$package = false</optional></parameter></paramdef> - <paramdef>string <parameter> <optional>$level = false</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::staticHasErrors</function> + </refname> + <refpurpose> + Determine whether there are any errors on any error stack + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.boolean; + <function>PEAR_ErrorStack::staticHasErrors</function> + </funcdef> + <paramdef> + &type.string;|&false; + <parameter> <optional>$package = false</optional></parameter> + </paramdef> + <paramdef> + &type.string; + <parameter> <optional>$level = false</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.statichaserrors.desc"> - &title.desc; - <para>Static version of <link linkend="core.pear.pear-errorstack.haserrors"> - <function>PEAR_ErrorStack::hasErrors</function></link>. Returns &true; if any singleton - stack has any errors pending. Since PEAR 1.3.2, If <varname>$package</varname> is specified, it will call PEAR_ErrorStack::hasErrors - for the singleton error stack of that package. If level is specified, hasErrors will ignore - any errors not conforming to the error level specified. Use this to simulate error_reporting(E_NOTICE), for example</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.statichaserrors.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.string;|&false; - <parameter>$package</parameter> - </term> - <listitem> - <para> - Package name to retrieve error information from, or false to retrieve error information from all singleton stacks - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$level</parameter> - </term> - <listitem> - <para> - Level name to check for a particular severity. Use this to determine whether only a particular - class of errors has occurred, such as whether any warnings have occurred (errors will be ignored) - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.statichaserrors.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> + <refsect1 id="core.pear.pear-errorstack.statichaserrors.desc"> + &title.desc; + <para> + Static version of <link linkend="core.pear.pear-errorstack.haserrors"> + <function>PEAR_ErrorStack::hasErrors</function></link>. + + Returns &true; if any singleton stack has any errors pending. + + Since PEAR 1.3.2, If <varname>$package</varname> + is specified, it will call PEAR_ErrorStack::hasErrors + for the singleton error stack of that package. + + If level is specified, hasErrors will ignore + any errors not conforming to the error level specified. + + Use this to simulate error_reporting(E_NOTICE), for example + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.statichaserrors.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.string;|&false; + <parameter>$package</parameter> + </term> + <listitem> + <para> + Package name to retrieve error information from, + or false to retrieve error information + from all singleton stacks + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$level</parameter> + </term> + <listitem> + <para> + Level name to check for a particular severity. + + Use this to determine whether only a particular + class of errors has occurred, + such as whether any warnings have occurred + + (errors will be ignored) + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.statichaserrors.throws"> + &title.throws; + &noexceptions; + </refsect1> - <refsect1 id="core.pear.pear-errorstack.statichaserrors.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.statichaserrors.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/staticpopcallback.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/staticpopcallback.xml diff -u peardoc/en/core/pear/pear-errorstack/staticpopcallback.xml:1.2 peardoc/en/core/pear/pear-errorstack/staticpopcallback.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/staticpopcallback.xml:1.2 Sat Mar 20 02:43:04 2004 +++ peardoc/en/core/pear/pear-errorstack/staticpopcallback.xml Mon Jul 18 10:15:18 2005 @@ -1,42 +1,49 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.staticpopcallback"> - <refnamediv> - <refname><function>PEAR_ErrorStack::staticPopCallback</function></refname> - <refpurpose>Remove a callback from every error callback stack</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef><replaceable>array|string|false</replaceable> <function>PEAR_ErrorStack::staticPopCallback</function></funcdef> -<paramdef></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - - <refsect1 id="core.pear.pear-errorstack.staticpopcallback.desc"> - &title.desc; - <para>Pop a callback from every Error Stack. No check is made to determine whether this is a good idea, so - use with discretion.</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpopcallback.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpopcallback.see"> - &title.see; - <para> - <emphasis>see</emphasis> <link linkend="core.pear.pear-errorstack.staticpushcallback"><function>PEAR_ErrorStack::staticPushCallback</function></link> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpopcallback.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refnamediv> + <refname><function>PEAR_ErrorStack::staticPopCallback</function></refname> + <refpurpose>Remove a callback from every error callback stack</refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + <replaceable>array|string|false</replaceable> <function>PEAR_ErrorStack::staticPopCallback</function> + </funcdef> + <paramdef></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="core.pear.pear-errorstack.staticpopcallback.desc"> + &title.desc; + <para> + Pop a callback from every Error Stack. + + No check is made to determine whether this is a good idea, + so use with discretion. + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpopcallback.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpopcallback.see"> + &title.see; + <para> + <emphasis>see</emphasis> + <link + linkend="core.pear.pear-errorstack.staticpushcallback"> + <function>PEAR_ErrorStack::staticPushCallback</function> + </link> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpopcallback.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/staticpush.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/en/core/pear/pear-errorstack/staticpush.xml diff -u peardoc/en/core/pear/pear-errorstack/staticpush.xml:1.3 peardoc/en/core/pear/pear-errorstack/staticpush.xml:1.4 --- peardoc/en/core/pear/pear-errorstack/staticpush.xml:1.3 Thu Apr 7 16:38:43 2005 +++ peardoc/en/core/pear/pear-errorstack/staticpush.xml Mon Jul 18 10:15:18 2005 @@ -1,158 +1,191 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="core.pear.pear-errorstack.staticpush"> - <refnamediv> - <refname><function>PEAR_ErrorStack::staticPush</function></refname> - <refpurpose>Static version of <link -linkend="core.pear.pear-errorstack.push"><function>push</function></link></refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef><replaceable>PEAR_Error|null|Exception</replaceable> <function>PEAR_ErrorStack::staticPush</function></funcdef> - <paramdef>string <parameter>$package</parameter></paramdef> - <paramdef>int <parameter>$code</parameter></paramdef> - <paramdef>string <parameter> <optional>$level = 'error'</optional></parameter></paramdef> - <paramdef>array <parameter> <optional>$params = array()</optional></parameter></paramdef> - <paramdef>string <parameter> <optional>$msg = &false;</optional></parameter></paramdef> - <paramdef>array <parameter> <optional>$repackage = &false;</optional></parameter></paramdef> - <paramdef>array <parameter> <optional>$backtrace = &false;</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::staticPush</function> + </refname> + <refpurpose> + Static version of + <link linkend="core.pear.pear-errorstack.push"> + <function>push</function> + </link> + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + <replaceable>PEAR_Error|null|Exception</replaceable> + <function>PEAR_ErrorStack::staticPush</function> + </funcdef> + <paramdef> + &type.string; + <parameter>$package</parameter> + </paramdef> + <paramdef> + &type.int; + <parameter>$code</parameter> + </paramdef> + <paramdef> + &type.string; + <parameter> <optional>$level = 'error'</optional></parameter> + </paramdef> + <paramdef> + &type.array; + <parameter> <optional>$params = array()</optional></parameter> + </paramdef> + <paramdef> + &type.string; + <parameter> <optional>$msg = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.array; + <parameter> <optional>$repackage = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.array; + <parameter> <optional>$backtrace = &false;</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.staticpush.desc"> - &title.desc; - <para></para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpush.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$package</parameter> - </term> - <listitem> - <para> - Package name this error belongs to - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.int; - <parameter>$code</parameter> - </term> - <listitem> - <para> - Package-specific error code - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$level</parameter> - </term> - <listitem> - <para> - Error level. This is NOT spell-checked - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.array; - <parameter>$params</parameter> - </term> - <listitem> - <para> - associative array of error parameters - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$msg</parameter> - </term> - <listitem> - <para> - Error message, or a portion of it if the message -is to be generated - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.array; - <parameter>$repackage</parameter> - </term> - <listitem> - <para> - If this error re-packages an error pushed by - another package, place the array returned from - <link linkend="core.pear.pear-errorstack.pop"><function>pop</function></link> - in this parameter - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.array; - <parameter>$backtrace</parameter> - </term> - <listitem> - <para> - Protected parameter: use this to pass in the - <ulink url="&url.php.lookup;debug_backtrace">debug_backtrace</ulink> - that should be used to find error context - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.returns"> - &title.returns; - <para> - <emphasis>returns</emphasis> if compatibility mode is on, a PEAR_Error is also thrown. - If the class Exception exists, then one - is returned to allow code like: - <programlisting role="php-highlighted"> + <refsect1 id="core.pear.pear-errorstack.staticpush.desc"> + &title.desc; + <para></para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpush.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$package</parameter> + </term> + <listitem> + <para> + Package name this error belongs to + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.int; + <parameter>$code</parameter> + </term> + <listitem> + <para> + Package-specific error code + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$level</parameter> + </term> + <listitem> + <para> + Error level. This is NOT spell-checked + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.array; + <parameter>$params</parameter> + </term> + <listitem> + <para> + associative array of error parameters + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$msg</parameter> + </term> + <listitem> + <para> + Error message, or a portion of + it if the message is to be generated + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.array; + <parameter>$repackage</parameter> + </term> + <listitem> + <para> + If this error re-packages an error pushed by + another package, place the array returned from + <link linkend="core.pear.pear-errorstack.pop"> + <function>pop</function> + </link> + in this parameter + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.array; + <parameter>$backtrace</parameter> + </term> + <listitem> + <para> + Protected parameter: use this to pass in the + <ulink url="&url.php.lookup;debug_backtrace">debug_backtrace</ulink> + that should be used to find error context + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.returns"> + &title.returns; + <para> + <emphasis>returns</emphasis> + if compatibility mode is on, + a PEAR_Error is also thrown. + + If the class Exception exists, then one + is returned to allow code like: + <programlisting role="php-highlighted"> <?php 1 throw ($stack-><link linkend="core.pear.pear-errorstack.push">push</link>(MY_ERROR_CODE, 'error', array('username' => 'grob'))); ?> - </programlisting> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpush.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> + </programlisting> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpush.throws"> + &title.throws; + &noexceptions; + </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpush.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpush.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/staticpushcallback.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/staticpushcallback.xml diff -u peardoc/en/core/pear/pear-errorstack/staticpushcallback.xml:1.2 peardoc/en/core/pear/pear-errorstack/staticpushcallback.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/staticpushcallback.xml:1.2 Sat Mar 20 02:43:04 2004 +++ peardoc/en/core/pear/pear-errorstack/staticpushcallback.xml Mon Jul 18 10:15:18 2005 @@ -1,63 +1,88 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.staticpushcallback"> - <refnamediv> - <refname><function>PEAR_ErrorStack::staticPushCallback</function></refname> - <refpurpose>Set an error Callback for every package's error stack</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>void <function>PEAR_ErrorStack::staticPushCallback</function></funcdef> - <paramdef>string|array <parameter>$cb</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::staticPushCallback</function> + </refname> + <refpurpose> + Set an error Callback for every package's error stack + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.void; + <function>PEAR_ErrorStack::staticPushCallback</function> + </funcdef> + <paramdef> + &type.string;|&type.array; + <parameter>$cb</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.staticpushcallback.desc"> - &title.desc; - <para>Set an error callback for every package's singleton error stack.</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpushcallback.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - <type>string|array</type> - <parameter>$cb</parameter> - </term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpushcallback.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - - <refsect1 id="core.pear.pear-errorstack.staticpushcallback.see"> - &title.see; - <para> - <emphasis>see</emphasis> <link linkend="core.pear.pear-errorstack.staticpopcallback"><function>PEAR_ErrorStack::staticPopCallback</function></link>, <link linkend="core.pear.pear-errorstack.pushcallback"><function>PEAR_ErrorStack::pushCallback</function></link> - </para> - <para> - <emphasis>see</emphasis> <link linkend="core.pear.pear-errorstack.constants.details.errorstack---php"><constant>PEAR_ERRORSTACK_PUSHANDLOG</constant></link>, <link linkend="core.pear.pear-errorstack.constants.details.errorstack---php"><constant>PEAR_ERRORSTACK_PUSH</constant></link>, <link linkend="core.pear.pear-errorstack.constants.details.errorstack---php"><constant>PEAR_ERRORSTACK_LOG</constant></link> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpushcallback.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpushcallback.desc"> + &title.desc; + <para> + Set an error callback for every + package's singleton error stack. + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpushcallback.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + <type>&type.string;|&type.array;</type> + <parameter>$cb</parameter> + </term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpushcallback.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpushcallback.see"> + &title.see; + <para> + <emphasis>see</emphasis> + <link linkend="core.pear.pear-errorstack.staticpopcallback"> + <function>PEAR_ErrorStack::staticPopCallback</function> + </link>, + <link linkend="core.pear.pear-errorstack.pushcallback"> + <function>PEAR_ErrorStack::pushCallback</function> + </link> + </para> + <para> + <emphasis>see</emphasis> + <link linkend="core.pear.pear-errorstack.constants.details.errorstack---php"> + <constant>PEAR_ERRORSTACK_PUSHANDLOG</constant> + </link>, + <link linkend="core.pear.pear-errorstack.constants.details.errorstack---php"> + <constant>PEAR_ERRORSTACK_PUSH</constant> + </link>, + <link linkend="core.pear.pear-errorstack.constants.details.errorstack---php"> + <constant>PEAR_ERRORSTACK_LOG</constant> + </link> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpushcallback.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables:
http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml diff -u peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml:1.2 peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml:1.2 Mon Jul 18 03:15:59 2005 +++ peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml Mon Jul 18 10:15:18 2005 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.setdefaultcallback"> <refnamediv> <refname> @@ -40,7 +40,7 @@ <variablelist> <varlistentry> <term> - <type>array|string</type> + <type>&type.array;|&type.string;</type> <parameter>$callback</parameter> </term> <listitem> http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/setdefaultlogger.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/setdefaultlogger.xml diff -u peardoc/en/core/pear/pear-errorstack/setdefaultlogger.xml:1.2 peardoc/en/core/pear/pear-errorstack/setdefaultlogger.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/setdefaultlogger.xml:1.2 Sat Mar 20 02:43:04 2004 +++ peardoc/en/core/pear/pear-errorstack/setdefaultlogger.xml Mon Jul 18 10:15:18 2005 @@ -1,54 +1,65 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.setdefaultlogger"> - <refnamediv> - <refname><function>PEAR_ErrorStack::setDefaultLogger</function></refname> - <refpurpose>Set up a PEAR::Log object for all error stacks that don't have one</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>void <function>PEAR_ErrorStack::setDefaultLogger</function></funcdef> - <paramdef>Log <parameter>&$log</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::setDefaultLogger</function> + </refname> + <refpurpose> + Set up a PEAR::Log object for all + error stacks that don't have one + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.void; + <function>PEAR_ErrorStack::setDefaultLogger</function> + </funcdef> + <paramdef> + Log <parameter>&$log</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.desc"> - &title.desc; - <para>Set up a PEAR::Log object for all error stacks that don't have one</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - <type>Log</type> - <parameter>&$log</parameter> - </term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.desc"> + &title.desc; + <para> + Set up a PEAR::Log object for all + error stacks that don't have one + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + <type>Log</type> + <parameter>&$log</parameter> + </term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.throws"> + &title.throws; + &noexceptions; + </refsect1> - <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultlogger.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/seterrormessagetemplate.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/core/pear/pear-errorstack/seterrormessagetemplate.xml diff -u peardoc/en/core/pear/pear-errorstack/seterrormessagetemplate.xml:1.1 peardoc/en/core/pear/pear-errorstack/seterrormessagetemplate.xml:1.2 --- peardoc/en/core/pear/pear-errorstack/seterrormessagetemplate.xml:1.1 Sat Mar 20 01:16:32 2004 +++ peardoc/en/core/pear/pear-errorstack/seterrormessagetemplate.xml Mon Jul 18 10:15:18 2005 @@ -1,59 +1,76 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="core.pear.pear-errorstack.seterrormessagetemplate"> - <refnamediv> - <refname><function>PEAR_ErrorStack::setErrorMessageTemplate</function></refname> - <refpurpose>Set the Error Message Template array</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>string <function>PEAR_ErrorStack::setErrorMessageTemplate</function></funcdef> - <paramdef>mixed <parameter>$template</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::setErrorMessageTemplate</function> + </refname> + <refpurpose>Set the Error Message Template array</refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.string; + <function>PEAR_ErrorStack::setErrorMessageTemplate</function> + </funcdef> + <paramdef> + &type.mixed; + <parameter>$template</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.desc"> - &title.desc; - <para>The array format must be: <![CDATA[ array(error code => 'message template',...)]]></para> - <para> - Error message parameters passed into <link linkend="core.pear.pear-errorstack.push"><function>push</function></link> - will be used as input for the error message. If the template is 'message %foo% was %bar%', and the - parameters are array('foo' => 'one', 'bar' => 'six'), the error - message returned will be 'message one was six' - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.mixed; - <parameter>$template</parameter> - </term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.note"> - &title.note; - ¬e.notstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.desc"> + &title.desc; + <para> + The array format must be: + <![CDATA[ array(error code => 'message template',...)]]> + </para> + <para> + Error message parameters passed into + <link linkend="core.pear.pear-errorstack.push"> + <function>push</function> + </link> + will be used as input for the error message. + + If the template is 'message %foo% was %bar%', + and the parameters are + array('foo' => 'one', + 'bar' => 'six'), + the error message returned will be + 'message one was six' + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.mixed; + <parameter>$template</parameter> + </term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.seterrormessagetemplate.note"> + &title.note; + ¬e.notstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/setlogger.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/setlogger.xml diff -u peardoc/en/core/pear/pear-errorstack/setlogger.xml:1.2 peardoc/en/core/pear/pear-errorstack/setlogger.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/setlogger.xml:1.2 Sat Mar 20 02:43:04 2004 +++ peardoc/en/core/pear/pear-errorstack/setlogger.xml Mon Jul 18 10:15:18 2005 @@ -1,53 +1,64 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.setlogger"> - <refnamediv> - <refname><function>PEAR_ErrorStack::setLogger</function></refname> - <refpurpose>Set up a PEAR::Log object for this error stack</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>void <function>PEAR_ErrorStack::setLogger</function></funcdef> - <paramdef>Log <parameter>&$log</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::setLogger</function> + </refname> + <refpurpose> + Set up a PEAR::Log object for this error stack + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.void; + <function>PEAR_ErrorStack::setLogger</function> + </funcdef> + <paramdef> + Log + <parameter>&$log</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.setlogger.desc"> - &title.desc; - <para>Set a PEAR::Log object to use for a specific error stack instance</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setlogger.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - <type>Log</type> - <parameter>&$log</parameter> - </term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setlogger.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setlogger.note"> - &title.note; - ¬e.notstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.setlogger.desc"> + &title.desc; + <para> + Set a PEAR::Log object to use + for a specific error stack instance + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setlogger.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + <type>Log</type> + <parameter>&$log</parameter> + </term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setlogger.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setlogger.note"> + &title.note; + ¬e.notstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/setmessagecallback.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/core/pear/pear-errorstack/setmessagecallback.xml diff -u peardoc/en/core/pear/pear-errorstack/setmessagecallback.xml:1.1 peardoc/en/core/pear/pear-errorstack/setmessagecallback.xml:1.2 --- peardoc/en/core/pear/pear-errorstack/setmessagecallback.xml:1.1 Sat Mar 20 01:16:32 2004 +++ peardoc/en/core/pear/pear-errorstack/setmessagecallback.xml Mon Jul 18 10:15:18 2005 @@ -1,54 +1,64 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="core.pear.pear-errorstack.setmessagecallback"> - <refnamediv> - <refname><function>PEAR_ErrorStack::setMessageCallback</function></refname> - <refpurpose>Set an error code => error message mapping callback</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>void <function>PEAR_ErrorStack::setMessageCallback</function></funcdef> - <paramdef>mixed <parameter>$msgCallback</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - - <refsect1 id="core.pear.pear-errorstack.setmessagecallback.desc"> - &title.desc; - <para>This method sets the callback that can be used to generate error messages for any PEAR_ErrorStack instance</para> - - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setmessagecallback.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.mixed; - <parameter>$msgCallback</parameter> - </term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setmessagecallback.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setmessagecallback.note"> - &title.note; - ¬e.notstatic; - </refsect1> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::setMessageCallback</function> + </refname> + <refpurpose> + Set an error code => error message mapping callback + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.void; + <function>PEAR_ErrorStack::setMessageCallback</function> + </funcdef> + <paramdef> + &type.mixed; + <parameter>$msgCallback</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="core.pear.pear-errorstack.setmessagecallback.desc"> + &title.desc; + <para> + This method sets the callback that + can be used to generate error + messages for any PEAR_ErrorStack instance + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setmessagecallback.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.mixed; + <parameter>$msgCallback</parameter> + </term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setmessagecallback.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setmessagecallback.note"> + &title.note; + ¬e.notstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/singleton.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/en/core/pear/pear-errorstack/singleton.xml diff -u peardoc/en/core/pear/pear-errorstack/singleton.xml:1.3 peardoc/en/core/pear/pear-errorstack/singleton.xml:1.4 --- peardoc/en/core/pear/pear-errorstack/singleton.xml:1.3 Sat Oct 23 17:13:23 2004 +++ peardoc/en/core/pear/pear-errorstack/singleton.xml Mon Jul 18 10:15:18 2005 @@ -1,120 +1,158 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="core.pear.pear-errorstack.singleton"> - <refnamediv> - <refname><function>PEAR_ErrorStack::singleton</function></refname> - <refpurpose>Return a single error stack for this package.</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef><replaceable><link linkend="core.pear.pear-errorstack"><classname>PEAR_ErrorStack</classname></link></replaceable>& <function>PEAR_ErrorStack::singleton</function></funcdef> - <paramdef>string <parameter>$package</parameter></paramdef> - <paramdef>callback <parameter> <optional>$msgCallback = &false;</optional></parameter></paramdef> - <paramdef>callback <parameter> <optional>$contextCallback = &false;</optional></parameter></paramdef> - <paramdef>boolean <parameter> <optional>$throwPEAR_Error = &false;</optional></parameter></paramdef> - <paramdef>string <parameter> <optional>$stackClass = 'PEAR_ErrorStack'</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname><function>PEAR_ErrorStack::singleton</function></refname> + <refpurpose>Return a single error stack for this package.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + <replaceable> + <link linkend="core.pear.pear-errorstack"> + <classname>PEAR_ErrorStack</classname> + </link> + </replaceable>& + <function>PEAR_ErrorStack::singleton</function> + </funcdef> + <paramdef> + &type.string; + <parameter>$package</parameter> + </paramdef> + <paramdef> + &type.callback; + <parameter> <optional>$msgCallback = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.callback; + <parameter> <optional>$contextCallback = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.boolean; + <parameter> <optional>$throwPEAR_Error = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.string; + <parameter> + <optional>$stackClass = 'PEAR_ErrorStack'</optional> + </parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.singleton.bcwarning"> - <title>Backwards Compatibility Warning</title> - <warning> + <refsect1 id="core.pear.pear-errorstack.singleton.bcwarning"> + <title>Backwards Compatibility Warning</title> + <warning> + <para> + As of PEAR 1.3.2, + PEAR_ErrorStack no longer instantiates + and returns an Exception object in PHP5, + and the second-to-last parameter has been removed. + + Code that relies upon this behavior will break. + </para> + </warning> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.singleton.desc"> + &title.desc; + <para> + Note that all parameters are ignored if the + stack for package $package has already been instantiated + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.singleton.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$package</parameter> + </term> + <listitem> <para> - As of PEAR 1.3.2, PEAR_ErrorStack no longer instantiates and returns an Exception object in PHP5, and - the second-to-last parameter has been removed. Code that relies upon this behavior will break. + name of the package this error stack represents </para> - </warning> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.singleton.desc"> - &title.desc; - <para>Note that all parameters are ignored if the stack for package $package has already been instantiated</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.singleton.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$package</parameter> - </term> - <listitem> - <para> - name of the package this error stack represents - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - <type>callback</type> - <parameter>$msgCallback</parameter> - </term> - <listitem> - <para> - callback used for error message generation - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - <type>callback</type> - <parameter>$contextCallback</parameter> - </term> - <listitem> - <para> - callback used for context generation, defaults to <link linkend="core.pear.pear-errorstack.getfileline"><function>getFileLine</function></link> - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.bool; - <parameter>$throwPEAR_Error</parameter> - </term> - <listitem> - <para> - If &true;, then <link linkend="core.pear.pear.raiseerror"><function>PEAR::raiseError</function></link> will be called and a <link linkend="core.pear.pear-error"><classname>PEAR_Error</classname></link> object will be returned - from calls to <link linkend="core.pear.pear-errorstack.push"><function>PEAR_ErrorStack::push</function></link> - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$stackClass</parameter> - </term> - <listitem> - <para> - class to instantiate - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.singleton.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + <type>callback</type> + <parameter>$msgCallback</parameter> + </term> + <listitem> + <para> + callback used for error message generation + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + <type>callback</type> + <parameter>$contextCallback</parameter> + </term> + <listitem> + <para> + callback used for context generation, defaults to <link linkend="core.pear.pear-errorstack.getfileline"><function>getFileLine</function></link> + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.bool; + <parameter>$throwPEAR_Error</parameter> + </term> + <listitem> + <para> + If &true;, then + <link linkend="core.pear.pear.raiseerror"> + <function>PEAR::raiseError</function> + </link> will be called and a + <link linkend="core.pear.pear-error"> + <classname>PEAR_Error</classname> + </link> + object will be returned from calls to + <link linkend="core.pear.pear-errorstack.push"> + <function>PEAR_ErrorStack::push</function> + </link> + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$stackClass</parameter> + </term> + <listitem> + <para> + class to instantiate + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.singleton.throws"> + &title.throws; + &noexceptions; + </refsect1> - <refsect1 id="core.pear.pear-errorstack.singleton.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.singleton.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/staticgeterrors.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/en/core/pear/pear-errorstack/staticgeterrors.xml diff -u peardoc/en/core/pear/pear-errorstack/staticgeterrors.xml:1.3 peardoc/en/core/pear/pear-errorstack/staticgeterrors.xml:1.4 --- peardoc/en/core/pear/pear-errorstack/staticgeterrors.xml:1.3 Sat Oct 23 17:13:23 2004 +++ peardoc/en/core/pear/pear-errorstack/staticgeterrors.xml Mon Jul 18 10:15:18 2005 @@ -1,48 +1,77 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="core.pear.pear-errorstack.staticgeterrors"> - <refnamediv> - <refname><function>PEAR_ErrorStack::staticGetErrors</function></refname> - <refpurpose>Get a list of all errors since last purge, organized by package</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>array <function>PEAR_ErrorStack::staticGetErrors</function></funcdef> - <paramdef>boolean <parameter> <optional>$purge = &false;</optional></parameter></paramdef> - <paramdef>string|false <parameter> <optional>$level = &false;</optional></parameter></paramdef> - <paramdef>boolean <parameter> <optional>$merge = &false;</optional></parameter></paramdef> - <paramdef>array <parameter> <optional>$sortfunc = array('PEAR_ErrorStack', '_sortErrors')</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname><function>PEAR_ErrorStack::staticGetErrors</function></refname> + <refpurpose> + Get a list of all errors since last purge, + organized by package + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef>&type.array; + <function>PEAR_ErrorStack::staticGetErrors</function> + </funcdef> + <paramdef> + &type.boolean; + <parameter> <optional>$purge = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.string;|&false; + <parameter> <optional>$level = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.boolean; + <parameter> <optional>$merge = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.array; + <parameter> + <optional> + $sortfunc = array('PEAR_ErrorStack', '_sortErrors') + </optional> + </parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.staticgeterrors.bcwarning"> - <title>Backwards Compatibility Warning</title> - <warning> - <para> - As of PEAR 1.3.2, the second parameter is a new parameter <varname>$level</varname>. Any code that - relies on $merge being the second parameter will break. - </para> - </warning> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticgeterrors.desc"> - &title.desc; - <para>Static version of <link linkend="core.pear.pear-errorstack.geterrors"><function>PEAR_ErrorStack::getErrors</function></link>, returns all errors from all singleton stacks.</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticgeterrors.param"> - &title.param; + <refsect1 id="core.pear.pear-errorstack.staticgeterrors.bcwarning"> + <title>Backwards Compatibility Warning</title> + <warning> <para> - <variablelist> - <varlistentry> - <term> - &type.bool; - <parameter>$purge</parameter> - </term> - <listitem> - <para> + As of PEAR 1.3.2, + the second parameter is a new parameter <varname>$level</varname>. + + Any code that relies on $merge being the second parameter will break. + </para> + </warning> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticgeterrors.desc"> + &title.desc; + <para> + Static version of + <link linkend="core.pear.pear-errorstack.geterrors"> + <function>PEAR_ErrorStack::getErrors</function> + </link>, + returns all errors from all singleton stacks. + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticgeterrors.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.bool; + <parameter>$purge</parameter> + </term> + <listitem> + <para> Set to purge the error stack of existing errors </para> </listitem> @@ -55,53 +84,56 @@ <parameter>$level</parameter> </term> <listitem> - <para> - Level name to check for a particular severity. Use this to determine whether only a particular - class of errors has occurred, such as whether any warnings have occurred (errors will be ignored) - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.bool; - <parameter>$merge</parameter> - </term> - <listitem> - <para> - Set to return a flat array, not organized by package - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.array; - <parameter>$sortfunc</parameter> - </term> - <listitem> - <para> - Function used to sort a merged array - default sorts by time, and -should be good for most cases - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticgeterrors.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> + <para> + Level name to check for a particular severity. + + Use this to determine whether only a particular + class of errors has occurred, + such as whether any warnings have occurred + + (errors will be ignored) + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.bool; + <parameter>$merge</parameter> + </term> + <listitem> + <para> + Set to return a flat array, not organized by package + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.array; + <parameter>$sortfunc</parameter> + </term> + <listitem> + <para> + Function used to sort a merged array + - default sorts by time, and should be good for most cases + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticgeterrors.throws"> + &title.throws; + &noexceptions; + </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticgeterrors.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticgeterrors.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/statichaserrors.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/en/core/pear/pear-errorstack/statichaserrors.xml diff -u peardoc/en/core/pear/pear-errorstack/statichaserrors.xml:1.3 peardoc/en/core/pear/pear-errorstack/statichaserrors.xml:1.4 --- peardoc/en/core/pear/pear-errorstack/statichaserrors.xml:1.3 Sat Oct 23 17:13:23 2004 +++ peardoc/en/core/pear/pear-errorstack/statichaserrors.xml Mon Jul 18 10:15:18 2005 @@ -1,73 +1,101 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="core.pear.pear-errorstack.statichaserrors"> - <refnamediv> - <refname><function>PEAR_ErrorStack::staticHasErrors</function></refname> - <refpurpose>Determine whether there are any errors on any error stack</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>boolean <function>PEAR_ErrorStack::staticHasErrors</function></funcdef> - <paramdef>string|false <parameter> <optional>$package = false</optional></parameter></paramdef> - <paramdef>string <parameter> <optional>$level = false</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::staticHasErrors</function> + </refname> + <refpurpose> + Determine whether there are any errors on any error stack + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.boolean; + <function>PEAR_ErrorStack::staticHasErrors</function> + </funcdef> + <paramdef> + &type.string;|&false; + <parameter> <optional>$package = false</optional></parameter> + </paramdef> + <paramdef> + &type.string; + <parameter> <optional>$level = false</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.statichaserrors.desc"> - &title.desc; - <para>Static version of <link linkend="core.pear.pear-errorstack.haserrors"> - <function>PEAR_ErrorStack::hasErrors</function></link>. Returns &true; if any singleton - stack has any errors pending. Since PEAR 1.3.2, If <varname>$package</varname> is specified, it will call PEAR_ErrorStack::hasErrors - for the singleton error stack of that package. If level is specified, hasErrors will ignore - any errors not conforming to the error level specified. Use this to simulate error_reporting(E_NOTICE), for example</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.statichaserrors.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.string;|&false; - <parameter>$package</parameter> - </term> - <listitem> - <para> - Package name to retrieve error information from, or false to retrieve error information from all singleton stacks - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$level</parameter> - </term> - <listitem> - <para> - Level name to check for a particular severity. Use this to determine whether only a particular - class of errors has occurred, such as whether any warnings have occurred (errors will be ignored) - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.statichaserrors.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> + <refsect1 id="core.pear.pear-errorstack.statichaserrors.desc"> + &title.desc; + <para> + Static version of <link linkend="core.pear.pear-errorstack.haserrors"> + <function>PEAR_ErrorStack::hasErrors</function></link>. + + Returns &true; if any singleton stack has any errors pending. + + Since PEAR 1.3.2, If <varname>$package</varname> + is specified, it will call PEAR_ErrorStack::hasErrors + for the singleton error stack of that package. + + If level is specified, hasErrors will ignore + any errors not conforming to the error level specified. + + Use this to simulate error_reporting(E_NOTICE), for example + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.statichaserrors.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.string;|&false; + <parameter>$package</parameter> + </term> + <listitem> + <para> + Package name to retrieve error information from, + or false to retrieve error information + from all singleton stacks + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$level</parameter> + </term> + <listitem> + <para> + Level name to check for a particular severity. + + Use this to determine whether only a particular + class of errors has occurred, + such as whether any warnings have occurred + + (errors will be ignored) + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.statichaserrors.throws"> + &title.throws; + &noexceptions; + </refsect1> - <refsect1 id="core.pear.pear-errorstack.statichaserrors.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.statichaserrors.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/staticpopcallback.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/staticpopcallback.xml diff -u peardoc/en/core/pear/pear-errorstack/staticpopcallback.xml:1.2 peardoc/en/core/pear/pear-errorstack/staticpopcallback.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/staticpopcallback.xml:1.2 Sat Mar 20 02:43:04 2004 +++ peardoc/en/core/pear/pear-errorstack/staticpopcallback.xml Mon Jul 18 10:15:18 2005 @@ -1,42 +1,49 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.staticpopcallback"> - <refnamediv> - <refname><function>PEAR_ErrorStack::staticPopCallback</function></refname> - <refpurpose>Remove a callback from every error callback stack</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef><replaceable>array|string|false</replaceable> <function>PEAR_ErrorStack::staticPopCallback</function></funcdef> -<paramdef></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - - <refsect1 id="core.pear.pear-errorstack.staticpopcallback.desc"> - &title.desc; - <para>Pop a callback from every Error Stack. No check is made to determine whether this is a good idea, so - use with discretion.</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpopcallback.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpopcallback.see"> - &title.see; - <para> - <emphasis>see</emphasis> <link linkend="core.pear.pear-errorstack.staticpushcallback"><function>PEAR_ErrorStack::staticPushCallback</function></link> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpopcallback.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refnamediv> + <refname><function>PEAR_ErrorStack::staticPopCallback</function></refname> + <refpurpose>Remove a callback from every error callback stack</refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + <replaceable>array|string|false</replaceable> <function>PEAR_ErrorStack::staticPopCallback</function> + </funcdef> + <paramdef></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="core.pear.pear-errorstack.staticpopcallback.desc"> + &title.desc; + <para> + Pop a callback from every Error Stack. + + No check is made to determine whether this is a good idea, + so use with discretion. + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpopcallback.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpopcallback.see"> + &title.see; + <para> + <emphasis>see</emphasis> + <link + linkend="core.pear.pear-errorstack.staticpushcallback"> + <function>PEAR_ErrorStack::staticPushCallback</function> + </link> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpopcallback.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/staticpush.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/en/core/pear/pear-errorstack/staticpush.xml diff -u peardoc/en/core/pear/pear-errorstack/staticpush.xml:1.3 peardoc/en/core/pear/pear-errorstack/staticpush.xml:1.4 --- peardoc/en/core/pear/pear-errorstack/staticpush.xml:1.3 Thu Apr 7 16:38:43 2005 +++ peardoc/en/core/pear/pear-errorstack/staticpush.xml Mon Jul 18 10:15:18 2005 @@ -1,158 +1,191 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="core.pear.pear-errorstack.staticpush"> - <refnamediv> - <refname><function>PEAR_ErrorStack::staticPush</function></refname> - <refpurpose>Static version of <link -linkend="core.pear.pear-errorstack.push"><function>push</function></link></refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef><replaceable>PEAR_Error|null|Exception</replaceable> <function>PEAR_ErrorStack::staticPush</function></funcdef> - <paramdef>string <parameter>$package</parameter></paramdef> - <paramdef>int <parameter>$code</parameter></paramdef> - <paramdef>string <parameter> <optional>$level = 'error'</optional></parameter></paramdef> - <paramdef>array <parameter> <optional>$params = array()</optional></parameter></paramdef> - <paramdef>string <parameter> <optional>$msg = &false;</optional></parameter></paramdef> - <paramdef>array <parameter> <optional>$repackage = &false;</optional></parameter></paramdef> - <paramdef>array <parameter> <optional>$backtrace = &false;</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::staticPush</function> + </refname> + <refpurpose> + Static version of + <link linkend="core.pear.pear-errorstack.push"> + <function>push</function> + </link> + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + <replaceable>PEAR_Error|null|Exception</replaceable> + <function>PEAR_ErrorStack::staticPush</function> + </funcdef> + <paramdef> + &type.string; + <parameter>$package</parameter> + </paramdef> + <paramdef> + &type.int; + <parameter>$code</parameter> + </paramdef> + <paramdef> + &type.string; + <parameter> <optional>$level = 'error'</optional></parameter> + </paramdef> + <paramdef> + &type.array; + <parameter> <optional>$params = array()</optional></parameter> + </paramdef> + <paramdef> + &type.string; + <parameter> <optional>$msg = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.array; + <parameter> <optional>$repackage = &false;</optional></parameter> + </paramdef> + <paramdef> + &type.array; + <parameter> <optional>$backtrace = &false;</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.staticpush.desc"> - &title.desc; - <para></para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpush.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$package</parameter> - </term> - <listitem> - <para> - Package name this error belongs to - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.int; - <parameter>$code</parameter> - </term> - <listitem> - <para> - Package-specific error code - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$level</parameter> - </term> - <listitem> - <para> - Error level. This is NOT spell-checked - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.array; - <parameter>$params</parameter> - </term> - <listitem> - <para> - associative array of error parameters - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$msg</parameter> - </term> - <listitem> - <para> - Error message, or a portion of it if the message -is to be generated - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.array; - <parameter>$repackage</parameter> - </term> - <listitem> - <para> - If this error re-packages an error pushed by - another package, place the array returned from - <link linkend="core.pear.pear-errorstack.pop"><function>pop</function></link> - in this parameter - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term> - &type.array; - <parameter>$backtrace</parameter> - </term> - <listitem> - <para> - Protected parameter: use this to pass in the - <ulink url="&url.php.lookup;debug_backtrace">debug_backtrace</ulink> - that should be used to find error context - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.returns"> - &title.returns; - <para> - <emphasis>returns</emphasis> if compatibility mode is on, a PEAR_Error is also thrown. - If the class Exception exists, then one - is returned to allow code like: - <programlisting role="php-highlighted"> + <refsect1 id="core.pear.pear-errorstack.staticpush.desc"> + &title.desc; + <para></para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpush.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$package</parameter> + </term> + <listitem> + <para> + Package name this error belongs to + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.int; + <parameter>$code</parameter> + </term> + <listitem> + <para> + Package-specific error code + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$level</parameter> + </term> + <listitem> + <para> + Error level. This is NOT spell-checked + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.array; + <parameter>$params</parameter> + </term> + <listitem> + <para> + associative array of error parameters + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$msg</parameter> + </term> + <listitem> + <para> + Error message, or a portion of + it if the message is to be generated + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.array; + <parameter>$repackage</parameter> + </term> + <listitem> + <para> + If this error re-packages an error pushed by + another package, place the array returned from + <link linkend="core.pear.pear-errorstack.pop"> + <function>pop</function> + </link> + in this parameter + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + &type.array; + <parameter>$backtrace</parameter> + </term> + <listitem> + <para> + Protected parameter: use this to pass in the + <ulink url="&url.php.lookup;debug_backtrace">debug_backtrace</ulink> + that should be used to find error context + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.returns"> + &title.returns; + <para> + <emphasis>returns</emphasis> + if compatibility mode is on, + a PEAR_Error is also thrown. + + If the class Exception exists, then one + is returned to allow code like: + <programlisting role="php-highlighted"> <?php 1 throw ($stack-><link linkend="core.pear.pear-errorstack.push">push</link>(MY_ERROR_CODE, 'error', array('username' => 'grob'))); ?> - </programlisting> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpush.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> + </programlisting> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpush.throws"> + &title.throws; + &noexceptions; + </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpush.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpush.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/staticpushcallback.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/staticpushcallback.xml diff -u peardoc/en/core/pear/pear-errorstack/staticpushcallback.xml:1.2 peardoc/en/core/pear/pear-errorstack/staticpushcallback.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/staticpushcallback.xml:1.2 Sat Mar 20 02:43:04 2004 +++ peardoc/en/core/pear/pear-errorstack/staticpushcallback.xml Mon Jul 18 10:15:18 2005 @@ -1,63 +1,88 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.staticpushcallback"> - <refnamediv> - <refname><function>PEAR_ErrorStack::staticPushCallback</function></refname> - <refpurpose>Set an error Callback for every package's error stack</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>void <function>PEAR_ErrorStack::staticPushCallback</function></funcdef> - <paramdef>string|array <parameter>$cb</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::staticPushCallback</function> + </refname> + <refpurpose> + Set an error Callback for every package's error stack + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.void; + <function>PEAR_ErrorStack::staticPushCallback</function> + </funcdef> + <paramdef> + &type.string;|&type.array; + <parameter>$cb</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.staticpushcallback.desc"> - &title.desc; - <para>Set an error callback for every package's singleton error stack.</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpushcallback.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - <type>string|array</type> - <parameter>$cb</parameter> - </term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpushcallback.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - - <refsect1 id="core.pear.pear-errorstack.staticpushcallback.see"> - &title.see; - <para> - <emphasis>see</emphasis> <link linkend="core.pear.pear-errorstack.staticpopcallback"><function>PEAR_ErrorStack::staticPopCallback</function></link>, <link linkend="core.pear.pear-errorstack.pushcallback"><function>PEAR_ErrorStack::pushCallback</function></link> - </para> - <para> - <emphasis>see</emphasis> <link linkend="core.pear.pear-errorstack.constants.details.errorstack---php"><constant>PEAR_ERRORSTACK_PUSHANDLOG</constant></link>, <link linkend="core.pear.pear-errorstack.constants.details.errorstack---php"><constant>PEAR_ERRORSTACK_PUSH</constant></link>, <link linkend="core.pear.pear-errorstack.constants.details.errorstack---php"><constant>PEAR_ERRORSTACK_LOG</constant></link> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.staticpushcallback.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpushcallback.desc"> + &title.desc; + <para> + Set an error callback for every + package's singleton error stack. + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpushcallback.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + <type>&type.string;|&type.array;</type> + <parameter>$cb</parameter> + </term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpushcallback.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpushcallback.see"> + &title.see; + <para> + <emphasis>see</emphasis> + <link linkend="core.pear.pear-errorstack.staticpopcallback"> + <function>PEAR_ErrorStack::staticPopCallback</function> + </link>, + <link linkend="core.pear.pear-errorstack.pushcallback"> + <function>PEAR_ErrorStack::pushCallback</function> + </link> + </para> + <para> + <emphasis>see</emphasis> + <link linkend="core.pear.pear-errorstack.constants.details.errorstack---php"> + <constant>PEAR_ERRORSTACK_PUSHANDLOG</constant> + </link>, + <link linkend="core.pear.pear-errorstack.constants.details.errorstack---php"> + <constant>PEAR_ERRORSTACK_PUSH</constant> + </link>, + <link linkend="core.pear.pear-errorstack.constants.details.errorstack---php"> + <constant>PEAR_ERRORSTACK_LOG</constant> + </link> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.staticpushcallback.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: