MySQLiByDanielGP::setMySQLquery2ServerByPatternLine() - Code Metrics - Inspection of "just internal code re-organization" - danielgp/common-lib - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 137f35...33c4fa )

by Daniel

created 2016-02-06 21:01 UTC

setMySQLquery2ServerByPatternLine() A

↳ Parent: MySQLiByDanielGP

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	12
rs	9.4285
cc	3
eloc	9
nc	3
nop	5

<?php

/**
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Daniel Popiniuc
 *
 * 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.
 *
 */

namespace danielgp\common_lib;

/**
 * Usefull functions to get quick MySQL content
 *
 * @author Daniel Popiniuc
 */
trait MySQLiByDanielGP
{

    use MySQLiByDanielGPnumbers,
        MySQLiMultipleExecution;

    /**
     * Intiates connection to MySQL
     *
     * @param array $mySQLconfig
     *
     * $mySQLconfig           = [
     * 'host'     => MYSQL_HOST,
     * 'port'     => MYSQL_PORT,
     * 'username' => MYSQL_USERNAME,
     * 'password' => MYSQL_PASSWORD,
     * 'database' => MYSQL_DATABASE,
     * ];
     */
    protected function connectToMySql($mySQLconfig)
    {
        if (is_null($this->mySQLconnection)) {
            extract($mySQLconfig);
            $this->mySQLconnection = new \mysqli($host, $username, $password, $database, $port);
            if (is_null($this->mySQLconnection->connect_error)) {
                return '';
            }
            $this->mySQLconnection = null;
            $erNo                  = $this->mySQLconnection->connect_errno;
            $erMsg                 = $this->mySQLconnection->connect_error;
            $msg                   = $this->lclMsgCmn('i18n_Feedback_ConnectionError');
            return sprintf($msg, $erNo, $erMsg, $host, $port, $username, $database);
        }
    }

    /**
     * Provides a detection if given Query does contain a Parameter
     * that may require statement processing later on
     *
     * @param string $sQuery
     * @param string $paramIdentifier
     * @return boolean
     */
    protected function getMySQLqueryWithParameterIdentifier($sQuery, $paramIdentifier)
    {
        $sReturn = true;
        if (strpos($sQuery, $paramIdentifier) === false) {
            $sReturn = false;
        }
        return $sReturn;
    }

    /**
     * Transmit Query to MySQL server and get results back
     *
     * @param string $sQuery
     * @param string $sReturnType
     * @param array $ftrs
     * @return boolean|array|string
     */
    protected function setMySQLquery2Server($sQuery, $sReturnType = null, $ftrs = null)
    {
        if (is_null($sReturnType)) {
            $this->mySQLconnection->query(html_entity_decode($sQuery));
            return '';
        } elseif (is_null($this->mySQLconnection)) {
            return ['customError' => $this->lclMsgCmn('i18n_MySQL_ConnectionNotExisting'), 'result' => null];
        }
        $result = $this->mySQLconnection->query(html_entity_decode($sQuery));
        if ($result) {
            return $this->setMySQLquery2ServerConnected(['Result' => $result, 'RType' => $sReturnType, 'F' => $ftrs]);
        }
        $erM  = [$this->mySQLconnection->errno, $this->mySQLconnection->error];
        $cErr = sprintf($this->lclMsgCmn('i18n_MySQL_QueryError'), $erM[0], $erM[1]);
        return ['customError' => $cErr, 'result' => null];
    }

    /**
     * Turns a raw query result into various structures
     * based on different predefined $parameters['returnType'] value
     *
     * @param array $parameters
     * @return array as ['customError' => '...', 'result' => '...']
     */
    private function setMySQLquery2ServerByPattern($parameters)
    {
        $aReturn = $parameters['return'];
        $vld     = $this->setMySQLqueryValidateInputs($parameters);
        if ($vld[1] !== '') {
            return ['customError' => $vld[1], 'result' => ''];
        } elseif ($parameters['returnType'] == 'value') {
            return ['customError' => $vld[1], 'result' => $parameters['QueryResult']->fetch_row()[0]];
        }
        $counter2 = 0;
        for ($counter = 0; $counter < $parameters['NoOfRows']; $counter++) {
            $line = $parameters['QueryResult']->fetch_row();
            $this->setMySQLquery2ServerByPatternLine($parameters, $line, $counter, $counter2, $aReturn);
            $counter2++;
        }
        return ['customError' => '', 'result' => $aReturn['result']];
    }

    private function setMySQLquery2ServerByPatternKey($parameters, $line, $counter)
    {
        switch ($parameters['returnType']) {
            case 'array_key_value':
                return [$line[0], $line[1]];
            // intentionally left open
            case 'array_key2_value':
                return [$line[0] . '@' . $line[1], $line[1]];
            // intentionally left open
            case 'array_numbered':
                return [$counter, $line[0]];
            // intentionally left open
        }
    }

    private function setMySQLquery2ServerByPatternLine($parameters, $line, $counter, $counter2, &$aReturn)
    {
        if (in_array($parameters['returnType'], ['array_key_value', 'array_key2_value', 'array_numbered'])) {
            $rslt                        = $this->setMySQLquery2ServerByPatternKey($parameters, $line, $counter);
            $aReturn['result'][$rslt[0]] = $rslt[1];
        } elseif ($parameters['returnType'] == 'array_key_value2') {
            $aReturn['result'][$line[0]][] = $line[1];
        } else {
            $finfo = $parameters['QueryResult']->fetch_fields();
            $this->setMySQLquery2ServerByPatternLineAdvanced($parameters, $finfo, $line, $counter2, $aReturn);
        }
    }

    private function setMySQLquery2ServerByPatternLineAdvanced($parameters, $finfo, $line, $counter2, &$aReturn)
    {
        foreach ($finfo as $columnCounter => $value) {
            switch ($parameters['returnType']) {
                case 'array_first_key_rest_values':
                    if ($columnCounter !== 0) {
                        $aReturn['result'][$line[0]][$value->name] = $line[$columnCounter];
                    }
                    break;
                case 'array_pairs_key_value':
                    $aReturn['result'][$value->name]                                   = $line[$columnCounter];
                    break;
                case 'full_array_key_numbered':
                    $aReturn['result'][$counter2][$value->name]                        = $line[$columnCounter];
                    break;
                case 'full_array_key_numbered_with_record_number_prefix':
                    $parameters['prefix']                                              = 'RecordNo';
                // intentionally left open
                case 'full_array_key_numbered_with_prefix':
                    $aReturn['result'][$parameters['prefix']][$counter2][$value->name] = $line[$columnCounter];
                    break;
            }
        }
    }

    private function setMySQLquery2ServerConnected($inArray)
    {
        if ($inArray['RType'] == 'id') {
            return ['customError' => '', 'result' => $this->mySQLconnection->insert_id];
        } elseif ($inArray['RType'] == 'lines') {
            return ['result' => $inArray['Result']->num_rows, 'customError' => ''];
        }
        $parameters = [
            'NoOfColumns' => $inArray['Result']->field_count,
            'NoOfRows'    => $inArray['Result']->num_rows,
            'QueryResult' => $inArray['Result'],
            'returnType'  => $inArray['RType'],
            'return'      => ['customError' => '', 'result' => null]
        ];
        if (substr($inArray['RType'], -6) == 'prefix') {
            $parameters['prefix'] = $inArray['F']['prefix'];
        }
        return $this->setMySQLquery2ServerByPattern($parameters);
    }
}


