ezcache.php File Reference

Go to the source code of this file.

Functions
	checkPaths ($cacheEntries, $purge)
if($options['list-tags']) if($options['list-ids'])	clearItems ($cacheEntries, $cli, $name)
	purgeItems ($cacheEntries, $cli, $name)
if(!function_exists( 'readline')) if(!function_exists( 'getUserInput'))	reportProgress ($filename, $count)
Variables
	$cacheList = eZCache::fetchList()
	$cli = eZCLI::instance()
if($options['clear-all']) if($options['clear-tag'])	$idName = false
if($options['purge'])	$noAction = true
	$options
if($options['expiry'])	$purge = false
if($options['iteration-max'])	$purgeExpiry = false
if($options['iteration-sleep'])	$purgeMax = false
	$purgeSleep = false
	$script
	$sys = eZSys::instance()

---

Function Documentation

checkPaths	(	$	cacheEntries,
		$	purge
	)

Definition at line 202 of file bin/php/ezcache.php.

Referenced by clearItems(), and purgeItems().

if ($options['list-tags']) if ($options['list-ids']) clearItems	(	$	cacheEntries,
		$	cli,
		$	name
	)

Definition at line 159 of file bin/php/ezcache.php.

purgeItems	(	$	cacheEntries,
		$	cli,
		$	name
	)

Definition at line 180 of file bin/php/ezcache.php.

if (!function_exists( 'readline')) if (!function_exists( 'getUserInput')) reportProgress	(	$	filename,
		$	count
	)

Definition at line 276 of file bin/php/ezcache.php.

---

Variable Documentation

$cacheList = eZCache::fetchList()

Definition at line 88 of file bin/php/ezcache.php.

Referenced by eZCache\clearAll(), eZCache\clearByID(), eZCache\clearByTag(), eZCache\fetchByIDList(), and eZCache\fetchList().

$cli = eZCLI::instance()

Definition at line 32 of file bin/php/ezcache.php.

if ($options['clear-all']) if ($options['clear-tag']) $idName = false

Definition at line 313 of file bin/php/ezcache.php.

if ($options['purge']) $noAction = true

Definition at line 86 of file bin/php/ezcache.php.

$options

Initial value:

 $script->getOptions( "[clear-tag:][clear-id:][clear-all]" .  "[iteration-sleep:][iteration-max:][expiry:][list-tags][list-ids][purge]",
                                "",
                                array( 'clear-tag' => 'Clears all caches related to a given tag',
                                       'clear-id' => 'Clears all caches related to a given id, separate multiple ids with a comma',
                                       'clear-all' => 'Clears all caches',
                                       'purge' => 'Enforces purging of cache items which ensures that specified entries are physically removed (Useful for saving diskspace). Used together with the clear-* options.',
                                       'iteration-sleep' => 'Amount of seconds to sleep between each iteration when performing a purge operation, can be a float.',
                                       'iteration-max' => 'Amount of items to remove in each iteration when performing a purge operation.',
                                       'expiry' => 'Date or relative time which specifies when cache items are to be considered expired, e.g \'now\', \'-2 days\' or \'last monday\'',
                                       'list-tags' => 'Lists all available tags',
                                       'list-ids' => 'Lists all available ids' ) )

Definition at line 43 of file bin/php/ezcache.php.

if ($options['expiry']) $purge = false

Definition at line 79 of file bin/php/ezcache.php.

Referenced by checkPaths(), and eZCache\clearItem().

if ($options['iteration-max']) $purgeExpiry = false

Definition at line 68 of file bin/php/ezcache.php.

Referenced by purgeItems().

if ($options['iteration-sleep']) $purgeMax = false

Definition at line 63 of file bin/php/ezcache.php.

Referenced by purgeItems().

$purgeSleep = false

Definition at line 58 of file bin/php/ezcache.php.

Referenced by purgeItems().

$script

Initial value:

 eZScript::instance( array( 'description' => ( "eZ Publish Cache Handler\n" .
                                                        "Allows for easy clearing of Cache files\n" .
                                                        "\n" .
                                                        "./bin/php/ezcache.php --clear-tag=content" ),
                                     'use-session' => false,
                                     'use-modules' => false,
                                     'use-extensions' => true ) )

Definition at line 33 of file bin/php/ezcache.php.

$sys = eZSys::instance()

Definition at line 54 of file bin/php/ezcache.php.