Calendar_Frontend_Json

json interface for calendar

Implements:

Tinebase_Frontend_Json_Interface, Tinebase_Frontend_Interface

Extend:

Tinebase_Frontend_Json_Abstract

Methods

Name	Description
createRecurException	creates an exception instance of a recurring event
deleteEvents	deletes existing events
deleteRecurSeries	deletes a recur series
deleteResources	deletes existing resources
getDefaultCalendar	get default addressbook
getEvent	Return a single event
getEventExceptions
getFreeBusyInfo
getPollEvents	get alternative events for poll identified by its id
getResource	Return a single resouece
iMIPPrepare	prepares an iMIP (RFC 6047) Message
iMIPProcess	process an iMIP (RFC 6047) Message
importEvents	import contacts
importRemoteEvents	creates a scheduled import
resolveGroupMembers
saveEvent	creates/updates an event / recur
saveResource	creates/updates a Resource
searchAttenders
searchEvents	Search for events matching given arguments
searchFreeTime
searchResources	Search for resources matching given arguments
setAttenderStatus	sets attendee status for an attender on the given event
setDefinitePollEvent	set the definite event by deleting all other alternative events and close poll
updateRecurSeries	updated a recur series

Inherited methods

Name	Description
__call	magic method for json api
addFilterModelPlugin	Add a plugin for a former filter
getModelsConfiguration	returns model configurations for application starter
getRegistryData	Returns registry data of the application.
getRelatableModels	Returns all relatable models for this app
getTemplates	get available templates by containerId
resolveContainersAndTags	resolve containers and tags

Calendar_Frontend_Json::createRecurException

Description

public createRecurException (array $recordData, bool $deleteInstance, bool $deleteAllFollowing, bool $checkBusyConflicts)

creates an exception instance of a recurring event

NOTE: deleting persistent exceptions is done via a normal delete action
and handled in the controller

Parameters

• (array) $recordData
• (bool) $deleteInstance
• (bool) $deleteAllFollowing
• (bool) $checkBusyConflicts

Return Values

array

exception Event | updated baseEvent

---

Calendar_Frontend_Json::deleteEvents

Description

public deleteEvents (array $ids, string $range)

deletes existing events

Parameters

• (array) $ids
• (string) $range

Return Values

string

---

Calendar_Frontend_Json::deleteRecurSeries

Description

public deleteRecurSeries (array $recordData)

deletes a recur series

Parameters

• (array) $recordData

Return Values

array

---

Calendar_Frontend_Json::deleteResources

Description

public deleteResources (array $ids)

deletes existing resources

Parameters

• (array) $ids

Return Values

string

---

Calendar_Frontend_Json::getDefaultCalendar

Description

public getDefaultCalendar (void)

get default addressbook

Parameters

This function has no parameters.

Return Values

array

---

Calendar_Frontend_Json::getEvent

Description

public getEvent (string $id)

Return a single event

Parameters

• (string) $id

Return Values

array

record data

---

Calendar_Frontend_Json::getEventExceptions

Description

 getEventExceptions (void)

Parameters

This function has no parameters.

Return Values

void

---

Calendar_Frontend_Json::getFreeBusyInfo

Description

 getFreeBusyInfo (void)

Parameters

This function has no parameters.

Return Values

void

---

Calendar_Frontend_Json::getPollEvents

Description

public getPollEvents (string $pollId)

get alternative events for poll identified by its id

NOTE: the event itself is a alternative events as well.

Parameters

• (string) $pollId

Return Values

array

array results -> array of events

---

Calendar_Frontend_Json::getResource

Description

public getResource (string $id)

Return a single resouece

Parameters

• (string) $id

Return Values

array

record data

---

Calendar_Frontend_Json::iMIPPrepare

Description

public iMIPPrepare (array|\Calendar_Model_iMIP $iMIP)

prepares an iMIP (RFC 6047) Message

Parameters

• (array|\Calendar_Model_iMIP) $iMIP

Return Values

array

prepared iMIP part

---

Calendar_Frontend_Json::iMIPProcess

Description

public iMIPProcess (array $iMIP, string $status)

process an iMIP (RFC 6047) Message

Parameters

• (array) $iMIP
• (string) $status

Return Values

array

prepared iMIP part

Throws Exceptions

\Tinebase_Exception_NotFound

\Tinebase_Exception_Record_DefinitionFailure

\Tinebase_Exception_Record_Validation

\Zend_Db_Statement_Exception

---

Calendar_Frontend_Json::importEvents

Description

public importEvents (string $tempFileId, string $definitionId, array $importOptions, array $clientRecordData)

import contacts

Parameters

• (string) $tempFileId : to import
• (string) $definitionId
• (array) $importOptions
• (array) $clientRecordData

Return Values

array

Throws Exceptions

\Tinebase_Exception_SystemGeneric

---

Calendar_Frontend_Json::importRemoteEvents

Description

public importRemoteEvents (string $remoteUrl, string $interval, array $importOptions)

creates a scheduled import

Parameters

• (string) $remoteUrl
• (string) $interval
• (array) $importOptions

Return Values

array

---

Calendar_Frontend_Json::resolveGroupMembers

Description

 resolveGroupMembers (void)

Parameters

This function has no parameters.

Return Values

void

---

Calendar_Frontend_Json::saveEvent

Description

public saveEvent (array $recordData, bool $checkBusyConflicts)

creates/updates an event / recur

WARNING: the Calendar_Controller_Event::create method is not conform to the regular interface!
The parent's _save method doesn't work here!

Parameters

• (array) $recordData
• (bool) $checkBusyConflicts

Return Values

array

created/updated event

---

Calendar_Frontend_Json::saveResource

Description

public saveResource (array $recordData)

creates/updates a Resource

Parameters

• (array) $recordData

Return Values

array

created/updated Resource

Throws Exceptions

\Calendar_Exception_ResourceAdminGrant

---

Calendar_Frontend_Json::searchAttenders

Description

 searchAttenders (void)

Parameters

This function has no parameters.

Return Values

void

---

Calendar_Frontend_Json::searchEvents

Description

public searchEvents (array $filter, array $paging, bool $addFixedCalendars)

Search for events matching given arguments

Parameters

• (array) $filter
• (array) $paging
• (bool) $addFixedCalendars

Return Values

array

---

Calendar_Frontend_Json::searchFreeTime

Description

 searchFreeTime (void)

Parameters

This function has no parameters.

Return Values

void

---

Calendar_Frontend_Json::searchResources

Description

public searchResources (array $filter, array $paging)

Search for resources matching given arguments

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Calendar_Frontend_Json::setAttenderStatus

Description

public setAttenderStatus (array $eventData, array $attenderData, string $authKey)

sets attendee status for an attender on the given event

NOTE: for recur events we implicitly create an exceptions on demand

Parameters

• (array) $eventData
• (array) $attenderData
• (string) $authKey

Return Values

array

complete event

---

Calendar_Frontend_Json::setDefinitePollEvent

Description

public setDefinitePollEvent (array $event)

set the definite event by deleting all other alternative events and close poll

Parameters

• (array) $event

Return Values

array

updated event

---

Calendar_Frontend_Json::updateRecurSeries

Description

public updateRecurSeries (array $recordData, bool $checkBusyConflicts)

updated a recur series

Parameters

• (array) $recordData
• (bool) $checkBusyConflicts

Return Values

array

---