Helper - Code Metrics - Inspection of "[*]: update the changelog" - voku/simple-mysqli - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 06bfdf...e10040 )

by Lars

created 2019-02-24 01:10 UTC

Helper F

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	459
Duplicated Lines	28.1 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

84.88%

Importance

Changes

Metric	Value
wmc	65
lcom	1
cbo	5
dl	129
loc	459
ccs	146
cts	172
cp	0.8488
rs	3.2
c	0
b	0
f	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	generateCacheKey()	0	16	1
A	optimizeTables()	19	19	5
A	repairTables()	19	19	5
A	isMysqlndIsUsed()	0	14	3
B	isUtf8mb4Supported()	0	41	7
A	get_mysql_client_version()	24	24	5
A	get_mysql_server_version()	24	24	5
B	getDbFields()	6	45	9
C	copyTableRow()	6	74	10
D	phoneticSearch()	31	83	15

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Helper often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Helper, and based on these observations, apply Extract Interface, too.

<?php

declare(strict_types=1);

namespace voku\db;

use voku\cache\Cache;
use voku\helper\Phonetic;

/**
 * Helper: This class can handle extra functions that use the "Simple-MySQLi"-classes.
 */
class Helper
{
    /**
     * @param DB $dbConnection
     *
     * @return string
     */
    private static function generateCacheKey(DB $dbConnection): string
    {
        // init
        $configTmp = [];

        $configOrig = $dbConnection->getConfig();
        \array_walk_recursive(
            $configOrig,
            static function ($k, $v) use (&$configTmp) {
                $configTmp[] = $v;
                $configTmp[] = $k;
            }
        );

        return \implode('--', $configTmp);
    }

    /**
     * Optimize tables
     *
     * @param array   $tables       database table names
     * @param DB|null $dbConnection <p>Use <strong>null</strong> to get your first singleton instance.</p>
     *
     * @return int
     */
    public static function optimizeTables(array $tables = [], DB $dbConnection = null): int

    {
        if ($dbConnection === null) {
            $dbConnection = DB::getInstance();
        }

        $optimized = 0;
        if (!empty($tables)) {
            foreach ($tables as $table) {
                $optimize = 'OPTIMIZE TABLE ' . $dbConnection->quote_string($table);
                $result = $dbConnection->query($optimize);
                if ($result) {
                    $optimized++;
                }
            }
        }

        return $optimized;
    }

    /**
     * Repair tables
     *
     * @param array   $tables       database table names
     * @param DB|null $dbConnection <p>Use <strong>null</strong> to get your first singleton instance.</p>
     *
     * @return int
     */
    public static function repairTables(array $tables = [], DB $dbConnection = null): int

    {
        if ($dbConnection === null) {
            $dbConnection = DB::getInstance();
        }

        $optimized = 0;
        if (!empty($tables)) {
            foreach ($tables as $table) {
                $optimize = 'REPAIR TABLE ' . $dbConnection->quote_string($table);
                $result = $dbConnection->query($optimize);
                if ($result) {
                    $optimized++;
                }
            }
        }

        return $optimized;
    }

    /**
     * Check if "mysqlnd"-driver is used.
     *
     * @return bool
     */
    public static function isMysqlndIsUsed(): bool
    {
        static $_mysqlnd_is_used = null;

        if ($_mysqlnd_is_used === null) {
            $_mysqlnd_is_used = (
                \extension_loaded('mysqlnd')
                &&
                \function_exists('mysqli_fetch_all')
            );
        }

        return $_mysqlnd_is_used;
    }

