johnstevin / cachetool

CLI App and library to manage apc & opcache.

CacheTool - Manage cache in the CLI

CacheTool allows you to work with apc, opcache, and the file status cache through the cli. It will connect to a fastcgi server (like php-fpm) and operate it's cache.

Why is this useful?

• Maybe you want to clear the bytecode cache without reloading php-fpm or using a web endpoint
• Maybe you want to have a cron which deals with cache invalidation
• Maybe you want to see some statistics right from the console
• And many more...

Note that, unlike APC and Opcache, the file status cache is per-process rather than stored in shared memory. This means that running stat:clear against PHP-FPM will only affect whichever FPM worker responds to the request, not the whole pool. Julien Pauli has written a post with more details on how the file status cache operates.

Installation

$ curl -sO http://gordalina.github.io/cachetool/downloads/cachetool.phar
$ chmod +x cachetool.phar

Usage (as an application)

You can connect to a automatically guessed fastcgi server (if /var/run/php5-fpm.sock is a file or 127.0.0.1:9000)

$ php cachetool.phar apc:cache:info --fcgi

You can connect to a fastcgi server through ip

$ php cachetool.phar apc:cache:info --fcgi=127.0.0.1:9000

Or by socket

$ php cachetool.phar opcache:status --fcgi=/var/run/php5-fpm.sock

Or to the cli

$ php cachetool.phar opcache:status --cli

You have some useful commands that you can you

apc
  apc:bin:dump             Get a binary dump of files and user variables
  apc:bin:load             Load a binary dump into the APC file and user variables
  apc:cache:clear          Clears APC cache (user, system or all)
  apc:cache:info           Shows APC user & system cache information
  apc:cache:info:file      Shows APC file cache information
  apc:key:delete           Deletes an APC key
  apc:key:exists           Checks if an APC key exists
  apc:key:fetch            Shows the content of an APC key
  apc:key:store            Store an APC key with given value
  apc:sma:info             Show APC shared memory allocation information
apcu
  apcu:cache:clear         Clears APCu cache
  apcu:cache:info          Shows APCu user & system cache information
  apcu:cache:info:keys     Shows APCu keys cache information
  apcu:key:delete          Deletes an APCu key
  apcu:key:exists          Checks if an APCu key exists
  apcu:key:fetch           Shows the content of an APCu key
  apcu:key:store           Store an APCu key with given value
  apcu:regexp:delete       Deletes all APCu key matching a regexp
  apcu:sma:info            Show APCu shared memory allocation information
opcache
  opcache:configuration    Get configuration information about the cache
  opcache:reset            Resets the contents of the opcode cache
  opcache:status           Show summary information about the opcode cache
  opcache:status:scripts   Show scripts in the opcode cache
stat
  stat:clear               Clears the file status cache, including the realpath cache
  stat:realpath_get        Show summary information of realpath cache entries
  stat:realpath_size       Display size of realpath cache

Configuration File

You can have a configuration file with the adapter configuration, allowing you to call CacheTool without --fcgi or --cli option.

The file must be named .cachetool.yml. CacheTool will look for this file on the current directory and in any parent directory until it finds one. If the paths above fail it will try to load /etc/cachetool.yml configuration file.

An example of what this file might look like is:

Will connect to fastcgi at 127.0.0.1:9000

adapter: fastcgi
fastcgi: 127.0.0.1:9000

Will connect to cli (disregarding fastcgi configuration)

adapter: cli
fastcgi: /var/run/php5-fpm.sock

CacheTool writes files to the system temporary directory (given by sys_get_temp_dir()) but if you want to change this, for example, if your fastcgi service is run with PrivateTemp you can set it on the config file:

adapter: fastcgi
fastcgi: /var/run/php5-fpm.sock
temp_dir: /dev/shm/cachetool

Usage (as a library)

Add it as a dependency

$ composer require gordalina/cachetool

If you want to use it in a Symfony 2.x project, require the 1.x version

$ composer require gordalina/cachetool:~1.0

Create instance

use CacheTool\Adapter\FastCGI;
use CacheTool\CacheTool;

$adapter = new FastCGI('127.0.0.1:9000', $tempDir = '/tmp');
$cache = CacheTool::factory($adapter);

You can use apc and opcache functions

$cache->apc_clear_cache('both');
$cache->opcache_reset();

Proxies

CacheTool depends on Proxies to provide functionality, by default when creating a CacheTool instance from the factory all proxies are enabled ApcProxy, OpcacheProxy and PhpProxy, you can customize it or extend to your will like the example below:

use CacheTool\Adapter\FastCGI;
use CacheTool\CacheTool;
use CacheTool\Proxy;

$adapter = new FastCGI('/var/run/php5-fpm.sock');
$cache = new CacheTool();
$cache->setAdapter($adapter);
$cache->addProxy(new Proxy\ApcProxy());
$cache->addProxy(new Proxy\PhpProxy());

Updating CacheTool

Running php cachetool.phar self-update will update a phar install with the latest version.

Requirements

PHP 5.3.3

Testing

After running composer install, run ./vendor/bin/phpunit

License

CacheTool is licensed under the MIT License - see the LICENSE for details