ApiMainDataDescriptionIfForm » История » Редакция 6
Редакция 5 (Артем, 08.12.2017 17:26) → Редакция 6/7 (Артем, 08.12.2017 17:27)
h1. Формат данных ifForm
ifTable содержит в себе элементы для создания формы выбора или ввода каких-данных посетителем сайта
---
h2. Пример вывода
---
!https://static.ilcats.ru/images/helpsystem/catalogsApi/apiHelpExampleIfFormFieldsHtml.png!
---
h2. Описание возвращаемых данных
---
Массив *ifForm* состоит из четырех элементов:
p(. 1) *format = ifForm*
p(. 2) Массив значений *fields*, который содержит элементы формы. Каждый элемент, в свою очередь, массив из 4 элементов:
p((. 2.1) *id* - ID поля формы
p((. 2.2) *name* - заголовок поля формы
p((. 2.3) *type* - тип поля формы. На данный момент поддерживается два типа: *selectable* - выборка из нескольких значений и *inputable* - вводимое значение.
p((. 2.4) *values* - массив возможных значений. Каждый элемент массива - массив из двух или трех элементов: обязательных *value* - значение, *name* - название в локали каталога, и необязательного *isSelected* - маркера выбранного в текущий момент элемента (*true* или *1* - элемент выбран). Если поле типа *inputable*, то массив *values* содержит единственный элемент.
p(. 3) Массив *parameters* - одномерный массив, содержащий описание правил передачи в API данных из формы. Линейный массив, описывающий параметры формы. Состоит из элементов:
p((. *fpMethod* - метод передачи параметров формы. На данный момент поддерживается только метод *get*
p((. *fpFormFieldsDelimeter* - разделитель полей формы[1]
p((. *fpFormValuesDelimeter* - разделитель названия параметра и его значения[1]
p((. *fpEncodeMethod* - метод кодирования параметров формы при передаче[2]
p((. *formDataUrlParamName* - имя параметра, через который передаются данные формы
fn1. Данные формы при методе GET должны передаваться в одном $_GET параметре. Для примера на изображении ниже значение передаваемого формой параметра (без кодирования из *fpEncodeMethod*), например, будет выглядеть следующим образом:
bq. &modification=...|...|...|...|...|DT=L
, где "..." это скрытые на скриншоте значения.
fn2. После конкатенации (по правилу из предыдущего абзаца) параметров формы в строку вида param1=value1|param2=value2|....|paramN=valueN полученная строка кодируется указанным в *fpEncodeMethod*
p(. 4) Массив *urlParams*, содержащий список GET параметров вызова следующего метода. При этом значение параметра с индексом из *formDataUrlParamName* заменяется результат из п.3
---
h2. Пример возвращаемых данных
---
!https://static.ilcats.ru/images/helpsystem/catalogsApi/apiHelpExampleIfFormFields.png!