From f873d44ded59647cbf6a639389793806c1969c5b Mon Sep 17 00:00:00 2001
From: thomas <thomas@44c647ce-9c0f-0410-b52a-842ac1e357ba>
Date: Wed, 28 Apr 2010 19:23:47 +0000
Subject: [PATCH] [ZF-8972] Zend_Validate:

- added section for Zend_Validate_Float

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@22040 44c647ce-9c0f-0410-b52a-842ac1e357ba
---
 .../manual/en/module_specs/Zend_Validate-Float.xml | 85 ++++++++++++++++++++++
 .../manual/en/module_specs/Zend_Validate-Set.xml   | 14 +---
 2 files changed, 86 insertions(+), 13 deletions(-)
 create mode 100644 documentation/manual/en/module_specs/Zend_Validate-Float.xml

diff --git a/documentation/manual/en/module_specs/Zend_Validate-Float.xml b/documentation/manual/en/module_specs/Zend_Validate-Float.xml
new file mode 100644
index 000000000..334807ddb
--- /dev/null
+++ b/documentation/manual/en/module_specs/Zend_Validate-Float.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Reviewed: no -->
+<sect2 id="zend.validate.set.float">
+    <title>Float</title>
+
+    <para>
+        <classname>Zend_Validate_Float</classname> allows you to validate if a given value contains
+        a floating-point value. This validator validates also localized input.
+    </para>
+
+    <sect3 id="zend.validate.set.float.options">
+        <title>Supported options for Zend_Validate_Float</title>
+
+        <para>
+            The following options are supported for <classname>Zend_Validate_Float</classname>:
+        </para>
+
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <emphasis><property>locale</property></emphasis>: Sets the locale which will be
+                    used to validate localized float values.
+                </para>
+            </listitem>
+        </itemizedlist>
+    </sect3>
+
+    <sect3 id="zend.validate.set.float.basic">
+        <title>Simple float validation</title>
+
+        <para>
+            The simplest way to validate a float is by using the system settings. When no option
+            is used, the environment locale is used for validation:
+        </para>
+
+        <programlisting language="php"><![CDATA[
+$validator = new Zend_Validate_Float();
+
+$validator->isValid(1234.5);   // returns true
+$validator->isValid('10a01'); // returns false
+$validator->isValid('1,234.5'); // returns true
+]]></programlisting>
+
+        <para>
+            In the above example we expected that our environment is set to "en" as locale.
+        </para>
+    </sect3>
+
+    <sect3 id="zend.validate.set.float.localized">
+        <title>Localized float validation</title>
+
+        <para>
+            Often it's useful to be able to validate also localized values. Float values are often
+            written different in other countries. For example using english you will write "1.5".
+            In german you may write "1,5" and in other languages you may use grouping.
+        </para>
+
+        <para>
+            <classname>Zend_Validate_Float</classname> is able to validate such notations. But it is
+            limited to the locale you set. See the following code:
+        </para>
+
+        <programlisting language="php"><![CDATA[
+$validator = new Zend_Validate_Float(array('locale' => 'de'));
+
+$validator->isValid(1234.5); // returns true
+$validator->isValid("1 234,5"); // returns false
+$validator->isValid("1.234"); // returns true
+]]></programlisting>
+
+        <para>
+            As you can see, by using a locale, your input is validated localized. Using a different
+            notation you get a <constant>FALSE</constant> when the locale forces a different
+            notation.
+        </para>
+
+        <para>
+            The locale can also be set afterwards by using <methodname>setLocale()</methodname> and
+            retrieved by using <methodname>getLocale()</methodname>.
+        </para>
+    </sect3>
+</sect2>
+<!--
+vim:se ts=4 sw=4 et:
+-->
diff --git a/documentation/manual/en/module_specs/Zend_Validate-Set.xml b/documentation/manual/en/module_specs/Zend_Validate-Set.xml
index 3523a9f6a..06d567a4a 100644
--- a/documentation/manual/en/module_specs/Zend_Validate-Set.xml
+++ b/documentation/manual/en/module_specs/Zend_Validate-Set.xml
@@ -43,19 +43,7 @@
     <xi:include href="Zend_Validate-Db.xml" />
     <xi:include href="Zend_Validate-Digits.xml" />
     <xi:include href="Zend_Validate-EmailAddress.xml" />
-
-    <sect2 id="zend.validate.set.float">
-        <title>Float</title>
-
-        <para>
-            Returns <constant>TRUE</constant> if and only if <varname>$value</varname> is a
-            floating-point value. Since Zend Framework 1.8 this validator takes into account the
-            actual locale from browser, environment or application wide set locale. You can of
-            course use the get/setLocale accessors to change the used locale or give it while
-            creating a instance of this validator.
-        </para>
-    </sect2>
-
+    <xi:include href="Zend_Validate-Float.xml" />
     <xi:include href="Zend_Validate-GreaterThan.xml" />
     <xi:include href="Zend_Validate-Hex.xml" />
     <xi:include href="Zend_Validate-Hostname.xml" />
-- 
2.11.4.GIT