latest/php/code-style/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11
  12       <link rel="shortcut icon" href="../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.5">
  14
  15
  16
  17         <title>Code Style - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../assets/stylesheets/main.77f3fd56.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../assets/stylesheets/palette.7fa14f5b.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37
  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="">
  53
  54
  55
  56     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  57     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  58     <label class="md-overlay" for="__drawer"></label>
  59     <div data-md-component="skip">
  60
  61
  62         <a href="#code-style" class="md-skip">
  63           Skip to content
  64         </a>
  65
  66     </div>
  67     <div data-md-component="announce">
  68
  69         <aside class="md-announce">
  70           <div class="md-announce__inner md-grid md-typeset">
  71
  72     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  73
  74           </div>
  75         </aside>
  76
  77     </div>
  78
  79
  80
  81 <header class="md-header" data-md-component="header">
  82   <nav class="md-header__inner md-grid" aria-label="Header">
  83     <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation">
  84
  85   <img src="../../assets/logo.png" alt="logo">
  86
  87     </a>
  88     <label class="md-header__button md-icon" for="__drawer">
  89       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  90     </label>
  91     <div class="md-header__title" data-md-component="header-title">
  92       <div class="md-header__ellipsis">
  93         <div class="md-header__topic">
  94           <span class="md-ellipsis">
  95             WoltLab Suite Documentation
  96           </span>
  97         </div>
  98         <div class="md-header__topic" data-md-component="header-topic">
  99           <span class="md-ellipsis">
 100
 101               Code Style
 102
 103           </span>
 104         </div>
 105       </div>
 106     </div>
 107     <div class="md-header__options">
 108
 109     </div>
 110
 111       <label class="md-header__button md-icon" for="__search">
 112         <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>
 113       </label>
 114
 115 <div class="md-search" data-md-component="search" role="dialog">
 116   <label class="md-search__overlay" for="__search"></label>
 117   <div class="md-search__inner" role="search">
 118     <form class="md-search__form" name="search">
 119       <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>
 120       <label class="md-search__icon md-icon" for="__search">
 121         <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>
 122         <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>
 123       </label>
 124       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 125         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
 126       </button>
 127     </form>
 128     <div class="md-search__output">
 129       <div class="md-search__scrollwrap" data-md-scrollfix>
 130         <div class="md-search-result" data-md-component="search-result">
 131           <div class="md-search-result__meta">
 132             Initializing search
 133           </div>
 134           <ol class="md-search-result__list"></ol>
 135         </div>
 136       </div>
 137     </div>
 138   </div>
 139 </div>
 140
 141
 142       <div class="md-header__source">
 143
 144 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 145   <div class="md-source__icon md-icon">
 146
 147     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 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>
 148   </div>
 149   <div class="md-source__repository">
 150     GitHub
 151   </div>
 152 </a>
 153       </div>
 154
 155   </nav>
 156 </header>
 157
 158     <div class="md-container" data-md-component="container">
 159
 160
 161
 162
 163       <main class="md-main" data-md-component="main">
 164         <div class="md-main__inner md-grid">
 165
 166
 167
 168               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 169                 <div class="md-sidebar__scrollwrap">
 170                   <div class="md-sidebar__inner">
 171
 172
 173
 174
 175
 176 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 177   <label class="md-nav__title" for="__drawer">
 178     <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
 179
 180   <img src="../../assets/logo.png" alt="logo">
 181
 182     </a>
 183     WoltLab Suite Documentation
 184   </label>
 185
 186     <div class="md-nav__source">
 187
 188 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 189   <div class="md-source__icon md-icon">
 190
 191     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 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>
 192   </div>
 193   <div class="md-source__repository">
 194     GitHub
 195   </div>
 196 </a>
 197     </div>
 198
 199   <ul class="md-nav__list" data-md-scrollfix>
 200
 201
 202
 203
 204
 205
 206
 207
 208     <li class="md-nav__item">
 209       <a href="../../getting-started/" class="md-nav__link">
 210         Getting Started
 211       </a>
 212     </li>
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 227
 228
 229         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
 230
 231       <label class="md-nav__link" for="__nav_2">
 232         PHP API
 233         <span class="md-nav__icon md-icon"></span>
 234       </label>
 235       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 236         <label class="md-nav__title" for="__nav_2">
 237           <span class="md-nav__icon md-icon"></span>
 238           PHP API
 239         </label>
 240         <ul class="md-nav__list" data-md-scrollfix>
 241
 242
 243
 244
 245
 246     <li class="md-nav__item">
 247       <a href="../pages/" class="md-nav__link">
 248         Pages
 249       </a>
 250     </li>
 251
 252
 253
 254
 255
 256
 257
 258     <li class="md-nav__item">
 259       <a href="../database-objects/" class="md-nav__link">
 260         Database Objects
 261       </a>
 262     </li>
 263
 264
 265
 266
 267
 268
 269
 270     <li class="md-nav__item">
 271       <a href="../database-access/" class="md-nav__link">
 272         Database Access
 273       </a>
 274     </li>
 275
 276
 277
 278
 279
 280
 281
 282     <li class="md-nav__item">
 283       <a href="../exceptions/" class="md-nav__link">
 284         Exceptions
 285       </a>
 286     </li>
 287
 288
 289
 290
 291
 292
 293
 294
 295     <li class="md-nav__item md-nav__item--nested">
 296
 297
 298         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 299
 300       <label class="md-nav__link" for="__nav_2_5">
 301         API
 302         <span class="md-nav__icon md-icon"></span>
 303       </label>
 304       <nav class="md-nav" aria-label="API" data-md-level="2">
 305         <label class="md-nav__title" for="__nav_2_5">
 306           <span class="md-nav__icon md-icon"></span>
 307           API
 308         </label>
 309         <ul class="md-nav__list" data-md-scrollfix>
 310
 311
 312
 313
 314
 315     <li class="md-nav__item">
 316       <a href="../api/caches/" class="md-nav__link">
 317         Caches
 318       </a>
 319     </li>
 320
 321
 322
 323
 324
 325
 326
 327     <li class="md-nav__item">
 328       <a href="../api/comments/" class="md-nav__link">
 329         Comments
 330       </a>
 331     </li>
 332
 333
 334
 335
 336
 337
 338
 339     <li class="md-nav__item">
 340       <a href="../api/cronjobs/" class="md-nav__link">
 341         Cronjobs
 342       </a>
 343     </li>
 344
 345
 346
 347
 348
 349
 350
 351     <li class="md-nav__item">
 352       <a href="../api/events/" class="md-nav__link">
 353         Events
 354       </a>
 355     </li>
 356
 357
 358
 359
 360
 361
 362
 363
 364     <li class="md-nav__item md-nav__item--nested">
 365
 366
 367         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 368
 369       <label class="md-nav__link" for="__nav_2_5_5">
 370         Form Builder
 371         <span class="md-nav__icon md-icon"></span>
 372       </label>
 373       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 374         <label class="md-nav__title" for="__nav_2_5_5">
 375           <span class="md-nav__icon md-icon"></span>
 376           Form Builder
 377         </label>
 378         <ul class="md-nav__list" data-md-scrollfix>
 379
 380
 381
 382
 383
 384     <li class="md-nav__item">
 385       <a href="../api/form_builder/overview/" class="md-nav__link">
 386         Overview
 387       </a>
 388     </li>
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../api/form_builder/structure/" class="md-nav__link">
 398         Structure
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408     <li class="md-nav__item">
 409       <a href="../api/form_builder/form_fields/" class="md-nav__link">
 410         Fields
 411       </a>
 412     </li>
 413
 414
 415
 416
 417
 418
 419
 420     <li class="md-nav__item">
 421       <a href="../api/form_builder/validation_data/" class="md-nav__link">
 422         Validation and Data
 423       </a>
 424     </li>
 425
 426
 427
 428
 429
 430
 431
 432     <li class="md-nav__item">
 433       <a href="../api/form_builder/dependencies/" class="md-nav__link">
 434         Dependencies
 435       </a>
 436     </li>
 437
 438
 439
 440         </ul>
 441       </nav>
 442     </li>
 443
 444
 445
 446
 447
 448
 449
 450     <li class="md-nav__item">
 451       <a href="../api/package_installation_plugins/" class="md-nav__link">
 452         Package Installation Plugins
 453       </a>
 454     </li>
 455
 456
 457
 458
 459
 460
 461
 462     <li class="md-nav__item">
 463       <a href="../api/user_activity_points/" class="md-nav__link">
 464         User Activity Points
 465       </a>
 466     </li>
 467
 468
 469
 470
 471
 472
 473
 474     <li class="md-nav__item">
 475       <a href="../api/user_notifications/" class="md-nav__link">
 476         User Notifications
 477       </a>
 478     </li>
 479
 480
 481
 482
 483
 484
 485
 486     <li class="md-nav__item">
 487       <a href="../api/sitemaps/" class="md-nav__link">
 488         Sitemaps
 489       </a>
 490     </li>
 491
 492
 493
 494         </ul>
 495       </nav>
 496     </li>
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506     <li class="md-nav__item md-nav__item--active">
 507
 508       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 509
 510
 511
 512
 513         <label class="md-nav__link md-nav__link--active" for="__toc">
 514           Code Style
 515           <span class="md-nav__icon md-icon"></span>
 516         </label>
 517
 518       <a href="./" class="md-nav__link md-nav__link--active">
 519         Code Style
 520       </a>
 521
 522
 523 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 524
 525
 526
 527
 528
 529     <label class="md-nav__title" for="__toc">
 530       <span class="md-nav__icon md-icon"></span>
 531       Table of contents
 532     </label>
 533     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 534
 535         <li class="md-nav__item">
 536   <a href="#general-code-style" class="md-nav__link">
 537     General Code Style
 538   </a>
 539
 540     <nav class="md-nav" aria-label="General Code Style">
 541       <ul class="md-nav__list">
 542
 543           <li class="md-nav__item">
 544   <a href="#naming-conventions" class="md-nav__link">
 545     Naming conventions
 546   </a>
 547
 548 </li>
 549
 550           <li class="md-nav__item">
 551   <a href="#arrays" class="md-nav__link">
 552     Arrays
 553   </a>
 554
 555 </li>
 556
 557           <li class="md-nav__item">
 558   <a href="#ternary-operator" class="md-nav__link">
 559     Ternary Operator
 560   </a>
 561
 562 </li>
 563
 564           <li class="md-nav__item">
 565   <a href="#whitespaces" class="md-nav__link">
 566     Whitespaces
 567   </a>
 568
 569 </li>
 570
 571       </ul>
 572     </nav>
 573
 574 </li>
 575
 576         <li class="md-nav__item">
 577   <a href="#classes" class="md-nav__link">
 578     Classes
 579   </a>
 580
 581     <nav class="md-nav" aria-label="Classes">
 582       <ul class="md-nav__list">
 583
 584           <li class="md-nav__item">
 585   <a href="#referencing-class-names" class="md-nav__link">
 586     Referencing Class Names
 587   </a>
 588
 589 </li>
 590
 591           <li class="md-nav__item">
 592   <a href="#static-getters-of-databaseobject-classes" class="md-nav__link">
 593     Static Getters (of DatabaseObject Classes)
 594   </a>
 595
 596 </li>
 597
 598           <li class="md-nav__item">
 599   <a href="#long-method-calls" class="md-nav__link">
 600     Long method calls
 601   </a>
 602
 603 </li>
 604
 605       </ul>
 606     </nav>
 607
 608 </li>
 609
 610     </ul>
 611
 612 </nav>
 613
 614     </li>
 615
 616
 617
 618
 619
 620
 621
 622     <li class="md-nav__item">
 623       <a href="../apps/" class="md-nav__link">
 624         Apps
 625       </a>
 626     </li>
 627
 628
 629
 630
 631
 632
 633
 634     <li class="md-nav__item">
 635       <a href="../gdpr/" class="md-nav__link">
 636         GDPR
 637       </a>
 638     </li>
 639
 640
 641
 642         </ul>
 643       </nav>
 644     </li>
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656     <li class="md-nav__item md-nav__item--nested">
 657
 658
 659         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 660
 661       <label class="md-nav__link" for="__nav_3">
 662         Languages, Templates & CSS
 663         <span class="md-nav__icon md-icon"></span>
 664       </label>
 665       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 666         <label class="md-nav__title" for="__nav_3">
 667           <span class="md-nav__icon md-icon"></span>
 668           Languages, Templates & CSS
 669         </label>
 670         <ul class="md-nav__list" data-md-scrollfix>
 671
 672
 673
 674
 675
 676     <li class="md-nav__item">
 677       <a href="../../view/languages/" class="md-nav__link">
 678         Languages
 679       </a>
 680     </li>
 681
 682
 683
 684
 685
 686
 687
 688     <li class="md-nav__item">
 689       <a href="../../view/templates/" class="md-nav__link">
 690         Templates
 691       </a>
 692     </li>
 693
 694
 695
 696
 697
 698
 699
 700     <li class="md-nav__item">
 701       <a href="../../view/css/" class="md-nav__link">
 702         CSS
 703       </a>
 704     </li>
 705
 706
 707
 708         </ul>
 709       </nav>
 710     </li>
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722     <li class="md-nav__item md-nav__item--nested">
 723
 724
 725         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 726
 727       <label class="md-nav__link" for="__nav_4">
 728         JavaScript API
 729         <span class="md-nav__icon md-icon"></span>
 730       </label>
 731       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 732         <label class="md-nav__title" for="__nav_4">
 733           <span class="md-nav__icon md-icon"></span>
 734           JavaScript API
 735         </label>
 736         <ul class="md-nav__list" data-md-scrollfix>
 737
 738
 739
 740
 741
 742     <li class="md-nav__item">
 743       <a href="../../javascript/general-usage/" class="md-nav__link">
 744         General Usage
 745       </a>
 746     </li>
 747
 748
 749
 750
 751
 752
 753
 754
 755     <li class="md-nav__item md-nav__item--nested">
 756
 757
 758         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 759
 760       <label class="md-nav__link" for="__nav_4_2">
 761         New API
 762         <span class="md-nav__icon md-icon"></span>
 763       </label>
 764       <nav class="md-nav" aria-label="New API" data-md-level="2">
 765         <label class="md-nav__title" for="__nav_4_2">
 766           <span class="md-nav__icon md-icon"></span>
 767           New API
 768         </label>
 769         <ul class="md-nav__list" data-md-scrollfix>
 770
 771
 772
 773
 774
 775     <li class="md-nav__item">
 776       <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
 777         Writing a module
 778       </a>
 779     </li>
 780
 781
 782
 783
 784
 785
 786
 787     <li class="md-nav__item">
 788       <a href="../../javascript/new-api_data-structures/" class="md-nav__link">
 789         Data Structures
 790       </a>
 791     </li>
 792
 793
 794
 795
 796
 797
 798
 799     <li class="md-nav__item">
 800       <a href="../../javascript/new-api_core/" class="md-nav__link">
 801         Core Functions
 802       </a>
 803     </li>
 804
 805
 806
 807
 808
 809
 810
 811     <li class="md-nav__item">
 812       <a href="../../javascript/new-api_dom/" class="md-nav__link">
 813         DOM
 814       </a>
 815     </li>
 816
 817
 818
 819
 820
 821
 822
 823     <li class="md-nav__item">
 824       <a href="../../javascript/new-api_events/" class="md-nav__link">
 825         Event Handling
 826       </a>
 827     </li>
 828
 829
 830
 831
 832
 833
 834
 835     <li class="md-nav__item">
 836       <a href="../../javascript/new-api_ajax/" class="md-nav__link">
 837         Ajax
 838       </a>
 839     </li>
 840
 841
 842
 843
 844
 845
 846
 847     <li class="md-nav__item">
 848       <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
 849         Dialogs
 850       </a>
 851     </li>
 852
 853
 854
 855
 856
 857
 858
 859     <li class="md-nav__item">
 860       <a href="../../javascript/new-api_browser/" class="md-nav__link">
 861         Browser and Screen Sizes
 862       </a>
 863     </li>
 864
 865
 866
 867
 868
 869
 870
 871     <li class="md-nav__item">
 872       <a href="../../javascript/new-api_ui/" class="md-nav__link">
 873         User Interface
 874       </a>
 875     </li>
 876
 877
 878
 879         </ul>
 880       </nav>
 881     </li>
 882
 883
 884
 885
 886
 887
 888
 889     <li class="md-nav__item">
 890       <a href="../../javascript/legacy-api/" class="md-nav__link">
 891         Legacy API
 892       </a>
 893     </li>
 894
 895
 896
 897
 898
 899
 900
 901     <li class="md-nav__item">
 902       <a href="../../javascript/helper-functions/" class="md-nav__link">
 903         Helper Functions
 904       </a>
 905     </li>
 906
 907
 908
 909
 910
 911
 912
 913     <li class="md-nav__item">
 914       <a href="../../javascript/code-snippets/" class="md-nav__link">
 915         Code Snippets
 916       </a>
 917     </li>
 918
 919
 920
 921         </ul>
 922       </nav>
 923     </li>
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935     <li class="md-nav__item md-nav__item--nested">
 936
 937
 938         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 939
 940       <label class="md-nav__link" for="__nav_5">
 941         Package Components
 942         <span class="md-nav__icon md-icon"></span>
 943       </label>
 944       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 945         <label class="md-nav__title" for="__nav_5">
 946           <span class="md-nav__icon md-icon"></span>
 947           Package Components
 948         </label>
 949         <ul class="md-nav__list" data-md-scrollfix>
 950
 951
 952
 953
 954
 955     <li class="md-nav__item">
 956       <a href="../../package/package-xml/" class="md-nav__link">
 957         package.xml
 958       </a>
 959     </li>
 960
 961
 962
 963
 964
 965
 966
 967
 968     <li class="md-nav__item md-nav__item--nested">
 969
 970
 971         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
 972
 973       <label class="md-nav__link" for="__nav_5_2">
 974         PIPs
 975         <span class="md-nav__icon md-icon"></span>
 976       </label>
 977       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 978         <label class="md-nav__title" for="__nav_5_2">
 979           <span class="md-nav__icon md-icon"></span>
 980           PIPs
 981         </label>
 982         <ul class="md-nav__list" data-md-scrollfix>
 983
 984
 985
 986
 987
 988     <li class="md-nav__item">
 989       <a href="../../package/pip/" class="md-nav__link">
 990         Overview
 991       </a>
 992     </li>
 993
 994
 995
 996
 997
 998
 999
