WordPress 4.4
[autoinstalls/wordpress.git] / wp-includes / locale.php
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          */
21         public $weekday;
22
23         /**
24          * Stores the translated strings for the one character weekday names.
25          *
26          * There is a hack to make sure that Tuesday and Thursday, as well
27          * as Sunday and Saturday, don't conflict. See init() method for more.
28          *
29          * @see WP_Locale::init() for how to handle the hack.
30          *
31          * @since 2.1.0
32          * @var array
33          */
34         public $weekday_initial;
35
36         /**
37          * Stores the translated strings for the abbreviated weekday names.
38          *
39          * @since 2.1.0
40          * @var array
41          */
42         public $weekday_abbrev;
43
44         /**
45          * Stores the default start of the week.
46          *
47          * @since 4.4.0
48          * @var string
49          */
50         public $start_of_week;
51
52         /**
53          * Stores the translated strings for the full month names.
54          *
55          * @since 2.1.0
56          * @var array
57          */
58         public $month;
59
60         /**
61          * Stores the translated strings for the abbreviated month names.
62          *
63          * @since 2.1.0
64          * @var array
65          */
66         public $month_abbrev;
67
68         /**
69          * Stores the translated strings for 'am' and 'pm'.
70          *
71          * Also the capitalized versions.
72          *
73          * @since 2.1.0
74          * @var array
75          */
76         public $meridiem;
77
78         /**
79          * The text direction of the locale language.
80          *
81          * Default is left to right 'ltr'.
82          *
83          * @since 2.1.0
84          * @var string
85          */
86         public $text_direction = 'ltr';
87
88         /**
89          * The thousands separator and decimal point values used for localizing numbers.
90          *
91          * @since 2.3.0
92          * @access public
93          * @var array
94          */
95         public $number_format;
96
97         /**
98          * Sets up the translated strings and object properties.
99          *
100          * The method creates the translatable strings for various
101          * calendar elements. Which allows for specifying locale
102          * specific calendar names and text direction.
103          *
104          * @since 2.1.0
105          * @access private
106          *
107          * @global string $text_direction
108          * @global string $wp_version
109          */
110         public function init() {
111                 // The Weekdays
112                 $this->weekday[0] = /* translators: weekday */ __('Sunday');
113                 $this->weekday[1] = /* translators: weekday */ __('Monday');
114                 $this->weekday[2] = /* translators: weekday */ __('Tuesday');
115                 $this->weekday[3] = /* translators: weekday */ __('Wednesday');
116                 $this->weekday[4] = /* translators: weekday */ __('Thursday');
117                 $this->weekday[5] = /* translators: weekday */ __('Friday');
118                 $this->weekday[6] = /* translators: weekday */ __('Saturday');
119
120                 // The first letter of each day.
121                 $this->weekday_initial[ __( 'Sunday' ) ]    = /* translators: one-letter abbreviation of the weekday */ _x( 'S', 'Sunday initial' );
122                 $this->weekday_initial[ __( 'Monday' ) ]    = /* translators: one-letter abbreviation of the weekday */ _x( 'M', 'Monday initial' );
123                 $this->weekday_initial[ __( 'Tuesday' ) ]   = /* translators: one-letter abbreviation of the weekday */ _x( 'T', 'Tuesday initial' );
124                 $this->weekday_initial[ __( 'Wednesday' ) ] = /* translators: one-letter abbreviation of the weekday */ _x( 'W', 'Wednesday initial' );
125                 $this->weekday_initial[ __( 'Thursday' ) ]  = /* translators: one-letter abbreviation of the weekday */ _x( 'T', 'Thursday initial' );
126                 $this->weekday_initial[ __( 'Friday' ) ]    = /* translators: one-letter abbreviation of the weekday */ _x( 'F', 'Friday initial' );
127                 $this->weekday_initial[ __( 'Saturday' ) ]  = /* translators: one-letter abbreviation of the weekday */ _x( 'S', 'Saturday initial' );
128
129                 // Abbreviations for each day.
130                 $this->weekday_abbrev[__('Sunday')]    = /* translators: three-letter abbreviation of the weekday */ __('Sun');
131                 $this->weekday_abbrev[__('Monday')]    = /* translators: three-letter abbreviation of the weekday */ __('Mon');
132                 $this->weekday_abbrev[__('Tuesday')]   = /* translators: three-letter abbreviation of the weekday */ __('Tue');
133                 $this->weekday_abbrev[__('Wednesday')] = /* translators: three-letter abbreviation of the weekday */ __('Wed');
134                 $this->weekday_abbrev[__('Thursday')]  = /* translators: three-letter abbreviation of the weekday */ __('Thu');
135                 $this->weekday_abbrev[__('Friday')]    = /* translators: three-letter abbreviation of the weekday */ __('Fri');
136                 $this->weekday_abbrev[__('Saturday')]  = /* translators: three-letter abbreviation of the weekday */ __('Sat');
137
138                 // The Months
139                 $this->month['01'] = /* translators: month name */ __( 'January' );
140                 $this->month['02'] = /* translators: month name */ __( 'February' );
141                 $this->month['03'] = /* translators: month name */ __( 'March' );
142                 $this->month['04'] = /* translators: month name */ __( 'April' );
143                 $this->month['05'] = /* translators: month name */ __( 'May' );
144                 $this->month['06'] = /* translators: month name */ __( 'June' );
145                 $this->month['07'] = /* translators: month name */ __( 'July' );
146                 $this->month['08'] = /* translators: month name */ __( 'August' );
147                 $this->month['09'] = /* translators: month name */ __( 'September' );
148                 $this->month['10'] = /* translators: month name */ __( 'October' );
149                 $this->month['11'] = /* translators: month name */ __( 'November' );
150                 $this->month['12'] = /* translators: month name */ __( 'December' );
151
152                 // The Months, genitive
153                 $this->month_genitive['01'] = /* translators: month name, genitive */ _x( 'January', 'genitive' );
154                 $this->month_genitive['02'] = /* translators: month name, genitive */ _x( 'February', 'genitive' );
155                 $this->month_genitive['03'] = /* translators: month name, genitive */ _x( 'March', 'genitive' );
156                 $this->month_genitive['04'] = /* translators: month name, genitive */ _x( 'April', 'genitive' );
157                 $this->month_genitive['05'] = /* translators: month name, genitive */ _x( 'May', 'genitive' );
158                 $this->month_genitive['06'] = /* translators: month name, genitive */ _x( 'June', 'genitive' );
159                 $this->month_genitive['07'] = /* translators: month name, genitive */ _x( 'July', 'genitive' );
160                 $this->month_genitive['08'] = /* translators: month name, genitive */ _x( 'August', 'genitive' );
161                 $this->month_genitive['09'] = /* translators: month name, genitive */ _x( 'September', 'genitive' );
162                 $this->month_genitive['10'] = /* translators: month name, genitive */ _x( 'October', 'genitive' );
163                 $this->month_genitive['11'] = /* translators: month name, genitive */ _x( 'November', 'genitive' );
164                 $this->month_genitive['12'] = /* translators: month name, genitive */ _x( 'December', 'genitive' );
165
166                 // Abbreviations for each month.
167                 $this->month_abbrev[ __( 'January' ) ]   = /* translators: three-letter abbreviation of the month */ _x( 'Jan', 'January abbreviation' );
168                 $this->month_abbrev[ __( 'February' ) ]  = /* translators: three-letter abbreviation of the month */ _x( 'Feb', 'February abbreviation' );
169                 $this->month_abbrev[ __( 'March' ) ]     = /* translators: three-letter abbreviation of the month */ _x( 'Mar', 'March abbreviation' );
170                 $this->month_abbrev[ __( 'April' ) ]     = /* translators: three-letter abbreviation of the month */ _x( 'Apr', 'April abbreviation' );
171                 $this->month_abbrev[ __( 'May' ) ]       = /* translators: three-letter abbreviation of the month */ _x( 'May', 'May abbreviation' );
172                 $this->month_abbrev[ __( 'June' ) ]      = /* translators: three-letter abbreviation of the month */ _x( 'Jun', 'June abbreviation' );
173                 $this->month_abbrev[ __( 'July' ) ]      = /* translators: three-letter abbreviation of the month */ _x( 'Jul', 'July abbreviation' );
174                 $this->month_abbrev[ __( 'August' ) ]    = /* translators: three-letter abbreviation of the month */ _x( 'Aug', 'August abbreviation' );
175                 $this->month_abbrev[ __( 'September' ) ] = /* translators: three-letter abbreviation of the month */ _x( 'Sep', 'September abbreviation' );
176                 $this->month_abbrev[ __( 'October' ) ]   = /* translators: three-letter abbreviation of the month */ _x( 'Oct', 'October abbreviation' );
177                 $this->month_abbrev[ __( 'November' ) ]  = /* translators: three-letter abbreviation of the month */ _x( 'Nov', 'November abbreviation' );
178                 $this->month_abbrev[ __( 'December' ) ]  = /* translators: three-letter abbreviation of the month */ _x( 'Dec', 'December abbreviation' );
179
180                 // The Meridiems
181                 $this->meridiem['am'] = __('am');
182                 $this->meridiem['pm'] = __('pm');
183                 $this->meridiem['AM'] = __('AM');
184                 $this->meridiem['PM'] = __('PM');
185
186                 // Numbers formatting
187                 // See http://php.net/number_format
188
189                 /* translators: $thousands_sep argument for http://php.net/number_format, default is , */
190                 $trans = __('number_format_thousands_sep');
191                 $this->number_format['thousands_sep'] = ('number_format_thousands_sep' == $trans) ? ',' : $trans;
192
193                 /* translators: $dec_point argument for http://php.net/number_format, default is . */
194                 $trans = __('number_format_decimal_point');
195                 $this->number_format['decimal_point'] = ('number_format_decimal_point' == $trans) ? '.' : $trans;
196
197                 // Set text direction.
198                 if ( isset( $GLOBALS['text_direction'] ) )
199                         $this->text_direction = $GLOBALS['text_direction'];
200                 /* translators: 'rtl' or 'ltr'. This sets the text direction for WordPress. */
201                 elseif ( 'rtl' == _x( 'ltr', 'text direction' ) )
202                         $this->text_direction = 'rtl';
203
204                 if ( 'rtl' === $this->text_direction && strpos( $GLOBALS['wp_version'], '-src' ) ) {
205                         $this->text_direction = 'ltr';
206                         add_action( 'all_admin_notices', array( $this, 'rtl_src_admin_notice' ) );
207                 }
208         }
209
210         /**
211          * @since 3.8.0
212          */
213         public function rtl_src_admin_notice() {
214                 /* translators: %s: Name of the directory (build) */
215                 echo '<div class="error"><p>' . sprintf( __( 'The %s directory of the develop repository must be used for RTL.' ), '<code>build</code>' ) . '</p></div>';
216         }
217
218         /**
219          * Retrieve the full translated weekday word.
220          *
221          * Week starts on translated Sunday and can be fetched
222          * by using 0 (zero). So the week starts with 0 (zero)
223          * and ends on Saturday with is fetched by using 6 (six).
224          *
225          * @since 2.1.0
226          * @access public
227          *
228          * @param int $weekday_number 0 for Sunday through 6 Saturday
229          * @return string Full translated weekday
230          */
231         public function get_weekday($weekday_number) {
232                 return $this->weekday[$weekday_number];
233         }
234
235         /**
236          * Retrieve the translated weekday initial.
237          *
238          * The weekday initial is retrieved by the translated
239          * full weekday word. When translating the weekday initial
240          * pay attention to make sure that the starting letter does
241          * not conflict.
242          *
243          * @since 2.1.0
244          * @access public
245          *
246          * @param string $weekday_name
247          * @return string
248          */
249         public function get_weekday_initial($weekday_name) {
250                 return $this->weekday_initial[$weekday_name];
251         }
252
253         /**
254          * Retrieve the translated weekday abbreviation.
255          *
256          * The weekday abbreviation is retrieved by the translated
257          * full weekday word.
258          *
259          * @since 2.1.0
260          * @access public
261          *
262          * @param string $weekday_name Full translated weekday word
263          * @return string Translated weekday abbreviation
264          */
265         public function get_weekday_abbrev($weekday_name) {
266                 return $this->weekday_abbrev[$weekday_name];
267         }
268
269         /**
270          * Retrieve the full translated month by month number.
271          *
272          * The $month_number parameter has to be a string
273          * because it must have the '0' in front of any number
274          * that is less than 10. Starts from '01' and ends at
275          * '12'.
276          *
277          * You can use an integer instead and it will add the
278          * '0' before the numbers less than 10 for you.
279          *
280          * @since 2.1.0
281          * @access public
282          *
283          * @param string|int $month_number '01' through '12'
284          * @return string Translated full month name
285          */
286         public function get_month($month_number) {
287                 return $this->month[zeroise($month_number, 2)];
288         }
289
290         /**
291          * Retrieve translated version of month abbreviation string.
292          *
293          * The $month_name parameter is expected to be the translated or
294          * translatable version of the month.
295          *
296          * @since 2.1.0
297          * @access public
298          *
299          * @param string $month_name Translated month to get abbreviated version
300          * @return string Translated abbreviated month
301          */
302         public function get_month_abbrev($month_name) {
303                 return $this->month_abbrev[$month_name];
304         }
305
306         /**
307          * Retrieve translated version of meridiem string.
308          *
309          * The $meridiem parameter is expected to not be translated.
310          *
311          * @since 2.1.0
312          * @access public
313          *
314          * @param string $meridiem Either 'am', 'pm', 'AM', or 'PM'. Not translated version.
315          * @return string Translated version
316          */
317         public function get_meridiem($meridiem) {
318                 return $this->meridiem[$meridiem];
319         }
320
321         /**
322          * Global variables are deprecated. For backwards compatibility only.
323          *
324          * @deprecated For backwards compatibility only.
325          * @access private
326          *
327          * @global array $weekday
328          * @global array $weekday_initial
329          * @global array $weekday_abbrev
330          * @global array $month
331          * @global array $month_abbrev
332          *
333          * @since 2.1.0
334          */
335         public function register_globals() {
336                 $GLOBALS['weekday']         = $this->weekday;
337                 $GLOBALS['weekday_initial'] = $this->weekday_initial;
338                 $GLOBALS['weekday_abbrev']  = $this->weekday_abbrev;
339                 $GLOBALS['month']           = $this->month;
340                 $GLOBALS['month_abbrev']    = $this->month_abbrev;
341         }
342
343         /**
344          * Constructor which calls helper methods to set up object variables
345          *
346          * @since 2.1.0
347          */
348         public function __construct() {
349                 $this->init();
350                 $this->register_globals();
351         }
352
353         /**
354          * Checks if current locale is RTL.
355          *
356          * @since 3.0.0
357          * @return bool Whether locale is RTL.
358          */
359         public function is_rtl() {
360                 return 'rtl' == $this->text_direction;
361         }
362
363         /**
364          * Register date/time format strings for general POT.
365          *
366          * Private, unused method to add some date/time formats translated
367          * on wp-admin/options-general.php to the general POT that would
368          * otherwise be added to the admin POT.
369          *
370          * @since 3.6.0
371          */
372         public function _strings_for_pot() {
373                 /* translators: localized date format, see http://php.net/date */
374                 __( 'F j, Y' );
375                 /* translators: localized time format, see http://php.net/date */
376                 __( 'g:i a' );
377                 /* translators: localized date and time format, see http://php.net/date */
378                 __( 'F j, Y g:i a' );
379         }
380 }
381
382 /**
383  * Checks if current locale is RTL.
384  *
385  * @since 3.0.0
386  *
387  * @global WP_Locale $wp_locale
388  *
389  * @return bool Whether locale is RTL.
390  */
391 function is_rtl() {
392         global $wp_locale;
393         return $wp_locale->is_rtl();
394 }