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

Вспомогательный класс, отвечает за получение и установку сведений о прочитанных и непрочитанных объектах.

Открытые члены
	__construct ($site_id=null, $user_id=null)

	setDefaultEntity ($entity)

	setSiteId ($site_id)

	setUserId ($user_id)

	getLastReadedId ($entity=null)

	getReadedIds ($entity=null, $entity_ids_filter=null)

	getReadedCount ($entity=null)

	getUnreadCount ($total_or_object, $entity=null, $site_id_field= 'site_id', $id_field= 'id')

	markAsReaded ($entity_ids, $entity=null)

	markAllAsReaded ($last_id_or_object, $entity=null, $site_id_field= 'site_id', $user_id_field= 'user_id', $id_field= 'id')

	removeReadFlag ($ids, $entity=null)

Поля данных
const	LAST_ID_POSTFIX = '_LASTID'

	$site_id

	$user_id

Защищенные члены
	getEntity ($priority_entity)

Защищенные данные
	$entity

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

__construct	(	$site_id = `null`,
		$user_id = `null`
	)

Методы

getEntity ( $priority_entity )

protected

Возвращает тип объектов приоритетный или по умолчанию

Аргументы

$priority_entity приоритетный entity, возвращается именно он, если задан

Возвращает: string

Исключения

\RS\Exception Бросает исключение, если entity не задан

getLastReadedId ( $entity = null )

Возвращает ID последнего прочитанного объекта

Аргументы

string $entity Тип объектов

Возвращает: integer

getReadedCount ( $entity = null )

Возвращает количество прочитанных объектов

Аргументы

string $entity Тип объектов

Возвращает: mixed

getReadedIds	(	$entity = `null`,
		$entity_ids_filter = `null`
	)

Возвращает ID прочитанных объектов

Аргументы

string	$entity	Тип объектов
null \| array	$entity_ids_filter	Фильтр по ID объектов

Возвращает: array

getUnreadCount	(	$total_or_object,
		$entity = `null`,
		$site_id_field = `'site_id'`,
		$id_field = `'id'`
	)

Возвращает количество непрочитанных объектов

Аргументы

integer \| \RS\Orm\AbstractObject \| \RS\Orm\Request	$total_or_object	Общее количество объектов Если integer, то должно содержать общее количество объектов Если , то будет построен запрос на получение общего количества объектов Если , то будет построен запрос на основе данного запроса для получения общего количества объектов
string	$entity	Тип объектов
string	$site_id_field	Поле, в котором содержится ID сайта
string	$id_field	Поле, в котором содержится ID объекта

Возвращает: integer

Исключения

\RS\Exception Бросает исключение в случае некорректного типа объекта $total_or_object

markAllAsReaded	(	$last_id_or_object,
		$entity = `null`,
		$site_id_field = `'site_id'`,
		$user_id_field = `'user_id'`,
		$id_field = `'id'`
	)

Возвращает количество непрочитанных объектов

Аргументы

integer \| \RS\Orm\AbstractObject \| \RS\Orm\Request	$last_id_or_object	Общее количество объектов Если integer, то должно содержать общее количество объектов Если , то будет построен запрос на получение общего количества объектов Если , то будет построен запрос на основе данного запроса для получения общего количества объектов
string	$entity	Тип объектов
string	$site_id_field	Поле, в котором содержится ID сайта
string	$user_id_field	Поле, в котором содержится ID пользователя
string	$id_field	Поле, в котором содержится ID объекта

Возвращает: void

Исключения

\RS\Exception Бросает исключение в случае некорректного типа объекта $total_or_object

markAsReaded	(	$entity_ids,
		$entity = `null`
	)

Отмечает прочитанным объект

Аргументы

array \| integer	$entity_ids	ID или список ID объектов
string	$entity	Тип объекта

Возвращает: void

removeReadFlag	(	$ids,
		$entity = `null`
	)

Удаляет информацию о фактах просмотра объекта

Аргументы

	$ids
string \| null	$entity

Возвращает: integer

setDefaultEntity ( $entity )

Устанавливает ID метки, с которой будет работать текущий экземпляр класса

Возвращает

setSiteId ( $site_id )

Устанавливает текущий сайт, в рамках которого будет идти учет счетчиков

Аргументы

integer $site_id ID сайта

Возвращает: void

setUserId ( $user_id )

Устанавливает текущего пользователя, в рамках которого будет идти учет счетчиков

Аргументы

integer $user_id ID пользователя

Возвращает: void

Поля

$entity

protected

$site_id

$user_id

const LAST_ID_POSTFIX = '_LASTID'

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

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

Поля данных

Защищенные члены

Защищенные данные

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

Методы

Поля