Add Audience_Settings class.

sayanm085 · Mar 14, 2024 · f33605c · f33605c
1 parent ce2eba0
commit f33605c
Showing 1 changed file with 110 additions and 0 deletions.
diff --git a/includes/Modules/Analytics_4/Audience_Settings.php b/includes/Modules/Analytics_4/Audience_Settings.php
@@ -0,0 +1,110 @@
+<?php
+/**
+ * Class Google\Site_Kit\Modules\Analytics_4\Audience_Settings
+ *
+ * @package   Google\Site_Kit\Modules\Analytics_4
+ * @copyright 2024 Google LLC
+ * @license   https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
+ * @link      https://sitekit.withgoogle.com
+ */
+
+namespace Google\Site_Kit\Modules\Analytics_4;
+
+use Google\Site_Kit\Core\Storage\User_Setting;
+use Google\Site_Kit\Core\Util\Sanitize;
+
+/**
+ * Class for Analytics 4 audience settings.
+ *
+ * @since n.e.x.t
+ * @access private
+ * @ignore
+ */
+class Audience_Settings extends User_Setting {
+
+    /**
+	 * The user option name for audience setting.
+	 */
+	const OPTION = 'googlesitekit_audience_settings';
+
+	/**
+	 * Gets the expected value type.
+	 *
+	 * @since n.e.x.t
+	 *
+	 * @return string The type name.
+	 */
+	protected function get_type() {
+		return 'object';
+	}
+
+	/**
+	 * Gets the default value.
+	 *
+	 * @since n.e.x.t
+	 *
+	 * @return array The default value.
+	 */
+	protected function get_default() {
+		return array(
+			'configuredAudiences'                => array(),
+			'isAudienceSegmentationWidgetHidden' => false,
+		);
+	}
+
+	/**
+	 * Merges an array of settings to update.
+	 *
+	 * @since n.e.x.t
+	 *
+	 * @param array $partial Partial settings array to save.
+	 * @return bool True on success, false on failure.
+	 */
+	public function merge( array $partial ) {
+		$settings = $this->get();
+		$partial  = array_filter(
+			$partial,
+			function ( $value ) {
+				return null !== $value;
+			}
+		);
+
+		$allowed_settings = array(
+			'configuredAudiences'    => true,
+			'isAudienceSegmentationWidgetHidden' => true,
+		);
+
+		$updated = array_intersect_key( $partial, $allowed_settings );
+
+		return $this->set( array_merge( $settings, $updated ) );
+	}
+
+	/**
+	 * Gets the callback for sanitizing the setting's value before saving.
+	 *
+	 * @since n.e.x.t
+	 *
+	 * @return callable Sanitize callback.
+	 */
+	protected function get_sanitize_callback() {
+		return function ( $settings ) {
+			if ( ! is_array( $settings ) ) {
+				return array();
+			}
+
+			$sanitized_settings = array();
+
+			if ( isset( $settings['configuredAudiences'] ) ) {
+				$sanitized_settings['configuredAudiences'] = Sanitize::sanitize_string_list( $settings['configuredAudiences'] );
+			}
+
+			if ( isset( $settings['isAudienceSegmentationWidgetHidden'] ) ) {
+				$sanitized_settings['isAudienceSegmentationWidgetHidden'] = false !== $settings['isAudienceSegmentationWidgetHidden'];
+			}
+
+			return $sanitized_settings;
+		};
+	}
+
+
+}