ornicar / apcbundle

UNMAINTAINED - Use https://github.com/Smart-Core/AcceleratorCacheBundle instead

NOT MAINTAINED

Use https://github.com/Smart-Core/AcceleratorCacheBundle instead

Provide a command line to clear APC cache from the console.

The problem with APC is that it's impossible to clear it from command line. Because even if you enable APC for PHP CLI, it's a different instance than, say, your Apache PHP or PHP-CGI APC instance.

The trick here is to create a file in the web dir, execute it through HTTP, then remove it.

Prerequisite

If you want to clear Apache part of APC, you will need to enable allow_url_fopen in php.ini to allow opening of URL object-like files, or set the curl option.

Installation

1. Add it to your composer.json:

   {
       "require": {
           "ornicar/apc-bundle": "1.0.*"
       }
   }

   or:

       composer require ornicar/apc-bundle
       composer update ornicar/apc-bundle

2. Add this bundle to your application kernel:

    // app/AppKernel.php
    public function registerBundles()
    {
        return array(
            // ...
            new Ornicar\ApcBundle\OrnicarApcBundle(),
            // ...
        );
    }
   

3. Configure ornicar_apc service:

    # app/config/config.yml
    ornicar_apc:
        host: http://example.com
        web_dir: %kernel.root_dir%/../web
   

4. If you want to use curl rather than fopen set the following option:

    # app/config/config.yml
    ornicar_apc:
        ...
        mode: curl
   

Usage

Clear all APC cache (opcode+user):

      $ php app/console apc:clear

Clear only opcode cache:

      $ php app/console apc:clear --opcode

Clear only user cache:

      $ php app/console apc:clear --user

Clear the CLI cache (opcode+user):

      $ php app/console apc:clear --cli

Capifony usage

To automatically clear apc cache after each capifony deploy you can define a custom task

namespace :symfony do
  desc "Clear apc cache"
  task :clear_apc do
    capifony_pretty_print "--> Clear apc cache"
    run "#{try_sudo} sh -c 'cd #{latest_release} && #{php_bin} #{symfony_console} apc:clear #{console_options}'"
    capifony_puts_ok
  end
end

and add these hooks

# apc
after "deploy", "symfony:clear_apc"
after "deploy:rollback:cleanup", "symfony:clear_apc"

Nginx configuration

If you are using nginx and limiting PHP scripts that you are passing to fpm you need to allow 'apc' prefixed php files. Otherwise your web server will return the requested PHP file as text and the system won't be able to clear the apc cache.

Example configuration:

# Your virtual host
server {
  ...
  location ~ ^/(app|app_dev|apc-.*)\.php(/|$) { { # This will allow apc (apc-{MD5HASH}.php) files to be processed by fpm
    fastcgi_pass                127.0.0.1:9000;
    ...

apcbundle's Issues

prerequisite to clear apache APC

To clear apache part of apc, you need to allow_url_fopen=1 (or On) in php.ini. This should be mentioned as prerequisite in README.md.

Make it to work with latest stable version of Symfony2

Direct clear cache via PHP-FPM

Please take a look at the following alternative instruction:
http://www.alexfu.it/2013/10/08/clearing-apc-php-fpm-command-line.html

I guess it's likely more reliable and doesn't require additional configuration.
It's maybe worth merging it into your bundle as an option.

Add support of load balancing (multiple backends)

Clearing cache for only one project

Hi. I have many projects (symsony2 apps) and I'd like to clear cache for one only. Is it possible?

Generated PHP file has to check if APC module has been loaded

Generated PHP file has to check if APC module has been loaded. Otherwise we just get a server error if the APC module is not loaded in the web server.
Sorry I cannot add another pull request, but you can look at my last commit of my fork:

https://github.com/naitsirch/ornicar-apc-bundle/commit/954fa7d793ecaad594ba96125570160680441fdf

Would be nice if this will be included ;-)
Thanks

RuntimeException when "host" is a redirection

There should be more information than an empty RuntimeException when the provided "host" is doing a redirection, or maybe the redirection should be followed.