Cache::commit() - Code Metrics - Inspection of "缓存类增加push方法用于追加元素到数组缓存" - top-think/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — 6.0 ( 9dcf40...bc5730 )

by liu
created 2019-05-05 09:51 UTC
Cache::commit() A

↳ Parent: Cache
Complexity

Conditions	3
Paths	3
Size

Total Lines	11
Code Lines	6
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	12
Importance

Changes
Metric	Value
cc	3
eloc	6
nc	3
nop	0
dl	0
loc	11
ccs	0
cts	7
cp	0
crap	12
rs	10
c	0
b	0
f	0
<?php
// +----------------------------------------------------------------------

// | ThinkPHP [ WE CAN DO IT JUST THINK ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006~2019 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: liu21st <[email protected]>
// +----------------------------------------------------------------------
declare (strict_types = 1);

namespace think;

use Psr\Cache\CacheItemInterface;
use Psr\Cache\CacheItemPoolInterface;
use think\cache\CacheItem;
use think\cache\Driver;
use think\exception\InvalidArgumentException;

/**
 * 缓存管理类
 */

class Cache implements CacheItemPoolInterface
{
    /**
     * 缓存队列
     * @var array
     */
    protected $data = [];

    /**
     * 延期保存的缓存队列
     * @var array
     */
    protected $deferred = [];

    /**
     * 缓存实例
     * @var array
     */
    protected $instance = [];

    /**
     * 配置参数
     * @var array
     */
    protected $config = [];

    /**
     * 操作句柄
     * @var object
     */
    protected $handler;

    public function __construct(array $config = [])

    {
        $this->config = $config;
    }

    public static function __make(Config $config)

    {
        return new static($config->get('cache'));
        return new static(/** @scrutinizer ignore-type */ $config->get('cache'));
    }

