Docs For Class Date_Holidays

Date_Holidays_Driver Date_Holidays_Driver(
)

Constructor

Use the Date_Holidays::factory() method to construct an object of a certain driver

Access: protected

[ Top ]

void addDriver(
object Date_Holidays_Driver
$driver)

Add a driver component

Abstract:
Access: public

Overridden in child classes as:

Date_Holidays_Driver_Composite::addDriver(): Add a driver component

Parameters:

object Date_Holidays_Driver $driver — driver-object

[ Top ]

boolean addTranslationFile(
string
$file, string
$locale)

Add a translation-file's content

The translation-file's content will be parsed and translations for holidays will be made available with the specified locale.

Return: true on success, otherwise a PEAR_ErrorStack object
Throws: object PEAR_Errorstack
Access: public

Parameters:

string	`$file`	—	filename of the language file
string	`$locale`	—	locale-code of the translation

[ Top ]

object Date_Holidays_Holiday getHoliday(
string
$internalName, [string
$locale = null])

Returns the specified holiday

Return format:

   array(
       'title' =>  'Easter Sunday'
       'date'  =>  '2004-04-11'
   )

Return: holiday's information on success, otherwise a PEAR_Error object
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
Access: public
Usedby: Date_Holidays_Driver::getHolidayForDate()
Usedby: Date_Holidays_Driver::getHolidays()
Uses: Date_Holidays_Driver::getHolidayDate()
Uses: Date_Holidays_Driver::getHolidayTitle()

Overridden in child classes as:

Date_Holidays_Driver_Composite::getHoliday(): Returns the specified holiday

Parameters:

string	`$internalName`	—	internal name of the holiday
string	`$locale`	—	locale setting that shall be used by this method

[ Top ]

object Date getHolidayDate(
string
$internalName)

Returns date of a holiday

Return: date of the holiday as PEAR::Date object on success, otherwise a PEAR_Error object
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME, DATE_HOLIDAYS_DATE_UNAVAILABLE
Access: public
Usedby: Date_Holidays_Driver::getHolidayDates()
Usedby: Date_Holidays_Driver::getHoliday()

Overridden in child classes as:

Date_Holidays_Driver_Composite::getHolidayDate(): Returns date of a holiday

Parameters:

string $internalName — internal name for holiday

[ Top ]

array getHolidayDates(
[array
$restrict = array()])

Returns dates of all holidays or those specififed in $restrict array

Structure of the returned array:

 array(
   'internalNameFoo' => object of type date,
   'internalNameBar' => object of type date
 )

Return: with holidays' dates on success, otherwise a PEAR_Error object
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
Access: public
Uses: Date_Holidays_Driver::getHolidayDate()

Overridden in child classes as:

Date_Holidays_Driver_Composite::getHolidayDates(): Returns dates of all holidays or those specififed in $restrict array

Parameters:

array $restrict — internal names of desired holidays

[ Top ]

object object getHolidayForDate(
mixed
$date, [string
$locale = null], [boolean
$multiple = false])

Returns the title of the holiday, if any was found, matching the specified date.

Normally the method will return the title/data for the first holiday matching the date. If you want the mthod 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 of the titles/data.

 array(
   array(
       'title' => 'New Year',
       'date'  => Object of type Date
   ),
   array(
       'title' => 'Circumcision of Jesus',
       'date'  => Object of type Date
   )
 )

Return: 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
See: Date_Holidays_Driver::getHoliday()
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_DATE, DATE_HOLIDAYS_INVALID_DATE_FORMAT
Access: public
Uses: Date_Holidays_Driver::getHoliday()
Uses: Date_Holidays_Driver::getHolidayTitle()

Overridden in child classes as:

Date_Holidays_Driver_Composite::getHolidayForDate(): Returns the title of the holiday, if any was found, matching the specified date.

Parameters:

mixed	`$date`	—	date (timestamp \| string \| PEAR::Date object)
string	`$locale`	—	locale setting that shall be used by this method
boolean	`$multiple`	—

[ Top ]

array getHolidays(
[array
$restrict = array()])

Returns all holidays that the driver knows.

You can limit the holidays by setting the $restrict array, then only those will be returned, whose internal name occurrs in this array.

