MemcachedCache::status() - Code Metrics - Inspection of "update travis conf (3)" - comodojo/cache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 26da3a...b9da65 )

by Marco

created 2017-01-29 10:18 UTC

MemcachedCache::status() B

↳ Parent: MemcachedCache

Complexity

Conditions	3
Paths	3

Size

Total Lines	27
Code Lines	15

Duplication

Lines	6
Ratio	22.22 %

Code Coverage

Tests	11
CRAP Score	3.2746

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	6
loc	27
ccs	11
cts	16
cp	0.6875
rs	8.8571
cc	3
eloc	15
nc	3
nop	0
crap	3.2746

<?php namespace Comodojo\Cache;

use \Comodojo\Cache\CacheObject\CacheObject;
use \Memcached;
use \Comodojo\Exception\CacheException;
use \Exception;

/**
 * Memcached cache class
 * 
 * @package     Comodojo Spare Parts
 * @author      Marco Giovinazzi <[email protected]>
 * @license     MIT
 *
 * LICENSE:
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

class MemcachedCache extends CacheObject {

    /**
     * Internal memcached handler
     *
     * @var \Memcached
     */
    private $instance = null;

    /**
     * Class constructor
     *
     * @param   string          $server         Server address (or IP)
     * @param   string          $port           (optional) Server port
     * @param   string          $weight         (optional) Server weight
     * @param   string          $persistent_id  (optional) Persistent id
     * @param   \Monolog\Logger $logger         Logger instance
     * 
     * @throws \Comodojo\Exception\CacheException
     */
    public function __construct( $server, $port=11211, $weight=0, $persistent_id=null, \Monolog\Logger $logger=null ) {

        if ( empty($server) ) throw new CacheException("Invalid or unspecified memcached server");

        if ( !is_null($persistent_id) && !is_string($persistent_id) ) throw new CacheException("Invalid persistent id");

        if ( self::getMemcachedStatus() === false ) {

            $this->raiseError("Memcached extension not available, disabling cache administratively");

            $this->disable();
            
            return;

        }
        
        $this->instance = new Memcached($persistent_id);

        $port = filter_var($port, FILTER_VALIDATE_INT, array(
            "options" => array(
                "min_range" => 1,
                "max_range" => 65535,
                "default" => 11211 )
            )
        );

        $weight = filter_var($weight, FILTER_VALIDATE_INT, array(
            "options" => array(
                "min_range" => 0,
                "default" => 0 )
            )
        );

        $this->addServer($server, $port, $weight);

        if ( $this->isEnabled() ) {

            try {
            
                parent::__construct( $logger );
                
            }
            
            catch ( CacheException $ce ) {
                
                throw $ce;
                
            }

        }

    }

    /**
     * Set cache element
     *
     * This method will throw only logical exceptions.
     * In case of failures, it will return a boolean false.
     *
     * @param   string  $name    Name for cache element
     * @param   mixed   $data    Data to cache
     * @param   int     $ttl     Time to live
     *
     * @return  bool
     * @throws \Comodojo\Exception\CacheException
     */
    public function set($name, $data, $ttl=null) {

        if ( empty($name) ) throw new CacheException("Name of object cannot be empty");
        
        if ( is_null($data) ) throw new CacheException("Object content cannot be null");
        
        if ( !$this->isEnabled() ) return false;

        $this->resetErrorState();

        try {
            
            $this->setTtl($ttl);

            $namespace = $this->getNamespaceKey();

            if ( $namespace === false ) $namespace = $this->setNamespaceKey();

            if ( $namespace === false ) {

                $this->raiseError("Error writing cache (Memcached), exiting gracefully", array(
                    "RESULTCODE" => $this->instance->getResultCode(),
                    "RESULTMESSAGE" => $this->instance->getResultMessage()
                ));

                $this->setErrorState();

                $return = false;

            } else {

                $shadowName = $namespace."-".md5($name);
            
                $shadowTtl = $this->getTime() + $this->ttl;

                $shadowData = serialize($data);
                
                $return = $this->instance->set($shadowName, $shadowData, $shadowTtl);

                if ( $return === false ) {


                    $this->raiseError("Error writing cache (Memcached), exiting gracefully", array(
                        "RESULTCODE" => $this->instance->getResultCode(),
                        "RESULTMESSAGE" => $this->instance->getResultMessage()
                    ));

                    $this->setErrorState();

                }

            }

        } catch (CacheException $ce) {
            
            throw $ce;

        }

        return $return;

    }

    /**
     * Get cache element
     *
     * This method will throw only logical exceptions.
     * In case of failures, it will return a null value.
     * In case of cache not found, it will return a null value.
     *
     * @param   string  $name    Name for cache element
     *
     * @return  mixed
     * @throws \Comodojo\Exception\CacheException
     */
    public function get($name) {

        if ( empty($name) ) throw new CacheException("Name of object cannot be empty");

        if ( !$this->isEnabled() ) return null;

        $this->resetErrorState();

        $namespace = $this->getNamespaceKey();

        if ( $namespace === false ) {

            $return = false;

        } else {

            $shadowName = $namespace."-".md5($name);

            $return = $this->instance->get($shadowName);

            if ( $return === false && $this->instance->getResultCode() != Memcached::RES_NOTFOUND ) {


                $this->raiseError("Error reading cache (Memcached), exiting gracefully", array(
                    "RESULTCODE" => $this->instance->getResultCode(),
                    "RESULTMESSAGE" => $this->instance->getResultMessage()
                ));

                $this->setErrorState();

            }

        }

        return $return === false ? null : unserialize($return);

    }

    /**
     * Delete cache object (or entire namespace if $name is null)
     *
     * This method will throw only logical exceptions.
     * In case of failures, it will return a boolean false.
     *
     * @param   string  $name    Name for cache element
     *
     * @return  bool
     * @throws \Comodojo\Exception\CacheException
     */
    public function delete($name=null) {

        if ( !$this->isEnabled() ) return false;

        $this->resetErrorState();

        $namespace = $this->getNamespaceKey();

        if ( $namespace === false ) return true;

        if ( empty($name) ) {


            $delete = $this->instance->delete($this->getNamespace());

        } else {

            $delete = $this->instance->delete($namespace."-".md5($name));

        }

        if ( $delete === false ) {


            $this->raiseError("Error writing cache (Memcached), exiting gracefully", array(
                "RESULTCODE" => $this->instance->getResultCode(),
                "RESULTMESSAGE" => $this->instance->getResultMessage()
            ));

            $this->setErrorState();

        }


        return $delete;

    }

    /**
     * Clean cache objects in all namespaces
     *
     * This method will throw only logical exceptions.
     *
     * @return  bool
     * @throws \Comodojo\Exception\CacheException
     */
    public function flush() {

        if ( !$this->isEnabled() ) return false;

        $this->resetErrorState();

        $result = $this->instance->flush();

        if ( $result === false ) {


            $this->raiseError("Error flushing cache (Memcached), exiting gracefully", array(
                "RESULTCODE" => $this->instance->getResultCode(),
                "RESULTMESSAGE" => $this->instance->getResultMessage()
            ));

            $this->setErrorState();

            return false;

        }

        return true;

    }

    /**
     * Get cache status
     *
     * @return  array
     */
    public function status() {

        if ( !$this->isEnabled() ) return array(

            "provider"  => "memcached",
            "enabled"   => false,
            "objects"   => null,
            "options"   => array()
        );

        $stats = $this->instance->getStats();

        $objects = 0;

        foreach ($stats as $key => $value) {
            
            $objects = max($objects, $value['curr_items']);

        }

        return array(
            "provider"  => "memcached",
            "enabled"   => $this->isEnabled(),
            "objects"   => intval($objects),
            "options"   => $stats
        );

    }

    /**
     * Get the current memcached instance
     *
     * @return  \Memcached
     */
    final public function getInstance() {

        return $this->instance;

    }

    /**
     * Set key for namespace
     *
     * @return  mixed
     */
    private function setNamespaceKey() {


        $uId = self::getUniqueId();

        $return = $this->instance->set($this->getNamespace(), $uId, 0);

        return $return === false ? false : $uId;

    }

    /**
     * Get key for namespace
     *
     * @return  string
     */
    private function getNamespaceKey() {

        return $this->instance->get($this->getNamespace());

    }

    /**
     * Add a Memcached server to stack
     *
     * @param   string          $server         Server address (or IP)
     * @param   string          $port           Server port
     * @param   string          $weight         Server weight
     */
    private function addServer($server, $port, $weight) {

        $status = $this->instance->addServer($server, $port, $weight);

        if ( $status === false ) {

            $this->raiseError("Error communicating with server", array(
                "RESULTCODE" => $this->instance->getResultCode(),
                "RESULTMESSAGE" => $this->instance->getResultMessage()
            ));

        }

        if ( sizeof($this->instance->getServerList()) == 0 ) {

            $this->raiseError("No available server, disabling cache administratively");

            $this->disable();

        } else {

            $this->enable();

        }

    }
    
    /**
     * Check Memcached availability
     *
     * @return  bool
     */
    private static function getMemcachedStatus() {
        
        return class_exists('Memcached');
        
    }

}


