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

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

Класс предоставляет API для управления счетчиком просмотра одного объекта

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

 __construct (\RS\Orm\AbstractObject $orm_object, $meter_id, $site_id=null, $user_id=null)
 
 getMeterId ()
 
 getUnviewedCounter ()
 
 markAsViewed ($ids)
 
 markAllAsViewed ()
 
 removeViewedFlag ($ids)
 

Поля данных

 $orm_object
 
 $user_id
 
 $site_id
 
 $meter_id
 

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

__construct ( \RS\Orm\AbstractObject  $orm_object,
  $meter_id,
  $site_id = null,
  $user_id = null 
)

MeterApi constructor.

Аргументы
\RS\Orm\AbstractObject$orm_objectORM объект, с которым будет работать счетчик
string$meter_idID счетчика
integer | null$site_idID текущего сайта. Если не указан, то будет взят из системы
integer | null$user_idID текущего пользователя. Если не указан, то будет взят из системы

Методы

getMeterId ( )

Возвращает идентификатор счетчика

Возвращает
string

Замещает MeterApiInterface.

getUnviewedCounter ( )

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

Аргументы
integer | null$user_id
Возвращает
integer

Замещает MeterApiInterface.

markAllAsViewed ( )

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

Аргументы
integer | null$user_id
Возвращает
integer

Замещает MeterApiInterface.

markAsViewed (   $ids)

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

Аргументы
mixed$ids
Возвращает
integer

Замещает MeterApiInterface.

removeViewedFlag (   $ids)

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

Возвращает
integer

Замещает MeterApiInterface.

Поля

$meter_id
$orm_object
$site_id
$user_id