class-options.php — Advanced Ads – Ad Manager & AdSense 2.0.4

advanced-ads / includes / class-options.php

advanced-ads / includes Last commit date

class-options.php

224 lines

1	<?php
2	/**
3	* Get and Set Options.
4	*
5	* @package AdvancedAds
6	* @author Advanced Ads <info@wpadvancedads.com>
7	* @since 1.50.0
8	*/
9
10	namespace AdvancedAds;
11
12	use AdvancedAds\Framework\Utilities\Arr;
13
14	defined( 'ABSPATH' ) \|\| exit;
15
16	/**
17	* This class is used to get and set plugin options.
18	*/
19	class Options {
20
21	/**
22	* Hold plugin options.
23	*
24	* @var array
25	*/
26	private $options = [];
27
28	/**
29	* Original DB option values.
30	*
31	* @var array
32	*/
33	private $raw_options = [];
34
35	/**
36	* Map of key to their respective option name.
37	*
38	* @var array
39	*/
40	private $options_map = [
41	'advanced-ads' => ADVADS_SLUG,
42	'adsense' => ADVADS_SLUG . '-adsense',
43	'adblocker' => ADVADS_SLUG . '-adblocker',
44	'ads-txt' => 'advanced_ads_ads_txt',
45	'notices' => ADVADS_SLUG . '-notices',
46	'privacy' => ADVADS_SLUG . '-privacy',
47	'pro' => ADVADS_SLUG . '-pro',
48	'tracking' => ADVADS_SLUG . '-tracking',
49	];
50
51	/**
52	* Retrieves the instance of the Options class.
53	*
54	* @return Options
55	*/
56	public static function instance() {
57	static $instance;
58
59	if ( null === $instance ) {
60	$instance = new Options();
61	}
62
63	return $instance;
64	}
65
66	/**
67	* Gets the value of a specific option.
68	*
69	* @param string $key Option suffix (advanced-ads-XXX).
70	* @param mixed $default_val Default value to return if the option is not set.
71	*
72	* @return mixed Array of option values, or the default value.
73	*/
74	public function get( $key, $default_val = false ) {
75	$keys = $this->normalize_key( $key );
76	$option_name = array_shift( $keys );
77	$values = $this->get_option( $option_name );
78
79	foreach ( $keys as $key ) {
80	$values = Arr::get( $values, $key, null );
81	}
82
83	return null === $values ? $default_val : $values;
84	}
85
86	/**
87	* Sets the value of a specific option.
88	*
89	* It checks if the method to set the option exists in the instance of the class and calls it if it does.
90	*
91	* @param string $key Option suffix (advanced-ads-XXX).
92	* @param array $value The value to set.
93	*
94	* @return array The new value of the option.
95	*/
96	public function set( $key, $value ): array {
97	$keys = $this->normalize_key( $key );
98	$option_name = array_shift( $keys );
99
100	$this->get_option( $option_name ); // Make sure the option is loaded.
101
102	$values = $this->raw_options[ $option_name ] ?? [];
103	$current = &$values;
104
105	foreach ( $keys as $key ) {
106	if ( ! Arr::has( $current, $key ) ) {
107	Arr::set( $current, $key, [] );
108	}
109	$current = &$current[ $key ];
110	}
111	$current = $value;
112
113	return $this->set_option( $option_name, $values );
114	}
115
116	/**
117	* Retrieves the value of an option identified by the given key.
118	*
119	* @param string $key Option name.
120	*
121	* @return array
122	*/
123	private function get_option( $key ): array {
124	// Early bail!!
125	if ( isset( $this->options[ $key ] ) ) {
126	return $this->options[ $key ];
127	}
128
129	// Check for getter method.
130	$method = 'get_' . $key;
131	if ( method_exists( $this, $method ) ) {
132	$this->options[ $key ] = $this->$method();
133	}
134
135	// Check in key map.
136	if ( isset( $this->options_map[ $key ] ) ) {
137	$this->options[ $key ] = get_option( $this->options_map[ $key ], [] );
138	}
139
140	$this->raw_options[ $key ] = $this->options[ $key ];
141	$this->options[ $key ] = $this->normalize_option( $this->options[ $key ] );
142
143	return $this->options[ $key ];
144	}
145
146	/**
147	* Sets the value of an option and updates the corresponding database entry.
148	*
149	* @param string $key Option name.
150	* @param mixed $value Option value.
151	*
152	* @return array The normalized option value.
153	*/
154	private function set_option( $key, $value ): array {
155	// Check for setter method.
156	$method = 'set_' . $key;
157	if ( method_exists( $this, $method ) ) {
158	$this->$method( $value );
159	}
160
161	// Check in key map.
162	if ( isset( $this->options_map[ $key ] ) ) {
163	update_option( $this->options_map[ $key ], $value );
164	}
165
166	$this->raw_options[ $key ] = $value;
167	$this->options[ $key ] = $this->normalize_option( $value );
168
169	return $this->options[ $key ];
170	}
171
172	/**
173	* Normalizes the given options array recursively.
174	*
175	* @param array $options Options array to be normalized.
176	*
177	* @return array The normalized options array.
178	*/
179	private function normalize_option( $options ): array {
180	if ( ! is_array( $options ) \|\| empty( $options ) ) {
181	return [];
182	}
183
184	foreach ( $options as $key => $value ) {
185	$option[ $key ] = is_array( $value )
186	? $this->normalize_option( $value )
187	: $this->normalize_value( $value );
188	}
189
190	return $option;
191	}
192
193	/**
194	* Normalizes a given value.
195	*
196	* @param mixed $value Value to be normalized.
197	*
198	* @return mixed The normalized value.
199	*/
200	private function normalize_value( $value ) {
201	if ( 'true' === $value \|\| 'on' === $value ) {
202	$value = true;
203	} elseif ( 'false' === $value \|\| 'off' === $value ) {
204	$value = false;
205	} elseif ( '0' === $value \|\| '1' === $value ) {
206	$value = intval( $value );
207	}
208
209	return $value;
210	}
211
212	/**
213	* Normalizes a given key by removing leading and trailing dots and splitting it into an array.
214	*
215	* @param string $key Key to be normalized.
216	*
217	* @return array The normalized key as an array.
218	*/
219	private function normalize_key( $key ) {
220	$key = trim( $key, '.' );
221	return explode( '.', $key );
222	}
223	}
224