1			<?php namespace Comodojo\Cache;
2
3			use \Comodojo\Cache\CacheObject\CacheObject;
4			use \Memcached;
5			use \Comodojo\Exception\CacheException;
6			use \Exception;
7
8			/**
9			* Memcached cache class
10			*
11			* @package Comodojo Spare Parts
12			* @author Marco Giovinazzi <[email protected]>
13			* @license MIT
14			*
15			* LICENSE:
16			*
17			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23			* THE SOFTWARE.
24			*/
25
26			class MemcachedCache extends CacheObject {
27
28			/**
29			* Internal memcached handler
30			*
31			* @var \Memcached
32			*/
33			private $instance = null;
34
35			/**
36			* Class constructor
37			*
38			* @param string $server Server address (or IP)
39			* @param string $port (optional) Server port
40			* @param string $weight (optional) Server weight
41			* @param string $persistent_id (optional) Persistent id
42			* @param \Monolog\Logger $logger Logger instance
43			*
44			* @throws \Comodojo\Exception\CacheException
45			*/
46	186		public function __construct( $server, $port=11211, $weight=0, $persistent_id=null, \Monolog\Logger $logger=null ) {
47
48	186		if ( empty($server) ) throw new CacheException("Invalid or unspecified memcached server");
49
50	186		if ( !is_null($persistent_id) && !is_string($persistent_id) ) throw new CacheException("Invalid persistent id");
51
52	186		if ( self::getMemcachedStatus() === false ) {
53
54			$this->raiseError("Memcached extension not available, disabling cache administratively");
55
56			$this->disable();
57
58			return;
59
60			}
61
62	186		$this->instance = new Memcached($persistent_id);
63
64	186		$port = filter_var($port, FILTER_VALIDATE_INT, array(
65			"options" => array(
66	186		"min_range" => 1,
67	186		"max_range" => 65535,
68	186		"default" => 11211 )
69	186		)
70	186		);
71
72	186		$weight = filter_var($weight, FILTER_VALIDATE_INT, array(
73			"options" => array(
74	186		"min_range" => 0,
75	186		"default" => 0 )
76	186		)
77	186		);
78
79	186		$this->addServer($server, $port, $weight);
80
81	186		if ( $this->isEnabled() ) {
82
83			try {
84
85	186		parent::__construct( $logger );
86
87			}
88
89	186		catch ( CacheException $ce ) {
90
91			throw $ce;
92
93			}
94
95	186		}
96
97	186		}
98
99			/**
100			* Set cache element
101			*
102			* This method will throw only logical exceptions.
103			* In case of failures, it will return a boolean false.
104			*
105			* @param string $name Name for cache element
106			* @param mixed $data Data to cache
107			* @param int $ttl Time to live
108			*
109			* @return bool
110			* @throws \Comodojo\Exception\CacheException
111			*/
112	72		public function set($name, $data, $ttl=null) {
113
114	72		if ( empty($name) ) throw new CacheException("Name of object cannot be empty");
115
116	72		if ( is_null($data) ) throw new CacheException("Object content cannot be null");
117
118	72		if ( !$this->isEnabled() ) return false;
119
120	72		$this->resetErrorState();
121
122			try {
123
124	72		$this->setTtl($ttl);
125
126	72		$namespace = $this->getNamespaceKey();
127
128	72		if ( $namespace === false ) $namespace = $this->setNamespaceKey();
129
130	72		if ( $namespace === false ) {
131
132			$this->raiseError("Error writing cache (Memcached), exiting gracefully", array(
133			"RESULTCODE" => $this->instance->getResultCode(),
134			"RESULTMESSAGE" => $this->instance->getResultMessage()
135			));
136
137			$this->setErrorState();
138
139			$return = false;
140
141			} else {
142
143	72		$shadowName = $namespace."-".md5($name);
144
145	72		$shadowTtl = $this->getTime() + $this->ttl;
146
147	72		$shadowData = serialize($data);
148
149	72		$return = $this->instance->set($shadowName, $shadowData, $shadowTtl);
150
151	72	View Code Duplication	if ( $return === false ) {
			0 ignored issues – show Duplication introduced 2017-01-29 09:23 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
152
153			$this->raiseError("Error writing cache (Memcached), exiting gracefully", array(
154			"RESULTCODE" => $this->instance->getResultCode(),
155			"RESULTMESSAGE" => $this->instance->getResultMessage()
156			));
157
158			$this->setErrorState();
159
160			}
161
162			}
163
164	72		} catch (CacheException $ce) {
165
166			throw $ce;
167
168			}
169
170	72		return $return;
171
172			}
173
174			/**
175			* Get cache element
176			*
177			* This method will throw only logical exceptions.
178			* In case of failures, it will return a null value.
179			* In case of cache not found, it will return a null value.
180			*
181			* @param string $name Name for cache element
182			*
183			* @return mixed
184			* @throws \Comodojo\Exception\CacheException
185			*/
186	46		public function get($name) {
187
188	46		if ( empty($name) ) throw new CacheException("Name of object cannot be empty");
189
190	46		if ( !$this->isEnabled() ) return null;
191
192	46		$this->resetErrorState();
193
194	46		$namespace = $this->getNamespaceKey();
195
196	46		if ( $namespace === false ) {
197
198	17		$return = false;
199
200	17		} else {
201
202	35		$shadowName = $namespace."-".md5($name);
203
204	35		$return = $this->instance->get($shadowName);
205
206	35	View Code Duplication	if ( $return === false && $this->instance->getResultCode() != Memcached::RES_NOTFOUND ) {
			0 ignored issues – show Duplication introduced 2017-01-29 09:23 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
207
208			$this->raiseError("Error reading cache (Memcached), exiting gracefully", array(
209			"RESULTCODE" => $this->instance->getResultCode(),
210			"RESULTMESSAGE" => $this->instance->getResultMessage()
211			));
212
213			$this->setErrorState();
214
215			}
216
217			}
218
219	46		return $return === false ? null : unserialize($return);
220
221			}
222
223			/**
224			* Delete cache object (or entire namespace if $name is null)
225			*
226			* This method will throw only logical exceptions.
227			* In case of failures, it will return a boolean false.
228			*
229			* @param string $name Name for cache element
230			*
231			* @return bool
232			* @throws \Comodojo\Exception\CacheException
233			*/
234	18		public function delete($name=null) {
235
236	18		if ( !$this->isEnabled() ) return false;
237
238	18		$this->resetErrorState();
239
240	18		$namespace = $this->getNamespaceKey();
241
242	18		if ( $namespace === false ) return true;
243
244	18	View Code Duplication	if ( empty($name) ) {
			0 ignored issues – show Duplication introduced 2017-01-29 09:23 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
245
246			$delete = $this->instance->delete($this->getNamespace());
247
248			} else {
249
250	18		$delete = $this->instance->delete($namespace."-".md5($name));
251
252			}
253
254	18	View Code Duplication	if ( $delete === false ) {
			0 ignored issues – show Duplication introduced 2017-01-29 09:23 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
255
256			$this->raiseError("Error writing cache (Memcached), exiting gracefully", array(
257			"RESULTCODE" => $this->instance->getResultCode(),
258			"RESULTMESSAGE" => $this->instance->getResultMessage()
259			));
260
261			$this->setErrorState();
262
263			}
264
265
266	18		return $delete;
267
268			}
269
270			/**
271			* Clean cache objects in all namespaces
272			*
273			* This method will throw only logical exceptions.
274			*
275			* @return bool
276			* @throws \Comodojo\Exception\CacheException
277			*/
278	18		public function flush() {
279
280	18		if ( !$this->isEnabled() ) return false;
281
282	18		$this->resetErrorState();
283
284	18		$result = $this->instance->flush();
285
286	18	View Code Duplication	if ( $result === false ) {
			0 ignored issues – show Duplication introduced 2017-01-29 09:23 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
287
288			$this->raiseError("Error flushing cache (Memcached), exiting gracefully", array(
289			"RESULTCODE" => $this->instance->getResultCode(),
290			"RESULTMESSAGE" => $this->instance->getResultMessage()
291			));
292
293			$this->setErrorState();
294
295			return false;
296
297			}
298
299	18		return true;
300
301			}
302
303			/**
304			* Get cache status
305			*
306			* @return array
307			*/
308	18		public function status() {
309
310	18	View Code Duplication	if ( !$this->isEnabled() ) return array(
			0 ignored issues – show Duplication introduced 2017-01-29 09:23 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
311			"provider" => "memcached",
312			"enabled" => false,
313			"objects" => null,
314			"options" => array()
315			);
316
317	18		$stats = $this->instance->getStats();
318
319	18		$objects = 0;
320
321	18		foreach ($stats as $key => $value) {
322
323	18		$objects = max($objects, $value['curr_items']);
324
325	18		}
326
327			return array(
328	18		"provider" => "memcached",
329	18		"enabled" => $this->isEnabled(),
330	18		"objects" => intval($objects),
331			"options" => $stats
332	18		);
333
334			}
335
336			/**
337			* Get the current memcached instance
338			*
339			* @return \Memcached
340			*/
341			final public function getInstance() {
342
343			return $this->instance;
344
345			}
346
347			/**
348			* Set key for namespace
349			*
350			* @return mixed
351			*/
352	36	View Code Duplication	private function setNamespaceKey() {
			0 ignored issues – show Duplication introduced 2017-01-29 09:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
353
354	36		$uId = self::getUniqueId();
355
356	36		$return = $this->instance->set($this->getNamespace(), $uId, 0);
357
358	36		return $return === false ? false : $uId;
359
360			}
361
362			/**
363			* Get key for namespace
364			*
365			* @return string
366			*/
367	119		private function getNamespaceKey() {
368
369	119		return $this->instance->get($this->getNamespace());
370
371			}
372
373			/**
374			* Add a Memcached server to stack
375			*
376			* @param string $server Server address (or IP)
377			* @param string $port Server port
378			* @param string $weight Server weight
379			*/
380	186		private function addServer($server, $port, $weight) {
381
382	186		$status = $this->instance->addServer($server, $port, $weight);
383
384	186		if ( $status === false ) {
385
386			$this->raiseError("Error communicating with server", array(
387			"RESULTCODE" => $this->instance->getResultCode(),
388			"RESULTMESSAGE" => $this->instance->getResultMessage()
389			));
390
391			}
392
393	186		if ( sizeof($this->instance->getServerList()) == 0 ) {
394
395			$this->raiseError("No available server, disabling cache administratively");
396
397			$this->disable();
398
399			} else {
400
401	186		$this->enable();
402
403			}
404
405	186		}
406
407			/**
408			* Check Memcached availability
409			*
410			* @return bool
411			*/
412	186		private static function getMemcachedStatus() {
413
414	186		return class_exists('Memcached');
415
416			}
417
418			}
419

comodojo / cache

Push — master ( 26da3a...b9da65 )

MemcachedCache::status() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like