ePages 6.10 - DE_EPAGES/Object/API/SavedIncludesHandler.pm

Package DE_EPAGES::Object::API::SavedIncludesHandler

Handles SavedIncludes.

Functions

clearAllCaches
clearObjectCache
getObjectCachePath
getRootCachePath
new
savePage

clearAllCaches

Deletes the directory where all "saved-includes" stored.

Syntax
$SavedIncludesHandler->clearAllCaches;

clearObjectCache

Deletes the directory of a specific object cache. Function check's if cache directory exist and delete them.

Syntax
$SavedIncludesHandler->clearObjectCachePath($Object);
Input
$Object (string)
object that is already cached

getObjectCachePath

Returns the path of cache directory for an specific object. The object doesnt have to cached already, so the directory doesent have to exist.

Syntax
$CachePath = $SavedIncludesHandler->getObjectCachePath($Object);
Input
$Object (string)
object that should be cached, or is already cached
Return
$ObjectCachePath (string)
path to directory of object cache

getRootCachePath

Returns the path of directory where all "saved-includes" stored. (e.g. "C:/epages/Shared/Static/Store/SavedIncludes")

Syntax
$CachePath = $SavedIncludesHandler->getRootCachePath;
Return
$CachePath (string)
path to root directory

new

Creates a new SavedIncludesHandler object

Syntax
$SavedIncludesHandler = DE_EPAGES::Object::API::SavedIncludesHandler->new();

savePage

Save cache of actual object in File. Use static path of actual object. To save cache file the function will need a unique cachekey, this key is integrated in filename. Also a function to compute the content is needed. Content is computed if no cachefile exist.

Syntax
$Content = $SavedIncludesHandler->savePage($CacheKey, $FallBackSub);
Example
$Content = $SavedIncludesHandler->savePage('MBO.Menu_de',
sub{
    return join '', @{$Processor->replaceTLEs($cTemplate)};
});
Input
$CacheKey (string)
name or key must be unique for an object
$FallBackSub (sub)
function that generate and returns actual content
Return
$Content (content)
Content from cached file