danielgp /
io-operations
| Total Complexity | 44 |
| Total Lines | 245 |
| Duplicated Lines | 0 % |
| Changes | 9 | ||
| Bugs | 0 | Features | 3 |
Complex classes like InputOutputDatabases 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.
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 InputOutputDatabases, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 29 | trait InputOutputDatabases |
||
| 30 | { |
||
| 31 | |||
| 32 | public $strErrorText = null; |
||
| 33 | private $arrayConnectionDetails = []; |
||
| 34 | private $bolDebugText = false; |
||
| 35 | private $objConnection = null; |
||
| 36 | |||
| 37 | public function establishDatabaseConnectionFlexible(string $strDatabaseType, array $arrayConnectionParameters) |
||
| 38 | { |
||
| 39 | if (http_response_code() != 200) { |
||
| 40 | return null; |
||
| 41 | } |
||
| 42 | $arrayAuth = [ |
||
| 43 | 'U' => '', |
||
| 44 | 'P' => '', |
||
| 45 | ]; |
||
| 46 | if (array_key_exists('Authentication', $arrayConnectionParameters)) { |
||
| 47 | $arrayAuth = [ |
||
| 48 | 'U' => $arrayConnectionParameters['Authentication']['Username'], |
||
| 49 | 'P' => $arrayConnectionParameters['Authentication']['Password'], |
||
| 50 | ]; |
||
| 51 | } |
||
| 52 | switch ($strDatabaseType) { |
||
| 53 | case 'MySQL': |
||
| 54 | $strDsn = 'mysql:' |
||
| 55 | . implode(';', [ |
||
| 56 | 'host=' . $arrayConnectionParameters['Host'], |
||
| 57 | 'dbname=' . $arrayConnectionParameters['Database'], |
||
| 58 | 'port=' . $arrayConnectionParameters['Port'], |
||
| 59 | 'charset=' . $arrayConnectionParameters['Charset'], |
||
| 60 | 'collation=' . $arrayConnectionParameters['Collation'], |
||
| 61 | ]); |
||
| 62 | $aConnectionOptions = [ |
||
| 63 | \PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION, |
||
| 64 | \PDO::MYSQL_ATTR_FOUND_ROWS => TRUE, |
||
| 65 | ]; |
||
| 66 | break; |
||
| 67 | case 'SQLite': |
||
| 68 | $strDsn = 'sqlite:' . $arrayConnectionParameters['FileName']; |
||
| 69 | $aConnectionOptions = [ |
||
| 70 | \PDO::ATTR_EMULATE_PREPARES => false, |
||
| 71 | \PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION, |
||
| 72 | ]; |
||
| 73 | break; |
||
| 74 | } |
||
| 75 | $this->arrayConnectionDetails['DatabaseType'] = $strDatabaseType; |
||
| 76 | $this->exposeDebugText('Database connection DSN: ' . $strDsn); |
||
|
Comprehensibility
Best Practice
introduced
by
|
|||
| 77 | if ($arrayAuth['U'] != '') { |
||
| 78 | $this->exposeDebugText('Database connection username: ' . $arrayAuth['U']); |
||
| 79 | } |
||
| 80 | try { |
||
| 81 | $this->objConnection = new \PDO($strDsn, $arrayAuth['U'], $arrayAuth['P'], $aConnectionOptions); |
||
| 82 | $this->exposeDebugText('Database connection established: ' |
||
| 83 | . $this->getResultsAsJson($this->objConnection)); |
||
| 84 | } catch (\RuntimeException $e) { |
||
| 85 | if (!headers_sent()) { |
||
| 86 | http_response_code(403); |
||
| 87 | } |
||
| 88 | $this->strErrorText = vsprintf('Conectarea la [%s] a întâmpinat o eroare' |
||
| 89 | . ', detaliile sunt după cum urmează: %s', [ |
||
| 90 | $strDatabaseType, |
||
| 91 | $e->getMessage(), |
||
| 92 | ]); |
||
| 93 | $this->exposeDebugText('Database connection: ' . $this->strErrorText); |
||
| 94 | } |
||
| 95 | } |
||
| 96 | |||
| 97 | public function exposeDebugText(string $strText) |
||
| 98 | { |
||
| 99 | if ($this->bolDebugText) { |
||
| 100 | error_log($strText); |
||
| 101 | } |
||
| 102 | } |
||
| 103 | |||
| 104 | public function getQueryFromFile(array $arrayInputs) |
||
| 105 | { |
||
| 106 | $this->exposeDebugText('Query file is: ' . $arrayInputs['queryFileName']); |
||
| 107 | $fileContent = $this->getFileEntireContent($arrayInputs['queryFileName']); |
||
| 108 | $strRawQuery = $fileContent; |
||
| 109 | if (is_array($fileContent)) { |
||
| 110 | $strRawQueryAsIs = implode(' ', $fileContent); |
||
| 111 | $this->exposeDebugText('Query as read from file: ' . $strRawQueryAsIs); |
||
| 112 | $arrayToClean = [ |
||
| 113 | str_repeat(' ', 12), |
||
| 114 | str_repeat(' ', 8), |
||
| 115 | str_repeat(' ', 4), |
||
| 116 | str_repeat(' ', 2), |
||
| 117 | ]; |
||
| 118 | $strRawQuery = str_replace($arrayToClean, ' ', $strRawQueryAsIs); |
||
| 119 | } |
||
| 120 | $sReturn = $strRawQuery; |
||
| 121 | if (array_key_exists('queryParameterValues', $arrayInputs) && ($arrayInputs['queryParameterValues'] !== [])) { |
||
| 122 | $sReturn = vsprintf($strRawQuery, $arrayInputs['queryParameterValues']); |
||
| 123 | } |
||
| 124 | return $sReturn; |
||
| 125 | } |
||
| 126 | |||
| 127 | public function getResultsAsJson(array|\PDO $arrayResults) |
||
| 128 | { |
||
| 129 | $encodingFlags = (JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE); |
||
| 130 | return json_encode($arrayResults, $encodingFlags); |
||
| 131 | } |
||
| 132 | |||
| 133 | public function getResultsThroughVerification(array $arrayResult) |
||
| 134 | { |
||
| 135 | $strReturn = $arrayResult; |
||
| 136 | if (is_null($arrayResult)) { |
||
| 137 | if (!headers_sent()) { |
||
| 138 | http_response_code(403); |
||
| 139 | } |
||
| 140 | $this->strErrorText = 'NU există date pe server cu valorile introduse!'; |
||
| 141 | $this->exposeDebugText('No data (NULL): ' . $this->strErrorText); |
||
| 142 | } elseif (is_array($arrayResult)) { |
||
| 143 | if ($arrayResult == []) { |
||
| 144 | if (!headers_sent()) { |
||
| 145 | http_response_code(403); |
||
| 146 | } |
||
| 147 | $this->strErrorText = 'NU există date pe server cu valorile introduse!'; |
||
| 148 | $this->exposeDebugText('Empty results: ' . $this->strErrorText); |
||
| 149 | } |
||
| 150 | } |
||
| 151 | return $strReturn; |
||
| 152 | } |
||
| 153 | |||
| 154 | public function getResultsUsingQuery(string $strQuery, string $strFetchingType = \PDO::FETCH_ASSOC) |
||
| 155 | { |
||
| 156 | if (is_null($this->objConnection)) { |
||
| 157 | return null; |
||
| 158 | } |
||
| 159 | $result = []; |
||
| 160 | try { |
||
| 161 | $stmt = $this->objConnection->prepare($strQuery); |
||
| 162 | $this->exposeDebugText('Before Query execution: ' . $strQuery); |
||
| 163 | $stmt->execute(); |
||
| 164 | if (substr($strQuery, 0, 7) === 'INSERT ') { |
||
| 165 | $this->exposeDebugText('INSERT detected'); |
||
| 166 | $intLastInsertId = $this->objConnection->lastInsertId(); |
||
| 167 | $this->exposeDebugText('Last insert ID: ' . $intLastInsertId); |
||
| 168 | switch ($intLastInsertId) { |
||
| 169 | case '0': |
||
| 170 | $intRowsAffected = 0; |
||
| 171 | break; |
||
| 172 | default: |
||
| 173 | $intRowsAffected = $stmt->rowCount(); |
||
| 174 | break; |
||
| 175 | } |
||
| 176 | $result = [ |
||
| 177 | 'lastInsertId' => $intLastInsertId, |
||
| 178 | 'rowsAffected' => $intRowsAffected, |
||
| 179 | ]; |
||
| 180 | $this->exposeDebugText('Rows affected: ' . $this->getResultsAsJson($result)); |
||
| 181 | } elseif ((substr($strQuery, 0, 7) === 'UPDATE ') || (substr($strQuery, 0, 5) === 'CALL ')) { |
||
| 182 | $this->exposeDebugText('UPDATE/CALL detected'); |
||
| 183 | $result = [ |
||
| 184 | 'rowsAffected' => $stmt->rowCount(), |
||
| 185 | ]; |
||
| 186 | $this->exposeDebugText('Rows affected: ' . $this->getResultsAsJson($result)); |
||
| 187 | } elseif (($stmt->rowCount() == 0) && ($this->arrayConnectionDetails['DatabaseType'] != 'SQLite')) { |
||
| 188 | $this->exposeDebugText('0 RowCount seen'); |
||
| 189 | $result = [ |
||
| 190 | 'rowsAffected' => 0, |
||
| 191 | ]; |
||
| 192 | $this->exposeDebugText('Rows affected: ' . $this->getResultsAsJson($result)); |
||
| 193 | } else { |
||
| 194 | $result = $stmt->fetchAll($strFetchingType); |
||
| 195 | } |
||
| 196 | $objReturn = $this->getResultsThroughVerification($result); |
||
| 197 | $this->exposeDebugText('Return after verification:' . $this->getResultsAsJson($objReturn)); |
||
| 198 | return $objReturn; |
||
| 199 | } catch (\PDOException $e) { |
||
| 200 | if (!headers_sent()) { |
||
| 201 | http_response_code(403); |
||
| 202 | } |
||
| 203 | $this->strErrorText = vsprintf('Eroare întâlnită, mesajul de la serverul de date este [%s]', [ |
||
| 204 | $e->getMessage(), |
||
| 205 | ]); |
||
| 206 | $this->exposeDebugText('After Query execution: ' . $this->strErrorText); |
||
| 207 | } |
||
| 208 | } |
||
| 209 | |||
| 210 | public function getStoredQuery($objClass, $label, $given_parameters = null) |
||
| 217 | } |
||
| 218 | |||
| 219 | public function setBatchDataIntoDatabase(string $strQuery, array $arrayDataToWrite, string $strWhich) |
||
| 220 | { |
||
| 221 | if (is_null($this->objConnection)) { |
||
| 222 | return null; |
||
| 223 | } |
||
| 259 | } |
||
| 260 | } |
||
| 261 | } |
||
| 262 | |||
| 263 | public function setQueryWithoutAnyReturnExpected(string $strQuery): void |
||
| 278 |
Loading history...