CalendR
Fork me on Github

Class CalendR\Period\ Day

Represents a Day


Inherits from: PeriodAbstract

Constants

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

Methods

__construct( DateTime $begin, int $firstWeekday = Day::MONDAY)

DateTime getBegin()

from PeriodAbstract
DateTime getEnd()

from PeriodAbstract
bool contains( DateTime $date)

Checks if the given period is contained in the current period

 from PeriodAbstract
bool equals( PeriodInterface $period)

Checks if a period is equals to an other

 from PeriodAbstract
bool includes( PeriodInterface $period, bool $strict = true)

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

 from PeriodAbstract
boolean containsEvent( EventInterface $event)

Returns if $event is during this period.

 from PeriodAbstract
string format( string $format)

Format the period to a string

 from PeriodAbstract
bool isCurrent()

Returns if the current period is the current one

 from PeriodAbstract
PeriodInterface getNext()

Gets the next period of the same type

 from PeriodAbstract
PeriodInterface getPrevious()

Gets the previous period of the same type

 from PeriodAbstract
setFirstWeekday( int $firstWeekday)

from PeriodAbstract
int getFirstWeekday()

from PeriodAbstract
DatePeriod getDatePeriod()

Returns the period as a DatePeriod
string __toString()

Returns the day name (probably in english)
static bool isValid( DateTime $start)

static DateInterval getDateInterval()

Returns a \DateInterval equivalent to the period

Details

public __construct( DateTime $begin, int $firstWeekday = Day::MONDAY)

Parameters
DateTime $begin
int $firstWeekday

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

public DatePeriod getDatePeriod()

Returns the period as a DatePeriod

Return Value
DatePeriod

public string __toString()

Returns the day name (probably in english)

Return Value
string

static public bool isValid( DateTime $start)

Parameters
DateTime $start
Return Value
bool

static public DateInterval getDateInterval()

Returns a \DateInterval equivalent to the period

Return Value
DateInterval