Проект

Общее

Профиль

Действия

ApiMainDataDescriptionIfForm » История » Редакция 6

« Предыдущее | Редакция 6/7 (Разница(diff)) | Следующее »
Артем, 08.12.2017 17:27


Формат данных ifForm

ifTable содержит в себе элементы для создания формы выбора или ввода каких-данных посетителем сайта


Пример вывода



Описание возвращаемых данных


Массив ifForm состоит из четырех элементов:

1) format = ifForm

2) Массив значений fields, который содержит элементы формы. Каждый элемент, в свою очередь, массив из 4 элементов:

2.1) id - ID поля формы

2.2) name - заголовок поля формы

2.3) type - тип поля формы. На данный момент поддерживается два типа: selectable - выборка из нескольких значений и inputable - вводимое значение.

2.4) values - массив возможных значений. Каждый элемент массива - массив из двух или трех элементов: обязательных value - значение, name - название в локали каталога, и необязательного isSelected - маркера выбранного в текущий момент элемента (true или 1 - элемент выбран). Если поле типа inputable, то массив values содержит единственный элемент.

3) Массив parameters - одномерный массив, содержащий описание правил передачи в API данных из формы. Состоит из элементов:

fpMethod - метод передачи параметров формы. На данный момент поддерживается только метод get

fpFormFieldsDelimeter - разделитель полей формы1

fpFormValuesDelimeter - разделитель названия параметра и его значения1

fpEncodeMethod - метод кодирования параметров формы при передаче2

formDataUrlParamName - имя параметра, через который передаются данные формы

1 Данные формы при методе GET должны передаваться в одном $_GET параметре. Для примера на изображении ниже значение передаваемого формой параметра (без кодирования из fpEncodeMethod), например, будет выглядеть следующим образом:

&modification=...|...|...|...|...|DT=L

, где "..." это скрытые на скриншоте значения.

2 После конкатенации (по правилу из предыдущего абзаца) параметров формы в строку вида param1=value1|param2=value2|....|paramN=valueN полученная строка кодируется указанным в fpEncodeMethod

4) Массив urlParams, содержащий список GET параметров вызова следующего метода. При этом значение параметра с индексом из formDataUrlParamName заменяется результат из п.3


Пример возвращаемых данных


Обновлено Артем около 7 лет назад · 6 изменени(я, ий)