SnCache

Complexity

Total Complexity

54

Size/Duplication

Total Lines	244
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

2.83%

Importance

Changes	16
Bugs	0	Features	0

29 Methods

Rating	Name	Duplication	Size	Complexity
A	cache_repack()	0	10	4
A	cache_clear()	0	10	3
A	cache_clear_all()	0	8	2
A	cache_isset()	0	3	2
A	cache_get()	0	3	2
B	cache_set()	0	21	8
A	queryCacheSetByFilter()	0	3	1
A	cache_unset()	0	9	3
A	cache_lock_get()	0	3	1
A	cache_lock_set()	0	3	1
A	cache_lock_unset()	0	7	2
A	cache_lock_unset_all()	0	7	1
A	getData()	0	3	2
A	cacheUnsetElement()	0	3	1
A	isArrayLocation()	0	3	1
A	getDataRefByLocationAndId()	0	3	1
A	setUnitLocator()	0	5	2
A	getUnitLocator()	0	3	2
A	getUnitLocatorByFullLocation()	0	3	2
A	setUnitLocatorByLocationAndIDs()	0	3	1
A	isUnitLocatorNotSet()	0	3	1
A	locatorReset()	0	3	1
A	queriesReset()	0	3	1
A	getQueries()	0	3	1
A	getLocks()	0	3	1
A	getQueriesByLocationAndFilter()	0	3	3
A	isQueryCacheByLocationAndFilterEmpty()	0	3	2
A	queryCacheResetByLocationAndFilter()	0	3	1
A	__construct()	0	3	1

<?php

/**
 * Class SnCache
 *
 * Permanent cache for classSupernova
 */
class SnCache {
  /**
   * Кэш данных - юзера, планеты, юниты, очередь, альянсы итд
   *
   * @var array $data
   */
  protected $data = array();

  /**
   * Кэширует соответствия между расположением объектов - в частности юнитов и очередей
   *
   * Массив $locator - хранит отношения между записями для быстрого доступа по тип_записи:тип_локации:ид_локации:внутренний_ид_записи=>информация
   * Для LOC_UNIT внутренний ИД - это SNID, а информация - это ссылка на запись `unit`
   * Для LOC_QUE внутренний ИД - это тип очереди, а информация - массив ссылок на `que`
   *
   * @var array $locator
   */
  protected $locator = array();

  /**
   * Кэш запросов
   *
   * @var array $queries
   */
  protected $queries = array();

  /**
   * Информация о блокировках
   *
   * @var array $locks
   */
  protected $locks = array();

  /**
   * @var db_mysql $db
   */
  protected $db;

  /**
   * SnDbCachedOperator constructor.
   *
   * @param \Common\GlobalContainer $gc
   * @param db_mysql $db
   */
  public function __construct($gc, $db) {

The parameter $gc is not used and could be removed.

    $this->db = $db;
  }


  /**
   * Repacking data for $location_type
   *
   * @param int $location_type
   * @param int $record_id
   */
  public function cache_repack($location_type, $record_id = 0) {
    // Если есть $user_id - проверяем, а надо ли перепаковывать?
    if ($record_id && isset($this->data[$location_type][$record_id]) && $this->data[$location_type][$record_id] !== null) {
      return;
    }

    HelperArray::array_repack($this->data[$location_type]);
    HelperArray::array_repack($this->locator[$location_type], 3); // TODO У каждого типа локации - своя глубина!!!! Но можно и глубже ???
    HelperArray::array_repack($this->queries[$location_type], 1);
  }

  public function cache_clear($location_type, $hard = true) {
    if ($hard && !empty($this->data[$location_type])) {
      // Здесь нельзя делать unset - надо записывать NULL, что бы это отразилось на зависимых записях
      // TODO - replace with setNull
      array_walk($this->data[$location_type], 'setNull');
    }
    $this->locator[$location_type] = array();
    $this->queries[$location_type] = array();
    $this->cache_repack($location_type); // Перепаковываем внутренние структуры, если нужно
  }

  // TODO - UNUSED ????????????

64% of this comment could be valid code. Did you maybe forget this after debugging?

  public function cache_clear_all($hard = true) {
    if ($hard) {
      $this->data = array();
      static::cache_lock_unset_all();
    }
    $this->locator = array();
    $this->queries = array();
  }

  public function cache_isset($location_type, $record_id) {
    return isset($this->data[$location_type][$record_id]) && $this->data[$location_type][$record_id] !== null;
  }

  // TODO - UNUSED ????????????

64% of this comment could be valid code. Did you maybe forget this after debugging?

  public function cache_get($location_type, $record_id) {
    return isset($this->data[$location_type][$record_id]) ? $this->data[$location_type][$record_id] : null;
  }