Return format:

   array(
       'easter'        =>  object of type Date_Holidays_Holiday,
       'eastermonday'  =>  object of type Date_Holidays_Holiday,
       ...
   )

Return: numeric array containing objects of Date_Holidays_Holiday on success, otherwise a PEAR_Error object
See: Date_Holidays_Driver::getHoliday()
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
Access: public
Uses: Date_Holidays_Driver::getHoliday()

Overridden in child classes as:

Date_Holidays_Driver_Composite::getHolidays(): Returns all holidays that were found

Parameters:

array $restrict — internal names of desired holidays

[ Top ]

string getHolidayTitle(
string
$internalName, [string
$locale = null])

Returns localized title for a holiday

Return: title on success, otherwise a PEAR_Error object
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME, DATE_HOLIDAYS_TITLE_UNAVAILABLE
Access: public
Usedby: Date_Holidays_Driver::getHolidayForDate()
Usedby: Date_Holidays_Driver::getHolidayTitles()
Usedby: Date_Holidays_Driver::getHoliday()

Overridden in child classes as:

Date_Holidays_Driver_Composite::getHolidayTitle(): Returns localized title for a holiday

Parameters:

string	`$internalName`	—	internal name for holiday
string	`$locale`	—	locale setting that shall be used by this method

[ Top ]

array getHolidayTitles(
[array
$restrict = array()], [string
$locale = null])

Returns localized titles of all holidays or those specififed in $restrict array

Return: with localized holiday titles on success, otherwise a PEAR_Error object
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
Access: public
Uses: Date_Holidays_Driver::getHolidayTitle()

Overridden in child classes as:

Date_Holidays_Driver_Composite::getHolidayTitles(): Returns localized titles of all holidays or those specififed in $restrict array

Parameters:

array	`$restrict`	—	internal names of desired holidays
string	`$locale`	—	locale setting that shall be used by this method

[ Top ]

array getInternalHolidayNames(
)

Returns the internal names of holidays that were calculated

Access: public

Overridden in child classes as:

Date_Holidays_Driver_Composite::getInternalHolidayNames(): Returns the internal names of holidays that were calculated

[ Top ]

int getYear(
)

Returns the driver's current year

Return: current year
Access: public

Overridden in child classes as:

Date_Holidays_Driver_Composite::getYear(): Using this method doesn't affect anything. If you have bben able to add your driver to this compound, you should also be able to directly execute this action.

[ Top ]

boolean isHoliday(
mixed
$date, [array
$restrict = array()])

Determines whether a date represents a holiday or not

Return: true if date represents a holiday, otherwise false
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_DATE, DATE_HOLIDAYS_INVALID_DATE_FORMAT
Access: public

Overridden in child classes as:

Date_Holidays_Driver_Composite::isHoliday(): Determines whether a date represents a holiday or not.

Parameters:

mixed	`$date`	—	date (can be a timestamp, string or PEAR::Date object)
array	`$restrict`	—	internal-names of holidays to limit search on

[ Top ]

boolean removeDriver(
object Date_Holidays_Driver
$driver)

Remove a driver component

Return: true on success, otherwise a PEAR_Error object
Abstract:
Throws: object PEAR_Error DATE_HOLIDAYS_DRIVER_NOT_FOUND
Access: public

Overridden in child classes as:

Date_Holidays_Driver_Composite::removeDriver(): Remove a driver component

Parameters:

object Date_Holidays_Driver $driver — driver-object

[ Top ]

void setLocale(
string
$locale)

Sets the driver's locale

Access: public

Overridden in child classes as:

Date_Holidays_Driver_Composite::setLocale(): Using this method doesn't affect anything. If you have bben able to add your driver to this compound, you should also be able to directly execute this action.

Parameters:

string $locale — locale

[ Top ]

boolean setYear(
int
$year)

Sets the driver's current year

Calling this method forces the object to rebuild the holidays

Return: true on success, otherwise a PEAR_ErrorStack object
Throws: object PEAR_ErrorStack
Access: public
Uses: Date_Holidays_Driver::_buildHolidays()

Overridden in child classes as:

Date_Holidays_Driver_Composite::setYear(): Using this method doesn't affect anything. If you have bben able to add your driver to this compound, you should also be able to directly execute this action.

