eventespresso / event-espresso-core

core/libraries/form_sections/form_handlers/InvalidFormHandlerException.php

Indentation +21 added lines, -21 removed lines

@@ -13,25 +13,25 @@
 class InvalidFormHandlerException extends \UnexpectedValueException
 {
 
-    /**
-     * InvalidFormHandlerException constructor.
-     *
-     * @param string     $actual the FormHandler object that was received
-     * @param string     $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct($actual, $message = '', $code = 0, \Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    'A valid Form Handler was expected but instead "%1$s" was received.',
-                    'event_espresso'
-                ),
-                $actual
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidFormHandlerException constructor.
+	 *
+	 * @param string     $actual the FormHandler object that was received
+	 * @param string     $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct($actual, $message = '', $code = 0, \Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'A valid Form Handler was expected but instead "%1$s" was received.',
+					'event_espresso'
+				),
+				$actual
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/libraries/form_sections/base/EE_Form_Section_Base.form.php

Indentation +476 added lines, -476 removed lines

@@ -15,486 +15,486 @@
 abstract class EE_Form_Section_Base
 {
 
-    /**
-     * the URL the form is submitted to
-     *
-     * @var string
-     */
-    protected $_action;
-
-    /**
-     * POST (default) or GET
-     *
-     * @var string
-     */
-    protected $_method;
-
-    /**
-     * html_id and html_name are derived from this by default
-     *
-     * @var string
-     */
-    protected $_name;
-
-    /**
-     * $_html_id
-     * @var string
-     */
-    protected $_html_id;
-
-    /**
-     * $_html_class
-     * @var string
-     */
-    protected $_html_class;
-
-    /**
-     * $_html_style
-     * @var string
-     */
-    protected $_html_style;
-
-    /**
-     * $_other_html_attributes
-     * @var string
-     */
-    protected $_other_html_attributes;
-
-    /**
-     * The form section of which this form section is a part
-     *
-     * @var EE_Form_Section_Proper
-     */
-    protected $_parent_section;
-
-    /**
-     * flag indicating that _construct_finalize has been called.
-     * If it has not been called and we try to use functions which require it, we call it
-     * with no parameters. But normally, _construct_finalize should be called by the instantiating class
-     *
-     * @var boolean
-     */
-    protected $_construction_finalized;
-
-    /**
-     * Strategy for parsing the form HTML upon display
-     *
-     * @var FormHtmlFilter
-     */
-    protected $_form_html_filter;
-
-
-    /**
-     * @param array $options_array {
-     * @type        $name          string the name for this form section, if you want to explicitly define it
-     *                             }
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($options_array = array())
-    {
-        // used by display strategies
-        // assign incoming values to properties
-        foreach ($options_array as $key => $value) {
-            $key = '_' . $key;
-            if (property_exists($this, $key) && empty($this->{$key})) {
-                $this->{$key} = $value;
-                if ($key === '_subsections' && ! is_array($value)) {
-                    throw new InvalidDataTypeException($key, $value, 'array');
-                }
-            }
-        }
-        // set parser which allows the form section's rendered HTML to be filtered
-        if (isset($options_array['form_html_filter']) && $options_array['form_html_filter'] instanceof FormHtmlFilter) {
-            $this->_form_html_filter = $options_array['form_html_filter'];
-        }
-    }
-
-
-
-    /**
-     * @param $parent_form_section
-     * @param $name
-     * @throws \EE_Error
-     */
-    protected function _construct_finalize($parent_form_section, $name)
-    {
-        $this->_construction_finalized = true;
-        $this->_parent_section = $parent_form_section;
-        if ($name !== null) {
-            $this->_name = $name;
-        }
-    }
-
-
-
-    /**
-     * make sure construction finalized was called, otherwise children might not be ready
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function ensure_construct_finalized_called()
-    {
-        if (! $this->_construction_finalized) {
-            $this->_construct_finalize($this->_parent_section, $this->_name);
-        }
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function action()
-    {
-        return $this->_action;
-    }
-
-
-
-    /**
-     * @param string $action
-     */
-    public function set_action($action)
-    {
-        $this->_action = $action;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function method()
-    {
-        return ! empty($this->_method) ? $this->_method : 'POST';
-    }
-
-
-
-    /**
-     * @param string $method
-     */
-    public function set_method($method)
-    {
-        switch ($method) {
-            case 'get':
-            case 'GET':
-                $this->_method = 'GET';
-                break;
-            default:
-                $this->_method = 'POST';
-        }
-    }
-
-
-
-    /**
-     * Sets the html_id to its default value, if none was specified in the constructor.
-     * Calculation involves using the name and the parent's html id
-     * return void
-     *
-     * @throws \EE_Error
-     */
-    protected function _set_default_html_id_if_empty()
-    {
-        if (! $this->_html_id) {
-            if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
-                $this->_html_id = $this->_parent_section->html_id()
-                                  . '-'
-                                  . $this->_prep_name_for_html_id($this->name());
-            } else {
-                $this->_html_id = $this->_prep_name_for_html_id($this->name());
-            }
-        }
-    }
-
-
-
-    /**
-     * _prep_name_for_html_id
-     *
-     * @param $name
-     * @return string
-     */
-    private function _prep_name_for_html_id($name)
-    {
-        return sanitize_key(str_replace(array(' ', ' ', '_'), '-', $name));
-    }
+	/**
+	 * the URL the form is submitted to
+	 *
+	 * @var string
+	 */
+	protected $_action;
+
+	/**
+	 * POST (default) or GET
+	 *
+	 * @var string
+	 */
+	protected $_method;
+
+	/**
+	 * html_id and html_name are derived from this by default
+	 *
+	 * @var string
+	 */
+	protected $_name;
+
+	/**
+	 * $_html_id
+	 * @var string
+	 */
+	protected $_html_id;
+
+	/**
+	 * $_html_class
+	 * @var string
+	 */
+	protected $_html_class;
+
+	/**
+	 * $_html_style
+	 * @var string
+	 */
+	protected $_html_style;
+
+	/**
+	 * $_other_html_attributes
+	 * @var string
+	 */
+	protected $_other_html_attributes;
+
+	/**
+	 * The form section of which this form section is a part
+	 *
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_parent_section;
+
+	/**
+	 * flag indicating that _construct_finalize has been called.
+	 * If it has not been called and we try to use functions which require it, we call it
+	 * with no parameters. But normally, _construct_finalize should be called by the instantiating class
+	 *
+	 * @var boolean
+	 */
+	protected $_construction_finalized;
+
+	/**
+	 * Strategy for parsing the form HTML upon display
+	 *
+	 * @var FormHtmlFilter
+	 */
+	protected $_form_html_filter;
+
+
+	/**
+	 * @param array $options_array {
+	 * @type        $name          string the name for this form section, if you want to explicitly define it
+	 *                             }
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($options_array = array())
+	{
+		// used by display strategies
+		// assign incoming values to properties
+		foreach ($options_array as $key => $value) {
+			$key = '_' . $key;
+			if (property_exists($this, $key) && empty($this->{$key})) {
+				$this->{$key} = $value;
+				if ($key === '_subsections' && ! is_array($value)) {
+					throw new InvalidDataTypeException($key, $value, 'array');
+				}
+			}
+		}
+		// set parser which allows the form section's rendered HTML to be filtered
+		if (isset($options_array['form_html_filter']) && $options_array['form_html_filter'] instanceof FormHtmlFilter) {
+			$this->_form_html_filter = $options_array['form_html_filter'];
+		}
+	}
+
+
+
+	/**
+	 * @param $parent_form_section
+	 * @param $name
+	 * @throws \EE_Error
+	 */
+	protected function _construct_finalize($parent_form_section, $name)
+	{
+		$this->_construction_finalized = true;
+		$this->_parent_section = $parent_form_section;
+		if ($name !== null) {
+			$this->_name = $name;
+		}
+	}
+
+
+
+	/**
+	 * make sure construction finalized was called, otherwise children might not be ready
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function ensure_construct_finalized_called()
+	{
+		if (! $this->_construction_finalized) {
+			$this->_construct_finalize($this->_parent_section, $this->_name);
+		}
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function action()
+	{
+		return $this->_action;
+	}
+
+
+
+	/**
+	 * @param string $action
+	 */
+	public function set_action($action)
+	{
+		$this->_action = $action;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function method()
+	{
+		return ! empty($this->_method) ? $this->_method : 'POST';
+	}
+
+
+
+	/**
+	 * @param string $method
+	 */
+	public function set_method($method)
+	{
+		switch ($method) {
+			case 'get':
+			case 'GET':
+				$this->_method = 'GET';
+				break;
+			default:
+				$this->_method = 'POST';
+		}
+	}
+
+
+
+	/**
+	 * Sets the html_id to its default value, if none was specified in the constructor.
+	 * Calculation involves using the name and the parent's html id
+	 * return void
+	 *
+	 * @throws \EE_Error
+	 */
+	protected function _set_default_html_id_if_empty()
+	{
+		if (! $this->_html_id) {
+			if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
+				$this->_html_id = $this->_parent_section->html_id()
+								  . '-'
+								  . $this->_prep_name_for_html_id($this->name());
+			} else {
+				$this->_html_id = $this->_prep_name_for_html_id($this->name());
+			}
+		}
+	}
+
+
+
+	/**
+	 * _prep_name_for_html_id
+	 *
+	 * @param $name
+	 * @return string
+	 */
+	private function _prep_name_for_html_id($name)
+	{
+		return sanitize_key(str_replace(array(' ', ' ', '_'), '-', $name));
+	}
 
 
 
-    /**
-     * Returns the HTML, JS, and CSS necessary to display this form section on a page.
-     * Note however, it's recommended that you instead call enqueue_js on the "wp_enqueue_scripts" action,
-     * and call get_html when you want to output the html. Calling get_html_and_js after
-     * "wp_enqueue_scripts" has already fired seems to work for now, but is contrary
-     * to the instructions on https://developer.wordpress.org/reference/functions/wp_enqueue_script/
-     * and so might stop working anytime.
-     *
-     * @return string
-     */
-    public function get_html_and_js()
-    {
-        return $this->get_html();
-    }
+	/**
+	 * Returns the HTML, JS, and CSS necessary to display this form section on a page.
+	 * Note however, it's recommended that you instead call enqueue_js on the "wp_enqueue_scripts" action,
+	 * and call get_html when you want to output the html. Calling get_html_and_js after
+	 * "wp_enqueue_scripts" has already fired seems to work for now, but is contrary
+	 * to the instructions on https://developer.wordpress.org/reference/functions/wp_enqueue_script/
+	 * and so might stop working anytime.
+	 *
+	 * @return string
+	 */
+	public function get_html_and_js()
+	{
+		return $this->get_html();
+	}
 
 
-
-    /**
-     * Gets the HTML for displaying this form section
-     *
-     * @return string
-     */
-    abstract public function get_html();
-
-
-    /**
-     * @param bool $add_pound_sign
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_id($add_pound_sign = false)
-    {
-        $this->_set_default_html_id_if_empty();
-        return $add_pound_sign ? '#' . $this->_html_id : $this->_html_id;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_class()
-    {
-        return $this->_html_class;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_style()
-    {
-        return $this->_html_style;
-    }
-
-
-
-    /**
-     * @param mixed $html_class
-     */
-    public function set_html_class($html_class)
-    {
-        $this->_html_class = $html_class;
-    }
-
-
-
-    /**
-     * @param mixed $html_id
-     */
-    public function set_html_id($html_id)
-    {
-        $this->_html_id = $html_id;
-    }
-
-
-
-    /**
-     * @param mixed $html_style
-     */
-    public function set_html_style($html_style)
-    {
-        $this->_html_style = $html_style;
-    }
-
-
-
-    /**
-     * @param string $other_html_attributes
-     */
-    public function set_other_html_attributes($other_html_attributes)
-    {
-        $this->_other_html_attributes = $other_html_attributes;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function other_html_attributes()
-    {
-        return ! empty($this->_other_html_attributes) ? ' ' . $this->_other_html_attributes : '';
-    }
-
-
-
-    /**
-     * Gets the name of the form section. This is not the same as the HTML name.
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function name()
-    {
-        if (! $this->_construction_finalized) {
-            throw new EE_Error(sprintf(esc_html__(
-                'You cannot use the form section\s name until _construct_finalize has been called on it (when we set the name). It was called on a form section of type \'s\'',
-                'event_espresso'
-            ), get_class($this)));
-        }
-        return $this->_name;
-    }
-
-
-
-    /**
-     * Gets the parent section
-     *
-     * @return EE_Form_Section_Proper
-     */
-    public function parent_section()
-    {
-        return $this->_parent_section;
-    }
-
-
-    /**
-     * returns HTML for generating the opening form HTML tag (<form>)
-     *
-     * @param string $action           the URL the form is submitted to
-     * @param string $method           POST (default) or GET
-     * @param string $other_attributes anything else added to the form open tag, MUST BE VALID HTML
-     * @return string
-     * @throws EE_Error
-     */
-    public function form_open($action = '', $method = '', $other_attributes = '')
-    {
-        if (! empty($action)) {
-            $this->set_action($action);
-        }
-        if (! empty($method)) {
-            $this->set_method($method);
-        }
-        $html = EEH_HTML::nl(1, 'form') . '<form';
-        $html .= $this->html_id() !== '' ? ' id="' . $this->get_html_id_for_form($this->html_id()) . '"' : '';
-        $html .= ' action="' . $this->action() . '"';
-        $html .= ' method="' . $this->method() . '"';
-        $html .= ' name="' . $this->name() . '"';
-        $html .= $other_attributes . '>';
-        return $html;
-    }
-
-
-
-    /**
-     * ensures that html id for form either ends in "-form" or "-frm"
-     * so that id doesn't conflict/collide with other elements
-     *
-     * @param string $html_id
-     * @return string
-     */
-    protected function get_html_id_for_form($html_id)
-    {
-        $strlen = strlen($html_id);
-        $html_id = strpos($html_id, '-form') === $strlen - 5 || strpos($html_id, '-frm') === $strlen - 4
-            ? $html_id
-            : $html_id . '-frm';
-        return $html_id;
-    }
-
-
-    /**
-     * returns HTML for generating the closing form HTML tag (</form>)
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function form_close()
-    {
-        return EEH_HTML::nl(-1, 'form')
-               . '</form>'
-               . EEH_HTML::nl()
-               . '<!-- end of ee-'
-               . $this->html_id()
-               . '-form -->'
-               . EEH_HTML::nl();
-    }
-
-
-
-    /**
-     * enqueues JS (and CSS) for the form (ie immediately call wp_enqueue_script and
-     * wp_enqueue_style; the scripts could have optionally been registered earlier)
-     * Default does nothing, but child classes can override
-     *
-     * @return void
-     */
-    public function enqueue_js()
-    {
-        // defaults to enqueue NO js or css
-    }
-
-
-
-    /**
-     * Adds any extra data needed by js. Eventually we'll call wp_localize_script
-     * with it, and it will be on each form section's 'other_data' property.
-     * By default nothing is added, but child classes can extend this method to add something.
-     * Eg, if you have an input that will cause a modal dialog to appear,
-     * here you could add an entry like 'modal_dialog_inputs' to this array
-     * to map between the input's html ID and the modal dialogue's ID, so that
-     * your JS code will know where to find the modal dialog when the input is pressed.
-     * Eg $form_other_js_data['modal_dialog_inputs']['some-input-id']='modal-dialog-id';
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data($form_other_js_data = array())
-    {
-        return $form_other_js_data;
-    }
-
-
-
-    /**
-     * This isn't just the name of an input, it's a path pointing to an input. The
-     * path is similar to a folder path: slash (/) means to descend into a subsection,
-     * dot-dot-slash (../) means to ascend into the parent section.
-     * After a series of slashes and dot-dot-slashes, there should be the name of an input,
-     * which will be returned.
-     * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
-     * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
-     * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
-     * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
-     * Etc
-     *
-     * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
-     * @return EE_Form_Section_Base
-     */
-    public function find_section_from_path($form_section_path)
-    {
-        if (strpos($form_section_path, '/') === 0) {
-            $form_section_path = substr($form_section_path, strlen('/'));
-        }
-        if (empty($form_section_path)) {
-            return $this;
-        }
-        if (strpos($form_section_path, '../') === 0) {
-            $parent = $this->parent_section();
-            $form_section_path = substr($form_section_path, strlen('../'));
-            if ($parent instanceof EE_Form_Section_Base) {
-                return $parent->find_section_from_path($form_section_path);
-            }
-            if (empty($form_section_path)) {
-                return $this;
-            }
-        }
-        // couldn't find it using simple parent following
-        return null;
-    }
+
+	/**
+	 * Gets the HTML for displaying this form section
+	 *
+	 * @return string
+	 */
+	abstract public function get_html();
+
+
+	/**
+	 * @param bool $add_pound_sign
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_id($add_pound_sign = false)
+	{
+		$this->_set_default_html_id_if_empty();
+		return $add_pound_sign ? '#' . $this->_html_id : $this->_html_id;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_class()
+	{
+		return $this->_html_class;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_style()
+	{
+		return $this->_html_style;
+	}
+
+
+
+	/**
+	 * @param mixed $html_class
+	 */
+	public function set_html_class($html_class)
+	{
+		$this->_html_class = $html_class;
+	}
+
+
+
+	/**
+	 * @param mixed $html_id
+	 */
+	public function set_html_id($html_id)
+	{
+		$this->_html_id = $html_id;
+	}
+
+
+
+	/**
+	 * @param mixed $html_style
+	 */
+	public function set_html_style($html_style)
+	{
+		$this->_html_style = $html_style;
+	}
+
+
+
+	/**
+	 * @param string $other_html_attributes
+	 */
+	public function set_other_html_attributes($other_html_attributes)
+	{
+		$this->_other_html_attributes = $other_html_attributes;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function other_html_attributes()
+	{
+		return ! empty($this->_other_html_attributes) ? ' ' . $this->_other_html_attributes : '';
+	}
+
+
+
+	/**
+	 * Gets the name of the form section. This is not the same as the HTML name.
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function name()
+	{
+		if (! $this->_construction_finalized) {
+			throw new EE_Error(sprintf(esc_html__(
+				'You cannot use the form section\s name until _construct_finalize has been called on it (when we set the name). It was called on a form section of type \'s\'',
+				'event_espresso'
+			), get_class($this)));
+		}
+		return $this->_name;
+	}
+
+
+
+	/**
+	 * Gets the parent section
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	public function parent_section()
+	{
+		return $this->_parent_section;
+	}
+
+
+	/**
+	 * returns HTML for generating the opening form HTML tag (<form>)
+	 *
+	 * @param string $action           the URL the form is submitted to
+	 * @param string $method           POST (default) or GET
+	 * @param string $other_attributes anything else added to the form open tag, MUST BE VALID HTML
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function form_open($action = '', $method = '', $other_attributes = '')
+	{
+		if (! empty($action)) {
+			$this->set_action($action);
+		}
+		if (! empty($method)) {
+			$this->set_method($method);
+		}
+		$html = EEH_HTML::nl(1, 'form') . '<form';
+		$html .= $this->html_id() !== '' ? ' id="' . $this->get_html_id_for_form($this->html_id()) . '"' : '';
+		$html .= ' action="' . $this->action() . '"';
+		$html .= ' method="' . $this->method() . '"';
+		$html .= ' name="' . $this->name() . '"';
+		$html .= $other_attributes . '>';
+		return $html;
+	}
+
+
+
+	/**
+	 * ensures that html id for form either ends in "-form" or "-frm"
+	 * so that id doesn't conflict/collide with other elements
+	 *
+	 * @param string $html_id
+	 * @return string
+	 */
+	protected function get_html_id_for_form($html_id)
+	{
+		$strlen = strlen($html_id);
+		$html_id = strpos($html_id, '-form') === $strlen - 5 || strpos($html_id, '-frm') === $strlen - 4
+			? $html_id
+			: $html_id . '-frm';
+		return $html_id;
+	}
+
+
+	/**
+	 * returns HTML for generating the closing form HTML tag (</form>)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function form_close()
+	{
+		return EEH_HTML::nl(-1, 'form')
+			   . '</form>'
+			   . EEH_HTML::nl()
+			   . '<!-- end of ee-'
+			   . $this->html_id()
+			   . '-form -->'
+			   . EEH_HTML::nl();
+	}
+
+
+
+	/**
+	 * enqueues JS (and CSS) for the form (ie immediately call wp_enqueue_script and
+	 * wp_enqueue_style; the scripts could have optionally been registered earlier)
+	 * Default does nothing, but child classes can override
+	 *
+	 * @return void
+	 */
+	public function enqueue_js()
+	{
+		// defaults to enqueue NO js or css
+	}
+
+
+
+	/**
+	 * Adds any extra data needed by js. Eventually we'll call wp_localize_script
+	 * with it, and it will be on each form section's 'other_data' property.
+	 * By default nothing is added, but child classes can extend this method to add something.
+	 * Eg, if you have an input that will cause a modal dialog to appear,
+	 * here you could add an entry like 'modal_dialog_inputs' to this array
+	 * to map between the input's html ID and the modal dialogue's ID, so that
+	 * your JS code will know where to find the modal dialog when the input is pressed.
+	 * Eg $form_other_js_data['modal_dialog_inputs']['some-input-id']='modal-dialog-id';
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data($form_other_js_data = array())
+	{
+		return $form_other_js_data;
+	}
+
+
+
+	/**
+	 * This isn't just the name of an input, it's a path pointing to an input. The
+	 * path is similar to a folder path: slash (/) means to descend into a subsection,
+	 * dot-dot-slash (../) means to ascend into the parent section.
+	 * After a series of slashes and dot-dot-slashes, there should be the name of an input,
+	 * which will be returned.
+	 * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
+	 * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
+	 * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
+	 * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
+	 * Etc
+	 *
+	 * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
+	 * @return EE_Form_Section_Base
+	 */
+	public function find_section_from_path($form_section_path)
+	{
+		if (strpos($form_section_path, '/') === 0) {
+			$form_section_path = substr($form_section_path, strlen('/'));
+		}
+		if (empty($form_section_path)) {
+			return $this;
+		}
+		if (strpos($form_section_path, '../') === 0) {
+			$parent = $this->parent_section();
+			$form_section_path = substr($form_section_path, strlen('../'));
+			if ($parent instanceof EE_Form_Section_Base) {
+				return $parent->find_section_from_path($form_section_path);
+			}
+			if (empty($form_section_path)) {
+				return $this;
+			}
+		}
+		// couldn't find it using simple parent following
+		return null;
+	}
 }
 // End of file EE_Form_Section_Base.form.php

Spacing +15 added lines, -15 removed lines

@@ -95,7 +95,7 @@ 
         // used by display strategies
         // assign incoming values to properties
         foreach ($options_array as $key => $value) {
-            $key = '_' . $key;
+            $key = '_'.$key;
             if (property_exists($this, $key) && empty($this->{$key})) {
                 $this->{$key} = $value;
                 if ($key === '_subsections' && ! is_array($value)) {
@@ -135,7 +135,7 @@ 
      */
     public function ensure_construct_finalized_called()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             $this->_construct_finalize($this->_parent_section, $this->_name);
         }
     }
@@ -198,7 +198,7 @@ 
      */
     protected function _set_default_html_id_if_empty()
     {
-        if (! $this->_html_id) {
+        if ( ! $this->_html_id) {
             if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
                 $this->_html_id = $this->_parent_section->html_id()
                                   . '-'
@@ -257,7 +257,7 @@ 
     public function html_id($add_pound_sign = false)
     {
         $this->_set_default_html_id_if_empty();
-        return $add_pound_sign ? '#' . $this->_html_id : $this->_html_id;
+        return $add_pound_sign ? '#'.$this->_html_id : $this->_html_id;
     }
 
 
@@ -327,7 +327,7 @@ 
      */
     public function other_html_attributes()
     {
-        return ! empty($this->_other_html_attributes) ? ' ' . $this->_other_html_attributes : '';
+        return ! empty($this->_other_html_attributes) ? ' '.$this->_other_html_attributes : '';
     }
 
 
@@ -340,7 +340,7 @@ 
      */
     public function name()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             throw new EE_Error(sprintf(esc_html__(
                 'You cannot use the form section\s name until _construct_finalize has been called on it (when we set the name). It was called on a form section of type \'s\'',
                 'event_espresso'
@@ -373,18 +373,18 @@ 
      */
     public function form_open($action = '', $method = '', $other_attributes = '')
     {
-        if (! empty($action)) {
+        if ( ! empty($action)) {
             $this->set_action($action);
         }
-        if (! empty($method)) {
+        if ( ! empty($method)) {
             $this->set_method($method);
         }
-        $html = EEH_HTML::nl(1, 'form') . '<form';
-        $html .= $this->html_id() !== '' ? ' id="' . $this->get_html_id_for_form($this->html_id()) . '"' : '';
-        $html .= ' action="' . $this->action() . '"';
-        $html .= ' method="' . $this->method() . '"';
-        $html .= ' name="' . $this->name() . '"';
-        $html .= $other_attributes . '>';
+        $html = EEH_HTML::nl(1, 'form').'<form';
+        $html .= $this->html_id() !== '' ? ' id="'.$this->get_html_id_for_form($this->html_id()).'"' : '';
+        $html .= ' action="'.$this->action().'"';
+        $html .= ' method="'.$this->method().'"';
+        $html .= ' name="'.$this->name().'"';
+        $html .= $other_attributes.'>';
         return $html;
     }
 
@@ -402,7 +402,7 @@ 
         $strlen = strlen($html_id);
         $html_id = strpos($html_id, '-form') === $strlen - 5 || strpos($html_id, '-frm') === $strlen - 4
             ? $html_id
-            : $html_id . '-frm';
+            : $html_id.'-frm';
         return $html_id;
     }
 

core/libraries/form_sections/base/EE_Model_Form_Section.form.php

Indentation +456 added lines, -456 removed lines

@@ -12,460 +12,460 @@
 class EE_Model_Form_Section extends EE_Form_Section_Proper
 {
 
-    /**
-     * @var EEM_Base
-     */
-    protected $_model = null;
-
-    /**
-     * @var EE_Base_Class
-     */
-    protected $_model_object = null;
-
-
-
-    /**
-     * @param array        $options_array   keys: {
-     * @type EEM_Base      $model
-     * @type EE_Base_Class $model_object
-     * @type array         $subsection_args array keys should be subsection names (that either do or will exist), and
-     *       values are the arrays as you would pass them to that subsection
-     *                                      }
-     * @throws EE_Error
-     */
-    public function __construct($options_array = array())
-    {
-        if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
-            $this->_model = $options_array['model'];
-        }
-        if (! $this->_model || ! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(sprintf(esc_html__(
-                "Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
-                "event_espresso"
-            )));
-        }
-        if (isset($options_array['subsection_args'])) {
-            $subsection_args = $options_array['subsection_args'];
-        } else {
-            $subsection_args = array();
-        }
-        // gather fields and relations to convert to inputs
-        // but if they're just going to exclude a field anyways, don't bother converting it to an input
-        $exclude = $this->_subsections;
-        if (isset($options_array['exclude'])) {
-            $exclude = array_merge($exclude, array_flip($options_array['exclude']));
-        }
-        $model_fields = array_diff_key($this->_model->field_settings(), $exclude);
-        $model_relations = array_diff_key($this->_model->relation_settings(), $exclude);
-        // convert fields and relations to inputs
-        $this->_subsections = array_merge(
-            $this->_convert_model_fields_to_inputs($model_fields),
-            $this->_convert_model_relations_to_inputs($model_relations, $subsection_args),
-            $this->_subsections
-        );
-        parent::__construct($options_array);
-        if (isset($options_array['model_object']) && $options_array['model_object'] instanceof EE_Base_Class) {
-            $this->populate_model_obj($options_array['model_object']);
-        }
-    }
-
-
-
-    /**
-     * For now, just makes inputs for only HABTM relations
-     *
-     * @param EE_Model_Relation_Base[] $relations
-     * @param array                    $subsection_args keys should be existing or soon-to-be-existing input names, and
-     *                                                  their values are {
-     * @type array {
-     * @type EE_Base_Class[]           $model_objects   if the subsection is an EE_Select_Multi_Model_Input
-     *                                                  }
-     *                                                  }
-     * @return array
-     */
-    protected function _convert_model_relations_to_inputs($relations, $subsection_args = array())
-    {
-        $inputs = array();
-        foreach ($relations as $relation_name => $relation_obj) {
-            $input_constructor_args = array(
-                array_merge(
-                    array(
-                        'required'        => $relation_obj instanceof EE_Belongs_To_Relation,
-                        'html_label_text' => $relation_obj instanceof EE_Belongs_To_Relation
-                            ? $relation_obj->get_other_model()->item_name(1)
-                            : $relation_obj->get_other_model()
-                                           ->item_name(2),
-                    ),
-                    $subsection_args
-                ),
-            );
-            $input = null;
-            switch (get_class($relation_obj)) {
-                case 'EE_HABTM_Relation':
-                    if (
-                        isset($subsection_args[ $relation_name ])
-                        && isset($subsection_args[ $relation_name ]['model_objects'])
-                    ) {
-                        $model_objects = $subsection_args[ $relation_name ]['model_objects'];
-                    } else {
-                        $model_objects = $relation_obj->get_other_model()->get_all();
-                    }
-                    $input = new EE_Select_Multi_Model_Input($model_objects, $input_constructor_args);
-                    break;
-                default:
-            }
-            if ($input) {
-                $inputs[ $relation_name ] = $input;
-            }
-        }
-        return $inputs;
-    }
-
-
-
-    /**
-     * Changes model fields into form section inputs
-     *
-     * @param EE_Model_Field_Base[] $model_fields keys are the model's name
-     * @throws EE_Error
-     * @return EE_Form_Input_Base[]
-     */
-    protected function _convert_model_fields_to_inputs($model_fields = array())
-    {
-        $inputs = array();
-        foreach ($model_fields as $field_name => $model_field) {
-            if ($model_field instanceof EE_Model_Field_Base) {
-                $input_constructor_args = array(
-                    array(
-                        'required'        => ! $model_field->is_nullable()
-                                             && $model_field->get_default_value()
-                                                === null,
-                        'html_label_text' => $model_field->get_nicename(),
-                        'default'         => $model_field->get_default_value(),
-                    ),
-                );
-                switch (get_class($model_field)) {
-                    case 'EE_All_Caps_Text_Field':
-                    case 'EE_Any_Foreign_Model_Name_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Boolean_Field':
-                        $input_class = 'EE_Yes_No_Input';
-                        break;
-                    case 'EE_Datetime_Field':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Email_Field':
-                        $input_class = 'EE_Email_Input';
-                        break;
-                    case 'EE_Enum_Integer_Field':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Enum_Text_Field':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Float_Field':
-                        $input_class = 'EE_Float_Input';
-                        break;
-                    case 'EE_Foreign_Key_Int_Field':
-                    case 'EE_Foreign_Key_String_Field':
-                    case 'EE_WP_User_Field':
-                        $models_pointed_to = $model_field instanceof EE_Field_With_Model_Name
-                            ? $model_field->get_model_class_names_pointed_to() : array();
-                        if (true || is_array($models_pointed_to) && count($models_pointed_to) > 1) {
-                            $input_class = 'EE_Text_Input';
-                        } else {
-                            // so its just one model
-                            $model_name = is_array($models_pointed_to) ? reset($models_pointed_to) : $models_pointed_to;
-                            $model = EE_Registry::instance()->load_model($model_name);
-                            $model_names = $model->get_all_names(array('limit' => 10));
-                            if ($model_field->is_nullable()) {
-                                array_unshift($model_names, esc_html__("Please Select", 'event_espresso'));
-                            }
-                            $input_constructor_args[1] = $input_constructor_args[0];
-                            $input_constructor_args[0] = $model_names;
-                            $input_class = 'EE_Select_Input';
-                        }
-                        break;
-                    case 'EE_Full_HTML_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Infinite_Integer':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Integer_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Maybe_Serialized_Text_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        break;
-                    case 'EE_Money_Field':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Post_Content_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Plain_Text_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Primary_Key_Int_Field':
-                        $input_class = 'EE_Hidden_Input';
-                        $input_constructor_args[0]['normalization_strategy'] = new EE_Int_Normalization();
-                        break;
-                    case 'EE_Primary_Key_String_Field':
-                        $input_class = 'EE_Hidden_Input';
-                        break;
-                    case 'EE_Serialized_Text_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        break;
-                    case 'EE_Simple_HTML_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Simple_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Slug_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Trashed_Flag_Field':
-                        $input_class = 'EE_Yes_No_Input';
-                        break;
-                    case 'EE_WP_Post_Status_Field':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_WP_Post_Type_Field':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    default:
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field of type '%s' does not convert to any known Form Input. Please add a case to EE_Model_Form_section's _convert_model_fields_to_inputs switch statement",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                }
-                $reflection = new ReflectionClass($input_class);
-                $input = $reflection->newInstanceArgs($input_constructor_args);
-                $inputs[ $field_name ] = $input;
-            }
-        }
-        return $inputs;
-    }
-
-
-
-    /**
-     * Mostly the same as populate_defaults , except takes a model object as input, not an array,
-     * and also sets the form's _model_object
-     *
-     * @param EE_Base_Class $model_obj
-     * @return void
-     */
-    public function populate_model_obj($model_obj)
-    {
-        $model_obj = $this->_model->ensure_is_obj($model_obj);
-        $this->_model_object = $model_obj;
-        $defaults = $model_obj->model_field_array();
-        foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
-            $subsection = $this->get_subsection($relation_name, false);
-            if ($subsection instanceof EE_Form_Input_Base) {
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                    // then we only expect there to be one
-                    $related_item = $this->_model_object->get_first_related($relation_name);
-                    $defaults[ $relation_name ] = $related_item->ID();
-                } else {
-                    $related_items = $this->_model_object->get_many_related($relation_name);
-                    $ids = array();
-                    foreach ($related_items as $related_item) {
-                        $ids[] = $related_item->ID();
-                    }
-                    $defaults[ $relation_name ] = $ids;
-                }
-            }
-        }
-        $defaults = apply_filters(
-            'FHEE__EE_Model_Form_Section__populate_model_obj',
-            $defaults,
-            $this
-        );
-        $this->populate_defaults($defaults);
-    }
-
-
-
-    /**
-     * Gets all the input values that correspond to model fields. Keys are the input/field names,
-     * values are their normalized values
-     *
-     * @return array
-     */
-    public function inputs_values_corresponding_to_model_fields()
-    {
-        return array_intersect_key($this->input_values(), $this->_model->field_settings());
-    }
-
-
-
-    /**
-     * After we've normalized the data as normal, set the corresponding model object
-     * on the form.
-     *
-     * @param array $req_data should usually be the form post/request data (the default).
-     * @return void
-     */
-    public function _normalize($req_data)
-    {
-        parent::_normalize($req_data);
-        // create or set the model object, if it isn't already
-        if (! $this->_model_object) {
-            // check to see if the form indicates a PK, in which case we want to only retrieve it and update it
-            $pk_name = $this->_model->primary_key_name();
-            $model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
-            if ($model_obj) {
-                $this->_model_object = $model_obj;
-            } else {
-                $this->_model_object = EE_Registry::instance()->load_class($this->_model->get_this_model_name());
-            }
-        }
-    }
-
-
-
-    /**
-     * After this form has been initialized and is verified to be valid,
-     * either creates a model object from its data and saves it, or updates
-     * the model object its data represents
-     *
-     * @throws EE_Error
-     * @return int, 1 on a successful update, the ID of
-     *                    the new entry on insert; 0 on failure
-     */
-    public function save()
-    {
-        if (! $this->_model_object) {
-            throw new EE_Error(sprintf(esc_html__(
-                "Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
-                "event_espresso"
-            ), get_class($this->_model)));
-        }
-        // ok so the model object is set. Just set it with the submitted form data
-        foreach ($this->inputs_values_corresponding_to_model_fields() as $field_name => $field_value) {
-            // only set the non-primary key
-            if ($field_name != $this->_model->primary_key_name()) {
-                $this->_model_object->set($field_name, $field_value);
-            }
-        }
-        $success = $this->_model_object->save();
-        foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
-            if (isset($this->_subsections[ $relation_name ])) {
-                $success = $this->_save_related_info($relation_name);
-            }
-        }
-        do_action('AHEE__EE_Model_Form_Section__save__done', $this, $success);
-        return $success;
-    }
-
-
-
-    /**
-     * Automatically finds the related model info from the form, if present, and
-     * save the relations indicated
-     *
-     * @type string $relation_name
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _save_related_info($relation_name)
-    {
-        $relation_obj = $this->_model->related_settings_for($relation_name);
-        if ($relation_obj instanceof EE_Belongs_To_Relation) {
-            // there is just a foreign key on this model pointing to that one
-            $this->_model_object->_add_relation_to($this->get_input_value($relation_name), $relation_name);
-        } elseif ($relation_obj instanceof EE_Has_Many_Relation) {
-            // then we want to consider all of its currently-related things.
-            // if they're in this list, keep them
-            // if they're not in this list, remove them
-            // and lastly add all the new items
-            throw new EE_Error(sprintf(esc_html__(
-                'Automatic saving of related info across a "has many" relation is not yet supported',
-                "event_espresso"
-            )));
-        } elseif ($relation_obj instanceof EE_HABTM_Relation) {
-            // delete everything NOT in this list
-            $normalized_input_value = $this->get_input_value($relation_name);
-            if ($normalized_input_value && is_array($normalized_input_value)) {
-                $where_query_params = array(
-                    $relation_obj->get_other_model()->primary_key_name() => array('NOT_IN', $normalized_input_value),
-                );
-            } else {
-                $where_query_params = array();
-            }
-            $this->_model_object->_remove_relations($relation_name, $where_query_params);
-            foreach ($normalized_input_value as $id) {
-                $this->_model_object->_add_relation_to($id, $relation_name);
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * Gets the model of this model form
-     *
-     * @return EEM_Base
-     */
-    public function get_model()
-    {
-        return $this->_model;
-    }
-
-
-
-    /**
-     * Gets the model object for this model form, which was either set
-     * upon construction (using the $options_array arg 'model_object'), by using
-     * set_model_object($model_obj), or implicitly
-     * when receive_form_submission($req_data) was called.
-     *
-     * @return EE_Base_Class
-     */
-    public function get_model_object()
-    {
-        return $this->_model_object;
-    }
-
-
-
-    /**
-     * gets teh default name of this form section if none is specified
-     *
-     * @return string
-     */
-    protected function _set_default_name_if_empty()
-    {
-        if (! $this->_name) {
-            $default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
-            $this->_name = $default_name;
-        }
-    }
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model = null;
+
+	/**
+	 * @var EE_Base_Class
+	 */
+	protected $_model_object = null;
+
+
+
+	/**
+	 * @param array        $options_array   keys: {
+	 * @type EEM_Base      $model
+	 * @type EE_Base_Class $model_object
+	 * @type array         $subsection_args array keys should be subsection names (that either do or will exist), and
+	 *       values are the arrays as you would pass them to that subsection
+	 *                                      }
+	 * @throws EE_Error
+	 */
+	public function __construct($options_array = array())
+	{
+		if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
+			$this->_model = $options_array['model'];
+		}
+		if (! $this->_model || ! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(sprintf(esc_html__(
+				"Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
+				"event_espresso"
+			)));
+		}
+		if (isset($options_array['subsection_args'])) {
+			$subsection_args = $options_array['subsection_args'];
+		} else {
+			$subsection_args = array();
+		}
+		// gather fields and relations to convert to inputs
+		// but if they're just going to exclude a field anyways, don't bother converting it to an input
+		$exclude = $this->_subsections;
+		if (isset($options_array['exclude'])) {
+			$exclude = array_merge($exclude, array_flip($options_array['exclude']));
+		}
+		$model_fields = array_diff_key($this->_model->field_settings(), $exclude);
+		$model_relations = array_diff_key($this->_model->relation_settings(), $exclude);
+		// convert fields and relations to inputs
+		$this->_subsections = array_merge(
+			$this->_convert_model_fields_to_inputs($model_fields),
+			$this->_convert_model_relations_to_inputs($model_relations, $subsection_args),
+			$this->_subsections
+		);
+		parent::__construct($options_array);
+		if (isset($options_array['model_object']) && $options_array['model_object'] instanceof EE_Base_Class) {
+			$this->populate_model_obj($options_array['model_object']);
+		}
+	}
+
+
+
+	/**
+	 * For now, just makes inputs for only HABTM relations
+	 *
+	 * @param EE_Model_Relation_Base[] $relations
+	 * @param array                    $subsection_args keys should be existing or soon-to-be-existing input names, and
+	 *                                                  their values are {
+	 * @type array {
+	 * @type EE_Base_Class[]           $model_objects   if the subsection is an EE_Select_Multi_Model_Input
+	 *                                                  }
+	 *                                                  }
+	 * @return array
+	 */
+	protected function _convert_model_relations_to_inputs($relations, $subsection_args = array())
+	{
+		$inputs = array();
+		foreach ($relations as $relation_name => $relation_obj) {
+			$input_constructor_args = array(
+				array_merge(
+					array(
+						'required'        => $relation_obj instanceof EE_Belongs_To_Relation,
+						'html_label_text' => $relation_obj instanceof EE_Belongs_To_Relation
+							? $relation_obj->get_other_model()->item_name(1)
+							: $relation_obj->get_other_model()
+										   ->item_name(2),
+					),
+					$subsection_args
+				),
+			);
+			$input = null;
+			switch (get_class($relation_obj)) {
+				case 'EE_HABTM_Relation':
+					if (
+						isset($subsection_args[ $relation_name ])
+						&& isset($subsection_args[ $relation_name ]['model_objects'])
+					) {
+						$model_objects = $subsection_args[ $relation_name ]['model_objects'];
+					} else {
+						$model_objects = $relation_obj->get_other_model()->get_all();
+					}
+					$input = new EE_Select_Multi_Model_Input($model_objects, $input_constructor_args);
+					break;
+				default:
+			}
+			if ($input) {
+				$inputs[ $relation_name ] = $input;
+			}
+		}
+		return $inputs;
+	}
+
+
+
+	/**
+	 * Changes model fields into form section inputs
+	 *
+	 * @param EE_Model_Field_Base[] $model_fields keys are the model's name
+	 * @throws EE_Error
+	 * @return EE_Form_Input_Base[]
+	 */
+	protected function _convert_model_fields_to_inputs($model_fields = array())
+	{
+		$inputs = array();
+		foreach ($model_fields as $field_name => $model_field) {
+			if ($model_field instanceof EE_Model_Field_Base) {
+				$input_constructor_args = array(
+					array(
+						'required'        => ! $model_field->is_nullable()
+											 && $model_field->get_default_value()
+												=== null,
+						'html_label_text' => $model_field->get_nicename(),
+						'default'         => $model_field->get_default_value(),
+					),
+				);
+				switch (get_class($model_field)) {
+					case 'EE_All_Caps_Text_Field':
+					case 'EE_Any_Foreign_Model_Name_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Boolean_Field':
+						$input_class = 'EE_Yes_No_Input';
+						break;
+					case 'EE_Datetime_Field':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Email_Field':
+						$input_class = 'EE_Email_Input';
+						break;
+					case 'EE_Enum_Integer_Field':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Enum_Text_Field':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Float_Field':
+						$input_class = 'EE_Float_Input';
+						break;
+					case 'EE_Foreign_Key_Int_Field':
+					case 'EE_Foreign_Key_String_Field':
+					case 'EE_WP_User_Field':
+						$models_pointed_to = $model_field instanceof EE_Field_With_Model_Name
+							? $model_field->get_model_class_names_pointed_to() : array();
+						if (true || is_array($models_pointed_to) && count($models_pointed_to) > 1) {
+							$input_class = 'EE_Text_Input';
+						} else {
+							// so its just one model
+							$model_name = is_array($models_pointed_to) ? reset($models_pointed_to) : $models_pointed_to;
+							$model = EE_Registry::instance()->load_model($model_name);
+							$model_names = $model->get_all_names(array('limit' => 10));
+							if ($model_field->is_nullable()) {
+								array_unshift($model_names, esc_html__("Please Select", 'event_espresso'));
+							}
+							$input_constructor_args[1] = $input_constructor_args[0];
+							$input_constructor_args[0] = $model_names;
+							$input_class = 'EE_Select_Input';
+						}
+						break;
+					case 'EE_Full_HTML_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
+						break;
+					case 'EE_Infinite_Integer':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Integer_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Maybe_Serialized_Text_Field':
+						$input_class = 'EE_Text_Area_Input';
+						break;
+					case 'EE_Money_Field':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Post_Content_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
+						break;
+					case 'EE_Plain_Text_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Primary_Key_Int_Field':
+						$input_class = 'EE_Hidden_Input';
+						$input_constructor_args[0]['normalization_strategy'] = new EE_Int_Normalization();
+						break;
+					case 'EE_Primary_Key_String_Field':
+						$input_class = 'EE_Hidden_Input';
+						break;
+					case 'EE_Serialized_Text_Field':
+						$input_class = 'EE_Text_Area_Input';
+						break;
+					case 'EE_Simple_HTML_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Simple_HTML_Validation_Strategy());
+						break;
+					case 'EE_Slug_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Trashed_Flag_Field':
+						$input_class = 'EE_Yes_No_Input';
+						break;
+					case 'EE_WP_Post_Status_Field':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_WP_Post_Type_Field':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					default:
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field of type '%s' does not convert to any known Form Input. Please add a case to EE_Model_Form_section's _convert_model_fields_to_inputs switch statement",
+							"event_espresso"
+						), get_class($model_field)));
+				}
+				$reflection = new ReflectionClass($input_class);
+				$input = $reflection->newInstanceArgs($input_constructor_args);
+				$inputs[ $field_name ] = $input;
+			}
+		}
+		return $inputs;
+	}
+
+
+
+	/**
+	 * Mostly the same as populate_defaults , except takes a model object as input, not an array,
+	 * and also sets the form's _model_object
+	 *
+	 * @param EE_Base_Class $model_obj
+	 * @return void
+	 */
+	public function populate_model_obj($model_obj)
+	{
+		$model_obj = $this->_model->ensure_is_obj($model_obj);
+		$this->_model_object = $model_obj;
+		$defaults = $model_obj->model_field_array();
+		foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
+			$subsection = $this->get_subsection($relation_name, false);
+			if ($subsection instanceof EE_Form_Input_Base) {
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
+					// then we only expect there to be one
+					$related_item = $this->_model_object->get_first_related($relation_name);
+					$defaults[ $relation_name ] = $related_item->ID();
+				} else {
+					$related_items = $this->_model_object->get_many_related($relation_name);
+					$ids = array();
+					foreach ($related_items as $related_item) {
+						$ids[] = $related_item->ID();
+					}
+					$defaults[ $relation_name ] = $ids;
+				}
+			}
+		}
+		$defaults = apply_filters(
+			'FHEE__EE_Model_Form_Section__populate_model_obj',
+			$defaults,
+			$this
+		);
+		$this->populate_defaults($defaults);
+	}
+
+
+
+	/**
+	 * Gets all the input values that correspond to model fields. Keys are the input/field names,
+	 * values are their normalized values
+	 *
+	 * @return array
+	 */
+	public function inputs_values_corresponding_to_model_fields()
+	{
+		return array_intersect_key($this->input_values(), $this->_model->field_settings());
+	}
+
+
+
+	/**
+	 * After we've normalized the data as normal, set the corresponding model object
+	 * on the form.
+	 *
+	 * @param array $req_data should usually be the form post/request data (the default).
+	 * @return void
+	 */
+	public function _normalize($req_data)
+	{
+		parent::_normalize($req_data);
+		// create or set the model object, if it isn't already
+		if (! $this->_model_object) {
+			// check to see if the form indicates a PK, in which case we want to only retrieve it and update it
+			$pk_name = $this->_model->primary_key_name();
+			$model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
+			if ($model_obj) {
+				$this->_model_object = $model_obj;
+			} else {
+				$this->_model_object = EE_Registry::instance()->load_class($this->_model->get_this_model_name());
+			}
+		}
+	}
+
+
+
+	/**
+	 * After this form has been initialized and is verified to be valid,
+	 * either creates a model object from its data and saves it, or updates
+	 * the model object its data represents
+	 *
+	 * @throws EE_Error
+	 * @return int, 1 on a successful update, the ID of
+	 *                    the new entry on insert; 0 on failure
+	 */
+	public function save()
+	{
+		if (! $this->_model_object) {
+			throw new EE_Error(sprintf(esc_html__(
+				"Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
+				"event_espresso"
+			), get_class($this->_model)));
+		}
+		// ok so the model object is set. Just set it with the submitted form data
+		foreach ($this->inputs_values_corresponding_to_model_fields() as $field_name => $field_value) {
+			// only set the non-primary key
+			if ($field_name != $this->_model->primary_key_name()) {
+				$this->_model_object->set($field_name, $field_value);
+			}
+		}
+		$success = $this->_model_object->save();
+		foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
+			if (isset($this->_subsections[ $relation_name ])) {
+				$success = $this->_save_related_info($relation_name);
+			}
+		}
+		do_action('AHEE__EE_Model_Form_Section__save__done', $this, $success);
+		return $success;
+	}
+
+
+
+	/**
+	 * Automatically finds the related model info from the form, if present, and
+	 * save the relations indicated
+	 *
+	 * @type string $relation_name
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _save_related_info($relation_name)
+	{
+		$relation_obj = $this->_model->related_settings_for($relation_name);
+		if ($relation_obj instanceof EE_Belongs_To_Relation) {
+			// there is just a foreign key on this model pointing to that one
+			$this->_model_object->_add_relation_to($this->get_input_value($relation_name), $relation_name);
+		} elseif ($relation_obj instanceof EE_Has_Many_Relation) {
+			// then we want to consider all of its currently-related things.
+			// if they're in this list, keep them
+			// if they're not in this list, remove them
+			// and lastly add all the new items
+			throw new EE_Error(sprintf(esc_html__(
+				'Automatic saving of related info across a "has many" relation is not yet supported',
+				"event_espresso"
+			)));
+		} elseif ($relation_obj instanceof EE_HABTM_Relation) {
+			// delete everything NOT in this list
+			$normalized_input_value = $this->get_input_value($relation_name);
+			if ($normalized_input_value && is_array($normalized_input_value)) {
+				$where_query_params = array(
+					$relation_obj->get_other_model()->primary_key_name() => array('NOT_IN', $normalized_input_value),
+				);
+			} else {
+				$where_query_params = array();
+			}
+			$this->_model_object->_remove_relations($relation_name, $where_query_params);
+			foreach ($normalized_input_value as $id) {
+				$this->_model_object->_add_relation_to($id, $relation_name);
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * Gets the model of this model form
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_model()
+	{
+		return $this->_model;
+	}
+
+
+
+	/**
+	 * Gets the model object for this model form, which was either set
+	 * upon construction (using the $options_array arg 'model_object'), by using
+	 * set_model_object($model_obj), or implicitly
+	 * when receive_form_submission($req_data) was called.
+	 *
+	 * @return EE_Base_Class
+	 */
+	public function get_model_object()
+	{
+		return $this->_model_object;
+	}
+
+
+
+	/**
+	 * gets teh default name of this form section if none is specified
+	 *
+	 * @return string
+	 */
+	protected function _set_default_name_if_empty()
+	{
+		if (! $this->_name) {
+			$default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
+			$this->_name = $default_name;
+		}
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -38,7 +38,7 @@ 
         if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
             $this->_model = $options_array['model'];
         }
-        if (! $this->_model || ! $this->_model instanceof EEM_Base) {
+        if ( ! $this->_model || ! $this->_model instanceof EEM_Base) {
             throw new EE_Error(sprintf(esc_html__(
                 "Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
                 "event_espresso"
@@ -103,10 +103,10 @@ 
             switch (get_class($relation_obj)) {
                 case 'EE_HABTM_Relation':
                     if (
-                        isset($subsection_args[ $relation_name ])
-                        && isset($subsection_args[ $relation_name ]['model_objects'])
+                        isset($subsection_args[$relation_name])
+                        && isset($subsection_args[$relation_name]['model_objects'])
                     ) {
-                        $model_objects = $subsection_args[ $relation_name ]['model_objects'];
+                        $model_objects = $subsection_args[$relation_name]['model_objects'];
                     } else {
                         $model_objects = $relation_obj->get_other_model()->get_all();
                     }
@@ -115,7 +115,7 @@ 
                 default:
             }
             if ($input) {
-                $inputs[ $relation_name ] = $input;
+                $inputs[$relation_name] = $input;
             }
         }
         return $inputs;
@@ -265,7 +265,7 @@ 
                 }
                 $reflection = new ReflectionClass($input_class);
                 $input = $reflection->newInstanceArgs($input_constructor_args);
-                $inputs[ $field_name ] = $input;
+                $inputs[$field_name] = $input;
             }
         }
         return $inputs;
@@ -291,14 +291,14 @@ 
                 if ($relation_obj instanceof EE_Belongs_To_Relation) {
                     // then we only expect there to be one
                     $related_item = $this->_model_object->get_first_related($relation_name);
-                    $defaults[ $relation_name ] = $related_item->ID();
+                    $defaults[$relation_name] = $related_item->ID();
                 } else {
                     $related_items = $this->_model_object->get_many_related($relation_name);
                     $ids = array();
                     foreach ($related_items as $related_item) {
                         $ids[] = $related_item->ID();
                     }
-                    $defaults[ $relation_name ] = $ids;
+                    $defaults[$relation_name] = $ids;
                 }
             }
         }
