Функции и методы

request()

Функция возвращает данные по текущему запросу.

Метод	Параметры	Описание
get($code = "")	$code - код параметра	Параметры запроса
header($code = "")	$header - код заголовка	Заголовки запроса
method()		Тип запроса
ip()		IP-адрес клиента
path()		Путь запроса
map()		Карта роута для обработки запроса

Пример: request()->get()

response()

Функция возвращает ответ клиенту. Имеется набор предустановленных ответов, которые реализованы согласно стандартам HTTP.

Метод	Параметры	Описание
json($data = [], $statusCode = 200, $options = [], $headers = [])	$data - данные ответа $statusCode - код ответа $options - параметры ответа (аналогичны функции json_encode) $headers - дополнительные заголовки ответа	Возращает ответ клиенту в JSON-формате
accepted()
badGateway()
badRequest($message = '')
conflict()
created($data = [])
failedDependency()
forbidden()
gone()
httpVersionNotSupported()
internalServerError($message = '')
invalidSslCertificate()
lengthRequired()
locked()
methodNotAllowed()
misdirectedRequest()
movedPermanently($location = '')
multipleChoices()
noContent()
nonAuthoritativeInformation()
notAcceptable()
notFound()
notImplemented()
notModified()
ok($data = [])
partialContent($contentRange = '')
payloadTooLarge($retryAfterSeconds = 60)
paymentRequired()
permanentRedirect($location = '')
preconditionFailed()
processing()
requestedHostUnavailable()
resetContent()
seeOther($location = '')
serviceUnavailable()
sslHandshakeFailed()
switchingProtocols($upgrade = '')
temporaryRedirect($location = '')
tooManyRequests()
unProcessableEntity()
unauthorized()
unavailableForLegalReasons()
unknownError()
unsupportedMediaType()
upgradeRequired()
uriTooLong()
useProxy($location = '')
webServerIsDown()

Пример: response()->json($data)

Пример: response()->ok()

cache()

Функция для работы с системным кэшем. Является обёрткой над системным классом Cache. Используется кэш установленный в настройках системы.

Метод	Параметры	Описание
get($id, $ttl = 86400, $dir = false)	$id - идентификатор $ttl - время жизни $dir - директория	Получение кэша по ID, если кэша нет, тогда инициализирует его
set($data)	$data - данные для кэша	Сохранение кэша в ранее инициализированный кэш
clear($dir)	$dir - директория	Очистка кэша

Пример: cache()->get($cacheId, $cacheTtl, $cacheDir)

journal()

Функция для работы c журналами.

Метод	Параметры	Описание
add($type, $data = [], $clientId = '')	$type - тип журнала $data - данные $clientId - ID клиента	Запись данных в журнал

Тип журнала Входящие запросы: request-response

Пример: journal()->add('request-response', ['request' => request()->get(), 'response' => $response]);

db()

Функция возвращает текущее подключение к базе данных. Является обёрткой над системным методом getConnection() класса Application.

Метод	Параметры	Описание
query($sql)	$sql - строка SQL-запроса	Выполнение запроса

Пример: db()->query($sql)

token()

Функция для работы с токенами.

Метод	Параметры	Описание
getData($token)	$token - токен клиента	Возвращает информацию по токену
getDataByUserId($userId)	$userId - ID пользователя	Возвращает данные токена по ID пользователя
getExpirationDate($token)	$token - токен клиента	Возвращает срок годности токена
updateExpirationDate($token)	$token - токен клиента	Обновляет срок годности токена, согласно настройкам Безопасности модуля
delete($token)	$token - токен клиента	Удаляет токен пользователя
generate($parameters = [], $update = false)	$parameters - все те же ключи, что и для метода UserTable::getList() $update - флаг для регулирования - обновлять уже созданные токены или же создать новые токены	Генерация токенов для пользователей

Пример: token()->getData('8f757146-097eb57b-b07d669e-112463ff')

Пример: token()->generate(['filter' => ['>ID' => 30]], true)