3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>Persistent Caches - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ef6f36e2.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <script>function __prefix(e){return new URL(
"../../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
57 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
58 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
59 <label class=
"md-overlay" for=
"__drawer"></label>
60 <div data-md-component=
"skip">
63 <a href=
"#persistent-caches" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
84 <img src=
"../../../assets/logo.png" alt=
"logo">
87 <label class=
"md-header__button md-icon" for=
"__drawer">
88 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 <div class=
"md-header__title" data-md-component=
"header-title">
91 <div class=
"md-header__ellipsis">
92 <div class=
"md-header__topic">
93 <span class=
"md-ellipsis">
94 WoltLab Suite Documentation
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
109 <label class=
"md-header__button md-icon" for=
"__search">
110 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
113 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
114 <label class=
"md-search__overlay" for=
"__search"></label>
115 <div class=
"md-search__inner" role=
"search">
116 <form class=
"md-search__form" name=
"search">
117 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
118 <label class=
"md-search__icon md-icon" for=
"__search">
119 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
120 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
122 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
123 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
126 <div class=
"md-search__output">
127 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
128 <div class=
"md-search-result" data-md-component=
"search-result">
129 <div class=
"md-search-result__meta">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
142 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
143 <div class=
"md-source__icon md-icon">
145 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
166 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
167 <div class=
"md-sidebar__scrollwrap">
168 <div class=
"md-sidebar__inner">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
184 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
185 <div class=
"md-source__icon md-icon">
187 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../../getting-started/" class=
"md-nav__link">
222 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
225 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" checked
>
227 <label class=
"md-nav__link" for=
"__nav_2">
229 <span class=
"md-nav__icon md-icon"></span>
231 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
232 <label class=
"md-nav__title" for=
"__nav_2">
233 <span class=
"md-nav__icon md-icon"></span>
236 <ul class=
"md-nav__list" data-md-scrollfix
>
242 <li class=
"md-nav__item">
243 <a href=
"../../pages/" class=
"md-nav__link">
254 <li class=
"md-nav__item">
255 <a href=
"../../database-objects/" class=
"md-nav__link">
266 <li class=
"md-nav__item">
267 <a href=
"../../database-access/" class=
"md-nav__link">
278 <li class=
"md-nav__item">
279 <a href=
"../../exceptions/" class=
"md-nav__link">
293 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
296 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" checked
>
298 <label class=
"md-nav__link" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
302 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
303 <label class=
"md-nav__title" for=
"__nav_2_5">
304 <span class=
"md-nav__icon md-icon"></span>
307 <ul class=
"md-nav__list" data-md-scrollfix
>
316 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
319 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" checked
>
321 <label class=
"md-nav__link" for=
"__nav_2_5_1">
323 <span class=
"md-nav__icon md-icon"></span>
325 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
326 <label class=
"md-nav__title" for=
"__nav_2_5_1">
327 <span class=
"md-nav__icon md-icon"></span>
330 <ul class=
"md-nav__list" data-md-scrollfix
>
336 <li class=
"md-nav__item">
337 <a href=
"../caches/" class=
"md-nav__link">
350 <li class=
"md-nav__item md-nav__item--active">
352 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
357 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
359 <span class=
"md-nav__icon md-icon"></span>
362 <a href=
"./" class=
"md-nav__link md-nav__link--active">
367 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
373 <label class=
"md-nav__title" for=
"__toc">
374 <span class=
"md-nav__icon md-icon"></span>
377 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
379 <li class=
"md-nav__item">
380 <a href=
"#abstractcachebuilder" class=
"md-nav__link">
384 <nav class=
"md-nav" aria-label=
"AbstractCacheBuilder">
385 <ul class=
"md-nav__list">
387 <li class=
"md-nav__item">
388 <a href=
"#getdataarray-parameters-string-arrayindex-array" class=
"md-nav__link">
389 getData(array $parameters = [], string $arrayIndex = ''): array
394 <li class=
"md-nav__item">
395 <a href=
"#getmaxlifetime-int" class=
"md-nav__link">
396 getMaxLifetime(): int
401 <li class=
"md-nav__item">
402 <a href=
"#resetarray-parameters-void" class=
"md-nav__link">
403 reset(array $parameters = []): void
408 <li class=
"md-nav__item">
409 <a href=
"#rebuildarray-parameters-array" class=
"md-nav__link">
410 rebuild(array $parameters): array
432 <li class=
"md-nav__item">
433 <a href=
"../caches_runtime-caches/" class=
"md-nav__link">
450 <li class=
"md-nav__item">
451 <a href=
"../comments/" class=
"md-nav__link">
462 <li class=
"md-nav__item">
463 <a href=
"../cronjobs/" class=
"md-nav__link">
474 <li class=
"md-nav__item">
475 <a href=
"../events/" class=
"md-nav__link">
487 <li class=
"md-nav__item md-nav__item--nested">
490 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
492 <label class=
"md-nav__link" for=
"__nav_2_5_5">
494 <span class=
"md-nav__icon md-icon"></span>
496 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
497 <label class=
"md-nav__title" for=
"__nav_2_5_5">
498 <span class=
"md-nav__icon md-icon"></span>
501 <ul class=
"md-nav__list" data-md-scrollfix
>
507 <li class=
"md-nav__item">
508 <a href=
"../form_builder/overview/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../form_builder/structure/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../form_builder/form_fields/" class=
"md-nav__link">
543 <li class=
"md-nav__item">
544 <a href=
"../form_builder/validation_data/" class=
"md-nav__link">
555 <li class=
"md-nav__item">
556 <a href=
"../form_builder/dependencies/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../package_installation_plugins/" class=
"md-nav__link">
575 Package Installation Plugins
585 <li class=
"md-nav__item">
586 <a href=
"../user_activity_points/" class=
"md-nav__link">
597 <li class=
"md-nav__item">
598 <a href=
"../user_notifications/" class=
"md-nav__link">
609 <li class=
"md-nav__item">
610 <a href=
"../sitemaps/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../../code-style/" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"../../apps/" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"../../gdpr/" class=
"md-nav__link">
673 <li class=
"md-nav__item md-nav__item--nested">
676 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
678 <label class=
"md-nav__link" for=
"__nav_3">
679 Languages, Templates & CSS
680 <span class=
"md-nav__icon md-icon"></span>
682 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
683 <label class=
"md-nav__title" for=
"__nav_3">
684 <span class=
"md-nav__icon md-icon"></span>
685 Languages, Templates & CSS
687 <ul class=
"md-nav__list" data-md-scrollfix
>
693 <li class=
"md-nav__item">
694 <a href=
"../../../view/languages/" class=
"md-nav__link">
705 <li class=
"md-nav__item">
706 <a href=
"../../../view/templates/" class=
"md-nav__link">
717 <li class=
"md-nav__item">
718 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
729 <li class=
"md-nav__item">
730 <a href=
"../../../view/css/" class=
"md-nav__link">
751 <li class=
"md-nav__item md-nav__item--nested">
754 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
756 <label class=
"md-nav__link" for=
"__nav_4">
757 TypeScript and JavaScript API
758 <span class=
"md-nav__icon md-icon"></span>
760 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
761 <label class=
"md-nav__title" for=
"__nav_4">
762 <span class=
"md-nav__icon md-icon"></span>
763 TypeScript and JavaScript API
765 <ul class=
"md-nav__list" data-md-scrollfix
>
771 <li class=
"md-nav__item">
772 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
783 <li class=
"md-nav__item">
784 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
796 <li class=
"md-nav__item md-nav__item--nested">
799 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
801 <label class=
"md-nav__link" for=
"__nav_4_3">
803 <span class=
"md-nav__icon md-icon"></span>
805 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
806 <label class=
"md-nav__title" for=
"__nav_4_3">
807 <span class=
"md-nav__icon md-icon"></span>
810 <ul class=
"md-nav__list" data-md-scrollfix
>
816 <li class=
"md-nav__item">
817 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
828 <li class=
"md-nav__item">
829 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
840 <li class=
"md-nav__item">
841 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
852 <li class=
"md-nav__item">
853 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
864 <li class=
"md-nav__item">
865 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
876 <li class=
"md-nav__item">
877 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
888 <li class=
"md-nav__item">
889 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
900 <li class=
"md-nav__item">
901 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
902 Browser and Screen Sizes
912 <li class=
"md-nav__item">
913 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
930 <li class=
"md-nav__item">
931 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
942 <li class=
"md-nav__item">
943 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
954 <li class=
"md-nav__item">
955 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
976 <li class=
"md-nav__item md-nav__item--nested">
979 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
981 <label class=
"md-nav__link" for=
"__nav_5">
983 <span class=
"md-nav__icon md-icon"></span>
985 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
986 <label class=
"md-nav__title" for=
"__nav_5">
987 <span class=
"md-nav__icon md-icon"></span>
990 <ul class=
"md-nav__list" data-md-scrollfix
>
996 <li class=
"md-nav__item">
997 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
1009 <li class=
"md-nav__item md-nav__item--nested">
1012 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1014 <label class=
"md-nav__link" for=
"__nav_5_2">
1016 <span class=
"md-nav__icon md-icon"></span>
1018 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1019 <label class=
"md-nav__title" for=
"__nav_5_2">
1020 <span class=
"md-nav__icon md-icon"></span>
1023 <ul class=
"md-nav__list" data-md-scrollfix
>
1029 <li class=
"md-nav__item">
1030 <a href=
"../../../package/pip/" class=
"md-nav__link">
1041 <li class=
"md-nav__item">
1042 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
1053 <li class=
"md-nav__item">
1054 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
1065 <li class=
"md-nav__item">
1066 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
1077 <li class=
"md-nav__item">
1078 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1089 <li class=
"md-nav__item">
1090 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1101 <li class=
"md-nav__item">
1102 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1113 <li class=
"md-nav__item">
1114 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1125 <li class=
"md-nav__item">
1126 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1137 <li class=
"md-nav__item">
1138 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1149 <li class=
"md-nav__item">
1150 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1161 <li class=
"md-nav__item">
1162 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1173 <li class=
"md-nav__item">
1174 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1185 <li class=
"md-nav__item">
1186 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1197 <li class=
"md-nav__item">
1198 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1209 <li class=
"md-nav__item">
1210 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1221 <li class=
"md-nav__item">
1222 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1233 <li class=
"md-nav__item">
1234 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1245 <li class=
"md-nav__item">
1246 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1247 objectTypeDefinition
1257 <li class=
"md-nav__item">
1258 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1269 <li class=
"md-nav__item">
1270 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1281 <li class=
"md-nav__item">
1282 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1293 <li class=
"md-nav__item">
1294 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1305 <li class=
"md-nav__item">
1306 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1317 <li class=
"md-nav__item">
1318 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1329 <li class=
"md-nav__item">
1330 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1341 <li class=
"md-nav__item">
1342 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1353 <li class=
"md-nav__item">
1354 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1365 <li class=
"md-nav__item">
1366 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1377 <li class=
"md-nav__item">
1378 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1389 <li class=
"md-nav__item">
1390 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1391 userNotificationEvent
1401 <li class=
"md-nav__item">
1402 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1413 <li class=
"md-nav__item">
1414 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1431 <li class=
"md-nav__item">
1432 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1453 <li class=
"md-nav__item md-nav__item--nested">
1456 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1458 <label class=
"md-nav__link" for=
"__nav_6">
1460 <span class=
"md-nav__icon md-icon"></span>
1462 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1463 <label class=
"md-nav__title" for=
"__nav_6">
1464 <span class=
"md-nav__icon md-icon"></span>
1467 <ul class=
"md-nav__list" data-md-scrollfix
>
1474 <li class=
"md-nav__item md-nav__item--nested">
1477 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1479 <label class=
"md-nav__link" for=
"__nav_6_1">
1480 Migrating from WSC
5.3
1481 <span class=
"md-nav__icon md-icon"></span>
1483 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1484 <label class=
"md-nav__title" for=
"__nav_6_1">
1485 <span class=
"md-nav__icon md-icon"></span>
1486 Migrating from WSC
5.3
1488 <ul class=
"md-nav__list" data-md-scrollfix
>
1494 <li class=
"md-nav__item">
1495 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1506 <li class=
"md-nav__item">
1507 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1508 Session Handling and Authentication
1518 <li class=
"md-nav__item">
1519 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1520 TypeScript and JavaScript
1530 <li class=
"md-nav__item">
1531 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1542 <li class=
"md-nav__item">
1543 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1544 Third Party Libraries
1561 <li class=
"md-nav__item md-nav__item--nested">
1564 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1566 <label class=
"md-nav__link" for=
"__nav_6_2">
1567 Migrating from WSC
5.2
1568 <span class=
"md-nav__icon md-icon"></span>
1570 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1571 <label class=
"md-nav__title" for=
"__nav_6_2">
1572 <span class=
"md-nav__icon md-icon"></span>
1573 Migrating from WSC
5.2
1575 <ul class=
"md-nav__list" data-md-scrollfix
>
1581 <li class=
"md-nav__item">
1582 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1593 <li class=
"md-nav__item">
1594 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1595 Templates and Languages
1605 <li class=
"md-nav__item">
1606 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1607 Third Party Libraries
1624 <li class=
"md-nav__item md-nav__item--nested">
1627 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1629 <label class=
"md-nav__link" for=
"__nav_6_3">
1630 Migrating from WSC
3.1
1631 <span class=
"md-nav__icon md-icon"></span>
1633 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1634 <label class=
"md-nav__title" for=
"__nav_6_3">
1635 <span class=
"md-nav__icon md-icon"></span>
1636 Migrating from WSC
3.1
1638 <ul class=
"md-nav__list" data-md-scrollfix
>
1644 <li class=
"md-nav__item">
1645 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1663 <li class=
"md-nav__item md-nav__item--nested">
1666 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1668 <label class=
"md-nav__link" for=
"__nav_6_4">
1669 Migrating from WSC
3.0
1670 <span class=
"md-nav__icon md-icon"></span>
1672 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1673 <label class=
"md-nav__title" for=
"__nav_6_4">
1674 <span class=
"md-nav__icon md-icon"></span>
1675 Migrating from WSC
3.0
1677 <ul class=
"md-nav__list" data-md-scrollfix
>
1683 <li class=
"md-nav__item">
1684 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1695 <li class=
"md-nav__item">
1696 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1707 <li class=
"md-nav__item">
1708 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1719 <li class=
"md-nav__item">
1720 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1731 <li class=
"md-nav__item">
1732 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1750 <li class=
"md-nav__item md-nav__item--nested">
1753 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1755 <label class=
"md-nav__link" for=
"__nav_6_5">
1756 Migrating from WCF
2.1
1757 <span class=
"md-nav__icon md-icon"></span>
1759 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1760 <label class=
"md-nav__title" for=
"__nav_6_5">
1761 <span class=
"md-nav__icon md-icon"></span>
1762 Migrating from WCF
2.1
1764 <ul class=
"md-nav__list" data-md-scrollfix
>
1770 <li class=
"md-nav__item">
1771 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1782 <li class=
"md-nav__item">
1783 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1794 <li class=
"md-nav__item">
1795 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1806 <li class=
"md-nav__item">
1807 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1834 <li class=
"md-nav__item md-nav__item--nested">
1837 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1839 <label class=
"md-nav__link" for=
"__nav_7">
1841 <span class=
"md-nav__icon md-icon"></span>
1843 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1844 <label class=
"md-nav__title" for=
"__nav_7">
1845 <span class=
"md-nav__icon md-icon"></span>
1848 <ul class=
"md-nav__list" data-md-scrollfix
>
1855 <li class=
"md-nav__item md-nav__item--nested">
1858 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1860 <label class=
"md-nav__link" for=
"__nav_7_1">
1862 <span class=
"md-nav__icon md-icon"></span>
1864 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1865 <label class=
"md-nav__title" for=
"__nav_7_1">
1866 <span class=
"md-nav__icon md-icon"></span>
1869 <ul class=
"md-nav__list" data-md-scrollfix
>
1875 <li class=
"md-nav__item">
1876 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1887 <li class=
"md-nav__item">
1888 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1899 <li class=
"md-nav__item">
1900 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1911 <li class=
"md-nav__item">
1912 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1923 <li class=
"md-nav__item">
1924 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
1951 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1952 <div class=
"md-sidebar__scrollwrap">
1953 <div class=
"md-sidebar__inner">
1955 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1961 <label class=
"md-nav__title" for=
"__toc">
1962 <span class=
"md-nav__icon md-icon"></span>
1965 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1967 <li class=
"md-nav__item">
1968 <a href=
"#abstractcachebuilder" class=
"md-nav__link">
1969 AbstractCacheBuilder
1972 <nav class=
"md-nav" aria-label=
"AbstractCacheBuilder">
1973 <ul class=
"md-nav__list">
1975 <li class=
"md-nav__item">
1976 <a href=
"#getdataarray-parameters-string-arrayindex-array" class=
"md-nav__link">
1977 getData(array $parameters = [], string $arrayIndex = ''): array
1982 <li class=
"md-nav__item">
1983 <a href=
"#getmaxlifetime-int" class=
"md-nav__link">
1984 getMaxLifetime(): int
1989 <li class=
"md-nav__item">
1990 <a href=
"#resetarray-parameters-void" class=
"md-nav__link">
1991 reset(array $parameters = []): void
1996 <li class=
"md-nav__item">
1997 <a href=
"#rebuildarray-parameters-array" class=
"md-nav__link">
1998 rebuild(array $parameters): array
2016 <div class=
"md-content" data-md-component=
"content">
2017 <article class=
"md-content__inner md-typeset">
2020 <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">
2021 <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>
2025 <h1 id=
"persistent-caches">Persistent Caches
<a class=
"headerlink" href=
"#persistent-caches" title=
"Permanent link">#
</a></h1>
2026 <p>Relational databases are designed around the principle of normalized data that
2027 is organized across clearly separated tables with defined releations between
2028 data rows. While this enables you to quickly access and modify individual rows
2029 and columns, it can create the problem that re-assembling this data into a more
2030 complex structure can be quite expensive.
</p>
2031 <p>For example, the user group permissions are stored for each user group and each
2032 permissions separately, but in order to be applied, they need to be fetched and
2033 the cumulative values across all user groups of an user have to be calculated.
2034 These repetitive tasks on barely ever changing data make them an excellent
2035 target for caching, where all sub-sequent requests are accelerated because they
2036 no longer have to perform the same expensive calculations every time.
</p>
2037 <p>It is easy to get lost in the realm of caching, especially when it comes to the
2038 decision if you should use a cache or not. When in doubt, you should opt to not
2039 use them, because they also come at a hidden cost that cannot be expressed through
2040 simple SQL query counts. If you haven't already, it is recommended that you read
2041 the
<a href=
"../caches/">introduction article on caching
</a> first, it provides a bit
2042 of background on caches and examples that should help you in your decision.
</p>
2043 <h2 id=
"abstractcachebuilder"><code>AbstractCacheBuilder
</code><a class=
"headerlink" href=
"#abstractcachebuilder" title=
"Permanent link">#
</a></h2>
2044 <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>
2045 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>
2046 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2047 <span class=
"k">namespace
</span> <span class=
"nx">wcf\system\cache\builder
</span><span class=
"p">;
</span>
2049 <span class=
"k">class
</span> <span class=
"nc">ExampleCacheBuilder
</span> <span class=
"k">extends
</span> <span class=
"nx">AbstractCacheBuilder
</span> <span class=
"p">{
</span>
2050 <span class=
"c1">//
3600 =
1hr
</span>
2051 <span class=
"k">protected
</span> <span class=
"nv">$maxLifetime
</span> <span class=
"o">=
</span> <span class=
"mi">3600</span><span class=
"p">;
</span>
2053 <span class=
"k">public
</span> <span class=
"k">function
</span> <span class=
"nf">rebuild
</span><span class=
"p">(
</span><span class=
"k">array
</span> <span class=
"nv">$parameters
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2054 <span class=
"nv">$data
</span> <span class=
"o">=
</span> <span class=
"p">[];
</span>
2056 <span class=
"c1">// fetch and process your data and assign it to `$data`
</span>
2058 <span class=
"k">return
</span> <span class=
"nv">$data
</span><span class=
"p">;
</span>
2059 <span class=
"p">}
</span>
2060 <span class=
"p">}
</span>
2062 <p>Reading data from your cache builder is quite simple and follows a consistent
2063 pattern. The callee only needs to know the name of the cache builder, which
2064 parameters it requires and how the returned data looks like. It does not need
2065 to know how the data is retrieve, where it was stored, nor if it had to be
2066 rebuild due to the maximum lifetime.
</p>
2067 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2068 <span class=
"k">use
</span> <span class=
"nx">wcf\system\cache\builder\ExampleCacheBuilder
</span><span class=
"p">;
</span>
2070 <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">-
></span><span class=
"na">getData
</span><span class=
"p">(
</span><span class=
"nv">$parameters
</span><span class=
"p">);
</span>
2072 <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>
2073 <p>Retrieves the data from the cache builder, the
<code>$parameters
</code> array is automatically
2074 sorted to allow sub-sequent requests for the same parameters to be recognized,
2075 even if their parameters are mixed. For example,
<code>getData([
1,
2])
</code> and
<code>getData([
2,
1])
</code>
2076 will have the same exact result.
</p>
2077 <p>The optional
<code>$arrayIndex
</code> will instruct the cache builder to retrieve the data
2078 and examine if the returned data is an array that has the index
<code>$arrayIndex
</code>.
2079 If it is set, the potion below this index is returned instead.
</p>
2080 <h3 id=
"getmaxlifetime-int"><code>getMaxLifetime(): int
</code><a class=
"headerlink" href=
"#getmaxlifetime-int" title=
"Permanent link">#
</a></h3>
2081 <p>Returns the maximum lifetime of a cache in seconds. It can be controlled through
2082 the
<code>protected $maxLifetime
</code> property which defaults to
<code>0</code>. Any cache that has
2083 a lifetime greater than
0 is automatically discarded when exceeding this age,
2084 otherwise it will remain forever until it is explicitly removed or invalidated.
</p>
2085 <h3 id=
"resetarray-parameters-void"><code>reset(array $parameters = []): void
</code><a class=
"headerlink" href=
"#resetarray-parameters-void" title=
"Permanent link">#
</a></h3>
2086 <p>Invalidates a cache, the
<code>$parameters
</code> array will again be ordered using the same
2087 rules that are applied for
<code>getData()
</code>.
</p>
2088 <h3 id=
"rebuildarray-parameters-array"><code>rebuild(array $parameters): array
</code><a class=
"headerlink" href=
"#rebuildarray-parameters-array" title=
"Permanent link">#
</a></h3>
2089 <p><em>This method is protected.
</em></p>
2090 <p>This is the only method that a cache builder deriving from
<code>AbstractCacheBuilder
</code>
2091 has to implement and it will be invoked whenever the cache is required to be
2092 rebuild for whatever reason.
</p>
2098 <div class=
"md-source-date">
2101 Last update:
2021-
01-
08
2120 <footer class=
"md-footer">
2122 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2124 <a href=
"../caches/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2125 <div class=
"md-footer__button md-icon">
2126 <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>
2128 <div class=
"md-footer__title">
2129 <div class=
"md-ellipsis">
2130 <span class=
"md-footer__direction">
2139 <a href=
"../caches_runtime-caches/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2140 <div class=
"md-footer__title">
2141 <div class=
"md-ellipsis">
2142 <span class=
"md-footer__direction">
2148 <div class=
"md-footer__button md-icon">
2149 <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>
2155 <div class=
"md-footer-meta md-typeset">
2156 <div class=
"md-footer-meta__inner md-grid">
2157 <div class=
"md-footer-copyright">
2159 <div class=
"md-footer-copyright__highlight">
2160 Copyright ©
2020 WoltLab GmbH
2164 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2169 <div class=
"md-footer-copyright">
2170 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2171 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2178 <div class=
"md-dialog" data-md-component=
"dialog">
2179 <div class=
"md-dialog__inner md-typeset"></div>
2181 <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>
2184 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>