csphere\core\cache\Driver_File

Complexity

Total Complexity

18

Size/Duplication

Total Lines	181
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
A	clear()	0	13	2
A	delete()	0	11	3
A	info()	0	15	1
A	keys()	0	19	2
B	load()	0	15	5
A	save()	0	23	3

<?php

/**
 * Provides caching functionality on the filesystem
 *
 * PHP Version 5
 *
 * @category  Core
 * @package   Cache
 * @author    Hans-Joachim Piepereit <contact@csphere.eu>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

namespace csphere\core\cache;

/**
 * Provides caching functionality on the filesystem
 *
 * @category  Core
 * @package   Cache
 * @author    Hans-Joachim Piepereit <contact@csphere.eu>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

class Driver_File extends Base
{
    /**
     * Stores the cache directory
     **/
    private $_dir = '';

    /**
     * Files to exclude for stats
     **/
    private $_exclude = ['info.txt'];

    /**
     * Creates the cache handler object
     *
     * @param array $config Configuration details as an array
     *
     * @throws \Exception
     *
     * @return \csphere\core\cache\Driver_File
     **/

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

There must be no blank lines after the function comment

    public function __construct(array $config)
    {
        parent::__construct($config);

        $this->_dir = \csphere\core\init\path() . 'csphere/storage/cache/';

        if (!is_writeable($this->_dir)) {

            throw new \Exception('Directory "' . $this->_dir . '" is not writeable');
        }
    }

    /**
     * Clears the cache content
     *
     * @return boolean
     **/
    public function clear()
    {
        $content = \csphere\core\files\File::search(
            $this->_dir, false, $this->_exclude
        );

        foreach ($content AS $file) {

            unlink($this->_dir . $file);
        }

        return true;
    }

    /**
     * Removes a cached key
     *
     * @param string $key Name of the key
     * @param int    $ttl Time to life used for the key
     *
     * @return boolean
     **/

There must be no blank lines after the function comment

    public function delete($key, $ttl = 0)
    {
        $token = empty($ttl) ? $key : 'ttl_' . $key;

        if (file_exists($this->_dir . $token . '.tmp')) {

            unlink($this->_dir . $token . '.tmp');
        }

        return true;
    }

    /**
     * Returns a formatted array with statistics
     *
     * @return array
     **/

There must be no blank lines after the function comment

    public function info()
    {
        $info = parent::info();

        $files = \csphere\core\files\File::search(
            $this->_dir, false, $this->_exclude
        );

        $info['version'] = '';
        $info['client']  = '';
        $info['server']  = '';
        $info['keys']    = count($files);

        return $info;
    }

    /**
     * Returns a formatted array with all keys and additional information
     *
     * @return array
     **/

There must be no blank lines after the function comment

    public function keys()
    {
        $info = \csphere\core\files\File::search(
            $this->_dir, false, $this->_exclude
        );

        $form = [];

        foreach ($info AS $filename) {

            $form[$filename] = ['name' => $filename,
                                'time' => filemtime($this->_dir . $filename),
                                'size' => filesize($this->_dir . $filename)];
        }

        $form = array_values($form);

        return $form;
    }

    /**
     * Fetches the desired key
     *
     * @param string $key Name of the key
     * @param int    $ttl Time to life used for the key
     *
     * @return array
     **/

There must be no blank lines after the function comment

    public function load($key, $ttl = 0)
    {
        $token = empty($ttl) ? $key : 'ttl_' . $key;

        if (file_exists($this->_dir . $token . '.tmp')
            && (empty($ttl)
            || filemtime($this->_dir . $token . '.tmp') >= (time() - $ttl))
        ) {
            $string = file_get_contents($this->_dir . $token . '.tmp');

            return unserialize($string);
        }

        return false;

The return type of return false; (false) is incompatible with the return type declared by the abstract method csphere\core\cache\Base::load of type array.

    }

    /**
     * Stores the key with its value in the cache
     *
     * @param string $key   Name of the key
     * @param array  $value Content to be stored
     * @param int    $ttl   Time to life used for the key
     *
     * @return boolean
     **/

There must be no blank lines after the function comment

    public function save($key, $value, $ttl = 0)
    {
        $token = empty($ttl) ? $key : 'ttl_' . $key;

        $store = serialize($value);

        $save_cache = fopen($this->_dir . $token . '.tmp', 'w');

        // Set stream encoding if possible to avoid converting issues
        if (function_exists('stream_encoding')) {

            stream_encoding($save_cache, 'UTF-8');
        }

        fwrite($save_cache, $store);
        fclose($save_cache);

        chmod($this->_dir . $token . '.tmp', 0755);

        $this->log($key);

        return true;
    }
}