Docs For Class Date_Holidays

Class: Date_Holidays_Filter

Child classes:

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_Composite: Class that acts like a single filter but actually is a compound of an arbitrary number of filters.

Date_Holidays_Filter_Whitelist: Class that represents a filter which has knowledge about the holidays that driver-calculations are limited to.

Inherited Variables

Inherited Methods

Class Details

[line 30]
Baseclass for a holiday-filter.

Abstract:
Author: Carsten Lucke <mailto:luckec@tool-garage.de>
Version: $Id: Filter.php,v 1.3 2005/09/11 15:27:21 luckec Exp $

Method Detail

Date_Holidays_Filter (Constructor) [line 65]

Date_Holidays_Filter Date_Holidays_Filter(
array
$holidays)

Constructor.

Creates a new filter that knows, which holidays the calculating driver shall be restricted to.

Parameters:

array $holidays — numerical array that contains internal names of holidays

[ Top ]

accept [line 99]

boolean accept(
string
$internalName)

Lets the filter decide whether a holiday shall be processed or not.

Return: true, if a holidays shall be processed, false otherwise
Abstract:

Overridden in child classes as:

Date_Holidays_Filter_Blacklist::accept(): Lets the filter decide whether a holiday shall be processed or not.

Date_Holidays_Filter_Composite::accept(): Lets the filter decide whether a holiday shall be processed or not.

Date_Holidays_Filter_Whitelist::accept(): Lets the filter decide whether a holiday shall be processed or not.

Parameters:

string $internalName — a holidays' internal name

[ Top ]

getFilteredHolidays [line 75]

array getFilteredHolidays(
)

Returns the internal names of holidays that are subject to the filter.

Return: internal holiday-names

[ Top ]

setFilteredHolidays [line 84]

void setFilteredHolidays(
array
$holidays)

Sets the internal names of holidays that are subject to the filter.

Parameters:

array $holidays — internal holiday-names

[ Top ]

Class: Date_Holidays_Filter

Class Overview

Author(s):

Version:

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Method Detail

Date_Holidays_Filter (Constructor) [line 65]

Parameters:

accept [line 99]

Parameters:

getFilteredHolidays [line 75]

setFilteredHolidays [line 84]

Parameters: