class-ad-list-stats.php
1 week ago
class-cache.php
1 week ago
class-conditional.php
3 months ago
class-content-injection.php
1 year ago
class-data.php
1 week ago
class-sanitize.php
1 year ago
class-testing.php
1 year ago
class-validation.php
1 year ago
class-wordpress.php
1 week ago
index.php
2 years ago
class-cache.php
190 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Object cache helper for Advanced Ads entity data. |
| 4 | * |
| 5 | * @package AdvancedAds |
| 6 | * @author Advanced Ads <info@wpadvancedads.com> |
| 7 | * @since 2.0.14 |
| 8 | */ |
| 9 | |
| 10 | namespace AdvancedAds\Utilities; |
| 11 | |
| 12 | defined( 'ABSPATH' ) || exit; |
| 13 | |
| 14 | /** |
| 15 | * Cache. |
| 16 | * |
| 17 | * Wraps wp_cache_* with versioned keys per prefix so flush_group() can invalidate |
| 18 | * a whole namespace without deleting individual entries (Redis-friendly). |
| 19 | */ |
| 20 | class Cache { |
| 21 | |
| 22 | /** |
| 23 | * wp_cache group for all Advanced Ads cache entries. |
| 24 | * |
| 25 | * @var string |
| 26 | */ |
| 27 | public const GROUP = 'advanced-ads'; |
| 28 | |
| 29 | /** |
| 30 | * Cache prefix for ad list / entity data. |
| 31 | * |
| 32 | * @var string |
| 33 | */ |
| 34 | public const PREFIX_ADS = 'ads'; |
| 35 | |
| 36 | /** |
| 37 | * Cache prefix for group list / entity data. |
| 38 | * |
| 39 | * @var string |
| 40 | */ |
| 41 | public const PREFIX_GROUPS = 'groups'; |
| 42 | |
| 43 | /** |
| 44 | * Cache prefix for placement list / entity data. |
| 45 | * |
| 46 | * @var string |
| 47 | */ |
| 48 | public const PREFIX_PLACEMENTS = 'placements'; |
| 49 | |
| 50 | /** |
| 51 | * Logical key: ID => lightweight list row (all entity prefixes). |
| 52 | * |
| 53 | * @var string |
| 54 | */ |
| 55 | public const KEY_SUMMARIES = 'summaries'; |
| 56 | |
| 57 | /** |
| 58 | * Logical key: ID => lightweight list row for post_status any (includes trash). |
| 59 | * |
| 60 | * @var string |
| 61 | */ |
| 62 | public const KEY_SUMMARIES_ALL_STATUSES = 'summaries_all_statuses'; |
| 63 | |
| 64 | /** |
| 65 | * Logical key: all entity IDs. |
| 66 | * |
| 67 | * @var string |
| 68 | */ |
| 69 | public const KEY_ALL_IDS = 'all_ids'; |
| 70 | |
| 71 | /** |
| 72 | * Suffix for version counter keys stored in the object cache. |
| 73 | * |
| 74 | * @var string |
| 75 | */ |
| 76 | private const VERSION_SUFFIX = ':version'; |
| 77 | |
| 78 | /** |
| 79 | * Known prefixes that flush_all() invalidates. |
| 80 | * |
| 81 | * @var string[] |
| 82 | */ |
| 83 | private const PREFIXES = [ |
| 84 | self::PREFIX_ADS, |
| 85 | self::PREFIX_GROUPS, |
| 86 | self::PREFIX_PLACEMENTS, |
| 87 | ]; |
| 88 | |
| 89 | /** |
| 90 | * Read a cached value. |
| 91 | * |
| 92 | * Returns null on cache miss. Callers should build the value and store it with set(). |
| 93 | * |
| 94 | * @param string $prefix Namespace prefix (e.g. self::PREFIX_ADS). |
| 95 | * @param string $key Logical cache key (e.g. self::KEY_SUMMARIES). |
| 96 | * |
| 97 | * @return mixed|null Cached value, or null when not found. |
| 98 | */ |
| 99 | public static function get( string $prefix, string $key ) { |
| 100 | $cache_key = self::build_key( $prefix, $key ); |
| 101 | $found = false; |
| 102 | $value = wp_cache_get( $cache_key, self::GROUP, false, $found ); |
| 103 | |
| 104 | if ( ! $found ) { |
| 105 | return null; |
| 106 | } |
| 107 | |
| 108 | return $value; |
| 109 | } |
| 110 | |
| 111 | /** |
| 112 | * Store a value in the cache. |
| 113 | * |
| 114 | * @param string $prefix Namespace prefix. |
| 115 | * @param string $key Logical cache key. |
| 116 | * @param mixed $value Value to store. |
| 117 | * |
| 118 | * @return bool |
| 119 | */ |
| 120 | public static function set( string $prefix, string $key, $value ): bool { |
| 121 | return wp_cache_set( self::build_key( $prefix, $key ), $value, self::GROUP ); |
| 122 | } |
| 123 | |
| 124 | /** |
| 125 | * Delete a single cached value. |
| 126 | * |
| 127 | * @param string $prefix Namespace prefix. |
| 128 | * @param string $key Logical cache key. |
| 129 | * |
| 130 | * @return bool |
| 131 | */ |
| 132 | public static function delete( string $prefix, string $key ): bool { |
| 133 | return wp_cache_delete( self::build_key( $prefix, $key ), self::GROUP ); |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Invalidate all entries under a prefix by bumping its version counter. |
| 138 | * |
| 139 | * @param string $prefix Namespace prefix. |
| 140 | * |
| 141 | * @return void |
| 142 | */ |
| 143 | public static function flush_group( string $prefix ): void { |
| 144 | $version_key = $prefix . self::VERSION_SUFFIX; |
| 145 | wp_cache_set( $version_key, self::get_version( $prefix ) + 1, self::GROUP ); |
| 146 | } |
| 147 | |
| 148 | /** |
| 149 | * Invalidate all known entity cache prefixes. |
| 150 | * |
| 151 | * @return void |
| 152 | */ |
| 153 | public static function flush_all(): void { |
| 154 | foreach ( self::PREFIXES as $prefix ) { |
| 155 | self::flush_group( $prefix ); |
| 156 | } |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * Build the full wp_cache key for a logical key under a prefix. |
| 161 | * |
| 162 | * @param string $prefix Namespace prefix. |
| 163 | * @param string $key Logical cache key. |
| 164 | * |
| 165 | * @return string |
| 166 | */ |
| 167 | public static function build_key( string $prefix, string $key ): string { |
| 168 | return $prefix . ':v' . self::get_version( $prefix ) . ':' . $key; |
| 169 | } |
| 170 | |
| 171 | /** |
| 172 | * Get the current version counter for a prefix. |
| 173 | * |
| 174 | * @param string $prefix Namespace prefix. |
| 175 | * |
| 176 | * @return int |
| 177 | */ |
| 178 | public static function get_version( string $prefix ): int { |
| 179 | $version_key = $prefix . self::VERSION_SUFFIX; |
| 180 | $found = false; |
| 181 | $version = wp_cache_get( $version_key, self::GROUP, false, $found ); |
| 182 | |
| 183 | if ( $found ) { |
| 184 | return (int) $version; |
| 185 | } |
| 186 | |
| 187 | return 1; |
| 188 | } |
| 189 | } |
| 190 |