API: Страницы

Содержание

page

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

page_count

получение количества страниц

part_count

получение количества разделов

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

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

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->page();

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

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

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

Array
(
    [status] => ok
    [message] => success
    [response] => Array
        (
            [0] => Array
                (
                    [id] => 132
                    [id_part] => 14
                    [id_tpl] => 14
                    [name] => Тестовая страница
                    [link] => 
                    [title] => 
                    [keywords] => 
                    [description] => 
                    [fixed] => 1
                    [sort] => 87
                    [confirm] => 1
                    [noindex] => 1
                )

        )

)

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

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

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

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

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

$this->smartriver->page_count();

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

$this->smartriver->page_count(['confirm' => 1]);

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

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

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

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

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

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

$this->smartriver->part_count();

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

$this->smartriver->part_count(['confirm' => 1]);

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

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

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