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_Driver_Resource

The Kronolith_Driver_Resource class implements the Kronolith_Driver API for storing resource calendars in a SQL backend.

Copyright 1999-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.

Kronolith_Driver
Extended by Kronolith_Driver_Sql
Extended by Kronolith_Driver_Resource
Package: Kronolith
Author: Luc Saillard luc.saillard@fr.alcove.com
Author: Chuck Hagenbuch chuck@horde.org
Author: Jan Schneider jan@horde.org
Author: Michael J Rubinsky mrubinsk@horde.org
Located at Driver/Resource.php
Methods summary
public
# deleteEvent( string $event, boolean $silent = false )

Delete an event.

Delete an event.

Since this is the Kronolith_Resource's version of the event, if we delete it, we must also make sure to remove it from the event that it is attached to. Not sure if there is a better way to do this...

Parameters

$event
$eventId The ID of the event to delete.
$silent
<p>Don't send notifications, used when deleting events in bulk from maintenance tasks.</p>

Throws

Kronolith_Exception
Horde_Exception_NotFound

See

lib/Driver/Kronolith_Driver_Sql#deleteEvent($eventId , $silent)

Overrides

Kronolith_Driver_Sql::deleteEvent()
public Kronolith_Resource
# save( Kronolith_Resource $resource )

Save or update a Kronolith_Resource

Save or update a Kronolith_Resource

Parameters

$resource

Returns

Kronolith_Resource
object

Throws

Kronolith_Exception
public
# delete( Kronolith_Resource $resource )

Removes a resource from storage, along with any events in the resource's calendar.

Removes a resource from storage, along with any events in the resource's calendar.

Parameters

$resource
The kronolith resource to remove

Throws

Kronolith_Exception

Overrides

Kronolith_Driver_Sql::delete()
public Kronolith_Resource_Base
# getResource( integer $id )

Obtain a Kronolith_Resource by the resource's id

Obtain a Kronolith_Resource by the resource's id

Parameters

$id
The key for the Kronolith_Resource

Returns

Kronolith_Resource_Base

Throws

Kronolith_Exception
public integer
# getResourceIdByCalendar( string $calendar )

Obtain the resource id associated with the given calendar uid.

Obtain the resource id associated with the given calendar uid.

Parameters

$calendar
The calendar's uid.

Returns

integer
The Kronolith_Resource id.

Throws

Kronolith_Exception
public boolean
# isResourceCalendar( string $calendar )

Determine if the provided calendar id represents a resource's calendar.

Determine if the provided calendar id represents a resource's calendar.

Parameters

$calendar
The calendar identifier to check.

Returns

boolean
public an
# listResources( integer $perms = Horde_Perms::READ, array $filter = array(), string $orderby = null )

Return a list of Kronolith_Resources

Return a list of Kronolith_Resources

Right now, all users have Horde_Perms::READ, but only system admins have Horde_Perms::EDIT | Horde_Perms::DELETE

Parameters

$perms
A Horde_Perms::* constant.
$filter
A hash of field/values to filter on.
$orderby
Field to order results by. Null for no ordering.

Returns

an
array of Kronolith_Resource objects.

Throws

Kronolith_Exception
public array
# getGroupMemberships( integer $resource_id )

Obtain the group id for each group the speciied resource is a member of.

Obtain the group id for each group the speciied resource is a member of.

Parameters

$resource_id
The resource id to check for.

Returns

array
of group ids.

Throws

Kronolith_Exception
Methods inherited from Kronolith_Driver_Sql
backgroundColor(), convertFromDriver(), convertToDriver(), countEvents(), exists(), filterEventsByCalendar(), getByUID(), getEvent(), initialize(), listAlarms(), listEvents(), search()
Methods inherited from Kronolith_Driver
__construct(), colors(), getParam(), move(), nextRecurrence(), open(), saveEvent(), setParam(), setParams()
Properties inherited from Kronolith_Driver
$backgroundColor, $calendar, $foregroundColor
API documentation generated by ApiGen