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

Class: Date_Holidays_Filter_Composite

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

Class Overview

Date_Holidays_Filter
   |
   --Date_Holidays_Filter_Composite

Class that acts like a single filter but actually is a compound of an arbitrary number of filters.


Author(s):

Version:

  • CVS: $Id$

Methods


Inherited Variables

Inherited Methods

Class: Date_Holidays_Filter

Date_Holidays_Filter::__construct()
Constructor.
Date_Holidays_Filter::Date_Holidays_Filter()
Constructor.
Date_Holidays_Filter::accept()
Lets the filter decide whether a holiday shall be processed or not.
Date_Holidays_Filter::getFilteredHolidays()
Returns the internal names of holidays that are subject to the filter.
Date_Holidays_Filter::setFilteredHolidays()
Sets the internal names of holidays that are subject to the filter.

Class Details

[line 45]
Class that acts like a single filter but actually is a compound of an arbitrary number of filters.


[ Top ]


Method Detail

Date_Holidays_Filter_Composite (Constructor)   [line 66]

Date_Holidays_Filter_Composite Date_Holidays_Filter_Composite( )

Constructor.

[ Top ]

__construct (Constructor)   [line 58]

Date_Holidays_Filter_Composite __construct( )

Constructor.

Overrides Date_Holidays_Filter::__construct() (Constructor.)
[ Top ]

accept   [line 78]

boolean accept( string $holiday)

Lets the filter decide whether a holiday shall be processed or not.
  • Return: true, if a holidays shall be processed, false otherwise

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

Parameters:

string   $holiday     a holidays' internal name

[ Top ]

addFilter   [line 96]

boolean addFilter( Date_Holidays_Filter $filter)

Add a filter to the compound.
  • Return: true on success, false otherwise
  • Access: public

Parameters:

Date_Holidays_Filter   $filter     filter object

[ Top ]

removeFilter   [line 116]

boolean removeFilter( Date_Holidays_Filter $filter)

Remove a filter from the compound.
  • Return: true on success, otherwise a PEAR_Error object
  • Throws: PEAR_Error DATE_HOLIDAYS_FILTER_NOT_FOUND
  • Access: public

Parameters:

Date_Holidays_Filter   $filter     filter object

[ Top ]


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