API: Универсальный модуль

Содержание
позволяет получить список модулей
позволяет получить страницы модуля
позволяет получить разделы модуля
позволяет подсчитать количество страниц модуля
позволяет подсчитать количество разделов модуля



Метод module позволяет получить список модулей.


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


нет параметров.



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

$this->smartriver->module();


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


Array

(

    [status] => ok

    [message] => success

    [response] => Array

        (

            [0] => Array

                (

                    [id] => 1

                    [name] => Галерея

                    [link] => gallery

                    [sort] => 1

                    [active] => 1

                )


            [1] => Array

                (

                    [id] => 2

                    [name] => Блог

                    [link] => blog

                    [sort] => 2

                    [active] => 1

                )


        )


)



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


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


module

ID модуля, по которому идет выборка. ID можно получить с помощью метода module либо в админ. панели SE4
Тип integer
Значение по умолчанию нет


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


where_in условия для выборки из БД (аналог SQL синтаксиса WHERE IN)
Тип array
Возможные значения принимается массив из 2х значений, где первое - поле в таблице, а второе - его возможные значения для построения запроса вида WHERE catalog.id IN (10, 20, 30).
Значение по умолчанию нет


where_not_in условия для выборки из БД (аналог SQL синтаксиса WHERE NOT IN)
Тип array
Возможные значения принимается массив из 2х значений, где первое - поле в таблице, а второе - его исключенные значения для построения запроса вида WHERE catalog.id NOT IN (10, 20, 30).
Значение по умолчанию нет


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


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


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


extra дополнительные данные, которые необходимо получить
Тип array
Возможные значения массив с максимальным набором данных выглядит следующим образом array('part', 'params'), где part - разделы, params - значения доп. параметров данной страницы
Значение по умолчанию нет


full если параметр равен false, то дополнительные данные выгружаются только с флагом active=1
Тип boolean
Значение по умолчанию
false


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



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

$this->smartriver->module_item(['module' => 1]);


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

$this->smartriver->module_item(['module' => 2, 'where' => ['id_part' => 17, 'active' => 1], 'extra' => ['part', 'params']]);


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

Array
(
    [status] => ok
    [message] => success
    [response] => Array
        (
            [0] => Array
                (
                    [id] => 70
                    [id_part] => 17
                    [id_module] => 2
                    [id_tpl] => -1
                    [name] => Тестовый элемент
                    [desc_short] => 

Тестовый анонс

[desc_full] =>

Тестовое описание

[link] => /test/item/testovy_element [image] => /images/gallery/x5Gkh3zUvHH9dOFgDUmj.gif [seo_title] => [seo_keywords] => [seo_description] => [sort] => 0 [active] => 1 [module] => Array ( [id] => 2 [name] => Тестовый раздел [link] => test [active] => 1 ) [photo] => Array ( [0] => Array ( [url] => /images/gallery/x5Gkh3zUvHH9dOFgDUmj.gif [caption] => ) [1] => Array ( [url] => /images/gallery/IkbQSDqL8w8ZywGHmqPc.gif [caption] => ) ) [part] => Array ( [0] => Array ( [id] => 17 [id_parent] => 0 [id_tpl] => -1 [name] => Тестовый раздел [announce] =>

Тестовый анонс

[description] =>

Тестовый анонс

[link] => /test/part/testovy_razdel [image] => /images/gallery/x5Gkh3zUvHH9dOFgDUmj.gif [sort] => 0 [active] => 1 ) ) [params] => Array ( [0] => Array ( [id] => 6 [name] => Тестовый параметр [type] => boolean [value] => 1 [section] => all [sort] => 0 [active] => 1 ) ) ) ) [settings] => Array ( [default_photo] => [watermark] => ) )


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


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


default_photo фото, которое используется по умолчанию, если фото к странице или разделу не было загружено
watermark
водяной знак, который автоматически накладывается при загрузке фото через админ. панель SE4



Метод module_part позволяет получить разделы модуля.


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


module ID модуля, по которому идет выборка. ID можно получить с помощью метода module либо в админ. панели SE4
Тип integer
Значение по умолчанию нет


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


