Calendar_Decorator (Constructor) [line 79]
Calendar_Decorator Calendar_Decorator(
object
&$calendar)
|
|
Constructs the Calendar_Decorator
Parameters:
adjust [line 140]
Adjusts the date (helper method)
build [line 272]
fetch [line 286]
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.
Overridden in child classes as:
- Calendar_Decorator_Wrapper::fetch()
- Wraps objects returned from fetch in the named Decorator class
- MonthPayload_Decorator::fetch()
fetchAll [line 297]
Fetches all child from the current collection of children
Overridden in child classes as:
- Calendar_Decorator_Wrapper::fetchAll()
- Wraps the returned calendar objects from fetchAll in the named decorator
getTimestamp [line 105]
Returns a timestamp from the current date / time values. Format of timestamp depends on Calendar_Engine implementation being used
getValidator [line 331]
Returns an instance of Calendar_Validator
isEmpty [line 256]
Check if the current object is empty
isFirst [line 213]
Returns true if Day object is first in a Week Only relevant when Day is created by Calendar_Month_Weekdays::build()
isLast [line 227]
Returns true if Day object is last in a Week Only relevant when Day is created by Calendar_Month_Weekdays::build()
isSelected [line 129]
True if the calendar subclass object is selected (e.g. today)
isValid [line 320]
Determine whether this date is valid, with the bounds determined by the Calendar_Engine. The call is passed on to Calendar_Validator::isValid
nextDay [line 528]
int nextDay(
[string
$format = 'int'])
|
|
Returns the value for the next day
Parameters:
nextHour [line 567]
int nextHour(
[string
$format = 'int'])
|
|
Returns the value for the next hour
Parameters:
nextMinute [line 606]
int nextMinute(
[string
$format = 'int'])
|
|
Returns the value for the next minute
Parameters:
nextMonth [line 423]
int nextMonth(
[string
$format = 'int'])
|
|
Returns the value for next month
Overridden in child classes as:
- MonthDecorator::nextMonth()
- Override the nextMonth method to format the output
Parameters:
nextSecond [line 645]
int nextSecond(
[string
$format = 'int'])
|
|
Returns the value for the next second
Parameters:
nextWeek [line 480]
int nextWeek(
[string
$format = 'n_in_month'])
|
|
Returns the value for next week
Parameters:
nextYear [line 384]
int nextYear(
[string
$format = 'int'])
|
|
Returns the value for next year
Parameters:
prevDay [line 502]
int prevDay(
[string
$format = 'int'])
|
|
Returns the value for the previous day
Parameters:
prevHour [line 541]
int prevHour(
[string
$format = 'int'])
|
|
Returns the value for the previous hour
Parameters:
prevMinute [line 580]
int prevMinute(
[string
$format = 'int'])
|
|
Returns the value for the previous minute
Parameters:
prevMonth [line 397]
int prevMonth(
[string
$format = 'int'])
|
|
Returns the value for the previous month
Overridden in child classes as:
- MonthDecorator::prevMonth()
- Override the prevMonth method to format the output
Parameters:
prevSecond [line 619]
int prevSecond(
[string
$format = 'int'])
|
|
Returns the value for the previous second
Parameters:
prevWeek [line 436]
int prevWeek(
[string
$format = 'n_in_month'])
|
|
Returns the value for the previous week
Parameters:
prevYear [line 358]
int prevYear(
[string
$format = 'int'])
|
|
Returns the value for the previous year
Parameters:
setSelected [line 118]
void setSelected(
[boolean
$state = true])
|
|
Defines calendar object as selected (e.g. for today)
Parameters:
setTimestamp [line 93]
void setTimestamp(
int
$ts)
|
|
Defines the calendar by a Unix timestamp, replacing values passed to the constructor
Parameters:
size [line 308]
Get the number Calendar subclass objects stored in the internal collection
thisDay [line 515]
int thisDay(
[string
$format = 'int'])
|
|
Returns the value for this day
Overridden in child classes as:
- MyBoldDecorator::thisDay()
Parameters:
thisHour [line 554]
int thisHour(
[string
$format = 'int'])
|
|
Returns the value for this hour
Parameters:
thisMinute [line 593]
int thisMinute(
[string
$format = 'int'])
|
|
Returns the value for this minute
Parameters:
thisMonth [line 410]
int thisMonth(
[string
$format = 'int'])
|
|
Returns the value for this month
Overridden in child classes as:
- MonthDecorator::thisMonth()
- Override the thisMonth method to format the output
Parameters:
thisSecond [line 632]
int thisSecond(
[string
$format = 'int'])
|
|
Returns the value for this second
Parameters:
thisWeek [line 458]
int thisWeek(
[string
$format = 'n_in_month'])
|
|
Returns the value for this week
Parameters:
thisYear [line 371]
int thisYear(
[string
$format = 'int'])
|
|
Returns the value for this year
Parameters:
toArray [line 153]
array toArray(
[mixed
$stamp = null])
|
|
Returns the date as an associative array (helper method)
Parameters: