-
Notifications
You must be signed in to change notification settings - Fork 10
/
Driver.php
1417 lines (1303 loc) · 45.1 KB
/
Driver.php
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4: */
/**
* Driver.php
*
* PHP Version 4
*
* Copyright (c) 1997-2008 The PHP Group
*
* This source file is subject to version 2.0 of the PHP license,
* that is bundled with this package in the file LICENSE, and is
* available at through the world-wide-web at
* http://www.php.net/license/2_02.txt.
* If you did not receive a copy of the PHP license and are unable to
* obtain it through the world-wide-web, please send a note to
* license@php.net so we can mail you a copy immediately.
*
* Authors: Carsten Lucke <luckec@tool-garage.de>
*
* CVS file id: $Id$
*
* @category Date
* @package Date_Holidays
* @author Carsten Lucke <luckec@tool-garage.de>
* @license http://www.php.net/license/3_01.txt PHP License 3.0.1
* @version CVS: $Id$
* @link http://pear.php.net/package/Date_Holidays
*/
/**
* DriverClass and associated defines.
*
* @abstract
* @category Date
* @package Date_Holidays
* @author Carsten Lucke <luckec@tool-garage.de>
* @license http://www.php.net/license/3_01.txt PHP License 3.0.1
* @version CVS: $Id$
* @link http://pear.php.net/package/Date_Holidays
*/
/**
* uses PEAR_Errorstack
*/
require_once 'PEAR/ErrorStack.php';
require_once 'Date/Holidays/Filter.php';
require_once 'Date/Holidays/Filter/Whitelist.php';
require_once 'Date/Holidays/Filter/Blacklist.php';
/**
* invalid internal name
*
* @access public
*/
define('DATE_HOLIDAYS_INVALID_INTERNAL_NAME', 51);
/**
* title for a holiday is not available
*
* @access public
*/
define('DATE_HOLIDAYS_TITLE_UNAVAILABLE', 52);
/**
* date could not be converted into a PEAR::Date object
*
* date was neither a timestamp nor a string
*
* @access public
* @deprecated will certainly be removed
*/
define('DATE_HOLIDAYS_INVALID_DATE', 53);
/**
* string that represents a date has wrong format
*
* format must be YYYY-MM-DD
*
* @access public
* @deprecated will certainly be removed
*/
define('DATE_HOLIDAYS_INVALID_DATE_FORMAT', 54);
/**
* date for a holiday is not available
*
* @access public
*/
define('DATE_HOLIDAYS_DATE_UNAVAILABLE', 55);
/**
* language-file doesn't exist
*
* @access public
*/
define('DATE_HOLIDAYS_LANGUAGEFILE_NOT_FOUND', 56);
/**
* unable to read language-file
*
* @access public
*/
define('DATE_HOLIDAYS_UNABLE_TO_READ_TRANSLATIONDATA', 57);
/**
* Name of the static {@link Date_Holidays_Driver} method returning
* a array of possible ISO3166 codes that identify itself.
*
* @access public
*/
define('DATE_HOLIDAYS_DRIVER_IDENTIFY_ISO3166_METHOD', 'getISO3166Codes');
/**
* class that helps you to locate holidays for a year
*
* @abstract
* @category Date
* @package Date_Holidays
* @subpackage Driver
* @author Carsten Lucke <luckec@tool-garage.de>
* @license http://www.php.net/license/3_01.txt PHP License 3.0.1
* @version CVS: $Id$
* @link http://pear.php.net/package/Date_Holidays
*/
class Date_Holidays_Driver
{
/**
* this driver's name
*
* @access protected
* @var string
*/
var $_driverName;
/**
* locale setting for output
*
* @access protected
* @var string
*/
var $_locale;
/**
* locales for which translations of holiday titles are available
*
* @access private
* @var array
*/
var $_availableLocales = array('C');
/**
* object's current year
*
* @access protected
* @var int
*/
var $_year;
/**
* internal names for the available holidays
*
* @access protected
* @var array
*/
var $_internalNames = array();
/**
* dates of the available holidays
*
* @access protected
* @var array
*/
var $_dates = array();
/**
* array of the available holidays indexed by date
*
* @access protected
* @var array
*/
var $_holidays = array();
/**
* localized names of the available holidays
*
* @access protected
* @var array
*/
var $_titles = array();
/**
* Array of holiday-properties indexed by internal-names and
* furthermore by locales.
*
* <code>
* $_holidayProperties = array(
* 'internalName1' => array(
* 'de_DE' => array(),
* 'en_US' => array(),
* 'fr_FR' => array()
* )
* 'internalName2' => array(
* 'de_DE' => array(),
* 'en_US' => array(),
* 'fr_FR' => array()
* )
* );
* </code>
*/
var $_holidayProperties = array();
/**
* Constructor
*
* Use the Date_Holidays::factory() method to construct an object of a
* certain driver
*
* @access protected
*/
function Date_Holidays_Driver()
{
}
/**
* Method that returns an array containing the ISO3166 codes that may possibly
* identify a driver.
*
* @static
* @access public
* @return array possible ISO3166 codes
*/
function getISO3166Codes()
{
return array();
}
/**
* Sets the driver's current year
*
* Calling this method forces the object to rebuild the holidays
*
* @param int $year year
*
* @access public
* @return boolean true on success, otherwise a PEAR_ErrorStack object
* @throws object PEAR_ErrorStack
* @uses _buildHolidays()
*/
function setYear($year)
{
$this->_year = $year;
return $this->_buildHolidays();
}
/**
* Returns the driver's current year
*
* @access public
* @return int current year
*/
function getYear()
{
return $this->_year;
}
/**
* Build the internal arrays that contain data about the calculated holidays
*
* @abstract
* @access protected
* @return boolean true on success, otherwise a PEAR_ErrorStack object
* @throws object PEAR_ErrorStack
*/
function _buildHolidays()
{
}
/**
* Add a driver component
*
* @param object $driver Date_Holidays_Driver object
*
* @abstract
* @access public
* @return void
*/
function addDriver($driver)
{
}
/**
* addTranslation
*
* Search for installed language files appropriate for the specified
* locale and add them to the driver
*
* @param string $locale locale setting to be used
*
* @access public
* @return boolean true on success, otherwise false
*/
function addTranslation($locale)
{
$data_dir = "@DATA-DIR@";
$bestLocale = $this->_findBestLocale($locale);
$matches = array();
$loaded = false;
if ($data_dir == '@'.'DATA-DIR'.'@') {
$data_dir = dirname(dirname(dirname(__FILE__)));
$stubdirs = array(
"$data_dir/lang/{$this->_driverName}/",
"$data_dir/lang/Christian/");
} else {
//Christian driver is exceptional...
if ($this->_driverName == 'Christian') {
$stubdir = "$data_dir/Date_Holidays/lang/Christian/";
} else {
$stubdir = "$data_dir/Date_Holidays_{$this->_driverName}/lang/{$this->_driverName}/";
if (! is_dir($stubdir)) {
$stubdir = $data_dir . "/Date_Holidays/lang/";
}
}
$stubdirs = array(
$stubdir,
"$data_dir/Date_Holidays_{$this->_driverName}/lang/Christian/");
}
foreach ($stubdirs as $stubdir) {
if (is_dir($stubdir)) {
if ($dh = opendir($stubdir)) {
while (($file = readdir($dh)) !== false) {
if (strlen($locale) == 5) {
if (((strncasecmp($file, $bestLocale, 5) == 0))
|| (strncasecmp($file, $locale, 5) == 0)
) {
array_push($matches, $file);
}
}
if (strlen($locale) == 2) {
if (((strncasecmp($file, $bestLocale, 2) == 0))
|| (strncasecmp($file, $locale, 2) == 0)
) {
array_push($matches, $file);
}
}
}
closedir($dh);
$forget = array();
sort($matches);
foreach ($matches as $am) {
if (strpos($am, ".ser") !== false) {
$this->addCompiledTranslationFile($stubdir.$am, $locale);
$loaded = true;
array_push($forget, basename($am, ".ser") . ".xml");
} else {
if (!in_array($am, $forget)) {
$this->addTranslationFile(
$stubdir . $am,
str_replace(".xml", "", $am)
);
$loaded = true;
}
}
}
}
}
}
return $loaded;
}
/**
* Remove a driver component
*
* @param object $driver Date_Holidays_Driver driver-object
*
* @abstract
* @access public
* @return boolean true on success, otherwise a PEAR_Error object
* @throws object PEAR_Error DATE_HOLIDAYS_DRIVER_NOT_FOUND
*/
function removeDriver($driver)
{
}
/**
* Returns the internal names of holidays that were calculated
*
* @access public
* @return array
*/
function getInternalHolidayNames()
{
return $this->_internalNames;
}
/**
* Returns localized titles of all holidays or those accepted by the filter
*
* @param Date_Holidays_Filter $filter filter-object (or an array !DEPRECATED!)
* @param string $locale locale setting that shall be used
* by this method
*
* @access public
* @return array $filter array with localized holiday titles on success,
* otherwise a PEAR_Error object
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
* @uses getHolidayTitle()
*/
function getHolidayTitles($filter = null, $locale = null)
{
if (is_null($filter)) {
$filter = new Date_Holidays_Filter_Blacklist(array());
} elseif (is_array($filter)) {
$filter = new Date_Holidays_Filter_Whitelist($filter);
}
$titles = array();
foreach ($this->_internalNames as $internalName) {
if ($filter->accept($internalName)) {
$title = $this->getHolidayTitle($internalName, $locale);
if (Date_Holidays::isError($title)) {
return $title;
}
$titles[$internalName] = $title;
}
}
return $titles;
}
/**
* Returns localized title for a holiday
*
* @param string $internalName internal name for holiday
* @param string $locale locale setting to be used by this method
*
* @access public
* @return string title on success, otherwise a PEAR_Error object
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
* @throws object PEAR_Error DATE_HOLIDAYS_TITLE_UNAVAILABLE
*/
function getHolidayTitle($internalName, $locale = null)
{
if (! in_array($internalName, $this->_internalNames)) {
$msg = 'Invalid internal name: ' . $internalName;
return Date_Holidays::raiseError(DATE_HOLIDAYS_INVALID_INTERNAL_NAME,
$msg);
}
if (is_null($locale)) {
$locale = $this->_findBestLocale($this->_locale);
} else {
$locale = $this->_findBestLocale($locale);
}
if (! isset($this->_titles[$locale][$internalName])) {
if (Date_Holidays::staticGetProperty('DIE_ON_MISSING_LOCALE')) {
$err = DATE_HOLIDAYS_TITLE_UNAVAILABLE;
$msg = 'The internal name (' . $internalName . ') ' .
'for the holiday was correct but no ' .
'localized title could be found';
return Date_Holidays::raiseError($err, $msg);
}
}
if (isset($this->_titles[$locale][$internalName])) {
return $this->_titles[$locale][$internalName];
} else {
return $this->_titles['C'][$internalName];
}
}
/**
* Returns the localized properties of a holiday. If no properties have
* been stored an empty array will be returned.
*
* @param string $internalName internal name for holiday
* @param string $locale locale setting that shall be used by this method
*
* @access public
* @return array array of properties on success, otherwise
* a PEAR_Error object
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
*/
function getHolidayProperties($internalName, $locale = null)
{
if (! in_array($internalName, $this->_internalNames)) {
$msg = 'Invalid internal name: ' . $internalName;
return Date_Holidays::raiseError(DATE_HOLIDAYS_INVALID_INTERNAL_NAME,
$msg);
}
if (is_null($locale)) {
$locale = $this->_findBestLocale($this->_locale);
} else {
$locale = $this->_findBestLocale($locale);
}
$properties = array();
if (isset($this->_holidayProperties[$internalName][$locale])) {
$properties = $this->_holidayProperties[$internalName][$locale];
}
return $properties;
}
/**
* Returns all holidays that the driver knows.
*
* You can limit the holidays by passing a filter, then only those
* holidays accepted by the filter will be returned.
*
* Return format:
* <pre>
* array(
* 'easter' => object of type Date_Holidays_Holiday,
* 'eastermonday' => object of type Date_Holidays_Holiday,
* ...
* )
* </pre>
*
* @param Date_Holidays_Filter $filter filter-object
* (or an array !DEPRECATED!)
* @param string $locale locale setting that shall be used
* by this method
*
* @access public
* @return array numeric array containing objects of
* Date_Holidays_Holiday on success, otherwise a
* PEAR_Error object
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
* @see getHoliday()
*/
function getHolidays($filter = null, $locale = null)
{
if (is_null($filter)) {
$filter = new Date_Holidays_Filter_Blacklist(array());
} elseif (is_array($filter)) {
$filter = new Date_Holidays_Filter_Whitelist($filter);
}
if (is_null($locale)) {
$locale = $this->_locale;
}
$holidays = array();
foreach ($this->_internalNames as $internalName) {
if ($filter->accept($internalName)) {
// no need to check for valid internal-name, will be
// done by #getHoliday()
$holidays[$internalName] = $this->getHoliday($internalName,
$locale);
}
}
return $holidays;
}
/**
* Returns the specified holiday
*
* Return format:
* <pre>
* array(
* 'title' => 'Easter Sunday'
* 'date' => '2004-04-11'
* )
* </pre>
*
* @param string $internalName internal name of the holiday
* @param string $locale locale setting that shall be used
* by this method
*
* @access public
* @return object Date_Holidays_Holiday holiday's information on
* success, otherwise a PEAR_Error
* object
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
* @uses getHolidayTitle()
* @uses getHolidayDate()
*/
function getHoliday($internalName, $locale = null)
{
if (! in_array($internalName, $this->_internalNames)) {
return Date_Holidays::raiseError(DATE_HOLIDAYS_INVALID_INTERNAL_NAME,
'Invalid internal name: ' . $internalName);
}
if (is_null($locale)) {
$locale = $this->_locale;
}
$title = $this->getHolidayTitle($internalName, $locale);
if (Date_Holidays::isError($title)) {
return $title;
}
$date = $this->getHolidayDate($internalName);
if (Date_Holidays::isError($date)) {
return $date;
}
$properties = $this->getHolidayProperties($internalName, $locale);
if (Date_Holidays::isError($properties)) {
return $properties;
}
$holiday = new Date_Holidays_Holiday($internalName,
$title,
$date,
$properties);
return $holiday;
}
/**
* Determines whether a date represents a holiday or not
*
* @param mixed $date a timestamp, string or PEAR::Date object
* @param Date_Holidays_Filter $filter filter-object (or an array !DEPRECATED!)
*
* @access public
* @return boolean true if date represents a holiday, otherwise false
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_DATE_FORMAT
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_DATE
*/
function isHoliday($date, $filter = null)
{
if (! is_a($date, 'Date')) {
$date = $this->_convertDate($date);
if (Date_Holidays::isError($date)) {
return $date;
}
}
//rebuild internal array of holidays if required.
$compare_year = $date->getYear();
$this_year = $this->getYear();
if ($this_year !== $compare_year) {
$this->setYear($compare_year);
}
if (is_null($filter)) {
$filter = new Date_Holidays_Filter_Blacklist(array());
} elseif (is_array($filter)) {
$filter = new Date_Holidays_Filter_Whitelist($filter);
}
foreach (array_keys($this->_dates) as $internalName) {
if ($filter->accept($internalName)) {
if (Date_Holidays_Driver::dateSloppyCompare($date,
$this->_dates[$internalName]) != 0) {
continue;
}
$this->setYear($this_year);
return true;
}
}
$this->setYear($this_year);
return false;
}
/**
* Returns a <code>Date_Holidays_Holiday</code> object, if any was found,
* matching the specified date.
*
* Normally the method will return the object of the first holiday matching
* the date. If you want the method to continue searching holidays for the
* specified date, set the 4th param to true.
*
* If multiple holidays match your date, the return value will be an array
* containing a number of <code>Date_Holidays_Holiday</code> items.
*
* @param mixed $date date (timestamp | string | PEAR::Date object)
* @param string $locale locale setting that shall be used by this method
* @param boolean $multiple if true, continue searching holidays for
* specified date
*
* @access public
* @return object object of type Date_Holidays_Holiday on success
* (numeric array of those on multiple search),
* if no holiday was found, matching this date,
* null is returned
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_DATE_FORMAT
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_DATE
* @uses getHoliday()
* @uses getHolidayTitle()
* @see getHoliday()
**/
function getHolidayForDate($date, $locale = null, $multiple = false)
{
if (!is_a($date, 'Date')) {
$date = $this->_convertDate($date);
if (Date_Holidays::isError($date)) {
return $date;
}
}
if ($date->getYear() != $this->_year) {
return null;
}
$isodate = mktime(0,
0,
0,
$date->getMonth(),
$date->getDay(),
$date->getYear());
unset($date);
if (is_null($locale)) {
$locale = $this->_locale;
}
if (array_key_exists($isodate, $this->_holidays)) {
if (!$multiple) {
//get only the first feast for this day
$internalName = $this->_holidays[$isodate][0];
$result = $this->getHoliday($internalName, $locale);
return Date_Holidays::isError($result) ? null : $result;
}
// array that collects data, if multiple searching is done
$data = array();
foreach ($this->_holidays[$isodate] as $internalName) {
$result = $this->getHoliday($internalName, $locale);
if (Date_Holidays::isError($result)) {
continue;
}
$data[] = $result;
}
return $data;
}
return null;
}
/**
* Returns an array containing a number of
* <code>Date_Holidays_Holiday</code> items.
*
* If no items have been found the returned array will be empty.
*
* @param mixed $start date: timestamp, string or PEAR::Date
* @param mixed $end date: timestamp, string or PEAR::Date
* @param Date_Holidays_Filter $filter filter-object (or
* an array !DEPRECATED!)
* @param string $locale locale setting that shall be used
* by this method
*
* @access public
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_DATE_FORMAT
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_DATE
* @return array an array containing a number
* of <code>Date_Holidays_Holiday</code> items
*/
function getHolidaysForDatespan($start, $end, $filter = null, $locale = null)
{
if (is_null($filter)) {
$filter = new Date_Holidays_Filter_Blacklist(array());
} elseif (is_array($filter)) {
$filter = new Date_Holidays_Filter_Whitelist($filter);
}
if (!is_a($start, 'Date')) {
$start = $this->_convertDate($start);
if (Date_Holidays::isError($start)) {
return $start;
}
}
if (!is_a($end, 'Date')) {
$end = $this->_convertDate($end);
if (Date_Holidays::isError($end)) {
return $end;
}
}
$isodateStart = mktime(0,
0,
0,
$start->getMonth(),
$start->getDay(),
$start->getYear());
unset($start);
$isodateEnd = mktime(0,
0,
0,
$end->getMonth(),
$end->getDay(),
$end->getYear());
unset($end);
if (is_null($locale)) {
$locale = $this->_locale;
}
$internalNames = array();
foreach ($this->_holidays as $isoDateTS => $arHolidays) {
if ($isoDateTS >= $isodateStart && $isoDateTS <= $isodateEnd) {
$internalNames = array_merge($internalNames, $arHolidays);
}
}
$retval = array();
foreach ($internalNames as $internalName) {
if ($filter->accept($internalName)) {
$retval[] = $this->getHoliday($internalName, $locale);
}
}
return $retval;
}
/**
* Converts timestamp or date-string into da PEAR::Date object
*
* @param mixed $date date
*
* @static
* @access private
* @return object PEAR_Date
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_DATE_FORMAT
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_DATE
*/
function _convertDate($date)
{
if (is_string($date)) {
if (! preg_match('/^[0-9]{4}-[0-9]{2}-[0-9]{2}/', $date)) {
return Date_Holidays::raiseError(DATE_HOLIDAYS_INVALID_DATE_FORMAT,
'Date-string has wrong format (must be YYYY-MM-DD)');
}
$date = new Date($date);
return $date;
}
if (is_int($date)) {
$date = new Date(date('Y-m-d', $date));
return $date;
}
return Date_Holidays::raiseError(DATE_HOLIDAYS_INVALID_DATE,
'The date you specified is invalid');
}
/**
* Adds all holidays in the array to the driver's internal list of holidays.
*
* Format of the array:
* <pre>
* array(
* 'newYearsDay' => array(
* 'date' => '01-01',
* 'title' => 'New Year\'s Day',
* 'translations' => array(
* 'de_DE' => 'Neujahr',
* 'en_EN' => 'New Year\'s Day'
* )
* ),
* 'valentinesDay' => array(
* ...
* )
* );
* </pre>
*
* @param array $holidays static holidays' data
*
* @access protected
* @uses _addHoliday()
* @return void
*/
function _addStaticHolidays($holidays)
{
foreach ($holidays as $internalName => $holiday) {
// add the holiday's basic data
$this->_addHoliday($internalName,
$this->_year . '-' . $holiday['date'],
$holiday['title']);
}
}
/**
* Adds a holiday to the driver's holidays
*
* @param string $internalName internal name - must not contain characters
* that aren't allowed as variable-names
* @param mixed $date date (timestamp | string | PEAR::Date object)
* @param string $title holiday title
*
* @access protected
* @return void
*/
function _addHoliday($internalName, $date, $title)
{
if (! is_a($date, 'Date')) {
$date = new Date($date);
}
$this->_dates[$internalName] = $date;
$this->_titles['C'][$internalName] = $title;
$isodate = mktime(0, 0, 0,
$date->getMonth(),
$date->getDay(),
$date->getYear());
if (!isset($this->_holidays[$isodate])) {
$this->_holidays[$isodate] = array();
}
array_push($this->_holidays[$isodate], $internalName);
array_push($this->_internalNames, $internalName);
}
/**
* Add a localized translation for a holiday's title. Overwrites existing data.
*
* @param string $internalName internal name of an existing holiday
* @param string $locale locale setting that shall be used by this method
* @param string $title title
*
* @access protected
* @return true on success, otherwise a PEAR_Error object
* @throws object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
*/
function _addTranslationForHoliday($internalName, $locale, $title)
{
if (! in_array($internalName, $this->_internalNames)) {
$msg = 'Couldn\'t add translation (' . $locale . ') ' .
'for holiday with this internal name: ' . $internalName;
return Date_Holidays::raiseError(DATE_HOLIDAYS_INVALID_INTERNAL_NAME,
$msg);
}
if (! in_array($locale, $this->_availableLocales)) {
array_push($this->_availableLocales, $locale);
}
$this->_titles[$locale][$internalName] = $title;
return true;
}
/**
* Adds a localized (regrading translation etc.) string-property for a holiday.
* Overwrites existing data.
*
* @param string $internalName internal-name
* @param string $locale locale-setting
* @param string $propId property-identifier
* @param mixed $propVal property-value
*
* @access public
* @return boolean true on success, false otherwise
* @throws PEAR_ErrorStack if internal-name does not exist
*/
function _addStringPropertyForHoliday($internalName, $locale, $propId, $propVal)
{
if (! in_array($internalName, $this->_internalNames)) {
$msg = 'Couldn\'t add property (locale: ' . $locale . ') '.
'for holiday with this internal name: ' . $internalName;
return Date_Holidays::raiseError(DATE_HOLIDAYS_INVALID_INTERNAL_NAME,
$msg);
}
if (!isset($this->_holidayProperties[$internalName]) ||
!is_array($this->_holidayProperties[$internalName])) {
$this->_holidayProperties[$internalName] = array();
}
if (! isset($this->_holidayProperties[$internalName][$locale]) ||
!is_array($this->_holidayProperties[$internalName][$locale])) {
$this->_holidayProperties[$internalName][$locale] = array();
}
$this->_holidayProperties[$internalName][$locale][$propId] = $propVal;
return true;
}
/**
* Adds a arbitrary number of localized string-properties for the
* specified holiday.
*
* @param string $internalName internal-name
* @param string $locale locale-setting
* @param array $properties associative array: array(propId1 => val1,...)
*
* @access public
* @return boolean true on success, false otherwise
* @throws PEAR_ErrorStack if internal-name does not exist
*/
function _addStringPropertiesForHoliday($internalName, $locale, $properties)
{
foreach ($properties as $propId => $propValue) {
return $this->_addStringPropertyForHoliday($internalName,
$locale,
$propId,
$propValue);
}
return true;
}
/**
* Add a language-file's content
*