classCache::getMode() - Code Metrics - Inspection of "CDOE-misc-41a52.9: Beautifying code" - supernova-ws/SuperNova - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — work-fleets ( 692eef...9e987d )

by SuperNova.WS
created 2016-08-12 21:38 UTC
classCache::getMode() A

↳ Parent: classCache
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10
ccs	0
cts	3
cp	0
crap	2
<?php
/**
 *
 * @package supernova
 * @version $Id$
 * @copyright (c) 2009-2010 Gorlum for http://supernova.ws
 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
 *
 */

/**
 * @ignore
 * Defining some constants
 */
define('CACHER_NOT_INIT', -1);
define('CACHER_NO_CACHE', 0);
define('CACHER_XCACHE', 1);

define('CACHER_LOCK_WAIT', 5); // maximum cacher wait for table unlock in seconds. Can be float

// max timeout cacher can sleep in waiting for unlockDefault = 10000 ms = 0.01s
// really it will sleep mt_rand(100, classCache::CACHER_LOCK_SLEEP)
define('CACHER_LOCK_SLEEP', 10000);

/**
 *
 * Basic cacher class that handles different cache engines
 * It's pretty smart to handle one cache instance for all application instances (if there is PHP-cacher installed)
 * Currently supported only XCache and no-cache (array)
 * With no-cache some advanced features would be unaccessible
 * Cacher works not only with single values. It's also support multidimensional arrays
 * Currently support is a bit limited - for example there is no "walk" function. However basic array abilities supported
 * You should NEVER operate with arrays inside of cacher and should ALWAYS use wrap-up functions
 *
 *
 * @property bool _INITIALIZED
 * @property array lng_stat_usage - Array for locale strings usage statistics
 * @property array tables
 *
 * @package supernova
 */
class classCache {
  // CACHER_NOT_INIT - not initialized
  // CACHER_NO_CACHE - no cache - array() used
  // CACHER_XCACHE   - xCache
  protected static $mode = CACHER_NOT_INIT;
  protected static $data;
  protected $prefix;

  protected static $cacheObject;

  /**
   * @return int
   */
  public function getMode() {
    return static::$mode;
  }

  public function __construct($prefIn = 'CACHE_', $init_mode = false) {
    if (!($init_mode === false || $init_mode === CACHER_NO_CACHE || ($init_mode === CACHER_XCACHE && extension_loaded('xcache')))) {
      throw new UnexpectedValueException('Wrong work mode or current mode does not supported on your server');
    }

    $this->prefix = $prefIn;
    if (extension_loaded('xcache') && ($init_mode === CACHER_XCACHE || $init_mode === false)) {
      if (self::$mode === CACHER_NOT_INIT) {
        self::$mode = CACHER_XCACHE;
      }
    } else {
      if (self::$mode === CACHER_NOT_INIT) {
        self::$mode = CACHER_NO_CACHE;
        if (!self::$data) {
          self::$data = array();
        }
      }
    }
  }

  public static function getInstance($prefIn = 'CACHE_', $table_name = '') {
    if (!isset(self::$cacheObject)) {
      $className = get_class();
      self::$cacheObject = new $className($prefIn);
    }

    return self::$cacheObject;
  }

  public final function __clone() {
    // You NEVER need to copy cacher object or siblings
    throw new BadMethodCallException('Clone is not allowed');
  }

  // -------------------------------------------------------------------------
  // Here comes low-level functions - those that directly works with cacher engines
  // -------------------------------------------------------------------------
  public function __set($name, $value) {

    switch (self::$mode) {
      case CACHER_NO_CACHE:
        self::$data[$this->prefix . $name] = $value;
      break;

      case CACHER_XCACHE:
        xcache_set($this->prefix . $name, $value);
      break;
    }
  }

  public function __get($name) {
    switch (self::$mode) {
      case CACHER_NO_CACHE:
        return self::$data[$this->prefix . $name];
      break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

      case CACHER_XCACHE:
        return xcache_get($this->prefix . $name);
      break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
    }

    return null;
  }

