Версия: 6.x
burger close
Открытые статические члены
Класс Utils

Подробное описание

Вспомогательные возможности для внешних API общего назначения

Открытые статические члены

static extractOrm (\RS\Orm\AbstractObject $orm_object, $change_link_fields=['description', 'html', 'content'], $use_cache=true)
 
static extractOrmList ($list_of_orm_objects, $index_key=null)
 
static prepareLinks ($text)
 
static extractOrmTreeList ($list_of_orm_objects)
 
static getConstantComments (\ReflectionClass $reflection)
 
static prepareHTML ($body)
 
static checkAppIsRegistered ($client_id, $client_secret)
 
static getApiUrls ()
 
static prepareDatetimeIso (array $row, $time_offset= '')
 
static prepareDatetimeIsoList (array $rows, $time_offset= '')
 

Методы

static checkAppIsRegistered (   $client_id,
  $client_secret 
)
static

Проверяет зарегистрировано ли в системе приложение по его секретному ключу и идентификатору, если нет то кидает исключение

Аргументы
string$client_id- id клиентского приложения
string$client_secret- секретный ключ приложения
Возвращает
AbstractAppType
static extractOrm ( \RS\Orm\AbstractObject  $orm_object,
  $change_link_fields = ['description',
'html'  ,
'content']  ,
  $use_cache = true 
)
static
static extractOrmList (   $list_of_orm_objects,
  $index_key = null 
)
static

Возвращает значения свойств ORM объектов в списке, которые разрешены для отдачи через API

Аргументы
array$list_of_orm_objects- массив объектов
string$index_key- указывается если необходим информация по определённому ключу
Возвращает
array
static extractOrmTreeList (   $list_of_orm_objects)
static

Возвращает значения свойств ORM объектов в списке, которые разрешены для отдачи через API

Аргументы
array$list_of_orm_objects- массив объектов
Возвращает
array
static getApiUrls ( )
static

Возвращает список адресов для API

Возвращает
array
static getConstantComments ( \ReflectionClass  $reflection)
static

Возвращает PHPDoc комментарии к константам, т.к. в Reflection такого, к сожалению, на сегодняшний день нет

Аргументы
\ReflectionClass$reflection
Возвращает
array
static prepareDatetimeIso ( array  $row,
  $time_offset = '' 
)
static

Формирует дату в формате ISO8601 у значений массива, где есть дата. Такая дата содержит смещение времени на сервере, что позволяет корректно отобразить дату с учетом локальной временной зоны на клиентском устройстве.

Аргументы
array$rowМассив Ключ => Значение, где в значениях размещается дата
string$time_offsetСмещение времени, относительно GMT. В формате "+ЧЧ:ММ". По умолчанию временная зона берется из настроек системы
Возвращает
array
static prepareDatetimeIsoList ( array  $rows,
  $time_offset = '' 
)
static

Формирует дату в формате ISO8601 у значений массива в списке, где есть дата.

Аргументы
array[]$rows Массив массивов со значениями
string$time_offsetСмещение времени, относительно GMT. В формате "+ЧЧ:ММ".
Возвращает
array
static prepareHTML (   $body)
static

Изменяет ссылки в HTML на абсолютные

Аргументы
string$body- HTML для редактирования
Возвращает
string
static prepareLinks (   $text)
static

Изменяет относительные ссылки на абсолютные

Аргументы
string$text
Возвращает
string