DbConnect
extends DbControllerModel
in
Абстрактный класс служащий прослойкой между логикой ядра и подключением к БД.
Необходим для корректной настройки контролла, отвечающего за сохранение пользовательских данных. Все прикладные контроллы должны быть унаследованы от него.
Class DbControllerModel
Table of Contents
| $query | Переменная, отвечающая за отправку curl запросов | Request |
|---|---|---|
| $tableName | Название таблицы | |
| $rules | Правила для полей бд. Указывается тип каждого поля. | |
| $connectConfig | Конфигурация для настройки подключения к БД. | |
| $primaryKeyName | Название поля, которое является уникальным ключом | |
| __construct() | mixed | |
| getValue() | Приводим полученный результат из запроса к требуемому виду. | mixed|null |
| select() | Отправляем запрос на получение данных | IModelRes |
| insert() | Отправляем запрос на добавление данных | mixed|IModelRes |
| update() | Выполняем запрос на обновление данных | mixed|IModelRes |
| save() | Выполняем запрос на сохранение данных. | mixed|IModelRes |
| delete() | Выполняем запрос на удаление данных | mixed|IModelRes |
| query() | Выполняем произвольный запрос | mixed|IModelRes |
| __construct() | mixed | |
| setPrimaryKeyName() | Устанавливает имя уникального ключа | mixed |
| getPrimaryKeyName() | получение имени уникального ключа | mixed |
| setRules() | Устанавливает правила для полей | mixed |
| getValue() | Приводит полученный результат к требуемому типу. | mixed |
| select() | Выполнение запроса на поиск записей в источнике данных Возвращает массив вида: [ 'status': bool, 'data': mixed, 'error': string ], где: status - статус выполнения запроса data - результат выполнения запроса error - ошибки, возникшие во время выполнения запроса | IModelRes |
| insert() | Выполнение запроса на добавление записи в источник данных | mixed |
| update() | Выполнение запроса на обновление записи в источнике данных | mixed |
| save() | Выполнение запроса на сохранения записи. | mixed |
| delete() | Выполнение запроса на удаление записи в источнике данных | mixed |
| query() | Выполнение произвольного запроса к источнику данных | mixed |
| escapeString() | Декодирование текста(Текст становится приемлемым и безопасным для sql запроса). | string |
Properties
$query
Переменная, отвечающая за отправку curl запросов
private
Request
$query
$tableName
Название таблицы
public
mixed
$tableName
$rules
Правила для полей бд. Указывается тип каждого поля.
protected
mixed
$rules
$connectConfig
Конфигурация для настройки подключения к БД.
protected
mixed
$connectConfig
$primaryKeyName
Название поля, которое является уникальным ключом
protected
mixed
$primaryKeyName
Methods
__construct()
public
__construct(
)
: mixed
Return values
mixedgetValue()
Приводим полученный результат из запроса к требуемому виду.
public
getValue(
$res :
IModelRes|null
)
: mixed|null
В данном случае, ожидаем что полученные данные будут вида: [ 'key' => 'value' ]
Parameters
- $res : IModelRes|null
Результат выполнения запроса
Return values
mixed|nullselect()
Отправляем запрос на получение данных
public
select(
$select :
array
[, $isOne :
bool
= false ]
)
: IModelRes
Parameters
- $select : array
Данные для поиска значения
- $isOne : bool = false
Вывести только 1 запись.
Return values
IModelResinsert()
Отправляем запрос на добавление данных
public
insert(
$insertData :
QueryData
)
: mixed|IModelRes
Parameters
- $insertData : QueryData
Данные для добавления записи
Return values
mixed|IModelResupdate()
Выполняем запрос на обновление данных
public
update(
$updateData :
QueryData
)
: mixed|IModelRes
Parameters
- $updateData : QueryData
Данные для обновления записи
Return values
mixed|IModelRessave()
Выполняем запрос на сохранение данных.
public
save(
$insertData :
QueryData
[, $isNew :
bool
= false ]
)
: mixed|IModelRes
Тут суть в том, что если данных для обновления нет, то будет добавлена новая запись.
Parameters
- $insertData : QueryData
Данные для сохранения записи
- $isNew : bool = false
Определяет необходимость добавления новой записи
Return values
mixed|IModelResdelete()
Выполняем запрос на удаление данных
public
delete(
$deleteData :
QueryData
)
: mixed|IModelRes
Parameters
- $deleteData : QueryData
Данные для удаления записи
Return values
mixed|IModelResquery()
Выполняем произвольный запрос
public
query(
$sql :
string
)
: mixed|IModelRes
Parameters
- $sql : string
Запрос, который необходимо выполнить
Return values
mixed|IModelRes__construct()
public
__construct(
)
: mixed
Return values
mixedsetPrimaryKeyName()
Устанавливает имя уникального ключа
public
setPrimaryKeyName(
$primaryKeyName :
mixed
)
: mixed
Parameters
- $primaryKeyName : mixed
Return values
mixedgetPrimaryKeyName()
получение имени уникального ключа
public
getPrimaryKeyName(
)
: mixed
Return values
mixedsetRules()
Устанавливает правила для полей
public
setRules(
$rules :
)
: mixed
Parameters
Return values
mixedgetValue()
Приводит полученный результат к требуемому типу.
public
abstract getValue(
$res :
IModelRes|null
)
: mixed
В качестве результата должен вернуться массив вида: [ key => value ] где key - порядковый номер поля(0, 1... 3), либо название поля. Рекомендуется использовать имя поля. Важно чтобы имя поля было указано в rules, имена не входящие в rules будут проигнорированы. value - значение поля.
Parameters
- $res : IModelRes|null
Результат выполнения запроса
Tags
Return values
mixedselect()
Выполнение запроса на поиск записей в источнике данных Возвращает массив вида: [ 'status': bool, 'data': mixed, 'error': string ], где: status - статус выполнения запроса data - результат выполнения запроса error - ошибки, возникшие во время выполнения запроса
public
abstract select(
$select :
array
[, $isOne :
bool
= false ]
)
: IModelRes
Parameters
- $select : array
Данные для поиска значения
- $isOne : bool = false
Вывести только 1 запись.
Return values
IModelResinsert()
Выполнение запроса на добавление записи в источник данных
public
abstract insert(
$insertData :
QueryData
)
: mixed
Parameters
- $insertData : QueryData
Данные для добавления записи
Return values
mixedupdate()
Выполнение запроса на обновление записи в источнике данных
public
abstract update(
$updateData :
QueryData
)
: mixed
Parameters
- $updateData : QueryData
Данные для обновления записи
Return values
mixedsave()
Выполнение запроса на сохранения записи.
public
abstract save(
$insertData :
QueryData
[, $isNew :
bool
= false ]
)
: mixed
Обновление записи происходит в том случае, если запись присутствует в источнике данных. Иначе будет добавлена новая запись.
Parameters
- $insertData : QueryData
Данные для сохранения записи
- $isNew : bool = false
Определяет необходимость добавления новой записи
Return values
mixeddelete()
Выполнение запроса на удаление записи в источнике данных
public
abstract delete(
$deleteData :
QueryData
)
: mixed
Parameters
- $deleteData : QueryData
Данные для удаления записи
Return values
mixedquery()
Выполнение произвольного запроса к источнику данных
public
abstract query(
$sql :
string
)
: mixed
Parameters
- $sql : string
Запрос, который необходимо выполнить
Return values
mixedescapeString()
Декодирование текста(Текст становится приемлемым и безопасным для sql запроса).
public
escapeString(
$str :
string
)
: string
Parameters
- $str : string
Исходный текст