Docs For Class DayIterator

Description

Implements interfaces:

Iterator (internal interface)

Implementation of simple day iterator

version: 1.03
author: Michal "Techi" Vrchota <michal.vrchota@seznam.cz>
license: GPL
since: PHP 5

Direct descendents

Class	Description
HotelAlotment	Implementation of simple day iterator
SeasonDayIterator	Class DayIterator

Variable Summary

integer $currentDate

integer $currentDay

integer $from

integer $to

Method Summary

DayIterator __construct (integer $from, integer $to)

mixed current ()

integer getDiffDays ()

integer getFrom ()

integer getTo ()

bool isBetween (integer $time)

integer key ()

void next ()

void rewind ()

bool valid ()

Variables

integer $currentDate (line 37)

var: unix timestamp
access: protected

integer $currentDay (line 43)

access: protected

integer $from (line 25)

var: unix timestamp
access: protected

integer $to (line 31)

var: unix timestamp
access: protected

Methods

Constructor __construct (line 52)

Constructor

access: public

DayIterator __construct (integer $from, integer $to)

integer $from: unix timestamp - hour, min and sec should be equal to 0
integer $to: unix timestamp - hour, min and sec should be equal to 0

Redefined in descendants as:

HotelAlotment::__construct()
SeasonDayIterator::__construct() : Constructor

current (line 123)

access: public

mixed current ()

Implementation of:

Iterator::current

getDiffDays (line 99)

Computes total number of days

return: number of days
access: public

integer getDiffDays ()

getFrom (line 79)

return: period-from
access: public

integer getFrom ()

Redefined in descendants as:

HotelAlotment::getFrom()

getTo (line 88)

return: period-to
access: public

integer getTo ()

Redefined in descendants as:

HotelAlotment::getTo()

isBetween (line 70)

check if given $time is inside given range

return: true if $time is in range
access: public

bool isBetween (integer $time)

integer $time: unix timestamp - hour, min and sec should be equal to 0

key (line 114)

access: public

integer key ()

Implementation of:

Iterator::key

next (line 128)

access: public

void next ()

Implementation of:

Iterator::next

rewind (line 104)

access: public

void rewind ()

Implementation of:

Iterator::rewind

valid (line 138)

access: public

bool valid ()

Implementation of:

Iterator::valid