where_in условия для выборки из БД (аналог SQL синтаксиса WHERE IN)
Тип array
Возможные значения принимается массив из 2х значений, где первое - поле в таблице, а второе - его возможные значения для построения запроса вида WHERE catalog.id IN (10, 20, 30).
Значение по умолчанию нет


where_not_in условия для выборки из БД (аналог SQL синтаксиса WHERE NOT IN)
Тип array
Возможные значения принимается массив из 2х значений, где первое - поле в таблице, а второе - его исключенные значения для построения запроса вида WHERE catalog.id NOT IN (10, 20, 30).
Значение по умолчанию нет


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


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


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


extra дополнительные данные, которые необходимо получить
Тип array
Возможные значения массив с максимальным набором данных выглядит следующим образом array('params'), где params - значения доп. параметров данного раздела
Значение по умолчанию нет


full если параметр равен false, то дополнительные данные выгружаются только с флагом active=1
Тип boolean
Значение по умолчанию
false


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



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

$this->smartriver->module_part(['module' => 1]);


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

$this->smartriver->module_part(['module' => 2, 'where' => ['active' => 1], 'extra' => ['params']]);


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

Array
(
    [status] => ok
    [message] => success
    [response] => Array
        (
            [0] => Array
                (
                    [id] => 17
                    [id_parent] => 0
                    [id_module] => 2
                    [id_tpl] => -1
                    [name] => Тестовый раздел
                    [announce] => 

Тестовый анонс

[description] =>

Тестовый анонс

[link] => /test/part/testovy_razdel [image] => /images/gallery/x5Gkh3zUvHH9dOFgDUmj.gif [seo_title] => [seo_keywords] => [seo_description] => [sort] => 0 [active] => 1 [photo] => Array ( [0] => Array ( [url] => /images/gallery/x5Gkh3zUvHH9dOFgDUmj.gif [caption] => ) [1] => Array ( [url] => /images/gallery/IkbQSDqL8w8ZywGHmqPc.gif [caption] => ) ) [params] => Array ( [0] => Array ( [id] => 6 [name] => Тестовый параметр [type] => boolean [value] => [section] => all [sort] => 0 [active] => 1 ) ) ) ) )


Помимо основных данных, выгружаются фото (photo) для каждого раздела.



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


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


module ID модуля, по которому идет выборка. ID можно получить с помощью метода module либо в админ. панели SE4
Тип integer
Значение по умолчанию нет


where условия для выборки из БД
Тип array
Возможные значения работает аналогично методу module_item (нажмите, чтобы посмотреть)
Значение по умолчанию нет


where_in условия для выборки из БД (аналог SQL синтаксиса WHERE IN)
Тип array
Возможные значения работает аналогично методу module_item (нажмите, чтобы посмотреть)
Значение по умолчанию нет


where_not_in условия для выборки из БД (аналог SQL синтаксиса WHERE NOT IN)
Тип array
Возможные значения работает аналогично методу module_item (нажмите, чтобы посмотреть)
Значение по умолчанию нет


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



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

$this->smartriver->module_item_count(['module' => 1]);


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

$this->smartriver->module_item_count(['module' => 2, 'where' => ['id_part' => 17, 'active' => 1]]);


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

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



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


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


module ID модуля, по которому идет выборка. ID можно получить с помощью метода module либо в админ. панели SE4
Тип integer
Значение по умолчанию нет


where условия для выборки из БД
Тип array
Возможные значения работает аналогично методу module_part (нажмите, чтобы посмотреть)
Значение по умолчанию нет


where_in условия для выборки из БД (аналог SQL синтаксиса WHERE IN)
Тип array
Возможные значения работает аналогично методу module_part (нажмите, чтобы посмотреть)
Значение по умолчанию нет


where_not_in условия для выборки из БД (аналог SQL синтаксиса WHERE NOT IN)
Тип array
Возможные значения работает аналогично методу module_part (нажмите, чтобы посмотреть)
Значение по умолчанию нет


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



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

$this->smartriver->module_part_count(['module' => 1]);


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

$this->smartriver->module_part_count(['module' => 2, 'where' => ['id' => 17, 'active' => 1]]);


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

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




Мы используем файлы cookie, чтобы сделать работу с сайтом проще и удобнее. Подробную информацию можно прочитать тут

totop