Modules/Default/ApplicationCache/Facade.php

Show: inherited
Table of Contents

\Conjoon_Modules_Default_ApplicationCache_Facade

Package: Default

This facade eases the access to often needed operations regarding backend implementations of the ApplicationCache.

Author
Thorsten Suckow-Homberg  

Properties

Propertyprivate\Conjoon_Modules_Default_ApplicationCache_Facade  $_instance= 'null'
static

Default valuenullDetails
Type
\Conjoon_Modules_Default_ApplicationCache_Facade
Propertyprivate\Conjoon_Modules_Default_Registry_Facade  $_registryFacade= 'null'

Default valuenullDetails
Type
\Conjoon_Modules_Default_Registry_Facade

Methods

methodprivate__clone( ) : void

Enforce singleton.

methodprivate__construct( ) : void

Enforce singleton.

methodpublicgetCacheEntryCountForUserId( integer $userId, string $folder ) : integer

Returns the number of cache entries that should get cached locally.

The number depends of the user settings, i.e. which kind of filetypes he wishes to cache.

Parameters
Name Type Description
$userId integer

The id of the user for whom the number of cache entries should be returned.

$folder string

The folder where the manifest files resist

Returns
Type Description
integer
Throws
Exception Description
\InvalidArgumentException, RuntimeException
methodpublicgetCacheLastChangedTimestampForUserId( integer $userId ) : float

Returns the Unix timestamp in milliseconds of the cache last changes, i.e. the last time the user altered the options regarding file-types to cache.

Parameters
Name Type Description
$userId integer

The id of the user for whom the lastChanged- timestamp should get returned.

Returns
Type Description
float
Throws
Exception Description
\InvalidArgumentException
methodpublicgetManifestFileListForUserId( integer $userId, string $folder ) : array

Returns the list of files that hold the cache entries: based on the user settings, only this files will be returned which represent a group of filetypes that should get cached.

Parameters
Name Type Description
$userId integer

The user id for which the fileList should be returned

$folder string

The folder where the manifest files resist

Returns
Type Description
array an associative array with the following keys: - combinedFile: a file name that should point to a file which holds all the requested cache files already combined - fileList: an array with file names where all the entries for the requested caches can be found
Throws
Exception Description
\InvalidArgumentException
methodpublicsetCacheLastChangedTimestampForUserId( float $microtime, integer $userId ) : void

Sets the last cached microtimestamp for the specified userId.

Parameters
Name Type Description
$microtime float

The time in milliseconds

$userId integer

The id of the user for whom the lastChanged- timestamp should be set.

Throws
Exception Description
\InvalidArgumentException
Documentation was generated by DocBlox 0.18.1.