eventespresso / event-espresso-core

core/libraries/form_sections/inputs/EE_Form_Input_With_Options_Base.input.php

Spacing +13 added lines, -13 removed lines

@@ -115,7 +115,7 @@ 
             $all_ints = true;
             array_walk_recursive(
                 $this->_options,
-                function ($value, $key) use (&$all_ints) {
+                function($value, $key) use (&$all_ints) {
                     // is this a top-level key? ignore it
                     if (
                         ! is_array($value)
@@ -177,13 +177,13 @@ 
         if (EEH_Array::is_multi_dimensional_array($arr)) {
             foreach ($arr as $sub_array) {
                 foreach ((array) $sub_array as $key => $value) {
-                    $flat_array[ $key ] = $value;
+                    $flat_array[$key] = $value;
                     $this->_set_label_size($value);
                 }
             }
         } else {
             foreach ($arr as $key => $value) {
-                $flat_array[ $key ] = $value;
+                $flat_array[$key] = $value;
                 $this->_set_label_size($value);
             }
         }
@@ -204,17 +204,17 @@ 
                 $desc = '';
                 if ($this->_use_desc_in_label) {
                     $desc = $question_option->desc();
-                    $desc = ! empty($desc) ? '<span class="ee-question-option-desc">' . $desc . '</span>' : '';
+                    $desc = ! empty($desc) ? '<span class="ee-question-option-desc">'.$desc.'</span>' : '';
                 }
                 $value = $question_option->value();
                 // add value even if it's empty
-                $flat_array[ $value ] = $value;
+                $flat_array[$value] = $value;
                 // if both value and desc are not empty, then separate with a dash
-                if (! empty($value) && ! empty($desc)) {
-                    $flat_array[ $value ] .= ' - ' . $desc;
+                if ( ! empty($value) && ! empty($desc)) {
+                    $flat_array[$value] .= ' - '.$desc;
                 } else {
                     // otherwise, just add desc, since either or both of the vars is empty, and no dash is necessary
-                    $flat_array[ $value ] .= $desc;
+                    $flat_array[$value] .= $desc;
                 }
             } elseif (is_array($question_option)) {
                 $flat_array += $this->_flatten_select_options($question_option);
@@ -233,7 +233,7 @@ 
     public function set_label_sizes()
     {
         // did the input settings specifically say to NOT set the label size dynamically ?
-        if (! $this->_enforce_label_size) {
+        if ( ! $this->_enforce_label_size) {
             foreach ($this->_options as $option) {
                 // calculate the strlen of the label
                 $this->_set_label_size($option);
@@ -252,7 +252,7 @@ 
     private function _set_label_size($value = '')
     {
         // don't change label size if it has already been set and is being enforced
-        if ($this->_enforce_label_size && $this->_label_size >  0) {
+        if ($this->_enforce_label_size && $this->_label_size > 0) {
             return;
         }
         // determine length of option value
@@ -299,13 +299,13 @@ 
     {
         $options = $this->flat_options();
         $unnormalized_value_choices = $this->get_normalization_strategy()->unnormalize($this->_normalized_value);
-        if (! $this->_multiple_selections) {
+        if ( ! $this->_multiple_selections) {
             $unnormalized_value_choices = array($unnormalized_value_choices);
         }
         $pretty_strings = array();
         foreach ((array) $unnormalized_value_choices as $unnormalized_value_choice) {
-            if (isset($options[ $unnormalized_value_choice ])) {
-                $pretty_strings[] = $options[ $unnormalized_value_choice ];
+            if (isset($options[$unnormalized_value_choice])) {
+                $pretty_strings[] = $options[$unnormalized_value_choice];
             } else {
                 $pretty_strings[] = $this->normalized_value();
             }

Indentation +320 added lines, -320 removed lines

@@ -11,324 +11,324 @@
  */
 class EE_Form_Input_With_Options_Base extends EE_Form_Input_Base
 {
-    /**
-     * array of available options to choose as an answer
-     *
-     * @var array
-     */
-    protected $_options = array();
-
-    /**
-     * whether to display the html_label_text above the checkbox/radio button options
-     *
-     * @var boolean
-     */
-    protected $_display_html_label_text = true;
-
-    /**
-     * whether to display an question option description as part of the input label
-     *
-     * @var boolean
-     */
-    protected $_use_desc_in_label = true;
-
-    /**
-     * strlen() result for the longest input value (what gets displayed in the label)
-     * this is used to apply a css class to the input label
-     *
-     * @var int
-     */
-    protected $_label_size = 0;
-
-    /**
-     * whether to enforce the label size value passed in the constructor
-     *
-     * @var boolean
-     */
-    protected $_enforce_label_size = false;
-
-    /**
-     * whether to allow multiple selections (ie, the value of this input should be an array)
-     * or not (ie, the value should be a simple int, string, etc)
-     *
-     * @var boolean
-     */
-    protected $_multiple_selections = false;
-
-
-
-    /**
-     * @param array     $answer_options
-     * @param array     $input_settings {
-     * @type int|string $label_size
-     * @type boolean    $display_html_label_text
-     *                                  }
-     *                                  And all the options accepted by EE_Form_Input_Base
-     */
-    public function __construct($answer_options = array(), $input_settings = array())
-    {
-        if (isset($input_settings['label_size'])) {
-            $this->_set_label_size($input_settings['label_size']);
-            if (isset($input_settings['enforce_label_size']) && $input_settings['enforce_label_size']) {
-                $this->_enforce_label_size = true;
-            }
-        }
-        if (isset($input_settings['display_html_label_text'])) {
-            $this->set_display_html_label_text($input_settings['display_html_label_text']);
-        }
-        $this->set_select_options($answer_options);
-        parent::__construct($input_settings);
-    }
-
-
-
-    /**
-     * Sets the allowed options for this input. Also has the side-effect of
-     * updating the normalization strategy to match the keys provided in the array
-     *
-     * @param array $answer_options
-     * @return void  just has the side-effect of setting the options for this input
-     */
-    public function set_select_options($answer_options = array())
-    {
-        $answer_options = is_array($answer_options) ? $answer_options : array($answer_options);
-        // get the first item in the select options and check it's type
-        $this->_options = reset($answer_options) instanceof EE_Question_Option
-            ? $this->_process_question_options($answer_options)
-            : $answer_options;
-        // d( $this->_options );
-        $select_option_keys = array_keys($this->_options);
-        // attempt to determine data type for values in order to set normalization type
-        // purposefully only
-        if (
-            count($this->_options) === 2
-            && (
-                (in_array(true, $select_option_keys, true) && in_array(false, $select_option_keys, true))
-                || (in_array(1, $select_option_keys, true) && in_array(0, $select_option_keys, true))
-            )
-        ) {
-            // values appear to be boolean, like TRUE, FALSE, 1, 0
-            $normalization = new EE_Boolean_Normalization();
-        } else {
-            // are ALL the options ints (even if we're using a multi-dimensional array)? If so use int validation
-            $all_ints = true;
-            array_walk_recursive(
-                $this->_options,
-                function ($value, $key) use (&$all_ints) {
-                    // is this a top-level key? ignore it
-                    if (
-                        ! is_array($value)
-                        && ! is_int($key)
-                        && $key !== ''
-                        && $key !== null
-                    ) {
-                        $all_ints = false;
-                    }
-                }
-            );
-            if ($all_ints) {
-                $normalization = new EE_Int_Normalization();
-            } else {
-                $normalization = new EE_Text_Normalization();
-            }
-        }
-        // does input type have multiple options ?
-        if ($this->_multiple_selections) {
-            $this->_set_normalization_strategy(new EE_Many_Valued_Normalization($normalization));
-        } else {
-            $this->_set_normalization_strategy($normalization);
-        }
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function options()
-    {
-        return $this->_options;
-    }
-
-
-
-    /**
-     * Returns an array which is guaranteed to not be multidimensional
-     *
-     * @return array
-     */
-    public function flat_options()
-    {
-        return $this->_flatten_select_options($this->options());
-    }
-
-
-
-    /**
-     * Makes sure $arr is a flat array, not a multidimensional one
-     *
-     * @param array $arr
-     * @return array
-     */
-    protected function _flatten_select_options($arr)
-    {
-        $flat_array = array();
-        if (EEH_Array::is_multi_dimensional_array($arr)) {
-            foreach ($arr as $sub_array) {
-                foreach ((array) $sub_array as $key => $value) {
-                    $flat_array[ $key ] = $value;
-                    $this->_set_label_size($value);
-                }
-            }
-        } else {
-            foreach ($arr as $key => $value) {
-                $flat_array[ $key ] = $value;
-                $this->_set_label_size($value);
-            }
-        }
-        return $flat_array;
-    }
-
-
-
-    /**
-     * @param EE_Question_Option[] $question_options_array
-     * @return array
-     */
-    protected function _process_question_options($question_options_array = array())
-    {
-        $flat_array = array();
-        foreach ($question_options_array as $question_option) {
-            if ($question_option instanceof EE_Question_Option) {
-                $desc = '';
-                if ($this->_use_desc_in_label) {
-                    $desc = $question_option->desc();
-                    $desc = ! empty($desc) ? '<span class="ee-question-option-desc">' . $desc . '</span>' : '';
-                }
-                $value = $question_option->value();
-                // add value even if it's empty
-                $flat_array[ $value ] = $value;
-                // if both value and desc are not empty, then separate with a dash
-                if (! empty($value) && ! empty($desc)) {
-                    $flat_array[ $value ] .= ' - ' . $desc;
-                } else {
-                    // otherwise, just add desc, since either or both of the vars is empty, and no dash is necessary
-                    $flat_array[ $value ] .= $desc;
-                }
-            } elseif (is_array($question_option)) {
-                $flat_array += $this->_flatten_select_options($question_option);
-            }
-        }
-        return $flat_array;
-    }
-
-
-
-    /**
-     *    set_label_sizes
-     *
-     * @return void
-     */
-    public function set_label_sizes()
-    {
-        // did the input settings specifically say to NOT set the label size dynamically ?
-        if (! $this->_enforce_label_size) {
-            foreach ($this->_options as $option) {
-                // calculate the strlen of the label
-                $this->_set_label_size($option);
-            }
-        }
-    }
-
-
-
-    /**
-     *    _set_label_size_class
-     *
-     * @param int|string $value
-     * @return void
-     */
-    private function _set_label_size($value = '')
-    {
-        // don't change label size if it has already been set and is being enforced
-        if ($this->_enforce_label_size && $this->_label_size >  0) {
-            return;
-        }
-        // determine length of option value
-        $val_size = is_int($value) ? $value : strlen($value);
-        // use new value if bigger than existing
-        $this->_label_size = $val_size > $this->_label_size ? $val_size : $this->_label_size;
-    }
-
-
-
-    /**
-     *    get_label_size_class
-     *
-     * @return string
-     */
-    public function get_label_size_class()
-    {
-        $size = ' medium-lbl';
-        // use maximum option value length to determine label size
-        if ($this->_label_size < 3) {
-            $size = ' nano-lbl';
-        } elseif ($this->_label_size < 6) {
-            $size = ' micro-lbl';
-        } elseif ($this->_label_size < 12) {
-            $size = ' tiny-lbl';
-        } elseif ($this->_label_size < 25) {
-            $size = ' small-lbl';
-        } elseif ($this->_label_size < 50) {
-            $size = ' medium-lbl';
-        } elseif ($this->_label_size >= 100) {
-            $size = ' big-lbl';
-        }
-        return $size;
-    }
-
-
-
-    /**
-     * Returns the pretty value for the normalized value
-     *
-     * @return string
-     */
-    public function pretty_value()
-    {
-        $options = $this->flat_options();
-        $unnormalized_value_choices = $this->get_normalization_strategy()->unnormalize($this->_normalized_value);
-        if (! $this->_multiple_selections) {
-            $unnormalized_value_choices = array($unnormalized_value_choices);
-        }
-        $pretty_strings = array();
-        foreach ((array) $unnormalized_value_choices as $unnormalized_value_choice) {
-            if (isset($options[ $unnormalized_value_choice ])) {
-                $pretty_strings[] = $options[ $unnormalized_value_choice ];
-            } else {
-                $pretty_strings[] = $this->normalized_value();
-            }
-        }
-        return implode(', ', $pretty_strings);
-    }
-
-
-
-    /**
-     * @return boolean
-     */
-    public function display_html_label_text()
-    {
-        return $this->_display_html_label_text;
-    }
-
-
-
-    /**
-     * @param boolean $display_html_label_text
-     */
-    public function set_display_html_label_text($display_html_label_text)
-    {
-        $this->_display_html_label_text = filter_var($display_html_label_text, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * array of available options to choose as an answer
+	 *
+	 * @var array
+	 */
+	protected $_options = array();
+
+	/**
+	 * whether to display the html_label_text above the checkbox/radio button options
+	 *
+	 * @var boolean
+	 */
+	protected $_display_html_label_text = true;
+
+	/**
+	 * whether to display an question option description as part of the input label
+	 *
+	 * @var boolean
+	 */
+	protected $_use_desc_in_label = true;
+
+	/**
+	 * strlen() result for the longest input value (what gets displayed in the label)
+	 * this is used to apply a css class to the input label
+	 *
+	 * @var int
+	 */
+	protected $_label_size = 0;
+
+	/**
+	 * whether to enforce the label size value passed in the constructor
+	 *
+	 * @var boolean
+	 */
+	protected $_enforce_label_size = false;
+
+	/**
+	 * whether to allow multiple selections (ie, the value of this input should be an array)
+	 * or not (ie, the value should be a simple int, string, etc)
+	 *
+	 * @var boolean
+	 */
+	protected $_multiple_selections = false;
+
+
+
+	/**
+	 * @param array     $answer_options
+	 * @param array     $input_settings {
+	 * @type int|string $label_size
+	 * @type boolean    $display_html_label_text
+	 *                                  }
+	 *                                  And all the options accepted by EE_Form_Input_Base
+	 */
+	public function __construct($answer_options = array(), $input_settings = array())
+	{
+		if (isset($input_settings['label_size'])) {
+			$this->_set_label_size($input_settings['label_size']);
+			if (isset($input_settings['enforce_label_size']) && $input_settings['enforce_label_size']) {
+				$this->_enforce_label_size = true;
+			}
+		}
+		if (isset($input_settings['display_html_label_text'])) {
+			$this->set_display_html_label_text($input_settings['display_html_label_text']);
+		}
+		$this->set_select_options($answer_options);
+		parent::__construct($input_settings);
+	}
+
+
+
+	/**
+	 * Sets the allowed options for this input. Also has the side-effect of
+	 * updating the normalization strategy to match the keys provided in the array
+	 *
+	 * @param array $answer_options
+	 * @return void  just has the side-effect of setting the options for this input
+	 */
+	public function set_select_options($answer_options = array())
+	{
+		$answer_options = is_array($answer_options) ? $answer_options : array($answer_options);
+		// get the first item in the select options and check it's type
+		$this->_options = reset($answer_options) instanceof EE_Question_Option
+			? $this->_process_question_options($answer_options)
+			: $answer_options;
+		// d( $this->_options );
+		$select_option_keys = array_keys($this->_options);
+		// attempt to determine data type for values in order to set normalization type
+		// purposefully only
+		if (
+			count($this->_options) === 2
+			&& (
+				(in_array(true, $select_option_keys, true) && in_array(false, $select_option_keys, true))
+				|| (in_array(1, $select_option_keys, true) && in_array(0, $select_option_keys, true))
+			)
+		) {
+			// values appear to be boolean, like TRUE, FALSE, 1, 0
+			$normalization = new EE_Boolean_Normalization();
+		} else {
+			// are ALL the options ints (even if we're using a multi-dimensional array)? If so use int validation
+			$all_ints = true;
+			array_walk_recursive(
+				$this->_options,
+				function ($value, $key) use (&$all_ints) {
+					// is this a top-level key? ignore it
+					if (
+						! is_array($value)
+						&& ! is_int($key)
+						&& $key !== ''
+						&& $key !== null
+					) {
+						$all_ints = false;
+					}
+				}
+			);
+			if ($all_ints) {
+				$normalization = new EE_Int_Normalization();
+			} else {
+				$normalization = new EE_Text_Normalization();
+			}
+		}
+		// does input type have multiple options ?
+		if ($this->_multiple_selections) {
+			$this->_set_normalization_strategy(new EE_Many_Valued_Normalization($normalization));
+		} else {
+			$this->_set_normalization_strategy($normalization);
+		}
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function options()
+	{
+		return $this->_options;
+	}
+
+
+
+	/**
+	 * Returns an array which is guaranteed to not be multidimensional
+	 *
+	 * @return array
+	 */
+	public function flat_options()
+	{
+		return $this->_flatten_select_options($this->options());
+	}
+
+
+
+	/**
+	 * Makes sure $arr is a flat array, not a multidimensional one
+	 *
+	 * @param array $arr
+	 * @return array
+	 */
+	protected function _flatten_select_options($arr)
+	{
+		$flat_array = array();
+		if (EEH_Array::is_multi_dimensional_array($arr)) {
+			foreach ($arr as $sub_array) {
+				foreach ((array) $sub_array as $key => $value) {
+					$flat_array[ $key ] = $value;
+					$this->_set_label_size($value);
+				}
+			}
+		} else {
+			foreach ($arr as $key => $value) {
+				$flat_array[ $key ] = $value;
+				$this->_set_label_size($value);
+			}
+		}
+		return $flat_array;
+	}
+
+
+
+	/**
+	 * @param EE_Question_Option[] $question_options_array
+	 * @return array
+	 */
+	protected function _process_question_options($question_options_array = array())
+	{
+		$flat_array = array();
+		foreach ($question_options_array as $question_option) {
+			if ($question_option instanceof EE_Question_Option) {
+				$desc = '';
+				if ($this->_use_desc_in_label) {
+					$desc = $question_option->desc();
+					$desc = ! empty($desc) ? '<span class="ee-question-option-desc">' . $desc . '</span>' : '';
+				}
+				$value = $question_option->value();
+				// add value even if it's empty
+				$flat_array[ $value ] = $value;
+				// if both value and desc are not empty, then separate with a dash
+				if (! empty($value) && ! empty($desc)) {
+					$flat_array[ $value ] .= ' - ' . $desc;
+				} else {
+					// otherwise, just add desc, since either or both of the vars is empty, and no dash is necessary
+					$flat_array[ $value ] .= $desc;
+				}
+			} elseif (is_array($question_option)) {
+				$flat_array += $this->_flatten_select_options($question_option);
+			}
+		}
+		return $flat_array;
+	}
+
+
+
+	/**
+	 *    set_label_sizes
+	 *
+	 * @return void
+	 */
+	public function set_label_sizes()
+	{
+		// did the input settings specifically say to NOT set the label size dynamically ?
+		if (! $this->_enforce_label_size) {
+			foreach ($this->_options as $option) {
+				// calculate the strlen of the label
+				$this->_set_label_size($option);
+			}
+		}
+	}
+
+
+
+	/**
+	 *    _set_label_size_class
+	 *
+	 * @param int|string $value
+	 * @return void
+	 */
+	private function _set_label_size($value = '')
+	{
+		// don't change label size if it has already been set and is being enforced
+		if ($this->_enforce_label_size && $this->_label_size >  0) {
+			return;
+		}
+		// determine length of option value
+		$val_size = is_int($value) ? $value : strlen($value);
+		// use new value if bigger than existing
+		$this->_label_size = $val_size > $this->_label_size ? $val_size : $this->_label_size;
+	}
+
+
+
+	/**
+	 *    get_label_size_class
+	 *
+	 * @return string
+	 */
+	public function get_label_size_class()
+	{
+		$size = ' medium-lbl';
+		// use maximum option value length to determine label size
+		if ($this->_label_size < 3) {
+			$size = ' nano-lbl';
+		} elseif ($this->_label_size < 6) {
+			$size = ' micro-lbl';
+		} elseif ($this->_label_size < 12) {
+			$size = ' tiny-lbl';
+		} elseif ($this->_label_size < 25) {
+			$size = ' small-lbl';
+		} elseif ($this->_label_size < 50) {
+			$size = ' medium-lbl';
+		} elseif ($this->_label_size >= 100) {
+			$size = ' big-lbl';
+		}
+		return $size;
+	}
+
+
+
+	/**
+	 * Returns the pretty value for the normalized value
+	 *
+	 * @return string
+	 */
+	public function pretty_value()
+	{
+		$options = $this->flat_options();
+		$unnormalized_value_choices = $this->get_normalization_strategy()->unnormalize($this->_normalized_value);
+		if (! $this->_multiple_selections) {
+			$unnormalized_value_choices = array($unnormalized_value_choices);
+		}
+		$pretty_strings = array();
+		foreach ((array) $unnormalized_value_choices as $unnormalized_value_choice) {
+			if (isset($options[ $unnormalized_value_choice ])) {
+				$pretty_strings[] = $options[ $unnormalized_value_choice ];
+			} else {
+				$pretty_strings[] = $this->normalized_value();
+			}
+		}
+		return implode(', ', $pretty_strings);
+	}
+
+
+
+	/**
+	 * @return boolean
+	 */
+	public function display_html_label_text()
+	{
+		return $this->_display_html_label_text;
+	}
+
+
+
+	/**
+	 * @param boolean $display_html_label_text
+	 */
+	public function set_display_html_label_text($display_html_label_text)
+	{
+		$this->_display_html_label_text = filter_var($display_html_label_text, FILTER_VALIDATE_BOOLEAN);
+	}
 }

core/libraries/form_sections/strategies/sensitive_data_removal/EE_CCV_Sensitive_Data_Removal.strategy.php

Indentation +14 added lines, -14 removed lines

@@ -11,18 +11,18 @@
  */
 class EE_CCV_Sensitive_Data_Removal extends EE_Sensitive_Data_Removal_Base
 {
-    public function remove_sensitive_data($normalized_value)
-    {
-        // Get the ccv Length
-        $ccv_lenght = strlen($normalized_value);
-        // Replace all characters of credit card except the last four and dashes
-        for ($i = 0; $i < $ccv_lenght; $i++) {
-            if ($normalized_value[ $i ] == '-') {
-                continue;
-            }
-            $normalized_value[ $i ] = 'X';
-        }
-        // Return the masked Credit Card #
-        return $normalized_value;
-    }
+	public function remove_sensitive_data($normalized_value)
+	{
+		// Get the ccv Length
+		$ccv_lenght = strlen($normalized_value);
+		// Replace all characters of credit card except the last four and dashes
+		for ($i = 0; $i < $ccv_lenght; $i++) {
+			if ($normalized_value[ $i ] == '-') {
+				continue;
+			}
+			$normalized_value[ $i ] = 'X';
+		}
+		// Return the masked Credit Card #
+		return $normalized_value;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -17,10 +17,10 @@
         $ccv_lenght = strlen($normalized_value);
         // Replace all characters of credit card except the last four and dashes
         for ($i = 0; $i < $ccv_lenght; $i++) {
-            if ($normalized_value[ $i ] == '-') {
+            if ($normalized_value[$i] == '-') {
                 continue;
             }
-            $normalized_value[ $i ] = 'X';
+            $normalized_value[$i] = 'X';
         }
         // Return the masked Credit Card #
         return $normalized_value;

core/libraries/form_sections/strategies/sensitive_data_removal/EE_Credit_Card_Sensitive_Data_Removal.strategy.php

Indentation +14 added lines, -14 removed lines

@@ -11,18 +11,18 @@
  */
 class EE_Credit_Card_Sensitive_Data_Removal extends EE_Sensitive_Data_Removal_Base
 {
-    public function remove_sensitive_data($normalized_value)
-    {
-        // Get the cc Length
-        $cc_length = strlen($normalized_value);
-        // Replace all characters of credit card except the last four and dashes
-        for ($i = 0; $i < $cc_length - 4; $i++) {
-            if ($normalized_value[ $i ] == '-') {
-                continue;
-            }
-            $normalized_value[ $i ] = 'X';
-        }
-        // Return the masked Credit Card #
-        return $normalized_value;
-    }
+	public function remove_sensitive_data($normalized_value)
+	{
+		// Get the cc Length
+		$cc_length = strlen($normalized_value);
+		// Replace all characters of credit card except the last four and dashes
+		for ($i = 0; $i < $cc_length - 4; $i++) {
+			if ($normalized_value[ $i ] == '-') {
+				continue;
+			}
+			$normalized_value[ $i ] = 'X';
+		}
+		// Return the masked Credit Card #
+		return $normalized_value;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -17,10 +17,10 @@
         $cc_length = strlen($normalized_value);
         // Replace all characters of credit card except the last four and dashes
         for ($i = 0; $i < $cc_length - 4; $i++) {
-            if ($normalized_value[ $i ] == '-') {
+            if ($normalized_value[$i] == '-') {
                 continue;
             }
-            $normalized_value[ $i ] = 'X';
+            $normalized_value[$i] = 'X';
         }
         // Return the masked Credit Card #
         return $normalized_value;

core/libraries/form_sections/strategies/validation/EE_Max_Length_Validation_Strategy.strategy.php

Spacing +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
     public function get_jquery_validation_rule_array()
     {
         if ($this->_max_length !== EE_INF) {
-            return array( 'maxlength' => $this->_max_length, 'messages' => array( 'maxlength' => $this->get_validation_error_message() ) );
+            return array('maxlength' => $this->_max_length, 'messages' => array('maxlength' => $this->get_validation_error_message()));
         } else {
             return array();
         }

Indentation +34 added lines, -34 removed lines

@@ -11,41 +11,41 @@
  */
 class EE_Max_Length_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    protected $_max_length;
+	protected $_max_length;
 
-    public function __construct($validation_error_message = null, $max_length = EE_INF)
-    {
-        $this->_max_length = $max_length;
-        if ($validation_error_message === null) {
-            $validation_error_message = sprintf(esc_html__('Input is too long. Maximum number of characters is %1$s', 'event_espresso'), $max_length);
-        }
-        parent::__construct($validation_error_message);
-    }
+	public function __construct($validation_error_message = null, $max_length = EE_INF)
+	{
+		$this->_max_length = $max_length;
+		if ($validation_error_message === null) {
+			$validation_error_message = sprintf(esc_html__('Input is too long. Maximum number of characters is %1$s', 'event_espresso'), $max_length);
+		}
+		parent::__construct($validation_error_message);
+	}
 
-    /**
-     * @param $normalized_value
-     */
-    public function validate($normalized_value)
-    {
-        if (
-            $this->_max_length !== EE_INF &&
-                $normalized_value &&
-                is_string($normalized_value) &&
-                 strlen($normalized_value) > $this->_max_length
-        ) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'maxlength');
-        }
-    }
+	/**
+	 * @param $normalized_value
+	 */
+	public function validate($normalized_value)
+	{
+		if (
+			$this->_max_length !== EE_INF &&
+				$normalized_value &&
+				is_string($normalized_value) &&
+				 strlen($normalized_value) > $this->_max_length
+		) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'maxlength');
+		}
+	}
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        if ($this->_max_length !== EE_INF) {
-            return array( 'maxlength' => $this->_max_length, 'messages' => array( 'maxlength' => $this->get_validation_error_message() ) );
-        } else {
-            return array();
-        }
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		if ($this->_max_length !== EE_INF) {
+			return array( 'maxlength' => $this->_max_length, 'messages' => array( 'maxlength' => $this->get_validation_error_message() ) );
+		} else {
+			return array();
+		}
+	}
 }

core/libraries/form_sections/strategies/validation/EE_Min_Length_Validation_Strategy.strategy.php

Spacing +1 added lines, -1 removed lines

@@ -40,6 +40,6 @@
      */
     public function get_jquery_validation_rule_array()
     {
-        return array( 'minlength' => $this->_min_length, 'messages' => array( 'minlength' => $this->get_validation_error_message() ) );
+        return array('minlength' => $this->_min_length, 'messages' => array('minlength' => $this->get_validation_error_message()));
     }
 }

Indentation +27 added lines, -27 removed lines

@@ -11,34 +11,34 @@
  */
 class EE_Min_Length_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    protected $_min_length;
+	protected $_min_length;
 
-    public function __construct($validation_error_message = null, $min_length = 0)
-    {
-        $this->_min_length = $min_length;
-        parent::__construct($validation_error_message);
-    }
+	public function __construct($validation_error_message = null, $min_length = 0)
+	{
+		$this->_min_length = $min_length;
+		parent::__construct($validation_error_message);
+	}
 
-    /**
-     * @param $normalized_value
-     */
-    public function validate($normalized_value)
-    {
-        if (
-            $this->_min_length > 0 &&
-                $normalized_value &&
-                is_string($normalized_value) &&
-                strlen($normalized_value) < $this->_min_length
-        ) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'minlength');
-        }
-    }
+	/**
+	 * @param $normalized_value
+	 */
+	public function validate($normalized_value)
+	{
+		if (
+			$this->_min_length > 0 &&
+				$normalized_value &&
+				is_string($normalized_value) &&
+				strlen($normalized_value) < $this->_min_length
+		) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'minlength');
+		}
+	}
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        return array( 'minlength' => $this->_min_length, 'messages' => array( 'minlength' => $this->get_validation_error_message() ) );
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		return array( 'minlength' => $this->_min_length, 'messages' => array( 'minlength' => $this->get_validation_error_message() ) );
+	}
 }

core/libraries/form_sections/strategies/validation/EE_Text_Validation_Strategy.strategy.php

Spacing +3 added lines, -3 removed lines

@@ -29,8 +29,8 @@ 
     public function validate($normalized_value)
     {
         $string_normalized_value = (string) $normalized_value;
-        if ($this->_regex &&  $string_normalized_value) {
-            if (! preg_match($this->_regex, $string_normalized_value)) {
+        if ($this->_regex && $string_normalized_value) {
+            if ( ! preg_match($this->_regex, $string_normalized_value)) {
                 throw new EE_Validation_Error($this->get_validation_error_message(), 'regex');
             }
         }
@@ -42,7 +42,7 @@ 
     public function get_jquery_validation_rule_array()
     {
         if ($this->_regex !== null) {
-            return array( 'regex' => $this->regex_js(), 'messages' => array( 'regex' => $this->get_validation_error_message() ) );
+            return array('regex' => $this->regex_js(), 'messages' => array('regex' => $this->get_validation_error_message()));
         } else {
             return array();
         }

Indentation +41 added lines, -41 removed lines

@@ -10,53 +10,53 @@
  */
 class EE_Text_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    protected $_regex = null;
-    /**
-     *
-     * @param string $validation_error_message
-     * @param string $regex a PHP regex; the javascript regex will be derived from this
-     */
-    public function __construct($validation_error_message = null, $regex = null)
-    {
-        $this->_regex = $regex;
-        parent::__construct($validation_error_message);
-    }
+	protected $_regex = null;
+	/**
+	 *
+	 * @param string $validation_error_message
+	 * @param string $regex a PHP regex; the javascript regex will be derived from this
+	 */
+	public function __construct($validation_error_message = null, $regex = null)
+	{
+		$this->_regex = $regex;
+		parent::__construct($validation_error_message);
+	}
 
-    /**
-     * @param $normalized_value
-     */
-    public function validate($normalized_value)
-    {
-        $string_normalized_value = (string) $normalized_value;
-        if ($this->_regex &&  $string_normalized_value) {
-            if (! preg_match($this->_regex, $string_normalized_value)) {
-                throw new EE_Validation_Error($this->get_validation_error_message(), 'regex');
-            }
-        }
-    }
+	/**
+	 * @param $normalized_value
+	 */
+	public function validate($normalized_value)
+	{
+		$string_normalized_value = (string) $normalized_value;
+		if ($this->_regex &&  $string_normalized_value) {
+			if (! preg_match($this->_regex, $string_normalized_value)) {
+				throw new EE_Validation_Error($this->get_validation_error_message(), 'regex');
+			}
+		}
+	}
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        if ($this->_regex !== null) {
-            return array( 'regex' => $this->regex_js(), 'messages' => array( 'regex' => $this->get_validation_error_message() ) );
-        } else {
-            return array();
-        }
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		if ($this->_regex !== null) {
+			return array( 'regex' => $this->regex_js(), 'messages' => array( 'regex' => $this->get_validation_error_message() ) );
+		} else {
+			return array();
+		}
+	}
 
 /**
  * Translates a PHP regex into a javscript regex (eg, PHP needs separate delimieters, whereas
  * javscript does not
  * @return string
  */
-    public function regex_js()
-    {
-        // first character must be the delimiter
-        $delimeter = $this->_regex[0];
-        $last_occurence_of_delimieter = strrpos($this->_regex, $delimeter);
-        return substr($this->_regex, 1, $last_occurence_of_delimieter - 1);
-    }
+	public function regex_js()
+	{
+		// first character must be the delimiter
+		$delimeter = $this->_regex[0];
+		$last_occurence_of_delimieter = strrpos($this->_regex, $delimeter);
+		return substr($this->_regex, 1, $last_occurence_of_delimieter - 1);
+	}
 }

core/libraries/form_sections/form_handlers/FormHandler.php

Spacing +17 added lines, -17 removed lines

@@ -171,7 +171,7 @@ 
      */
     public function form($for_display = false)
     {
-        if (! $this->formIsValid()) {
+        if ( ! $this->formIsValid()) {
             return null;
         }
         if ($for_display) {
@@ -274,7 +274,7 @@ 
      */
     public function setFormName($form_name)
     {
-        if (! is_string($form_name)) {
+        if ( ! is_string($form_name)) {
             throw new InvalidDataTypeException('$form_name', $form_name, 'string');
         }
         $this->form_name = $form_name;
@@ -298,7 +298,7 @@ 
      */
     public function setAdminName($admin_name)
     {
-        if (! is_string($admin_name)) {
+        if ( ! is_string($admin_name)) {
             throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
         }
         $this->admin_name = $admin_name;
@@ -322,7 +322,7 @@ 
      */
     public function setSlug($slug)
     {
-        if (! is_string($slug)) {
+        if ( ! is_string($slug)) {
             throw new InvalidDataTypeException('$slug', $slug, 'string');
         }
         $this->slug = $slug;
@@ -345,7 +345,7 @@ 
      */
     public function setSubmitBtnText($submit_btn_text)
     {
-        if (! is_string($submit_btn_text)) {
+        if ( ! is_string($submit_btn_text)) {
             throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
         }
         if (empty($submit_btn_text)) {
@@ -374,7 +374,7 @@ 
      */
     public function setFormAction($form_action)
     {
-        if (! is_string($form_action)) {
+        if ( ! is_string($form_action)) {
             throw new InvalidDataTypeException('$form_action', $form_action, 'string');
         }
         $this->form_action = $form_action;
@@ -493,11 +493,11 @@ 
         $text = ! empty($text) ? $text : $this->submitBtnText();
         return new EE_Submit_Input(
             array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(),
-                'html_id'               => 'ee-form-submit-' . $this->slug(),
+                'html_name'             => 'ee-form-submit-'.$this->slug(),
+                'html_id'               => 'ee-form-submit-'.$this->slug(),
                 'html_class'            => 'ee-form-submit',
                 'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => $text,
             )
         );
@@ -513,11 +513,11 @@ 
      */
     public function appendSubmitButton($text = '')
     {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+        if ($this->form->subsection_exists($this->slug().'-submit-btn')) {
             return;
         }
         $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+            array($this->slug().'-submit-btn' => $this->generateSubmitButton($text)),
             null,
             false
         );
@@ -534,11 +534,11 @@ 
     {
         $cancel_button = new EE_Submit_Input(
             array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
-                'html_id'               => 'ee-cancel-form-' . $this->slug(),
+                'html_name'             => 'ee-form-submit-'.$this->slug(), // YES! Same name as submit !!!
+                'html_id'               => 'ee-cancel-form-'.$this->slug(),
                 'html_class'            => 'ee-cancel-form',
                 'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
             )
         );
@@ -558,7 +558,7 @@ 
         $this->form->add_subsections(
             array(
                 'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+                    EEH_HTML::div('', '', 'clear-float').EEH_HTML::divx()
                 ),
             ),
             null,
@@ -644,11 +644,11 @@ 
      */
     public function process($submitted_form_data = array())
     {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
+        if ( ! $this->form()->was_submitted($submitted_form_data)) {
             throw new InvalidFormSubmissionException($this->form_name);
         }
         $this->form(true)->receive_form_submission($submitted_form_data);
-        if (! $this->form()->is_valid()) {
+        if ( ! $this->form()->is_valid()) {
             throw new InvalidFormSubmissionException(
                 $this->form_name,
                 sprintf(

Indentation +638 added lines, -638 removed lines

@@ -29,642 +29,642 @@
  */
 abstract class FormHandler implements FormHandlerInterface
 {
-    /**
-     * will add opening and closing HTML form tags as well as a submit button
-     */
-    const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
-
-    /**
-     * will add opening and closing HTML form tags but NOT a submit button
-     */
-    const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags but will add a submit button
-     */
-    const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags NOR a submit button
-     */
-    const DO_NOT_SETUP_FORM = 'do_not_setup_form';
-
-    /**
-     * if set to false, then this form has no displayable content,
-     * and will only be used for processing data sent passed via GET or POST
-     * defaults to true ( ie: form has displayable content )
-     *
-     * @var boolean $displayable
-     */
-    private $displayable = true;
-
-    /**
-     * @var string $form_name
-     */
-    private $form_name;
-
-    /**
-     * @var string $admin_name
-     */
-    private $admin_name;
-
-    /**
-     * @var string $slug
-     */
-    private $slug;
-
-    /**
-     * @var string $submit_btn_text
-     */
-    private $submit_btn_text;
-
-    /**
-     * @var string $form_action
-     */
-    private $form_action;
-
-    /**
-     * form params in key value pairs
-     * can be added to form action URL or as hidden inputs
-     *
-     * @var array $form_args
-     */
-    private $form_args = array();
-
-    /**
-     * value of one of the string constant above
-     *
-     * @var string $form_config
-     */
-    private $form_config;
-
-    /**
-     * whether or not the form was determined to be invalid
-     *
-     * @var boolean $form_has_errors
-     */
-    private $form_has_errors;
-
-    /**
-     * the absolute top level form section being used on the page
-     *
-     * @var EE_Form_Section_Proper $form
-     */
-    private $form;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-    // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
-
-
-    /**
-     * Form constructor.
-     *
-     * @param string           $form_name
-     * @param string           $admin_name
-     * @param string           $slug
-     * @param string           $form_action
-     * @param string           $form_config
-     * @param EE_Registry|null $registry
-     */
-    public function __construct(
-        $form_name,
-        $admin_name,
-        $slug,
-        $form_action = '',
-        $form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-        EE_Registry $registry = null
-    ) {
-        $this->setFormName($form_name);
-        $this->setAdminName($admin_name);
-        $this->setSlug($slug);
-        $this->setFormAction($form_action);
-        $this->setFormConfig($form_config);
-        $this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
-        $this->registry = $registry;
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function getFormConfigConstants()
-    {
-        return array(
-            FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-            FormHandler::ADD_FORM_TAGS_ONLY,
-            FormHandler::ADD_FORM_SUBMIT_ONLY,
-            FormHandler::DO_NOT_SETUP_FORM,
-        );
-    }
-
-
-    /**
-     * @param bool $for_display
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws LogicException
-     */
-    public function form($for_display = false)
-    {
-        if (! $this->formIsValid()) {
-            return null;
-        }
-        if ($for_display) {
-            $form_config = $this->formConfig();
-            if (
-                $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-                || $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
-            ) {
-                $this->appendSubmitButton();
-                $this->clearFormButtonFloats();
-            }
-        }
-        return $this->form;
-    }
-
-
-    /**
-     * @return boolean
-     * @throws LogicException
-     */
-    public function formIsValid()
-    {
-        if ($this->form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        $form = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
-            $this->generate(),
-            $this
-        );
-        if ($this->verifyForm($form)) {
-            $this->setForm($form);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper|null $form
-     * @return bool
-     * @throws LogicException
-     */
-    public function verifyForm(EE_Form_Section_Proper $form = null)
-    {
-        $form = $form !== null ? $form : $this->form;
-        if ($form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        throw new LogicException(
-            sprintf(
-                esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
-                $this->form_name,
-                var_export($form, true)
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper $form
-     */
-    public function setForm(EE_Form_Section_Proper $form)
-    {
-        $this->form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function displayable()
-    {
-        return $this->displayable;
-    }
-
-
-    /**
-     * @param boolean $displayable
-     */
-    public function setDisplayable($displayable = false)
-    {
-        $this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * a public name for the form that can be displayed on the frontend of a site
-     *
-     * @return string
-     */
-    public function formName()
-    {
-        return $this->form_name;
-    }
-
-
-    /**
-     * @param string $form_name
-     * @throws InvalidDataTypeException
-     */
-    public function setFormName($form_name)
-    {
-        if (! is_string($form_name)) {
-            throw new InvalidDataTypeException('$form_name', $form_name, 'string');
-        }
-        $this->form_name = $form_name;
-    }
-
-
-    /**
-     * a public name for the form that can be displayed, but only in the admin
-     *
-     * @return string
-     */
-    public function adminName()
-    {
-        return $this->admin_name;
-    }
-
-
-    /**
-     * @param string $admin_name
-     * @throws InvalidDataTypeException
-     */
-    public function setAdminName($admin_name)
-    {
-        if (! is_string($admin_name)) {
-            throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
-        }
-        $this->admin_name = $admin_name;
-    }
-
-
-    /**
-     * a URL friendly string that can be used for identifying the form
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->slug;
-    }
-
-
-    /**
-     * @param string $slug
-     * @throws InvalidDataTypeException
-     */
-    public function setSlug($slug)
-    {
-        if (! is_string($slug)) {
-            throw new InvalidDataTypeException('$slug', $slug, 'string');
-        }
-        $this->slug = $slug;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function submitBtnText()
-    {
-        return $this->submit_btn_text;
-    }
-
-
-    /**
-     * @param string $submit_btn_text
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function setSubmitBtnText($submit_btn_text)
-    {
-        if (! is_string($submit_btn_text)) {
-            throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
-        }
-        if (empty($submit_btn_text)) {
-            throw new InvalidArgumentException(
-                esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
-            );
-        }
-        $this->submit_btn_text = $submit_btn_text;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formAction()
-    {
-        return ! empty($this->form_args)
-            ? add_query_arg($this->form_args, $this->form_action)
-            : $this->form_action;
-    }
-
-
-    /**
-     * @param string $form_action
-     * @throws InvalidDataTypeException
-     */
-    public function setFormAction($form_action)
-    {
-        if (! is_string($form_action)) {
-            throw new InvalidDataTypeException('$form_action', $form_action, 'string');
-        }
-        $this->form_action = $form_action;
-    }
-
-
-    /**
-     * @param array $form_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function addFormActionArgs($form_args = array())
-    {
-        if (is_object($form_args)) {
-            throw new InvalidDataTypeException(
-                '$form_args',
-                $form_args,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($form_args)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
-            );
-        }
-        $this->form_args = array_merge($this->form_args, $form_args);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formConfig()
-    {
-        return $this->form_config;
-    }
-
-
-    /**
-     * @param string $form_config
-     * @throws DomainException
-     */
-    public function setFormConfig($form_config)
-    {
-        if (
-            ! in_array(
-                $form_config,
-                array(
-                FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-                FormHandler::ADD_FORM_TAGS_ONLY,
-                FormHandler::ADD_FORM_SUBMIT_ONLY,
-                FormHandler::DO_NOT_SETUP_FORM,
-                ),
-                true
-            )
-        ) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
-                        'event_espresso'
-                    ),
-                    $form_config
-                )
-            );
-        }
-        $this->form_config = $form_config;
-    }
-
-
-    /**
-     * called after the form is instantiated
-     * and used for performing any logic that needs to occur early
-     * before any of the other methods are called.
-     * returns true if everything is ok to proceed,
-     * and false if no further form logic should be implemented
-     *
-     * @return boolean
-     */
-    public function initialize()
-    {
-        $this->form_has_errors = EE_Error::has_error(true);
-        return true;
-    }
-
-
-    /**
-     * used for setting up css and js
-     *
-     * @return void
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function enqueueStylesAndScripts()
-    {
-        $this->form()->enqueue_js();
-    }
-
-
-    /**
-     * creates and returns the actual form
-     *
-     * @return EE_Form_Section_Proper
-     */
-    abstract public function generate();
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Submit"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateSubmitButton($text = '')
-    {
-        $text = ! empty($text) ? $text : $this->submitBtnText();
-        return new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(),
-                'html_id'               => 'ee-form-submit-' . $this->slug(),
-                'html_class'            => 'ee-form-submit',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => $text,
-            )
-        );
-    }
-
-
-    /**
-     * calls generateSubmitButton() and appends it onto the form along with a float clearing div
-     *
-     * @param string $text
-     * @return void
-     * @throws EE_Error
-     */
-    public function appendSubmitButton($text = '')
-    {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
-            return;
-        }
-        $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
-            null,
-            false
-        );
-    }
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Cancel"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateCancelButton($text = '')
-    {
-        $cancel_button = new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
-                'html_id'               => 'ee-cancel-form-' . $this->slug(),
-                'html_class'            => 'ee-cancel-form',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
-            )
-        );
-        $cancel_button->set_button_css_attributes(false);
-        return $cancel_button;
-    }
-
-
-    /**
-     * appends a float clearing div onto end of form
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function clearFormButtonFloats()
-    {
-        $this->form->add_subsections(
-            array(
-                'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
-                ),
-            ),
-            null,
-            false
-        );
-    }
-
-
-    /**
-     * takes the generated form and displays it along with ony other non-form HTML that may be required
-     * returns a string of HTML that can be directly echoed in a template
-     *
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function display()
-    {
-        $form_html = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
-            ''
-        );
-        $form_config = $this->formConfig();
-        if (
-            $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $additional_props = $this->requiresMultipartEnctype()
-                ? ' enctype="multipart/form-data"'
-                : '';
-            $form_html .= $this->form()->form_open(
-                $this->formAction(),
-                'POST',
-                $additional_props
-            );
-        }
-        $form_html .= $this->form(true)->get_html();
-        if (
-            $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $form_html .= $this->form()->form_close();
-        }
-        $form_html .= apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
-            ''
-        );
-        return $form_html;
-    }
-
-    /**
-     * Determines if this form needs "enctype='multipart/form-data'" or not.
-     * @since 4.9.80.p
-     * @return bool
-     * @throws EE_Error
-     */
-    public function requiresMultipartEnctype()
-    {
-        foreach ($this->form()->inputs_in_subsections() as $input) {
-            if ($input instanceof EE_File_Input) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * handles processing the form submission
-     * returns true or false depending on whether the form was processed successfully or not
-     *
-     * @param array $submitted_form_data
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws LogicException
-     * @throws InvalidFormSubmissionException
-     */
-    public function process($submitted_form_data = array())
-    {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
-            throw new InvalidFormSubmissionException($this->form_name);
-        }
-        $this->form(true)->receive_form_submission($submitted_form_data);
-        if (! $this->form()->is_valid()) {
-            throw new InvalidFormSubmissionException(
-                $this->form_name,
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
-                        'event_espresso'
-                    ),
-                    $this->form_name,
-                    '<br />',
-                    implode('<br />', $this->form()->get_validation_errors_accumulated())
-                )
-            );
-        }
-        return (array) apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__process__valid_data',
-            $this->form()->valid_data(),
-            $this
-        );
-    }
+	/**
+	 * will add opening and closing HTML form tags as well as a submit button
+	 */
+	const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
+
+	/**
+	 * will add opening and closing HTML form tags but NOT a submit button
+	 */
+	const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags but will add a submit button
+	 */
+	const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags NOR a submit button
+	 */
+	const DO_NOT_SETUP_FORM = 'do_not_setup_form';
+
+	/**
+	 * if set to false, then this form has no displayable content,
+	 * and will only be used for processing data sent passed via GET or POST
+	 * defaults to true ( ie: form has displayable content )
+	 *
+	 * @var boolean $displayable
+	 */
+	private $displayable = true;
+
+	/**
+	 * @var string $form_name
+	 */
+	private $form_name;
+
+	/**
+	 * @var string $admin_name
+	 */
+	private $admin_name;
+
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
+
+	/**
+	 * @var string $submit_btn_text
+	 */
+	private $submit_btn_text;
+
+	/**
+	 * @var string $form_action
+	 */
+	private $form_action;
+
+	/**
+	 * form params in key value pairs
+	 * can be added to form action URL or as hidden inputs
+	 *
+	 * @var array $form_args
+	 */
+	private $form_args = array();
+
+	/**
+	 * value of one of the string constant above
+	 *
+	 * @var string $form_config
+	 */
+	private $form_config;
+
+	/**
+	 * whether or not the form was determined to be invalid
+	 *
+	 * @var boolean $form_has_errors
+	 */
+	private $form_has_errors;
+
+	/**
+	 * the absolute top level form section being used on the page
+	 *
+	 * @var EE_Form_Section_Proper $form
+	 */
+	private $form;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+	// phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
+
+
+	/**
+	 * Form constructor.
+	 *
+	 * @param string           $form_name
+	 * @param string           $admin_name
+	 * @param string           $slug
+	 * @param string           $form_action
+	 * @param string           $form_config
+	 * @param EE_Registry|null $registry
+	 */
+	public function __construct(
+		$form_name,
+		$admin_name,
+		$slug,
+		$form_action = '',
+		$form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+		EE_Registry $registry = null
+	) {
+		$this->setFormName($form_name);
+		$this->setAdminName($admin_name);
+		$this->setSlug($slug);
+		$this->setFormAction($form_action);
+		$this->setFormConfig($form_config);
+		$this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
+		$this->registry = $registry;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function getFormConfigConstants()
+	{
+		return array(
+			FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+			FormHandler::ADD_FORM_TAGS_ONLY,
+			FormHandler::ADD_FORM_SUBMIT_ONLY,
+			FormHandler::DO_NOT_SETUP_FORM,
+		);
+	}
+
+
+	/**
+	 * @param bool $for_display
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws LogicException
+	 */
+	public function form($for_display = false)
+	{
+		if (! $this->formIsValid()) {
+			return null;
+		}
+		if ($for_display) {
+			$form_config = $this->formConfig();
+			if (
+				$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+				|| $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
+			) {
+				$this->appendSubmitButton();
+				$this->clearFormButtonFloats();
+			}
+		}
+		return $this->form;
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws LogicException
+	 */
+	public function formIsValid()
+	{
+		if ($this->form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		$form = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
+			$this->generate(),
+			$this
+		);
+		if ($this->verifyForm($form)) {
+			$this->setForm($form);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper|null $form
+	 * @return bool
+	 * @throws LogicException
+	 */
+	public function verifyForm(EE_Form_Section_Proper $form = null)
+	{
+		$form = $form !== null ? $form : $this->form;
+		if ($form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		throw new LogicException(
+			sprintf(
+				esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
+				$this->form_name,
+				var_export($form, true)
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function setForm(EE_Form_Section_Proper $form)
+	{
+		$this->form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function displayable()
+	{
+		return $this->displayable;
+	}
+
+
+	/**
+	 * @param boolean $displayable
+	 */
+	public function setDisplayable($displayable = false)
+	{
+		$this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * a public name for the form that can be displayed on the frontend of a site
+	 *
+	 * @return string
+	 */
+	public function formName()
+	{
+		return $this->form_name;
+	}
+
+
+	/**
+	 * @param string $form_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormName($form_name)
+	{
+		if (! is_string($form_name)) {
+			throw new InvalidDataTypeException('$form_name', $form_name, 'string');
+		}
+		$this->form_name = $form_name;
+	}
+
+
+	/**
+	 * a public name for the form that can be displayed, but only in the admin
+	 *
+	 * @return string
+	 */
+	public function adminName()
+	{
+		return $this->admin_name;
+	}
+
+
+	/**
+	 * @param string $admin_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setAdminName($admin_name)
+	{
+		if (! is_string($admin_name)) {
+			throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
+		}
+		$this->admin_name = $admin_name;
+	}
+
+
+	/**
+	 * a URL friendly string that can be used for identifying the form
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->slug;
+	}
+
+
+	/**
+	 * @param string $slug
+	 * @throws InvalidDataTypeException
+	 */
+	public function setSlug($slug)
+	{
+		if (! is_string($slug)) {
+			throw new InvalidDataTypeException('$slug', $slug, 'string');
+		}
+		$this->slug = $slug;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function submitBtnText()
+	{
+		return $this->submit_btn_text;
+	}
+
+
+	/**
+	 * @param string $submit_btn_text
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function setSubmitBtnText($submit_btn_text)
+	{
+		if (! is_string($submit_btn_text)) {
+			throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
+		}
+		if (empty($submit_btn_text)) {
+			throw new InvalidArgumentException(
+				esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
+			);
+		}
+		$this->submit_btn_text = $submit_btn_text;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formAction()
+	{
+		return ! empty($this->form_args)
+			? add_query_arg($this->form_args, $this->form_action)
+			: $this->form_action;
+	}
+
+
+	/**
+	 * @param string $form_action
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormAction($form_action)
+	{
+		if (! is_string($form_action)) {
+			throw new InvalidDataTypeException('$form_action', $form_action, 'string');
+		}
+		$this->form_action = $form_action;
+	}
+
+
+	/**
+	 * @param array $form_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function addFormActionArgs($form_args = array())
+	{
+		if (is_object($form_args)) {
+			throw new InvalidDataTypeException(
+				'$form_args',
+				$form_args,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($form_args)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
+			);
+		}
+		$this->form_args = array_merge($this->form_args, $form_args);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formConfig()
+	{
+		return $this->form_config;
+	}
+
+
+	/**
+	 * @param string $form_config
+	 * @throws DomainException
+	 */
+	public function setFormConfig($form_config)
+	{
+		if (
+			! in_array(
+				$form_config,
+				array(
+				FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+				FormHandler::ADD_FORM_TAGS_ONLY,
+				FormHandler::ADD_FORM_SUBMIT_ONLY,
+				FormHandler::DO_NOT_SETUP_FORM,
+				),
+				true
+			)
+		) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
+						'event_espresso'
+					),
+					$form_config
+				)
+			);
+		}
+		$this->form_config = $form_config;
+	}
+
+
+	/**
+	 * called after the form is instantiated
+	 * and used for performing any logic that needs to occur early
+	 * before any of the other methods are called.
+	 * returns true if everything is ok to proceed,
+	 * and false if no further form logic should be implemented
+	 *
+	 * @return boolean
+	 */
+	public function initialize()
+	{
+		$this->form_has_errors = EE_Error::has_error(true);
+		return true;
+	}
+
+
+	/**
+	 * used for setting up css and js
+	 *
+	 * @return void
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function enqueueStylesAndScripts()
+	{
+		$this->form()->enqueue_js();
+	}
+
+
+	/**
+	 * creates and returns the actual form
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	abstract public function generate();
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Submit"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateSubmitButton($text = '')
+	{
+		$text = ! empty($text) ? $text : $this->submitBtnText();
+		return new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(),
+				'html_id'               => 'ee-form-submit-' . $this->slug(),
+				'html_class'            => 'ee-form-submit',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => $text,
+			)
+		);
+	}
+
+
+	/**
+	 * calls generateSubmitButton() and appends it onto the form along with a float clearing div
+	 *
+	 * @param string $text
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function appendSubmitButton($text = '')
+	{
+		if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+			return;
+		}
+		$this->form->add_subsections(
+			array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+			null,
+			false
+		);
+	}
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Cancel"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateCancelButton($text = '')
+	{
+		$cancel_button = new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
+				'html_id'               => 'ee-cancel-form-' . $this->slug(),
+				'html_class'            => 'ee-cancel-form',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
+			)
+		);
+		$cancel_button->set_button_css_attributes(false);
+		return $cancel_button;
+	}
+
+
+	/**
+	 * appends a float clearing div onto end of form
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function clearFormButtonFloats()
+	{
+		$this->form->add_subsections(
+			array(
+				'clear-submit-btn-float' => new EE_Form_Section_HTML(
+					EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+				),
+			),
+			null,
+			false
+		);
+	}
+
+
+	/**
+	 * takes the generated form and displays it along with ony other non-form HTML that may be required
+	 * returns a string of HTML that can be directly echoed in a template
+	 *
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function display()
+	{
+		$form_html = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
+			''
+		);
+		$form_config = $this->formConfig();
+		if (
+			$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$additional_props = $this->requiresMultipartEnctype()
+				? ' enctype="multipart/form-data"'
+				: '';
+			$form_html .= $this->form()->form_open(
+				$this->formAction(),
+				'POST',
+				$additional_props
+			);
+		}
+		$form_html .= $this->form(true)->get_html();
+		if (
+			$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$form_html .= $this->form()->form_close();
+		}
+		$form_html .= apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
+			''
+		);
+		return $form_html;
+	}
+
+	/**
+	 * Determines if this form needs "enctype='multipart/form-data'" or not.
+	 * @since 4.9.80.p
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function requiresMultipartEnctype()
+	{
+		foreach ($this->form()->inputs_in_subsections() as $input) {
+			if ($input instanceof EE_File_Input) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * handles processing the form submission
+	 * returns true or false depending on whether the form was processed successfully or not
+	 *
+	 * @param array $submitted_form_data
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws LogicException
+	 * @throws InvalidFormSubmissionException
+	 */
+	public function process($submitted_form_data = array())
+	{
+		if (! $this->form()->was_submitted($submitted_form_data)) {
+			throw new InvalidFormSubmissionException($this->form_name);
+		}
+		$this->form(true)->receive_form_submission($submitted_form_data);
+		if (! $this->form()->is_valid()) {
+			throw new InvalidFormSubmissionException(
+				$this->form_name,
+				sprintf(
+					esc_html__(
+						'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
+						'event_espresso'
+					),
+					$this->form_name,
+					'<br />',
+					implode('<br />', $this->form()->get_validation_errors_accumulated())
+				)
+			);
+		}
+		return (array) apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__process__valid_data',
+			$this->form()->valid_data(),
+			$this
+		);
+	}
 }

core/libraries/form_sections/form_handlers/SequentialStepForm.php

Spacing +3 added lines, -3 removed lines

@@ -113,7 +113,7 @@ 
     public function setOrder($order)
     {
         $order = absint($order);
-        if (! $order > 0) {
+        if ( ! $order > 0) {
             throw new InvalidArgumentException(
                 esc_html__('The form order property must be a positive integer.', 'event_espresso')
             );
@@ -142,7 +142,7 @@ 
      */
     public function setRedirectUrl($redirect_url)
     {
-        if (! is_string($redirect_url)) {
+        if ( ! is_string($redirect_url)) {
             throw new InvalidDataTypeException('$redirect_url', $redirect_url, 'string');
         }
         if (empty($redirect_url)) {
@@ -199,7 +199,7 @@ 
             );
         }
         foreach ($redirect_arg_keys_to_remove as $redirect_arg_key) {
-            unset($this->redirect_args[ $redirect_arg_key ]);
+            unset($this->redirect_args[$redirect_arg_key]);
         }
     }
 

Indentation +221 added lines, -221 removed lines

@@ -18,227 +18,227 @@
  */
 abstract class SequentialStepForm extends FormHandler implements SequentialStepFormInterface
 {
-    const REDIRECT_TO_NEXT_STEP    = 'redirect_to_next_step';
-
-    const REDIRECT_TO_CURRENT_STEP = 'redirect_to_current_step';
-
-    const REDIRECT_TO_PREV_STEP    = 'redirect_to_prev_step';
-
-    const REDIRECT_TO_OTHER        = 'redirect_to_other';
-
-    /**
-     * numerical value used for sorting form steps
-     *
-     * @var int $order
-     */
-    private $order = 1;
-
-    /**
-     * a final URL with all form related parameters added
-     * that will be used to advance to the next step
-     *
-     * @var string $redirect_url
-     */
-    private $redirect_url = '';
-
-    /**
-     * URL params in key value pairs
-     *
-     * @var array $redirect_args
-     */
-    private $redirect_args = array();
-
-    /**
-     * Which step should be redirected to after form processing.
-     * Usually after successfully processing this value would be REDIRECT_TO_NEXT_STEP
-     * If a form is invalid and requires errors to be corrected,
-     * then this value would be REDIRECT_TO_CURRENT_STEP so that form can be resubmitted
-     * Some form handlers do not have a form that is displayable,
-     * and only perform data processing, but if an error occurs,
-     * then this value needs to be set to REDIRECT_TO_PREV_STEP
-     * since the current step has no displayable content.
-     * if the form is completely finished, and needs to redirect to somewhere
-     * completely different, then this value will be REDIRECT_TO_OTHER
-     *
-     * @var string $redirect_to
-     */
-    private $redirect_to = SequentialStepForm::REDIRECT_TO_CURRENT_STEP;
-
-
-    /**
-     * SequentialStepForm constructor
-     *
-     * @param int         $order
-     * @param string      $form_name
-     * @param string      $admin_name
-     * @param string      $slug
-     * @param string      $form_action
-     * @param string      $form_config
-     * @param EE_Registry|null $registry
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     */
-    public function __construct(
-        $order,
-        $form_name,
-        $admin_name,
-        $slug,
-        $form_action = '',
-        $form_config = 'add_form_tags_and_submit',
-        ?EE_Registry $registry = null
-    ) {
-        $this->setOrder($order);
-        parent::__construct($form_name, $admin_name, $slug, $form_action, $form_config, $registry);
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function order()
-    {
-        return $this->order;
-    }
-
-
-
-    /**
-     * @param int $order
-     * @throws InvalidArgumentException
-     */
-    public function setOrder($order)
-    {
-        $order = absint($order);
-        if (! $order > 0) {
-            throw new InvalidArgumentException(
-                esc_html__('The form order property must be a positive integer.', 'event_espresso')
-            );
-        }
-        $this->order = $order;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function redirectUrl()
-    {
-        return ! empty($this->redirect_args)
-            ? add_query_arg($this->redirect_args, $this->redirect_url)
-            : $this->redirect_url;
-    }
-
-
-
-    /**
-     * @param string $redirect_url
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function setRedirectUrl($redirect_url)
-    {
-        if (! is_string($redirect_url)) {
-            throw new InvalidDataTypeException('$redirect_url', $redirect_url, 'string');
-        }
-        if (empty($redirect_url)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect URL can not be an empty string.', 'event_espresso')
-            );
-        }
-        $this->redirect_url = $redirect_url;
-    }
-
-
-
-    /**
-     * @param array $redirect_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function addRedirectArgs($redirect_args = array())
-    {
-        if (is_object($redirect_args)) {
-            throw new InvalidDataTypeException(
-                '$redirect_args',
-                $redirect_args,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($redirect_args)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect argument can not be an empty array.', 'event_espresso')
-            );
-        }
-        $this->redirect_args = array_merge($this->redirect_args, (array) $redirect_args);
-    }
-
-
-
-    /**
-     * @param array $redirect_arg_keys_to_remove
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function removeRedirectArgs($redirect_arg_keys_to_remove = array())
-    {
-        if (is_object($redirect_arg_keys_to_remove)) {
-            throw new InvalidDataTypeException(
-                '$redirect_arg_keys_to_remove',
-                $redirect_arg_keys_to_remove,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($redirect_arg_keys_to_remove)) {
-            throw new InvalidArgumentException(
-                esc_html__('The $redirect_arg_keys_to_remove argument can not be an empty array.', 'event_espresso')
-            );
-        }
-        foreach ($redirect_arg_keys_to_remove as $redirect_arg_key) {
-            unset($this->redirect_args[ $redirect_arg_key ]);
-        }
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function redirectTo()
-    {
-        return $this->redirect_to;
-    }
-
-
-
-    /**
-     * @param string $redirect_to
-     * @throws InvalidDataTypeException
-     */
-    public function setRedirectTo($redirect_to)
-    {
-        if (
-            ! in_array(
-                $redirect_to,
-                array(
-                    SequentialStepForm::REDIRECT_TO_NEXT_STEP,
-                    SequentialStepForm::REDIRECT_TO_CURRENT_STEP,
-                    SequentialStepForm::REDIRECT_TO_PREV_STEP,
-                    SequentialStepForm::REDIRECT_TO_OTHER,
-                ),
-                true
-            )
-        ) {
-            throw new InvalidDataTypeException(
-                'setRedirectTo()',
-                $redirect_to,
-                'one of the SequentialStepForm class constants was expected.'
-            );
-        }
-        $this->redirect_to = $redirect_to;
-    }
+	const REDIRECT_TO_NEXT_STEP    = 'redirect_to_next_step';
+
+	const REDIRECT_TO_CURRENT_STEP = 'redirect_to_current_step';
+
+	const REDIRECT_TO_PREV_STEP    = 'redirect_to_prev_step';
+
+	const REDIRECT_TO_OTHER        = 'redirect_to_other';
+
+	/**
+	 * numerical value used for sorting form steps
+	 *
+	 * @var int $order
+	 */
+	private $order = 1;
+
+	/**
+	 * a final URL with all form related parameters added
+	 * that will be used to advance to the next step
+	 *
+	 * @var string $redirect_url
+	 */
+	private $redirect_url = '';
+
+	/**
+	 * URL params in key value pairs
+	 *
+	 * @var array $redirect_args
+	 */
+	private $redirect_args = array();
+
+	/**
+	 * Which step should be redirected to after form processing.
+	 * Usually after successfully processing this value would be REDIRECT_TO_NEXT_STEP
+	 * If a form is invalid and requires errors to be corrected,
+	 * then this value would be REDIRECT_TO_CURRENT_STEP so that form can be resubmitted
+	 * Some form handlers do not have a form that is displayable,
+	 * and only perform data processing, but if an error occurs,
+	 * then this value needs to be set to REDIRECT_TO_PREV_STEP
+	 * since the current step has no displayable content.
+	 * if the form is completely finished, and needs to redirect to somewhere
+	 * completely different, then this value will be REDIRECT_TO_OTHER
+	 *
+	 * @var string $redirect_to
+	 */
+	private $redirect_to = SequentialStepForm::REDIRECT_TO_CURRENT_STEP;
+
+
+	/**
+	 * SequentialStepForm constructor
+	 *
+	 * @param int         $order
+	 * @param string      $form_name
+	 * @param string      $admin_name
+	 * @param string      $slug
+	 * @param string      $form_action
+	 * @param string      $form_config
+	 * @param EE_Registry|null $registry
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 */
+	public function __construct(
+		$order,
+		$form_name,
+		$admin_name,
+		$slug,
+		$form_action = '',
+		$form_config = 'add_form_tags_and_submit',
+		?EE_Registry $registry = null
+	) {
+		$this->setOrder($order);
+		parent::__construct($form_name, $admin_name, $slug, $form_action, $form_config, $registry);
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->order;
+	}
+
+
+
+	/**
+	 * @param int $order
+	 * @throws InvalidArgumentException
+	 */
+	public function setOrder($order)
+	{
+		$order = absint($order);
+		if (! $order > 0) {
+			throw new InvalidArgumentException(
+				esc_html__('The form order property must be a positive integer.', 'event_espresso')
+			);
+		}
+		$this->order = $order;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function redirectUrl()
+	{
+		return ! empty($this->redirect_args)
+			? add_query_arg($this->redirect_args, $this->redirect_url)
+			: $this->redirect_url;
+	}
+
+
+
+	/**
+	 * @param string $redirect_url
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function setRedirectUrl($redirect_url)
+	{
+		if (! is_string($redirect_url)) {
+			throw new InvalidDataTypeException('$redirect_url', $redirect_url, 'string');
+		}
+		if (empty($redirect_url)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect URL can not be an empty string.', 'event_espresso')
+			);
+		}
+		$this->redirect_url = $redirect_url;
+	}
+
+
+
+	/**
+	 * @param array $redirect_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function addRedirectArgs($redirect_args = array())
+	{
+		if (is_object($redirect_args)) {
+			throw new InvalidDataTypeException(
+				'$redirect_args',
+				$redirect_args,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($redirect_args)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect argument can not be an empty array.', 'event_espresso')
+			);
+		}
+		$this->redirect_args = array_merge($this->redirect_args, (array) $redirect_args);
+	}
+
+
+
+	/**
+	 * @param array $redirect_arg_keys_to_remove
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function removeRedirectArgs($redirect_arg_keys_to_remove = array())
+	{
+		if (is_object($redirect_arg_keys_to_remove)) {
+			throw new InvalidDataTypeException(
+				'$redirect_arg_keys_to_remove',
+				$redirect_arg_keys_to_remove,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($redirect_arg_keys_to_remove)) {
+			throw new InvalidArgumentException(
+				esc_html__('The $redirect_arg_keys_to_remove argument can not be an empty array.', 'event_espresso')
+			);
+		}
+		foreach ($redirect_arg_keys_to_remove as $redirect_arg_key) {
+			unset($this->redirect_args[ $redirect_arg_key ]);
+		}
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function redirectTo()
+	{
+		return $this->redirect_to;
+	}
+
+
+
+	/**
+	 * @param string $redirect_to
+	 * @throws InvalidDataTypeException
+	 */
+	public function setRedirectTo($redirect_to)
+	{
+		if (
+			! in_array(
+				$redirect_to,
+				array(
+					SequentialStepForm::REDIRECT_TO_NEXT_STEP,
+					SequentialStepForm::REDIRECT_TO_CURRENT_STEP,
+					SequentialStepForm::REDIRECT_TO_PREV_STEP,
+					SequentialStepForm::REDIRECT_TO_OTHER,
+				),
+				true
+			)
+		) {
+			throw new InvalidDataTypeException(
+				'setRedirectTo()',
+				$redirect_to,
+				'one of the SequentialStepForm class constants was expected.'
+			);
+		}
+		$this->redirect_to = $redirect_to;
+	}
 }
 // End of file SequentialStepForm.php
 // Location: /SequentialStepForm.php

core/db_models/EEM_Ticket_Price.model.php

Spacing +4 added lines, -4 removed lines

@@ -42,11 +42,11 @@
             'Price' => new EE_Belongs_To_Relation()
         );
         $this->_model_chain_to_wp_user = 'Ticket';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
         // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
         // follow the caps of the ticket
         $this->_caps_slug = 'tickets';
         parent::__construct($timezone);

Indentation +37 added lines, -37 removed lines

@@ -11,43 +11,43 @@
  */
 class EEM_Ticket_Price extends EEM_Base
 {
-    // private instance of the EEM_Ticket_Price object
-    protected static $_instance = null;
+	// private instance of the EEM_Ticket_Price object
+	protected static $_instance = null;
 
-    /**
-     *      private constructor to prevent direct creation
-     *      @Constructor
-     *      @access protected
-     *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     *      @return void
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = esc_html__('Ticket Price', 'event_espresso');
-        $this->plural_item = esc_html__('Ticket Prices', 'event_espresso');
+	/**
+	 *      private constructor to prevent direct creation
+	 *      @Constructor
+	 *      @access protected
+	 *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 *      @return void
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = esc_html__('Ticket Price', 'event_espresso');
+		$this->plural_item = esc_html__('Ticket Prices', 'event_espresso');
 
-        $this->_tables = array(
-            'Ticket_Price' => new EE_Primary_Table('esp_ticket_price', 'TKP_ID')
-        );
-        $this->_fields = array(
-            'Ticket_Price' => array(
-                'TKP_ID' => new EE_Primary_Key_Int_Field('TKP_ID', 'Ticket Price ID'),
-                'TKT_ID' => new EE_Foreign_Key_Int_Field('TKT_ID', 'Ticket Id', false, 0, 'Ticket'),
-                'PRC_ID' => new EE_Foreign_Key_Int_Field('PRC_ID', 'Price ID', false, 0, 'Price'),
-            )
-        );
-        $this->_model_relations = array(
-            'Ticket' => new EE_Belongs_To_Relation(),
-            'Price' => new EE_Belongs_To_Relation()
-        );
-        $this->_model_chain_to_wp_user = 'Ticket';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        // follow the caps of the ticket
-        $this->_caps_slug = 'tickets';
-        parent::__construct($timezone);
-    }
+		$this->_tables = array(
+			'Ticket_Price' => new EE_Primary_Table('esp_ticket_price', 'TKP_ID')
+		);
+		$this->_fields = array(
+			'Ticket_Price' => array(
+				'TKP_ID' => new EE_Primary_Key_Int_Field('TKP_ID', 'Ticket Price ID'),
+				'TKT_ID' => new EE_Foreign_Key_Int_Field('TKT_ID', 'Ticket Id', false, 0, 'Ticket'),
+				'PRC_ID' => new EE_Foreign_Key_Int_Field('PRC_ID', 'Price ID', false, 0, 'Price'),
+			)
+		);
+		$this->_model_relations = array(
+			'Ticket' => new EE_Belongs_To_Relation(),
+			'Price' => new EE_Belongs_To_Relation()
+		);
+		$this->_model_chain_to_wp_user = 'Ticket';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		// follow the caps of the ticket
+		$this->_caps_slug = 'tickets';
+		parent::__construct($timezone);
+	}
 }