class-setting.php

<?php
/**
 * Cloudinary represents a single setting node point.
 *
 * @package   Cloudinary\Settings
 */

namespace Cloudinary\Settings;

use Cloudinary\Traits\Params_Trait;
use Cloudinary\Settings;
use Cloudinary\UI\Component;

/**
 * Class Setting
 *
 * @package Cloudinary\Settings
 */
class Setting {

	use Params_Trait;

	/**
	 * Holds the settings component.
	 *
	 * @var Component
	 */
	protected $component;
	/**
	 * Holds the setting type.
	 *
	 * @var string
	 */
	protected $type;

	/**
	 * Holds the root parent.
	 *
	 * @var Settings
	 */
	protected $root;

	/**
	 * Holds the slug.
	 *
	 * @var string
	 */
	protected $slug;

	/**
	 * Holds the list of children.
	 *
	 * @var self[]
	 */
	protected $children = array();

	/**
	 * Holds the parent.
	 *
	 * @var self
	 */
	protected $parent;

	/**
	 * Setting constructor.
	 *
	 * @param string   $slug   The setting slug.
	 * @param Settings $root   The root setting.
	 * @param array    $params Optional Params.
	 */
	public function __construct( $slug, $root = null, $params = array() ) {

		if ( is_null( $root ) ) {
			$root = new Settings( $slug, $params );
		}
		$this->root = $root;
		$this->slug = $slug;
		if ( ! empty( $params ) ) {
			$this->set_params( $params );
		}
	}

	/**
	 * Set the parent setting.
	 *
	 * @param string $parent The slug of the parent setting.
	 */
	public function set_parent( $parent ) {
		$this->parent = $parent;
	}

	/**
	 * Get the parent.
	 *
	 * @param int $depth The depth to go down.
	 *
	 * @return Settings|Setting
	 */
	public function get_parent( $depth = 1 ) {
		$slug = $this->slug;
		while ( 0 < $depth ) {
			$slug = substr( $slug, 0, strrpos( $slug, $this->separator ) );
			$depth --;
		}

		return $this->root->get_setting( $slug );
	}

	/**
	 * Set the setting type.
	 *
	 * @param string $type The parent setting.
	 */
	public function set_type( $type ) {
		$this->type = $type;
	}

	/**
	 * Get the setting type.
	 *
	 * @return string
	 */
	public function get_type() {
		return $this->type;
	}

	/**
	 * Get the settings component.
	 *
	 * @return Component
	 */
	public function get_component() {
		if ( ! $this->component ) {
			foreach ( $this->children as $child ) {
				$child->get_component();
			}
			$this->component = Component::init( $this );
		}

		return $this->component;
	}

	/**
	 * Get the child settings.
	 *
	 * @return Setting[]
	 */
	public function get_settings() {
		return $this->children;
	}

	/**
	 * Get the submitted value, if exists.
	 *
	 * @return mixed
	 */
	public function get_submitted_value() {
		if ( ! empty( $this->children ) ) {
			$value = array();
			foreach ( $this->children as $slug => $child ) {
				$child_value = $child->get_submitted_value();
				if ( null !== $child_value ) {
					$value[ $slug ] = $child_value;
				}
			}

			return $value;
		}

		$raw_value = $this->root->get_submitted_value( $this->get_slug() );
		$value     = null;
		if ( $raw_value ) {
			$value = $this->get_component()->sanitize_value( $raw_value );
		}

		if ( is_null( $value ) && 'text' === $this->get_param( 'type' ) ) {
			$value = $this->get_param( 'default', '' );
		}

		return $value;
	}

	/**
	 * Get a setting.
	 *
	 * @param string $slug The slug of the setting to get.
	 *
	 * @return Setting
	 */
	public function get_setting( $slug ) {
		if ( isset( $this->children[ $slug ] ) ) {
			return $this->children[ $slug ];
		} elseif ( $this->has_setting( $slug ) ) {
			foreach ( $this->children as $child ) {
				if ( $child->has_setting( $slug ) ) {
					return $child->get_setting( $slug );
				}
			}
		}

		$found = $this->root->get_setting( $this->slug . $this->separator . $slug );
		if ( $found ) {
			$found = $this->root->get_setting( $slug );
		}

		return $found;
	}

