Kemist\Cache\Info

Complexity

Total Complexity

35

Size/Duplication

Total Lines	232
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	offsetExists()	0	3	1
A	offsetGet()	0	3	1
A	offsetSet()	0	3	1
A	offsetUnset()	0	3	1
A	getIterator()	0	3	1
A	touchItem()	0	8	3
B	getItem()	0	13	5
A	getItemOrDefault()	0	3	2
A	setItem()	0	3	1
A	increaseItem()	0	3	3
A	getData()	0	3	3
A	getKeys()	0	3	1
A	createData()	0	8	1
A	deleteData()	0	5	2
A	appendData()	0	3	1
A	setData()	0	3	1
A	getExpiry()	0	3	3
A	filterByTags()	0	9	3

<?php

namespace Kemist\Cache;

/**
 * Cache Info
 *
 * @version 1.0.4
 */
class Info implements \ArrayAccess, \IteratorAggregate {

  /**
   * Cache info data
   * @var array 
   */
  protected $data = array();

  /**
   * Constructor
   * 
   * @param array $data
   */
  public function __construct(array $data = array()) {
    $this->data = $data;
  }

  /**
   * ArrayAccess offsetExists
   * 
   * @param string $offset
   * @return bool
   */
  public function offsetExists($offset) {
    return isset($this->data[$offset]);
  }

  /**
   * ArrayAccess offsetGet
   * 
   * @param string $offset
   * @return mixed
   */
  public function offsetGet($offset) {
    return $this->data[$offset];
  }

  /**
   * ArrayAccess offsetSet
   * 
   * @param string $offset
   * @param mixed $value
   */
  public function offsetSet($offset, $value) {
    $this->data[$offset] = $value;
  }

  /**
   * ArrayAccess offsetUnset
   * 
   * @param string $offset
   */
  public function offsetUnset($offset) {
    unset($this->data[$offset]);
  }

  /**
   * IteratorAggregate
   *
   * @return \ArrayIterator
   */
  public function getIterator() {
    return new \ArrayIterator($this->data);
  }

  /**
   * Updates timestamp items in cache info
   * 
   * @param string $name
   * @param array|string $itemNames
   */
  public function touchItem($name, $itemNames = array()) {
    if (!is_array($itemNames)) {
      $itemNames = array($itemNames);
    }
    foreach ($itemNames as $itemName) {
      $this->data[$name][$itemName] = time();
    }
  }

  /**
   * Gets an item from cache info
   * 
   * @param string $name
   * @param string $itemName
   * @param string $type
   * @param string $format
   * 
   * @return string|int|bool
   */
  public function getItem($name, $itemName, $type = 'int', $format = 'U') {
    if (!isset($this->data[$name])) {
      return false;
    }
    switch ($type) {
      case 'date':
        return isset($this->data[$name][$itemName]) ? date($format, $this->data[$name][$itemName]) : null;
      case 'int':
        return (int) $this->getItemOrDefault($name, $itemName, 0);
      default:
        return $this->getItemOrDefault($name, $itemName);
    }
  }

  /**
   * Gets an item value or default if not exists
   * 
   * @param string $name
   * @param string $itemName
   * @param mixed $default
   * 
   * @return mixed
   */
  protected function getItemOrDefault($name, $itemName, $default = null) {
    return isset($this->data[$name][$itemName]) ? $this->data[$name][$itemName] : $default;
  }

  /**
   * Sets an item
   * 
   * @param string $name
   * @param string $item
   * @param mixed $value
   */
  public function setItem($name, $item, $value) {
    $this->data[$name][$item] = $value;
  }

  /**
   * Inreases an item in cache info
   * 
   * @param string $name
   * @param string $itemName
   */
  public function increaseItem($name, $itemName) {
    $this->data[$name][$itemName] = (isset($this->data[$name][$itemName]) && is_int($this->data[$name][$itemName]) ? ++$this->data[$name][$itemName] : 1);
  }

  /**
   * Gets Cache info data
   * 
   * @param $name Cache key
   * 
   * @return array
   */
  public function getData($name = '') {
    return $name == '' ? $this->data : (isset($this->data[$name]) ? $this->data[$name] : null);
  }

  /**
   * Gets all cache key names
   *  	 
   * @return array
   */
  public function getKeys() {
    return array_keys($this->data);
  }

  /**
   * Creates an info item
   * 
   * @param string $name
   */
  public function createData($name) {
    $this->data[$name] = array(
        'last_read' => null,
        'read_count' => 0,
        'tags' => array()
    );
    $this->touchItem($name, 'created');
  }

  /**
   * Deletes an info item
   * 
   * @param string $name
   */
  public function deleteData($name) {
    if (isset($this->data[$name])) {
      unset($this->data[$name]);
    }
  }

  /**
   * Appends data to an item
   * 
   * @param string $name
   * @param array $data
   */
  public function appendData($name, array $data) {
    $this->data[$name] = array_merge($this->data[$name], $data);
  }

  /**
   * Sets info data
   * 
   * @param array $data
   */
  public function setData(array $data) {
    $this->data = $data;
  }

  /**
   * Gets expiry information
   * 
   * @param string $name Cache name
   * @param string $format Date format
   * 	 
   * @return string
   */
  public function getExpiry($name, $format = 'U') {
    return isset($this->data[$name]['expiry']) ? ($this->data[$name]['expiry'] == 0 ? 0 : date($format, $this->data[$name]['expiry'])) : null;
  }

  /**
   * Get cache names having the given tags
   * 
   * @param array $tags
   * 
   * @return array
   */
  public function filterByTags(array $tags) {
    $result = array();
    foreach ($this->data as $key => $info) {
      if (count(array_intersect($tags, $info['tags'])) > 0) {
        $result[] = $key;
      }
    }
    return $result;
  }
  
}