  public function __isset($name) {
    switch (self::$mode) {
      case CACHER_NO_CACHE:
        return isset(self::$data[$this->prefix . $name]);
      break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

      case CACHER_XCACHE:
        return xcache_isset($this->prefix . $name) && ($this->__get($name) !== null);
      break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
    }

    return false;
  }

  public function __unset($name) {

    switch (self::$mode) {
      case CACHER_NO_CACHE:
        unset(self::$data[$this->prefix . $name]);
      break;

      case CACHER_XCACHE:
        xcache_unset($this->prefix . $name);
      break;
    }
  }

  public function unset_by_prefix($prefix_unset = '') {
    static $array_clear;
    !$array_clear ? $array_clear = function (&$v, $k, $p) {
      strpos($k, $p) === 0 ? $v = null : false;
    } : false;

    switch (self::$mode) {
      case CACHER_NO_CACHE:
//        array_walk(self::$data, create_function('&$v,$k,$p', 'if(strpos($k, $p) === 0)$v = NULL;'), $this->prefix.$prefix_unset);

        array_walk(self::$data, $array_clear, $this->prefix . $prefix_unset);

        return true;
      break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

      case CACHER_XCACHE:
        if (!function_exists('xcache_unset_by_prefix')) {
          return false;
        }

        return xcache_unset_by_prefix($this->prefix . $prefix_unset);
      break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
    }

    return true;
  }
  // -------------------------------------------------------------------------
  // End of low-level functions
  // -------------------------------------------------------------------------

  protected function make_element_name($args, $diff = 0) {
    $num_args = count($args);

    if ($num_args < 1) {
      return false;
    }

    $name = '';
    $aName = array();
    for ($i = 0; $i <= $num_args - 1 - $diff; $i++) {
      $name .= "[{$args[$i]}]";
      array_unshift($aName, $name);
    }

    return $aName;
  }

  public function array_set() {
    $args = func_get_args();
    $name = $this->make_element_name($args, 1);

    if (!$name) {
      return null;
    }

    if ($this->$name[0] === null) {
      for ($i = count($name) - 1; $i > 0; $i--) {
        $cName = "{$name[$i]}_COUNT";
        $cName1 = "{$name[$i-1]}_COUNT";
        if ($this->$cName1 == null || $i == 1) {
          $this->$cName++;
        }
      }
    }

    $this->$name[0] = $args[count($args) - 1];

    return true;
  }

  public function array_get() {
    $name = $this->make_element_name(func_get_args());
    if (!$name) {
      return null;
    }

    return $this->$name[0];
  }

  public function array_count() {
    $name = $this->make_element_name(func_get_args());
    if (!$name) {
      return 0;
    }
    $cName = "{$name[0]}_COUNT";
    $retVal = $this->$cName;
    if (!$retVal) {
      $retVal = null;
    }

    return $retVal;
  }

  public function array_unset() {
    $name = $this->make_element_name(func_get_args());

    if (!$name) {
      return false;
    }
    $this->unset_by_prefix($name[0]);

    for ($i = 1; $i < count($name); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
      $cName = "{$name[$i]}_COUNT";
      $cName1 = "{$name[$i-1]}_COUNT";

      if ($i == 1 || $this->$cName1 === null) {
        $this->$cName--;
        if ($this->$cName <= 0) {
          unset($this->$cName);
        }
      }
    }

    return true;
  }

  public function dumpData() {
    switch (self::$mode) {
      case CACHER_NO_CACHE:
        return dump(self::$data, $this->prefix);
      break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

      default:
        return false;
      break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
    }
  }

  public function reset() {
    $this->unset_by_prefix();

    $this->_INITIALIZED = false;
  }

  public function init($reInit = false) {

    $this->_INITIALIZED = true;
  }

  public function isInitialized() {
    return $this->_INITIALIZED;
  }
}










///*

