1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
<?php
/**
* ChoiceFormat class file.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the BSD License.
*
* Copyright(c) 2004 by Qiang Xue. All rights reserved.
*
* To contact the author write to {@link mailto:qiang.xue@gmail.com Qiang Xue}
* The latest version of PRADO can be obtained from:
* {@link http://prado.sourceforge.net/}
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @package Prado\I18N\core
*/
namespace Prado\I18N\core;
/**
* ChoiceFormat class.
*
* ChoiceFormat converts between ranges of numeric values and string
* names for those ranges.
*
* A ChoiceFormat splits the real number line -Inf to +Inf into two or
* more contiguous ranges. Each range is mapped to a string.
* ChoiceFormat is generally used in a MessageFormat for displaying
* grammatically correct plurals such as "There are 2 files."
*
* <code>
* $string = '[0] are no files |[1] is one file |(1,Inf] are {number} files';
*
* $formatter = new MessageFormat(...); //init for a source
* $translated = $formatter->format($string);
*
* $choice = new ChoiceFormat();
* echo $choice->format($translated, 0); //shows "are no files"
* </code>
*
* The message/string choices are separated by the pipe "|" followed
* by a set notation of the form
* # <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><</tt> -- less than.
* # <tt><=</tt> -- less than equals.
* # <tt>></tt> -- greater than.
* # <tt>>=</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>&</tt> -- conditional AND.
* # <tt>&&</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>
* @package Prado\I18N\core
*/
class ChoiceFormat
{
/**
* The pattern to validate a set notation
* @var string
*/
protected $validate = '/[\(\[\{]|[-Inf\d:\s]+|,|[\+Inf\d\s:\?\-=!><%\|&\(\)]+|[\)\]\}]/ms';
/**
* The pattern to parse the formatting string.
* @var string
*/
protected $parse = '/\s*\|?([\(\[\{]([-Inf\d:\s]+,?[\+Inf\d\s:\?\-=!><%\|&\(\)]*)+[\)\]\}])\s*/';
/**
* The value for positive infinity.
* @var float
*/
protected $inf;
/**
* Constructor.
*/
function __construct()
{
$this->inf = -log(0);
}
/**
* Determine if the given number belongs to a given set
* @param float the number to test.
* @param string the set, in set notation.
* @return boolean true if number is in the set, false otherwise.
*/
function isValid($number, $set)
{
$n = preg_match_all($this->validate,$set,$matches,PREG_SET_ORDER);
if($n < 3) throw new Exception("Invalid set \"{$set}\"");
if(preg_match('/\{\s*n:([^\}]+)\}/', $set, $def))
{
return $this->isValidSetNotation($number, $def[1]);
}
$leftBracket = $matches[0][0];
$rightBracket = $matches[$n-1][0];
$i = 0;
$elements = array();
foreach($matches as $match)
{
$string = $match[0];
if($i != 0 && $i != $n-1 && $string !== ',')
{
if($string == '-Inf')
$elements[] = -1*$this->inf;
else if ($string == '+Inf' || $string == 'Inf')
$elements[] = $this->inf;
else
$elements[] = floatval($string);
}
$i++;
}
$total = count($elements);
$number = floatval($number);
if($leftBracket == '{' && $rightBracket == '}')
return in_array($number, $elements);
$left = false;
if($leftBracket == '[')
$left = $number >= $elements[0];
else if ($leftBracket == '(')
$left = $number > $elements[0];
$right = false;
if($rightBracket==']')
$right = $number <= $elements[$total-1];
else if($rightBracket == ')')
$right = $number < $elements[$total-1];
if($left && $right) return true;
return false;
}
protected function isValidSetNotation($number, $set)
{
$str = '$result = '.str_replace('n', '$number', $set).';';
try
{
eval($str);
return $result;
}
catch(Exception $e)
{
return false;
}
}
/**
* Parse a choice string and get a list of sets and a list of strings
* corresponding to the sets.
* @param string the string containing the choices
* @return array array($sets, $strings)
*/
function parse($string)
{
$n = preg_match_all($this->parse,$string,$matches, PREG_OFFSET_CAPTURE);
$sets = array();
foreach($matches[1] as $match)
$sets[] = $match[0];
$offset = $matches[0];
$strings = array();
for($i = 0; $i < $n; $i++)
{
$len = strlen($offset[$i][0]);
$begin = $i == 0? $len : $offset[$i][1] + $len;
$end = $i == $n-1 ? strlen($string) : $offset[$i+1][1];
$strings[] = substr($string, $begin, $end - $begin);
}
return array($sets, $strings);
}
/**
* For the choice string, and a number, find and return the
* string that satisfied the set within the choices.
* @param string the choices string.
* @param float the number to test.
* @return string the choosen string.
*/
public function format($string, $number)
{
list($sets, $strings) = $this->parse($string);
$total = count($sets);
for($i = 0; $i < $total; $i++)
{
if($this->isValid($number, $sets[$i]))
return $strings[$i];
}
return false;
}
}
|
