APCu cache support

Author: Rastusik

README.md

@@ -87,6 +87,19 @@ return [
 ];
 ```
 
+### Enable APCu
+
+```php
+return [
+    'phpdi-zf2' => [
+        'cache' => [
+            'adapter' => 'apcu',
+            'namespace' => 'your_di_cache_key',
+        ],
+    ]
+];
+```
+
 ### Enable file cache
 
 ```php
@@ -129,4 +142,4 @@ To clear the definition cache, run the following command from the project root:
 
 ```
 php public/index.php php-di-clear-cache
-```
+```

config/module.config.php

@@ -22,7 +22,7 @@
 
         'factories' => [
             'ControllerLoader' => __NAMESPACE__ . '\\Service\\ControllerLoaderFactory',
-            'DiCache' => __NAMESPACE__ . '\\Service\\CacheFactory',
+            'DiCache' => __NAMESPACE__ . '\\Service\\CacheFactory\CacheFactory',
         ],
     ],
 

src/DI/ZendFramework2/Service/CacheFactory.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * @author Martin Fris <[email protected]>
+ */
+
+namespace DI\ZendFramework2\Service\CacheFactory;
+
+use Doctrine\Common\Cache\ApcCache;
+
+/**
+ * Class RedisFactory
+ * @author mfris
+ * @package DI\ZendFramework\Service\CacheFactory
+ */
+final class ApcuFactory implements CacheFactoryInterface
+{
+
+    /**
+     * @param array $config
+     * @return ApcCache
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function newInstance(array $config)
+    {
+        return new ApcCache();
+    }
+}

src/DI/ZendFramework2/Service/CacheFactory/ApcuFactory.php

@@ -0,0 +1,91 @@
+<?php
+/**
+ * @author     mfris
+ */
+
+namespace DI\ZendFramework2\Service\CacheFactory;
+
+use DI\ZendFramework2\Service\ConfigTrait;
+use Doctrine\Common\Cache\Cache;
+use Doctrine\Common\Cache\CacheProvider;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+/**
+ * Factory for php di definitions cache
+ *
+ * @author  mfris
+ * @package \DI\ZendFramework\Service\Cache
+ */
+class CacheFactory implements FactoryInterface
+{
+    use ConfigTrait;
+
+    /**
+     * @var array
+     */
+    private $adapterClasses = [
+        'filesystem' => FileSystemFactory::class,
+        'redis' => RedisFactory::class,
+        'memcached' => MemcachedFactory::class,
+        'apcu' => ApcuFactory::class,
+    ];
+
+    /**
+     * @var CacheFactoryInterface[]
+     */
+    private $adapters = [];
+
+    /**
+     * Create service
+     *
+     * @param ServiceLocatorInterface $serviceLocator
+     * @return mixed
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        $config = $this->getConfig($serviceLocator);
+
+        if (!isset($config['cache'])) {
+            return null;
+        }
+
+        $config = $config['cache'];
+        /* @var $cache CacheProvider|Cache */
+        $cache = null;
+        $cacheFactory = $this->getCacheFactory($config);
+        $cache = $cacheFactory->newInstance($config);
+
+        if (isset($config['namespace'])) {
+            $cache->setNamespace(trim($config['namespace']));
+        }
+
+        return $cache;
+    }
+
+    /**
+     * @param array $config
+     * @return CacheFactoryInterface
+     * @throws ConfigException
+     * @SuppressWarnings(PHPMD.StaticAccess)
+     */
+    private function getCacheFactory(array $config)
+    {
+        if (!isset($config['adapter'])) {
+            throw ConfigException::newCacheAdapterMissingException();
+        }
+
+        $adapter = $config['adapter'];
+
+        if (!isset($this->adapterClasses[$adapter])) {
+            throw ConfigException::newUnsupportedCacheAdapterException($adapter);
+        }
+
+        if (!isset($this->adapters[$adapter])) {
+            $this->adapters[$adapter] = new $this->adapterClasses[$adapter]();
+        }
+
+        /* @var CacheFactoryInterface $cacheFactory */
+        return $this->adapters[$adapter];
+    }
+}

src/DI/ZendFramework2/Service/CacheFactory/CacheFactory.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * @author Martin Fris <[email protected]>
+ */
+
+namespace DI\ZendFramework2\Service\CacheFactory;
+
+use Doctrine\Common\Cache\Cache;
+
+/**
+ * Interface CacheFactoryInterface
+ * @package DI\ZendFramework\Service\CacheFactory
+ */
+interface CacheFactoryInterface
+{
+
+    /**
+     * @param array $config
+     * @return Cache
+     */
+    public function newInstance(array $config);
+}

src/DI/ZendFramework2/Service/CacheFactory/CacheFactoryInterface.php

@@ -2,15 +2,15 @@
 /**
  * @author  mfris
  */
-namespace DI\ZendFramework2\Service;
+namespace DI\ZendFramework2\Service\CacheFactory;
 
 use Exception;
 
 /**
  * Class ConfigException - custom exception for configuration problems
  *
  * @author mfris
- * @package DI\ZendFramework2\Service
+ * @package DI\ZendFramework\Service
  */
 class ConfigException extends Exception
 {

src/DI/ZendFramework2/Service/ConfigException.php renamed to src/DI/ZendFramework2/Service/CacheFactory/ConfigException.php

@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * @author Martin Fris <[email protected]>
+ */
+
+namespace DI\ZendFramework2\Service\CacheFactory;
+
+use Doctrine\Common\Cache\FilesystemCache;
+
+/**
+ * Class FileSystemFactory
+ * @author mfris
+ * @package DI\ZendFramework\Service\CacheFactory
+ */
+final class FileSystemFactory implements CacheFactoryInterface
+{
+
+    /**
+     * @param array $config
+     * @return FilesystemCache
+     * @throws \InvalidArgumentException
+     */
+    public function newInstance(array $config)
+    {
+        $directory = getcwd() . '/data/php-di/cache';
+
+        if (isset($config['directory'])) {
+            $directory = $config['directory'];
+        }
+
+        return new FilesystemCache($directory);
+    }
+}