Date_Holidays
[ class tree: Date_Holidays ] [ index: Date_Holidays ] [ all elements ]

Element index for package Date_Holidays

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ j ] [ r ] [ s ] [ t ] [ u ] [ w ] [ _ ]

_

_getModulesFromDir
in file Holidays.php, method Date_Holidays::_getModulesFromDir()
    Fetch all modules from a directory and its subdirectories
__construct
in file Filter.php, method Date_Holidays_Filter::__construct()
    Constructor.
$_dates
in file Driver.php, variable Date_Holidays_Driver::$_dates
    dates of the available holidays
$_driverName
in file Christian.php, variable Date_Holidays_Driver_Christian::$_driverName
    this driver's name
$_driverName
in file EasternChristian.php, variable Date_Holidays_Driver_EasternChristian::$_driverName
    this driver's name
$_driverName
in file Driver.php, variable Date_Holidays_Driver::$_driverName
    this driver's name
$_driverName
in file Composite.php, variable Date_Holidays_Driver_Composite::$_driverName
    this driver's name
$_driverName
in file Jewish.php, variable Date_Holidays_Driver_Jewish::$_driverName
    this driver's name
$_holidays
in file Driver.php, variable Date_Holidays_Driver::$_holidays
    array of the available holidays indexed by date
$_internalNames
in file Driver.php, variable Date_Holidays_Driver::$_internalNames
    internal names for the available holidays
$_locale
in file Driver.php, variable Date_Holidays_Driver::$_locale
    locale setting for output
$_titles
in file Driver.php, variable Date_Holidays_Driver::$_titles
    localized names of the available holidays
$_year
in file Driver.php, variable Date_Holidays_Driver::$_year
    object's current year
_addDays
in file Driver.php, method Date_Holidays_Driver::_addDays()
    Converts the date to the specified no of days from the given date
_addHoliday
in file Driver.php, method Date_Holidays_Driver::_addHoliday()
    Adds a holiday to the driver's holidays
_addStaticHolidays
in file Driver.php, method Date_Holidays_Driver::_addStaticHolidays()
    Adds all holidays in the array to the driver's internal list of holidays.
_addStringPropertiesForHoliday
in file Driver.php, method Date_Holidays_Driver::_addStringPropertiesForHoliday()
    Adds a arbitrary number of localized string-properties for the specified holiday.
_addStringPropertyForHoliday
in file Driver.php, method Date_Holidays_Driver::_addStringPropertyForHoliday()
    Adds a localized (regrading translation etc.) string-property for a holiday.
_addTranslationData
in file Driver.php, method Date_Holidays_Driver::_addTranslationData()
    Add a language-file's content. Translations, properties, etc. for holidays will be made available with the specified locale.
_addTranslationForHoliday
in file Driver.php, method Date_Holidays_Driver::_addTranslationForHoliday()
    Add a localized translation for a holiday's title. Overwrites existing data.
_buildHolidays
in file Christian.php, method Date_Holidays_Driver_Christian::_buildHolidays()
    Build the internal arrays that contain data about the calculated holidays
_buildHolidays
in file EasternChristian.php, method Date_Holidays_Driver_EasternChristian::_buildHolidays()
    Build the internal arrays that contain data about the calculated holidays
_buildHolidays
in file Jewish.php, method Date_Holidays_Driver_Jewish::_buildHolidays()
    Build the internal arrays that contain data about the calculated holidays
_buildHolidays
in file Driver.php, method Date_Holidays_Driver::_buildHolidays()
    Build the internal arrays that contain data about the calculated holidays
_buildHolidays
in file creating_drivers.php, method Date_Holidays_Driver_Example::_buildHolidays()
    Build the internal arrays that contain data about the calculated holidays
_findBestLocale
in file Driver.php, method Date_Holidays_Driver::_findBestLocale()
    Finds the best internally available locale for the specified one
_removeHoliday
in file Driver.php, method Date_Holidays_Driver::_removeHoliday()
    Remove a holiday from internal storage
