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

Class: Date_Holidays_Filter

Source Location: /Date_Holidays-0.21.8/Date/Holidays/Filter.php

Class Overview


Baseclass for a holiday-filter.


Author(s):

Version:

  • CVS: $Id$

Methods


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_Whitelist
Class that represents a filter which has knowledge about the holidays that driver-calculations are limited to.
Date_Holidays_Filter_Composite
Class that acts like a single filter but actually is a compound of an arbitrary number of filters.

Inherited Variables

Inherited Methods


Class Details

[line 37]
Baseclass for a holiday-filter.


[ Top ]


Method Detail

Date_Holidays_Filter (Constructor)   [line 74]

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 ]

__construct (Constructor)   [line 56]

Date_Holidays_Filter __construct( array $holidays)

Constructor.

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


Overridden in child classes as:

Date_Holidays_Filter_Blacklist::__construct()
Constructor.
Date_Holidays_Filter_Whitelist::__construct()
Constructor.
Date_Holidays_Filter_Composite::__construct()
Constructor.

Parameters:

array   $holidays     numerical array that contains internal names of holidays

[ Top ]

accept   [line 113]

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_Whitelist::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.

Parameters:

string   $internalName     a holidays' internal name

[ Top ]

getFilteredHolidays   [line 84]

array getFilteredHolidays( )

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

[ Top ]

setFilteredHolidays   [line 96]

void setFilteredHolidays( array $holidays)

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

Parameters:

array   $holidays     internal holiday-names

[ Top ]


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