Docs For Class Calendar

Calendar_Decorator (Constructor) [line 59]

Calendar_Decorator Calendar_Decorator(
object subclass
&$calendar)

Constructs the Calendar_Decorator

Parameters:

object subclass &$calendar — to Calendar to decorate

[ Top ]

adjust [line 113]

void adjust(
)

Adjusts the date (helper method)

Access: public

[ Top ]

build [line 228]

boolean build(
[array
$sDates = array()])

Build the children

Abstract:
Access: public

Overridden in child classes as:

MonthPayload_Decorator::build()

Parameters:

array $sDates — containing Calendar objects to select (optional)

[ Top ]

fetch [line 241]

mixed fetch(
)

Iterator method for fetching child Calendar subclass objects (e.g. a minute from an hour object). On reaching the end of the collection, returns false and resets the collection for further iteratations.

Return: either an object subclass of Calendar or false
Access: public

Overridden in child classes as:

Calendar_Decorator_Wrapper::fetch(): Wraps objects returned from fetch in the named Decorator class

MonthPayload_Decorator::fetch()

[ Top ]

fetchAll [line 251]

array fetchAll(
)

Fetches all child from the current collection of children

Access: public

Overridden in child classes as:

Calendar_Decorator_Wrapper::fetchAll(): Wraps the returned calendar objects from fetchAll in the named decorator

[ Top ]

getTimestamp [line 82]

int getTimestamp(
)

Returns a timestamp from the current date / time values. Format of

timestamp depends on Calendar_Engine implementation being used

Return: timestamp
Access: public

[ Top ]

getValidator [line 284]

Calendar_Validator &getValidator(
)

Returns an instance of Calendar_Validator

Access: public

[ Top ]

isEmpty [line 214]

boolean isEmpty(
)

Access: public

[ Top ]

isFirst [line 177]

boolean isFirst(
)

Returns true if Day object is first in a Week

Only relevant when Day is created by Calendar_Month_Weekdays::build()

Access: public

[ Top ]

isLast [line 189]

boolean isLast(
)

Returns true if Day object is last in a Week

Only relevant when Day is created by Calendar_Month_Weekdays::build()

Access: public

[ Top ]

isSelected [line 103]

boolean isSelected(
)

True if the calendar subclass object is selected (e.g. today)

Access: public

[ Top ]

isValid [line 274]

boolean isValid(
)

Determine whether this date is valid, with the bounds determined by

the Calendar_Engine. The call is passed on to Calendar_Validator::isValid

Access: public

[ Top ]

nextDay [line 453]

int nextDay(
[string
$format = 'int'])

Returns the value for the next day

Return: e.g. 12 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

nextHour [line 486]

int nextHour(
[string
$format = 'int'])

Returns the value for the next hour

Return: e.g. 14 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

nextMinute [line 519]

int nextMinute(
[string
$format = 'int'])

Returns the value for the next minute

Return: e.g. 25 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

nextMonth [line 361]

int nextMonth(
[string
$format = 'int'])

Returns the value for next month

Return: e.g. 6 or timestamp
Access: public

Overridden in child classes as:

MonthDecorator::nextMonth(): Override the nextMonth method to format the output

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

nextSecond [line 552]

int nextSecond(
[string
$format = 'int'])

Returns the value for the next second

Return: e.g. 45 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

nextWeek [line 412]

int nextWeek(
[string
$format = 'n_in_month'])

Returns the value for next week

Return: e.g. 6 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

nextYear [line 328]

int nextYear(
[string
$format = 'int'])

Returns the value for next year

Return: e.g. 2004 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

prevDay [line 432]

int prevDay(
[string
$format = 'int'])

Returns the value for the previous day

Return: e.g. 10 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

prevHour [line 464]

int prevHour(
[string
$format = 'int'])

Returns the value for the previous hour

Return: e.g. 13 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

prevMinute [line 497]

int prevMinute(
[string
$format = 'int'])

Returns the value for the previous minute

Return: e.g. 23 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

prevMonth [line 339]

int prevMonth(
[string
$format = 'int'])

Returns the value for the previous month

