Turba_Application
extends Horde_Registry_Application
in package
Table of Contents
- $features : mixed
- $version : mixed
- backup() : mixed
- cleanupData() : mixed
- configSpecialValues() : array<string|int, mixed>
- Returns values for <configspecial> configuration settings.
- davDeleteObject() : bool
- Delete an object from an addressbook
- davGetCollections() : mixed
- davGetObject() : array<string|int, mixed>
- Get an iCalendar vCard out of Turba
- davGetObjects() : mixed
- davPutObject() : string|null
- Put a carddav contact into a Turba addressbook
- download() : mixed
- getInitialPage() : mixed
- getOutlookMapping() : mixed
- menu() : mixed
- perms() : mixed
- removeUserData() : mixed
- restore() : mixed
- restoreDependencies() : mixed
- sidebar() : mixed
- Add additional items to the sidebar.
- topbarCreate() : mixed
- _bootstrap() : mixed
- _init() : mixed
- Global variables defined: $addSources - TODO $attributes - (array) Attribute data from the config/attributes.php file.
- _modified() : int
- Returns the last modification (or creation) date of a contact.
- _restoreContact() : array<string|int, mixed>
- Restores a single contact.
Properties
$features
public
mixed
$features
= array('smartmobileView' => \true, 'modseq' => \true)
$version
public
mixed
$version
= 'H5 (5.0.0alpha7)'
Methods
backup()
public
backup([array<string|int, mixed> $users = array() ]) : mixed
Parameters
- $users : array<string|int, mixed> = array()
Return values
mixed —cleanupData()
public
cleanupData() : mixed
Return values
mixed —configSpecialValues()
Returns values for <configspecial> configuration settings.
public
configSpecialValues(string $what) : array<string|int, mixed>
Parameters
- $what : string
-
Either 'client-fields' or 'sources'.
Return values
array<string|int, mixed> —The values for the requested configuration setting.
davDeleteObject()
Delete an object from an addressbook
public
davDeleteObject(mixed $collection, string $object) : bool
Parameters
- $collection : mixed
- $object : string
-
The Object ID in caldav
Return values
bool —true if a record was deleted [not implemented]
davGetCollections()
public
davGetCollections(mixed $user) : mixed
Parameters
- $user : mixed
Return values
mixed —davGetObject()
Get an iCalendar vCard out of Turba
public
davGetObject(string|mixed $collection, string $object) : array<string|int, mixed>
Parameters
- $collection : string|mixed
-
the external collection id
- $object : string
-
The Object ID in caldav
Return values
array<string|int, mixed> —iCalendar
davGetObjects()
public
davGetObjects(mixed $collection) : mixed
Parameters
- $collection : mixed
Return values
mixed —davPutObject()
Put a carddav contact into a Turba addressbook
public
davPutObject(string|mixed $collection, string $object, string $data) : string|null
Flow:
- Check if addressbook exists and user may access
- Load data into Horde_Icalendar
- Find the vCard component(s)
- Turn each vCard to a turba driver-independent hash
- Check if the contact already exists in backend
- Break if the existing contact is newer than the update
- Update existing contact with all fields from update
- Create new contact and mapping from update
Parameters
- $collection : string|mixed
-
the external collection id
- $object : string
-
The Object ID in caldav
- $data : string
-
The icalendar data to put
Return values
string|null —download()
public
download(Horde_Variables $vars) : mixed
Parameters
- $vars : Horde_Variables
Tags
Return values
mixed —getInitialPage()
public
getInitialPage() : mixed
Return values
mixed —getOutlookMapping()
public
getOutlookMapping() : mixed
Return values
mixed —menu()
public
menu(Horde_Menu $menu) : mixed
Parameters
- $menu : Horde_Menu
-
The menu object
Return values
mixed —perms()
public
perms() : mixed
Return values
mixed —removeUserData()
public
removeUserData(mixed $user) : mixed
Parameters
- $user : mixed
Return values
mixed —restore()
public
restore(Collection $data) : mixed
Parameters
- $data : Collection
Return values
mixed —restoreDependencies()
public
restoreDependencies() : mixed
Return values
mixed —sidebar()
Add additional items to the sidebar.
public
sidebar(Horde_View_Sidebar $sidebar) : mixed
Parameters
- $sidebar : Horde_View_Sidebar
-
The sidebar object.
Return values
mixed —topbarCreate()
public
topbarCreate(Horde_Tree_Renderer_Base $tree[, mixed $parent = null ][, array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $tree : Horde_Tree_Renderer_Base
- $parent : mixed = null
- $params : array<string|int, mixed> = array()
Return values
mixed —_bootstrap()
protected
_bootstrap() : mixed
Return values
mixed —_init()
Global variables defined: $addSources - TODO $attributes - (array) Attribute data from the config/attributes.php file.
protected
_init() : mixed
$browse_source_count - TODO $cfgSources - TODO $copymoveSources - TODO
Return values
mixed —_modified()
Returns the last modification (or creation) date of a contact.
protected
_modified(string $collection, mixed $uid) : int
Parameters
- $collection : string
-
A address book ID.
- $uid : mixed
Return values
int —Timestamp of the last modification.
_restoreContact()
Restores a single contact.
protected
_restoreContact(array<string|int, mixed> $contact, string $user, array<string|int, mixed> $cfgSources, array<string|int, mixed> $map) : array<string|int, mixed>
Parameters
- $contact : array<string|int, mixed>
-
A contact hash.
- $user : string
-
A user name.
- $cfgSources : array<string|int, mixed>
-
A backend configuration list.
- $map : array<string|int, mixed>
-
Maps old group member IDs to new IDs.
Return values
array<string|int, mixed> —The updated map.