Manager

Back Back Up Advanced Editor

<?php

namespace CarouselSlider\Supports\SettingApi;

use CarouselSlider\Supports\Sanitize;
use WP_Error;

defined( 'ABSPATH' ) || exit;

/**
 * Very simple WordPress Settings API wrapper class
 *
 * WordPress Option Page Wrapper class that implements WordPress Settings API and
 * give you easy way to create multi tabs admin menu and
 * add setting fields with build in validation.
 *
 * @author  Sayful Islam <sayful.islam001@gmail.com>
 * @link    https://sayfulislam.com
 */
class SettingApi {
	/**
	 * The instance of the class
	 *
	 * @var self
	 */
	private static $instance = null;

/**
	 * Settings options array
	 *
	 * @var array
	 */
	protected $options = array();

/**
	 * Settings menu fields array
	 *
	 * @var array
	 */
	protected $menu_fields = array();

/**
	 * Settings fields array
	 *
	 * @var array
	 */
	protected $fields = array();

/**
	 * Settings tabs array
	 *
	 * @var array
	 */
	protected $panels = array();

/**
	 * The setting sections
	 *
	 * @var array
	 */
	protected $sections = array();

/**
	 * Option name
	 *
	 * @var string
	 */
	protected $option_name = '';

/**
	 * The only one instance of the class can be loaded
	 *
	 * @return self
	 */
	public static function init() {
		if ( is_null( self::$instance ) ) {
			self::$instance = new self();
		}

return self::$instance;
	}

/**
	 * Add new admin menu
	 *
	 * This method is accessible outside the class for creating menu
	 *
	 * @param  array $menu_fields  The setting arguments.
	 *
	 * @return WP_Error|SettingApi
	 */
	public function add_menu( array $menu_fields ) {
		if ( ! isset( $menu_fields['page_title'], $menu_fields['menu_title'], $menu_fields['menu_slug'] ) ) {
			return new WP_Error( 'field_not_set', 'Required key is not set properly for creating menu.' );
		}

$this->menu_fields = $menu_fields;

if ( ! empty( $menu_fields['option_name'] ) ) {
			$this->set_option_name( $menu_fields['option_name'] );
		}

return $this;
	}

/**
	 * Sanitize options values
	 *
	 * @param  array $input  The setting arguments.
	 *
	 * @return array
	 */
	public function sanitize_options( array $input ): array {
		$output_array = array();
		$fields       = $this->get_fields();
		$options      = $this->get_options();
		foreach ( $fields as $field ) {
			$key     = $field['id'] ?? null;
			$default = $field['default'] ?? null;
			$type    = $field['type'] ?? 'text';
			$value   = $input[ $field['id'] ] ?? $options[ $field['id'] ];

if ( isset( $field['options'] ) && is_array( $field['options'] ) ) {
				$output_array[ $key ] = in_array( $value, array_keys( $field['options'] ), true ) ? $value : $default;
				continue;
			}

if ( isset( $field['sanitize_callback'] ) && is_callable( $field['sanitize_callback'] ) ) {
				$output_array[ $key ] = call_user_func( $field['sanitize_callback'], $value );
				continue;
			}

$output_array[ $key ] = $this->sanitize_by_input_type( $value, $field['type'] );
		}

return $output_array;
	}

/**
	 * Validate the option's value
	 *
	 * @param  mixed  $value  The value.
	 * @param  string $type  The input field type.
	 *
	 * @return string|numeric
	 */
	private function sanitize_by_input_type( $value, string $type = 'text' ) {
		switch ( $type ) {
			case 'number':
				return Sanitize::number( $value );

case 'url':
				return Sanitize::url( $value );

case 'email':
				return Sanitize::email( $value );

case 'date':
				return Sanitize::date( $value );

case 'textarea':
				return Sanitize::textarea( $value );

case 'text':
				return Sanitize::text( $value );

default:
				return Sanitize::deep( $value );
		}
	}

/**
	 * Get fields default values
	 *
	 * @return array
	 */
	public function get_default_options(): array {
		$defaults = array();

foreach ( $this->get_fields() as $field ) {
			$defaults[ $field['id'] ] = $field['default'] ?? '';
		}

return $defaults;
	}

/**
	 * Get options parsed with default value
	 *
	 * @return array
	 */
	public function get_options(): array {
		if ( empty( $this->options ) ) {
			$defaults      = $this->get_default_options();
			$options       = get_option( $this->get_option_name() );
			$this->options = wp_parse_args( $options, $defaults );
		}

return $this->options;
	}

/**
	 * Update options
	 *
	 * @param  array $options  The options.
	 * @param  bool  $sanitize  If it should sanitize options.
	 */
	public function update_options( array $options, bool $sanitize = true ) {
		if ( $sanitize ) {
			$options = $this->sanitize_options( $options );
		}
		update_option( $this->get_option_name(), $options );
	}

/**
	 * Get settings panels
	 *
	 * @return array
	 */
	public function get_panels(): array {
		$panels = apply_filters( 'carousel_slider/settings/panels', $this->panels );

// Sort by priority.
		usort( $panels, array( $this, 'sort_by_priority' ) );

return $panels;
	}

/**
	 * Set panels
	 *
	 * @param  array $panels  The setting arguments.
	 *
	 * @return self
	 */
	public function set_panels( array $panels ): SettingApi {
		foreach ( $panels as $panel ) {
			$this->set_panel( $panel );
		}

return $this;
	}

/**
	 * Get settings sections
	 *
	 * @return array
	 */
	public function get_sections(): array {
		$sections = apply_filters( 'carousel_slider/settings/sections', $this->sections );

// Sort by priority.
		usort( $sections, array( $this, 'sort_by_priority' ) );

return $sections;
	}

/**
	 * Set sections
	 *
	 * @param  array $sections  The setting arguments.
	 *
	 * @return self
	 */
	public function set_sections( array $sections ): SettingApi {
		foreach ( $sections as $section ) {
			$this->set_section( $section );
		}

return $this;
	}

/**
	 * Get settings fields
	 *
	 * @return array
	 */
	public function get_fields(): array {
		$fields = apply_filters( 'carousel_slider/settings/fields', $this->fields );

// Sort by priority.
		usort( $fields, array( $this, 'sort_by_priority' ) );

return $fields;
	}

/**
	 * Set fields
	 *
	 * @param  array $fields  The setting arguments.
	 *
	 * @return self
	 */
	public function set_fields( array $fields ): SettingApi {
		foreach ( $fields as $field ) {
			$this->set_field( $field );
		}

return $this;
	}

/**
	 * Get panel by panel id
	 *
	 * @param  string $panel_id  The panel id.
	 *
	 * @return false|array
	 */
	public function get_panel( string $panel_id ) {
		$current_panel = false;
		foreach ( $this->panels as $panel ) {
			if ( $panel_id === $panel['id'] ) {
				$current_panel = $panel;
			}
		}

return $current_panel;
	}

/**
	 * Add setting page tab
	 *
	 * This method is accessible outside the class for creating page tab
	 *
	 * @param  array $panel  The setting arguments.
	 *
	 * @return self
	 */
	public function set_panel( array $panel ): SettingApi {
		$panel = wp_parse_args(
			$panel,
			array(
				'id'          => '',
				'title'       => '',
				'description' => '',
				'priority'    => 200,
			)
		);

$this->panels[] = $panel;

return $this;
	}

/**
	 * Add Setting page section
	 *
	 * @param  array $section  The setting arguments.
	 *
	 * @return self
	 */
	public function set_section( array $section ): SettingApi {
		$section = wp_parse_args(
			$section,
			array(
				'id'          => 'general',
				'panel'       => '',
				'title'       => '',
				'description' => '',
				'priority'    => 200,
			)
		);

$this->sections[] = $section;

return $this;
	}

/**
	 * Add new settings field
	 * This method is accessible outside the class for creating settings field
	 *
	 * @param  array $field  The setting arguments.
	 *
	 * @return self
	 */
	public function set_field( array $field ): SettingApi {
		$field = wp_parse_args(
			$field,
			array(
				'type'        => 'text',
				'section'     => 'general',
				'id'          => '',
				'title'       => '',
				'description' => '',
				'priority'    => 200,
			)
		);

$this->fields[ $field['id'] ] = $field;

return $this;
	}

/**
	 * Sort array by its priority field
	 *
	 * @param  array $array1  First array.
	 * @param  array $array2  Second array.
	 *
	 * @return mixed
	 */
	public function sort_by_priority( array $array1, array $array2 ) {
		return $array1['priority'] - $array2['priority'];
	}

/**
	 * Get option name
	 *
	 * @return string
	 */
	public function get_option_name(): string {
		if ( ! empty( $this->menu_fields['option_name'] ) ) {
			return $this->menu_fields['option_name'];
		}

return $this->option_name;
	}

/**
	 * Set option name
	 *
	 * @param  string $option_name  The option name.
	 *
	 * @return SettingApi
	 */
	public function set_option_name( string $option_name ): SettingApi {
		$this->option_name = $option_name;

return $this;
	}
}