Версия: 6.x
burger close
Класс Api
Граф наследования:Api:
EntityList BaseModel

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

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

Открытые члены

 __construct ()
 
 getList ($page=null, $page_size=null, $order=null)
 
 getDesktopNoticeTypes ()
 
 excludeLockedUserNotices ($notice_list, $user_id, $site_id=null)
 
 getUserLockedNotices ($user_id, $site_id=null)
 
 getAllLockedUserDesktopNotices ($user_id)
 
 getSenders ()
 
- Открытые члены унаследованные от EntityList
 __construct (AbstractObject $orm_element, array $options=[])
 
 setDefaultOrder ($order)
 
 getNameField ()
 
 setNameField ($field)
 
 setAliasField ($field)
 
 setSortField ($field)
 
 setIdField ($field)
 
 getIdField ()
 
 getSiteIdField ()
 
 setLoadOnDelete ($bool)
 
 setSiteContext ($site_id=null)
 
 getSiteContext ()
 
 setMultisite ($bool)
 
 isMultisite ()
 
 resetQueryObject ()
 
 getCleanQueryObject ()
 
 queryObj ()
 
 setQueryObj (\RS\Orm\Request $q)
 
 defAlias ()
 
 setFilter ($key, $value=null, $type= '=', $prefix= 'AND', array $options=[])
 
 clearFilter ()
 
 getList ($page=null, $page_size=null, $order=null)
 
 getListAsArray ($page=0, $page_size=0, $order= '')
 
 getListAsResource ($page=0, $page_size=0, $order= '')
 
 getPagedList ($page_size)
 
 loadAssocList ($key_field, $value=null)
 
 getAssocList ($key_field, $value=null)
 
 setOrder ($order=null, array $values=null)
 
 setGroup ($group=null)
 
 getListCount ()
 
 getFirst ()
 
 getOneItem ($id)
 
 getById ($id, $request=null)
 
 getElement ()
 
 setElement ($object)
 
 getElementClass ()
 
 getNewElement ()
 
 save ($id=null, array $user_post=[])
 
 addFilterControl (\RS\Html\Filter\Control $filter_control)
 
 addTableControl (\RS\Html\Table\Control $table_control)
 
 del (array $ids)
 
 multiDelete ($ids)
 
 getSelectList ($first=[])
 
 multieditFormView ($tpl_path, $formfile, array $addparam=[])
 
 multiUpdate (array $data, $ids=[])
 
 moveElement ($from, $to, $flag,\RS\Orm\Request $extra_expr=null)
 
 noWriteRights ($right=DefaultModuleRights::RIGHT_UPDATE)
 
 getIdByAlias ($alias_or_id, $alias_field=null)
 
 saveRequest ($key)
 
 getIdsByRequest (\RS\Orm\Request $request)
 
- Открытые члены унаследованные от BaseModel
 addError ($message, $fieldname=null, $form=null)
 
 hasError ()
 
 getErrors ()
 
 cleanErrors ()
 
 getDisplayErrors ()
 
 getErrorsStr ()
 
 getFormErrors ($form, $separator= ', ')
 
 getNonFormErrors ($separator= ', ')
 
 exportErrors ()
 
 importErrors ($data)
 

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

static selectSendersList ()
 
static getSenderByShortName ($name)
 
static getAllNoticeClasses ()
 
static getClassNameByPath ($file_path)
 
static getNoticeConfig ($class_name)
 
- Открытые статические члены унаследованные от EntityList
static getInstance ($key= 'default')
 
static staticSelectList ($first=[])
 
static getSavedRequest ($key, $default=null)
 

Дополнительные унаследованные члены

- Поля данных унаследованные от EntityList
const WHERE_CONDITION_VAR = 'where_conditions'
 
- Поля данных унаследованные от BaseModel
 $form_fieldname = []
 
 $errors_by_form = []
 
 $errors_non_form = []
 
 $errors = []
 
- Защищенные члены унаследованные от EntityList
 parseArrayFilter ($filters)
 
 filterLike ($key, $value, $type, $prefix, $options)
 
 filterIs ($key, $value, $type, $prefix, $options)
 
 filterFullText ($key, $value, $type, $prefix, $options)
 
 filterIn ($key, $value, $type, $prefix, $options)
 
 filterNotin ($key, $value, $type, $prefix, $options)
 
 filterDefault ($key, $value, $type, $prefix, $options)
 
 setPage ($page, $pageSize)
 
 moveArrayUp ($arr)
 
 moveArrayDown ($arr)
 
- Защищенные данные унаследованные от EntityList
 $default_order
 
 $load_on_delete = false
 
 $id_field = 'id'
 
 $alias_field
 
 $sort_field
 
 $name_field
 
 $site_id_field = 'site_id'
 
 $is_multisite = false
 
 $site_context
 
 $def_table_alias = 'A'
 
 $obj
 
 $obj_instance
 
 $filter_active = false
 
 $multiedit_template = '%system%/coreobject/multiedit_form.tpl'
 
 $assocPlainList = []
 
 $parsePrefixes = ['&' => 'AND'
 
 $q
 
- Защищенные данные унаследованные от BaseModel
 $default_error_fieldname = 'Информация'
 
- Статические защищенные данные унаследованные от EntityList
static $instance = []
 

Конструктор(ы)

__construct ( )

Методы

excludeLockedUserNotices (   $notice_list,
  $user_id,
  $site_id = null 
)

Исключает из списка уведомления, которые запрещены у пользователя

Аргументы
$notice_listсписок уведомлений
$user_idID пользователя
$site_idID сайта
Возвращает
array Возвращает те уведомления, которые не запрещены у пользователя
getAllLockedUserDesktopNotices (   $user_id)

Возвращает список заблокированных Desktop уведомлений для пользователя в рамках сайта

Аргументы
integer$user_idID пользователя
Возвращает
array()
static getAllNoticeClasses ( )
static

Получить полный список всех уведомлений системы

Возвращает
array
static getClassNameByPath (   $file_path)
static

Возвращает имя класса уведомления по пути к файлу

Аргументы
string$file_path
Возвращает
string
getDesktopNoticeTypes ( )

Возвращает список типов уведомлений, которые возможно отправить в Desktop Приложение

Возвращает
array
getList (   $page = null,
  $page_size = null,
  $order = null 
)

Возвращает список объектов, согласно заданным раннее условиям

Аргументы
integer$page- номер страницы
integer$page_size- количество элементов на страницу
string$order- условие сортировки
Возвращает
array of objects
static getNoticeConfig (   $class_name)
static

Возвращает объект NoticeConfig по имени класса уведомления

Аргументы
string$class_name
static getSenderByShortName (   $name)
static

Возвращает объект провайдера по его короткому строковому идентификатору

Аргументы
string$name
Возвращает
Sms
getSenders ( )

Возвращает список SMS-провайдеров.

Возвращает
array
getUserLockedNotices (   $user_id,
  $site_id = null 
)
Аргументы
$user_id
null$site_id
Возвращает
array
Исключения
\RS\Exception
static selectSendersList ( )
static

Возвращает список сервисов-отправителей SMS

Возвращает
array