1 | <?php |
2 | /** |
3 | * Date and Time Locale object |
4 | * |
5 | * @package WordPress |
6 | * @subpackage i18n |
7 | */ |
8 | |
9 | /** |
10 | * Class that loads the calendar locale. |
11 | * |
12 | * @since 2.1.0 |
13 | */ |
14 | class WP_Locale { |
15 | /** |
16 | * Stores the translated strings for the full weekday names. |
17 | * |
18 | * @since 2.1.0 |
19 | * @var array |
20 | * @access private |
21 | */ |
22 | var $weekday; |
23 | |
24 | /** |
25 | * Stores the translated strings for the one character weekday names. |
26 | * |
27 | * There is a hack to make sure that Tuesday and Thursday, as well |
28 | * as Sunday and Saturday don't conflict. See init() method for more. |
29 | * |
30 | * @see WP_Locale::init() for how to handle the hack. |
31 | * |
32 | * @since 2.1.0 |
33 | * @var array |
34 | * @access private |
35 | */ |
36 | var $weekday_initial; |
37 | |
38 | /** |
39 | * Stores the translated strings for the abbreviated weekday names. |
40 | * |
41 | * @since 2.1.0 |
42 | * @var array |
43 | * @access private |
44 | */ |
45 | var $weekday_abbrev; |
46 | |
47 | /** |
48 | * Stores the translated strings for the full month names. |
49 | * |
50 | * @since 2.1.0 |
51 | * @var array |
52 | * @access private |
53 | */ |
54 | var $month; |
55 | |
56 | /** |
57 | * Stores the translated strings for the abbreviated month names. |
58 | * |
59 | * @since 2.1.0 |
60 | * @var array |
61 | * @access private |
62 | */ |
63 | var $month_abbrev; |
64 | |
65 | /** |
66 | * Stores the translated strings for 'am' and 'pm'. |
67 | * |
68 | * Also the capalized versions. |
69 | * |
70 | * @since 2.1.0 |
71 | * @var array |
72 | * @access private |
73 | */ |
74 | var $meridiem; |
75 | |
76 | /** |
77 | * The text direction of the locale language. |
78 | * |
79 | * Default is left to right 'ltr'. |
80 | * |
81 | * @since 2.1.0 |
82 | * @var string |
83 | * @access private |
84 | */ |
85 | var $text_direction = 'ltr'; |
86 | |
87 | /** |
88 | * Imports the global version to the class property. |
89 | * |
90 | * @since 2.1.0 |
91 | * @var array |
92 | * @access private |
93 | */ |
94 | var $locale_vars = array('text_direction'); |
95 | |
96 | /** |
97 | * Sets up the translated strings and object properties. |
98 | * |
99 | * The method creates the translatable strings for various |
100 | * calendar elements. Which allows for specifying locale |
101 | * specific calendar names and text direction. |
102 | * |
103 | * @since 2.1.0 |
104 | * @access private |
105 | */ |
106 | function init() { |
107 | // The Weekdays |
108 | $this->weekday[0] = /* translators: weekday */ __('Sunday'); |
109 | $this->weekday[1] = /* translators: weekday */ __('Monday'); |
110 | $this->weekday[2] = /* translators: weekday */ __('Tuesday'); |
111 | $this->weekday[3] = /* translators: weekday */ __('Wednesday'); |
112 | $this->weekday[4] = /* translators: weekday */ __('Thursday'); |
113 | $this->weekday[5] = /* translators: weekday */ __('Friday'); |
114 | $this->weekday[6] = /* translators: weekday */ __('Saturday'); |
115 | |
116 | // The first letter of each day. The _%day%_initial suffix is a hack to make |
117 | // sure the day initials are unique. |
118 | $this->weekday_initial[__('Sunday')] = /* translators: one-letter abbreviation of the weekday */ __('S_Sunday_initial'); |
119 | $this->weekday_initial[__('Monday')] = /* translators: one-letter abbreviation of the weekday */ __('M_Monday_initial'); |
120 | $this->weekday_initial[__('Tuesday')] = /* translators: one-letter abbreviation of the weekday */ __('T_Tuesday_initial'); |
121 | $this->weekday_initial[__('Wednesday')] = /* translators: one-letter abbreviation of the weekday */ __('W_Wednesday_initial'); |
122 | $this->weekday_initial[__('Thursday')] = /* translators: one-letter abbreviation of the weekday */ __('T_Thursday_initial'); |
123 | $this->weekday_initial[__('Friday')] = /* translators: one-letter abbreviation of the weekday */ __('F_Friday_initial'); |
124 | $this->weekday_initial[__('Saturday')] = /* translators: one-letter abbreviation of the weekday */ __('S_Saturday_initial'); |
125 | |
126 | foreach ($this->weekday_initial as $weekday_ => $weekday_initial_) { |
127 | $this->weekday_initial[$weekday_] = preg_replace('/_.+_initial$/', '', $weekday_initial_); |
128 | } |
129 | |
130 | // Abbreviations for each day. |
131 | $this->weekday_abbrev[__('Sunday')] = /* translators: three-letter abbreviation of the weekday */ __('Sun'); |
132 | $this->weekday_abbrev[__('Monday')] = /* translators: three-letter abbreviation of the weekday */ __('Mon'); |
133 | $this->weekday_abbrev[__('Tuesday')] = /* translators: three-letter abbreviation of the weekday */ __('Tue'); |
134 | $this->weekday_abbrev[__('Wednesday')] = /* translators: three-letter abbreviation of the weekday */ __('Wed'); |
135 | $this->weekday_abbrev[__('Thursday')] = /* translators: three-letter abbreviation of the weekday */ __('Thu'); |
136 | $this->weekday_abbrev[__('Friday')] = /* translators: three-letter abbreviation of the weekday */ __('Fri'); |
137 | $this->weekday_abbrev[__('Saturday')] = /* translators: three-letter abbreviation of the weekday */ __('Sat'); |
138 | |
139 | // The Months |
140 | $this->month['01'] = /* translators: month name */ __('January'); |
141 | $this->month['02'] = /* translators: month name */ __('February'); |
142 | $this->month['03'] = /* translators: month name */ __('March'); |
143 | $this->month['04'] = /* translators: month name */ __('April'); |
144 | $this->month['05'] = /* translators: month name */ __('May'); |
145 | $this->month['06'] = /* translators: month name */ __('June'); |
146 | $this->month['07'] = /* translators: month name */ __('July'); |
147 | $this->month['08'] = /* translators: month name */ __('August'); |
148 | $this->month['09'] = /* translators: month name */ __('September'); |
149 | $this->month['10'] = /* translators: month name */ __('October'); |
150 | $this->month['11'] = /* translators: month name */ __('November'); |
151 | $this->month['12'] = /* translators: month name */ __('December'); |
152 | |
153 | // Abbreviations for each month. Uses the same hack as above to get around the |
154 | // 'May' duplication. |
155 | $this->month_abbrev[__('January')] = /* translators: three-letter abbreviation of the month */ __('Jan_January_abbreviation'); |
156 | $this->month_abbrev[__('February')] = /* translators: three-letter abbreviation of the month */ __('Feb_February_abbreviation'); |
157 | $this->month_abbrev[__('March')] = /* translators: three-letter abbreviation of the month */ __('Mar_March_abbreviation'); |
158 | $this->month_abbrev[__('April')] = /* translators: three-letter abbreviation of the month */ __('Apr_April_abbreviation'); |
159 | $this->month_abbrev[__('May')] = /* translators: three-letter abbreviation of the month */ __('May_May_abbreviation'); |
160 | $this->month_abbrev[__('June')] = /* translators: three-letter abbreviation of the month */ __('Jun_June_abbreviation'); |
161 | $this->month_abbrev[__('July')] = /* translators: three-letter abbreviation of the month */ __('Jul_July_abbreviation'); |
162 | $this->month_abbrev[__('August')] = /* translators: three-letter abbreviation of the month */ __('Aug_August_abbreviation'); |
163 | $this->month_abbrev[__('September')] = /* translators: three-letter abbreviation of the month */ __('Sep_September_abbreviation'); |
164 | $this->month_abbrev[__('October')] = /* translators: three-letter abbreviation of the month */ __('Oct_October_abbreviation'); |
165 | $this->month_abbrev[__('November')] = /* translators: three-letter abbreviation of the month */ __('Nov_November_abbreviation'); |
166 | $this->month_abbrev[__('December')] = /* translators: three-letter abbreviation of the month */ __('Dec_December_abbreviation'); |
167 | |
168 | foreach ($this->month_abbrev as $month_ => $month_abbrev_) { |
169 | $this->month_abbrev[$month_] = preg_replace('/_.+_abbreviation$/', '', $month_abbrev_); |
170 | } |
171 | |
172 | // The Meridiems |
173 | $this->meridiem['am'] = __('am'); |
174 | $this->meridiem['pm'] = __('pm'); |
175 | $this->meridiem['AM'] = __('AM'); |
176 | $this->meridiem['PM'] = __('PM'); |
177 | |
178 | // Numbers formatting |
179 | // See http://php.net/number_format |
180 | |
181 | /* translators: $thousands_sep argument for http://php.net/number_format, default is , */ |
182 | $trans = __('number_format_thousands_sep'); |
183 | $this->number_format['thousands_sep'] = ('number_format_thousands_sep' == $trans) ? ',' : $trans; |
184 | |
185 | /* translators: $dec_point argument for http://php.net/number_format, default is . */ |
186 | $trans = __('number_format_decimal_point'); |
187 | $this->number_format['decimal_point'] = ('number_format_decimal_point' == $trans) ? '.' : $trans; |
188 | |
189 | // Import global locale vars set during inclusion of $locale.php. |
190 | foreach ( (array) $this->locale_vars as $var ) { |
191 | if ( isset($GLOBALS[$var]) ) |
192 | $this->$var = $GLOBALS[$var]; |
193 | } |
194 | |
195 | } |
196 | |
197 | /** |
198 | * Retrieve the full translated weekday word. |
199 | * |
200 | * Week starts on translated Sunday and can be fetched |
201 | * by using 0 (zero). So the week starts with 0 (zero) |
202 | * and ends on Saturday with is fetched by using 6 (six). |
203 | * |
204 | * @since 2.1.0 |
205 | * @access public |
206 | * |
207 | * @param int $weekday_number 0 for Sunday through 6 Saturday |
208 | * @return string Full translated weekday |
209 | */ |
210 | function get_weekday($weekday_number) { |
211 | return $this->weekday[$weekday_number]; |
212 | } |
213 | |
214 | /** |
215 | * Retrieve the translated weekday initial. |
216 | * |
217 | * The weekday initial is retrieved by the translated |
218 | * full weekday word. When translating the weekday initial |
219 | * pay attention to make sure that the starting letter does |
220 | * not conflict. |
221 | * |
222 | * @since 2.1.0 |
223 | * @access public |
224 | * |
225 | * @param string $weekday_name |
226 | * @return string |
227 | */ |
228 | function get_weekday_initial($weekday_name) { |
229 | return $this->weekday_initial[$weekday_name]; |
230 | } |
231 | |
232 | /** |
233 | * Retrieve the translated weekday abbreviation. |
234 | * |
235 | * The weekday abbreviation is retrieved by the translated |
236 | * full weekday word. |
237 | * |
238 | * @since 2.1.0 |
239 | * @access public |
240 | * |
241 | * @param string $weekday_name Full translated weekday word |
242 | * @return string Translated weekday abbreviation |
243 | */ |
244 | function get_weekday_abbrev($weekday_name) { |
245 | return $this->weekday_abbrev[$weekday_name]; |
246 | } |
247 | |
248 | /** |
249 | * Retrieve the full translated month by month number. |
250 | * |
251 | * The $month_number parameter has to be a string |
252 | * because it must have the '0' in front of any number |
253 | * that is less than 10. Starts from '01' and ends at |
254 | * '12'. |
255 | * |
256 | * You can use an integer instead and it will add the |
257 | * '0' before the numbers less than 10 for you. |
258 | * |
259 | * @since 2.1.0 |
260 | * @access public |
261 | * |
262 | * @param string|int $month_number '01' through '12' |
263 | * @return string Translated full month name |
264 | */ |
265 | function get_month($month_number) { |
266 | return $this->month[zeroise($month_number, 2)]; |
267 | } |
268 | |
269 | /** |
270 | * Retrieve translated version of month abbreviation string. |
271 | * |
272 | * The $month_name parameter is expected to be the translated or |
273 | * translatable version of the month. |
274 | * |
275 | * @since 2.1.0 |
276 | * @access public |
277 | * |
278 | * @param string $month_name Translated month to get abbreviated version |
279 | * @return string Translated abbreviated month |
280 | */ |
281 | function get_month_abbrev($month_name) { |
282 | return $this->month_abbrev[$month_name]; |
283 | } |
284 | |
285 | /** |
286 | * Retrieve translated version of meridiem string. |
287 | * |
288 | * The $meridiem parameter is expected to not be translated. |
289 | * |
290 | * @since 2.1.0 |
291 | * @access public |
292 | * |
293 | * @param string $meridiem Either 'am', 'pm', 'AM', or 'PM'. Not translated version. |
294 | * @return string Translated version |
295 | */ |
296 | function get_meridiem($meridiem) { |
297 | return $this->meridiem[$meridiem]; |
298 | } |
299 | |
300 | /** |
301 | * Global variables are deprecated. For backwards compatibility only. |
302 | * |
303 | * @deprecated For backwards compatibility only. |
304 | * @access private |
305 | * |
306 | * @since 2.1.0 |
307 | */ |
308 | function register_globals() { |
309 | $GLOBALS['weekday'] = $this->weekday; |
310 | $GLOBALS['weekday_initial'] = $this->weekday_initial; |
311 | $GLOBALS['weekday_abbrev'] = $this->weekday_abbrev; |
312 | $GLOBALS['month'] = $this->month; |
313 | $GLOBALS['month_abbrev'] = $this->month_abbrev; |
314 | } |
315 | |
316 | /** |
317 | * PHP4 style constructor which calls helper methods to set up object variables |
318 | * |
319 | * @uses WP_Locale::init() |
320 | * @uses WP_Locale::register_globals() |
321 | * @since 2.1.0 |
322 | * |
323 | * @return WP_Locale |
324 | */ |
325 | function WP_Locale() { |
326 | $this->init(); |
327 | $this->register_globals(); |
328 | } |
329 | /** |
330 | * Checks if current locale is RTL. |
331 | * |
332 | * @since 3.0.0 |
333 | * @return bool Whether locale is RTL. |
334 | */ |
335 | function is_rtl() { |
336 | return 'rtl' == $this->text_direction; |
337 | } |
338 | } |
339 | |
340 | /** |
341 | * Checks if current locale is RTL. |
342 | * |
343 | * @since 3.0.0 |
344 | * @return bool Whether locale is RTL. |
345 | */ |
346 | function is_rtl() { |
347 | global $wp_locale; |
348 | return $wp_locale->is_rtl(); |
349 | } |
350 | |
351 | ?> |
352 | |