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 ]

boolean addCompiledTranslationFile(
string
$file, string
$locale)

Add a compiled language-file's content

The language-file's content will be unserialized and translations, properties, etc. 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 compiled language file
string	`$locale`	—	locale-code of the translation

[ Top ]

void addDriver(
object Date_Holidays_Driver
$driver)

Add a driver component

Access: public
Abstract:

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 language-file's content

The language-file's content will be parsed and translations, properties, etc. 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
Usedby: Date_Holidays_Driver::getHolidayForDate()
Uses: Date_Holidays_Driver::getHolidayDate()
Uses: Date_Holidays_Driver::getHolidayTitle()
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
Access: public

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
Usedby: Date_Holidays_Driver::getHolidayDates()
Usedby: Date_Holidays_Driver::getHoliday()
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME, DATE_HOLIDAYS_DATE_UNAVAILABLE
Access: public

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(
[Date_Holidays_Filter
$filter = null])

Returns dates of all holidays or those accepted by the applied filter.

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
Uses: Date_Holidays_Driver::getHolidayDate()
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
Access: public

Overridden in child classes as:

Date_Holidays_Driver_Composite::getHolidayDates(): Returns dates of all holidays or those accepted by the specified filter.

Parameters:

Date_Holidays_Filter $filter — filter-object (or an array !DEPRECATED!)

[ Top ]

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

Returns a


1     Date_Holidays_Holiday

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


1     Date_Holidays_Holiday

items.

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

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 getHolidayProperties(
string
$internalName, [string
$locale = null])

Returns the localized properties of a holiday. If no properties have been stored an empty array will be returned.

Return: array of properties on success, otherwise a PEAR_Error object
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
Access: public

Parameters:

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

[ Top ]

array getHolidays(
[Date_Holidays_Filter
$filter = null], [string
$locale = null])

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:

   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

Overridden in child classes as:

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

Parameters:

Date_Holidays_Filter	`$filter`	—	filter-object (or an array !DEPRECATED!)
string	`$locale`	—	locale setting that shall be used by this method

[ Top ]

array getHolidaysForDatespan(
mixed
$start, mixed
$end, [Date_Holidays_Filter
$filter = null], [string
$locale = null])

Returns an array containing a number of


1     Date_Holidays_Holiday

items.

If no items have been found the returned array will be empty.

Return: an array containing a number of


1     Date_Holidays_Holiday

items

Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_DATE, DATE_HOLIDAYS_INVALID_DATE_FORMAT
Access: public

Parameters:

mixed	`$start`	—	date (timestamp \| string \| PEAR::Date object)
mixed	`$end`	—	date (timestamp \| string \| PEAR::Date object)
Date_Holidays_Filter	`$filter`	—	filter-object (or an array !DEPRECATED!)
string	`$locale`	—	locale setting that shall be used by this method

[ Top ]

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

Returns localized title for a holiday

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

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(
[Date_Holidays_Filter
$filter = null], [string
$locale = null])

Returns localized titles of all holidays or those accepted by the filter

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

Overridden in child classes as:

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

Parameters:

string	`$locale`	—	locale setting that shall be used by this method
Date_Holidays_Filter	`$filter`	—	filter-object (or an array !DEPRECATED!)

[ Top ]

array getInternalHolidayNames(
)

Returns the internal names of holidays that were calculated

Access: public

[ 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 been able to add your driver to this compound, you should also be able to directly execute this action.

[ Top ]

boolean isHoliday(
mixed
$date, [Date_Holidays_Filter
$filter = null])

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)
Date_Holidays_Filter	`$filter`	—	filter-object (or an array !DEPRECATED!)

[ Top ]

boolean removeDriver(
object Date_Holidays_Driver
$driver)

Remove a driver component

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

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
Uses: Date_Holidays_Driver::_buildHolidays()
Throws: object PEAR_ErrorStack
Access: public

Overridden in child classes as:

Date_Holidays_Driver_Composite::setYear(): This (re)sets the year of every driver-object in the compound.

Parameters:

int $year — year

[ Top ]

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

Adds a holiday to the driver's holidays

Usedby: Date_Holidays_Driver::_addStaticHolidays()
Access: protected

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(
           ...
       )
   );

Uses: Date_Holidays_Driver::_addHoliday()
Access: protected

Parameters:

array $holidays — static holidays' data

[ Top ]

boolean _addStringPropertiesForHoliday(
string
$internalName, string
$locale, array
$properties)

Adds a arbitrary number of localized string-properties for the specified holiday.

Return: true on success, false otherwise
Throws: PEAR_ErrorStack if internal-name does not exist
Access: public

Parameters:

string	`$internalName`	—	internal-name
string	`$locale`	—	locale-setting
array	`$properties`	—	associative array: array(propId1 => value1, propid2 => value2, ...)

[ Top ]

boolean _addStringPropertyForHoliday(
string
$internalName, string
$locale, string
$propId, mixed
$propVal)

Adds a localized (regrading translation etc.) string-property for a holiday.

Overwrites existing data.

Return: true on success, false otherwise
Throws: PEAR_ErrorStack if internal-name does not exist
Access: public

Parameters:

string	`$internalName`	—	internal-name
string	`$locale`	—	locale-setting
string	`$propId`	—	property-identifier
mixed	`$propVal`	—	property-value

[ Top ]

boolean _addTranslationData(
array
$data, string
$locale)

Add a language-file's content. Translations, properties, etc. 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:

array	`$data`	—	translated data
string	`$locale`	—	locale-code of the translation

[ Top ]

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

Add a localized translation for a holiday's title. Overwrites existing data.

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

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
Usedby: Date_Holidays_Driver::setYear()
Throws: object PEAR_ErrorStack
Access: protected
Abstract:

Overridden in child classes as:

Date_Holidays_Driver_Example::_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_Jewish::_buildHolidays(): Build the internal arrays that contain data about the calculated holidays

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

Date_Holidays_Driver_Sweden::_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

Date_Holidays_Driver_USA::_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 179]

addCompiledTranslationFile [line 821]

Parameters:

addDriver [line 232]

Parameters:

addTranslationFile [line 781]

Parameters:

getHoliday [line 423]

Parameters:

getHolidayDate [line 940]

Parameters:

getHolidayDates [line 971]

Parameters:

getHolidayForDate [line 509]

Parameters:

getHolidayProperties [line 336]

Parameters:

getHolidays [line 380]

Parameters:

getHolidaysForDatespan [line 556]

Parameters:

getHolidayTitle [line 302]

Parameters:

getHolidayTitles [line 270]

Parameters:

getInternalHolidayNames [line 255]

getYear [line 206]

isHoliday [line 459]

Parameters:

removeDriver [line 245]

Parameters:

setLocale [line 999]

Parameters:

setYear [line 194]

Parameters:

_addHoliday [line 673]

Parameters:

_addStaticHolidays [line 657]

Parameters:

_addStringPropertiesForHoliday [line 759]

Parameters:

_addStringPropertyForHoliday [line 726]

Parameters:

_addTranslationData [line 851]

Parameters:

_addTranslationForHoliday [line 699]

Parameters:

_buildHolidays [line 219]

_findBestLocale [line 914]

Parameters:

_removeHoliday [line 884]

Parameters: