Registry connector for Horde backend. Provides the communication between
the Horde Registry on the local machine and the ActiveSync Horde driver.
See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.horde.org/licenses/lgpl21.
Copyright 2010-2012 Horde LLC (http://www.horde.org/)
Methods summary
public
Horde_ActiveSync_Driver_Horde_Connector_Registry
|
#
__construct( array $params = array() )
Const'r
Parameters
- $params
- Configuration parameters. Requires:
<span class="php-quote">'registry'</span> - An instance of Horde_Registry
Returns
Horde_ActiveSync_Driver_Horde_Connector_Registry
|
public
array
|
#
calendar_listUids( integer $startstamp, integer $endstamp )
Get a list of events from horde's calendar api
Get a list of events from horde's calendar api
Parameters
- $startstamp
- The start of time period.
- $endstamp
- The end of time period
Returns
array
|
public
array
|
#
calendar_listBy( string $action, integer $from_ts, integer $to_ts )
Get a list of event uids that have had $action happen since $from_ts.
Get a list of event uids that have had $action happen since $from_ts.
Parameters
- $action
- The action to check for (add, modify, delete)
- $from_ts
- The timestamp to start checking from
- $to_ts
- The ending timestamp
Returns
array
An array of event uids
|
public
Horde_ActiveSync_Message_Appointment
|
#
calendar_export( string $uid )
Export the specified event as an ActiveSync message
Export the specified event as an ActiveSync message
Parameters
Returns
Horde_ActiveSync_Message_Appointment
|
public
string
|
#
calendar_import( Horde_ActiveSync_Message_Appointment $content )
Import an event into Horde's calendar store.
Import an event into Horde's calendar store.
Parameters
- $content
- The event content
Returns
string
The event's UID
|
public
boolean
|
#
calendar_replace( string $uid, Horde_ActiveSync_Message_Appointment $content )
Replace the event with new data
Replace the event with new data
Parameters
- $uid
- The UID of the event to replace
- $content
- The new event content
Returns
boolean
|
public
boolean
|
#
calendar_delete( string $uid )
Delete an event from Horde's calendar storage
Delete an event from Horde's calendar storage
Parameters
- $uid
- The UID of the event to delete
Returns
boolean
|
public
integer
|
#
calendar_getActionTimestamp( string $uid, string $action )
Return the timestamp for the last time $action was performed.
Return the timestamp for the last time $action was performed.
Parameters
- $uid
- The UID of the event we are interested in.
- $action
- The action we are interested in (add, modify...)
Returns
integer
|
public
array
|
#
contacts_listUids( )
Get a list of all contacts a user can see
Get a list of all contacts a user can see
Returns
array
of contact UIDs
|
public
array
|
#
contacts_export( string $uid )
Export the specified contact from Horde's contacts storage
Export the specified contact from Horde's contacts storage
Parameters
Returns
array
The contact hash
|
public
boolean
|
#
contacts_import( string $content, string $import_source = null )
Import the provided contact data into Horde's contacts storage
Import the provided contact data into Horde's contacts storage
Parameters
- $content
- The contact data
- $import_source
- $source The contact source to import to
Returns
boolean
|
public
boolean
|
#
contacts_replace( string $uid, string $content, string $sources = null )
Replace the specified contact with the data provided.
Replace the specified contact with the data provided.
Parameters
- $uid
- The UID of the contact to replace
- $content
- The contact data
- $sources
- The sources where UID will be replaced
Returns
boolean
|
public
bolean
|
#
contacts_delete( string $uid )
Delete the specified contact
Delete the specified contact
Parameters
- $uid
- The UID of the contact to remove
Returns
bolean
|
public
integer
|
#
contacts_getActionTimestamp( string $uid, string $action )
Get the timestamp of the most recent occurance of $action for the
specifed contact
Get the timestamp of the most recent occurance of $action for the
specifed contact
Parameters
- $uid
- The UID of the contact to search
- $action
- The action to lookup
Returns
integer
|
public
array
|
#
contacts_listBy( string $action, integer $from_ts, integer $to_ts )
Get a list of contact uids that have had $action happen since $from_ts.
Get a list of contact uids that have had $action happen since $from_ts.
Parameters
- $action
- The action to check for (add, modify, delete)
- $from_ts
- The timestamp to start checking from
- $to_ts
- The ending timestamp
Returns
array
An array of event uids
|
public
|
|
public
string
|
|
public
array
|
#
tasks_listUids( )
List all tasks in the user's default tasklist.
List all tasks in the user's default tasklist.
Returns
array
An array of task uids.
|
public
|
|
public
Horde_ActiveSync_Message_Task
|
#
tasks_export( string $uid )
Export a single task from the backend.
Export a single task from the backend.
Parameters
Returns
Horde_ActiveSync_Message_Task
The task message object
|
public
string
|
#
tasks_import( Horde_ActiveSync_Message_Task $message )
Importa a single task into the backend.
Importa a single task into the backend.
Parameters
- $message
- The task message object
Returns
string
The newly added task's uid.
|
public
boolean
|
#
tasks_replace( string $uid, Horde_ActiveSync_Message_Task $message )
Replace an existing task with the provided task.
Replace an existing task with the provided task.
Parameters
- $uid
- The existing tasks's uid
- $message
- The task object
Returns
boolean
|
public
boolean
|
#
tasks_delete( string $id )
Delete a task from the backend.
Delete a task from the backend.
Parameters
Returns
boolean
|
public
integer
|
#
tasks_getActionTimestamp( string $uid, string $action )
Return the timestamp for the last time $action was performed.
Return the timestamp for the last time $action was performed.
Parameters
- $uid
- The UID of the task we are interested in.
- $action
- The action we are interested in (add, modify...)
Returns
integer
|
public
array
|
#
tasks_listBy( string $action, integer $from_ts )
Get a list of task uids that have had $action happen since $from_ts.
Get a list of task uids that have had $action happen since $from_ts.
Parameters
- $action
- The action to check for (add, modify, delete)
- $from_ts
- The timestamp to start checking from
Returns
array
An array of event uids
|
public
array
|
#
horde_listApis( )
Return all active api interfaces.
Return all active api interfaces.
Returns
array
An array of interface names.
|
public
mixed
|
#
horde_getPref( string $app, string $pref )
Obtain a user's preference setting.
Obtain a user's preference setting.
Parameters
- $app
- The Horde application providing the setting.
- $pref
- The name of the preference setting.
Returns
mixed
The preference value
|
public
string
|
#
horde_hasInterface( string $api )
Obtain the name of the Horde application that provides the specified api
interface.
Obtain the name of the Horde application that provides the specified api
interface.
Parameters
Returns
string
The application name.
|
public
array
|
#
getChanges( string $collection, integer $from_ts, integer $to_ts )
Get all server changes for the specified collection
Get all server changes for the specified collection
Parameters
- $collection
- The collection type (calendar, contacts, tasks)
- $from_ts
- Starting timestamp
- $to_ts
- Ending timestamp
Returns
array
A hash of add, modify, and delete uids
Throws
InvalidArgumentException
|
public
|
#
clearAuth( )
Clear the authentication and destroy the current session.
Clear the authentication and destroy the current session.
|