1			<?php
2
3			/**
4			*
5			* The MIT License (MIT)
6			*
7			* Copyright (c) 2015 Daniel Popiniuc
8			*
9			* Permission is hereby granted, free of charge, to any person obtaining a copy
10			* of this software and associated documentation files (the "Software"), to deal
11			* in the Software without restriction, including without limitation the rights
12			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13			* copies of the Software, and to permit persons to whom the Software is
14			* furnished to do so, subject to the following conditions:
15			*
16			* The above copyright notice and this permission notice shall be included in all
17			* copies or substantial portions of the Software.
18			*
19			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25			* SOFTWARE.
26			*
27			*/
28
29			namespace danielgp\common_lib;
30
31			/**
32			* Usefull functions to get quick MySQL content
33			*
34			* @author Daniel Popiniuc
35			*/
36			trait MySQLiByDanielGP
37			{
38
39			use MySQLiByDanielGPnumbers,
40			MySQLiMultipleExecution;
41
42			/**
43			* Intiates connection to MySQL
44			*
45			* @param array $mySQLconfig
46			*
47			* $mySQLconfig = [
48			* 'host' => MYSQL_HOST,
49			* 'port' => MYSQL_PORT,
50			* 'username' => MYSQL_USERNAME,
51			* 'password' => MYSQL_PASSWORD,
52			* 'database' => MYSQL_DATABASE,
53			* ];
54			*/
55			protected function connectToMySql($mySQLconfig)
56			{
57			if (is_null($this->mySQLconnection)) {
58			extract($mySQLconfig);
59			$this->mySQLconnection = new \mysqli($host, $username, $password, $database, $port);
60			if (is_null($this->mySQLconnection->connect_error)) {
61			return '';
62			}
63			$this->mySQLconnection = null;
64			$erNo = $this->mySQLconnection->connect_errno;
65			$erMsg = $this->mySQLconnection->connect_error;
66			$msg = $this->lclMsgCmn('i18n_Feedback_ConnectionError');
67			return sprintf($msg, $erNo, $erMsg, $host, $port, $username, $database);
68			}
69			}
70
71			/**
72			* Provides a detection if given Query does contain a Parameter
73			* that may require statement processing later on
74			*
75			* @param string $sQuery
76			* @param string $paramIdentifier
77			* @return boolean
78			*/
79			protected function getMySQLqueryWithParameterIdentifier($sQuery, $paramIdentifier)
80			{
81			$sReturn = true;
82			if (strpos($sQuery, $paramIdentifier) === false) {
83			$sReturn = false;
84			}
85			return $sReturn;
86			}
87
88			/**
89			* Transmit Query to MySQL server and get results back
90			*
91			* @param string $sQuery
92			* @param string $sReturnType
93			* @param array $ftrs
94			* @return boolean\|array\|string
95			*/
96			protected function setMySQLquery2Server($sQuery, $sReturnType = null, $ftrs = null)
97			{
98			if (is_null($sReturnType)) {
99			$this->mySQLconnection->query(html_entity_decode($sQuery));
100			return '';
101			} elseif (is_null($this->mySQLconnection)) {
102			return ['customError' => $this->lclMsgCmn('i18n_MySQL_ConnectionNotExisting'), 'result' => null];
103			}
104			$result = $this->mySQLconnection->query(html_entity_decode($sQuery));
105			if ($result) {
106			return $this->setMySQLquery2ServerConnected(['Result' => $result, 'RType' => $sReturnType, 'F' => $ftrs]);
107			}
108			$erM = [$this->mySQLconnection->errno, $this->mySQLconnection->error];
109			$cErr = sprintf($this->lclMsgCmn('i18n_MySQL_QueryError'), $erM[0], $erM[1]);
110			return ['customError' => $cErr, 'result' => null];
111			}
112
113			/**
114			* Turns a raw query result into various structures
115			* based on different predefined $parameters['returnType'] value
116			*
117			* @param array $parameters
118			* @return array as ['customError' => '...', 'result' => '...']
119			*/
120			private function setMySQLquery2ServerByPattern($parameters)
121			{
122			$aReturn = $parameters['return'];
123			$vld = $this->setMySQLqueryValidateInputs($parameters);
124			if ($vld[1] !== '') {
125			return ['customError' => $vld[1], 'result' => ''];
126			} elseif ($parameters['returnType'] == 'value') {
127			return ['customError' => $vld[1], 'result' => $parameters['QueryResult']->fetch_row()[0]];
128			}
129			$counter2 = 0;
130			for ($counter = 0; $counter < $parameters['NoOfRows']; $counter++) {
131			$line = $parameters['QueryResult']->fetch_row();
132			$this->setMySQLquery2ServerByPatternLine($parameters, $line, $counter, $counter2, $aReturn);
133			$counter2++;
134			}
135			return ['customError' => '', 'result' => $aReturn['result']];
136			}
137
138			private function setMySQLquery2ServerByPatternKey($parameters, $line, $counter)
139			{
140			switch ($parameters['returnType']) {
141			case 'array_key_value':
142			return [$line[0], $line[1]];
143			// intentionally left open
144			case 'array_key2_value':
145			return [$line[0] . '@' . $line[1], $line[1]];
146			// intentionally left open
147			case 'array_numbered':
148			return [$counter, $line[0]];
149			// intentionally left open
150			}
151			}
152
153			private function setMySQLquery2ServerByPatternLine($parameters, $line, $counter, $counter2, &$aReturn)
154			{
155			if (in_array($parameters['returnType'], ['array_key_value', 'array_key2_value', 'array_numbered'])) {
156			$rslt = $this->setMySQLquery2ServerByPatternKey($parameters, $line, $counter);
157			$aReturn['result'][$rslt[0]] = $rslt[1];
158			} elseif ($parameters['returnType'] == 'array_key_value2') {
159			$aReturn['result'][$line[0]][] = $line[1];
160			} else {
161			$finfo = $parameters['QueryResult']->fetch_fields();
162			$this->setMySQLquery2ServerByPatternLineAdvanced($parameters, $finfo, $line, $counter2, $aReturn);
163			}
164			}
165
166			private function setMySQLquery2ServerByPatternLineAdvanced($parameters, $finfo, $line, $counter2, &$aReturn)
167			{
168			foreach ($finfo as $columnCounter => $value) {
169			switch ($parameters['returnType']) {
170			case 'array_first_key_rest_values':
171			if ($columnCounter !== 0) {
172			$aReturn['result'][$line[0]][$value->name] = $line[$columnCounter];
173			}
174			break;
175			case 'array_pairs_key_value':
176			$aReturn['result'][$value->name] = $line[$columnCounter];
177			break;
178			case 'full_array_key_numbered':
179			$aReturn['result'][$counter2][$value->name] = $line[$columnCounter];
180			break;
181			case 'full_array_key_numbered_with_record_number_prefix':
182			$parameters['prefix'] = 'RecordNo';
183			// intentionally left open
184			case 'full_array_key_numbered_with_prefix':
185			$aReturn['result'][$parameters['prefix']][$counter2][$value->name] = $line[$columnCounter];
186			break;
187			}
188			}
189			}
190
191			private function setMySQLquery2ServerConnected($inArray)
192			{
193			if ($inArray['RType'] == 'id') {
194			return ['customError' => '', 'result' => $this->mySQLconnection->insert_id];
195			} elseif ($inArray['RType'] == 'lines') {
196			return ['result' => $inArray['Result']->num_rows, 'customError' => ''];
197			}
198			$parameters = [
199			'NoOfColumns' => $inArray['Result']->field_count,
200			'NoOfRows' => $inArray['Result']->num_rows,
201			'QueryResult' => $inArray['Result'],
202			'returnType' => $inArray['RType'],
203			'return' => ['customError' => '', 'result' => null]
204			];
205			if (substr($inArray['RType'], -6) == 'prefix') {
206			$parameters['prefix'] = $inArray['F']['prefix'];
207			}
208			return $this->setMySQLquery2ServerByPattern($parameters);
209			}
210			}
211

danielgp / common-lib

Push — master ( 137f35...33c4fa )

setMySQLquery2ServerByPatternLine() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like