ePages 6.11.0 - DE_EPAGES/Presentation/API/PageCache.pm

Package DE_EPAGES::Presentation::API::PageCache

Interface for page cache handling.

@EXPORT_OK
UpdatePageCache
InvalidatePageCache
IsCacheFileUpToDate
GetCacheFileName
DeleteCacheFile
DeleteCacheFiles

Functions

DeleteCacheFile
DeleteCacheFiles
GetCacheFileName
InvalidatePageCache
IsCacheFileUpToDate
UpdatePageCache

DeleteCacheFile

Delete the static file for the given object, view action, locale id and params

Syntax
DeleteCacheFile($Object, $ViewActionName, $LocaleID, $hParams);
Input
$Object (object)
object
$ViewActionName (string)
name of the ViewAction
$LocaleID (string)
locale id
$hParams (hash)
additional params like sort order

DeleteCacheFiles

Delete the static files of each currency and locale for the given object

Syntax
DeleteCacheFiles($Object, $ViewActionName,$hParams);
Input
$Object (object)
object
$ViewActionName (string)
name of the ViewAction
$hParams (hash)
additional params like sort order

GetCacheFileName

Returns the filename, which is used to save the static content. (like Object.StaticPath/GUID_ViewAction_Locale_Language_Currency_pagePage_pageSizePageSize

Syntax
$FileName = GetCacheFileName($Object, $ViewActionName, $LocaleID, $hParams);
Input
$Object (object)
object
$ViewActionName (string)
name of the ViewAction
$LocaleID (string)
locale id
$hParams (hash)
additional params like sort order
Return
$FileName (string)
filename of the cached file (without extension)

InvalidatePageCache

Sets PageCacheLastInvalidation to current date. (obsolete use DE_EPAGES::Object::API::Object::Site::invalidatePageCache)

Syntax
InvalidatePageCache($Site);
Input
$Site (object)
site object

IsCacheFileUpToDate

Is cached file up-to-date ?

Syntax
$LoadOldPage = IsCacheFileUpToDate($CacheFileName, $PageCache);
Input
$CacheFileName (string)
file name
$PageCache (int)
how many minutes is the file up-to-date, see DE_EPAGES::Object::API::Object::Object::pageCacheDuration
Return
$LoadOldPage (boolean)
file is up-to-date

UpdatePageCache

Updates page cache date of the object's site if the object is an instance of one of the pre-defined classes. These classes influence the content which is shown on storefront pages. (obsolete use DE_EPAGES::Object::API::Object::Object::updatePageCache)

Syntax
UpdatePageCache($Object);
Input
$Object (object)
the object