    /**
     * Check if the current environment supports "utf8mb4".
     *
     * @param DB $dbConnection
     *
     * @return bool
     */
    public static function isUtf8mb4Supported(DB $dbConnection = null): bool
    {
        /**
         *  https://make.wordpress.org/core/2015/04/02/the-utf8mb4-upgrade/
         *
         * - You’re currently using the utf8 character set.
         * - Your MySQL server is version 5.5.3 or higher (including all 10.x versions of MariaDB).
         * - Your MySQL client libraries are version 5.5.3 or higher. If you’re using mysqlnd, 5.0.9 or higher.
         *
         * INFO: utf8mb4 is 100% backwards compatible with utf8.
         */
        if ($dbConnection === null) {
            $dbConnection = DB::getInstance();
        }

        $server_version = self::get_mysql_server_version($dbConnection);
        $client_version = self::get_mysql_client_version($dbConnection);

        if (
            $server_version >= 50503
            &&
            (
                (
                    self::isMysqlndIsUsed()
                    &&
                    $client_version >= 50009
                )
                ||
                (
                    !self::isMysqlndIsUsed()
                    &&
                    $client_version >= 50503
                )
            )

        ) {
            return true;
        }

        return false;
    }

    /**
     * A phonetic search algorithms for different languages.
     *
     * INFO: if you need better performance, please save the "voku\helper\Phonetic"-output into the DB and search for it
     *
     * @param string      $searchString
     * @param string      $searchFieldName
     * @param string      $idFieldName
     * @param string      $language     <p>en, de, fr</p>
     * @param string      $table
     * @param array       $whereArray
     * @param DB|null     $dbConnection <p>use <strong>null</strong> if you will use the current database-connection</p>
     * @param string|null $databaseName <p>use <strong>null</strong> if you will use the current database</p>
     * @param bool        $useCache     use cache?
     * @param int         $cacheTTL     cache-ttl in seconds
     *
     * @return array
     */
    public static function phoneticSearch(string $searchString, string $searchFieldName, string $idFieldName = null, string $language = 'de', string $table = '', array $whereArray = null, DB $dbConnection = null, string $databaseName = null, bool $useCache = false, int $cacheTTL = 3600): array
    {
        // init
        $cacheKey = null;

        if ($dbConnection === null) {
            $dbConnection = DB::getInstance();
        }

        if ($table === '') {
            $debug = new Debug($dbConnection);
            $debug->displayError('Invalid table name, table name in empty.', false);

            return [];
        }

        if ($idFieldName === null) {
            $idFieldName = 'id';
        }

        $whereSQL = $dbConnection->_parseArrayPair($whereArray, 'AND');

        if ($whereSQL) {
            $whereSQL = 'AND ' . $whereSQL;
        }

        if ($databaseName) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $databaseName = $dbConnection->quote_string(\trim($databaseName)) . '.';
        }

        // get the row
        $query = 'SELECT ' . $dbConnection->quote_string($searchFieldName) . ', ' . $dbConnection->quote_string($idFieldName) . ' 
          FROM ' . $databaseName . $dbConnection->quote_string($table) . '
          WHERE 1 = 1
          ' . $whereSQL . '
        ';

        if ($useCache) {
            $cache = new Cache(null, null, false, $useCache);
            $cacheKey = 'sql-phonetic-search-' . \md5($query);

            if (
                $cache->getCacheIsReady()
                &&
                $cache->existsItem($cacheKey)
            ) {
                return $cache->getItem($cacheKey);
            }
        } else {
            $cache = false;
        }

        $result = $dbConnection->query($query);

        // make sure the row exists
        if ($result->num_rows <= 0) {
            return [];
        }

        $dataToSearchIn = [];
        /** @noinspection LoopWhichDoesNotLoopInspection */
        /** @noinspection PhpAssignmentInConditionInspection */
        while ($tmpArray = $result->fetchArray()) {
            $dataToSearchIn[$tmpArray[$idFieldName]] = $tmpArray[$searchFieldName];
        }

        $phonetic = new Phonetic($language);
        $return = $phonetic->phonetic_matches($searchString, $dataToSearchIn);

        // save into the cache
        if (
            $cacheKey !== null
            &&
            $useCache
            &&
            $cache instanceof Cache
            &&
            $cache->getCacheIsReady()
        ) {
            $cache->setItem($cacheKey, $return, $cacheTTL);
        }

