• Home
• Horde_ActiveSync_State_Base

PHP Class Horde_ActiveSync_State_Base, horde

显示文件 Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_backend		The backend driver
$_changes	array	(Will remain null until getChanges() is called)
$_collection	array	Keys include: - class: The collection class Contacts, Calendar etc... - synckey: The current synckey - newsynckey: The new synckey sent back to the client - id: Server folder id - filtertype: Filter - conflict: Conflicts - truncation: Truncation
$_deviceInfo	Horde_ActiveSync_Device	Device object.
$_folder		Caches the current state(s) in memory
$_folderUidMap	array	A map of backend folderids to UIDs
$_lastSyncStamp	timestamp	The timestamp for the last syncKey
$_logger	Horde_Log_Logger	Logger instance
$_params	array	Configuration parameters
$_procid	integer	The process id (used for logging).
$_syncKey	string	The syncKey for the current request.
$_thisSyncStamp	timestamp	The current sync timestamp
$_type	string	The type of request we are handling.

Public Methods

Method	Description
RowCmp ( $a, $b ) : unknown_type	Helper function for the _diff method
__construct ( array $params = [] )	Const'r
checkCollision ( string $syncKey ) : boolean	Check for the (rare) possibility of a synckey collision between collections.
connect ( )	(Re)open backend storage connection.
deleteSyncCache ( string $devid, string $user )	Delete a complete sync cache
deviceExists ( string $devId, string $user = null ) : boolean	Check that a given device id is known to the server. This is regardless of Provisioning status.
disconnect ( )	Close the underlying backend storage connection.
generatePolicyKey ( ) : integer	Generate a random 10 digit policy key
getChangeCount ( ) : integer	Get the number of server changes.
getChanges ( array $options = [] ) : array	Get all items that have changed since the last sync time
getCurrentSyncKey ( ) : string	Get the current synckey
getDeviceRWStatus ( string $devId, boolean $refresh = false ) : integer	Return a device wipe status
getFolderUidForBackendId ( string $serverid ) : string | boolean	Get a EAS Folder Uid for the given backend server id.
getFolderUidToBackendIdMap ( ) : array	Return the mapping of folder uids to backend folderids.
getKnownFolders ( ) : array	Return an array of known folders. This is essentially the state for a FOLDERSYNC request. AS uses a seperate synckey for FOLDERSYNC requests also, so need to treat it as any other collection.
getLastSyncTimestamp ( ) : integer	Get the last time the currently loaded device issued a SYNC request.
getLatestSynckeyForCollection ( string $collection_id ) : string | integer	Return the most recently seen synckey for the given collection.
getNewSyncKey ( string $syncKey ) : string	Gets the new sync key for a specified sync key. You must save the new sync state under this sync key when done sync'ing by calling setNewSyncKey(), then save().
getNewSyncKeyWrapper ( string $syncKey ) : string	Non-static wrapper for getNewSyncKey.
getPolicyKey ( string $devId ) : integer	Obtain the current policy key, if it exists.
getSyncCache ( string $devid, string $user, array $fields = null ) : array	Return the sync cache.
getSyncKeyCounter ( string $syncKey ) : mixed	Return the counter for the specified syncKey.
getSyncKeyUid ( string $syncKey ) : string	Return the UID portion of a synckey.
isConflict ( array $stat, string $type ) : boolean	Determines if the server version of the message represented by $stat conflicts with the client version of the message. For this driver, this is true whenever $lastSyncTime is older then $stat['mod']. Method is only called from the Importer during an import of a non-new change from the client.
isDuplicatePIMAddition ( string $id ) : string	Check and see that we didn't already see the incoming change from the client.
listDevices ( ) : array	List all devices that we know about.
loadDeviceInfo ( $device, string $user = null, array $params = [] ) : Horde_ActiveSync_Device	Obtain the device object.
loadState ( array $collection, string $syncKey, string $type = null, string $id = null )	Load and initialize the sync state
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 syncstate to storage
saveSyncCache ( array $cache, string $devid, string $user, array $dirty = [] )	Save the provided sync_cache.
setBackend ( Horde_ActiveSync_Driver_Base $backend ) : void	Set the backend driver (should really only be called by a backend object when passing this object to client code)
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
setLogger ( Horde_Log_Logger $logger )	Set the logger instance for this object.
setNewSyncKey ( string $newKey )	Update the $oldKey syncState to $newKey.
setPolicyKey ( string $devId, integer $key )	Save a new device policy key to storage.
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
_getCutOffDate ( integer $restrict ) : integer	Returns the timestamp of the earliest modification time to consider
_getDiff ( array $old, array $new ) : unknown_type	Helper function that performs the actual diff between client state and server state FOLDERSYNC arrays.
_getFolderChanges ( )	Get folder changes. Populates $this->_changes with an array of change entries each containing 'type', 'id' and possibly 'flags'.
_getMailMapChanges ( array $changes ) : array	Return all available mailMap changes for the current folder.
_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.

Method Details

Property Details