Docs For Class Date_Holidays_Driver

Date_Holidays_Driver_Composite Date_Holidays_Driver_Composite(
)

Constructor

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

Access: protected

[ Top ]

boolean addDriver(
object Date_Holidays_Driver
$driver)

Add a driver component

Return: true on success, false otherwise
Access: public

Overrides Date_Holidays_Driver::addDriver() (Add a driver component)

Parameters:

object Date_Holidays_Driver $driver — driver-object

[ 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_Composite::getHolidayForDate()

Overrides Date_Holidays_Driver::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
Access: public

Overrides Date_Holidays_Driver::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 specified filter.

Return: array with holidays' dates on success, otherwise a PEAR_ErrorStack object
Throws: object PEAR_ErrorStack DATE_HOLIDAYS_INVALID_INTERNAL_NAME
Access: public

Overrides Date_Holidays_Driver::getHolidayDates() (Returns dates of all holidays or those accepted by the applied 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 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_Composite::getHoliday()
Access: public
Uses: Date_Holidays_Driver_Composite::getHoliday()
Uses: Date_Holidays_Driver_Composite::getHolidayTitle()

Overrides Date_Holidays_Driver::getHolidayForDate() (Returns a

Date_Holidays_Holiday

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

Returns all holidays that were found

Return format:

   array(
       'easter' =>  array(
           'title' =>  'Easter Sunday'
           'date'  =>  '2004-04-11'
       ),
       'eastermonday'  =>  array(
           'title' =>  'Easter Monday'
           'date'  =>  '2004-04-12'
       ),
       ...
   )

Return: numeric array containing objects of Date_Holidays_Holiday on success, otherwise a PEAR_ErrorStack object
Throws: object PEAR_ErrorStack DATE_HOLIDAYS_INVALID_INTERNAL_NAME
Access: public

Overrides Date_Holidays_Driver::getHolidays() (Returns all holidays that the driver knows.)

Parameters:

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

[ 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_Composite::getHolidayForDate()

Overrides Date_Holidays_Driver::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 specififed in $restrict array

Return: array with localized holiday titles on success, otherwise a PEAR_Error object
Throws: object PEAR_Error DATE_HOLIDAYS_INVALID_INTERNAL_NAME
Access: public

Overrides Date_Holidays_Driver::getHolidayTitles() (Returns localized titles of all holidays or those accepted by the filter)

Parameters:

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

[ Top ]

void 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.

This method is only available to keep abstraction working.

Access: public

Overrides Date_Holidays_Driver::getYear() (Returns the driver's current year)

[ Top ]

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

Determines whether a date represents a holiday or not.

The method searches all added drivers for this date, to determine whether it's a holiday.

Return: true if date represents a holiday, otherwise false
Access: public

Overrides Date_Holidays_Driver::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

Overrides Date_Holidays_Driver::removeDriver() (Remove a driver component)

Parameters:

object Date_Holidays_Driver $driver — driver-object

[ Top ]

void setLocale(

$locale)

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.

This method is only available to keep abstraction working.

Access: public

Overrides Date_Holidays_Driver::setLocale() (Sets the driver's locale)

Parameters:

$locale —

[ Top ]

boolean setYear(
int
$year)

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

Note that this will cause every attached driver to recalculate the holidays!

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

Overrides Date_Holidays_Driver::setYear() (Sets the driver's current year)

Parameters:

int $year — year

[ Top ]

Class: Date_Holidays_Driver_Composite

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_Composite (Constructor) [line 62]

addDriver [line 84]

Parameters:

getHoliday [line 151]

Parameters:

getHolidayDate [line 175]

Parameters:

getHolidayDates [line 199]

Parameters:

getHolidayForDate [line 290]

Parameters:

getHolidays [line 344]

Parameters:

getHolidayTitle [line 406]

Parameters:

getHolidayTitles [line 431]

Parameters:

getYear [line 491]

isHoliday [line 531]

Parameters:

removeDriver [line 107]

Parameters:

setLocale [line 550]

Parameters:

setYear [line 505]

Parameters: