<?php
/**
* Options handling
*
* Handles all options operations for the plugin.
*
* @package System
* @author Pierre Lannoy <https://pierre.lannoy.fr/>.
* @since 1.0.0
*/
namespace Vibes\System;
use Vibes\System\Environment;
/**
* Define the options functionality.
*
* Handles all options operations for the plugin.
*
* @package System
* @author Pierre Lannoy <https://pierre.lannoy.fr/>.
* @since 1.0.0
*/
class Option {
/**
* The list of defaults options.
*
* @since 1.0.0
* @access private
* @var array $defaults The defaults list.
*/
private static $defaults = [];
/**
* The list of network-wide options.
*
* @since 1.0.0
* @access private
* @var array $network The network-wide list.
*/
private static $network = [];
/**
* The list of site options.
*
* @since 1.0.0
* @access private
* @var array $site The site list.
*/
private static $site = [];
/**
* The list of private options.
*
* @since 1.0.0
* @access private
* @var array $private The private options list.
*/
private static $private = [];
/**
* Set the defaults options.
*
* @since 1.0.0
*/
public static function init() {
self::$defaults['use_apcu'] = true;
self::$defaults['use_cdn'] = false;
self::$defaults['download_favicons'] = false;
self::$defaults['script_in_footer'] = false;
self::$defaults['display_nag'] = false;
self::$defaults['metrics'] = true;
self::$defaults['nags'] = [];
self::$defaults['version'] = '0.0.0';
self::$defaults['cut_path'] = 4;
self::$defaults['rcut_path'] = 6;
self::$defaults['sampling'] = 1000;
self::$defaults['resource_sampling'] = 500;
self::$defaults['capture'] = true;
self::$defaults['rcapture'] = true;
self::$defaults['livelog'] = true;
self::$defaults['smart_filter'] = true;
self::$defaults['buffer'] = true;
self::$defaults['history'] = 14;
self::$defaults['rhistory'] = 7;
self::$defaults['quality'] = 2;
self::$defaults['qstat'] = 10;
self::$defaults['twindow'] = 3600;
self::$network = [ 'version', 'use_cdn', 'use_apcu', 'download_favicons', 'script_in_footer', 'display_nag', 'metrics', 'cut_path', 'rcut_path', 'sampling', 'resource_sampling', 'capture', 'rcapture', 'livelog', 'smart_filter', 'buffer', 'history', 'rhistory', 'quality', 'qstat', 'twindow' ];
}
/**
* Get the options infos for Site Health "info" tab.
*
* @since 1.0.0
*/
public static function debug_info() {
$result = [];
$si = '[Site Option] ';
$nt = $si;
if ( Environment::is_wordpress_multisite() ) {
$nt = '[Network Option] ';
}
foreach ( self::$network as $opt ) {
$val = self::network_get( $opt );
$result[ $opt ] = [
'label' => $nt . $opt,
'value' => is_bool( $val ) ? $val ? 1 : 0 : $val,
'private' => in_array( $opt, self::$private, true ),
];
}
foreach ( self::$site as $opt ) {
$val = self::site_get( $opt );
$result[ $opt ] = [
'label' => $si . $opt,
'value' => is_bool( $val ) ? $val ? 1 : 0 : $val,
'private' => in_array( $opt, self::$private, true ),
];
}
return $result;
}
/**
* Get an option value for a site.
*
* @param string $option Option name. Expected to not be SQL-escaped.
* @param boolean $default Optional. The default value if option doesn't exists.
* @return mixed The value of the option.
* @since 1.0.0
*/
public static function site_get( $option, $default = null ) {
if ( array_key_exists( $option, self::$defaults ) && ! isset( $default ) ) {
$default = self::$defaults[ $option ];
}
$val = get_option( VIBES_PRODUCT_ABBREVIATION . '_' . $option, $default );
if ( is_bool( $default ) ) {
return (bool) $val;
}
return $val;
}
/**
* Get an option value for a network.
*
* @param string $option Option name. Expected to not be SQL-escaped.
* @param boolean $default Optional. The default value if option doesn't exists.
* @return mixed The value of the option.
* @since 1.0.0
*/
public static function network_get( $option, $default = null ) {
if ( array_key_exists( $option, self::$defaults ) && ! isset( $default ) ) {
$default = self::$defaults[ $option ];
}
$val = get_site_option( VIBES_PRODUCT_ABBREVIATION . '_' . $option, $default );
if ( is_bool( $default ) ) {
return (bool) $val;
}
return $val;
}
/**
* Verify if an option exists.
*
* @param string $option Option name. Expected to not be SQL-escaped.
* @return boolean True if the option exists, false otherwise.
* @since 1.0.0
*/
public static function site_exists( $option ) {
return 'non_existent_option' !== get_option( VIBES_PRODUCT_ABBREVIATION . '_' . $option, 'non_existent_option' );
}
/**
* Verify if an option exists.
*
* @param string $option Option name. Expected to not be SQL-escaped.
* @return boolean True if the option exists, false otherwise.
* @since 1.0.0
*/
public static function network_exists( $option ) {
return 'non_existent_option' !== get_site_option( VIBES_PRODUCT_ABBREVIATION . '_' . $option, 'non_existent_option' );
}
/**
* Set an option value for a site.
*
* @param string $option Option name. Expected to not be SQL-escaped.
* @param mixed $value Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
* @param string|bool $autoload Optional. Whether to load the option when WordPress starts up. For existing options,
* `$autoload` can only be updated using `update_option()` if `$value` is also changed.
* Accepts 'yes'|true to enable or 'no'|false to disable. For non-existent options,
* the default value is 'yes'. Default null.
* @return boolean False if value was not updated and true if value was updated.
* @since 1.0.0
*/
public static function site_set( $option, $value, $autoload = null ) {
if ( false === $value ) {
$value = 0;
}
return update_option( VIBES_PRODUCT_ABBREVIATION . '_' . $option, $value, $autoload );
}
/**
* Set an option value for a network.
*
* @param string $option Option name. Expected to not be SQL-escaped.
* @param mixed $value Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
* @return boolean False if value was not updated and true if value was updated.
* @since 1.0.0
*/
public static function network_set( $option, $value ) {
if ( false === $value ) {
$value = 0;
}
return update_site_option( VIBES_PRODUCT_ABBREVIATION . '_' . $option, $value );
}
/**
* Delete all options for a site.
*
* @return integer Number of deleted items.
* @since 1.0.0
*/
public static function site_delete_all() {
global $wpdb;
$result = 0;
// phpcs:ignore
$delete = $wpdb->get_col( "SELECT option_name FROM {$wpdb->options} WHERE option_name LIKE '" . VIBES_PRODUCT_ABBREVIATION . '_%' . "';" );
foreach ( $delete as $option ) {
if ( delete_option( $option ) ) {
++$result;
}
}
return $result;
}
/**
* Reset some options to their defaults.
*
* @since 1.0.0
*/
public static function reset_to_defaults() {
foreach ( self::$network as $key ) {
if ( 'version' !== $key ) {
self::network_set( $key, self::$defaults[ $key ] );
}
}
}
/**
* Initializes the class and set its properties.
*
* @since 1.0.0
*/
public function __construct() {
}
}
Option::init();