	/**
	 * Magic method to chain directly to the child settings by slug.
	 *
	 * @param string $name The name/slug of the child setting.
	 *
	 * @return Setting|null
	 */
	public function __get( $name ) {

		$value = false;
		if ( '_' === $name[0] ) {
			$value = true;
			$name  = ltrim( $name, '_' );
		}
		if ( ! isset( $this->children[ $name ] ) ) {
			$params                  = array(
				Settings::META_KEYS['storage'] => $this->get_param( Settings::META_KEYS['storage'] ) . $this->separator . $name,
			);
			$this->children[ $name ] = $this->root->add( $this->slug . $this->separator . $name, array(), $params );
		}
		$return = $this->children[ $name ];
		if ( $value ) {
			$return = $return->get_value();
		}

		return $return;
	}

	/**
	 * Magic method to set a child setting's value.
	 *
	 * @param string $name  The setting name being set.
	 * @param mixed  $value The value to set.
	 */
	public function __set( $name, $value ) {

		$this->{$name}->set_value( $value );
	}

	/**
	 * Add a child component.
	 *
	 * @param self $component The component to add.
	 *
	 * @return Setting|\WP_Error
	 */
	public function add( $component ) {
		$parts                   = explode( $this->separator, $component->get_slug() );
		$slug                    = array_pop( $parts );
		$this->children[ $slug ] = $component;

		return $component;
	}

	/**
	 * Get the component slug.
	 *
	 * @return string
	 */
	public function get_slug() {

		return $this->slug;
	}

	/**
	 * Get a setting value.
	 *
	 * @param string $slug The slug to get.
	 *
	 * @return mixed
	 */
	public function get_value( $slug = null ) {
		if ( null !== $slug ) {
			if ( isset( $this->children[ $slug ] ) ) {
				return $this->children[ $slug ]->get_value();
			}
		}

		return $this->root->get_value( $slug ? $slug : $this->slug );
	}

	/**
	 * Set the value of the setting.
	 *
	 * @param mixed $value The value to set.
	 */
	public function set_value( $value ) {

		$this->root->set_value( $this->slug, $value );
	}

	/**
	 * Pend a setting's value, for prep to update.
	 *
	 * @param mixed $value The value to set.
	 */
	public function set_pending( $value ) {
		$this->root->set_pending( $this->slug, $value );
	}

	/**
	 * Get a setting's pending value for update.
	 *
	 * @return mixed
	 */
	public function get_pending() {
		return $this->root->get_pending( $this->slug );
	}

	/**
	 * Check if a slug has a pending set of changes.
	 *
	 * @return bool
	 */
	public function has_pending() {
		return $this->root->has_pending( $this->slug );
	}

	/**
	 * Remove a pending set.
	 */
	public function remove_pending() {
		$this->root->remove_pending( $this->slug );
	}

	/**
	 * Check if the setting has a parent.
	 *
	 * @return bool
	 */
	public function has_parent() {
		return ! empty( $this->parent );
	}

	/**
	 * Check if the setting has settings.
	 *
	 * @return bool
	 */
	public function has_settings() {
		return ! empty( $this->children );
	}

	/**
	 * Check if the setting has a child setting with the slug.
	 *
	 * @param string $slug The slug to check for.
	 *
	 * @return bool
	 */
	public function has_setting( $slug ) {
		if ( isset( $this->children[ $slug ] ) ) {
			return true;
		}
		foreach ( $this->children as $child ) {
			if ( $child->has_setting( $slug ) ) {
				return true;
			}
		}

		return false;
	}

	/**
	 * Get the main option name.
	 *
	 * @return string
	 */
	public function get_option_name() {
		return explode( $this->separator, $this->get_param( Settings::META_KEYS['storage'] ), 2 )[0];
	}

	/**
	 * Get the option parent.
	 *
	 * @return Settings
	 */
	public function get_option_parent() {
		$root = explode( $this->separator, $this->slug, 2 )[0];

		return $this->root->get_setting( $root );
	}

	/**
	 * Get the root setting.
	 *
	 * @return Settings
	 */
	public function get_root_setting() {
		return $this->root;
	}

	/**
	 * Find a setting.
	 *
	 * @param string $slug The slug to find.
	 *
	 * @return Setting
	 */
	public function find_setting( $slug ) {
		return $this->root->find_setting( $slug );
	}

	/**
	 * Save the setting value.
	 *
	 * @param mixed $value The value to save.
	 */
	public function save_value( $value ) {
		$this->root->set_pending( $this->slug, $value );
		$this->root->save_setting( $this->get_option_name() );
	}

	/**
	 * Delete a settings data.
	 *
	 * @return bool
	 */
	public function delete() {
		$this->root->set_pending( $this->slug, '--delete' );
		$this->root->remove_pending( $this->slug );

		return $this->root->delete( $this->get_param( Settings::META_KEYS['storage'] ) );
	}
}