Database::reset() - Code Metrics - Inspection of "add status field in Response class and change stri..." - tnhfw/tnh-fw - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — develop ( fe93c2...a526c9 )

by nguereza

created 2020-11-04 07:15 UTC

Database::reset() A

↳ Parent: Database

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	1

Metric	Value
cc	1
eloc	7
c	1
b	1
f	1
nc	1
nop	0
dl	0
loc	9
rs	10

<?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 Database extends BaseClass {
	
        /**
         * The DatabaseConnection instance
         * @var object
         */
        private $connection = null;
    
        /**
         * The number of rows returned by the last query
         * @var int
         */
        private $numRows = 0;
	
        /**
         * The last insert id for the primary key column that have auto increment or sequence
         * @var mixed
         */
        private $insertId = null;
	
        /**
         * The full SQL query statment after build for each command
         * @var string
         */
        private $query = null;
	
        /**
         * The result returned for the last query
         * @var mixed
         */
        private $result = array();
	
        /**
         * The number of executed query for the current request
         * @var int
         */
        private $queryCount = 0;
	
        /**
         * The default data to be used in the INSERT, UPDATE statments 
         * @var array
         */
        private $data = array();
	
        /**
         * The cache default time to live in second. 0 means no need 
         * to use the cache feature
         * @var int
         */
        private $cacheTtl = 0;

        /**
         * The cache current time to live. 0 means no need 
         * to use the cache feature
         * @var int
         */
        private $temporaryCacheTtl = 0;

        /**
         * The DatabaseQueryBuilder instance
         * @var object
         */
        protected $queryBuilder = null;
    
        /**
         * The DatabaseQueryRunner instance
         * @var object
         */
        protected $queryRunner = null;

        /**
         * The DatabaseCache instance
         * @var object
         */
        protected $cache = null;

        /**
         * Construct new instance
         * 
         * @param object $connection the DatabaseConnection instance
         */
        public function __construct(DatabaseConnection $connection = null) {
            parent::__construct();
    		if ($connection !== null) {
                $this->connection = $connection;
            } 
        }

        /**
         * Get the result of one record rows returned by the current query
         * @param  boolean|string $sqlOrResult if is boolean and true will return the SQL query string.
         * If is string will determine the result type "array" or "object"
         * @return mixed       the query SQL string or the record result
         */
        public function get($sqlOrResult = false) {
            $this->queryBuilder->limit(1);
            $query = $this->getAll(true);
            if ($sqlOrResult === true) {
                return $query;
            } 
            return $this->query($query, false, $sqlOrResult == 'array');
        }

        /**
         * Get the result of record rows list returned by the current query
         * @param  boolean|string $sqlOrResult if is boolean and true will return the SQL query string.
         * If is string will determine the result type "array" or "object"
         * @return mixed       the query SQL string or the record result
         */
        public function getAll($sqlOrResult = false) {
            $query = $this->queryBuilder->getQuery();
            if ($sqlOrResult === true) {
                return $query;
            }
            return $this->query($query, true, $sqlOrResult == 'array');
        }

        /**
         * Insert new record in the database
         * @param  array   $data   the record data if is empty will use the $this->data array.
         * @param  boolean $escape  whether to escape or not the values
         * @return mixed          the insert id of the new record or null
         */
        public function insert($data = array(), $escape = true) {
            if (empty($data) && !empty($this->data)) {
                //as when using $this->setData() may be the data already escaped
                $escape = false;
                $data = $this->data;
            }
            $query = $this->queryBuilder->insert($data, $escape)->getQuery();
            $result = $this->query($query);
            if ($result) {
                $this->setLastInsertId();
                return $this->insertId;
            }
            return false;
        }

        /**
         * Update record in the database
         * @param  array   $data   the record data if is empty will use the $this->data array.
         * @param  boolean $escape  whether to escape or not the values
         * @return mixed          the update status
         */
        public function update($data = array(), $escape = true) {
            if (empty($data) && !empty($this->data)) {
                //as when using $this->setData() may be the data already escaped
                $escape = false;
                $data = $this->data;
            }
            $query = $this->queryBuilder->update($data, $escape)->getQuery();
            return $this->query($query);
        }

        /**
         * Delete the record in database
         * @return mixed the delete status
         */
        public function delete() {
            $query = $this->queryBuilder->delete()->getQuery();
            return $this->query($query);
        }

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

        /**
         * Get database cache time to live
         * @return integer        
         */
        public function getCacheTimeToLive() {
            return $this->cacheTtl;
        }

        /**
         * Get database current cache time to live
         * @return integer        
         */
        public function getTempCacheTimeToLive() {
            return $this->temporaryCacheTtl;
        }
	
        /**
         * Enabled cache temporary for the current query not globally   
         * @param  integer $ttl the cache time to live in second
         * @return object        the current instance
         */
        public function cached($ttl = 0) {
            $this->temporaryCacheTtl = $ttl;
            return $this;
        }

        /**
         * Return the number query executed count for the current request
         * @return int
         */
        public function queryCount() {
            return $this->queryCount;
        }

        /**
         * Return the current query SQL string
         * @return string
         */
        public function getQuery() {
            return $this->query;
        }

        /**
         * Return the DatabaseConnection instance
         * @return object DatabaseConnection
         */
        public function getConnection() {
            return $this->connection;
        }

        /**
         * Set the DatabaseConnection instance
         * @param object DatabaseConnection $connection the DatabaseConnection object
         *
         * @return object the current instance
         */
        public function setConnection(DatabaseConnection $connection = null) {
            $this->connection = $connection;
            return $this;
        }

        /**
         * Return the DatabaseQueryBuilder instance
         * @return object DatabaseQueryBuilder
         */
        public function getQueryBuilder() {
            return $this->queryBuilder;
        }

        /**
         * Set the DatabaseQueryBuilder instance
         * @param object DatabaseQueryBuilder $queryBuilder the DatabaseQueryBuilder object
         */
        public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder = null) {
            $this->queryBuilder = $queryBuilder;
            return $this;
        }

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

        /**
         * Set the DatabaseCache instance
         * @param object DatabaseCache $cache the DatabaseCache object
         */
        public function setCache(DatabaseCache $cache = null) {
            $this->cache = $cache;
            return $this;
        }
    
        /**
         * Return the DatabaseQueryRunner instance
         * @return object DatabaseQueryRunner
         */
        public function getQueryRunner() {
            return $this->queryRunner;
        }

        /**
         * Set the DatabaseQueryRunner instance
         * @param object DatabaseQueryRunner $queryRunner the DatabaseQueryRunner object
         */
        public function setQueryRunner(DatabaseQueryRunner $queryRunner = null) {
            $this->queryRunner = $queryRunner;
            return $this;
        }

        /**
         * Return the data to be used for insert, update, etc.
         * @return array
         */
        public function getData() {
            return $this->data;
        }

        /**
         * Set the data to be used for insert, update, etc.
         * @param string|array $key the data key identified
         * @param mixed $value the data value
         * @param boolean $escape whether to escape or not the $value
         * @return object        the current Database instance
         */
        public function setData($key, $value = null, $escape = true) {
            if (is_array($key)) {
                foreach ($key as $k => $v) {
                    $this->setData($k, $v, $escape);
                }	
            } else {
                $this->data[$key] = $this->connection->escape($value, $escape);
            }
            return $this;
        }

        /**
         * Return the number of rows returned by the current query
         * @return int
         */
        public function numRows() {
            return $this->numRows;
        }

        /**
         * Return the last insert id value
         * @return mixed
         */
        public function insertId() {
            return $this->insertId;
        }

        /**
         * Execute an SQL query
         * @param  string  $query the query SQL string
         * @param  boolean $returnAsList  indicate whether to return all record or just one row 
         * @param  boolean $returnAsArray return the result as array or not
         * @return mixed         the query result
         */
        public function query($query, $returnAsList = true, $returnAsArray = false) {
            $this->reset();
            $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
            $this->logger->info('Execute SQL query [' . $this->query . ']');

            $cacheExpire = $this->temporaryCacheTtl;

            //return to the initial cache time
            $this->temporaryCacheTtl = $this->cacheTtl;

            //the database cache content
            $cacheContent = $this->cache->setQuery($query)
                                        ->setReturnType($returnAsList)
                                        ->setReturnAsArray($returnAsArray)
                                        ->setCacheTtl($cacheExpire)
                                        ->getCacheContent();
            if (!$cacheContent) {
                $this->logger->info('No cache data found for this query or is not a SELECT query, get result from real database');
                //count the number of query execution to server
                $this->queryCount++;
                
                $queryResult = $this->queryRunner->setQuery($query)
                                                 ->setReturnType($returnAsList)
                                                 ->setReturnAsArray($returnAsArray)
                                                 ->execute();

                if (is_object($queryResult)) {
                    $this->result  = $queryResult->getResult();
                    $this->numRows = $queryResult->getNumRows();
                    //save the result into cache
                    $this->cache->setCacheContent($this->result);
                }
            } else {
                $this->logger->info('The result for query [' . $this->query . '] already cached use it');
                $this->result = $cacheContent;
                $this->numRows = count($this->result); //TODO check if is_array before use count
            }
            return $this->result;
        }

        /**
         * Set the last insert id value
         *
         * @return object the current instance
         */
        protected function setLastInsertId() {
            $id = $this->connection->getPdo()->lastInsertId();
            //if the table doesn't have the auto increment field or sequence,
            // the value of 0 will be returned 
            if (!$id) {
                $id = true;
            }
            $this->insertId = $id;
            return $this;
        }

        /**
         * Reset the database class attributs to the initial values before each query.
         */
        protected function reset() {
            //query builder reset
            $this->queryBuilder->reset();
            $this->numRows    = 0;
            $this->insertId   = null;
            $this->query      = null;
            $this->result     = array();
            $this->data       = array();
            $this->queryCount = 0;
        }
    }


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 Database extends BaseClass {
32
33			/**
34			* The DatabaseConnection instance
35			* @var object
36			*/
37			private $connection = null;
38
39			/**
40			* The number of rows returned by the last query
41			* @var int
42			*/
43			private $numRows = 0;
44
45			/**
46			* The last insert id for the primary key column that have auto increment or sequence
47			* @var mixed
48			*/
49			private $insertId = null;
50
51			/**
52			* The full SQL query statment after build for each command
53			* @var string
54			*/
55			private $query = null;
56
57			/**
58			* The result returned for the last query
59			* @var mixed
60			*/
61			private $result = array();
62
63			/**
64			* The number of executed query for the current request
65			* @var int
66			*/
67			private $queryCount = 0;
68
69			/**
70			* The default data to be used in the INSERT, UPDATE statments
71			* @var array
72			*/
73			private $data = array();
74
75			/**
76			* The cache default time to live in second. 0 means no need
77			* to use the cache feature
78			* @var int
79			*/
80			private $cacheTtl = 0;
81
82			/**
83			* The cache current time to live. 0 means no need
84			* to use the cache feature
85			* @var int
86			*/
87			private $temporaryCacheTtl = 0;
88
89			/**
90			* The DatabaseQueryBuilder instance
91			* @var object
92			*/
93			protected $queryBuilder = null;
94
95			/**
96			* The DatabaseQueryRunner instance
97			* @var object
98			*/
99			protected $queryRunner = null;
100
101			/**
102			* The DatabaseCache instance
103			* @var object
104			*/
105			protected $cache = null;
106
107			/**
108			* Construct new instance
109			*
110			* @param object $connection the DatabaseConnection instance
111			*/
112			public function __construct(DatabaseConnection $connection = null) {
113			parent::__construct();
114			if ($connection !== null) {
115			$this->connection = $connection;
116			}
117			}
118
119			/**
120			* Get the result of one record rows returned by the current query
121			* @param boolean\|string $sqlOrResult if is boolean and true will return the SQL query string.
122			* If is string will determine the result type "array" or "object"
123			* @return mixed the query SQL string or the record result
124			*/
125			public function get($sqlOrResult = false) {
126			$this->queryBuilder->limit(1);
127			$query = $this->getAll(true);
128			if ($sqlOrResult === true) {
129			return $query;
130			}
131			return $this->query($query, false, $sqlOrResult == 'array');
132			}
133
134			/**
135			* Get the result of record rows list returned by the current query
136			* @param boolean\|string $sqlOrResult if is boolean and true will return the SQL query string.
137			* If is string will determine the result type "array" or "object"
138			* @return mixed the query SQL string or the record result
139			*/
140			public function getAll($sqlOrResult = false) {
141			$query = $this->queryBuilder->getQuery();
142			if ($sqlOrResult === true) {
143			return $query;
144			}
145			return $this->query($query, true, $sqlOrResult == 'array');
146			}
147
148			/**
149			* Insert new record in the database
150			* @param array $data the record data if is empty will use the $this->data array.
151			* @param boolean $escape whether to escape or not the values
152			* @return mixed the insert id of the new record or null
153			*/
154			public function insert($data = array(), $escape = true) {
155			if (empty($data) && !empty($this->data)) {
156			//as when using $this->setData() may be the data already escaped
157			$escape = false;
158			$data = $this->data;
159			}
160			$query = $this->queryBuilder->insert($data, $escape)->getQuery();
161			$result = $this->query($query);
162			if ($result) {
163			$this->setLastInsertId();
164			return $this->insertId;
165			}
166			return false;
167			}
168
169			/**
170			* Update record in the database
171			* @param array $data the record data if is empty will use the $this->data array.
172			* @param boolean $escape whether to escape or not the values
173			* @return mixed the update status
174			*/
175			public function update($data = array(), $escape = true) {
176			if (empty($data) && !empty($this->data)) {
177			//as when using $this->setData() may be the data already escaped
178			$escape = false;
179			$data = $this->data;
180			}
181			$query = $this->queryBuilder->update($data, $escape)->getQuery();
182			return $this->query($query);
183			}
184
185			/**
186			* Delete the record in database
187			* @return mixed the delete status
188			*/
189			public function delete() {
190			$query = $this->queryBuilder->delete()->getQuery();
191			return $this->query($query);
192			}
193
194			/**
195			* Set database cache time to live
196			* @param integer $ttl the cache time to live in second
197			* @return object the current instance
198			*/
199			public function setCacheTimeToLive($ttl = 0) {
200			$this->cacheTtl = $ttl;
201			$this->temporaryCacheTtl = $ttl;
202			return $this;
203			}
204
205			/**
206			* Get database cache time to live
207			* @return integer
208			*/
209			public function getCacheTimeToLive() {
210			return $this->cacheTtl;
211			}
212
213			/**
214			* Get database current cache time to live
215			* @return integer
216			*/
217			public function getTempCacheTimeToLive() {
218			return $this->temporaryCacheTtl;
219			}
220
221			/**
222			* Enabled cache temporary for the current query not globally
223			* @param integer $ttl the cache time to live in second
224			* @return object the current instance
225			*/
226			public function cached($ttl = 0) {
227			$this->temporaryCacheTtl = $ttl;
228			return $this;
229			}
230
231			/**
232			* Return the number query executed count for the current request
233			* @return int
234			*/
235			public function queryCount() {
236			return $this->queryCount;
237			}
238
239			/**
240			* Return the current query SQL string
241			* @return string
242			*/
243			public function getQuery() {
244			return $this->query;
245			}
246
247			/**
248			* Return the DatabaseConnection instance
249			* @return object DatabaseConnection
250			*/
251			public function getConnection() {
252			return $this->connection;
253			}
254
255			/**
256			* Set the DatabaseConnection instance
257			* @param object DatabaseConnection $connection the DatabaseConnection object
258			*
259			* @return object the current instance
260			*/
261			public function setConnection(DatabaseConnection $connection = null) {
262			$this->connection = $connection;
263			return $this;
264			}
265
266			/**
267			* Return the DatabaseQueryBuilder instance
268			* @return object DatabaseQueryBuilder
269			*/
270			public function getQueryBuilder() {
271			return $this->queryBuilder;
272			}
273
274			/**
275			* Set the DatabaseQueryBuilder instance
276			* @param object DatabaseQueryBuilder $queryBuilder the DatabaseQueryBuilder object
277			*/
278			public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder = null) {
279			$this->queryBuilder = $queryBuilder;
280			return $this;
281			}
282
283			/**
284			* Return the DatabaseCache instance
285			* @return object DatabaseCache
286			*/
287			public function getCache() {
288			return $this->cache;
289			}
290
291			/**
292			* Set the DatabaseCache instance
293			* @param object DatabaseCache $cache the DatabaseCache object
294			*/
295			public function setCache(DatabaseCache $cache = null) {
296			$this->cache = $cache;
297			return $this;
298			}
299
300			/**
301			* Return the DatabaseQueryRunner instance
302			* @return object DatabaseQueryRunner
303			*/
304			public function getQueryRunner() {
305			return $this->queryRunner;
306			}
307
308			/**
309			* Set the DatabaseQueryRunner instance
310			* @param object DatabaseQueryRunner $queryRunner the DatabaseQueryRunner object
311			*/
312			public function setQueryRunner(DatabaseQueryRunner $queryRunner = null) {
313			$this->queryRunner = $queryRunner;
314			return $this;
315			}
316
317			/**
318			* Return the data to be used for insert, update, etc.
319			* @return array
320			*/
321			public function getData() {
322			return $this->data;
323			}
324
325			/**
326			* Set the data to be used for insert, update, etc.
327			* @param string\|array $key the data key identified
328			* @param mixed $value the data value
329			* @param boolean $escape whether to escape or not the $value
330			* @return object the current Database instance
331			*/
332			public function setData($key, $value = null, $escape = true) {
333			if (is_array($key)) {
334			foreach ($key as $k => $v) {
335			$this->setData($k, $v, $escape);
336			}
337			} else {
338			$this->data[$key] = $this->connection->escape($value, $escape);
339			}
340			return $this;
341			}
342
343			/**
344			* Return the number of rows returned by the current query
345			* @return int
346			*/
347			public function numRows() {
348			return $this->numRows;
349			}
350
351			/**
352			* Return the last insert id value
353			* @return mixed
354			*/
355			public function insertId() {
356			return $this->insertId;
357			}
358
359			/**
360			* Execute an SQL query
361			* @param string $query the query SQL string
362			* @param boolean $returnAsList indicate whether to return all record or just one row
363			* @param boolean $returnAsArray return the result as array or not
364			* @return mixed the query result
365			*/
366			public function query($query, $returnAsList = true, $returnAsArray = false) {
367			$this->reset();
368			$this->query = preg_replace('/\s\s+\|\t\t+/', ' ', trim($query));
369			$this->logger->info('Execute SQL query [' . $this->query . ']');
370
371			$cacheExpire = $this->temporaryCacheTtl;
372
373			//return to the initial cache time
374			$this->temporaryCacheTtl = $this->cacheTtl;
375
376			//the database cache content
377			$cacheContent = $this->cache->setQuery($query)
378			->setReturnType($returnAsList)
379			->setReturnAsArray($returnAsArray)
380			->setCacheTtl($cacheExpire)
381			->getCacheContent();
382			if (!$cacheContent) {
383			$this->logger->info('No cache data found for this query or is not a SELECT query, get result from real database');
384			//count the number of query execution to server
385			$this->queryCount++;
386
387			$queryResult = $this->queryRunner->setQuery($query)
388			->setReturnType($returnAsList)
389			->setReturnAsArray($returnAsArray)
390			->execute();
391
392			if (is_object($queryResult)) {
393			$this->result = $queryResult->getResult();
394			$this->numRows = $queryResult->getNumRows();
395			//save the result into cache
396			$this->cache->setCacheContent($this->result);
397			}
398			} else {
399			$this->logger->info('The result for query [' . $this->query . '] already cached use it');
400			$this->result = $cacheContent;
401			$this->numRows = count($this->result); //TODO check if is_array before use count
402			}
403			return $this->result;
404			}
405
406			/**
407			* Set the last insert id value
408			*
409			* @return object the current instance
410			*/
411			protected function setLastInsertId() {
412			$id = $this->connection->getPdo()->lastInsertId();
413			//if the table doesn't have the auto increment field or sequence,
414			// the value of 0 will be returned
415			if (!$id) {
416			$id = true;
417			}
418			$this->insertId = $id;
419			return $this;
420			}
421
422			/**
423			* Reset the database class attributs to the initial values before each query.
424			*/
425			protected function reset() {
426			//query builder reset
427			$this->queryBuilder->reset();
428			$this->numRows = 0;
429			$this->insertId = null;
430			$this->query = null;
431			$this->result = array();
432			$this->data = array();
433			$this->queryCount = 0;
434			}
435			}
436

tnhfw / tnh-fw

Push — develop ( fe93c2...a526c9 )

Database::reset() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like