Overview

Packages

  • Kronolith
  • None

Classes

  • Kronolith
  • Kronolith_Ajax_Application
  • Kronolith_Ajax_Imple_ContactAutoCompleter
  • Kronolith_Ajax_Imple_Embed
  • Kronolith_Ajax_Imple_TagActions
  • Kronolith_Ajax_Imple_TagAutoCompleter
  • Kronolith_Api
  • Kronolith_Calendar
  • Kronolith_Calendar_External
  • Kronolith_Calendar_External_Tasks
  • Kronolith_Calendar_Holiday
  • Kronolith_Calendar_Internal
  • Kronolith_Calendar_Remote
  • Kronolith_Calendar_Resource
  • Kronolith_Calendars_Base
  • Kronolith_Calendars_Default
  • Kronolith_Calendars_Kolab
  • Kronolith_Day
  • Kronolith_Driver
  • Kronolith_Driver_Holidays
  • Kronolith_Driver_Horde
  • Kronolith_Driver_Ical
  • Kronolith_Driver_Kolab
  • Kronolith_Driver_Mock
  • Kronolith_Driver_Resource
  • Kronolith_Driver_Sql
  • Kronolith_Event
  • Kronolith_Event_Holidays
  • Kronolith_Event_Horde
  • Kronolith_Event_Ical
  • Kronolith_Event_Kolab
  • Kronolith_Event_Resource
  • Kronolith_Event_Sql
  • Kronolith_Exception
  • Kronolith_Factory_Calendars
  • Kronolith_Factory_Geo
  • Kronolith_Form_CreateCalendar
  • Kronolith_Form_CreateResource
  • Kronolith_Form_CreateResourceGroup
  • Kronolith_Form_DeleteCalendar
  • Kronolith_Form_DeleteResource
  • Kronolith_Form_DeleteResourceGroup
  • Kronolith_Form_EditCalendar
  • Kronolith_Form_EditRemoteCalendar
  • Kronolith_Form_EditResource
  • Kronolith_Form_EditResourceGroup
  • Kronolith_Form_SubscribeRemoteCalendar
  • Kronolith_Form_UnsubscribeRemoteCalendar
  • Kronolith_FreeBusy
  • Kronolith_FreeBusy_View
  • Kronolith_FreeBusy_View_Day
  • Kronolith_FreeBusy_View_Month
  • Kronolith_FreeBusy_View_Week
  • Kronolith_FreeBusy_View_Workweek
  • Kronolith_Geo_Base
  • Kronolith_Geo_Mysql
  • Kronolith_Geo_Sql
  • Kronolith_LoginTasks_SystemTask_Upgrade
  • Kronolith_LoginTasks_Task_PurgeEvents
  • Kronolith_Notification_Listener_AjaxStatus
  • Kronolith_Resource
  • Kronolith_Resource_Base
  • Kronolith_Resource_Group
  • Kronolith_Resource_Single
  • Kronolith_Storage
  • Kronolith_Storage_Kolab
  • Kronolith_Storage_Sql
  • Kronolith_Tagger
  • Kronolith_Test
  • Kronolith_View_Day
  • Kronolith_View_DeleteEvent
  • Kronolith_View_EditEvent
  • Kronolith_View_Event
  • Kronolith_View_ExportEvent
  • Kronolith_View_Month
  • Kronolith_View_Week
  • Kronolith_View_WorkWeek
  • Kronolith_View_Year
  • Overview
  • Package
  • Class
  • Tree

Class Kronolith_Resource_Base

Base class for Kronolith resources. Partially presents a Horde_Share_Object interface.

Copyright 2009-2012 Horde LLC (http://www.horde.org/)

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

Direct known subclasses

Kronolith_Resource_Group, Kronolith_Resource_Single
Abstract
Package: Kronolith
Author: Michael J. Rubinsky mrubinsk@horde.org
Located at Resource/Base.php
Methods summary
public Kronolith_Resource
# __construct( array $params = array() )

Const'r

Const'r

Parameters

$params

Returns

Kronolith_Resource
object
public mixed
# getId( )

Obtain the resource's internal identifier.

Obtain the resource's internal identifier.

Returns

mixed
The id.
public
# set( string $property, mixed $value )

Allow setting of properties

Allow setting of properties

Parameters

$property
The property to set
$value
The value to set to
public unknown_type
# hasPermission( mixed $user, mixed $permission = Horde_Perms::READ, mixed $restrict = null )

Parameters

$user
$permission
$restrict

Returns

unknown_type

Todo:

need to fine tune this
public unknown_type
# get( mixed $property )

Implemented to stand in as a share object.

Implemented to stand in as a share object.

Parameters

$property

Returns

unknown_type
public Kronolith_Resource
# save( )

Save resource to storage.

Save resource to storage.

Returns

Kronolith_Resource
object

Throws

Kronolith_Exception
public Kronolith_Driver_Resource
# getDriver( )

Get a storage driver instance for the resource. For now, just instantiate it here, in future, probably inject it in the const'r.

Get a storage driver instance for the resource. For now, just instantiate it here, in future, probably inject it in the const'r.

Returns

Kronolith_Driver_Resource
public integer
# getResponse( Kronolith_Event $event )

Check availability and return an appropriate Kronolith response code.

Check availability and return an appropriate Kronolith response code.

Parameters

$event
The event to check on

Returns

integer
Kronolith::RESPONSE* constant
abstract public unknown_type
# isFree( mixed $event )

Determine if event is free for specified time

Determine if event is free for specified time

Parameters

$event

Returns

unknown_type
abstract public unknown_type
# addEvent( mixed $event )

Adds $event to this resource's calendar - thus blocking the time for any other event.

Adds $event to this resource's calendar - thus blocking the time for any other event.

Parameters

$event

Returns

unknown_type
abstract public unknown_type
# removeEvent( mixed $event )

Remove this event from resource's calendar

Remove this event from resource's calendar

Parameters

$event

Returns

unknown_type
abstract public unknown_type
# getFreeBusy( )

Obtain the freebusy information for this resource. Takes into account if this is a group of resources or not. (Returns the cumulative FB info for all the resources in the group.

Obtain the freebusy information for this resource. Takes into account if this is a group of resources or not. (Returns the cumulative FB info for all the resources in the group.

Returns

unknown_type
abstract public unknown_type
# setId( integer $id )

Sets the current resource's id. Must not be an existing resource.

Sets the current resource's id. Must not be an existing resource.

Parameters

$id
The id for this resource

Returns

unknown_type
abstract public unknown_type
# getResponseType( )

Get ResponseType for this resource.

Get ResponseType for this resource.

Returns

unknown_type
API documentation generated by ApiGen