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

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

Интерфейс, содержащий функции по работе со счетчиками

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

 getMeterId ()
 
 getUnviewedCounter ()
 
 markAsViewed ($ids)
 
 markAllAsViewed ()
 
 removeViewedFlag ($ids)
 

Методы

getMeterId ( )

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

Возвращает
string

Замещается в MeterApi и TopicMeterApi.

getUnviewedCounter ( )

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

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

Замещается в MeterApi и TopicMeterApi.

markAllAsViewed ( )

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

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

Замещается в MeterApi и TopicMeterApi.

markAsViewed (   $ids)

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

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

Замещается в MeterApi и TopicMeterApi.

removeViewedFlag (   $ids)

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

Возвращает
integer

Замещается в MeterApi и TopicMeterApi.