cvs: peardoc /en/package/authentication auth.xml /en/package/authentication/auth/auth checkauth.xml

mj Thu Feb 24 11:39:34 2005 EDT Added files: /peardoc/en/package/authentication/auth/auth checkauth.xml Modified files: /peardoc/en/package/authentication auth.xml Log: * Added documentation for checkAuth() # Bug: #3262 http://cvs.php.net/diff.php/peardoc/en/package/authentication/auth.xml?r1=1.6&r2=1.7&ty=u Index: peardoc/en/package/authentication/auth.xml diff -u peardoc/en/package/authentication/auth.xml:1.6 peardoc/en/package/authentication/auth.xml:1.7 --- peardoc/en/package/authentication/auth.xml:1.6 Fri Jun 25 13:45:57 2004 +++ peardoc/en/package/authentication/auth.xml Thu Feb 24 11:39:34 2005 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <sect1 id="package.authentication.auth"> <title>Auth</title> @@ -19,6 +19,7 @@ &package.authentication.auth.auth.setexpire; &package.authentication.auth.auth.setidle; &package.authentication.auth.auth.start; + &package.authentication.auth.auth.checkauth; </sect1> <!-- Keep this comment at the end of the file http://cvs.php.net/co.php/peardoc/en/package/authentication/auth/auth/checkauth.xml?r=1.1&p=1 Index: peardoc/en/package/authentication/auth/auth/checkauth.xml +++ peardoc/en/package/authentication/auth/auth/checkauth.xml <!-- $Revision: 1.1 $ --> <refentry id="package.authentication.auth.auth.checkauth"> <refnamediv> <refname>Auth::checkAuth()</refname> <refpurpose> check if a session with valid authentication information exists </refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>boolean <function>Auth_HTTP::checkAuth</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.authentication.auth.auth.checkauth.desc"> &title.desc; <para> Checks if a HTTP session exists that contains valid authentication information. </para> </refsect1> <refsect1 id="package.authentication.auth.auth.checkauth.return"> &title.returns; <para> <parameter>boolean</parameter> - If a session with valid authentication information exists, the function return &true;. Otherwise it returns &false;. </para> </refsect1> <refsect1 id="package.authentication.auth.auth.checkauth.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 -->