Your IP : 216.73.216.43
<?php
/**
* This file is part of PDepend.
*
* PHP Version 5
*
* Copyright (c) 2008-2017 Manuel Pichler <mapi@pdepend.org>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Manuel Pichler nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @copyright 2008-2017 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
*
* @since 0.10.0
*/
namespace PDepend\Util\Cache;
use InvalidArgumentException;
use PDepend\Util\Cache\Driver\FileCacheDriver;
use PDepend\Util\Cache\Driver\MemoryCacheDriver;
use PDepend\Util\Configuration;
/**
* Factory that encapsulates the creation of a concrete cache instance.
*
* @copyright 2008-2017 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
*
* @since 0.10.0
*/
class CacheFactory
{
const DEFAULT_TTL = 2592000; //30 days
/**
* The system configuration.
*
* @var Configuration
*/
protected $configuration = null;
/**
* Singleton property that holds existing cache instances.
*
* @var CacheDriver[]
*/
protected $caches = array();
/**
* Constructs a new cache factory instance for the given configuration.
*
* @param Configuration $configuration The system configuration.
*/
public function __construct(Configuration $configuration)
{
$this->configuration = $configuration;
}
/**
* Creates a new instance or returns an existing cache for the given cache
* identifier.
*
* @param string $cacheKey The name/identifier for the cache instance.
*
* @return CacheDriver
*/
public function create($cacheKey = null)
{
if (false === isset($this->caches[$cacheKey])) {
$this->caches[$cacheKey] = $this->createCache($cacheKey);
}
return $this->caches[$cacheKey];
}
/**
* Creates a cache instance based on the supplied configuration.
*
* @param string|null $cacheKey The name/identifier for the cache instance.
*
* @throws InvalidArgumentException If the configured cache driver is unknown.
*
* @return CacheDriver
*/
protected function createCache($cacheKey = null)
{
switch ($this->configuration->cache->driver) {
case 'file':
return $this->createFileCache(
$this->configuration->cache->location,
$this->configuration->cache->ttl,
$cacheKey
);
case 'memory':
return $this->createMemoryCache();
}
throw new InvalidArgumentException(
"Unknown cache driver '{$this->configuration->cache->driver}' given."
);
}
/**
* Creates a new file system based cache instance.
*
* @param string $location Cache root directory.
* @param int $ttl Cache ttl
* @param string|null $cacheKey The name/identifier for the cache instance.
*
* @return FileCacheDriver
*/
protected function createFileCache($location, $ttl = self::DEFAULT_TTL, $cacheKey = null)
{
return new FileCacheDriver($location, $ttl, $cacheKey);
}
/**
* Creates an in memory cache instance.
*
* @return MemoryCacheDriver
*/
protected function createMemoryCache()
{
return new MemoryCacheDriver();
}
}