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

mmApp
in

Статический класс, хранящий состояние и параметры приложения.

Class mmApp

Table of Contents

$userDbController Использование стороннего контроллера для подключения к БД. DbControllerModel|null
$isSaveDb Куда сохраняются пользовательские данные. Если false, то данные сохраняются в файл, иначе в бд. По умолчанию false.
$appType Тип приложения. (Алиса, бот vk|telegram). string
$config Основная конфигурация приложения. array
$params Основные параметры приложения. array
arrayMerge() Объединение 2 массивов. array
setConfig() Инициализация конфигурации приложения. void
setParams() Инициализация параметров приложения. void
setIsSaveDb() Переопределения места, для хранения данных пользователя. void
saveJson() Сохранение данных в json файл. bool
saveLog() Сохранение логов. bool

Properties

$userDbController

Использование стороннего контроллера для подключения к БД.

public static DbControllerModel|null $userDbController = null
Класс должен быть унаследован от DbControllerModel. Стоит применять в том случае, если используется другая СУБД. Если опция не передается, то используется стандартное подключение MySql.

$isSaveDb

Куда сохраняются пользовательские данные. Если false, то данные сохраняются в файл, иначе в бд. По умолчанию false.

public static mixed $isSaveDb = false

$appType

Тип приложения. (Алиса, бот vk|telegram).

public static string $appType

$config

Основная конфигурация приложения.

public static array $config = ['error_log' => __DIR__ . '/../../logs', 'json' => __DIR__ . '/../../json', 'db' => [ 'host' => null, // Адрес расположения базы данных (localhost, https://example.com) 'user' => null, // Имя пользователя 'pass' => null, // Пароль пользователя 'database' => null, ], 'isLocalStorage' => false]

$params

Основные параметры приложения.

public static array $params = ['viber_token' => null, 'viber_sender' => null, 'viber_api_version' => null, 'telegram_token' => null, 'vk_api_version' => null, 'vk_confirmation_token' => null, 'vk_token' => null, 'marusia_token' => null, 'yandex_token' => null, 'yandex_speech_kit_token' => null, 'y_isAuthUser' => false, 'app_id' => null, 'user_id' => null, 'welcome_text' => 'Текст приветствия', 'help_text' => 'Текст помощи', 'intents' => [[ 'name' => WELCOME_INTENT_NAME, // Название команды приветствия 'slots' => [ // Слова, на которые будет срабатывать приветствие 'привет', 'здравст', ], ], [ 'name' => HELP_INTENT_NAME, // Название команды помощи 'slots' => [ // Слова, на которые будет срабатывать помощь 'помощ', 'что ты умеешь', ], ]], 'utm_text' => null]

Methods

arrayMerge()

Объединение 2 массивов.

public static arrayMerge( $array1 : array , $array2 : array|null ) : array
Parameters
$array1 : array

Массив с котором необходимо объединить значение.

$array2 : array|null

Массив для объединения.

Tags
api
Return values
array

setConfig()

Инициализация конфигурации приложения.

public static setConfig( $config : array ) : void
Parameters
$config : array

Пользовательская конфигурация.

Tags
api

setParams()

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

public static setParams( $params : array ) : void
Parameters
$params : array

Пользовательские параметры.

Tags
api

setIsSaveDb()

Переопределения места, для хранения данных пользователя.

public static setIsSaveDb( [ $isSaveDb : bool = false ] ) : void
Parameters
$isSaveDb : bool = false

Если true, то данные сохраняются в БД, иначе в файл.

saveJson()

Сохранение данных в json файл.

public static saveJson( $fileName : string , $data : array|null ) : bool
Parameters
$fileName : string

Название файла.

$data : array|null

Сохраняемые данные.

Tags
throws
api
Return values
bool

saveLog()

Сохранение логов.

public static saveLog( $fileName : string , $errorText : string ) : bool
Parameters
$fileName : string

Название файла.

$errorText : string

Текст ошибки.

Tags
throws
api
Return values
bool

Search results