API Documentation
\
Kronolith
Backup

\Kronolith_View_Day

The Kronolith_View_Day:: class provides an API for viewing days.

Summary

Methods
Properties
Constants
__construct()
getTime()
getTomorrow()
getYesterday()
isToday()
isTomorrow()
diff()
html()
parse()
link()
getName()
prefHourFormat()
$slotsPerHour
$slotsPerDay
$slotLength
$slots
$all_day_events
$span
$totalspan
$sidebyside
$events
No constants found
_sortByStart()
$_event_matrix
$_parsed
$_currentCalendars
$_first
$_last
N/A
No private methods found
No private properties found
N/A

Properties

$slotsPerHour

$slotsPerHour : integer

How many time slots are we dividing each hour into? Set from user preferences.

Type

integer

$slotsPerDay

$slotsPerDay : integer

How many slots do we have per day? Calculated from $_slotsPerHour.

Type

integer

$slotLength

$slotLength : integer

How many minutes are in each slot? Calculated from $_slotsPerHour.

Type

integer

$slots

$slots : array

Array of slots holding hours and minutes for each piece of this day.

Type

array

$all_day_events

$all_day_events :

Type

$span

$span :

Type

$totalspan

$totalspan :

Type

$sidebyside

$sidebyside :

Type

$events

$events :

Type

$_event_matrix

$_event_matrix :

Type

$_parsed

$_parsed :

Type

$_currentCalendars

$_currentCalendars :

Type

$_first

$_first :

Type

$_last

$_last :

Type

Methods

__construct()

__construct(\Horde_Date  $date, array  $events = null) : \Kronolith_View_Day

Constructor.

Parameters

\Horde_Date $date

The day for this view
array $events

An array of Kronolith_Event objects

Returns

\Kronolith_View_Day

getTime()

getTime(  $format,   $offset)

Parameters

$format
$offset

getTomorrow()

getTomorrow()

getYesterday()

getYesterday()

isToday()

isToday()

isTomorrow()

isTomorrow()

diff()

diff(  $other = null)

Parameters

$other

html()

html()

parse()

parse()

This function runs through the events and tries to figure out what should be on each line of the output table. This is a little tricky.

link()

link(  $offset,   $full = false)

Parameters

$offset
$full

getName()

getName()

prefHourFormat()

prefHourFormat(  $hour,   $min)

Parameters

$hour
$min

_sortByStart()

_sortByStart(  $evA,   $evB)

Parameters

$evA
$evB