Class: Date_Holidays_Driver_Composite

Date_Holidays_Driver_Composite Date_Holidays_Driver_Composite( )

Constructor

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

void addDriver( object Date_Holidays_Driver $driver)

Add a driver component

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

Parameters:

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

Returns the specified holiday

Return format:

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

Overrides Date_Holidays_Driver::getHoliday() (Returns the specified holiday)

Parameters:

object Date getHolidayDate( string $internalName)

Returns date of a holiday

Overrides Date_Holidays_Driver::getHolidayDate() (Returns date of a holiday)

Parameters:

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

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

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

Parameters:

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
   )
 )
 

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

Parameters:

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

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'
       ),
       ...
   )
 

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

Parameters:

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

Returns localized title for a holiday

Overrides Date_Holidays_Driver::getHolidayTitle() (Returns localized title for a holiday)

Parameters:

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

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

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

Parameters:

array getInternalHolidayNames( )

Returns the internal names of holidays that were calculated

If two or more drivers in the compound have equal internal-names, then those ones of the highest priorized driver will be taken.

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

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

This method is only available to keep abstraction working.

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

boolean isHoliday( mixed $date)

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.

Overrides Date_Holidays_Driver::isHoliday() (Determines whether a date represents a holiday or not)

Parameters:

boolean removeDriver( object Date_Holidays_Driver $driver)

Remove a driver component

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

Parameters:

void setLocale( mixed $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.

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

void setYear( mixed $year)

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.

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