Kemist\Cache\Storage\AbstractStorage

Complexity

Total Complexity

13

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	miss()	0	3	1
A	hit()	0	3	1
A	info()	0	17	3
A	getHits()	0	3	1
A	getMisses()	0	3	1
A	storeName()	0	5	2
A	delete()	0	7	2
A	get()	0	11	2

<?php

namespace Kemist\Cache\Storage;

/**
 * AbstractStorage class
 * 
 * @package Kemist\Cache
 * 
 * @version 1.0.6
 */
abstract class AbstractStorage {

  /**
   * Cached field names
   * 	 	
   * @var array
   */
  protected $fields = array();

  /**
   * Number of hits
   * @var int
   */
  protected $hits = 0;

  /**
   * Number of misses
   * @var int
   */
  protected $misses = 0;

  /**
   * Cache provider Object
   * @var object
   */
  protected $provider;

  /**
   * Info method
   * @var string 
   */
  protected $infoMethod = 'info';

  /**
   * Key prefix to avoid collisions
   * @var string 
   */
  protected $prefix = '';

  /**
   * Retrieves the content of $name cache
   * 	 
   * @SuppressWarnings(PHPMD.UnusedFormalParameter)
   * @param string $name cache name
   *
   * @return mixed
   */
  public function get($name, $compressed = false) {
    $value = $this->provider->get($this->prefix . $name);
    if ($value !== false) {
      $this->hit();
      $this->storeName($name);
    } else {
      $this->miss();
    }

    return $value;
  }

  /**
   * Cache miss occured
   */
  public function miss() {
    $this->misses++;
  }

  /**
   * Cache hit occured
   */
  public function hit() {
    $this->hits++;
  }

  /**
   * Deletes the specified cache or each one if '' given
   * 	 
   * @param string $name cache name
   *
   * @return bool
   */
  public function delete($name = '') {
    if ($name == '') {
      return $this->provider->flush();
    } else {
      return $this->provider->delete($this->prefix . $name);
    }
  }

  /**
   * Retrieves information of Cache state
   * 
   * @param bool $getFields
   *  
   * @return array
   */
  public function info($getFields = false) {
    $info = array();
    $className = explode('\\', get_class($this));
    $info['CACHE_TYPE'] = end($className);
    $info['CACHE_HITS'] = $this->hits;
    $info['CACHE_MISSES'] = $this->misses;

    $info = array_merge($info, call_user_func(array($this->provider, $this->infoMethod)));

    if ($getFields) {
      foreach ($this->fields as $field) {
        $info['field_content'][$field] = $this->get($field);
      }
    }

    return $info;
  }

  /**
   * Retrieves cache hits
   * 
   * @return int
   */
  public function getHits() {
    return $this->hits;
  }

  /**
   * Retrieves cache misses
   * 
   * @return int
   */
  public function getMisses() {
    return $this->misses;
  }

  /**
   * Stores cache name
   * 
   * @param string $name
   */
  protected function storeName($name) {
    if (!in_array($name, $this->fields)) {
      $this->fields[] = $name;
    }
  }

}