Class Kronolith_Driver_holidays

Description

The Kronolith_Driver_holidays implements support for the PEAR package Date_Holidays.

Located in /lib/Driver/holidays.php (line 12)

Kronolith_Driver
   |
   --Kronolith_Driver_holidays
Method Summary
 mixed delete (string $calendar)
 mixed deleteEvent (string $eventId)
 void exists ()
 Kronolith_Event &getByUID (string $uid, [array $calendars = null], [boolean $getAll = false])
 void &getEvent ([ $eventId = null])
 void listAlarms ( $date, [ $fullevent = false])
 array listEvents ([int|Horde_Date $startDate = null], [int|Horde_Date $endDate = null], [bool $hasAlarm = false])
 void move (string $eventId, string $newCalendar)
 void saveEvent ( $event)
 void _getEvents ( $dh,  $startDate,  $endDate)
 void _getTranslationFile ( $driver)
Variables
Methods
delete (line 139)

Deletes a calendar and all its events.

  • return: True or a PEAR_Error on failure.
mixed delete (string $calendar)
  • string $calendar: The name of the calendar to delete.
deleteEvent (line 151)

Deletes an event.

  • return: True or a PEAR_Error on failure.
mixed deleteEvent (string $eventId)
  • string $eventId: The ID of the event to delete.
exists (line 111)
void exists ()
getByUID (line 106)

Get an event or events with the given UID value.

Kronolith_Event &getByUID (string $uid, [array $calendars = null], [boolean $getAll = false])
  • string $uid: The UID to match
  • array $calendars: A restricted array of calendar ids to search
  • boolean $getAll: Return all matching events? If this is false, an error will be returned if more than one event is found.
getEvent (line 91)
void &getEvent ([ $eventId = null])
  • $eventId

Redefinition of:
Kronolith_Driver::getEvent()
Stub to be overridden in the child class.
listAlarms (line 14)
void listAlarms ( $date, [ $fullevent = false])
  • $date
  • $fullevent

Redefinition of:
Kronolith_Driver::listAlarms()
Stub to be overridden in the child class.
listEvents (line 33)

Returns a list of all holidays occuring between

  1. $startDate
and
  1. $endDate
.

  • return: An array of all holidays within the given datespan.
array listEvents ([int|Horde_Date $startDate = null], [int|Horde_Date $endDate = null], [bool $hasAlarm = false])
  • int|Horde_Date $startDate: The start of the datespan to be checked. Defaults to the current date.
  • int|Horde_Date $endDate: The end of the datespan. Defaults to the current date.
  • bool $hasAlarm: Left in for compatibility reasons and has no effect on this function. Defaults to
    1. false

Redefinition of:
Kronolith_Driver::listEvents()
Stub to be overridden in the child class.
move (line 127)

Moves an event to a new calendar.

void move (string $eventId, string $newCalendar)
  • string $eventId: The event to move.
  • string $newCalendar: The new calendar.
saveEvent (line 116)
void saveEvent ( $event)
  • $event

Redefinition of:
Kronolith_Driver::saveEvent()
Stub o be overridden in the child class.
_getEvents (line 65)
void _getEvents ( $dh,  $startDate,  $endDate)
  • $dh
  • $startDate
  • $endDate
_getTranslationFile (line 156)
void _getTranslationFile ( $driver)
  • $driver

Inherited Methods

Inherited From Kronolith_Driver

 Kronolith_Driver::Kronolith_Driver()
 Kronolith_Driver::factory()
 Kronolith_Driver::generateUID()
 Kronolith_Driver::getCalendar()
 Kronolith_Driver::getEvent()
 Kronolith_Driver::initialize()
 Kronolith_Driver::listAlarms()
 Kronolith_Driver::listEvents()
 Kronolith_Driver::nextRecurrence()
 Kronolith_Driver::open()
 Kronolith_Driver::removeUserData()
 Kronolith_Driver::rename()
 Kronolith_Driver::saveEvent()
 Kronolith_Driver::search()

Documentation generated on Sun, 30 Jan 2011 05:31:46 +0000 by phpDocumentor 1.4.3