soflomo / cache
Command line utility for cache management in Zend Framework 2
Installs: 10 733
Dependents: 0
Suggesters: 0
Security: 0
Stars: 14
Watchers: 4
Forks: 5
Open Issues: 3
Requires
- php: >=5.3.3
- zendframework/zend-cache: ~2.0
- zendframework/zend-mvc: ~2.0
This package is not auto-updated.
Last update: 2024-10-26 16:49:03 UTC
README
Soflomo\Cache is a command line utility for cache management in Zend Framework 2. It enables you to manage your Zend\Cache instances from the commandline, including:
- Printing a list of all available cache services
- Get the status (total space, available space) of all services
- Flush the complete cache instance
- Clear the cache by expired items
- Clear the cache by namespace
- Clear the cache by prefix
- Removing ZF2 application caches: the merged config and module map files
Installation
Soflomo\Cache works with Composer. Make sure you have
the composer.phar downloaded and you have a composer.json
file at the root of
your project. To install it, add the following line into your composer.json
file:
"require": {
"soflomo/cache": "~0.2"
}
After installation of the package, you need to enable the module by adding
Soflomo\Cache
to your application.config.php
file.
Requirements
- Zend Framework 2: the
Zend\Cache
component - Zend Framework 2: the
Zend\Mvc
component
Configuration
Soflomo\Cache scans automatically the list of available caches from the caches
key in the configuration. This key serves to define your caches as service.
If you want to use this key, you must register the cache as abstract factory:
'service_manager' => array( 'abstract_factories' => array( 'Zend\Cache\Service\StorageCacheAbstractServiceFactory', ), ),
With Soflomo\Cache you are not forced to use the cache abstract factory. The only
prerequisite is the cache must be available as a service. You can register your
own cache service using e.g. the service manager. For these self-defined caches
you cannot use the --list
and --status --all
commands and you are required
to supply the service name of the cache.
Usage
Typing php public/index.php
will show you a list of all available commands in
your application, including all Soflomo\Cache commands.
List all available caches
php public/index.php cache --list
NB. You have to define your caches using the abstract factory.
Get the cache status
php public/index.php cache --status
If you have only one cache defined, this cache is picked. For more than one cache, you will get to choose which cache's status must be printed.
When your cache is defined without using the abstract factory, you must supply the cache name:
php public/index.php cache --status MyCacheServiceName
All cache statuses are listed with --all
:
php public/index.php cache --status --all
Note with the --all
only caches from the abstract factory are listed.
Flush the cache
php public/index.php cache --flush
If you have only one cache defined, this cache is picked. For more than one cache, you will get to choose which cache's status must be printed.
When your cache is defined without using the abstract factory, you must supply the cache name:
php public/index.php cache --flush MyCacheServiceName
All clearing operations, including --flush
will require confirmation via the
prompt. Using the command non-interactively, you can use the --force
or -f
flag:
php public/index.php cache --flush --force
Clear all expired items
php public/index.php cache --clear --expired
If you have only one cache defined, this cache is picked. For more than one cache, you will get to choose which cache's status must be printed.
When your cache is defined without using the abstract factory, you must supply the cache name:
php public/index.php cache --clear MyCacheServiceName --expired
All clearing operations, including --clear --expired
will require confirmation
via the prompt. Using the command non-interactively, you can use the --force
or -f
flag:
php public/index.php cache --clear --expired --force
Clear items by namespace
php public/index.php cache --clear --by-namespace=MyNamespace
If you have only one cache defined, this cache is picked. For more than one cache, you will get to choose which cache's status must be printed.
When your cache is defined without using the abstract factory, you must supply the cache name:
php public/index.php cache --clear MyCacheServiceName --by-namespace=MyNamespace
All clearing operations, including --clear --by-namespace=MyNamespace
will
require confirmation via the prompt. Using the command non-interactively, you
can use the --force
or -f
flag:
php public/index.php cache --clear --force --by-namespace=MyNamespace
Clear items by prefix
php public/index.php cache --clear --by-prefix=MyPrefix
If you have only one cache defined, this cache is picked. For more than one cache, you will get to choose which cache's status must be printed.
When your cache is defined without using the abstract factory, you must supply the cache name:
php public/index.php cache --clear MyCacheServiceName --by-prefix=MyPrefix
All clearing operations, including --clear --by-prefix=MyPrefix
will
require confirmation via the prompt. Using the command non-interactively, you
can use the --force
or -f
flag:
php public/index.php cache --clear --force --by-prefix=MyPrefix
Clear the ZF2 application's config cache
php public/index.php cache --clear-config
Clear the ZF2 application's module map
php public/index.php cache --module-map
Clearing opcode cache
At this moment, it is not possible to clear the opcode cache. The opcode caches of CLI and PHP-FPM are not shared and as such, you cannot control the cache from PHP-FPM with the CLI.
Like the Symfony ApcBundle it is required to create a file in the web directory and call that file via HTTP. Then the file itself can clear the PHP-FPM opcode cache. You can track the progress of this feature in the issue #2.