oont-contents/plugins/google-site-kit/includes/Modules/Sign_In_With_Google/Settings.php
2025-02-08 15:10:23 +01:00

199 lines
4.6 KiB
PHP

<?php
/**
* Class Google\Site_Kit\Modules\Sign_In_With_Google\Settings
*
* @package Google\Site_Kit\Modules\Sign_In_With_Google
* @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\Sign_In_With_Google;
use Google\Site_Kit\Core\Modules\Module_Settings;
/**
* Class for Sign_In_With_Google settings.
*
* @since 1.137.0
* @access private
* @ignore
*/
class Settings extends Module_Settings {
const OPTION = 'googlesitekit_sign-in-with-google_settings';
const TEXT_CONTINUE_WITH_GOOGLE = array(
'value' => 'continue_with',
'label' => 'Continue with Google',
);
const TEXT_SIGN_IN = array(
'value' => 'signin',
'label' => 'Sign in',
);
const TEXT_SIGN_IN_WITH_GOOGLE = array(
'value' => 'signin_with',
'label' => 'Sign in with Google',
);
const TEXT_SIGN_UP_WITH_GOOGLE = array(
'value' => 'signup_with',
'label' => 'Sign up with Google',
);
const TEXTS = array(
self::TEXT_CONTINUE_WITH_GOOGLE,
self::TEXT_SIGN_IN,
self::TEXT_SIGN_IN_WITH_GOOGLE,
self::TEXT_SIGN_UP_WITH_GOOGLE,
);
const THEME_LIGHT = array(
'value' => 'outline',
'label' => 'Light',
);
const THEME_NEUTRAL = array(
'value' => 'filled_blue',
'label' => 'Neutral',
);
const THEME_DARK = array(
'value' => 'filled_black',
'label' => 'Dark',
);
const THEMES = array(
self::THEME_LIGHT,
self::THEME_NEUTRAL,
self::THEME_DARK,
);
const SHAPE_RECTANGULAR = array(
'value' => 'rectangular',
'label' => 'Rectangular',
);
const SHAPE_PILL = array(
'value' => 'pill',
'label' => 'Pill',
);
const SHAPES = array(
self::SHAPE_RECTANGULAR,
self::SHAPE_PILL,
);
/**
* Gets the default value.
*
* @since 1.137.0
*
* @return array An array of default settings values.
*/
protected function get_default() {
return array(
'clientID' => '',
'text' => self::TEXT_SIGN_IN_WITH_GOOGLE['value'],
'theme' => self::THEME_LIGHT['value'],
'shape' => self::SHAPE_RECTANGULAR['value'],
'oneTapEnabled' => false,
'oneTapOnAllPages' => false,
);
}
/**
* Gets the callback for sanitizing the setting's value before saving.
*
* @since 1.137.0
*
* @return callable|null
*/
protected function get_sanitize_callback() {
return function ( $option ) {
if ( ! is_array( $option ) ) {
return $option;
}
if ( isset( $option['clientID'] ) ) {
$option['clientID'] = (string) $option['clientID'];
}
if ( isset( $option['text'] ) ) {
$text_options = array(
self::TEXT_CONTINUE_WITH_GOOGLE['value'],
self::TEXT_SIGN_IN['value'],
self::TEXT_SIGN_IN_WITH_GOOGLE['value'],
self::TEXT_SIGN_UP_WITH_GOOGLE['value'],
);
if ( ! in_array( $option['text'], $text_options, true ) ) {
$option['text'] = self::TEXT_SIGN_IN_WITH_GOOGLE['value'];
}
}
if ( isset( $option['theme'] ) ) {
$theme_options = array(
self::THEME_LIGHT['value'],
self::THEME_NEUTRAL['value'],
self::THEME_DARK['value'],
);
if ( ! in_array( $option['theme'], $theme_options, true ) ) {
$option['theme'] = self::THEME_LIGHT['value'];
}
}
if ( isset( $option['shape'] ) ) {
$shape_options = array(
self::SHAPE_RECTANGULAR['value'],
self::SHAPE_PILL['value'],
);
if ( ! in_array( $option['shape'], $shape_options, true ) ) {
$option['shape'] = self::SHAPE_RECTANGULAR['value'];
}
}
if ( isset( $option['oneTapEnabled'] ) ) {
$option['oneTapEnabled'] = (bool) $option['oneTapEnabled'];
}
if ( isset( $option['oneTapOnAllPages'] ) ) {
$option['oneTapOnAllPages'] = (bool) $option['oneTapOnAllPages'];
}
return $option;
};
}
/**
* Gets the label for a given Sign in with Google setting value.
*
* @since 1.140.0
*
* @param string $setting_name The slug for the Sign in with Google setting.
* @param string $value The setting value to look up the label for.
* @return string The label for the given setting value.
*/
public function get_label( $setting_name, $value ) {
switch ( $setting_name ) {
case 'text':
$constant = self::TEXTS;
break;
case 'theme':
$constant = self::THEMES;
break;
case 'shape':
$constant = self::SHAPES;
break;
}
if ( ! isset( $constant ) ) {
return '';
}
$key = array_search( $value, array_column( $constant, 'value' ), true );
if ( false === $key ) {
return '';
}
return $constant[ $key ]['label'];
}
}