Описание класса DbController | Universal Bot

DbController extends DbControllerModel
in

Абстрактный класс служащий прослойкой между логикой ядра и подключением к БД.

Необходим для корректной настройки контролла, отвечающего за сохранение пользовательских данных. Все прикладные контроллы должны быть унаследованы от него.

Class DbControllerModel

Table of Contents

$db Подключение к базе данных. Sql|null
$tableName Название таблицы
$rules Правила для полей бд. Указывается тип каждого поля.
$connectConfig Конфигурация для настройки подключения к БД.
$primaryKeyName Название поля, которое является уникальным ключом
__construct() mixed
getValue() Приводит полученный результат к требуемому типу. mixed|null
getTableName() Название таблицы/файла с данными. string
insert() Выполнение запроса на добавление записи в источник данных bool|mysqli_result|null
update() Выполнение запроса на обновление записи в источнике данных bool|mysqli_result|null
save() Выполнение запроса на сохранения записи. bool|mysqli_result|null
isSelected() Наличие записи в таблице bool
select() Выполнение запроса на поиск записей в источнике данных Возвращает массив вида: [ 'status': bool, 'data': mixed, 'error': string ], где: status - статус выполнения запроса data - результат выполнения запроса error - ошибки, возникшие во время выполнения запроса IModelRes
query() Выполнение произвольного запроса к источнику данных bool|mysqli_result|null
delete() Выполнение запроса на удаление записи в источнике данных bool|mysqli_result|null
escapeString() Декодирование текста(Текст становится приемлемым и безопасным для sql запроса). string
validate() Валидация значений полей для таблицы. array
getFileData() Получение всех значений из файла. Актуально если переменная mmApp::$isSaveDb равна false. array|mixed
__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

$db

Подключение к базе данных.

public Sql|null $db

$rules

Правила для полей бд. Указывается тип каждого поля.

protected mixed $rules

$connectConfig

Конфигурация для настройки подключения к БД.

protected mixed $connectConfig

$primaryKeyName

Название поля, которое является уникальным ключом

protected mixed $primaryKeyName

Methods

__construct()

public __construct( ) : mixed
Return values
mixed

getValue()

Приводит полученный результат к требуемому типу.

public getValue( $res : IModelRes|null ) : mixed|null

В качестве результата должен вернуться массив вида: [ key => value ] где key - порядковый номер поля(0, 1... 3), либо название поля. Рекомендуется использовать имя поля. Важно чтобы имя поля было указано в rules, имена не входящие в rules будут проигнорированы. value - значение поля.

Parameters
$res : IModelRes|null

Результат выполнения запроса

Tags
see
Return values
mixed|null

getTableName()

Название таблицы/файла с данными.

protected getTableName( ) : string
Return values
string

insert()

Выполнение запроса на добавление записи в источник данных

public insert( $insertQuery : QueryData ) : bool|mysqli_result|null
Parameters
$insertQuery : QueryData

Данные для добавления записи

Tags
throws
Return values
bool|mysqli_result|null

update()

Выполнение запроса на обновление записи в источнике данных

public update( $updateQuery : QueryData ) : bool|mysqli_result|null
Parameters
$updateQuery : QueryData

Данные для обновления записи

Tags
throws
Return values
bool|mysqli_result|null

save()

Выполнение запроса на сохранения записи.

public save( $queryData : QueryData [, $isNew : bool = false ] ) : bool|mysqli_result|null

Обновление записи происходит в том случае, если запись присутствует в источнике данных. Иначе будет добавлена новая запись.

Parameters
$queryData : QueryData

Данные для сохранения записи

$isNew : bool = false

Определяет необходимость добавления новой записи

Tags
throws
Return values
bool|mysqli_result|null

isSelected()

Наличие записи в таблице

protected isSelected( $select : array ) : bool
Parameters
$select : array

Запрос

Return values
bool

select()