__construct
in file Whitelist.php, method Date_Holidays_Filter_Whitelist::__construct()
    Constructor.
__construct
in file Composite.php, method Date_Holidays_Filter_Composite::__construct()
    Constructor.
__construct
in file Blacklist.php, method Date_Holidays_Filter_Blacklist::__construct()
    Constructor.
top

a

accept
in file Filter.php, method Date_Holidays_Filter::accept()
    Lets the filter decide whether a holiday shall be processed or not.
addingTranslations.php
procedural page addingTranslations.php
addCompiledTranslationFile
in file Driver.php, method Date_Holidays_Driver::addCompiledTranslationFile()
    Add a compiled language-file's content
addDriver
in file Composite.php, method Date_Holidays_Driver_Composite::addDriver()
    Add a driver component
addDriver
in file Driver.php, method Date_Holidays_Driver::addDriver()
    Add a driver component
addTranslation
in file Driver.php, method Date_Holidays_Driver::addTranslation()
    addTranslation
addTranslationFile
in file Driver.php, method Date_Holidays_Driver::addTranslationFile()
    Add a language-file's content
accept
in file Whitelist.php, method Date_Holidays_Filter_Whitelist::accept()
    Lets the filter decide whether a holiday shall be processed or not.
accept
in file Composite.php, method Date_Holidays_Filter_Composite::accept()
    Lets the filter decide whether a holiday shall be processed or not.
accept
in file Blacklist.php, method Date_Holidays_Filter_Blacklist::accept()
    Lets the filter decide whether a holiday shall be processed or not.
addFilter
in file Composite.php, method Date_Holidays_Filter_Composite::addFilter()
    Add a filter to the compound.
top

b

Blacklist.php
procedural page Blacklist.php
top

c

calcEaster
in file EasternChristian.php, method Date_Holidays_Driver_EasternChristian::calcEaster()
    Calculates date for Easter using the Gaussian algorithm.
calcEaster
in file Christian.php, method Date_Holidays_Driver_Christian::calcEaster()
    Calculates date for Easter using the Gaussian algorithm.
Christian.php
procedural page Christian.php
Composite.php
procedural page Composite.php
creating_drivers.php
procedural page creating_drivers.php
Composite.php
procedural page Composite.php
top

d

Date_Holidays
in file Holidays.php, method Date_Holidays::Date_Holidays()
    Constructor
Date_Holidays
in file Holidays.php, class Date_Holidays
    class that helps you to locate holidays for a year
DATE_HOLIDAYS_ERROR_DRIVERFILE_NOT_FOUND
in file Holidays.php, constant DATE_HOLIDAYS_ERROR_DRIVERFILE_NOT_FOUND
    could not find file of driver-class
DATE_HOLIDAYS_ERROR_INVALID_ARGUMENT
in file Holidays.php, constant DATE_HOLIDAYS_ERROR_INVALID_ARGUMENT
    invalid argument was passed to a method
DATE_HOLIDAYS_ERROR_MISSING_DRIVER_DIR
in file Holidays.php, constant DATE_HOLIDAYS_ERROR_MISSING_DRIVER_DIR
    Driver directory does not exist
DATE_HOLIDAYS_ERROR_MISSING_FILTER_DIR
in file Holidays.php, constant DATE_HOLIDAYS_ERROR_MISSING_FILTER_DIR
    Filter directory does not exist
Date_Holidays_Filter
in file Filter.php, method Date_Holidays_Filter::Date_Holidays_Filter()
    Constructor.
Date_Holidays_Filter
in file Filter.php, class Date_Holidays_Filter
    Baseclass for a holiday-filter.
Date_Holidays_Holiday
in file Holiday.php, method Date_Holidays_Holiday::Date_Holidays_Holiday()
    Constructor
Date_Holidays_Holiday
in file Holiday.php, class Date_Holidays_Holiday
    Simple class that wraps a holiday's data
Driver.php
procedural page Driver.php
DATE_HOLIDAYS_DATE_UNAVAILABLE
in file Driver.php, constant DATE_HOLIDAYS_DATE_UNAVAILABLE
    date for a holiday is not available
