Bladeren bron

[GENERIC] Manual:

- added section for supported options

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@21241 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 16 jaren geleden
bovenliggende
commit
2badc122f1

+ 47 - 0
documentation/manual/en/module_specs/Zend_Validate-Db.xml

@@ -10,6 +10,53 @@
         value.
     </para>
 
+    <sect3 id="zend.validate.set.db.options">
+        <title>Supported options for Zend_Validate_Db_*</title>
+
+        <para>
+            The following options are supported for
+            <classname>Zend_Validate_Db_NoRecordExists</classname> and
+            <classname>Zend_Validate_Db_RecordExists</classname>:
+        </para>
+
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <emphasis><property>adapter</property></emphasis>: The database adapter which
+                    will be used for the search.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <emphasis><property>exclude</property></emphasis>: Sets records which will be
+                    excluded from the search.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <emphasis><property>field</property></emphasis>: The database field within this
+                    table which will be searched for the record.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <emphasis><property>schema</property></emphasis>: Sets the schema which will be
+                    used for the search.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <emphasis><property>table</property></emphasis>: The table which will be
+                    searched for the record.
+                </para>
+            </listitem>
+        </itemizedlist>
+    </sect3>
+
     <sect3 id="zend.validate.db.basic-usage">
         <title>Basic usage</title>
 

+ 20 - 19
documentation/manual/en/module_specs/Zend_Validate-EmailAddress.xml

@@ -47,10 +47,10 @@ if ($validator->isValid($email)) {
         <itemizedlist>
             <listitem>
                 <para>
-                    <emphasis>allow</emphasis>: Defines which type of domain names are accepted.
-                    This option is used in conjunction with the hostname option to set the
-                    hostname validator. For more informations about possible values of this
-                    option, look at <link linkend="zend.validate.set.hostname">Hostname</link>
+                    <emphasis><property>allow</property></emphasis>: Defines which type of domain
+                    names are accepted. This option is used in conjunction with the hostname option
+                    to set the hostname validator. For more informations about possible values of
+                    this option, look at <link linkend="zend.validate.set.hostname">Hostname</link>
                     and possible <constant>ALLOW</constant>* constants. This option defaults to
                     <constant>ALLOW_DNS</constant>.
                 </para>
@@ -58,36 +58,37 @@ if ($validator->isValid($email)) {
 
             <listitem>
                 <para>
-                    <emphasis>hostname</emphasis>: Sets the hostname validator with which the
-                    domain part of the email address will be validated.
+                    <emphasis><property>deep</property></emphasis>: Defines if the servers MX
+                    records should be verified by a deep check. When this option is set to
+                    <constant>TRUE</constant> then additionally to MX records also the A, A6 and
+                    <constant>AAAA</constant> records are used to verify if the server accepts
+                    emails. This option defaults to <constant>FALSE</constant>.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <emphasis>mx</emphasis>: Defines if the MX records from the server should be
-                    detected. If this option is defined to <constant>TRUE</constant> then the MX
-                    records are used to verify if the server
-                    accepts emails. This option defaults to <constant>FALSE</constant>.
+                    <emphasis><property>domain</property></emphasis>: Defines if the domain part
+                    should be checked. When this option is set to <constant>FALSE</constant>, then
+                    only the local part of the email address will be checked. In this case the
+                    hostname validator will not be called. This option defaults to
+                    <constant>TRUE</constant>.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <emphasis>deep</emphasis>: Defines if the servers MX records should be verified
-                    by a deep check. When this option is set to <constant>TRUE</constant> then
-                    additionally to MX records also the A, A6 and <constant>AAAA</constant> records
-                    are used to verify if the server accepts emails. This option defaults to
-                    <constant>FALSE</constant>.
+                    <emphasis><property>hostname</property></emphasis>: Sets the hostname validator
+                    with which the domain part of the email address will be validated.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <emphasis>domain</emphasis>: Defines if the domain part should be checked.
-                    When this option is set to <constant>FALSE</constant>, then only the local part
-                    of the email address will be checked. In this case the hostname validator will
-                    not be called. This option defaults to <constant>TRUE</constant>.
+                    <emphasis><property>mx</property></emphasis>: Defines if the MX records from the
+                    server should be detected. If this option is defined to
+                    <constant>TRUE</constant> then the MX records are used to verify if the server
+                    accepts emails. This option defaults to <constant>FALSE</constant>.
                 </para>
             </listitem>
         </itemizedlist>

+ 8 - 0
documentation/manual/en/module_specs/Zend_Validate-Hex.xml

@@ -27,6 +27,14 @@ if ($validator->isValid('123ABC')) {
             unicode zeros and numbers from other scripts than latin will not be treaten as valid.
         </para>
     </note>
+
+    <sect3 id="zend.validate.set.hex.options">
+        <title>Supported options for Zend_Validate_Hex</title>
+
+        <para>
+            There are no additional options for <classname>Zend_Validate_Hex</classname>:
+        </para>
+    </sect3>
 </sect2>
 <!--
 vim:se ts=4 sw=4 et: