├── .all-contributorsrc ├── .codeclimate.yml ├── .editorconfig ├── .gitignore ├── .travis.yml ├── LICENSE.md ├── README.md ├── composer.json ├── includes ├── functions.php └── object-cache.php ├── package.json ├── phpcs.xml ├── phpmd.xml ├── phpunit.xml ├── src ├── CacheAdapter │ ├── CacheAdapter.php │ ├── CacheAdapterFactory.php │ ├── Psr16CacheAdapter.php │ ├── Psr6CacheAdapter.php │ └── PsrCacheAdapterFactory.php ├── CacheKeyGen │ ├── CacheKeyGen.php │ ├── WpCacheKeyGen.php │ └── WpPsrCacheKeyGen.php ├── CacheSelector │ ├── BaseCacheSelector.php │ ├── BaseCacheSelectorFactory.php │ ├── CacheSelector.php │ └── CacheSelectorFactory.php ├── ObjectCache.php ├── ObjectCacheFactory.php └── ObjectCacheService.php └── tests └── KeyGenTest.php /.all-contributorsrc: -------------------------------------------------------------------------------- 1 | { 2 | "projectName": "wp-psr-cache", 3 | "projectOwner": "felixarntz", 4 | "files": [ 5 | "README.md" 6 | ], 7 | "imageSize": 100, 8 | "commit": false, 9 | "contributors": [ 10 | { 11 | "login": "felixarntz", 12 | "name": "Felix Arntz", 13 | "avatar_url": "https://avatars1.githubusercontent.com/u/3531426?v=4", 14 | "profile": "https://leaves-and-love.net", 15 | "contributions": [ 16 | "code", 17 | "bug", 18 | "doc", 19 | "example", 20 | "ideas", 21 | "test" 22 | ] 23 | }, 24 | { 25 | "login": "schlessera", 26 | "name": "Alain Schlesser", 27 | "avatar_url": "https://avatars1.githubusercontent.com/u/83631?v=4", 28 | "profile": "https://www.alainschlesser.com/", 29 | "contributions": [ 30 | "code", 31 | "bug", 32 | "review" 33 | ] 34 | }, 35 | { 36 | "login": "tfrommen", 37 | "name": "Thorsten Frommen", 38 | "avatar_url": "https://avatars2.githubusercontent.com/u/6049306?v=4", 39 | "profile": "https://tfrommen.de", 40 | "contributions": [ 41 | "review" 42 | ] 43 | }, 44 | { 45 | "login": "moorscode", 46 | "name": "Jip", 47 | "avatar_url": "https://avatars0.githubusercontent.com/u/2005352?v=4", 48 | "profile": "http://www.jipmoors.nl", 49 | "contributions": [ 50 | "ideas" 51 | ] 52 | } 53 | ] 54 | } 55 | -------------------------------------------------------------------------------- /.codeclimate.yml: -------------------------------------------------------------------------------- 1 | --- 2 | engines: 3 | duplication: 4 | enabled: true 5 | config: 6 | languages: 7 | - php 8 | fixme: 9 | enabled: true 10 | phpcodesniffer: 11 | enabled: true 12 | config: 13 | file_extensions: "php" 14 | standard: "phpcs.xml" 15 | ignore_warnings: true 16 | encoding: utf-8 17 | phpmd: 18 | enabled: true 19 | config: 20 | file_extensions: "php" 21 | rulesets: "phpmd.xml" 22 | ratings: 23 | paths: 24 | - "src/**.php" 25 | exclude_paths: 26 | - "includes/*" 27 | - "tests/*" 28 | - "vendor/*" -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # PHP PSR-2 Coding Standards 2 | # http://www.php-fig.org/psr/psr-2/ 3 | 4 | root = true 5 | 6 | [*.php] 7 | charset = utf-8 8 | end_of_line = lf 9 | insert_final_newline = true 10 | trim_trailing_whitespace = true 11 | indent_style = space 12 | indent_size = 4 -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ############# 2 | ## IDEs 3 | ############# 4 | 5 | *.pydevproject 6 | .project 7 | .metadata 8 | *.swp 9 | *~.nib 10 | local.properties 11 | .classpath 12 | .settings/ 13 | .loadpath 14 | .externalToolBuilders/ 15 | *.launch 16 | .cproject 17 | .buildpath 18 | nbproject/ 19 | 20 | ############# 21 | ## 3rd-Party 22 | ############# 23 | 24 | node_modules/ 25 | vendor/ 26 | 27 | ############# 28 | ## OSes 29 | ############# 30 | 31 | [Tt]humbs.db 32 | [Dd]esktop.ini 33 | *.DS_store 34 | .DS_store? 35 | 36 | ############# 37 | ## Misc 38 | ############# 39 | 40 | tmp/ 41 | *.tmp 42 | *.bak 43 | *.log 44 | *.lock 45 | *-lock.json 46 | *.[Cc]ache 47 | *.cpr 48 | *.orig 49 | *.php.in 50 | .idea/ 51 | .sass-cache/* 52 | temp/ 53 | ._* 54 | .Trashes 55 | .svn 56 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | language: php 3 | cache: 4 | directories: 5 | - vendor 6 | - $HOME/.composer/cache 7 | matrix: 8 | include: 9 | - php: 7.2 10 | env: PHPLINT=1 PHPCS=1 COVERAGE=1 11 | - php: 7.1 12 | - php: 7.0 13 | allow_failures: 14 | - php: nightly 15 | before_script: 16 | - composer self-update 17 | - composer install 18 | - | 19 | if [[ "$COVERAGE" == "1" ]]; then 20 | curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter 21 | chmod +x ./cc-test-reporter 22 | ./cc-test-reporter before-build 23 | fi 24 | script: 25 | - | 26 | if [[ "$PHPLINT" == "1" ]]; then 27 | find -L . -path ./vendor -prune -o -name '*.php' -print0 | xargs -0 -n 1 -P 4 php -l 28 | fi 29 | - | 30 | if [[ "$PHPCS" == "1" ]]; then 31 | vendor/bin/phpcs -v --runtime-set ignore_warnings_on_exit 1 32 | fi 33 | - | 34 | if [[ -z "$CODECLIMATE_REPO_TOKEN" ]]; then 35 | COVERAGE="0" 36 | fi 37 | - | 38 | if [[ "$COVERAGE" == "1" ]]; then 39 | mkdir -p build/logs 40 | vendor/bin/phpunit -c phpunit.xml --coverage-clover build/logs/clover.xml 41 | else 42 | vendor/bin/phpunit -c phpunit.xml 43 | fi 44 | after_script: 45 | - | 46 | if [[ "$COVERAGE" == "1" ]]; then 47 | ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT 48 | fi 49 | notifications: 50 | email: false 51 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | ### GNU GENERAL PUBLIC LICENSE 2 | 3 | Version 2, June 1991 4 | 5 | Copyright (C) 1989, 1991 Free Software Foundation, Inc. 6 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA 7 | 8 | Everyone is permitted to copy and distribute verbatim copies 9 | of this license document, but changing it is not allowed. 10 | 11 | ### Preamble 12 | 13 | The licenses for most software are designed to take away your freedom 14 | to share and change it. By contrast, the GNU General Public License is 15 | intended to guarantee your freedom to share and change free 16 | software--to make sure the software is free for all its users. This 17 | General Public License applies to most of the Free Software 18 | Foundation's software and to any other program whose authors commit to 19 | using it. (Some other Free Software Foundation software is covered by 20 | the GNU Lesser General Public License instead.) You can apply it to 21 | your programs, too. 22 | 23 | When we speak of free software, we are referring to freedom, not 24 | price. Our General Public Licenses are designed to make sure that you 25 | have the freedom to distribute copies of free software (and charge for 26 | this service if you wish), that you receive source code or can get it 27 | if you want it, that you can change the software or use pieces of it 28 | in new free programs; and that you know you can do these things. 29 | 30 | To protect your rights, we need to make restrictions that forbid 31 | anyone to deny you these rights or to ask you to surrender the rights. 32 | These restrictions translate to certain responsibilities for you if 33 | you distribute copies of the software, or if you modify it. 34 | 35 | For example, if you distribute copies of such a program, whether 36 | gratis or for a fee, you must give the recipients all the rights that 37 | you have. You must make sure that they, too, receive or can get the 38 | source code. And you must show them these terms so they know their 39 | rights. 40 | 41 | We protect your rights with two steps: (1) copyright the software, and 42 | (2) offer you this license which gives you legal permission to copy, 43 | distribute and/or modify the software. 44 | 45 | Also, for each author's protection and ours, we want to make certain 46 | that everyone understands that there is no warranty for this free 47 | software. If the software is modified by someone else and passed on, 48 | we want its recipients to know that what they have is not the 49 | original, so that any problems introduced by others will not reflect 50 | on the original authors' reputations. 51 | 52 | Finally, any free program is threatened constantly by software 53 | patents. We wish to avoid the danger that redistributors of a free 54 | program will individually obtain patent licenses, in effect making the 55 | program proprietary. To prevent this, we have made it clear that any 56 | patent must be licensed for everyone's free use or not licensed at 57 | all. 58 | 59 | The precise terms and conditions for copying, distribution and 60 | modification follow. 61 | 62 | ### TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 63 | 64 | **0.** This License applies to any program or other work which 65 | contains a notice placed by the copyright holder saying it may be 66 | distributed under the terms of this General Public License. The 67 | "Program", below, refers to any such program or work, and a "work 68 | based on the Program" means either the Program or any derivative work 69 | under copyright law: that is to say, a work containing the Program or 70 | a portion of it, either verbatim or with modifications and/or 71 | translated into another language. (Hereinafter, translation is 72 | included without limitation in the term "modification".) Each licensee 73 | is addressed as "you". 74 | 75 | Activities other than copying, distribution and modification are not 76 | covered by this License; they are outside its scope. The act of 77 | running the Program is not restricted, and the output from the Program 78 | is covered only if its contents constitute a work based on the Program 79 | (independent of having been made by running the Program). Whether that 80 | is true depends on what the Program does. 81 | 82 | **1.** You may copy and distribute verbatim copies of the Program's 83 | source code as you receive it, in any medium, provided that you 84 | conspicuously and appropriately publish on each copy an appropriate 85 | copyright notice and disclaimer of warranty; keep intact all the 86 | notices that refer to this License and to the absence of any warranty; 87 | and give any other recipients of the Program a copy of this License 88 | along with the Program. 89 | 90 | You may charge a fee for the physical act of transferring a copy, and 91 | you may at your option offer warranty protection in exchange for a 92 | fee. 93 | 94 | **2.** You may modify your copy or copies of the Program or any 95 | portion of it, thus forming a work based on the Program, and copy and 96 | distribute such modifications or work under the terms of Section 1 97 | above, provided that you also meet all of these conditions: 98 | 99 | 100 | **a)** You must cause the modified files to carry prominent notices 101 | stating that you changed the files and the date of any change. 102 | 103 | 104 | **b)** You must cause any work that you distribute or publish, that in 105 | whole or in part contains or is derived from the Program or any part 106 | thereof, to be licensed as a whole at no charge to all third parties 107 | under the terms of this License. 108 | 109 | 110 | **c)** If the modified program normally reads commands interactively 111 | when run, you must cause it, when started running for such interactive 112 | use in the most ordinary way, to print or display an announcement 113 | including an appropriate copyright notice and a notice that there is 114 | no warranty (or else, saying that you provide a warranty) and that 115 | users may redistribute the program under these conditions, and telling 116 | the user how to view a copy of this License. (Exception: if the 117 | Program itself is interactive but does not normally print such an 118 | announcement, your work based on the Program is not required to print 119 | an announcement.) 120 | 121 | These requirements apply to the modified work as a whole. If 122 | identifiable sections of that work are not derived from the Program, 123 | and can be reasonably considered independent and separate works in 124 | themselves, then this License, and its terms, do not apply to those 125 | sections when you distribute them as separate works. But when you 126 | distribute the same sections as part of a whole which is a work based 127 | on the Program, the distribution of the whole must be on the terms of 128 | this License, whose permissions for other licensees extend to the 129 | entire whole, and thus to each and every part regardless of who wrote 130 | it. 131 | 132 | Thus, it is not the intent of this section to claim rights or contest 133 | your rights to work written entirely by you; rather, the intent is to 134 | exercise the right to control the distribution of derivative or 135 | collective works based on the Program. 136 | 137 | In addition, mere aggregation of another work not based on the Program 138 | with the Program (or with a work based on the Program) on a volume of 139 | a storage or distribution medium does not bring the other work under 140 | the scope of this License. 141 | 142 | **3.** You may copy and distribute the Program (or a work based on it, 143 | under Section 2) in object code or executable form under the terms of 144 | Sections 1 and 2 above provided that you also do one of the following: 145 | 146 | 147 | **a)** Accompany it with the complete corresponding machine-readable 148 | source code, which must be distributed under the terms of Sections 1 149 | and 2 above on a medium customarily used for software interchange; or, 150 | 151 | 152 | **b)** Accompany it with a written offer, valid for at least three 153 | years, to give any third party, for a charge no more than your cost of 154 | physically performing source distribution, a complete machine-readable 155 | copy of the corresponding source code, to be distributed under the 156 | terms of Sections 1 and 2 above on a medium customarily used for 157 | software interchange; or, 158 | 159 | 160 | **c)** Accompany it with the information you received as to the offer 161 | to distribute corresponding source code. (This alternative is allowed 162 | only for noncommercial distribution and only if you received the 163 | program in object code or executable form with such an offer, in 164 | accord with Subsection b above.) 165 | 166 | The source code for a work means the preferred form of the work for 167 | making modifications to it. For an executable work, complete source 168 | code means all the source code for all modules it contains, plus any 169 | associated interface definition files, plus the scripts used to 170 | control compilation and installation of the executable. However, as a 171 | special exception, the source code distributed need not include 172 | anything that is normally distributed (in either source or binary 173 | form) with the major components (compiler, kernel, and so on) of the 174 | operating system on which the executable runs, unless that component 175 | itself accompanies the executable. 176 | 177 | If distribution of executable or object code is made by offering 178 | access to copy from a designated place, then offering equivalent 179 | access to copy the source code from the same place counts as 180 | distribution of the source code, even though third parties are not 181 | compelled to copy the source along with the object code. 182 | 183 | **4.** You may not copy, modify, sublicense, or distribute the Program 184 | except as expressly provided under this License. Any attempt otherwise 185 | to copy, modify, sublicense or distribute the Program is void, and 186 | will automatically terminate your rights under this License. However, 187 | parties who have received copies, or rights, from you under this 188 | License will not have their licenses terminated so long as such 189 | parties remain in full compliance. 190 | 191 | **5.** You are not required to accept this License, since you have not 192 | signed it. However, nothing else grants you permission to modify or 193 | distribute the Program or its derivative works. These actions are 194 | prohibited by law if you do not accept this License. Therefore, by 195 | modifying or distributing the Program (or any work based on the 196 | Program), you indicate your acceptance of this License to do so, and 197 | all its terms and conditions for copying, distributing or modifying 198 | the Program or works based on it. 199 | 200 | **6.** Each time you redistribute the Program (or any work based on 201 | the Program), the recipient automatically receives a license from the 202 | original licensor to copy, distribute or modify the Program subject to 203 | these terms and conditions. You may not impose any further 204 | restrictions on the recipients' exercise of the rights granted herein. 205 | You are not responsible for enforcing compliance by third parties to 206 | this License. 207 | 208 | **7.** If, as a consequence of a court judgment or allegation of 209 | patent infringement or for any other reason (not limited to patent 210 | issues), conditions are imposed on you (whether by court order, 211 | agreement or otherwise) that contradict the conditions of this 212 | License, they do not excuse you from the conditions of this License. 213 | If you cannot distribute so as to satisfy simultaneously your 214 | obligations under this License and any other pertinent obligations, 215 | then as a consequence you may not distribute the Program at all. For 216 | example, if a patent license would not permit royalty-free 217 | redistribution of the Program by all those who receive copies directly 218 | or indirectly through you, then the only way you could satisfy both it 219 | and this License would be to refrain entirely from distribution of the 220 | Program. 221 | 222 | If any portion of this section is held invalid or unenforceable under 223 | any particular circumstance, the balance of the section is intended to 224 | apply and the section as a whole is intended to apply in other 225 | circumstances. 226 | 227 | It is not the purpose of this section to induce you to infringe any 228 | patents or other property right claims or to contest validity of any 229 | such claims; this section has the sole purpose of protecting the 230 | integrity of the free software distribution system, which is 231 | implemented by public license practices. Many people have made 232 | generous contributions to the wide range of software distributed 233 | through that system in reliance on consistent application of that 234 | system; it is up to the author/donor to decide if he or she is willing 235 | to distribute software through any other system and a licensee cannot 236 | impose that choice. 237 | 238 | This section is intended to make thoroughly clear what is believed to 239 | be a consequence of the rest of this License. 240 | 241 | **8.** If the distribution and/or use of the Program is restricted in 242 | certain countries either by patents or by copyrighted interfaces, the 243 | original copyright holder who places the Program under this License 244 | may add an explicit geographical distribution limitation excluding 245 | those countries, so that distribution is permitted only in or among 246 | countries not thus excluded. In such case, this License incorporates 247 | the limitation as if written in the body of this License. 248 | 249 | **9.** The Free Software Foundation may publish revised and/or new 250 | versions of the General Public License from time to time. Such new 251 | versions will be similar in spirit to the present version, but may 252 | differ in detail to address new problems or concerns. 253 | 254 | Each version is given a distinguishing version number. If the Program 255 | specifies a version number of this License which applies to it and 256 | "any later version", you have the option of following the terms and 257 | conditions either of that version or of any later version published by 258 | the Free Software Foundation. If the Program does not specify a 259 | version number of this License, you may choose any version ever 260 | published by the Free Software Foundation. 261 | 262 | **10.** If you wish to incorporate parts of the Program into other 263 | free programs whose distribution conditions are different, write to 264 | the author to ask for permission. For software which is copyrighted by 265 | the Free Software Foundation, write to the Free Software Foundation; 266 | we sometimes make exceptions for this. Our decision will be guided by 267 | the two goals of preserving the free status of all derivatives of our 268 | free software and of promoting the sharing and reuse of software 269 | generally. 270 | 271 | **NO WARRANTY** 272 | 273 | **11.** BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO 274 | WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 275 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 276 | OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY 277 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 278 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 279 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 280 | PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME 281 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 282 | 283 | **12.** IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 284 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 285 | AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU 286 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 287 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 288 | PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 289 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 290 | FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF 291 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 292 | DAMAGES. 293 | 294 | ### END OF TERMS AND CONDITIONS 295 | 296 | ### How to Apply These Terms to Your New Programs 297 | 298 | If you develop a new program, and you want it to be of the greatest 299 | possible use to the public, the best way to achieve this is to make it 300 | free software which everyone can redistribute and change under these 301 | terms. 302 | 303 | To do so, attach the following notices to the program. It is safest to 304 | attach them to the start of each source file to most effectively 305 | convey the exclusion of warranty; and each file should have at least 306 | the "copyright" line and a pointer to where the full notice is found. 307 | 308 | one line to give the program's name and an idea of what it does. 309 | Copyright (C) yyyy name of author 310 | 311 | This program is free software; you can redistribute it and/or 312 | modify it under the terms of the GNU General Public License 313 | as published by the Free Software Foundation; either version 2 314 | of the License, or (at your option) any later version. 315 | 316 | This program is distributed in the hope that it will be useful, 317 | but WITHOUT ANY WARRANTY; without even the implied warranty of 318 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 319 | GNU General Public License for more details. 320 | 321 | You should have received a copy of the GNU General Public License 322 | along with this program; if not, write to the Free Software 323 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 324 | 325 | Also add information on how to contact you by electronic and paper 326 | mail. 327 | 328 | If the program is interactive, make it output a short notice like this 329 | when it starts in an interactive mode: 330 | 331 | Gnomovision version 69, Copyright (C) year name of author 332 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details 333 | type `show w'. This is free software, and you are welcome 334 | to redistribute it under certain conditions; type `show c' 335 | for details. 336 | 337 | The hypothetical commands \`show w' and \`show c' should show the 338 | appropriate parts of the General Public License. Of course, the 339 | commands you use may be called something other than \`show w' and 340 | \`show c'; they could even be mouse-clicks or menu items--whatever 341 | suits your program. 342 | 343 | You should also get your employer (if you work as a programmer) or 344 | your school, if any, to sign a "copyright disclaimer" for the program, 345 | if necessary. Here is a sample; alter the names: 346 | 347 | Yoyodyne, Inc., hereby disclaims all copyright 348 | interest in the program `Gnomovision' 349 | (which makes passes at compilers) written 350 | by James Hacker. 351 | 352 | signature of Ty Coon, 1 April 1989 353 | Ty Coon, President of Vice 354 | 355 | This General Public License does not permit incorporating your program 356 | into proprietary programs. If your program is a subroutine library, 357 | you may consider it more useful to permit linking proprietary 358 | applications with the library. If this is what you want to do, use the 359 | [GNU Lesser General Public 360 | License](https://www.gnu.org/licenses/lgpl.html) instead of this 361 | License. 362 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Build Status](https://api.travis-ci.org/felixarntz/wp-psr-cache.png?branch=master)](https://travis-ci.org/felixarntz/wp-psr-cache) 2 | [![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors) 3 | [![Code Climate](https://codeclimate.com/github/felixarntz/wp-psr-cache/badges/gpa.svg)](https://codeclimate.com/github/felixarntz/wp-psr-cache) 4 | [![Test Coverage](https://codeclimate.com/github/felixarntz/wp-psr-cache/badges/coverage.svg)](https://codeclimate.com/github/felixarntz/wp-psr-cache/coverage) 5 | [![Latest Stable Version](https://poser.pugx.org/felixarntz/wp-psr-cache/version)](https://packagist.org/packages/felixarntz/wp-psr-cache) 6 | [![License](https://poser.pugx.org/felixarntz/wp-psr-cache/license)](https://packagist.org/packages/felixarntz/wp-psr-cache) 7 | 8 | # WP PSR Cache 9 | 10 | Object cache implementation for WordPress that acts as an adapter for PSR-6 and PSR-16 caching libraries. 11 | 12 | ## What do PSR-6 and PSR-16 mean? 13 | 14 | [PSR-6](http://www.php-fig.org/psr/psr-6/) and [PSR-16](http://www.php-fig.org/psr/psr-16/) are standards established by the [PHP-FIG](http://www.php-fig.org/) organization. These standards are commonly used in PHP projects of any kind (WordPress is unfortunately an exception), and since this library acts as an adapter, you can use any compatible caching library of your choice with WordPress now. Popular examples include the [Symfony Cache Component](https://github.com/symfony/cache) or [Stash](https://github.com/tedious/Stash). 15 | 16 | ## Features 17 | 18 | * Any PSR-6 or PSR-16 cache implementation can be used 19 | * Persistent and non-persistent cache implementations can be individually specified 20 | * Support for reading/writing/deleting multiple cache keys at once 21 | * Only checks persistent cache if value not already present in non-persistent cache 22 | * Full multisite support, including site and network switching 23 | * Allows registration of further cache implementations for fine-grained control per cache group 24 | 25 | ## How to Install 26 | 27 | Require this library as a dependency when managing your project with Composer (for example by using [Bedrock](https://github.com/roots/bedrock)). You also have to install an actual [PSR-6](https://packagist.org/providers/psr/cache-implementation) or [PSR-16](https://packagist.org/providers/psr/simple-cache-implementation) cache implementation. 28 | 29 | After the installation, you need to move the `includes/object-cache.php` file into your `wp-content` directory. If you prefer, you can also automate that process by adding the following to your project's `composer.json`: 30 | 31 | ``` 32 | "scripts": { 33 | "post-install-cmd": [ 34 | "cp -rp web/app/mu-plugins/wp-psr-cache/includes/object-cache.php web/app/object-cache.php" 35 | ] 36 | } 37 | ``` 38 | 39 | Then, replace the inline comment in the `object-cache.php` file with the actual instantiations of the classes you want to use. You need to provide two implementations, one for the persistent cache and another for the non-persistent cache. 40 | 41 | To prevent conflicts with multiple WordPress installations accessing the same cache service, it is recommended to define a unique `WP_CACHE_KEY_PREFIX` constant in your `wp-config.php` file. 42 | 43 | ### Example 44 | 45 | The following example uses the `symfony/cache` library, so you have to require it in your `composer.json`. It then uses that library's Memcached implementation as persistent cache and its array storage as non-persistent cache. 46 | 47 | ```php 48 | addServer( '127.0.0.1', 11211, 20 ); 73 | 74 | wp_cache_start( new MemcachedCache( $memcached ), new ArrayCache() ); 75 | } 76 | 77 | wp_psr_start_cache(); 78 | 79 | ``` 80 | 81 | If you prefer to have more granular control and use more than just one persistent and one non-persistent cache, you can register additional cache adapters using the [`LeavesAndLove\WpPsrCache\CacheSelector\CacheSelector`](https://github.com/felixarntz/wp-psr-cache/blob/master/src/CacheSelector/CacheSelector.php) interface. The implementation used by the object cache can easily be retrieved via `wp_object_cache()->getSelector()`. 82 | 83 | ## Requirements 84 | 85 | * PHP >= 7.0 86 | 87 | ## Contributors 88 | 89 | Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): 90 | 91 | 92 | 93 | | [
Felix Arntz](https://leaves-and-love.net)
[💻](https://github.com/felixarntz/wp-psr-cache/commits?author=felixarntz "Code") [🐛](https://github.com/felixarntz/wp-psr-cache/issues?q=author%3Afelixarntz "Bug reports") [📖](https://github.com/felixarntz/wp-psr-cache/commits?author=felixarntz "Documentation") [💡](#example-felixarntz "Examples") [🤔](#ideas-felixarntz "Ideas, Planning, & Feedback") [⚠️](https://github.com/felixarntz/wp-psr-cache/commits?author=felixarntz "Tests") | [
Alain Schlesser](https://www.alainschlesser.com/)
[💻](https://github.com/felixarntz/wp-psr-cache/commits?author=schlessera "Code") [🐛](https://github.com/felixarntz/wp-psr-cache/issues?q=author%3Aschlessera "Bug reports") [👀](#review-schlessera "Reviewed Pull Requests") | [
Thorsten Frommen](https://tfrommen.de)
[👀](#review-tfrommen "Reviewed Pull Requests") | [
Jip](http://www.jipmoors.nl)
[🤔](#ideas-moorscode "Ideas, Planning, & Feedback") | 94 | | :---: | :---: | :---: | :---: | 95 | 96 | 97 | This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome! -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "felixarntz/wp-psr-cache", 3 | "description": "Object cache implementation for WordPress that acts as an adapter for PSR-6 and PSR-16 caching libraries.", 4 | "version": "1.0.0", 5 | "type": "wordpress-muplugin", 6 | "license": "GPL-2.0-or-later", 7 | "keywords": [ 8 | "wordpress", 9 | "mu-plugin", 10 | "cache", 11 | "psr-6", 12 | "psr-16", 13 | "adapter" 14 | ], 15 | "homepage": "https://github.com/felixarntz/wp-psr-cache", 16 | "authors": [ 17 | { 18 | "name": "Felix Arntz", 19 | "email": "felix-arntz@leaves-and-love.net", 20 | "homepage": "https://leaves-and-love.net", 21 | "role": "Developer" 22 | } 23 | ], 24 | "support": { 25 | "issues": "https://github.com/felixarntz/wp-psr-cache/issues" 26 | }, 27 | "autoload": { 28 | "psr-4": { 29 | "LeavesAndLove\\WpPsrCache\\": "src" 30 | } 31 | }, 32 | "autoload-dev": { 33 | "psr-4": { 34 | "LeavesAndLove\\WpPsrCache\\Tests\\": "tests" 35 | } 36 | }, 37 | "require": { 38 | "php": "^7.0", 39 | "composer/installers": "~1.0", 40 | "psr/cache": "*", 41 | "psr/simple-cache": "*" 42 | }, 43 | "require-dev": { 44 | "phpunit/phpunit": "6.2.*", 45 | "squizlabs/php_codesniffer": "3.*" 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /includes/functions.php: -------------------------------------------------------------------------------- 1 | create( $persistent_cache ); 44 | $non_persistent_cache_adapter = $adapter_factory->create( $non_persistent_cache ); 45 | 46 | $selector = $selector_factory->create( $persistent_cache_adapter, $non_persistent_cache_adapter ); 47 | $cache = $cache_factory->create( $selector ); 48 | 49 | ObjectCacheService::setInstance( $cache ); 50 | } 51 | 52 | /** 53 | * Adds a group or list of groups to the global cache groups. 54 | * 55 | * @since 1.0.0 56 | * @see WpCacheKeyGen::addGlobalGroups() 57 | * 58 | * @param string|array $groups A group or an array of groups to add. 59 | */ 60 | function wp_cache_add_global_groups( $groups ) { 61 | wp_object_cache()->getKeygen()->addGlobalGroups( (array) $groups ); 62 | } 63 | 64 | /** 65 | * Adds a group or list of groups to the network cache groups. 66 | * 67 | * @since 1.0.0 68 | * @see WpCacheKeyGen::addNetworkGroups() 69 | * 70 | * @param string|array $groups A group or an array of groups to add. 71 | */ 72 | function wp_cache_add_network_groups( $groups ) { 73 | wp_object_cache()->getKeygen()->addNetworkGroups( (array) $groups ); 74 | } 75 | 76 | /** 77 | * Adds a group or list of groups to the non-persistent cache groups. 78 | * 79 | * @since 1.0.0 80 | * @see CacheSelector::addNonPersistentGroups() 81 | * 82 | * @param string|array $groups A group or an array of groups to add. 83 | */ 84 | function wp_cache_add_non_persistent_groups( $groups ) { 85 | wp_object_cache()->getSelector()->addNonPersistentGroups( (array) $groups ); 86 | } 87 | 88 | /** 89 | * Switches the internal site ID. 90 | * 91 | * @since 1.0.0 92 | * @see WpCacheKeyGen::switchSiteContext() 93 | * 94 | * @param int $site_id Site ID. 95 | */ 96 | function wp_cache_switch_to_site( $site_id ) { 97 | wp_object_cache()->getKeygen()->switchSiteContext( (int) $site_id ); 98 | } 99 | 100 | /** 101 | * Switches the internal network ID. 102 | * 103 | * @since 1.0.0 104 | * @see WpCacheKeyGen::switchNetworkContext() 105 | * 106 | * @param int $network_id Network ID. 107 | */ 108 | function wp_cache_switch_to_network( $network_id ) { 109 | wp_object_cache()->getKeygen()->switchNetworkContext( (int) $network_id ); 110 | } 111 | 112 | /** 113 | * Obtains a value from the cache. 114 | * 115 | * @since 1.0.0 116 | * @see ObjectCache::get() 117 | * 118 | * @param string $key The key of this item in the cache. 119 | * @param string $group Optional. The group of this item in the cache. Default empty string. 120 | * @param bool $force Optional. Whether to force an update of the non-persistent cache 121 | * from the persistent cache. Default false. 122 | * @param bool &$found Optional. Whether the key was found in the cache (passed by reference). 123 | * Disambiguates a return of false, a storable value. Default null. 124 | * @return mixed The value of the item from the cache, or false in case of cache miss. 125 | */ 126 | function wp_cache_get( $key, $group = '', $force = false, &$found = null ) { 127 | $found = (bool) $found; 128 | 129 | return wp_object_cache()->get( $key, $group, $force, $found ); 130 | } 131 | 132 | /** 133 | * Stores a value in the cache. 134 | * 135 | * @since 1.0.0 136 | * @see ObjectCache::set() 137 | * 138 | * @param string $key The key of the item to store. 139 | * @param mixed $value The value of the item to store. Must be serializable. 140 | * @param string $group Optional. The group of the item to store. Default empty string. 141 | * @param int $expiration Optional. When to expire the value, passed in seconds. Default 0 (no expiration). 142 | * @return bool True on success, false on failure. 143 | */ 144 | function wp_cache_set( $key, $value, $group = '', $expiration = 0 ) { 145 | return wp_object_cache()->set( $key, $value, $group, $expiration ); 146 | } 147 | 148 | /** 149 | * Stores a value in the cache if its key is not already set. 150 | * 151 | * @since 1.0.0 152 | * @see ObjectCache::add() 153 | * 154 | * @param string $key The key of the item to store. 155 | * @param mixed $value The value of the item to store. Must be serializable. 156 | * @param string $group Optional. The group of the item to store. Default empty string. 157 | * @param int $expiration Optional. When to expire the value, passed in seconds. Default 0 (no expiration). 158 | * @return bool True on success, false on failure. 159 | */ 160 | function wp_cache_add( $key, $value, $group = '', $expiration = 0 ) { 161 | if ( wp_suspend_cache_addition() ) { 162 | return false; 163 | } 164 | 165 | return wp_object_cache()->add( $key, $value, $group, $expiration ); 166 | } 167 | 168 | /** 169 | * Stores a value in the cache if its key is already set. 170 | * 171 | * @since 1.0.0 172 | * @see ObjectCache::replace() 173 | * 174 | * @param string $key The key of the item to store. 175 | * @param mixed $value The value of the item to store. Must be serializable. 176 | * @param string $group Optional. The group of the item to store. Default empty string. 177 | * @param int $expiration Optional. When to expire the value, passed in seconds. Default 0 (no expiration). 178 | * @return bool True on success, false on failure. 179 | */ 180 | function wp_cache_replace( $key, $value, $group = '', $expiration = 0 ) { 181 | return wp_object_cache()->replace( $key, $value, $group, $expiration ); 182 | } 183 | 184 | /** 185 | * Increments a numeric value in the cache. 186 | * 187 | * @since 1.0.0 188 | * @see ObjectCache::increment() 189 | * 190 | * @param string $key The key of the item to increment its value. 191 | * @param int $offset Optional. The amount by which to increment the value. Default 1. 192 | * @param string $group Optional. The group of the item to increment. Default empty string. 193 | * @return int|bool The item's new value on success, false on failure. 194 | */ 195 | function wp_cache_incr( $key, $offset = 1, $group = '' ) { 196 | return wp_object_cache()->increment( $key, $offset, $group ); 197 | } 198 | 199 | /** 200 | * Decrements a numeric value in the cache. 201 | * 202 | * @since 1.0.0 203 | * @see ObjectCache::decrement() 204 | * 205 | * @param string $key The key of the item to decrement its value. 206 | * @param int $offset Optional. The amount by which to decrement the value. Default 1. 207 | * @param string $group Optional. The group of the item to decrement. Default empty string. 208 | * @return int|bool The item's new value on success, false on failure. 209 | */ 210 | function wp_cache_decr( $key, $offset = 1, $group = '' ) { 211 | return wp_object_cache()->decrement( $key, $offset, $group ); 212 | } 213 | 214 | /** 215 | * Deletes a value from the cache. 216 | * 217 | * @since 1.0.0 218 | * @see ObjectCache::delete() 219 | * 220 | * @param string $key The key of the item to delete. 221 | * @param string $group Optional. The group of the item to delete. Default empty string. 222 | * @return bool True on success, false on failure. 223 | */ 224 | function wp_cache_delete( $key, $group = '' ) { 225 | return wp_object_cache()->delete( $key, $group ); 226 | } 227 | 228 | /** 229 | * Deletes all values from the cache. 230 | * 231 | * @since 1.0.0 232 | * @see ObjectCache::flush() 233 | * 234 | * @return bool True on success, false on failure. 235 | */ 236 | function wp_cache_flush() { 237 | return wp_object_cache()->flush(); 238 | } 239 | 240 | /** 241 | * Initializes the object cache. 242 | * 243 | * @since 1.0.0 244 | */ 245 | function wp_cache_init() { 246 | // This ensures an exception is thrown if no object cache has been set before this point. 247 | ObjectCacheService::getInstance(); 248 | } 249 | 250 | /** 251 | * Closes the cache. 252 | * 253 | * @since 1.0.0 254 | * 255 | * @return bool True on success, false on failure. 256 | */ 257 | function wp_cache_close() { 258 | return true; 259 | } 260 | 261 | /** 262 | * Determines whether a value is present in the cache. 263 | * 264 | * @since 1.0.0 265 | * @see ObjectCache::has() 266 | * 267 | * @param string $key The key of the item in the cache. 268 | * @param string $group Optional. The group of the item in the cache. Default empty string. 269 | * @return bool True if the value is present, false otherwise. 270 | */ 271 | function wp_cache_has( $key, $group = '' ) { 272 | return wp_object_cache()->has( $key, $group ); 273 | } 274 | 275 | /** 276 | * Obtains multiple values from the cache. 277 | * 278 | * @since 1.0.0 279 | * @see ObjectCache::getMultiple() 280 | * 281 | * @param array $keys The list of keys for the items in the cache. 282 | * @param string $group Optional. The group of the items in the cache. Default empty string. 283 | * @param bool $force Optional. Whether to force an update of the non-persistent cache 284 | * from the persistent cache. Default false. 285 | * @return array List of key => value pairs. For cache misses, false will be used as value. 286 | */ 287 | function wp_cache_get_multi( $keys, $group = '', $force = false ) { 288 | return wp_object_cache()->getMultiple( $keys, $group, $force ); 289 | } 290 | 291 | /** 292 | * Stores multiple values in the cache. 293 | * 294 | * @since 1.0.0 295 | * @see ObjectCache::setMultiple() 296 | * 297 | * @param array $keys The list of key => value pairs to store. 298 | * @param string $group Optional. The group of the items to store. Default empty string. 299 | * @param int $expiration Optional. When to expire the value, passed in seconds. Default 0 (no expiration). 300 | * @return bool True on success, false on failure. 301 | */ 302 | function wp_cache_set_multi( $values, $group = '', $expiration = 0 ) { 303 | return wp_object_cache()->setMultiple( $values, $group, $expiration ); 304 | } 305 | 306 | /** 307 | * Deletes multiple values from the cache. 308 | * 309 | * @since 1.0.0 310 | * @see ObjectCache::deleteMultiple() 311 | * 312 | * @param array $keys The list of keys for the items in the cache to delete. 313 | * @param string $group Optional. The group of the items to delete. Default empty string. 314 | * @return bool True on success, false on failure. 315 | */ 316 | function wp_cache_delete_multi( $keys, $group = '' ) { 317 | return wp_object_cache()->deleteMultiple( $keys, $group ); 318 | } 319 | 320 | /** 321 | * Builds the full internal cache key for a given key and group. 322 | * 323 | * @since 1.0.0 324 | * @see WpCacheKeyGen::generate() 325 | * 326 | * @param string $key A cache key. 327 | * @param string $group A cache group. 328 | * @return string The full cache key to use with cache implementations. 329 | */ 330 | function wp_cache_get_key( $key, $group = '' ) { 331 | return wp_object_cache()->getKeygen()->generate( $key, $group ); 332 | } 333 | 334 | /** 335 | * Gets the main object cache instance. 336 | * 337 | * @since 1.0.0 338 | * 339 | * @global WP_Object_Cache $wp_object_cache Object cache global instance. 340 | * 341 | * @return ObjectCache Main object cache instance. 342 | */ 343 | function wp_object_cache() { 344 | return $GLOBALS['wp_object_cache']; 345 | } 346 | 347 | /** 348 | * Switches the internal site ID. 349 | * 350 | * This function exists for compatibility, but is actually incorrectly named. 351 | * It will not trigger a deprecated notice, but it's still outdated. 352 | * 353 | * @since 1.0.0 354 | * @deprecated 1.0.0 Use wp_cache_switch_to_site() 355 | * @see wp_cache_switch_to_site() 356 | * 357 | * @param int $blog_id Site ID. 358 | */ 359 | function wp_cache_switch_to_blog( $blog_id ) { 360 | wp_cache_switch_to_site( $blog_id ); 361 | 362 | // When `wp_cache_switch_to_blog()` is called right after multisite initialization, it must set the network. 363 | $keygen = wp_object_cache()->getKeygen(); 364 | if ( 0 === $keygen->getNetworkContext() ) { 365 | if ( ! empty( $GLOBALS['current_blog'] ) && (int) $blog_id === (int) $GLOBALS['current_blog']->id ) { 366 | $site = $GLOBALS['current_blog']; 367 | } else { 368 | $site = get_site( $blog_id ); 369 | } 370 | 371 | $keygen->switchNetworkContext( $site->network_id ); 372 | } 373 | } 374 | -------------------------------------------------------------------------------- /includes/object-cache.php: -------------------------------------------------------------------------------- 1 | (https://leaves-and-love.net)", 17 | "devDependencies": { 18 | "all-contributors-cli": "^4.10.1" 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /phpcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | PHPCS rules for WP PSR Cache. 4 | 5 | ./src 6 | 7 | ^/includes/* 8 | ^/vendor/* 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /phpmd.xml: -------------------------------------------------------------------------------- 1 | 2 | 9 | PHPMD rules for WP PSR Cache. 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | -------------------------------------------------------------------------------- /phpunit.xml: -------------------------------------------------------------------------------- 1 | 2 | 17 | 18 | 19 | tests 20 | 21 | 22 | 23 | 24 | 25 | src 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /src/CacheAdapter/CacheAdapter.php: -------------------------------------------------------------------------------- 1 | value pairs. For cache misses, false will be used as value. 60 | */ 61 | public function getMultiple(array $keys): array; 62 | 63 | /** 64 | * Store multiple values in the cache. 65 | * 66 | * @since 1.0.0 67 | * 68 | * @param array $values The list of key => value pairs to store. 69 | * @param int $expiration Optional. When the values should expire. Must be passed 70 | * in seconds. Default 0 (no expiration). 71 | * @return bool True on success, false on failure. 72 | */ 73 | public function setMultiple(array $values, int $expiration = 0): bool; 74 | 75 | /** 76 | * Delete multiple values from the cache. 77 | * 78 | * @since 1.0.0 79 | * 80 | * @param array $keys The list of unique keys for the items in the cache to delete. 81 | * @return bool True on success, false on failure. 82 | */ 83 | public function deleteMultiple(array $keys): bool; 84 | 85 | /** 86 | * Determine whether a value is present in the cache. 87 | * 88 | * @since 1.0.0 89 | * 90 | * @param string $key The unique key of this item. 91 | * @return bool True if the value is present, false otherwise. 92 | */ 93 | public function has(string $key): bool; 94 | 95 | /** 96 | * Delete all values from the cache. 97 | * 98 | * @since 1.0.0 99 | * 100 | * @return bool True on success, false on failure. 101 | */ 102 | public function clear(): bool; 103 | 104 | /** 105 | * Get the cache client instance used by the adapter. 106 | * 107 | * @since 1.0.0 108 | * 109 | * @return object Cache client instance. 110 | */ 111 | public function getClient(); 112 | } 113 | -------------------------------------------------------------------------------- /src/CacheAdapter/CacheAdapterFactory.php: -------------------------------------------------------------------------------- 1 | cache = $cache; 37 | } 38 | 39 | /** 40 | * Obtain a value from the cache. 41 | * 42 | * @since 1.0.0 43 | * 44 | * @param string $key The unique key of this item in the cache. 45 | * @return mixed The value of the item from the cache, or false in case of cache miss. 46 | */ 47 | public function get(string $key) 48 | { 49 | return $this->cache->get($key, false); 50 | } 51 | 52 | /** 53 | * Store a value in the cache. 54 | * 55 | * @since 1.0.0 56 | * 57 | * @param string $key The key of the item to store. 58 | * @param mixed $value The value of the item to store. Must be serializable. 59 | * @param int $expiration Optional. When the value should expire. Must be passed 60 | * in seconds. Default 0 (no expiration). 61 | * @return bool True on success, false on failure. 62 | */ 63 | public function set(string $key, $value, int $expiration = 0): bool 64 | { 65 | $expiration = 0 === $expiration ? null : $expiration; 66 | 67 | return $this->cache->set($key, $value, $expiration); 68 | } 69 | 70 | /** 71 | * Delete a value from the cache. 72 | * 73 | * @since 1.0.0 74 | * 75 | * @param string $key The unique cache key of the item to delete. 76 | * @return bool True on success, false on failure. 77 | */ 78 | public function delete(string $key): bool 79 | { 80 | return $this->cache->delete($key); 81 | } 82 | 83 | /** 84 | * Obtain multiple values from the cache. 85 | * 86 | * @since 1.0.0 87 | * 88 | * @param array $keys The list of unique keys for the items in the cache. 89 | * @return array List of key => value pairs. For cache misses, false will be used as value. 90 | */ 91 | public function getMultiple(array $keys): array 92 | { 93 | $values = array(); 94 | 95 | foreach ($this->cache->getMultiple($keys, false) as $key => $value) { 96 | $values[$key] = $value; 97 | } 98 | 99 | return $values; 100 | } 101 | 102 | /** 103 | * Store multiple values in the cache. 104 | * 105 | * @since 1.0.0 106 | * 107 | * @param array $values The list of key => value pairs to store. 108 | * @param int $expiration Optional. When the values should expire. Must be passed 109 | * in seconds. Default 0 (no expiration). 110 | * @return bool True on success, false on failure. 111 | */ 112 | public function setMultiple(array $values, int $expiration = 0): bool 113 | { 114 | $expiration = 0 === $expiration ? null : $expiration; 115 | 116 | return $this->cache->setMultiple($values, $expiration); 117 | } 118 | 119 | /** 120 | * Delete multiple values from the cache. 121 | * 122 | * @since 1.0.0 123 | * 124 | * @param array $keys The list of unique keys for the items in the cache to delete. 125 | * @return bool True on success, false on failure. 126 | */ 127 | public function deleteMultiple(array $keys): bool 128 | { 129 | return $this->cache->deleteMultiple($keys); 130 | } 131 | 132 | /** 133 | * Determine whether a value is present in the cache. 134 | * 135 | * @since 1.0.0 136 | * 137 | * @param string $key The unique key of this item. 138 | * @return bool True if the value is present, false otherwise. 139 | */ 140 | public function has(string $key): bool 141 | { 142 | return $this->cache->has($key); 143 | } 144 | 145 | /** 146 | * Delete all values from the cache. 147 | * 148 | * @since 1.0.0 149 | * 150 | * @return bool True on success, false on failure. 151 | */ 152 | public function clear(): bool 153 | { 154 | return $this->cache->clear(); 155 | } 156 | 157 | /** 158 | * Get the cache client instance used by the adapter. 159 | * 160 | * @since 1.0.0 161 | * 162 | * @return object Cache client instance. 163 | */ 164 | public function getClient() 165 | { 166 | return $this->cache; 167 | } 168 | } 169 | -------------------------------------------------------------------------------- /src/CacheAdapter/Psr6CacheAdapter.php: -------------------------------------------------------------------------------- 1 | cache = $cache; 37 | } 38 | 39 | /** 40 | * Obtain a value from the cache. 41 | * 42 | * @since 1.0.0 43 | * 44 | * @param string $key The unique key of this item in the cache. 45 | * @return mixed The value of the item from the cache, or false in case of cache miss. 46 | */ 47 | public function get(string $key) 48 | { 49 | $item = $this->cache->getItem($key); 50 | 51 | if (!$item->isHit()) { 52 | return false; 53 | } 54 | 55 | return $item->get(); 56 | } 57 | 58 | /** 59 | * Store a value in the cache. 60 | * 61 | * @since 1.0.0 62 | * 63 | * @param string $key The key of the item to store. 64 | * @param mixed $value The value of the item to store. Must be serializable. 65 | * @param int $expiration Optional. When the value should expire. Must be passed 66 | * in seconds. Default 0 (no expiration). 67 | * @return bool True on success, false on failure. 68 | */ 69 | public function set(string $key, $value, int $expiration = 0): bool 70 | { 71 | $item = $this->cache->getItem($key); 72 | 73 | $item->set($value); 74 | if ($expiration > 0) { 75 | $item->expiresAfter($expiration); 76 | } 77 | 78 | return $this->cache->save($item); 79 | } 80 | 81 | /** 82 | * Delete a value from the cache. 83 | * 84 | * @since 1.0.0 85 | * 86 | * @param string $key The unique cache key of the item to delete. 87 | * @return bool True on success, false on failure. 88 | */ 89 | public function delete(string $key): bool 90 | { 91 | return $this->cache->deleteItem($key); 92 | } 93 | 94 | /** 95 | * Obtain multiple values from the cache. 96 | * 97 | * @since 1.0.0 98 | * 99 | * @param array $keys The list of unique keys for the items in the cache. 100 | * @return array List of key => value pairs. For cache misses, false will be used as value. 101 | */ 102 | public function getMultiple(array $keys): array 103 | { 104 | $values = array(); 105 | 106 | foreach ($this->cache->getItems($keys) as $key => $item) { 107 | $values[$key] = $item->isHit() ? $item->get() : false; 108 | } 109 | 110 | return $values; 111 | } 112 | 113 | /** 114 | * Store multiple values in the cache. 115 | * 116 | * @since 1.0.0 117 | * 118 | * @param array $values The list of key => value pairs to store. 119 | * @param int $expiration Optional. When the values should expire. Must be passed 120 | * in seconds. Default 0 (no expiration). 121 | * @return bool True on success, false on failure. 122 | */ 123 | public function setMultiple(array $values, int $expiration = 0): bool 124 | { 125 | $items = $this->cache->getItems(array_keys($values)); 126 | 127 | foreach ($items as $key => $item) { 128 | $item->set($values[$key]); 129 | if ($expiration > 0) { 130 | $item->expiresAfter($expiration); 131 | } 132 | 133 | $this->cache->saveDeferred($item); 134 | } 135 | 136 | return $this->cache->commit(); 137 | } 138 | 139 | /** 140 | * Delete multiple values from the cache. 141 | * 142 | * @since 1.0.0 143 | * 144 | * @param array $keys The list of unique keys for the items in the cache to delete. 145 | * @return bool True on success, false on failure. 146 | */ 147 | public function deleteMultiple(array $keys): bool 148 | { 149 | return $this->cache->deleteItems($keys); 150 | } 151 | 152 | /** 153 | * Determine whether a value is present in the cache. 154 | * 155 | * @since 1.0.0 156 | * 157 | * @param string $key The unique key of this item. 158 | * @return bool True if the value is present, false otherwise. 159 | */ 160 | public function has(string $key): bool 161 | { 162 | $item = $this->cache->getItem($key); 163 | 164 | return $item->isHit(); 165 | } 166 | 167 | /** 168 | * Delete all values from the cache. 169 | * 170 | * @since 1.0.0 171 | * 172 | * @return bool True on success, false on failure. 173 | */ 174 | public function clear(): bool 175 | { 176 | return $this->cache->clear(); 177 | } 178 | 179 | /** 180 | * Get the cache client instance used by the adapter. 181 | * 182 | * @since 1.0.0 183 | * 184 | * @return object Cache client instance. 185 | */ 186 | public function getClient() 187 | { 188 | return $this->cache; 189 | } 190 | } 191 | -------------------------------------------------------------------------------- /src/CacheAdapter/PsrCacheAdapterFactory.php: -------------------------------------------------------------------------------- 1 | Psr6CacheAdapter::class, 27 | Psr16::class => Psr16CacheAdapter::class, 28 | ); 29 | 30 | /** 31 | * Create a cache adapter for a given cache implementation. 32 | * 33 | * @since 1.0.0 34 | * 35 | * @param Psr6|Psr16 $cache The cache implementation to wrap in the adapter. 36 | * @return CacheAdapter The cache adapter that wraps the passed cache implementation. 37 | * 38 | * @throws InvalidArgumentException Thrown if the cache implementation is not supported by this factory. 39 | */ 40 | public function create($cache): CacheAdapter 41 | { 42 | foreach (self::MAPPINGS as $interface => $adapter) { 43 | if ($cache instanceof $interface) { 44 | return new $adapter($cache); 45 | } 46 | } 47 | 48 | throw new InvalidArgumentException( 49 | sprintf( 50 | 'Incompatible cache implementation of class "%1$s" passed to "$2$s".', 51 | get_class($cache), 52 | get_class($this) 53 | ) 54 | ); 55 | } 56 | } 57 | -------------------------------------------------------------------------------- /src/CacheKeyGen/CacheKeyGen.php: -------------------------------------------------------------------------------- 1 | switchSiteContext($siteId); 43 | $this->switchNetworkContext($networkId); 44 | } 45 | 46 | /** 47 | * Generate the full cache key for a given key and group. 48 | * 49 | * @since 1.0.0 50 | * 51 | * @param string $key A cache key. 52 | * @param string $group A cache group. 53 | * @return string The full cache key to use with cache implementations. 54 | */ 55 | public function generate(string $key, string $group): string 56 | { 57 | switch (true) { 58 | case isset($this->globalGroups[$group]): 59 | $key = 'global.' . $group . '.' . $key; 60 | break; 61 | case isset($this->networkGroups[$group]): 62 | $key = 'network.' . $this->networkId . '.' . $group . '.' . $key; 63 | break; 64 | default: 65 | $key = 'site.' . $this->siteId . '.' . $group . '.' . $key; 66 | } 67 | 68 | if (defined('WP_CACHE_KEY_PREFIX') && !empty(WP_CACHE_KEY_PREFIX)) { 69 | $key = WP_CACHE_KEY_PREFIX . '.' . $key; 70 | } 71 | 72 | return $this->sanitize($key); 73 | } 74 | 75 | /** 76 | * Add cache groups to consider global groups. 77 | * 78 | * @since 1.0.0 79 | * 80 | * @param array $groups The list of groups that are global. 81 | */ 82 | public function addGlobalGroups(array $groups) 83 | { 84 | $groups = array_fill_keys($groups, true); 85 | $this->globalGroups = array_merge($this->globalGroups, $groups); 86 | } 87 | 88 | /** 89 | * Gets the list of global groups. 90 | * 91 | * @since 1.0.0 92 | * 93 | * @return array List of global groups. 94 | */ 95 | public function getGlobalGroups(): array 96 | { 97 | return array_keys($this->globalGroups); 98 | } 99 | 100 | /** 101 | * Add cache groups to consider network groups. 102 | * 103 | * @since 1.0.0 104 | * 105 | * @param array $groups The list of groups that are network-specific. 106 | */ 107 | public function addNetworkGroups(array $groups) 108 | { 109 | $groups = array_fill_keys($groups, true); 110 | $this->networkGroups = array_merge($this->networkGroups, $groups); 111 | } 112 | 113 | /** 114 | * Gets the list of network groups. 115 | * 116 | * @since 1.0.0 117 | * 118 | * @return array List of network groups. 119 | */ 120 | public function getNetworkGroups(): array 121 | { 122 | return array_keys($this->networkGroups); 123 | } 124 | 125 | /** 126 | * Switch the site context. 127 | * 128 | * @since 1.0.0 129 | * 130 | * @param int $siteId Site ID to switch the context to. 131 | */ 132 | public function switchSiteContext(int $siteId) 133 | { 134 | $this->siteId = $siteId; 135 | } 136 | 137 | /** 138 | * Get the site context. 139 | * 140 | * @since 1.0.0 141 | * 142 | * @return int Site ID of the current context. 143 | */ 144 | public function getSiteContext(): int 145 | { 146 | return $this->siteId; 147 | } 148 | 149 | /** 150 | * Switch the network context. 151 | * 152 | * @since 1.0.0 153 | * 154 | * @param int $networkId Network ID to switch the context to. 155 | */ 156 | public function switchNetworkContext(int $networkId) 157 | { 158 | $this->networkId = $networkId; 159 | } 160 | 161 | /** 162 | * Get the network context. 163 | * 164 | * @since 1.0.0 165 | * 166 | * @return int Network ID of the current context. 167 | */ 168 | public function getNetworkContext(): int 169 | { 170 | return $this->networkId; 171 | } 172 | 173 | /** 174 | * Sanitize a cache key by replacing unsupported characters. 175 | * 176 | * @since 1.0.0 177 | * 178 | * @param string $key A cache key. 179 | * @return string The sanitized cache key. 180 | */ 181 | protected function sanitize(string $key): string 182 | { 183 | // The following characters are not supported in PSR-6/PSR-16. 184 | $replacements = array( 185 | '{' => '', 186 | '}' => '', 187 | '(' => '', 188 | ')' => '', 189 | '/' => '', 190 | '\\' => '', 191 | '@' => '', 192 | ':' => '.', 193 | ' ' => '', // This is not explicitly forbidden, but causes issues easily. 194 | ); 195 | 196 | return str_replace(array_keys($replacements), array_values($replacements), $key); 197 | } 198 | } 199 | -------------------------------------------------------------------------------- /src/CacheSelector/BaseCacheSelector.php: -------------------------------------------------------------------------------- 1 | persistentCache = $persistentCache; 50 | $this->nonPersistentCache = $nonPersistentCache; 51 | } 52 | 53 | /** 54 | * Registers a cache adapter for a set of persistent groups. 55 | * 56 | * @since 1.0.0 57 | * 58 | * @param CacheAdapter $cache Cache adapter. 59 | * @param array $groups List of groups to use the cache adapter for. 60 | */ 61 | public function registerPersistentCache(CacheAdapter $cache, array $groups) 62 | { 63 | foreach ($groups as $group) { 64 | $this->persistentCaches[$group] = $cache; 65 | } 66 | } 67 | 68 | /** 69 | * Registers a cache adapter for a set of non-persistent groups. 70 | * 71 | * @since 1.0.0 72 | * 73 | * @param CacheAdapter $cache Cache adapter. 74 | * @param array $groups List of groups to use the cache adapter for. 75 | */ 76 | public function registerNonPersistentCache(CacheAdapter $cache, array $groups) 77 | { 78 | foreach ($groups as $group) { 79 | $this->nonPersistentCaches[$group] = $cache; 80 | } 81 | } 82 | 83 | /** 84 | * Selects the persistent cache adapter to use for a given cache group. 85 | * 86 | * If no persistent cache adapter is registered for the group specifically, 87 | * the default persistent cache adapter will be returned. 88 | * 89 | * @since 1.0.0 90 | * 91 | * @param string $group A cache group. 92 | * @return CacheAdapter Cache adapter to use for the group. 93 | */ 94 | public function selectPersistentCache(string $group): CacheAdapter 95 | { 96 | if (isset($this->persistentCaches[$group])) { 97 | return $this->persistentCaches[$group]; 98 | } 99 | 100 | return $this->persistentCache; 101 | } 102 | 103 | /** 104 | * Selects the non-persistent cache adapter to use for a given cache group. 105 | * 106 | * If no non-persistent cache adapter is registered for the group specifically, 107 | * the default non-persistent cache adapter will be returned. 108 | * 109 | * @since 1.0.0 110 | * 111 | * @param string $group A cache group. 112 | * @return CacheAdapter Cache adapter to use for the group. 113 | */ 114 | public function selectNonPersistentCache(string $group): CacheAdapter 115 | { 116 | if (isset($this->nonPersistentCaches[$group])) { 117 | return $this->nonPersistentCaches[$group]; 118 | } 119 | 120 | return $this->nonPersistentCache; 121 | } 122 | 123 | /** 124 | * Add cache groups to consider non-persistent groups. 125 | * 126 | * @since 1.0.0 127 | * 128 | * @param array $groups The list of groups that are non-persistent. 129 | */ 130 | public function addNonPersistentGroups(array $groups) 131 | { 132 | $groups = array_fill_keys($groups, true); 133 | $this->nonPersistentGroups = array_merge($this->nonPersistentGroups, $groups); 134 | } 135 | 136 | /** 137 | * Gets the list of non-persistent groups. 138 | * 139 | * @since 1.0.0 140 | * 141 | * @return array List of non-persistent groups. 142 | */ 143 | public function getNonPersistentGroups(): array 144 | { 145 | return array_keys($this->nonPersistentGroups); 146 | } 147 | 148 | /** 149 | * Determine whether a cache group is non-persistent. 150 | * 151 | * @since 1.0.0 152 | * 153 | * @param string $group A cache group. 154 | * @return bool True if the group is non-persistent, false otherwise. 155 | */ 156 | public function isNonPersistentGroup(string $group): bool 157 | { 158 | return isset($this->nonPersistentGroups[$group]); 159 | } 160 | 161 | /** 162 | * Delete all values from the persistent caches. 163 | * 164 | * @since 1.0.0 165 | * 166 | * @return bool True on success, false on failure. 167 | */ 168 | public function clearPersistent(): bool 169 | { 170 | return $this->persistentCache->clear() && $this->clearCaches($this->persistentCaches); 171 | } 172 | 173 | /** 174 | * Delete all values from the non-persistent caches. 175 | * 176 | * @since 1.0.0 177 | * 178 | * @return bool True on success, false on failure. 179 | */ 180 | public function clearNonPersistent(): bool 181 | { 182 | return $this->nonPersistentCache->clear() && $this->clearCaches($this->nonPersistentCaches); 183 | } 184 | 185 | /** 186 | * Delete all values from a set of caches. 187 | * 188 | * @since 1.0.0 189 | * 190 | * @param array $caches List of cache adapter instances. 191 | * @return bool True on success, false on failure. 192 | */ 193 | protected function clearCaches(array $caches): bool 194 | { 195 | $caches = array_filter($caches); 196 | $clearedCaches = array_filter(array_map(function ($cache) { 197 | return $cache->clear(); 198 | }, $caches)); 199 | 200 | return count($caches) === count($clearedCaches); 201 | } 202 | } 203 | -------------------------------------------------------------------------------- /src/CacheSelector/BaseCacheSelectorFactory.php: -------------------------------------------------------------------------------- 1 | selector = $selector; 51 | $this->keygen = $keygen; 52 | } 53 | 54 | /** 55 | * Obtain a value from the cache. 56 | * 57 | * @since 1.0.0 58 | * 59 | * @param string $key The key of this item in the cache. 60 | * @param string $group Optional. The group of this item in the cache. Default 'default'. 61 | * @param bool $force Optional. Whether to force an update of the non-persistent cache 62 | * from the persistent cache. Default false. 63 | * @param bool &$found Optional. Whether the key was found in the cache (passed by reference). 64 | * Disambiguates a return of false, a storable value. Default false. 65 | * @return mixed The value of the item from the cache, or false in case of cache miss. 66 | */ 67 | public function get(string $key, string $group = self::DEFAULT_GROUP, bool $force = false, bool &$found = false) 68 | { 69 | $group = $this->parseDefaultGroup($group); 70 | $key = $this->keygen->generate($key, $group); 71 | 72 | $nonPersistentCache = $this->selector->selectNonPersistentCache($group); 73 | 74 | $found = false; 75 | 76 | $nonPersistent = $this->selector->isNonPersistentGroup($group); 77 | if ($nonPersistent || !$force) { 78 | if ($nonPersistentCache->has($key)) { 79 | $this->cacheHits++; 80 | $found = true; 81 | return $nonPersistentCache->get($key); 82 | } 83 | 84 | if ($nonPersistent) { 85 | $this->cacheMisses++; 86 | return false; 87 | } 88 | } 89 | 90 | $persistentCache = $this->selector->selectPersistentCache($group); 91 | 92 | if ($persistentCache->has($key)) { 93 | $this->cacheHits++; 94 | $found = true; 95 | $value = $persistentCache->get($key); 96 | 97 | $nonPersistentCache->set($key, $value); 98 | 99 | return $value; 100 | } 101 | 102 | $this->cacheMisses++; 103 | return false; 104 | } 105 | 106 | /** 107 | * Store a value in the cache. 108 | * 109 | * @since 1.0.0 110 | * 111 | * @param string $key The key of the item to store. 112 | * @param mixed $value The value of the item to store. Must be serializable. 113 | * @param string $group Optional. The group of the item to store. Default 'default'. 114 | * @param int $expiration Optional. When to expire the value, passed in seconds. Default 0 (no expiration). 115 | * @return bool True on success, false on failure. 116 | */ 117 | public function set(string $key, $value, string $group = self::DEFAULT_GROUP, int $expiration = 0): bool 118 | { 119 | $group = $this->parseDefaultGroup($group); 120 | $key = $this->keygen->generate($key, $group); 121 | 122 | $nonPersistentCache = $this->selector->selectNonPersistentCache($group); 123 | 124 | if ($this->selector->isNonPersistentGroup($group)) { 125 | return $nonPersistentCache->set($key, $value, $expiration); 126 | } 127 | 128 | $persistentCache = $this->selector->selectPersistentCache($group); 129 | 130 | if ($persistentCache->set($key, $value, $expiration)) { 131 | $nonPersistentCache->set($key, $value, $expiration); 132 | 133 | return true; 134 | } 135 | 136 | return false; 137 | } 138 | 139 | /** 140 | * Store a value in the cache if its key is not already set. 141 | * 142 | * @since 1.0.0 143 | * 144 | * @param string $key The key of the item to store. 145 | * @param mixed $value The value of the item to store. Must be serializable. 146 | * @param string $group Optional. The group of the item to store. Default 'default'. 147 | * @param int $expiration Optional. When to expire the value, passed in seconds. Default 0 (no expiration). 148 | * @return bool True on success, false on failure. 149 | */ 150 | public function add(string $key, $value, string $group = self::DEFAULT_GROUP, int $expiration = 0): bool 151 | { 152 | $group = $this->parseDefaultGroup($group); 153 | $key = $this->keygen->generate($key, $group); 154 | 155 | $nonPersistentCache = $this->selector->selectNonPersistentCache($group); 156 | 157 | if ($this->selector->isNonPersistentGroup($group)) { 158 | return !$nonPersistentCache->has($key) && $nonPersistentCache->set($key, $value, $expiration); 159 | } 160 | 161 | $persistentCache = $this->selector->selectPersistentCache($group); 162 | 163 | if (!$persistentCache->has($key) && $persistentCache->set($key, $value, $expiration)) { 164 | $nonPersistentCache->set($key, $value, $expiration); 165 | 166 | return true; 167 | } 168 | 169 | return false; 170 | } 171 | 172 | /** 173 | * Store a value in the cache if its key is already set. 174 | * 175 | * @since 1.0.0 176 | * 177 | * @param string $key The key of the item to store. 178 | * @param mixed $value The value of the item to store. Must be serializable. 179 | * @param string $group Optional. The group of the item to store. Default 'default'. 180 | * @param int $expiration Optional. When to expire the value, passed in seconds. Default 0 (no expiration). 181 | * @return bool True on success, false on failure. 182 | */ 183 | public function replace(string $key, $value, string $group = self::DEFAULT_GROUP, int $expiration = 0): bool 184 | { 185 | $group = $this->parseDefaultGroup($group); 186 | $key = $this->keygen->generate($key, $group); 187 | 188 | $nonPersistentCache = $this->selector->selectNonPersistentCache($group); 189 | 190 | if ($this->selector->isNonPersistentGroup($group)) { 191 | return $nonPersistentCache->has($key) && $nonPersistentCache->set($key, $value, $expiration); 192 | } 193 | 194 | $persistentCache = $this->selector->selectPersistentCache($group); 195 | 196 | if ($persistentCache->has($key) && $persistentCache->set($key, $value, $expiration)) { 197 | $nonPersistentCache->set($key, $value, $expiration); 198 | 199 | return true; 200 | } 201 | 202 | return false; 203 | } 204 | 205 | /** 206 | * Increment a numeric value in the cache. 207 | * 208 | * @since 1.0.0 209 | * 210 | * @param string $key The key of the item to increment its value. 211 | * @param int $offset Optional. The amount by which to increment the value. Default 1. 212 | * @param string $group Optional. The group of the item to increment. Default 'default'. 213 | * @return int|bool The item's new value on success, false on failure. 214 | */ 215 | public function increment(string $key, int $offset = 1, string $group = self::DEFAULT_GROUP) 216 | { 217 | $value = $this->get($key, $group, false, $found); 218 | 219 | if (!$found) { 220 | return false; 221 | } 222 | 223 | $value = is_numeric($value) ? $value + $offset : 0; 224 | 225 | // A value below 0 is not allowed. 226 | $value = $value >= 0 ? $value : 0; 227 | 228 | if ($this->set($key, $value, $group)) { 229 | return $value; 230 | } 231 | 232 | return false; 233 | } 234 | 235 | /** 236 | * Decrement a numeric value in the cache. 237 | * 238 | * @since 1.0.0 239 | * 240 | * @param string $key The key of the item to decrement its value. 241 | * @param int $offset Optional. The amount by which to decrement the value. Default 1. 242 | * @param string $group Optional. The group of the item to decrement. Default 'default'. 243 | * @return int|bool The item's new value on success, false on failure. 244 | */ 245 | public function decrement(string $key, int $offset = 1, string $group = self::DEFAULT_GROUP) 246 | { 247 | $value = $this->get($key, $group, false, $found); 248 | 249 | if (!$found) { 250 | return false; 251 | } 252 | 253 | $value = is_numeric($value) ? $value - $offset : 0; 254 | 255 | // A value below 0 is not allowed. 256 | $value = $value >= 0 ? $value : 0; 257 | 258 | if ($this->set($key, $value, $group)) { 259 | return $value; 260 | } 261 | 262 | return false; 263 | } 264 | 265 | /** 266 | * Delete a value from the cache. 267 | * 268 | * @since 1.0.0 269 | * 270 | * @param string $key The key of the item to delete. 271 | * @param string $group Optional. The group of the item to delete. Default 'default'. 272 | * @return bool True on success, false on failure. 273 | */ 274 | public function delete(string $key, string $group = self::DEFAULT_GROUP): bool 275 | { 276 | $group = $this->parseDefaultGroup($group); 277 | $key = $this->keygen->generate($key, $group); 278 | 279 | $nonPersistentCache = $this->selector->selectNonPersistentCache($group); 280 | 281 | if ($this->selector->isNonPersistentGroup($group)) { 282 | // If the item is not in the cache, return true. 283 | return !$nonPersistentCache->has($key) || $nonPersistentCache->delete($key); 284 | } 285 | 286 | $persistentCache = $this->selector->selectPersistentCache($group); 287 | 288 | // If the item is not in the cache, return true. 289 | if (!$persistentCache->has($key) || $persistentCache->delete($key)) { 290 | $nonPersistentCache->delete($key); 291 | 292 | return true; 293 | } 294 | 295 | return false; 296 | } 297 | 298 | /** 299 | * Delete all values from the cache. 300 | * 301 | * @since 1.0.0 302 | * 303 | * @return bool True on success, false on failure. 304 | */ 305 | public function flush(): bool 306 | { 307 | if ($this->selector->clearPersistent()) { 308 | $this->selector->clearNonPersistent(); 309 | 310 | return true; 311 | } 312 | 313 | return false; 314 | } 315 | 316 | /** 317 | * Determine whether a value is present in the cache. 318 | * 319 | * @since 1.0.0 320 | * 321 | * @param string $key The key of the item in the cache. 322 | * @param string $group Optional. The group of the item in the cache. Default 'default'. 323 | * @return bool True if the value is present, false otherwise. 324 | */ 325 | public function has(string $key, string $group = self::DEFAULT_GROUP): bool 326 | { 327 | $group = $this->parseDefaultGroup($group); 328 | $key = $this->keygen->generate($key, $group); 329 | 330 | $nonPersistentCache = $this->selector->selectNonPersistentCache($group); 331 | 332 | if ($this->selector->isNonPersistentGroup($group)) { 333 | return $nonPersistentCache->has($key); 334 | } 335 | 336 | $persistentCache = $this->selector->selectPersistentCache($group); 337 | 338 | return $persistentCache->has($key); 339 | } 340 | 341 | /** 342 | * Obtain multiple values from the cache. 343 | * 344 | * @since 1.0.0 345 | * 346 | * @param array $keys The list of keys for the items in the cache. 347 | * @param string $group Optional. The group of the items in the cache. Default 'default'. 348 | * @param bool $force Optional. Whether to force an update of the non-persistent cache 349 | * from the persistent cache. Default false. 350 | * @return array List of key => value pairs. For cache misses, false will be used as value. 351 | */ 352 | public function getMultiple(array $keys, string $group = self::DEFAULT_GROUP, bool $force = false): array 353 | { 354 | $group = $this->parseDefaultGroup($group); 355 | $fullKeys = $this->buildKeys($keys, $group); 356 | 357 | $nonPersistentCache = $this->selector->selectNonPersistentCache($group); 358 | 359 | if ($this->selector->isNonPersistentGroup($group)) { 360 | $values = array_combine($keys, $nonPersistentCache->getMultiple($fullKeys)); 361 | 362 | $this->checkMultipleHitsAndMisses($values); 363 | return $values; 364 | } 365 | 366 | if (!$force) { 367 | $values = $nonPersistentCache->getMultiple($fullKeys); 368 | $needed = array(); 369 | foreach ($values as $fullKey => $value) { 370 | if (false !== $value) { 371 | continue; 372 | } 373 | 374 | $needed[] = $fullKey; 375 | } 376 | } else { 377 | $values = array(); 378 | $needed = $fullKeys; 379 | } 380 | 381 | if (!empty($needed)) { 382 | $persistentCache = $this->selector->selectPersistentCache($group); 383 | 384 | // For cache misses in original lookup, check the persistent cache. 385 | $persistentValues = $persistentCache->getMultiple($needed); 386 | 387 | $values = array_merge($values, $persistentValues); 388 | } 389 | 390 | $values = array_combine($keys, $values); 391 | 392 | $this->checkMultipleHitsAndMisses($values); 393 | return $values; 394 | } 395 | 396 | /** 397 | * Store multiple values in the cache. 398 | * 399 | * @since 1.0.0 400 | * 401 | * @param array $values The list of key => value pairs to store. 402 | * @param string $group Optional. The group of the items to store. Default 'default'. 403 | * @param int $expiration Optional. When to expire the value, passed in seconds. Default 0 (no expiration). 404 | * @return bool True on success, false on failure. 405 | */ 406 | public function setMultiple(array $values, string $group = self::DEFAULT_GROUP, int $expiration = 0): bool 407 | { 408 | $group = $this->parseDefaultGroup($group); 409 | $fullKeys = $this->buildKeys(array_keys($values), $group); 410 | $fullValues = array_combine($fullKeys, $values); 411 | 412 | $nonPersistentCache = $this->selector->selectNonPersistentCache($group); 413 | 414 | if ($this->selector->isNonPersistentGroup($group)) { 415 | return $nonPersistentCache->setMultiple($fullValues, $expiration); 416 | } 417 | 418 | $persistentCache = $this->selector->selectPersistentCache($group); 419 | 420 | if ($persistentCache->setMultiple($fullValues, $expiration)) { 421 | $nonPersistentCache->set($fullValues, $expiration); 422 | 423 | return true; 424 | } 425 | 426 | return false; 427 | } 428 | 429 | /** 430 | * Delete multiple values from the cache. 431 | * 432 | * @since 1.0.0 433 | * 434 | * @param array $keys The list of keys for the items in the cache to delete. 435 | * @param string $group Optional. The group of the items to delete. Default 'default'. 436 | * @return bool True on success, false on failure. 437 | */ 438 | public function deleteMultiple(array $keys, string $group = self::DEFAULT_GROUP): bool 439 | { 440 | $group = $this->parseDefaultGroup($group); 441 | $fullKeys = $this->buildKeys($keys, $group); 442 | 443 | $nonPersistentCache = $this->selector->selectNonPersistentCache($group); 444 | 445 | if ($this->selector->isNonPersistentGroup($group)) { 446 | return $nonPersistentCache->deleteMultiple($fullKeys); 447 | } 448 | 449 | $persistentCache = $this->selector->selectPersistentCache($group); 450 | 451 | if ($persistentCache->deleteMultiple($fullKeys)) { 452 | $nonPersistentCache->deleteMultiple($fullKeys); 453 | 454 | return true; 455 | } 456 | 457 | return false; 458 | } 459 | 460 | /** 461 | * Get the selector used by the object cache. 462 | * 463 | * @since 1.0.0 464 | * 465 | * @return CacheSelector Selector instance. 466 | */ 467 | public function getSelector(): CacheSelector 468 | { 469 | return $this->selector; 470 | } 471 | 472 | /** 473 | * Get the key generator used by the object cache. 474 | * 475 | * @since 1.0.0 476 | * 477 | * @return CacheKeyGen Key generator instance. 478 | */ 479 | public function getKeygen(): CacheKeyGen 480 | { 481 | return $this->keygen; 482 | } 483 | 484 | /** 485 | * Gets the amount of times the cache data was already stored in the cache. 486 | * 487 | * @since 1.0.0 488 | * 489 | * @return int Amount of cache hits. 490 | */ 491 | public function getCacheHits(): int 492 | { 493 | return $this->cacheHits; 494 | } 495 | 496 | /** 497 | * Gets the amount of times the cache data was not stored in the cache. 498 | * 499 | * @since 1.0.0 500 | * 501 | * @return int Amount of cache misses. 502 | */ 503 | public function getCacheMisses(): int 504 | { 505 | return $this->cacheMisses; 506 | } 507 | 508 | /** 509 | * Output cache-related stats. 510 | * 511 | * @since 1.0.0 512 | */ 513 | public function stats() 514 | { 515 | $out = array(); 516 | 517 | $out[] = '

'; 518 | $out[] = 'Cache Hits: ' . $this->cacheHits . '
'; 519 | $out[] = 'Cache Misses: ' . $this->cacheMisses . '
'; 520 | $out[] = 'Persistent Cache Client: ' . get_class( $this->selector->selectPersistentCache( '' )->getClient() ) . '
'; 521 | $out[] = 'Non-Persistent Cache Client: ' . get_class( $this->selector->selectNonPersistentCache( '' )->getClient() ) . ''; 522 | $out[] = '

'; 523 | 524 | echo implode( PHP_EOL, $out ); 525 | } 526 | 527 | /** 528 | * Magic getter. 529 | * 530 | * Allows for backward-compatibility with plugins still doing it wrong. 531 | * 532 | * @since 1.0.0 533 | * 534 | * @param string $name Property to get. 535 | * @return mixed Property value. 536 | */ 537 | public function __get(string $name) 538 | { 539 | switch($name) { 540 | case 'cache_hits': 541 | return $this->cacheHits; 542 | case 'cache_misses': 543 | return $this->cacheMisses; 544 | case 'global_groups': 545 | return $this->keygen->getGlobalGroups(); 546 | case 'non_persistent_groups': 547 | return $this->selector->getNonPersistentGroups(); 548 | } 549 | } 550 | 551 | /** 552 | * Magic setter. 553 | * 554 | * Allows for backward-compatibility with plugins still doing it wrong. 555 | * 556 | * @since 1.0.0 557 | * 558 | * @param string $name Property to set. 559 | * @param mixed $value Property value. 560 | */ 561 | public function __set(string $name, $value) 562 | { 563 | switch($name) { 564 | case 'cache_hits': 565 | $this->cacheHits = (int) $value; 566 | case 'cache_misses': 567 | $this->cacheMisses = (int) $value; 568 | case 'global_groups': 569 | $this->keygen->addGlobalGroups((array) $value); 570 | case 'non_persistent_groups': 571 | $this->selector->addNonPersistentGroups((array) $value); 572 | } 573 | } 574 | 575 | /** 576 | * Magic isset-er. 577 | * 578 | * Allows for backward-compatibility with plugins still doing it wrong. 579 | * 580 | * @since 1.0.0 581 | * 582 | * @param string $name Property to check if set. 583 | * @return bool True if property is set, false otherwise. 584 | */ 585 | public function __isset(string $name): bool 586 | { 587 | switch($name) { 588 | case 'cache_hits': 589 | case 'cache_misses': 590 | case 'global_groups': 591 | case 'non_persistent_groups': 592 | return true; 593 | } 594 | 595 | return false; 596 | } 597 | 598 | /** 599 | * Get the default group in case the passed group is empty. 600 | * 601 | * @since 1.0.0 602 | * 603 | * @param string $group A cache group. 604 | * @return string The value of $group, or the default group. 605 | */ 606 | private function parseDefaultGroup(string $group) 607 | { 608 | return empty($group) ? self::DEFAULT_GROUP : $group; 609 | } 610 | 611 | /** 612 | * Builds full cache keys for given keys and a group. 613 | * 614 | * @since 1.0.0 615 | * 616 | * @param array $keys A list of cache keys. 617 | * @param string $group The cache group for the keys. 618 | * @return array The list of full cache keys. 619 | */ 620 | private function buildKeys(array $keys, string $group): array 621 | { 622 | $fullKeys = array(); 623 | 624 | foreach ($keys as $key) { 625 | $fullKeys[] = $this->keygen->generate($key, $group); 626 | } 627 | 628 | return $fullKeys; 629 | } 630 | 631 | /** 632 | * Increases the cache hits and misses by evaluating a result for multiple cache keys. 633 | * 634 | * @since 1.0.0 635 | * 636 | * @param array $values Array of $key => $value pairs as a cache lookup result. 637 | */ 638 | private function checkMultipleHitsAndMisses(array $values) 639 | { 640 | $foundValues = array_filter($values, function($value) { 641 | return false !== $value; 642 | }); 643 | 644 | $this->cacheHits += count($foundValues); 645 | $this->cacheMisses += count($values) - count($foundValues); 646 | } 647 | } 648 | -------------------------------------------------------------------------------- /src/ObjectCacheFactory.php: -------------------------------------------------------------------------------- 1 | keygen = new WpPsrCacheKeyGen(1, 1); 27 | $this->keygen->addGlobalGroups($this->globalGroups); 28 | $this->keygen->addNetworkGroups($this->networkGroups); 29 | } 30 | 31 | public function tearDown() 32 | { 33 | $this->keygen->switchSiteContext(1); 34 | $this->keygen->switchNetworkContext(1); 35 | } 36 | 37 | /** 38 | * @dataProvider dataGenerate 39 | */ 40 | public function testGenerate(string $key, string $group, int $siteId, int $networkId, string $expected) 41 | { 42 | $this->keygen->switchSiteContext($siteId); 43 | $this->keygen->switchNetworkContext($networkId); 44 | 45 | $this->assertSame($expected, $this->keygen->generate($key, $group)); 46 | } 47 | 48 | public function dataGenerate() 49 | { 50 | return array( 51 | array('key1', 'site_options', 1, 1, 'site.1.site_options.key1'), 52 | array('key2', 'site_options', 2, 1, 'site.2.site_options.key2'), 53 | array('key3', 'site_options', 1, 2, 'site.1.site_options.key3'), 54 | array('key4', 'site_options', 2, 2, 'site.2.site_options.key4'), 55 | array('key5', 'network_options', 1, 1, 'network.1.network_options.key5'), 56 | array('key6', 'network_options', 2, 1, 'network.1.network_options.key6'), 57 | array('key7', 'network_options', 1, 2, 'network.2.network_options.key7'), 58 | array('key8', 'network_options', 2, 2, 'network.2.network_options.key8'), 59 | array('key9', 'global_options', 1, 1, 'global.global_options.key9'), 60 | array('key10', 'global_options', 2, 1, 'global.global_options.key10'), 61 | array('key11', 'global_options', 1, 2, 'global.global_options.key11'), 62 | array('key12', 'global_options', 2, 2, 'global.global_options.key12'), 63 | ); 64 | } 65 | 66 | /** 67 | * @dataProvider dataSanitize 68 | */ 69 | public function testSanitize(string $key, string $expected) 70 | { 71 | $key = $this->keygen->generate($key, 'global_options'); 72 | $key = substr($key, strlen('global.global_options.')); 73 | 74 | $this->assertSame($expected, $key); 75 | } 76 | 77 | public function dataSanitize() 78 | { 79 | return array( 80 | array('hello', 'hello'), 81 | array('alphanumerickey1', 'alphanumerickey1'), 82 | array('alpha_numeric_key2', 'alpha_numeric_key2'), 83 | array('1numberatbeginning', '1numberatbeginning'), 84 | array('1', '1'), 85 | array('key.with.dot', 'key.with.dot'), 86 | array('key:with:colon', 'key.with.colon'), 87 | array('key with space', 'keywithspace'), 88 | array('key@with{special}characters', 'keywithspecialcharacters'), 89 | array('(more\special/characters)', 'morespecialcharacters'), 90 | ); 91 | } 92 | } 93 | --------------------------------------------------------------------------------