[prev in list] [next in list] [prev in thread] [next in thread] 

List:       pear-doc
Subject:    [PEAR-DOC] cvs: peardoc /en/package/authentication auth.xml  /en/package/authentication/auth/auth se
From:       "Yavor Shahpasov" <yavo () php ! net>
Date:       2004-06-25 17:45:58
Message-ID: cvsyavo1088185558 () cvsserver
[Download RAW message or body]

yavo		Fri Jun 25 13:45:58 2004 EDT

  Added files:                 
    /peardoc/en/package/authentication/auth/auth	setshowlogin.xml 

  Modified files:              
    /peardoc/en/package/authentication	auth.xml 
  Log:
  added docs for setShowLogin
  
http://cvs.php.net/diff.php/peardoc/en/package/authentication/auth.xml?r1=1.5&r2=1.6&ty=u
Index: peardoc/en/package/authentication/auth.xml
diff -u peardoc/en/package/authentication/auth.xml:1.5 peardoc/en/package/authentication/auth.xml:1.6
--- peardoc/en/package/authentication/auth.xml:1.5	Sun Jun 13 06:04:57 2004
+++ peardoc/en/package/authentication/auth.xml	Fri Jun 25 13:45:57 2004
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <sect1 id="package.authentication.auth">
  <title>Auth</title>
 
@@ -15,6 +15,7 @@
  &package.authentication.auth.auth.getusername;
  &package.authentication.auth.auth.sessionvalidthru;
  &package.authentication.auth.auth.setsessionname; 
+ &package.authentication.auth.auth.setshowlogin; 
  &package.authentication.auth.auth.setexpire; 
  &package.authentication.auth.auth.setidle;
  &package.authentication.auth.auth.start;  

http://cvs.php.net/co.php/peardoc/en/package/authentication/auth/auth/setshowlogin.xml?r=1.1&p=1
Index: peardoc/en/package/authentication/auth/auth/setshowlogin.xml
+++ peardoc/en/package/authentication/auth/auth/setshowlogin.xml
<!-- $Revision: 1.1 $ -->
<refentry id="package.authentication.auth.auth.setshowlogin">
   <refnamediv>
    <refname>Auth::setShowLogin()</refname>
    <refpurpose>controls if the login form will be displayed</refpurpose>
   </refnamediv>
   <refsynopsisdiv>
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>Auth::setShowLogin</function></funcdef>
     <paramdef>bool <parameter>$showLogin = true</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   </refsynopsisdiv>
   <refsect1 id="package.authentication.auth.auth.setshowlogin.desc">
    &title.desc;
    <para>
     Controls if the login page will be displayed to the user. Normally you might need to 
     display the login form only on a certain page of your web application.
    </para>
   </refsect1>   
   <refsect1 id="package.authentication.auth.auth.setshowlogin.parameter">
    &title.param;
    <para>
     <variablelist>
      <varlistentry>
       <term>
        &type.string;
        <parameter>$showLogin</parameter>
       </term>
       <listitem>
        <para>        
         true if you want to display the login form and false if you want 
         to hide it.
        </para>
       </listitem>      
      </varlistentry>
     </variablelist>
    </para>
   </refsect1>   
   <refsect1 id="package.authentication.auth.auth.setshowlogin.note">
    &title.note;
    &note.notstatic;
    <para>
     This is equivalent to the 4th paramether of <function>Auth::Auth()</function>
     <link linkend="package.authentication.auth.auth.auth">
      Auth::Auth()
     </link>   
    </para>
   </refsect1>      
  </refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
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
-->  

-- 
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

[prev in list] [next in list] [prev in thread] [next in thread]