• Home
• Horde_ActiveSync_State_Sql

PHP Class Horde_ActiveSync_State_Sql, horde

Needs a number of SQL tables present: syncStateTable (horde_activesync_state): sync_timestamp: - The timestamp of last sync sync_key: - The syncKey for the last sync sync_pending: - If the last sync resulted in a MOREAVAILABLE, this contains a list of UIDs that still need to be sent to the client. sync_data: - Any state data that we need to track for the specific syncKey. Data such as current folder list on the client (for a FOLDERSYNC) and IMAP email UIDs (for Email collections during a SYNC). sync_devid: - The device id. sync_folderid:- The folder id for this sync. sync_user: - The user for this synckey. sync_mod: - The last modification stamp. syncMapTable (horde_activesync_map): message_uid - The server uid for the object sync_modtime - The time the change was received from the client and applied to the server data store. sync_key - The syncKey that was current at the time the change was received. sync_devid - The device id this change was done on. sync_user - The user that initiated the change. syncDeviceTable (horde_activesync_device): device_id - The unique id for this device device_type - The device type the client identifies itself with device_agent - The user agent string sent by the device device_policykey - The current policykey for this device device_rwstatus - The current remote wipe status for this device syncUsersTable (horde_activesync_device_users): device_user - A username attached to the device device_id - The device id device_policykey - The provisioned policykey for this device/user combination. 显示文件 Open project: horde/horde

Protected Properties

Property	Type	Description
$_db	Horde_Db_Adapter	DB handle
$_syncCacheTable	string	The Synccache table. Holds the sync cache and is used to cache info about SYNC and PING request that are only sent a single time. Also stores data supported looping SYNC requests.
$_syncDeviceTable	string	Device information table. Holds information about each client.
$_syncMailMapTable	string	The Sync Mail Map table. Same principle as self::_syncMapTable, but for email collection data.
$_syncMapTable	string	The Sync Map table. This table temporarily holds information about changes received FROM the client and is used to prevent mirroring back changes to the client that originated there.
$_syncStateTable	string	State table name. This table holds the device's current state.
$_syncUsersTable	string	Users table. Holds information specific to a user.

Public Methods

Method	Description
__construct ( array $params = [] ) : Horde_ActiveSync_State_Sql	Const'r
connect ( )	(Re)open backend storage connection.
deleteSyncCache ( string $devid, string $user = null )	Delete a complete sync cache
deviceExists ( string $devId, string $user = null ) : integer	Check that a given device id is known to the server. This is regardless of Provisioning status. If $user is provided, checks that the device is attached to the provided username.
disconnect ( )	Close the underlying backend storage connection.
getLastSyncTimestamp ( string $id = null, string $user = null ) : integer	Get the last time the loaded device issued a SYNC request.
getSyncCache ( string $devid, string $user, array $fields = null ) : array	Return the sync cache.
isDuplicatePIMAddition ( string $id ) : string	Check and see that we didn't already see the incoming change from the client.
isDuplicatePIMChange ( string $uid, string $synckey ) : boolean	Check if the UID provided was altered during the SYNC_KEY provided.
listDevices ( string $user = null, array $filter = [] ) : array	List all devices that we know about.
loadDeviceInfo ( string $devId, string $user = null, array $params = [] ) : Horde_ActiveSync_Device	Load the device object.
removeState ( array $options )	Explicitly remove a state from storage.
resetAllPolicyKeys ( )	Reset ALL device policy keys. Used when server policies have changed and you want to force ALL devices to pick up the changes. This will cause all devices that support provisioning to be reprovisioned.
save ( )	Save the current state to storage
saveSyncCache ( array $cache, string $devid, string $user, array $dirty = [] )	Save the provided sync_cache.
setDeviceInfo ( Horde_ActiveSync_Device $data, array $dirty = [] )	Set new device info
setDeviceProperties ( array $data, string $deviceId )	Set the device's properties as sent by a SETTINGS request.
setDeviceRWStatus ( string $devId, string $status )	Set a new remotewipe status for the device
setPolicyKey ( string $devId, integer $key )	Save a new device policy key to storage.
updateServerIdInState ( string $uid, string $serverid )	Update the serverid for a given folder uid in the folder's state object.
updateState ( string $type, array $change, integer $origin = Horde_ActiveSync::CHANGE_ORIGIN_NA, string $user = null, string $clientid = '' )	Update the state to reflect changes
updateSyncStamp ( )	Update the syncStamp in the collection state, outside of any other changes.

Protected Methods

Method	Description
_checkCollision ( string $guid ) : boolean	Check for the (rare) possibility of a synckey collision between collections.
_gc ( string $syncKey )	Garbage collector - clean up from previous sync requests.
_getMailMapChanges ( array $changes ) : array	Return all available mailMap changes for the current folder.
_getPIMChangeTS ( array $changes ) : array	Return an array of timestamps from the map table for the last client-initiated change for the provided uid. Used to avoid mirroring back changes to the client that it sent to the server.
_havePIMChanges ( ) : boolean	Check for the existence of ANY entries in the map table for this device and user.
_loadState ( )	Load the state represented by $syncKey from storage.
_loadStateFromResults ( array $results )	Actually load the state data into the object from the query results.
_resetDeviceState ( string $id ) : void	Reset the sync state for this device, for the specified collection.

Method Details

Property Details