Выполнение запроса на поиск записей в источнике данных Возвращает массив вида: [ 'status': bool, 'data': mixed, 'error': string ], где: status - статус выполнения запроса data - результат выполнения запроса error - ошибки, возникшие во время выполнения запроса

public select( $select : array [, $isOne : bool = false ] ) : IModelRes
Parameters
$select : array

Данные для поиска значения

$isOne : bool = false

Вывести только 1 запись.

Return values
IModelRes

query()

Выполнение произвольного запроса к источнику данных

public query( $sql : string ) : bool|mysqli_result|null
Parameters
$sql : string

Запрос, который необходимо выполнить

Tags
api
Return values
bool|mysqli_result|null

delete()

Выполнение запроса на удаление записи в источнике данных

public delete( $queryDelete : QueryData ) : bool|mysqli_result|null
Parameters
$queryDelete : QueryData

Данные для удаления записи

Tags
throws
Return values
bool|mysqli_result|null

escapeString()

Декодирование текста(Текст становится приемлемым и безопасным для sql запроса).

public final escapeString( $text : string ) : string
Parameters
$text : string

Исходный текст.

Tags
api
Return values
string

validate()

Валидация значений полей для таблицы.

public validate( $element : array ) : array
Parameters
$element : array
Tags
api
Return values
array

getFileData()

Получение всех значений из файла. Актуально если переменная mmApp::$isSaveDb равна false.

public getFileData( ) : array|mixed
Tags
api
Return values
array|mixed

setPrimaryKeyName()

Устанавливает имя уникального ключа

public setPrimaryKeyName( $primaryKeyName : mixed ) : mixed
Parameters
$primaryKeyName : mixed
Return values
mixed

getPrimaryKeyName()

получение имени уникального ключа

public getPrimaryKeyName( ) : mixed
Return values
mixed

setRules()

Устанавливает правила для полей

public setRules( $rules : ) : mixed
Parameters
$rules :
Return values
mixed

getValue()

Приводит полученный результат к требуемому типу.

public abstract getValue( $res : IModelRes|null ) : mixed

В качестве результата должен вернуться массив вида: [ key => value ] где key - порядковый номер поля(0, 1... 3), либо название поля. Рекомендуется использовать имя поля. Важно чтобы имя поля было указано в rules, имена не входящие в rules будут проигнорированы. value - значение поля.

Parameters
$res : IModelRes|null

Результат выполнения запроса

Tags
see
Return values
mixed

select()

Выполнение запроса на поиск записей в источнике данных Возвращает массив вида: [ '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
IModelRes

insert()

Выполнение запроса на добавление записи в источник данных

public abstract insert( $insertData : QueryData ) : mixed
Parameters
$insertData : QueryData

Данные для добавления записи

Return values
mixed

update()

Выполнение запроса на обновление записи в источнике данных

public abstract update( $updateData : QueryData ) : mixed
Parameters
$updateData : QueryData

Данные для обновления записи

Return values
mixed

save()

Выполнение запроса на сохранения записи.

public abstract save( $insertData : QueryData [, $isNew : bool = false ] ) : mixed

Обновление записи происходит в том случае, если запись присутствует в источнике данных. Иначе будет добавлена новая запись.

Parameters
$insertData : QueryData

Данные для сохранения записи

$isNew : bool = false

Определяет необходимость добавления новой записи

Return values
mixed

delete()

Выполнение запроса на удаление записи в источнике данных

public abstract delete( $deleteData : QueryData ) : mixed
Parameters
$deleteData : QueryData

Данные для удаления записи

Return values
mixed

query()

Выполнение произвольного запроса к источнику данных

public abstract query( $sql : string ) : mixed
Parameters
$sql : string

Запрос, который необходимо выполнить

Return values
mixed

escapeString()

Декодирование текста(Текст становится приемлемым и безопасным для sql запроса).

public escapeString( $str : string ) : string
Parameters
$str : string

Исходный текст

Return values
string

Search results