//New test metaclass for handling DB table caching
//*/
//
//class class_db_cache extends classCache
//{
//  protected $tables = array(
//    'users' => array('name' => 'users', 'id' => 'id', 'index' => 'users_INDEX', 'count' => 'users_COUNT', 'lock' => 'users_LOCK', 'callback' => 'cb_users', 'ttl' => 0),
//    'config' => array('name' => 'config', 'id' => 'config_name', 'index' => 'config_INDEX', 'count' => 'config_COUNT', 'lock' => 'config_LOCK', 'callback' => 'cb_config', 'ttl' => 0),
//  );
//
//  public function __construct($gamePrefix = 'sn_')
//  {
//    parent::__construct("{$gamePrefix}dbcache_");
//  }
//
//  public function cache_add($table_name = 'table', $id_field = 'id', $ttl = 0, $force_load = false)
//  {
//    $table['name']     = $table_name;
//    $table['id']       = $id_field;
//    $table['index']    = "{$table_name}_INDEX";
//    $table['count']    = "{$table_name}_COUNT";
//    $table['lock']     = "{$table_name}_LOCK";
//    $table['callback'] = "cb_{$table_name}";
//    $table['ttl']      = $ttl;
//
//    $this->tables[$table_name] = $table;
//    // here we can load table data from DB - fields and indexes
//    // $force_reload would show should we need to reload table data from DB
//  }
//
//  // multilock
//  protected function table_lock($table_name, $wait_if_locked = false, $lock = NULL)
//  {
//    $lock_field_name = $this->tables['$table_name']['lock'];
//
//    $lock_wait_start = microtime(true);
//    while($wait_if_locked && !$this->$lock_field_name && (microtime(true) - $lock_wait_start <= CACHER_LOCK_WAIT))
//    {
//      usleep(mt_rand(100, classCache::CACHER_LOCK_SLEEP));
//    }
//
//    $result = (!$this->$lock_field_name) XOR ($lock === NULL);
//    if($result && $lock)
//    {
//      $this->$lock_field_name = $lock;
//    }
//
//    return $result;
//  }
//
//
//  /*
//    Magic start here. __call magic method will transform name of call to table name and handle all caching & db-related stuff
//    If there is such row in cache it will be returned. Otherwise it will read from DB, cached and returned
//    I.e. class_db_cache->table_name() call mean that all request will be done with records (cached or DB) in `table_name` table
//    __call interpets last argument as optional boolean parameter $force.
//    In read operations $force === true will tell cacher not to use cached data but load records from DB
//    In write operations $force === true will tell cacher immidiatly store new data to DB not relating on internal mechanics
//
//    __call have several forms
//
//    Form 1:
//      __call($id, [$force]) - "SELECT * FROM {table} WHERE id_field = $id"
//
//    Form 2: (not implemented yet)
//      __call('get', $condition, [$force]) - "SELECT * FROM {table} WHERE $condition"
//
//    Form 3: (not implemented yet)
//      __call('set', $data, [$condition], [$force]) - "UPDATE {table} SET $row = $data WHERE $condition"
//
//    Form 4: (not implemented yet)
//      __call('add', $data, [$condition], [$force]) - "UPDATE {table} SET $row = $row + $data WHERE $condition"
//  */
//
//  public function __call($name, $arguments)
//  {
//    $main_argument = $arguments[0];
//
//    switch($main_argument)
//    {
//      case 'get':
//        // it might be SELECT
//      break;
//
//      case 'set':
//        // it might be UPDATE
//      break;
//
//      default:
//        // it might be SELECT * FROM {table} WHERE id = $main_argument;
//        return $this->get_item($name, $main_argument, $arguments[1]);
//      break;
//    }
//  }
//
//  public function get_item($table_name, $id, $force_reload = false)
//  {
//    $internal_name = "{$table_name}_{$id}";
//
//    if(isset($this->$internal_name) && !$force_reload)
//    {
//      // pdump("{$id} - returning stored data");
//
//      return $this->$internal_name;
//    }
//    else
//    {
//      // pdump("{$id} - asking DB");
//
//      return $this->db_loadItem($table_name, $id);
//    }
//  }
//
//  public function db_loadItem($table_name, $id)
//  {
//    // If no table_name or no index - there is no such element
//    if(!$id && !$table_name)
//    {
//      return NULL;
//    }
//
//    $result = $this->db_loadItems($table_name, '*', "`{$this->tables[$table_name]['id']}` = '{$id}'", 1);
//    if($result)
//    {
//      return $result[$id];
//    }
//    else
//    {
//      $this->del_item($table_name, $id);
//      return NULL;
//    }
//  }
//
//  public function db_loadItems($table_name, $fields = '*', $condition = '', $limits = '')
//  {
//    if(!$fields)
//    {
//      $fields = '*';
//    }
//
//    if($condition)
//    {
//      $condition = " WHERE {$condition}";
//    }
//
//    if($limits)
//    {
//      $limits = " LIMIT {$limits}";
//    }
//
//    $query = doquery("SELECT {$fields} FROM `{{{$table_name}}}`{$condition}{$limits};");
//
//    $table = $this->tables[$table_name];
//
//    $index = $this->$table['index'];
//    $count = $this->$table['count'];
//
//    $result = NULL;
//
//    while ( $row = db_fetch($query) )
//    {
//      /*
//      foreach($row as $index => &$value)
//      {
//        if(is_numeric($value))
//        {
//          $value = floatval($value);
//
//          //if((double)intval($value) === $value)
//          //{
//          //  $value = intval($value);
//          //}
//        }
//      }
//      */
//
//      $item_id = $row[$table['id']];
//      $item_name = "{$table['name']}_{$item_id}";
//      if(!isset($this->$item_name))
//      {
//        $count++;
//      }
//
//      // Loading element to cache
//      $this->$item_name = $row;
//      // Also loading element to returning set
//      $result[$item_id] = $row;
//
//      // Internal work
//      // Indexing element for fast search
//      $index[$item_id] = true;
//    }
//
//    if($result)
//    {
//      $this->$table['index'] = $index;
//      $this->$table['count'] = $count;
//    }
//
//    return $result;
//  }
//
//  public function db_loadAll($table_name)
//  {
//    $this->unset_by_prefix("{$table_name}_");
//    $this->db_loadItems($table_name);
//  }
//
//  public function del_item($table_name, $id, $force_db_remove = false)
//  {
//    $internal_name = "{$table_name}_{$id}";
//
//    if(isset($this->$internal_name))
//    {
//      $table = $this->tables[$table_name];
//
//      $index = $this->$table['index'];
//      unset($index[$id]);
//      $this->$table['index'] = $index;
//
//      $this->$table['count']--;
//    }
//
//    if($force_db_remove)
//    {
//      doDelete("DELETE FROM {{{$table_name}}} WHERE `{$table['id']}` = '{$id}';");
//    }
//  }
//
///*
//  public function db_saveAll()
//  {
//    $toSave = array();
//    foreach($defaults as $field => $value)
//    {
//      $toSave[$field] = NULL;
//    }
//
//    $this->db_saveItem($toSave);
//  }
//
//  public function db_saveItem($index, $value = NULL)
//  {
//    if($index)
//    {
//      if(!is_array($index))
//      {
//        $index = array($index => $value);
//      }
//
//      foreach($index as $item_name => &$value)
//      {
//        if($value !== NULL)
//        {
//          $this->$item_name = $value;
//        }
//        else
//        {
//          $value = $this->$item_name;
//        }
//
//        $qry .= " ('{$item_name}', '{$value}'),";
//      }
//
//      $qry = substr($qry, 0, -1);
//      $qry = "REPLACE INTO `{{{$this->table_name}}}` (`{$this->sql_index_field}`, `{$this->sql_value_field}`) VALUES {$qry};";
//      doquery($qry);
//    };
//  }
//*/
//}

supernova-ws / SuperNova

Push — work-fleets ( 692eef...9e987d )

classCache::getMode() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
