samsonframework /
orm
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:
| 1 | <?php |
||
| 15 | class Database |
||
| 16 | { |
||
| 17 | /** @var \PDO Database driver */ |
||
| 18 | protected $driver; |
||
| 19 | |||
| 20 | /** @var string Database name */ |
||
| 21 | protected $database; |
||
| 22 | |||
| 23 | /** @var int Amount of milliseconds spent on queries */ |
||
| 24 | protected $elapsed; |
||
| 25 | |||
| 26 | /** @var int Amount queries executed */ |
||
| 27 | protected $count; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * Connect to a database using driver with parameters |
||
| 31 | * @param string $database Database name |
||
| 32 | * @param string $username Database username |
||
| 33 | * @param string $password Database password |
||
| 34 | * @param string $host Database host(localhost by default) |
||
| 35 | * @param int $port Database port(3306 by default) |
||
| 36 | * @param string $driver Database driver for interaction(MySQL by default) |
||
| 37 | * @param string $charset Database character set |
||
| 38 | * @return bool True if connection to database was successful |
||
| 39 | */ |
||
| 40 | public function connect( |
||
| 62 | |||
| 63 | /** |
||
| 64 | * Get database name |
||
| 65 | * @return string |
||
| 66 | */ |
||
| 67 | public function database() |
||
| 71 | |||
| 72 | /** |
||
| 73 | * Create new database record |
||
| 74 | * @param string $entity Entity class name |
||
| 75 | * @return null|RecordInterface Entity instance |
||
| 76 | * @throws EntityNotFound |
||
| 77 | */ |
||
| 78 | View Code Duplication | public function entity($entity) |
|
| 79 | { |
||
| 80 | if (class_exists($entity)) { |
||
| 81 | return new $entity($this); |
||
| 82 | } else { |
||
| 83 | throw new EntityNotFound('['.$entity.'] not found'); |
||
| 84 | } |
||
| 85 | } |
||
| 86 | |||
| 87 | /** |
||
| 88 | * Get entity query manager |
||
| 89 | * @param string $entity Entity identifier |
||
| 90 | * @return Query Query manager instance |
||
| 91 | */ |
||
| 92 | public function manager($entity) |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Intreal error beautifier |
||
| 99 | * @param \Exception $e |
||
| 100 | * @param $sql |
||
| 101 | */ |
||
| 102 | private function outputError(\Exception $e, $sql, $text = 'Error executing database query:') |
||
| 103 | { |
||
| 104 | elapsed('erorr'); |
||
| 105 | echo("\n" . '<div style="font-size:12px; position:relative; background:red; z-index:9999999;">' |
||
| 106 | .'<div style="padding:4px 10px;">'.$text.'</div>' |
||
| 107 | .'<div style="padding:0px 10px;">['.htmlspecialchars($e->getMessage()).']</div>' |
||
| 108 | .'<textarea style="display:block; width:100%; min-height:100px;">'.$sql . '</textarea></div>'); |
||
| 109 | } |
||
| 110 | |||
| 111 | /** |
||
| 112 | * Proxy function for executing database fetching logic with exception, |
||
| 113 | * error, profile handling |
||
| 114 | * @param callback $fetcher Callback for fetching |
||
| 115 | * @return mixed Fetching function result |
||
| 116 | */ |
||
| 117 | private function execute($fetcher) |
||
| 118 | { |
||
| 119 | $result = array(); |
||
| 120 | |||
| 121 | if (isset($this->driver)) { |
||
| 122 | // Store timestamp |
||
| 123 | $tsLast = microtime(true); |
||
| 124 | |||
| 125 | try { // Call fetcher |
||
| 126 | // Get argument and remove first one |
||
| 127 | $args = func_get_args(); |
||
| 128 | array_shift($args); |
||
| 129 | |||
| 130 | // Proxy calling of fetcher function with passing parameters |
||
| 131 | $result = call_user_func_array($fetcher, $args); |
||
| 132 | } catch (\PDOException $e) { |
||
| 133 | $this->outputError($e, $sql, 'Error executing ['.$fetcher.']'); |
||
| 134 | } |
||
| 135 | |||
| 136 | // Store queries count |
||
| 137 | $this->count++; |
||
| 138 | |||
| 139 | // Count elapsed time |
||
| 140 | $this->elapsed += microtime(true) - $tsLast; |
||
| 141 | } |
||
| 142 | |||
| 143 | return $result; |
||
| 144 | } |
||
| 145 | |||
| 146 | /** |
||
| 147 | * High-level database query executor |
||
| 148 | * @param string $sql SQL statement |
||
| 149 | * @return mixed Database query result |
||
| 150 | */ |
||
| 151 | private function innerQuery($sql) |
||
| 152 | { |
||
| 153 | try { |
||
| 154 | // Perform database query |
||
| 155 | $result = $this->driver->prepare($sql)->execute(); |
||
| 156 | } catch (\PDOException $e) { |
||
| 157 | $this->outputError($e, $sql); |
||
| 158 | } |
||
| 159 | } |
||
| 160 | |||
| 161 | /** |
||
| 162 | * Retrieve array of records from a database, if $className is passed method |
||
| 163 | * will try to create an object of that type. If request has failed than |
||
| 164 | * method will return empty array of stdClass all arrays regarding to $className is |
||
| 165 | * passed or not. |
||
| 166 | * |
||
| 167 | * @param string $sql Query text |
||
| 168 | * @return array Collection of arrays or objects |
||
| 169 | */ |
||
| 170 | private function innerFetch($sql, $className = null) |
||
| 171 | { |
||
| 172 | try { |
||
| 173 | // Perform database query |
||
| 174 | if (!isset($className)) { // Return array |
||
| 175 | return $this->driver->query($sql)->fetchAll(\PDO::FETCH_ASSOC); |
||
| 176 | } else { // Create object of passed class name |
||
| 177 | return $this->driver->query($sql)->fetchAll(\PDO::FETCH_CLASS, $className, array(&$this)); |
||
| 178 | } |
||
| 179 | } catch (\PDOException $e) { |
||
| 180 | $this->outputError($e, $sql, 'Fetching database records:'); |
||
| 181 | } |
||
| 182 | } |
||
| 183 | |||
| 184 | /** |
||
| 185 | * Special accelerated function to retrieve db record fields instead of objects |
||
| 186 | * |
||
| 187 | * @param string $className |
||
| 188 | * @param mixed $query |
||
| 189 | * @param string $field |
||
| 190 | * |
||
| 191 | * @return array |
||
| 192 | */ |
||
| 193 | private function innerFetchColumn($className, $query, $field) |
||
| 194 | { |
||
| 195 | // Get SQL |
||
| 196 | $sql = $this->prepareSQL($className, $query); |
||
| 197 | |||
| 198 | // TODO: Remove old attributes retrieval |
||
| 199 | // Get table column index by its name |
||
| 200 | $columnIndex = array_search($field, array_values($className::$_table_attributes)); |
||
| 201 | |||
| 202 | try { |
||
| 203 | // Perform database query |
||
| 204 | return $this->driver->query($sql)->fetchAll(\PDO::FETCH_COLUMN, $columnIndex); |
||
| 205 | } catch (\PDOException $e) { |
||
| 206 | $this->outputError($e, $sql, 'Error fetching records column values:'); |
||
| 207 | } |
||
| 208 | } |
||
| 209 | |||
| 210 | /** |
||
| 211 | * High-level database query executor |
||
| 212 | * @param string $sql SQL statement |
||
| 213 | * @return mixed Database query result |
||
| 214 | */ |
||
| 215 | public function query($sql) |
||
| 216 | { |
||
| 217 | return $this->execute(array($this, 'innerQuery'), $sql); |
||
| 218 | } |
||
| 219 | |||
| 220 | /** |
||
| 221 | * Retrieve array of records from a database, if $className is passed method |
||
| 222 | * will try to create an object of that type. If request has failed than |
||
| 223 | * method will return empty array of stdClass all arrays regarding to $className is |
||
| 224 | * passed or not. |
||
| 225 | * |
||
| 226 | * @param string $sql Query text |
||
| 227 | * @return array Collection of arrays or objects |
||
| 228 | */ |
||
| 229 | public function fetch($sql) |
||
| 230 | { |
||
| 231 | return $this->execute(array($this, 'innerFetch'), $sql); |
||
| 232 | } |
||
| 233 | |||
| 234 | /** |
||
| 235 | * Special accelerated function to retrieve db record fields instead of objects |
||
| 236 | * |
||
| 237 | * @param string $className |
||
| 238 | * @param mixed $query |
||
| 239 | * @param string $field |
||
| 240 | * |
||
| 241 | * @return array |
||
| 242 | */ |
||
| 243 | public function fetchColumn($className, $query, $field) |
||
| 244 | { |
||
| 245 | return $this->execute(array($this, 'innerFetchColumn'), $className, $query, $field); |
||
| 246 | } |
||
| 247 | |||
| 248 | public function create($className, &$object = null) |
||
| 261 | |||
| 262 | public function update($className, &$object) |
||
| 269 | |||
| 270 | public function delete($className, &$object) |
||
| 276 | |||
| 277 | /** Count query result */ |
||
| 278 | public function count($className, $query) |
||
| 288 | |||
| 289 | /** |
||
| 290 | * Выполнить защиту значения поля для его безопасного использования в запросах |
||
| 291 | * |
||
| 292 | * @param string $value Значения поля для запроса |
||
| 293 | * @return string $value Безопасное представление значения поля для запроса |
||
| 294 | */ |
||
| 295 | protected function protectQueryValue($value) |
||
| 308 | |||
| 309 | /** |
||
| 310 | * Prepare create & update SQL statements fields |
||
| 311 | * @param string $className Entity name |
||
| 312 | * @param Record $object Database object to get values(if needed) |
||
| 313 | * @param bool $straight Way of forming SQL field statements |
||
| 314 | * @return array Collection of key => value with SQL fields statements |
||
| 315 | */ |
||
| 316 | protected function &getQueryFields($className, & $object = null, $straight = false) |
||
| 346 | |||
| 347 | /** @deprecated Use query() */ |
||
| 348 | public function &simple_query($sql) |
||
| 352 | } |
||
| 353 |
Loading history...
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..