• Home
• Horde_ActiveSync_SyncCache

PHP Class Horde_ActiveSync_SyncCache, horde

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

Protected Properties

Property	Type	Description
$_data	array	The cache data.
$_devid	string	The device id
$_dirty	array	Track dirty properties.
$_logger	Horde_Log_Logger	Logger
$_procid	integer	Process id for logging.
$_state	Horde_ActiveSync_State_Base	The state driver
$_user	string	The username

Public Methods

Method	Description
__construct ( Horde_ActiveSync_State_Base $state, string $devid, string $user, Horde_Log_Logger $logger = null ) : Horde_ActiveSync_SyncCache	Constructor
__get ( $property )
__isset ( $property )
__set ( $property, $value )
addCollection ( array $collection )	Add a new collection to the cache
addConfirmedKey ( string $key )	Add a confirmed synckey to the cache.
clearCollectionKeys ( )	Clear all synckeys from the known collections.
clearCollections ( )	Remove all collection data.
clearFolders ( )	Clear the folder cache
collectionExists ( stirng $collectionid ) : boolean	Check for the existance of a specific collection in the cache.
collectionIsPingable ( string $id ) : boolean	Check if a specified collection is PINGable.
countCollections ( )	Return the count of available collections in the cache
delete ( )	Delete the entire synccache from the backend.
deleteFolder ( string $folder )	Remove a folder from the cache
getCollections ( boolean $requireKey = true ) : array	Return all the collections in the syncCache.
getFolder ( string $folder ) : array | boolean	Return an entry from the folder cache.
getFolders ( )	Return the folders cache.
hasPingChangeFlag ( string $collectionid ) : boolean	Checks the status of the ping change flag. If true, the last PING request detected a change in the specified collection.
loadCacheFromStorage ( )	Repopulate the cache data from storage.
refreshCollections ( )	Refresh the cached collections from the state backend.
refreshFolderCache ( )	Refresh the folder cache from the backend.
removeCollection ( string $id, boolean $purge = true )	Remove a collection from the cache.
removeConfirmedKey ( string $key )	Remove a confirmed sycnkey from the cache
removePingableCollection ( $id )	Set a collection as non-PINGable.
resetPingChangeFlag ( string $id )	Reset the specified collection's ping change flag.
save ( )	Save the synccache to storage.
setPingChangeFlag ( string $id )	Set the ping change flag on a collection. Indicatates that the last PING was terminated with a change in this collection.
setPingableCollection ( string $id )	Set a specific collection to be PINGable.
updateCollection ( array $collection, array $options = [] )	Update a collection in the cache.
updateFiltertype ( string $id, integer $filtertype )	Update the filtertype for the specified collection.
updateFolder ( Horde_ActiveSync_Message_Folder $folder )	Update a folder entry in the cache.
updateTimestamp ( )	Update the cache timestamp to the current time.
updateWindowSize ( string $id, $windowsize )	Update the windowsize for the specified collection.
validateCache ( boolean $hb_only = false ) : boolean	Validate the cache. Compares the cache timestamp with the current cache timestamp in the state backend. If the timestamps are different, some other request has modified the cache, so it should be invalidated.
validateCollectionsFromCache ( array &$collections )	Validate the collections from the cache and fill in any missing values from the folder cache.
validateTimestamps ( ) : boolean	Perform some sanity checking on the various timestamps to ensure we are in a valid state. Basically checks that we are not currently running a looping sync and that the last looping sync ending normally.

Protected Methods

Method	Description
_isValidProperty ( $property )
_markCollectionsDirty ( boolean $id )	Mark specific collection as dirty, but only if the entire collection data is not already marked dirty.

Method Details

Property Details