@@ -336,7 +336,7 @@ 
     {
         parent::_normalize($req_data);
         // create or set the model object, if it isn't already
-        if (! $this->_model_object) {
+        if ( ! $this->_model_object) {
             // check to see if the form indicates a PK, in which case we want to only retrieve it and update it
             $pk_name = $this->_model->primary_key_name();
             $model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
@@ -361,7 +361,7 @@ 
      */
     public function save()
     {
-        if (! $this->_model_object) {
+        if ( ! $this->_model_object) {
             throw new EE_Error(sprintf(esc_html__(
                 "Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
                 "event_espresso"
@@ -376,7 +376,7 @@ 
         }
         $success = $this->_model_object->save();
         foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
-            if (isset($this->_subsections[ $relation_name ])) {
+            if (isset($this->_subsections[$relation_name])) {
                 $success = $this->_save_related_info($relation_name);
             }
         }
@@ -463,8 +463,8 @@ 
      */
     protected function _set_default_name_if_empty()
     {
-        if (! $this->_name) {
-            $default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
+        if ( ! $this->_name) {
+            $default_name = str_replace("EEM_", "", get_class($this->_model))."_Model_Form";
             $this->_name = $default_name;
         }
     }

core/libraries/form_sections/EE_Sample_Form.form.php

Indentation +56 added lines, -56 removed lines

@@ -2,62 +2,62 @@
 
 class EE_Sample_Form extends EE_Form_Section_Proper
 {
-    public function __construct()
-    {
-        $this->_subsections = array(
-            'h1' => new EE_Form_Section_HTML('hello wordl'),
-            'name' => new EE_Text_Input(array('required' => true,'default' => 'your name here')),
-            'email' => new EE_Email_Input(array('required' => false)),
-            'shirt_size' => new EE_Select_Input(array('' => 'Please select...', 's' =>  esc_html__("Small", "event_espresso"),'m' =>  esc_html__("Medium", "event_espresso"),'l' =>  esc_html__("Large", "event_espresso")), array('required' => true,'default' => 's')),
-            'month_normal' => new EE_Month_Input(),
-            'month_leading_zero' => new EE_Month_Input(true),
-            'year_2' => new EE_Year_Input(false, 1, 1),
-            'year_4' => new EE_Year_Input(true, 0, 10, array('default' => '2017')),
-            'yes_no' => new EE_Yes_No_Input(array('html_label_text' =>  esc_html__("Yes or No", "event_espresso"))),
-            'credit_card' => new EE_Credit_Card_Input(),
-            'image_1' => new EE_Admin_File_Uploader_Input(),
-            'image_2' => new EE_Admin_File_Uploader_Input(),
-            'skillz' => new EE_Checkbox_Multi_Input(array('php' => 'PHP','mysql' => 'MYSQL'), array('default' => array('php'))),
-            'float' => new EE_Float_Input(),
-            'essay' => new EE_Text_Area_Input(),
-            'amenities' => new EE_Select_Multiple_Input(
-                array(
-                    'hottub' => 'Hot Tub',
-                    'balcony' => "Balcony",
-                    'skylight' => 'SkyLight',
-                    'no_axe' => 'No Axe Murderers'
-                ),
-                array(
-                    'default' => array(
-                        'hottub',
-                        'no_axe' ),
-                )
-            ),
-            'payment_methods' => new EE_Select_Multi_Model_Input(EEM_Payment_Method::instance()->get_all()),
-            );
-        $this->_layout_strategy = new EE_Div_Per_Section_Layout();
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		$this->_subsections = array(
+			'h1' => new EE_Form_Section_HTML('hello wordl'),
+			'name' => new EE_Text_Input(array('required' => true,'default' => 'your name here')),
+			'email' => new EE_Email_Input(array('required' => false)),
+			'shirt_size' => new EE_Select_Input(array('' => 'Please select...', 's' =>  esc_html__("Small", "event_espresso"),'m' =>  esc_html__("Medium", "event_espresso"),'l' =>  esc_html__("Large", "event_espresso")), array('required' => true,'default' => 's')),
+			'month_normal' => new EE_Month_Input(),
+			'month_leading_zero' => new EE_Month_Input(true),
+			'year_2' => new EE_Year_Input(false, 1, 1),
+			'year_4' => new EE_Year_Input(true, 0, 10, array('default' => '2017')),
+			'yes_no' => new EE_Yes_No_Input(array('html_label_text' =>  esc_html__("Yes or No", "event_espresso"))),
+			'credit_card' => new EE_Credit_Card_Input(),
+			'image_1' => new EE_Admin_File_Uploader_Input(),
+			'image_2' => new EE_Admin_File_Uploader_Input(),
+			'skillz' => new EE_Checkbox_Multi_Input(array('php' => 'PHP','mysql' => 'MYSQL'), array('default' => array('php'))),
+			'float' => new EE_Float_Input(),
+			'essay' => new EE_Text_Area_Input(),
+			'amenities' => new EE_Select_Multiple_Input(
+				array(
+					'hottub' => 'Hot Tub',
+					'balcony' => "Balcony",
+					'skylight' => 'SkyLight',
+					'no_axe' => 'No Axe Murderers'
+				),
+				array(
+					'default' => array(
+						'hottub',
+						'no_axe' ),
+				)
+			),
+			'payment_methods' => new EE_Select_Multi_Model_Input(EEM_Payment_Method::instance()->get_all()),
+			);
+		$this->_layout_strategy = new EE_Div_Per_Section_Layout();
+		parent::__construct();
+	}
 
-    /**
-     * Extra validation for the 'name' input.
-     * @param EE_Text_Input $form_input
-     */
-    public function _validate_name($form_input)
-    {
-        if ($form_input->raw_value() != 'Mike') {
-            $form_input->add_validation_error(esc_html__("You are not mike. You must be brent or darren. Thats ok, I guess", 'event_espresso'), 'not-mike');
-        }
-    }
+	/**
+	 * Extra validation for the 'name' input.
+	 * @param EE_Text_Input $form_input
+	 */
+	public function _validate_name($form_input)
+	{
+		if ($form_input->raw_value() != 'Mike') {
+			$form_input->add_validation_error(esc_html__("You are not mike. You must be brent or darren. Thats ok, I guess", 'event_espresso'), 'not-mike');
+		}
+	}
 
-    public function _validate()
-    {
-        parent::_validate();
-        if (
-            $this->_subsections['shirt_size']->normalized_value() == 's'
-                && $this->_subsections['year_4']->normalized_value() < 2010
-        ) {
-            $this->add_validation_error(esc_html__("If you want a small shirt, you should be born after 2010. Otherwise theyre just too big", 'event_espresso'), 'too-old');
-        }
-    }
+	public function _validate()
+	{
+		parent::_validate();
+		if (
+			$this->_subsections['shirt_size']->normalized_value() == 's'
+				&& $this->_subsections['year_4']->normalized_value() < 2010
+		) {
+			$this->add_validation_error(esc_html__("If you want a small shirt, you should be born after 2010. Otherwise theyre just too big", 'event_espresso'), 'too-old');
+		}
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -6,9 +6,9 @@ 
     {
         $this->_subsections = array(
             'h1' => new EE_Form_Section_HTML('hello wordl'),
-            'name' => new EE_Text_Input(array('required' => true,'default' => 'your name here')),
+            'name' => new EE_Text_Input(array('required' => true, 'default' => 'your name here')),
             'email' => new EE_Email_Input(array('required' => false)),
-            'shirt_size' => new EE_Select_Input(array('' => 'Please select...', 's' =>  esc_html__("Small", "event_espresso"),'m' =>  esc_html__("Medium", "event_espresso"),'l' =>  esc_html__("Large", "event_espresso")), array('required' => true,'default' => 's')),
+            'shirt_size' => new EE_Select_Input(array('' => 'Please select...', 's' =>  esc_html__("Small", "event_espresso"), 'm' =>  esc_html__("Medium", "event_espresso"), 'l' =>  esc_html__("Large", "event_espresso")), array('required' => true, 'default' => 's')),
             'month_normal' => new EE_Month_Input(),
             'month_leading_zero' => new EE_Month_Input(true),
             'year_2' => new EE_Year_Input(false, 1, 1),
@@ -17,7 +17,7 @@ 
             'credit_card' => new EE_Credit_Card_Input(),
             'image_1' => new EE_Admin_File_Uploader_Input(),
             'image_2' => new EE_Admin_File_Uploader_Input(),
-            'skillz' => new EE_Checkbox_Multi_Input(array('php' => 'PHP','mysql' => 'MYSQL'), array('default' => array('php'))),
+            'skillz' => new EE_Checkbox_Multi_Input(array('php' => 'PHP', 'mysql' => 'MYSQL'), array('default' => array('php'))),
             'float' => new EE_Float_Input(),
             'essay' => new EE_Text_Area_Input(),
             'amenities' => new EE_Select_Multiple_Input(

core/libraries/form_sections/payment_methods/EE_Billing_Attendee_Info_Form.form.php

Indentation +157 added lines, -157 removed lines

@@ -14,172 +14,172 @@
 class EE_Billing_Attendee_Info_Form extends EE_Billing_Info_Form
 {
 
-    /**
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param array $options_array @see EE_Form_Section_Proper::__construct()
-     */
-    public function __construct(EE_Payment_Method $payment_method, $options_array = array())
-    {
-        $options_array['subsections'] = array_merge(
-            array(
-                'first_name'    => new EE_Text_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-fname', 'html_label_text' => esc_html__('First Name', 'event_espresso') )),
-                'last_name'     => new EE_Text_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-lname', 'html_label_text' => esc_html__('Last Name', 'event_espresso') )),
-                'email'             => new EE_Email_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-email', 'html_label_text' => esc_html__('Email', 'event_espresso') )),
-                'address'           => new EE_Text_Input(array( 'html_label_text' =>  esc_html__('Address', 'event_espresso'), 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-address' )),
-                'address2'      => new EE_Text_Input(array( 'html_label_text' => esc_html__('Address 2', 'event_espresso'), 'html_class' => 'ee-billing-qstn ee-billing-qstn-address2' )),
-                'city'                  => new EE_Text_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-city', 'html_label_text' => esc_html__('City', 'event_espresso') )),
-                'state'                 => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__state_field', new EE_State_Select_Input(null, array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-state', 'html_label_text' => esc_html__('State', 'event_espresso') ))),
-                'country'           => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__country_field', new EE_Country_Select_Input(null, array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-country', 'html_label_text' => esc_html__('Country', 'event_espresso') ))),
-                'zip'                   => new EE_Text_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-zip', 'html_label_text' => esc_html__('Zip', 'event_espresso') )),
-                'phone'         => new EE_Text_Input(array( 'html_class' => 'ee-billing-qstn ee-billing-qstn-phone', 'html_label_text' => esc_html__('Phone', 'event_espresso') )),
-            ),
-            isset($options_array['subsections']) ? $options_array['subsections'] : array()
-        );
+	/**
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param array $options_array @see EE_Form_Section_Proper::__construct()
+	 */
+	public function __construct(EE_Payment_Method $payment_method, $options_array = array())
+	{
+		$options_array['subsections'] = array_merge(
+			array(
+				'first_name'    => new EE_Text_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-fname', 'html_label_text' => esc_html__('First Name', 'event_espresso') )),
+				'last_name'     => new EE_Text_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-lname', 'html_label_text' => esc_html__('Last Name', 'event_espresso') )),
+				'email'             => new EE_Email_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-email', 'html_label_text' => esc_html__('Email', 'event_espresso') )),
+				'address'           => new EE_Text_Input(array( 'html_label_text' =>  esc_html__('Address', 'event_espresso'), 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-address' )),
+				'address2'      => new EE_Text_Input(array( 'html_label_text' => esc_html__('Address 2', 'event_espresso'), 'html_class' => 'ee-billing-qstn ee-billing-qstn-address2' )),
+				'city'                  => new EE_Text_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-city', 'html_label_text' => esc_html__('City', 'event_espresso') )),
+				'state'                 => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__state_field', new EE_State_Select_Input(null, array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-state', 'html_label_text' => esc_html__('State', 'event_espresso') ))),
+				'country'           => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__country_field', new EE_Country_Select_Input(null, array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-country', 'html_label_text' => esc_html__('Country', 'event_espresso') ))),
+				'zip'                   => new EE_Text_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-zip', 'html_label_text' => esc_html__('Zip', 'event_espresso') )),
+				'phone'         => new EE_Text_Input(array( 'html_class' => 'ee-billing-qstn ee-billing-qstn-phone', 'html_label_text' => esc_html__('Phone', 'event_espresso') )),
+			),
+			isset($options_array['subsections']) ? $options_array['subsections'] : array()
+		);
 
-        parent::__construct($payment_method, $options_array);
-    }
+		parent::__construct($payment_method, $options_array);
+	}
 
-    /**
-     * Sets the defaults for the billing form according to the attendee's details
-     * @param EE_Attendee $attendee
-     */
-    public function populate_from_attendee($attendee)
-    {
-        $attendee = EEM_Attendee::instance()->ensure_is_obj($attendee);
+	/**
+	 * Sets the defaults for the billing form according to the attendee's details
+	 * @param EE_Attendee $attendee
+	 */
+	public function populate_from_attendee($attendee)
+	{
+		$attendee = EEM_Attendee::instance()->ensure_is_obj($attendee);
 
-        /** @var $attendee EE_Attendee */
-        $this->populate_defaults(
-            apply_filters(
-                'FHEE__EE_Billing_Attendee_Info_Form__populate_from_attendee',
-                array(
-                    'first_name' => $attendee->fname(),
-                    'last_name' => $attendee->lname(),
-                    'email' => $attendee->email(),
-                    'address' => $attendee->address(),
-                    'address2' => $attendee->address2(),
-                    'city' => $attendee->city(),
-                    'state' => $this->getAttendeeStateValueForForm($attendee),
-                    'country' => $attendee->country_ID(),
-                    'zip' => $attendee->zip(),
-                    'phone' => $attendee->phone(),
-                ),
-                $attendee,
-                $this
-            )
-        );
-    }
+		/** @var $attendee EE_Attendee */
+		$this->populate_defaults(
+			apply_filters(
+				'FHEE__EE_Billing_Attendee_Info_Form__populate_from_attendee',
+				array(
+					'first_name' => $attendee->fname(),
+					'last_name' => $attendee->lname(),
+					'email' => $attendee->email(),
+					'address' => $attendee->address(),
+					'address2' => $attendee->address2(),
+					'city' => $attendee->city(),
+					'state' => $this->getAttendeeStateValueForForm($attendee),
+					'country' => $attendee->country_ID(),
+					'zip' => $attendee->zip(),
+					'phone' => $attendee->phone(),
+				),
+				$attendee,
+				$this
+			)
+		);
+	}
 
-    /**
-     * Gets the default value to use for the billing form's state value.
-     * @since 4.10.0.p
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error2
-     */
-    protected function getAttendeeStateValueForForm(EE_Attendee $attendee)
-    {
-        // If the state input was removed, just return a blank string.
-        if (! $this->has_subsection('state')) {
-            return '';
-        }
-        $state_input =  $this->get_input('state', false);
-        if ($state_input instanceof EE_State_Select_Input) {
-            $state_field_to_use =  $state_input->valueFieldName();
-        } else {
-            $state_field_to_use = 'STA_ID';
-        }
-        switch ($state_field_to_use) {
-            case 'STA_abbrev':
-                $state_value = $attendee->state_abbrev();
-                break;
-            case 'STA_name':
-                $state_value = $attendee->state_name();
-                break;
-            default:
-                $state_value = $attendee->state_ID();
-        }
-        return $state_value;
-    }
+	/**
+	 * Gets the default value to use for the billing form's state value.
+	 * @since 4.10.0.p
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error2
+	 */
+	protected function getAttendeeStateValueForForm(EE_Attendee $attendee)
+	{
+		// If the state input was removed, just return a blank string.
+		if (! $this->has_subsection('state')) {
+			return '';
+		}
+		$state_input =  $this->get_input('state', false);
+		if ($state_input instanceof EE_State_Select_Input) {
+			$state_field_to_use =  $state_input->valueFieldName();
+		} else {
+			$state_field_to_use = 'STA_ID';
+		}
+		switch ($state_field_to_use) {
+			case 'STA_abbrev':
+				$state_value = $attendee->state_abbrev();
+				break;
+			case 'STA_name':
+				$state_value = $attendee->state_name();
+				break;
+			default:
+				$state_value = $attendee->state_ID();
+		}
+		return $state_value;
+	}
 
 
 
-    /**
-     * copy_billing_form_data_to_attendee
-     * copies info from the billing form to the attendee's details
-     * @param \EE_Attendee $attendee - the attendee object to copy details to
-     * @return \EE_Attendee
-     */
-    public function copy_billing_form_data_to_attendee(EE_Attendee $attendee)
-    {
-        // grab billing form data
-        $data = $this->valid_data();
-        // copy first_name
-        if (! empty($data['first_name'])) {
-            $attendee->set_fname($data['first_name']);
-        }
-        // copy last_name
-        if (! empty($data['last_name'])) {
-            $attendee->set_lname($data['last_name']);
-        }
-        // copy email
-        if (! empty($data['email'])) {
-            $attendee->set_email($data['email']);
-        }
-        // copy address
-        if (! empty($data['address'])) {
-            $attendee->set_address($data['address']);
-        }
-        // copy address2
-        if (! empty($data['address2'])) {
-            $attendee->set_address2($data['address2']);
-        }
-        // copy city
-        if (! empty($data['city'])) {
-            $attendee->set_city($data['city']);
-        }
-        // copy state
-        if (! empty($data['state'])) {
-            $attendee->set_state($data['state']);
-        }
-        // copy country
-        if (! empty($data['country'])) {
-            $attendee->set_country($data['country']);
-        }
-        // copy zip
-        if (! empty($data['zip'])) {
-            $attendee->set_zip($data['zip']);
-        }
-        // copy phone
-        if (! empty($data['phone'])) {
-            $attendee->set_phone($data['phone']);
-        }
-        return $attendee;
-    }
+	/**
+	 * copy_billing_form_data_to_attendee
+	 * copies info from the billing form to the attendee's details
+	 * @param \EE_Attendee $attendee - the attendee object to copy details to
+	 * @return \EE_Attendee
+	 */
+	public function copy_billing_form_data_to_attendee(EE_Attendee $attendee)
+	{
+		// grab billing form data
+		$data = $this->valid_data();
+		// copy first_name
+		if (! empty($data['first_name'])) {
+			$attendee->set_fname($data['first_name']);
+		}
+		// copy last_name
+		if (! empty($data['last_name'])) {
+			$attendee->set_lname($data['last_name']);
+		}
+		// copy email
+		if (! empty($data['email'])) {
+			$attendee->set_email($data['email']);
+		}
+		// copy address
+		if (! empty($data['address'])) {
+			$attendee->set_address($data['address']);
+		}
+		// copy address2
+		if (! empty($data['address2'])) {
+			$attendee->set_address2($data['address2']);
+		}
+		// copy city
+		if (! empty($data['city'])) {
+			$attendee->set_city($data['city']);
+		}
+		// copy state
+		if (! empty($data['state'])) {
+			$attendee->set_state($data['state']);
+		}
+		// copy country
+		if (! empty($data['country'])) {
+			$attendee->set_country($data['country']);
+		}
+		// copy zip
+		if (! empty($data['zip'])) {
+			$attendee->set_zip($data['zip']);
+		}
+		// copy phone
+		if (! empty($data['phone'])) {
+			$attendee->set_phone($data['phone']);
+		}
+		return $attendee;
+	}
 
 
-    /**
-     * create_attendee_from_billing_form_data
-     * uses info from the billing form to create a new attendee
-     * @return \EE_Attendee
-     */
-    public function create_attendee_from_billing_form_data()
-    {
-        // grab billing form data
-        $data = $this->valid_data();
-        return EE_Attendee::new_instance(array(
-            'ATT_fname'         => ! empty($data['first_name']) ? $data['first_name'] : '',
-            'ATT_lname'         => ! empty($data['last_name']) ? $data['last_name'] : '',
-            'ATT_email'         => ! empty($data['email']) ? $data['email'] : '',
-            'ATT_address'       => ! empty($data['address']) ? $data['address'] : '',
-            'ATT_address2'  => ! empty($data['address2']) ? $data['address2'] : '',
-            'ATT_city'          => ! empty($data['city']) ? $data['city'] : '',
-            'STA_ID'                => ! empty($data['state']) ? $data['state'] : '',
-            'CNT_ISO'           => ! empty($data['country']) ? $data['country'] : '',
-            'ATT_zip'               => ! empty($data['zip']) ? $data['zip'] : '',
-            'ATT_phone'         => ! empty($data['phone']) ? $data['phone'] : '',
-        ));
-    }
+	/**
+	 * create_attendee_from_billing_form_data
+	 * uses info from the billing form to create a new attendee
+	 * @return \EE_Attendee
+	 */
+	public function create_attendee_from_billing_form_data()
+	{
+		// grab billing form data
+		$data = $this->valid_data();
+		return EE_Attendee::new_instance(array(
+			'ATT_fname'         => ! empty($data['first_name']) ? $data['first_name'] : '',
+			'ATT_lname'         => ! empty($data['last_name']) ? $data['last_name'] : '',
+			'ATT_email'         => ! empty($data['email']) ? $data['email'] : '',
+			'ATT_address'       => ! empty($data['address']) ? $data['address'] : '',
+			'ATT_address2'  => ! empty($data['address2']) ? $data['address2'] : '',
+			'ATT_city'          => ! empty($data['city']) ? $data['city'] : '',
+			'STA_ID'                => ! empty($data['state']) ? $data['state'] : '',
+			'CNT_ISO'           => ! empty($data['country']) ? $data['country'] : '',
+			'ATT_zip'               => ! empty($data['zip']) ? $data['zip'] : '',
+			'ATT_phone'         => ! empty($data['phone']) ? $data['phone'] : '',
+		));
+	}
 }
 
 // End of file EE_Billing_Attendee_Info_Form.form.php

Spacing +23 added lines, -23 removed lines

@@ -23,16 +23,16 @@ 
     {
         $options_array['subsections'] = array_merge(
             array(
-                'first_name'    => new EE_Text_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-fname', 'html_label_text' => esc_html__('First Name', 'event_espresso') )),
-                'last_name'     => new EE_Text_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-lname', 'html_label_text' => esc_html__('Last Name', 'event_espresso') )),
-                'email'             => new EE_Email_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-email', 'html_label_text' => esc_html__('Email', 'event_espresso') )),
-                'address'           => new EE_Text_Input(array( 'html_label_text' =>  esc_html__('Address', 'event_espresso'), 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-address' )),
-                'address2'      => new EE_Text_Input(array( 'html_label_text' => esc_html__('Address 2', 'event_espresso'), 'html_class' => 'ee-billing-qstn ee-billing-qstn-address2' )),
-                'city'                  => new EE_Text_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-city', 'html_label_text' => esc_html__('City', 'event_espresso') )),
-                'state'                 => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__state_field', new EE_State_Select_Input(null, array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-state', 'html_label_text' => esc_html__('State', 'event_espresso') ))),
-                'country'           => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__country_field', new EE_Country_Select_Input(null, array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-country', 'html_label_text' => esc_html__('Country', 'event_espresso') ))),
-                'zip'                   => new EE_Text_Input(array( 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-zip', 'html_label_text' => esc_html__('Zip', 'event_espresso') )),
-                'phone'         => new EE_Text_Input(array( 'html_class' => 'ee-billing-qstn ee-billing-qstn-phone', 'html_label_text' => esc_html__('Phone', 'event_espresso') )),
+                'first_name'    => new EE_Text_Input(array('required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-fname', 'html_label_text' => esc_html__('First Name', 'event_espresso'))),
+                'last_name'     => new EE_Text_Input(array('required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-lname', 'html_label_text' => esc_html__('Last Name', 'event_espresso'))),
+                'email'             => new EE_Email_Input(array('required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-email', 'html_label_text' => esc_html__('Email', 'event_espresso'))),
+                'address'           => new EE_Text_Input(array('html_label_text' =>  esc_html__('Address', 'event_espresso'), 'required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-address')),
+                'address2'      => new EE_Text_Input(array('html_label_text' => esc_html__('Address 2', 'event_espresso'), 'html_class' => 'ee-billing-qstn ee-billing-qstn-address2')),
+                'city'                  => new EE_Text_Input(array('required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-city', 'html_label_text' => esc_html__('City', 'event_espresso'))),
+                'state'                 => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__state_field', new EE_State_Select_Input(null, array('required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-state', 'html_label_text' => esc_html__('State', 'event_espresso')))),
+                'country'           => apply_filters('FHEE__EE_Billing_Attendee_Info_Form__country_field', new EE_Country_Select_Input(null, array('required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-country', 'html_label_text' => esc_html__('Country', 'event_espresso')))),
+                'zip'                   => new EE_Text_Input(array('required' => true, 'html_class' => 'ee-billing-qstn ee-billing-qstn-zip', 'html_label_text' => esc_html__('Zip', 'event_espresso'))),
+                'phone'         => new EE_Text_Input(array('html_class' => 'ee-billing-qstn ee-billing-qstn-phone', 'html_label_text' => esc_html__('Phone', 'event_espresso'))),
             ),
             isset($options_array['subsections']) ? $options_array['subsections'] : array()
         );
@@ -80,12 +80,12 @@ 
     protected function getAttendeeStateValueForForm(EE_Attendee $attendee)
     {
         // If the state input was removed, just return a blank string.
-        if (! $this->has_subsection('state')) {
+        if ( ! $this->has_subsection('state')) {
             return '';
         }
-        $state_input =  $this->get_input('state', false);
+        $state_input = $this->get_input('state', false);
         if ($state_input instanceof EE_State_Select_Input) {
-            $state_field_to_use =  $state_input->valueFieldName();
+            $state_field_to_use = $state_input->valueFieldName();
         } else {
             $state_field_to_use = 'STA_ID';
         }
@@ -115,43 +115,43 @@ 
         // grab billing form data
         $data = $this->valid_data();
         // copy first_name
-        if (! empty($data['first_name'])) {
+        if ( ! empty($data['first_name'])) {
             $attendee->set_fname($data['first_name']);
         }
         // copy last_name
-        if (! empty($data['last_name'])) {
+        if ( ! empty($data['last_name'])) {
             $attendee->set_lname($data['last_name']);
         }
         // copy email
-        if (! empty($data['email'])) {
+        if ( ! empty($data['email'])) {
             $attendee->set_email($data['email']);
         }
         // copy address
-        if (! empty($data['address'])) {
+        if ( ! empty($data['address'])) {
             $attendee->set_address($data['address']);
         }
         // copy address2
-        if (! empty($data['address2'])) {
+        if ( ! empty($data['address2'])) {
             $attendee->set_address2($data['address2']);
         }
         // copy city
-        if (! empty($data['city'])) {
+        if ( ! empty($data['city'])) {
             $attendee->set_city($data['city']);
         }
         // copy state
-        if (! empty($data['state'])) {
+        if ( ! empty($data['state'])) {
             $attendee->set_state($data['state']);
         }
         // copy country
-        if (! empty($data['country'])) {
+        if ( ! empty($data['country'])) {
             $attendee->set_country($data['country']);
         }
         // copy zip
-        if (! empty($data['zip'])) {
+        if ( ! empty($data['zip'])) {
             $attendee->set_zip($data['zip']);
         }
         // copy phone
-        if (! empty($data['phone'])) {
+        if ( ! empty($data['phone'])) {
             $attendee->set_phone($data['phone']);
         }
         return $attendee;

core/libraries/form_sections/payment_methods/EE_Payment_Method_Form.form.php

Indentation +191 added lines, -191 removed lines

@@ -7,195 +7,195 @@
 class EE_Payment_Method_Form extends EE_Model_Form_Section
 {
 
-    /**
-     * All the subsection inputs that correspond ot extra meta rows
-     * for this payment method
-     *
-     * @var EE_Form_Input_Base[]
-     */
-    protected $_extra_meta_inputs = array();
-
-    /**
-     * Because payment method form might DELAY part of construction, we want to remember
-     * what options were passed in
-     *
-     * @var array
-     */
-    protected $_options_array = array();
-
-    /**
-     * The payment method type for this form
-     *
-     * @var EE_PMT_Base
-     */
-    protected $_payment_method_type;
-
-
-
-    /**
-     * @param array      $options_array       {
-     * @type string      $extra_meta_inputs   should be EE_Form_Section_Validatable[] which
-     *                                        will be _subsections and will be saved as extra meta on the payment
-     *                                        method object;
-     * @type EE_PMT_Base $payment_method_type the payment method type this form is for
-     * @see EE_Model_Form_Section::__construct() for more
-     *                                        }
-     */
-    public function __construct($options_array = array())
-    {
-        $this->_model = EEM_Payment_Method::instance();
-        $this->_options_array = $options_array;
-        if (isset($options_array['payment_method_type'])) {
-            $this->_payment_method_type = $options_array['payment_method_type'];
-        }
-        $options_array = $this->_options_array;
-        if (isset($options_array['extra_meta_inputs'])) {
-            $this->_extra_meta_inputs = array_merge($this->_extra_meta_inputs, $options_array['extra_meta_inputs']);
-        }
-        if ($this->_extra_meta_inputs) {
-            $this->_subsections = array_merge($this->_subsections, $this->_extra_meta_inputs);
-        }
-        $this->_subsections['PMD_button_url'] = new EE_Admin_File_Uploader_Input(
-            array('html_label_text' => esc_html__('Button URL', 'event_espresso'))
-        );
-        $this->_subsections['PMD_scope'] = new EE_Checkbox_Multi_Input(
-            EEM_Payment_Method::instance()->scopes(),
-            array(
-                'html_label_text' => $this->_model->field_settings_for('PMD_scope')->get_nicename()
-                                     . EEH_Template::get_help_tab_link('payment_methods_overview'),
-            )
-        );
-        // setup the currency options
-        $this->_subsections['Currency'] = new EE_Select_Multi_Model_Input(
-            EEM_Currency::instance()->get_all_currencies_usable_by($this->_payment_method_type),
-            array(
-                'html_label_text' => esc_html__('Currencies Supported', 'event_espresso'),
-                'required'        => true,
-            )
-        );
-        $this->_subsections['PMD_order'] = new EE_Text_Input(array(
-            'html_label_text'        => esc_html__('Order', 'event_espresso'),
-            'html_help_text'         => esc_html__('Lowest numbers will be shown first', 'event_espresso'),
-            'normalization_strategy' => new EE_Int_Normalization(),
-            'validation_strategies'  => array(
-                new EE_Int_Validation_Strategy(),
-            ),
-            'default'                => 0,
-        ));
-        $this->_layout_strategy = new EE_Admin_Two_Column_Layout();
-        parent::__construct($options_array);
-        $debug_mode = isset($this->_subsections['PMD_debug_mode']) ? $this->_subsections['PMD_debug_mode'] : null;
-        if ($debug_mode instanceof EE_Form_Input_Base) {
-            $debug_mode->set_html_help_text(esc_html__(
-                'This payment method has a Sandbox Server (also known as Testing Server, Development Server, Quality Assurance Server, etc). While in debug mode and using this sandbox server, real payments will not be processed.',
-                'event_espresso'
-            ));
-        }
-    }
-
-
-
-    /**
-     * Finishes construction given the parent form section and this form section's name
-     *
-     * @param EE_Form_Section_Proper $parent_form_section
-     * @param string                 $name
-     * @throws EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        if (! $this->_payment_method_type instanceof EE_PMT_Base) {
-            throw new EE_Error(sprintf(esc_html__(
-                'Payment Method forms must have set their payment method type BEFORE calling _construct_finalize',
-                'event_espresso'
-            )));
-        }
-        // set the name of this form based on the payment method type
-        if (! $this->_name && ! $name) {
-            $name = str_replace(" ", "_", ucwords(str_replace("_", " ", ($this->_payment_method_type->system_name()))))
-                    . "_Settings_Form";
-        }
-        parent::_construct_finalize($parent_form_section, $name);
-    }
-
-
-
-    /**
-     * @param $payment_method_type
-     * @throws EE_Error
-     */
-    public function set_payment_method_type($payment_method_type)
-    {
-        if (! $payment_method_type instanceof EE_PMT_Base) {
-            throw new EE_Error(sprintf(esc_html__(
-                "Payment Method forms MUST set a payment method type by using _set_payment_method_type",
-                "event_espresso"
-            )));
-        }
-        $this->_payment_method_type = $payment_method_type;
-    }
-
-
-
-    /**
-     * extends the model form section's save method to also save the extra meta field values
-     *
-     * @return int ID of the payment method inserted, or true on update
-     */
-    public function save()
-    {
-        $parent_save_val = parent::save();
-        if ($this->_model_object && $this->_model_object->ID()) {
-            foreach ($this->_extra_meta_inputs as $input_name => $input) {
-                $this->_model_object->update_extra_meta($input_name, $input->normalized_value());
-            }
-        }
-        return $parent_save_val;
-    }
-
-
-
-    /**
-     * Overrides parent's populate_model_obj to also populate the extra meta fields
-     *
-     * @param EE_Base_Class $model_obj
-     */
-    public function populate_model_obj($model_obj)
-    {
-        $model_obj = $this->_model->ensure_is_obj($model_obj);
-        parent::populate_model_obj($model_obj);
-        $extra_meta = $model_obj->all_extra_meta_array();
-        foreach ($this->_extra_meta_inputs as $input_name => $extra_meta_input) {
-            if (isset($extra_meta[ $input_name ])) {
-                $extra_meta_input->set_default($extra_meta[ $input_name ]);
-            }
-        }
-    }
-
-
-
-    /**
-     * gets the default name of this form section if none is specified
-     *
-     * @return string
-     */
-    protected function _set_default_name_if_empty()
-    {
-        if (! $this->_name) {
-            $default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
-            $this->_name = $default_name;
-        }
-    }
-
-
-
-    /**
-     * Gets all the extra meta inputs in this form
-     *
-     * @return EE_Form_Input_Base[]
-     */
-    public function extra_meta_inputs()
-    {
-        return $this->_extra_meta_inputs;
-    }
+	/**
+	 * All the subsection inputs that correspond ot extra meta rows
+	 * for this payment method
+	 *
+	 * @var EE_Form_Input_Base[]
+	 */
+	protected $_extra_meta_inputs = array();
+
+	/**
+	 * Because payment method form might DELAY part of construction, we want to remember
+	 * what options were passed in
+	 *
+	 * @var array
+	 */
+	protected $_options_array = array();
+
+	/**
+	 * The payment method type for this form
+	 *
+	 * @var EE_PMT_Base
+	 */
+	protected $_payment_method_type;
+
+
+
+	/**
+	 * @param array      $options_array       {
+	 * @type string      $extra_meta_inputs   should be EE_Form_Section_Validatable[] which
+	 *                                        will be _subsections and will be saved as extra meta on the payment
+	 *                                        method object;
+	 * @type EE_PMT_Base $payment_method_type the payment method type this form is for
+	 * @see EE_Model_Form_Section::__construct() for more
+	 *                                        }
+	 */
+	public function __construct($options_array = array())
+	{
+		$this->_model = EEM_Payment_Method::instance();
+		$this->_options_array = $options_array;
+		if (isset($options_array['payment_method_type'])) {
+			$this->_payment_method_type = $options_array['payment_method_type'];
+		}
+		$options_array = $this->_options_array;
+		if (isset($options_array['extra_meta_inputs'])) {
+			$this->_extra_meta_inputs = array_merge($this->_extra_meta_inputs, $options_array['extra_meta_inputs']);
+		}
+		if ($this->_extra_meta_inputs) {
+			$this->_subsections = array_merge($this->_subsections, $this->_extra_meta_inputs);
+		}
+		$this->_subsections['PMD_button_url'] = new EE_Admin_File_Uploader_Input(
+			array('html_label_text' => esc_html__('Button URL', 'event_espresso'))
+		);
+		$this->_subsections['PMD_scope'] = new EE_Checkbox_Multi_Input(
+			EEM_Payment_Method::instance()->scopes(),
+			array(
+				'html_label_text' => $this->_model->field_settings_for('PMD_scope')->get_nicename()
+									 . EEH_Template::get_help_tab_link('payment_methods_overview'),
+			)
+		);
+		// setup the currency options
+		$this->_subsections['Currency'] = new EE_Select_Multi_Model_Input(
+			EEM_Currency::instance()->get_all_currencies_usable_by($this->_payment_method_type),
+			array(
+				'html_label_text' => esc_html__('Currencies Supported', 'event_espresso'),
+				'required'        => true,
+			)
+		);
+		$this->_subsections['PMD_order'] = new EE_Text_Input(array(
+			'html_label_text'        => esc_html__('Order', 'event_espresso'),
+			'html_help_text'         => esc_html__('Lowest numbers will be shown first', 'event_espresso'),
+			'normalization_strategy' => new EE_Int_Normalization(),
+			'validation_strategies'  => array(
+				new EE_Int_Validation_Strategy(),
+			),
+			'default'                => 0,
+		));
+		$this->_layout_strategy = new EE_Admin_Two_Column_Layout();
+		parent::__construct($options_array);
+		$debug_mode = isset($this->_subsections['PMD_debug_mode']) ? $this->_subsections['PMD_debug_mode'] : null;
+		if ($debug_mode instanceof EE_Form_Input_Base) {
+			$debug_mode->set_html_help_text(esc_html__(
+				'This payment method has a Sandbox Server (also known as Testing Server, Development Server, Quality Assurance Server, etc). While in debug mode and using this sandbox server, real payments will not be processed.',
+				'event_espresso'
+			));
+		}
+	}
+
+
+
+	/**
+	 * Finishes construction given the parent form section and this form section's name
+	 *
+	 * @param EE_Form_Section_Proper $parent_form_section
+	 * @param string                 $name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		if (! $this->_payment_method_type instanceof EE_PMT_Base) {
+			throw new EE_Error(sprintf(esc_html__(
+				'Payment Method forms must have set their payment method type BEFORE calling _construct_finalize',
+				'event_espresso'
+			)));
+		}
+		// set the name of this form based on the payment method type
+		if (! $this->_name && ! $name) {
+			$name = str_replace(" ", "_", ucwords(str_replace("_", " ", ($this->_payment_method_type->system_name()))))
+					. "_Settings_Form";
+		}
+		parent::_construct_finalize($parent_form_section, $name);
+	}
+
+
+
+	/**
+	 * @param $payment_method_type
+	 * @throws EE_Error
+	 */
+	public function set_payment_method_type($payment_method_type)
+	{
+		if (! $payment_method_type instanceof EE_PMT_Base) {
+			throw new EE_Error(sprintf(esc_html__(
+				"Payment Method forms MUST set a payment method type by using _set_payment_method_type",
+				"event_espresso"
+			)));
+		}
+		$this->_payment_method_type = $payment_method_type;
+	}
+
+
+
+	/**
+	 * extends the model form section's save method to also save the extra meta field values
+	 *
+	 * @return int ID of the payment method inserted, or true on update
+	 */
+	public function save()
+	{
+		$parent_save_val = parent::save();
+		if ($this->_model_object && $this->_model_object->ID()) {
+			foreach ($this->_extra_meta_inputs as $input_name => $input) {
+				$this->_model_object->update_extra_meta($input_name, $input->normalized_value());
+			}
+		}
+		return $parent_save_val;
+	}
+
+
+
+	/**
+	 * Overrides parent's populate_model_obj to also populate the extra meta fields
+	 *
+	 * @param EE_Base_Class $model_obj
+	 */
+	public function populate_model_obj($model_obj)
+	{
+		$model_obj = $this->_model->ensure_is_obj($model_obj);
+		parent::populate_model_obj($model_obj);
+		$extra_meta = $model_obj->all_extra_meta_array();
+		foreach ($this->_extra_meta_inputs as $input_name => $extra_meta_input) {
+			if (isset($extra_meta[ $input_name ])) {
+				$extra_meta_input->set_default($extra_meta[ $input_name ]);
+			}
+		}
+	}
+
+
+
+	/**
+	 * gets the default name of this form section if none is specified
+	 *
+	 * @return string
+	 */
+	protected function _set_default_name_if_empty()
+	{
+		if (! $this->_name) {
+			$default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
+			$this->_name = $default_name;
+		}
+	}
+
+
+
+	/**
+	 * Gets all the extra meta inputs in this form
+	 *
+	 * @return EE_Form_Input_Base[]
+	 */
+	public function extra_meta_inputs()
+	{
+		return $this->_extra_meta_inputs;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -104,14 +104,14 @@ 
      */
     public function _construct_finalize($parent_form_section, $name)
     {
-        if (! $this->_payment_method_type instanceof EE_PMT_Base) {
+        if ( ! $this->_payment_method_type instanceof EE_PMT_Base) {
             throw new EE_Error(sprintf(esc_html__(
                 'Payment Method forms must have set their payment method type BEFORE calling _construct_finalize',
                 'event_espresso'
             )));
         }
         // set the name of this form based on the payment method type
-        if (! $this->_name && ! $name) {
+        if ( ! $this->_name && ! $name) {
             $name = str_replace(" ", "_", ucwords(str_replace("_", " ", ($this->_payment_method_type->system_name()))))
                     . "_Settings_Form";
         }
@@ -126,7 +126,7 @@ 
      */
     public function set_payment_method_type($payment_method_type)
     {
-        if (! $payment_method_type instanceof EE_PMT_Base) {
+        if ( ! $payment_method_type instanceof EE_PMT_Base) {
             throw new EE_Error(sprintf(esc_html__(
                 "Payment Method forms MUST set a payment method type by using _set_payment_method_type",
                 "event_espresso"
@@ -166,8 +166,8 @@ 
         parent::populate_model_obj($model_obj);
         $extra_meta = $model_obj->all_extra_meta_array();
         foreach ($this->_extra_meta_inputs as $input_name => $extra_meta_input) {
-            if (isset($extra_meta[ $input_name ])) {
-                $extra_meta_input->set_default($extra_meta[ $input_name ]);
+            if (isset($extra_meta[$input_name])) {
+                $extra_meta_input->set_default($extra_meta[$input_name]);
             }
         }
     }
@@ -181,8 +181,8 @@ 
      */
     protected function _set_default_name_if_empty()
     {
-        if (! $this->_name) {
-            $default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
+        if ( ! $this->_name) {
+            $default_name = str_replace("EEM_", "", get_class($this->_model))."_Model_Form";
             $this->_name = $default_name;
         }
     }

core/libraries/form_sections/strategies/display/EE_Admin_File_Uploader_Display_Strategy.strategy.php

Indentation +61 added lines, -61 removed lines

@@ -12,73 +12,73 @@
 class EE_Admin_File_Uploader_Display_Strategy extends EE_Display_Strategy_Base
 {
 
-    /**
-     * Its important this media only get enqueued AFTER init, but before the footer... where the
-     * rest of our forms JS gets enqueued. Otherwise the JS gets enqueued fine, and loaded on the page fine,
-     * but when you upload an image it gets uploaded fine to the server, but it doesn't display and reports an error
-     * (also it doesn't show any of the currently existing media in the modal window that pops up when you click the button
-     * to select media).
-     * Besides that, no special consideration should be required to make the media uploader appear, besides having
-     * this input displayed.
-     * @deprecated. enqueue_js should be called automatically now
-     */
-    public static function enqueue_scripts()
-    {
-        EE_Error::doing_it_wrong(__FUNCTION__, esc_html__('EE_Admin_File_Uploader_Display_Strategy::enqueue_scripts() no longer needs to be called in order to display the admin uploader input correctly. This is handled now by EE_Admin_File_Uploader_Display_Strategy::enqueue_js() which is called automatically when enqueueing JS and CSS for the form', 'event_espresso'), '4.9.8.rc.015');
-        wp_enqueue_media();
-        wp_enqueue_script('media-upload');
-        wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL . 'scripts/ee-media-uploader.js');
-    }
+	/**
+	 * Its important this media only get enqueued AFTER init, but before the footer... where the
+	 * rest of our forms JS gets enqueued. Otherwise the JS gets enqueued fine, and loaded on the page fine,
+	 * but when you upload an image it gets uploaded fine to the server, but it doesn't display and reports an error
+	 * (also it doesn't show any of the currently existing media in the modal window that pops up when you click the button
+	 * to select media).
+	 * Besides that, no special consideration should be required to make the media uploader appear, besides having
+	 * this input displayed.
+	 * @deprecated. enqueue_js should be called automatically now
+	 */
+	public static function enqueue_scripts()
+	{
+		EE_Error::doing_it_wrong(__FUNCTION__, esc_html__('EE_Admin_File_Uploader_Display_Strategy::enqueue_scripts() no longer needs to be called in order to display the admin uploader input correctly. This is handled now by EE_Admin_File_Uploader_Display_Strategy::enqueue_js() which is called automatically when enqueueing JS and CSS for the form', 'event_espresso'), '4.9.8.rc.015');
+		wp_enqueue_media();
+		wp_enqueue_script('media-upload');
+		wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL . 'scripts/ee-media-uploader.js');
+	}
 
-    /**
-     * Enqueues the JS and CSS needed to display this input
-     */
-    public function enqueue_js()
-    {
-        wp_enqueue_media();
-        wp_enqueue_script('media-upload');
-        wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL . 'scripts/ee-media-uploader.js');
-        parent::enqueue_js();
-    }
+	/**
+	 * Enqueues the JS and CSS needed to display this input
+	 */
+	public function enqueue_js()
+	{
+		wp_enqueue_media();
+		wp_enqueue_script('media-upload');
+		wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL . 'scripts/ee-media-uploader.js');
+		parent::enqueue_js();
+	}
 
 
 
-    /**
-     *
-     * @return string of html to display the field
-     */
+	/**
+	 *
+	 * @return string of html to display the field
+	 */
 
-    public function display()
-    {
-        // the actual input
-        $input = '<input type="text" size="34" ';
-        $input .= 'name="' . $this->_input->html_name() . '" ';
-        $input .= $this->_input->html_class() != '' ? 'class="large-text ee_media_url ' . $this->_input->html_class() . '" ' : 'class="large-text ee_media_url" ';
-        $input .= 'value="' . $this->_input->raw_value_in_form() . '" ';
-        $input .= $this->_input->other_html_attributes() . '>';
-        // image uploader
-        $uploader = EEH_HTML::link('#', '<img src="' . admin_url('images/media-button-image.gif') . '" >', esc_html__('click to add an image', 'event_espresso'), '', 'ee_media_upload');
-        // only attempt to show the image if it at least exists
-        $image = $this->src_exists($this->_input->raw_value()) ? EEH_HTML::br(2) . EEH_HTML::img($this->_input->raw_value(), esc_html__('logo', 'event_espresso'), '', 'ee_media_image') : '';
-        // html string
-        return EEH_HTML::div($input . EEH_HTML::nbsp() . $uploader . $image, '', 'ee_media_uploader_area');
-    }
+	public function display()
+	{
+		// the actual input
+		$input = '<input type="text" size="34" ';
+		$input .= 'name="' . $this->_input->html_name() . '" ';
+		$input .= $this->_input->html_class() != '' ? 'class="large-text ee_media_url ' . $this->_input->html_class() . '" ' : 'class="large-text ee_media_url" ';
+		$input .= 'value="' . $this->_input->raw_value_in_form() . '" ';
+		$input .= $this->_input->other_html_attributes() . '>';
+		// image uploader
+		$uploader = EEH_HTML::link('#', '<img src="' . admin_url('images/media-button-image.gif') . '" >', esc_html__('click to add an image', 'event_espresso'), '', 'ee_media_upload');
+		// only attempt to show the image if it at least exists
+		$image = $this->src_exists($this->_input->raw_value()) ? EEH_HTML::br(2) . EEH_HTML::img($this->_input->raw_value(), esc_html__('logo', 'event_espresso'), '', 'ee_media_image') : '';
+		// html string
+		return EEH_HTML::div($input . EEH_HTML::nbsp() . $uploader . $image, '', 'ee_media_uploader_area');
+	}
 
 
 
-    /**
-     * Asserts an image actually exists as quickly as possible by sending a HEAD
-     * request
-     * @param string $src
-     * @return boolean
-     */
-    protected function src_exists($src)
-    {
-        $results = wp_remote_head($src);
-        if (is_array($results) && ! $results instanceof WP_Error) {
-            return strpos($results['headers']['content-type'], "image") !== false;
-        } else {
-            return false;
-        }
-    }
+	/**
+	 * Asserts an image actually exists as quickly as possible by sending a HEAD
+	 * request
+	 * @param string $src
+	 * @return boolean
+	 */
+	protected function src_exists($src)
+	{
+		$results = wp_remote_head($src);
+		if (is_array($results) && ! $results instanceof WP_Error) {
+			return strpos($results['headers']['content-type'], "image") !== false;
+		} else {
+			return false;
+		}
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -27,7 +27,7 @@ 
         EE_Error::doing_it_wrong(__FUNCTION__, esc_html__('EE_Admin_File_Uploader_Display_Strategy::enqueue_scripts() no longer needs to be called in order to display the admin uploader input correctly. This is handled now by EE_Admin_File_Uploader_Display_Strategy::enqueue_js() which is called automatically when enqueueing JS and CSS for the form', 'event_espresso'), '4.9.8.rc.015');
         wp_enqueue_media();
         wp_enqueue_script('media-upload');
-        wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL . 'scripts/ee-media-uploader.js');
+        wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL.'scripts/ee-media-uploader.js');
     }
 
     /**
@@ -37,7 +37,7 @@ 
     {
         wp_enqueue_media();
         wp_enqueue_script('media-upload');
-        wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL . 'scripts/ee-media-uploader.js');
+        wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL.'scripts/ee-media-uploader.js');
         parent::enqueue_js();
     }
 
@@ -52,16 +52,16 @@ 
     {
         // the actual input
         $input = '<input type="text" size="34" ';
-        $input .= 'name="' . $this->_input->html_name() . '" ';
-        $input .= $this->_input->html_class() != '' ? 'class="large-text ee_media_url ' . $this->_input->html_class() . '" ' : 'class="large-text ee_media_url" ';
-        $input .= 'value="' . $this->_input->raw_value_in_form() . '" ';
-        $input .= $this->_input->other_html_attributes() . '>';
+        $input .= 'name="'.$this->_input->html_name().'" ';
+        $input .= $this->_input->html_class() != '' ? 'class="large-text ee_media_url '.$this->_input->html_class().'" ' : 'class="large-text ee_media_url" ';
+        $input .= 'value="'.$this->_input->raw_value_in_form().'" ';
+        $input .= $this->_input->other_html_attributes().'>';
         // image uploader
-        $uploader = EEH_HTML::link('#', '<img src="' . admin_url('images/media-button-image.gif') . '" >', esc_html__('click to add an image', 'event_espresso'), '', 'ee_media_upload');
+        $uploader = EEH_HTML::link('#', '<img src="'.admin_url('images/media-button-image.gif').'" >', esc_html__('click to add an image', 'event_espresso'), '', 'ee_media_upload');
         // only attempt to show the image if it at least exists
-        $image = $this->src_exists($this->_input->raw_value()) ? EEH_HTML::br(2) . EEH_HTML::img($this->_input->raw_value(), esc_html__('logo', 'event_espresso'), '', 'ee_media_image') : '';
+        $image = $this->src_exists($this->_input->raw_value()) ? EEH_HTML::br(2).EEH_HTML::img($this->_input->raw_value(), esc_html__('logo', 'event_espresso'), '', 'ee_media_image') : '';
         // html string
-        return EEH_HTML::div($input . EEH_HTML::nbsp() . $uploader . $image, '', 'ee_media_uploader_area');
+        return EEH_HTML::div($input.EEH_HTML::nbsp().$uploader.$image, '', 'ee_media_uploader_area');
     }
 
 

core/libraries/form_sections/strategies/display/EE_Select_Multiple_Display_Strategy.strategy.php

Indentation +43 added lines, -43 removed lines

@@ -12,54 +12,54 @@
 class EE_Select_Multiple_Display_Strategy extends EE_Select_Display_Strategy
 {
 
-    /**
-     *
-     * @throws EE_Error
-     * @return string of html to display the field
-     */
-    public function display()
-    {
+	/**
+	 *
+	 * @throws EE_Error
+	 * @return string of html to display the field
+	 */
+	public function display()
+	{
 
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
-            throw new EE_Error(sprintf(esc_html__('Cannot use Select Multiple Display Strategy with an input that doesn\'t have options', "event_espresso")));
-        }
+		if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+			throw new EE_Error(sprintf(esc_html__('Cannot use Select Multiple Display Strategy with an input that doesn\'t have options', "event_espresso")));
+		}
 
-        $html = EEH_HTML::nl(0, 'select');
-        $html .= '<select multiple';
-        $html .= ' id="' . $this->_input->html_id() . '"';
-        $html .= ' name="' . $this->_input->html_name() . '[]"';
-        $class = $this->_input->required() ? $this->_input->required_css_class() . ' ' . $this->_input->html_class() : $this->_input->html_class();
-        $html .= ' class="' . $class . '"';
-        // add html5 required
-        $html .= $this->_input->required() ? ' required' : '';
-        $html .= ' style="' . $this->_input->html_style() . '"';
-        $html .= ' ' . $this->_input->other_html_attributes();
-        $html .= '>';
+		$html = EEH_HTML::nl(0, 'select');
+		$html .= '<select multiple';
+		$html .= ' id="' . $this->_input->html_id() . '"';
+		$html .= ' name="' . $this->_input->html_name() . '[]"';
+		$class = $this->_input->required() ? $this->_input->required_css_class() . ' ' . $this->_input->html_class() : $this->_input->html_class();
+		$html .= ' class="' . $class . '"';
+		// add html5 required
+		$html .= $this->_input->required() ? ' required' : '';
+		$html .= ' style="' . $this->_input->html_style() . '"';
+		$html .= ' ' . $this->_input->other_html_attributes();
+		$html .= '>';
 
-        EEH_HTML::indent(1, 'select');
-        if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
-            throw new EE_Error(sprintf(esc_html__("Select multiple display strategy does not allow for nested arrays of options.", "event_espresso")));
-        } else {
-            $html .= $this->_display_options($this->_input->options());
-        }
+		EEH_HTML::indent(1, 'select');
+		if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
+			throw new EE_Error(sprintf(esc_html__("Select multiple display strategy does not allow for nested arrays of options.", "event_espresso")));
+		} else {
+			$html .= $this->_display_options($this->_input->options());
+		}
 
-        $html .= EEH_HTML::nl(-1, 'select') . "</select>";
-        return $html;
-    }
+		$html .= EEH_HTML::nl(-1, 'select') . "</select>";
+		return $html;
+	}
 
 
 
-    /**
-     * Checks if that $value is one of the selected ones
-     * @param string|int $value unnormalized value option (string)
-     * @return boolean
-     */
-    protected function _check_if_option_selected($value)
-    {
-        $selected_options = $this->_input->raw_value();
-        if (empty($selected_options)) {
-            return false;
-        }
-        return in_array($value, $selected_options) ? true : false;
-    }
+	/**
+	 * Checks if that $value is one of the selected ones
+	 * @param string|int $value unnormalized value option (string)
+	 * @return boolean
+	 */
+	protected function _check_if_option_selected($value)
+	{
+		$selected_options = $this->_input->raw_value();
+		if (empty($selected_options)) {
+			return false;
+		}
+		return in_array($value, $selected_options) ? true : false;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -20,20 +20,20 @@ 
     public function display()
     {
 
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+        if ( ! $this->_input instanceof EE_Form_Input_With_Options_Base) {
             throw new EE_Error(sprintf(esc_html__('Cannot use Select Multiple Display Strategy with an input that doesn\'t have options', "event_espresso")));
         }
 
         $html = EEH_HTML::nl(0, 'select');
         $html .= '<select multiple';
-        $html .= ' id="' . $this->_input->html_id() . '"';
-        $html .= ' name="' . $this->_input->html_name() . '[]"';
-        $class = $this->_input->required() ? $this->_input->required_css_class() . ' ' . $this->_input->html_class() : $this->_input->html_class();
-        $html .= ' class="' . $class . '"';
+        $html .= ' id="'.$this->_input->html_id().'"';
+        $html .= ' name="'.$this->_input->html_name().'[]"';
+        $class = $this->_input->required() ? $this->_input->required_css_class().' '.$this->_input->html_class() : $this->_input->html_class();
+        $html .= ' class="'.$class.'"';
         // add html5 required
         $html .= $this->_input->required() ? ' required' : '';
-        $html .= ' style="' . $this->_input->html_style() . '"';
-        $html .= ' ' . $this->_input->other_html_attributes();
+        $html .= ' style="'.$this->_input->html_style().'"';
+        $html .= ' '.$this->_input->other_html_attributes();
         $html .= '>';
 
         EEH_HTML::indent(1, 'select');
@@ -43,7 +43,7 @@ 
             $html .= $this->_display_options($this->_input->options());
         }
 
-        $html .= EEH_HTML::nl(-1, 'select') . "</select>";
+        $html .= EEH_HTML::nl(-1, 'select')."</select>";
         return $html;
     }
 

core/libraries/form_sections/strategies/display/EE_Select_Display_Strategy.strategy.php

Indentation +65 added lines, -65 removed lines

@@ -15,78 +15,78 @@
 class EE_Select_Display_Strategy extends EE_Display_Strategy_Base
 {
 
-    /**
-     *
-     * @throws EE_Error
-     * @return string of html to display the field
-     */
-    public function display()
-    {
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
-            throw new EE_Error(sprintf(esc_html__('Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso')));
-        }
+	/**
+	 *
+	 * @throws EE_Error
+	 * @return string of html to display the field
+	 */
+	public function display()
+	{
+		if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+			throw new EE_Error(sprintf(esc_html__('Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso')));
+		}
 
-        $html = EEH_HTML::nl(0, 'select');
-        $html .= '<select';
-        $html .= $this->_attributes_string(
-            $this->_standard_attributes_array()
-        );
-        $html .= '>';
+		$html = EEH_HTML::nl(0, 'select');
+		$html .= '<select';
+		$html .= $this->_attributes_string(
+			$this->_standard_attributes_array()
+		);
+		$html .= '>';
 
-        if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
-            EEH_HTML::indent(1, 'optgroup');
-            foreach ($this->_input->options() as $opt_group_label => $opt_group) {
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
-                }
-                EEH_HTML::indent(1, 'option');
-                $html .= $this->_display_options($opt_group);
-                EEH_HTML::indent(-1, 'option');
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
-                }
-            }
-            EEH_HTML::indent(-1, 'optgroup');
-        } else {
-            $html .= $this->_display_options($this->_input->options());
-        }
+		if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
+			EEH_HTML::indent(1, 'optgroup');
+			foreach ($this->_input->options() as $opt_group_label => $opt_group) {
+				if (! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+				}
+				EEH_HTML::indent(1, 'option');
+				$html .= $this->_display_options($opt_group);
+				EEH_HTML::indent(-1, 'option');
+				if (! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
+				}
+			}
+			EEH_HTML::indent(-1, 'optgroup');
+		} else {
+			$html .= $this->_display_options($this->_input->options());
+		}
 
-        $html .= EEH_HTML::nl(0, 'select') . '</select>';
-        return $html;
-    }
+		$html .= EEH_HTML::nl(0, 'select') . '</select>';
+		return $html;
+	}
 
 
 
-    /**
-     * Displays a flat list of options as option tags
-     * @param array $options
-     * @return string
-     */
-    protected function _display_options($options)
-    {
-        $html = '';
-        EEH_HTML::indent(1, 'option');
-        foreach ($options as $value => $display_text) {
-            // even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
-            // PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
-            $unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one($value);
-            $selected = $this->_check_if_option_selected($unnormalized_value) ? ' selected="selected"' : '';
-            $html .= EEH_HTML::nl(0, 'option') . '<option value="' . esc_attr($unnormalized_value) . '"' . $selected . '>' . $display_text . '</option>';
-        }
-        EEH_HTML::indent(-1, 'option');
-        return $html;
-    }
+	/**
+	 * Displays a flat list of options as option tags
+	 * @param array $options
+	 * @return string
+	 */
+	protected function _display_options($options)
+	{
+		$html = '';
+		EEH_HTML::indent(1, 'option');
+		foreach ($options as $value => $display_text) {
+			// even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
+			// PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
+			$unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one($value);
+			$selected = $this->_check_if_option_selected($unnormalized_value) ? ' selected="selected"' : '';
+			$html .= EEH_HTML::nl(0, 'option') . '<option value="' . esc_attr($unnormalized_value) . '"' . $selected . '>' . $display_text . '</option>';
+		}
+		EEH_HTML::indent(-1, 'option');
+		return $html;
+	}
 
 
 
-    /**
-     * Checks if that value is the one selected
-     *
-     * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
-     * @return string
-     */
-    protected function _check_if_option_selected($option_value)
-    {
-        return $option_value === $this->_input->raw_value();
-    }
+	/**
+	 * Checks if that value is the one selected
+	 *
+	 * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
+	 * @return string
+	 */
+	protected function _check_if_option_selected($option_value)
+	{
+		return $option_value === $this->_input->raw_value();
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -22,7 +22,7 @@ 
      */
     public function display()
     {
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+        if ( ! $this->_input instanceof EE_Form_Input_With_Options_Base) {
             throw new EE_Error(sprintf(esc_html__('Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso')));
         }
 
@@ -36,14 +36,14 @@ 
         if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
             EEH_HTML::indent(1, 'optgroup');
             foreach ($this->_input->options() as $opt_group_label => $opt_group) {
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+                if ( ! empty($opt_group_label)) {
+                    $html .= EEH_HTML::nl(0, 'optgroup').'<optgroup label="'.esc_attr($opt_group_label).'">';
                 }
                 EEH_HTML::indent(1, 'option');
                 $html .= $this->_display_options($opt_group);
                 EEH_HTML::indent(-1, 'option');
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
+                if ( ! empty($opt_group_label)) {
+                    $html .= EEH_HTML::nl(0, 'optgroup').'</optgroup>';
                 }
             }
             EEH_HTML::indent(-1, 'optgroup');
@@ -51,7 +51,7 @@ 
             $html .= $this->_display_options($this->_input->options());
         }
 
-        $html .= EEH_HTML::nl(0, 'select') . '</select>';
+        $html .= EEH_HTML::nl(0, 'select').'</select>';
         return $html;
     }
 
@@ -71,7 +71,7 @@ 
             // PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
             $unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one($value);
             $selected = $this->_check_if_option_selected($unnormalized_value) ? ' selected="selected"' : '';
-            $html .= EEH_HTML::nl(0, 'option') . '<option value="' . esc_attr($unnormalized_value) . '"' . $selected . '>' . $display_text . '</option>';
+            $html .= EEH_HTML::nl(0, 'option').'<option value="'.esc_attr($unnormalized_value).'"'.$selected.'>'.$display_text.'</option>';
         }
         EEH_HTML::indent(-1, 'option');
         return $html;