Base::clear() - Code Metrics - csphere-cms/cSphere - Measure and Improve Code Quality continuously with Scrutinizer

Base::clear()
last analyzed 2017-04-21 16:53 UTC

↳ Parent: Base

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
nc	1
dl	0
loc	1
c	0
b	0
f	0

<?php

/**
 * Provides caching functionality
 *
 * PHP Version 5
 *
 * @category  Core
 * @package   Cache
 * @author    Hans-Joachim Piepereit <[email protected]>
 * @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 <[email protected]>
 * @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
     **/


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


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

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


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


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


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

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


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


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


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


1			<?php
2
3			/**
4			* Provides caching functionality
5			*
6			* PHP Version 5
7			*
8			* @category Core
9			* @package Cache
10			* @author Hans-Joachim Piepereit <[email protected]>
11			* @copyright 2013 cSphere Team
12			* @license http://opensource.org/licenses/bsd-license Simplified BSD License
13			* @link http://www.csphere.eu
14			**/
15
16			namespace csphere\core\cache;
17
18			/**
19			* Provides caching functionality
20			*
21			* @category Core
22			* @package Cache
23			* @author Hans-Joachim Piepereit <[email protected]>
24			* @copyright 2013 cSphere Team
25			* @license http://opensource.org/licenses/bsd-license Simplified BSD License
26			* @link http://www.csphere.eu
27			**/
28
29			abstract class Base extends \csphere\core\service\Drivers
30			{
31			/**
32			* Stores the logger object
33			**/
34			protected $logger = null;
35
36			/**
37			* Clears the cache content
38			*
39			* @return boolean
40			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
41
42			abstract public function clear();
43
44			/**
45			* Removes a cached key
46			*
47			* @param string $key Name of the key
48			* @param int $ttl Time to life used for the key
49			*
50			* @return boolean
51			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
52
53			abstract public function delete($key, $ttl = 0);
54
55			/**
56			* Returns a formatted array with statistics
57			*
58			* @return array
59			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
60
61			public function info()
62			{
63			$info = $this->config;
64
65			unset($info['password'], $info['timeout']);
66
67			return $info;
68			}
69
70			/**
71			* Returns a formatted array with all keys and additional information
72			*
73			* @return array
74			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
75
76			abstract public function keys();
77
78			/**
79			* Fetches the desired key
80			*
81			* @param string $key Name of the key
82			* @param int $ttl Time to life used for the key
83			*
84			* @return array
85			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
86
87			abstract public function load($key, $ttl = 0);
88
89			/**
90			* Fetches the desired keys
91			*
92			* @param array $keys Name of the keys
93			*
94			* @return array
95			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
96
97			public function loadArray(array $keys)
98			{
99			$result = [];
100
101			// Run through all keys
102			foreach ($keys AS $key) {
103
104			$result[$key] = $this->load($key);
105			}
106
107			return $result;
108			}
109
110			/**
111			* Logs cache inserts
112			*
113			* @param string $key The cache key that is stored
114			*
115			* @return void
116			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
117
118			protected function log($key)
119			{
120			// Get logger if not done yet
121			if ($this->logger == null) {
122
123			$this->logger = $this->loader->load('logs');
124			}
125
126			$this->logger->log('cache', $key);
127			}
128
129			/**
130			* Stores the key with its value in the cache
131			*
132			* @param string $key Name of the key
133			* @param array $value Content to be stored
134			* @param int $ttl Time to life used for the key
135			*
136			* @return boolean
137			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
138
139			abstract public function save($key, $value, $ttl = 0);
140			}
141

csphere-cms / cSphere

Base::clear() last analyzed 2017-04-21 16:53 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Base::clear()
last analyzed 2017-04-21 16:53 UTC