5.4/php/api/caches_persistent-caches/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="canonical" href="https://docs.woltlab.com/5.4/php/api/caches_persistent-caches/">
  13
  14       <link rel="icon" href="../../../assets/default.favicon.ico">
  15       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.2">
  16
  17
  18
  19         <title>Persistent Caches - WoltLab Suite Documentation</title>
  20
  21
  22
  23       <link rel="stylesheet" href="../../../assets/stylesheets/main.6f955dcd.min.css">
  24
  25
  26         <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css">
  27
  28
  29
  30           <meta name="theme-color" content="#009485">
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  41
  42
  43
  44
  45
  46   </head>
  47
  48
  49
  50
  51
  52
  53
  54     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  55
  56
  57     <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  58
  59     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  60     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  61     <label class="md-overlay" for="__drawer"></label>
  62     <div data-md-component="skip">
  63
  64
  65         <a href="#persistent-caches" class="md-skip">
  66           Skip to content
  67         </a>
  68
  69     </div>
  70     <div data-md-component="announce">
  71
  72         <aside class="md-announce">
  73           <div class="md-announce__inner md-grid md-typeset">
  74
  75     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  76
  77           </div>
  78         </aside>
  79
  80     </div>
  81
  82       <header class="md-header" data-md-component="header">
  83   <nav class="md-header__inner md-grid" aria-label="Header">
  84     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  85
  86   <img src="../../../assets/logo.png" alt="logo">
  87
  88     </a>
  89     <label class="md-header__button md-icon" for="__drawer">
  90       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  91     </label>
  92     <div class="md-header__title" data-md-component="header-title">
  93       <div class="md-header__ellipsis">
  94         <div class="md-header__topic">
  95           <span class="md-ellipsis">
  96             WoltLab Suite Documentation
  97           </span>
  98         </div>
  99         <div class="md-header__topic" data-md-component="header-topic">
 100           <span class="md-ellipsis">
 101
 102               Persistent Caches
 103
 104           </span>
 105         </div>
 106       </div>
 107     </div>
 108
 109
 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.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>
 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.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>
 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 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 175   <label class="md-nav__title" for="__drawer">
 176     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 177
 178   <img src="../../../assets/logo.png" alt="logo">
 179
 180     </a>
 181     WoltLab Suite Documentation
 182   </label>
 183
 184     <div class="md-nav__source">
 185
 186 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 187   <div class="md-source__icon md-icon">
 188
 189     <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>
 190   </div>
 191   <div class="md-source__repository">
 192     GitHub
 193   </div>
 194 </a>
 195     </div>
 196
 197   <ul class="md-nav__list" data-md-scrollfix>
 198
 199
 200
 201
 202
 203
 204
 205
 206     <li class="md-nav__item">
 207       <a href="../../../getting-started/" class="md-nav__link">
 208         Getting Started
 209       </a>
 210     </li>
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 225
 226
 227         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
 228
 229       <label class="md-nav__link" for="__nav_2">
 230         PHP API
 231         <span class="md-nav__icon md-icon"></span>
 232       </label>
 233       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 234         <label class="md-nav__title" for="__nav_2">
 235           <span class="md-nav__icon md-icon"></span>
 236           PHP API
 237         </label>
 238         <ul class="md-nav__list" data-md-scrollfix>
 239
 240
 241
 242
 243
 244     <li class="md-nav__item">
 245       <a href="../../pages/" class="md-nav__link">
 246         Pages
 247       </a>
 248     </li>
 249
 250
 251
 252
 253
 254
 255
 256     <li class="md-nav__item">
 257       <a href="../../database-objects/" class="md-nav__link">
 258         Database Objects
 259       </a>
 260     </li>
 261
 262
 263
 264
 265
 266
 267
 268     <li class="md-nav__item">
 269       <a href="../../database-access/" class="md-nav__link">
 270         Database Access
 271       </a>
 272     </li>
 273
 274
 275
 276
 277
 278
 279
 280     <li class="md-nav__item">
 281       <a href="../../exceptions/" class="md-nav__link">
 282         Exceptions
 283       </a>
 284     </li>
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295     <li class="md-nav__item md-nav__item--active 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" checked>
 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
 316
 317
 318     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 319
 320
 321         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" checked>
 322
 323       <label class="md-nav__link" for="__nav_2_5_1">
 324         Caches
 325         <span class="md-nav__icon md-icon"></span>
 326       </label>
 327       <nav class="md-nav" aria-label="Caches" data-md-level="3">
 328         <label class="md-nav__title" for="__nav_2_5_1">
 329           <span class="md-nav__icon md-icon"></span>
 330           Caches
 331         </label>
 332         <ul class="md-nav__list" data-md-scrollfix>
 333
 334
 335
 336
 337
 338     <li class="md-nav__item">
 339       <a href="../caches/" class="md-nav__link">
 340         Overview
 341       </a>
 342     </li>
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352     <li class="md-nav__item md-nav__item--active">
 353
 354       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 355
 356
 357
 358
 359
 360         <label class="md-nav__link md-nav__link--active" for="__toc">
 361           Persistent Caches
 362           <span class="md-nav__icon md-icon"></span>
 363         </label>
 364
 365       <a href="./" class="md-nav__link md-nav__link--active">
 366         Persistent Caches
 367       </a>
 368
 369
 370 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 371
 372
 373
 374
 375
 376
 377     <label class="md-nav__title" for="__toc">
 378       <span class="md-nav__icon md-icon"></span>
 379       Table of contents
 380     </label>
 381     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 382
 383         <li class="md-nav__item">
 384   <a href="#abstractcachebuilder" class="md-nav__link">
 385     AbstractCacheBuilder
 386   </a>
 387
 388     <nav class="md-nav" aria-label="AbstractCacheBuilder">
 389       <ul class="md-nav__list">
 390
 391           <li class="md-nav__item">
 392   <a href="#getdataarray-parameters-string-arrayindex-array" class="md-nav__link">
 393     getData(array $parameters = [], string $arrayIndex = ''): array
 394   </a>
 395
 396 </li>
 397
 398           <li class="md-nav__item">
 399   <a href="#getmaxlifetime-int" class="md-nav__link">
 400     getMaxLifetime(): int
 401   </a>
 402
 403 </li>
 404
 405           <li class="md-nav__item">
 406   <a href="#resetarray-parameters-void" class="md-nav__link">
 407     reset(array $parameters = []): void
 408   </a>
 409
 410 </li>
 411
 412           <li class="md-nav__item">
 413   <a href="#rebuildarray-parameters-array" class="md-nav__link">
 414     rebuild(array $parameters): array
 415   </a>
 416
 417 </li>
 418
 419       </ul>
 420     </nav>
 421
 422 </li>
 423
 424     </ul>
 425
 426 </nav>
 427
 428     </li>
 429
 430
 431
 432
 433
 434
 435
 436     <li class="md-nav__item">
 437       <a href="../caches_runtime-caches/" class="md-nav__link">
 438         Runtime Caches
 439       </a>
 440     </li>
 441
 442
 443
 444         </ul>
 445       </nav>
 446     </li>
 447
 448
 449
 450
 451
 452
 453
 454     <li class="md-nav__item">
 455       <a href="../comments/" class="md-nav__link">
 456         Comments
 457       </a>
 458     </li>
 459
 460
 461
 462
 463
 464
 465
 466     <li class="md-nav__item">
 467       <a href="../cronjobs/" class="md-nav__link">
 468         Cronjobs
 469       </a>
 470     </li>
 471
 472
 473
 474
 475
 476
 477
 478     <li class="md-nav__item">
 479       <a href="../events/" class="md-nav__link">
 480         Events
 481       </a>
 482     </li>
 483
 484
 485
 486
 487
 488
 489
 490
 491     <li class="md-nav__item md-nav__item--nested">
 492
 493
 494         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 495
 496       <label class="md-nav__link" for="__nav_2_5_5">
 497         Form Builder
 498         <span class="md-nav__icon md-icon"></span>
 499       </label>
 500       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 501         <label class="md-nav__title" for="__nav_2_5_5">
 502           <span class="md-nav__icon md-icon"></span>
 503           Form Builder
 504         </label>
 505         <ul class="md-nav__list" data-md-scrollfix>
 506
 507
 508
 509
 510
 511     <li class="md-nav__item">
 512       <a href="../form_builder/overview/" class="md-nav__link">
 513         Overview
 514       </a>
 515     </li>
 516
 517
 518
 519
 520
 521
 522
 523     <li class="md-nav__item">
 524       <a href="../form_builder/structure/" class="md-nav__link">
 525         Structure
 526       </a>
 527     </li>
 528
 529
 530
 531
 532
 533
 534
 535     <li class="md-nav__item">
 536       <a href="../form_builder/form_fields/" class="md-nav__link">
 537         Fields
 538       </a>
 539     </li>
 540
 541
 542
 543
 544
 545
 546
 547     <li class="md-nav__item">
 548       <a href="../form_builder/validation_data/" class="md-nav__link">
 549         Validation and Data
 550       </a>
 551     </li>
 552
 553
 554
 555
 556
 557
 558
 559     <li class="md-nav__item">
 560       <a href="../form_builder/dependencies/" class="md-nav__link">
 561         Dependencies
 562       </a>
 563     </li>
 564
 565
 566
 567         </ul>
 568       </nav>
 569     </li>
 570
 571
 572
 573
 574
 575
 576
 577     <li class="md-nav__item">
 578       <a href="../package_installation_plugins/" class="md-nav__link">
 579         Package Installation Plugins
 580       </a>
 581     </li>
 582
 583
 584
 585
 586
 587
 588
 589     <li class="md-nav__item">
 590       <a href="../user_activity_points/" class="md-nav__link">
 591         User Activity Points
 592       </a>
 593     </li>
 594
 595
 596
 597
 598
 599
 600
 601     <li class="md-nav__item">
 602       <a href="../user_notifications/" class="md-nav__link">
 603         User Notifications
 604       </a>
 605     </li>
 606
 607
 608
 609
 610
 611
 612
 613     <li class="md-nav__item">
 614       <a href="../sitemaps/" class="md-nav__link">
 615         Sitemaps
 616       </a>
 617     </li>
 618
 619
 620
 621         </ul>
 622       </nav>
 623     </li>
 624
 625
 626
 627
 628
 629
 630
 631     <li class="md-nav__item">
 632       <a href="../../code-style/" class="md-nav__link">
 633         Code Style
 634       </a>
 635     </li>
 636
 637
 638
 639
 640
 641
 642
 643     <li class="md-nav__item">
 644       <a href="../../apps/" class="md-nav__link">
 645         Apps
 646       </a>
 647     </li>
 648
 649
 650
 651
 652
 653
 654
 655     <li class="md-nav__item">
 656       <a href="../../gdpr/" class="md-nav__link">
 657         GDPR
 658       </a>
 659     </li>
 660
 661
 662
 663         </ul>
 664       </nav>
 665     </li>
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677     <li class="md-nav__item md-nav__item--nested">
 678
 679
 680         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 681
 682       <label class="md-nav__link" for="__nav_3">
 683         Languages, Templates & CSS
 684         <span class="md-nav__icon md-icon"></span>
 685       </label>
 686       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 687         <label class="md-nav__title" for="__nav_3">
 688           <span class="md-nav__icon md-icon"></span>
 689           Languages, Templates & CSS
 690         </label>
 691         <ul class="md-nav__list" data-md-scrollfix>
 692
 693
 694
 695
 696
 697     <li class="md-nav__item">
 698       <a href="../../../view/languages/" class="md-nav__link">
 699         Languages
 700       </a>
 701     </li>
 702
 703
 704
 705
 706
 707
 708
 709     <li class="md-nav__item">
 710       <a href="../../../view/templates/" class="md-nav__link">
 711         Templates
 712       </a>
 713     </li>
 714
 715
 716
 717
 718
 719
 720
 721     <li class="md-nav__item">
 722       <a href="../../../view/template-plugins/" class="md-nav__link">
 723         Template Plugins
 724       </a>
 725     </li>
 726
 727
 728
 729
 730
 731
 732
 733     <li class="md-nav__item">
 734       <a href="../../../view/css/" class="md-nav__link">
 735         CSS
 736       </a>
 737     </li>
 738
 739
 740
 741         </ul>
 742       </nav>
 743     </li>
 744
 745
 746
 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" type="checkbox" id="__nav_4" >
 759
 760       <label class="md-nav__link" for="__nav_4">
 761         TypeScript and JavaScript API
 762         <span class="md-nav__icon md-icon"></span>
 763       </label>
 764       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 765         <label class="md-nav__title" for="__nav_4">
 766           <span class="md-nav__icon md-icon"></span>
 767           TypeScript and JavaScript 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/general-usage/" class="md-nav__link">
 777         General Usage
 778       </a>
 779     </li>
 780
 781
 782
 783
 784
 785
 786
 787     <li class="md-nav__item">
 788       <a href="../../../javascript/typescript/" class="md-nav__link">
 789         TypeScript
 790       </a>
 791     </li>
 792
 793
 794
 795
 796
 797
 798
 799
 800     <li class="md-nav__item md-nav__item--nested">
 801
 802
 803         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 804
 805       <label class="md-nav__link" for="__nav_4_3">
 806         New API
 807         <span class="md-nav__icon md-icon"></span>
 808       </label>
 809       <nav class="md-nav" aria-label="New API" data-md-level="2">
 810         <label class="md-nav__title" for="__nav_4_3">
 811           <span class="md-nav__icon md-icon"></span>
 812           New API
 813         </label>
 814         <ul class="md-nav__list" data-md-scrollfix>
 815
 816
 817
 818
 819
 820     <li class="md-nav__item">
 821       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 822         Writing a module
 823       </a>
 824     </li>
 825
 826
 827
 828
 829
 830
 831
 832     <li class="md-nav__item">
 833       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 834         Data Structures
 835       </a>
 836     </li>
 837
 838
 839
 840
 841
 842
 843
 844     <li class="md-nav__item">
 845       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 846         Core Functions
 847       </a>
 848     </li>
 849
 850
 851
 852
 853
 854
 855
 856     <li class="md-nav__item">
 857       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 858         DOM
 859       </a>
 860     </li>
 861
 862
 863
 864
 865
 866
 867
 868     <li class="md-nav__item">
 869       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 870         Event Handling
 871       </a>
 872     </li>
 873
 874
 875
 876
 877
 878
 879
 880     <li class="md-nav__item">
 881       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 882         Ajax
 883       </a>
 884     </li>
 885
 886
 887
 888
 889
 890
 891
 892     <li class="md-nav__item">
 893       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 894         Dialogs
 895       </a>
 896     </li>
 897
 898
 899
 900
 901
 902
 903
 904     <li class="md-nav__item">
 905       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 906         Browser and Screen Sizes
 907       </a>
 908     </li>
 909
 910
 911
 912
 913
 914
 915
 916     <li class="md-nav__item">
 917       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 918         User Interface
 919       </a>
 920     </li>
 921
 922
 923
 924         </ul>
 925       </nav>
 926     </li>
 927
 928
 929
 930
 931
 932
 933
 934     <li class="md-nav__item">
 935       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 936         Legacy API
 937       </a>
 938     </li>
 939
 940
 941
 942
 943
 944
 945
 946     <li class="md-nav__item">
 947       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 948         Helper Functions
 949       </a>
 950     </li>
 951
 952
 953
 954
 955
 956
 957
 958     <li class="md-nav__item">
 959       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 960         Code Snippets
 961       </a>
 962     </li>
 963
 964
 965
 966         </ul>
 967       </nav>
 968     </li>
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980     <li class="md-nav__item md-nav__item--nested">
 981
 982
 983         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 984
 985       <label class="md-nav__link" for="__nav_5">
 986         Package Components
 987         <span class="md-nav__icon md-icon"></span>
 988       </label>
 989       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 990         <label class="md-nav__title" for="__nav_5">
 991           <span class="md-nav__icon md-icon"></span>
 992           Package Components
 993         </label>
 994         <ul class="md-nav__list" data-md-scrollfix>
 995
 996
 997
 998
 999
