PHP Class Yasumi\Filters\BetweenFilter

Filters all holidays between the given start and end date. An additional parameter can be used to identify if the start and end date need to be included in the comparison. Note: this class can be used separately, however is implemented by the AbstractProvider::between method.
Inheritance: extends FilterIterato\FilterIterator
显示文件 Open project: azuyalabs/yasumi

Public Methods

Method Description
__construct ( Iterator $iterator, DateTime $start_date, DateTime $end_date, boolean $equal = true ) Construct the Between FilterIterator Object
accept ( ) : boolean

Method Details

__construct() public method

Construct the Between FilterIterator Object
public __construct ( Iterator $iterator, DateTime $start_date, DateTime $end_date, boolean $equal = true )
$iterator Iterator Iterator object of the Holidays Provider
$start_date DateTime Start date of the time frame to check against
$end_date DateTime End date of the time frame to check against
$equal boolean Indicate whether the start and end dates should be included in the comparison

accept() public method

public accept ( ) : boolean
return boolean Check whether the current element of the iterator is acceptable