Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* @package Freemius

[2] Fix | Delete

[3] Fix | Delete

* @license https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3

[4] Fix | Delete

* @since 1.0.3

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[8] Fix | Delete

exit;

[9] Fix | Delete

}

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* 2-layer lazy options manager.

[13] Fix | Delete

* layer 2: Memory

[14] Fix | Delete

* layer 1: Database (options table). All options stored as one option record in the DB to reduce number of DB queries.

[15] Fix | Delete

[16] Fix | Delete

* If load() is not explicitly called, starts as empty manager. Same thing about saving the data - you have to explicitly call store().

[17] Fix | Delete

[18] Fix | Delete

* Class Freemius_Option_Manager

[19] Fix | Delete

[20] Fix | Delete

class FS_Option_Manager {

[21] Fix | Delete

/**

[22] Fix | Delete

* @var string

[23] Fix | Delete

[24] Fix | Delete

private $_id;

[25] Fix | Delete

/**

[26] Fix | Delete

* @var array|object

[27] Fix | Delete

[28] Fix | Delete

private $_options;

[29] Fix | Delete

/**

[30] Fix | Delete

* @var FS_Logger

[31] Fix | Delete

[32] Fix | Delete

private $_logger;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* @since 2.0.0

[36] Fix | Delete

* @var int The ID of the blog that is associated with the current site level options.

[37] Fix | Delete

[38] Fix | Delete

private $_blog_id = 0;

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* @since 2.0.0

[42] Fix | Delete

* @var bool

[43] Fix | Delete

[44] Fix | Delete

private $_is_network_storage;

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* @var bool|null

[48] Fix | Delete

[49] Fix | Delete

private $_autoload;

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* @var array[string]FS_Option_Manager {

[53] Fix | Delete

* @key string

[54] Fix | Delete

* @value FS_Option_Manager

[55] Fix | Delete

* }

[56] Fix | Delete

[57] Fix | Delete

private static $_MANAGERS = array();

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* @author Vova Feldman (@svovaf)

[61] Fix | Delete

* @since 1.0.3

[62] Fix | Delete

[63] Fix | Delete

* @param string $id

[64] Fix | Delete

* @param bool $load

[65] Fix | Delete

* @param bool|int $network_level_or_blog_id Since 2.0.0

[66] Fix | Delete

* @param bool|null $autoload

[67] Fix | Delete

[68] Fix | Delete

private function __construct(

[69] Fix | Delete

$id,

[70] Fix | Delete

$load = false,

[71] Fix | Delete

$network_level_or_blog_id = false,

[72] Fix | Delete

$autoload = null

[73] Fix | Delete

) {

[74] Fix | Delete

$id = strtolower( $id );

[75] Fix | Delete

[76] Fix | Delete

$this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_opt_mngr_' . $id, WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK );

[77] Fix | Delete

[78] Fix | Delete

$this->_logger->entrance();

[79] Fix | Delete

$this->_logger->log( 'id = ' . $id );

[80] Fix | Delete

[81] Fix | Delete

$this->_id = $id;

[82] Fix | Delete

[83] Fix | Delete

$this->_autoload = $autoload;

[84] Fix | Delete

[85] Fix | Delete

if ( is_multisite() ) {

[86] Fix | Delete

$this->_is_network_storage = ( true === $network_level_or_blog_id );

[87] Fix | Delete

[88] Fix | Delete

if ( is_numeric( $network_level_or_blog_id ) ) {

[89] Fix | Delete

$this->_blog_id = $network_level_or_blog_id;

[90] Fix | Delete

}

[91] Fix | Delete

} else {

[92] Fix | Delete

$this->_is_network_storage = false;

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

if ( $load ) {

[96] Fix | Delete

$this->load();

[97] Fix | Delete

}

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* @author Vova Feldman (@svovaf)

[102] Fix | Delete

* @since 1.0.3

[103] Fix | Delete

[104] Fix | Delete

* @param string $id

[105] Fix | Delete

* @param bool $load

[106] Fix | Delete

* @param bool|int $network_level_or_blog_id Since 2.0.0

[107] Fix | Delete

* @param bool|null $autoload

[108] Fix | Delete

[109] Fix | Delete

* @return \FS_Option_Manager

[110] Fix | Delete

[111] Fix | Delete

static function get_manager(

[112] Fix | Delete

$id,

[113] Fix | Delete

$load = false,

[114] Fix | Delete

$network_level_or_blog_id = false,

[115] Fix | Delete

$autoload = null

[116] Fix | Delete

) {

[117] Fix | Delete

$key = strtolower( $id );

[118] Fix | Delete

[119] Fix | Delete

if ( is_multisite() ) {

[120] Fix | Delete

if ( true === $network_level_or_blog_id ) {

[121] Fix | Delete

$key .= ':ms';

[122] Fix | Delete

} else if ( is_numeric( $network_level_or_blog_id ) && $network_level_or_blog_id > 0 ) {

[123] Fix | Delete

$key .= ":{$network_level_or_blog_id}";

[124] Fix | Delete

} else {

[125] Fix | Delete

$network_level_or_blog_id = get_current_blog_id();

[126] Fix | Delete

[127] Fix | Delete

$key .= ":{$network_level_or_blog_id}";

[128] Fix | Delete

}

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

if ( ! isset( self::$_MANAGERS[ $key ] ) ) {

[132] Fix | Delete

self::$_MANAGERS[ $key ] = new FS_Option_Manager(

[133] Fix | Delete

$id,

[134] Fix | Delete

$load,

[135] Fix | Delete

$network_level_or_blog_id,

[136] Fix | Delete

$autoload

[137] Fix | Delete

);

[138] Fix | Delete

} // If load required but not yet loaded, load.

[139] Fix | Delete

else if ( $load && ! self::$_MANAGERS[ $key ]->is_loaded() ) {

[140] Fix | Delete

self::$_MANAGERS[ $key ]->load();

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

return self::$_MANAGERS[ $key ];

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

/**

[147] Fix | Delete

* @author Vova Feldman (@svovaf)

[148] Fix | Delete

* @since 1.0.3

[149] Fix | Delete

[150] Fix | Delete

* @param bool $flush

[151] Fix | Delete

[152] Fix | Delete

function load( $flush = false ) {

[153] Fix | Delete

$this->_logger->entrance();

[154] Fix | Delete

[155] Fix | Delete

if ( ! $flush && isset( $this->_options ) ) {

[156] Fix | Delete

return;

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

if ( isset( $this->_options ) ) {

[160] Fix | Delete

// Clear prev options.

[161] Fix | Delete

$this->clear();

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

$option_name = $this->get_option_manager_name();

[165] Fix | Delete

[166] Fix | Delete

if ( $this->_is_network_storage ) {

[167] Fix | Delete

$this->_options = get_site_option( $option_name );

[168] Fix | Delete

} else if ( $this->_blog_id > 0 ) {

[169] Fix | Delete

$this->_options = get_blog_option( $this->_blog_id, $option_name );

[170] Fix | Delete

} else {

[171] Fix | Delete

$this->_options = get_option( $option_name );

[172] Fix | Delete

}

[173] Fix | Delete

[174] Fix | Delete

if ( is_string( $this->_options ) ) {

[175] Fix | Delete

$this->_options = json_decode( $this->_options );

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

// $this->_logger->info('get_option = ' . var_export($this->_options, true));

[179] Fix | Delete

[180] Fix | Delete

if ( false === $this->_options ) {

[181] Fix | Delete

$this->clear();

[182] Fix | Delete

}

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

/**

[186] Fix | Delete

* @author Vova Feldman (@svovaf)

[187] Fix | Delete

* @since 1.0.3

[188] Fix | Delete

[189] Fix | Delete

* @return bool

[190] Fix | Delete

[191] Fix | Delete

function is_loaded() {

[192] Fix | Delete

return isset( $this->_options );

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

/**

[196] Fix | Delete

* @author Vova Feldman (@svovaf)

[197] Fix | Delete

* @since 1.0.3

[198] Fix | Delete

[199] Fix | Delete

* @return bool

[200] Fix | Delete

[201] Fix | Delete

function is_empty() {

[202] Fix | Delete

return ( $this->is_loaded() && false === $this->_options );

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

/**

[206] Fix | Delete

* @author Vova Feldman (@svovaf)

[207] Fix | Delete

* @since 1.0.6

[208] Fix | Delete

[209] Fix | Delete

* @param bool $flush

[210] Fix | Delete

[211] Fix | Delete

function clear( $flush = false ) {

[212] Fix | Delete

$this->_logger->entrance();

[213] Fix | Delete

[214] Fix | Delete

$this->_options = array();

[215] Fix | Delete

[216] Fix | Delete

if ( $flush ) {

[217] Fix | Delete

$this->store();

[218] Fix | Delete

}

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

/**

[222] Fix | Delete

* Delete options manager from DB.

[223] Fix | Delete

[224] Fix | Delete

* @author Vova Feldman (@svovaf)

[225] Fix | Delete

* @since 1.0.9

[226] Fix | Delete

[227] Fix | Delete

function delete() {

[228] Fix | Delete

$option_name = $this->get_option_manager_name();

[229] Fix | Delete

[230] Fix | Delete

if ( $this->_is_network_storage ) {

[231] Fix | Delete

delete_site_option( $option_name );

[232] Fix | Delete

} else if ( $this->_blog_id > 0 ) {

[233] Fix | Delete

delete_blog_option( $this->_blog_id, $option_name );

[234] Fix | Delete

} else {

[235] Fix | Delete

delete_option( $option_name );

[236] Fix | Delete

}

[237] Fix | Delete

}

[238] Fix | Delete

[239] Fix | Delete

/**

[240] Fix | Delete

* @author Vova Feldman (@svovaf)

[241] Fix | Delete

* @since 1.0.6

[242] Fix | Delete

[243] Fix | Delete

* @param string $option

[244] Fix | Delete

* @param bool $flush

[245] Fix | Delete

[246] Fix | Delete

* @return bool

[247] Fix | Delete

[248] Fix | Delete

function has_option( $option, $flush = false ) {

[249] Fix | Delete

if ( ! $this->is_loaded() || $flush ) {

[250] Fix | Delete

$this->load( $flush );

[251] Fix | Delete

}

[252] Fix | Delete

[253] Fix | Delete

return array_key_exists( $option, $this->_options );

[254] Fix | Delete

}

[255] Fix | Delete

[256] Fix | Delete

/**

[257] Fix | Delete

* @author Vova Feldman (@svovaf)

[258] Fix | Delete

* @since 1.0.3

[259] Fix | Delete

[260] Fix | Delete

* @param string $option

[261] Fix | Delete

* @param mixed $default

[262] Fix | Delete

* @param bool $flush

[263] Fix | Delete

[264] Fix | Delete

* @return mixed

[265] Fix | Delete

[266] Fix | Delete

function get_option( $option, $default = null, $flush = false ) {

[267] Fix | Delete

$this->_logger->entrance( 'option = ' . $option );

[268] Fix | Delete

[269] Fix | Delete

if ( ! $this->is_loaded() || $flush ) {

[270] Fix | Delete

$this->load( $flush );

[271] Fix | Delete

}

[272] Fix | Delete

[273] Fix | Delete

if ( is_array( $this->_options ) ) {

[274] Fix | Delete

$value = isset( $this->_options[ $option ] ) ?

[275] Fix | Delete

$this->_options[ $option ] :

[276] Fix | Delete

$default;

[277] Fix | Delete

} else if ( is_object( $this->_options ) ) {

[278] Fix | Delete

$value = isset( $this->_options->{$option} ) ?

[279] Fix | Delete

$this->_options->{$option} :

[280] Fix | Delete

$default;

[281] Fix | Delete

} else {

[282] Fix | Delete

$value = $default;

[283] Fix | Delete

}

[284] Fix | Delete

[285] Fix | Delete

/**

[286] Fix | Delete

* If it's an object, return a clone of the object, otherwise,

[287] Fix | Delete

* external changes of the object will actually change the value

[288] Fix | Delete

* of the object in the option manager which may lead to an unexpected

[289] Fix | Delete

* behaviour and data integrity when a store() call is triggered.

[290] Fix | Delete

[291] Fix | Delete

* Example:

[292] Fix | Delete

* $object1 = $options->get_option( 'object1' );

[293] Fix | Delete

* $object1->x = 123;

[294] Fix | Delete

[295] Fix | Delete

* $object2 = $options->get_option( 'object2' );

[296] Fix | Delete

* $object2->y = 'dummy';

[297] Fix | Delete

[298] Fix | Delete

* $options->set_option( 'object2', $object2, true );

[299] Fix | Delete

[300] Fix | Delete

* If we don't return a clone of option 'object1', setting 'object2'

[301] Fix | Delete

* will also store the updated value of 'object1' which is quite not

[302] Fix | Delete

* an expected behaviour.

[303] Fix | Delete

[304] Fix | Delete

* @author Vova Feldman

[305] Fix | Delete

[306] Fix | Delete

return is_object( $value ) ? clone $value : $value;

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

/**

[310] Fix | Delete

* @author Vova Feldman (@svovaf)

[311] Fix | Delete

* @since 1.0.3

[312] Fix | Delete

[313] Fix | Delete

* @param string $option

[314] Fix | Delete

* @param mixed $value

[315] Fix | Delete

* @param bool $flush

[316] Fix | Delete

[317] Fix | Delete

function set_option( $option, $value, $flush = false ) {

[318] Fix | Delete

$this->_logger->entrance( 'option = ' . $option );

[319] Fix | Delete

[320] Fix | Delete

if ( ! $this->is_loaded() ) {

[321] Fix | Delete

$this->clear();

[322] Fix | Delete

}

[323] Fix | Delete

[324] Fix | Delete

/**

[325] Fix | Delete

* If it's an object, store a clone of the object, otherwise,

[326] Fix | Delete

* external changes of the object will actually change the value

[327] Fix | Delete

* of the object in the options manager which may lead to an unexpected

[328] Fix | Delete

* behaviour and data integrity when a store() call is triggered.

[329] Fix | Delete

[330] Fix | Delete

* Example:

[331] Fix | Delete

* $object1 = new stdClass();

[332] Fix | Delete

* $object1->x = 123;

[333] Fix | Delete

[334] Fix | Delete

* $options->set_option( 'object1', $object1 );

[335] Fix | Delete

[336] Fix | Delete

* $object1->x = 456;

[337] Fix | Delete

[338] Fix | Delete

* $options->set_option( 'object2', $object2, true );

[339] Fix | Delete

[340] Fix | Delete

* If we don't set the option as a clone of option 'object1', setting 'object2'

[341] Fix | Delete

* will also store the updated value of 'object1' ($object1->x = 456 instead of

[342] Fix | Delete

* $object1->x = 123) which is quite not an expected behaviour.

[343] Fix | Delete

[344] Fix | Delete

* @author Vova Feldman

[345] Fix | Delete

[346] Fix | Delete

$copy = is_object( $value ) ? clone $value : $value;

[347] Fix | Delete

[348] Fix | Delete

if ( is_array( $this->_options ) ) {

[349] Fix | Delete

$this->_options[ $option ] = $copy;

[350] Fix | Delete

} else if ( is_object( $this->_options ) ) {

[351] Fix | Delete

$this->_options->{$option} = $copy;

[352] Fix | Delete

}

[353] Fix | Delete

[354] Fix | Delete

if ( $flush ) {

[355] Fix | Delete

$this->store();

[356] Fix | Delete

}

[357] Fix | Delete

}

[358] Fix | Delete

[359] Fix | Delete

/**

[360] Fix | Delete

* Unset option.

[361] Fix | Delete

[362] Fix | Delete

* @author Vova Feldman (@svovaf)

[363] Fix | Delete

* @since 1.0.3

[364] Fix | Delete

[365] Fix | Delete

* @param string $option

[366] Fix | Delete

* @param bool $flush

[367] Fix | Delete

[368] Fix | Delete

function unset_option( $option, $flush = false ) {

[369] Fix | Delete

$this->_logger->entrance( 'option = ' . $option );

[370] Fix | Delete

[371] Fix | Delete

if ( is_array( $this->_options ) ) {

[372] Fix | Delete

if ( ! isset( $this->_options[ $option ] ) ) {

[373] Fix | Delete

return;

[374] Fix | Delete

}

[375] Fix | Delete

[376] Fix | Delete

unset( $this->_options[ $option ] );

[377] Fix | Delete

[378] Fix | Delete

} else if ( is_object( $this->_options ) ) {

[379] Fix | Delete

if ( ! isset( $this->_options->{$option} ) ) {

[380] Fix | Delete

return;

[381] Fix | Delete

}

[382] Fix | Delete

[383] Fix | Delete

unset( $this->_options->{$option} );

[384] Fix | Delete

}

[385] Fix | Delete

[386] Fix | Delete

if ( $flush ) {

[387] Fix | Delete

$this->store();

[388] Fix | Delete

}

[389] Fix | Delete

}

[390] Fix | Delete

[391] Fix | Delete

/**

[392] Fix | Delete

* Dump options to database.

[393] Fix | Delete

[394] Fix | Delete

* @author Vova Feldman (@svovaf)

[395] Fix | Delete

* @since 1.0.3

[396] Fix | Delete

[397] Fix | Delete

function store() {

[398] Fix | Delete

$this->_logger->entrance();

[399] Fix | Delete

[400] Fix | Delete

$option_name = $this->get_option_manager_name();

[401] Fix | Delete

[402] Fix | Delete

if ( $this->_logger->is_on() ) {

[403] Fix | Delete

$this->_logger->info( $option_name . ' = ' . var_export( $this->_options, true ) );

[404] Fix | Delete

}

[405] Fix | Delete

[406] Fix | Delete

// Update DB.

[407] Fix | Delete

if ( $this->_is_network_storage ) {

[408] Fix | Delete

update_site_option( $option_name, $this->_options );

[409] Fix | Delete

} else if ( $this->_blog_id > 0 ) {

[410] Fix | Delete

update_blog_option( $this->_blog_id, $option_name, $this->_options );

[411] Fix | Delete

} else {

[412] Fix | Delete

update_option( $option_name, $this->_options, $this->_autoload );

[413] Fix | Delete

}

[414] Fix | Delete

}

[415] Fix | Delete

[416] Fix | Delete

/**

[417] Fix | Delete

* Get options keys.

[418] Fix | Delete

[419] Fix | Delete

* @author Vova Feldman (@svovaf)

[420] Fix | Delete

* @since 1.0.3

[421] Fix | Delete

[422] Fix | Delete

* @return string[]

[423] Fix | Delete

[424] Fix | Delete

function get_options_keys() {

[425] Fix | Delete

if ( is_array( $this->_options ) ) {

[426] Fix | Delete

return array_keys( $this->_options );

[427] Fix | Delete

} else if ( is_object( $this->_options ) ) {

[428] Fix | Delete

return array_keys( get_object_vars( $this->_options ) );

[429] Fix | Delete

}

[430] Fix | Delete

[431] Fix | Delete

return array();

[432] Fix | Delete

}

[433] Fix | Delete

[434] Fix | Delete

#--------------------------------------------------------------------------------

[435] Fix | Delete

#region Migration

[436] Fix | Delete

#--------------------------------------------------------------------------------

[437] Fix | Delete

[438] Fix | Delete

/**

[439] Fix | Delete

* Migrate options from site level.

[440] Fix | Delete

[441] Fix | Delete

* @author Vova Feldman (@svovaf)

[442] Fix | Delete

* @since 2.0.0

[443] Fix | Delete

[444] Fix | Delete

function migrate_to_network() {

[445] Fix | Delete

$site_options = FS_Option_Manager::get_manager($this->_id, true, false);

[446] Fix | Delete

[447] Fix | Delete

$options = is_object( $site_options->_options ) ?

[448] Fix | Delete

get_object_vars( $site_options->_options ) :

[449] Fix | Delete

$site_options->_options;

[450] Fix | Delete

[451] Fix | Delete

if ( ! empty( $options ) ) {

[452] Fix | Delete

foreach ( $options as $key => $val ) {

[453] Fix | Delete

$this->set_option( $key, $val, false );

[454] Fix | Delete

}

[455] Fix | Delete

[456] Fix | Delete

$this->store();

[457] Fix | Delete

}

[458] Fix | Delete

}

[459] Fix | Delete

[460] Fix | Delete

#endregion

[461] Fix | Delete

[462] Fix | Delete

#--------------------------------------------------------------------------------

[463] Fix | Delete

#region Helper Methods

[464] Fix | Delete

#--------------------------------------------------------------------------------

[465] Fix | Delete

[466] Fix | Delete

/**

[467] Fix | Delete

* @return string

[468] Fix | Delete

[469] Fix | Delete

private function get_option_manager_name() {

[470] Fix | Delete

return $this->_id;

[471] Fix | Delete

}

[472] Fix | Delete

[473] Fix | Delete

#endregion

[474] Fix | Delete

}

[475] Fix | Delete

[476] Fix | Delete