Class BirthdayEvent

com.woltlab.wcal.core.data.calendar.event

Description

Implementation of abstract event for birthday events Birthday information is stored in the user option table in the format 'YYYY-MM-DD' - sometimes years are not specified, so its only '0000-MM-DD'

author: Arian Glander
copyright: 2001-2008 WoltLab GmbH
license: WoltLab

DatabaseObject
   |
   --AbstractEvent
      |
      --BirthdayEvent

Variable Summary

Type	Name
`static String`	`$sortOrder`

Method Summary

Return	Name
`BirthdayEvent`	`__construct(array $data)`
`static array<mixed>`	`addEvent(array<mixed> $events, integer $startTime, BirthdayEvent $event, [string $index = null])`
`static array<BirthdayEvent>`	`getBirthdays(integer $timestamp, $sortField, $sortOrder, [User $user = null], boolean $sortByAge)`
`static unknown`	`getCachedBirthdays(integer $start, integer $end, array<mixed> $options)`
`void`	`getDescription()`
`static array<mixed>`	`getEvents(integer $start, integer $end, array<Calendar> $calendars, [string $index = null], [array<mixed> $options = array()])`
`void`	`getICalendarRRule()`
`void`	`getIconName()`
`void`	`getID()`
`void`	`getStartTime()`
`void`	`getSubject()`
`static void`	`getSupportedPermissions()`
`void`	`getUID()`
`void`	`getURL([ $currentDay = 0])`
`void`	`getUsername()`

Variables

$sortOrder

public static String $sortOrder = 'ASC'

Sort order (when getting a list of birthdays)

Inherited variables from AbstractEvent

AbstractEvent::$sortBy

Inherited variables from DatabaseObject

DatabaseObject::$data

Methods

__construct

public BirthdayEvent __construct(array $data)

Constructs the Birthday Event default values will be initialized

Parameters:

$data - array with values

Redefinition of: DatabaseObject::__construct()

addEvent

protected static array<mixed> addEvent(array<mixed> $events, integer $startTime, BirthdayEvent $event, [string $index = null])

Add event to event list

return: list of events

Parameters:

$events - list of events
$startTime - start of event
$event - event to add
$index - returned array can be grouped by calendarIDs, day or time (@see CalendarUtil)

getBirthdays

public static array<BirthdayEvent> getBirthdays(integer $timestamp, $sortField, $sortOrder, [User $user = null], boolean $sortByAge)

Returns all birthdays of a specific date.

Parameters:

$timestamp
$sortByAge
$user
$sortField
$sortOrder

getCachedBirthdays

protected static unknown getCachedBirthdays(integer $start, integer $end, array<mixed> $options)

Read the cache and returns only the birthdays in the given timeframe each day (timestamp) contains an associative array with userIDs to data:

e.g. $userID => array('age' => $age, 'timestamp' => $timestamp)

Parameters:

$start - start of birthdays timeframe
$end - end of birthdays timeframe
$options - additional options

getDescription

public void getDescription()

see: AbstractEvent::getDescription()

Redefinition of: AbstractEvent::getDescription()

getEvents

public static array<mixed> getEvents(integer $start, integer $end, array<Calendar> $calendars, [string $index = null], [array<mixed> $options = array()])

Get all birthdays in between a given timeframe

return: array holding the events (grouped or plain)

Parameters:

$start - timestamp of interval start
$end - timestamp of interval end
$calendars - array holding all calendars grouped by ID
$index - returned array can be grouped by calendarIDs, day or time (@see CalendarUtil)
$options - optional associative array to pass options