    /**
     * 连接缓存
     * @access public
     * @param  array $options  配置数组

     * @param  bool  $force 强制重新连接

     * @return Driver
     */
    public function connect(array $options = [], bool $force = false): Driver
    {
        $name = md5(serialize($options));

        if ($force || !isset($this->instance[$name])) {
            $type = !empty($options['type']) ? $options['type'] : 'File';

            $this->instance[$name] = App::factory($type, '\\think\\cache\\driver\\', $options);
        }

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

    /**
     * 自动初始化缓存
     * @access protected
     * @param  array $options 配置数组
     * @param  bool  $force   强制更新
     * @return Driver
     */
    protected function init(array $options = [], bool $force = false): Driver
    {
        if (is_null($this->handler) || $force) {
            $options = !empty($options) ? $options : $this->config;

            if (isset($options['type']) && 'complex' == $options['type']) {
                $default = $options['default'];
                $options = $options[$default['type']] ?? $default;
            }

            $this->handler = $this->connect($options);
        }

        return $this->handler;
    }

    /**
     * 设置配置
     * @access public
     * @param  array $config 配置参数
     * @return void
     */
    public function config(array $config): void
    {
        $this->config = array_merge($this->config, $config);
    }

    /**
     * 切换缓存类型 需要配置 cache.type 为 complex
     * @access public
     * @param  string $name  缓存标识
     * @param  bool   $force 强制更新
     * @return Driver
     */
    public function store(string $name = '', bool $force = false): Driver
    {
        if ('' !== $name && 'complex' == $this->config['type']) {
            return $this->connect($this->config[$name], $force);
        }

        return $this->init([], $force);
    }

    /**
     * 读取缓存
     * @access public
     * @param  string $key 缓存变量名

     * @param  mixed  $default 默认值
     * @return mixed
     */
    public function get(string $key, $default = false)
    {
        return $this->init()->get($key, $default);
    }

    /**
     * 写入缓存
     * @access public
     * @param  string        $name 缓存变量名

     * @param  mixed         $value  存储数据
     * @param  int|\DateTime $expire  有效时间 0为永久

     * @return bool
     */
    public function set(string $name, $value, $expire = null): bool
    {
        return $this->init()->set($name, $value, $expire);
        return $this->init()->set($name, $value, /** @scrutinizer ignore-type */ $expire);
    }

    /**
     * 追加缓存
     * @access public
     * @param  string        $name 缓存变量名

     * @param  mixed         $value  存储数据
     * @param  int|\DateTime $expire  有效时间 0为永久

     * @return array
     */
    public function push(string $name, $value, $expire = null): array
    {
        return $this->init()->push($name, $value, $expire);
    }

    /**
     * 读取并删除缓存
     * @access public
     * @param  string $name 缓存变量名
     * @return mixed
     */
    public function pull(string $name)
    {
        return $this->init()->pull($name);
    }

    /**
     * 如果不存在则写入缓存
     * @access public
     * @param  string $name 缓存变量名

     * @param  mixed  $value  存储数据
     * @param  int    $expire  有效时间 0为永久

     * @return mixed
     */
    public function remember(string $name, $value, $expire = null)
    {
        return $this->init()->remember($name, $value, $expire);
    }

    /**

     * 删除缓存
     * @access public
     * @param  string $name 缓存变量名

     * @return bool
     */
    public function delete(string $key): bool
    {
        return $this->init()->rm($key);
    }

    /**

     * 判断缓存是否存在
     * @access public
     * @param  string $name 缓存变量名

     * @return bool
     */
    public function has(string $key): bool
    {
        return $this->init()->has($key);
    }

    /**
     * 缓存标签
     * @access public
     * @param  string|array $name 标签名
     * @return Driver
     */
    public function tag($name)
    {
        return $this->init()->tag($name);
    }

    /**
     * 返回句柄对象，可执行其它高级方法
     *
     * @access public
     * @return object
     */
    public function handler()
    {
        return $this->init()->handler();
    }

    /**
     * 返回「键」对应的一个缓存项。
     * @access public
     * @param  string $key 缓存标识
     * @return CacheItemInterface
     * @throws InvalidArgumentException
     */
    public function getItem($key): CacheItem
    {
        if (isset($this->data[$key])) {
            return $this->data[$key];
        }

        $cacheItem = new CacheItem($key);

        if ($this->has($key)) {
            $cacheItem->set($this->get($key));
        }

        $this->data[$key] = $cacheItem;

        return $cacheItem;
    }

    /**
     * 返回一个可供遍历的缓存项集合。
     * @access public
     * @param  array $keys

     * @return array|\Traversable
     * @throws InvalidArgumentException
     */
    public function getItems(array $keys = []): array
    {
        $result = [];
        foreach ($keys as $key) {
            $result[] = $this->getItem($key);
        }

        return $result;
    }

    /**
     * 检查缓存系统中是否有「键」对应的缓存项。
     * @access public
     * @param  string $key

     * @return bool
     * @throws InvalidArgumentException
     */
    public function hasItem($key): bool
    {
        return $this->has($key);
    }

    /**
     * 清空缓冲池
     * @access public
     * @return bool
     */
    public function clear(): bool
    {
        return $this->init()->clear();
    }

    /**
     * 从缓冲池里移除某个缓存项
     * @access public
     * @param  string $key

     * @return bool
     * @throws InvalidArgumentException
     */
    public function deleteItem($key): bool
    {
        return $this->delete($key);
    }

    /**
     * 从缓冲池里移除多个缓存项
     * @access public
     * @param  array $keys

     * @return bool
     * @throws InvalidArgumentException
     */
    public function deleteItems(array $keys): bool
    {
        foreach ($keys as $key) {
            $this->delete($key);
        }

        return true;
    }

    /**
     * 立刻为「CacheItemInterface」对象做数据持久化。
     * @access public
     * @param  CacheItemInterface $item

     * @return bool
     */
    public function save(CacheItemInterface $item): bool
    {
        if ($item->getKey()) {
            return $this->set($item->getKey(), $item->get(), $item->getExpire());
        }

        return false;
    }

    /**
     * 稍后为「CacheItemInterface」对象做数据持久化。
     * @access public
     * @param  CacheItemInterface $item

     * @return bool
     */
    public function saveDeferred(CacheItemInterface $item): bool
    {
        $this->deferred[$item->getKey()] = $item;
        return true;
    }

    /**
     * 提交所有的正在队列里等待的请求到数据持久层，配合 `saveDeferred()` 使用
     * @access public
     * @return bool
     */
    public function commit(): bool
    {
        foreach ($this->deferred as $key => $item) {
            $result = $this->save($item);
            unset($this->deferred[$key]);

            if (false === $result) {
                return false;
            }
        }
        return true;
    }

    public function __call($method, $args)

    {
        return call_user_func_array([$this->init(), $method], $args);
    }

    public function __destruct()

    {
        if (!empty($this->deferred)) {
            $this->commit();
        }
    }

}

top-think / framework

Push — 6.0 ( 9dcf40...bc5730 )

Cache::commit() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