Date_Holidays_Driver
in file Driver.php, class Date_Holidays_Driver
    class that helps you to locate holidays for a year
Date_Holidays_Driver
in file Driver.php, method Date_Holidays_Driver::Date_Holidays_Driver()
    Constructor
Date_Holidays_Driver_Christian
in file Christian.php, class Date_Holidays_Driver_Christian
    class that calculates Christian holidays
Date_Holidays_Driver_Christian
in file Christian.php, method Date_Holidays_Driver_Christian::Date_Holidays_Driver_Christian()
    Constructor
Date_Holidays_Driver_Composite
in file Composite.php, class Date_Holidays_Driver_Composite
    Composite driver - you can use this one to combine two or more drivers
Date_Holidays_Driver_Composite
in file Composite.php, method Date_Holidays_Driver_Composite::Date_Holidays_Driver_Composite()
    Constructor
Date_Holidays_Driver_EasternChristian
in file EasternChristian.php, method Date_Holidays_Driver_EasternChristian::Date_Holidays_Driver_EasternChristian()
    Constructor
Date_Holidays_Driver_EasternChristian
in file EasternChristian.php, class Date_Holidays_Driver_EasternChristian
    class that calculates Eastern Christian holidays
Date_Holidays_Driver_Example
in file creating_drivers.php, class Date_Holidays_Driver_Example
    Example how to create an own driver-class for Date_Holidays
Date_Holidays_Driver_Example
in file creating_drivers.php, method Date_Holidays_Driver_Example::Date_Holidays_Driver_Example()
    Constructor
DATE_HOLIDAYS_DRIVER_IDENTIFY_ISO3166_METHOD
in file Driver.php, constant DATE_HOLIDAYS_DRIVER_IDENTIFY_ISO3166_METHOD
    Name of the static Date_Holidays_Driver method returning a array of possible ISO3166 codes that identify itself.
Date_Holidays_Driver_Jewish
in file Jewish.php, method Date_Holidays_Driver_Jewish::Date_Holidays_Driver_Jewish()
    Constructor
Date_Holidays_Driver_Jewish
in file Jewish.php, class Date_Holidays_Driver_Jewish
    class that calculates Jewish holidays
DATE_HOLIDAYS_DRIVER_NOT_FOUND
in file Composite.php, constant DATE_HOLIDAYS_DRIVER_NOT_FOUND
    driver not found
DATE_HOLIDAYS_INVALID_DATE
in file Driver.php, constant DATE_HOLIDAYS_INVALID_DATE
    date could not be converted into a PEAR::Date object
DATE_HOLIDAYS_INVALID_DATE_FORMAT
in file Driver.php, constant DATE_HOLIDAYS_INVALID_DATE_FORMAT
    string that represents a date has wrong format
DATE_HOLIDAYS_INVALID_INTERNAL_NAME
in file Driver.php, constant DATE_HOLIDAYS_INVALID_INTERNAL_NAME
    invalid internal name
DATE_HOLIDAYS_LANGUAGEFILE_NOT_FOUND
in file Driver.php, constant DATE_HOLIDAYS_LANGUAGEFILE_NOT_FOUND
    language-file doesn't exist
DATE_HOLIDAYS_TITLE_UNAVAILABLE
in file Driver.php, constant DATE_HOLIDAYS_TITLE_UNAVAILABLE
    title for a holiday is not available
DATE_HOLIDAYS_UNABLE_TO_READ_TRANSLATIONDATA
in file Driver.php, constant DATE_HOLIDAYS_UNABLE_TO_READ_TRANSLATIONDATA
    unable to read language-file
Date_Holidays_Filter_Blacklist
in file Blacklist.php, class Date_Holidays_Filter_Blacklist
    Class that represents a filter which has knowledge about the holidays that must be excluded from driver-calculations.
Date_Holidays_Filter_Blacklist
in file Blacklist.php, method Date_Holidays_Filter_Blacklist::Date_Holidays_Filter_Blacklist()
    Constructor.
