[ class tree: plugins ] [ index: plugins ] [ all elements ]

Class: staticCache

Source Location: /zp-extensions/static_html_cache.php

Class staticCache

Property Summary
mixed   $disable  
mixed   $pageCachePath  

[ Top ]
Method Summary
void   abortHTMLCache()   Aborts HTML caching
bool   checkIfAllowedPage()   Checks if the current page should be excluded from caching.
void   clearHTMLCache()   Cleans out the cache folder. (Adpated from the zenphoto image cache)
string   createCacheFilepath()   Creates the path and filename of the page to be cached.
void   deleteStaticCacheFile()   Deletes a cache file
void   endHTMLCache()   Ends the caching: Ends the output buffering and writes the html cache file from the buffer
void   startHTMLCache()   Starts the caching: Gets either an already cached file if existing or starts the output buffering.

[ Top ]
Properties
mixed   $disable = false [line 92]

[ Top ]
mixed   $pageCachePath = NULL [line 93]

[ Top ]
Methods
abortHTMLCache  [line 218]

  void abortHTMLCache( )

Aborts HTML caching

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



[ Top ]
checkIfAllowedPage  [line 104]

  bool checkIfAllowedPage( )

Checks if the current page should be excluded from caching.

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



[ Top ]
clearHTMLCache  [line 315]

  void clearHTMLCache( [ $folder = ''], string $cachefolder  )

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

Parameters:
string   $cachefolder:  the sub-folder to clean
   $folder: 


[ Top ]
createCacheFilepath  [line 230]

  string createCacheFilepath( )

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



[ Top ]
deleteStaticCacheFile  [line 304]

  void deleteStaticCacheFile( string $cachefilepath  )

Deletes a cache file

Parameters:
string   $cachefilepath:  Path to the cache file to be deleted


[ Top ]
endHTMLCache  [line 196]

  void endHTMLCache( )

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

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



[ Top ]
startHTMLCache  [line 161]

  void startHTMLCache( )

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



[ Top ]

Documentation generated on Tue, 20 Dec 2011 16:08:10 +0100 by phpDocumentor 1.4.3