Изменения документа Для_разработчиков

Редактировал(а) Михаил Галич 26.11.2024, 12:16

От версии < 5.2 >

отредактировано Михаил Галич
на 11.12.2023, 13:56

К версии 1.1 >

отредактировано Михаил Галич
на 11.12.2023, 13:49

Изменить комментарий: К данной версии нет комментариев

Необработанный
Обработанный

Комментарий

Свойства страницы (1 изменено, 0 добавлено, 0 удалено)

Подробности

Свойства страницы

Содержимое

@@ -30,189 +30,5 @@
  </script>}}}
--== Функции ==
--=== WPInit({params}) ===
--
--Функция загрузки виджета с параметризацией, при создании необходимо передать id виджета, который можно найти в Административной панели
--
--===== Минимальный способ инициализации: =====
--
--* WPInit({ id: 1 })
--
--===== Пример передаваемых данных: =====
--
--Виджет можно инициализировать с различными параметрами, все из них опциональные, кроме id.
--
--{{{WPInit({
--    id: 1,
--    width: 400,
--    height: 600,
--    type: 'modal'
--})}}}
--
--=== WPOpen({params}) ===
--
--Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant'
--
--===== Пример передаваемых данных: =====
--
--{{{// показ виджета с группой id 5
--WPOpen({
--    groupid: [5]
--})}}}
--
--=== WPOpenModal({params}) ===
--
--Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal'
--
--===== Пример передаваемых данных: =====
--
--{{{// показ виджета на нажатие кнопки с id "OpenButton" var OpenButton = document.getElementById('OpenButton'); OpenButton.onclick = function() { WPOpenModal({ tariffsid: [27, 28] }) }}}}
--
--=== WPChange({status, data}) ===
--
--Функция, которая вызывается каждый раз при изменении состояния виджета. Каждый раз передаёт в переменной response состояние в status и опционально данные в data. При переопределении этой функции у себя на странице, администратор может следить за состоянием виджета и статусом заказа из javascript
--
--===== Примеры передаваемых данных: =====
--
--* { status:'starting' } — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать
--* { status:'started' } — виджет на начальном экране, где показывается список услуг для покупки
--* { status:'reserved', data: { order_id: 2 } } — виджет находится на стадии забронированного заказ, в data передаётся id
--* { status:'completed', data: { order_id: 2 } } — виджет находится на стадии оплаченного заказ, в data передаётся id заказа
--
--===== Пример работы с данными: =====
--
--{{{WPChange = function(response) { if (response.status == 'starting') { // действие на внешней странице } if (response.status == 'started') { // действие на внешней странице } if (response.status == 'reserved') { // id зарезервированного заказа: response.data.order_id } if (response.status == 'completed') { // id оплаченного заказа: response.data.order_id } }}}}
--
--== Параметры ==
--
--==== Обязательные параметры WPInit ====
--
--==== id: 1 ====
--
--id виджета, который можно узнать в Административной панели
--
--==== Возможные параметры WPInit ====
--
--==== height: 480 ====
--
--Высота виджета в пикселях, по умолчанию:
--
--* 480px, если виджет запущен как type: 'modal'
--* 100%, если виджет запущен как type: 'instant'
--
--==== width: 640 ====
--
--Ширина виджета в пикселях, по умолчанию:
--
--* 640px, если виджет запущен как type: 'modal'
--* 100%, если виджет запущен как type: 'instant'
--
--==== type: 'modal' ====
--
--Способ открытия виджета, по умолчанию 'instant':
--
--* 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации
--* 'modal' Открытие виджета в модальном окне
--
--==== place: '#place' ====
--
--Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant'
--
--(% class="box warningmessage" %)
--(((
--**Важно:** элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery)
--)))
--
--==== Возможные параметры WPOpen и WPOpenModal ====
--
--===== Календарь и даты =====
--
--==== nocalendar: false ====
--
--Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. По умолчанию false
--
--==== mindate: '01.01.2019' ====
--
--Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня
--
--==== maxdate: '01.01.2020' ====
--
--Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре.
--
--==== forcedate: '12.06.2019' ====
--
--Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018.
--
--==== disableddates: ['23.02.2019' ====
--
--==== , … ] ====
--
--Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
--Пример использования: disableddates: ['23.02.2018', '08.03.2018'] уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
--
--===== Услуги, пакеты услуг, группы услуг =====
--
--==== tariffsid: [29 ====
--
--==== , 30 ====
--
--==== , … ] ====
--
--Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
--Пример использования:
--tariffsid: [29, 30] покажет тарифы с id 29 и 30 во вкладке «Покупка услуг».
--tariffsid: false уберёт все тарифы с первой страницы
--
--==== rtariffsid: [56 ====
--
--==== , 57 ====
--
--==== , … ] ====
--
--Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
--Пример использования:
--rtariffsid: [56, 57] покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг»
--tariffsid: false уберёт все тарифы с первой страницы
--
--==== bundlesid: [4 ====
--
--==== , 5 ====
--
--==== , … ] ====
--
--Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него.
--Пример использования:
--bundlesid: [4, 5] покажет пакеты услуг с id 4 и 5 в момент открытия виджета.
--bundlesid: false уберёт все пакеты услуг с первой страницы
--
--==== groupid: 12 ====
--
--Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете.
--
--~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--
--
--===== Предзаказ =====
--
--==== preorder: [{id: 57 ====
--
--==== , date: '06.06.2019' ====
--
--==== , count: 1 ====
--
--==== }, … ] ====
--
--Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки.
--
--* id — id услуги к покупке
--* date — дата, на которую покупается услуга
--* count — количество покупаемых услуг
--
--
--===== Пример передаваемых данных: =====
--
--
--
--