Docs For Class Date_Holidays_Driver

Class: Date_Holidays_Driver_USA

Class Overview

Date_Holidays_Driver
   |
   --Date_Holidays_Driver_USA

class that calculates observed U.S. holidays

Author(s):

Kevin English <mailto:kevin at x5dev.com>

Version:

$Id: USA.php,v 1.2 2005/12/22 21:10:14 luckec Exp $

Methods

Class: Date_Holidays_Driver

Date_Holidays_Driver::Date_Holidays_Driver()

Constructor

Date_Holidays_Driver::addCompiledTranslationFile()

Add a compiled language-file's content

Date_Holidays_Driver::addDriver()

Add a driver component

Date_Holidays_Driver::addTranslationFile()

Add a language-file's content

Date_Holidays_Driver::getHoliday()

Returns the specified holiday

Date_Holidays_Driver::getHolidayDate()

Returns date of a holiday

Date_Holidays_Driver::getHolidayDates()

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

Date_Holidays_Driver::getHolidayForDate()

Returns a


1     Date_Holidays_Holiday

object, if any was found, matching the specified date.

Date_Holidays_Driver::getHolidayProperties()

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

Date_Holidays_Driver::getHolidays()

Returns all holidays that the driver knows.

Date_Holidays_Driver::getHolidaysForDatespan()

Returns an array containing a number of


1     Date_Holidays_Holiday

items.

Date_Holidays_Driver::getHolidayTitle()

Returns localized title for a holiday

Date_Holidays_Driver::getHolidayTitles()

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

Date_Holidays_Driver::getInternalHolidayNames()

Returns the internal names of holidays that were calculated

Date_Holidays_Driver::getYear()

Returns the driver's current year

Date_Holidays_Driver::isHoliday()

Determines whether a date represents a holiday or not

Date_Holidays_Driver::removeDriver()

Remove a driver component

Date_Holidays_Driver::setLocale()

Sets the driver's locale

Date_Holidays_Driver::setYear()

Sets the driver's current year

Date_Holidays_Driver::_addHoliday()

Adds a holiday to the driver's holidays

Date_Holidays_Driver::_addStaticHolidays()

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

Date_Holidays_Driver::_addStringPropertiesForHoliday()

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

Date_Holidays_Driver::_addStringPropertyForHoliday()

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

Date_Holidays_Driver::_addTranslationData()

Add a language-file's content. Translations, properties, etc. for holidays will be made available with the specified locale.

Date_Holidays_Driver::_addTranslationForHoliday()

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

Date_Holidays_Driver::_buildHolidays()

Build the internal arrays that contain data about the calculated holidays

Date_Holidays_Driver::_findBestLocale()

Finds the best internally available locale for the specified one

Date_Holidays_Driver::_removeHoliday()

Remove a holiday from internal storage

Class Details

[line 30]
class that calculates observed U.S. holidays

Author: Kevin English <mailto:kevin@x5dev.com>
Version: $Id: USA.php,v 1.2 2005/12/22 21:10:14 luckec Exp $

Method Detail

Date_Holidays_Driver_USA (Constructor) [line 39]

Date_Holidays_Driver_USA Date_Holidays_Driver_USA(
)

Constructor

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

Access: protected

[ Top ]

_buildHolidays [line 50]

boolean _buildHolidays(
)

Build the internal arrays that contain data about the calculated holidays

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

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

[ Top ]

Class: Date_Holidays_Driver_USA

Class Overview

Author(s):

Version:

Methods

Inherited Variables

Class: Date_Holidays_Driver

Inherited Methods

Class: Date_Holidays_Driver

Class Details

Method Detail

Date_Holidays_Driver_USA (Constructor) [line 39]

_buildHolidays [line 50]