cvs: peardoc /en/package/authentication/auth-prefmanager/auth-prefmanager getpref.xml setreturndefaults.xml usecache.xml
/en/package/authentication/auth/auth auth.xml setexpire.xml setidle.xml

From: Date: Sat, 27 Dec 2008 09:26:33 +0000
Subject: cvs: peardoc /en/package/authentication/auth-prefmanager/auth-prefmanager getpref.xml setreturndefaults.xml usecache.xml
/en/package/authentication/auth/auth auth.xml setexpire.xml setidle.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-11346@lists.php.net to get a copy of this message
farell Sat Dec 27 09:26:33 2008 UTC Modified files: /peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager getpref.xml setreturndefaults.xml usecache.xml /peardoc/en/package/authentication/auth/auth auth.xml setexpire.xml setidle.xml Log: parameter initializer fixed (removed equal sign)

http://cvs.php.net/viewvc.cgi/peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/getpref.xml?r1=1.5&r2=1.6&diff_format=u Index: peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/getpref.xml diff -u peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/getpref.xml:1.5 peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/getpref.xml:1.6 --- peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/getpref.xml:1.5 Thu Oct 9 15:16:19 2008 +++ peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/getpref.xml Sat Dec 27 09:26:33 2008 @@ -6,7 +6,7 @@ </refname> <refpurpose> Get a preference. -</refpurpose> + </refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> @@ -26,9 +26,8 @@ </paramdef> <paramdef choice="opt"> bool - <parameter> - $showDefaults</parameter> - = <initializer>true</initializer> + <parameter>$showDefaults</parameter> + <initializer>true</initializer> </paramdef> </funcprototype> </funcsynopsis> @@ -90,4 +89,4 @@ &title.note; &note.notstatic; </refsection> -</refentry> +</refentry> \ No newline at end of file http://cvs.php.net/viewvc.cgi/peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/setreturndefaults.xml?r1=1.5&r2=1.6&diff_format=u Index: peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/setreturndefaults.xml diff -u peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/setreturndefaults.xml:1.5 peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/setreturndefaults.xml:1.6 --- peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/setreturndefaults.xml:1.5 Thu Oct 9 15:16:19 2008 +++ peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/setreturndefaults.xml Sat Dec 27 09:26:33 2008 @@ -18,9 +18,8 @@ </funcdef> <paramdef choice="opt"> mixed - <parameter> - $returnDefaults</parameter> - = <initializer>true</initializer> + <parameter>$returnDefaults</parameter> + <initializer>true</initializer> </paramdef> </funcprototype> </funcsynopsis> @@ -58,4 +57,4 @@ <link linkend="package.authentication.auth-prefmanager.auth-prefmanager.getdefaultpref"><function>getDefaultPref</function></link> will always return the default value. </para> </refsection> -</refentry> +</refentry> \ No newline at end of file http://cvs.php.net/viewvc.cgi/peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/usecache.xml?r1=1.5&r2=1.6&diff_format=u Index: peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/usecache.xml diff -u peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/usecache.xml:1.5 peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/usecache.xml:1.6 --- peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/usecache.xml:1.5 Thu Oct 9 15:16:20 2008 +++ peardoc/en/package/authentication/auth-prefmanager/auth-prefmanager/usecache.xml Sat Dec 27 09:26:33 2008 @@ -16,9 +16,8 @@ </funcdef> <paramdef choice="opt"> bool - <parameter> - $use</parameter> - = <initializer>true</initializer> + <parameter>$use</parameter> + <initializer>true</initializer> </paramdef> </funcprototype> </funcsynopsis> @@ -56,4 +55,4 @@ &title.note; &note.notstatic; </refsection> -</refentry> +</refentry> \ No newline at end of file http://cvs.php.net/viewvc.cgi/peardoc/en/package/authentication/auth/auth/auth.xml?r1=1.18&r2=1.19&diff_format=u Index: peardoc/en/package/authentication/auth/auth/auth.xml diff -u peardoc/en/package/authentication/auth/auth/auth.xml:1.18 peardoc/en/package/authentication/auth/auth/auth.xml:1.19 --- peardoc/en/package/authentication/auth/auth/auth.xml:1.18 Thu Oct 9 15:16:19 2008 +++ peardoc/en/package/authentication/auth/auth/auth.xml Sat Dec 27 09:26:33 2008 @@ -12,7 +12,8 @@ <paramdef choice="opt">mixed <parameter>$options = ""</parameter></paramdef> <paramdef choice="opt">string <parameter>$loginFunction = ""</parameter></paramdef> <paramdef choice="opt">boolean <parameter>$showLogin</parameter> - = <initializer>true</initializer></paramdef> + <initializer>true</initializer> + </paramdef> </funcprototype> </funcsynopsis> @@ -20,7 +21,7 @@ <refsection xml:id="package.authentication.auth.auth.auth.desc"> &title.desc; <para> - Constructor for the authentication system. + Constructor for the authentication system. </para> <para> The constructor will ensure that the PHP session management is started by @@ -52,7 +53,7 @@ <listitem> <para> Array containing the options for both Auth itself and the storage - driver. See + driver. See <link linkend="package.authentication.auth.intro-options"> Auth Options </link> @@ -70,7 +71,7 @@ <para> The name of a user-defined function that prints the login screen. This function is passed three parameters - when called $username, $status, &amp;$auth. + when called $username, $status, &amp;$auth. These are in order the previously attempted username, the status code that caused the previous auth attempt to fail and a reference to the Auth object @@ -107,7 +108,7 @@ <refsection xml:id="package.authentication.auth.auth.auth.example"> &title.example; <example><info><title>Using different DB parameters</title></info> - + <programlisting role="php"> <![CDATA[ <?php @@ -153,11 +154,11 @@ </para> </refsection> - + <refsection xml:id="package.authentication.auth.auth.auth.example-customcont"> &title.example; <example><info><title>Using different DB parameters</title></info> - + <programlisting role="php"> <![CDATA[ <?php @@ -181,20 +182,20 @@ </example> <para> - This example shows you how you can pass your + This example shows you how you can pass your own storage container to Auth. </para> <para> - If the storage containers supplied with Auth are not capable - of fulfilling your requirements, you can easliy create your own + If the storage containers supplied with Auth are not capable + of fulfilling your requirements, you can easliy create your own storage container. Read the storage containers section for more info <link linkend="package.authentication.auth.intro-storage"> Introduction - The storage drivers </link> - + </para> </refsection> - - </refentry> + + </refentry> \ No newline at end of file http://cvs.php.net/viewvc.cgi/peardoc/en/package/authentication/auth/auth/setexpire.xml?r1=1.7&r2=1.8&diff_format=u Index: peardoc/en/package/authentication/auth/auth/setexpire.xml diff -u peardoc/en/package/authentication/auth/auth/setexpire.xml:1.7 peardoc/en/package/authentication/auth/auth/setexpire.xml:1.8 --- peardoc/en/package/authentication/auth/auth/setexpire.xml:1.7 Thu Oct 9 15:16:19 2008 +++ peardoc/en/package/authentication/auth/auth/setexpire.xml Sat Dec 27 09:26:33 2008 @@ -10,7 +10,8 @@ <funcdef>void <function>Auth::setExpire</function></funcdef> <paramdef choice="req">integer <parameter>$time</parameter></paramdef> <paramdef choice="opt">boolean <parameter>$add</parameter> - = <initializer>false</initializer></paramdef> + <initializer>false</initializer> + </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -20,7 +21,7 @@ With this function you can set the maximum expire time that is used by auth to a new value. </para> - </refsection> + </refsection> <refsection xml:id="package.authentication.auth.auth.setexpire.parameter"> &title.param; <para> @@ -32,7 +33,7 @@ </term> <listitem> <para> - expiration time, + expiration time, number of seconds </para> </listitem> @@ -44,7 +45,7 @@ </term> <listitem> <para> - if &true; <parameter>$time</parameter> + if &true; <parameter>$time</parameter> is added to the existing expiration time, if &false; the exitsing time value will be replaced. </para> @@ -52,7 +53,7 @@ </varlistentry> </variablelist> </para> - </refsection> + </refsection> <refsection xml:id="package.authentication.auth.auth.setexpire.note"> &title.note; &note.notstatic; @@ -64,4 +65,4 @@ expires. </para> </refsection> - </refentry> + </refentry> \ No newline at end of file http://cvs.php.net/viewvc.cgi/peardoc/en/package/authentication/auth/auth/setidle.xml?r1=1.3&r2=1.4&diff_format=u Index: peardoc/en/package/authentication/auth/auth/setidle.xml diff -u peardoc/en/package/authentication/auth/auth/setidle.xml:1.3 peardoc/en/package/authentication/auth/auth/setidle.xml:1.4 --- peardoc/en/package/authentication/auth/auth/setidle.xml:1.3 Thu Oct 9 15:16:19 2008 +++ peardoc/en/package/authentication/auth/auth/setidle.xml Sat Dec 27 09:26:33 2008 @@ -10,7 +10,8 @@ <funcdef>void <function>Auth::setIdle</function></funcdef> <paramdef choice="req">integer <parameter>$time</parameter></paramdef> <paramdef choice="opt">boolean <parameter>$add</parameter> - = <initializer>false</initializer></paramdef> + <initializer>false</initializer> + </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -24,7 +25,7 @@ out. If on the other hand the user performs any action within the maximum idle time interval, the idle time is reset. </para> - </refsection> + </refsection> <refsection xml:id="package.authentication.auth.auth.setidle.parameter"> &title.param; <para> @@ -39,7 +40,7 @@ idle time in seconds </para> </listitem> - </varlistentry> + </varlistentry> <varlistentry> <term> &type.bool; @@ -47,7 +48,7 @@ </term> <listitem> <para> - if &true; <parameter>$time</parameter> + if &true; <parameter>$time</parameter> is added to the existing idle time, if &false; the existing time value will be replaced. </para> @@ -60,4 +61,4 @@ &title.note; &note.notstatic; </refsection> -</refentry> +</refentry> \ No newline at end of file
« previous php.pear.doc (#11346) next »