1000     <li class="md-nav__item">
1001       <a href="../../package/pip/acl-option/" class="md-nav__link">
1002         aclOption
1003       </a>
1004     </li>
1005
1006
1007
1008
1009
1010
1011
1012     <li class="md-nav__item">
1013       <a href="../../package/pip/acp-menu/" class="md-nav__link">
1014         acpMenu
1015       </a>
1016     </li>
1017
1018
1019
1020
1021
1022
1023
1024     <li class="md-nav__item">
1025       <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1026         acpSearchProvider
1027       </a>
1028     </li>
1029
1030
1031
1032
1033
1034
1035
1036     <li class="md-nav__item">
1037       <a href="../../package/pip/acp-template/" class="md-nav__link">
1038         acpTemplate
1039       </a>
1040     </li>
1041
1042
1043
1044
1045
1046
1047
1048     <li class="md-nav__item">
1049       <a href="../../package/pip/bbcode/" class="md-nav__link">
1050         bbcode
1051       </a>
1052     </li>
1053
1054
1055
1056
1057
1058
1059
1060     <li class="md-nav__item">
1061       <a href="../../package/pip/box/" class="md-nav__link">
1062         box
1063       </a>
1064     </li>
1065
1066
1067
1068
1069
1070
1071
1072     <li class="md-nav__item">
1073       <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1074         clipboardAction
1075       </a>
1076     </li>
1077
1078
1079
1080
1081
1082
1083
1084     <li class="md-nav__item">
1085       <a href="../../package/pip/core-object/" class="md-nav__link">
1086         coreObject
1087       </a>
1088     </li>
1089
1090
1091
1092
1093
1094
1095
1096     <li class="md-nav__item">
1097       <a href="../../package/pip/cronjob/" class="md-nav__link">
1098         cronjob
1099       </a>
1100     </li>
1101
1102
1103
1104
1105
1106
1107
1108     <li class="md-nav__item">
1109       <a href="../../package/pip/event-listener/" class="md-nav__link">
1110         eventListener
1111       </a>
1112     </li>
1113
1114
1115
1116
1117
1118
1119
1120     <li class="md-nav__item">
1121       <a href="../../package/pip/file/" class="md-nav__link">
1122         file
1123       </a>
1124     </li>
1125
1126
1127
1128
1129
1130
1131
1132     <li class="md-nav__item">
1133       <a href="../../package/pip/language/" class="md-nav__link">
1134         language
1135       </a>
1136     </li>
1137
1138
1139
1140
1141
1142
1143
1144     <li class="md-nav__item">
1145       <a href="../../package/pip/media-provider/" class="md-nav__link">
1146         mediaProvider
1147       </a>
1148     </li>
1149
1150
1151
1152
1153
1154
1155
1156     <li class="md-nav__item">
1157       <a href="../../package/pip/menu/" class="md-nav__link">
1158         menu
1159       </a>
1160     </li>
1161
1162
1163
1164
1165
1166
1167
1168     <li class="md-nav__item">
1169       <a href="../../package/pip/menu-item/" class="md-nav__link">
1170         menuItem
1171       </a>
1172     </li>
1173
1174
1175
1176
1177
1178
1179
1180     <li class="md-nav__item">
1181       <a href="../../package/pip/object-type/" class="md-nav__link">
1182         objectType
1183       </a>
1184     </li>
1185
1186
1187
1188
1189
1190
1191
1192     <li class="md-nav__item">
1193       <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1194         objectTypeDefinition
1195       </a>
1196     </li>
1197
1198
1199
1200
1201
1202
1203
1204     <li class="md-nav__item">
1205       <a href="../../package/pip/option/" class="md-nav__link">
1206         option
1207       </a>
1208     </li>
1209
1210
1211
1212
1213
1214
1215
1216     <li class="md-nav__item">
1217       <a href="../../package/pip/page/" class="md-nav__link">
1218         page
1219       </a>
1220     </li>
1221
1222
1223
1224
1225
1226
1227
1228     <li class="md-nav__item">
1229       <a href="../../package/pip/pip/" class="md-nav__link">
1230         pip
1231       </a>
1232     </li>
1233
1234
1235
1236
1237
1238
1239
1240     <li class="md-nav__item">
1241       <a href="../../package/pip/script/" class="md-nav__link">
1242         script
1243       </a>
1244     </li>
1245
1246
1247
1248
1249
1250
1251
1252     <li class="md-nav__item">
1253       <a href="../../package/pip/smiley/" class="md-nav__link">
1254         smiley
1255       </a>
1256     </li>
1257
1258
1259
1260
1261
1262
1263
1264     <li class="md-nav__item">
1265       <a href="../../package/pip/sql/" class="md-nav__link">
1266         sql
1267       </a>
1268     </li>
1269
1270
1271
1272
1273
1274
1275
1276     <li class="md-nav__item">
1277       <a href="../../package/pip/style/" class="md-nav__link">
1278         style
1279       </a>
1280     </li>
1281
1282
1283
1284
1285
1286
1287
1288     <li class="md-nav__item">
1289       <a href="../../package/pip/template/" class="md-nav__link">
1290         template
1291       </a>
1292     </li>
1293
1294
1295
1296
1297
1298
1299
1300     <li class="md-nav__item">
1301       <a href="../../package/pip/template-listener/" class="md-nav__link">
1302         templateListener
1303       </a>
1304     </li>
1305
1306
1307
1308
1309
1310
1311
1312     <li class="md-nav__item">
1313       <a href="../../package/pip/user-group-option/" class="md-nav__link">
1314         userGroupOption
1315       </a>
1316     </li>
1317
1318
1319
1320
1321
1322
1323
1324     <li class="md-nav__item">
1325       <a href="../../package/pip/user-menu/" class="md-nav__link">
1326         userMenu
1327       </a>
1328     </li>
1329
1330
1331
1332
1333
1334
1335
1336     <li class="md-nav__item">
1337       <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1338         userNotificationEvent
1339       </a>
1340     </li>
1341
1342
1343
1344
1345
1346
1347
1348     <li class="md-nav__item">
1349       <a href="../../package/pip/user-option/" class="md-nav__link">
1350         userOption
1351       </a>
1352     </li>
1353
1354
1355
1356
1357
1358
1359
1360     <li class="md-nav__item">
1361       <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1362         userProfileMenu
1363       </a>
1364     </li>
1365
1366
1367
1368         </ul>
1369       </nav>
1370     </li>
1371
1372
1373
1374
1375
1376
1377
1378     <li class="md-nav__item">
1379       <a href="../../package/database-php-api/" class="md-nav__link">
1380         Database PHP API
1381       </a>
1382     </li>
1383
1384
1385
1386         </ul>
1387       </nav>
1388     </li>
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400     <li class="md-nav__item md-nav__item--nested">
1401
1402
1403         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1404
1405       <label class="md-nav__link" for="__nav_6">
1406         Migration
1407         <span class="md-nav__icon md-icon"></span>
1408       </label>
1409       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1410         <label class="md-nav__title" for="__nav_6">
1411           <span class="md-nav__icon md-icon"></span>
1412           Migration
1413         </label>
1414         <ul class="md-nav__list" data-md-scrollfix>
1415
1416
1417
1418
1419
1420
1421     <li class="md-nav__item md-nav__item--nested">
1422
1423
1424         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1425
1426       <label class="md-nav__link" for="__nav_6_1">
1427         Migrating from WSC 5.3
1428         <span class="md-nav__icon md-icon"></span>
1429       </label>
1430       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1431         <label class="md-nav__title" for="__nav_6_1">
1432           <span class="md-nav__icon md-icon"></span>
1433           Migrating from WSC 5.3
1434         </label>
1435         <ul class="md-nav__list" data-md-scrollfix>
1436
1437
1438
1439
1440
1441     <li class="md-nav__item">
1442       <a href="../../migration/wsc53/php/" class="md-nav__link">
1443         PHP API
1444       </a>
1445     </li>
1446
1447
1448
1449
1450
1451
1452
1453     <li class="md-nav__item">
1454       <a href="../../migration/wsc53/session/" class="md-nav__link">
1455         Session Handling and Authentication
1456       </a>
1457     </li>
1458
1459
1460
1461
1462
1463
1464
1465     <li class="md-nav__item">
1466       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1467         JavaScript
1468       </a>
1469     </li>
1470
1471
1472
1473
1474
1475
1476
1477     <li class="md-nav__item">
1478       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1479         Templates
1480       </a>
1481     </li>
1482
1483
1484
1485
1486
1487
1488
1489     <li class="md-nav__item">
1490       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1491         Third Party Libraries
1492       </a>
1493     </li>
1494
1495
1496
1497         </ul>
1498       </nav>
1499     </li>
1500
1501
1502
1503
1504
1505
1506
1507
1508     <li class="md-nav__item md-nav__item--nested">
1509
1510
1511         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1512
1513       <label class="md-nav__link" for="__nav_6_2">
1514         Migrating from WSC 5.2
1515         <span class="md-nav__icon md-icon"></span>
1516       </label>
1517       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1518         <label class="md-nav__title" for="__nav_6_2">
1519           <span class="md-nav__icon md-icon"></span>
1520           Migrating from WSC 5.2
1521         </label>
1522         <ul class="md-nav__list" data-md-scrollfix>
1523
1524
1525
1526
1527
1528     <li class="md-nav__item">
1529       <a href="../../migration/wsc52/php/" class="md-nav__link">
1530         PHP API
1531       </a>
1532     </li>
1533
1534
1535
1536
1537
1538
1539
1540     <li class="md-nav__item">
1541       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1542         Templates and Languages
1543       </a>
1544     </li>
1545
1546
1547
1548
1549
1550
1551
1552     <li class="md-nav__item">
1553       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1554         Third Party Libraries
1555       </a>
1556     </li>
1557
1558
1559
1560         </ul>
1561       </nav>
1562     </li>
1563
1564
1565
1566
1567
1568
1569
1570
1571     <li class="md-nav__item md-nav__item--nested">
1572
1573
1574         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1575
1576       <label class="md-nav__link" for="__nav_6_3">
1577         Migrating from WSC 3.1
1578         <span class="md-nav__icon md-icon"></span>
1579       </label>
1580       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1581         <label class="md-nav__title" for="__nav_6_3">
1582           <span class="md-nav__icon md-icon"></span>
1583           Migrating from WSC 3.1
1584         </label>
1585         <ul class="md-nav__list" data-md-scrollfix>
1586
1587
1588
1589
1590
1591     <li class="md-nav__item">
1592       <a href="../../migration/wsc31/php/" class="md-nav__link">
1593         PHP API
1594       </a>
1595     </li>
1596
1597
1598
1599         </ul>
1600       </nav>
1601     </li>
1602
1603
1604
1605
1606
1607
1608
1609
1610     <li class="md-nav__item md-nav__item--nested">
1611
1612
1613         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1614
1615       <label class="md-nav__link" for="__nav_6_4">
1616         Migrating from WSC 3.0
1617         <span class="md-nav__icon md-icon"></span>
1618       </label>
1619       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1620         <label class="md-nav__title" for="__nav_6_4">
1621           <span class="md-nav__icon md-icon"></span>
1622           Migrating from WSC 3.0
1623         </label>
1624         <ul class="md-nav__list" data-md-scrollfix>
1625
1626
1627
1628
1629
1630     <li class="md-nav__item">
1631       <a href="../../migration/wsc30/php/" class="md-nav__link">
1632         PHP API
1633       </a>
1634     </li>
1635
1636
1637
1638
1639
1640
1641
1642     <li class="md-nav__item">
1643       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1644         JavaScript API
1645       </a>
1646     </li>
1647
1648
1649
1650
1651
1652
1653
1654     <li class="md-nav__item">
1655       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1656         Templates
1657       </a>
1658     </li>
1659
1660
1661
1662
1663
1664
1665
1666     <li class="md-nav__item">
1667       <a href="../../migration/wsc30/css/" class="md-nav__link">
1668         CSS
1669       </a>
1670     </li>
1671
1672
1673
1674
1675
1676
1677
1678     <li class="md-nav__item">
1679       <a href="../../migration/wsc30/package/" class="md-nav__link">
1680         Package Components
1681       </a>
1682     </li>
1683
1684
1685
1686         </ul>
1687       </nav>
1688     </li>
1689
1690
1691
1692
1693
1694
1695
1696
1697     <li class="md-nav__item md-nav__item--nested">
1698
1699
1700         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1701
1702       <label class="md-nav__link" for="__nav_6_5">
1703         Migrating from WCF 2.1
1704         <span class="md-nav__icon md-icon"></span>
1705       </label>
1706       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1707         <label class="md-nav__title" for="__nav_6_5">
1708           <span class="md-nav__icon md-icon"></span>
1709           Migrating from WCF 2.1
1710         </label>
1711         <ul class="md-nav__list" data-md-scrollfix>
1712
1713
1714
1715
1716
1717     <li class="md-nav__item">
1718       <a href="../../migration/wcf21/php/" class="md-nav__link">
1719         PHP API
1720       </a>
1721     </li>
1722
1723
1724
1725
1726
1727
1728
1729     <li class="md-nav__item">
1730       <a href="../../migration/wcf21/templates/" class="md-nav__link">
1731         Templates
1732       </a>
1733     </li>
1734
1735
1736
1737
1738
1739
1740
1741     <li class="md-nav__item">
1742       <a href="../../migration/wcf21/css/" class="md-nav__link">
1743         CSS
1744       </a>
1745     </li>
1746
1747
1748
1749
1750
1751
1752
1753     <li class="md-nav__item">
1754       <a href="../../migration/wcf21/package/" class="md-nav__link">
1755         Package Components
1756       </a>
1757     </li>
1758
1759
1760
1761         </ul>
1762       </nav>
1763     </li>
1764
1765
1766
1767         </ul>
1768       </nav>
1769     </li>
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781     <li class="md-nav__item md-nav__item--nested">
1782
1783
1784         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1785
1786       <label class="md-nav__link" for="__nav_7">
1787         Tutorials
1788         <span class="md-nav__icon md-icon"></span>
1789       </label>
1790       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1791         <label class="md-nav__title" for="__nav_7">
1792           <span class="md-nav__icon md-icon"></span>
1793           Tutorials
1794         </label>
1795         <ul class="md-nav__list" data-md-scrollfix>
1796
1797
1798
1799
1800
1801
1802     <li class="md-nav__item md-nav__item--nested">
1803
1804
1805         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1806
1807       <label class="md-nav__link" for="__nav_7_1">
1808         Tutorial Series
1809         <span class="md-nav__icon md-icon"></span>
1810       </label>
1811       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1812         <label class="md-nav__title" for="__nav_7_1">
1813           <span class="md-nav__icon md-icon"></span>
1814           Tutorial Series
1815         </label>
1816         <ul class="md-nav__list" data-md-scrollfix>
1817
1818
1819
1820
1821
1822     <li class="md-nav__item">
1823       <a href="../../tutorial/series/overview/" class="md-nav__link">
1824         Overview
1825       </a>
1826     </li>
1827
1828
1829
1830
1831
1832
1833
1834     <li class="md-nav__item">
1835       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1836         Part 1
1837       </a>
1838     </li>
1839
1840
1841
1842
1843
1844
1845
1846     <li class="md-nav__item">
1847       <a href="../../tutorial/series/part_2/" class="md-nav__link">
1848         Part 2
1849       </a>
1850     </li>
1851
1852
1853
1854
1855
1856
1857
1858     <li class="md-nav__item">
1859       <a href="../../tutorial/series/part_3/" class="md-nav__link">
1860         Part 3
1861       </a>
1862     </li>
1863
1864
1865
1866         </ul>
1867       </nav>
1868     </li>
1869
1870
1871
1872         </ul>
1873       </nav>
1874     </li>
1875
1876
1877
1878   </ul>
1879 </nav>
1880                   </div>
1881                 </div>
1882               </div>
1883
1884
1885
1886               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1887                 <div class="md-sidebar__scrollwrap">
1888                   <div class="md-sidebar__inner">
1889
1890 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1891
1892
1893
1894
1895
1896     <label class="md-nav__title" for="__toc">
1897       <span class="md-nav__icon md-icon"></span>
1898       Table of contents
1899     </label>
1900     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1901
1902         <li class="md-nav__item">
1903   <a href="#general-code-style" class="md-nav__link">
1904     General Code Style
1905   </a>
1906
1907     <nav class="md-nav" aria-label="General Code Style">
1908       <ul class="md-nav__list">
1909
1910           <li class="md-nav__item">
1911   <a href="#naming-conventions" class="md-nav__link">
1912     Naming conventions
1913   </a>
1914
1915 </li>
1916
1917           <li class="md-nav__item">
1918   <a href="#arrays" class="md-nav__link">
1919     Arrays
1920   </a>
1921
1922 </li>
1923
1924           <li class="md-nav__item">
1925   <a href="#ternary-operator" class="md-nav__link">
1926     Ternary Operator
1927   </a>
1928
1929 </li>
1930
1931           <li class="md-nav__item">
1932   <a href="#whitespaces" class="md-nav__link">
1933     Whitespaces
1934   </a>
1935
1936 </li>
1937
1938       </ul>
1939     </nav>
1940
1941 </li>
1942
1943         <li class="md-nav__item">
1944   <a href="#classes" class="md-nav__link">
1945     Classes
1946   </a>
1947
1948     <nav class="md-nav" aria-label="Classes">
1949       <ul class="md-nav__list">
1950
1951           <li class="md-nav__item">
1952   <a href="#referencing-class-names" class="md-nav__link">
1953     Referencing Class Names
1954   </a>
1955
1956 </li>
1957
1958           <li class="md-nav__item">
1959   <a href="#static-getters-of-databaseobject-classes" class="md-nav__link">
1960     Static Getters (of DatabaseObject Classes)
1961   </a>
1962
1963 </li>
1964
1965           <li class="md-nav__item">
1966   <a href="#long-method-calls" class="md-nav__link">
1967     Long method calls
1968   </a>
1969
1970 </li>
1971
1972       </ul>
1973     </nav>
1974
1975 </li>
1976
1977     </ul>
1978
1979 </nav>
1980                   </div>
1981                 </div>
1982               </div>
1983
1984
1985           <div class="md-content" data-md-component="content">
1986             <article class="md-content__inner md-typeset">
1987
1988
1989                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/code-style.md" title="Edit this page" class="md-content__button md-icon">
1990                     <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>
1991                   </a>
1992
1993
1994                 <h1 id="code-style">Code Style<a class="headerlink" href="#code-style" title="Permanent link">#</a></h1>
1995 <div class="admonition info">
1996 <p class="admonition-title">The following code style conventions are used by us for our own packages. While you do not have to follow every rule, you are encouraged to do so.</p>
1997 </div>
1998 <p>For information about how to document your code, please refer to the <a href="../code-style-documentation/">documentation page</a>.</p>
1999 <h2 id="general-code-style">General Code Style<a class="headerlink" href="#general-code-style" title="Permanent link">#</a></h2>
2000 <h3 id="naming-conventions">Naming conventions<a class="headerlink" href="#naming-conventions" title="Permanent link">#</a></h3>
2001 <p>The relevant naming conventions are:</p>
2002 <ul>
2003 <li><strong>Upper camel case</strong>:
2004   The first letters of all compound words are written in upper case.</li>
2005 <li><strong>Lower camel case</strong>:
2006   The first letters of compound words are written in upper case, except for the first letter which is written in lower case.</li>
2007 <li><strong>Screaming snake case</strong>:
2008   All letters are written in upper case and compound words are separated by underscores.</li>
2009 </ul>
2010 <table>
2011 <thead>
2012 <tr>
2013 <th>Type</th>
2014 <th>Convention</th>
2015 <th>Example</th>
2016 </tr>
2017 </thead>
2018 <tbody>
2019 <tr>
2020 <td>Variable</td>
2021 <td>lower camel case</td>
2022 <td><code>$variableName</code></td>
2023 </tr>
2024 <tr>
2025 <td>Class</td>
2026 <td>upper camel case</td>
2027 <td><code>class UserGroupEditor</code></td>
2028 </tr>
2029 <tr>
2030 <td>Properties</td>
2031 <td>lower camel case</td>
2032 <td><code>public $propertyName</code></td>
2033 </tr>
2034 <tr>
2035 <td>Method</td>
2036 <td>lower camel case</td>
2037 <td><code>public function getObjectByName()</code></td>
2038 </tr>
2039 <tr>
2040 <td>Constant</td>
2041 <td>screaming snake case</td>
2042 <td><code>MODULE_USER_THING</code></td>
2043 </tr>
2044 </tbody>
2045 </table>
2046 <h3 id="arrays">Arrays<a class="headerlink" href="#arrays" title="Permanent link">#</a></h3>
2047 <p>For arrays, use the short array syntax introduced with PHP 5.4.
2048 The following example illustrates the different cases that can occur when working with arrays and how to format them:</p>
2049 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2050
2051 <span class="nv">$empty</span> <span class="o">=</span> <span class="p">[];</span>
2052
2053 <span class="nv">$oneElement</span> <span class="o">=</span> <span class="p">[</span><span class="mi">1</span><span class="p">];</span>
2054 <span class="nv">$multipleElements</span> <span class="o">=</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">];</span>
2055
2056 <span class="nv">$oneElementWithKey</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;firstElement&#39;</span> <span class="o">=&gt;</span> <span class="mi">1</span><span class="p">];</span>
2057 <span class="nv">$multipleElementsWithKey</span> <span class="o">=</span> <span class="p">[</span>
2058     <span class="s1">&#39;firstElement&#39;</span> <span class="o">=&gt;</span> <span class="mi">1</span><span class="p">,</span>
2059     <span class="s1">&#39;secondElement&#39;</span> <span class="o">=&gt;</span> <span class="mi">2</span><span class="p">,</span>
2060     <span class="s1">&#39;thirdElement&#39;</span> <span class="o">=&gt;</span> <span class="mi">3</span>
2061 <span class="p">];</span>
2062 </code></pre></div>
2063 <h3 id="ternary-operator">Ternary Operator<a class="headerlink" href="#ternary-operator" title="Permanent link">#</a></h3>
2064 <p>The ternary operator can be used for short conditioned assignments:</p>
2065 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2066
2067 <span class="nv">$name</span> <span class="o">=</span> <span class="nb">isset</span><span class="p">(</span><span class="nv">$tagArgs</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">])</span> <span class="o">?</span> <span class="nv">$tagArgs</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">]</span> <span class="o">:</span> <span class="s1">&#39;default&#39;</span><span class="p">;</span>
2068 </code></pre></div>
2069 <p>The condition and the values should be short so that the code does not result in a very long line which thus decreases the readability compared to an <code>if-else</code> statement.</p>
2070 <p>Parentheses may only be used around the condition and not around the whole statement:</p>
2071 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2072
2073 <span class="c1">// do not do it like this</span>
2074 <span class="nv">$name</span> <span class="o">=</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$tagArgs</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">])</span> <span class="o">?</span> <span class="nv">$tagArgs</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">]</span> <span class="o">:</span> <span class="s1">&#39;default&#39;</span><span class="p">);</span>
2075 </code></pre></div>
2076 <p>Parentheses around the conditions may not be used to wrap simple function calls:</p>
2077 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2078
2079 <span class="c1">// do not do it like this</span>
2080 <span class="nv">$name</span> <span class="o">=</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$tagArgs</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">]))</span> <span class="o">?</span> <span class="nv">$tagArgs</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">]</span> <span class="o">:</span> <span class="s1">&#39;default&#39;</span><span class="p">;</span>
2081 </code></pre></div>
2082 <p>but have to be used for comparisons or other binary operators:</p>
2083 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2084
2085 <span class="nv">$value</span> <span class="o">=</span> <span class="p">(</span><span class="nv">$otherValue</span> <span class="o">&gt;</span> <span class="nv">$upperLimit</span><span class="p">)</span> <span class="o">?</span> <span class="nv">$additionalValue</span> <span class="o">:</span> <span class="nv">$otherValue</span><span class="p">;</span>
2086 </code></pre></div>
2087 <p>If you need to use more than one binary operator, use an <code>if-else</code> statement.</p>
2088 <p>The same rules apply to assigning array values:</p>
2089 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2090
2091 <span class="nv">$values</span> <span class="o">=</span> <span class="p">[</span>
2092     <span class="s1">&#39;first&#39;</span> <span class="o">=&gt;</span> <span class="nv">$firstValue</span><span class="p">,</span>
2093     <span class="s1">&#39;second&#39;</span> <span class="o">=&gt;</span> <span class="nv">$secondToggle</span> <span class="o">?</span> <span class="nv">$secondValueA</span> <span class="o">:</span> <span class="nv">$secondValueB</span><span class="p">,</span>
2094     <span class="s1">&#39;third&#39;</span> <span class="o">=&gt;</span> <span class="p">(</span><span class="nv">$thirdToogle</span> <span class="o">&gt;</span> <span class="mi">13</span><span class="p">)</span> <span class="o">?</span> <span class="nv">$thirdToogleA</span> <span class="o">:</span> <span class="nv">$thirdToogleB</span>
2095 <span class="p">];</span>
2096 </code></pre></div>
2097 <p>or return values:</p>
2098 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2099
2100 <span class="k">return</span> <span class="nb">isset</span><span class="p">(</span><span class="nv">$tagArgs</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">])</span> <span class="o">?</span> <span class="nv">$tagArgs</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">]</span> <span class="o">:</span> <span class="s1">&#39;default&#39;</span><span class="p">;</span>
2101 </code></pre></div>
2102 <h3 id="whitespaces">Whitespaces<a class="headerlink" href="#whitespaces" title="Permanent link">#</a></h3>
2103 <p>You have to put a whitespace <em>in front</em> of the following things:</p>
2104 <ul>
2105 <li>equal sign in assignments: <code>$x = 1;</code></li>
2106 <li>comparison operators: <code>$x == 1</code></li>
2107 <li>opening bracket of a block <code>public function test() {</code></li>
2108 </ul>
2109 <p>You have to put a whitespace <em>behind</em> the following things:</p>
2110 <ul>
2111 <li>equal sign in assignments: <code>$x = 1;</code></li>
2112 <li>comparison operators: <code>$x == 1</code></li>
2113 <li>comma in a function/method parameter list if the comma is not followed by a line break: <code>public function test($a, $b) {</code></li>
2114 <li><code>if</code>, <code>for</code>, <code>foreach</code>, <code>while</code>: <code>if ($x == 1)</code></li>
2115 </ul>
2116 <h2 id="classes">Classes<a class="headerlink" href="#classes" title="Permanent link">#</a></h2>
2117 <h3 id="referencing-class-names">Referencing Class Names<a class="headerlink" href="#referencing-class-names" title="Permanent link">#</a></h3>
2118 <p>If you have to reference a class name inside a php file, you have to use the <code>class</code> keyword.</p>
2119 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2120
2121 <span class="c1">// not like this</span>
2122 <span class="nv">$className</span> <span class="o">=</span> <span class="s1">&#39;wcf\data\example\Example&#39;</span><span class="p">;</span>
2123
2124 <span class="c1">// like this</span>
2125 <span class="k">use</span> <span class="nx">wcf\data\example\Example</span><span class="p">;</span>
2126 <span class="nv">$className</span> <span class="o">=</span> <span class="nx">Example</span><span class="o">::</span><span class="na">class</span><span class="p">;</span>
2127 </code></pre></div>
2128 <h3 id="static-getters-of-databaseobject-classes">Static Getters (of <code>DatabaseObject</code> Classes)<a class="headerlink" href="#static-getters-of-databaseobject-classes" title="Permanent link">#</a></h3>
2129 <p>Some database objects provide static getters, either if they are decorators or for a unique combination of database table columns, like <code>wcf\data\box\Box::getBoxByIdentifier()</code>:</p>
2130 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2131 <span class="k">namespace</span> <span class="nx">wcf\data\box</span><span class="p">;</span>
2132 <span class="k">use</span> <span class="nx">wcf\data\DatabaseObject</span><span class="p">;</span>
2133 <span class="k">use</span> <span class="nx">wcf\system\WCF</span><span class="p">;</span>
2134
2135 <span class="k">class</span> <span class="nc">Box</span> <span class="k">extends</span> <span class="nx">DatabaseObject</span> <span class="p">{</span>
2136     <span class="sd">/**</span>
2137 <span class="sd">     * Returns the box with the given identifier.</span>
2138 <span class="sd">     *</span>
2139 <span class="sd">     * @param   string      $identifier</span>
2140 <span class="sd">     * @return  Box|null</span>
2141 <span class="sd">     */</span>
2142     <span class="k">public</span> <span class="k">static</span> <span class="k">function</span> <span class="nf">getBoxByIdentifier</span><span class="p">(</span><span class="nv">$identifier</span><span class="p">)</span> <span class="p">{</span>
2143         <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT  *</span>
2144 <span class="s2">            FROM    wcf&quot;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s2">&quot;_box</span>
2145 <span class="s2">            WHERE   identifier = ?&quot;</span><span class="p">;</span>
2146         <span class="nv">$statement</span> <span class="o">=</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">prepareStatement</span><span class="p">(</span><span class="nv">$sql</span><span class="p">);</span>
2147         <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">([</span><span class="nv">$identifier</span><span class="p">]);</span>
2148
2149         <span class="k">return</span> <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">fetchObject</span><span class="p">(</span><span class="nx">self</span><span class="o">::</span><span class="na">class</span><span class="p">);</span>
2150     <span class="p">}</span>
2151 <span class="p">}</span>
2152 </code></pre></div>
2153 <p>Such methods should always either return the desired object or <code>null</code> if the object does not exist.
2154 <code>wcf\system\database\statement\PreparedStatement::fetchObject()</code> already takes care of this distinction so that its return value can simply be returned by such methods.</p>
2155 <p>The name of such getters should generally follow the convention <code>get{object type}By{column or other description}</code>.</p>
2156 <h3 id="long-method-calls">Long method calls<a class="headerlink" href="#long-method-calls" title="Permanent link">#</a></h3>
2157 <p>In some instances, methods with many argument have to be called which can result in lines of code like this one:</p>
2158 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2159
2160 <span class="nx">\wcf\system\search\SearchIndexManager</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">set</span><span class="p">(</span><span class="s1">&#39;com.woltlab.wcf.article&#39;</span><span class="p">,</span> <span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">articleContentID</span><span class="p">,</span> <span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">content</span><span class="p">,</span> <span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">title</span><span class="p">,</span> <span class="nv">$articles</span><span class="p">[</span><span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">articleID</span><span class="p">]</span><span class="o">-&gt;</span><span class="na">time</span><span class="p">,</span> <span class="nv">$articles</span><span class="p">[</span><span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">articleID</span><span class="p">]</span><span class="o">-&gt;</span><span class="na">userID</span><span class="p">,</span> <span class="nv">$articles</span><span class="p">[</span><span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">articleID</span><span class="p">]</span><span class="o">-&gt;</span><span class="na">username</span><span class="p">,</span> <span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">languageID</span><span class="p">,</span> <span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">teaser</span><span class="p">);</span>
2161 </code></pre></div>
2162 <p>which is hardly readable.
2163 Therefore, the line must be split into multiple lines with each argument in a separate line:</p>
2164 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2165
2166 <span class="nx">\wcf\system\search\SearchIndexManager</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">set</span><span class="p">(</span>
2167     <span class="s1">&#39;com.woltlab.wcf.article&#39;</span><span class="p">,</span>
2168     <span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">articleContentID</span><span class="p">,</span>
2169     <span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">content</span><span class="p">,</span>
2170     <span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">title</span><span class="p">,</span>
2171     <span class="nv">$articles</span><span class="p">[</span><span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">articleID</span><span class="p">]</span><span class="o">-&gt;</span><span class="na">time</span><span class="p">,</span>
2172     <span class="nv">$articles</span><span class="p">[</span><span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">articleID</span><span class="p">]</span><span class="o">-&gt;</span><span class="na">userID</span><span class="p">,</span>
2173     <span class="nv">$articles</span><span class="p">[</span><span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">articleID</span><span class="p">]</span><span class="o">-&gt;</span><span class="na">username</span><span class="p">,</span>
2174     <span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">languageID</span><span class="p">,</span>
2175     <span class="nv">$articleContent</span><span class="o">-&gt;</span><span class="na">teaser</span>
2176 <span class="p">);</span>
2177 </code></pre></div>
2178 <p>In general, this rule applies to the following methods:</p>
2179 <ul>
2180 <li><code>wcf\system\edit\EditHistoryManager::add()</code></li>
2181 <li><code>wcf\system\message\quote\MessageQuoteManager::addQuote()</code></li>
2182 <li><code>wcf\system\message\quote\MessageQuoteManager::getQuoteID()</code></li>
2183 <li><code>wcf\system\search\SearchIndexManager::set()</code></li>
2184 <li><code>wcf\system\user\object\watch\UserObjectWatchHandler::updateObject()</code></li>
2185 <li><code>wcf\system\user\notification\UserNotificationHandler::fireEvent()</code></li>
2186 </ul>
2187
2188
2189
2190
2191 <hr>
2192 <div class="md-source-date">
2193   <small>
2194
2195       Last update: 2021-01-08
2196
2197   </small>
2198 </div>
2199
2200
2201
2202
2203
2204
2205
2206
2207             </article>
2208           </div>
2209         </div>
2210       </main>
2211
2212
2213 <footer class="md-footer">
2214
2215     <nav class="md-footer__inner md-grid" aria-label="Footer">
2216
2217         <a href="../api/sitemaps/" class="md-footer__link md-footer__link--prev" rel="prev">
2218           <div class="md-footer__button md-icon">
2219             <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>
2220           </div>
2221           <div class="md-footer__title">
2222             <div class="md-ellipsis">
2223               <span class="md-footer__direction">
2224                 Previous
2225               </span>
2226               Sitemaps
2227             </div>
2228           </div>
2229         </a>
2230
2231
2232         <a href="../apps/" class="md-footer__link md-footer__link--next" rel="next">
2233           <div class="md-footer__title">
2234             <div class="md-ellipsis">
2235               <span class="md-footer__direction">
2236                 Next
2237               </span>
2238               Apps
2239             </div>
2240           </div>
2241           <div class="md-footer__button md-icon">
2242             <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>
2243           </div>
2244         </a>
2245
2246     </nav>
2247
2248   <div class="md-footer-meta md-typeset">
2249     <div class="md-footer-meta__inner md-grid">
2250       <div class="md-footer-copyright">
2251
2252           <div class="md-footer-copyright__highlight">
2253             Copyright © 2020 WoltLab GmbH
2254           </div>
2255
2256         Made with
2257         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2258           Material for MkDocs
2259         </a>
2260
2261       </div>
2262       <div class="md-footer-copyright">
2263         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2264         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2265 </div>
2266     </div>
2267   </div>
2268 </footer>
2269
2270     </div>
2271     <div class="md-dialog" data-md-component="dialog">
2272       <div class="md-dialog__inner md-typeset"></div>
2273     </div>
2274     <script id="__config" type="application/json">{"base": "../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../assets/javascripts/workers/search.fb4a9340.min.js", "version": {"provider": "mike"}}</script>
2275
2276
2277       <script src="../../assets/javascripts/bundle.5cf3e710.min.js"></script>
2278
2279
2280   </body>
2281 </html>