EmailLog\Core\UI\Setting\Setting

Complexity

Total Complexity

12

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
	initialize()	0	1	?
A	load()	0	3	1
A	register()	0	5	1
A	get_value()	0	5	1
A	get_fields()	0	3	1
A	render()	0	3	1
A	sanitize()	0	20	4
A	build_fields()	0	15	2

<?php namespace EmailLog\Core\UI\Setting;

defined( 'ABSPATH' ) || exit; // Exit if accessed directly.

/**
 * Email Log Setting.
 * Contains a setting section and a number of fields.
 *
 * @since 2.0.0
 */
abstract class Setting {

	/**
	 * @var \EmailLog\Core\UI\Setting\SettingSection
	 */
	protected $section;

	/**
	 * Set default values for SettingSection.
	 * Further customization can be done by the add-on in the `initialize` method.
	 */
	public function __construct() {
		$this->section = new SettingSection();

		$this->initialize();

		$this->section->fields = $this->get_fields();
		$this->section->callback = array( $this, 'render' );
		$this->section->sanitize_callback = array( $this, 'sanitize' );
	}

	/**
	 * Setup hooks and filters.
	 */
	public function load() {
		add_filter( 'el_setting_sections', array( $this, 'register' ) );
	}

	/**
	 * Register the setting using the filter.
	 *
	 * @param SettingSection[] $sections List of existing SettingSections.
	 *
	 * @return SettingSection[] Modified list of SettingSections.
	 */
	public function register( $sections ) {
		$sections[] = $this->section;

		return $sections;
	}

	/**
	 * Get the value stored in the option.
	 * If no values are found then the default values are returned.
	 *
	 * @return array Stored value.
	 */
	public function get_value() {
		$value = get_option( $this->section->option_name );

		return wp_parse_args( $value, $this->section->default_value );
	}

	/**
	 * Customize the SettingSection.
	 *
	 * @return void
	 */
	abstract protected function initialize();

	/**
	 * Get the list of SettingFields.
	 *
	 * @return SettingField[] List of fields for the Setting.
	 */
	protected function get_fields() {
		return $this->build_fields();
	}

	/**
	 * Render the Settings section.
	 *
	 * By default it does nothing.
	 */
	public function render() {
		return;
	}

	/**
	 * Sanitize the option values.
	 *
	 * @param mixed $values User entered values.
	 *
	 * @return mixed Sanitized values.
	 */
	public function sanitize( $values ) {
		if ( ! is_array( $values ) ) {
			return array();
		}

		$values = wp_parse_args( $values, $this->section->default_value );
		$sanitized_values = array();

		foreach ( $this->section->field_labels as $field_id => $label ) {
			$callback = array( $this, 'sanitize_' . $field_id );

			if ( is_callable( $callback ) ) {
				$sanitized_values[ $field_id ] = call_user_func( $callback, $values[ $field_id ] );
			} else {
				$sanitized_values[ $field_id ] = $values[ $field_id ];
			}
		}

		return $sanitized_values;
	}

	/**
	 * Build SettingField objects from field id and labels.
	 *
	 * @since 2.1.0
	 *
	 * @return \EmailLog\Core\UI\Setting\SettingField[] Built SettingFields.
	 */
	protected function build_fields() {
		$fields = array();

		foreach ( $this->section->field_labels as $field_id => $label ) {
			$field           = new SettingField();
			$field->id       = $field_id;
			$field->title    = $label;
			$field->args     = array( 'id' => $field_id );
			$field->callback = array( $this, 'render_' . $field_id . '_settings' );

			$fields[] = $field;
		}

		return $fields;
	}
}