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

Alisa extends TemplateTypeModel

Класс, отвечающий за корректную инициализацию и отправку ответа для Алисы Class Alisa

Table of Contents

VERSION '1.0'
MAX_TIME_REQUEST 2.8
$session Информация о сессии пользователя. array|null
$isState Использование хранилища. True - используется, false - нет. bool
$stateName Название хранилища. Зависит от того, от куда берутся данные (локально, глобально). string|null
$controller Класс с логикой приложения. BotController|null
$error Строка с ошибками, произошедшими при работе приложения. string|null
$timeStart Время начала работы приложения. float|int|null
$isUsedLocalStorage Использование локального хранилища как БД. bool
getResponse() Получение данных, необходимых для построения ответа пользователю. array
init() Инициализация основных параметров. В случае успешной инициализации, вернет true, иначе false. bool
getContext() Получение ответа, который отправится пользователю. В случае с Алисой, Марусей и Сбер, возвращается json. С остальными типами, ответ отправляется непосредственно на сервер. string
getLocalStorage() Получение данные из локального хранилища Алисы array|null
isLocalStorage() Проверка на использование локального хранилища bool
__construct() mixed
initProcessingTime() Установка начального времени. void
getProcessingTime() Получить время выполнения программы. int|float
getError() Получение текста с ошибкой при выполнении программы. string|null
init() Инициализация основных параметров. В случае успешной инициализации, вернет true, иначе false. bool
getContext() Получение ответа, который отправится пользователю. В случае с Алисой, Марусей и Сбер, возвращается json. С остальными типами, ответ отправляется непосредственно на сервер. string
getRatingContext() Отправка ответа для выставления оценки приложеня. Актуально для Сбер. Для остальных приложений вызовется getContext() string
isLocalStorage() Доступно ли использование локального хранилища. bool
getLocalStorage() Возвращаем данные из хранилища. array|null
setLocalStorage() Сохранение данных в хранилище. void

Constants

VERSION

mixed $VERSION = '1.0'

MAX_TIME_REQUEST

mixed $MAX_TIME_REQUEST = 2.8

Properties

$session

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

protected array|null $session

$isState

Использование хранилища. True - используется, false - нет.

protected bool $isState = false

$stateName

Название хранилища. Зависит от того, от куда берутся данные (локально, глобально).

protected string|null $stateName

$error

Строка с ошибками, произошедшими при работе приложения.

protected string|null $error

$timeStart

Время начала работы приложения.

protected float|int|null $timeStart

$isUsedLocalStorage

Использование локального хранилища как БД.

public bool $isUsedLocalStorage

Methods

getResponse()

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

protected getResponse( ) : array
Tags
throws
Return values
array

init()

Инициализация основных параметров. В случае успешной инициализации, вернет true, иначе false.

public init( $content : string|null , &$controller : BotController ) : bool
Parameters
$content : string|null

Запрос пользователя.

$controller : BotController

Ссылка на класс с логикой навык/бота.

Tags
throws
api
see

Смотри тут

Return values
bool

getContext()

Получение ответа, который отправится пользователю. В случае с Алисой, Марусей и Сбер, возвращается json. С остальными типами, ответ отправляется непосредственно на сервер.

public getContext( ) : string
Tags
throws
api
see

Смотри тут

Return values
string

getLocalStorage()

Получение данные из локального хранилища Алисы

public getLocalStorage( ) : array|null
Return values
array|null

isLocalStorage()

Проверка на использование локального хранилища

public isLocalStorage( ) : bool

Если доступно, и используется опция для сохранения данных в хранилище, тогда пользовательские данные не будут сохраняться в БД.

Return values
bool

initProcessingTime()

Установка начального времени.

private initProcessingTime( ) : void

Необходимо для определения времени выполнения программы.

getProcessingTime()

Получить время выполнения программы.

public getProcessingTime( ) : int|float
Tags
api
Return values
int|float

getError()

Получение текста с ошибкой при выполнении программы.

public getError( ) : string|null
Tags
api
Return values
string|null

init()

Инициализация основных параметров. В случае успешной инициализации, вернет true, иначе false.

public abstract init( $content : string|null , &$controller : BotController ) : bool
Parameters
$content : string|null

Запрос пользователя.

$controller : BotController

Ссылка на класс с логикой навык/бота.

Tags
api
Return values
bool

getContext()

Получение ответа, который отправится пользователю. В случае с Алисой, Марусей и Сбер, возвращается json. С остальными типами, ответ отправляется непосредственно на сервер.

public abstract getContext( ) : string
Return values
string

getRatingContext()

Отправка ответа для выставления оценки приложеня. Актуально для Сбер. Для остальных приложений вызовется getContext()

public getRatingContext( ) : string
Return values
string

isLocalStorage()

Доступно ли использование локального хранилища.

public isLocalStorage( ) : bool

Если доступно, и используется опция для сохранения данных в хранилище, тогда пользовательские данные не будут сохраняться в БД.

Tags
api
Return values
bool

getLocalStorage()

Возвращаем данные из хранилища.

public getLocalStorage( ) : array|null
Tags
api
Return values
array|null

setLocalStorage()

Сохранение данных в хранилище.

public setLocalStorage( $data : array|null ) : void
Parameters
$data : array|null

сохраняемые данные

Tags
api

Search results