Версия: 5.x
Класс RsNewsApi

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

Обеспечивает взаимодействие с сервером ReadyScript для получения новостей, а также управляет счетчиками

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

 __construct ($user_id=null)
 
 getNewsList ($page, $pageSize)
 
 checkNews ()
 
 getTotal ()
 
 setTotal ($total)
 
 markAsViewed ($id)
 
 markAllAsViewed ()
 
 getLastError ()
 

Поля данных

const LINK_TYPE_EXTERNAL = 'external'
 
const LINK_TYPE_CLIENT_ADMIN = 'client-admin'
 
const LINK_TYPE_CLIENT = 'client'
 
const LAST_ID_KEY = 'rs-news-last-id-'
 
const LAST_VIEWED_ID_KEY = 'rs-news-last-viewed-id-'
 
const TOTAL_KEY = 'rs-news-total'
 
const METER_KEY = 'rs-news'
 
 $error
 
 $user_id
 

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

 setLastId ($last_id)
 
 getLastId ()
 
 getLastViewedId ()
 
 getLink ($link, $link_type)
 
 requester ($method, $params=array())
 

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

 $readitem_api
 

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

__construct (   $user_id = null)

Методы

checkNews ( )

Проверяет, есть ли новые новости. Возвращает количество непрочитанных новостей.

Возвращает
integer
getLastError ( )

Возвращает последнюю ошибку

getLastId ( )
protected

Возвращает ID последней новости, которая присутствует на сервере ReadyScript

getLastViewedId ( )
protected

Возвращает ID новости, ниже которой все новости считаются прочитанными

Возвращает
integer
getLink (   $link,
  $link_type 
)
protected

Возвращает подготовленную ссылку новости

Аргументы
string$link_typeТип ссылки
string$linkссылка
getNewsList (   $page,
  $pageSize 
)

Возвращает список новостей, а также информацию о прочитанности новости

Аргументы
$pageстраница
$pageSizeразмер страницы
Возвращает
array
getTotal ( )

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

Возвращает
integer
markAllAsViewed ( )

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

Возвращает
integer
markAsViewed (   $id)

Помечает новость как прочитанную. Возвращает количество непрочитанных новостей.

Аргументы
integer$idID прочитанной новости
Возвращает
int
requester (   $method,
  $params = array() 
)
protected
Аргументы
$method
$params
Возвращает
mixed
setLastId (   $last_id)
protected

Сохраняет ID последней новости, которая присутствует на сервере ReadyScript

Аргументы
$last_id
setTotal (   $total)

Сохраняет общее количество новостей, которое присутствует на сервере ReadyScript

Аргументы
integer$total

Поля

$error
$readitem_api
protected
$user_id
const LAST_ID_KEY = 'rs-news-last-id-'
const LAST_VIEWED_ID_KEY = 'rs-news-last-viewed-id-'
const LINK_TYPE_CLIENT = 'client'
const LINK_TYPE_CLIENT_ADMIN = 'client-admin'
const LINK_TYPE_EXTERNAL = 'external'
const METER_KEY = 'rs-news'
const TOTAL_KEY = 'rs-news-total'