        return $return;
    }

    /**
     * A string that represents the MySQL client library version.
     *
     * @param DB $dbConnection
     *
     * @return string
     */
    public static function get_mysql_client_version(DB $dbConnection = null): string

    {
        static $MYSQL_CLIENT_VERSION_CACHE = [];

        if ($dbConnection === null) {
            $dbConnection = DB::getInstance();
        }

        $cacheKey = self::generateCacheKey($dbConnection);

        if (isset($MYSQL_CLIENT_VERSION_CACHE[$cacheKey])) {
            return $MYSQL_CLIENT_VERSION_CACHE[$cacheKey];
        }

        $doctrineConnection = $dbConnection->getDoctrineConnection();
        if ($doctrineConnection) {
            $doctrineWrappedConnection = $doctrineConnection->getWrappedConnection();
            if ($doctrineWrappedConnection instanceof \Doctrine\DBAL\Driver\PDOConnection) {
                return $MYSQL_CLIENT_VERSION_CACHE[$cacheKey] = '';
            }
        }

        return $MYSQL_CLIENT_VERSION_CACHE[$cacheKey] = (string) \mysqli_get_client_version($dbConnection->getLink());
    }

    /**
     * Returns a string representing the version of the MySQL server that the MySQLi extension is connected to.
     *
     * @param DB $dbConnection
     *
     * @return string
     */
    public static function get_mysql_server_version(DB $dbConnection = null): string

    {
        static $MYSQL_SERVER_VERSION_CACHE = [];

        if ($dbConnection === null) {
            $dbConnection = DB::getInstance();
        }

        $cacheKey = self::generateCacheKey($dbConnection);

        if (isset($MYSQL_SERVER_VERSION_CACHE[$cacheKey])) {
            return $MYSQL_SERVER_VERSION_CACHE[$cacheKey];
        }

        $doctrineConnection = $dbConnection->getDoctrineConnection();
        if ($doctrineConnection) {
            $doctrineWrappedConnection = $doctrineConnection->getWrappedConnection();
            if ($doctrineWrappedConnection instanceof \Doctrine\DBAL\Driver\PDOConnection) {
                return $MYSQL_SERVER_VERSION_CACHE[$cacheKey] = (string) $doctrineWrappedConnection->getServerVersion();
            }
        }

        return $MYSQL_SERVER_VERSION_CACHE[$cacheKey] = (string) \mysqli_get_server_version($dbConnection->getLink());
    }

    /**
     * Return all db-fields from a table.
     *
     * @param string      $table
     * @param bool        $useStaticCache
     * @param DB|null     $dbConnection <p>use <strong>null</strong> if you will use the current database-connection</p>
     * @param string|null $databaseName <p>use <strong>null</strong> if you will use the current database</p>
     *
     * @return array
     */
    public static function getDbFields(string $table, bool $useStaticCache = true, DB $dbConnection = null, string $databaseName = null): array
    {
        static $DB_FIELDS_CACHE = [];

        // use the static cache
        if (
            $useStaticCache
            &&
            isset($DB_FIELDS_CACHE[$table])
        ) {
            return $DB_FIELDS_CACHE[$table];
        }

        // init
        $dbFields = [];

        if ($dbConnection === null) {
            $dbConnection = DB::getInstance();
        }

        if ($table === '') {
            $debug = new Debug($dbConnection);
            $debug->displayError('Invalid table name, table name in empty.', false);

            return [];
        }

        if ($databaseName) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $databaseName = $dbConnection->quote_string(\trim($databaseName)) . '.';
        }

        $sql = 'SHOW COLUMNS FROM ' . $databaseName . $dbConnection->escape($table);
        $result = $dbConnection->query($sql);

        if ($result && $result->num_rows > 0) {
            foreach ($result->fetchAllArray() as $tmpResult) {
                $dbFields[] = $tmpResult['Field'];
            }
        }

        // add to static cache
        $DB_FIELDS_CACHE[$table] = $dbFields;

        return $dbFields;
    }

    /**
     * Copy row within a DB table and making updates to the columns.
     *
     * @param string      $table
     * @param array       $whereArray
     * @param array       $updateArray
     * @param array       $ignoreArray
     * @param DB|null     $dbConnection <p>Use <strong>null</strong> to get your first singleton instance.</p>
     * @param string|null $databaseName <p>use <strong>null</strong> if you will use the current database</p>
     *
     * @return bool|int "int" (insert_id) by "<b>INSERT / REPLACE</b>"-queries<br />
     *                   "false" on error
     */
    public static function copyTableRow(string $table, array $whereArray, array $updateArray = [], array $ignoreArray = [], DB $dbConnection = null, string $databaseName = null)
    {
        // init
        $table = \trim($table);

        if ($dbConnection === null) {
            $dbConnection = DB::getInstance();
        }

        if ($table === '') {
            $debug = new Debug($dbConnection);
            $debug->displayError('Invalid table name, table name in empty.', false);

            return false;
        }

        $whereSQL = $dbConnection->_parseArrayPair($whereArray, 'AND');
        if ($whereSQL) {
            $whereSQL = 'AND ' . $whereSQL;
        }

        if ($databaseName) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $databaseName = $dbConnection->quote_string(\trim($databaseName)) . '.';
        }

        // get the row
        $query = 'SELECT * FROM ' . $databaseName . $dbConnection->quote_string($table) . '
          WHERE 1 = 1
          ' . $whereSQL . '
        ';
        $result = $dbConnection->query($query);

        // make sure the row exists
        if ($result->num_rows > 0) {

            /** @noinspection LoopWhichDoesNotLoopInspection */
            /** @noinspection PhpAssignmentInConditionInspection */
            while ($tmpArray = $result->fetchArray()) {

                // re-build a new DB query and ignore some field-names
                $bindings = [];
                $insert_keys = '';
                $insert_values = '';

                foreach ($tmpArray as $fieldName => $value) {
                    if (!\in_array($fieldName, $ignoreArray, true)) {
                        if (\array_key_exists($fieldName, $updateArray)) {
                            $insert_keys .= ',' . $fieldName;
                            $insert_values .= ',?';
                            $bindings[] = $updateArray[$fieldName]; // INFO: do not escape non selected data
                        } else {
                            $insert_keys .= ',' . $fieldName;
                            $insert_values .= ',?';
                            $bindings[] = $value; // INFO: do not escape non selected data
                        }
                    }
                }

                $insert_keys = \ltrim($insert_keys, ',');
                $insert_values = \ltrim($insert_values, ',');

                // insert the "copied" row
                $new_query = 'INSERT INTO ' . $databaseName . $dbConnection->quote_string($table) . ' 
                  (' . $insert_keys . ')
                  VALUES 
                  (' . $insert_values . ')
                ';

                return $dbConnection->query($new_query, $bindings);
            }
        }

        return false;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace voku\db;