Parameters:

int $year — year

[ Top ]

void _addHoliday(
string
$internalName, mixed
$date, string
$title)

Adds a holiday to the driver's holidays

Access: protected
Usedby: Date_Holidays_Driver::_addStaticHolidays()

Parameters:

string	`$internalName`	—	internal name - must not contain characters that aren't allowed as variable-names
mixed	`$date`	—	date (timestamp \| string \| PEAR::Date object)
string	`$title`	—	holiday title

[ Top ]

void _addStaticHolidays(
array
$holidays)

Adds all holidays in the array to the driver's internal list of holidays.

Format of the array:

   array(
       'newYearsDay'   => array(
           'date'          => '01-01',
           'title'         => 'New Year\'s Day',
           'translations'  => array(
               'de_DE' =>  'Neujahr',
               'en_EN' =>  'New Year\'s Day'
           )
       ),
       'valentinesDay' => array(
           ...
       )
   );

Access: protected
Uses: Date_Holidays_Driver::_addTranslationForHoliday()
Uses: Date_Holidays_Driver::_addHoliday()

Parameters:

array $holidays — static holidays' data

[ Top ]

true _addTranslationForHoliday(
string
$internalName, string
$locale, string
$title)

Add a localized translation for a holiday's title

Return: on success, otherwise a PEAR_Error object
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
Access: protected
Usedby: Date_Holidays_Driver::_addStaticHolidays()

Parameters:

string	`$internalName`	—	internal name of an existing holiday
string	`$locale`	—	locale setting that shall be used by this method
string	`$title`	—	title

[ Top ]

boolean _buildHolidays(
)

Build the internal arrays that contain data about the calculated holidays

Return: true on success, otherwise a PEAR_ErrorStack object
Abstract:
Throws: object PEAR_ErrorStack
Access: protected
Usedby: Date_Holidays_Driver::setYear()

Overridden in child classes as:

Date_Holidays_Driver_Example::_buildHolidays(): Build the internal arrays that contain data about the calculated holidays

Date_Holidays_Driver_Jewish::_buildHolidays(): Build the internal arrays that contain data about the calculated holidays

Date_Holidays_Driver_USA::_buildHolidays(): Build the internal arrays that contain data about the calculated holidays

Date_Holidays_Driver_Christian::_buildHolidays(): Build the internal arrays that contain data about the calculated holidays

Date_Holidays_Driver_Germany::_buildHolidays(): Build the internal arrays that contain data about the calculated holidays

Date_Holidays_Driver_UNO::_buildHolidays(): Build the internal arrays that contain data about the calculated holidays

[ Top ]

string _findBestLocale(
string
$locale)

Finds the best internally available locale for the specified one

Return: best locale available
Access: protected

Parameters:

string $locale — locale

[ Top ]

boolean _removeHoliday(
$string
$internalName)

Remove a holiday from internal storage

This method should be used within driver classes to unset holidays that were inherited from parent-drivers

Return: true on success, otherwise a PEAR_Error object
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
Access: protected

Parameters:

$string $internalName — internal name

[ Top ]

Class: Date_Holidays_Driver

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$_dates = array()

$_holidays = array()

$_internalNames = array()

$_locale =

$_titles = array()

$_year =

Method Detail

Date_Holidays_Driver (Constructor) [line 148]

addDriver [line 201]

Parameters:

addTranslationFile [line 585]

Parameters:

getHoliday [line 345]

Parameters:

getHolidayDate [line 670]

Parameters:

getHolidayDates [line 701]

Parameters:

getHolidayForDate [line 431]

Parameters:

getHolidays [line 310]

Parameters:

getHolidayTitle [line 265]

Parameters:

getHolidayTitles [line 239]

Parameters:

getInternalHolidayNames [line 224]

getYear [line 175]

isHoliday [line 376]

Parameters:

removeDriver [line 214]

Parameters:

setLocale [line 724]

Parameters:

setYear [line 163]

Parameters:

_addHoliday [line 533]

Parameters:

_addStaticHolidays [line 517]

Parameters:

_addTranslationForHoliday [line 559]

Parameters:

_buildHolidays [line 188]

_findBestLocale [line 644]

Parameters:

_removeHoliday [line 614]

Parameters: