ZenphotoCMS 1.6.5

static_html_cache
in package

Table of Contents

Properties

$enabled  : mixed
$dirty  : mixed
$pageCachePath  : mixed

Methods

_disable()  : string
used to disable cashing when the uri is an image processor uri
abortHTMLCache()  : mixed
Aborts HTML caching Used for instance, when there is a 404 error or such
checkIfAllowedPage()  : bool
Checks if the current page should be excluded from caching.
clearHTMLCache()  : mixed
Cleans out the cache folder. (Adpated from the zenphoto image cache)
clearOnPublish()  : mixed
Clears the html cache for items if published and this is enabled on the options
createCacheFilepath()  : string
Creates the path and filename of the page to be cached.
deletestatic_html_cacheFile()  : mixed
Deletes a cache file
disable()  : mixed
call to disable caching a page
endHTMLCache()  : mixed
Ends the caching: Ends the output buffering and writes the html cache file from the buffer
overviewbutton()  : string
Adds the utility button for cache clearing
startHTMLCache()  : mixed
Starts the caching: Gets either an already cached file if existing or starts the output buffering.

Properties

Methods

_disable()

used to disable cashing when the uri is an image processor uri

public static _disable(string $uri) : string
Parameters
$uri : string
Return values
string

abortHTMLCache()

Aborts HTML caching Used for instance, when there is a 404 error or such

public abortHTMLCache() : mixed

checkIfAllowedPage()

Checks if the current page should be excluded from caching.

public checkIfAllowedPage() : bool

Pages that can be excluded are custom pages included Zenpage pages (these optionally more specific by titlelink) and the standard theme pages image.php (optionally by image file name), album.php (optionally by album folder name) or index.php

Return values
bool

clearHTMLCache()

Cleans out the cache folder. (Adpated from the zenphoto image cache)

public static clearHTMLCache([mixed $folder = NULL ]) : mixed
Parameters
$folder : mixed = NULL

clearOnPublish()

Clears the html cache for items if published and this is enabled on the options

public static clearOnPublish(object $obj) : mixed
Parameters
$obj : object
Tags
since
1.6.1

former published() method functionality moved from cacheManager

createCacheFilepath()

Creates the path and filename of the page to be cached.

public createCacheFilepath(mixed $accessType) : string
Parameters
$accessType : mixed
Return values
string

deletestatic_html_cacheFile()

Deletes a cache file

public deletestatic_html_cacheFile(string $cachefilepath) : mixed
Parameters
$cachefilepath : string

Path to the cache file to be deleted

endHTMLCache()

Ends the caching: Ends the output buffering and writes the html cache file from the buffer

public endHTMLCache() : mixed

Place this function on zenphoto's root index.php file in the absolute last line

overviewbutton()

Adds the utility button for cache clearing

public static overviewbutton(array<string|int, mixed> $buttons) : string
Parameters
$buttons : array<string|int, mixed>
Tags
since
1.6.1

moved from cacheManager

Return values
string

startHTMLCache()

Starts the caching: Gets either an already cached file if existing or starts the output buffering.

public startHTMLCache() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results