admin
1 day ago
api
3 years ago
database
5 months ago
deprecated
1 month ago
donors
5 months ago
emails
9 months ago
forms
1 day ago
frontend
6 years ago
gateways
9 months ago
libraries
9 months ago
payments
2 months ago
actions.php
9 months ago
ajax-functions.php
3 days ago
class-give-async-process.php
1 year ago
class-give-background-updater.php
9 months ago
class-give-cache-setting.php
1 year ago
class-give-cache.php
9 months ago
class-give-cli-commands.php
1 year ago
class-give-comment.php
9 months ago
class-give-cron.php
9 months ago
class-give-donate-form.php
1 year ago
class-give-donor.php
2 years ago
class-give-email-access.php
5 years ago
class-give-license-handler.php
1 month ago
class-give-logging.php
9 months ago
class-give-readme-parser.php
4 years ago
class-give-roles.php
5 months ago
class-give-scripts.php
2 weeks ago
class-give-session.php
9 months ago
class-give-stats.php
6 years ago
class-give-template-loader.php
6 years ago
class-give-tooltips.php
6 years ago
class-give-translation.php
4 years ago
class-notices.php
9 months ago
country-functions.php
7 months ago
currencies-list.php
7 months ago
currency-functions.php
3 years ago
error-tracking.php
6 years ago
filters.php
9 months ago
formatting.php
9 months ago
install.php
9 months ago
login-register.php
2 years ago
misc-functions.php
1 month ago
plugin-compatibility.php
6 years ago
post-types.php
1 year ago
price-functions.php
6 years ago
process-donation.php
1 year ago
setting-functions.php
6 years ago
shortcodes.php
1 year ago
template-functions.php
1 year ago
user-functions.php
3 years ago
class-give-cache-setting.php
291 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Class for managing plugin settings cache |
| 4 | * |
| 5 | * Note: only use for internal purpose. |
| 6 | * |
| 7 | * @package Give |
| 8 | * @subpackage Classes/Give_Cache_Setting |
| 9 | * @copyright Copyright (c) 2018, GiveWP |
| 10 | * @license https://opensource.org/licenses/gpl-license GNU Public License |
| 11 | * @since 2.4.0 |
| 12 | */ |
| 13 | |
| 14 | // Exit if accessed directly. |
| 15 | if ( ! defined( 'ABSPATH' ) ) { |
| 16 | exit; |
| 17 | } |
| 18 | |
| 19 | /** |
| 20 | * Class Give_Cache_Setting |
| 21 | */ |
| 22 | class Give_Cache_Setting { |
| 23 | /** |
| 24 | * Instance. |
| 25 | * |
| 26 | * @since 2.4.0 |
| 27 | * @access private |
| 28 | * @var Give_Cache_Setting |
| 29 | */ |
| 30 | private static $instance; |
| 31 | |
| 32 | /** |
| 33 | * Cache key. |
| 34 | * |
| 35 | * @since 2.4.0 |
| 36 | * @access private |
| 37 | * @var string |
| 38 | */ |
| 39 | private $cache_key = 'giveAllOptions'; |
| 40 | |
| 41 | |
| 42 | /** |
| 43 | * Cache group. |
| 44 | * |
| 45 | * @since 2.4.0 |
| 46 | * @access private |
| 47 | * @var string |
| 48 | */ |
| 49 | private $cache_group = 'give-options'; |
| 50 | |
| 51 | /** |
| 52 | * Array of cached settings |
| 53 | * |
| 54 | * @since 2.4.0 |
| 55 | * @access private |
| 56 | * @var array |
| 57 | */ |
| 58 | private $settings = [ |
| 59 | 'give_settings' => [], |
| 60 | 'give_version' => '', |
| 61 | 'give_completed_upgrades' => [], |
| 62 | 'give_doing_upgrade' => [], |
| 63 | 'give_paused_batches' => [], |
| 64 | 'give_install_pages_created' => '', |
| 65 | 'give_show_db_upgrade_complete_notice' => '', |
| 66 | 'give_addon_last_activated' => '', |
| 67 | 'currencies' => [], |
| 68 | 'gateways' => [], |
| 69 | ]; |
| 70 | |
| 71 | /** |
| 72 | * Array of cached setting db option names |
| 73 | * |
| 74 | * @since 2.4.0 |
| 75 | * @access private |
| 76 | * @var array |
| 77 | */ |
| 78 | private $db_option_ids = [ |
| 79 | 'give_settings', |
| 80 | 'give_version', |
| 81 | 'give_completed_upgrades', |
| 82 | 'give_doing_upgrade', |
| 83 | 'give_install_pages_created', |
| 84 | 'give_show_db_upgrade_complete_notice', |
| 85 | 'give_addon_last_activated', |
| 86 | 'give_paused_batches', |
| 87 | ]; |
| 88 | |
| 89 | /** |
| 90 | * Array of cached setting option names |
| 91 | * |
| 92 | * @since 2.4.0 |
| 93 | * @access private |
| 94 | * @var array |
| 95 | */ |
| 96 | private static $all_option_ids; |
| 97 | |
| 98 | /** |
| 99 | * Singleton pattern. |
| 100 | * |
| 101 | * @since 2.4.0 |
| 102 | * @access private |
| 103 | */ |
| 104 | private function __construct() { |
| 105 | } |
| 106 | |
| 107 | |
| 108 | /** |
| 109 | * Get instance. |
| 110 | * |
| 111 | * @since 2.4.0 |
| 112 | * @access public |
| 113 | * @return Give_Cache_Setting |
| 114 | */ |
| 115 | public static function get_instance() { |
| 116 | if ( null === static::$instance ) { |
| 117 | self::$instance = new static(); |
| 118 | |
| 119 | self::$instance->setup(); |
| 120 | } |
| 121 | |
| 122 | return self::$instance; |
| 123 | } |
| 124 | |
| 125 | /** |
| 126 | * Setup |
| 127 | * |
| 128 | * @since 4.3.0 use init hook for currency and gateway list |
| 129 | * @since 2.4.0 |
| 130 | * @access private |
| 131 | */ |
| 132 | private function setup() { |
| 133 | self::$all_option_ids = array_keys( $this->settings ); |
| 134 | |
| 135 | $this->load_plugin_settings(); |
| 136 | |
| 137 | add_action( 'added_option', [ $this, 'reload_plugin_settings' ] ); |
| 138 | add_action( 'updated_option', [ $this, 'reload_plugin_settings' ] ); |
| 139 | add_action( 'deleted_option', [ $this, 'reload_plugin_settings' ] ); |
| 140 | |
| 141 | add_action( 'init', [ $this, 'setup_currencies_list' ]); |
| 142 | add_action( 'init', [ $this, 'setup_gateways_list' ]); |
| 143 | } |
| 144 | |
| 145 | /** |
| 146 | * Load plugin settings |
| 147 | * |
| 148 | * @since 2.4.0 |
| 149 | * @access private |
| 150 | */ |
| 151 | private function load_plugin_settings() { |
| 152 | global $wpdb; |
| 153 | |
| 154 | /** |
| 155 | * Fire the filter |
| 156 | * |
| 157 | * This filter can be used if admin facing any caching issue. |
| 158 | * This is a switch to enable or disable setting cache. |
| 159 | * Thus filter can be removed in future. |
| 160 | * |
| 161 | * @since 2.4.1 |
| 162 | */ |
| 163 | if ( ! apply_filters( 'give_disable_setting_cache', false ) ) { |
| 164 | $cache = wp_cache_get( $this->cache_key, $this->cache_group ); |
| 165 | |
| 166 | // Load options from cache. |
| 167 | if ( ! empty( $cache ) ) { |
| 168 | $this->settings = $cache; |
| 169 | |
| 170 | return; |
| 171 | } |
| 172 | } |
| 173 | |
| 174 | $db_option_ids = '\'' . implode( '\',\'', $this->db_option_ids ) . '\''; |
| 175 | |
| 176 | $sql = "SELECT option_name, option_value FROM $wpdb->options WHERE option_name IN ({$db_option_ids}) "; |
| 177 | $results = $wpdb->get_results( $sql ); |
| 178 | |
| 179 | if ( ! empty( $results ) ) { |
| 180 | |
| 181 | /* @var stdClass $result */ |
| 182 | foreach ( $results as $result ) { |
| 183 | $this->settings[ $result->option_name ] = maybe_unserialize( $result->option_value ); |
| 184 | } |
| 185 | |
| 186 | wp_cache_set( $this->cache_key, $this->settings, $this->cache_group ); |
| 187 | } |
| 188 | } |
| 189 | |
| 190 | /** |
| 191 | * Reload option when add, update or delete |
| 192 | * |
| 193 | * Note: only for internal logic |
| 194 | * |
| 195 | * @since 2.4.0 |
| 196 | * |
| 197 | * @param $option_name |
| 198 | */ |
| 199 | public function reload_plugin_settings( $option_name ) { |
| 200 | // Bailout. |
| 201 | if ( ! in_array( $option_name, $this->db_option_ids ) ) { |
| 202 | return; |
| 203 | } |
| 204 | |
| 205 | wp_cache_delete( $this->cache_key, $this->cache_group ); |
| 206 | $this->load_plugin_settings(); |
| 207 | } |
| 208 | |
| 209 | /** |
| 210 | * Setup currencies list |
| 211 | * |
| 212 | * @since 2.4.0 |
| 213 | * @since 2.9.6 Replaced require_once with require to support multiple calls. |
| 214 | */ |
| 215 | public function setup_currencies_list() { |
| 216 | $currencies = require GIVE_PLUGIN_DIR . 'includes/currencies-list.php'; |
| 217 | |
| 218 | /** |
| 219 | * Filter the supported currency list |
| 220 | * |
| 221 | * @since 2.4.0 |
| 222 | */ |
| 223 | $currencies = apply_filters( 'give_register_currency', $currencies ); |
| 224 | |
| 225 | $this->settings['currencies'] = $currencies; |
| 226 | } |
| 227 | |
| 228 | |
| 229 | /** |
| 230 | * Setup gateway list |
| 231 | * |
| 232 | * Note: use give_get_enabled_payment_gateways function to get list of registered gateway. |
| 233 | * |
| 234 | * @since 3.0.0 test and offline gateways are defaulted in the new Gateway API |
| 235 | * @since 2.4.0 |
| 236 | * @since 2.15.0 Set payment gateway checkout label to admin defined payment gateway checkout label. |
| 237 | */ |
| 238 | public function setup_gateways_list() { |
| 239 | $gateways = []; |
| 240 | |
| 241 | /** |
| 242 | * Filter the supported gateways list |
| 243 | * |
| 244 | * @since 2.4.0 |
| 245 | */ |
| 246 | $gateways = apply_filters( 'give_register_gateway', $gateways ); |
| 247 | |
| 248 | $this->settings['gateways'] = $gateways; |
| 249 | } |
| 250 | |
| 251 | |
| 252 | /** |
| 253 | * Get option |
| 254 | * |
| 255 | * @since 2.4.0 |
| 256 | * @access public |
| 257 | * |
| 258 | * @param $option_name |
| 259 | * @param bool $default |
| 260 | * |
| 261 | * @return mixed |
| 262 | */ |
| 263 | public static function get_option( $option_name, $default = false ) { |
| 264 | $value = $default; |
| 265 | |
| 266 | if ( in_array( $option_name, self::$all_option_ids ) ) { |
| 267 | $value = ! empty( self::$instance->settings[ $option_name ] ) |
| 268 | ? self::$instance->settings[ $option_name ] |
| 269 | : $default; |
| 270 | } |
| 271 | |
| 272 | return $value; |
| 273 | } |
| 274 | |
| 275 | /** |
| 276 | * Get plugin settings |
| 277 | * |
| 278 | * @since 2.4.0 |
| 279 | * @access public |
| 280 | */ |
| 281 | public static function get_settings() { |
| 282 | |
| 283 | /** |
| 284 | * Filter the plugin setting |
| 285 | */ |
| 286 | return (array) apply_filters( 'give_get_settings', self::get_option( 'give_settings', [] ) ); |
| 287 | } |
| 288 | } |
| 289 | |
| 290 | Give_Cache_Setting::get_instance(); |
| 291 |