FragmentCache::init() - Code Metrics - Inspection of "Merge fixes" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.1 ( 66095f...207f8c )

by Alexander

created 2017-07-20 14:01 UTC

FragmentCache::init() A

↳ Parent: FragmentCache

Complexity

Conditions	4
Paths	4

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	8
cts	8
cp	1
rs	9.2
c	0
b	0
f	0
cc	4
eloc	7
nc	4
nop	0
crap	4

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\widgets;

use Yii;
use yii\base\Widget;
use yii\caching\CacheInterface;
use yii\caching\Dependency;
use yii\di\Instance;

/**
 * FragmentCache is used by [[\yii\base\View]] to provide caching of page fragments.
 *
 * @property string|false $cachedContent The cached content. False is returned if valid content is not found
 * in the cache. This property is read-only.
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
class FragmentCache extends Widget
{
    /**
     * @var CacheInterface|array|string the cache object or the application component ID of the cache object.
     * After the FragmentCache object is created, if you want to change this property,
     * you should only assign it with a cache object.
     * Starting from version 2.0.2, this can also be a configuration array for creating the object.
     */
    public $cache = 'cache';
    /**
     * @var int number of seconds that the data can remain valid in cache.
     * Use 0 to indicate that the cached data will never expire.
     */
    public $duration = 60;
    /**
     * @var array|Dependency the dependency that the cached content depends on.
     * This can be either a [[Dependency]] object or a configuration array for creating the dependency object.
     * For example,
     *
     * ```php
     * [
     *     'class' => \yii\caching\DbDependency::class,
     *     'sql' => 'SELECT MAX(updated_at) FROM post',
     * ]
     * ```
     *
     * would make the output cache depends on the last modified time of all posts.
     * If any post has its modification time changed, the cached content would be invalidated.
     */
    public $dependency;
    /**
     * @var array list of factors that would cause the variation of the content being cached.
     * Each factor is a string representing a variation (e.g. the language, a GET parameter).
     * The following variation setting will cause the content to be cached in different versions
     * according to the current application language:
     *
     * ```php
     * [
     *     Yii::$app->language,
     * ]
     * ```
     */
    public $variations;
    /**
     * @var bool whether to enable the fragment cache. You may use this property to turn on and off
     * the fragment cache according to specific setting (e.g. enable fragment cache only for GET requests).
     */
    public $enabled = true;
    /**
     * @var array a list of placeholders for embedding dynamic contents. This property
     * is used internally to implement the content caching feature. Do not modify it.
     */
    public $dynamicPlaceholders;


    /**
     * Initializes the FragmentCache object.
     */
    public function init()
    {
        parent::init();

        $this->cache = $this->enabled ? Instance::ensure($this->cache, CacheInterface::class) : null;

        if ($this->cache instanceof CacheInterface && $this->getCachedContent() === false) {
            $this->getView()->cacheStack[] = $this;
            ob_start();
            ob_implicit_flush(false);
        }
    }

    /**
     * Marks the end of content to be cached.
     * Content displayed before this method call and after [[init()]]
     * will be captured and saved in cache.
     * This method does nothing if valid content is already found in cache.
     * @return string the result of widget execution to be outputted.
     */
    public function run()
    {
        if (($content = $this->getCachedContent()) !== false) {
            return $content;
        } elseif ($this->cache instanceof CacheInterface) {
            array_pop($this->getView()->cacheStack);

            $content = ob_get_clean();
            if ($content === false || $content === '') {
                return '';
            }
            if (is_array($this->dependency)) {
                $this->dependency = Yii::createObject($this->dependency);
            }
            $data = [$content, $this->dynamicPlaceholders];
            $this->cache->set($this->calculateKey(), $data, $this->duration, $this->dependency);

            if (empty($this->getView()->cacheStack) && !empty($this->dynamicPlaceholders)) {
                $content = $this->updateDynamicContent($content, $this->dynamicPlaceholders);
            }
            return $content;
        }
        return '';
    }

    /**
     * @var string|bool the cached content. False if the content is not cached.
     */
    private $_content;

    /**
     * Returns the cached content if available.
     * @return string|false the cached content. False is returned if valid content is not found in the cache.
     */
    public function getCachedContent()
    {
        if ($this->_content !== null) {
            return $this->_content;

        }

        $this->_content = false;

        if (!($this->cache instanceof CacheInterface)) {
            return $this->_content;
        }

        $key = $this->calculateKey();
        $data = $this->cache->get($key);
        if (!is_array($data) || count($data) !== 2) {
            return $this->_content;
        }

        list($this->_content, $placeholders) = $data;
        if (!is_array($placeholders) || count($placeholders) === 0) {
            return $this->_content;
        }

        if (empty($this->getView()->cacheStack)) {
            // outermost cache: replace placeholder with dynamic content
            $this->_content = $this->updateDynamicContent($this->_content, $placeholders);
        }
        foreach ($placeholders as $name => $statements) {
            $this->getView()->addDynamicPlaceholder($name, $statements);
        }

        return $this->_content;
    }

    /**
     * Replaces placeholders in content by results of evaluated dynamic statements.
     *
     * @param string $content
     * @param array $placeholders
     * @return string final content
     */
    protected function updateDynamicContent($content, $placeholders)
    {
        foreach ($placeholders as $name => $statements) {
            $placeholders[$name] = $this->getView()->evaluateDynamicContent($statements);
        }

        return strtr($content, $placeholders);
    }

    /**
     * Generates a unique key used for storing the content in cache.
     * The key generated depends on both [[id]] and [[variations]].
     * @return mixed a valid cache key
     */
    protected function calculateKey()
    {
        $factors = [__CLASS__, $this->getId()];
        if (is_array($this->variations)) {
            foreach ($this->variations as $factor) {
                $factors[] = $factor;
            }
        }

        return $factors;
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\widgets;
9
10		use Yii;
11		use yii\base\Widget;
12		use yii\caching\CacheInterface;
13		use yii\caching\Dependency;
14		use yii\di\Instance;
15
16		/**
17		* FragmentCache is used by [[\yii\base\View]] to provide caching of page fragments.
18		*
19		* @property string\|false $cachedContent The cached content. False is returned if valid content is not found
20		* in the cache. This property is read-only.
21		*
22		* @author Qiang Xue <[email protected]>
23		* @since 2.0
24		*/
25		class FragmentCache extends Widget
26		{
27		/**
28		* @var CacheInterface\|array\|string the cache object or the application component ID of the cache object.
29		* After the FragmentCache object is created, if you want to change this property,
30		* you should only assign it with a cache object.
31		* Starting from version 2.0.2, this can also be a configuration array for creating the object.
32		*/
33		public $cache = 'cache';
34		/**
35		* @var int number of seconds that the data can remain valid in cache.
36		* Use 0 to indicate that the cached data will never expire.
37		*/
38		public $duration = 60;
39		/**
40		* @var array\|Dependency the dependency that the cached content depends on.
41		* This can be either a [[Dependency]] object or a configuration array for creating the dependency object.
42		* For example,
43		*
44		* ```php
45		* [
46		* 'class' => \yii\caching\DbDependency::class,
47		* 'sql' => 'SELECT MAX(updated_at) FROM post',
48		* ]
49		* ```
50		*
51		* would make the output cache depends on the last modified time of all posts.
52		* If any post has its modification time changed, the cached content would be invalidated.
53		*/
54		public $dependency;
55		/**
56		* @var array list of factors that would cause the variation of the content being cached.
57		* Each factor is a string representing a variation (e.g. the language, a GET parameter).
58		* The following variation setting will cause the content to be cached in different versions
59		* according to the current application language:
60		*
61		* ```php
62		* [
63		* Yii::$app->language,
64		* ]
65		* ```
66		*/
67		public $variations;
68		/**
69		* @var bool whether to enable the fragment cache. You may use this property to turn on and off
70		* the fragment cache according to specific setting (e.g. enable fragment cache only for GET requests).
71		*/
72		public $enabled = true;
73		/**
74		* @var array a list of placeholders for embedding dynamic contents. This property
75		* is used internally to implement the content caching feature. Do not modify it.
76		*/
77		public $dynamicPlaceholders;
78
79
80		/**
81		* Initializes the FragmentCache object.
82		*/
83	7	public function init()
84		{
85	7	parent::init();
86
87	7	$this->cache = $this->enabled ? Instance::ensure($this->cache, CacheInterface::class) : null;
88
89	7	if ($this->cache instanceof CacheInterface && $this->getCachedContent() === false) {
90	6	$this->getView()->cacheStack[] = $this;
91	6	ob_start();
92	6	ob_implicit_flush(false);
93		}
94	7	}
95
96		/**
97		* Marks the end of content to be cached.
98		* Content displayed before this method call and after [[init()]]
99		* will be captured and saved in cache.
100		* This method does nothing if valid content is already found in cache.
101		* @return string the result of widget execution to be outputted.
102		*/
103	7	public function run()
104		{
105	7	if (($content = $this->getCachedContent()) !== false) {
106	4	return $content;
107	7	} elseif ($this->cache instanceof CacheInterface) {
108	6	array_pop($this->getView()->cacheStack);
109
110	6	$content = ob_get_clean();
111	6	if ($content === false \|\| $content === '') {
112	1	return '';
113		}
114	5	if (is_array($this->dependency)) {
115		$this->dependency = Yii::createObject($this->dependency);
116		}
117	5	$data = [$content, $this->dynamicPlaceholders];
118	5	$this->cache->set($this->calculateKey(), $data, $this->duration, $this->dependency);
119
120	5	if (empty($this->getView()->cacheStack) && !empty($this->dynamicPlaceholders)) {
121	3	$content = $this->updateDynamicContent($content, $this->dynamicPlaceholders);
122		}
123	5	return $content;
124		}
125	2	return '';
126		}
127
128		/**
129		* @var string\|bool the cached content. False if the content is not cached.
130		*/
131		private $_content;
132
133		/**
134		* Returns the cached content if available.
135		* @return string\|false the cached content. False is returned if valid content is not found in the cache.
136		*/
137	7	public function getCachedContent()
138		{
139	7	if ($this->_content !== null) {
140	7	return $this->_content;
		0 ignored issues – show Bug Compatibility introduced 2017-02-12 12:30 UTC by Report Bug Copy Issue Report The expression `$this->_content;` of type `string\|boolean` adds the type `boolean` to the return on line 140 which is incompatible with the return type documented by `yii\widgets\FragmentCache::getCachedContent` of type `string\|false`. Loading history...
141		}
142
143	7	$this->_content = false;
144
145	7	if (!($this->cache instanceof CacheInterface)) {
146	2	return $this->_content;
147		}
148
149	6	$key = $this->calculateKey();
150	6	$data = $this->cache->get($key);
151	6	if (!is_array($data) \|\| count($data) !== 2) {
152	6	return $this->_content;
153		}
154
155	4	list($this->_content, $placeholders) = $data;
156	4	if (!is_array($placeholders) \|\| count($placeholders) === 0) {
157	1	return $this->_content;
158		}
159
160	3	if (empty($this->getView()->cacheStack)) {
161		// outermost cache: replace placeholder with dynamic content
162	3	$this->_content = $this->updateDynamicContent($this->_content, $placeholders);
163		}
164	3	foreach ($placeholders as $name => $statements) {
165	3	$this->getView()->addDynamicPlaceholder($name, $statements);
166		}
167
168	3	return $this->_content;
169		}
170
171		/**
172		* Replaces placeholders in content by results of evaluated dynamic statements.
173		*
174		* @param string $content
175		* @param array $placeholders
176		* @return string final content
177		*/
178	3	protected function updateDynamicContent($content, $placeholders)
179		{
180	3	foreach ($placeholders as $name => $statements) {
181	3	$placeholders[$name] = $this->getView()->evaluateDynamicContent($statements);
182		}
183
184	3	return strtr($content, $placeholders);
185		}
186
187		/**
188		* Generates a unique key used for storing the content in cache.
189		* The key generated depends on both [[id]] and [[variations]].
190		* @return mixed a valid cache key
191		*/
192	6	protected function calculateKey()
193		{
194	6	$factors = [__CLASS__, $this->getId()];
195	6	if (is_array($this->variations)) {
196		foreach ($this->variations as $factor) {
197		$factors[] = $factor;
198		}
199		}
200
201	6	return $factors;
202		}
203		}
204

yiisoft / yii2

Push — 2.1 ( 66095f...207f8c )

FragmentCache::init() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like