DatabaseCache::setCacheContent() - Code Metrics - Inspection of "Improve some classes, remove some unnecessary meth..." - tnhfw/tnh-fw - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — 1.0.0-dev ( 62b9b2...317ddd )

by nguereza

created 2020-04-16 09:40 UTC

DatabaseCache::setCacheContent() A

↳ Parent: DatabaseCache

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	8
nc	2
nop	1
dl	0
loc	11
rs	10
c	0
b	0
f	0

<?php
    defined('ROOT_PATH') || exit('Access denied');
    /**
     * TNH Framework
     *
     * A simple PHP framework using HMVC architecture
     *
     * This content is released under the MIT License (MIT)
     *
     * Copyright (c) 2017 TNH Framework
     *
     * Permission is hereby granted, free of charge, to any person obtaining a copy
     * of this software and associated documentation files (the "Software"), to deal
     * in the Software without restriction, including without limitation the rights
     * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     * copies of the Software, and to permit persons to whom the Software is
     * furnished to do so, subject to the following conditions:
     *
     * The above copyright notice and this permission notice shall be included in all
     * copies or substantial portions of the Software.
     *
     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
     * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
     * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
     * SOFTWARE.
     */
    
    class DatabaseCache extends BaseClass {
	
        /**
         * The cache time to live in second. 0 means no need to use the cache feature
         * @var int
         */
        private $cacheTtl = 0;
	
        /**
         * The CacheInterface instance
         * @var object
         */
        private $cache = null;

        /**
         * The SQL query statment to get or save the result into cache
         * @var string
         */
        private $query = null;

        /**
         * If the current query is the SELECT query
         * @var boolean
         */
        private $isSelectQuery = false;

        /**
         * The status of the database cache
         * @var boolean
         */
        private $dbCacheStatus = false;

        /**
         * Indicate if we need return result as list 
         * @var boolean
         */
        private $returnAsList = true;
     
     
        /**
         * Indicate if we need return result as array or not
         * @var boolean
         */
        private $returnAsArray = true;
     

        /**
         * Construct new instance
         */
        public function __construct() {
            parent::__construct();
        }

        /**
         * Return the current query SQL string
         * @return string
         */
        public function getQuery() {
            return $this->query;
        }
        
        /**
         * Set the query SQL string
         * @param string $query the SQL query to set
         * @return object DatabaseQueryRunner
         */
        public function setQuery($query) {
            $this->query = $query;
            return $this;
        }

        /**
         * Set database cache time to live
         * @param integer $ttl the cache time to live in second
         * @return object        the current Database instance
         */
        public function setCacheTtl($ttl = 0) {
            $this->cacheTtl = $ttl;
            return $this;
        }

        /**
         * Return the cache instance
         * @return object CacheInterface
         */
        public function getCache() {
            return $this->cache;
        }

        /**
         * Set the cache instance
         * @param object CacheInterface $cache the cache object
         * @return object Database
         */
        public function setCache(CacheInterface $cache) {
            $this->cache = $cache;
            return $this;
        }


        /**
         * Set the query return type as list or not
         * @param boolean $returnType
         * @return object the current instance
         */
        public function setReturnType($returnType) {
            $this->returnAsList = $returnType;
            return $this;
        }
        
        /**
         * Set the return as array or not
         * @param boolean $status the status if true will return as array
         * @return object the current instance
         */
        public function setReturnAsArray($status = true) {
            $this->returnAsArray = $status;
            return $this;
        }
    	
        /**
         * Get the cache content for this query
         * @see Database::query
         *      
         * @return mixed
         */
        public function getCacheContent() {
            //set some attributes values
            $this->setPropertiesValues();
            if (! $this->canUseCache()) {
                $this->logger->info('The cache is not enabled for this query or is not a SELECT query'); 
                return null;
            }
            $this->setCacheFromSuperInstanceIfNull();
            $this->logger->info('The cache is enabled for this query, try to get result from cache'); 
            $cacheKey = $this->getCacheKey();
            return $this->cache->get($cacheKey);
        }

        /**
         * Save the result of query into cache
         * @param string $key    the cache key
         * @param mixed $result the query result to save
         * @param int $expire the cache TTL
         *
         * @return boolean|null the status of the operation
         */
        public function setCacheContent($result) {
            //set some attributes values
            $this->setPropertiesValues();
            if (! $this->canUseCache()) {
                $this->logger->info('The cache is not enabled for this query or is not a SELECT query'); 
                return null;
            }
            $this->setCacheFromSuperInstanceIfNull();
            $cacheKey = $this->getCacheKey();
            $this->logger->info('Save the result for query [' . $this->query . '] into cache for future use');
            return $this->cache->set($cacheKey, $result, $this->cacheTtl);
        }

        /**
         * Set the cache instance using the super global instance if the current instance is null 
         * and the cache feature is enabled.
         */
        protected function setCacheFromSuperInstanceIfNull() {
            if (!is_object($this->cache)) {
                //can not call method with reference in argument
                //like $this->setCache(& get_instance()->cache);
                //use temporary variable
                $instance = & get_instance()->cache;
                $this->cache = $instance;
            }
        }

        /**
         * Set some properties values to use later
         */
        protected function setPropertiesValues() {
            //If is the SELECT query
            $this->isSelectQuery = stristr($this->query, 'SELECT') !== false;

             //if can use cache feature for this query
            $this->dbCacheStatus = get_config('cache_enable', false) && $this->cacheTtl > 0;
        }
        
        /**
         * Return the cache key for the current query
         * @see Database::query
         * 
         *  @return string
         */
        protected function getCacheKey() {
            return md5($this->query . $this->returnAsList . $this->returnAsArray);
        }

        /**
         * Check whether can use cache feature for the current query
         * @return boolean
         */
        protected function canUseCache() {
            return $this->isSelectQuery && $this->dbCacheStatus;
        }
    }


