From d88930d23f712f9b9da279f32ee689e6d719f13b Mon Sep 17 00:00:00 2001
From: wei <>
Date: Fri, 15 Feb 2008 01:09:36 +0000
Subject: update docs on TChoiceFormat

---
 framework/I18N/TChoiceFormat.php     | 24 +++++++++++++++++++++++-
 framework/I18N/core/ChoiceFormat.php | 33 ++++++++++++++++++++++++++++-----
 2 files changed, 51 insertions(+), 6 deletions(-)

(limited to 'framework')

diff --git a/framework/I18N/TChoiceFormat.php b/framework/I18N/TChoiceFormat.php
index bf646c31..eeca3541 100644
--- a/framework/I18N/TChoiceFormat.php
+++ b/framework/I18N/TChoiceFormat.php
@@ -47,6 +47,28 @@ Prado::using('System.I18N.TTranslate');
  * Properties
  * - <b>Value</b>, float,
  *   <br>Gets or sets the Value that determines which string choice to display.
+ * Since version 3.1.2 the following set notation is also possible.
+ *
+ *  # <tt>{n: n % 10 > 1 && n % 10 < 5}</tt> --  matches numbers like 2, 3, 4, 22, 23, 24
+ *
+ * Where set is defined by the expression after <tt>n:</tt>. In particular, the expression
+ * accepts the following mathematical/logical operators to form a set of logical conditions
+ * on the value given by <tt>n</tt>:
+ *   # <tt>&lt;</tt> -- less than.
+ *   # <tt>&lt;=</tt> -- less than equals.
+ *   # <tt>&gt;</tt> -- greater than.
+ *   # <tt>&gt=</tt> -- greater than equals.
+ *   # <tt>==</tt> -- of equal value.
+ *   # <tt>%</tt> -- modulo, e.g., 1 % 10 equals 1, 11 % 10 equals 1.
+ *   # <tt>-</tt> -- minus, negative.
+ *   # <tt>+</tt> -- addition.
+ *   # <tt>&amp;</tt> -- conditional AND.
+ *   # <tt>&amp;&amp;</tt> -- condition AND with short circuit.
+ *   # <tt>|</tt> -- conditional OR.
+ *   # <tt>||</tt> -- conditional OR with short circuit. 
+ *   # <tt>!</tt> -- negation.
+ *
+ * Additional round brackets can also be used to perform grouping.
  *
  * @author Xiang Wei Zhuo <weizhuo[at]gmail[dot]com>
  * @version v1.0, last update on Fri Dec 24 21:38:49 EST 2004
@@ -86,4 +108,4 @@ class TChoiceFormat extends TTranslate
 			return strtr($string, array('{Value}'=> $value));
 	}
 }
-?>
\ No newline at end of file
+?>
diff --git a/framework/I18N/core/ChoiceFormat.php b/framework/I18N/core/ChoiceFormat.php
index d36ab57b..b8eb69f0 100644
--- a/framework/I18N/core/ChoiceFormat.php
+++ b/framework/I18N/core/ChoiceFormat.php
@@ -41,14 +41,37 @@
  *
  * The message/string choices are separated by the pipe "|" followed
  * by a set notation of the form
- *  # <t>[1,2]</t> -- accepts values between 1 and 2, inclusive.
- *  # <t>(1,2)</t> -- accepts values between 1 and 2, excluding 1 and 2.
- *  # <t>{1,2,3,4}</t> -- only values defined in the set are accepted.
- *  # <t>[-Inf,0)</t> -- accepts value greater or equal to negative infinity
+ *  # <tt>[1,2]</tt> -- accepts values between 1 and 2, inclusive.
+ *  # <tt>(1,2)</tt> -- accepts values between 1 and 2, excluding 1 and 2.
+ *  # <tt>{1,2,3,4}</tt> -- only values defined in the set are accepted.
+ *  # <tt>[-Inf,0)</tt> -- accepts value greater or equal to negative infinity
  *                       and strictly less than 0
  * Any non-empty combinations of the delimiters of square and round brackets
  * are acceptable.
  *
+ * Since version 3.1.2 the following set notation is also possible.
+ *
+ *  # <tt>{n: n % 10 > 1 && n % 10 < 5}</tt> --  matches numbers like 2, 3, 4, 22, 23, 24
+ *
+ * Where set is defined by the expression after <tt>n:</tt>. In particular, the expression
+ * accepts the following mathematical/logical operators to form a set of logical conditions
+ * on the value given by <tt>n</tt>:
+ *   # <tt>&lt;</tt> -- less than.
+ *   # <tt>&lt;=</tt> -- less than equals.
+ *   # <tt>&gt;</tt> -- greater than.
+ *   # <tt>&gt=</tt> -- greater than equals.
+ *   # <tt>==</tt> -- of equal value.
+ *   # <tt>%</tt> -- modulo, e.g., 1 % 10 equals 1, 11 % 10 equals 1.
+ *   # <tt>-</tt> -- minus, negative.
+ *   # <tt>+</tt> -- addition.
+ *   # <tt>&amp;</tt> -- conditional AND.
+ *   # <tt>&amp;&amp;</tt> -- condition AND with short circuit.
+ *   # <tt>|</tt> -- conditional OR.
+ *   # <tt>||</tt> -- conditional OR with short circuit. 
+ *   # <tt>!</tt> -- negation.
+ *
+ * Additional round brackets can also be used to perform grouping.
+ *
  * @author Xiang Wei Zhuo <weizhuo[at]gmail[dot]com>
  * @version v1.0, last update on Fri Dec 24 20:46:16 EST 2004
  * @package System.I18N.core
@@ -200,4 +223,4 @@ class ChoiceFormat
 	}
 }
 
-?>
\ No newline at end of file
+?>
-- 
cgit v1.2.3