• Home
• Horde_ActiveSync_Collections

PHP Class Horde_ActiveSync_Collections, horde

Mostra file Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_as	Horde_ActiveSync	The ActiveSync server object.
$_cache	Horde_ActiveSync_SyncCache	The syncCache
$_changedCollections	array	Cache of collections that have had changes detected.
$_changes	array	Cache of changes.
$_collections	array	The collection data
$_globalWindowSize	integer	Global WINDOWSIZE Defaults to 100 (MS-ASCMD 2.2.3.188)
$_hangingSync	boolean	Flag to indicate the client is requesting a hanging SYNC.
$_importedChanges	boolean	Imported changes flag.
$_logger	Horde_Log_Logger	The logger
$_procid	integer	Cache the process id for logging.
$_shortSyncRequest	boolean	Short sync request flag.
$_synckeyCount	integer	Count of available synckeys
$_tempSyncCache	Horde_ActiveSync_SyncCache	Cache a temporary syncCache.
$_unchangedCount	integer	Count of unchanged collections calculated for PARTIAL sync.
$_windowsizeOverride	boolean	Flag to indicate we have overridden the globalWindowSize

Public Methods

Method	Description
__call ( $method, $parameters )	Magic.
__construct ( Horde_ActiveSync_SyncCache $cache, Horde_ActiveSync $as )	Const'r
__get ( $property )	Property getter
__set ( $property, $value )	Property setter.
addCollection ( array $collection, boolean $requireSyncKey = false )	Add a new populated collection array to the sync cache.
cachedCollectionCount ( ) : integer	Return the count of collections in the cache only.
canDoLoopingSync ( ) : boolean	Return whether or not we want a looping sync. We can do a looping sync if we have no imported changes AND we have either a hbinterval, wait, or a shortSync.
canSendEmptyResponse ( ) : boolean	Return if we can do an empty response
checkFilterType ( string $id, string $filter ) : boolean	Check for an update FILTERTYPE
checkStaleRequest ( ) : boolean	Return if the current looping sync is stale. A stale looping sync is one which has begun earlier than the most recently running sync reported by the syncCache.
collectionCount ( ) : integer	Return the count of available collections.
deleteFolderFromHierarchy ( $uid )	Delete a folder from the hierarchy cache.
ensureOptions ( )	Ensure default OPTIONS values are populated, while not overwriting any existing values.
getBackendIdForFolderUid ( $folderid ) : string	Translate an EAS folder uid into a backend serverid.
getChangesFlag ( string $collection_id ) : boolean	Get the getchanges flag on the specified collection.
getCollectionChangeCount ( boolean $ping = false ) : integer	Return the count of the current collection's chagnes.
getCollectionChanges ( boolean $ping = false, array $ensure = [] ) : array	Return any changes for the current collection.
getCollectionClass ( string $id ) : string | boolean	Return a collection class given the collection id.
getCollectionType ( $id )
getDefaultWindowSize ( )
getFolderUidForBackendId ( string $folderid ) : string	Translate a backend id E.g., INBOX into an EAS folder uid.
getHeartbeat ( ) : integer | boolean	Return the heartbeat interval. Always returned as the heartbeat (seconds) not wait interval (minutes).
getHierarchyChanges ( ) : array	Return all know hierarchy changes.
getIterator ( )	Iterator
getNewCollection ( ) : array	Get a new collection array, populated with default values.
haveHierarchy ( ) : boolean	Return if we have a current folder hierarchy.
havePingableCollections ( ) : boolean	Check if we have any pingable collections.
haveSyncableCollections ( long $version ) : boolean	Determine if we have any syncable collections either locally or in the sync cache.
initCollectionState ( array &$collection, boolean $requireSyncKey = false )	Attempt to initialize the sync state.
initEmptySync ( ) : boolean	Prepare the syncCache for an EMPTY sync request.
initFullSync ( )	Prepares the syncCache for a full sync request.
initHierarchySync ( string $synckey ) : array	Prepare for a hierarchy sync.
initPartialSync ( ) : boolean	Prepares the syncCache for a partial sync request and checks that it is allowed.
loadCollectionsFromCache ( )	Load all the collections we know about from the cache.
pollForChanges ( integer $heartbeat, integer $interval, array $options = [] ) : boolean | integer	Poll the backend for changes.
resetPingCache ( )	Force reset all collection's PINGABLE flag. Used to force client to issue a non-empty PING request.
save ( boolean $preserve_folders = false )	Save the syncCache to storage.
setDefaultWindowSize ( integer $window, boolean $override = false )	Sets the default WINDOWSIZE.
setGetChangesFlag ( string $collection_id )	Set the getchanges flag on the specified collection.
setHeartbeat ( array $hb )	Set the looping sync heartbeat values.
updateCache ( )	Update the syncCache with current collection data.
updateCollectionsFromCache ( )	Updates data from the cache for collectons that are already loaded. Used to ensure looping SYNC and PING requests are operating on the most recent syncKey.
updateFolderinHierarchy ( Horde_ActiveSync_Message_Folder $folder, boolean $update = false )	Update/Add a folder in the hierarchy cache.
updateHierarchyKey ( string $key )	Update the hierarchy synckey in the cache.
updatePingableFlag ( )	Marks all loaded collections with a synckey as pingable.
validateFromCache ( )	Validates the collection data from the syncCache, filling in missing values from the folder cache.
validateHierarchyChanges ( Horde_ActiveSync_Connector_Exporter_FolderSync $exporter, array $seenFolders )	Validate and perform some sanity checks on the hierarchy changes before being sent to the client.

Protected Methods

Method	Description
_checkConfirmedKeys ( )
_getMissingCollectionsFromCache ( )	Populate the collections data with missing data from the syncCache during a PARTIAL SYNC.
_haveNoChangesInPartialSync ( ) : boolean	Return if we have no changes to collection options, but have requested a partial sync. A partial sync must have either a wait, hbinterval, or some subset of collections to be valid.
_sleep ( integer $interval )	Wait for specified interval, and close any backend connections while we wait.

Method Details

Property Details