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

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

<
От версии < 12.1 >
отредактировано Михаил Галич
на 12.12.2023, 10:59
К версии < 57.2 >
отредактировано Михаил Галич
на 21.12.2023, 13:48
>
Изменить комментарий: allow view права для XWiki.XWikiAllGroup

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -1,12 +1,15 @@
1 -== Для разработчиков ==
1 +{{toc depth="4"/}}
2 2  
3 -Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманому вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:
3 += Инструкция для подключения =
4 4  
5 -~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр id для подключения
5 +Назначение данного раздела описать способы взаимодействия с виджетом Веб-платформы по задуманному вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:
6 6  
7 +~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр ##id## для подключения
8 +
7 7  2. Вставьте в необходимом месте на своём сайте код:
8 8  
9 9  {{code language="html"}}
12 +
10 10  <script type="text/javascript">
11 11  // инициализируем виджет с параметрами
12 12  WPInit({
... ... @@ -29,34 +29,46 @@
29 29   }
30 30  }
31 31  </script>
35 +
32 32  {{/code}}
33 33  
34 -== Функции ==
38 += Функции =
35 35  
36 -=== WPInit({params}) ===
40 +== WPInit ==
37 37  
38 -Функция загрузки виджета с параметризацией, при создании необходимо передать id виджета, который можно найти в Административной панели
42 +(% class="box infomessage" %)
43 +(((
44 +Функция загрузки виджета с параметризацией, при создании необходимо передать**## id ##**виджета, который можно найти в Административной панели
45 +)))
39 39  
40 40  ===== Минимальный способ инициализации: =====
41 41  
42 -* WPInit({ id: 1 })
49 +{{code language="javascript"}}
50 +WPInit({ id: 1 })
51 +{{/code}}
43 43  
44 44  ===== Пример передаваемых данных: =====
45 45  
46 -Виджет можно инициализировать с различными параметрами, все из них опциональные, кроме id.
55 +(% class="box infomessage" %)
56 +(((
57 +Виджет можно инициализировать с различными параметрами, все из них опциональные, кроме **##id##**.
58 +)))
47 47  
48 48  {{code language="javascript"}}
49 49  WPInit({
50 - id: 1,
51 - width: 400,
52 - height: 600,
53 - type: 'modal'
62 +id: 1,
63 +width: 400,
64 +height: 600,
65 +type: 'modal'
54 54  })
55 55  {{/code}}
56 56  
57 -=== WPOpen({params}) ===
69 +== WPOpen ==
58 58  
59 -Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant'
71 +(% class="box infomessage" %)
72 +(((
73 +Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с## **type: 'instant'**##
74 +)))
60 60  
61 61  ===== Пример передаваемых данных: =====
62 62  
... ... @@ -63,310 +63,792 @@
63 63  {{code language="javascript"}}
64 64  // показ виджета с группой id 5
65 65  WPOpen({
66 - groupid: [5]
81 +groupid: [5]
67 67  })
68 68  {{/code}}
69 69  
70 -=== WPOpenModal({params}) ===
85 +== WPOpenModal ==
71 71  
72 -Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal'
87 +(% class="box infomessage" %)
88 +(((
89 +Функция открытия виджета в модальном окне, используется при инициализации виджета с## **type: 'modal'**##
90 +)))
73 73  
74 74  ===== Пример передаваемых данных: =====
75 75  
76 -{{{// показ виджета на нажатие кнопки с id "OpenButton" var OpenButton = document.getElementById('OpenButton'); OpenButton.onclick = function() { WPOpenModal({ tariffsid: [27, 28] }) }}}}
94 +{{code language="javascript"}}
95 +// показ виджета на нажатие кнопки с id "OpenButton"
96 +var OpenButton = document.getElementById('OpenButton');
97 +OpenButton.onclick = function () {
98 +WPOpenModal({ tariffsid: [27, 28] });
99 +};
100 +{{/code}}
77 77  
78 -=== WPChange({status, data}) ===
102 +== WPChange ==
79 79  
80 -Функция, которая вызывается каждый раз при изменении состояния виджета. Каждый раз передаёт в переменной response состояние в status и опционально данные в data. При переопределении этой функции у себя на странице, администратор может следить за состоянием виджета и статусом заказа из javascript
104 +(% class="box infomessage" %)
105 +(((
106 +Функция, которая вызывается каждый раз при изменении состояния виджета.
107 +Каждый раз передаёт в переменной response состояние в **##status##** и опционально данные в **##data##**.
108 +При переопределении этой функции у себя на странице, администратор может следить за состоянием виджета и статусом заказа из javascript
109 +)))
81 81  
82 82  ===== Примеры передаваемых данных: =====
83 83  
84 -* { status:'starting' } — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать
85 -* { status:'started' } — виджет на начальном экране, где показывается список услуг для покупки
86 -* { status:'reserved', data: { order_id: 2 } } — виджет находится на стадии забронированного заказ, в data передаётся id
87 -* { status:'completed', data: { order_id: 2 } } — виджет находится на стадии оплаченного заказ, в data передаётся id заказа
113 +- ##{ status:'starting' }## — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать
114 +- ##{ status:'started' }## — виджет на начальном экране, где показывается список услуг для покупки
115 +- ##{ status:'reserved', data: { order_id: 2 } }## — виджет находится на стадии забронированного заказ, в data передаётся id
116 +- ##{ status:'completed', data: { order_id: 2 } }## — виджет находится на стадии оплаченного заказ, в data передаётся id заказа
88 88  
89 89  ===== Пример работы с данными: =====
90 90  
91 -{{{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 } }}}}
120 +{{code language="javascript"}}
121 +WPChange = function(response) {
122 + if (response.status == 'starting') {
123 + // действие на внешней странице
124 + }
125 + if (response.status == 'started') {
126 + // действие на внешней странице
127 + }
128 + if (response.status == 'reserved') {
129 + // id зарезервированного заказа: response.data.order_id
130 + }
131 + if (response.status == 'completed') {
132 + // id оплаченного заказа: response.data.order_id
133 + }
134 +}
135 +{{/code}}
92 92  
93 -== Параметры ==
137 += Параметры =
94 94  
95 -==== Обязательные параметры WPInit ====
139 +== Обязательные параметры WPInit ==
96 96  
97 -==== id: 1 ====
141 +==== id ====
98 98  
99 -id виджета, который можно узнать в Административной панели
143 +Тип данных:## //number//##
100 100  
101 -==== Возможные параметры WPInit ====
145 +(% class="box infomessage" %)
146 +(((
147 +id виджета, который можно узнать в Административной панели.
148 +)))
102 102  
103 -==== height: 480 ====
150 +== Возможные параметры WPInit ==
104 104  
152 +==== height ====
153 +
154 +Тип данных:## //number//##
155 +
156 +(% class="box infomessage" %)
157 +(((
105 105  Высота виджета в пикселях, по умолчанию:
159 +• 480px, если виджет запущен как type: 'modal'
160 +• 100%, если виджет запущен как type: 'instant'
161 +)))
106 106  
107 -* 480px, если виджет запущен как type: 'modal'
108 -* 100%, если виджет запущен как type: 'instant'
163 +==== width ====
109 109  
110 -==== width: 640 ====
165 +Тип данных:## //number//##
111 111  
167 +(% class="box infomessage" %)
168 +(((
112 112  Ширина виджета в пикселях, по умолчанию:
170 +• 640px, если виджет запущен как type: 'modal'
171 +• 100%, если виджет запущен как type: 'instant'
172 +)))
113 113  
114 -* 640px, если виджет запущен как type: 'modal'
115 -* 100%, если виджет запущен как type: 'instant'
174 +==== type ====
116 116  
117 -==== type: 'modal' ====
176 +Тип данных:## //string//##
118 118  
119 -Способ открытия виджета, по умолчанию 'instant':
178 +По умолчанию:##// 'instant'//##
120 120  
121 -* 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации
122 -* 'modal' Открытие виджета в модальном окне
180 +(% class="box infomessage" %)
181 +(((
182 +Способ открытия виджета
183 +• 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации
184 +• 'modal' Открытие виджета в модальном окне
185 +)))
123 123  
124 -==== place: '#place' ====
187 +==== place ====
125 125  
126 -Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant'
189 +Тип данных:## //string//##
127 127  
191 +(% class="box infomessage" %)
192 +(((
193 +Идентификатор элемента DOM, в который необходимо поместить виджет, например: **###widget##**. Используется совместно с **##type: 'instant'##**
194 +)))
195 +
128 128  (% class="box warningmessage" %)
129 129  (((
130 130  **Важно:** элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery)
131 131  )))
132 132  
133 -==== ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-- ====
201 +----
134 134  
135 -==== Возможные параметры WPOpen и WPOpenModal ====
203 +== Возможные параметры WPOpen и WPOpenModal ==
136 136  
137 -===== Календарь и даты =====
205 +=== Инструкторские занятия ===
138 138  
139 -==== nocalendar: false ====
207 +==== categories ====
140 140  
141 -Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. По умолчанию false
209 +Тип данных:##// Array<string>//##
142 142  
143 -==== mindate: '01.01.2019' ====
211 +По умолчанию:##// []//##
144 144  
145 -Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня
213 +(% class="box infomessage" %)
214 +(((
215 +Фильтр категорий инструкторских занятий. Скрывает категории в выпадающем списке, **##id##** которых не совпадают заданными в массиве.
216 +)))
146 146  
147 -==== maxdate: '01.01.2020' ====
218 +[[image:1703065952567-753.png]]
148 148  
149 -Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре.
220 +==== coachid ====
150 150  
151 -==== forcedate: '12.06.2019' ====
222 +Тип данных:##// number//##
152 152  
153 араметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018.
224 +По умолчанию:##// undefined//##
154 154  
155 -==== disableddates: ['23.02.2019' ====
226 +(% class="box infomessage" %)
227 +(((
228 +Идентификатор тренера, позволяет сепарировать список занятий по тренеру
229 +)))
156 156  
157 -==== , ] ====
231 +==== grouplessonsskillstariffs **##*##** ====
158 158  
159 -Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
160 -Пример использования: disableddates: ['23.02.2018', '08.03.2018'] уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
233 +Тип данных:##// object//##
161 161  
162 -~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--
235 +По умолчанию:##// {}//##
163 163  
164 -===== Услуги, пакеты услуг, группы услуг =====
237 +(% class="box infomessage" %)
238 +(((
239 +Ограничивает список тарифов (в фильтре) при выборе конкретной дисциплины групповых занятий.
240 +Принимает объект, внутри которого указываются пары ключ/значение по выражению: {skillid}: [{tariffid},...]
241 +)))
165 165  
166 -==== tariffsid: [29 ====
243 +Пример:
167 167  
168 -==== , 30 ====
245 +{{code language="javascript"}}
246 +grouplessonsskillstariffs: {
247 + "1": [ 15, 23] // При выборе дисциплины с id 1 - отображать тарифы с id 15 и 23
248 +}
249 +{{/code}}
169 169  
170 -==== , … ] ====
251 +==== grouplessonstariffsid ====
171 171  
172 -Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
173 -Пример использования:
174 -tariffsid: [29, 30] покажет тарифы с id 29 и 30 во вкладке «Покупка услуг».
175 -tariffsid: false уберёт все тарифы с первой страницы
253 +Тип данных:##// Array<number>//##
176 176  
177 -==== rtariffsid: [56 ====
255 +По умолчанию:##// []//##
178 178  
179 -==== , 57 ====
257 +(% class="box infomessage" %)
258 +(((
259 +Фильтр программ обучения для групповых занятий
260 +)))
180 180  
181 -==== , … ] ====
262 +[[image:1703065356750-663.png]]
182 182  
183 -Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
184 -Пример использования:
185 -rtariffsid: [56, 57] покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг»
186 -tariffsid: false уберёт все тарифы с первой страницы
264 +Пример:
187 187  
188 -==== bundlesid: [4 ====
266 +{{code language="javascript"}}
267 +grouplessonstariffsid: [1823, 1900] // скрыть групповые программы обучения, кроме 1823 и 1900
268 +{{/code}}
189 189  
190 -==== , 5 ====
270 +==== lessonslocation **##*##** ====
191 191  
192 -==== , … ] ====
272 +Тип данных:##// number//##
193 193  
194 -Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него.
195 -Пример использования:
196 -bundlesid: [4, 5] покажет пакеты услуг с id 4 и 5 в момент открытия виджета.
197 -bundlesid: false уберёт все пакеты услуг с первой страницы
274 +По умолчанию:##// undefined//##
198 198  
199 -==== groupid: 12 ====
276 +(% class="box infomessage" %)
277 +(((
278 +Отображение места занятия для индивидуальных, групповых и многодневных занятий
279 +)))
200 200  
201 -Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете.
281 +[[image:1702560957244-690.png]]
202 202  
203 -~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--
283 +==== lessonstariffsid ====
204 204  
205 -===== Предзаказ =====
285 +Тип данных:##// Array<number>//##
206 206  
207 -==== preorder: [{id: 57 ====
287 +По умолчанию:##// []//##
208 208  
209 -==== , date: '06.06.2019' ====
289 +(% class="box infomessage" %)
290 +(((
291 +Ограничить видимость доступных тарифов в выпадающем списке программ обучения по массиву с их идентификаторами
292 +)))
210 210  
211 -==== , count: 1 ====
294 +[[image:1702641274330-465.png]]
212 212  
213 -==== }, ] ====
296 +==== multidayslessonsskillstariffs **##*##** ====
214 214  
215 -Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки.
298 +Тип данных:##// Array<number> //##//|## object##//
216 216  
217 -* id — id услуги к покупке
218 -* date — дата, на которую покупается услуга
219 -* count — количество покупаемых услуг
300 +По умолчанию:##// []//##
220 220  
221 -===== Пример передаваемых данных: =====
302 +(% class="box infomessage" %)
303 +(((
304 +Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов.
305 +Параметр дополняет фильтрацию по параметру **##grouplessonsskillstariffs##**.
306 +)))
222 222  
308 +==== nocategories **##*##** ====
309 +
310 +Тип данных:##// boolean//##
311 +
312 +По умолчанию:##// false//##
313 +
314 +(% class="box infomessage" %)
315 +(((
316 +Если **##true##** скрывает фильтр по категории инструкторских занятий
317 +)))
318 +
319 +[[image:1702638427440-675.png]]
320 +
321 +==== nocoach **##*##** ====
322 +
323 +Тип данных:##// boolean//##
324 +
325 +По умолчанию:##// false//##
326 +
327 +(% class="box infomessage" %)
328 +(((
329 +Если **##true##** скрывает выпадающее меню выбора инструктора
330 +)))
331 +
332 +[[image:1702638265778-588.png]]
333 +
334 +==== nolocation **##*##** ====
335 +
336 +Тип данных:##// boolean//##
337 +
338 +По умолчанию:##// false//##
339 +
340 +(% class="box infomessage" %)
341 +(((
342 +Если **##true##** скрывает фильтр по месту проведения инструкторских занятий
343 +)))
344 +
345 +[[image:1702638034420-756.png]]
346 +
347 +==== noskills **##*##** ====
348 +
349 +Тип данных:##// boolean//##
350 +
351 +По умолчанию:##// false//##
352 +
353 +(% class="box infomessage" %)
354 +(((
355 +Если **##true##** скрывает фильтр по дисциплине инструкторских занятий
356 +)))
357 +
358 +[[image:1702638705750-678.png]]
359 +
360 +==== notariffs ====
361 +
362 +Тип данных:##// boolean//##
363 +
364 +По умолчанию:##// false//##
365 +
366 +(% class="box infomessage" %)
367 +(((
368 +Если **##true##** скрывает фильтр по программе обучения инструкторских занятий
369 +)))
370 +
371 +[[image:1703063138160-208.png]]
372 +
373 +==== personallessonsskillstariffs **##*##** ====
374 +
375 +Тип данных:##// object//##
376 +
377 +По умолчанию:##// {}//##
378 +
379 +(% class="box infomessage" %)
380 +(((
381 +Ограничивает список тарифов (в фильтре) при выборе конкретной дисциплины.
382 +Принимает объект, внутри которого указываются пары ключ/значение по выражению: {skillid}: [{tariffid},...]
383 +)))
384 +
385 +Пример:
386 +
223 223  {{code language="javascript"}}
224 -// либо WPOpenModal({})
225 -WPOpen({
226 - preorder: [
227 - {
228 - id: 57,
229 - date: '06.06.2019',
230 - count: 1
231 - }, {
232 - id: 58,
233 - date: '07.06.2019',
234 - count: 2
235 - }
236 - ]
237 -})
388 +personallessonsskillstariffs: {
389 + "1": [ 15, 23] // При выборе дисциплины с id 1 - отображать тарифы с id 15 и 23
390 +}
238 238  {{/code}}
239 239  
240 -===== Отображение =====
393 +==== placeid **##*##** ====
241 241  
242 -==== forcetab: 'rewrite' ====
395 +Тип данных:##// number//##
243 243  
244 ереключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром onlytab
397 +По умолчанию:##// undefined//##
245 245  
246 -==== onlytab: 'rewrite' ====
399 +(% class="box infomessage" %)
400 +(((
401 +идентификатор места, использующийся для получения списка инструкторов.
402 +)))
247 247  
248 -Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab
404 +==== skills **##*##** ====
249 249  
250 -* onlytab: 'service' покажет только вкладку «покупка услуг».
251 -* onlytab: 'rewrite' покажет только вкладку «пополнение услуг».
406 +Тип данных:##// Array<number>//##
252 252  
253 -==== forcemedia: 'E0012345678900' ====
408 +По умолчанию:##// []//##
254 254  
410 +(% class="box infomessage" %)
411 +(((
412 +Ограничить видимость доступных к выбору дисциплин по идентификатору
413 +)))
414 +
415 +[[image:1702639385677-964.png]]
416 +
417 +=== Календарь и даты ===
418 +
419 +==== disableddates ====
420 +
421 +Тип данных:##// Array<string>//##
422 +
423 +По умолчанию:##// []//##
424 +
425 +(% class="box infomessage" %)
426 +(((
427 +Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
428 +)))
429 +
430 +Пример:
431 +
432 +{{code language="javascript"}}
433 +disableddates: ['23.02.2018', '08.03.2018'] // уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
434 +{{/code}}
435 +
436 +==== forcedate ====
437 +
438 +Тип данных:##// string//##
439 +
440 +По умолчанию:##// undefined//##
441 +
442 +(% class="box infomessage" %)
443 +(((
444 +Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//).
445 +**##forcedate: '20.05.2018'##** покажет услуги к продаже на дату 20.05.2018.
446 +)))
447 +
448 +==== maxdate ====
449 +
450 +Тип данных:##// string//##
451 +
452 +По умолчанию:##// undefined//##
453 +
454 +(% class="box infomessage" %)
455 +(((
456 +Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//).
457 +**##maxdate: '20.05.2018'##** покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре.
458 +)))
459 +
460 +==== mindate ====
461 +
462 +Тип данных:##// string//##
463 +
464 +По умолчанию:##// undefined//##
465 +
466 +(% class="box infomessage" %)
467 +(((
468 +Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//).
469 +**##mindate: '20.05.2018'##** покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня.
470 +)))
471 +
472 +==== nocalendar ====
473 +
474 +Тип данных:## //boolean//##
475 +
476 +По умолчанию:##// false//##
477 +
478 +(% class="box infomessage" %)
479 +(((
480 +Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна.
481 +)))
482 +
483 +----
484 +
485 +=== Отображение ===
486 +
487 +==== cartmaxitems **##*##** ====
488 +
489 +Тип данных:##// number//##
490 +
491 +По умолчанию:##// 6//##
492 +
493 +(% class="box infomessage" %)
494 +(((
495 +Ограничивает максимальное кол-во товаров в корзине. ##Минимальное значение 1, но не меньше **cartminitems**. Максимальное значение 60.##
496 +)))
497 +
498 +==== cartminitems **##*##** ====
499 +
500 +Тип данных:##// number//##
501 +
502 +По умолчанию:##// 1//##
503 +
504 +(% class="box infomessage" %)
505 +(((
506 +Ограничивает минимальное кол-во товаров в корзине. ##Минимальное значение 1. Максимальное значение 60, но не больше **cartmaxitems**.##
507 +)))
508 +
509 +==== clubsiteid ====
510 +
511 +Тип данных:##// number//##
512 +
513 +По умолчанию:##// 0//##
514 +
515 +(% class="box infomessage" %)
516 +(((
517 +Вызов сайта для оформления клубного контракта
518 +)))
519 +
520 +==== disablemultipleseances **##*##** ====
521 +
522 +Тип данных:##// boolean//##
523 +
524 +По умолчанию:##// false//##
525 +
526 +(% class="box infomessage" %)
527 +(((
528 +Параметр предотвращает добавление в корзину тарифов с различными сеансами.
529 +Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину.
530 +Товары без сеансов **не будут затронуты**.
531 +)))
532 +
533 +==== forcemedia ====
534 +
535 +Тип данных:##// string//##
536 +
537 +По умолчанию:##// ''//##
538 +
539 +(% class="box infomessage" %)
540 +(((
255 255  Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить.
542 +)))
256 256  
257 -==== nopromo: false ====
544 +Пример:
258 258  
259 -Убирает вывод промокода на странице подтверждения заказа. По умолчанию false
546 +{{code language="javascript"}}
547 +forcemedia: 'E0012345678900'
548 +{{/code}}
260 260  
261 -==== terminal: true ====
550 +==== forceseanceid **##*##** ====
262 262  
263 -Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере.
552 +Тип данных:##// number//##
264 264  
265 -==== cartmaxitems: 5 ====
554 +По умолчанию без указания идентификатора не учитывается.
266 266  
267 -==== ====
556 +(% class="box infomessage" %)
557 +(((
558 +Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий.
559 +)))
268 268  
269 -Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 6
561 +==== forcesectorid **##*##** ====
270 270  
271 -==== cartminitems: 2 ====
563 +Тип данных:##// number//##
272 272  
273 -==== ====
565 +По умолчанию без указания идентификатора не учитывается.
274 274  
275 -Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 1
567 +(% class="box infomessage" %)
568 +(((
569 +Заставит виджет выбрать сектор мероприятия по **##id##** и не позволять вернуться к этапу выбора других секторов.
570 +)))
276 276  
277 -==== locale: 'ru' ====
572 +==== forcetab **##*##** ====
278 278  
279 -==== ====
574 +Тип данных:##// string//##
280 280  
576 +По умолчанию:##// ''//##
577 +
578 +(% class="box infomessage" %)
579 +(((
580 +Переключение на необходимую вкладку виджета («**покупка услуг**» или «**пополнение услуг**») при загрузке.
581 +По умолчанию открывается вкладка «**покупка услуг**».
582 +**##forcetab: 'rewrite'##** принудительно откроет «**пополнение услуг**».
583 +Обычно используется в комбинации с параметром **##onlytab##**
584 +)))
585 +
586 +==== locale **##*##** ====
587 +
588 +Тип данных:##// string//##
589 +
590 +По умолчанию:##// ''//##
591 +
592 +(% class="box infomessage" %)
593 +(((
281 281  Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык.
595 +)))
282 282  
283 -==== ordercomment: 'Комментарий к заказу' ====
597 +==== minimap **##*##** ====
284 284  
285 -==== ====
599 +Тип данных:##// boolean//##
286 286  
601 +По умолчанию:##// true//##
602 +
603 +(% class="box infomessage" %)
604 +(((
605 +Отображать миникарту.
606 +)))
607 +
608 +==== minimapaspect **##*##** ====
609 +
610 +Тип данных:##// number//##
611 +
612 +По умолчанию:##// 0.2//##
613 +
614 +(% class="box infomessage" %)
615 +(((
616 +Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится.
617 +)))
618 +
619 +==== nopromo **##*##** ====
620 +
621 +Тип данных:##// boolean//##
622 +
623 +По умолчанию:##// false//##
624 +
625 +(% class="box infomessage" %)
626 +(((
627 +Убирает вывод промокода на странице подтверждения заказа.
628 +)))
629 +
630 +==== onlytab **##*##** ====
631 +
632 +Тип данных:##// string //##//|## Array<string>##//
633 +
634 +По умолчанию:##// []//##
635 +
636 +(% class="box infomessage" %)
637 +(((
638 +Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром **##forcetab##**
639 +)))
640 +
641 +{{code language="javascript"}}
642 +onlytab: 'service' // покажет только вкладку «покупка услуг».
643 +onlytab: 'rewrite' // покажет только вкладку «пополнение услуг».
644 +onlytab: ['service', 'rewrite'] // покажет только вкладки «покупка услуг» и «пополнение услуг»;
645 +{{/code}}
646 +
647 +==== ordercomment **##*##** ====
648 +
649 +Тип данных:##// string//##
650 +
651 +По умолчанию:##// ''//##
652 +
653 +(% class="box infomessage" %)
654 +(((
287 287  Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов.
656 +)))
288 288  
289 -==== disablemultipleseances: true ====
658 +==== requiredloyalty **##*##** ====
290 290  
291 -==== ====
660 +Тип данных:##// boolean//##
292 292  
293 -Параметр предотвращает добавление в корзину тарифов с различными сеансами.
294 -Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты.
295 -По умолчанию false
662 +По умолчанию:##// false//##
296 296  
664 +(% class="box infomessage" %)
665 +(((
666 +Включает обязательную регистрацию клиента в программе настроенной на объектке.
667 +)))
297 297  
298 -==== tariffsseancesfilter: true ====
669 +==== resetcart **##*##** ====
299 299  
300 -==== ====
671 +Тип данных:##// boolean//##
301 301  
673 +По умолчанию:##// false//##
674 +
675 +(% class="box infomessage" %)
676 +(((
677 +Автоматически очищать содержимое корзины.
678 +)))
679 +
680 +==== saletermstype **##*##** ====
681 +
682 +Тип данных:##// string//##
683 +
684 +По умолчанию:##// '//default//'//##
685 +
686 +(% class="box infomessage" %)
687 +(((
688 +Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна
689 +)))
690 +
691 +{{code language="javascript"}}
692 +saletermstype: 'checkbox' // потребует установку галочки для согласия.
693 +saletermstype: 'dialog' // покажет всплывающее окно с правилами, которые нужно принять.
694 +saletermstype: 'default' // принятие правил не требуется.
695 +{{/code}}
696 +
697 +==== shownoticketsseances **##*##** ====
698 +
699 +Тип данных:##// boolean//##
700 +
701 +По умолчанию:##// false//##
702 +
703 +(% class="box infomessage" %)
704 +(((
705 +Не скрывать сеансы, на которые закончились билеты. Работает если **##tariffsseancesfilter: true##**
706 +)))
707 +
708 +==== showoverseances **##*##** ====
709 +
710 +Тип данных:##// boolean//##
711 +
712 +По умолчанию:##// false//##
713 +
714 +(% class="box infomessage" %)
715 +(((
716 +Отвечает за отображение прошедших сеансов в списке для фильтрации по времени. При значении **##true##** прошедшие сеансы будут отображаться, но недоступны для выбора пользователем. Работает если **##tariffsseancesfilter: true##**
717 +)))
718 +
719 +[[image:1702554598837-627.png]]
720 +
721 +==== tariffsseancesfilter **##*##** ====
722 +
723 +Тип данных:##// boolean//##
724 +
725 +По умолчанию:##// false//##
726 +
727 +(% class="box infomessage" %)
728 +(((
729 +Включить отображение фильтра тарифов по сеансам.
730 +)))
731 +
302 302  [[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]]
303 303  
304 -Включить отображение фильтра тарифов по сеансам. По умолчанию false
734 +----
305 305  
306 -==== resetcart: true ====
736 +=== Предзаказ ===
307 307  
308 -==== ====
738 +==== preorder ====
309 309  
310 -Автоматически очищать содержимое корзины. По умолчанию false
740 +Тип данных:##// Array<object>//##
311 311  
312 -==== minimap: false ====
742 +По умолчанию:##// undefined//##
313 313  
314 -==== ====
744 +(% class="box infomessage" %)
745 +(((
746 +Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки.
747 +• ##id## — id услуги к покупке
748 +• ##date## — дата, на которую покупается услуга
749 +• ##count## — количество покупаемых услуг
750 +)))
315 315  
316 -Отображать миникарту. По умолчанию true
752 +===== Пример передаваемых данных: =====
317 317  
318 -==== minimapaspect: 0.5 ====
754 +{{code language="javascript"}}
755 +// либо WPOpenModal({})
756 +WPOpen({
757 + preorder: [
758 + {
759 + id: 57,
760 + date: '06.06.2019',
761 + count: 1
762 + }, {
763 + id: 58,
764 + date: '07.06.2019',
765 + count: 2
766 + }
767 + ]
768 +})
769 +{{/code}}
319 319  
320 -==== ====
771 +----
321 321  
322 -Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. По умолчанию 0.2
773 +=== Услуги, пакеты услуг, группы услуг ===
323 323  
324 -==== forceseanceid: 42 ====
775 +==== tariffsid ====
325 325  
326 -==== ====
777 +Тип данных:##// Array<number> //##//|## boolean##//
327 327  
328 -Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. Без указания идентификатора не учитывается.
779 +По умолчанию:##// []//##
329 329  
330 -==== forcesectorid: 42 ====
781 +(% class="box infomessage" %)
782 +(((
783 +Тарифы, которые следует показать на вкладке «Покупка услуг».
784 +По умолчанию массив пуст и не показывает отдельно никакие из услуг.
785 +Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
786 +)))
331 331  
332 -==== ====
788 +Пример:
333 333  
334 -Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. Без указания идентификатора не учитывается.
790 +{{code language="javascript"}}
791 +tariffsid: [29, 30] // покажет тарифы с id 29 и 30 во вкладке «Покупка услуг».
792 +tariffsid: false // уберёт все тарифы с первой страницы
793 +{{/code}}
335 335  
336 -==== requiredloyalty: true ====
795 +==== rewritetariffsid **##*##** ====
337 337  
338 -==== ====
797 +Тип данных:##// Array<number> //##//|## boolean##//
339 339  
340 -Включает обязательную регистриацию клиента в программе настроенной на объектке. По умолчанию false
799 +По умолчанию:##// []//##
341 341  
342 -==== personallessonsskillstariffs: [56 ====
801 +(% class="box infomessage" %)
802 +(((
803 +Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг».
804 +По умолчанию массив пуст и не показывает отдельно никакие из услуг.
805 +Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
806 +)))
343 343  
344 -==== , 57 ====
808 +Пример:
345 345  
346 -==== , … ] ====
810 +{{code language="javascript"}}
811 +rtariffsid: [56, 57] // покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг»
812 +rtariffsid: false // уберёт все тарифы во вкладке «Пополнение услуг»
813 +{{/code}}
347 347  
348 -==== ====
815 +==== rtariffsid ====
349 349  
350 -Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. По умолчанию []
817 +(% class="box infomessage" %)
818 +(((
819 +См. **##rewritetariffsid##**. Доступен и в старой версии виджета
820 +)))
351 351  
352 -==== multidayslessonsskillstariffs: [56 ====
822 +==== bundlesid ====
353 353  
354 -==== , 57 ====
824 +Тип данных:##// Array<number> //##//|## boolean##//
355 355  
356 -==== , … ] ====
826 +По умолчанию:##// []//##
357 357  
358 -==== ====
828 +(% class="box infomessage" %)
829 +(((
830 +Пакеты услуг, которые следует показать на первой странице.
831 +По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг.
832 +Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него.
833 +)))
359 359  
360 -Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. По умолчанию []
835 +Пример:
361 361  
362 -==== saletermstype: 'checkbox' ====
837 +{{code language="javascript"}}
838 +bundlesid: [4, 5] // покажет пакеты услуг с id 4 и 5 в момент открытия виджета.
839 +bundlesid: false // уберёт все пакеты услуг с первой страницы
840 +{{/code}}
363 363  
364 -==== ====
842 +==== bundleslessonstariffsid ====
365 365  
366 -Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна
844 +Тип данных:##// Array<number>//##
367 367  
368 -* saletermstype: 'checkbox' потребует установку галочки для согласия.
369 -* saletermstype: 'dialog' покажет всплывающее окно с правилами, которые нужно принять.
370 -* saletermstype: 'default' принятие правил не требуется.
846 +По умолчанию:##// []//##
371 371  
372 -По умолчанию 'default'
848 +(% class="box infomessage" %)
849 +(((
850 +Фильтр списка доступных связок занятий по массиву идентификаторов
851 +)))
852 +
853 +==== groupid ====
854 +
855 +Тип данных:##// number//##
856 +
857 +По умолчанию:##// undefined//##
858 +
859 +(% class="box infomessage" %)
860 +(((
861 +Параметр, который форсирует показ определённой группы услуг ппс. **##groupid: 5##** покажет только одну группу с **##id##** 5 в виджете.
862 +)))
863 +
864 +----
865 +
866 +(% class="box warningmessage" %)
867 +(((
868 +**##* ##**- доступно в новой версии виджета
869 +)))
1702554428428-400.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +20.2 KB
Содержимое
1702554509270-941.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +13.2 KB
Содержимое
1702554528172-562.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +13.2 KB
Содержимое
1702554569171-323.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +13.1 KB
Содержимое
1702554574520-666.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +13.1 KB
Содержимое
1702554576844-773.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +13.1 KB
Содержимое
1702554598837-627.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +13.4 KB
Содержимое
1702560922714-276.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +11.1 KB
Содержимое
1702560957244-690.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +11.6 KB
Содержимое
1702638034420-756.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +2.0 KB
Содержимое
1702638265778-588.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +2.4 KB
Содержимое
1702638427440-675.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +2.9 KB
Содержимое
1702638705750-678.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +3.5 KB
Содержимое
1702639385677-964.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +2.6 KB
Содержимое
1702641274330-465.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +3.7 KB
Содержимое
1703061675290-102.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +35.6 KB
Содержимое
1703063138160-208.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +3.7 KB
Содержимое
1703065328290-657.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +37.2 KB
Содержимое
1703065338350-331.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +37.1 KB
Содержимое
1703065356750-663.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +36.7 KB
Содержимое
1703065952567-753.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.galich
Размер
... ... @@ -1,0 +1,1 @@
1 +2.9 KB
Содержимое
XWiki.XWikiRights[0]
allow
... ... @@ -1,0 +1,1 @@
1 +Разрешить
levels
... ... @@ -1,0 +1,1 @@
1 +view
users
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
XWiki.XWikiRights[1]
allow
... ... @@ -1,0 +1,1 @@
1 +Запретить
levels
... ... @@ -1,0 +1,1 @@
1 +delete,script,edit,comment
users
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
XWiki.XWikiRights[2]
allow
... ... @@ -1,0 +1,1 @@
1 +Разрешить
groups
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiAllGroup
levels
... ... @@ -1,0 +1,1 @@
1 +view