svn: /pear/peardoc/trunk/en/package/authentication/auth/auth/ setadvancedsecurity.xml

cweiske                                  Wed, 14 Oct 2009 21:07:44 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=289645

Log:
fix Bug #14392: setAdvancedSecurity documentation

Bug: http://pear.php.net/bugs/14392 (unknown) 
      
Changed paths:
    U   pear/peardoc/trunk/en/package/authentication/auth/auth/setadvancedsecurity.xml

Modified: pear/peardoc/trunk/en/package/authentication/auth/auth/setadvancedsecurity.xml
===================================================================
--- pear/peardoc/trunk/en/package/authentication/auth/auth/setadvancedsecurity.xml	2009-10-14 21:06:47 UTC (rev 289644)
+++ pear/peardoc/trunk/en/package/authentication/auth/auth/setadvancedsecurity.xml	2009-10-14 21:07:44 UTC (rev 289645)
@@ -8,7 +8,7 @@
    <funcsynopsis>
     <funcprototype>
      <funcdef>void <function>Auth::setAdvancedSecurity</function></funcdef>
-     <paramdef choice="opt">bool <parameter>$flag = true</parameter></paramdef>
+     <paramdef choice="opt">mixed <parameter>$flag = true</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    </refsynopsisdiv>
@@ -59,13 +59,24 @@
      <variablelist>
       <varlistentry>
        <term>
-        &type.bool;
+        &type.mixed;
         <parameter>$flag</parameter>
        </term>
        <listitem>
         <para>
          &true; if you want to enable advanced security features &false; if you want to disable them.
         </para>
+        <para>
+         You also may pass an array if you want to fine-tune security options.
+         &true; means the following:
+        </para>
+        <programlisting role="php"><![CDATA[
+array(
+    AUTH_ADV_USERAGENT => true,
+    AUTH_ADV_IPCHECK   => true,
+    AUTH_ADV_CHALLENGE => true
+);
+]]></programlisting>
        </listitem>
       </varlistentry>
      </variablelist>