eventespresso / event-espresso-core

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

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 	 * Checks if that value is the one selected
 	 *
 	 * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
-	 * @return string
+	 * @return boolean
 	 */
 	protected function _check_if_option_selected($option_value ){
 		return $option_value === $this->_input->raw_value();

Indentation +11 added lines, -11 removed lines

@@ -38,15 +38,15 @@ 
 		if ( EEH_Array::is_multi_dimensional_array( $this->_input->options() )) {
 			EEH_HTML::indent( 1, 'optgroup' );
 			foreach( $this->_input->options() as $opt_group_label => $opt_group ){
-			    if ( ! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
-                }
+				if ( ! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+				}
 				EEH_HTML::indent( 1, 'option' );
 				$html .= $this->_display_options( $opt_group );
 				EEH_HTML::indent( -1, 'option' );
-                if ( ! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl( 0, 'optgroup' ) . '</optgroup>';
-			    }
+				if ( ! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl( 0, 'optgroup' ) . '</optgroup>';
+				}
 			}
 			EEH_HTML::indent( -1, 'optgroup' );
 		} else {
@@ -68,11 +68,11 @@ 
 		$html = '';
 		EEH_HTML::indent( 1, 'option' );
 		foreach( $options as $value => $display_text ){
-		    //even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
-            //PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
-            $unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one( $value );
-            $selected = $this->_check_if_option_selected($unnormalized_value ) ? ' selected="selected"' : '';
-            $html.= EEH_HTML::nl( 0, 'option' ) . '<option value="' . esc_attr($unnormalized_value ) . '"' . $selected . '>' . $display_text . '</option>';
+			//even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
+			//PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
+			$unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one( $value );
+			$selected = $this->_check_if_option_selected($unnormalized_value ) ? ' selected="selected"' : '';
+			$html.= EEH_HTML::nl( 0, 'option' ) . '<option value="' . esc_attr($unnormalized_value ) . '"' . $selected . '>' . $display_text . '</option>';
 		}
 		EEH_HTML::indent( -1, 'option' );
 		return $html;

Spacing +27 added lines, -27 removed lines

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

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

Indentation +315 added lines, -315 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,320 +16,320 @@ 
 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 = '')
-    {
-        // 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';
-        } else if ($this->_label_size < 6) {
-            $size = ' micro-lbl';
-        } else if ($this->_label_size < 12) {
-            $size = ' tiny-lbl';
-        } else if ($this->_label_size < 25) {
-            $size = ' small-lbl';
-        } else if ($this->_label_size < 50) {
-            $size = ' medium-lbl';
-        } else if ($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 = '')
+	{
+		// 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';
+		} else if ($this->_label_size < 6) {
+			$size = ' micro-lbl';
+		} else if ($this->_label_size < 12) {
+			$size = ' tiny-lbl';
+		} else if ($this->_label_size < 25) {
+			$size = ' small-lbl';
+		} else if ($this->_label_size < 50) {
+			$size = ' medium-lbl';
+		} else if ($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);
+	}
 
 
 

Spacing +7 added lines, -7 removed lines

@@ -119,12 +119,12 @@ 
             $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)
+                    if ( ! is_array($value)
                         && ! is_int($key)
                        && $key !== ''
-                       && $key !== null){
+                       && $key !== null) {
                         $all_ints = false;
                     }
                 }
