API: Новости

Содержание

news

получение страницы или раздела новостей

news_count

позволяет подсчитать количество страниц новостей

news_part_count

позволяет подсчитать количество разделов новостей

Метод news позволяет получить страницы или разделы новостей.

Параметры запроса (передаются в массиве):

act	определяет действие, которое будет выполнено (получение страниц или разделов новостей)
Тип	string
Возможные значения	get (получение страниц новостей), get_part (получение разделов новостей)
Значение по умолчанию	get

where	условия для выборки из БД
Тип	array
Возможные значения	любой допустимый набор пар ключ-значение для корректного sql запроса, например array('id' => 1) будет соответствовать записи "WHERE id=1"
Значение по умолчанию	нет

limit	ограничение по количеству вывода данных
Тип	integer
Значение по умолчанию	нет

offset	сдвиг для построения пагинации
Тип	integer
Значение по умолчанию	нет

order	порядок вывода данных (сортировка)
Тип	string
Возможные значения	возможные значения - любая допустимая сортировка согласно БД, например 'name asc' будет соответствовать сортировке по имени от А до Я. Для сортировки по возрастанию используется asc, по убыванию - desc
Значение по умолчанию	нет

Внимание! Для использования параметров where и order, а также для корректной обработки ответа, необходимо знать структуру таблиц, соответствующих данному методу. Для просмотра информации перейдите по ссылке.

Пример простейшего вызова:

$this->smartriver->news();

Пример вызова с параметрами:

$this->smartriver->news(['act' => 'get', 'where' => ['id' => 91]]);

Пример ответа:

Array
(
    [status] => ok
    [message] => success
    [response] => Array
        (
            [0] => Array
                (
                    [id] => 91
                    [id_part] => 7
                    [id_tpl] => -1
                    [name] => Тестовая новость
                    [announce] => Тестовый анонс
                    [content] => Содержание
                    [link] => 
                    [image] => /images/gallery/IkbQSDqL8w8ZywGHmqPc.gif
                    [date] => 2022-11-02
                    [time] => 10:26:24
                    [seo_title] => 
                    [seo_keywords] => 
                    [seo_description] => 
                    [top] => 0
                    [sort] => 0
                    [active] => 1
                    [params] => Array
                        (
                            [test] => 2022-11-02
                        )

                    [photo] => Array
                        (
                            [0] => Array
                                (
                                    [url] => /images/gallery/IkbQSDqL8w8ZywGHmqPc.gif
                                    [caption] => 
                                )

                        )

                )

        )

    [settings] => Array
        (
            [date_format] => dd.mm.yyyy
            [default_photo] => 
            [pagination] => off
            [sort] => date_desc
            [timer] => on
            [time_format] => H:i
            [watermark] => 
        )

)

Помимо основных данных, выгружаются дополнительные параметры (params) и фото (photo) для каждой новости, а также, список настроек модуля "Новости" (settings) в общем массиве данных (даже если выборка содержит 0 совпадений).

Настройки модуля "Новости" содержат следующие параметры:

date_format	формат даты, который используется на сайте (подробнее о формате даты в системе SE4 по ссылке)
default_photo	фото, которое используется по умолчанию, если фото к новости или разделу новостей не было загружено
pagination	используется ли пагинация для новостей (подробнее о типах пагинации в системе SE4 по ссылке)
sort	сортировка новостей по умолчанию
timer	отложенный запуск новостей (on/off)
time_format	формат времени, который используется на сайте (подробнее о формате времени в системе SE4 по ссылке)
watermark	водяной знак, который автоматически накладывается при загрузке фото через админ. панель SE4

Метод news_count позволяет подсчитать количество страниц новостей по заданной выборке для построения пагинации.

Параметры запроса:

where	условия для выборки из БД
Тип	array
Возможные значения	любой допустимый набор пар ключ-значение для корректного sql запроса, например array('active' => 1) будет соответствовать записи "WHERE active=1"
Значение по умолчанию	нет

Внимание! Для использования параметра where необходимо знать структуру таблицы, соответствующей данному методу. Для просмотра информации перейдите по ссылке.

Пример простейшего вызова:

$this->smartriver->news_count();

Пример вызова с параметрами:

$this->smartriver->news_count(['active' => 1]);

Пример ответа:

Array
(
    [status] => ok
    [message] => success
    [response] => 93
)

Метод news_part_count позволяет подсчитать количество разделов новостей по заданной выборке для построения пагинации.

Параметры запроса:

where	условия для выборки из БД
Тип	array
Возможные значения	любой допустимый набор пар ключ-значение для корректного sql запроса, например array('active' => 1) будет соответствовать записи "WHERE active=1"
Значение по умолчанию	нет

Пример простейшего вызова:

$this->smartriver->news_part_count();

Пример вызова с параметрами:

$this->smartriver->news_part_count(['active' => 1]);

Пример ответа:

Array
(
    [status] => ok
    [message] => success
    [response] => 5
)

Была ли полезна для вас данная статья?