Class CalendR\Period\ PeriodAbstract

An abstract class that represent a date period and provide some base helpers

Methods

	__construct( int $firstWeekday = Day::MONDAY)
DateTime	getBegin()
DateTime	getEnd()
bool	contains( DateTime $date) Checks if the given period is contained in the current period
bool	equals( PeriodInterface $period) Checks if a period is equals to an other
bool	includes( PeriodInterface $period, bool $strict = true) Returns true if the period include the other period given as argument
boolean	containsEvent( EventInterface $event) Returns if $event is during this period.
string	format( string $format) Format the period to a string
bool	isCurrent() Returns if the current period is the current one
PeriodInterface	getNext() Gets the next period of the same type
PeriodInterface	getPrevious() Gets the previous period of the same type
	setFirstWeekday( int $firstWeekday)
int	getFirstWeekday()

Details

`public __construct( int $firstWeekday = Day::MONDAY)`

Parameters

int

$firstWeekday

Exceptions

NotAWeekDay

`public DateTime getBegin()`

Return Value

DateTime

`public DateTime getEnd()`

Return Value

DateTime

`public bool contains( DateTime $date)`

Checks if the given period is contained in the current period

Parameters

DateTime

$date

Return Value

bool	true if the period contains this date

`public bool equals( PeriodInterface $period)`

Checks if a period is equals to an other

Parameters

PeriodInterface

$period

Return Value

bool

`public bool includes( PeriodInterface $period, bool $strict = true)`

Returns true if the period include the other period given as argument

Parameters

PeriodInterface	$period
bool	$strict

Return Value

bool

`public boolean containsEvent( EventInterface $event)`

Returns if $event is during this period.

Non strict. Must return true if : * Event is during period * Period is during event * Event begin is during Period * Event end is during Period

Parameters

EventInterface

$event

Return Value

boolean

`public string format( string $format)`

Format the period to a string

Parameters

string

$format

Return Value

string

`public bool isCurrent()`

Returns if the current period is the current one

Return Value

bool

`public PeriodInterface getNext()`

Gets the next period of the same type

Return Value

PeriodInterface

`public PeriodInterface getPrevious()`

Gets the previous period of the same type

Return Value

PeriodInterface

`public setFirstWeekday( int $firstWeekday)`

Parameters

int

$firstWeekday

`public int getFirstWeekday()`

Return Value

int