Class cacheManager

Standard options interface

Package: plugins\cachemanager
Author: Stephen
Located at zp-extensions/cacheManager.php

Methods summary
`public`	# `__construct( )`
`public`	# `getOptionsSupported( )` supported options
`public`	# `handleOption( string $option, mixed $currentValue )` custom option handler Parameters `$option` `$currentValue`
`public static`	# `printJS( )`
`public string`	# `handleOptionSave( string $themename, string $themealbum )` process custom option saves Parameters `$themename` `$themealbum` Returns string
`public static`	# `addCacheSize( string $owner, integer $size, integer $width, integer $height, integer $cw, integer $ch, integer $cx, integer $cy, boolean $thumb, boolean $watermark = NULL, string $effects = NULL, boolean $maxspace = false )` Adds a custom image cache size for themes and – despite the method name – also for plugins Adds a custom image cache size for themes and – despite the method name – also for plugins Parameters `$owner` Name of the theme (or plugin) this belongs to `$size` `$width` `$height` `$cw` crop width `$ch` crop height `$cx` crop x `$cy` crop y `$thumb` `$watermark` `$effects` `$maxspace`
`public static`	# `addThemeCacheSize( $theme, $size, $width, $height, $cw, $ch, $cx, $cy, $thumb, $watermark = NULL, $effects = NULL, $maxspace = false )` Adds a custom image cache size for themes and – despite the method name – also for plugins Adds a custom image cache size for themes and – despite the method name – also for plugins Deprecated Zenphoto 1.6 - Use cacheManager::addCacheSize() instead Since Zenphoto 1.5.1
`public static`	# `addDefaultThumbSize( )` Adds the default theme thumb cache size Adds the default theme thumb cache size
`public static`	# `addThemeDefaultThumbSize( )` Adds the default theme thumb cache size Adds the default theme thumb cache size Deprecated Zenphoto 1.6 - Better use cacheManager::addDefaultThumbSize(); Since Zenphoto 1.5.1
`public static`	# `addDefaultSizedImageSize( )` Adds default sized image size for the cachemanger Adds default sized image size for the cachemanger
`public static`	# `addThemeDefaultSizedImageSize( )` Deprecated Zenphoto 1.6 - Better use cacheManager::addDefaultSizedImageSize(); Since Zenphoto 1.5.1
`public static`	# `published( object $obj )` filter for the setShow() methods Parameters `$obj`
`public static string`	# `getTitle( string $table, string $row )` Parameters `$table` `$row` Returns string
`public static`	# `recordMissing( string $table, string $row, string $image )` Updates an global array variable with missing images Updates an global array variable with missing images Parameters `$table` `$row` `$image`
`public static mixed`	# `updateCacheName( mixed $text, string $target, string $update )` Updates the path to the cache folder Updates the path to the cache folder Parameters `$text` `$target` `$update` Returns mixed
`public static array`	# `getSizes( string $mode = 'all' )` Returns an array with the stored sizes to cache Returns an array with the stored sizes to cache Note: The default thumb and sized image sizes are not included even if set Parameters `$mode` "all" for all sizes stored, "inactive' or "active" Returns array
`public static type`	# `loadAlbums( type $albumobj )` Processes an album and recursively its subalbums Processes an album and recursively its subalbums Parameters `$albumobj` Returns type
`public static`	# `loadAlbum( obj $albumobj )` Processes a single album to cache its images Processes a single album to cache its images Parameters `$albumobj` $album Object of the album to cache the images
`public static integer`	# `loadImages( type $albumobj )` Processes the images of an album Processes the images of an album Parameters `$albumobj` Returns integer
`public static mixed`	# `generateImage( string $imageuri )` Sends a single cURL request to i.php to generate the image size requested if curl is available, otherwise requests the image size directly by printing it. Sends a single cURL request to i.php to generate the image size requested if curl is available, otherwise requests the image size directly by printing it. Parameters `$imageuri` The image processor uri to this image Returns mixed
`public static boolean`	# `isValid( string $owner )` Used to check and skip cachemanager sizes if - their owner (theme or extension) isn't existing or not enabled. Also used to sort our default thumb/default sized image Used to check and skip cachemanager sizes if - their owner (theme or extension) isn't existing or not enabled. Also used to sort our default thumb/default sized image Checks if this is from an existing theme ("admin" sizes are always valid) Checks if this is from an enabeled extension Checks if this is a custom size (e.g. not one of the non active plugins) Parameters `$owner` Returns boolean
`public static`	# `printSizesListEntry( string $value, string $checked, string $text, string $class = null )` Prints the form elements to select a cache size to process Prints the form elements to select a cache size to process Parameters `$value` `$checked` `$text` `$class`
`public static`	# `overviewbutton( $buttons )`
`public static`	# `albumbutton( $html, $object, $prefix )`
`public static`	# `deleteCacheSizes( string $owner )` Deletes theme cache sizes of the owner Deletes theme cache sizes of the owner Parameters `$owner` $owner) Owner of the cache size (theme or extension)
`public static`	# `deleteThemeCacheSizes( string $owner )` Deprecated Zenphoto 1.6 - Use cachemanager::deleteCacheSizes() instead Parameters `$owner` Owner of the cache size (theme or extension) Since Zenphoto 1.5.1
`public static`	# `cleanupCacheSizes( )` Removes up all sizes by non existing themes and non active plugins on this install Removes up all sizes by non existing themes and non active plugins on this install
`public static`	# `printCurlNote( )` Just prints a note if the PHP extension cURL is not available Just prints a note if the PHP extension cURL is not available
`public static`	# `printButtons( string $returnpage, string $alb = '', boolean $hidden = false )` Prints the buttons after you cached image sizes Prints the buttons after you cached image sizes Parameters `$returnpage` Pageurl to return to `$alb` Name of the album if caching from an album page `$hidden` True if the buttons should be hidden via the css class "hidden" initially.

Properties summary
`public static array`	`$sizes`	# `array()`
`public static array`	`$enabledsizes`	# `array()`
`public static integer`	`$albums_cached`	# `0`
`public static integer`	`$images_cached`	# `0`
`public static integer`	`$imagesizes_total`	# `0`
`public static integer`	`$starttime`	# `0`
`public static integer`	`$imagesizes_cached`	# `0`
`public static integer`	`$imagesizes_failed`	# `0`
`public static`	`$missingimages`	# `null`

Classes

Interfaces

Exceptions

Functions

Class cacheManager

Parameters

Parameters

Returns

Parameters

Deprecated

Since

Deprecated

Since

Deprecated

Since

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Deprecated

Parameters

Since

Parameters