6
7			use voku\cache\Cache;
8			use voku\helper\Phonetic;
9
10			/**
11			* Helper: This class can handle extra functions that use the "Simple-MySQLi"-classes.
12			*/
13			class Helper
14			{
15			/**
16			* @param DB $dbConnection
17			*
18			* @return string
19			*/
20	8		private static function generateCacheKey(DB $dbConnection): string
21			{
22			// init
23	8		$configTmp = [];
24
25	8		$configOrig = $dbConnection->getConfig();
26	8		\array_walk_recursive(
27	8		$configOrig,
28			static function ($k, $v) use (&$configTmp) {
29	8		$configTmp[] = $v;
30	8		$configTmp[] = $k;
31	8		}
32			);
33
34	8		return \implode('--', $configTmp);
35			}
36
37			/**
38			* Optimize tables
39			*
40			* @param array $tables database table names
41			* @param DB\|null $dbConnection <p>Use <strong>null</strong> to get your first singleton instance.</p>
42			*
43			* @return int
44			*/
45	1	View Code Duplication	public static function optimizeTables(array $tables = [], DB $dbConnection = null): int
			0 ignored issues – show Duplication introduced 2017-09-02 21:09 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
46			{
47	1		if ($dbConnection === null) {
48	1		$dbConnection = DB::getInstance();
49			}
50
51	1		$optimized = 0;
52	1		if (!empty($tables)) {
53	1		foreach ($tables as $table) {
54	1		$optimize = 'OPTIMIZE TABLE ' . $dbConnection->quote_string($table);
55	1		$result = $dbConnection->query($optimize);
56	1		if ($result) {
57	1		$optimized++;
58			}
59			}
60			}
61
62	1		return $optimized;
63			}
64
65			/**
66			* Repair tables
67			*
68			* @param array $tables database table names
69			* @param DB\|null $dbConnection <p>Use <strong>null</strong> to get your first singleton instance.</p>
70			*
71			* @return int
72			*/
73	1	View Code Duplication	public static function repairTables(array $tables = [], DB $dbConnection = null): int
			0 ignored issues – show Duplication introduced 2017-09-02 21:09 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
74			{
75	1		if ($dbConnection === null) {
76	1		$dbConnection = DB::getInstance();
77			}
78
79	1		$optimized = 0;
80	1		if (!empty($tables)) {
81	1		foreach ($tables as $table) {
82	1		$optimize = 'REPAIR TABLE ' . $dbConnection->quote_string($table);
83	1		$result = $dbConnection->query($optimize);
84	1		if ($result) {
85	1		$optimized++;
86			}
87			}
88			}
89
90	1		return $optimized;
91			}
92
93			/**
94			* Check if "mysqlnd"-driver is used.
95			*
96			* @return bool
97			*/
98	91		public static function isMysqlndIsUsed(): bool
99			{
100	91		static $_mysqlnd_is_used = null;
101
102	91		if ($_mysqlnd_is_used === null) {
103			$_mysqlnd_is_used = (
104	1		\extension_loaded('mysqlnd')
105			&&
106	1		\function_exists('mysqli_fetch_all')
107			);
108			}
109
110	91		return $_mysqlnd_is_used;
111			}
112
113			/**
114			* Check if the current environment supports "utf8mb4".
115			*
116			* @param DB $dbConnection
117			*
118			* @return bool
119			*/
120	8		public static function isUtf8mb4Supported(DB $dbConnection = null): bool
121			{
122			/**
123			* https://make.wordpress.org/core/2015/04/02/the-utf8mb4-upgrade/
124			*
125			* - You’re currently using the utf8 character set.
126			* - Your MySQL server is version 5.5.3 or higher (including all 10.x versions of MariaDB).
127			* - Your MySQL client libraries are version 5.5.3 or higher. If you’re using mysqlnd, 5.0.9 or higher.
128			*
129			* INFO: utf8mb4 is 100% backwards compatible with utf8.
130			*/
131	8		if ($dbConnection === null) {
132			$dbConnection = DB::getInstance();
133			}
134
135	8		$server_version = self::get_mysql_server_version($dbConnection);
136	8		$client_version = self::get_mysql_client_version($dbConnection);
137
138			if (
139	8		$server_version >= 50503
140			&&
141			(
142			(
143	8		self::isMysqlndIsUsed()
144			&&
145	8		$client_version >= 50009
146			)
147			\|\|
148			(
149			!self::isMysqlndIsUsed()
150			&&
151	8		$client_version >= 50503
152			)
153			)
154
155			) {
156	8		return true;
157			}
158
159			return false;
160			}
161
162			/**
163			* A phonetic search algorithms for different languages.
164			*
165			* INFO: if you need better performance, please save the "voku\helper\Phonetic"-output into the DB and search for it
166			*
167			* @param string $searchString
168			* @param string $searchFieldName
169			* @param string $idFieldName
170			* @param string $language <p>en, de, fr</p>
171			* @param string $table
172			* @param array $whereArray
173			* @param DB\|null $dbConnection <p>use <strong>null</strong> if you will use the current database-connection</p>
174			* @param string\|null $databaseName <p>use <strong>null</strong> if you will use the current database</p>
175			* @param bool $useCache use cache?
176			* @param int $cacheTTL cache-ttl in seconds
177			*
178			* @return array
179			*/
180	2		public static function phoneticSearch(string $searchString, string $searchFieldName, string $idFieldName = null, string $language = 'de', string $table = '', array $whereArray = null, DB $dbConnection = null, string $databaseName = null, bool $useCache = false, int $cacheTTL = 3600): array
181			{
182			// init
183	2		$cacheKey = null;
184
185	2		if ($dbConnection === null) {
186	2		$dbConnection = DB::getInstance();
187			}
188
189	2	View Code Duplication	if ($table === '') {
190			$debug = new Debug($dbConnection);
191			$debug->displayError('Invalid table name, table name in empty.', false);
192
193			return [];
194			}
195
196	2		if ($idFieldName === null) {
197			$idFieldName = 'id';
198			}
199
200	2		$whereSQL = $dbConnection->_parseArrayPair($whereArray, 'AND');
			0 ignored issues – show Bug introduced 2017-04-05 04:06 UTC by Report Bug Copy Issue Report It seems like `$whereArray` defined by parameter `$whereArray` on line 180 can also be of type `null`; however, `voku\db\DB::_parseArrayPair()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
201	2		if ($whereSQL) {
202	2		$whereSQL = 'AND ' . $whereSQL;
203			}
204
205	2		if ($databaseName) {
			0 ignored issues – show Bug Best Practice introduced 2017-04-05 04:06 UTC by Report Bug Copy Issue Report The expression `$databaseName` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
206			$databaseName = $dbConnection->quote_string(\trim($databaseName)) . '.';
207			}
208
209			// get the row
210	2		$query = 'SELECT ' . $dbConnection->quote_string($searchFieldName) . ', ' . $dbConnection->quote_string($idFieldName) . '
211	2		FROM ' . $databaseName . $dbConnection->quote_string($table) . '
212			WHERE 1 = 1
213	2		' . $whereSQL . '
214			';
215
216	2	View Code Duplication	if ($useCache) {
217	1		$cache = new Cache(null, null, false, $useCache);
218	1		$cacheKey = 'sql-phonetic-search-' . \md5($query);
219
220			if (
221	1		$cache->getCacheIsReady()
222			&&
223	1		$cache->existsItem($cacheKey)
224			) {
225	1		return $cache->getItem($cacheKey);
226			}
227			} else {
228	1		$cache = false;
229			}
230
231	2		$result = $dbConnection->query($query);
232
233			// make sure the row exists
234	2		if ($result->num_rows <= 0) {
235			return [];
236			}
237
238	2		$dataToSearchIn = [];
239			/** @noinspection LoopWhichDoesNotLoopInspection */
240			/** @noinspection PhpAssignmentInConditionInspection */
241	2		while ($tmpArray = $result->fetchArray()) {
242	2		$dataToSearchIn[$tmpArray[$idFieldName]] = $tmpArray[$searchFieldName];
243			}
244
245	2		$phonetic = new Phonetic($language);
246	2		$return = $phonetic->phonetic_matches($searchString, $dataToSearchIn);
247
248			// save into the cache
249		View Code Duplication	if (
250	2		$cacheKey !== null
251			&&
252	2		$useCache
253			&&
254	2		$cache instanceof Cache
255			&&
256	2		$cache->getCacheIsReady()
257			) {
258	1		$cache->setItem($cacheKey, $return, $cacheTTL);
259			}
260
261	2		return $return;
262			}
263
264			/**
265			* A string that represents the MySQL client library version.
266			*
267			* @param DB $dbConnection
268			*
269			* @return string
270			*/
271	8	View Code Duplication	public static function get_mysql_client_version(DB $dbConnection = null): string
			0 ignored issues – show Duplication introduced 2017-04-05 04:06 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
272			{
273	8		static $MYSQL_CLIENT_VERSION_CACHE = [];
274
275	8		if ($dbConnection === null) {
276			$dbConnection = DB::getInstance();
277			}
278
279	8		$cacheKey = self::generateCacheKey($dbConnection);
280
281	8		if (isset($MYSQL_CLIENT_VERSION_CACHE[$cacheKey])) {
282	8		return $MYSQL_CLIENT_VERSION_CACHE[$cacheKey];
283			}
284
285	2		$doctrineConnection = $dbConnection->getDoctrineConnection();
286	2		if ($doctrineConnection) {
287			$doctrineWrappedConnection = $doctrineConnection->getWrappedConnection();
288			if ($doctrineWrappedConnection instanceof \Doctrine\DBAL\Driver\PDOConnection) {
289			return $MYSQL_CLIENT_VERSION_CACHE[$cacheKey] = '';
290			}
291			}
292
293	2		return $MYSQL_CLIENT_VERSION_CACHE[$cacheKey] = (string) \mysqli_get_client_version($dbConnection->getLink());
294			}
295
296			/**
297			* Returns a string representing the version of the MySQL server that the MySQLi extension is connected to.
298			*
299			* @param DB $dbConnection
300			*
301			* @return string
302			*/
303	8	View Code Duplication	public static function get_mysql_server_version(DB $dbConnection = null): string
			0 ignored issues – show Duplication introduced 2017-04-05 04:06 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
304			{
305	8		static $MYSQL_SERVER_VERSION_CACHE = [];
306
307	8		if ($dbConnection === null) {
308			$dbConnection = DB::getInstance();
309			}
310
311	8		$cacheKey = self::generateCacheKey($dbConnection);
312
313	8		if (isset($MYSQL_SERVER_VERSION_CACHE[$cacheKey])) {
314	8		return $MYSQL_SERVER_VERSION_CACHE[$cacheKey];
315			}
316
317	2		$doctrineConnection = $dbConnection->getDoctrineConnection();
318	2		if ($doctrineConnection) {
319			$doctrineWrappedConnection = $doctrineConnection->getWrappedConnection();
320			if ($doctrineWrappedConnection instanceof \Doctrine\DBAL\Driver\PDOConnection) {
321			return $MYSQL_SERVER_VERSION_CACHE[$cacheKey] = (string) $doctrineWrappedConnection->getServerVersion();
322			}
323			}
324
325	2		return $MYSQL_SERVER_VERSION_CACHE[$cacheKey] = (string) \mysqli_get_server_version($dbConnection->getLink());
326			}
327
328			/**
329			* Return all db-fields from a table.
330			*
331			* @param string $table
332			* @param bool $useStaticCache
333			* @param DB\|null $dbConnection <p>use <strong>null</strong> if you will use the current database-connection</p>
334			* @param string\|null $databaseName <p>use <strong>null</strong> if you will use the current database</p>
335			*
336			* @return array
337			*/
338	1		public static function getDbFields(string $table, bool $useStaticCache = true, DB $dbConnection = null, string $databaseName = null): array
339			{
340	1		static $DB_FIELDS_CACHE = [];
341
342			// use the static cache
343			if (
344	1		$useStaticCache
345			&&
346	1		isset($DB_FIELDS_CACHE[$table])
347			) {
348	1		return $DB_FIELDS_CACHE[$table];
349			}
350
351			// init
352	1		$dbFields = [];
353
354	1		if ($dbConnection === null) {
355	1		$dbConnection = DB::getInstance();
356			}
357
358	1	View Code Duplication	if ($table === '') {
359			$debug = new Debug($dbConnection);
360			$debug->displayError('Invalid table name, table name in empty.', false);
361
362			return [];
363			}
364
365	1		if ($databaseName) {
			0 ignored issues – show Bug Best Practice introduced 2017-04-03 14:44 UTC by Report Bug Copy Issue Report The expression `$databaseName` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
366			$databaseName = $dbConnection->quote_string(\trim($databaseName)) . '.';
367			}
368
369	1		$sql = 'SHOW COLUMNS FROM ' . $databaseName . $dbConnection->escape($table);
370	1		$result = $dbConnection->query($sql);
371
372	1		if ($result && $result->num_rows > 0) {
373	1		foreach ($result->fetchAllArray() as $tmpResult) {
374	1		$dbFields[] = $tmpResult['Field'];
375			}
376			}
377
378			// add to static cache
379	1		$DB_FIELDS_CACHE[$table] = $dbFields;
380
381	1		return $dbFields;
382			}
383
384			/**
385			* Copy row within a DB table and making updates to the columns.
386			*
387			* @param string $table
388			* @param array $whereArray
389			* @param array $updateArray
390			* @param array $ignoreArray
391			* @param DB\|null $dbConnection <p>Use <strong>null</strong> to get your first singleton instance.</p>
392			* @param string\|null $databaseName <p>use <strong>null</strong> if you will use the current database</p>
393			*
394			* @return bool\|int "int" (insert_id) by "<b>INSERT / REPLACE</b>"-queries<br />
395			* "false" on error
396			*/
397	1		public static function copyTableRow(string $table, array $whereArray, array $updateArray = [], array $ignoreArray = [], DB $dbConnection = null, string $databaseName = null)
398			{
399			// init
400	1		$table = \trim($table);
401
402	1		if ($dbConnection === null) {
403	1		$dbConnection = DB::getInstance();
404			}
405
406	1	View Code Duplication	if ($table === '') {
407			$debug = new Debug($dbConnection);
408			$debug->displayError('Invalid table name, table name in empty.', false);
409
410			return false;
411			}
412
413	1		$whereSQL = $dbConnection->_parseArrayPair($whereArray, 'AND');
414	1		if ($whereSQL) {
415	1		$whereSQL = 'AND ' . $whereSQL;
416			}
417
418	1		if ($databaseName) {
			0 ignored issues – show Bug Best Practice introduced 2017-04-03 14:44 UTC by Report Bug Copy Issue Report The expression `$databaseName` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
419			$databaseName = $dbConnection->quote_string(\trim($databaseName)) . '.';
420			}
421
422			// get the row
423	1		$query = 'SELECT * FROM ' . $databaseName . $dbConnection->quote_string($table) . '
424			WHERE 1 = 1
425	1		' . $whereSQL . '
426			';
427	1		$result = $dbConnection->query($query);
428
429			// make sure the row exists
430	1		if ($result->num_rows > 0) {
431
432			/** @noinspection LoopWhichDoesNotLoopInspection */
433			/** @noinspection PhpAssignmentInConditionInspection */
434	1		while ($tmpArray = $result->fetchArray()) {
435
436			// re-build a new DB query and ignore some field-names
437	1		$bindings = [];
438	1		$insert_keys = '';
439	1		$insert_values = '';
440
441	1		foreach ($tmpArray as $fieldName => $value) {
442	1		if (!\in_array($fieldName, $ignoreArray, true)) {
443	1		if (\array_key_exists($fieldName, $updateArray)) {
444	1		$insert_keys .= ',' . $fieldName;
445	1		$insert_values .= ',?';
446	1		$bindings[] = $updateArray[$fieldName]; // INFO: do not escape non selected data
447			} else {
448	1		$insert_keys .= ',' . $fieldName;
449	1		$insert_values .= ',?';
450	1		$bindings[] = $value; // INFO: do not escape non selected data
451			}
452			}
453			}
454
455	1		$insert_keys = \ltrim($insert_keys, ',');
456	1		$insert_values = \ltrim($insert_values, ',');
457
458			// insert the "copied" row
459	1		$new_query = 'INSERT INTO ' . $databaseName . $dbConnection->quote_string($table) . '
460	1		(' . $insert_keys . ')
461			VALUES
462	1		(' . $insert_values . ')
463			';
464
465	1		return $dbConnection->query($new_query, $bindings);
466			}
467			}
468
469			return false;
470			}
471			}
472

voku / simple-mysqli