php Класс отвечает за работу базой данных совершает запросы форматируе

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
<?php
/**
* Класс отвечает за работу с базой данных,
* совершает запросы, форматирует возвращаемый результат.
*
* Все запросы перед тем как быть отправлены не сервер
* проходят проверку классом Query, тем самым гарантируя
* безопасность запросов.
*
* @version '1.0'
*
* Примеры использования:
*
* Подключение к базе данных, используя DSN:
* $connection = new MySqlConnect('root@localhost/test');
*
* Подключение, использыя ассоциативный массив в качестве параметров:
* $configuration = array('user' => 'root', 'host' => 'localhost',' db_name' => 'test');
* $connection = new MySqlConnect($configuration);
*
* Выполнение запроса общего вида:
* $result = $connection ->query('SELECT * FROM %N WHERE `help_keyword_id`=%D','help_keyword',39);
*
* Получение одной строки:
* $result = $connection ->getRow('SELECT * FROM `help_topic` WHERE `name`=%S','REGEXP');
*
* Добавление записи в таблицу используя тип %H
* $user = array('first_name' => 'Ivan', 'last_name' => 'Petrov', 'user' => 'admin123', 'password' => md5('qwerty123456'));
* $result = $connection -> query('INSERT INTO `users` SET %H',$user);
*/
class MySqlC {
private $connected = false;
private $lastQuery = 'nope';
private $log = array();
private $db_config = array(
'host' => 'localhost',
'port' => NULL,
'user' => 'root',
'db_name' => 'test',
'password' => ''
);
/**
* Выполняет подключение к базе данных, обрабатывает результаты запросов
*
* @param string $data Строка вида user:password/host:port/db_name
* @param array $data Ассоциативный массив, содержит параметры подключения к базе
*
* @return MySqlC Экземпляр класса
*/
public function __construct($data) {
if (is_string($data)) {
$pattern = '/(\w+):?(\w+)?@(\w+):?(\w+)?\/(\w+)/';
$matches = array();
preg_match($pattern, $data, $matches);
$data = array(
'host' => $matches[3],
'port' => isset($matches[4]) ? $matches[4] : NULL,
'user' => $matches[1],
'password' => $matches[2],
'db_name' => $matches[5],
'encoding' => 'utf8'
);
}
$this->db_config = array_merge($this->db_config, $data);
$str = $this->db_config['host'];
$str .= (!$this->db_config['port']) ? "" : ":" . $this->db_config['port'];
$this->connected = @mysqli_connect($this->db_config['host'], $this->db_config['user'], $this->db_config['password'], $this->db_config['db_name'], $this->db_config['port']);
if (!$this->connected) {
$this->handleError(mysqli_connect_error());
} else {
$dns_str = $this->db_config['user'];
$dns_str .= ":" . $this->db_config['password'];
$dns_str .= "@" . $this->db_config['host'];
$dns_str .= "/" . $this->db_config['db_name'];
$this->pushLog("Connected: " . $dns_str);
}
}
/**
* Выполняет выборку в виде строки
*
* В случае, если вернется более, чем одна строка, то результатом этой функции будет первая
*
* @param Query $query Экземпляр класса Query
* @param string $string Строка запроса
* @param mixed $args Аргументы, которые необходимо подставить на место плейсхолдеров
*
* @return array Массив скаляров, строка из базы данных
*/
public function getRow() {
$res = $this->query(func_get_args());
if (is_a($res, 'mysqli_result')) {
$return = mysqli_fetch_array($res, MYSQLI_ASSOC);
mysqli_free_result($res);
return $return;
}
return $res;
}
/**
* Выполняет выборку в виде таблицы
*
* @param Query $query Экземпляр класса Query
* @param string $string Строка запроса
* @param mixed $args Аргументы, которые необходимо подставить на место плейсхолдеров
*
* @return array Массив строк, двумерный массив. Таблица из БД
*/
public function getTable() {
$res = $this->query(func_get_args());
$table = array();
if (is_a($res, 'mysqli_result')) {
$row = mysqli_fetch_array($res, MYSQLI_ASSOC);
while ($row) {
array_push($table, $row);
$row = mysqli_fetch_array($res, MYSQLI_ASSOC);
}
return $table;
}
return $res;
}
/**
* Выполняет выборку в виде колонки
*
* В случае, если вернется более, чем один столбец, результатом этой функции будет первый
*
* @param Query $query Экземпляр класса Query
* @param string $string Строка запроса
* @param mixed $args Аргументы, которые необходимо подставить на место плейсхолдеров
*
* @return array Массив скаляров, колонка из базы данных
*/
public function getColumn() {
$res = $this->query(func_get_args());
$col = array();
if (is_a($res, 'mysqli_result')) {
$row = mysqli_fetch_array($res);
while ($row) {
array_push($col, $row[0]);
$row = mysqli_fetch_array($res);
}
return $col;
}
return $res;
}
/**
* Выполняет выборку в виде строки
*
* В случае, если вернется более, чем одна ячейка, результатом этой функции будет первая в первой строке
*
* @param Query $query Экземпляр класса Query
* @param string $string Строка запроса
* @param mixed $args Аргументы, которые необходимо подставить на место плейсхолдеров
*
* @return mixed Ячейка
*/
public function getCell() {
$res = $this->query(func_get_args());
if (is_a($res, 'mysqli_result')) {
$return = mysqli_fetch_array($res);
return $return[0];
}
return $res;
}
/**
* Выполняет запрос к базе данных, обрабатывает возникшие ошибки
*
* @param Query $query Экземпляр класса Query
* @param String $string Строка запроса
* @param mixed $args Аргументы, которые необходимо подставить на место плейсхолдеров
*
* @return mysqli_result
*/
public function query() {
$args = func_get_args();
if (sizeof($args) == 0) {
return NULL;
}
if (is_array($args[0])) {
$args = $args[0];
}
$inp = array_shift($args);
if (!$this->connected) {
return NULL;
}
try {
$q = !is_a($inp, 'Query') ? new Query($inp, $this->connected) : $inp;
$query = $q->parse($args);
} catch (Exception $e) {
$this->handleError($e);
return NULL;
}
$start = microtime(TRUE);
$result = mysqli_query($this->connected, $query);
$time = microtime(TRUE) - $start;
if (!$result) {
$err = mysqli_error($this->connected);
$this->handleError($err, $query);
return NULL;
} else {
$this->lastQuery = $query;
$log = 'Complited. In ' . $time . ' microseconds. Query: "' . $query . '"';
$this->pushLog($log);
return $result;
}
}
/**
* Возваращает последний выполненный запрос. Если такового не имеется, то возвращает NULL
*
* @return string Последний выполненный запрос
*/
public function getLastQuery() {
return $this->lastQuery;
}
/**
* Возваращает лог в виде массива, где каждый элемент это запись лога
*
* @return array
*/
public function getLog() {
return $this->log;
}
/**
* Возваращает последнее сообщение. Если такового не имеется, то возвращает NULL
*
* @return string Последнее сообщение
*/
public function getLastMessage() {
if (sizeof($this->log) > 0) {
return $this->log[sizeof($this->log) - 1];
}
return NULL;
}
/**
* Добавляет запись в лог
*
* @param mixed $event
*/
private function pushLog($event) {
array_push($this->log, $event);
}
/**
* Обрабатывает возникшие ошибки
*
* @param mixed $error Исключение, строка ошибки
* @param string $query Строка запроса, в результате которой возникла ошибка
*/
private function handleError($error, $query = NULL) {
$result = 'Error. ';
if (is_a($error, 'Exception')) {
$result .= $error->getMessage() . ' in file: ' . $error->getFile() . ' on ' . $error->getLine() . 'line.';
} else {
$result .= (string) $error;
}
if (isset($query)) {
$result .= ' Query: ' . $query;
}
$this->pushLog($result);
}
}
/**
* Производит обработку строк запроса,
* подготовку переменных для подстановки на зарезервированные места.
* В основном не предназначен для самостоятельного использования. Работает в паре с MySqlC.
*
* %D — целые числа
* %F — числа с плавающей точкой
* %S — строки, даты, время
* %N — строки, отвечающие за имена таблиц, полей
* %A — массивы, которые будут представлены в виде value1, value2
* %H — хеши, которые будут представлены в виде `name1`=value1, `name2`=value2
*
* Примеры использования:
*
* Создание нового запроса:
* $query = new Query(array('SELECT %N FROM `mysql` LIMIT 0,%D'));
*
* Подстановка значений переменных на плейсхолдеры:
* $str = $query->parse(array('name',10));
*
* Следует заметить, что передается массив. Это сделано для удобной интеграции с MySqlC
*/
class Query {
private $query;
private $varCount = 0;
private $variable = array();
private $connected;
const DECIMAL = 'DECIMAL';
const STRING = 'STING';
const NAME = 'NAME';
const ARAY = 'ARAY';
const FLOAT = 'FLOAT';
const HASH = 'HASH';
/**
* Создает экземпляр класса обрабатывает полученую строку заброса,
* разбивает ее.
*
* @param string $query Запрос с плейсхолдерами
* @param mysqli $connection Для обработки строковых переменных.
*
* @throws InvalidArgumentException Исключение вызывается, если аргументы не соответствуют ожидаемым
*/
function __construct($query, $connection = NULL) {
if (!is_string($query)) {
throw new InvalidArgumentException('String expected. ' . gettype($query) . ' given.');
}
$this->parseVariables($query);
if (is_a($connection, 'mysqli')) {
$this->connected = $connection;
}
}
/**
* Производит подстановку переменных на свои места, перед этим подготавивая их.
*
* @return string Готовый к отправке базе данных запрос
*
* @throws InvalidArgumentException Вызывается, если аргументы не соответствуют ожидаемым
*/
public function parse() {
$query = $this->query;
$counter = 0;
$in = func_get_arg(0);
if (sizeof($in) == 0 && $this->varCount == 0) {
return $this->query;
}
$vars = $this->variable;
while (sizeof($vars) > 0) {
$currentVariable = array_shift($vars);
$currentInput = array_shift($in);
if ($currentInput === NULL) {
throw new InvalidArgumentException('Invalid number of arguments. Expected ' . $this->varCount . '.');
}
if (($currentVariable['type'] === Query::HASH || $currentVariable['type'] === Query::ARAY) && !is_array($currentInput)) {
throw new InvalidArgumentException('Array expected. "' . gettype($currentInput) . '" is given.');
}
if (($currentVariable['type'] === Query::HASH || $currentVariable['type'] === Query::ARAY) && is_array($currentInput)) {
$paste = $this->prepareVariable($currentVariable, $currentInput);
$searchFor = '/#' . $currentVariable['id'] . '#/u';
$query = preg_replace($searchFor, $paste, $query);
$counter++;
} elseif (is_array($currentInput)) {
$c = false;
foreach ($currentInput as $input) {
if ($c) {
$currentVariable = array_shift($vars);
if ($currentVariable == NULL) {
throw new InvalidArgumentException('Query expects ' . $this->varCount . ' variables.');
}
}
if (($currentVariable['type'] === Query::HASH || $currentVariable['type'] === Query::ARAY) && !is_array($input)) {
throw new InvalidArgumentException('Array expected. "' . gettype($input) . '" is given.');
}
$paste = $this->prepareVariable($currentVariable, $input);
$searchFor = '/#' . $currentVariable['id'] . '#/u';
$query = preg_replace($searchFor, $paste, $query);
$counter++;
$c = true;
}
} else {
$paste = $this->prepareVariable($currentVariable, $currentInput);
$searchFor = '/#' . $currentVariable['id'] . '#/u';
$query = preg_replace($searchFor, $paste, $query);
$counter++;
}
}
if ($counter != $this->varCount) {
throw new InvalidArgumentException('Invalid number of variables is given.d');
}
return $query;
}
/**
* Анализирует запрос с плейсхолдерами, выделяет их, резервирует им места.
*
* @param string $string Строка запроса
*/
private function parseVariables($string) {
$pattern = '/%([DFSNHA])({([^{}]+)})?/u';
$array = preg_split($pattern, $string);
$matches = array();
preg_match_all($pattern, $string, $matches);
$result = "";
$counter = 0;
foreach ($array as $key => $value) {
if (isset($matches[1][$key])) {
switch ($matches[1][$key]) {
case 'F':
$type = Query::FLOAT;
break;
case 'D':
$type = Query::DECIMAL;
break;
case 'N':
$type = Query::NAME;
break;
case 'A':
$type = Query::ARAY;
break;
case 'H':
$type = Query::HASH;
break;
default:
$type = Query::STRING;
}
$this->variable[$counter]['type'] = $type;
$this->variable[$counter]['regexp'] = $matches[3][$key];
$this->variable[$counter]['id'] = $counter;
$result .= $value . '#' . $counter . '#';
$counter++;
} else {
$result .= $value;
}
}
$this->varCount = $counter;
$this->query = $result;
}
/**
* Проверяет переменные на соответствие заказанному формату
*
* @param array $field Массив параметров плейсхолдера
* @param mixed $value Значение для подстановки на место
*
* @return mixed Обработанное и готовое для подстановки в запрос значение
*
* @throws InvalidArgumentException Исключение вызывается, если происходит несоответствие типов
*/
private function prepareVariable($field, $value) {
if ($value === NULL) {
return NULL;
}
if ($field['regexp'] != NULL) {
if (!preg_match($field['regexp'], $value)) {
throw new InvalidArgumentException('Argument: "' . $value . '" Doesn\'t matches: ' . $field['regexp']);
}
}
switch ($field['type']) {
case Query::DECIMAL:
$result = $this->prepareDecimal($value);
break;
case Query::STRING:
$result = $this->prepareSting($value);
break;
case Query::NAME:
$result = $this->prepareName($value);
break;
case Query::ARAY:
if (!is_array($value)) {
throw new InvalidArgumentException('Array expected. ' . gettype($value) . ' is given.');
}
$result = '(';
while (sizeof($value) > 1) {
$val = $this->prepareUnknown(array_shift($value));
$result .= $val . ', ';
}
$val = $this->prepareUnknown(array_shift($value));
$result .= $val . ')';
break;
case Query::FLOAT:
$result = $this->prepareFloat($value);
break;
case Query::HASH:
if (!is_array($value)) {
throw new InvalidArgumentException('Array expected. ' . gettype($value) . ' is given.');
}
$result = '';
if (sizeof($value) > 0) {
foreach ($value as $key => $valu) {
$key = $this->prepareName($key);
$valu = $this->prepareUnknown($valu);
$result .= $key . '=' . $valu . ', ';
}
$result = substr($result, 0, strlen($result) - 2);
}
break;
default: $result = NULL;
}
return $result;
}
/**
* Подготавливает к подстановке переменную неизвестного типа, согласно is_type()
* В зависимости от этого вызываются функции
* $this->prepareDecimal($unk)
* $this->prepareFloat($unk)
* $this->prepareSting($unk)
*
* @param mixed $unk
*
* @return mixed Возвращает значение
*/
private function prepareUnknown($unk) {
if (is_integer($unk)) {
return $this->prepareDecimal($unk);
} elseif (is_float($unk)) {
return $this->prepareFloat($unk);
}
return $this->prepareSting($unk);
}
/**
* Проверяет переменную и подготавливает к подстановке в запрос
*
* @param string $str
*
* @return string
*/
private function prepareSting($str) {
$str = (string)$str;
$str = stripslashes($str);
if (isset($this->connected)) {
$str = mysqli_real_escape_string($this->connected, $str);
} else {
$str = mysql_real_escape_string($str);
}
$result = "'" . $str . "'";
return $result;
}
/**
* Проверяет переменную и подготавливает к подстановке в запрос
*
* @param float $flo
* @return float
* @throws InvalidArgumentException Вызывается в случае несоответствия формату
*/
private function prepareFloat($flo) {
if (!is_numeric($flo)) {
throw new InvalidArgumentException('Float expected. ' . gettype($flo) . ' is given.');
}
return (float) $flo;
}
/**
* Проверяет переменную и подготавливает к подстановке в запрос
*
* @param integer $dec
* @return dec
* @throws InvalidArgumentException Вызывается в случае несоответствия формату
*/
private function prepareDecimal($dec) {
if (!is_numeric($dec)) {
throw new InvalidArgumentException('Decimal expected. ' . gettype($dec) . ' is given.');
}
return round($dec);
}
/**
* Проверяет переменную и подготавливает к подстановке в запрос
*
* @param string $str
* @return string
* @throws InvalidArgumentException Вызывается в случае несоответствия формату
*/
private function prepareName($name) {
if (!is_string($name)) {
throw new InvalidArgumentException('String expected. ' . gettype($name) . ' is given.');
}
$name = stripslashes($name);
if (isset($this->connected)) {
$str = mysqli_real_escape_string($this->connected, $name);
} else {
$str = mysql_real_escape_string($name);
}
if (strlen($name) > 30) {
throw new LengthException('Length of name should be less then 30 symbols');
}
return '`' . $name . '`';
}
}