Calendar_Frontend_Cli

Cli frontend for Calendar

This class handles cli requests for the Calendar

Extend:

Tinebase_Frontend_Cli_Abstract

Methods

Name	Description
alarmAckReport	print alarm acknowledgement report (when, ip, client, user, ...)
compareCalendars	compare two calendars and create report of missing/different events
deleteDuplicateEvents	delete duplicate events - allowed params: organizer=ORGANIZER_CONTACTID (equals) created_by=USER_ID (equals) dtstart="2014-10-28" (after) summary=EVENT_SUMMARY (contains) -d (dry run)
exportResources	exports all resources as CSV examples: --method Calendar.exportResources --username=USER
exportSharedCalendars	exports all shared calendars as CSV examples: --method Calendar.exportSharedCalendars --username=USER
exportVCalendar	exports calendars as ICS (VCALENDAR) examples: --method Calendar.exportVCalendar --username=USER -- container_id=CALID filename=/my/export/file.ics --method Calendar.exportVCalendar --username=USER -- type=personal path=/my/export/path/
fetchDataFromIcs	fetch data from ics file and put it into the matching tine20 events example: php tine20.php --method=Calendar.fetchDataFromIcs -v -d --username test --password test my.ics
getAnonymousMethods	return anonymous methods
import	import events
repairAttendee
repairDanglingDisplaycontainerEvents	repair dangling attendee records (no displaycontainer_id)
reportBigEventAttachments
restoreFallouts	remove future fallout exdates for events in given calendars
setResourcesGrants	set resource grants
sharedCalendarReport	report of shared calendars
updateEventLocations	update event locations (before 2018.11 there was no autoupdate on resource rename) allowed params: --updatePastEvents (otherwise from now on) -d (dry run)
userCalendarReport

Inherited methods

Name	Description
createContainer	add container
createDemoData	create demo data
getHelp	echos usage information
importegw14	import from egroupware
setContainerGrants	set container grants
setContainerGrantsHelper	set containers grants helper
setContainerGrantsReadOnly	setContainerGrantsReadOnly
updateImportExportDefinition	update or create import/export definition

Calendar_Frontend_Cli::alarmAckReport

Description

public alarmAckReport (\Zend_Console_Getopt $_opts)

print alarm acknowledgement report (when, ip, client, user, ...)

Parameters

• (\Zend_Console_Getopt) $_opts

Return Values

void

---

Calendar_Frontend_Cli::compareCalendars

Description

public compareCalendars (\Zend_Console_Getopt $_opts)

compare two calendars and create report of missing/different events

Parameters

• (\Zend_Console_Getopt) $_opts

Return Values

void

---

Calendar_Frontend_Cli::deleteDuplicateEvents

Description

public deleteDuplicateEvents (\Zend_Console_Getopt $opts)

delete duplicate events - allowed params: organizer=ORGANIZER_CONTACTID (equals) created_by=USER_ID (equals) dtstart="2014-10-28" (after) summary=EVENT_SUMMARY (contains) -d (dry run)

Parameters

• (\Zend_Console_Getopt) $opts

Return Values

void

---

Calendar_Frontend_Cli::exportResources

Description

public exportResources ( $_opts)

exports all resources as CSV examples: --method Calendar.exportResources --username=USER

Parameters

• () $_opts

Return Values

bool

---

Calendar_Frontend_Cli::exportSharedCalendars

Description

public exportSharedCalendars ( $_opts)

exports all shared calendars as CSV examples: --method Calendar.exportSharedCalendars --username=USER

Parameters

• () $_opts

Return Values

bool

---

Calendar_Frontend_Cli::exportVCalendar

Description

public exportVCalendar ( $_opts)

exports calendars as ICS (VCALENDAR) examples: --method Calendar.exportVCalendar --username=USER -- container_id=CALID filename=/my/export/file.ics --method Calendar.exportVCalendar --username=USER -- type=personal path=/my/export/path/

Parameters

• () $_opts

Return Values

bool

---

Calendar_Frontend_Cli::fetchDataFromIcs

Description

public fetchDataFromIcs ( $_opts)

fetch data from ics file and put it into the matching tine20 events example: php tine20.php --method=Calendar.fetchDataFromIcs -v -d --username test --password test my.ics

Parameters

• () $_opts

Return Values

int

NOTE: currently only alarms are supported

TODO add more fields that can be processed / imported

---

Calendar_Frontend_Cli::getAnonymousMethods

Description

public static getAnonymousMethods (void)

return anonymous methods

Parameters

This function has no parameters.

Return Values

array

---

Calendar_Frontend_Cli::import

Description

public import (\Zend_Console_Getopt $_opts)

import events

Parameters

• (\Zend_Console_Getopt) $_opts

Return Values

void

---

Calendar_Frontend_Cli::repairAttendee

Description

 repairAttendee (void)

Parameters

This function has no parameters.

Return Values

void

---

Calendar_Frontend_Cli::repairDanglingDisplaycontainerEvents

Description

public repairDanglingDisplaycontainerEvents (void)

repair dangling attendee records (no displaycontainer_id)

Parameters

This function has no parameters.

Return Values

void

---

Calendar_Frontend_Cli::reportBigEventAttachments

Description

 reportBigEventAttachments (void)

Parameters

This function has no parameters.

Return Values

void

---

Calendar_Frontend_Cli::restoreFallouts

Description

public restoreFallouts ( $_opts)

remove future fallout exdates for events in given calendars

Parameters

• () $_opts

Return Values

void

---

Calendar_Frontend_Cli::setResourcesGrants

Description

public setResourcesGrants (\Zend_Console_Getopt $_opts)

set resource grants

example usages:
(1) $ php tine20.php --method=Calendar.setResourcesGrants accountId=15 accountType=group grants=readGrant [-d]
(2) $ php tine20.php --method=Calendar.setResourcesGrants id=3339 accountId=15 accountType=group grants=readGrant overwrite=1

Parameters

• (\Zend_Console_Getopt) $_opts

Return Values

int

Throws Exceptions

\Tinebase_Exception_InvalidArgument

\Tinebase_Exception_NotFound

---

Calendar_Frontend_Cli::sharedCalendarReport

Description

public sharedCalendarReport (\Zend_Console_Getopt $_opts)

report of shared calendars

Parameters

• (\Zend_Console_Getopt) $_opts

Return Values

int

---

Calendar_Frontend_Cli::updateEventLocations

Description

public updateEventLocations (void)

update event locations (before 2018.11 there was no autoupdate on resource rename) allowed params: --updatePastEvents (otherwise from now on) -d (dry run)

Parameters

This function has no parameters.

Return Values

void

---

Calendar_Frontend_Cli::userCalendarReport

Description

 userCalendarReport (void)

Parameters

This function has no parameters.

Return Values

void

---