1			<?php
2			defined('ROOT_PATH') \|\| exit('Access denied');
3			/**
4			* TNH Framework
5			*
6			* A simple PHP framework using HMVC architecture
7			*
8			* This content is released under the MIT License (MIT)
9			*
10			* Copyright (c) 2017 TNH Framework
11			*
12			* Permission is hereby granted, free of charge, to any person obtaining a copy
13			* of this software and associated documentation files (the "Software"), to deal
14			* in the Software without restriction, including without limitation the rights
15			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16			* copies of the Software, and to permit persons to whom the Software is
17			* furnished to do so, subject to the following conditions:
18			*
19			* The above copyright notice and this permission notice shall be included in all
20			* copies or substantial portions of the Software.
21			*
22			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28			* SOFTWARE.
29			*/
30
31			class DatabaseCache extends BaseClass {
32
33			/**
34			* The cache time to live in second. 0 means no need to use the cache feature
35			* @var int
36			*/
37			private $cacheTtl = 0;
38
39			/**
40			* The CacheInterface instance
41			* @var object
42			*/
43			private $cache = null;
44
45			/**
46			* The SQL query statment to get or save the result into cache
47			* @var string
48			*/
49			private $query = null;
50
51			/**
52			* If the current query is the SELECT query
53			* @var boolean
54			*/
55			private $isSelectQuery = false;
56
57			/**
58			* The status of the database cache
59			* @var boolean
60			*/
61			private $dbCacheStatus = false;
62
63			/**
64			* Indicate if we need return result as list
65			* @var boolean
66			*/
67			private $returnAsList = true;
68
69
70			/**
71			* Indicate if we need return result as array or not
72			* @var boolean
73			*/
74			private $returnAsArray = true;
75
76
77			/**
78			* Construct new instance
79			*/
80			public function __construct() {
81			parent::__construct();
82			}
83
84			/**
85			* Return the current query SQL string
86			* @return string
87			*/
88			public function getQuery() {
89			return $this->query;
90			}
91
92			/**
93			* Set the query SQL string
94			* @param string $query the SQL query to set
95			* @return object DatabaseQueryRunner
96			*/
97			public function setQuery($query) {
98			$this->query = $query;
99			return $this;
100			}
101
102			/**
103			* Set database cache time to live
104			* @param integer $ttl the cache time to live in second
105			* @return object the current Database instance
106			*/
107			public function setCacheTtl($ttl = 0) {
108			$this->cacheTtl = $ttl;
109			return $this;
110			}
111
112			/**
113			* Return the cache instance
114			* @return object CacheInterface
115			*/
116			public function getCache() {
117			return $this->cache;
118			}
119
120			/**
121			* Set the cache instance
122			* @param object CacheInterface $cache the cache object
123			* @return object Database
124			*/
125			public function setCache(CacheInterface $cache) {
126			$this->cache = $cache;
127			return $this;
128			}
129
130
131			/**
132			* Set the query return type as list or not
133			* @param boolean $returnType
134			* @return object the current instance
135			*/
136			public function setReturnType($returnType) {
137			$this->returnAsList = $returnType;
138			return $this;
139			}
140
141			/**
142			* Set the return as array or not
143			* @param boolean $status the status if true will return as array
144			* @return object the current instance
145			*/
146			public function setReturnAsArray($status = true) {
147			$this->returnAsArray = $status;
148			return $this;
149			}
150
151			/**
152			* Get the cache content for this query
153			* @see Database::query
154			*
155			* @return mixed
156			*/
157			public function getCacheContent() {
158			//set some attributes values
159			$this->setPropertiesValues();
160			if (! $this->canUseCache()) {
161			$this->logger->info('The cache is not enabled for this query or is not a SELECT query');
162			return null;
163			}
164			$this->setCacheFromSuperInstanceIfNull();
165			$this->logger->info('The cache is enabled for this query, try to get result from cache');
166			$cacheKey = $this->getCacheKey();
167			return $this->cache->get($cacheKey);
168			}
169
170			/**
171			* Save the result of query into cache
172			* @param string $key the cache key
173			* @param mixed $result the query result to save
174			* @param int $expire the cache TTL
175			*
176			* @return boolean\|null the status of the operation
177			*/
178			public function setCacheContent($result) {
179			//set some attributes values
180			$this->setPropertiesValues();
181			if (! $this->canUseCache()) {
182			$this->logger->info('The cache is not enabled for this query or is not a SELECT query');
183			return null;
184			}
185			$this->setCacheFromSuperInstanceIfNull();
186			$cacheKey = $this->getCacheKey();
187			$this->logger->info('Save the result for query [' . $this->query . '] into cache for future use');
188			return $this->cache->set($cacheKey, $result, $this->cacheTtl);
189			}
190
191			/**
192			* Set the cache instance using the super global instance if the current instance is null
193			* and the cache feature is enabled.
194			*/
195			protected function setCacheFromSuperInstanceIfNull() {
196			if (!is_object($this->cache)) {
197			//can not call method with reference in argument
198			//like $this->setCache(& get_instance()->cache);
199			//use temporary variable
200			$instance = & get_instance()->cache;
201			$this->cache = $instance;
202			}
203			}
204
205			/**
206			* Set some properties values to use later
207			*/
208			protected function setPropertiesValues() {
209			//If is the SELECT query
210			$this->isSelectQuery = stristr($this->query, 'SELECT') !== false;
211
212			//if can use cache feature for this query
213			$this->dbCacheStatus = get_config('cache_enable', false) && $this->cacheTtl > 0;
214			}
215
216			/**
217			* Return the cache key for the current query
218			* @see Database::query
219			*
220			* @return string
221			*/
222			protected function getCacheKey() {
223			return md5($this->query . $this->returnAsList . $this->returnAsArray);
224			}
225
226			/**
227			* Check whether can use cache feature for the current query
228			* @return boolean
229			*/
230			protected function canUseCache() {
231			return $this->isSelectQuery && $this->dbCacheStatus;
232			}
233			}
234

tnhfw / tnh-fw

Push — 1.0.0-dev ( 62b9b2...317ddd )

DatabaseCache::setCacheContent() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like