Commit | Line | Data |
---|---|---|
45ca63d0 TD |
1 | |
2 | <!doctype html> | |
3 | <html lang="en" class="no-js"> | |
4 | <head> | |
5 | ||
6 | <meta charset="utf-8"> | |
7 | <meta name="viewport" content="width=device-width,initial-scale=1"> | |
8 | ||
9 | ||
10 | ||
11 | ||
12 | <link rel="shortcut icon" href="../../assets/default.favicon.ico"> | |
fb88dc6e | 13 | <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.5"> |
45ca63d0 TD |
14 | |
15 | ||
16 | ||
17 | <title>Template Plugins - WoltLab Suite Documentation</title> | |
18 | ||
19 | ||
20 | ||
fb88dc6e | 21 | <link rel="stylesheet" href="../../assets/stylesheets/main.77f3fd56.min.css"> |
45ca63d0 TD |
22 | |
23 | ||
24 | <link rel="stylesheet" href="../../assets/stylesheets/palette.7fa14f5b.min.css"> | |
25 | ||
26 | ||
27 | ||
28 | <meta name="theme-color" content="#009485"> | |
29 | ||
30 | ||
31 | ||
32 | ||
33 | ||
34 | ||
35 | ||
36 | ||
37 | <link rel="stylesheet" href="../../stylesheets/extra.css"> | |
38 | ||
39 | ||
40 | ||
41 | ||
42 | ||
43 | </head> | |
44 | ||
45 | ||
46 | ||
47 | ||
48 | ||
49 | ||
50 | ||
51 | <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent=""> | |
52 | ||
53 | ||
54 | ||
55 | <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> | |
56 | <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> | |
57 | <label class="md-overlay" for="__drawer"></label> | |
58 | <div data-md-component="skip"> | |
59 | ||
60 | ||
61 | <a href="#template-plugins" class="md-skip"> | |
62 | Skip to content | |
63 | </a> | |
64 | ||
65 | </div> | |
66 | <div data-md-component="announce"> | |
67 | ||
68 | <aside class="md-announce"> | |
69 | <div class="md-announce__inner md-grid md-typeset"> | |
70 | ||
71 | <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a> | |
72 | ||
73 | </div> | |
74 | </aside> | |
75 | ||
76 | </div> | |
77 | ||
78 | ||
79 | ||
80 | <header class="md-header" data-md-component="header"> | |
81 | <nav class="md-header__inner md-grid" aria-label="Header"> | |
82 | <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation"> | |
83 | ||
84 | <img src="../../assets/logo.png" alt="logo"> | |
85 | ||
86 | </a> | |
87 | <label class="md-header__button md-icon" for="__drawer"> | |
88 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg> | |
89 | </label> | |
90 | <div class="md-header__title" data-md-component="header-title"> | |
91 | <div class="md-header__ellipsis"> | |
92 | <div class="md-header__topic"> | |
93 | <span class="md-ellipsis"> | |
94 | WoltLab Suite Documentation | |
95 | </span> | |
96 | </div> | |
97 | <div class="md-header__topic" data-md-component="header-topic"> | |
98 | <span class="md-ellipsis"> | |
99 | ||
100 | Template Plugins | |
101 | ||
102 | </span> | |
103 | </div> | |
104 | </div> | |
105 | </div> | |
106 | <div class="md-header__options"> | |
107 | ||
108 | </div> | |
109 | ||
110 | <label class="md-header__button md-icon" for="__search"> | |
111 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> | |
112 | </label> | |
113 | ||
114 | <div class="md-search" data-md-component="search" role="dialog"> | |
115 | <label class="md-search__overlay" for="__search"></label> | |
116 | <div class="md-search__inner" role="search"> | |
117 | <form class="md-search__form" name="search"> | |
118 | <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required> | |
119 | <label class="md-search__icon md-icon" for="__search"> | |
120 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> | |
121 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> | |
122 | </label> | |
123 | <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> | |
124 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg> | |
125 | </button> | |
126 | </form> | |
127 | <div class="md-search__output"> | |
128 | <div class="md-search__scrollwrap" data-md-scrollfix> | |
129 | <div class="md-search-result" data-md-component="search-result"> | |
130 | <div class="md-search-result__meta"> | |
131 | Initializing search | |
132 | </div> | |
133 | <ol class="md-search-result__list"></ol> | |
134 | </div> | |
135 | </div> | |
136 | </div> | |
137 | </div> | |
138 | </div> | |
139 | ||
140 | ||
141 | </nav> | |
142 | </header> | |
143 | ||
144 | <div class="md-container" data-md-component="container"> | |
145 | ||
146 | ||
147 | ||
148 | ||
149 | <main class="md-main" data-md-component="main"> | |
150 | <div class="md-main__inner md-grid"> | |
151 | ||
152 | ||
153 | ||
154 | <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > | |
155 | <div class="md-sidebar__scrollwrap"> | |
156 | <div class="md-sidebar__inner"> | |
157 | ||
158 | ||
159 | ||
160 | ||
161 | ||
162 | <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> | |
163 | <label class="md-nav__title" for="__drawer"> | |
164 | <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation"> | |
165 | ||
166 | <img src="../../assets/logo.png" alt="logo"> | |
167 | ||
168 | </a> | |
169 | WoltLab Suite Documentation | |
170 | </label> | |
171 | ||
172 | <ul class="md-nav__list" data-md-scrollfix> | |
173 | ||
174 | ||
175 | ||
176 | ||
177 | ||
178 | ||
179 | ||
180 | ||
181 | <li class="md-nav__item"> | |
182 | <a href="../../getting-started/" class="md-nav__link"> | |
183 | Getting Started | |
184 | </a> | |
185 | </li> | |
186 | ||
187 | ||
188 | ||
189 | ||
190 | ||
191 | ||
192 | ||
193 | ||
194 | ||
195 | ||
196 | ||
197 | <li class="md-nav__item md-nav__item--nested"> | |
198 | ||
199 | ||
200 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" > | |
201 | ||
202 | <label class="md-nav__link" for="__nav_2"> | |
203 | PHP API | |
204 | <span class="md-nav__icon md-icon"></span> | |
205 | </label> | |
206 | <nav class="md-nav" aria-label="PHP API" data-md-level="1"> | |
207 | <label class="md-nav__title" for="__nav_2"> | |
208 | <span class="md-nav__icon md-icon"></span> | |
209 | PHP API | |
210 | </label> | |
211 | <ul class="md-nav__list" data-md-scrollfix> | |
212 | ||
213 | ||
214 | ||
215 | ||
216 | ||
217 | <li class="md-nav__item"> | |
218 | <a href="../../php/pages/" class="md-nav__link"> | |
219 | Pages | |
220 | </a> | |
221 | </li> | |
222 | ||
223 | ||
224 | ||
225 | ||
226 | ||
227 | ||
228 | ||
229 | <li class="md-nav__item"> | |
230 | <a href="../../php/database-objects/" class="md-nav__link"> | |
231 | Database Objects | |
232 | </a> | |
233 | </li> | |
234 | ||
235 | ||
236 | ||
237 | ||
238 | ||
239 | ||
240 | ||
241 | <li class="md-nav__item"> | |
242 | <a href="../../php/database-access/" class="md-nav__link"> | |
243 | Database Access | |
244 | </a> | |
245 | </li> | |
246 | ||
247 | ||
248 | ||
249 | ||
250 | ||
251 | ||
252 | ||
253 | <li class="md-nav__item"> | |
254 | <a href="../../php/exceptions/" class="md-nav__link"> | |
255 | Exceptions | |
256 | </a> | |
257 | </li> | |
258 | ||
259 | ||
260 | ||
261 | ||
262 | ||
263 | ||
264 | ||
265 | ||
266 | <li class="md-nav__item md-nav__item--nested"> | |
267 | ||
268 | ||
269 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" > | |
270 | ||
271 | <label class="md-nav__link" for="__nav_2_5"> | |
272 | API | |
273 | <span class="md-nav__icon md-icon"></span> | |
274 | </label> | |
275 | <nav class="md-nav" aria-label="API" data-md-level="2"> | |
276 | <label class="md-nav__title" for="__nav_2_5"> | |
277 | <span class="md-nav__icon md-icon"></span> | |
278 | API | |
279 | </label> | |
280 | <ul class="md-nav__list" data-md-scrollfix> | |
281 | ||
282 | ||
283 | ||
284 | ||
285 | ||
286 | <li class="md-nav__item"> | |
287 | <a href="../../php/api/caches/" class="md-nav__link"> | |
288 | Caches | |
289 | </a> | |
290 | </li> | |
291 | ||
292 | ||
293 | ||
294 | ||
295 | ||
296 | ||
297 | ||
298 | <li class="md-nav__item"> | |
299 | <a href="../../php/api/comments/" class="md-nav__link"> | |
300 | Comments | |
301 | </a> | |
302 | </li> | |
303 | ||
304 | ||
305 | ||
306 | ||
307 | ||
308 | ||
309 | ||
310 | <li class="md-nav__item"> | |
311 | <a href="../../php/api/cronjobs/" class="md-nav__link"> | |
312 | Cronjobs | |
313 | </a> | |
314 | </li> | |
315 | ||
316 | ||
317 | ||
318 | ||
319 | ||
320 | ||
321 | ||
322 | <li class="md-nav__item"> | |
323 | <a href="../../php/api/events/" class="md-nav__link"> | |
324 | Events | |
325 | </a> | |
326 | </li> | |
327 | ||
328 | ||
329 | ||
330 | ||
331 | ||
332 | ||
333 | ||
334 | ||
335 | <li class="md-nav__item md-nav__item--nested"> | |
336 | ||
337 | ||
338 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" > | |
339 | ||
340 | <label class="md-nav__link" for="__nav_2_5_5"> | |
341 | Form Builder | |
342 | <span class="md-nav__icon md-icon"></span> | |
343 | </label> | |
344 | <nav class="md-nav" aria-label="Form Builder" data-md-level="3"> | |
345 | <label class="md-nav__title" for="__nav_2_5_5"> | |
346 | <span class="md-nav__icon md-icon"></span> | |
347 | Form Builder | |
348 | </label> | |
349 | <ul class="md-nav__list" data-md-scrollfix> | |
350 | ||
351 | ||
352 | ||
353 | ||
354 | ||
355 | <li class="md-nav__item"> | |
356 | <a href="../../php/api/form_builder/overview/" class="md-nav__link"> | |
357 | Overview | |
358 | </a> | |
359 | </li> | |
360 | ||
361 | ||
362 | ||
363 | ||
364 | ||
365 | ||
366 | ||
367 | <li class="md-nav__item"> | |
368 | <a href="../../php/api/form_builder/structure/" class="md-nav__link"> | |
369 | Structure | |
370 | </a> | |
371 | </li> | |
372 | ||
373 | ||
374 | ||
375 | ||
376 | ||
377 | ||
378 | ||
379 | <li class="md-nav__item"> | |
380 | <a href="../../php/api/form_builder/form_fields/" class="md-nav__link"> | |
381 | Fields | |
382 | </a> | |
383 | </li> | |
384 | ||
385 | ||
386 | ||
387 | ||
388 | ||
389 | ||
390 | ||
391 | <li class="md-nav__item"> | |
392 | <a href="../../php/api/form_builder/validation_data/" class="md-nav__link"> | |
393 | Validation and Data | |
394 | </a> | |
395 | </li> | |
396 | ||
397 | ||
398 | ||
399 | ||
400 | ||
401 | ||
402 | ||
403 | <li class="md-nav__item"> | |
404 | <a href="../../php/api/form_builder/dependencies/" class="md-nav__link"> | |
405 | Dependencies | |
406 | </a> | |
407 | </li> | |
408 | ||
409 | ||
410 | ||
411 | </ul> | |
412 | </nav> | |
413 | </li> | |
414 | ||
415 | ||
416 | ||
417 | ||
418 | ||
419 | ||
420 | ||
421 | <li class="md-nav__item"> | |
422 | <a href="../../php/api/package_installation_plugins/" class="md-nav__link"> | |
423 | Package Installation Plugins | |
424 | </a> | |
425 | </li> | |
426 | ||
427 | ||
428 | ||
429 | ||
430 | ||
431 | ||
432 | ||
433 | <li class="md-nav__item"> | |
434 | <a href="../../php/api/user_activity_points/" class="md-nav__link"> | |
435 | User Activity Points | |
436 | </a> | |
437 | </li> | |
438 | ||
439 | ||
440 | ||
441 | ||
442 | ||
443 | ||
444 | ||
445 | <li class="md-nav__item"> | |
446 | <a href="../../php/api/user_notifications/" class="md-nav__link"> | |
447 | User Notifications | |
448 | </a> | |
449 | </li> | |
450 | ||
451 | ||
452 | ||
453 | ||
454 | ||
455 | ||
456 | ||
457 | <li class="md-nav__item"> | |
458 | <a href="../../php/api/sitemaps/" class="md-nav__link"> | |
459 | Sitemaps | |
460 | </a> | |
461 | </li> | |
462 | ||
463 | ||
464 | ||
465 | </ul> | |
466 | </nav> | |
467 | </li> | |
468 | ||
469 | ||
470 | ||
471 | ||
472 | ||
473 | ||
474 | ||
475 | <li class="md-nav__item"> | |
476 | <a href="../../php/code-style/" class="md-nav__link"> | |
477 | Code Style | |
478 | </a> | |
479 | </li> | |
480 | ||
481 | ||
482 | ||
483 | ||
484 | ||
485 | ||
486 | ||
487 | <li class="md-nav__item"> | |
488 | <a href="../../php/apps/" class="md-nav__link"> | |
489 | Apps | |
490 | </a> | |
491 | </li> | |
492 | ||
493 | ||
494 | ||
495 | ||
496 | ||
497 | ||
498 | ||
499 | <li class="md-nav__item"> | |
500 | <a href="../../php/gdpr/" class="md-nav__link"> | |
501 | GDPR | |
502 | </a> | |
503 | </li> | |
504 | ||
505 | ||
506 | ||
507 | </ul> | |
508 | </nav> | |
509 | </li> | |
510 | ||
511 | ||
512 | ||
513 | ||
514 | ||
515 | ||
516 | ||
517 | ||
518 | ||
519 | ||
520 | ||
521 | <li class="md-nav__item md-nav__item--nested"> | |
522 | ||
523 | ||
524 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" > | |
525 | ||
526 | <label class="md-nav__link" for="__nav_3"> | |
527 | Languages, Templates & CSS | |
528 | <span class="md-nav__icon md-icon"></span> | |
529 | </label> | |
530 | <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1"> | |
531 | <label class="md-nav__title" for="__nav_3"> | |
532 | <span class="md-nav__icon md-icon"></span> | |
533 | Languages, Templates & CSS | |
534 | </label> | |
535 | <ul class="md-nav__list" data-md-scrollfix> | |
536 | ||
537 | ||
538 | ||
539 | ||
540 | ||
541 | <li class="md-nav__item"> | |
542 | <a href="../languages/" class="md-nav__link"> | |
543 | Languages | |
544 | </a> | |
545 | </li> | |
546 | ||
547 | ||
548 | ||
549 | ||
550 | ||
551 | ||
552 | ||
553 | <li class="md-nav__item"> | |
554 | <a href="../templates/" class="md-nav__link"> | |
555 | Templates | |
556 | </a> | |
557 | </li> | |
558 | ||
559 | ||
560 | ||
561 | ||
562 | ||
563 | ||
564 | ||
565 | <li class="md-nav__item"> | |
566 | <a href="../css/" class="md-nav__link"> | |
567 | CSS | |
568 | </a> | |
569 | </li> | |
570 | ||
571 | ||
572 | ||
573 | </ul> | |
574 | </nav> | |
575 | </li> | |
576 | ||
577 | ||
578 | ||
579 | ||
580 | ||
581 | ||
582 | ||
583 | ||
584 | ||
585 | ||
586 | ||
587 | <li class="md-nav__item md-nav__item--nested"> | |
588 | ||
589 | ||
590 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > | |
591 | ||
592 | <label class="md-nav__link" for="__nav_4"> | |
593 | JavaScript API | |
594 | <span class="md-nav__icon md-icon"></span> | |
595 | </label> | |
596 | <nav class="md-nav" aria-label="JavaScript API" data-md-level="1"> | |
597 | <label class="md-nav__title" for="__nav_4"> | |
598 | <span class="md-nav__icon md-icon"></span> | |
599 | JavaScript API | |
600 | </label> | |
601 | <ul class="md-nav__list" data-md-scrollfix> | |
602 | ||
603 | ||
604 | ||
605 | ||
606 | ||
607 | <li class="md-nav__item"> | |
608 | <a href="../../javascript/general-usage/" class="md-nav__link"> | |
609 | General Usage | |
610 | </a> | |
611 | </li> | |
612 | ||
613 | ||
614 | ||
615 | ||
616 | ||
617 | ||
618 | ||
619 | ||
620 | <li class="md-nav__item md-nav__item--nested"> | |
621 | ||
622 | ||
623 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" > | |
624 | ||
625 | <label class="md-nav__link" for="__nav_4_2"> | |
626 | New API | |
627 | <span class="md-nav__icon md-icon"></span> | |
628 | </label> | |
629 | <nav class="md-nav" aria-label="New API" data-md-level="2"> | |
630 | <label class="md-nav__title" for="__nav_4_2"> | |
631 | <span class="md-nav__icon md-icon"></span> | |
632 | New API | |
633 | </label> | |
634 | <ul class="md-nav__list" data-md-scrollfix> | |
635 | ||
636 | ||
637 | ||
638 | ||
639 | ||
640 | <li class="md-nav__item"> | |
641 | <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link"> | |
642 | Writing a module | |
643 | </a> | |
644 | </li> | |
645 | ||
646 | ||
647 | ||
648 | ||
649 | ||
650 | ||
651 | ||
652 | <li class="md-nav__item"> | |
653 | <a href="../../javascript/new-api_data-structures/" class="md-nav__link"> | |
654 | Data Structures | |
655 | </a> | |
656 | </li> | |
657 | ||
658 | ||
659 | ||
660 | ||
661 | ||
662 | ||
663 | ||
664 | <li class="md-nav__item"> | |
665 | <a href="../../javascript/new-api_core/" class="md-nav__link"> | |
666 | Core Functions | |
667 | </a> | |
668 | </li> | |
669 | ||
670 | ||
671 | ||
672 | ||
673 | ||
674 | ||
675 | ||
676 | <li class="md-nav__item"> | |
677 | <a href="../../javascript/new-api_dom/" class="md-nav__link"> | |
678 | DOM | |
679 | </a> | |
680 | </li> | |
681 | ||
682 | ||
683 | ||
684 | ||
685 | ||
686 | ||
687 | ||
688 | <li class="md-nav__item"> | |
689 | <a href="../../javascript/new-api_events/" class="md-nav__link"> | |
690 | Event Handling | |
691 | </a> | |
692 | </li> | |
693 | ||
694 | ||
695 | ||
696 | ||
697 | ||
698 | ||
699 | ||
700 | <li class="md-nav__item"> | |
701 | <a href="../../javascript/new-api_ajax/" class="md-nav__link"> | |
702 | Ajax | |
703 | </a> | |
704 | </li> | |
705 | ||
706 | ||
707 | ||
708 | ||
709 | ||
710 | ||
711 | ||
712 | <li class="md-nav__item"> | |
713 | <a href="../../javascript/new-api_dialogs/" class="md-nav__link"> | |
714 | Dialogs | |
715 | </a> | |
716 | </li> | |
717 | ||
718 | ||
719 | ||
720 | ||
721 | ||
722 | ||
723 | ||
724 | <li class="md-nav__item"> | |
725 | <a href="../../javascript/new-api_browser/" class="md-nav__link"> | |
726 | Browser and Screen Sizes | |
727 | </a> | |
728 | </li> | |
729 | ||
730 | ||
731 | ||
732 | ||
733 | ||
734 | ||
735 | ||
736 | <li class="md-nav__item"> | |
737 | <a href="../../javascript/new-api_ui/" class="md-nav__link"> | |
738 | User Interface | |
739 | </a> | |
740 | </li> | |
741 | ||
742 | ||
743 | ||
744 | </ul> | |
745 | </nav> | |
746 | </li> | |
747 | ||
748 | ||
749 | ||
750 | ||
751 | ||
752 | ||
753 | ||
754 | <li class="md-nav__item"> | |
755 | <a href="../../javascript/legacy-api/" class="md-nav__link"> | |
756 | Legacy API | |
757 | </a> | |
758 | </li> | |
759 | ||
760 | ||
761 | ||
762 | ||
763 | ||
764 | ||
765 | ||
766 | <li class="md-nav__item"> | |
767 | <a href="../../javascript/helper-functions/" class="md-nav__link"> | |
768 | Helper Functions | |
769 | </a> | |
770 | </li> | |
771 | ||
772 | ||
773 | ||
774 | ||
775 | ||
776 | ||
777 | ||
778 | <li class="md-nav__item"> | |
779 | <a href="../../javascript/code-snippets/" class="md-nav__link"> | |
780 | Code Snippets | |
781 | </a> | |
782 | </li> | |
783 | ||
784 | ||
785 | ||
786 | </ul> | |
787 | </nav> | |
788 | </li> | |
789 | ||
790 | ||
791 | ||
792 | ||
793 | ||
794 | ||
795 | ||
796 | ||
797 | ||
798 | ||
799 | ||
800 | <li class="md-nav__item md-nav__item--nested"> | |
801 | ||
802 | ||
803 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > | |
804 | ||
805 | <label class="md-nav__link" for="__nav_5"> | |
806 | Package Components | |
807 | <span class="md-nav__icon md-icon"></span> | |
808 | </label> | |
809 | <nav class="md-nav" aria-label="Package Components" data-md-level="1"> | |
810 | <label class="md-nav__title" for="__nav_5"> | |
811 | <span class="md-nav__icon md-icon"></span> | |
812 | Package Components | |
813 | </label> | |
814 | <ul class="md-nav__list" data-md-scrollfix> | |
815 | ||
816 | ||
817 | ||
818 | ||
819 | ||
820 | <li class="md-nav__item"> | |
821 | <a href="../../package/package-xml/" class="md-nav__link"> | |
822 | package.xml | |
823 | </a> | |
824 | </li> | |
825 | ||
826 | ||
827 | ||
828 | ||
829 | ||
830 | ||
831 | ||
832 | ||
833 | <li class="md-nav__item md-nav__item--nested"> | |
834 | ||
835 | ||
836 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" > | |
837 | ||
838 | <label class="md-nav__link" for="__nav_5_2"> | |
839 | PIPs | |
840 | <span class="md-nav__icon md-icon"></span> | |
841 | </label> | |
842 | <nav class="md-nav" aria-label="PIPs" data-md-level="2"> | |
843 | <label class="md-nav__title" for="__nav_5_2"> | |
844 | <span class="md-nav__icon md-icon"></span> | |
845 | PIPs | |
846 | </label> | |
847 | <ul class="md-nav__list" data-md-scrollfix> | |
848 | ||
849 | ||
850 | ||
851 | ||
852 | ||
853 | <li class="md-nav__item"> | |
854 | <a href="../../package/pip/" class="md-nav__link"> | |
855 | Overview | |
856 | </a> | |
857 | </li> | |
858 | ||
859 | ||
860 | ||
861 | ||
862 | ||
863 | ||
864 | ||
865 | <li class="md-nav__item"> | |
866 | <a href="../../package/pip/acl-option/" class="md-nav__link"> | |
867 | aclOption | |
868 | </a> | |
869 | </li> | |
870 | ||
871 | ||
872 | ||
873 | ||
874 | ||
875 | ||
876 | ||
877 | <li class="md-nav__item"> | |
878 | <a href="../../package/pip/acp-menu/" class="md-nav__link"> | |
879 | acpMenu | |
880 | </a> | |
881 | </li> | |
882 | ||
883 | ||
884 | ||
885 | ||
886 | ||
887 | ||
888 | ||
889 | <li class="md-nav__item"> | |
890 | <a href="../../package/pip/acp-search-provider/" class="md-nav__link"> | |
891 | acpSearchProvider | |
892 | </a> | |
893 | </li> | |
894 | ||
895 | ||
896 | ||
897 | ||
898 | ||
899 | ||
900 | ||
901 | <li class="md-nav__item"> | |
902 | <a href="../../package/pip/acp-template/" class="md-nav__link"> | |
903 | acpTemplate | |
904 | </a> | |
905 | </li> | |
906 | ||
907 | ||
908 | ||
909 | ||
910 | ||
911 | ||
912 | ||
913 | <li class="md-nav__item"> | |
914 | <a href="../../package/pip/bbcode/" class="md-nav__link"> | |
915 | bbcode | |
916 | </a> | |
917 | </li> | |
918 | ||
919 | ||
920 | ||
921 | ||
922 | ||
923 | ||
924 | ||
925 | <li class="md-nav__item"> | |
926 | <a href="../../package/pip/box/" class="md-nav__link"> | |
927 | box | |
928 | </a> | |
929 | </li> | |
930 | ||
931 | ||
932 | ||
933 | ||
934 | ||
935 | ||
936 | ||
937 | <li class="md-nav__item"> | |
938 | <a href="../../package/pip/clipboard-action/" class="md-nav__link"> | |
939 | clipboardAction | |
940 | </a> | |
941 | </li> | |
942 | ||
943 | ||
944 | ||
945 | ||
946 | ||
947 | ||
948 | ||
949 | <li class="md-nav__item"> | |
950 | <a href="../../package/pip/core-object/" class="md-nav__link"> | |
951 | coreObject | |
952 | </a> | |
953 | </li> | |
954 | ||
955 | ||
956 | ||
957 | ||
958 | ||
959 | ||
960 | ||
961 | <li class="md-nav__item"> | |
962 | <a href="../../package/pip/cronjob/" class="md-nav__link"> | |
963 | cronjob | |
964 | </a> | |
965 | </li> | |
966 | ||
967 | ||
968 | ||
969 | ||
970 | ||
971 | ||
972 | ||
973 | <li class="md-nav__item"> | |
974 | <a href="../../package/pip/event-listener/" class="md-nav__link"> | |
975 | eventListener | |
976 | </a> | |
977 | </li> | |
978 | ||
979 | ||
980 | ||
981 | ||
982 | ||
983 | ||
984 | ||
985 | <li class="md-nav__item"> | |
986 | <a href="../../package/pip/file/" class="md-nav__link"> | |
987 | file | |
988 | </a> | |
989 | </li> | |
990 | ||
991 | ||
992 | ||
993 | ||
994 | ||
995 | ||
996 | ||
997 | <li class="md-nav__item"> | |
998 | <a href="../../package/pip/language/" class="md-nav__link"> | |
999 | language | |
1000 | </a> | |
1001 | </li> | |
1002 | ||
1003 | ||
1004 | ||
1005 | ||
1006 | ||
1007 | ||
1008 | ||
1009 | <li class="md-nav__item"> | |
1010 | <a href="../../package/pip/media-provider/" class="md-nav__link"> | |
1011 | mediaProvider | |
1012 | </a> | |
1013 | </li> | |
1014 | ||
1015 | ||
1016 | ||
1017 | ||
1018 | ||
1019 | ||
1020 | ||
1021 | <li class="md-nav__item"> | |
1022 | <a href="../../package/pip/menu/" class="md-nav__link"> | |
1023 | menu | |
1024 | </a> | |
1025 | </li> | |
1026 | ||
1027 | ||
1028 | ||
1029 | ||
1030 | ||
1031 | ||
1032 | ||
1033 | <li class="md-nav__item"> | |
1034 | <a href="../../package/pip/menu-item/" class="md-nav__link"> | |
1035 | menuItem | |
1036 | </a> | |
1037 | </li> | |
1038 | ||
1039 | ||
1040 | ||
1041 | ||
1042 | ||
1043 | ||
1044 | ||
1045 | <li class="md-nav__item"> | |
1046 | <a href="../../package/pip/object-type/" class="md-nav__link"> | |
1047 | objectType | |
1048 | </a> | |
1049 | </li> | |
1050 | ||
1051 | ||
1052 | ||
1053 | ||
1054 | ||
1055 | ||
1056 | ||
1057 | <li class="md-nav__item"> | |
1058 | <a href="../../package/pip/object-type-definition/" class="md-nav__link"> | |
1059 | objectTypeDefinition | |
1060 | </a> | |
1061 | </li> | |
1062 | ||
1063 | ||
1064 | ||
1065 | ||
1066 | ||
1067 | ||
1068 | ||
1069 | <li class="md-nav__item"> | |
1070 | <a href="../../package/pip/option/" class="md-nav__link"> | |
1071 | option | |
1072 | </a> | |
1073 | </li> | |
1074 | ||
1075 | ||
1076 | ||
1077 | ||
1078 | ||
1079 | ||
1080 | ||
1081 | <li class="md-nav__item"> | |
1082 | <a href="../../package/pip/page/" class="md-nav__link"> | |
1083 | page | |
1084 | </a> | |
1085 | </li> | |
1086 | ||
1087 | ||
1088 | ||
1089 | ||
1090 | ||
1091 | ||
1092 | ||
1093 | <li class="md-nav__item"> | |
1094 | <a href="../../package/pip/pip/" class="md-nav__link"> | |
1095 | pip | |
1096 | </a> | |
1097 | </li> | |
1098 | ||
1099 | ||
1100 | ||
1101 | ||
1102 | ||
1103 | ||
1104 | ||
1105 | <li class="md-nav__item"> | |
1106 | <a href="../../package/pip/script/" class="md-nav__link"> | |
1107 | script | |
1108 | </a> | |
1109 | </li> | |
1110 | ||
1111 | ||
1112 | ||
1113 | ||
1114 | ||
1115 | ||
1116 | ||
1117 | <li class="md-nav__item"> | |
1118 | <a href="../../package/pip/smiley/" class="md-nav__link"> | |
1119 | smiley | |
1120 | </a> | |
1121 | </li> | |
1122 | ||
1123 | ||
1124 | ||
1125 | ||
1126 | ||
1127 | ||
1128 | ||
1129 | <li class="md-nav__item"> | |
1130 | <a href="../../package/pip/sql/" class="md-nav__link"> | |
1131 | sql | |
1132 | </a> | |
1133 | </li> | |
1134 | ||
1135 | ||
1136 | ||
1137 | ||
1138 | ||
1139 | ||
1140 | ||
1141 | <li class="md-nav__item"> | |
1142 | <a href="../../package/pip/style/" class="md-nav__link"> | |
1143 | style | |
1144 | </a> | |
1145 | </li> | |
1146 | ||
1147 | ||
1148 | ||
1149 | ||
1150 | ||
1151 | ||
1152 | ||
1153 | <li class="md-nav__item"> | |
1154 | <a href="../../package/pip/template/" class="md-nav__link"> | |
1155 | template | |
1156 | </a> | |
1157 | </li> | |
1158 | ||
1159 | ||
1160 | ||
1161 | ||
1162 | ||
1163 | ||
1164 | ||
1165 | <li class="md-nav__item"> | |
1166 | <a href="../../package/pip/template-listener/" class="md-nav__link"> | |
1167 | templateListener | |
1168 | </a> | |
1169 | </li> | |
1170 | ||
1171 | ||
1172 | ||
1173 | ||
1174 | ||
1175 | ||
1176 | ||
1177 | <li class="md-nav__item"> | |
1178 | <a href="../../package/pip/user-group-option/" class="md-nav__link"> | |
1179 | userGroupOption | |
1180 | </a> | |
1181 | </li> | |
1182 | ||
1183 | ||
1184 | ||
1185 | ||
1186 | ||
1187 | ||
1188 | ||
1189 | <li class="md-nav__item"> | |
1190 | <a href="../../package/pip/user-menu/" class="md-nav__link"> | |
1191 | userMenu | |
1192 | </a> | |
1193 | </li> | |
1194 | ||
1195 | ||
1196 | ||
1197 | ||
1198 | ||
1199 | ||
1200 | ||
1201 | <li class="md-nav__item"> | |
1202 | <a href="../../package/pip/user-notification-event/" class="md-nav__link"> | |
1203 | userNotificationEvent | |
1204 | </a> | |
1205 | </li> | |
1206 | ||
1207 | ||
1208 | ||
1209 | ||
1210 | ||
1211 | ||
1212 | ||
1213 | <li class="md-nav__item"> | |
1214 | <a href="../../package/pip/user-option/" class="md-nav__link"> | |
1215 | userOption | |
1216 | </a> | |
1217 | </li> | |
1218 | ||
1219 | ||
1220 | ||
1221 | ||
1222 | ||
1223 | ||
1224 | ||
1225 | <li class="md-nav__item"> | |
1226 | <a href="../../package/pip/user-profile-menu/" class="md-nav__link"> | |
1227 | userProfileMenu | |
1228 | </a> | |
1229 | </li> | |
1230 | ||
1231 | ||
1232 | ||
1233 | </ul> | |
1234 | </nav> | |
1235 | </li> | |
1236 | ||
1237 | ||
1238 | ||
1239 | ||
1240 | ||
1241 | ||
1242 | ||
1243 | <li class="md-nav__item"> | |
1244 | <a href="../../package/database-php-api/" class="md-nav__link"> | |
1245 | Database PHP API | |
1246 | </a> | |
1247 | </li> | |
1248 | ||
1249 | ||
1250 | ||
1251 | </ul> | |
1252 | </nav> | |
1253 | </li> | |
1254 | ||
1255 | ||
1256 | ||
1257 | ||
1258 | ||
1259 | ||
1260 | ||
1261 | ||
1262 | ||
1263 | ||
1264 | ||
1265 | <li class="md-nav__item md-nav__item--nested"> | |
1266 | ||
1267 | ||
1268 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > | |
1269 | ||
1270 | <label class="md-nav__link" for="__nav_6"> | |
1271 | Migration | |
1272 | <span class="md-nav__icon md-icon"></span> | |
1273 | </label> | |
1274 | <nav class="md-nav" aria-label="Migration" data-md-level="1"> | |
1275 | <label class="md-nav__title" for="__nav_6"> | |
1276 | <span class="md-nav__icon md-icon"></span> | |
1277 | Migration | |
1278 | </label> | |
1279 | <ul class="md-nav__list" data-md-scrollfix> | |
1280 | ||
1281 | ||
1282 | ||
1283 | ||
1284 | ||
1285 | ||
1286 | <li class="md-nav__item md-nav__item--nested"> | |
1287 | ||
1288 | ||
1289 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" > | |
1290 | ||
1291 | <label class="md-nav__link" for="__nav_6_1"> | |
1292 | Migrating from WSC 5.3 | |
1293 | <span class="md-nav__icon md-icon"></span> | |
1294 | </label> | |
1295 | <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2"> | |
1296 | <label class="md-nav__title" for="__nav_6_1"> | |
1297 | <span class="md-nav__icon md-icon"></span> | |
1298 | Migrating from WSC 5.3 | |
1299 | </label> | |
1300 | <ul class="md-nav__list" data-md-scrollfix> | |
1301 | ||
1302 | ||
1303 | ||
1304 | ||
1305 | ||
1306 | <li class="md-nav__item"> | |
1307 | <a href="../../migration/wsc53/php/" class="md-nav__link"> | |
1308 | PHP API | |
1309 | </a> | |
1310 | </li> | |
1311 | ||
1312 | ||
1313 | ||
1314 | ||
1315 | ||
1316 | ||
1317 | ||
1318 | <li class="md-nav__item"> | |
1319 | <a href="../../migration/wsc53/session/" class="md-nav__link"> | |
1320 | Session Handling and Authentication | |
1321 | </a> | |
1322 | </li> | |
1323 | ||
1324 | ||
1325 | ||
1326 | ||
1327 | ||
1328 | ||
1329 | ||
1330 | <li class="md-nav__item"> | |
1331 | <a href="../../migration/wsc53/javascript/" class="md-nav__link"> | |
1332 | JavaScript | |
1333 | </a> | |
1334 | </li> | |
1335 | ||
1336 | ||
1337 | ||
1338 | ||
1339 | ||
1340 | ||
1341 | ||
1342 | <li class="md-nav__item"> | |
1343 | <a href="../../migration/wsc53/templates/" class="md-nav__link"> | |
1344 | Templates | |
1345 | </a> | |
1346 | </li> | |
1347 | ||
1348 | ||
1349 | ||
1350 | ||
1351 | ||
1352 | ||
1353 | ||
1354 | <li class="md-nav__item"> | |
1355 | <a href="../../migration/wsc53/libraries/" class="md-nav__link"> | |
1356 | Third Party Libraries | |
1357 | </a> | |
1358 | </li> | |
1359 | ||
1360 | ||
1361 | ||
1362 | </ul> | |
1363 | </nav> | |
1364 | </li> | |
1365 | ||
1366 | ||
1367 | ||
1368 | ||
1369 | ||
1370 | ||
1371 | ||
1372 | ||
1373 | <li class="md-nav__item md-nav__item--nested"> | |
1374 | ||
1375 | ||
1376 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" > | |
1377 | ||
1378 | <label class="md-nav__link" for="__nav_6_2"> | |
1379 | Migrating from WSC 5.2 | |
1380 | <span class="md-nav__icon md-icon"></span> | |
1381 | </label> | |
1382 | <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2"> | |
1383 | <label class="md-nav__title" for="__nav_6_2"> | |
1384 | <span class="md-nav__icon md-icon"></span> | |
1385 | Migrating from WSC 5.2 | |
1386 | </label> | |
1387 | <ul class="md-nav__list" data-md-scrollfix> | |
1388 | ||
1389 | ||
1390 | ||
1391 | ||
1392 | ||
1393 | <li class="md-nav__item"> | |
1394 | <a href="../../migration/wsc52/php/" class="md-nav__link"> | |
1395 | PHP API | |
1396 | </a> | |
1397 | </li> | |
1398 | ||
1399 | ||
1400 | ||
1401 | ||
1402 | ||
1403 | ||
1404 | ||
1405 | <li class="md-nav__item"> | |
1406 | <a href="../../migration/wsc52/templates/" class="md-nav__link"> | |
1407 | Templates and Languages | |
1408 | </a> | |
1409 | </li> | |
1410 | ||
1411 | ||
1412 | ||
1413 | ||
1414 | ||
1415 | ||
1416 | ||
1417 | <li class="md-nav__item"> | |
1418 | <a href="../../migration/wsc52/libraries/" class="md-nav__link"> | |
1419 | Third Party Libraries | |
1420 | </a> | |
1421 | </li> | |
1422 | ||
1423 | ||
1424 | ||
1425 | </ul> | |
1426 | </nav> | |
1427 | </li> | |
1428 | ||
1429 | ||
1430 | ||
1431 | ||
1432 | ||
1433 | ||
1434 | ||
1435 | ||
1436 | <li class="md-nav__item md-nav__item--nested"> | |
1437 | ||
1438 | ||
1439 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" > | |
1440 | ||
1441 | <label class="md-nav__link" for="__nav_6_3"> | |
1442 | Migrating from WSC 3.1 | |
1443 | <span class="md-nav__icon md-icon"></span> | |
1444 | </label> | |
1445 | <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2"> | |
1446 | <label class="md-nav__title" for="__nav_6_3"> | |
1447 | <span class="md-nav__icon md-icon"></span> | |
1448 | Migrating from WSC 3.1 | |
1449 | </label> | |
1450 | <ul class="md-nav__list" data-md-scrollfix> | |
1451 | ||
1452 | ||
1453 | ||
1454 | ||
1455 | ||
1456 | <li class="md-nav__item"> | |
1457 | <a href="../../migration/wsc31/php/" class="md-nav__link"> | |
1458 | PHP API | |
1459 | </a> | |
1460 | </li> | |
1461 | ||
1462 | ||
1463 | ||
1464 | </ul> | |
1465 | </nav> | |
1466 | </li> | |
1467 | ||
1468 | ||
1469 | ||
1470 | ||
1471 | ||
1472 | ||
1473 | ||
1474 | ||
1475 | <li class="md-nav__item md-nav__item--nested"> | |
1476 | ||
1477 | ||
1478 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" > | |
1479 | ||
1480 | <label class="md-nav__link" for="__nav_6_4"> | |
1481 | Migrating from WSC 3.0 | |
1482 | <span class="md-nav__icon md-icon"></span> | |
1483 | </label> | |
1484 | <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2"> | |
1485 | <label class="md-nav__title" for="__nav_6_4"> | |
1486 | <span class="md-nav__icon md-icon"></span> | |
1487 | Migrating from WSC 3.0 | |
1488 | </label> | |
1489 | <ul class="md-nav__list" data-md-scrollfix> | |
1490 | ||
1491 | ||
1492 | ||
1493 | ||
1494 | ||
1495 | <li class="md-nav__item"> | |
1496 | <a href="../../migration/wsc30/php/" class="md-nav__link"> | |
1497 | PHP API | |
1498 | </a> | |
1499 | </li> | |
1500 | ||
1501 | ||
1502 | ||
1503 | ||
1504 | ||
1505 | ||
1506 | ||
1507 | <li class="md-nav__item"> | |
1508 | <a href="../../migration/wsc30/javascript/" class="md-nav__link"> | |
1509 | JavaScript API | |
1510 | </a> | |
1511 | </li> | |
1512 | ||
1513 | ||
1514 | ||
1515 | ||
1516 | ||
1517 | ||
1518 | ||
1519 | <li class="md-nav__item"> | |
1520 | <a href="../../migration/wsc30/templates/" class="md-nav__link"> | |
1521 | Templates | |
1522 | </a> | |
1523 | </li> | |
1524 | ||
1525 | ||
1526 | ||
1527 | ||
1528 | ||
1529 | ||
1530 | ||
1531 | <li class="md-nav__item"> | |
1532 | <a href="../../migration/wsc30/css/" class="md-nav__link"> | |
1533 | CSS | |
1534 | </a> | |
1535 | </li> | |
1536 | ||
1537 | ||
1538 | ||
1539 | ||
1540 | ||
1541 | ||
1542 | ||
1543 | <li class="md-nav__item"> | |
1544 | <a href="../../migration/wsc30/package/" class="md-nav__link"> | |
1545 | Package Components | |
1546 | </a> | |
1547 | </li> | |
1548 | ||
1549 | ||
1550 | ||
1551 | </ul> | |
1552 | </nav> | |
1553 | </li> | |
1554 | ||
1555 | ||
1556 | ||
1557 | ||
1558 | ||
1559 | ||
1560 | ||
1561 | ||
1562 | <li class="md-nav__item md-nav__item--nested"> | |
1563 | ||
1564 | ||
1565 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" > | |
1566 | ||
1567 | <label class="md-nav__link" for="__nav_6_5"> | |
1568 | Migrating from WCF 2.1 | |
1569 | <span class="md-nav__icon md-icon"></span> | |
1570 | </label> | |
1571 | <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2"> | |
1572 | <label class="md-nav__title" for="__nav_6_5"> | |
1573 | <span class="md-nav__icon md-icon"></span> | |
1574 | Migrating from WCF 2.1 | |
1575 | </label> | |
1576 | <ul class="md-nav__list" data-md-scrollfix> | |
1577 | ||
1578 | ||
1579 | ||
1580 | ||
1581 | ||
1582 | <li class="md-nav__item"> | |
1583 | <a href="../../migration/wcf21/php/" class="md-nav__link"> | |
1584 | PHP API | |
1585 | </a> | |
1586 | </li> | |
1587 | ||
1588 | ||
1589 | ||
1590 | ||
1591 | ||
1592 | ||
1593 | ||
1594 | <li class="md-nav__item"> | |
1595 | <a href="../../migration/wcf21/templates/" class="md-nav__link"> | |
1596 | Templates | |
1597 | </a> | |
1598 | </li> | |
1599 | ||
1600 | ||
1601 | ||
1602 | ||
1603 | ||
1604 | ||
1605 | ||
1606 | <li class="md-nav__item"> | |
1607 | <a href="../../migration/wcf21/css/" class="md-nav__link"> | |
1608 | CSS | |
1609 | </a> | |
1610 | </li> | |
1611 | ||
1612 | ||
1613 | ||
1614 | ||
1615 | ||
1616 | ||
1617 | ||
1618 | <li class="md-nav__item"> | |
1619 | <a href="../../migration/wcf21/package/" class="md-nav__link"> | |
1620 | Package Components | |
1621 | </a> | |
1622 | </li> | |
1623 | ||
1624 | ||
1625 | ||
1626 | </ul> | |
1627 | </nav> | |
1628 | </li> | |
1629 | ||
1630 | ||
1631 | ||
1632 | </ul> | |
1633 | </nav> | |
1634 | </li> | |
1635 | ||
1636 | ||
1637 | ||
1638 | ||
1639 | ||
1640 | ||
1641 | ||
1642 | ||
1643 | ||
1644 | ||
1645 | ||
1646 | <li class="md-nav__item md-nav__item--nested"> | |
1647 | ||
1648 | ||
1649 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > | |
1650 | ||
1651 | <label class="md-nav__link" for="__nav_7"> | |
1652 | Tutorials | |
1653 | <span class="md-nav__icon md-icon"></span> | |
1654 | </label> | |
1655 | <nav class="md-nav" aria-label="Tutorials" data-md-level="1"> | |
1656 | <label class="md-nav__title" for="__nav_7"> | |
1657 | <span class="md-nav__icon md-icon"></span> | |
1658 | Tutorials | |
1659 | </label> | |
1660 | <ul class="md-nav__list" data-md-scrollfix> | |
1661 | ||
1662 | ||
1663 | ||
1664 | ||
1665 | ||
1666 | ||
1667 | <li class="md-nav__item md-nav__item--nested"> | |
1668 | ||
1669 | ||
1670 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" > | |
1671 | ||
1672 | <label class="md-nav__link" for="__nav_7_1"> | |
1673 | Tutorial Series | |
1674 | <span class="md-nav__icon md-icon"></span> | |
1675 | </label> | |
1676 | <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2"> | |
1677 | <label class="md-nav__title" for="__nav_7_1"> | |
1678 | <span class="md-nav__icon md-icon"></span> | |
1679 | Tutorial Series | |
1680 | </label> | |
1681 | <ul class="md-nav__list" data-md-scrollfix> | |
1682 | ||
1683 | ||
1684 | ||
1685 | ||
1686 | ||
1687 | <li class="md-nav__item"> | |
1688 | <a href="../../tutorial/series/overview/" class="md-nav__link"> | |
1689 | Overview | |
1690 | </a> | |
1691 | </li> | |
1692 | ||
1693 | ||
1694 | ||
1695 | ||
1696 | ||
1697 | ||
1698 | ||
1699 | <li class="md-nav__item"> | |
1700 | <a href="../../tutorial/series/part_1/" class="md-nav__link"> | |
1701 | Part 1 | |
1702 | </a> | |
1703 | </li> | |
1704 | ||
1705 | ||
1706 | ||
1707 | ||
1708 | ||
1709 | ||
1710 | ||
1711 | <li class="md-nav__item"> | |
1712 | <a href="../../tutorial/series/part_2/" class="md-nav__link"> | |
1713 | Part 2 | |
1714 | </a> | |
1715 | </li> | |
1716 | ||
1717 | ||
1718 | ||
1719 | ||
1720 | ||
1721 | ||
1722 | ||
1723 | <li class="md-nav__item"> | |
1724 | <a href="../../tutorial/series/part_3/" class="md-nav__link"> | |
1725 | Part 3 | |
1726 | </a> | |
1727 | </li> | |
1728 | ||
1729 | ||
1730 | ||
1731 | </ul> | |
1732 | </nav> | |
1733 | </li> | |
1734 | ||
1735 | ||
1736 | ||
1737 | </ul> | |
1738 | </nav> | |
1739 | </li> | |
1740 | ||
1741 | ||
1742 | ||
1743 | </ul> | |
1744 | </nav> | |
1745 | </div> | |
1746 | </div> | |
1747 | </div> | |
1748 | ||
1749 | ||
1750 | ||
1751 | <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > | |
1752 | <div class="md-sidebar__scrollwrap"> | |
1753 | <div class="md-sidebar__inner"> | |
1754 | ||
1755 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
1756 | ||
1757 | ||
1758 | ||
1759 | ||
1760 | ||
1761 | <label class="md-nav__title" for="__toc"> | |
1762 | <span class="md-nav__icon md-icon"></span> | |
1763 | Table of contents | |
1764 | </label> | |
1765 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | |
1766 | ||
1767 | <li class="md-nav__item"> | |
1768 | <a href="#53-anchor" class="md-nav__link"> | |
1769 | 5.3+ anchor | |
1770 | </a> | |
1771 | ||
1772 | </li> | |
1773 | ||
1774 | <li class="md-nav__item"> | |
1775 | <a href="#53-anchorattributes" class="md-nav__link"> | |
1776 | 5.3+ anchorAttributes | |
1777 | </a> | |
1778 | ||
1779 | </li> | |
1780 | ||
1781 | <li class="md-nav__item"> | |
1782 | <a href="#append" class="md-nav__link"> | |
1783 | append | |
1784 | </a> | |
1785 | ||
1786 | </li> | |
1787 | ||
1788 | <li class="md-nav__item"> | |
1789 | <a href="#assign" class="md-nav__link"> | |
1790 | assign | |
1791 | </a> | |
1792 | ||
1793 | </li> | |
1794 | ||
1795 | <li class="md-nav__item"> | |
1796 | <a href="#capture" class="md-nav__link"> | |
1797 | capture | |
1798 | </a> | |
1799 | ||
1800 | </li> | |
1801 | ||
1802 | <li class="md-nav__item"> | |
1803 | <a href="#concat" class="md-nav__link"> | |
1804 | concat | |
1805 | </a> | |
1806 | ||
1807 | </li> | |
1808 | ||
1809 | <li class="md-nav__item"> | |
1810 | <a href="#counter" class="md-nav__link"> | |
1811 | counter | |
1812 | </a> | |
1813 | ||
1814 | </li> | |
1815 | ||
1816 | <li class="md-nav__item"> | |
1817 | <a href="#54-csrftoken" class="md-nav__link"> | |
1818 | 5.4+ csrfToken | |
1819 | </a> | |
1820 | ||
1821 | </li> | |
1822 | ||
1823 | <li class="md-nav__item"> | |
1824 | <a href="#currency" class="md-nav__link"> | |
1825 | currency | |
1826 | </a> | |
1827 | ||
1828 | </li> | |
1829 | ||
1830 | <li class="md-nav__item"> | |
1831 | <a href="#cycle" class="md-nav__link"> | |
1832 | cycle | |
1833 | </a> | |
1834 | ||
1835 | </li> | |
1836 | ||
1837 | <li class="md-nav__item"> | |
1838 | <a href="#date" class="md-nav__link"> | |
1839 | date | |
1840 | </a> | |
1841 | ||
1842 | </li> | |
1843 | ||
1844 | <li class="md-nav__item"> | |
1845 | <a href="#31-dateinterval" class="md-nav__link"> | |
1846 | 3.1+ dateInterval | |
1847 | </a> | |
1848 | ||
1849 | </li> | |
1850 | ||
1851 | <li class="md-nav__item"> | |
1852 | <a href="#encodejs" class="md-nav__link"> | |
1853 | encodeJS | |
1854 | </a> | |
1855 | ||
1856 | </li> | |
1857 | ||
1858 | <li class="md-nav__item"> | |
1859 | <a href="#encodejson" class="md-nav__link"> | |
1860 | encodeJSON | |
1861 | </a> | |
1862 | ||
1863 | </li> | |
1864 | ||
1865 | <li class="md-nav__item"> | |
1866 | <a href="#escapecdata" class="md-nav__link"> | |
1867 | escapeCDATA | |
1868 | </a> | |
1869 | ||
1870 | </li> | |
1871 | ||
1872 | <li class="md-nav__item"> | |
1873 | <a href="#event" class="md-nav__link"> | |
1874 | event | |
1875 | </a> | |
1876 | ||
1877 | </li> | |
1878 | ||
1879 | <li class="md-nav__item"> | |
1880 | <a href="#fetch" class="md-nav__link"> | |
1881 | fetch | |
1882 | </a> | |
1883 | ||
1884 | </li> | |
1885 | ||
1886 | <li class="md-nav__item"> | |
1887 | <a href="#filesizebinary" class="md-nav__link"> | |
1888 | filesizeBinary | |
1889 | </a> | |
1890 | ||
1891 | </li> | |
1892 | ||
1893 | <li class="md-nav__item"> | |
1894 | <a href="#filesize" class="md-nav__link"> | |
1895 | filesize | |
1896 | </a> | |
1897 | ||
1898 | </li> | |
1899 | ||
1900 | <li class="md-nav__item"> | |
1901 | <a href="#hascontent" class="md-nav__link"> | |
1902 | hascontent | |
1903 | </a> | |
1904 | ||
1905 | </li> | |
1906 | ||
1907 | <li class="md-nav__item"> | |
1908 | <a href="#htmlcheckboxes" class="md-nav__link"> | |
1909 | htmlCheckboxes | |
1910 | </a> | |
1911 | ||
1912 | </li> | |
1913 | ||
1914 | <li class="md-nav__item"> | |
1915 | <a href="#htmloptions" class="md-nav__link"> | |
1916 | htmlOptions | |
1917 | </a> | |
1918 | ||
1919 | </li> | |
1920 | ||
1921 | <li class="md-nav__item"> | |
1922 | <a href="#implode" class="md-nav__link"> | |
1923 | implode | |
1924 | </a> | |
1925 | ||
1926 | </li> | |
1927 | ||
1928 | <li class="md-nav__item"> | |
1929 | <a href="#52-ipsearch" class="md-nav__link"> | |
1930 | 5.2+ ipSearch | |
1931 | </a> | |
1932 | ||
1933 | </li> | |
1934 | ||
1935 | <li class="md-nav__item"> | |
1936 | <a href="#30-js" class="md-nav__link"> | |
1937 | 3.0+ js | |
1938 | </a> | |
1939 | ||
1940 | </li> | |
1941 | ||
1942 | <li class="md-nav__item"> | |
1943 | <a href="#53-jslang" class="md-nav__link"> | |
1944 | 5.3+ jslang | |
1945 | </a> | |
1946 | ||
1947 | </li> | |
1948 | ||
1949 | <li class="md-nav__item"> | |
1950 | <a href="#lang" class="md-nav__link"> | |
1951 | lang | |
1952 | </a> | |
1953 | ||
1954 | </li> | |
1955 | ||
1956 | <li class="md-nav__item"> | |
1957 | <a href="#language" class="md-nav__link"> | |
1958 | language | |
1959 | </a> | |
1960 | ||
1961 | </li> | |
1962 | ||
1963 | <li class="md-nav__item"> | |
1964 | <a href="#link" class="md-nav__link"> | |
1965 | link | |
1966 | </a> | |
1967 | ||
1968 | </li> | |
1969 | ||
1970 | <li class="md-nav__item"> | |
1971 | <a href="#newlinetobreak" class="md-nav__link"> | |
1972 | newlineToBreak | |
1973 | </a> | |
1974 | ||
1975 | </li> | |
1976 | ||
1977 | <li class="md-nav__item"> | |
1978 | <a href="#30-page" class="md-nav__link"> | |
1979 | 3.0+ page | |
1980 | </a> | |
1981 | ||
1982 | </li> | |
1983 | ||
1984 | <li class="md-nav__item"> | |
1985 | <a href="#pages" class="md-nav__link"> | |
1986 | pages | |
1987 | </a> | |
1988 | ||
1989 | </li> | |
1990 | ||
1991 | <li class="md-nav__item"> | |
1992 | <a href="#plaintime" class="md-nav__link"> | |
1993 | plainTime | |
1994 | </a> | |
1995 | ||
1996 | </li> | |
1997 | ||
1998 | <li class="md-nav__item"> | |
1999 | <a href="#53-plural" class="md-nav__link"> | |
2000 | 5.3+ plural | |
2001 | </a> | |
2002 | ||
2003 | </li> | |
2004 | ||
2005 | <li class="md-nav__item"> | |
2006 | <a href="#prepend" class="md-nav__link"> | |
2007 | prepend | |
2008 | </a> | |
2009 | ||
2010 | </li> | |
2011 | ||
2012 | <li class="md-nav__item"> | |
2013 | <a href="#shortunit" class="md-nav__link"> | |
2014 | shortUnit | |
2015 | </a> | |
2016 | ||
2017 | </li> | |
2018 | ||
2019 | <li class="md-nav__item"> | |
2020 | <a href="#smallpages" class="md-nav__link"> | |
2021 | smallpages | |
2022 | </a> | |
2023 | ||
2024 | </li> | |
2025 | ||
2026 | <li class="md-nav__item"> | |
2027 | <a href="#tablewordwrap" class="md-nav__link"> | |
2028 | tableWordwrap | |
2029 | </a> | |
2030 | ||
2031 | </li> | |
2032 | ||
2033 | <li class="md-nav__item"> | |
2034 | <a href="#time" class="md-nav__link"> | |
2035 | time | |
2036 | </a> | |
2037 | ||
2038 | </li> | |
2039 | ||
2040 | <li class="md-nav__item"> | |
2041 | <a href="#truncate" class="md-nav__link"> | |
2042 | truncate | |
2043 | </a> | |
2044 | ||
2045 | </li> | |
2046 | ||
2047 | <li class="md-nav__item"> | |
2048 | <a href="#53-user" class="md-nav__link"> | |
2049 | 5.3+ user | |
2050 | </a> | |
2051 | ||
2052 | </li> | |
2053 | ||
2054 | </ul> | |
2055 | ||
2056 | </nav> | |
2057 | </div> | |
2058 | </div> | |
2059 | </div> | |
2060 | ||
2061 | ||
2062 | <div class="md-content" data-md-component="content"> | |
2063 | <article class="md-content__inner md-typeset"> | |
2064 | ||
2065 | ||
2066 | ||
2067 | <h1 id="template-plugins">Template Plugins<a class="headerlink" href="#template-plugins" title="Permanent link">#</a></h1> | |
2068 | <h2 id="53-anchor"><span class="label label-info">5.3+</span> <code>anchor</code><a class="headerlink" href="#53-anchor" title="Permanent link">#</a></h2> | |
2069 | <p>The <code>anchor</code> template plugin creates <code>a</code> HTML elements. | |
2070 | The easiest way to use the template plugin is to pass it an instance of <code>ITitledLinkObject</code>:</p> | |
2071 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">anchor</span> <span class="na">object</span><span class="o">=</span><span class="nv">$object</span><span class="cp">}</span><span class="x"></span> | |
2072 | </code></pre></div> | |
45ca63d0 TD |
2073 | <p>generates the same output as</p> |
2074 | <div class="highlight"><pre><span></span><code><span class="x"><a href="</span><span class="cp">{</span><span class="nv">$object</span><span class="o">-></span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">"></span><span class="cp">{</span><span class="nv">$object</span><span class="o">-></span><span class="na">getTitle</span><span class="o">()</span><span class="cp">}</span><span class="x"></a></span> | |
2075 | </code></pre></div> | |
45ca63d0 TD |
2076 | <p>Instead of an <code>object</code> parameter, a <code>link</code> and <code>content</code> parameter can be used:</p> |
2077 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">anchor</span> <span class="na">link</span><span class="o">=</span><span class="nv">$linkObject</span> <span class="na">content</span><span class="o">=</span><span class="nv">$content</span><span class="cp">}</span><span class="x"></span> | |
2078 | </code></pre></div> | |
45ca63d0 TD |
2079 | <p>where <code>$linkObject</code> implements <code>ILinkableObject</code> and <code>$content</code> is either an object implementing <code>ITitledObject</code> or having a <code>__toString()</code> method or <code>$content</code> is a string or a number.</p> |
2080 | <p>The last special attribute is <code>append</code> whose contents are appended to the <code>href</code> attribute of the generated anchor element.</p> | |
2081 | <p>All of the other attributes matching <code>~^[a-z]+([A-z]+)+$~</code>, expect for <code>href</code> which is disallowed, are added as attributes to the anchor element.</p> | |
2082 | <p>If an <code>object</code> attribute is present, the object also implements <code>IPopoverObject</code> and if the return value of <code>IPopoverObject::getPopoverLinkClass()</code> is included in the <code>class</code> attribute of the <code>anchor</code> tag, <code>data-object-id</code> is automatically added. | |
2083 | This functionality makes it easy to generate links with popover support. | |
2084 | Instead of</p> | |
2085 | <div class="highlight"><pre><span></span><code><span class="x"><a href="</span><span class="cp">{</span><span class="nv">$entry</span><span class="o">-></span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">" class="blogEntryLink" data-object-id="</span><span class="cp">{</span><span class="o">@</span><span class="nv">$entry</span><span class="o">-></span><span class="na">entryID</span><span class="cp">}</span><span class="x">"></span><span class="cp">{</span><span class="nv">$entry</span><span class="o">-></span><span class="na">subject</span><span class="cp">}</span><span class="x"></a></span> | |
2086 | </code></pre></div> | |
45ca63d0 TD |
2087 | <p>using</p> |
2088 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">anchor</span> <span class="na">object</span><span class="o">=</span><span class="nv">$entry</span> <span class="na">class</span><span class="o">=</span><span class="s1">'blogEntryLink'</span><span class="cp">}</span><span class="x"></span> | |
2089 | </code></pre></div> | |
45ca63d0 TD |
2090 | <p>is sufficient if <code>Entry::getPopoverLinkClass()</code> returns <code>blogEntryLink</code>.</p> |
2091 | <h2 id="53-anchorattributes"><span class="label label-info">5.3+</span> <code>anchorAttributes</code><a class="headerlink" href="#53-anchorattributes" title="Permanent link">#</a></h2> | |
2092 | <p><code>anchorAttributes</code> compliments the <code>StringUtil::getAnchorTagAttributes(string, bool): string</code> method. | |
2093 | It allows to easily generate the necessary attributes for an anchor tag based off the destination URL.</p> | |
2094 | <div class="highlight"><pre><span></span><code><span class="x"><a href="https://www.example.com" </span><span class="cp">{</span><span class="nf">anchorAttributes</span> <span class="na">url</span><span class="o">=</span><span class="s1">'https://www.example.com'</span> <span class="na">appendHref</span><span class="o">=</span><span class="kc">false</span> <span class="na">appendClassname</span><span class="o">=</span><span class="kc">true</span> <span class="na">isUgc</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x">></span> | |
2095 | </code></pre></div> | |
45ca63d0 TD |
2096 | <table> |
2097 | <thead> | |
2098 | <tr> | |
2099 | <th>Attribute</th> | |
2100 | <th>Description</th> | |
2101 | </tr> | |
2102 | </thead> | |
2103 | <tbody> | |
2104 | <tr> | |
2105 | <td><code>url</code></td> | |
2106 | <td>destination URL</td> | |
2107 | </tr> | |
2108 | <tr> | |
2109 | <td><code>appendHref</code></td> | |
2110 | <td>whether the <code>href</code> attribute should be generated; <code>true</code> by default</td> | |
2111 | </tr> | |
2112 | <tr> | |
2113 | <td><code>isUgc</code></td> | |
2114 | <td>whether the <code>rel="ugc"</code> attribute should be generated; <code>false</code> by default</td> | |
2115 | </tr> | |
2116 | <tr> | |
2117 | <td><code>appendClassname</code></td> | |
2118 | <td>whether the <code>class="externalURL"</code> attribute should be generated; <code>true</code> by default</td> | |
2119 | </tr> | |
2120 | </tbody> | |
2121 | </table> | |
2122 | <h2 id="append"><code>append</code><a class="headerlink" href="#append" title="Permanent link">#</a></h2> | |
2123 | <p>If a string should be appended to the value of a variable, <code>append</code> can be used:</p> | |
2124 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">'newValue'</span><span class="cp">}</span><span class="x"></span> | |
2125 | ||
2126 | <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'newValue *</span><span class="cp">}</span><span class="x"></span> | |
2127 | ||
2128 | <span class="cp">{</span><span class="nf">append</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">'2'</span><span class="cp">}</span><span class="x"></span> | |
2129 | ||
2130 | <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* now prints 'newValue2 *</span><span class="cp">}</span><span class="x"></span> | |
2131 | </code></pre></div> | |
45ca63d0 TD |
2132 | <p>If the variables does not exist yet, <code>append</code> creates a new one with the given value. |
2133 | If <code>append</code> is used on an array as the variable, the value is appended to all elements of the array.</p> | |
2134 | <h2 id="assign"><code>assign</code><a class="headerlink" href="#assign" title="Permanent link">#</a></h2> | |
2135 | <p>New template variables can be declared and new values can be assigned to existing template variables using <code>assign</code>:</p> | |
2136 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">'newValue'</span><span class="cp">}</span><span class="x"></span> | |
2137 | ||
2138 | <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'newValue *</span><span class="cp">}</span><span class="x"></span> | |
2139 | </code></pre></div> | |
45ca63d0 TD |
2140 | <h2 id="capture"><code>capture</code><a class="headerlink" href="#capture" title="Permanent link">#</a></h2> |
2141 | <p>In some situations, <code>assign</code> is not sufficient to assign values to variables in templates if the value is complex. | |
2142 | Instead, <code>capture</code> can be used:</p> | |
2143 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">capture</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span><span class="cp">}</span><span class="x"></span> | |
2144 | <span class="x"> </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span><span class="cp">}</span><span class="x"></span> | |
2145 | <span class="x"> <p></span><span class="cp">{</span><span class="nv">$bar</span><span class="cp">}</span><span class="x"></p></span> | |
2146 | <span class="x"> </span><span class="cp">{</span><span class="nf">else</span><span class="cp">}</span><span class="x"></span> | |
2147 | <span class="x"> <small></span><span class="cp">{</span><span class="nv">$baz</span><span class="cp">}</span><span class="x"></small></span> | |
2148 | <span class="x"> </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span> | |
2149 | <span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span> | |
2150 | </code></pre></div> | |
45ca63d0 TD |
2151 | <h2 id="concat"><code>concat</code><a class="headerlink" href="#concat" title="Permanent link">#</a></h2> |
2152 | <p><code>concat</code> is a modifier used to concatenate multiple strings:</p> | |
2153 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">foo</span> <span class="na">value</span><span class="o">=</span><span class="s1">'foo'</span><span class="cp">}</span><span class="x"></span> | |
2154 | ||
2155 | <span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">'bar'</span><span class="o">|</span><span class="na">concat</span><span class="o">:</span><span class="nv">$foo</span><span class="cp">}</span><span class="x"></span> | |
2156 | ||
2157 | <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'foobar *</span><span class="cp">}</span><span class="x"></span> | |
2158 | </code></pre></div> | |
45ca63d0 TD |
2159 | <h2 id="counter"><code>counter</code><a class="headerlink" href="#counter" title="Permanent link">#</a></h2> |
2160 | <p><code>counter</code> can be used to generate and optionally print a counter:</p> | |
2161 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints '1' *</span><span class="cp">}</span><span class="x"></span> | |
2162 | ||
2163 | <span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints '2' now *</span><span class="cp">}</span><span class="x"></span> | |
2164 | ||
2165 | <span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints nothing, but counter value is '3' now internally *</span><span class="cp">}</span><span class="x"></span> | |
2166 | ||
2167 | <span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints '4' *</span><span class="cp">}</span><span class="x"></span> | |
2168 | </code></pre></div> | |
45ca63d0 TD |
2169 | <p>Counter supports the following attributes:</p> |
2170 | <table> | |
2171 | <thead> | |
2172 | <tr> | |
2173 | <th>Attribute</th> | |
2174 | <th>Description</th> | |
2175 | </tr> | |
2176 | </thead> | |
2177 | <tbody> | |
2178 | <tr> | |
2179 | <td><code>assign</code></td> | |
2180 | <td>optional name of the template variable the current counter value is assigned to</td> | |
2181 | </tr> | |
2182 | <tr> | |
2183 | <td><code>direction</code></td> | |
2184 | <td>counting direction, either <code>up</code> or <code>down</code>; <code>up</code> by default</td> | |
2185 | </tr> | |
2186 | <tr> | |
2187 | <td><code>name</code></td> | |
2188 | <td>name of the counter, relevant if multiple counters are used simultaneously</td> | |
2189 | </tr> | |
2190 | <tr> | |
2191 | <td><code>print</code></td> | |
2192 | <td>if <code>true</code>, the current counter value is printed; <code>false</code> by default</td> | |
2193 | </tr> | |
2194 | <tr> | |
2195 | <td><code>skip</code></td> | |
2196 | <td>positive counting increment; <code>1</code> by default</td> | |
2197 | </tr> | |
2198 | <tr> | |
2199 | <td><code>start</code></td> | |
2200 | <td>start counter value; <code>1</code> by default</td> | |
2201 | </tr> | |
2202 | </tbody> | |
2203 | </table> | |
2204 | <h2 id="54-csrftoken"><span class="label label-info">5.4+</span> <code>csrfToken</code><a class="headerlink" href="#54-csrftoken" title="Permanent link">#</a></h2> | |
2205 | <p><code>{csrfToken}</code> prints out the session's CSRF token (“Security Token”).</p> | |
2206 | <div class="highlight"><pre><span></span><code><span class="x"><form action="</span><span class="cp">{</span><span class="nf">link</span> <span class="na">controller</span><span class="o">=</span><span class="s2">"Foo"</span><span class="cp">}{</span><span class="nf">/link</span><span class="cp">}</span><span class="x">" method="post"></span> | |
2207 | <span class="x"> </span><span class="cp">{</span><span class="c">* snip *</span><span class="cp">}</span><span class="x"></span> | |
2208 | ||
2209 | <span class="x"> </span><span class="cp">{</span><span class="nf">csrfToken</span><span class="cp">}</span><span class="x"></span> | |
2210 | <span class="x"></form></span> | |
2211 | </code></pre></div> | |
45ca63d0 TD |
2212 | <p>The <code>{csrfToken}</code> template plugin supports a <code>type</code> parameter. |
2213 | Specifying this parameter might be required in rare situations. | |
2214 | Please <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/template/plugin/CsrfTokenFunctionTemplatePlugin.class.php">check the implementation</a> for details.</p> | |
2215 | <h2 id="currency"><code>currency</code><a class="headerlink" href="#currency" title="Permanent link">#</a></h2> | |
2216 | <p><code>currency</code> is a modifier used to format currency values with two decimals using language dependent thousands separators and decimal point:</p> | |
2217 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">currencyValue</span> <span class="na">value</span><span class="o">=</span><span class="m">12.345</span><span class="cp">}</span><span class="x"></span> | |
2218 | ||
2219 | <span class="cp">{</span><span class="nv">$currencyValue</span><span class="o">|</span><span class="na">currency</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints '12.34' *</span><span class="cp">}</span><span class="x"></span> | |
2220 | </code></pre></div> | |
45ca63d0 TD |
2221 | <h2 id="cycle"><code>cycle</code><a class="headerlink" href="#cycle" title="Permanent link">#</a></h2> |
2222 | <p><code>cycle</code> can be used to cycle between different values:</p> | |
2223 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span> <span class="na">values</span><span class="o">=</span><span class="s1">'bar,baz'</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'bar' *</span><span class="cp">}</span><span class="x"></span> | |
2224 | ||
2225 | <span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'baz' *</span><span class="cp">}</span><span class="x"></span> | |
2226 | ||
2227 | <span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span> <span class="na">advance</span><span class="o">=</span><span class="kc">false</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'baz' again *</span><span class="cp">}</span><span class="x"></span> | |
2228 | ||
2229 | <span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'bar' *</span><span class="cp">}</span><span class="x"></span> | |
2230 | </code></pre></div> | |
45ca63d0 TD |
2231 | <div class="admonition info"> |
2232 | <p class="admonition-title">The values attribute only has to be present for the first call. If <code>cycle</code> is used in a loop, the presence of the same values in consecutive calls has no effect. Only once the values change, the cycle is reset.</p> | |
2233 | </div> | |
2234 | <table> | |
2235 | <thead> | |
2236 | <tr> | |
2237 | <th>Attribute</th> | |
2238 | <th>Description</th> | |
2239 | </tr> | |
2240 | </thead> | |
2241 | <tbody> | |
2242 | <tr> | |
2243 | <td><code>advance</code></td> | |
2244 | <td>if <code>true</code>, the current cycle value is advanced to the next value; <code>true</code> by default</td> | |
2245 | </tr> | |
2246 | <tr> | |
2247 | <td><code>assign</code></td> | |
2248 | <td>optional name of the template variable the current cycle value is assigned to; if used, <code>print</code> is set to <code>false</code></td> | |
2249 | </tr> | |
2250 | <tr> | |
2251 | <td><code>delimiter</code></td> | |
2252 | <td>delimiter between the different cycle values; <code>,</code> by default</td> | |
2253 | </tr> | |
2254 | <tr> | |
2255 | <td><code>name</code></td> | |
2256 | <td>name of the cycle, relevant if multiple cycles are used simultaneously</td> | |
2257 | </tr> | |
2258 | <tr> | |
2259 | <td><code>print</code></td> | |
2260 | <td>if <code>true</code>, the current cycle value is printed, <code>false</code> by default</td> | |
2261 | </tr> | |
2262 | <tr> | |
2263 | <td><code>reset</code></td> | |
2264 | <td>if <code>true</code>, the current cycle value is set to the first value, <code>false</code> by default</td> | |
2265 | </tr> | |
2266 | <tr> | |
2267 | <td><code>values</code></td> | |
2268 | <td>string containing the different cycles values, also see <code>delimiter</code></td> | |
2269 | </tr> | |
2270 | </tbody> | |
2271 | </table> | |
2272 | <h2 id="date"><code>date</code><a class="headerlink" href="#date" title="Permanent link">#</a></h2> | |
2273 | <p><code>date</code> generated a formatted date using <code>wcf\util\DateUtil::format()</code> with <code>DateUtil::DATE_FORMAT</code> internally.</p> | |
2274 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$timestamp</span><span class="o">|</span><span class="na">date</span><span class="cp">}</span><span class="x"></span> | |
2275 | </code></pre></div> | |
45ca63d0 TD |
2276 | <h2 id="31-dateinterval"><span class="label label-info">3.1+</span> <code>dateInterval</code><a class="headerlink" href="#31-dateinterval" title="Permanent link">#</a></h2> |
2277 | <p><code>dateInterval</code> calculates the difference between two unix timestamps and generated a textual date interval.</p> | |
2278 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">dateInterval</span> <span class="na">start</span><span class="o">=</span><span class="nv">$startTimestamp</span> <span class="na">end</span><span class="o">=</span><span class="nv">$endTimestamp</span> <span class="na">full</span><span class="o">=</span><span class="kc">true</span> <span class="na">format</span><span class="o">=</span><span class="s1">'sentence'</span><span class="cp">}</span><span class="x"></span> | |
2279 | </code></pre></div> | |
45ca63d0 TD |
2280 | <table> |
2281 | <thead> | |
2282 | <tr> | |
2283 | <th>Attribute</th> | |
2284 | <th>Description</th> | |
2285 | </tr> | |
2286 | </thead> | |
2287 | <tbody> | |
2288 | <tr> | |
2289 | <td><code>end</code></td> | |
2290 | <td>end of the time interval; current timestamp by default (though either <code>start</code> or <code>end</code> has to be set)</td> | |
2291 | </tr> | |
2292 | <tr> | |
2293 | <td><code>format</code></td> | |
2294 | <td>output format, either <code>default</code>, <code>sentence</code>, or <code>plain</code>; defaults to <code>default</code>, see <code>wcf\util\DateUtil::FORMAT_*</code> constants</td> | |
2295 | </tr> | |
2296 | <tr> | |
2297 | <td><code>full</code></td> | |
2298 | <td>if <code>true</code>, full difference in minutes is shown; if <code>false</code>, only the longest time interval is shown; <code>false</code> by default</td> | |
2299 | </tr> | |
2300 | <tr> | |
2301 | <td><code>start</code></td> | |
2302 | <td>start of the time interval; current timestamp by default (though either <code>start</code> or <code>end</code> has to be set)</td> | |
2303 | </tr> | |
2304 | </tbody> | |
2305 | </table> | |
2306 | <h2 id="encodejs"><code>encodeJS</code><a class="headerlink" href="#encodejs" title="Permanent link">#</a></h2> | |
2307 | <p><code>encodeJS</code> encodes a string to be used as a single-quoted string in JavaScript by replacing <code>\\</code> with <code>\\\\</code>, <code>'</code> with <code>\'</code>, linebreaks with <code>\n</code>, and <code>/</code> with <code>\/</code>.</p> | |
2308 | <div class="highlight"><pre><span></span><code><span class="x"><script></span> | |
2309 | <span class="x"> var foo = '</span><span class="cp">{</span><span class="o">@</span><span class="nv">$foo</span><span class="o">|</span><span class="na">encodeJS</span><span class="cp">}</span><span class="x">';</span> | |
2310 | <span class="x"></script></span> | |
2311 | </code></pre></div> | |
45ca63d0 TD |
2312 | <h2 id="encodejson"><code>encodeJSON</code><a class="headerlink" href="#encodejson" title="Permanent link">#</a></h2> |
2313 | <p><code>encodeJSON</code> encodes a JSON string to be used as a single-quoted string in JavaScript by replacing <code>\\</code> with <code>\\\\</code>, <code>'</code> with <code>&#39;</code>, linebreaks with <code>\n</code>, and <code>/</code> with <code>\/</code>. | |
2314 | Additionally, <code>htmlspecialchars</code> is applied to the string.</p> | |
2315 | <div class="highlight"><pre><span></span><code><span class="x">'</span><span class="cp">{</span><span class="o">@</span><span class="nv">$foo</span><span class="o">|</span><span class="na">encodeJSON</span><span class="cp">}</span><span class="x">'</span> | |
2316 | </code></pre></div> | |
45ca63d0 TD |
2317 | <h2 id="escapecdata"><code>escapeCDATA</code><a class="headerlink" href="#escapecdata" title="Permanent link">#</a></h2> |
2318 | <p><code>escapeCDATA</code> encodes a string to be used in a <code>CDATA</code> element by replacing <code>]]></code> with <code>]]]]><![CDATA[></code>.</p> | |
2319 | <div class="highlight"><pre><span></span><code><span class="x"><![CDATA[</span><span class="cp">{</span><span class="o">@</span><span class="nv">$foo</span><span class="o">|</span><span class="na">encodeCDATA</span><span class="cp">}</span><span class="x">]]></span> | |
2320 | </code></pre></div> | |
45ca63d0 TD |
2321 | <h2 id="event"><code>event</code><a class="headerlink" href="#event" title="Permanent link">#</a></h2> |
2322 | <p><code>event</code> provides extension points in templates that <a href="../../package/pip/template-listener/">template listeners</a> can use.</p> | |
2323 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">'foo'</span><span class="cp">}</span><span class="x"></span> | |
2324 | </code></pre></div> | |
45ca63d0 TD |
2325 | <h2 id="fetch"><code>fetch</code><a class="headerlink" href="#fetch" title="Permanent link">#</a></h2> |
2326 | <p><code>fetch</code> fetches the contents of a file using <code>file_get_contents</code>.</p> | |
2327 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">fetch</span> <span class="na">file</span><span class="o">=</span><span class="s1">'foo.html'</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints the contents of `foo.html` *</span><span class="cp">}</span><span class="x"></span> | |
2328 | ||
2329 | <span class="cp">{</span><span class="nf">fetch</span> <span class="na">file</span><span class="o">=</span><span class="s1">'bar.html'</span> <span class="na">assign</span><span class="o">=</span><span class="na">bar</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* assigns the contents of `foo.html` to `$bar`; does not print the contents *</span><span class="cp">}</span><span class="x"></span> | |
2330 | </code></pre></div> | |
45ca63d0 TD |
2331 | <h2 id="filesizebinary"><code>filesizeBinary</code><a class="headerlink" href="#filesizebinary" title="Permanent link">#</a></h2> |
2332 | <p><code>filesizeBinary</code> formats the filesize using binary filesize (in bytes).</p> | |
2333 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$filesize</span><span class="o">|</span><span class="na">filesizeBinary</span><span class="cp">}</span><span class="x"></span> | |
2334 | </code></pre></div> | |
45ca63d0 TD |
2335 | <h2 id="filesize"><code>filesize</code><a class="headerlink" href="#filesize" title="Permanent link">#</a></h2> |
2336 | <p><code>filesize</code> formats the filesize using filesize (in bytes).</p> | |
2337 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$filesize</span><span class="o">|</span><span class="na">filesize</span><span class="cp">}</span><span class="x"></span> | |
2338 | </code></pre></div> | |
45ca63d0 TD |
2339 | <h2 id="hascontent"><code>hascontent</code><a class="headerlink" href="#hascontent" title="Permanent link">#</a></h2> |
2340 | <p>In many cases, conditional statements can be used to determine if a certain section of a template is shown:</p> | |
2341 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">'bar'</span><span class="cp">}</span><span class="x"></span> | |
2342 | <span class="x"> only shown if $foo is bar</span> | |
2343 | <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span> | |
2344 | </code></pre></div> | |
45ca63d0 TD |
2345 | <p>In some situations, however, such conditional statements are not sufficient. |
2346 | One prominent example is a template event:</p> | |
2347 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">'bar'</span><span class="cp">}</span><span class="x"></span> | |
2348 | <span class="x"> <ul></span> | |
2349 | <span class="x"> </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">'bar'</span><span class="cp">}</span><span class="x"></span> | |
2350 | <span class="x"> <li>Bar</li></span> | |
2351 | <span class="x"> </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span> | |
2352 | ||
2353 | <span class="x"> </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">'listItems'</span><span class="cp">}</span><span class="x"></span> | |
2354 | <span class="x"> </li></span> | |
2355 | <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span> | |
2356 | </code></pre></div> | |
45ca63d0 TD |
2357 | <p>In this example, if <code>$foo !== 'bar'</code>, the list will not be shown, regardless of the additional template code provided by template listeners. |
2358 | In such a situation, <code>hascontent</code> has to be used:</p> | |
2359 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span><span class="x"></span> | |
2360 | <span class="x"> <ul></span> | |
2361 | <span class="x"> </span><span class="cp">{</span><span class="nf">content</span><span class="cp">}</span><span class="x"></span> | |
2362 | <span class="x"> </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">'bar'</span><span class="cp">}</span><span class="x"></span> | |
2363 | <span class="x"> <li>Bar</li></span> | |
2364 | <span class="x"> </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span> | |
2365 | ||
2366 | <span class="x"> </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">'listItems'</span><span class="cp">}</span><span class="x"></span> | |
2367 | <span class="x"> </span><span class="cp">{</span><span class="nf">/content</span><span class="cp">}</span><span class="x"></span> | |
2368 | <span class="x"> </ul></span> | |
2369 | <span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span><span class="x"></span> | |
2370 | </code></pre></div> | |
45ca63d0 TD |
2371 | <p>If the part of the template wrapped in the <code>content</code> tags has any (trimmed) content, the part of the template wrapped by <code>hascontent</code> tags is shown (including the part wrapped by the <code>content</code> tags), otherwise nothing is shown. |
2372 | Thus, this construct avoids an empty list compared to the <code>if</code> solution above.</p> | |
2373 | <p>Like <code>foreach</code>, <code>hascontent</code> also supports an <code>else</code> part:</p> | |
2374 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span><span class="x"></span> | |
2375 | <span class="x"> <ul></span> | |
2376 | <span class="x"> </span><span class="cp">{</span><span class="nf">content</span><span class="cp">}</span><span class="x"></span> | |
2377 | <span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span> | |
2378 | <span class="x"> </span><span class="cp">{</span><span class="nf">/content</span><span class="cp">}</span><span class="x"></span> | |
2379 | <span class="x"> </ul></span> | |
2380 | <span class="cp">{</span><span class="nf">hascontentelse</span><span class="cp">}</span><span class="x"></span> | |
2381 | <span class="x"> no list</span> | |
2382 | <span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span><span class="x"></span> | |
2383 | </code></pre></div> | |
45ca63d0 TD |
2384 | <h2 id="htmlcheckboxes"><code>htmlCheckboxes</code><a class="headerlink" href="#htmlcheckboxes" title="Permanent link">#</a></h2> |
2385 | <p><code>htmlCheckboxes</code> generates a list of HTML checkboxes.</p> | |
2386 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">htmlCheckboxes</span> <span class="na">name</span><span class="o">=</span><span class="na">foo</span> <span class="na">options</span><span class="o">=</span><span class="nv">$fooOptions</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$currentFoo</span><span class="cp">}</span><span class="x"></span> | |
2387 | ||
2388 | <span class="cp">{</span><span class="nf">htmlCheckboxes</span> <span class="na">name</span><span class="o">=</span><span class="na">bar</span> <span class="na">output</span><span class="o">=</span><span class="nv">$barLabels</span> <span class="na">values</span><span class="o">=</span><span class="nv">$barValues</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$currentBar</span><span class="cp">}</span><span class="x"></span> | |
2389 | </code></pre></div> | |
45ca63d0 TD |
2390 | <table> |
2391 | <thead> | |
2392 | <tr> | |
2393 | <th>Attribute</th> | |
2394 | <th>Description</th> | |
2395 | </tr> | |
2396 | </thead> | |
2397 | <tbody> | |
2398 | <tr> | |
2399 | <td><span class="label label-info">5.2+</span> <code>disabled</code></td> | |
2400 | <td>if <code>true</code>, all checkboxes are disabled</td> | |
2401 | </tr> | |
2402 | <tr> | |
2403 | <td><code>disableEncoding</code></td> | |
2404 | <td>if <code>true</code>, the values are not passed through <code>wcf\util\StringUtil::encodeHTML()</code>; <code>false</code> by default</td> | |
2405 | </tr> | |
2406 | <tr> | |
2407 | <td><code>name</code></td> | |
2408 | <td><code>name</code> attribute of the <code>input</code> checkbox element</td> | |
2409 | </tr> | |
2410 | <tr> | |
2411 | <td><code>output</code></td> | |
2412 | <td>array used as keys and values for <code>options</code> if present; not present by default</td> | |
2413 | </tr> | |
2414 | <tr> | |
2415 | <td><code>options</code></td> | |
2416 | <td>array selectable options with the key used as <code>value</code> attribute and the value as the checkbox label</td> | |
2417 | </tr> | |
2418 | <tr> | |
2419 | <td><code>selected</code></td> | |
2420 | <td>current selected value(s)</td> | |
2421 | </tr> | |
2422 | <tr> | |
2423 | <td><code>separator</code></td> | |
2424 | <td>separator between the different checkboxes in the generated output; empty string by default</td> | |
2425 | </tr> | |
2426 | <tr> | |
2427 | <td><code>values</code></td> | |
2428 | <td>array with values used in combination with <code>output</code>, where <code>output</code> is only used as keys for <code>options</code></td> | |
2429 | </tr> | |
2430 | </tbody> | |
2431 | </table> | |
2432 | <h2 id="htmloptions"><code>htmlOptions</code><a class="headerlink" href="#htmloptions" title="Permanent link">#</a></h2> | |
2433 | <p><code>htmlOptions</code> generates an <code>select</code> HTML element.</p> | |
2434 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">htmlOptions</span> <span class="na">name</span><span class="o">=</span><span class="s1">'foo'</span> <span class="na">options</span><span class="o">=</span><span class="nv">$options</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$selected</span><span class="cp">}</span><span class="x"></span> | |
2435 | ||
2436 | <span class="x"><select name="bar"></span> | |
2437 | <span class="x"> <option value=""</span><span class="cp">{</span><span class="nf">if</span> <span class="o">!</span><span class="nv">$selected</span><span class="cp">}</span><span class="x"> selected</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x">></span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.default</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></option></span> | |
2438 | <span class="x"> </span><span class="cp">{</span><span class="nf">htmlOptions</span> <span class="na">options</span><span class="o">=</span><span class="nv">$options</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$selected</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* no `name` attribute *</span><span class="cp">}</span><span class="x"></span> | |
2439 | <span class="x"></select></span> | |
2440 | </code></pre></div> | |
45ca63d0 TD |
2441 | <table> |
2442 | <thead> | |
2443 | <tr> | |
2444 | <th>Attribute</th> | |
2445 | <th>Description</th> | |
2446 | </tr> | |
2447 | </thead> | |
2448 | <tbody> | |
2449 | <tr> | |
2450 | <td><code>disableEncoding</code></td> | |
2451 | <td>if <code>true</code>, the values are not passed through <code>wcf\util\StringUtil::encodeHTML()</code>; <code>false</code> by default</td> | |
2452 | </tr> | |
2453 | <tr> | |
2454 | <td><code>object</code></td> | |
2455 | <td>optional instance of <code>wcf\data\DatabaseObjectList</code> that provides the selectable options (overwrites <code>options</code> attribute internally)</td> | |
2456 | </tr> | |
2457 | <tr> | |
2458 | <td><code>name</code></td> | |
2459 | <td><code>name</code> attribute of the <code>select</code> element; if not present, only the <strong>contents</strong> of the <code>select</code> element are printed</td> | |
2460 | </tr> | |
2461 | <tr> | |
2462 | <td><code>output</code></td> | |
2463 | <td>array used as keys and values for <code>options</code> if present; not present by default</td> | |
2464 | </tr> | |
2465 | <tr> | |
2466 | <td><code>values</code></td> | |
2467 | <td>array with values used in combination with <code>output</code>, where <code>output</code> is only used as keys for <code>options</code></td> | |
2468 | </tr> | |
2469 | <tr> | |
2470 | <td><code>options</code></td> | |
2471 | <td>array selectable options with the key used as <code>value</code> attribute and the value as the option label; if a value is an array, an <code>optgroup</code> is generated with the array key as the <code>optgroup</code> label</td> | |
2472 | </tr> | |
2473 | <tr> | |
2474 | <td><code>selected</code></td> | |
2475 | <td>current selected value(s)</td> | |
2476 | </tr> | |
2477 | </tbody> | |
2478 | </table> | |
2479 | <p>All additional attributes are added as attributes of the <code>select</code> HTML element.</p> | |
2480 | <h2 id="implode"><code>implode</code><a class="headerlink" href="#implode" title="Permanent link">#</a></h2> | |
2481 | <p><code>implodes</code> transforms an array into a string and prints it.</p> | |
2482 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">implode</span> <span class="na">from</span><span class="o">=</span><span class="nv">$array</span> <span class="na">key</span><span class="o">=</span><span class="na">key</span> <span class="na">item</span><span class="o">=</span><span class="na">item</span> <span class="na">glue</span><span class="o">=</span><span class="s2">";"</span><span class="cp">}{</span><span class="nv">$key</span><span class="cp">}</span><span class="x">: </span><span class="cp">{</span><span class="nv">$value</span><span class="cp">}{</span><span class="nf">/implode</span><span class="cp">}</span><span class="x"></span> | |
2483 | </code></pre></div> | |
45ca63d0 TD |
2484 | <table> |
2485 | <thead> | |
2486 | <tr> | |
2487 | <th>Attribute</th> | |
2488 | <th>Description</th> | |
2489 | </tr> | |
2490 | </thead> | |
2491 | <tbody> | |
2492 | <tr> | |
2493 | <td><code>from</code></td> | |
2494 | <td>array with the imploded values</td> | |
2495 | </tr> | |
2496 | <tr> | |
2497 | <td><code>glue</code></td> | |
2498 | <td>separator between the different array values; <code>', '</code> by default</td> | |
2499 | </tr> | |
2500 | <tr> | |
2501 | <td><code>item</code></td> | |
2502 | <td>template variable name where the current array value is stored during the iteration</td> | |
2503 | </tr> | |
2504 | <tr> | |
2505 | <td><code>key</code></td> | |
2506 | <td>optional template variable name where the current array key is stored during the iteration</td> | |
2507 | </tr> | |
2508 | </tbody> | |
2509 | </table> | |
2510 | <h2 id="52-ipsearch"><span class="label label-info">5.2+</span> <code>ipSearch</code><a class="headerlink" href="#52-ipsearch" title="Permanent link">#</a></h2> | |
2511 | <p><code>ipSearch</code> generates a link to search for an IP address.</p> | |
2512 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="s2">"127.0.0.1"</span><span class="o">|</span><span class="na">ipSearch</span><span class="cp">}</span><span class="x"></span> | |
2513 | </code></pre></div> | |
45ca63d0 TD |
2514 | <h2 id="30-js"><span class="label label-info">3.0+</span> <code>js</code><a class="headerlink" href="#30-js" title="Permanent link">#</a></h2> |
2515 | <p><code>js</code> generates script tags based on whether <code>ENABLE_DEBUG_MODE</code> and <code>VISITOR_USE_TINY_BUILD</code> are enabled.</p> | |
2516 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">'wbb'</span> <span class="na">file</span><span class="o">=</span><span class="s1">'WBB'</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/js/WBB.js' *</span><span class="cp">}</span><span class="x"></span> | |
2517 | ||
2518 | <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">'wcf'</span> <span class="na">file</span><span class="o">=</span><span class="s1">'WCF.Like'</span> <span class="na">bundle</span><span class="o">=</span><span class="s1">'WCF.Combined'</span><span class="cp">}</span><span class="x"></span> | |
2519 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/WCF.Like.js' if ENABLE_DEBUG_MODE=1 *</span><span class="cp">}</span><span class="x"></span> | |
2520 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/WCF.Combined.min.js' if ENABLE_DEBUG_MODE=0 *</span><span class="cp">}</span><span class="x"></span> | |
2521 | ||
2522 | <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">'wcf'</span> <span class="na">lib</span><span class="o">=</span><span class="s1">'jquery'</span><span class="cp">}</span><span class="x"></span> | |
2523 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/3rdParty/jquery.js' *</span><span class="cp">}</span><span class="x"></span> | |
2524 | ||
2525 | <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">'wcf'</span> <span class="na">lib</span><span class="o">=</span><span class="s1">'jquery-ui'</span> <span class="na">file</span><span class="o">=</span><span class="s1">'awesomeWidget'</span><span class="cp">}</span><span class="x"></span> | |
2526 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/3rdParty/jquery-ui/awesomeWidget.js' *</span><span class="cp">}</span><span class="x"></span> | |
2527 | ||
2528 | <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">'wcf'</span> <span class="na">file</span><span class="o">=</span><span class="s1">'WCF.Like'</span> <span class="na">bundle</span><span class="o">=</span><span class="s1">'WCF.Combined'</span> <span class="na">hasTiny</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"></span> | |
2529 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/WCF.Like.js' if ENABLE_DEBUG_MODE=1 *</span><span class="cp">}</span><span class="x"></span> | |
2530 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/WCF.Combined.min.js' (ENABLE_DEBUG_MODE=0 *</span><span class="cp">}</span><span class="x"></span> | |
2531 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/WCF.Combined.tiny.min.js' if ENABLE_DEBUG_MODE=0 and VISITOR_USE_TINY_BUILD=1 *</span><span class="cp">}</span><span class="x"></span> | |
2532 | </code></pre></div> | |
45ca63d0 TD |
2533 | <h2 id="53-jslang"><span class="label label-info">5.3+</span> <code>jslang</code><a class="headerlink" href="#53-jslang" title="Permanent link">#</a></h2> |
2534 | <p><code>jslang</code> works like <a href="#lang"><code>lang</code></a> with the difference that the resulting string is automatically passed through <a href="#encodejs"><code>encodeJS</code></a>.</p> | |
2535 | <div class="highlight"><pre><span></span><code><span class="x">require(['Language', /* … */], function(Language, /* … */) </span><span class="cp">{</span> | |
2536 | <span class="na">Language</span><span class="o">.</span><span class="na">addObject</span><span class="o">(</span><span class="cp">{</span> | |
2537 | <span class="s1">'app.foo.bar'</span><span class="o">:</span> <span class="s1">'{jslang}app.foo.bar{/jslang}'</span><span class="o">,</span> | |
2538 | <span class="cp">}</span><span class="o">);</span> | |
2539 | ||
2540 | <span class="o">//</span> <span class="err">…</span> | |
2541 | <span class="cp">}</span><span class="x">);</span> | |
2542 | </code></pre></div> | |
45ca63d0 TD |
2543 | <h2 id="lang"><code>lang</code><a class="headerlink" href="#lang" title="Permanent link">#</a></h2> |
2544 | <p><code>lang</code> replaces a language items with its value.</p> | |
2545 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.baz</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span> | |
2546 | ||
2547 | <span class="cp">{</span><span class="nf">lang</span> <span class="na">__literal</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x">foo.bar.baz</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span> | |
2548 | ||
2549 | <span class="cp">{</span><span class="nf">lang</span> <span class="na">foo</span><span class="o">=</span><span class="s1">'baz'</span><span class="cp">}</span><span class="x">foo.bar.baz</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span> | |
2550 | ||
2551 | <span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.baz.</span><span class="cp">{</span><span class="nv">$action</span><span class="cp">}{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span> | |
2552 | </code></pre></div> | |
45ca63d0 TD |
2553 | <table> |
2554 | <thead> | |
2555 | <tr> | |
2556 | <th>Attribute</th> | |
2557 | <th>Description</th> | |
2558 | </tr> | |
2559 | </thead> | |
2560 | <tbody> | |
2561 | <tr> | |
2562 | <td><code>__encode</code></td> | |
2563 | <td>if <code>true</code>, the output will be passed through <code>StringUtil::encodeHTML()</code></td> | |
2564 | </tr> | |
2565 | <tr> | |
2566 | <td><code>__literal</code></td> | |
2567 | <td>if <code>true</code>, template variables will not resolved but printed as they are in the language item; <code>false</code> by default</td> | |
2568 | </tr> | |
2569 | <tr> | |
2570 | <td><code>__optional</code></td> | |
2571 | <td>if <code>true</code> and the language item does not exist, an empty string is printed; <code>false</code> by default</td> | |
2572 | </tr> | |
2573 | </tbody> | |
2574 | </table> | |
2575 | <p>All additional attributes are available when parsing the language item.</p> | |
2576 | <h2 id="language"><code>language</code><a class="headerlink" href="#language" title="Permanent link">#</a></h2> | |
2577 | <p><code>language</code> replaces a language items with its value. | |
2578 | If the template variable <code>__language</code> exists, this language object will be used instead of <code>WCF::getLanguage()</code>. | |
2579 | This modifier is useful when assigning the value directly to a variable.</p> | |
2580 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$languageItem</span><span class="o">|</span><span class="na">language</span><span class="cp">}</span><span class="x"></span> | |
2581 | ||
2582 | <span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">foo</span> <span class="na">value</span><span class="o">=</span><span class="nv">$languageItem</span><span class="o">|</span><span class="na">language</span><span class="cp">}</span><span class="x"></span> | |
2583 | </code></pre></div> | |
45ca63d0 TD |
2584 | <h2 id="link"><code>link</code><a class="headerlink" href="#link" title="Permanent link">#</a></h2> |
2585 | <p><code>link</code> generates internal links using <code>LinkHandler</code>.</p> | |
2586 | <div class="highlight"><pre><span></span><code><span class="x"><a href="</span><span class="cp">{</span><span class="nf">link</span> <span class="na">controller</span><span class="o">=</span><span class="s1">'FooList'</span> <span class="na">application</span><span class="o">=</span><span class="s1">'bar'</span><span class="cp">}</span><span class="x">param1=2&param2=A</span><span class="cp">{</span><span class="nf">/link</span><span class="cp">}</span><span class="x">">Foo</a></span> | |
2587 | </code></pre></div> | |
45ca63d0 TD |
2588 | <table> |
2589 | <thead> | |
2590 | <tr> | |
2591 | <th>Attribute</th> | |
2592 | <th>Description</th> | |
2593 | </tr> | |
2594 | </thead> | |
2595 | <tbody> | |
2596 | <tr> | |
2597 | <td><code>application</code></td> | |
2598 | <td>abbreviation of the application the controller belongs to; <code>wcf</code> by default</td> | |
2599 | </tr> | |
2600 | <tr> | |
2601 | <td><code>controller</code></td> | |
2602 | <td>name of the controller; if not present, the landing page is linked in the frontend and the index page in the ACP</td> | |
2603 | </tr> | |
2604 | <tr> | |
2605 | <td><code>encode</code></td> | |
2606 | <td>if <code>true</code>, the generated link is passed through <code>wcf\util\StringUtil::encodeHTML()</code>; <code>true</code> by default</td> | |
2607 | </tr> | |
2608 | <tr> | |
2609 | <td><code>isEmail</code></td> | |
2610 | <td>sets <code>encode=false</code> and forces links to link to the frontend</td> | |
2611 | </tr> | |
2612 | </tbody> | |
2613 | </table> | |
2614 | <p>Additional attributes are passed to <code>LinkHandler::getLink()</code>.</p> | |
2615 | <h2 id="newlinetobreak"><code>newlineToBreak</code><a class="headerlink" href="#newlinetobreak" title="Permanent link">#</a></h2> | |
2616 | <p><code>newlineToBreak</code> transforms newlines into HTML <code><br></code> elements after encoding the content via <code>wcf\util\StringUtil::encodeHTML()</code>.</p> | |
2617 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">newlineToBreak</span><span class="cp">}</span><span class="x"></span> | |
2618 | </code></pre></div> | |
45ca63d0 TD |
2619 | <h2 id="30-page"><span class="label label-info">3.0+</span> <code>page</code><a class="headerlink" href="#30-page" title="Permanent link">#</a></h2> |
2620 | <p><code>page</code> generates an internal link to a CMS page.</p> | |
2621 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">page</span><span class="cp">}</span><span class="x">com.woltlab.wcf.CookiePolicy</span><span class="cp">{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span> | |
2622 | ||
2623 | <span class="cp">{</span><span class="nf">page</span> <span class="na">pageID</span><span class="o">=</span><span class="m">1</span><span class="cp">}{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span> | |
2624 | ||
2625 | <span class="cp">{</span><span class="nf">page</span> <span class="na">language</span><span class="o">=</span><span class="s1">'de'</span><span class="cp">}</span><span class="x">com.woltlab.wcf.CookiePolicy</span><span class="cp">{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span> | |
2626 | ||
2627 | <span class="cp">{</span><span class="nf">page</span> <span class="na">languageID</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x">com.woltlab.wcf.CookiePolicy</span><span class="cp">{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span> | |
2628 | </code></pre></div> | |
45ca63d0 TD |
2629 | <table> |
2630 | <thead> | |
2631 | <tr> | |
2632 | <th>Attribute</th> | |
2633 | <th>Description</th> | |
2634 | </tr> | |
2635 | </thead> | |
2636 | <tbody> | |
2637 | <tr> | |
2638 | <td><code>pageID</code></td> | |
2639 | <td>unique id of the page (cannot be used together with a page identifier as value)</td> | |
2640 | </tr> | |
2641 | <tr> | |
2642 | <td><code>languageID</code></td> | |
2643 | <td>id of the page language (cannot be used together with <code>language</code>)</td> | |
2644 | </tr> | |
2645 | <tr> | |
2646 | <td><code>language</code></td> | |
2647 | <td>language code of the page language (cannot be used together with <code>languageID</code>)</td> | |
2648 | </tr> | |
2649 | </tbody> | |
2650 | </table> | |
2651 | <h2 id="pages"><code>pages</code><a class="headerlink" href="#pages" title="Permanent link">#</a></h2> | |
2652 | <p><code>pages</code> generates a pagination.</p> | |
2653 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">pages</span> <span class="na">controller</span><span class="o">=</span><span class="s1">'FooList'</span> <span class="na">link</span><span class="o">=</span><span class="s2">"pageNo=%d"</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span> <span class="na">assign</span><span class="o">=</span><span class="na">pagesLinks</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints pagination *</span><span class="cp">}</span><span class="x"></span> | |
2654 | ||
2655 | <span class="cp">{</span><span class="o">@</span><span class="nv">$pagesLinks</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints same pagination again *</span><span class="cp">}</span><span class="x"></span> | |
2656 | </code></pre></div> | |
45ca63d0 TD |
2657 | <table> |
2658 | <thead> | |
2659 | <tr> | |
2660 | <th>Attribute</th> | |
2661 | <th>Description</th> | |
2662 | </tr> | |
2663 | </thead> | |
2664 | <tbody> | |
2665 | <tr> | |
2666 | <td><code>assign</code></td> | |
2667 | <td>optional name of the template variable the pagination is assigned to</td> | |
2668 | </tr> | |
2669 | <tr> | |
2670 | <td><code>controller</code></td> | |
2671 | <td>controller name of the generated links</td> | |
2672 | </tr> | |
2673 | <tr> | |
2674 | <td><code>link</code></td> | |
2675 | <td>additional link parameter where <code>%d</code> will be replaced with the relevant page number</td> | |
2676 | </tr> | |
2677 | <tr> | |
2678 | <td><code>pages</code></td> | |
2679 | <td>maximum number of of pages; by default, the template variable <code>$pages</code> is used</td> | |
2680 | </tr> | |
2681 | <tr> | |
2682 | <td><code>print</code></td> | |
2683 | <td>if <code>false</code> and <code>assign=true</code>, the pagination is not printed</td> | |
2684 | </tr> | |
2685 | <tr> | |
2686 | <td><code>application</code>, <code>id</code>, <code>object</code>, <code>title</code></td> | |
2687 | <td>additional parameters passed to <code>LinkHandler::getLink()</code> to generate page links</td> | |
2688 | </tr> | |
2689 | </tbody> | |
2690 | </table> | |
2691 | <h2 id="plaintime"><code>plainTime</code><a class="headerlink" href="#plaintime" title="Permanent link">#</a></h2> | |
2692 | <p><code>plainTime</code> formats a timestamp to include year, month, day, hour, and minutes. | |
2693 | The exact formatting depends on the current language (via the language items <code>wcf.date.dateTimeFormat</code>, <code>wcf.date.dateFormat</code>, and <code>wcf.date.timeFormat</code>).</p> | |
2694 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$timestamp</span><span class="o">|</span><span class="na">plainTime</span><span class="cp">}</span><span class="x"></span> | |
2695 | </code></pre></div> | |
45ca63d0 TD |
2696 | <h2 id="53-plural"><span class="label label-info">5.3+</span> <code>plural</code><a class="headerlink" href="#53-plural" title="Permanent link">#</a></h2> |
2697 | <p><code>plural</code> allows to easily select the correct plural form of a phrase based on a given <code>value</code>. | |
2698 | The pluralization logic follows the <a href="https://unicode-org.github.io/cldr-staging/charts/37/supplemental/language_plural_rules.md">Unicode Language Plural Rules</a> for cardinal numbers.</p> | |
2699 | <p>The <code>#</code> placeholder within the resulting phrase is replaced by the <code>value</code>. | |
2700 | It is automatically formatted using <code>StringUtil::formatNumeric</code>.</p> | |
2701 | <p>English:</p> | |
2702 | <p>Note the use of <code>1</code> if the number (<code>#</code>) is not used within the phrase and the use of <code>one</code> otherwise. | |
2703 | They are equivalent for English, but following this rule generalizes better to other languages, helping the translator. | |
2704 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span> | |
2705 | <span class="x"><h1>Hello </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'World'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'Worlds'</span><span class="cp">}</span><span class="x">!</h1></span> | |
2706 | <span class="x"><p>There </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'is one world'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'are # worlds'</span><span class="cp">}</span><span class="x">!</p></span> | |
2707 | <span class="x"><p>There </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="na">one</span><span class="o">=</span><span class="s1">'is # world'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'are # worlds'</span><span class="cp">}</span><span class="x">!</p></span> | |
2708 | </code></pre></div></p> | |
2709 | <p>German: | |
2710 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span> | |
2711 | <span class="x"><h1>Hallo </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'Welt'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'Welten'</span><span class="cp">}</span><span class="x">!</h1></span> | |
2712 | <span class="x"><p>Es gibt </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'eine Welt'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'# Welten'</span><span class="cp">}</span><span class="x">!</p></span> | |
2713 | <span class="x"><p>Es gibt </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="na">one</span><span class="o">=</span><span class="s1">'# Welt'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'# Welten'</span><span class="cp">}</span><span class="x">!</p></span> | |
2714 | </code></pre></div></p> | |
2715 | <p>Romanian:</p> | |
2716 | <p>Note the additional use of <code>few</code> which is not required in English or German. | |
2717 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span> | |
2718 | <span class="x"><h1>Salut </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'lume'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'lumi'</span><span class="cp">}</span><span class="x">!</h1></span> | |
2719 | <span class="x"><p>Există </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'o lume'</span> <span class="na">few</span><span class="o">=</span><span class="s1">'# lumi'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'# de lumi'</span><span class="cp">}</span><span class="x">!</p></span> | |
2720 | <span class="x"><p>Există </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="na">one</span><span class="o">=</span><span class="s1">'# lume'</span> <span class="na">few</span><span class="o">=</span><span class="s1">'# lumi'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'# de lumi'</span><span class="cp">}</span><span class="x">!</p></span> | |
2721 | </code></pre></div></p> | |
2722 | <p>Russian:</p> | |
2723 | <p>Note the difference between <code>1</code> (exactly <code>1</code>) and <code>one</code> (ending in <code>1</code>, except ending in <code>11</code>). | |
2724 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span> | |
2725 | <span class="x"><h1>Привет </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorld</span> <span class="m">1</span><span class="o">=</span><span class="s1">'мир'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'миры'</span><span class="cp">}</span><span class="x">!</h1></span> | |
2726 | <span class="x"><p>Есть </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'мир'</span> <span class="na">one</span><span class="o">=</span><span class="s1">'# мир'</span> <span class="na">few</span><span class="o">=</span><span class="s1">'# мира'</span> <span class="na">many</span><span class="o">=</span><span class="s1">'# миров'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'# миров'</span><span class="cp">}</span><span class="x">!</p></span> | |
2727 | </code></pre></div></p> | |
2728 | <table> | |
2729 | <thead> | |
2730 | <tr> | |
2731 | <th>Attribute</th> | |
2732 | <th>Description</th> | |
2733 | </tr> | |
2734 | </thead> | |
2735 | <tbody> | |
2736 | <tr> | |
2737 | <td>value</td> | |
2738 | <td>The value that is used to select the proper phrase.</td> | |
2739 | </tr> | |
2740 | <tr> | |
2741 | <td>other</td> | |
2742 | <td>The phrase that is used when no other selector matches.</td> | |
2743 | </tr> | |
2744 | <tr> | |
2745 | <td>Any Category Name</td> | |
2746 | <td>The phrase that is used when <code>value</code> belongs to the named category. Available categories depend on the language.</td> | |
2747 | </tr> | |
2748 | <tr> | |
2749 | <td>Any Integer</td> | |
2750 | <td>The phrase that is used when <code>value</code> is that exact integer.</td> | |
2751 | </tr> | |
2752 | </tbody> | |
2753 | </table> | |
2754 | <h2 id="prepend"><code>prepend</code><a class="headerlink" href="#prepend" title="Permanent link">#</a></h2> | |
2755 | <p>If a string should be prepended to the value of a variable, <code>prepend</code> can be used:</p> | |
2756 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">'newValue'</span><span class="cp">}</span><span class="x"></span> | |
2757 | ||
2758 | <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'newValue *</span><span class="cp">}</span><span class="x"></span> | |
2759 | ||
2760 | <span class="cp">{</span><span class="nf">prepend</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">'2'</span><span class="cp">}</span><span class="x"></span> | |
2761 | ||
2762 | <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* now prints '2newValue' *</span><span class="cp">}</span><span class="x"></span> | |
2763 | </code></pre></div> | |
45ca63d0 TD |
2764 | <p>If the variables does not exist yet, <code>prepend</code> creates a new one with the given value. |
2765 | If <code>prepend</code> is used on an array as the variable, the value is prepended to all elements of the array.</p> | |
2766 | <h2 id="shortunit"><code>shortUnit</code><a class="headerlink" href="#shortunit" title="Permanent link">#</a></h2> | |
2767 | <p><code>shortUnit</code> shortens numbers larger than 1000 by using unit suffixes:</p> | |
2768 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="m">10000</span><span class="o">|</span><span class="na">shortUnit</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 10k *</span><span class="cp">}</span><span class="x"></span> | |
2769 | <span class="cp">{</span><span class="m">5400000</span><span class="o">|</span><span class="na">shortUnit</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 5.4M *</span><span class="cp">}</span><span class="x"></span> | |
2770 | </code></pre></div> | |
45ca63d0 TD |
2771 | <h2 id="smallpages"><code>smallpages</code><a class="headerlink" href="#smallpages" title="Permanent link">#</a></h2> |
2772 | <p><code>smallpages</code> generates a smaller version of <code>pages</code> by using adding the <code>small</code> CSS class to the generated <code><nav></code> element and only showing 7 instead of 9 links. </p> | |
2773 | <h2 id="tablewordwrap"><code>tableWordwrap</code><a class="headerlink" href="#tablewordwrap" title="Permanent link">#</a></h2> | |
2774 | <p><code>tableWordwrap</code> inserts zero width spaces every 30 characters in words longer than 30 characters.</p> | |
2775 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">tableWordwrap</span><span class="cp">}</span><span class="x"></span> | |
2776 | </code></pre></div> | |
45ca63d0 TD |
2777 | <h2 id="time"><code>time</code><a class="headerlink" href="#time" title="Permanent link">#</a></h2> |
2778 | <p><code>time</code> generates an HTML <code>time</code> elements based on a timestamp that shows a relative time or the absolute time if the timestamp more than six days ago.</p> | |
2779 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$timestamp</span><span class="o">|</span><span class="na">time</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints a '<time>' element *</span><span class="cp">}</span><span class="x"></span> | |
2780 | </code></pre></div> | |
45ca63d0 TD |
2781 | <h2 id="truncate"><code>truncate</code><a class="headerlink" href="#truncate" title="Permanent link">#</a></h2> |
2782 | <p><code>truncate</code> truncates a long string into a shorter one:</p> | |
2783 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">truncate</span><span class="o">:</span><span class="m">35</span><span class="cp">}</span><span class="x"></span> | |
2784 | ||
2785 | <span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">truncate</span><span class="o">:</span><span class="m">35</span><span class="o">:</span><span class="s1">'_'</span><span class="o">:</span><span class="kc">true</span><span class="cp">}</span><span class="x"></span> | |
2786 | </code></pre></div> | |
45ca63d0 TD |
2787 | <table> |
2788 | <thead> | |
2789 | <tr> | |
2790 | <th>Parameter Number</th> | |
2791 | <th>Description</th> | |
2792 | </tr> | |
2793 | </thead> | |
2794 | <tbody> | |
2795 | <tr> | |
2796 | <td>0</td> | |
2797 | <td>truncated string</td> | |
2798 | </tr> | |
2799 | <tr> | |
2800 | <td>1</td> | |
2801 | <td>truncated length; <code>80</code> by default</td> | |
2802 | </tr> | |
2803 | <tr> | |
2804 | <td>2</td> | |
2805 | <td>ellipsis symbol; <code>wcf\util\StringUtil::HELLIP</code> by default</td> | |
2806 | </tr> | |
2807 | <tr> | |
2808 | <td>3</td> | |
2809 | <td>if <code>true</code>, words can be broken up in the middle; <code>false</code> by default</td> | |
2810 | </tr> | |
2811 | </tbody> | |
2812 | </table> | |
2813 | <h2 id="53-user"><span class="label label-info">5.3+</span> <code>user</code><a class="headerlink" href="#53-user" title="Permanent link">#</a></h2> | |
2814 | <p><code>user</code> generates links to user profiles. | |
2815 | The mandatory <code>object</code> parameter requires an instances of <code>UserProfile</code>. | |
2816 | The optional <code>type</code> parameter is responsible for what the generated link contains:</p> | |
2817 | <ul> | |
2818 | <li><code>type='default'</code> (also applies if no <code>type</code> is given) outputs the formatted username relying on the “User Marking” setting of the relevant user group. | |
2819 | Additionally, the user popover card will be shown when hovering over the generated link.</li> | |
2820 | <li><code>type='plain'</code> outputs the username without additional formatting.</li> | |
2821 | <li><code>type='avatar(\d+)'</code> outputs the user’s avatar in the specified size, i.e., <code>avatar48</code> outputs the avatar with a width and height of 48 pixels.</li> | |
2822 | </ul> | |
2823 | <p>The last special attribute is <code>append</code> whose contents are appended to the <code>href</code> attribute of the generated anchor element.</p> | |
2824 | <p>All of the other attributes matching <code>~^[a-z]+([A-z]+)+$~</code>, except for <code>href</code> which may not be added, are added as attributes to the anchor element.</p> | |
2825 | <p>Examples:</p> | |
2826 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">user</span> <span class="na">object</span><span class="o">=</span><span class="nv">$user</span><span class="cp">}</span><span class="x"></span> | |
2827 | </code></pre></div> | |
45ca63d0 TD |
2828 | <p>generates</p> |
2829 | <div class="highlight"><pre><span></span><code><span class="x"><a href="</span><span class="cp">{</span><span class="nv">$user</span><span class="o">-></span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">" data-object-id="</span><span class="cp">{</span><span class="nv">$user</span><span class="o">-></span><span class="na">userID</span><span class="cp">}</span><span class="x">" class="userLink"></span><span class="cp">{</span><span class="o">@</span><span class="nv">$user</span><span class="o">-></span><span class="na">getFormattedUsername</span><span class="o">()</span><span class="cp">}</span><span class="x"></a></span> | |
2830 | </code></pre></div> | |
45ca63d0 TD |
2831 | <p>and</p> |
2832 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">user</span> <span class="na">object</span><span class="o">=</span><span class="nv">$user</span> <span class="na">type</span><span class="o">=</span><span class="s1">'avatar48'</span> <span class="na">foo</span><span class="o">=</span><span class="s1">'bar'</span><span class="cp">}</span><span class="x"></span> | |
2833 | </code></pre></div> | |
45ca63d0 TD |
2834 | <p>generates</p> |
2835 | <div class="highlight"><pre><span></span><code><span class="x"><a href="</span><span class="cp">{</span><span class="nv">$user</span><span class="o">-></span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">" foo="bar"></span><span class="cp">{</span><span class="o">@</span><span class="nv">$object</span><span class="o">-></span><span class="na">getAvatar</span><span class="o">()-></span><span class="na">getImageTag</span><span class="o">(</span><span class="m">48</span><span class="o">)</span><span class="cp">}</span><span class="x"></a></span> | |
2836 | </code></pre></div> | |
2837 | ||
2838 | ||
2839 | ||
2840 | ||
2841 | ||
2842 | ||
2843 | ||
2844 | </article> | |
2845 | </div> | |
2846 | </div> | |
2847 | </main> | |
2848 | ||
2849 | ||
2850 | <footer class="md-footer"> | |
2851 | ||
2852 | <div class="md-footer-meta md-typeset"> | |
2853 | <div class="md-footer-meta__inner md-grid"> | |
2854 | <div class="md-footer-copyright"> | |
2855 | ||
2856 | <div class="md-footer-copyright__highlight"> | |
2857 | Copyright © 2020 WoltLab GmbH | |
2858 | </div> | |
2859 | ||
2860 | Made with | |
2861 | <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> | |
2862 | Material for MkDocs | |
2863 | </a> | |
fb88dc6e | 2864 | |
45ca63d0 TD |
2865 | </div> |
2866 | <div class="md-footer-copyright"> | |
2867 | <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a> | |
2868 | <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a> | |
2869 | </div> | |
2870 | </div> | |
2871 | </div> | |
2872 | </footer> | |
2873 | ||
2874 | </div> | |
2875 | <div class="md-dialog" data-md-component="dialog"> | |
2876 | <div class="md-dialog__inner md-typeset"></div> | |
2877 | </div> | |
2878 | <script id="__config" type="application/json">{"base": "../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../assets/javascripts/workers/search.fb4a9340.min.js", "version": {"provider": "mike"}}</script> | |
2879 | ||
2880 | ||
fb88dc6e | 2881 | <script src="../../assets/javascripts/bundle.5cf3e710.min.js"></script> |
45ca63d0 TD |
2882 | |
2883 | ||
2884 | </body> | |
2885 | </html> |