Overview

Packages

  • Kolab
    • FreeBusy

Classes

  • Horde_Kolab_FreeBusy
  • Horde_Kolab_FreeBusy_Cache
  • Horde_Kolab_FreeBusy_Cache_Base
  • Horde_Kolab_FreeBusy_Cache_DB
  • Horde_Kolab_FreeBusy_Cache_DB_acl
  • Horde_Kolab_FreeBusy_Cache_DB_xacl
  • Horde_Kolab_FreeBusy_Cache_File
  • Horde_Kolab_FreeBusy_Cache_File_acl
  • Horde_Kolab_FreeBusy_Cache_File_pvcal
  • Horde_Kolab_FreeBusy_Cache_File_vcal
  • Horde_Kolab_FreeBusy_Cache_File_xacl
  • Horde_Kolab_FreeBusy_Controller_Base
  • Horde_Kolab_FreeBusy_Controller_MatchDict
  • Horde_Kolab_FreeBusy_Controller_NotFound
  • Horde_Kolab_FreeBusy_Controller_RequestConfiguration
  • Horde_Kolab_FreeBusy_Driver_Base
  • Horde_Kolab_FreeBusy_Driver_Freebusy_Base
  • Horde_Kolab_FreeBusy_Driver_Freebusy_Kolab
  • Horde_Kolab_FreeBusy_Exception
  • Horde_Kolab_FreeBusy_Exception_NotFound
  • Horde_Kolab_FreeBusy_Exception_Unauthorized
  • Horde_Kolab_FreeBusy_Export_Freebusy_Backend_Kolab
  • Horde_Kolab_FreeBusy_Export_Freebusy_Base
  • Horde_Kolab_FreeBusy_Export_Freebusy_Decorator_Log
  • Horde_Kolab_FreeBusy_Factory_Base
  • Horde_Kolab_FreeBusy_Freebusy_Controller_Freebusy
  • Horde_Kolab_FreeBusy_Freebusy_Factory_Base
  • Horde_Kolab_FreeBusy_Freebusy_Factory_Kolab
  • Horde_Kolab_FreeBusy_Freebusy_Helper_Owa
  • Horde_Kolab_FreeBusy_Freebusy_Helper_StatusMap_Config
  • Horde_Kolab_FreeBusy_Freebusy_Helper_StatusMap_Default
  • Horde_Kolab_FreeBusy_Freebusy_Owner_Kolab
  • Horde_Kolab_FreeBusy_Freebusy_Params_Folder
  • Horde_Kolab_FreeBusy_Freebusy_UserDb_Kolab
  • Horde_Kolab_FreeBusy_Object_Event
  • Horde_Kolab_FreeBusy_Owner_Kolab
  • Horde_Kolab_FreeBusy_Params_Freebusy_Resource_Kolab
  • Horde_Kolab_FreeBusy_Params_User
  • Horde_Kolab_FreeBusy_Provider_Local
  • Horde_Kolab_FreeBusy_Provider_Remote
  • Horde_Kolab_FreeBusy_Provider_Remote_PassThrough
  • Horde_Kolab_FreeBusy_Provider_Remote_Redirect
  • Horde_Kolab_FreeBusy_Report
  • Horde_Kolab_FreeBusy_Resource_Decorator_Log
  • Horde_Kolab_FreeBusy_Resource_Decorator_Mcache
  • Horde_Kolab_FreeBusy_Resource_Event_Decorator_Log
  • Horde_Kolab_FreeBusy_Resource_Event_Decorator_Mcache
  • Horde_Kolab_FreeBusy_Resource_Event_Kolab
  • Horde_Kolab_FreeBusy_Resource_Event_Owa
  • Horde_Kolab_FreeBusy_Resource_Kolab
  • Horde_Kolab_FreeBusy_Translation
  • Horde_Kolab_FreeBusy_User_Anonymous
  • Horde_Kolab_FreeBusy_User_Decorator_Log
  • Horde_Kolab_FreeBusy_User_Kolab
  • Horde_Kolab_FreeBusy_UserDb_Kolab
  • Horde_Kolab_FreeBusy_UserDb_User_Kolab
  • Horde_Kolab_FreeBusy_View
  • Horde_Kolab_FreeBusy_View_error
  • Horde_Kolab_FreeBusy_View_vfb

