projects / GitHub / WoltLab / woltlab.github.io.git / blame
| 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 | ||
| fb962f09 | 12 | <link rel="icon" href="../../../assets/default.favicon.ico"> |
| a4835aa6 | 13 | <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.2"> |
| 45ca63d0 TD |
14 | |
| 15 | ||
| 16 | ||
| 17 | <title>Part 2 - WoltLab Suite Documentation</title> | |
| 18 | ||
| 19 | ||
| 20 | ||
| a4835aa6 | 21 | <link rel="stylesheet" href="../../../assets/stylesheets/main.6f955dcd.min.css"> |
| 45ca63d0 TD |
22 | |
| 23 | ||
| fb962f09 | 24 | <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css"> |
| 45ca63d0 TD |
25 | |
| 26 | ||
| 27 | ||
| 28 | <meta name="theme-color" content="#009485"> | |
| 29 | ||
| 30 | ||
| 31 | ||
| 32 | ||
| 33 | ||
| fd8430cb WG |
34 | |
| 35 | ||
| 45ca63d0 TD |
36 | |
| 37 | ||
| 38 | <link rel="stylesheet" href="../../../stylesheets/extra.css"> | |
| 39 | ||
| 40 | ||
| 41 | ||
| 42 | ||
| 43 | ||
| 44 | </head> | |
| 45 | ||
| 46 | ||
| 47 | ||
| 48 | ||
| 49 | ||
| 50 | ||
| 51 | ||
| 52 | <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent=""> | |
| 45ca63d0 TD |
53 | |
| 54 | ||
| fb962f09 WG |
55 | <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script> |
| 56 | ||
| 45ca63d0 TD |
57 | <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
| 58 | <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> | |
| 59 | <label class="md-overlay" for="__drawer"></label> | |
| 60 | <div data-md-component="skip"> | |
| 61 | ||
| 62 | ||
| 0a8a4f41 | 63 | <a href="#part-2-event-and-template-listeners" class="md-skip"> |
| 45ca63d0 TD |
64 | Skip to content |
| 65 | </a> | |
| 66 | ||
| 67 | </div> | |
| 68 | <div data-md-component="announce"> | |
| 69 | ||
| 70 | <aside class="md-announce"> | |
| 71 | <div class="md-announce__inner md-grid md-typeset"> | |
| 72 | ||
| 73 | <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a> | |
| 74 | ||
| 75 | </div> | |
| 76 | </aside> | |
| 77 | ||
| 78 | </div> | |
| 79 | ||
| fb962f09 | 80 | <header class="md-header" data-md-component="header"> |
| 45ca63d0 | 81 | <nav class="md-header__inner md-grid" aria-label="Header"> |
| fb962f09 | 82 | <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo"> |
| 45ca63d0 TD |
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 | Part 2 | |
| 101 | ||
| 102 | </span> | |
| 103 | </div> | |
| 104 | </div> | |
| 45ca63d0 TD |
105 | </div> |
| 106 | ||
| fb962f09 WG |
107 | |
| 108 | ||
| a3639e76 WG |
109 | <label class="md-header__button md-icon" for="__search"> |
| 110 | <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> | |
| 111 | </label> | |
| 112 | ||
| 113 | <div class="md-search" data-md-component="search" role="dialog"> | |
| 114 | <label class="md-search__overlay" for="__search"></label> | |
| 115 | <div class="md-search__inner" role="search"> | |
| 116 | <form class="md-search__form" name="search"> | |
| 117 | <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> | |
| 118 | <label class="md-search__icon md-icon" for="__search"> | |
| 119 | <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> | |
| 120 | <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> | |
| 121 | </label> | |
| 122 | <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> | |
| fb962f09 | 123 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.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> |
| a3639e76 WG |
124 | </button> |
| 125 | </form> | |
| 126 | <div class="md-search__output"> | |
| 127 | <div class="md-search__scrollwrap" data-md-scrollfix> | |
| 128 | <div class="md-search-result" data-md-component="search-result"> | |
| 129 | <div class="md-search-result__meta"> | |
| 130 | Initializing search | |
| 131 | </div> | |
| 132 | <ol class="md-search-result__list"></ol> | |
| 133 | </div> | |
| 134 | </div> | |
| 135 | </div> | |
| 136 | </div> | |
| 137 | </div> | |
| 138 | ||
| 45ca63d0 | 139 | |
| 7124f4cb WG |
140 | <div class="md-header__source"> |
| 141 | ||
| 142 | <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source"> | |
| 143 | <div class="md-source__icon md-icon"> | |
| 144 | ||
| fb962f09 | 145 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> |
| 7124f4cb WG |
146 | </div> |
| 147 | <div class="md-source__repository"> | |
| 148 | GitHub | |
| 149 | </div> | |
| 150 | </a> | |
| 151 | </div> | |
| 152 | ||
| 45ca63d0 TD |
153 | </nav> |
| 154 | </header> | |
| 155 | ||
| 156 | <div class="md-container" data-md-component="container"> | |
| 157 | ||
| 158 | ||
| 159 | ||
| 160 | ||
| 161 | <main class="md-main" data-md-component="main"> | |
| 162 | <div class="md-main__inner md-grid"> | |
| 163 | ||
| 164 | ||
| 165 | ||
| 166 | <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > | |
| 167 | <div class="md-sidebar__scrollwrap"> | |
| 168 | <div class="md-sidebar__inner"> | |
| 169 | ||
| 170 | ||
| 171 | ||
| 45ca63d0 TD |
172 | <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> |
| 173 | <label class="md-nav__title" for="__drawer"> | |
| fb962f09 | 174 | <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo"> |
| 45ca63d0 TD |
175 | |
| 176 | <img src="../../../assets/logo.png" alt="logo"> | |
| 177 | ||
| 178 | </a> | |
| 179 | WoltLab Suite Documentation | |
| 180 | </label> | |
| 181 | ||
| 7124f4cb WG |
182 | <div class="md-nav__source"> |
| 183 | ||
| 184 | <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source"> | |
| 185 | <div class="md-source__icon md-icon"> | |
| 186 | ||
| fb962f09 | 187 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> |
| 7124f4cb WG |
188 | </div> |
| 189 | <div class="md-source__repository"> | |
| 190 | GitHub | |
| 191 | </div> | |
| 192 | </a> | |
| 193 | </div> | |
| 194 | ||
| 45ca63d0 TD |
195 | <ul class="md-nav__list" data-md-scrollfix> |
| 196 | ||
| 197 | ||
| 198 | ||
| 199 | ||
| 200 | ||
| 201 | ||
| 202 | ||
| 203 | ||
| 204 | <li class="md-nav__item"> | |
| 205 | <a href="../../../getting-started/" class="md-nav__link"> | |
| 206 | Getting Started | |
| 207 | </a> | |
| 208 | </li> | |
| 209 | ||
| 210 | ||
| 211 | ||
| 212 | ||
| 213 | ||
| 214 | ||
| 215 | ||
| 216 | ||
| 217 | ||
| 218 | ||
| 219 | ||
| 220 | <li class="md-nav__item md-nav__item--nested"> | |
| 221 | ||
| 222 | ||
| 223 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" > | |
| 224 | ||
| 225 | <label class="md-nav__link" for="__nav_2"> | |
| 226 | PHP API | |
| 227 | <span class="md-nav__icon md-icon"></span> | |
| 228 | </label> | |
| 229 | <nav class="md-nav" aria-label="PHP API" data-md-level="1"> | |
| 230 | <label class="md-nav__title" for="__nav_2"> | |
| 231 | <span class="md-nav__icon md-icon"></span> | |
| 232 | PHP API | |
| 233 | </label> | |
| 234 | <ul class="md-nav__list" data-md-scrollfix> | |
| 235 | ||
| 236 | ||
| 237 | ||
| 238 | ||
| 239 | ||
| 240 | <li class="md-nav__item"> | |
| 241 | <a href="../../../php/pages/" class="md-nav__link"> | |
| 242 | Pages | |
| 243 | </a> | |
| 244 | </li> | |
| 245 | ||
| 246 | ||
| 247 | ||
| 248 | ||
| 249 | ||
| 250 | ||
| 251 | ||
| 252 | <li class="md-nav__item"> | |
| 253 | <a href="../../../php/database-objects/" class="md-nav__link"> | |
| 254 | Database Objects | |
| 255 | </a> | |
| 256 | </li> | |
| 257 | ||
| 258 | ||
| 259 | ||
| 260 | ||
| 261 | ||
| 262 | ||
| 263 | ||
| 264 | <li class="md-nav__item"> | |
| 265 | <a href="../../../php/database-access/" class="md-nav__link"> | |
| 266 | Database Access | |
| 267 | </a> | |
| 268 | </li> | |
| 269 | ||
| 270 | ||
| 271 | ||
| 272 | ||
| 273 | ||
| 274 | ||
| 275 | ||
| 276 | <li class="md-nav__item"> | |
| 277 | <a href="../../../php/exceptions/" class="md-nav__link"> | |
| 278 | Exceptions | |
| 279 | </a> | |
| 280 | </li> | |
| 281 | ||
| 282 | ||
| 283 | ||
| 284 | ||
| 285 | ||
| 286 | ||
| 287 | ||
| 288 | ||
| 289 | <li class="md-nav__item md-nav__item--nested"> | |
| 290 | ||
| 291 | ||
| 292 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" > | |
| 293 | ||
| 294 | <label class="md-nav__link" for="__nav_2_5"> | |
| 295 | API | |
| 296 | <span class="md-nav__icon md-icon"></span> | |
| 297 | </label> | |
| 298 | <nav class="md-nav" aria-label="API" data-md-level="2"> | |
| 299 | <label class="md-nav__title" for="__nav_2_5"> | |
| 300 | <span class="md-nav__icon md-icon"></span> | |
| 301 | API | |
| 302 | </label> | |
| 303 | <ul class="md-nav__list" data-md-scrollfix> | |
| 304 | ||
| 305 | ||
| 306 | ||
| 307 | ||
| 308 | ||
| 6923e968 WG |
309 | |
| 310 | <li class="md-nav__item md-nav__item--nested"> | |
| 311 | ||
| 312 | ||
| 313 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" > | |
| 314 | ||
| 315 | <label class="md-nav__link" for="__nav_2_5_1"> | |
| 316 | Caches | |
| 317 | <span class="md-nav__icon md-icon"></span> | |
| 318 | </label> | |
| 319 | <nav class="md-nav" aria-label="Caches" data-md-level="3"> | |
| 320 | <label class="md-nav__title" for="__nav_2_5_1"> | |
| 321 | <span class="md-nav__icon md-icon"></span> | |
| 322 | Caches | |
| 323 | </label> | |
| 324 | <ul class="md-nav__list" data-md-scrollfix> | |
| 325 | ||
| 326 | ||
| 327 | ||
| 328 | ||
| 329 | ||
| 45ca63d0 TD |
330 | <li class="md-nav__item"> |
| 331 | <a href="../../../php/api/caches/" class="md-nav__link"> | |
| 6923e968 WG |
332 | Overview |
| 333 | </a> | |
| 334 | </li> | |
| 335 | ||
| 336 | ||
| 337 | ||
| 338 | ||
| 339 | ||
| 340 | ||
| 341 | ||
| 342 | <li class="md-nav__item"> | |
| 343 | <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link"> | |
| 344 | Persistent Caches | |
| 345 | </a> | |
| 346 | </li> | |
| 347 | ||
| 348 | ||
| 349 | ||
| 350 | ||
| 351 | ||
| 352 | ||
| 353 | ||
| 354 | <li class="md-nav__item"> | |
| 355 | <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link"> | |
| 356 | Runtime Caches | |
| 45ca63d0 TD |
357 | </a> |
| 358 | </li> | |
| 359 | ||
| 360 | ||
| 361 | ||
| 6923e968 WG |
362 | </ul> |
| 363 | </nav> | |
| 364 | </li> | |
| 365 | ||
| 366 | ||
| 367 | ||
| 45ca63d0 TD |
368 | |
| 369 | ||
| 370 | ||
| 371 | ||
| 372 | <li class="md-nav__item"> | |
| 373 | <a href="../../../php/api/comments/" class="md-nav__link"> | |
| 374 | Comments | |
| 375 | </a> | |
| 376 | </li> | |
| 377 | ||
| 378 | ||
| 379 | ||
| 380 | ||
| 381 | ||
| 382 | ||
| 383 | ||
| 384 | <li class="md-nav__item"> | |
| 385 | <a href="../../../php/api/cronjobs/" class="md-nav__link"> | |
| 386 | Cronjobs | |
| 387 | </a> | |
| 388 | </li> | |
| 389 | ||
| 390 | ||
| 391 | ||
| 392 | ||
| 393 | ||
| 394 | ||
| 395 | ||
| 396 | <li class="md-nav__item"> | |
| 397 | <a href="../../../php/api/events/" class="md-nav__link"> | |
| 398 | Events | |
| 399 | </a> | |
| 400 | </li> | |
| 401 | ||
| 402 | ||
| 403 | ||
| 404 | ||
| 405 | ||
| 406 | ||
| 407 | ||
| 408 | ||
| 409 | <li class="md-nav__item md-nav__item--nested"> | |
| 410 | ||
| 411 | ||
| 412 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" > | |
| 413 | ||
| 414 | <label class="md-nav__link" for="__nav_2_5_5"> | |
| 415 | Form Builder | |
| 416 | <span class="md-nav__icon md-icon"></span> | |
| 417 | </label> | |
| 418 | <nav class="md-nav" aria-label="Form Builder" data-md-level="3"> | |
| 419 | <label class="md-nav__title" for="__nav_2_5_5"> | |
| 420 | <span class="md-nav__icon md-icon"></span> | |
| 421 | Form Builder | |
| 422 | </label> | |
| 423 | <ul class="md-nav__list" data-md-scrollfix> | |
| 424 | ||
| 425 | ||
| 426 | ||
| 427 | ||
| 428 | ||
| 429 | <li class="md-nav__item"> | |
| 430 | <a href="../../../php/api/form_builder/overview/" class="md-nav__link"> | |
| 431 | Overview | |
| 432 | </a> | |
| 433 | </li> | |
| 434 | ||
| 435 | ||
| 436 | ||
| 437 | ||
| 438 | ||
| 439 | ||
| 440 | ||
| 441 | <li class="md-nav__item"> | |
| 442 | <a href="../../../php/api/form_builder/structure/" class="md-nav__link"> | |
| 443 | Structure | |
| 444 | </a> | |
| 445 | </li> | |
| 446 | ||
| 447 | ||
| 448 | ||
| 449 | ||
| 450 | ||
| 451 | ||
| 452 | ||
| 453 | <li class="md-nav__item"> | |
| 454 | <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link"> | |
| 455 | Fields | |
| 456 | </a> | |
| 457 | </li> | |
| 458 | ||
| 459 | ||
| 460 | ||
| 461 | ||
| 462 | ||
| 463 | ||
| 464 | ||
| 465 | <li class="md-nav__item"> | |
| 466 | <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link"> | |
| 467 | Validation and Data | |
| 468 | </a> | |
| 469 | </li> | |
| 470 | ||
| 471 | ||
| 472 | ||
| 473 | ||
| 474 | ||
| 475 | ||
| 476 | ||
| 477 | <li class="md-nav__item"> | |
| 478 | <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link"> | |
| 479 | Dependencies | |
| 480 | </a> | |
| 481 | </li> | |
| 482 | ||
| 483 | ||
| 484 | ||
| 485 | </ul> | |
| 486 | </nav> | |
| 487 | </li> | |
| 488 | ||
| 489 | ||
| 490 | ||
| 491 | ||
| 492 | ||
| 493 | ||
| 494 | ||
| 495 | <li class="md-nav__item"> | |
| 496 | <a href="../../../php/api/package_installation_plugins/" class="md-nav__link"> | |
| 497 | Package Installation Plugins | |
| 498 | </a> | |
| 499 | </li> | |
| 500 | ||
| 501 | ||
| 502 | ||
| 503 | ||
| 504 | ||
| 505 | ||
| 506 | ||
| 507 | <li class="md-nav__item"> | |
| 508 | <a href="../../../php/api/user_activity_points/" class="md-nav__link"> | |
| 509 | User Activity Points | |
| 510 | </a> | |
| 511 | </li> | |
| 512 | ||
| 513 | ||
| 514 | ||
| 515 | ||
| 516 | ||
| 517 | ||
| 518 | ||
| 519 | <li class="md-nav__item"> | |
| 520 | <a href="../../../php/api/user_notifications/" class="md-nav__link"> | |
| 521 | User Notifications | |
| 522 | </a> | |
| 523 | </li> | |
| 524 | ||
| 525 | ||
| 526 | ||
| 527 | ||
| 528 | ||
| 529 | ||
| 530 | ||
| 531 | <li class="md-nav__item"> | |
| 532 | <a href="../../../php/api/sitemaps/" class="md-nav__link"> | |
| 533 | Sitemaps | |
| 534 | </a> | |
| 535 | </li> | |
| 536 | ||
| 537 | ||
| 538 | ||
| 539 | </ul> | |
| 540 | </nav> | |
| 541 | </li> | |
| 542 | ||
| 543 | ||
| 544 | ||
| 545 | ||
| 546 | ||
| 547 | ||
| 548 | ||
| 549 | <li class="md-nav__item"> | |
| 550 | <a href="../../../php/code-style/" class="md-nav__link"> | |
| 551 | Code Style | |
| 552 | </a> | |
| 553 | </li> | |
| 554 | ||
| 555 | ||
| 556 | ||
| 557 | ||
| 558 | ||
| 559 | ||
| 560 | ||
| 561 | <li class="md-nav__item"> | |
| 562 | <a href="../../../php/apps/" class="md-nav__link"> | |
| 563 | Apps | |
| 564 | </a> | |
| 565 | </li> | |
| 566 | ||
| 567 | ||
| 568 | ||
| 569 | ||
| 570 | ||
| 571 | ||
| 572 | ||
| 573 | <li class="md-nav__item"> | |
| 574 | <a href="../../../php/gdpr/" class="md-nav__link"> | |
| 575 | GDPR | |
| 576 | </a> | |
| 577 | </li> | |
| 578 | ||
| 579 | ||
| 580 | ||
| 581 | </ul> | |
| 582 | </nav> | |
| 583 | </li> | |
| 584 | ||
| 585 | ||
| 586 | ||
| 587 | ||
| 588 | ||
| 589 | ||
| 590 | ||
| 591 | ||
| 592 | ||
| 593 | ||
| 594 | ||
| 595 | <li class="md-nav__item md-nav__item--nested"> | |
| 596 | ||
| 597 | ||
| 598 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" > | |
| 599 | ||
| 600 | <label class="md-nav__link" for="__nav_3"> | |
| 601 | Languages, Templates & CSS | |
| 602 | <span class="md-nav__icon md-icon"></span> | |
| 603 | </label> | |
| 604 | <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1"> | |
| 605 | <label class="md-nav__title" for="__nav_3"> | |
| 606 | <span class="md-nav__icon md-icon"></span> | |
| 607 | Languages, Templates & CSS | |
| 608 | </label> | |
| 609 | <ul class="md-nav__list" data-md-scrollfix> | |
| 610 | ||
| 611 | ||
| 612 | ||
| 613 | ||
| 614 | ||
| 615 | <li class="md-nav__item"> | |
| 616 | <a href="../../../view/languages/" class="md-nav__link"> | |
| 617 | Languages | |
| 618 | </a> | |
| 619 | </li> | |
| 620 | ||
| 621 | ||
| 622 | ||
| 623 | ||
| 624 | ||
| 625 | ||
| 626 | ||
| 627 | <li class="md-nav__item"> | |
| 628 | <a href="../../../view/templates/" class="md-nav__link"> | |
| 629 | Templates | |
| 630 | </a> | |
| 631 | </li> | |
| 632 | ||
| 633 | ||
| 634 | ||
| 635 | ||
| 636 | ||
| 637 | ||
| 638 | ||
| 6923e968 WG |
639 | <li class="md-nav__item"> |
| 640 | <a href="../../../view/template-plugins/" class="md-nav__link"> | |
| 641 | Template Plugins | |
| 642 | </a> | |
| 643 | </li> | |
| 644 | ||
| 645 | ||
| 646 | ||
| 647 | ||
| 648 | ||
| 649 | ||
| 650 | ||
| 45ca63d0 TD |
651 | <li class="md-nav__item"> |
| 652 | <a href="../../../view/css/" class="md-nav__link"> | |
| 653 | CSS | |
| 654 | </a> | |
| 655 | </li> | |
| 656 | ||
| 657 | ||
| 658 | ||
| 659 | </ul> | |
| 660 | </nav> | |
| 661 | </li> | |
| 662 | ||
| 663 | ||
| 664 | ||
| 665 | ||
| 666 | ||
| 667 | ||
| 668 | ||
| 669 | ||
| 670 | ||
| 671 | ||
| 672 | ||
| 673 | <li class="md-nav__item md-nav__item--nested"> | |
| 674 | ||
| 675 | ||
| 676 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > | |
| 677 | ||
| 678 | <label class="md-nav__link" for="__nav_4"> | |
| 77efcd46 | 679 | TypeScript and JavaScript API |
| 45ca63d0 TD |
680 | <span class="md-nav__icon md-icon"></span> |
| 681 | </label> | |
| 77efcd46 | 682 | <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1"> |
| 45ca63d0 TD |
683 | <label class="md-nav__title" for="__nav_4"> |
| 684 | <span class="md-nav__icon md-icon"></span> | |
| 77efcd46 | 685 | TypeScript and JavaScript API |
| 45ca63d0 TD |
686 | </label> |
| 687 | <ul class="md-nav__list" data-md-scrollfix> | |
| 688 | ||
| 689 | ||
| 690 | ||
| 691 | ||
| 692 | ||
| 693 | <li class="md-nav__item"> | |
| 694 | <a href="../../../javascript/general-usage/" class="md-nav__link"> | |
| 695 | General Usage | |
| 696 | </a> | |
| 697 | </li> | |
| 698 | ||
| 699 | ||
| 700 | ||
| 701 | ||
| 702 | ||
| 703 | ||
| 704 | ||
| 77efcd46 WG |
705 | <li class="md-nav__item"> |
| 706 | <a href="../../../javascript/typescript/" class="md-nav__link"> | |
| 707 | TypeScript | |
| 708 | </a> | |
| 709 | </li> | |
| 710 | ||
| 711 | ||
| 712 | ||
| 713 | ||
| 714 | ||
| 715 | ||
| 716 | ||
| 45ca63d0 TD |
717 | |
| 718 | <li class="md-nav__item md-nav__item--nested"> | |
| 719 | ||
| 720 | ||
| 77efcd46 | 721 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" > |
| 45ca63d0 | 722 | |
| 77efcd46 | 723 | <label class="md-nav__link" for="__nav_4_3"> |
| 45ca63d0 TD |
724 | New API |
| 725 | <span class="md-nav__icon md-icon"></span> | |
| 726 | </label> | |
| 727 | <nav class="md-nav" aria-label="New API" data-md-level="2"> | |
| 77efcd46 | 728 | <label class="md-nav__title" for="__nav_4_3"> |
| 45ca63d0 TD |
729 | <span class="md-nav__icon md-icon"></span> |
| 730 | New API | |
| 731 | </label> | |
| 732 | <ul class="md-nav__list" data-md-scrollfix> | |
| 733 | ||
| 734 | ||
| 735 | ||
| 736 | ||
| 737 | ||
| 738 | <li class="md-nav__item"> | |
| 739 | <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link"> | |
| 740 | Writing a module | |
| 741 | </a> | |
| 742 | </li> | |
| 743 | ||
| 744 | ||
| 745 | ||
| 746 | ||
| 747 | ||
| 748 | ||
| 749 | ||
| 750 | <li class="md-nav__item"> | |
| 751 | <a href="../../../javascript/new-api_data-structures/" class="md-nav__link"> | |
| 752 | Data Structures | |
| 753 | </a> | |
| 754 | </li> | |
| 755 | ||
| 756 | ||
| 757 | ||
| 758 | ||
| 759 | ||
| 760 | ||
| 761 | ||
| 762 | <li class="md-nav__item"> | |
| 763 | <a href="../../../javascript/new-api_core/" class="md-nav__link"> | |
| 764 | Core Functions | |
| 765 | </a> | |
| 766 | </li> | |
| 767 | ||
| 768 | ||
| 769 | ||
| 770 | ||
| 771 | ||
| 772 | ||
| 773 | ||
| 774 | <li class="md-nav__item"> | |
| 775 | <a href="../../../javascript/new-api_dom/" class="md-nav__link"> | |
| 776 | DOM | |
| 777 | </a> | |
| 778 | </li> | |
| 779 | ||
| 780 | ||
| 781 | ||
| 782 | ||
| 783 | ||
| 784 | ||
| 785 | ||
| 786 | <li class="md-nav__item"> | |
| 787 | <a href="../../../javascript/new-api_events/" class="md-nav__link"> | |
| 788 | Event Handling | |
| 789 | </a> | |
| 790 | </li> | |
| 791 | ||
| 792 | ||
| 793 | ||
| 794 | ||
| 795 | ||
| 796 | ||
| 797 | ||
| 798 | <li class="md-nav__item"> | |
| 799 | <a href="../../../javascript/new-api_ajax/" class="md-nav__link"> | |
| 800 | Ajax | |
| 801 | </a> | |
| 802 | </li> | |
| 803 | ||
| 804 | ||
| 805 | ||
| 806 | ||
| 807 | ||
| 808 | ||
| 809 | ||
| 810 | <li class="md-nav__item"> | |
| 811 | <a href="../../../javascript/new-api_dialogs/" class="md-nav__link"> | |
| 812 | Dialogs | |
| 813 | </a> | |
| 814 | </li> | |
| 815 | ||
| 816 | ||
| 817 | ||
| 818 | ||
| 819 | ||
| 820 | ||
| 821 | ||
| 822 | <li class="md-nav__item"> | |
| 823 | <a href="../../../javascript/new-api_browser/" class="md-nav__link"> | |
| 824 | Browser and Screen Sizes | |
| 825 | </a> | |
| 826 | </li> | |
| 827 | ||
| 828 | ||
| 829 | ||
| 830 | ||
| 831 | ||
| 832 | ||
| 833 | ||
| 834 | <li class="md-nav__item"> | |
| 835 | <a href="../../../javascript/new-api_ui/" class="md-nav__link"> | |
| 836 | User Interface | |
| 837 | </a> | |
| 838 | </li> | |
| 839 | ||
| 840 | ||
| 841 | ||
| 842 | </ul> | |
| 843 | </nav> | |
| 844 | </li> | |
| 845 | ||
| 846 | ||
| 847 | ||
| 848 | ||
| 849 | ||
| 850 | ||
| 851 | ||
| 852 | <li class="md-nav__item"> | |
| 853 | <a href="../../../javascript/legacy-api/" class="md-nav__link"> | |
| 854 | Legacy API | |
| 855 | </a> | |
| 856 | </li> | |
| 857 | ||
| 858 | ||
| 859 | ||
| 860 | ||
| 861 | ||
| 862 | ||
| 863 | ||
| 864 | <li class="md-nav__item"> | |
| 865 | <a href="../../../javascript/helper-functions/" class="md-nav__link"> | |
| 866 | Helper Functions | |
| 867 | </a> | |
| 868 | </li> | |
| 869 | ||
| 870 | ||
| 871 | ||
| 872 | ||
| 873 | ||
| 874 | ||
| 875 | ||
| 876 | <li class="md-nav__item"> | |
| 877 | <a href="../../../javascript/code-snippets/" class="md-nav__link"> | |
| 878 | Code Snippets | |
| 879 | </a> | |
| 880 | </li> | |
| 881 | ||
| 882 | ||
| 883 | ||
| 884 | </ul> | |
| 885 | </nav> | |
| 886 | </li> | |
| 887 | ||
| 888 | ||
| 889 | ||
| 890 | ||
| 891 | ||
| 892 | ||
| 893 | ||
| 894 | ||
| 895 | ||
| 896 | ||
| 897 | ||
| 898 | <li class="md-nav__item md-nav__item--nested"> | |
| 899 | ||
| 900 | ||
| 901 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > | |
| 902 | ||
| 903 | <label class="md-nav__link" for="__nav_5"> | |
| 904 | Package Components | |
| 905 | <span class="md-nav__icon md-icon"></span> | |
| 906 | </label> | |
| 907 | <nav class="md-nav" aria-label="Package Components" data-md-level="1"> | |
| 908 | <label class="md-nav__title" for="__nav_5"> | |
| 909 | <span class="md-nav__icon md-icon"></span> | |
| 910 | Package Components | |
| 911 | </label> | |
| 912 | <ul class="md-nav__list" data-md-scrollfix> | |
| 913 | ||
| 914 | ||
| 915 | ||
| 916 | ||
| 917 | ||
| 918 | <li class="md-nav__item"> | |
| 919 | <a href="../../../package/package-xml/" class="md-nav__link"> | |
| 920 | package.xml | |
| 921 | </a> | |
| 922 | </li> | |
| 923 | ||
| 924 | ||
| 925 | ||
| 926 | ||
| 927 | ||
| 928 | ||
| 929 | ||
| 930 | ||
| 931 | <li class="md-nav__item md-nav__item--nested"> | |
| 932 | ||
| 933 | ||
| 934 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" > | |
| 935 | ||
| 936 | <label class="md-nav__link" for="__nav_5_2"> | |
| 937 | PIPs | |
| 938 | <span class="md-nav__icon md-icon"></span> | |
| 939 | </label> | |
| 940 | <nav class="md-nav" aria-label="PIPs" data-md-level="2"> | |
| 941 | <label class="md-nav__title" for="__nav_5_2"> | |
| 942 | <span class="md-nav__icon md-icon"></span> | |
| 943 | PIPs | |
| 944 | </label> | |
| 945 | <ul class="md-nav__list" data-md-scrollfix> | |
| 946 | ||
| 947 | ||
| 948 | ||
| 949 | ||
| 950 | ||
| 951 | <li class="md-nav__item"> | |
| 952 | <a href="../../../package/pip/" class="md-nav__link"> | |
| 953 | Overview | |
| 954 | </a> | |
| 955 | </li> | |
| 956 | ||
| 957 | ||
| 958 | ||
| 959 | ||
| 960 | ||
| 961 | ||
| 962 | ||
| 963 | <li class="md-nav__item"> | |
| 964 | <a href="../../../package/pip/acl-option/" class="md-nav__link"> | |
| 965 | aclOption | |
| 966 | </a> | |
| 967 | </li> | |
| 968 | ||
| 969 | ||
| 970 | ||
| 971 | ||
| 972 | ||
| 973 | ||
| 974 | ||
| 975 | <li class="md-nav__item"> | |
| 976 | <a href="../../../package/pip/acp-menu/" class="md-nav__link"> | |
| 977 | acpMenu | |
| 978 | </a> | |
| 979 | </li> | |
| 980 | ||
| 981 | ||
| 982 | ||
| 983 | ||
| 984 | ||
| 985 | ||
| 986 | ||
| 987 | <li class="md-nav__item"> | |
| 988 | <a href="../../../package/pip/acp-search-provider/" class="md-nav__link"> | |
| 989 | acpSearchProvider | |
| 990 | </a> | |
| 991 | </li> | |
| 992 | ||
| 993 | ||
| 994 | ||
| 995 | ||
| 996 | ||
| 997 | ||
| 998 | ||
| 999 | <li class="md-nav__item"> | |
| 1000 | <a href="../../../package/pip/acp-template/" class="md-nav__link"> | |
| 1001 | acpTemplate | |
| 1002 | </a> | |
| 1003 | </li> | |
| 1004 | ||
| 1005 | ||
| 1006 | ||
| 1007 | ||
| 1008 | ||
| 1009 | ||
| 1010 | ||
| 1011 | <li class="md-nav__item"> | |
| 1012 | <a href="../../../package/pip/bbcode/" class="md-nav__link"> | |
| 1013 | bbcode | |
| 1014 | </a> | |
| 1015 | </li> | |
| 1016 | ||
| 1017 | ||
| 1018 | ||
| 1019 | ||
| 1020 | ||
| 1021 | ||
| 1022 | ||
| 1023 | <li class="md-nav__item"> | |
| 1024 | <a href="../../../package/pip/box/" class="md-nav__link"> | |
| 1025 | box | |
| 1026 | </a> | |
| 1027 | </li> | |
| 1028 | ||
| 1029 | ||
| 1030 | ||
| 1031 | ||
| 1032 | ||
| 1033 | ||
| 1034 | ||
| 1035 | <li class="md-nav__item"> | |
| 1036 | <a href="../../../package/pip/clipboard-action/" class="md-nav__link"> | |
| 1037 | clipboardAction | |
| 1038 | </a> | |
| 1039 | </li> | |
| 1040 | ||
| 1041 | ||
| 1042 | ||
| 1043 | ||
| 1044 | ||
| 1045 | ||
| 1046 | ||
| 1047 | <li class="md-nav__item"> | |
| 1048 | <a href="../../../package/pip/core-object/" class="md-nav__link"> | |
| 1049 | coreObject | |
| 1050 | </a> | |
| 1051 | </li> | |
| 1052 | ||
| 1053 | ||
| 1054 | ||
| 1055 | ||
| 1056 | ||
| 1057 | ||
| 1058 | ||
| 1059 | <li class="md-nav__item"> | |
| 1060 | <a href="../../../package/pip/cronjob/" class="md-nav__link"> | |
| 1061 | cronjob | |
| 1062 | </a> | |
| 1063 | </li> | |
| 1064 | ||
| 1065 | ||
| 1066 | ||
| 1067 | ||
| 1068 | ||
| 1069 | ||
| 1070 | ||
| 6923e968 WG |
1071 | <li class="md-nav__item"> |
| 1072 | <a href="../../../package/pip/database/" class="md-nav__link"> | |
| 1073 | database | |
| 1074 | </a> | |
| 1075 | </li> | |
| 1076 | ||
| 1077 | ||
| 1078 | ||
| 1079 | ||
| 1080 | ||
| 1081 | ||
| 1082 | ||
| 45ca63d0 TD |
1083 | <li class="md-nav__item"> |
| 1084 | <a href="../../../package/pip/event-listener/" class="md-nav__link"> | |
| 1085 | eventListener | |
| 1086 | </a> | |
| 1087 | </li> | |
| 1088 | ||
| 1089 | ||
| 1090 | ||
| 1091 | ||
| 1092 | ||
| 1093 | ||
| 1094 | ||
| 1095 | <li class="md-nav__item"> | |
| 1096 | <a href="../../../package/pip/file/" class="md-nav__link"> | |
| 1097 | file | |
| 1098 | </a> | |
| 1099 | </li> | |
| 1100 | ||
| 1101 | ||
| 1102 | ||
| 1103 | ||
| 1104 | ||
| 1105 | ||
| 1106 | ||
| 1107 | <li class="md-nav__item"> | |
| 1108 | <a href="../../../package/pip/language/" class="md-nav__link"> | |
| 1109 | language | |
| 1110 | </a> | |
| 1111 | </li> | |
| 1112 | ||
| 1113 | ||
| 1114 | ||
| 1115 | ||
| 1116 | ||
| 1117 | ||
| 1118 | ||
| 1119 | <li class="md-nav__item"> | |
| 1120 | <a href="../../../package/pip/media-provider/" class="md-nav__link"> | |
| 1121 | mediaProvider | |
| 1122 | </a> | |
| 1123 | </li> | |
| 1124 | ||
| 1125 | ||
| 1126 | ||
| 1127 | ||
| 1128 | ||
| 1129 | ||
| 1130 | ||
| 1131 | <li class="md-nav__item"> | |
| 1132 | <a href="../../../package/pip/menu/" class="md-nav__link"> | |
| 1133 | menu | |
| 1134 | </a> | |
| 1135 | </li> | |
| 1136 | ||
| 1137 | ||
| 1138 | ||
| 1139 | ||
| 1140 | ||
| 1141 | ||
| 1142 | ||
| 1143 | <li class="md-nav__item"> | |
| 1144 | <a href="../../../package/pip/menu-item/" class="md-nav__link"> | |
| 1145 | menuItem | |
| 1146 | </a> | |
| 1147 | </li> | |
| 1148 | ||
| 1149 | ||
| 1150 | ||
| 1151 | ||
| 1152 | ||
| 1153 | ||
| 1154 | ||
| 1155 | <li class="md-nav__item"> | |
| 1156 | <a href="../../../package/pip/object-type/" class="md-nav__link"> | |
| 1157 | objectType | |
| 1158 | </a> | |
| 1159 | </li> | |
| 1160 | ||
| 1161 | ||
| 1162 | ||
| 1163 | ||
| 1164 | ||
| 1165 | ||
| 1166 | ||
| 1167 | <li class="md-nav__item"> | |
| 1168 | <a href="../../../package/pip/object-type-definition/" class="md-nav__link"> | |
| 1169 | objectTypeDefinition | |
| 1170 | </a> | |
| 1171 | </li> | |
| 1172 | ||
| 1173 | ||
| 1174 | ||
| 1175 | ||
| 1176 | ||
| 1177 | ||
| 1178 | ||
| 1179 | <li class="md-nav__item"> | |
| 1180 | <a href="../../../package/pip/option/" class="md-nav__link"> | |
| 1181 | option | |
| 1182 | </a> | |
| 1183 | </li> | |
| 1184 | ||
| 1185 | ||
| 1186 | ||
| 1187 | ||
| 1188 | ||
| 1189 | ||
| 1190 | ||
| 1191 | <li class="md-nav__item"> | |
| 1192 | <a href="../../../package/pip/page/" class="md-nav__link"> | |
| 1193 | page | |
| 1194 | </a> | |
| 1195 | </li> | |
| 1196 | ||
| 1197 | ||
| 1198 | ||
| 1199 | ||
| 1200 | ||
| 1201 | ||
| 1202 | ||
| 1203 | <li class="md-nav__item"> | |
| 1204 | <a href="../../../package/pip/pip/" class="md-nav__link"> | |
| 1205 | pip | |
| 1206 | </a> | |
| 1207 | </li> | |
| 1208 | ||
| 1209 | ||
| 1210 | ||
| 1211 | ||
| 1212 | ||
| 1213 | ||
| 1214 | ||
| 1215 | <li class="md-nav__item"> | |
| 1216 | <a href="../../../package/pip/script/" class="md-nav__link"> | |
| 1217 | script | |
| 1218 | </a> | |
| 1219 | </li> | |
| 1220 | ||
| 1221 | ||
| 1222 | ||
| 1223 | ||
| 1224 | ||
| 1225 | ||
| 1226 | ||
| 1227 | <li class="md-nav__item"> | |
| 1228 | <a href="../../../package/pip/smiley/" class="md-nav__link"> | |
| 1229 | smiley | |
| 1230 | </a> | |
| 1231 | </li> | |
| 1232 | ||
| 1233 | ||
| 1234 | ||
| 1235 | ||
| 1236 | ||
| 1237 | ||
| 1238 | ||
| 1239 | <li class="md-nav__item"> | |
| 1240 | <a href="../../../package/pip/sql/" class="md-nav__link"> | |
| 1241 | sql | |
| 1242 | </a> | |
| 1243 | </li> | |
| 1244 | ||
| 1245 | ||
| 1246 | ||
| 1247 | ||
| 1248 | ||
| 1249 | ||
| 1250 | ||
| 1251 | <li class="md-nav__item"> | |
| 1252 | <a href="../../../package/pip/style/" class="md-nav__link"> | |
| 1253 | style | |
| 1254 | </a> | |
| 1255 | </li> | |
| 1256 | ||
| 1257 | ||
| 1258 | ||
| 1259 | ||
| 1260 | ||
| 1261 | ||
| 1262 | ||
| 1263 | <li class="md-nav__item"> | |
| 1264 | <a href="../../../package/pip/template/" class="md-nav__link"> | |
| 1265 | template | |
| 1266 | </a> | |
| 1267 | </li> | |
| 1268 | ||
| 1269 | ||
| 1270 | ||
| 1271 | ||
| 1272 | ||
| 1273 | ||
| 1274 | ||
| 1275 | <li class="md-nav__item"> | |
| 1276 | <a href="../../../package/pip/template-listener/" class="md-nav__link"> | |
| 1277 | templateListener | |
| 1278 | </a> | |
| 1279 | </li> | |
| 1280 | ||
| 1281 | ||
| 1282 | ||
| 1283 | ||
| 1284 | ||
| 1285 | ||
| 1286 | ||
| 1287 | <li class="md-nav__item"> | |
| 1288 | <a href="../../../package/pip/user-group-option/" class="md-nav__link"> | |
| 1289 | userGroupOption | |
| 1290 | </a> | |
| 1291 | </li> | |
| 1292 | ||
| 1293 | ||
| 1294 | ||
| 1295 | ||
| 1296 | ||
| 1297 | ||
| 1298 | ||
| 1299 | <li class="md-nav__item"> | |
| 1300 | <a href="../../../package/pip/user-menu/" class="md-nav__link"> | |
| 1301 | userMenu | |
| 1302 | </a> | |
| 1303 | </li> | |
| 1304 | ||
| 1305 | ||
| 1306 | ||
| 1307 | ||
| 1308 | ||
| 1309 | ||
| 1310 | ||
| 1311 | <li class="md-nav__item"> | |
| 1312 | <a href="../../../package/pip/user-notification-event/" class="md-nav__link"> | |
| 1313 | userNotificationEvent | |
| 1314 | </a> | |
| 1315 | </li> | |
| 1316 | ||
| 1317 | ||
| 1318 | ||
| 1319 | ||
| 1320 | ||
| 1321 | ||
| 1322 | ||
| 1323 | <li class="md-nav__item"> | |
| 1324 | <a href="../../../package/pip/user-option/" class="md-nav__link"> | |
| 1325 | userOption | |
| 1326 | </a> | |
| 1327 | </li> | |
| 1328 | ||
| 1329 | ||
| 1330 | ||
| 1331 | ||
| 1332 | ||
| 1333 | ||
| 1334 | ||
| 1335 | <li class="md-nav__item"> | |
| 1336 | <a href="../../../package/pip/user-profile-menu/" class="md-nav__link"> | |
| 1337 | userProfileMenu | |
| 1338 | </a> | |
| 1339 | </li> | |
| 1340 | ||
| 1341 | ||
| 1342 | ||
| 1343 | </ul> | |
| 1344 | </nav> | |
| 1345 | </li> | |
| 1346 | ||
| 1347 | ||
| 1348 | ||
| 1349 | ||
| 1350 | ||
| 1351 | ||
| 1352 | ||
| 1353 | <li class="md-nav__item"> | |
| 1354 | <a href="../../../package/database-php-api/" class="md-nav__link"> | |
| 1355 | Database PHP API | |
| 1356 | </a> | |
| 1357 | </li> | |
| 1358 | ||
| 1359 | ||
| 1360 | ||
| 1361 | </ul> | |
| 1362 | </nav> | |
| 1363 | </li> | |
| 1364 | ||
| 1365 | ||
| 1366 | ||
| 1367 | ||
| 1368 | ||
| 1369 | ||
| 1370 | ||
| 1371 | ||
| 1372 | ||
| 1373 | ||
| 1374 | ||
| 1375 | <li class="md-nav__item md-nav__item--nested"> | |
| 1376 | ||
| 1377 | ||
| 1378 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > | |
| 1379 | ||
| 1380 | <label class="md-nav__link" for="__nav_6"> | |
| 1381 | Migration | |
| 1382 | <span class="md-nav__icon md-icon"></span> | |
| 1383 | </label> | |
| 1384 | <nav class="md-nav" aria-label="Migration" data-md-level="1"> | |
| 1385 | <label class="md-nav__title" for="__nav_6"> | |
| 1386 | <span class="md-nav__icon md-icon"></span> | |
| 1387 | Migration | |
| 1388 | </label> | |
| 1389 | <ul class="md-nav__list" data-md-scrollfix> | |
| 1390 | ||
| 1391 | ||
| 1392 | ||
| 1393 | ||
| 1394 | ||
| 1395 | ||
| 1396 | <li class="md-nav__item md-nav__item--nested"> | |
| 1397 | ||
| 1398 | ||
| 1399 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" > | |
| 1400 | ||
| 1401 | <label class="md-nav__link" for="__nav_6_1"> | |
| 1402 | Migrating from WSC 5.3 | |
| 1403 | <span class="md-nav__icon md-icon"></span> | |
| 1404 | </label> | |
| 1405 | <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2"> | |
| 1406 | <label class="md-nav__title" for="__nav_6_1"> | |
| 1407 | <span class="md-nav__icon md-icon"></span> | |
| 1408 | Migrating from WSC 5.3 | |
| 1409 | </label> | |
| 1410 | <ul class="md-nav__list" data-md-scrollfix> | |
| 1411 | ||
| 1412 | ||
| 1413 | ||
| 1414 | ||
| 1415 | ||
| 1416 | <li class="md-nav__item"> | |
| 1417 | <a href="../../../migration/wsc53/php/" class="md-nav__link"> | |
| 1418 | PHP API | |
| 1419 | </a> | |
| 1420 | </li> | |
| 1421 | ||
| 1422 | ||
| 1423 | ||
| 1424 | ||
| 1425 | ||
| 1426 | ||
| 1427 | ||
| 1428 | <li class="md-nav__item"> | |
| 1429 | <a href="../../../migration/wsc53/session/" class="md-nav__link"> | |
| 1430 | Session Handling and Authentication | |
| 1431 | </a> | |
| 1432 | </li> | |
| 1433 | ||
| 1434 | ||
| 1435 | ||
| 1436 | ||
| 1437 | ||
| 1438 | ||
| 1439 | ||
| 1440 | <li class="md-nav__item"> | |
| 1441 | <a href="../../../migration/wsc53/javascript/" class="md-nav__link"> | |
| 77efcd46 | 1442 | TypeScript and JavaScript |
| 45ca63d0 TD |
1443 | </a> |
| 1444 | </li> | |
| 1445 | ||
| 1446 | ||
| 1447 | ||
| 1448 | ||
| 1449 | ||
| 1450 | ||
| 1451 | ||
| 1452 | <li class="md-nav__item"> | |
| 1453 | <a href="../../../migration/wsc53/templates/" class="md-nav__link"> | |
| 1454 | Templates | |
| 1455 | </a> | |
| 1456 | </li> | |
| 1457 | ||
| 1458 | ||
| 1459 | ||
| 1460 | ||
| 1461 | ||
| 1462 | ||
| 1463 | ||
| 1464 | <li class="md-nav__item"> | |
| 1465 | <a href="../../../migration/wsc53/libraries/" class="md-nav__link"> | |
| 1466 | Third Party Libraries | |
| 1467 | </a> | |
| 1468 | </li> | |
| 1469 | ||
| 1470 | ||
| 1471 | ||
| 1472 | </ul> | |
| 1473 | </nav> | |
| 1474 | </li> | |
| 1475 | ||
| 1476 | ||
| 1477 | ||
| 1478 | ||
| 1479 | ||
| 1480 | ||
| 1481 | ||
| 1482 | ||
| 1483 | <li class="md-nav__item md-nav__item--nested"> | |
| 1484 | ||
| 1485 | ||
| 1486 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" > | |
| 1487 | ||
| 1488 | <label class="md-nav__link" for="__nav_6_2"> | |
| 1489 | Migrating from WSC 5.2 | |
| 1490 | <span class="md-nav__icon md-icon"></span> | |
| 1491 | </label> | |
| 1492 | <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2"> | |
| 1493 | <label class="md-nav__title" for="__nav_6_2"> | |
| 1494 | <span class="md-nav__icon md-icon"></span> | |
| 1495 | Migrating from WSC 5.2 | |
| 1496 | </label> | |
| 1497 | <ul class="md-nav__list" data-md-scrollfix> | |
| 1498 | ||
| 1499 | ||
| 1500 | ||
| 1501 | ||
| 1502 | ||
| 1503 | <li class="md-nav__item"> | |
| 1504 | <a href="../../../migration/wsc52/php/" class="md-nav__link"> | |
| 1505 | PHP API | |
| 1506 | </a> | |
| 1507 | </li> | |
| 1508 | ||
| 1509 | ||
| 1510 | ||
| 1511 | ||
| 1512 | ||
| 1513 | ||
| 1514 | ||
| 1515 | <li class="md-nav__item"> | |
| 1516 | <a href="../../../migration/wsc52/templates/" class="md-nav__link"> | |
| 1517 | Templates and Languages | |
| 1518 | </a> | |
| 1519 | </li> | |
| 1520 | ||
| 1521 | ||
| 1522 | ||
| 1523 | ||
| 1524 | ||
| 1525 | ||
| 1526 | ||
| 1527 | <li class="md-nav__item"> | |
| 1528 | <a href="../../../migration/wsc52/libraries/" class="md-nav__link"> | |
| 1529 | Third Party Libraries | |
| 1530 | </a> | |
| 1531 | </li> | |
| 1532 | ||
| 1533 | ||
| 1534 | ||
| 1535 | </ul> | |
| 1536 | </nav> | |
| 1537 | </li> | |
| 1538 | ||
| 1539 | ||
| 1540 | ||
| 1541 | ||
| 1542 | ||
| 1543 | ||
| 1544 | ||
| 1545 | ||
| 1546 | <li class="md-nav__item md-nav__item--nested"> | |
| 1547 | ||
| 1548 | ||
| 1549 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" > | |
| 1550 | ||
| 1551 | <label class="md-nav__link" for="__nav_6_3"> | |
| 1552 | Migrating from WSC 3.1 | |
| 1553 | <span class="md-nav__icon md-icon"></span> | |
| 1554 | </label> | |
| 1555 | <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2"> | |
| 1556 | <label class="md-nav__title" for="__nav_6_3"> | |
| 1557 | <span class="md-nav__icon md-icon"></span> | |
| 1558 | Migrating from WSC 3.1 | |
| 1559 | </label> | |
| 1560 | <ul class="md-nav__list" data-md-scrollfix> | |
| 1561 | ||
| 1562 | ||
| 1563 | ||
| 1564 | ||
| 1565 | ||
| 1566 | <li class="md-nav__item"> | |
| 1567 | <a href="../../../migration/wsc31/php/" class="md-nav__link"> | |
| 1568 | PHP API | |
| 1569 | </a> | |
| 1570 | </li> | |
| 1571 | ||
| 1572 | ||
| 1573 | ||
| 1574 | </ul> | |
| 1575 | </nav> | |
| 1576 | </li> | |
| 1577 | ||
| 1578 | ||
| 1579 | ||
| 1580 | ||
| 1581 | ||
| 1582 | ||
| 1583 | ||
| 1584 | ||
| 1585 | <li class="md-nav__item md-nav__item--nested"> | |
| 1586 | ||
| 1587 | ||
| 1588 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" > | |
| 1589 | ||
| 1590 | <label class="md-nav__link" for="__nav_6_4"> | |
| 1591 | Migrating from WSC 3.0 | |
| 1592 | <span class="md-nav__icon md-icon"></span> | |
| 1593 | </label> | |
| 1594 | <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2"> | |
| 1595 | <label class="md-nav__title" for="__nav_6_4"> | |
| 1596 | <span class="md-nav__icon md-icon"></span> | |
| 1597 | Migrating from WSC 3.0 | |
| 1598 | </label> | |
| 1599 | <ul class="md-nav__list" data-md-scrollfix> | |
| 1600 | ||
| 1601 | ||
| 1602 | ||
| 1603 | ||
| 1604 | ||
| 1605 | <li class="md-nav__item"> | |
| 1606 | <a href="../../../migration/wsc30/php/" class="md-nav__link"> | |
| 1607 | PHP API | |
| 1608 | </a> | |
| 1609 | </li> | |
| 1610 | ||
| 1611 | ||
| 1612 | ||
| 1613 | ||
| 1614 | ||
| 1615 | ||
| 1616 | ||
| 1617 | <li class="md-nav__item"> | |
| 1618 | <a href="../../../migration/wsc30/javascript/" class="md-nav__link"> | |
| 1619 | JavaScript API | |
| 1620 | </a> | |
| 1621 | </li> | |
| 1622 | ||
| 1623 | ||
| 1624 | ||
| 1625 | ||
| 1626 | ||
| 1627 | ||
| 1628 | ||
| 1629 | <li class="md-nav__item"> | |
| 1630 | <a href="../../../migration/wsc30/templates/" class="md-nav__link"> | |
| 1631 | Templates | |
| 1632 | </a> | |
| 1633 | </li> | |
| 1634 | ||
| 1635 | ||
| 1636 | ||
| 1637 | ||
| 1638 | ||
| 1639 | ||
| 1640 | ||
| 1641 | <li class="md-nav__item"> | |
| 1642 | <a href="../../../migration/wsc30/css/" class="md-nav__link"> | |
| 1643 | CSS | |
| 1644 | </a> | |
| 1645 | </li> | |
| 1646 | ||
| 1647 | ||
| 1648 | ||
| 1649 | ||
| 1650 | ||
| 1651 | ||
| 1652 | ||
| 1653 | <li class="md-nav__item"> | |
| 1654 | <a href="../../../migration/wsc30/package/" class="md-nav__link"> | |
| 1655 | Package Components | |
| 1656 | </a> | |
| 1657 | </li> | |
| 1658 | ||
| 1659 | ||
| 1660 | ||
| 1661 | </ul> | |
| 1662 | </nav> | |
| 1663 | </li> | |
| 1664 | ||
| 1665 | ||
| 1666 | ||
| 1667 | ||
| 1668 | ||
| 1669 | ||
| 1670 | ||
| 1671 | ||
| 1672 | <li class="md-nav__item md-nav__item--nested"> | |
| 1673 | ||
| 1674 | ||
| 1675 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" > | |
| 1676 | ||
| 1677 | <label class="md-nav__link" for="__nav_6_5"> | |
| 1678 | Migrating from WCF 2.1 | |
| 1679 | <span class="md-nav__icon md-icon"></span> | |
| 1680 | </label> | |
| 1681 | <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2"> | |
| 1682 | <label class="md-nav__title" for="__nav_6_5"> | |
| 1683 | <span class="md-nav__icon md-icon"></span> | |
| 1684 | Migrating from WCF 2.1 | |
| 1685 | </label> | |
| 1686 | <ul class="md-nav__list" data-md-scrollfix> | |
| 1687 | ||
| 1688 | ||
| 1689 | ||
| 1690 | ||
| 1691 | ||
| 1692 | <li class="md-nav__item"> | |
| 1693 | <a href="../../../migration/wcf21/php/" class="md-nav__link"> | |
| 1694 | PHP API | |
| 1695 | </a> | |
| 1696 | </li> | |
| 1697 | ||
| 1698 | ||
| 1699 | ||
| 1700 | ||
| 1701 | ||
| 1702 | ||
| 1703 | ||
| 1704 | <li class="md-nav__item"> | |
| 1705 | <a href="../../../migration/wcf21/templates/" class="md-nav__link"> | |
| 1706 | Templates | |
| 1707 | </a> | |
| 1708 | </li> | |
| 1709 | ||
| 1710 | ||
| 1711 | ||
| 1712 | ||
| 1713 | ||
| 1714 | ||
| 1715 | ||
| 1716 | <li class="md-nav__item"> | |
| 1717 | <a href="../../../migration/wcf21/css/" class="md-nav__link"> | |
| 1718 | CSS | |
| 1719 | </a> | |
| 1720 | </li> | |
| 1721 | ||
| 1722 | ||
| 1723 | ||
| 1724 | ||
| 1725 | ||
| 1726 | ||
| 1727 | ||
| 1728 | <li class="md-nav__item"> | |
| 1729 | <a href="../../../migration/wcf21/package/" class="md-nav__link"> | |
| 1730 | Package Components | |
| 1731 | </a> | |
| 1732 | </li> | |
| 1733 | ||
| 1734 | ||
| 1735 | ||
| 1736 | </ul> | |
| 1737 | </nav> | |
| 1738 | </li> | |
| 1739 | ||
| 1740 | ||
| 1741 | ||
| 1742 | </ul> | |
| 1743 | </nav> | |
| 1744 | </li> | |
| 1745 | ||
| 1746 | ||
| 1747 | ||
| 1748 | ||
| 1749 | ||
| 1750 | ||
| 1751 | ||
| 1752 | ||
| 1753 | ||
| 1754 | ||
| 1755 | ||
| 1756 | ||
| 1757 | ||
| 1758 | <li class="md-nav__item md-nav__item--active md-nav__item--nested"> | |
| 1759 | ||
| 1760 | ||
| 1761 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" checked> | |
| 1762 | ||
| 1763 | <label class="md-nav__link" for="__nav_7"> | |
| 1764 | Tutorials | |
| 1765 | <span class="md-nav__icon md-icon"></span> | |
| 1766 | </label> | |
| 1767 | <nav class="md-nav" aria-label="Tutorials" data-md-level="1"> | |
| 1768 | <label class="md-nav__title" for="__nav_7"> | |
| 1769 | <span class="md-nav__icon md-icon"></span> | |
| 1770 | Tutorials | |
| 1771 | </label> | |
| 1772 | <ul class="md-nav__list" data-md-scrollfix> | |
| 1773 | ||
| 1774 | ||
| 1775 | ||
| 1776 | ||
| 1777 | ||
| 1778 | ||
| 1779 | ||
| 1780 | ||
| 1781 | <li class="md-nav__item md-nav__item--active md-nav__item--nested"> | |
| 1782 | ||
| 1783 | ||
| 1784 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" checked> | |
| 1785 | ||
| 1786 | <label class="md-nav__link" for="__nav_7_1"> | |
| 1787 | Tutorial Series | |
| 1788 | <span class="md-nav__icon md-icon"></span> | |
| 1789 | </label> | |
| 1790 | <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2"> | |
| 1791 | <label class="md-nav__title" for="__nav_7_1"> | |
| 1792 | <span class="md-nav__icon md-icon"></span> | |
| 1793 | Tutorial Series | |
| 1794 | </label> | |
| 1795 | <ul class="md-nav__list" data-md-scrollfix> | |
| 1796 | ||
| 1797 | ||
| 1798 | ||
| 1799 | ||
| 1800 | ||
| 1801 | <li class="md-nav__item"> | |
| 1802 | <a href="../overview/" class="md-nav__link"> | |
| 1803 | Overview | |
| 1804 | </a> | |
| 1805 | </li> | |
| 1806 | ||
| 1807 | ||
| 1808 | ||
| 1809 | ||
| 1810 | ||
| 1811 | ||
| 1812 | ||
| 1813 | <li class="md-nav__item"> | |
| 1814 | <a href="../part_1/" class="md-nav__link"> | |
| 1815 | Part 1 | |
| 1816 | </a> | |
| 1817 | </li> | |
| 1818 | ||
| 1819 | ||
| 1820 | ||
| 1821 | ||
| 1822 | ||
| 1823 | ||
| 1824 | ||
| 1825 | ||
| 1826 | ||
| 1827 | <li class="md-nav__item md-nav__item--active"> | |
| 1828 | ||
| 1829 | <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> | |
| 1830 | ||
| a4835aa6 | 1831 | |
| 45ca63d0 TD |
1832 | |
| 1833 | ||
| 1834 | ||
| 1835 | <label class="md-nav__link md-nav__link--active" for="__toc"> | |
| 1836 | Part 2 | |
| 1837 | <span class="md-nav__icon md-icon"></span> | |
| 1838 | </label> | |
| 1839 | ||
| 1840 | <a href="./" class="md-nav__link md-nav__link--active"> | |
| 1841 | Part 2 | |
| 1842 | </a> | |
| 1843 | ||
| 1844 | ||
| 1845 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
| 1846 | ||
| 1847 | ||
| a4835aa6 | 1848 | |
| 45ca63d0 TD |
1849 | |
| 1850 | ||
| 1851 | ||
| 1852 | <label class="md-nav__title" for="__toc"> | |
| 1853 | <span class="md-nav__icon md-icon"></span> | |
| 1854 | Table of contents | |
| 1855 | </label> | |
| 1856 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | |
| 1857 | ||
| 1858 | <li class="md-nav__item"> | |
| 1859 | <a href="#package-functionality" class="md-nav__link"> | |
| 1860 | Package Functionality | |
| 1861 | </a> | |
| 1862 | ||
| 1863 | </li> | |
| 1864 | ||
| 1865 | <li class="md-nav__item"> | |
| 1866 | <a href="#used-components" class="md-nav__link"> | |
| 1867 | Used Components | |
| 1868 | </a> | |
| 1869 | ||
| 1870 | </li> | |
| 1871 | ||
| 1872 | <li class="md-nav__item"> | |
| 1873 | <a href="#package-structure" class="md-nav__link"> | |
| 1874 | Package Structure | |
| 1875 | </a> | |
| 1876 | ||
| 1877 | </li> | |
| 1878 | ||
| 1879 | <li class="md-nav__item"> | |
| 0a8a4f41 WG |
1880 | <a href="#extending-person-model" class="md-nav__link"> |
| 1881 | Extending Person Model | |
| 45ca63d0 TD |
1882 | </a> |
| 1883 | ||
| 1884 | </li> | |
| 1885 | ||
| 1886 | <li class="md-nav__item"> | |
| 1887 | <a href="#setting-birthday-in-acp" class="md-nav__link"> | |
| 1888 | Setting Birthday in ACP | |
| 1889 | </a> | |
| 1890 | ||
| 1891 | </li> | |
| 1892 | ||
| 1893 | <li class="md-nav__item"> | |
| 1894 | <a href="#adding-birthday-table-column-in-acp" class="md-nav__link"> | |
| 1895 | Adding Birthday Table Column in ACP | |
| 1896 | </a> | |
| 1897 | ||
| 1898 | </li> | |
| 1899 | ||
| 1900 | <li class="md-nav__item"> | |
| 1901 | <a href="#adding-birthday-in-front-end" class="md-nav__link"> | |
| 1902 | Adding Birthday in Front End | |
| 1903 | </a> | |
| 1904 | ||
| 1905 | </li> | |
| 1906 | ||
| 1907 | <li class="md-nav__item"> | |
| 1908 | <a href="#templatelistenerxml" class="md-nav__link"> | |
| 1909 | templateListener.xml | |
| 1910 | </a> | |
| 1911 | ||
| 1912 | </li> | |
| 1913 | ||
| 1914 | <li class="md-nav__item"> | |
| 1915 | <a href="#eventlistenerxml" class="md-nav__link"> | |
| 1916 | eventListener.xml | |
| 1917 | </a> | |
| 1918 | ||
| 1919 | </li> | |
| 1920 | ||
| 1921 | <li class="md-nav__item"> | |
| 1922 | <a href="#packagexml" class="md-nav__link"> | |
| 1923 | package.xml | |
| 1924 | </a> | |
| 1925 | ||
| 1926 | </li> | |
| 1927 | ||
| 1928 | </ul> | |
| 1929 | ||
| 1930 | </nav> | |
| 1931 | ||
| 1932 | </li> | |
| 1933 | ||
| 1934 | ||
| 1935 | ||
| 1936 | ||
| 1937 | ||
| 1938 | ||
| 1939 | ||
| 1940 | <li class="md-nav__item"> | |
| 1941 | <a href="../part_3/" class="md-nav__link"> | |
| 1942 | Part 3 | |
| 1943 | </a> | |
| 1944 | </li> | |
| 1945 | ||
| 1946 | ||
| 1947 | ||
| 41eda543 WG |
1948 | |
| 1949 | ||
| 1950 | ||
| 1951 | ||
| 1952 | <li class="md-nav__item"> | |
| 1953 | <a href="../part_4/" class="md-nav__link"> | |
| 1954 | Part 4 | |
| 1955 | </a> | |
| 1956 | </li> | |
| 1957 | ||
| 1958 | ||
| 1959 | ||
| 45ca63d0 TD |
1960 | </ul> |
| 1961 | </nav> | |
| 1962 | </li> | |
| 1963 | ||
| 1964 | ||
| 1965 | ||
| 1966 | </ul> | |
| 1967 | </nav> | |
| 1968 | </li> | |
| 1969 | ||
| 1970 | ||
| 1971 | ||
| 1972 | </ul> | |
| 1973 | </nav> | |
| 1974 | </div> | |
| 1975 | </div> | |
| 1976 | </div> | |
| 1977 | ||
| 1978 | ||
| 1979 | ||
| 1980 | <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > | |
| 1981 | <div class="md-sidebar__scrollwrap"> | |
| 1982 | <div class="md-sidebar__inner"> | |
| 1983 | ||
| 1984 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
| 1985 | ||
| 1986 | ||
| a4835aa6 | 1987 | |
| 45ca63d0 TD |
1988 | |
| 1989 | ||
| 1990 | ||
| 1991 | <label class="md-nav__title" for="__toc"> | |
| 1992 | <span class="md-nav__icon md-icon"></span> | |
| 1993 | Table of contents | |
| 1994 | </label> | |
| 1995 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | |
| 1996 | ||
| 1997 | <li class="md-nav__item"> | |
| 1998 | <a href="#package-functionality" class="md-nav__link"> | |
| 1999 | Package Functionality | |
| 2000 | </a> | |
| 2001 | ||
| 2002 | </li> | |
| 2003 | ||
| 2004 | <li class="md-nav__item"> | |
| 2005 | <a href="#used-components" class="md-nav__link"> | |
| 2006 | Used Components | |
| 2007 | </a> | |
| 2008 | ||
| 2009 | </li> | |
| 2010 | ||
| 2011 | <li class="md-nav__item"> | |
| 2012 | <a href="#package-structure" class="md-nav__link"> | |
| 2013 | Package Structure | |
| 2014 | </a> | |
| 2015 | ||
| 2016 | </li> | |
| 2017 | ||
| 2018 | <li class="md-nav__item"> | |
| 0a8a4f41 WG |
2019 | <a href="#extending-person-model" class="md-nav__link"> |
| 2020 | Extending Person Model | |
| 45ca63d0 TD |
2021 | </a> |
| 2022 | ||
| 2023 | </li> | |
| 2024 | ||
| 2025 | <li class="md-nav__item"> | |
| 2026 | <a href="#setting-birthday-in-acp" class="md-nav__link"> | |
| 2027 | Setting Birthday in ACP | |
| 2028 | </a> | |
| 2029 | ||
| 2030 | </li> | |
| 2031 | ||
| 2032 | <li class="md-nav__item"> | |
| 2033 | <a href="#adding-birthday-table-column-in-acp" class="md-nav__link"> | |
| 2034 | Adding Birthday Table Column in ACP | |
| 2035 | </a> | |
| 2036 | ||
| 2037 | </li> | |
| 2038 | ||
| 2039 | <li class="md-nav__item"> | |
| 2040 | <a href="#adding-birthday-in-front-end" class="md-nav__link"> | |
| 2041 | Adding Birthday in Front End | |
| 2042 | </a> | |
| 2043 | ||
| 2044 | </li> | |
| 2045 | ||
| 2046 | <li class="md-nav__item"> | |
| 2047 | <a href="#templatelistenerxml" class="md-nav__link"> | |
| 2048 | templateListener.xml | |
| 2049 | </a> | |
| 2050 | ||
| 2051 | </li> | |
| 2052 | ||
| 2053 | <li class="md-nav__item"> | |
| 2054 | <a href="#eventlistenerxml" class="md-nav__link"> | |
| 2055 | eventListener.xml | |
| 2056 | </a> | |
| 2057 | ||
| 2058 | </li> | |
| 2059 | ||
| 2060 | <li class="md-nav__item"> | |
| 2061 | <a href="#packagexml" class="md-nav__link"> | |
| 2062 | package.xml | |
| 2063 | </a> | |
| 2064 | ||
| 2065 | </li> | |
| 2066 | ||
| 2067 | </ul> | |
| 2068 | ||
| 2069 | </nav> | |
| 2070 | </div> | |
| 2071 | </div> | |
| 2072 | </div> | |
| 2073 | ||
| 2074 | ||
| 2075 | <div class="md-content" data-md-component="content"> | |
| 2076 | <article class="md-content__inner md-typeset"> | |
| 2077 | ||
| 2078 | ||
| 9b8bddda | 2079 | <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/tutorial/series/part_2.md" title="Edit this page" class="md-content__button md-icon"> |
| 7124f4cb WG |
2080 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg> |
| 2081 | </a> | |
| 2082 | ||
| 45ca63d0 | 2083 | |
| 0a8a4f41 | 2084 | <h1 id="part-2-event-and-template-listeners">Part 2: Event and Template Listeners<a class="headerlink" href="#part-2-event-and-template-listeners" title="Permanent link">#</a></h1> |
| 45ca63d0 TD |
2085 | <p>In the <a href="../part_1/">first part</a> of this tutorial series, we have created the base structure of our people management package. |
| 2086 | In further parts, we will use the package of the first part as a basis to directly add new features. | |
| 2087 | In order to explain how event listeners and template works, however, we will not directly adding a new feature to the package by altering it in this part, but we will assume that somebody else created the package and that we want to extend it the “correct” way by creating a plugin.</p> | |
| 2088 | <p>The goal of the small plugin that will be created in this part is to add the birthday of the managed people. | |
| 2089 | As in the first part, we will not bother with careful validation of the entered date but just make sure that it is a valid date.</p> | |
| 2090 | <h2 id="package-functionality">Package Functionality<a class="headerlink" href="#package-functionality" title="Permanent link">#</a></h2> | |
| 2091 | <p>The package should provide the following possibilities/functions:</p> | |
| 2092 | <ul> | |
| 2093 | <li>List person’s birthday (if set) in people list in the ACP</li> | |
| 2094 | <li>Sort people list by birthday in the ACP</li> | |
| 2095 | <li>Add or remove birthday when adding or editing person</li> | |
| 2096 | <li>List person’s birthday (if set) in people list in the front end</li> | |
| 2097 | <li>Sort people list by birthday in the front end</li> | |
| 2098 | </ul> | |
| 2099 | <h2 id="used-components">Used Components<a class="headerlink" href="#used-components" title="Permanent link">#</a></h2> | |
| 2100 | <p>We will use the following package installation plugins:</p> | |
| 2101 | <ul> | |
| 0a8a4f41 | 2102 | <li><a href="../../../package/pip/database/">database package installation plugin</a>,</li> |
| 45ca63d0 TD |
2103 | <li><a href="../../../package/pip/event-listener/">eventListener package installation plugin</a>,</li> |
| 2104 | <li><a href="../../../package/pip/file/">file package installation plugin</a>,</li> | |
| 2105 | <li><a href="../../../package/pip/language/">language package installation plugin</a>,</li> | |
| 45ca63d0 TD |
2106 | <li><a href="../../../package/pip/template/">template package installation plugin</a>,</li> |
| 2107 | <li><a href="../../../package/pip/template-listener/">templateListener package installation plugin</a>.</li> | |
| 2108 | </ul> | |
| 2109 | <p>For more information about the event system, please refer to the <a href="../../../php/api/events/">dedicated page on events</a>.</p> | |
| 2110 | <h2 id="package-structure">Package Structure<a class="headerlink" href="#package-structure" title="Permanent link">#</a></h2> | |
| 2111 | <p>The package will have the following file structure:</p> | |
| 0a8a4f41 | 2112 | <div class="highlight"><pre><span></span><code>├── eventListener.xml |
| 45ca63d0 | 2113 | ├── files |
| 0a8a4f41 WG |
2114 | │ ├── acp |
| 2115 | │ │ └── database | |
| 2116 | │ │ └── install_com.woltlab.wcf.people.birthday.php | |
| 45ca63d0 TD |
2117 | │ └── lib |
| 2118 | │ └── system | |
| 2119 | │ └── event | |
| 2120 | │ └── listener | |
| 2121 | │ ├── BirthdayPersonAddFormListener.class.php | |
| 2122 | │ └── BirthdaySortFieldPersonListPageListener.class.php | |
| 45ca63d0 TD |
2123 | ├── language |
| 2124 | │ ├── de.xml | |
| 2125 | │ └── en.xml | |
| 2126 | ├── package.xml | |
| 2127 | ├── templateListener.xml | |
| 2128 | └── templates | |
| 2129 | ├── __personListBirthday.tpl | |
| 2130 | └── __personListBirthdaySortField.tpl | |
| 2131 | </code></pre></div> | |
| 0a8a4f41 | 2132 | <h2 id="extending-person-model">Extending Person Model<a class="headerlink" href="#extending-person-model" title="Permanent link">#</a></h2> |
| 45ca63d0 | 2133 | <p>The existing model of a person only contains the person’s first name and their last name (in additional to the id used to identify created people). |
| 0a8a4f41 WG |
2134 | To add the birthday to the model, we need to create an additional database table column using the <a href="../../../package/pip/database/"><code>database</code> package installation plugin</a>:</p> |
| 2135 | <div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="n">php</span> | |
| 2136 | ||
| 2137 | <span class="n">use</span> <span class="n">wcf</span><span class="err">\</span><span class="k">system</span><span class="err">\</span><span class="k">database</span><span class="err">\</span><span class="k">table</span><span class="err">\</span><span class="k">column</span><span class="err">\</span><span class="n">DateDatabaseTableColumn</span><span class="p">;</span> | |
| 2138 | <span class="n">use</span> <span class="n">wcf</span><span class="err">\</span><span class="k">system</span><span class="err">\</span><span class="k">database</span><span class="err">\</span><span class="k">table</span><span class="err">\</span><span class="n">PartialDatabaseTable</span><span class="p">;</span> | |
| 2139 | ||
| 2140 | <span class="k">return</span> <span class="p">[</span> | |
| 2141 | <span class="n">PartialDatabaseTable</span><span class="p">::</span><span class="k">create</span><span class="p">(</span><span class="s1">'wcf1_person'</span><span class="p">)</span> | |
| 2142 | <span class="o">-></span><span class="n">columns</span><span class="p">([</span> | |
| 2143 | <span class="n">DateDatabaseTableColumn</span><span class="p">::</span><span class="k">create</span><span class="p">(</span><span class="s1">'birthday'</span><span class="p">),</span> | |
| 2144 | <span class="p">]),</span> | |
| 2145 | <span class="p">];</span> | |
| 45ca63d0 | 2146 | </code></pre></div> |
| 0a8a4f41 | 2147 | <p>If we have a <a href="../part_1/#person"><code>Person</code> object</a>, this new property can be accessed the same way as the <code>personID</code> property, the <code>firstName</code> property, or the <code>lastName</code> property from the base package: <code>$person->birthday</code>.</p> |
| 45ca63d0 | 2148 | <h2 id="setting-birthday-in-acp">Setting Birthday in ACP<a class="headerlink" href="#setting-birthday-in-acp" title="Permanent link">#</a></h2> |
| 0a8a4f41 | 2149 | <p>To set the birthday of a person, we only have to add another form field with an event listener:</p> |
| 45ca63d0 | 2150 | <div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="nx">php</span> |
| 0a8a4f41 | 2151 | |
| 45ca63d0 | 2152 | <span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span> |
| 0a8a4f41 | 2153 | |
| 45ca63d0 | 2154 | <span class="k">use</span> <span class="nx">wcf\acp\form\PersonAddForm</span><span class="p">;</span> |
| 0a8a4f41 WG |
2155 | <span class="k">use</span> <span class="nx">wcf\form\AbstractFormBuilderForm</span><span class="p">;</span> |
| 2156 | <span class="k">use</span> <span class="nx">wcf\system\form\builder\container\FormContainer</span><span class="p">;</span> | |
| 2157 | <span class="k">use</span> <span class="nx">wcf\system\form\builder\field\DateFormField</span><span class="p">;</span> | |
| 45ca63d0 TD |
2158 | |
| 2159 | <span class="sd">/**</span> | |
| 2160 | <span class="sd"> * Handles setting the birthday when adding and editing people.</span> | |
| 2161 | <span class="sd"> *</span> | |
| 2162 | <span class="sd"> * @author Matthias Schmidt</span> | |
| 0a8a4f41 | 2163 | <span class="sd"> * @copyright 2001-2021 WoltLab GmbH</span> |
| 45ca63d0 TD |
2164 | <span class="sd"> * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php></span> |
| 2165 | <span class="sd"> * @package WoltLabSuite\Core\System\Event\Listener</span> | |
| 2166 | <span class="sd"> */</span> | |
| 0a8a4f41 WG |
2167 | <span class="k">class</span> <span class="nc">BirthdayPersonAddFormListener</span> <span class="k">extends</span> <span class="nx">AbstractEventListener</span> |
| 2168 | <span class="p">{</span> | |
| 45ca63d0 | 2169 | <span class="sd">/**</span> |
| 0a8a4f41 | 2170 | <span class="sd"> * @see AbstractFormBuilderForm::createForm()</span> |
| 45ca63d0 | 2171 | <span class="sd"> */</span> |
| 0a8a4f41 WG |
2172 | <span class="k">protected</span> <span class="k">function</span> <span class="nf">onCreateForm</span><span class="p">(</span><span class="nx">PersonAddForm</span> <span class="nv">$form</span><span class="p">)</span><span class="o">:</span> <span class="nx">void</span> |
| 2173 | <span class="p">{</span> | |
| 2174 | <span class="sd">/** @var FormContainer $dataContainer */</span> | |
| 2175 | <span class="nv">$dataContainer</span> <span class="o">=</span> <span class="nv">$form</span><span class="o">-></span><span class="na">form</span><span class="o">-></span><span class="na">getNodeById</span><span class="p">(</span><span class="s1">'data'</span><span class="p">);</span> | |
| 2176 | <span class="nv">$dataContainer</span><span class="o">-></span><span class="na">appendChild</span><span class="p">(</span> | |
| 2177 | <span class="nx">DateFormField</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">'birthday'</span><span class="p">)</span> | |
| 2178 | <span class="o">-></span><span class="na">label</span><span class="p">(</span><span class="s1">'wcf.person.birthday'</span><span class="p">)</span> | |
| 2179 | <span class="o">-></span><span class="na">saveValueFormat</span><span class="p">(</span><span class="s1">'Y-m-d'</span><span class="p">)</span> | |
| 2180 | <span class="o">-></span><span class="na">nullable</span><span class="p">()</span> | |
| 2181 | <span class="p">);</span> | |
| 45ca63d0 TD |
2182 | <span class="p">}</span> |
| 2183 | <span class="p">}</span> | |
| 2184 | </code></pre></div> | |
| 0a8a4f41 WG |
2185 | <p>registered via</p> |
| 2186 | <div class="highlight"><pre><span></span><code><span class="nt"><eventlistener</span> <span class="na">name=</span><span class="s">"createForm@wcf\acp\form\PersonAddForm"</span><span class="nt">></span> | |
| 2187 | <span class="nt"><environment></span>admin<span class="nt"></environment></span> | |
| 2188 | <span class="nt"><eventclassname></span>wcf\acp\form\PersonAddForm<span class="nt"></eventclassname></span> | |
| 2189 | <span class="nt"><eventname></span>createForm<span class="nt"></eventname></span> | |
| 2190 | <span class="nt"><listenerclassname></span>wcf\system\event\listener\BirthdayPersonAddFormListener<span class="nt"></listenerclassname></span> | |
| 2191 | <span class="nt"><inherit></span>1<span class="nt"></inherit></span> | |
| 2192 | <span class="nt"></eventlistener></span> | |
| 2193 | </code></pre></div> | |
| 2194 | <p>in <code>eventListener.xml</code>, <a href="#eventlistenerxml">see below</a>.</p> | |
| 2195 | <p>As <code>BirthdayPersonAddFormListener</code> extends <code>AbstractEventListener</code> and as the name of relevant event is <code>createForm</code>, <code>AbstractEventListener</code> internally automatically calls <code>onCreateForm()</code> with the event object as the parameter. | |
| 2196 | It is important to set <code><inherit>1</inherit></code> so that the event listener is also executed for <code>PersonEditForm</code>, which extends <code>PersonAddForm</code>.</p> | |
| 2197 | <p>The language item <code>wcf.person.birthday</code> used in the label is the only new one for this package:</p> | |
| 2198 | <div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="n">xml</span> <span class="k">version</span><span class="o">=</span><span class="ss">"1.0"</span> <span class="k">encoding</span><span class="o">=</span><span class="ss">"UTF-8"</span><span class="o">?></span> | |
| 2199 | <span class="o"><</span><span class="k">language</span> <span class="n">xmlns</span><span class="o">=</span><span class="ss">"http://www.woltlab.com"</span> <span class="n">xmlns</span><span class="p">:</span><span class="n">xsi</span><span class="o">=</span><span class="ss">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="n">xsi</span><span class="p">:</span><span class="n">schemaLocation</span><span class="o">=</span><span class="ss">"http://www.woltlab.com http://www.woltlab.com/XSD/5.4/language.xsd"</span> <span class="n">languagecode</span><span class="o">=</span><span class="ss">"de"</span><span class="o">></span> | |
| 2200 | <span class="o"><</span><span class="n">category</span> <span class="n">name</span><span class="o">=</span><span class="ss">"wcf.person"</span><span class="o">></span> | |
| 2201 | <span class="o"><</span><span class="n">item</span> <span class="n">name</span><span class="o">=</span><span class="ss">"wcf.person.birthday"</span><span class="o">><!</span><span class="p">[</span><span class="n">CDATA</span><span class="p">[</span><span class="n">Geburtstag</span><span class="p">]]</span><span class="o">></</span><span class="n">item</span><span class="o">></span> | |
| 2202 | <span class="o"></</span><span class="n">category</span><span class="o">></span> | |
| 2203 | <span class="o"></</span><span class="k">language</span><span class="o">></span> | |
| 2204 | </code></pre></div> | |
| 2205 | <div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="n">xml</span> <span class="k">version</span><span class="o">=</span><span class="ss">"1.0"</span> <span class="k">encoding</span><span class="o">=</span><span class="ss">"UTF-8"</span><span class="o">?></span> | |
| 2206 | <span class="o"><</span><span class="k">language</span> <span class="n">xmlns</span><span class="o">=</span><span class="ss">"http://www.woltlab.com"</span> <span class="n">xmlns</span><span class="p">:</span><span class="n">xsi</span><span class="o">=</span><span class="ss">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="n">xsi</span><span class="p">:</span><span class="n">schemaLocation</span><span class="o">=</span><span class="ss">"http://www.woltlab.com http://www.woltlab.com/XSD/5.4/language.xsd"</span> <span class="n">languagecode</span><span class="o">=</span><span class="ss">"en"</span><span class="o">></span> | |
| 2207 | <span class="o"><</span><span class="n">category</span> <span class="n">name</span><span class="o">=</span><span class="ss">"wcf.person"</span><span class="o">></span> | |
| 2208 | <span class="o"><</span><span class="n">item</span> <span class="n">name</span><span class="o">=</span><span class="ss">"wcf.person.birthday"</span><span class="o">><!</span><span class="p">[</span><span class="n">CDATA</span><span class="p">[</span><span class="n">Birthday</span><span class="p">]]</span><span class="o">></</span><span class="n">item</span><span class="o">></span> | |
| 2209 | <span class="o"></</span><span class="n">category</span><span class="o">></span> | |
| 2210 | <span class="o"></</span><span class="k">language</span><span class="o">></span> | |
| 2211 | </code></pre></div> | |
| 45ca63d0 TD |
2212 | <h2 id="adding-birthday-table-column-in-acp">Adding Birthday Table Column in ACP<a class="headerlink" href="#adding-birthday-table-column-in-acp" title="Permanent link">#</a></h2> |
| 2213 | <p>To add a birthday column to the person list page in the ACP, we need three parts:</p> | |
| 2214 | <ol> | |
| 2215 | <li>an event listener that makes the <code>birthday</code> database table column a valid sort field,</li> | |
| 2216 | <li>a template listener that adds the birthday column to the table’s head, and</li> | |
| 2217 | <li>a template listener that adds the birthday column to the table’s rows.</li> | |
| 2218 | </ol> | |
| 2219 | <p>The first part is a very simple class:</p> | |
| 2220 | <div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="nx">php</span> | |
| 0a8a4f41 | 2221 | |
| 45ca63d0 | 2222 | <span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span> |
| 0a8a4f41 | 2223 | |
| 45ca63d0 TD |
2224 | <span class="k">use</span> <span class="nx">wcf\page\SortablePage</span><span class="p">;</span> |
| 2225 | ||
| 2226 | <span class="sd">/**</span> | |
| 2227 | <span class="sd"> * Makes people's birthday a valid sort field in the ACP and the front end.</span> | |
| 0a8a4f41 | 2228 | <span class="sd"> *</span> |
| 45ca63d0 | 2229 | <span class="sd"> * @author Matthias Schmidt</span> |
| 0a8a4f41 | 2230 | <span class="sd"> * @copyright 2001-2021 WoltLab GmbH</span> |
| 45ca63d0 TD |
2231 | <span class="sd"> * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php></span> |
| 2232 | <span class="sd"> * @package WoltLabSuite\Core\System\Event\Listener</span> | |
| 2233 | <span class="sd"> */</span> | |
| 0a8a4f41 WG |
2234 | <span class="k">class</span> <span class="nc">BirthdaySortFieldPersonListPageListener</span> <span class="k">extends</span> <span class="nx">AbstractEventListener</span> |
| 2235 | <span class="p">{</span> | |
| 45ca63d0 | 2236 | <span class="sd">/**</span> |
| 0a8a4f41 | 2237 | <span class="sd"> * @see SortablePage::validateSortField()</span> |
| 45ca63d0 | 2238 | <span class="sd"> */</span> |
| 0a8a4f41 WG |
2239 | <span class="k">public</span> <span class="k">function</span> <span class="nf">onValidateSortField</span><span class="p">(</span><span class="nx">SortablePage</span> <span class="nv">$page</span><span class="p">)</span><span class="o">:</span> <span class="nx">void</span> |
| 2240 | <span class="p">{</span> | |
| 2241 | <span class="nv">$page</span><span class="o">-></span><span class="na">validSortFields</span><span class="p">[]</span> <span class="o">=</span> <span class="s1">'birthday'</span><span class="p">;</span> | |
| 45ca63d0 TD |
2242 | <span class="p">}</span> |
| 2243 | <span class="p">}</span> | |
| 2244 | </code></pre></div> | |
| 45ca63d0 TD |
2245 | <div class="admonition info"> |
| 2246 | <p class="admonition-title">We use <code>SortablePage</code> as a type hint instead of <code>wcf\acp\page\PersonListPage</code> because we will be using the same event listener class in the front end to also allow sorting that list by birthday.</p> | |
| 2247 | </div> | |
| 2248 | <p>As the relevant template codes are only one line each, we will simply put them directly in the <code>templateListener.xml</code> file that will be shown <a href="#templatelistenerxml">later on</a>. | |
| 2249 | The code for the table head is similar to the other <code>th</code> elements:</p> | |
| 2250 | <div class="highlight"><pre><span></span><code><span class="x"><th class="columnDate columnBirthday</span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$sortField</span> <span class="o">==</span> <span class="s1">'birthday'</span><span class="cp">}</span><span class="x"> active </span><span class="cp">{</span><span class="o">@</span><span class="nv">$sortOrder</span><span class="cp">}{</span><span class="nf">/if</span><span class="cp">}</span><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">'PersonList'</span><span class="cp">}</span><span class="x">pageNo=</span><span class="cp">{</span><span class="o">@</span><span class="nv">$pageNo</span><span class="cp">}</span><span class="x">&sortField=birthday&sortOrder=</span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$sortField</span> <span class="o">==</span> <span class="s1">'birthday'</span> <span class="o">&&</span> <span class="nv">$sortOrder</span> <span class="o">==</span> <span class="s1">'ASC'</span><span class="cp">}</span><span class="x">DESC</span><span class="cp">{</span><span class="nf">else</span><span class="cp">}</span><span class="x">ASC</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}{</span><span class="nf">/link</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">wcf.person.birthday</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></a></th></span> | |
| 2251 | </code></pre></div> | |
| 45ca63d0 | 2252 | <p>For the table body’s column, we need to make sure that the birthday is only show if it is actually set:</p> |
| 0a8a4f41 | 2253 | <div class="highlight"><pre><span></span><code><span class="x"><td class="columnDate columnBirthday"></span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$person</span><span class="o">-></span><span class="na">birthday</span><span class="cp">}{</span><span class="o">@</span><span class="nv">$person</span><span class="o">-></span><span class="na">birthday</span><span class="o">|</span><span class="na">strtotime</span><span class="o">|</span><span class="na">date</span><span class="cp">}{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></td></span> |
| 45ca63d0 | 2254 | </code></pre></div> |
| 45ca63d0 TD |
2255 | <h2 id="adding-birthday-in-front-end">Adding Birthday in Front End<a class="headerlink" href="#adding-birthday-in-front-end" title="Permanent link">#</a></h2> |
| 2256 | <p>In the front end, we also want to make the list sortable by birthday and show the birthday as part of each person’s “statistics”.</p> | |
| 2257 | <p>To add the birthday as a valid sort field, we use <code>BirthdaySortFieldPersonListPageListener</code> just as in the ACP. | |
| 2258 | In the front end, we will now use a template (<code>__personListBirthdaySortField.tpl</code>) instead of a directly putting the template code in the <code>templateListener.xml</code> file:</p> | |
| 2259 | <div class="highlight"><pre><span></span><code><span class="x"><option value="birthday"</span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$sortField</span> <span class="o">==</span> <span class="s1">'birthday'</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">wcf.person.birthday</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></option></span> | |
| 2260 | </code></pre></div> | |
| 45ca63d0 TD |
2261 | <div class="admonition info"> |
| 2262 | <p class="admonition-title">You might have noticed the two underscores at the beginning of the template file. For templates that are included via template listeners, this is the naming convention we use.</p> | |
| 2263 | </div> | |
| 2264 | <p>Putting the template code into a file has the advantage that in the administrator is able to edit the code directly via a custom template group, even though in this case this might not be very probable.</p> | |
| 2265 | <p>To show the birthday, we use the following template code for the <code>personStatistics</code> template event, which again makes sure that the birthday is only shown if it is actually set:</p> | |
| 0a8a4f41 | 2266 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">if</span> <span class="nv">$person</span><span class="o">-></span><span class="na">birthday</span><span class="cp">}</span><span class="x"></span> |
| 45ca63d0 TD |
2267 | <span class="x"> <dt></span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.person.birthday</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></dt></span> |
| 2268 | <span class="x"> <dd></span><span class="cp">{</span><span class="o">@</span><span class="nv">$person</span><span class="o">-></span><span class="na">birthday</span><span class="o">|</span><span class="na">strtotime</span><span class="o">|</span><span class="na">date</span><span class="cp">}</span><span class="x"></dd></span> | |
| 2269 | <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span> | |
| 2270 | </code></pre></div> | |
| 45ca63d0 TD |
2271 | <h2 id="templatelistenerxml"><code>templateListener.xml</code><a class="headerlink" href="#templatelistenerxml" title="Permanent link">#</a></h2> |
| 2272 | <p>The following code shows the <code>templateListener.xml</code> file used to install all mentioned template listeners:</p> | |
| 2273 | <div class="highlight"><pre><span></span><code><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span> | |
| 0a8a4f41 | 2274 | <span class="nt"><data</span> <span class="na">xmlns=</span><span class="s">"http://www.woltlab.com"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="na">xsi:schemaLocation=</span><span class="s">"http://www.woltlab.com http://www.woltlab.com/tornado/5.4/templateListener.xsd"</span><span class="nt">></span> |
| 45ca63d0 TD |
2275 | <span class="nt"><import></span> |
| 2276 | <span class="c"><!-- admin --></span> | |
| 2277 | <span class="nt"><templatelistener</span> <span class="na">name=</span><span class="s">"personListBirthdayColumnHead"</span><span class="nt">></span> | |
| 2278 | <span class="nt"><eventname></span>columnHeads<span class="nt"></eventname></span> | |
| 2279 | <span class="nt"><environment></span>admin<span class="nt"></environment></span> | |
| 2280 | <span class="nt"><templatecode></span><span class="cp"><![CDATA[<th class="columnDate columnBirthday{if $sortField == 'birthday'} active {@$sortOrder}{/if}"><a href="{link controller='PersonList'}pageNo={@$pageNo}&sortField=birthday&sortOrder={if $sortField == 'birthday' && $sortOrder == 'ASC'}DESC{else}ASC{/if}{/link}">{lang}wcf.person.birthday{/lang}</a></th>]]></span><span class="nt"></templatecode></span> | |
| 2281 | <span class="nt"><templatename></span>personList<span class="nt"></templatename></span> | |
| 2282 | <span class="nt"></templatelistener></span> | |
| 2283 | <span class="nt"><templatelistener</span> <span class="na">name=</span><span class="s">"personListBirthdayColumn"</span><span class="nt">></span> | |
| 2284 | <span class="nt"><eventname></span>columns<span class="nt"></eventname></span> | |
| 2285 | <span class="nt"><environment></span>admin<span class="nt"></environment></span> | |
| 0a8a4f41 | 2286 | <span class="nt"><templatecode></span><span class="cp"><![CDATA[<td class="columnDate columnBirthday">{if $person->birthday}{@$person->birthday|strtotime|date}{/if}</td>]]></span><span class="nt"></templatecode></span> |
| 45ca63d0 TD |
2287 | <span class="nt"><templatename></span>personList<span class="nt"></templatename></span> |
| 2288 | <span class="nt"></templatelistener></span> | |
| 45ca63d0 TD |
2289 | <span class="c"><!-- /admin --></span> |
| 2290 | ||
| 2291 | <span class="c"><!-- user --></span> | |
| 2292 | <span class="nt"><templatelistener</span> <span class="na">name=</span><span class="s">"personListBirthday"</span><span class="nt">></span> | |
| 2293 | <span class="nt"><eventname></span>personStatistics<span class="nt"></eventname></span> | |
| 2294 | <span class="nt"><environment></span>user<span class="nt"></environment></span> | |
| 2295 | <span class="nt"><templatecode></span><span class="cp"><![CDATA[{include file='__personListBirthday'}]]></span><span class="nt"></templatecode></span> | |
| 2296 | <span class="nt"><templatename></span>personList<span class="nt"></templatename></span> | |
| 2297 | <span class="nt"></templatelistener></span> | |
| 2298 | <span class="nt"><templatelistener</span> <span class="na">name=</span><span class="s">"personListBirthdaySortField"</span><span class="nt">></span> | |
| 2299 | <span class="nt"><eventname></span>sortField<span class="nt"></eventname></span> | |
| 2300 | <span class="nt"><environment></span>user<span class="nt"></environment></span> | |
| 2301 | <span class="nt"><templatecode></span><span class="cp"><![CDATA[{include file='__personListBirthdaySortField'}]]></span><span class="nt"></templatecode></span> | |
| 2302 | <span class="nt"><templatename></span>personList<span class="nt"></templatename></span> | |
| 2303 | <span class="nt"></templatelistener></span> | |
| 2304 | <span class="c"><!-- /user --></span> | |
| 2305 | <span class="nt"></import></span> | |
| 2306 | <span class="nt"></data></span> | |
| 2307 | </code></pre></div> | |
| 45ca63d0 TD |
2308 | <p>In cases where a template is used, we simply use the <code>include</code> syntax to load the template.</p> |
| 2309 | <h2 id="eventlistenerxml"><code>eventListener.xml</code><a class="headerlink" href="#eventlistenerxml" title="Permanent link">#</a></h2> | |
| 0a8a4f41 | 2310 | <p>There are two event listeners that make <code>birthday</code> a valid sort field in the ACP and the front end, respectively, and the third event listener takes care of setting the birthday.</p> |
| 45ca63d0 | 2311 | <div class="highlight"><pre><span></span><code><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span> |
| 0a8a4f41 | 2312 | <span class="nt"><data</span> <span class="na">xmlns=</span><span class="s">"http://www.woltlab.com"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="na">xsi:schemaLocation=</span><span class="s">"http://www.woltlab.com http://www.woltlab.com/XSD/5.4/eventListener.xsd"</span><span class="nt">></span> |
| 45ca63d0 TD |
2313 | <span class="nt"><import></span> |
| 2314 | <span class="c"><!-- admin --></span> | |
| 0a8a4f41 | 2315 | <span class="nt"><eventlistener</span> <span class="na">name=</span><span class="s">"validateSortField@wcf\acp\page\PersonListPage"</span><span class="nt">></span> |
| 45ca63d0 TD |
2316 | <span class="nt"><environment></span>admin<span class="nt"></environment></span> |
| 2317 | <span class="nt"><eventclassname></span>wcf\acp\page\PersonListPage<span class="nt"></eventclassname></span> | |
| 2318 | <span class="nt"><eventname></span>validateSortField<span class="nt"></eventname></span> | |
| 2319 | <span class="nt"><listenerclassname></span>wcf\system\event\listener\BirthdaySortFieldPersonListPageListener<span class="nt"></listenerclassname></span> | |
| 2320 | <span class="nt"></eventlistener></span> | |
| 0a8a4f41 | 2321 | <span class="nt"><eventlistener</span> <span class="na">name=</span><span class="s">"createForm@wcf\acp\form\PersonAddForm"</span><span class="nt">></span> |
| 45ca63d0 TD |
2322 | <span class="nt"><environment></span>admin<span class="nt"></environment></span> |
| 2323 | <span class="nt"><eventclassname></span>wcf\acp\form\PersonAddForm<span class="nt"></eventclassname></span> | |
| 0a8a4f41 | 2324 | <span class="nt"><eventname></span>createForm<span class="nt"></eventname></span> |
| 45ca63d0 TD |
2325 | <span class="nt"><listenerclassname></span>wcf\system\event\listener\BirthdayPersonAddFormListener<span class="nt"></listenerclassname></span> |
| 2326 | <span class="nt"><inherit></span>1<span class="nt"></inherit></span> | |
| 2327 | <span class="nt"></eventlistener></span> | |
| 45ca63d0 TD |
2328 | <span class="c"><!-- /admin --></span> |
| 2329 | ||
| 2330 | <span class="c"><!-- user --></span> | |
| 0a8a4f41 | 2331 | <span class="nt"><eventlistener</span> <span class="na">name=</span><span class="s">"validateSortField@wcf\page\PersonListPage"</span><span class="nt">></span> |
| 45ca63d0 TD |
2332 | <span class="nt"><environment></span>user<span class="nt"></environment></span> |
| 2333 | <span class="nt"><eventclassname></span>wcf\page\PersonListPage<span class="nt"></eventclassname></span> | |
| 2334 | <span class="nt"><eventname></span>validateSortField<span class="nt"></eventname></span> | |
| 2335 | <span class="nt"><listenerclassname></span>wcf\system\event\listener\BirthdaySortFieldPersonListPageListener<span class="nt"></listenerclassname></span> | |
| 2336 | <span class="nt"></eventlistener></span> | |
| 2337 | <span class="c"><!-- /user --></span> | |
| 2338 | <span class="nt"></import></span> | |
| 2339 | <span class="nt"></data></span> | |
| 2340 | </code></pre></div> | |
| 45ca63d0 TD |
2341 | <h2 id="packagexml"><code>package.xml</code><a class="headerlink" href="#packagexml" title="Permanent link">#</a></h2> |
| 2342 | <p>The only relevant difference between the <code>package.xml</code> file of the base page from part 1 and the <code>package.xml</code> file of this package is that this package requires the base package <code>com.woltlab.wcf.people</code> (see <code><requiredpackages></code>):</p> | |
| 2343 | <div class="highlight"><pre><span></span><code><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span> | |
| 0a8a4f41 | 2344 | <span class="nt"><package</span> <span class="na">name=</span><span class="s">"com.woltlab.wcf.people.birthday"</span> <span class="na">xmlns=</span><span class="s">"http://www.woltlab.com"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="na">xsi:schemaLocation=</span><span class="s">"http://www.woltlab.com http://www.woltlab.com/XSD/5.4/package.xsd"</span><span class="nt">></span> |
| 45ca63d0 TD |
2345 | <span class="nt"><packageinformation></span> |
| 2346 | <span class="nt"><packagename></span>WoltLab Suite Core Tutorial: People (Birthday)<span class="nt"></packagename></span> | |
| 2347 | <span class="nt"><packagedescription></span>Adds a birthday field to the people management system as part of a tutorial to create packages.<span class="nt"></packagedescription></span> | |
| 0a8a4f41 WG |
2348 | <span class="nt"><version></span>5.4.0<span class="nt"></version></span> |
| 2349 | <span class="nt"><date></span>2021-04-16<span class="nt"></date></span> | |
| 45ca63d0 TD |
2350 | <span class="nt"></packageinformation></span> |
| 2351 | ||
| 2352 | <span class="nt"><authorinformation></span> | |
| 2353 | <span class="nt"><author></span>WoltLab GmbH<span class="nt"></author></span> | |
| 2354 | <span class="nt"><authorurl></span>http://www.woltlab.com<span class="nt"></authorurl></span> | |
| 2355 | <span class="nt"></authorinformation></span> | |
| 2356 | ||
| 2357 | <span class="nt"><requiredpackages></span> | |
| 0a8a4f41 WG |
2358 | <span class="nt"><requiredpackage</span> <span class="na">minversion=</span><span class="s">"5.4.0 Alpha 1"</span><span class="nt">></span>com.woltlab.wcf<span class="nt"></requiredpackage></span> |
| 2359 | <span class="nt"><requiredpackage</span> <span class="na">minversion=</span><span class="s">"5.4.0"</span><span class="nt">></span>com.woltlab.wcf.people<span class="nt"></requiredpackage></span> | |
| 45ca63d0 TD |
2360 | <span class="nt"></requiredpackages></span> |
| 2361 | ||
| 2362 | <span class="nt"><excludedpackages></span> | |
| 0a8a4f41 | 2363 | <span class="nt"><excludedpackage</span> <span class="na">version=</span><span class="s">"6.0.0 Alpha 1"</span><span class="nt">></span>com.woltlab.wcf<span class="nt"></excludedpackage></span> |
| 45ca63d0 TD |
2364 | <span class="nt"></excludedpackages></span> |
| 2365 | ||
| 45ca63d0 | 2366 | <span class="nt"><instructions</span> <span class="na">type=</span><span class="s">"install"</span><span class="nt">></span> |
| 45ca63d0 | 2367 | <span class="nt"><instruction</span> <span class="na">type=</span><span class="s">"file"</span> <span class="nt">/></span> |
| 0a8a4f41 | 2368 | <span class="nt"><instruction</span> <span class="na">type=</span><span class="s">"database"</span><span class="nt">></span>acp/database/install_com.woltlab.wcf.people.birthday.php<span class="nt"></instruction></span> |
| 45ca63d0 TD |
2369 | <span class="nt"><instruction</span> <span class="na">type=</span><span class="s">"template"</span> <span class="nt">/></span> |
| 2370 | <span class="nt"><instruction</span> <span class="na">type=</span><span class="s">"language"</span> <span class="nt">/></span> | |
| 2371 | ||
| 2372 | <span class="nt"><instruction</span> <span class="na">type=</span><span class="s">"eventListener"</span> <span class="nt">/></span> | |
| 2373 | <span class="nt"><instruction</span> <span class="na">type=</span><span class="s">"templateListener"</span> <span class="nt">/></span> | |
| 2374 | <span class="nt"></instructions></span> | |
| 2375 | <span class="nt"></package></span> | |
| 2376 | </code></pre></div> | |
| 45ca63d0 TD |
2377 | <hr /> |
| 2378 | <p>This concludes the second part of our tutorial series after which you now have extended the base package using event listeners and template listeners that allow you to enter the birthday of the people.</p> | |
| e3413d1b | 2379 | <p>The complete source code of this part can be found on <a href="https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/tutorial-series/part-2">GitHub</a>.</p> |
| 45ca63d0 | 2380 | |
| 4a5c32e1 WG |
2381 | |
| 2382 | ||
| 2383 | ||
| 2384 | <hr> | |
| 2385 | <div class="md-source-date"> | |
| 2386 | <small> | |
| 2387 | ||
| 5aa4be80 | 2388 | Last update: 2021-04-20 |
| 4a5c32e1 WG |
2389 | |
| 2390 | </small> | |
| 2391 | </div> | |
| 2392 | ||
| 2393 | ||
| 45ca63d0 TD |
2394 | |
| 2395 | ||
| 2396 | ||
| 2397 | ||
| 2398 | ||
| 2399 | ||
| 2400 | </article> | |
| 2401 | </div> | |
| 2402 | </div> | |
| fb962f09 | 2403 | |
| 45ca63d0 TD |
2404 | </main> |
| 2405 | ||
| 2406 | ||
| 2407 | <footer class="md-footer"> | |
| 2408 | ||
| 2409 | <nav class="md-footer__inner md-grid" aria-label="Footer"> | |
| 2410 | ||
| 2411 | <a href="../part_1/" class="md-footer__link md-footer__link--prev" rel="prev"> | |
| 2412 | <div class="md-footer__button md-icon"> | |
| 2413 | <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> | |
| 2414 | </div> | |
| 2415 | <div class="md-footer__title"> | |
| 2416 | <div class="md-ellipsis"> | |
| 2417 | <span class="md-footer__direction"> | |
| 2418 | Previous | |
| 2419 | </span> | |
| 2420 | Part 1 | |
| 2421 | </div> | |
| 2422 | </div> | |
| 2423 | </a> | |
| 2424 | ||
| 2425 | ||
| 2426 | <a href="../part_3/" class="md-footer__link md-footer__link--next" rel="next"> | |
| 2427 | <div class="md-footer__title"> | |
| 2428 | <div class="md-ellipsis"> | |
| 2429 | <span class="md-footer__direction"> | |
| 2430 | Next | |
| 2431 | </span> | |
| 2432 | Part 3 | |
| 2433 | </div> | |
| 2434 | </div> | |
| 2435 | <div class="md-footer__button md-icon"> | |
| 2436 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg> | |
| 2437 | </div> | |
| 2438 | </a> | |
| 2439 | ||
| 2440 | </nav> | |
| 2441 | ||
| 2442 | <div class="md-footer-meta md-typeset"> | |
| 2443 | <div class="md-footer-meta__inner md-grid"> | |
| 2444 | <div class="md-footer-copyright"> | |
| 2445 | ||
| 2446 | <div class="md-footer-copyright__highlight"> | |
| 2447 | Copyright © 2020 WoltLab GmbH | |
| 2448 | </div> | |
| 2449 | ||
| 2450 | Made with | |
| 2451 | <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> | |
| 2452 | Material for MkDocs | |
| 2453 | </a> | |
| fb88dc6e | 2454 | |
| 45ca63d0 TD |
2455 | </div> |
| 2456 | <div class="md-footer-copyright"> | |
| 2457 | <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a> | |
| 2458 | <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a> | |
| 2459 | </div> | |
| 2460 | </div> | |
| 2461 | </div> | |
| 2462 | </footer> | |
| 2463 | ||
| 2464 | </div> | |
| 2465 | <div class="md-dialog" data-md-component="dialog"> | |
| 2466 | <div class="md-dialog__inner md-typeset"></div> | |
| 2467 | </div> | |
| fb962f09 | 2468 | <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.fe42c31b.min.js", "version": {"provider": "mike"}}</script> |
| 45ca63d0 TD |
2469 | |
| 2470 | ||
| a4835aa6 | 2471 | <script src="../../../assets/javascripts/bundle.4ea5477f.min.js"></script> |
| 45ca63d0 TD |
2472 | |
| 2473 | ||
| 2474 | </body> | |
| 2475 | </html> |