Date_Holidays_Filter_Composite
in file Composite.php, method Date_Holidays_Filter_Composite::Date_Holidays_Filter_Composite()
    Constructor.
Date_Holidays_Filter_Composite
in file Composite.php, class Date_Holidays_Filter_Composite
    Class that acts like a single filter but actually is a compound of an arbitrary number of filters.
DATE_HOLIDAYS_FILTER_NOT_FOUND
in file Composite.php, constant DATE_HOLIDAYS_FILTER_NOT_FOUND
    Filter not found
Date_Holidays_Filter_Whitelist
in file Whitelist.php, method Date_Holidays_Filter_Whitelist::Date_Holidays_Filter_Whitelist()
    Constructor.
Date_Holidays_Filter_Whitelist
in file Whitelist.php, class Date_Holidays_Filter_Whitelist
    Class that represents a filter which has knowledge about the holidays that driver-calculations are limited to.
top

e

errorsOccurred
in file Holidays.php, method Date_Holidays::errorsOccurred()
    Checks whether errors occured
EasternChristian.php
procedural page EasternChristian.php
top

f

Filter.php
procedural page Filter.php
fetchingInstalledDrivers.php
procedural page fetchingInstalledDrivers.php
factory
in file Holidays.php, method Date_Holidays::factory()
    Factory method that creates a driver-object
factoryISO3166
in file Holidays.php, method Date_Holidays::factoryISO3166()
    Factory method that creates a driver-object
top

g

getDate
in file Holiday.php, method Date_Holidays_Holiday::getDate()
    Returns the date
getErrors
in file Holidays.php, method Date_Holidays::getErrors()
    Returns the errors the error-stack contains
getErrorStack
in file Holidays.php, method Date_Holidays::getErrorStack()
    Returns the error-stack
getFilteredHolidays
in file Filter.php, method Date_Holidays_Filter::getFilteredHolidays()
    Returns the internal names of holidays that are subject to the filter.
getInstalledDrivers
in file Holidays.php, method Date_Holidays::getInstalledDrivers()
    Returns a list of the installed drivers
getInstalledFilters
in file Holidays.php, method Date_Holidays::getInstalledFilters()
    Returns a list of the installed filters
getInternalName
in file Holiday.php, method Date_Holidays_Holiday::getInternalName()
    Returns the internal name
getProperties
in file Holiday.php, method Date_Holidays_Holiday::getProperties()
    Returns the holidays additional properties that contain information like a more detailed description, etc.
getTitle
in file Holiday.php, method Date_Holidays_Holiday::getTitle()
    Returns the title
getHoliday
in file Composite.php, method Date_Holidays_Driver_Composite::getHoliday()
    Returns the specified holiday
getHoliday
in file Driver.php, method Date_Holidays_Driver::getHoliday()
    Returns the specified holiday
getHolidayDate
in file Driver.php, method Date_Holidays_Driver::getHolidayDate()
    Returns date of a holiday
getHolidayDate
in file Composite.php, method Date_Holidays_Driver_Composite::getHolidayDate()
    Returns date of a holiday
getHolidayDates
in file Driver.php, method Date_Holidays_Driver::getHolidayDates()
    Returns dates of all holidays or those accepted by the applied filter.
getHolidayDates
in file Composite.php, method Date_Holidays_Driver_Composite::getHolidayDates()
    Returns dates of all holidays or those accepted by the specified filter.
getHolidayForDate
in file Composite.php, method Date_Holidays_Driver_Composite::getHolidayForDate()
    Returns the title of the holiday, if any was found, matching the specified date.
getHolidayForDate
in file Driver.php, method Date_Holidays_Driver::getHolidayForDate()
    Returns a
object, if any was found, matching the specified date.
getHolidayProperties
in file Driver.php, method Date_Holidays_Driver::getHolidayProperties()
    Returns the localized properties of a holiday. If no properties have been stored an empty array will be returned.
getHolidays
in file Composite.php, method Date_Holidays_Driver_Composite::getHolidays()
    Returns all holidays that were found