Return: e.g. 4 or Unix timestamp
Access: public

Overridden in child classes as:

MonthDecorator::prevMonth(): Override the prevMonth method to format the output

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

prevSecond [line 530]

int prevSecond(
[string
$format = 'int'])

Returns the value for the previous second

Return: e.g. 43 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

prevWeek [line 372]

int prevWeek(
[string
$format = 'n_in_month'])

Returns the value for the previous week

Return: e.g. 4 or Unix timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

prevYear [line 306]

int prevYear(
[string
$format = 'int'])

Returns the value for the previous year

Return: e.g. 2002 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

setSelected [line 93]

void setSelected(
[boolean
$state = true])

Defines calendar object as selected (e.g. for today)

Access: public

Parameters:

boolean $state — state whether Calendar subclass

[ Top ]

setTimestamp [line 71]

void setTimestamp(
int
$ts)

Defines the calendar by a Unix timestamp, replacing values

passed to the constructor

Access: public

Parameters:

int $ts — Unix timestamp

[ Top ]

size [line 262]

int size(
)

Get the number Calendar subclass objects stored in the internal collection.

Access: public

[ Top ]

thisDay [line 442]

int thisDay(
[string
$format = 'int'])

Returns the value for this day

Return: e.g. 11 or timestamp
Access: public

Overridden in child classes as:

MyBoldDecorator::thisDay()

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

thisHour [line 475]

int thisHour(
[string
$format = 'int'])

Returns the value for this hour

Return: e.g. 14 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

thisMinute [line 508]

int thisMinute(
[string
$format = 'int'])

Returns the value for this minute

Return: e.g. 24 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

thisMonth [line 350]

int thisMonth(
[string
$format = 'int'])

Returns the value for this month

Return: e.g. 5 or timestamp
Access: public

Overridden in child classes as:

MonthDecorator::thisMonth(): Override the thisMonth method to format the output

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

thisSecond [line 541]

int thisSecond(
[string
$format = 'int'])

Returns the value for this second

Return: e.g. 44 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

thisWeek [line 392]

int thisWeek(
[string
$format = 'n_in_month'])

Returns the value for this week

Return: e.g. 5 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

thisYear [line 317]

int thisYear(
[string
$format = 'int'])

Returns the value for this year

Return: e.g. 2003 or timestamp
Access: public

Parameters:

string $format — return value format ['int' | 'timestamp' | 'object' | 'array']

[ Top ]

toArray [line 124]

array toArray(
[mixed
$stamp = null])

Returns the date as an associative array (helper method)

Access: public

Parameters:

mixed $stamp — timestamp (leave empty for current timestamp)

[ Top ]

Class: Calendar_Decorator

Class Overview

Author(s):

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Method Detail

Calendar_Decorator (Constructor) [line 59]

Parameters:

adjust [line 113]

build [line 228]

Parameters:

fetch [line 241]

fetchAll [line 251]

getTimestamp [line 82]

getValidator [line 284]

isEmpty [line 214]

isFirst [line 177]

isLast [line 189]

isSelected [line 103]

isValid [line 274]

nextDay [line 453]

Parameters:

nextHour [line 486]

Parameters:

nextMinute [line 519]

Parameters:

nextMonth [line 361]

Parameters:

nextSecond [line 552]

Parameters:

nextWeek [line 412]

Parameters:

nextYear [line 328]

Parameters:

prevDay [line 432]

Parameters:

prevHour [line 464]

Parameters:

prevMinute [line 497]

Parameters:

prevMonth [line 339]

Parameters:

prevSecond [line 530]

Parameters:

prevWeek [line 372]

Parameters:

prevYear [line 306]

Parameters:

setSelected [line 93]

Parameters:

setTimestamp [line 71]

Parameters:

size [line 262]

thisDay [line 442]

Parameters:

thisHour [line 475]

Parameters:

thisMinute [line 508]

Parameters:

thisMonth [line 350]

Parameters:

thisSecond [line 541]

Parameters:

thisWeek [line 392]

Parameters:

thisYear [line 317]

Parameters:

toArray [line 124]

Parameters: