Browse Source

[GENERIC] Manual:

- added section for supported options

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@21238 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 16 years ago
parent
commit
be58610494

+ 33 - 0
documentation/manual/en/module_specs/Zend_Validate-Barcode.xml

@@ -350,6 +350,39 @@
         </listitem>
     </itemizedlist>
 
+    <sect3 id="zend.validate.set.barcode.options">
+        <title>Supported options for Zend_Validate_Barcode</title>
+
+        <para>
+            The following options are supported for <classname>Zend_Validate_Barcode</classname>:
+        </para>
+
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <emphasis><property>adapter</property></emphasis>: Sets the barcode adapter
+                    which will be used. Supported are all above noted adapters. When using a self
+                    defined adapter, then you have to set the complete classname.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <emphasis><property>checksum</property></emphasis>: <constant>TRUE</constant>
+                    when the barcode should contain a checksum. The default value depends on the
+                    used adapter. Note that some adapters don't allow to set this option.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <emphasis><property>options</property></emphasis>: Defines optional options for
+                    a self written adapters.
+                </para>
+            </listitem>
+        </itemizedlist>
+    </sect3>
+
     <sect3 id="zend.validate.set.barcode.basic">
         <title>Basic usage</title>
 

+ 24 - 0
documentation/manual/en/module_specs/Zend_Validate-Callback.xml

@@ -8,6 +8,30 @@
         validate a given value.
     </para>
 
+    <sect3 id="zend.validate.set.callback.options">
+        <title>Supported options for Zend_Validate_Callback</title>
+
+        <para>
+            The following options are supported for <classname>Zend_Validate_Callback</classname>:
+        </para>
+
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <emphasis><property>callback</property></emphasis>: Sets the callback which will
+                    be called for the validation.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <emphasis><property>options</property></emphasis>: Sets the additional options
+                    which will be given to the callback.
+                </para>
+            </listitem>
+        </itemizedlist>
+    </sect3>
+
     <sect3 id="zend.validate.set.callback.basic">
         <title>Basic usage</title>
 

+ 24 - 0
documentation/manual/en/module_specs/Zend_Validate-CreditCard.xml

@@ -99,6 +99,30 @@
         </para>
     </note>
 
+    <sect3 id="zend.validate.set.creditcard.options">
+        <title>Supported options for Zend_Validate_CreditCard</title>
+
+        <para>
+            The following options are supported for <classname>Zend_Validate_CreditCard</classname>:
+        </para>
+
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <emphasis><property>service</property></emphasis>: A callback to an online
+                    service which will additionally be used for the validation.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <emphasis><property>type</property></emphasis>: The type of creditcard which
+                    will be validated. See the below list of institutes for details.
+                </para>
+            </listitem>
+        </itemizedlist>
+    </sect3>
+
     <sect3 id="zend.validate.set.creditcard.basic">
         <title>Basic usage</title>