csphere\core\cache\Base

Complexity

Total Complexity

5

Size/Duplication

Total Lines	112
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
	clear()	0	1	?
	delete()	0	1	?
A	info()	0	8	1
	keys()	0	1	?
	load()	0	1	?
A	loadArray()	0	12	2
A	log()	0	10	2
	save()	0	1	?

<?php

/**
 * Provides caching functionality
 *
 * 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
 *
 * @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
 **/

abstract class Base extends \csphere\core\service\Drivers
{
    /**
     * Stores the logger object
     **/
    protected $logger = null;

    /**
     * Clears the cache content
     *
     * @return boolean
     **/

There must be no blank lines after the function comment

    abstract public function clear();

    /**
     * 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

    abstract public function delete($key, $ttl = 0);

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

There must be no blank lines after the function comment

    public function info()
    {
        $info = $this->config;

        unset($info['password'], $info['timeout']);

        return $info;
    }

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

There must be no blank lines after the function comment

    abstract public function keys();

    /**
     * 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

    abstract public function load($key, $ttl = 0);

    /**
     * Fetches the desired keys
     *
     * @param array $keys Name of the keys
     *
     * @return array
     **/

There must be no blank lines after the function comment

    public function loadArray(array $keys)
    {
        $result = [];

        // Run through all keys
        foreach ($keys AS $key) {

            $result[$key] = $this->load($key);
        }

        return $result;
    }

    /**
     * Logs cache inserts
     *
     * @param string $key The cache key that is stored
     *
     * @return void
     **/

There must be no blank lines after the function comment

    protected function log($key)
    {
        // Get logger if not done yet
        if ($this->logger == null) {

            $this->logger = $this->loader->load('logs');
        }

        $this->logger->log('cache', $key);
    }

    /**
     * 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

    abstract public function save($key, $value, $ttl = 0);
}