1000     <li class="md-nav__item">
1001       <a href="../../../package/package-xml/" class="md-nav__link">
1002         package.xml
1003       </a>
1004     </li>
1005
1006
1007
1008
1009
1010
1011
1012
1013     <li class="md-nav__item md-nav__item--nested">
1014
1015
1016         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1017
1018       <label class="md-nav__link" for="__nav_5_2">
1019         PIPs
1020         <span class="md-nav__icon md-icon"></span>
1021       </label>
1022       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1023         <label class="md-nav__title" for="__nav_5_2">
1024           <span class="md-nav__icon md-icon"></span>
1025           PIPs
1026         </label>
1027         <ul class="md-nav__list" data-md-scrollfix>
1028
1029
1030
1031
1032
1033     <li class="md-nav__item">
1034       <a href="../../../package/pip/" class="md-nav__link">
1035         Overview
1036       </a>
1037     </li>
1038
1039
1040
1041
1042
1043
1044
1045     <li class="md-nav__item">
1046       <a href="../../../package/pip/acl-option/" class="md-nav__link">
1047         aclOption
1048       </a>
1049     </li>
1050
1051
1052
1053
1054
1055
1056
1057     <li class="md-nav__item">
1058       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
1059         acpMenu
1060       </a>
1061     </li>
1062
1063
1064
1065
1066
1067
1068
1069     <li class="md-nav__item">
1070       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
1071         acpSearchProvider
1072       </a>
1073     </li>
1074
1075
1076
1077
1078
1079
1080
1081     <li class="md-nav__item">
1082       <a href="../../../package/pip/acp-template/" class="md-nav__link">
1083         acpTemplate
1084       </a>
1085     </li>
1086
1087
1088
1089
1090
1091
1092
1093     <li class="md-nav__item">
1094       <a href="../../../package/pip/bbcode/" class="md-nav__link">
1095         bbcode
1096       </a>
1097     </li>
1098
1099
1100
1101
1102
1103
1104
1105     <li class="md-nav__item">
1106       <a href="../../../package/pip/box/" class="md-nav__link">
1107         box
1108       </a>
1109     </li>
1110
1111
1112
1113
1114
1115
1116
1117     <li class="md-nav__item">
1118       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1119         clipboardAction
1120       </a>
1121     </li>
1122
1123
1124
1125
1126
1127
1128
1129     <li class="md-nav__item">
1130       <a href="../../../package/pip/core-object/" class="md-nav__link">
1131         coreObject
1132       </a>
1133     </li>
1134
1135
1136
1137
1138
1139
1140
1141     <li class="md-nav__item">
1142       <a href="../../../package/pip/cronjob/" class="md-nav__link">
1143         cronjob
1144       </a>
1145     </li>
1146
1147
1148
1149
1150
1151
1152
1153     <li class="md-nav__item">
1154       <a href="../../../package/pip/database/" class="md-nav__link">
1155         database
1156       </a>
1157     </li>
1158
1159
1160
1161
1162
1163
1164
1165     <li class="md-nav__item">
1166       <a href="../../../package/pip/event-listener/" class="md-nav__link">
1167         eventListener
1168       </a>
1169     </li>
1170
1171
1172
1173
1174
1175
1176
1177     <li class="md-nav__item">
1178       <a href="../../../package/pip/file/" class="md-nav__link">
1179         file
1180       </a>
1181     </li>
1182
1183
1184
1185
1186
1187
1188
1189     <li class="md-nav__item">
1190       <a href="../../../package/pip/language/" class="md-nav__link">
1191         language
1192       </a>
1193     </li>
1194
1195
1196
1197
1198
1199
1200
1201     <li class="md-nav__item">
1202       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1203         mediaProvider
1204       </a>
1205     </li>
1206
1207
1208
1209
1210
1211
1212
1213     <li class="md-nav__item">
1214       <a href="../../../package/pip/menu/" class="md-nav__link">
1215         menu
1216       </a>
1217     </li>
1218
1219
1220
1221
1222
1223
1224
1225     <li class="md-nav__item">
1226       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1227         menuItem
1228       </a>
1229     </li>
1230
1231
1232
1233
1234
1235
1236
1237     <li class="md-nav__item">
1238       <a href="../../../package/pip/object-type/" class="md-nav__link">
1239         objectType
1240       </a>
1241     </li>
1242
1243
1244
1245
1246
1247
1248
1249     <li class="md-nav__item">
1250       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1251         objectTypeDefinition
1252       </a>
1253     </li>
1254
1255
1256
1257
1258
1259
1260
1261     <li class="md-nav__item">
1262       <a href="../../../package/pip/option/" class="md-nav__link">
1263         option
1264       </a>
1265     </li>
1266
1267
1268
1269
1270
1271
1272
1273     <li class="md-nav__item">
1274       <a href="../../../package/pip/page/" class="md-nav__link">
1275         page
1276       </a>
1277     </li>
1278
1279
1280
1281
1282
1283
1284
1285     <li class="md-nav__item">
1286       <a href="../../../package/pip/pip/" class="md-nav__link">
1287         pip
1288       </a>
1289     </li>
1290
1291
1292
1293
1294
1295
1296
1297     <li class="md-nav__item">
1298       <a href="../../../package/pip/script/" class="md-nav__link">
1299         script
1300       </a>
1301     </li>
1302
1303
1304
1305
1306
1307
1308
1309     <li class="md-nav__item">
1310       <a href="../../../package/pip/smiley/" class="md-nav__link">
1311         smiley
1312       </a>
1313     </li>
1314
1315
1316
1317
1318
1319
1320
1321     <li class="md-nav__item">
1322       <a href="../../../package/pip/sql/" class="md-nav__link">
1323         sql
1324       </a>
1325     </li>
1326
1327
1328
1329
1330
1331
1332
1333     <li class="md-nav__item">
1334       <a href="../../../package/pip/style/" class="md-nav__link">
1335         style
1336       </a>
1337     </li>
1338
1339
1340
1341
1342
1343
1344
1345     <li class="md-nav__item">
1346       <a href="../../../package/pip/template/" class="md-nav__link">
1347         template
1348       </a>
1349     </li>
1350
1351
1352
1353
1354
1355
1356
1357     <li class="md-nav__item">
1358       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1359         templateListener
1360       </a>
1361     </li>
1362
1363
1364
1365
1366
1367
1368
1369     <li class="md-nav__item">
1370       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1371         userGroupOption
1372       </a>
1373     </li>
1374
1375
1376
1377
1378
1379
1380
1381     <li class="md-nav__item">
1382       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1383         userMenu
1384       </a>
1385     </li>
1386
1387
1388
1389
1390
1391
1392
1393     <li class="md-nav__item">
1394       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1395         userNotificationEvent
1396       </a>
1397     </li>
1398
1399
1400
1401
1402
1403
1404
1405     <li class="md-nav__item">
1406       <a href="../../../package/pip/user-option/" class="md-nav__link">
1407         userOption
1408       </a>
1409     </li>
1410
1411
1412
1413
1414
1415
1416
1417     <li class="md-nav__item">
1418       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1419         userProfileMenu
1420       </a>
1421     </li>
1422
1423
1424
1425         </ul>
1426       </nav>
1427     </li>
1428
1429
1430
1431
1432
1433
1434
1435     <li class="md-nav__item">
1436       <a href="../../../package/database-php-api/" class="md-nav__link">
1437         Database PHP API
1438       </a>
1439     </li>
1440
1441
1442
1443         </ul>
1444       </nav>
1445     </li>
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457     <li class="md-nav__item md-nav__item--nested">
1458
1459
1460         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1461
1462       <label class="md-nav__link" for="__nav_6">
1463         Migration
1464         <span class="md-nav__icon md-icon"></span>
1465       </label>
1466       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1467         <label class="md-nav__title" for="__nav_6">
1468           <span class="md-nav__icon md-icon"></span>
1469           Migration
1470         </label>
1471         <ul class="md-nav__list" data-md-scrollfix>
1472
1473
1474
1475
1476
1477
1478     <li class="md-nav__item md-nav__item--nested">
1479
1480
1481         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1482
1483       <label class="md-nav__link" for="__nav_6_1">
1484         Migrating from WSC 5.3
1485         <span class="md-nav__icon md-icon"></span>
1486       </label>
1487       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1488         <label class="md-nav__title" for="__nav_6_1">
1489           <span class="md-nav__icon md-icon"></span>
1490           Migrating from WSC 5.3
1491         </label>
1492         <ul class="md-nav__list" data-md-scrollfix>
1493
1494
1495
1496
1497
1498     <li class="md-nav__item">
1499       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1500         PHP API
1501       </a>
1502     </li>
1503
1504
1505
1506
1507
1508
1509
1510     <li class="md-nav__item">
1511       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1512         Session Handling and Authentication
1513       </a>
1514     </li>
1515
1516
1517
1518
1519
1520
1521
1522     <li class="md-nav__item">
1523       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1524         TypeScript and JavaScript
1525       </a>
1526     </li>
1527
1528
1529
1530
1531
1532
1533
1534     <li class="md-nav__item">
1535       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1536         Templates
1537       </a>
1538     </li>
1539
1540
1541
1542
1543
1544
1545
1546     <li class="md-nav__item">
1547       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1548         Third Party Libraries
1549       </a>
1550     </li>
1551
1552
1553
1554         </ul>
1555       </nav>
1556     </li>
1557
1558
1559
1560
1561
1562
1563
1564
1565     <li class="md-nav__item md-nav__item--nested">
1566
1567
1568         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1569
1570       <label class="md-nav__link" for="__nav_6_2">
1571         Migrating from WSC 5.2
1572         <span class="md-nav__icon md-icon"></span>
1573       </label>
1574       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1575         <label class="md-nav__title" for="__nav_6_2">
1576           <span class="md-nav__icon md-icon"></span>
1577           Migrating from WSC 5.2
1578         </label>
1579         <ul class="md-nav__list" data-md-scrollfix>
1580
1581
1582
1583
1584
1585     <li class="md-nav__item">
1586       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1587         PHP API
1588       </a>
1589     </li>
1590
1591
1592
1593
1594
1595
1596
1597     <li class="md-nav__item">
1598       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1599         Templates and Languages
1600       </a>
1601     </li>
1602
1603
1604
1605
1606
1607
1608
1609     <li class="md-nav__item">
1610       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1611         Third Party Libraries
1612       </a>
1613     </li>
1614
1615
1616
1617         </ul>
1618       </nav>
1619     </li>
1620
1621
1622
1623
1624
1625
1626
1627
1628     <li class="md-nav__item md-nav__item--nested">
1629
1630
1631         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1632
1633       <label class="md-nav__link" for="__nav_6_3">
1634         Migrating from WSC 3.1
1635         <span class="md-nav__icon md-icon"></span>
1636       </label>
1637       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1638         <label class="md-nav__title" for="__nav_6_3">
1639           <span class="md-nav__icon md-icon"></span>
1640           Migrating from WSC 3.1
1641         </label>
1642         <ul class="md-nav__list" data-md-scrollfix>
1643
1644
1645
1646
1647
1648     <li class="md-nav__item">
1649       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1650         PHP API
1651       </a>
1652     </li>
1653
1654
1655
1656         </ul>
1657       </nav>
1658     </li>
1659
1660
1661
1662
1663
1664
1665
1666
1667     <li class="md-nav__item md-nav__item--nested">
1668
1669
1670         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1671
1672       <label class="md-nav__link" for="__nav_6_4">
1673         Migrating from WSC 3.0
1674         <span class="md-nav__icon md-icon"></span>
1675       </label>
1676       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1677         <label class="md-nav__title" for="__nav_6_4">
1678           <span class="md-nav__icon md-icon"></span>
1679           Migrating from WSC 3.0
1680         </label>
1681         <ul class="md-nav__list" data-md-scrollfix>
1682
1683
1684
1685
1686
1687     <li class="md-nav__item">
1688       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1689         PHP API
1690       </a>
1691     </li>
1692
1693
1694
1695
1696
1697
1698
1699     <li class="md-nav__item">
1700       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1701         JavaScript API
1702       </a>
1703     </li>
1704
1705
1706
1707
1708
1709
1710
1711     <li class="md-nav__item">
1712       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1713         Templates
1714       </a>
1715     </li>
1716
1717
1718
1719
1720
1721
1722
1723     <li class="md-nav__item">
1724       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1725         CSS
1726       </a>
1727     </li>
1728
1729
1730
1731
1732
1733
1734
1735     <li class="md-nav__item">
1736       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1737         Package Components
1738       </a>
1739     </li>
1740
1741
1742
1743         </ul>
1744       </nav>
1745     </li>
1746
1747
1748
1749
1750
1751
1752
1753
1754     <li class="md-nav__item md-nav__item--nested">
1755
1756
1757         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1758
1759       <label class="md-nav__link" for="__nav_6_5">
1760         Migrating from WCF 2.1
1761         <span class="md-nav__icon md-icon"></span>
1762       </label>
1763       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1764         <label class="md-nav__title" for="__nav_6_5">
1765           <span class="md-nav__icon md-icon"></span>
1766           Migrating from WCF 2.1
1767         </label>
1768         <ul class="md-nav__list" data-md-scrollfix>
1769
1770
1771
1772
1773
1774     <li class="md-nav__item">
1775       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1776         PHP API
1777       </a>
1778     </li>
1779
1780
1781
1782
1783
1784
1785
1786     <li class="md-nav__item">
1787       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1788         Templates
1789       </a>
1790     </li>
1791
1792
1793
1794
1795
1796
1797
1798     <li class="md-nav__item">
1799       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1800         CSS
1801       </a>
1802     </li>
1803
1804
1805
1806
1807
1808
1809
1810     <li class="md-nav__item">
1811       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1812         Package Components
1813       </a>
1814     </li>
1815
1816
1817
1818         </ul>
1819       </nav>
1820     </li>
1821
1822
1823
1824         </ul>
1825       </nav>
1826     </li>
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838     <li class="md-nav__item md-nav__item--nested">
1839
1840
1841         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1842
1843       <label class="md-nav__link" for="__nav_7">
1844         Tutorials
1845         <span class="md-nav__icon md-icon"></span>
1846       </label>
1847       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1848         <label class="md-nav__title" for="__nav_7">
1849           <span class="md-nav__icon md-icon"></span>
1850           Tutorials
1851         </label>
1852         <ul class="md-nav__list" data-md-scrollfix>
1853
1854
1855
1856
1857
1858
1859     <li class="md-nav__item md-nav__item--nested">
1860
1861
1862         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1863
1864       <label class="md-nav__link" for="__nav_7_1">
1865         Tutorial Series
1866         <span class="md-nav__icon md-icon"></span>
1867       </label>
1868       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1869         <label class="md-nav__title" for="__nav_7_1">
1870           <span class="md-nav__icon md-icon"></span>
1871           Tutorial Series
1872         </label>
1873         <ul class="md-nav__list" data-md-scrollfix>
1874
1875
1876
1877
1878
1879     <li class="md-nav__item">
1880       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1881         Overview
1882       </a>
1883     </li>
1884
1885
1886
1887
1888
1889
1890
1891     <li class="md-nav__item">
1892       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1893         Part 1
1894       </a>
1895     </li>
1896
1897
1898
1899
1900
1901
1902
1903     <li class="md-nav__item">
1904       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1905         Part 2
1906       </a>
1907     </li>
1908
1909
1910
1911
1912
1913
1914
1915     <li class="md-nav__item">
1916       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1917         Part 3
1918       </a>
1919     </li>
1920
1921
1922
1923
1924
1925
1926
1927     <li class="md-nav__item">
1928       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
1929         Part 4
1930       </a>
1931     </li>
1932
1933
1934
1935
1936
1937
1938
1939     <li class="md-nav__item">
1940       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
1941         Part 5
1942       </a>
1943     </li>
1944
1945
1946
1947         </ul>
1948       </nav>
1949     </li>
1950
1951
1952
1953         </ul>
1954       </nav>
1955     </li>
1956
1957
1958
1959   </ul>
1960 </nav>
1961                   </div>
1962                 </div>
1963               </div>
1964
1965
1966
1967               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1968                 <div class="md-sidebar__scrollwrap">
1969                   <div class="md-sidebar__inner">
1970
1971 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1972
1973
1974
1975
1976
1977
1978     <label class="md-nav__title" for="__toc">
1979       <span class="md-nav__icon md-icon"></span>
1980       Table of contents
1981     </label>
1982     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1983
1984         <li class="md-nav__item">
1985   <a href="#abstractcachebuilder" class="md-nav__link">
1986     AbstractCacheBuilder
1987   </a>
1988
1989     <nav class="md-nav" aria-label="AbstractCacheBuilder">
1990       <ul class="md-nav__list">
1991
1992           <li class="md-nav__item">
1993   <a href="#getdataarray-parameters-string-arrayindex-array" class="md-nav__link">
1994     getData(array $parameters = [], string $arrayIndex = ''): array
1995   </a>
1996
1997 </li>
1998
1999           <li class="md-nav__item">
2000   <a href="#getmaxlifetime-int" class="md-nav__link">
2001     getMaxLifetime(): int
2002   </a>
2003
2004 </li>
2005
2006           <li class="md-nav__item">
2007   <a href="#resetarray-parameters-void" class="md-nav__link">
2008     reset(array $parameters = []): void
2009   </a>
2010
2011 </li>
2012
2013           <li class="md-nav__item">
2014   <a href="#rebuildarray-parameters-array" class="md-nav__link">
2015     rebuild(array $parameters): array
2016   </a>
2017
2018 </li>
2019
2020       </ul>
2021     </nav>
2022
2023 </li>
2024
2025     </ul>
2026
2027 </nav>
2028                   </div>
2029                 </div>
2030               </div>
2031
2032
2033           <div class="md-content" data-md-component="content">
2034             <article class="md-content__inner md-typeset">
2035
2036
2037                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/api/caches_persistent-caches.md" title="Edit this page" class="md-content__button md-icon">
2038                     <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>
2039                   </a>
2040
2041
2042                 <h1 id="persistent-caches">Persistent Caches<a class="headerlink" href="#persistent-caches" title="Permanent link">#</a></h1>
2043 <p>Relational databases are designed around the principle of normalized data that
2044 is organized across clearly separated tables with defined releations between
2045 data rows. While this enables you to quickly access and modify individual rows
2046 and columns, it can create the problem that re-assembling this data into a more
2047 complex structure can be quite expensive.</p>
2048 <p>For example, the user group permissions are stored for each user group and each
2049 permissions separately, but in order to be applied, they need to be fetched and
2050 the cumulative values across all user groups of an user have to be calculated.
2051 These repetitive tasks on barely ever changing data make them an excellent
2052 target for caching, where all sub-sequent requests are accelerated because they
2053 no longer have to perform the same expensive calculations every time.</p>
2054 <p>It is easy to get lost in the realm of caching, especially when it comes to the
2055 decision if you should use a cache or not. When in doubt, you should opt to not
2056 use them, because they also come at a hidden cost that cannot be expressed through
2057 simple SQL query counts. If you haven't already, it is recommended that you read
2058 the <a href="../caches/">introduction article on caching</a> first, it provides a bit
2059 of background on caches and examples that should help you in your decision.</p>
2060 <h2 id="abstractcachebuilder"><code>AbstractCacheBuilder</code><a class="headerlink" href="#abstractcachebuilder" title="Permanent link">#</a></h2>
2061 <p>Every cache builder should derive from the base class <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/cache/builder/AbstractCacheBuilder.class.php">AbstractCacheBuilder</a>
2062 that already implements the mandatory interface <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/cache/builder/ICacheBuilder.class.php">ICacheBuilder</a>.</p>
2063 <div class="titledCodeBox">
2064     <div class="codeBoxTitle">
2065         <code>php</code>
2066         <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/files/lib/system/cache/builder/ExampleCacheBuilder.class.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5z"/></svg></span></a>
2067     </div>
2068     ```php/api/caches/ExampleCacheBuilder.class.php
2069     ```
2070 </div>
2071
2072 <p>Reading data from your cache builder is quite simple and follows a consistent
2073 pattern. The callee only needs to know the name of the cache builder, which
2074 parameters it requires and how the returned data looks like. It does not need
2075 to know how the data is retrieve, where it was stored, nor if it had to be
2076 rebuild due to the maximum lifetime.</p>
2077 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2078 <span class="normal">2</span>
2079 <span class="normal">3</span>
2080 <span class="normal">4</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2081 <span class="k">use</span> <span class="nx">wcf\system\cache\builder\ExampleCacheBuilder</span><span class="p">;</span>
2082
2083 <span class="nv">$data</span> <span class="o">=</span> <span class="nx">ExampleCacheBuilder</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getData</span><span class="p">(</span><span class="nv">$parameters</span><span class="p">);</span>
2084 </code></pre></div>
2085 </td></tr></table>
2086 <h3 id="getdataarray-parameters-string-arrayindex-array"><code>getData(array $parameters = [], string $arrayIndex = ''): array</code><a class="headerlink" href="#getdataarray-parameters-string-arrayindex-array" title="Permanent link">#</a></h3>
2087 <p>Retrieves the data from the cache builder, the <code>$parameters</code> array is automatically
2088 sorted to allow sub-sequent requests for the same parameters to be recognized,
2089 even if their parameters are mixed. For example, <code>getData([1, 2])</code> and <code>getData([2, 1])</code>
2090 will have the same exact result.</p>
2091 <p>The optional <code>$arrayIndex</code> will instruct the cache builder to retrieve the data
2092 and examine if the returned data is an array that has the index <code>$arrayIndex</code>.
2093 If it is set, the potion below this index is returned instead.</p>
2094 <h3 id="getmaxlifetime-int"><code>getMaxLifetime(): int</code><a class="headerlink" href="#getmaxlifetime-int" title="Permanent link">#</a></h3>
2095 <p>Returns the maximum lifetime of a cache in seconds. It can be controlled through
2096 the <code>protected $maxLifetime</code> property which defaults to <code>0</code>. Any cache that has
2097 a lifetime greater than 0 is automatically discarded when exceeding this age,
2098 otherwise it will remain forever until it is explicitly removed or invalidated.</p>
2099 <h3 id="resetarray-parameters-void"><code>reset(array $parameters = []): void</code><a class="headerlink" href="#resetarray-parameters-void" title="Permanent link">#</a></h3>
2100 <p>Invalidates a cache, the <code>$parameters</code> array will again be ordered using the same
2101 rules that are applied for <code>getData()</code>.</p>
2102 <h3 id="rebuildarray-parameters-array"><code>rebuild(array $parameters): array</code><a class="headerlink" href="#rebuildarray-parameters-array" title="Permanent link">#</a></h3>
2103 <p><em>This method is protected.</em></p>
2104 <p>This is the only method that a cache builder deriving from <code>AbstractCacheBuilder</code>
2105 has to implement and it will be invoked whenever the cache is required to be
2106 rebuild for whatever reason.</p>
2107
2108
2109
2110
2111 <hr>
2112 <div class="md-source-date">
2113   <small>
2114
2115       Last update: 2021-04-23
2116
2117   </small>
2118 </div>
2119
2120
2121
2122
2123
2124
2125
2126
2127             </article>
2128           </div>
2129         </div>
2130
2131       </main>
2132
2133
2134 <footer class="md-footer">
2135
2136     <nav class="md-footer__inner md-grid" aria-label="Footer">
2137
2138         <a href="../caches/" class="md-footer__link md-footer__link--prev" rel="prev">
2139           <div class="md-footer__button md-icon">
2140             <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>
2141           </div>
2142           <div class="md-footer__title">
2143             <div class="md-ellipsis">
2144               <span class="md-footer__direction">
2145                 Previous
2146               </span>
2147               Overview
2148             </div>
2149           </div>
2150         </a>
2151
2152
2153         <a href="../caches_runtime-caches/" class="md-footer__link md-footer__link--next" rel="next">
2154           <div class="md-footer__title">
2155             <div class="md-ellipsis">
2156               <span class="md-footer__direction">
2157                 Next
2158               </span>
2159               Runtime Caches
2160             </div>
2161           </div>
2162           <div class="md-footer__button md-icon">
2163             <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>
2164           </div>
2165         </a>
2166
2167     </nav>
2168
2169   <div class="md-footer-meta md-typeset">
2170     <div class="md-footer-meta__inner md-grid">
2171       <div class="md-footer-copyright">
2172
2173           <div class="md-footer-copyright__highlight">
2174             Copyright © 2020 WoltLab GmbH
2175           </div>
2176
2177         Made with
2178         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2179           Material for MkDocs
2180         </a>
2181
2182       </div>
2183       <div class="md-footer-copyright">
2184         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2185         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2186 </div>
2187     </div>
2188   </div>
2189 </footer>
2190
2191     </div>
2192     <div class="md-dialog" data-md-component="dialog">
2193       <div class="md-dialog__inner md-typeset"></div>
2194     </div>
2195     <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>
2196
2197
2198       <script src="../../../assets/javascripts/bundle.4ea5477f.min.js"></script>
2199
2200
2201   </body>
2202 </html>