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

Model
in

Class Model

Table of Contents

$dbController DbControllerModel
$queryData QueryData
$startIndex Стартовое значение для индекса. int
rules() Правила для обработки полей. Где 1 - Элемент это название поля, 2 - Элемент тип поля, max - Максимальная длина. array
attributeLabels() Массив с полями таблицы, где ключ это название поля, а значение краткое описание. array
tableName() Название таблицы/файла с данными. string
__construct() Model constructor. mixed
getId() Возвращаем название уникального ключа таблицы. int|string|null
init() Инициализация данных для модели. void
selectOne() Выполнение запроса с поиском по уникальному ключу. IModelRes
initData() Инициализация параметров для запроса void
save() Сохранение значения в базу данных. bool|mysqli_result|null
update() Обновление значения в таблице. bool|mysqli_result|null
add() Добавление значения в таблицу. bool|mysqli_result|null
delete() Удаление значения из таблицы. bool|mysqli_result|null
where() Выполнение запроса к данным. IModelRes
whereOne() Выполнение запроса и инициализация переменных в случае успешного запроса. bool
escapeString() mixed
query() mixed
validate() mixed

Properties

$startIndex

Стартовое значение для индекса.

public int $startIndex = ""

Methods

rules()

Правила для обработки полей. Где 1 - Элемент это название поля, 2 - Элемент тип поля, max - Максимальная длина.

public abstract rules( ) : array
Return values
array —

[

  • string|array 0: Название поля.
  • string 1: Тип поля (text, string, integer, ...).
  • int max: Максимальная длина строки. ]

attributeLabels()

Массив с полями таблицы, где ключ это название поля, а значение краткое описание.

public abstract attributeLabels( ) : array

Для уникального ключа использовать значение ID.

Return values
array

tableName()

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

public abstract tableName( ) : string
Return values
string

__construct()

Model constructor.

public __construct( ) : mixed
Return values
mixed

getId()

Возвращаем название уникального ключа таблицы.

protected getId( ) : int|string|null
Return values
int|string|null

init()

Инициализация данных для модели.

public init( $data : array ) : void
Parameters
$data : array

Массив с данными.

Tags
api

selectOne()

Выполнение запроса с поиском по уникальному ключу.

public selectOne( ) : IModelRes
Tags
api
Return values
IModelRes

initData()

Инициализация параметров для запроса

private initData( ) : void

save()

Сохранение значения в базу данных.

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

Если значение уже есть в базе данных, то данные обновятся. Иначе добавляется новое значение.

Parameters
$isNew : bool = false

Добавить новую запись в базу данных без поиска по ключу.

Tags
throws
api
Return values
bool|mysqli_result|null

update()

Обновление значения в таблице.

public update( ) : bool|mysqli_result|null
Tags
throws
Return values
bool|mysqli_result|null

add()

Добавление значения в таблицу.

public add( ) : bool|mysqli_result|null
Tags
throws
Return values
bool|mysqli_result|null

delete()

Удаление значения из таблицы.

public delete( ) : bool|mysqli_result|null
Tags
api
throws
Return values
bool|mysqli_result|null

where()

Выполнение запроса к данным.

public where( [ $where : array|string|null = null ] [, $isOne : bool = false ] ) : IModelRes
Parameters
$where : array|string|null = null

Запрос к таблице.

$isOne : bool = false

Вывести только 1 результат. Используется только при поиске по файлу.

Tags
api
Return values
IModelRes

whereOne()

Выполнение запроса и инициализация переменных в случае успешного запроса.

public whereOne( [ $where : array|string|null = [] ] ) : bool
Parameters
$where : array|string|null = []

Запрос к таблице.

Tags
api
Return values
bool

escapeString()

public escapeString( $str : string ) : mixed
Parameters
$str : string
Return values
mixed

query()

public query( $sql : string ) : mixed
Parameters
$sql : string
Return values
mixed

validate()

public validate( ) : mixed
Return values
mixed

Search results