cvs: peardoc /en/package/authentication/liveuser/liveuser-error liveuser_error.xml

derick Tue Mar 16 12:58:43 2004 EDT Modified files: /peardoc/en/package/authentication/liveuser/liveuser-error liveuser_error.xml Log: - Fix didou's mess - Test 1 http://cvs.php.net/diff.php/peardoc/en/package/authentication/liveuser/liveuser-error/liveuser_error.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/package/authentication/liveuser/liveuser-error/liveuser_error.xml diff -u /dev/null peardoc/en/package/authentication/liveuser/liveuser-error/liveuser_error.xml:1.3 --- /dev/null Tue Mar 16 12:58:43 2004 +++ peardoc/en/package/authentication/liveuser/liveuser-error/liveuser_error.xml Tue Mar 16 12:58:43 2004 @@ -0,0 +1,120 @@ +<!-- $Revision: 1.3 $ --> +<refentry id="package.authentication.liveuser.liveuser-error.liveuser-error"> + <refnamediv> + <refname>constructor <function>LiveUser_Error::LiveUser_Error</function></refname> + <refpurpose>Creates a liveuser error object, extending the PEAR_Error class</refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once &apos;LiveUser.php&apos;; + </funcsynopsisinfo> + <funcprototype> + <funcdef>PEAR_Error constructor <function>LiveUser_Error::LiveUser_Error</function></funcdef> + <paramdef>int <parameter> <optional>$code = LIVEUSER_ERROR</optional></parameter></paramdef> + <paramdef>int <parameter> <optional>$mode = PEAR_ERROR_RETURN</optional></parameter></paramdef> + <paramdef>int <parameter> <optional>$level = E_USER_NOTICE</optional></parameter></paramdef> + <paramdef>mixed <parameter> <optional>$debuginfo = &null;</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1 id="package.authentication.liveuser.liveuser-error.liveuser-error.desc"> + &title.desc; + &notdocumented; + </refsect1> + <refsect1 id="package.authentication.liveuser.liveuser-error.liveuser-error.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + + + &type.int; + <parameter>$code</parameter> + </term> + <listitem> + <para> + the error code + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + + + &type.int; + <parameter>$mode</parameter> + </term> + <listitem> + <para> + the reaction to the error, either return, die or trigger/callback + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + + + &type.int; + <parameter>$level</parameter> + </term> + <listitem> + <para> + intensity of the error (PHP error code) + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term> + + + &type.mixed; + <parameter>$debuginfo</parameter> + </term> + <listitem> + <para> + any information that can inform user as to nature of the error + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="package.authentication.liveuser.liveuser-error.liveuser-error.throws"> + &title.throws; + <para> + <emphasis>throws</emphasis> no exceptions thrown + </para> + </refsect1> + <refsect1 id="package.authentication.liveuser.liveuser-error.liveuser-error.note"> + &title.note; + &note.notstatic; + </refsect1> +</refentry> +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:"../../../../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +vim600: syn=xml fen fdm=syntax fdl=2 si +vim: et tw=78 syn=sgml +vi: ts=1 sw=1 +-->