Interfaces

  • Horde_Kolab_FreeBusy_Driver_Freebusy_Interface
  • Horde_Kolab_FreeBusy_Driver_Interface
  • Horde_Kolab_FreeBusy_Export_Freebusy
  • Horde_Kolab_FreeBusy_Export_Freebusy_Backend
  • Horde_Kolab_FreeBusy_Factory
  • Horde_Kolab_FreeBusy_Freebusy_Helper_StatusMap
  • Horde_Kolab_FreeBusy_Freebusy_Owner
  • Horde_Kolab_FreeBusy_Owner
  • Horde_Kolab_FreeBusy_Params_Owner
  • Horde_Kolab_FreeBusy_Params_Resource
  • Horde_Kolab_FreeBusy_Provider
  • Horde_Kolab_FreeBusy_Resource
  • Horde_Kolab_FreeBusy_Resource_Event
  • Horde_Kolab_FreeBusy_User
  • Horde_Kolab_FreeBusy_UserDb
  • Horde_Kolab_FreeBusy_UserDb_User
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Kolab_FreeBusy_Object_Event

A reduced event representation derived from the Kronolith event representation.

Copyright 1999-2012 Horde LLC (http://www.horde.org/) Copyright 2004-2008 Klarälvdalens Datakonsult AB Copyright 2011 Kolab Systems AG

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Package: Kolab\FreeBusy
Category: Kolab
License: LGPL 2.1
Author: Chuck Hagenbuch chuck@horde.org
Author: Jan Schneider jan@horde.org
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://pear.horde.org/index.php?package=Kolab_FreeBusy
Located at Horde/Kolab/FreeBusy/Object/Event.php
Methods summary
public
# __construct( array $event )

Constructor.

Constructor.

Parameters

$event
The event data.
public boolean
# recursIn( Horde_Date $startDate, Horde_Date $endDate )

Determines if the event recurs in the given time span.

Determines if the event recurs in the given time span.

Parameters

$startDate
Start of the time span.
$endDate
End of the time span.

Returns

boolean
True if the event recurs in this time span.
public boolean
# recurs( )

Returns whether this event is a recurring event.

Returns whether this event is a recurring event.

Returns

boolean
True if this is a recurring event.
public string
# getStatus( )

Return the event status (one of the event status codes defined in this class).

Return the event status (one of the event status codes defined in this class).

Returns

string
The status of this event.
public integer
# duration( )

Return the duration of the event.

Return the duration of the event.

Returns

integer
The duration (in seconds) of the event.
public array
# getEncodedInformation( )

Return event details encoded for integration into the free/busy output.

Return event details encoded for integration into the free/busy output.

Returns

array
The encoded free/busy information.
public array
# getBusyTimes( Horde_Date $startDate, Horde_Date $endDate )

Retrieve the busy times from this event within the given timeframe. This is trivial for non-recurring events but recurring events need to be expanded.

Retrieve the busy times from this event within the given timeframe. This is trivial for non-recurring events but recurring events need to be expanded.

Parameters

$startDate
The start point.
$endDate
The end point.

Returns

array
The list of busy times (only the start times of the event).
Constants summary
string STATUS_NONE

Event status

Event status

# 'none'
string STATUS_UNKNOWN
# 'unknown'
string STATUS_BUSY
# 'busy'
string STATUS_TENTATIVE
# 'tentative'
string STATUS_OUTOFOFFICE
# 'outofoffice'
string STATUS_FREE
# 'free'
string STATUS_CONFIRMED
# 'confirmed'
string STATUS_CANCELLED
# 'cancelled'
API documentation generated by ApiGen