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

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

API для работы с токенами push уведомлений

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

 __construct ()
 
 sendPushMessageToUsers (\PushSender\Model\Orm\PushTokenMessage $push_message, $ids, $offset, $limit=100)
 
- Открытые члены унаследованные от 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 registerUserToken ($push_token, $app, $user_id=null, $device=[], $update_user_id=null)
 
static getPushTokensByUserIds ($user_ids, $app)
 
static filterUserIds ($user_ids, $push_id, $app_id)
 
- Открытые статические члены унаследованные от 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 ( )

Методы

static filterUserIds (   $user_ids,
  $push_id,
  $app_id 
)
static

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

Аргументы
array$user_idsсписок ID пользователей
string$push_idID уведомления
string$app_idID приложения
Возвращает
array
static getPushTokensByUserIds (   $user_ids,
  $app 
)
static

Возвращает список push токенов для списка пользователей. Если для какого либо пользователя нет токена, то данный пользователь игнорируется.

Аргументы
array$user_ids
string$app
Возвращает
array
static registerUserToken (   $push_token,
  $app,
  $user_id = null,
  $device = [],
  $update_user_id = null 
)
static

Регистрирует token пользователя в локальной базе

Аргументы
string$push_token- Токен устройства-получателя Push уведомлений
string$app- Идентификатор приложения
integer$user_id- ID пользователя
array$device- Массив сведений об устройстве
boolean$update_user_id- Флаг отвечающий за принудительную перезапись id пользователя
Исключения
\RS\Orm\Exception
Возвращает
Orm
Исключения
\RS\Orm\Exception
sendPushMessageToUsers ( \PushSender\Model\Orm\PushTokenMessage  $push_message,
  $ids,
  $offset,
  $limit = 100 
)

Отправка PUSH уведомлений на телефоны пользователей, по PUSH токенам

Аргументы
\PushSender\Model\Orm\PushTokenMessage$push_message- объект cообщение PUSH уведомления
array$ids- массив c id получателей
$offset- индекс первого отправляемого элемента
int$limit- количество сообщени, которое отправляется за 1 шаг
Возвращает
bool|int