getHolidays
in file Driver.php, method Date_Holidays_Driver::getHolidays()
    Returns all holidays that the driver knows.
getHolidaysForDatespan
in file Driver.php, method Date_Holidays_Driver::getHolidaysForDatespan()
    Returns an array containing a number of
items.
getHolidayTitle
in file Composite.php, method Date_Holidays_Driver_Composite::getHolidayTitle()
    Returns localized title for a holiday
getHolidayTitle
in file Driver.php, method Date_Holidays_Driver::getHolidayTitle()
    Returns localized title for a holiday
getHolidayTitles
in file Composite.php, method Date_Holidays_Driver_Composite::getHolidayTitles()
    Returns localized titles of all holidays or those specififed in $restrict array
getHolidayTitles
in file Driver.php, method Date_Holidays_Driver::getHolidayTitles()
    Returns localized titles of all holidays or those accepted by the filter
getInternalHolidayNames
in file Driver.php, method Date_Holidays_Driver::getInternalHolidayNames()
    Returns the internal names of holidays that were calculated
getISO3166Codes
in file Driver.php, method Date_Holidays_Driver::getISO3166Codes()
    Method that returns an array containing the ISO3166 codes that may possibly identify a driver.
getYear
in file Driver.php, method Date_Holidays_Driver::getYear()
    Returns the driver's current year
getYear
in file Composite.php, method 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

h

Holiday.php
procedural page Holiday.php
Holidays.php
procedural page Holidays.php
top

i

isError
in file Holidays.php, method Date_Holidays::isError()
    Checks a variable to determine whether it represents an error object or not
isHoliday
in file Driver.php, method Date_Holidays_Driver::isHoliday()
    Determines whether a date represents a holiday or not
isHoliday
in file Composite.php, method Date_Holidays_Driver_Composite::isHoliday()
    Determines whether a date represents a holiday or not.
top

j

Jewish.php
procedural page Jewish.php
top

r

raiseError
in file Holidays.php, method Date_Holidays::raiseError()
    Pushes a new error on the error-stack and returns a PEAR_Error object
removeDriver
in file Composite.php, method Date_Holidays_Driver_Composite::removeDriver()
    Remove a driver component
removeDriver
in file Driver.php, method Date_Holidays_Driver::removeDriver()
    Remove a driver component
removeFilter
in file Composite.php, method Date_Holidays_Filter_Composite::removeFilter()
    Remove a filter from the compound.
top

s

setDate
in file Holiday.php, method Date_Holidays_Holiday::setDate()
    Set the date
setFilteredHolidays
in file Filter.php, method Date_Holidays_Filter::setFilteredHolidays()
    Sets the internal names of holidays that are subject to the filter.
setInternalName
in file Holiday.php, method Date_Holidays_Holiday::setInternalName()
    Set the internal name
setTitle
in file Holiday.php, method Date_Holidays_Holiday::setTitle()
    Set the title
staticGetProperty
in file Holidays.php, method Date_Holidays::staticGetProperty()
    Returns an internal property value
staticSetProperty
in file Holidays.php, method Date_Holidays::staticSetProperty()
    Set a property for the Date_Holidays drivers
setLocale
in file Driver.php, method Date_Holidays_Driver::setLocale()
    Sets the driver's locale
setLocale
in file Composite.php, method 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.
setYear
in file Driver.php, method Date_Holidays_Driver::setYear()
    Sets the driver's current year
setYear
in file Composite.php, method Date_Holidays_Driver_Composite::setYear()
    This (re)sets the year of every driver-object in the compound.
top

t

toArray
in file Holiday.php, method Date_Holidays_Holiday::toArray()
    Returns the holiday data as an array.
top

u

usingCompositeDriver.php
procedural page usingCompositeDriver.php
usingStandaloneDriver.php
procedural page usingStandaloneDriver.php
top

w

Whitelist.php
procedural page Whitelist.php
top

Documentation generated on Tue, 22 Jan 2013 01:00:05 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.