Описание класса UsersData

UsersData extends Model
in

bot

models

Class UsersData

TABLE_NAME		'UsersData'
T_ALISA		0
T_VK		1
T_TELEGRAM		2
T_VIBER		3
T_MARUSIA		4
T_SMART_APP		5
T_USER_APP		512
$userId	Идентификатор пользователя (Уникальный ключ).	string\|null
$meta	Meta данные пользователя.	string\|array\|null
$data	Пользовательские данные.	string\|array\|null
$type	Тип записи (0 - Алиса; 1 - Vk; 2 - Telegram).	int
$dbController		DbControllerModel
$queryData		QueryData
$startIndex	Стартовое значение для индекса.	int
__construct()	UsersData constructor.	mixed
createTable()	Создание таблицы бд для хранения пользовательских данных.	bool\|mysqli_result\|null
dropTable()	Удаление таблицы бд для хранения пользовательских данных.	bool\|mysqli_result\|null
tableName()	Название таблицы/файла с данными.	string
rules()	Основные правила для полей.	array
attributeLabels()	Название атрибутов таблицы.	array
getOne()	Выполнение запроса на поиск одного значения.	bool
validate()	Валидация значений.	void
init()	Инициализация параметров.	void
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

TABLE_NAME


        
        mixed
        $TABLE_NAME
        = 'UsersData'

T_ALISA


        
        mixed
        $T_ALISA
        = ""

T_VK


        
        mixed
        $T_VK
        = 1

T_TELEGRAM


        
        mixed
        $T_TELEGRAM
        = 2

T_VIBER


        
        mixed
        $T_VIBER
        = 3

T_MARUSIA


        
        mixed
        $T_MARUSIA
        = 4

T_SMART_APP


        
        mixed
        $T_SMART_APP
        = 5

T_USER_APP


        
        mixed
        $T_USER_APP
        = 512

$userId

Идентификатор пользователя (Уникальный ключ).


        public
                string|null
        $userId

$meta

Meta данные пользователя.


        public
                string|array|null
        $meta

$data

Пользовательские данные.


        public
                string|array|null
        $data

$type

Тип записи (0 - Алиса; 1 - Vk; 2 - Telegram).


        public
                int
        $type

$dbController


        public
                DbControllerModel
        $dbController

$queryData


        public
                QueryData
        $queryData

$startIndex

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


        public
                int
        $startIndex
         = ""

__construct()

UsersData constructor.


        public
                                __construct(
                )
        : mixed

Return values

mixed

createTable()

Создание таблицы бд для хранения пользовательских данных.


        public
                                createTable(
                )
        : bool|mysqli_result|null

Return values

bool|mysqli_result|null

dropTable()

Удаление таблицы бд для хранения пользовательских данных.


        public
                                dropTable(
                )
        : bool|mysqli_result|null

Return values

bool|mysqli_result|null

tableName()

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


        public
                                tableName(
                )
        : string

Return values

string

rules()

Основные правила для полей.


        public
                                rules(
                )
        : array

Return values

array

attributeLabels()

Название атрибутов таблицы.


        public
                                attributeLabels(
                )
        : array

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

Return values

array

getOne()

Выполнение запроса на поиск одного значения.


        public
                                getOne(
                )
        : bool

В случае успешного поиска вернет true.

Return values

bool

validate()

Валидация значений.


        public
                                validate(
                )
        : void

init()

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

Parameters

$data : array: Массив с данными.

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()

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

Parameters

$data : array: Массив с данными.

selectOne()

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


        public
                                selectOne(
                )
        : IModelRes

Return values

IModelRes

initData()

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


        private
                                initData(
                )
        : void

save()

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


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

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

Parameters

$isNew : bool = false: Добавить новую запись в базу данных без поиска по ключу.

Return values

bool|mysqli_result|null

update()

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


        public
                                update(
                )
        : bool|mysqli_result|null

Return values

bool|mysqli_result|null

add()

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


        public
                                add(
                )
        : bool|mysqli_result|null

Return values

bool|mysqli_result|null

delete()

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


        public
                                delete(
                )
        : bool|mysqli_result|null

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 результат. Используется только при поиске по файлу.

Return values

IModelRes

whereOne()

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


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

Parameters

$where : array|string|null = []: Запрос к таблице.

Return values

bool

escapeString()


        public
                                escapeString(
                    
                            $str :
                string
                            
                )
        : mixed

Parameters

$str : string

Return values

mixed

query()

Parameters

$sql : string

Return values

mixed

validate()


        public
                                validate(
                )
        : mixed

Return values

mixed

UsersData extends Model in bot models

Table of Contents

Constants

TABLE_NAME

T_ALISA

T_VK

T_TELEGRAM

T_VIBER

T_MARUSIA

T_SMART_APP

T_USER_APP

Properties

$userId

$meta

$data

$type

$dbController

$queryData

$startIndex

Methods

__construct()

Return values

createTable()

Tags

Return values

dropTable()

Tags

Return values

tableName()

Tags

Return values

rules()

Tags

Return values

attributeLabels()

Tags

Return values

getOne()

Tags

Return values

validate()

Tags

init()

Parameters

Tags

rules()

Return values

attributeLabels()

Return values

tableName()

Return values

__construct()

Return values

getId()

Return values

init()

Parameters

Tags

selectOne()

Tags

Return values

initData()

save()

Parameters

Tags

Return values

update()

Tags

Return values

add()

Tags

Return values

delete()

Tags

Return values

where()

Parameters

Tags

Return values

whereOne()

UsersData extends Model
in

bot

models