  /* Кэшируем запись в соответствующий кэш

  Писать в кэш:
  1. Если записи не существует в кэше
  2. Если стоит $force_overwrite
  3. Если во время транзакции существующая запись не заблокирована

  Блокировать запись:
  1. Если идет транзакция и запись не заблокирована
  2. Если не стоит скип-лок
  */
  public function cache_set($location_type, $record, $force_overwrite = false, $skip_lock = false) {
    // нет идентификатора - выход
    if (!($record_id = $record[SnDbCachedOperator::$location_info[$location_type][P_ID]])) {
      return;
    }

    $in_transaction = $this->db->getTransaction()->check(false);
    if (
      $force_overwrite
      ||
      // Не заменяются заблокированные записи во время транзакции
      ($in_transaction && !$this->cache_lock_get($location_type, $record_id))
      ||
      !$this->cache_isset($location_type, $record_id)
    ) {
      $this->data[$location_type][$record_id] = $record;
      if ($in_transaction && !$skip_lock) {
        $this->cache_lock_set($location_type, $record_id);
      }
    }
  }

  public function queryCacheSetByFilter($location_type, $filter, $record_id) {
    $this->queries[$location_type][$filter][$record_id] = &$this->getDataRefByLocationAndId($location_type, $record_id);
  }

  public function cache_unset($cache_id, $safe_record_id) {
    // $record_id должен быть проверен заранее !
    if (isset($this->data[$cache_id][$safe_record_id]) && $this->data[$cache_id][$safe_record_id] !== null) {
      // Выставляем запись в null
      $this->data[$cache_id][$safe_record_id] = null;
      // Очищаем кэш мягко - что бы удалить очистить связанные данные - кэш локаций и кэш запоросов и всё, что потребуется впредь
      $this->cache_clear($cache_id, false);
    }
  }

  public function cache_lock_get($location_type, $record_id) {
    return isset($this->locks[$location_type][$record_id]);
  }

  public function cache_lock_set($location_type, $record_id) {
    return $this->locks[$location_type][$record_id] = true; // Не всегда - от результата
  }

  // TODO - UNUSED ????????????

64% of this comment could be valid code. Did you maybe forget this after debugging?

  public function cache_lock_unset($location_type, $record_id) {
    if (isset($this->locks[$location_type][$record_id])) {
      unset($this->locks[$location_type][$record_id]);
    }

    return true; // Не всегда - от результата
  }

  public function cache_lock_unset_all() {
    // Когда будем работать с xcache - это понадобиться, что бы снимать в xcache блокировки с записей
    // Пройти по массиву - снять блокировки для кэшера в памяти
    $this->locks = array();

    return true; // Не всегда - от результата
  }

  public function getData($locationType = LOC_NONE) {
    return $locationType == LOC_NONE ? $this->data : $this->data[$locationType];
  }

  public function cacheUnsetElement($locationType, $recordId) {
    $this->data[$locationType][$recordId] = null;
  }

  public function isArrayLocation($locationType) {
    return is_array($this->data[$locationType]);
  }

  /**
   * Return reference to record in $data by locationType and recordId
   *
   * @param int $locationType
   * @param int $recordId
   *
   * @return &mixed

The doc-type &mixed could not be parsed: Unknown type name "&mixed" at position 0. (view supported doc-types)

   */
  public function &getDataRefByLocationAndId($locationType, $recordId) {
    return $this->data[$locationType][$recordId];
  }

  // TODO UNUSED ????

45% of this comment could be valid code. Did you maybe forget this after debugging?

  public function setUnitLocator($unit, $unit_id) {
    if (is_array($unit)) {
      $this->locator[LOC_UNIT][$unit['unit_location_type']][$unit['unit_location_id']][$unit['unit_snid']] = &$this->getDataRefByLocationAndId(LOC_UNIT, $unit_id);
    }
  }

  public function getUnitLocator($location_type, $location_id, $unit_snid) {
    return $unit_snid ? $this->locator[LOC_UNIT][$location_type][$location_id][$unit_snid] : $this->locator[LOC_UNIT][$location_type][$location_id];
  }

  public function getUnitLocatorByFullLocation($location_type, $location_id) {
    return is_array($this->locator[LOC_UNIT][$location_type][$location_id]) ? $this->locator[LOC_UNIT][$location_type][$location_id] : array();
  }

  public function setUnitLocatorByLocationAndIDs($location_type, $location_id, $unit_data) {
    $this->locator[LOC_UNIT][$location_type][$location_id][$unit_data['unit_snid']] = &$this->data[LOC_UNIT][$unit_data['unit_id']];
  }

  public function isUnitLocatorNotSet($location_type, $location_id) {
    return !isset($this->locator[LOC_UNIT][$location_type][$location_id]);
  }

  public function locatorReset() {
    $this->locator = array();
  }

  public function queriesReset() {
    $this->queries = array();
  }

  public function getQueries() {
    return $this->queries;
  }

  public function getLocks() {
    return $this->locks;
  }

  public function getQueriesByLocationAndFilter($locationType, $filter) {
    return !empty($this->queries[$locationType][$filter]) && is_array($this->queries[$locationType][$filter]) ? $this->queries[$locationType][$filter] : array();
  }

  public function isQueryCacheByLocationAndFilterEmpty($locationType, $filter) {
    return !isset($this->queries[$locationType][$filter]) || $this->queries[$locationType][$filter] === null;
  }

  public function queryCacheResetByLocationAndFilter($locationType, $filter) {
    $this->queries[$locationType][$filter] = array();
  }

}