@@ -178,7 +178,7 @@ 
         $flat_array = array();
         if (EEH_Array::is_multi_dimensional_array($arr)) {
             foreach ($arr as $sub_array) {
-                foreach ((array)$sub_array as $key => $value) {
+                foreach ((array) $sub_array as $key => $value) {
                     $flat_array[$key] = $value;
                     $this->_set_label_size($value);
                 }
@@ -206,14 +206,14 @@ 
                 $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;
                 // if both value and desc are not empty, then separate with a dash
                 if ( ! empty($value) && ! empty($desc)) {
-                    $flat_array[$value] .= ' - ' . $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;
@@ -301,7 +301,7 @@ 
             $unnormalized_value_choices = array($unnormalized_value_choices);
         }
         $pretty_strings = array();
-        foreach ((array)$unnormalized_value_choices as $unnormalized_value_choice) {
+        foreach ((array) $unnormalized_value_choices as $unnormalized_value_choice) {
             if (isset($options[$unnormalized_value_choice])) {
                 $pretty_strings[] = $options[$unnormalized_value_choice];
             } else {

admin_pages/support/Support_Admin_Page.core.php

Indentation +234 added lines, -234 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -19,263 +19,263 @@ 
 
 
 
-    protected function _init_page_props()
-    {
-        $this->page_slug = EE_SUPPORT_PG_SLUG;
-        $this->page_label = esc_html__('Help & Support', 'event_espresso');
-        $this->_admin_base_url = EE_SUPPORT_ADMIN_URL;
-        $this->_admin_base_path = EE_SUPPORT_ADMIN;
-    }
+	protected function _init_page_props()
+	{
+		$this->page_slug = EE_SUPPORT_PG_SLUG;
+		$this->page_label = esc_html__('Help & Support', 'event_espresso');
+		$this->_admin_base_url = EE_SUPPORT_ADMIN_URL;
+		$this->_admin_base_path = EE_SUPPORT_ADMIN;
+	}
 
 
 
-    protected function _ajax_hooks()
-    {
-    }
+	protected function _ajax_hooks()
+	{
+	}
 
 
 
-    protected function _define_page_props()
-    {
-        $this->_labels = array();
-        $this->_admin_page_title = $this->page_label;
-    }
+	protected function _define_page_props()
+	{
+		$this->_labels = array();
+		$this->_admin_page_title = $this->page_label;
+	}
 
 
 
-    protected function _set_page_routes()
-    {
-        $this->_page_routes = array(
-            'default'    => array(
-                'func'       => '_contact_support',
-                'capability' => 'ee_read_ee',
-            ),
-            'developers' => array(
-                'func'       => '_developers',
-                'capability' => 'ee_read_ee',
-            ),
-            'shortcodes' => array(
-                'func'       => '_shortcodes',
-                'capability' => 'ee_read_ee',
-            ),
-        );
-    }
+	protected function _set_page_routes()
+	{
+		$this->_page_routes = array(
+			'default'    => array(
+				'func'       => '_contact_support',
+				'capability' => 'ee_read_ee',
+			),
+			'developers' => array(
+				'func'       => '_developers',
+				'capability' => 'ee_read_ee',
+			),
+			'shortcodes' => array(
+				'func'       => '_shortcodes',
+				'capability' => 'ee_read_ee',
+			),
+		);
+	}
 
 
 
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'    => array(
-                'nav'           => array(
-                    'label' => esc_html__('Support', 'event_espresso'),
-                    'order' => 30,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_support_boxes')),
-                'require_nonce' => false,
-            ),
-            'developers' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Developers', 'event_espresso'),
-                    'order' => 50,
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ),
-            'shortcodes' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Shortcodes', 'event_espresso'),
-                    'order' => 60,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_shortcodes_boxes')),
-                'require_nonce' => false,
-            ),
-        );
-    }
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'    => array(
+				'nav'           => array(
+					'label' => esc_html__('Support', 'event_espresso'),
+					'order' => 30,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_support_boxes')),
+				'require_nonce' => false,
+			),
+			'developers' => array(
+				'nav'           => array(
+					'label' => esc_html__('Developers', 'event_espresso'),
+					'order' => 50,
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			),
+			'shortcodes' => array(
+				'nav'           => array(
+					'label' => esc_html__('Shortcodes', 'event_espresso'),
+					'order' => 60,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_shortcodes_boxes')),
+				'require_nonce' => false,
+			),
+		);
+	}
 
 
 
-    //none of the below group are currently used for Support pages
-    protected function _add_screen_options()
-    {
-    }
-
+	//none of the below group are currently used for Support pages
+	protected function _add_screen_options()
+	{
+	}
+
 
 
-    protected function _add_feature_pointers()
-    {
-    }
+	protected function _add_feature_pointers()
+	{
+	}
 
 
 
-    public function admin_init()
-    {
-    }
+	public function admin_init()
+	{
+	}
 
 
 
-    public function admin_notices()
-    {
-    }
+	public function admin_notices()
+	{
+	}
 
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-
-    public function load_scripts_styles()
-    {
-    }
-
-
-
-    protected function _installation()
-    {
-        $template_path = EE_SUPPORT_ADMIN_TEMPLATE_PATH . 'support_admin_details_installation.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $template_path,
-            '',
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    protected function _resources()
-    {
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    protected function _add_settings_metabox($box, $label, array $args)
-    {
-        add_meta_box(
-            "espresso_{$box}_settings",
-            $label,
-            function ($post, $metabox) {
-                echo EEH_Template::display_template(
-                    $metabox['args']['template_path'],
-                    $metabox['args']['template_args'],
-                    true
-                );
-            },
-            $this->_current_screen->id,
-            'normal',
-            'high',
-            apply_filters(
-                "FHEE__Support_Admin_Page___add_settings_metabox__{$box}_args_array",
-                $args
-            )
-        );
-    }
-
-
-
-    protected function _resources_boxes()
-    {
-        $boxes = apply_filters(
-            'FHEE__Support_Admin_Page___resources_boxes__boxes_array',
-            array(
-                'favorite_theme_developers' => esc_html__('Favorite Theme Developers', 'event_espresso'),
-                'highly_recommended_themes' => esc_html__('Highly Recommended Themes', 'event_espresso'),
-                'hire_developer'            => esc_html__('Hire a Developer', 'event_espresso'),
-                'partners'                  => esc_html__('Partners', 'event_espresso'),
-                'recommended_plugins'       => esc_html__('Recommended Plugins', 'event_espresso'),
-                'other_resources'           => esc_html__('Other Resources', 'event_espresso'),
-            )
-        );
-        foreach ($boxes as $box => $label) {
-            $this->_add_settings_metabox(
-                $box,
-                $label,
-                array(
-                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
-                    'template_args' => $this->_template_args,
-                )
-            );
-        }
-    }
-
-
-
-    protected function _shortcodes()
-    {
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    protected function _shortcodes_boxes()
-    {
-        $boxes = apply_filters(
-            'FHEE__Support_Admin_Page___shortcodes_boxes__boxes_array',
-            array(
-                'shortcodes_event_listings'  => esc_html__('Event Listings', 'event_espresso'),
-                'shortcodes_ticket_selector' => esc_html__('Event Ticket Selector', 'event_espresso'),
-                'shortcodes_category'        => esc_html__('Event Categories', 'event_espresso'),
-                'shortcodes_attendee'        => esc_html__('Event Attendees', 'event_espresso')
-                /*'shortcodes_single_events' => esc_html__('Single Events', 'event_espresso'),*/
-                /*'shortcodes_attendee_listings' => esc_html__('Attendee Listings', 'event_espresso'),*/
-            )
-        );
-        foreach ($boxes as $box => $label) {
-            $this->_add_settings_metabox(
-                $box,
-                $label,
-                array(
-                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
-                    'template_args' => $this->_template_args,
-                )
-            );
-        }
-    }
-
-
-
-    protected function _contact_support()
-    {
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    protected function _support_boxes()
-    {
-        $boxes = apply_filters(
-            'FHEE__Support_Admin_Page___support_boxes__boxes_array',
-            array(
-                'contact_support'       => esc_html__('Contact Support', 'event_espresso'),
-                'important_information' => esc_html__('Important Information', 'event_espresso'),
-            )
-        );
-        foreach ($boxes as $box => $label) {
-            $this->_add_settings_metabox(
-                $box,
-                $label,
-                array(
-                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
-                    'template_args' => $this->_template_args,
-                )
-            );
-        }
-    }
-
-
-
-    protected function _developers()
-    {
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_SUPPORT_ADMIN_TEMPLATE_PATH . 'developers_admin_details.template.php',
-            array(),
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+
+	public function load_scripts_styles()
+	{
+	}
+
+
+
+	protected function _installation()
+	{
+		$template_path = EE_SUPPORT_ADMIN_TEMPLATE_PATH . 'support_admin_details_installation.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$template_path,
+			'',
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	protected function _resources()
+	{
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	protected function _add_settings_metabox($box, $label, array $args)
+	{
+		add_meta_box(
+			"espresso_{$box}_settings",
+			$label,
+			function ($post, $metabox) {
+				echo EEH_Template::display_template(
+					$metabox['args']['template_path'],
+					$metabox['args']['template_args'],
+					true
+				);
+			},
+			$this->_current_screen->id,
+			'normal',
+			'high',
+			apply_filters(
+				"FHEE__Support_Admin_Page___add_settings_metabox__{$box}_args_array",
+				$args
+			)
+		);
+	}
+
+
+
+	protected function _resources_boxes()
+	{
+		$boxes = apply_filters(
+			'FHEE__Support_Admin_Page___resources_boxes__boxes_array',
+			array(
+				'favorite_theme_developers' => esc_html__('Favorite Theme Developers', 'event_espresso'),
+				'highly_recommended_themes' => esc_html__('Highly Recommended Themes', 'event_espresso'),
+				'hire_developer'            => esc_html__('Hire a Developer', 'event_espresso'),
+				'partners'                  => esc_html__('Partners', 'event_espresso'),
+				'recommended_plugins'       => esc_html__('Recommended Plugins', 'event_espresso'),
+				'other_resources'           => esc_html__('Other Resources', 'event_espresso'),
+			)
+		);
+		foreach ($boxes as $box => $label) {
+			$this->_add_settings_metabox(
+				$box,
+				$label,
+				array(
+					'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
+					'template_args' => $this->_template_args,
+				)
+			);
+		}
+	}
+
+
+
+	protected function _shortcodes()
+	{
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	protected function _shortcodes_boxes()
+	{
+		$boxes = apply_filters(
+			'FHEE__Support_Admin_Page___shortcodes_boxes__boxes_array',
+			array(
+				'shortcodes_event_listings'  => esc_html__('Event Listings', 'event_espresso'),
+				'shortcodes_ticket_selector' => esc_html__('Event Ticket Selector', 'event_espresso'),
+				'shortcodes_category'        => esc_html__('Event Categories', 'event_espresso'),
+				'shortcodes_attendee'        => esc_html__('Event Attendees', 'event_espresso')
+				/*'shortcodes_single_events' => esc_html__('Single Events', 'event_espresso'),*/
+				/*'shortcodes_attendee_listings' => esc_html__('Attendee Listings', 'event_espresso'),*/
+			)
+		);
+		foreach ($boxes as $box => $label) {
+			$this->_add_settings_metabox(
+				$box,
+				$label,
+				array(
+					'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
+					'template_args' => $this->_template_args,
+				)
+			);
+		}
+	}
+
+
+
+	protected function _contact_support()
+	{
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	protected function _support_boxes()
+	{
+		$boxes = apply_filters(
+			'FHEE__Support_Admin_Page___support_boxes__boxes_array',
+			array(
+				'contact_support'       => esc_html__('Contact Support', 'event_espresso'),
+				'important_information' => esc_html__('Important Information', 'event_espresso'),
+			)
+		);
+		foreach ($boxes as $box => $label) {
+			$this->_add_settings_metabox(
+				$box,
+				$label,
+				array(
+					'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
+					'template_args' => $this->_template_args,
+				)
+			);
+		}
+	}
+
+
+
+	protected function _developers()
+	{
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EE_SUPPORT_ADMIN_TEMPLATE_PATH . 'developers_admin_details.template.php',
+			array(),
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
 
 
 

Spacing +7 added lines, -7 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -134,7 +134,7 @@ 
 
     protected function _installation()
     {
-        $template_path = EE_SUPPORT_ADMIN_TEMPLATE_PATH . 'support_admin_details_installation.template.php';
+        $template_path = EE_SUPPORT_ADMIN_TEMPLATE_PATH.'support_admin_details_installation.template.php';
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             $template_path,
             '',
@@ -157,7 +157,7 @@ 
         add_meta_box(
             "espresso_{$box}_settings",
             $label,
-            function ($post, $metabox) {
+            function($post, $metabox) {
                 echo EEH_Template::display_template(
                     $metabox['args']['template_path'],
                     $metabox['args']['template_args'],
@@ -194,7 +194,7 @@ 
                 $box,
                 $label,
                 array(
-                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
+                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH."support_admin_details_{$box}.template.php",
                     'template_args' => $this->_template_args,
                 )
             );
@@ -228,7 +228,7 @@ 
                 $box,
                 $label,
                 array(
-                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
+                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH."support_admin_details_{$box}.template.php",
                     'template_args' => $this->_template_args,
                 )
             );
@@ -258,7 +258,7 @@ 
                 $box,
                 $label,
                 array(
-                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
+                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH."support_admin_details_{$box}.template.php",
                     'template_args' => $this->_template_args,
                 )
             );
@@ -270,7 +270,7 @@ 
     protected function _developers()
     {
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_SUPPORT_ADMIN_TEMPLATE_PATH . 'developers_admin_details.template.php',
+            EE_SUPPORT_ADMIN_TEMPLATE_PATH.'developers_admin_details.template.php',
             array(),
             true
         );

core/libraries/form_sections/strategies/normalization/EE_Int_Normalization.strategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
 
     /**
      * @param string $value_to_normalize
-     * @return int|mixed|string
+     * @return null|integer
      * @throws \EE_Validation_Error
      */
     public function normalize($value_to_normalize)

Spacing +6 added lines, -6 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -34,9 +34,9 @@ 
             return null;
         }
         if (is_int($value_to_normalize) || is_float($value_to_normalize)) {
-            return (int)$value_to_normalize;
+            return (int) $value_to_normalize;
         }
-        if (! is_string($value_to_normalize)) {
+        if ( ! is_string($value_to_normalize)) {
             throw new EE_Validation_Error(
                 sprintf(
                     __('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'),
@@ -59,8 +59,8 @@ 
                 // if first match is the negative sign,
                 // then the number needs to be multiplied by -1 to remain negative
                 return $matches[1] === '-'
-                    ? (int)$matches[2] * -1
-                    : (int)$matches[2];
+                    ? (int) $matches[2] * -1
+                    : (int) $matches[2];
             }
         }
         //find if this input has a int validation strategy
@@ -73,7 +73,7 @@ 
         }
         //this really shouldn't ever happen because fields with a int normalization strategy
         //should also have a int validation strategy, but in case it doesn't use the default
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $default_validation_strategy = new EE_Int_Validation_Strategy();
             $validation_error_message = $default_validation_strategy->get_validation_error_message();
         }

Indentation +75 added lines, -75 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -15,89 +15,89 @@ 
 class EE_Int_Normalization extends EE_Normalization_Strategy_Base
 {
 
-    /*
+	/*
      * regex pattern that matches for the following:
      *      * optional negative sign
      *      * one or more digits
      */
-    const REGEX = '/^(-?)(\d+)(?:\.0+)?$/';
+	const REGEX = '/^(-?)(\d+)(?:\.0+)?$/';
 
 
 
-    /**
-     * @param string $value_to_normalize
-     * @return int|mixed|string
-     * @throws \EE_Validation_Error
-     */
-    public function normalize($value_to_normalize)
-    {
-        if ($value_to_normalize === null) {
-            return null;
-        }
-        if (is_int($value_to_normalize) || is_float($value_to_normalize)) {
-            return (int)$value_to_normalize;
-        }
-        if (! is_string($value_to_normalize)) {
-            throw new EE_Validation_Error(
-                sprintf(
-                    __('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'),
-                    print_r($value_to_normalize, true),
-                    gettype($value_to_normalize)
-                )
-            );
-        }
-        $value_to_normalize = filter_var(
-            $value_to_normalize,
-            FILTER_SANITIZE_NUMBER_FLOAT,
-            FILTER_FLAG_ALLOW_FRACTION
-        );
-        if ($value_to_normalize === '') {
-            return null;
-        }
-        $matches = array();
-        if (preg_match(EE_Int_Normalization::REGEX, $value_to_normalize, $matches)) {
-            if (count($matches) === 3) {
-                // if first match is the negative sign,
-                // then the number needs to be multiplied by -1 to remain negative
-                return $matches[1] === '-'
-                    ? (int)$matches[2] * -1
-                    : (int)$matches[2];
-            }
-        }
-        //find if this input has a int validation strategy
-        //in which case, use its message
-        $validation_error_message = null;
-        foreach ($this->_input->get_validation_strategies() as $validation_strategy) {
-            if ($validation_strategy instanceof EE_Int_Validation_Strategy) {
-                $validation_error_message = $validation_strategy->get_validation_error_message();
-            }
-        }
-        //this really shouldn't ever happen because fields with a int normalization strategy
-        //should also have a int validation strategy, but in case it doesn't use the default
-        if (! $validation_error_message) {
-            $default_validation_strategy = new EE_Int_Validation_Strategy();
-            $validation_error_message = $default_validation_strategy->get_validation_error_message();
-        }
-        throw new EE_Validation_Error($validation_error_message, 'numeric_only');
-    }
+	/**
+	 * @param string $value_to_normalize
+	 * @return int|mixed|string
+	 * @throws \EE_Validation_Error
+	 */
+	public function normalize($value_to_normalize)
+	{
+		if ($value_to_normalize === null) {
+			return null;
+		}
+		if (is_int($value_to_normalize) || is_float($value_to_normalize)) {
+			return (int)$value_to_normalize;
+		}
+		if (! is_string($value_to_normalize)) {
+			throw new EE_Validation_Error(
+				sprintf(
+					__('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'),
+					print_r($value_to_normalize, true),
+					gettype($value_to_normalize)
+				)
+			);
+		}
+		$value_to_normalize = filter_var(
+			$value_to_normalize,
+			FILTER_SANITIZE_NUMBER_FLOAT,
+			FILTER_FLAG_ALLOW_FRACTION
+		);
+		if ($value_to_normalize === '') {
+			return null;
+		}
+		$matches = array();
+		if (preg_match(EE_Int_Normalization::REGEX, $value_to_normalize, $matches)) {
+			if (count($matches) === 3) {
+				// if first match is the negative sign,
+				// then the number needs to be multiplied by -1 to remain negative
+				return $matches[1] === '-'
+					? (int)$matches[2] * -1
+					: (int)$matches[2];
+			}
+		}
+		//find if this input has a int validation strategy
+		//in which case, use its message
+		$validation_error_message = null;
+		foreach ($this->_input->get_validation_strategies() as $validation_strategy) {
+			if ($validation_strategy instanceof EE_Int_Validation_Strategy) {
+				$validation_error_message = $validation_strategy->get_validation_error_message();
+			}
+		}
+		//this really shouldn't ever happen because fields with a int normalization strategy
+		//should also have a int validation strategy, but in case it doesn't use the default
+		if (! $validation_error_message) {
+			$default_validation_strategy = new EE_Int_Validation_Strategy();
+			$validation_error_message = $default_validation_strategy->get_validation_error_message();
+		}
+		throw new EE_Validation_Error($validation_error_message, 'numeric_only');
+	}
 
 
 
-    /**
-     * Converts the int into a string for use in teh html form
-     *
-     * @param int $normalized_value
-     * @return string
-     */
-    public function unnormalize($normalized_value)
-    {
-        if ($normalized_value === null || $normalized_value === '') {
-            return '';
-        }
-        if (empty($normalized_value)) {
-            return '0';
-        }
-        return "$normalized_value";
-    }
+	/**
+	 * Converts the int into a string for use in teh html form
+	 *
+	 * @param int $normalized_value
+	 * @return string
+	 */
+	public function unnormalize($normalized_value)
+	{
+		if ($normalized_value === null || $normalized_value === '') {
+			return '';
+		}
+		if (empty($normalized_value)) {
+			return '0';
+		}
+		return "$normalized_value";
+	}
 }
 // End of file EE_Int_Normalization.strategy.php

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

Indentation +8 added lines, -8 removed lines

@@ -33,14 +33,14 @@
 	 * @return array
 	 */
 	function get_jquery_validation_rule_array(){
-        return array(
-            'number'=>true,
-            'step' => 1,
-            'messages' => array(
-                'number' => $this->get_validation_error_message(),
-                'step' => $this->get_validation_error_message()
-            )
-        );
+		return array(
+			'number'=>true,
+			'step' => 1,
+			'messages' => array(
+				'number' => $this->get_validation_error_message(),
+				'step' => $this->get_validation_error_message()
+			)
+		);
 	}
 }
 

Spacing +5 added lines, -5 removed lines

@@ -6,16 +6,16 @@ 
  * @subpackage	Expression package is undefined on line 19, column 19 in Templates/Scripting/PHPClass.php.
  * @author				Mike Nelson
  */
-class EE_Int_Validation_Strategy extends EE_Validation_Strategy_Base{
+class EE_Int_Validation_Strategy extends EE_Validation_Strategy_Base {
 
 	/**
 	 * @param null $validation_error_message
 	 */
-	public function __construct( $validation_error_message = NULL ) {
-		if( ! $validation_error_message ){
+	public function __construct($validation_error_message = NULL) {
+		if ( ! $validation_error_message) {
 			$validation_error_message = __("Only digits are allowed.", "event_espresso");
 		}
-		parent::__construct( $validation_error_message );
+		parent::__construct($validation_error_message);
 	}
 
 
@@ -32,7 +32,7 @@ 
 	/**
 	 * @return array
 	 */
-	function get_jquery_validation_rule_array(){
+	function get_jquery_validation_rule_array() {
         return array(
             'number'=>true,
             'step' => 1,

core/helpers/EEH_Money.helper.php

Indentation +88 added lines, -88 removed lines

@@ -8,62 +8,62 @@ 
  */
 if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
  /**
- *
- * Money helper class.
- * This class has helper methods that help with money related conversions and calculations.
- *
- * @since %VER%
- *
- * @package		Event Espresso
- * @subpackage	helpers
- * @author		Darren Ethier
- *
- * ------------------------------------------------------------------------
- */
+  *
+  * Money helper class.
+  * This class has helper methods that help with money related conversions and calculations.
+  *
+  * @since %VER%
+  *
+  * @package		Event Espresso
+  * @subpackage	helpers
+  * @author		Darren Ethier
+  *
+  * ------------------------------------------------------------------------
+  */
 class EEH_Money extends EEH_Base  {
 
 
-    /**
-     * This removes all localized money formatting from the incoming value
-     *
-     * @param int|float|string $money_value
-     * @param string           $CNT_ISO
-     * @return float
-     * @throws EE_Error
-     */
+	/**
+	 * This removes all localized money formatting from the incoming value
+	 *
+	 * @param int|float|string $money_value
+	 * @param string           $CNT_ISO
+	 * @return float
+	 * @throws EE_Error
+	 */
 	public static function strip_localized_money_formatting($money_value, $CNT_ISO = '') {
-        $currency_config = EEH_Money::get_currency_config($CNT_ISO);
-        $money_value = str_replace(
-		    array(
-                $currency_config->thsnds,
-                $currency_config->dec_mrk,
-            ),
-            array(
-                '', // remove thousands separator
-                '.', // convert decimal mark to what PHP expects
-            ),
-            $money_value
-        );
-        $money_value = filter_var(
-            $money_value,
-            FILTER_SANITIZE_NUMBER_FLOAT,
-            FILTER_FLAG_ALLOW_FRACTION
-        );
-        return $money_value;
-    }
-
-
-
-    /**
-     * This converts an incoming localized money value into a standard float item (to three decimal places)
-     *
-     * @param int|string $money_value
-     * @return float
-     * @throws EE_Error
-     */
+		$currency_config = EEH_Money::get_currency_config($CNT_ISO);
+		$money_value = str_replace(
+			array(
+				$currency_config->thsnds,
+				$currency_config->dec_mrk,
+			),
+			array(
+				'', // remove thousands separator
+				'.', // convert decimal mark to what PHP expects
+			),
+			$money_value
+		);
+		$money_value = filter_var(
+			$money_value,
+			FILTER_SANITIZE_NUMBER_FLOAT,
+			FILTER_FLAG_ALLOW_FRACTION
+		);
+		return $money_value;
+	}
+
+
+
+	/**
+	 * This converts an incoming localized money value into a standard float item (to three decimal places)
+	 *
+	 * @param int|string $money_value
+	 * @return float
+	 * @throws EE_Error
+	 */
 	public static function convert_to_float_from_localized_money($money_value ) {
 		//float it! and round to three decimal places
-        return round ( (float) EEH_Money::strip_localized_money_formatting($money_value), 3 );
+		return round ( (float) EEH_Money::strip_localized_money_formatting($money_value), 3 );
 	}
 
 
@@ -151,19 +151,19 @@ 
 
 
 
-    /**
-     * This returns a localized format string suitable for jQplot.
-     *
-     * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
-     *                         Otherwise will use currency settings for current active country on site.
-     * @return string
-     * @throws EE_Error
-     */
+	/**
+	 * This returns a localized format string suitable for jQplot.
+	 *
+	 * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
+	 *                         Otherwise will use currency settings for current active country on site.
+	 * @return string
+	 * @throws EE_Error
+	 */
 	public static function get_format_for_jqplot( $CNT_ISO = '') {
 		//default format
 		$format = 'f';
 		$currency_config = $currency_config = EEH_Money::get_currency_config($CNT_ISO);
-        //first get the decimal place and number of places
+		//first get the decimal place and number of places
 		$format = "%'." . $currency_config->dec_plc . $format;
 		//currency symbol on right side.
 		$format = $currency_config->sign_b4 ? $currency_config->sign . $format : $format . $currency_config->sign;
@@ -172,16 +172,16 @@ 
 
 
 
-    /**
-     * This returns a localized format string suitable for usage with the Google Charts API format param.
-     *
-     * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
-     *                         Otherwise will use currency settings for current active country on site.
-     *                         Note: GoogleCharts uses ICU pattern set
-     *                         (@see http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
-     * @return string
-     * @throws EE_Error
-     */
+	/**
+	 * This returns a localized format string suitable for usage with the Google Charts API format param.
+	 *
+	 * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
+	 *                         Otherwise will use currency settings for current active country on site.
+	 *                         Note: GoogleCharts uses ICU pattern set
+	 *                         (@see http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
+	 * @return string
+	 * @throws EE_Error
+	 */
 	public static function get_format_for_google_charts( $CNT_ISO = '' ) {
 		$currency_config = EEH_Money::get_currency_config($CNT_ISO);
 		$decimal_places_placeholder = str_pad( '', $currency_config->dec_plc, '0' );
@@ -208,24 +208,24 @@ 
 
 
 
-    /**
-     * @param string $CNT_ISO
-     * @return EE_Currency_Config|null
-     * @throws EE_Error
-     */
-    public static function get_currency_config($CNT_ISO = '')
-    {
-        //if CNT_ISO passed lets try to get currency settings for it.
-        $currency_config = $CNT_ISO !== ''
-            ? new EE_Currency_Config($CNT_ISO)
-            : null;
-        //default currency settings for site if not set
-        if (! $currency_config instanceof EE_Currency_Config) {
-            $currency_config = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
-                ? EE_Registry::instance()->CFG->currency
-                : new EE_Currency_Config();
-        }
-        return $currency_config;
-    }
+	/**
+	 * @param string $CNT_ISO
+	 * @return EE_Currency_Config|null
+	 * @throws EE_Error
+	 */
+	public static function get_currency_config($CNT_ISO = '')
+	{
+		//if CNT_ISO passed lets try to get currency settings for it.
+		$currency_config = $CNT_ISO !== ''
+			? new EE_Currency_Config($CNT_ISO)
+			: null;
+		//default currency settings for site if not set
+		if (! $currency_config instanceof EE_Currency_Config) {
+			$currency_config = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
+				? EE_Registry::instance()->CFG->currency
+				: new EE_Currency_Config();
+		}
+		return $currency_config;
+	}
 
 } //end class EEH_Money

Spacing +16 added lines, -16 removed lines

@@ -20,7 +20,7 @@ 
  *
  * ------------------------------------------------------------------------
  */
-class EEH_Money extends EEH_Base  {
+class EEH_Money extends EEH_Base {
 
 
     /**
@@ -61,9 +61,9 @@ 
      * @return float
      * @throws EE_Error
      */
-	public static function convert_to_float_from_localized_money($money_value ) {
+	public static function convert_to_float_from_localized_money($money_value) {
 		//float it! and round to three decimal places
-        return round ( (float) EEH_Money::strip_localized_money_formatting($money_value), 3 );
+        return round((float) EEH_Money::strip_localized_money_formatting($money_value), 3);
 	}
 
 
@@ -82,12 +82,12 @@ 
 	 * @throws EE_Error
 	 */
 
-	public static function compare_floats( $float1, $float2, $operator='=' ) {
+	public static function compare_floats($float1, $float2, $operator = '=') {
 		// Check numbers to 5 digits of precision
 		$epsilon = 0.00001;
 
-		$float1 = (float)$float1;
-		$float2 = (float)$float2;
+		$float1 = (float) $float1;
+		$float2 = (float) $float2;
 
 		switch ($operator) {
 			// equal
@@ -143,7 +143,7 @@ 
 				}
 				break;
 			default:
-				throw new EE_Error(__( "Unknown operator '" . $operator . "' in EEH_Money::compare_floats()", 'event_espresso' ) );
+				throw new EE_Error(__("Unknown operator '".$operator."' in EEH_Money::compare_floats()", 'event_espresso'));
 		}
 
 		return false;
@@ -159,14 +159,14 @@ 
      * @return string
      * @throws EE_Error
      */
-	public static function get_format_for_jqplot( $CNT_ISO = '') {
+	public static function get_format_for_jqplot($CNT_ISO = '') {
 		//default format
 		$format = 'f';
 		$currency_config = $currency_config = EEH_Money::get_currency_config($CNT_ISO);
         //first get the decimal place and number of places
-		$format = "%'." . $currency_config->dec_plc . $format;
+		$format = "%'.".$currency_config->dec_plc.$format;
 		//currency symbol on right side.
-		$format = $currency_config->sign_b4 ? $currency_config->sign . $format : $format . $currency_config->sign;
+		$format = $currency_config->sign_b4 ? $currency_config->sign.$format : $format.$currency_config->sign;
 		return $format;
 	}
 
@@ -182,20 +182,20 @@ 
      * @return string
      * @throws EE_Error
      */
-	public static function get_format_for_google_charts( $CNT_ISO = '' ) {
+	public static function get_format_for_google_charts($CNT_ISO = '') {
 		$currency_config = EEH_Money::get_currency_config($CNT_ISO);
-		$decimal_places_placeholder = str_pad( '', $currency_config->dec_plc, '0' );
+		$decimal_places_placeholder = str_pad('', $currency_config->dec_plc, '0');
 		//first get the decimal place and number of places
-		$format = '#,##0.' . $decimal_places_placeholder;
+		$format = '#,##0.'.$decimal_places_placeholder;
 
 		//currency symbol on right side.
-		$format = $currency_config->sign_b4 ? $currency_config->sign . $format : $format . $currency_config->sign;
+		$format = $currency_config->sign_b4 ? $currency_config->sign.$format : $format.$currency_config->sign;
 		$formatterObject = array(
 			'decimalSymbol' => $currency_config->dec_mrk,
 			'groupingSymbol' => $currency_config->thsnds,
 			'fractionDigits' => $currency_config->dec_plc,
 		);
-		if ( $currency_config->sign_b4 ) {
+		if ($currency_config->sign_b4) {
 			$formatterObject['prefix'] = $currency_config->sign;
 		} else {
 			$formatterObject['suffix'] = $currency_config->sign;
@@ -220,7 +220,7 @@ 
             ? new EE_Currency_Config($CNT_ISO)
             : null;
         //default currency settings for site if not set
-        if (! $currency_config instanceof EE_Currency_Config) {
+        if ( ! $currency_config instanceof EE_Currency_Config) {
             $currency_config = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
                 ? EE_Registry::instance()->CFG->currency
                 : new EE_Currency_Config();

admin_pages/maintenance/Maintenance_Admin_Page.core.php

Indentation +616 added lines, -616 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -28,636 +28,636 @@ 
 {
 
 
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-    }
-
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug = EE_MAINTENANCE_PG_SLUG;
-        $this->page_label = EE_MAINTENANCE_LABEL;
-        $this->_admin_base_url = EE_MAINTENANCE_ADMIN_URL;
-        $this->_admin_base_path = EE_MAINTENANCE_ADMIN;
-    }
-
-
-
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_migration_step', array($this, 'migration_step'));
-        add_action('wp_ajax_add_error_to_migrations_ran', array($this, 'add_error_to_migrations_ran'));
-    }
-
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = EE_MAINTENANCE_LABEL;
-        $this->_labels = array(
-            'buttons' => array(
-                'reset_reservations' => esc_html__('Reset Ticket and Datetime Reserved Counts', 'event_espresso'),
-                'reset_capabilities' => esc_html__('Reset Event Espresso Capabilities', 'event_espresso'),
-            ),
-        );
-    }
-
-
-
-    protected function _set_page_routes()
-    {
-        $this->_page_routes = array(
-            'default'                             => array(
-                'func'       => '_maintenance',
-                'capability' => 'manage_options',
-            ),
-            'change_maintenance_level'            => array(
-                'func'       => '_change_maintenance_level',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'system_status'                       => array(
-                'func'       => '_system_status',
-                'capability' => 'manage_options',
-            ),
-            'download_system_status' => array(
-                'func'       => '_download_system_status',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'send_migration_crash_report'         => array(
-                'func'       => '_send_migration_crash_report',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'confirm_migration_crash_report_sent' => array(
-                'func'       => '_confirm_migration_crash_report_sent',
-                'capability' => 'manage_options',
-            ),
-            'data_reset'                          => array(
-                'func'       => '_data_reset_and_delete',
-                'capability' => 'manage_options',
-            ),
-            'reset_db'                            => array(
-                'func'       => '_reset_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-                'args'       => array('nuke_old_ee4_data' => true),
-            ),
-            'start_with_fresh_ee4_db'             => array(
-                'func'       => '_reset_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-                'args'       => array('nuke_old_ee4_data' => false),
-            ),
-            'delete_db'                           => array(
-                'func'       => '_delete_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'rerun_migration_from_ee3'            => array(
-                'func'       => '_rerun_migration_from_ee3',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'reset_reservations'                  => array(
-                'func'       => '_reset_reservations',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'reset_capabilities'                  => array(
-                'func'       => '_reset_capabilities',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'reattempt_migration'                 => array(
-                'func'       => '_reattempt_migration',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-        );
-    }
-
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'       => array(
-                'nav'           => array(
-                    'label' => esc_html__('Maintenance', 'event_espresso'),
-                    'order' => 10,
-                ),
-                'require_nonce' => false,
-            ),
-            'data_reset'    => array(
-                'nav'           => array(
-                    'label' => esc_html__('Reset/Delete Data', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'require_nonce' => false,
-            ),
-            'system_status' => array(
-                'nav'           => array(
-                    'label' => esc_html__("System Information", "event_espresso"),
-                    'order' => 30,
-                ),
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-
-    /**
-     * default maintenance page. If we're in maintenance mode level 2, then we need to show
-     * the migration scripts and all that UI.
-     */
-    public function _maintenance()
-    {
-        //it all depends if we're in maintenance model level 1 (frontend-only) or
-        //level 2 (everything except maintenance page)
-        try {
-            //get the current maintenance level and check if
-            //we are removed
-            $mm = EE_Maintenance_Mode::instance()->level();
-            $placed_in_mm = EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-            if ($mm == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) {
-                //we just took the site out of maintenance mode, so notify the user.
-                //unfortunately this message appears to be echoed on the NEXT page load...
-                //oh well, we should really be checking for this on addon deactivation anyways
-                EE_Error::add_attention(__('Site taken out of maintenance mode because no data migration scripts are required',
-                    'event_espresso'));
-                $this->_process_notices(array('page' => 'espresso_maintenance_settings'), false);
-            }
-            //in case an exception is thrown while trying to handle migrations
-            switch (EE_Maintenance_Mode::instance()->level()) {
-                case EE_Maintenance_Mode::level_0_not_in_maintenance:
-                case EE_Maintenance_Mode::level_1_frontend_only_maintenance:
-                    $show_maintenance_switch = true;
-                    $show_backup_db_text = false;
-                    $show_migration_progress = false;
-                    $script_names = array();
-                    $addons_should_be_upgraded_first = false;
-                    break;
-                case EE_Maintenance_Mode::level_2_complete_maintenance:
-                    $show_maintenance_switch = false;
-                    $show_migration_progress = true;
-                    if (isset($this->_req_data['continue_migration'])) {
-                        $show_backup_db_text = false;
-                    } else {
-                        $show_backup_db_text = true;
-                    }
-                    $scripts_needing_to_run = EE_Data_Migration_Manager::instance()
-                                                                       ->check_for_applicable_data_migration_scripts();
-                    $addons_should_be_upgraded_first = EE_Data_Migration_Manager::instance()->addons_need_updating();
-                    $script_names = array();
-                    $current_script = null;
-                    foreach ($scripts_needing_to_run as $script) {
-                        if ($script instanceof EE_Data_Migration_Script_Base) {
-                            if ( ! $current_script) {
-                                $current_script = $script;
-                                $current_script->migration_page_hooks();
-                            }
-                            $script_names[] = $script->pretty_name();
-                        }
-                    }
-                    break;
-            }
-            $most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
-            $exception_thrown = false;
-        } catch (EE_Error $e) {
-            EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
-            //now, just so we can display the page correctly, make a error migration script stage object
-            //and also put the error on it. It only persists for the duration of this request
-            $most_recent_migration = new EE_DMS_Unknown_1_0_0();
-            $most_recent_migration->add_error($e->getMessage());
-            $exception_thrown = true;
-        }
-        $current_db_state = EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set();
-        $current_db_state = str_replace('.decaf', '', $current_db_state);
-        if ($exception_thrown
-            || ($most_recent_migration
-                && $most_recent_migration instanceof EE_Data_Migration_Script_Base
-                && $most_recent_migration->is_broken()
-            )
-        ) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
-            $this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/';
-            $this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce(array('action'  => 'confirm_migration_crash_report_sent',
-                                                                                        'success' => '0',
-            ), EE_MAINTENANCE_ADMIN_URL);
-        } elseif ($addons_should_be_upgraded_first) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
-        } else {
-            if ($most_recent_migration
-                && $most_recent_migration instanceof EE_Data_Migration_Script_Base
-                && $most_recent_migration->can_continue()
-            ) {
-                $show_backup_db_text = false;
-                $show_continue_current_migration_script = true;
-                $show_most_recent_migration = true;
-            } elseif (isset($this->_req_data['continue_migration'])) {
-                $show_most_recent_migration = true;
-                $show_continue_current_migration_script = false;
-            } else {
-                $show_most_recent_migration = false;
-                $show_continue_current_migration_script = false;
-            }
-            if (isset($current_script)) {
-                $migrates_to = $current_script->migrates_to_version();
-                $plugin_slug = $migrates_to['slug'];
-                $new_version = $migrates_to['version'];
-                $this->_template_args = array_merge($this->_template_args, array(
-                    'current_db_state' => sprintf(__("EE%s (%s)", "event_espresso"),
-                        isset($current_db_state[$plugin_slug]) ? $current_db_state[$plugin_slug] : 3, $plugin_slug),
-                    'next_db_state'    => isset($current_script) ? sprintf(__("EE%s (%s)", 'event_espresso'),
-                        $new_version, $plugin_slug) : null,
-                ));
-            } else {
-                $this->_template_args['current_db_state'] = null;
-                $this->_template_args['next_db_state'] = null;
-            }
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
-            $this->_template_args = array_merge(
-                $this->_template_args,
-                array(
-                    'show_most_recent_migration'             => $show_most_recent_migration,
-                    //flag for showing the most recent migration's status and/or errors
-                    'show_migration_progress'                => $show_migration_progress,
-                    //flag for showing the option to run migrations and see their progress
-                    'show_backup_db_text'                    => $show_backup_db_text,
-                    //flag for showing text telling the user to backup their DB
-                    'show_maintenance_switch'                => $show_maintenance_switch,
-                    //flag for showing the option to change maintenance mode between levels 0 and 1
-                    'script_names'                           => $script_names,
-                    //array of names of scripts that have run
-                    'show_continue_current_migration_script' => $show_continue_current_migration_script,
-                    //flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
-                    'reset_db_page_link'                     => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reset_db'),
-                        EE_MAINTENANCE_ADMIN_URL),
-                    'data_reset_page'                        => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'data_reset'),
-                        EE_MAINTENANCE_ADMIN_URL),
-                    'update_migration_script_page_link'      => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'change_maintenance_level'),
-                        EE_MAINTENANCE_ADMIN_URL),
-                    'ultimate_db_state'                      => sprintf(__("EE%s", 'event_espresso'),
-                        espresso_version()),
-                )
-            );
-            //make sure we have the form fields helper available. It usually is, but sometimes it isn't
-            //localize script stuff
-            wp_localize_script('ee-maintenance', 'ee_maintenance', array(
-                'migrating'                        => esc_html__("Updating Database...", "event_espresso"),
-                'next'                             => esc_html__("Next", "event_espresso"),
-                'fatal_error'                      => esc_html__("A Fatal Error Has Occurred", "event_espresso"),
-                'click_next_when_ready'            => esc_html__("The current Database Update has ended. Click 'next' when ready to proceed",
-                    "event_espresso"),
-                'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts,
-                'status_fatal_error'               => EE_Data_Migration_Manager::status_fatal_error,
-                'status_completed'                 => EE_Data_Migration_Manager::status_completed,
-            ));
-        }
-        $this->_template_args['most_recent_migration'] = $most_recent_migration;//the actual most recently ran migration
-        //now render the migration options part, and put it in a variable
-        $migration_options_template_file = apply_filters(
-            'FHEE__ee_migration_page__migration_options_template',
-            EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php'
-        );
-        $migration_options_html = EEH_Template::display_template($migration_options_template_file, $this->_template_args,true);
-        $this->_template_args['migration_options_html'] = $migration_options_html;
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
-            $this->_template_args, true);
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    /**
-     * returns JSON and executes another step of the currently-executing data migration (called via ajax)
-     */
-    public function migration_step()
-    {
-        $this->_template_args['data'] = EE_Data_Migration_Manager::instance()->response_to_migration_ajax_request();
-        $this->_return_json();
-    }
-
-
-
-    /**
-     * Can be used by js when it notices a response with HTML in it in order
-     * to log the malformed response
-     */
-    public function add_error_to_migrations_ran()
-    {
-        EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($this->_req_data['message']);
-        $this->_template_args['data'] = array('ok' => true);
-        $this->_return_json();
-    }
-
-
-
-    /**
-     * changes the maintenance level, provided there are still no migration scripts that should run
-     */
-    public function _change_maintenance_level()
-    {
-        $new_level = absint($this->_req_data['maintenance_mode_level']);
-        if ( ! EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
-            EE_Maintenance_Mode::instance()->set_maintenance_level($new_level);
-            $success = true;
-        } else {
-            EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-            $success = false;
-        }
-        $this->_redirect_after_action($success, 'Maintenance Mode', esc_html__("Updated", "event_espresso"));
-    }
-
-
-
-    /**
-     * a tab with options for resetting and/or deleting EE data
-     *
-     * @throws \EE_Error
-     * @throws \DomainException
-     */
-    public function _data_reset_and_delete()
-    {
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
-        $this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button(
-            'reset_reservations',
-            'reset_reservations',
-            array(),
-            'button button-primary',
-            '',
-            false
-        );
-        $this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button(
-            'reset_capabilities',
-            'reset_capabilities',
-            array(),
-            'button button-primary',
-            '',
-            false
-        );
-        $this->_template_args['delete_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'delete_db'),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['reset_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'reset_db'),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    protected function _reset_reservations()
-    {
-        if(\EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
-            EE_Error::add_success(
-                __(
-                    'Ticket and datetime reserved counts have been successfully reset.',
-                    'event_espresso'
-                )
-            );
-        } else {
-            EE_Error::add_success(
-                __(
-                    'Ticket and datetime reserved counts were correct and did not need resetting.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->_redirect_after_action(true, '', '', array('action' => 'data_reset'), true);
-    }
-
-
-
-    protected function _reset_capabilities()
-    {
-        EE_Registry::instance()->CAP->init_caps(true);
-        EE_Error::add_success(__('Default Event Espresso capabilities have been restored for all current roles.',
-            'event_espresso'));
-        $this->_redirect_after_action(false, '', '', array('action' => 'data_reset'), true);
-    }
-
-
-
-    /**
-     * resets the DMSs so we can attempt to continue migrating after a fatal error
-     * (only a good idea when someone has somehow tried ot fix whatever caused
-     * the fatal error in teh first place)
-     */
-    protected function _reattempt_migration()
-    {
-        EE_Data_Migration_Manager::instance()->reattempt();
-        $this->_redirect_after_action(false, '', '', array('action' => 'default'), true);
-    }
-
-
-
-    /**
-     * shows the big ol' System Information page
-     */
-    public function _system_status()
-    {
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
-        $this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati();
-        $this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'download_system_status',
-            ),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
-            $this->_template_args, true);
-        $this->display_admin_page_with_sidebar();
-    }
-
-    /**
-     * Downloads an HTML file of the system status that can be easily stored or emailed
-     */
-    public function _download_system_status()
-    {
-        $status_info = EEM_System_Status::instance()->get_system_stati();
-        header( 'Content-Disposition: attachment' );
-        header( "Content-Disposition: attachment; filename=system_status_" . sanitize_key( site_url() ) . ".html" );
-        echo "<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>";
-        echo "<h1>System Information for " . site_url() . "</h1>";
-        echo EEH_Template::layout_array_as_table( $status_info );
-        die;
-    }
-
-
-
-    public function _send_migration_crash_report()
-    {
-        $from = $this->_req_data['from'];
-        $from_name = $this->_req_data['from_name'];
-        $body = $this->_req_data['body'];
-        try {
-            $success = wp_mail(EE_SUPPORT_EMAIL,
-                'Migration Crash Report',
-                $body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
-                array(
-                    "from:$from_name<$from>",
-                    //					'content-type:text/html charset=UTF-8'
-                ));
-        } catch (Exception $e) {
-            $success = false;
-        }
-        $this->_redirect_after_action($success, esc_html__("Migration Crash Report", "event_espresso"),
-            esc_html__("sent", "event_espresso"),
-            array('success' => $success, 'action' => 'confirm_migration_crash_report_sent'));
-    }
-
-
-
-    public function _confirm_migration_crash_report_sent()
-    {
-        try {
-            $most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
-        } catch (EE_Error $e) {
-            EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
-            //now, just so we can display the page correctly, make a error migration script stage object
-            //and also put the error on it. It only persists for the duration of this request
-            $most_recent_migration = new EE_DMS_Unknown_1_0_0();
-            $most_recent_migration->add_error($e->getMessage());
-        }
-        $success = $this->_req_data['success'] == '1' ? true : false;
-        $this->_template_args['success'] = $success;
-        $this->_template_args['most_recent_migration'] = $most_recent_migration;
-        $this->_template_args['reset_db_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reset_db'),
-            EE_MAINTENANCE_ADMIN_URL);
-        $this->_template_args['reset_db_page_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'data_reset'),
-            EE_MAINTENANCE_ADMIN_URL);
-        $this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reattempt_migration'),
-            EE_MAINTENANCE_ADMIN_URL);
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
-            $this->_template_args, true);
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    /**
-     * Resets the entire EE4 database.
-     * Currently basically only sets up ee4 database for a fresh install- doesn't
-     * actually clean out the old wp options, or cpts (although does erase old ee table data)
-     *
-     * @param boolean $nuke_old_ee4_data controls whether or not we
-     *                                   destroy the old ee4 data, or just try initializing ee4 default data
-     */
-    public function _reset_db($nuke_old_ee4_data = true)
-    {
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        if ($nuke_old_ee4_data) {
-            EEH_Activation::delete_all_espresso_cpt_data();
-            EEH_Activation::delete_all_espresso_tables_and_data(false);
-            EEH_Activation::remove_cron_tasks();
-        }
-        //make sure when we reset the registry's config that it
-        //switches to using the new singleton
-        EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true);
-        EE_System::instance()->initialize_db_if_no_migrations_required(true);
-        EE_System::instance()->redirect_to_about_ee();
-    }
-
-
-
-    /**
-     * Deletes ALL EE tables, Records, and Options from the database.
-     */
-    public function _delete_db()
-    {
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        EEH_Activation::delete_all_espresso_cpt_data();
-        EEH_Activation::delete_all_espresso_tables_and_data();
-        EEH_Activation::remove_cron_tasks();
-        EEH_Activation::deactivate_event_espresso();
-        wp_safe_redirect(admin_url('plugins.php'));
-        exit;
-    }
-
-
-
-    /**
-     * sets up EE4 to rerun the migrations from ee3 to ee4
-     */
-    public function _rerun_migration_from_ee3()
-    {
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        EEH_Activation::delete_all_espresso_cpt_data();
-        EEH_Activation::delete_all_espresso_tables_and_data(false);
-        //set the db state to something that will require migrations
-        update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0');
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance);
-        $this->_redirect_after_action(true, esc_html__("Database", 'event_espresso'), esc_html__("reset", 'event_espresso'));
-    }
-
-
-
-    //none of the below group are currently used for Gateway Settings
-    protected function _add_screen_options()
-    {
-    }
-
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+	}
+
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug = EE_MAINTENANCE_PG_SLUG;
+		$this->page_label = EE_MAINTENANCE_LABEL;
+		$this->_admin_base_url = EE_MAINTENANCE_ADMIN_URL;
+		$this->_admin_base_path = EE_MAINTENANCE_ADMIN;
+	}
+
+
+
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_migration_step', array($this, 'migration_step'));
+		add_action('wp_ajax_add_error_to_migrations_ran', array($this, 'add_error_to_migrations_ran'));
+	}
+
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = EE_MAINTENANCE_LABEL;
+		$this->_labels = array(
+			'buttons' => array(
+				'reset_reservations' => esc_html__('Reset Ticket and Datetime Reserved Counts', 'event_espresso'),
+				'reset_capabilities' => esc_html__('Reset Event Espresso Capabilities', 'event_espresso'),
+			),
+		);
+	}
+
+
+
+	protected function _set_page_routes()
+	{
+		$this->_page_routes = array(
+			'default'                             => array(
+				'func'       => '_maintenance',
+				'capability' => 'manage_options',
+			),
+			'change_maintenance_level'            => array(
+				'func'       => '_change_maintenance_level',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'system_status'                       => array(
+				'func'       => '_system_status',
+				'capability' => 'manage_options',
+			),
+			'download_system_status' => array(
+				'func'       => '_download_system_status',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'send_migration_crash_report'         => array(
+				'func'       => '_send_migration_crash_report',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'confirm_migration_crash_report_sent' => array(
+				'func'       => '_confirm_migration_crash_report_sent',
+				'capability' => 'manage_options',
+			),
+			'data_reset'                          => array(
+				'func'       => '_data_reset_and_delete',
+				'capability' => 'manage_options',
+			),
+			'reset_db'                            => array(
+				'func'       => '_reset_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+				'args'       => array('nuke_old_ee4_data' => true),
+			),
+			'start_with_fresh_ee4_db'             => array(
+				'func'       => '_reset_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+				'args'       => array('nuke_old_ee4_data' => false),
+			),
+			'delete_db'                           => array(
+				'func'       => '_delete_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'rerun_migration_from_ee3'            => array(
+				'func'       => '_rerun_migration_from_ee3',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'reset_reservations'                  => array(
+				'func'       => '_reset_reservations',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'reset_capabilities'                  => array(
+				'func'       => '_reset_capabilities',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'reattempt_migration'                 => array(
+				'func'       => '_reattempt_migration',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+		);
+	}
+
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'       => array(
+				'nav'           => array(
+					'label' => esc_html__('Maintenance', 'event_espresso'),
+					'order' => 10,
+				),
+				'require_nonce' => false,
+			),
+			'data_reset'    => array(
+				'nav'           => array(
+					'label' => esc_html__('Reset/Delete Data', 'event_espresso'),
+					'order' => 20,
+				),
+				'require_nonce' => false,
+			),
+			'system_status' => array(
+				'nav'           => array(
+					'label' => esc_html__("System Information", "event_espresso"),
+					'order' => 30,
+				),
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+
+	/**
+	 * default maintenance page. If we're in maintenance mode level 2, then we need to show
+	 * the migration scripts and all that UI.
+	 */
+	public function _maintenance()
+	{
+		//it all depends if we're in maintenance model level 1 (frontend-only) or
+		//level 2 (everything except maintenance page)
+		try {
+			//get the current maintenance level and check if
+			//we are removed
+			$mm = EE_Maintenance_Mode::instance()->level();
+			$placed_in_mm = EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+			if ($mm == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) {
+				//we just took the site out of maintenance mode, so notify the user.
+				//unfortunately this message appears to be echoed on the NEXT page load...
+				//oh well, we should really be checking for this on addon deactivation anyways
+				EE_Error::add_attention(__('Site taken out of maintenance mode because no data migration scripts are required',
+					'event_espresso'));
+				$this->_process_notices(array('page' => 'espresso_maintenance_settings'), false);
+			}
+			//in case an exception is thrown while trying to handle migrations
+			switch (EE_Maintenance_Mode::instance()->level()) {
+				case EE_Maintenance_Mode::level_0_not_in_maintenance:
+				case EE_Maintenance_Mode::level_1_frontend_only_maintenance:
+					$show_maintenance_switch = true;
+					$show_backup_db_text = false;
+					$show_migration_progress = false;
+					$script_names = array();
+					$addons_should_be_upgraded_first = false;
+					break;
+				case EE_Maintenance_Mode::level_2_complete_maintenance:
+					$show_maintenance_switch = false;
+					$show_migration_progress = true;
+					if (isset($this->_req_data['continue_migration'])) {
+						$show_backup_db_text = false;
+					} else {
+						$show_backup_db_text = true;
+					}
+					$scripts_needing_to_run = EE_Data_Migration_Manager::instance()
+																	   ->check_for_applicable_data_migration_scripts();
+					$addons_should_be_upgraded_first = EE_Data_Migration_Manager::instance()->addons_need_updating();
+					$script_names = array();
+					$current_script = null;
+					foreach ($scripts_needing_to_run as $script) {
+						if ($script instanceof EE_Data_Migration_Script_Base) {
+							if ( ! $current_script) {
+								$current_script = $script;
+								$current_script->migration_page_hooks();
+							}
+							$script_names[] = $script->pretty_name();
+						}
+					}
+					break;
+			}
+			$most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
+			$exception_thrown = false;
+		} catch (EE_Error $e) {
+			EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
+			//now, just so we can display the page correctly, make a error migration script stage object
+			//and also put the error on it. It only persists for the duration of this request
+			$most_recent_migration = new EE_DMS_Unknown_1_0_0();
+			$most_recent_migration->add_error($e->getMessage());
+			$exception_thrown = true;
+		}
+		$current_db_state = EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set();
+		$current_db_state = str_replace('.decaf', '', $current_db_state);
+		if ($exception_thrown
+			|| ($most_recent_migration
+				&& $most_recent_migration instanceof EE_Data_Migration_Script_Base
+				&& $most_recent_migration->is_broken()
+			)
+		) {
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
+			$this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/';
+			$this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce(array('action'  => 'confirm_migration_crash_report_sent',
+																						'success' => '0',
+			), EE_MAINTENANCE_ADMIN_URL);
+		} elseif ($addons_should_be_upgraded_first) {
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
+		} else {
+			if ($most_recent_migration
+				&& $most_recent_migration instanceof EE_Data_Migration_Script_Base
+				&& $most_recent_migration->can_continue()
+			) {
+				$show_backup_db_text = false;
+				$show_continue_current_migration_script = true;
+				$show_most_recent_migration = true;
+			} elseif (isset($this->_req_data['continue_migration'])) {
+				$show_most_recent_migration = true;
+				$show_continue_current_migration_script = false;
+			} else {
+				$show_most_recent_migration = false;
+				$show_continue_current_migration_script = false;
+			}
+			if (isset($current_script)) {
+				$migrates_to = $current_script->migrates_to_version();
+				$plugin_slug = $migrates_to['slug'];
+				$new_version = $migrates_to['version'];
+				$this->_template_args = array_merge($this->_template_args, array(
+					'current_db_state' => sprintf(__("EE%s (%s)", "event_espresso"),
+						isset($current_db_state[$plugin_slug]) ? $current_db_state[$plugin_slug] : 3, $plugin_slug),
+					'next_db_state'    => isset($current_script) ? sprintf(__("EE%s (%s)", 'event_espresso'),
+						$new_version, $plugin_slug) : null,
+				));
+			} else {
+				$this->_template_args['current_db_state'] = null;
+				$this->_template_args['next_db_state'] = null;
+			}
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
+			$this->_template_args = array_merge(
+				$this->_template_args,
+				array(
+					'show_most_recent_migration'             => $show_most_recent_migration,
+					//flag for showing the most recent migration's status and/or errors
+					'show_migration_progress'                => $show_migration_progress,
+					//flag for showing the option to run migrations and see their progress
+					'show_backup_db_text'                    => $show_backup_db_text,
+					//flag for showing text telling the user to backup their DB
+					'show_maintenance_switch'                => $show_maintenance_switch,
+					//flag for showing the option to change maintenance mode between levels 0 and 1
+					'script_names'                           => $script_names,
+					//array of names of scripts that have run
+					'show_continue_current_migration_script' => $show_continue_current_migration_script,
+					//flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
+					'reset_db_page_link'                     => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reset_db'),
+						EE_MAINTENANCE_ADMIN_URL),
+					'data_reset_page'                        => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'data_reset'),
+						EE_MAINTENANCE_ADMIN_URL),
+					'update_migration_script_page_link'      => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'change_maintenance_level'),
+						EE_MAINTENANCE_ADMIN_URL),
+					'ultimate_db_state'                      => sprintf(__("EE%s", 'event_espresso'),
+						espresso_version()),
+				)
+			);
+			//make sure we have the form fields helper available. It usually is, but sometimes it isn't
+			//localize script stuff
+			wp_localize_script('ee-maintenance', 'ee_maintenance', array(
+				'migrating'                        => esc_html__("Updating Database...", "event_espresso"),
+				'next'                             => esc_html__("Next", "event_espresso"),
+				'fatal_error'                      => esc_html__("A Fatal Error Has Occurred", "event_espresso"),
+				'click_next_when_ready'            => esc_html__("The current Database Update has ended. Click 'next' when ready to proceed",
+					"event_espresso"),
+				'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts,
+				'status_fatal_error'               => EE_Data_Migration_Manager::status_fatal_error,
+				'status_completed'                 => EE_Data_Migration_Manager::status_completed,
+			));
+		}
+		$this->_template_args['most_recent_migration'] = $most_recent_migration;//the actual most recently ran migration
+		//now render the migration options part, and put it in a variable
+		$migration_options_template_file = apply_filters(
+			'FHEE__ee_migration_page__migration_options_template',
+			EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php'
+		);
+		$migration_options_html = EEH_Template::display_template($migration_options_template_file, $this->_template_args,true);
+		$this->_template_args['migration_options_html'] = $migration_options_html;
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
+			$this->_template_args, true);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	/**
+	 * returns JSON and executes another step of the currently-executing data migration (called via ajax)
+	 */
+	public function migration_step()
+	{
+		$this->_template_args['data'] = EE_Data_Migration_Manager::instance()->response_to_migration_ajax_request();
+		$this->_return_json();
+	}
+
+
+
+	/**
+	 * Can be used by js when it notices a response with HTML in it in order
+	 * to log the malformed response
+	 */
+	public function add_error_to_migrations_ran()
+	{
+		EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($this->_req_data['message']);
+		$this->_template_args['data'] = array('ok' => true);
+		$this->_return_json();
+	}
+
+
+
+	/**
+	 * changes the maintenance level, provided there are still no migration scripts that should run
+	 */
+	public function _change_maintenance_level()
+	{
+		$new_level = absint($this->_req_data['maintenance_mode_level']);
+		if ( ! EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
+			EE_Maintenance_Mode::instance()->set_maintenance_level($new_level);
+			$success = true;
+		} else {
+			EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+			$success = false;
+		}
+		$this->_redirect_after_action($success, 'Maintenance Mode', esc_html__("Updated", "event_espresso"));
+	}
+
+
+
+	/**
+	 * a tab with options for resetting and/or deleting EE data
+	 *
+	 * @throws \EE_Error
+	 * @throws \DomainException
+	 */
+	public function _data_reset_and_delete()
+	{
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
+		$this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button(
+			'reset_reservations',
+			'reset_reservations',
+			array(),
+			'button button-primary',
+			'',
+			false
+		);
+		$this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button(
+			'reset_capabilities',
+			'reset_capabilities',
+			array(),
+			'button button-primary',
+			'',
+			false
+		);
+		$this->_template_args['delete_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'delete_db'),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['reset_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'reset_db'),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	protected function _reset_reservations()
+	{
+		if(\EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
+			EE_Error::add_success(
+				__(
+					'Ticket and datetime reserved counts have been successfully reset.',
+					'event_espresso'
+				)
+			);
+		} else {
+			EE_Error::add_success(
+				__(
+					'Ticket and datetime reserved counts were correct and did not need resetting.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->_redirect_after_action(true, '', '', array('action' => 'data_reset'), true);
+	}
+
+
+
+	protected function _reset_capabilities()
+	{
+		EE_Registry::instance()->CAP->init_caps(true);
+		EE_Error::add_success(__('Default Event Espresso capabilities have been restored for all current roles.',
+			'event_espresso'));
+		$this->_redirect_after_action(false, '', '', array('action' => 'data_reset'), true);
+	}
+
+
+
+	/**
+	 * resets the DMSs so we can attempt to continue migrating after a fatal error
+	 * (only a good idea when someone has somehow tried ot fix whatever caused
+	 * the fatal error in teh first place)
+	 */
+	protected function _reattempt_migration()
+	{
+		EE_Data_Migration_Manager::instance()->reattempt();
+		$this->_redirect_after_action(false, '', '', array('action' => 'default'), true);
+	}
+
+
+
+	/**
+	 * shows the big ol' System Information page
+	 */
+	public function _system_status()
+	{
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
+		$this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati();
+		$this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'download_system_status',
+			),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
+			$this->_template_args, true);
+		$this->display_admin_page_with_sidebar();
+	}
+
+	/**
+	 * Downloads an HTML file of the system status that can be easily stored or emailed
+	 */
+	public function _download_system_status()
+	{
+		$status_info = EEM_System_Status::instance()->get_system_stati();
+		header( 'Content-Disposition: attachment' );
+		header( "Content-Disposition: attachment; filename=system_status_" . sanitize_key( site_url() ) . ".html" );
+		echo "<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>";
+		echo "<h1>System Information for " . site_url() . "</h1>";
+		echo EEH_Template::layout_array_as_table( $status_info );
+		die;
+	}
+
+
+
+	public function _send_migration_crash_report()
+	{
+		$from = $this->_req_data['from'];
+		$from_name = $this->_req_data['from_name'];
+		$body = $this->_req_data['body'];
+		try {
+			$success = wp_mail(EE_SUPPORT_EMAIL,
+				'Migration Crash Report',
+				$body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
+				array(
+					"from:$from_name<$from>",
+					//					'content-type:text/html charset=UTF-8'
+				));
+		} catch (Exception $e) {
+			$success = false;
+		}
+		$this->_redirect_after_action($success, esc_html__("Migration Crash Report", "event_espresso"),
+			esc_html__("sent", "event_espresso"),
+			array('success' => $success, 'action' => 'confirm_migration_crash_report_sent'));
+	}
+
+
+
+	public function _confirm_migration_crash_report_sent()
+	{
+		try {
+			$most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
+		} catch (EE_Error $e) {
+			EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
+			//now, just so we can display the page correctly, make a error migration script stage object
+			//and also put the error on it. It only persists for the duration of this request
+			$most_recent_migration = new EE_DMS_Unknown_1_0_0();
+			$most_recent_migration->add_error($e->getMessage());
+		}
+		$success = $this->_req_data['success'] == '1' ? true : false;
+		$this->_template_args['success'] = $success;
+		$this->_template_args['most_recent_migration'] = $most_recent_migration;
+		$this->_template_args['reset_db_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reset_db'),
+			EE_MAINTENANCE_ADMIN_URL);
+		$this->_template_args['reset_db_page_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'data_reset'),
+			EE_MAINTENANCE_ADMIN_URL);
+		$this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reattempt_migration'),
+			EE_MAINTENANCE_ADMIN_URL);
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
+			$this->_template_args, true);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	/**
+	 * Resets the entire EE4 database.
+	 * Currently basically only sets up ee4 database for a fresh install- doesn't
+	 * actually clean out the old wp options, or cpts (although does erase old ee table data)
+	 *
+	 * @param boolean $nuke_old_ee4_data controls whether or not we
+	 *                                   destroy the old ee4 data, or just try initializing ee4 default data
+	 */
+	public function _reset_db($nuke_old_ee4_data = true)
+	{
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		if ($nuke_old_ee4_data) {
+			EEH_Activation::delete_all_espresso_cpt_data();
+			EEH_Activation::delete_all_espresso_tables_and_data(false);
+			EEH_Activation::remove_cron_tasks();
+		}
+		//make sure when we reset the registry's config that it
+		//switches to using the new singleton
+		EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true);
+		EE_System::instance()->initialize_db_if_no_migrations_required(true);
+		EE_System::instance()->redirect_to_about_ee();
+	}
+
+
+
+	/**
+	 * Deletes ALL EE tables, Records, and Options from the database.
+	 */
+	public function _delete_db()
+	{
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		EEH_Activation::delete_all_espresso_cpt_data();
+		EEH_Activation::delete_all_espresso_tables_and_data();
+		EEH_Activation::remove_cron_tasks();
+		EEH_Activation::deactivate_event_espresso();
+		wp_safe_redirect(admin_url('plugins.php'));
+		exit;
+	}
+
+
+
+	/**
+	 * sets up EE4 to rerun the migrations from ee3 to ee4
+	 */
+	public function _rerun_migration_from_ee3()
+	{
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		EEH_Activation::delete_all_espresso_cpt_data();
+		EEH_Activation::delete_all_espresso_tables_and_data(false);
+		//set the db state to something that will require migrations
+		update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0');
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance);
+		$this->_redirect_after_action(true, esc_html__("Database", 'event_espresso'), esc_html__("reset", 'event_espresso'));
+	}
+
+
+
+	//none of the below group are currently used for Gateway Settings
+	protected function _add_screen_options()
+	{
+	}
+
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
 
 
-    public function admin_init()
-    {
-    }
-
-
-
-    public function admin_notices()
-    {
-    }
-
+	public function admin_init()
+	{
+	}
+
+
+
+	public function admin_notices()
+	{
+	}
+
 
 
-    public function admin_footer_scripts()
-    {
-    }
+	public function admin_footer_scripts()
+	{
+	}
 
 
 
-    public function load_scripts_styles()
-    {
-        wp_enqueue_script('ee_admin_js');
+	public function load_scripts_styles()
+	{
+		wp_enqueue_script('ee_admin_js');
 //		wp_enqueue_media();
 //		wp_enqueue_script('media-upload');
-        wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL . '/ee-maintenance.js', array('jquery'),
-            EVENT_ESPRESSO_VERSION, true);
-        wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css', array(),
-            EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso_maintenance');
-    }
+		wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL . '/ee-maintenance.js', array('jquery'),
+			EVENT_ESPRESSO_VERSION, true);
+		wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css', array(),
+			EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso_maintenance');
+	}
 
 
 
-    public function load_scripts_styles_default()
-    {
-        //styles
+	public function load_scripts_styles_default()
+	{
+		//styles
 //		wp_enqueue_style('ee-text-links');
 //		//scripts
 //		wp_enqueue_script('ee-text-links');
-    }
+	}
 
 
 

Spacing +17 added lines, -17 removed lines

@@ -244,13 +244,13 @@ 
                 && $most_recent_migration->is_broken()
             )
         ) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
+            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_migration_was_borked_page.template.php';
             $this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/';
             $this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce(array('action'  => 'confirm_migration_crash_report_sent',
                                                                                         'success' => '0',
             ), EE_MAINTENANCE_ADMIN_URL);
         } elseif ($addons_should_be_upgraded_first) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
+            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_upgrade_addons_before_migrating.template.php';
         } else {
             if ($most_recent_migration
                 && $most_recent_migration instanceof EE_Data_Migration_Script_Base
@@ -280,7 +280,7 @@ 
                 $this->_template_args['current_db_state'] = null;
                 $this->_template_args['next_db_state'] = null;
             }
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
+            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_migration_page.template.php';
             $this->_template_args = array_merge(
                 $this->_template_args,
                 array(
@@ -319,13 +319,13 @@ 
                 'status_completed'                 => EE_Data_Migration_Manager::status_completed,
             ));
         }
-        $this->_template_args['most_recent_migration'] = $most_recent_migration;//the actual most recently ran migration
+        $this->_template_args['most_recent_migration'] = $most_recent_migration; //the actual most recently ran migration
         //now render the migration options part, and put it in a variable
         $migration_options_template_file = apply_filters(
             'FHEE__ee_migration_page__migration_options_template',
-            EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php'
+            EE_MAINTENANCE_TEMPLATE_PATH.'migration_options_from_ee4.template.php'
         );
-        $migration_options_html = EEH_Template::display_template($migration_options_template_file, $this->_template_args,true);
+        $migration_options_html = EEH_Template::display_template($migration_options_template_file, $this->_template_args, true);
         $this->_template_args['migration_options_html'] = $migration_options_html;
         $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
             $this->_template_args, true);
@@ -384,7 +384,7 @@ 
      */
     public function _data_reset_and_delete()
     {
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
+        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_data_reset_and_delete.template.php';
         $this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button(
             'reset_reservations',
             'reset_reservations',
@@ -421,7 +421,7 @@ 
 
     protected function _reset_reservations()
     {
-        if(\EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
+        if (\EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
             EE_Error::add_success(
                 __(
                     'Ticket and datetime reserved counts have been successfully reset.',
@@ -469,7 +469,7 @@ 
      */
     public function _system_status()
     {
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
+        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_system_stati_page.template.php';
         $this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati();
         $this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce(
             array(
@@ -488,11 +488,11 @@ 
     public function _download_system_status()
     {
         $status_info = EEM_System_Status::instance()->get_system_stati();
-        header( 'Content-Disposition: attachment' );
-        header( "Content-Disposition: attachment; filename=system_status_" . sanitize_key( site_url() ) . ".html" );
+        header('Content-Disposition: attachment');
+        header("Content-Disposition: attachment; filename=system_status_".sanitize_key(site_url()).".html");
         echo "<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>";
-        echo "<h1>System Information for " . site_url() . "</h1>";
-        echo EEH_Template::layout_array_as_table( $status_info );
+        echo "<h1>System Information for ".site_url()."</h1>";
+        echo EEH_Template::layout_array_as_table($status_info);
         die;
     }
 
@@ -506,7 +506,7 @@ 
         try {
             $success = wp_mail(EE_SUPPORT_EMAIL,
                 'Migration Crash Report',
-                $body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
+                $body."/r/n<br>".print_r(EEM_System_Status::instance()->get_system_stati(), true),
                 array(
                     "from:$from_name<$from>",
                     //					'content-type:text/html charset=UTF-8'
@@ -541,7 +541,7 @@ 
             EE_MAINTENANCE_ADMIN_URL);
         $this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reattempt_migration'),
             EE_MAINTENANCE_ADMIN_URL);
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
+        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_confirm_migration_crash_report_sent.template.php';
         $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
             $this->_template_args, true);
         $this->display_admin_page_with_sidebar();
@@ -642,9 +642,9 @@ 
         wp_enqueue_script('ee_admin_js');
 //		wp_enqueue_media();
 //		wp_enqueue_script('media-upload');
-        wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL . '/ee-maintenance.js', array('jquery'),
+        wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL.'/ee-maintenance.js', array('jquery'),
             EVENT_ESPRESSO_VERSION, true);
-        wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css', array(),
+        wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL.'ee-maintenance.css', array(),
             EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('espresso_maintenance');
     }

core/services/loaders/CoreLoader.php

Spacing +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
      */
     public function __construct($generator)
     {
-        if(!($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
+        if ( ! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
             throw new InvalidArgumentException(
                 esc_html__(
                     'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
     /**
      * CoreLoader constructor.
      *
-     * @param EE_Registry|CoffeeShop $generator
+     * @param EE_Registry $generator
      * @throws InvalidArgumentException
      */
     public function __construct($generator)

Indentation +52 added lines, -52 removed lines

@@ -23,58 +23,58 @@
 class CoreLoader implements LoaderInterface
 {
 
-    /**
-     * @var EE_Registry|CoffeeShop $generator
-     */
-    private $generator;
-
-
-
-    /**
-     * CoreLoader constructor.
-     *
-     * @param EE_Registry|CoffeeShop $generator
-     * @throws InvalidArgumentException
-     */
-    public function __construct($generator)
-    {
-        if(!($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->generator = $generator;
-    }
-
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return mixed
-     * @throws ServiceNotFoundException
-     */
-    public function load($fqcn, $arguments = array())
-    {
-        return $this->generator instanceof EE_Registry
-            ? $this->generator->create($fqcn, $arguments)
-            : $this->generator->brew($fqcn, $arguments);
-    }
-
-
-
-    /**
-     * calls reset() on generator if method exists
-     */
-    public function reset()
-    {
-        if (method_exists($this->generator, 'reset')) {
-            $this->generator->reset();
-        }
-    }
+	/**
+	 * @var EE_Registry|CoffeeShop $generator
+	 */
+	private $generator;
+
+
+
+	/**
+	 * CoreLoader constructor.
+	 *
+	 * @param EE_Registry|CoffeeShop $generator
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($generator)
+	{
+		if(!($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->generator = $generator;
+	}
+
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 * @throws ServiceNotFoundException
+	 */
+	public function load($fqcn, $arguments = array())
+	{
+		return $this->generator instanceof EE_Registry
+			? $this->generator->create($fqcn, $arguments)
+			: $this->generator->brew($fqcn, $arguments);
+	}
+
+
+
+	/**
+	 * calls reset() on generator if method exists
+	 */
+	public function reset()
+	{
+		if (method_exists($this->generator, 'reset')) {
+			$this->generator->reset();
+		}
+	}
 
 }
 // End of file CoreLoader.php

core/services/loaders/LoaderDecorator.php

Indentation +16 added lines, -16 removed lines

@@ -19,22 +19,22 @@
 {
 
 
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
-
-
-
-    /**
-     * LoaderDecorator constructor.
-     *
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
+
+
+
+	/**
+	 * LoaderDecorator constructor.
+	 *
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}