eventespresso / event-espresso-core

core/services/Benchmark.php

Spacing +11 added lines, -11 removed lines

@@ -126,7 +126,7 @@ 
     {
         add_action(
             'shutdown',
-            function () use ($formatted) {
+            function() use ($formatted) {
                 Benchmark::displayResults(true, $formatted);
             }
         );
@@ -146,7 +146,7 @@ 
     {
         add_action(
             'shutdown',
-            function () use ($filepath, $formatted, $append) {
+            function() use ($filepath, $formatted, $append) {
                 Benchmark::writeResultsToFile($filepath, $formatted, $append);
             }
         );
@@ -164,17 +164,17 @@ 
             return '';
         }
         $output = '';
-        if (! empty(Benchmark::$times)) {
+        if ( ! empty(Benchmark::$times)) {
             $total = 0;
             $output .= $formatted
                 ? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
                 : '';
             foreach (Benchmark::$times as $timer_name => $total_time) {
                 $output .= Benchmark::formatTime($timer_name, $total_time, $formatted);
-                $output .= $formatted ? '<br />'  : "\n";
+                $output .= $formatted ? '<br />' : "\n";
                 $total += $total_time;
             }
-            if($formatted) {
+            if ($formatted) {
                 $output .= '<br />';
                 $output .= '<h4>TOTAL TIME</h4>';
                 $output .= Benchmark::formatTime('', $total, $formatted);
@@ -189,9 +189,9 @@ 
                 $output .= '<span style="color:red">Like...HEEELLLP</span><br />';
             }
         }
-        if (! empty(Benchmark::$memory_usage)) {
+        if ( ! empty(Benchmark::$memory_usage)) {
             $output .= $formatted
-                ? '<h5>Memory</h5>' . implode('<br />', Benchmark::$memory_usage)
+                ? '<h5>Memory</h5>'.implode('<br />', Benchmark::$memory_usage)
                 : implode("\n", Benchmark::$memory_usage);
         }
         if (empty($output)) {
@@ -239,12 +239,12 @@ 
         $filepath = ! empty($filepath) && is_readable(dirname($filepath))
             ? $filepath
             : '';
-        if( empty($filepath)) {
-            $filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
+        if (empty($filepath)) {
+            $filepath = EVENT_ESPRESSO_UPLOAD_DIR.'logs/benchmarking-'.date('Y-m-d').'.html';
         }
         file_put_contents(
             $filepath,
-            "\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
+            "\n".date('Y-m-d H:i:s').Benchmark::generateResults($formatted),
             $append ? FILE_APPEND | LOCK_EX : LOCK_EX
         );
     }
@@ -263,7 +263,7 @@ 
         return round(
             $size / pow(1024, $i = floor(log($size, 1024))),
             2
-        ) . ' ' . $unit[absint($i)];
+        ).' '.$unit[absint($i)];
     }
 
 

Indentation +297 added lines, -297 removed lines

@@ -17,303 +17,303 @@
 class Benchmark
 {
 
-    /**
-     * array containing the start time for the timers
-     */
-    private static $start_times;
-
-    /**
-     * array containing all the timer'd times, which can be outputted via show_times()
-     */
-    private static $times = array();
-
-    /**
-     * @var array
-     */
-    protected static $memory_usage = array();
-
-
-
-    /**
-     * whether to benchmark code or not
-     */
-    public static function doNotRun()
-    {
-        return ! WP_DEBUG || (defined('DOING_AJAX') && DOING_AJAX);
-    }
-
-
-
-    /**
-     * resetTimes
-     */
-    public static function resetTimes()
-    {
-        Benchmark::$times = array();
-    }
-
-
-
-    /**
-     * Add Benchmark::startTimer() before a block of code you want to measure the performance of
-     *
-     * @param null $timer_name
-     */
-    public static function startTimer($timer_name = null)
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
-        Benchmark::$start_times[$timer_name] = microtime(true);
-    }
-
-
-
-    /**
-     * Add Benchmark::stopTimer() after a block of code you want to measure the performance of
-     *
-     * @param string $timer_name
-     */
-    public static function stopTimer($timer_name = '')
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
-        if (isset(Benchmark::$start_times[$timer_name])) {
-            $start_time = Benchmark::$start_times[$timer_name];
-            unset(Benchmark::$start_times[$timer_name]);
-        } else {
-            $start_time = array_pop(Benchmark::$start_times);
-        }
-        Benchmark::$times[$timer_name] = number_format(microtime(true) - $start_time, 8);
-    }
-
-
-
-    /**
-     * Measure the memory usage by PHP so far.
-     *
-     * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
-     * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
-     * @param bool    $formatted
-     * @return void
-     */
-    public static function measureMemory($label = 'memory usage', $output_now = false, $formatted = true)
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $memory_used = Benchmark::convert(memory_get_usage(true));
-        Benchmark::$memory_usage[$label] = $memory_used;
-        if ($output_now) {
-            echo $formatted
-                ? "<br>{$label} : {$memory_used}"
-                : "\n {$label} : {$memory_used}";
-        }
-    }
-
-
-
-    /**
-     * will display the benchmarking results at shutdown
-     *
-     * @param bool $formatted
-     * @return void
-     */
-    public static function displayResultsAtShutdown($formatted = true)
-    {
-        add_action(
-            'shutdown',
-            function () use ($formatted) {
-                Benchmark::displayResults(true, $formatted);
-            }
-        );
-    }
-
-
-
-    /**
-     * will display the benchmarking results at shutdown
-     *
-     * @param string $filepath
-     * @param bool   $formatted
-     * @param bool   $append
-     * @return void
-     */
-    public static function writeResultsAtShutdown($filepath = '', $formatted = true, $append = true)
-    {
-        add_action(
-            'shutdown',
-            function () use ($filepath, $formatted, $append) {
-                Benchmark::writeResultsToFile($filepath, $formatted, $append);
-            }
-        );
-    }
-
-
-
-    /**
-     * @param bool $formatted
-     * @return string
-     */
-    private static function generateResults($formatted = true)
-    {
-        if (Benchmark::doNotRun()) {
-            return '';
-        }
-        $output = '';
-        if (! empty(Benchmark::$times)) {
-            $total = 0;
-            $output .= $formatted
-                ? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
-                : '';
-            foreach (Benchmark::$times as $timer_name => $total_time) {
-                $output .= Benchmark::formatTime($timer_name, $total_time, $formatted);
-                $output .= $formatted ? '<br />'  : "\n";
-                $total += $total_time;
-            }
-            if($formatted) {
-                $output .= '<br />';
-                $output .= '<h4>TOTAL TIME</h4>';
-                $output .= Benchmark::formatTime('', $total, $formatted);
-                $output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />';
-                $output .= '<br />';
-                $output .= '<h5>Performance scale (from best to worse)</h5>';
-                $output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />';
-                $output .= '<span style="color:deepskyblue">Like...no way man!</span><br />';
-                $output .= '<span style="color:limegreen">Like...groovy!</span><br />';
-                $output .= '<span style="color:gold">Ruh Oh</span><br />';
-                $output .= '<span style="color:darkorange">Zoinks!</span><br />';
-                $output .= '<span style="color:red">Like...HEEELLLP</span><br />';
-            }
-        }
-        if (! empty(Benchmark::$memory_usage)) {
-            $output .= $formatted
-                ? '<h5>Memory</h5>' . implode('<br />', Benchmark::$memory_usage)
-                : implode("\n", Benchmark::$memory_usage);
-        }
-        if (empty($output)) {
-            return '';
-        }
-        $output = $formatted
-            ? '<div style="border:1px solid #dddddd; background-color:#ffffff;'
-              . (is_admin()
-                ? ' margin:2em 2em 2em 180px;'
-                : ' margin:2em;')
-              . ' padding:2em;">'
-              . '<h4>BENCHMARKING</h4>'
-              . $output
-              . '</div>'
-            : $output;
-        return $output;
-    }
-
-
-
-    /**
-     * @param bool $echo
-     * @param bool $formatted
-     * @return string
-     */
-    public static function displayResults($echo = true, $formatted = true)
-    {
-        $results = Benchmark::generateResults($formatted);
-        if ($echo) {
-            echo $results;
-            $results = '';
-        }
-        return $results;
-    }
-
-
-
-    /**
-     * @param string $filepath
-     * @param bool   $formatted
-     * @param bool   $append
-     */
-    public static function writeResultsToFile($filepath = '', $formatted = true, $append = true)
-    {
-        $filepath = ! empty($filepath) && is_readable(dirname($filepath))
-            ? $filepath
-            : '';
-        if( empty($filepath)) {
-            $filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
-        }
-        file_put_contents(
-            $filepath,
-            "\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
-            $append ? FILE_APPEND | LOCK_EX : LOCK_EX
-        );
-    }
-
-
-
-    /**
-     * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc)
-     *
-     * @param int $size
-     * @return string
-     */
-    public static function convert($size)
-    {
-        $unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb');
-        return round(
-            $size / pow(1024, $i = floor(log($size, 1024))),
-            2
-        ) . ' ' . $unit[absint($i)];
-    }
-
-
-
-    /**
-     * @param string $timer_name
-     * @param float  $total_time
-     * @param bool   $formatted
-     * @return string
-     */
-    public static function formatTime($timer_name, $total_time, $formatted = true)
-    {
-        $total_time *= 1000;
-        switch ($total_time) {
-            case $total_time > 12500 :
-                $color = 'red';
-                $bold = 'bold';
-                break;
-            case $total_time > 2500 :
-                $color = 'darkorange';
-                $bold = 'bold';
-                break;
-            case $total_time > 500 :
-                $color = 'gold';
-                $bold = 'bold';
-                break;
-            case $total_time > 100 :
-                $color = 'limegreen';
-                $bold = 'normal';
-                break;
-            case $total_time > 20 :
-                $color = 'deepskyblue';
-                $bold = 'normal';
-                break;
-            default :
-                $color = 'mediumpurple';
-                $bold = 'normal';
-                break;
-        }
-        return $formatted
-            ? '<span style="min-width: 10px; margin:0 1em; color:'
-               . $color
-               . '; font-weight:'
-               . $bold
-               . '; font-size:1.2em;">'
-               . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT)
-               . '</span> '
-               . $timer_name
-            :  str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT);
-    }
+	/**
+	 * array containing the start time for the timers
+	 */
+	private static $start_times;
+
+	/**
+	 * array containing all the timer'd times, which can be outputted via show_times()
+	 */
+	private static $times = array();
+
+	/**
+	 * @var array
+	 */
+	protected static $memory_usage = array();
+
+
+
+	/**
+	 * whether to benchmark code or not
+	 */
+	public static function doNotRun()
+	{
+		return ! WP_DEBUG || (defined('DOING_AJAX') && DOING_AJAX);
+	}
+
+
+
+	/**
+	 * resetTimes
+	 */
+	public static function resetTimes()
+	{
+		Benchmark::$times = array();
+	}
+
+
+
+	/**
+	 * Add Benchmark::startTimer() before a block of code you want to measure the performance of
+	 *
+	 * @param null $timer_name
+	 */
+	public static function startTimer($timer_name = null)
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$timer_name = $timer_name !== '' ? $timer_name : get_called_class();
+		Benchmark::$start_times[$timer_name] = microtime(true);
+	}
+
+
+
+	/**
+	 * Add Benchmark::stopTimer() after a block of code you want to measure the performance of
+	 *
+	 * @param string $timer_name
+	 */
+	public static function stopTimer($timer_name = '')
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$timer_name = $timer_name !== '' ? $timer_name : get_called_class();
+		if (isset(Benchmark::$start_times[$timer_name])) {
+			$start_time = Benchmark::$start_times[$timer_name];
+			unset(Benchmark::$start_times[$timer_name]);
+		} else {
+			$start_time = array_pop(Benchmark::$start_times);
+		}
+		Benchmark::$times[$timer_name] = number_format(microtime(true) - $start_time, 8);
+	}
+
+
+
+	/**
+	 * Measure the memory usage by PHP so far.
+	 *
+	 * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
+	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
+	 * @param bool    $formatted
+	 * @return void
+	 */
+	public static function measureMemory($label = 'memory usage', $output_now = false, $formatted = true)
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$memory_used = Benchmark::convert(memory_get_usage(true));
+		Benchmark::$memory_usage[$label] = $memory_used;
+		if ($output_now) {
+			echo $formatted
+				? "<br>{$label} : {$memory_used}"
+				: "\n {$label} : {$memory_used}";
+		}
+	}
+
+
+
+	/**
+	 * will display the benchmarking results at shutdown
+	 *
+	 * @param bool $formatted
+	 * @return void
+	 */
+	public static function displayResultsAtShutdown($formatted = true)
+	{
+		add_action(
+			'shutdown',
+			function () use ($formatted) {
+				Benchmark::displayResults(true, $formatted);
+			}
+		);
+	}
+
+
+
+	/**
+	 * will display the benchmarking results at shutdown
+	 *
+	 * @param string $filepath
+	 * @param bool   $formatted
+	 * @param bool   $append
+	 * @return void
+	 */
+	public static function writeResultsAtShutdown($filepath = '', $formatted = true, $append = true)
+	{
+		add_action(
+			'shutdown',
+			function () use ($filepath, $formatted, $append) {
+				Benchmark::writeResultsToFile($filepath, $formatted, $append);
+			}
+		);
+	}
+
+
+
+	/**
+	 * @param bool $formatted
+	 * @return string
+	 */
+	private static function generateResults($formatted = true)
+	{
+		if (Benchmark::doNotRun()) {
+			return '';
+		}
+		$output = '';
+		if (! empty(Benchmark::$times)) {
+			$total = 0;
+			$output .= $formatted
+				? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
+				: '';
+			foreach (Benchmark::$times as $timer_name => $total_time) {
+				$output .= Benchmark::formatTime($timer_name, $total_time, $formatted);
+				$output .= $formatted ? '<br />'  : "\n";
+				$total += $total_time;
+			}
+			if($formatted) {
+				$output .= '<br />';
+				$output .= '<h4>TOTAL TIME</h4>';
+				$output .= Benchmark::formatTime('', $total, $formatted);
+				$output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />';
+				$output .= '<br />';
+				$output .= '<h5>Performance scale (from best to worse)</h5>';
+				$output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />';
+				$output .= '<span style="color:deepskyblue">Like...no way man!</span><br />';
+				$output .= '<span style="color:limegreen">Like...groovy!</span><br />';
+				$output .= '<span style="color:gold">Ruh Oh</span><br />';
+				$output .= '<span style="color:darkorange">Zoinks!</span><br />';
+				$output .= '<span style="color:red">Like...HEEELLLP</span><br />';
+			}
+		}
+		if (! empty(Benchmark::$memory_usage)) {
+			$output .= $formatted
+				? '<h5>Memory</h5>' . implode('<br />', Benchmark::$memory_usage)
+				: implode("\n", Benchmark::$memory_usage);
+		}
+		if (empty($output)) {
+			return '';
+		}
+		$output = $formatted
+			? '<div style="border:1px solid #dddddd; background-color:#ffffff;'
+			  . (is_admin()
+				? ' margin:2em 2em 2em 180px;'
+				: ' margin:2em;')
+			  . ' padding:2em;">'
+			  . '<h4>BENCHMARKING</h4>'
+			  . $output
+			  . '</div>'
+			: $output;
+		return $output;
+	}
+
+
+
+	/**
+	 * @param bool $echo
+	 * @param bool $formatted
+	 * @return string
+	 */
+	public static function displayResults($echo = true, $formatted = true)
+	{
+		$results = Benchmark::generateResults($formatted);
+		if ($echo) {
+			echo $results;
+			$results = '';
+		}
+		return $results;
+	}
+
+
+
+	/**
+	 * @param string $filepath
+	 * @param bool   $formatted
+	 * @param bool   $append
+	 */
+	public static function writeResultsToFile($filepath = '', $formatted = true, $append = true)
+	{
+		$filepath = ! empty($filepath) && is_readable(dirname($filepath))
+			? $filepath
+			: '';
+		if( empty($filepath)) {
+			$filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
+		}
+		file_put_contents(
+			$filepath,
+			"\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
+			$append ? FILE_APPEND | LOCK_EX : LOCK_EX
+		);
+	}
+
+
+
+	/**
+	 * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc)
+	 *
+	 * @param int $size
+	 * @return string
+	 */
+	public static function convert($size)
+	{
+		$unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb');
+		return round(
+			$size / pow(1024, $i = floor(log($size, 1024))),
+			2
+		) . ' ' . $unit[absint($i)];
+	}
+
+
+
+	/**
+	 * @param string $timer_name
+	 * @param float  $total_time
+	 * @param bool   $formatted
+	 * @return string
+	 */
+	public static function formatTime($timer_name, $total_time, $formatted = true)
+	{
+		$total_time *= 1000;
+		switch ($total_time) {
+			case $total_time > 12500 :
+				$color = 'red';
+				$bold = 'bold';
+				break;
+			case $total_time > 2500 :
+				$color = 'darkorange';
+				$bold = 'bold';
+				break;
+			case $total_time > 500 :
+				$color = 'gold';
+				$bold = 'bold';
+				break;
+			case $total_time > 100 :
+				$color = 'limegreen';
+				$bold = 'normal';
+				break;
+			case $total_time > 20 :
+				$color = 'deepskyblue';
+				$bold = 'normal';
+				break;
+			default :
+				$color = 'mediumpurple';
+				$bold = 'normal';
+				break;
+		}
+		return $formatted
+			? '<span style="min-width: 10px; margin:0 1em; color:'
+			   . $color
+			   . '; font-weight:'
+			   . $bold
+			   . '; font-size:1.2em;">'
+			   . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT)
+			   . '</span> '
+			   . $timer_name
+			:  str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT);
+	}
 
 
 

admin_pages/maintenance/Maintenance_Admin_Page.core.php

Spacing +19 added lines, -19 removed lines

@@ -261,13 +261,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
@@ -297,7 +297,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(
@@ -336,13 +336,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);
@@ -401,7 +401,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',
@@ -438,7 +438,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.',
@@ -486,7 +486,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(
@@ -505,11 +505,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;
     }
 
@@ -523,7 +523,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'
@@ -558,7 +558,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();
@@ -659,9 +659,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');
     }
@@ -698,8 +698,8 @@ 
 
     protected function _get_datetime_offset_fix_form()
     {
-        if (! $this->datetime_fix_offset_form instanceof EE_Form_Section_Proper) {
-            $this->datetime_fix_offset_form =  new EE_Form_Section_Proper(
+        if ( ! $this->datetime_fix_offset_form instanceof EE_Form_Section_Proper) {
+            $this->datetime_fix_offset_form = new EE_Form_Section_Proper(
                 array(
                     'name' => 'datetime_offset_fix_option',
                     'layout_strategy' => new EE_Admin_Two_Column_Layout(),

Indentation +736 added lines, -736 removed lines

@@ -28,755 +28,755 @@
 {
 
 
-    /**
-     * @var EE_Datetime_Offset_Fix_Form
-     */
-    protected $datetime_fix_offset_form;
-
-
-
-    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,
-            ),
-            'datetime_tools' => array(
-                'func' => '_datetime_tools',
-                'capability' => 'manage_options'
-            ),
-            'run_datetime_offset_fix' => array(
-                'func' => '_apply_datetime_offset',
-                'noheader' => true,
-                'headers_sent_route' => 'datetime_tools',
-                'capability' => 'manage_options'
-            )
-        );
-    }
-
-
-
-    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,
-            ),
-            'datetime_tools' => array(
-                'nav' => array(
-                    'label' => esc_html__('Datetime Utilities', 'event_espresso'),
-                    'order' => 25
-                ),
-                '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()
-    {
-    }
-
+	/**
+	 * @var EE_Datetime_Offset_Fix_Form
+	 */
+	protected $datetime_fix_offset_form;
+
+
+
+	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,
+			),
+			'datetime_tools' => array(
+				'func' => '_datetime_tools',
+				'capability' => 'manage_options'
+			),
+			'run_datetime_offset_fix' => array(
+				'func' => '_apply_datetime_offset',
+				'noheader' => true,
+				'headers_sent_route' => 'datetime_tools',
+				'capability' => 'manage_options'
+			)
+		);
+	}
+
+
+
+	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,
+			),
+			'datetime_tools' => array(
+				'nav' => array(
+					'label' => esc_html__('Datetime Utilities', 'event_espresso'),
+					'order' => 25
+				),
+				'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');
-    }
-
-
-    protected function _datetime_tools()
-    {
-        $form_action = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'run_datetime_offset_fix',
-                'return_action' => $this->_req_action
-            ),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $form = $this->_get_datetime_offset_fix_form();
-        $this->_admin_page_title = esc_html__('Datetime Utilities', 'event_espresso');
-        $this->_template_args['admin_page_content'] = $form->form_open($form_action, 'post')
-                                                      . $form->get_html_and_js()
-                                                      . $form->form_close();
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-
-    protected function _get_datetime_offset_fix_form()
-    {
-        if (! $this->datetime_fix_offset_form instanceof EE_Form_Section_Proper) {
-            $this->datetime_fix_offset_form =  new EE_Form_Section_Proper(
-                array(
-                    'name' => 'datetime_offset_fix_option',
-                    'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                    'subsections' => array(
-                        'title' => new EE_Form_Section_HTML(
-                            EEH_HTML::h2(
-                                esc_html__('Datetime Offset Tool', 'event_espresso')
-                            )
-                        ),
-                        'explanation' => new EE_Form_Section_HTML(
-                            EEH_HTML::p(
-                                esc_html__(
-                                    'Use this tool to automatically apply the provided offset to all Event Espresso records in your database that involve dates and times.',
-                                    'event_espresso'
-                                )
-                            )
-                            . EEH_HTML::p(
-                                esc_html__(
-                                    'Note: If you enter 1.25, that will result in the offset of 1 hour 15 minutes being applied.  Decimals represent the fraction of hours, not minutes.',
-                                    'event_espresso'
-                                )
-                            )
-                        ),
-                        'offset_input' => new EE_Float_Input(
-                            array(
-                                'html_name' => 'offset_for_datetimes',
-                                'html_label_text' => esc_html__(
-                                    'Offset to apply (in hours):',
-                                    'event_espresso'
-                                ),
-                                'min_value' => '-12',
-                                'max_value' => '14',
-                                'step_value' => '.25',
-                                'default' => DatetimeOffsetFix::getOffset()
-                            )
-                        ),
-                        'submit' => new EE_Submit_Input(
-                            array(
-                                'html_label_text' => '',
-                                'default' => esc_html__('Apply Offset', 'event_espresso')
-                            )
-                        )
-                    )
-                )
-            );
-        }
-        return $this->datetime_fix_offset_form;
-    }
-
-
-    /**
-     * Callback for the run_datetime_offset_fix route.
-     * @throws EE_Error
-     */
-    protected function _apply_datetime_offset()
-    {
-        if ($_SERVER['REQUEST_METHOD'] === 'POST') {
-            $form = $this->_get_datetime_offset_fix_form();
-            $form->receive_form_submission($this->_req_data);
-            if ($form->is_valid()) {
-                //save offset so batch processor can get it.
-                DatetimeOffsetFix::updateOffset($form->get_input_value('offset_input'));
-                //redirect to batch tool
-                wp_redirect(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'page' => 'espresso_batch',
-                            'batch' => 'job',
-                            'label' => esc_html__('Applying Offset', 'event_espresso'),
-                            'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\DatetimeOffsetFix'),
-                            'return_url' => urlencode(home_url(add_query_arg(null, null))),
-                        ),
-                        admin_url()
-                    )
-                );
-                exit;
-            }
-        }
-    }
+	}
+
+
+	protected function _datetime_tools()
+	{
+		$form_action = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'run_datetime_offset_fix',
+				'return_action' => $this->_req_action
+			),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$form = $this->_get_datetime_offset_fix_form();
+		$this->_admin_page_title = esc_html__('Datetime Utilities', 'event_espresso');
+		$this->_template_args['admin_page_content'] = $form->form_open($form_action, 'post')
+													  . $form->get_html_and_js()
+													  . $form->form_close();
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+
+	protected function _get_datetime_offset_fix_form()
+	{
+		if (! $this->datetime_fix_offset_form instanceof EE_Form_Section_Proper) {
+			$this->datetime_fix_offset_form =  new EE_Form_Section_Proper(
+				array(
+					'name' => 'datetime_offset_fix_option',
+					'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+					'subsections' => array(
+						'title' => new EE_Form_Section_HTML(
+							EEH_HTML::h2(
+								esc_html__('Datetime Offset Tool', 'event_espresso')
+							)
+						),
+						'explanation' => new EE_Form_Section_HTML(
+							EEH_HTML::p(
+								esc_html__(
+									'Use this tool to automatically apply the provided offset to all Event Espresso records in your database that involve dates and times.',
+									'event_espresso'
+								)
+							)
+							. EEH_HTML::p(
+								esc_html__(
+									'Note: If you enter 1.25, that will result in the offset of 1 hour 15 minutes being applied.  Decimals represent the fraction of hours, not minutes.',
+									'event_espresso'
+								)
+							)
+						),
+						'offset_input' => new EE_Float_Input(
+							array(
+								'html_name' => 'offset_for_datetimes',
+								'html_label_text' => esc_html__(
+									'Offset to apply (in hours):',
+									'event_espresso'
+								),
+								'min_value' => '-12',
+								'max_value' => '14',
+								'step_value' => '.25',
+								'default' => DatetimeOffsetFix::getOffset()
+							)
+						),
+						'submit' => new EE_Submit_Input(
+							array(
+								'html_label_text' => '',
+								'default' => esc_html__('Apply Offset', 'event_espresso')
+							)
+						)
+					)
+				)
+			);
+		}
+		return $this->datetime_fix_offset_form;
+	}
+
+
+	/**
+	 * Callback for the run_datetime_offset_fix route.
+	 * @throws EE_Error
+	 */
+	protected function _apply_datetime_offset()
+	{
+		if ($_SERVER['REQUEST_METHOD'] === 'POST') {
+			$form = $this->_get_datetime_offset_fix_form();
+			$form->receive_form_submission($this->_req_data);
+			if ($form->is_valid()) {
+				//save offset so batch processor can get it.
+				DatetimeOffsetFix::updateOffset($form->get_input_value('offset_input'));
+				//redirect to batch tool
+				wp_redirect(
+					EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'page' => 'espresso_batch',
+							'batch' => 'job',
+							'label' => esc_html__('Applying Offset', 'event_espresso'),
+							'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\DatetimeOffsetFix'),
+							'return_url' => urlencode(home_url(add_query_arg(null, null))),
+						),
+						admin_url()
+					)
+				);
+				exit;
+			}
+		}
+	}
 } //end Maintenance_Admin_Page class

core/admin/EE_Admin.core.php

Spacing +28 added lines, -28 removed lines

@@ -32,7 +32,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Admin) {
+        if ( ! self::$_instance instanceof EE_Admin) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -91,11 +91,11 @@ 
      */
     private function _define_all_constants()
     {
-        if (! defined('EE_ADMIN_URL')) {
-            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
-            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
-            define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates' . DS);
-            define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
+        if ( ! defined('EE_ADMIN_URL')) {
+            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL.'core/admin/');
+            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL.'admin_pages/');
+            define('EE_ADMIN_TEMPLATE', EE_ADMIN.'templates'.DS);
+            define('WP_ADMIN_PATH', ABSPATH.'wp-admin/');
             define('WP_AJAX_URL', admin_url('admin-ajax.php'));
         }
     }
@@ -114,7 +114,7 @@ 
         // set $main_file in stone
         static $main_file;
         // if $main_file is not set yet
-        if (! $main_file) {
+        if ( ! $main_file) {
             $main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
         }
         if ($plugin === $main_file) {
@@ -165,9 +165,9 @@ 
     public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array())
     {
         return array(
-            'maintenance' => EE_ADMIN_PAGES . 'maintenance' . DS,
-            'about'       => EE_ADMIN_PAGES . 'about' . DS,
-            'support'     => EE_ADMIN_PAGES . 'support' . DS,
+            'maintenance' => EE_ADMIN_PAGES.'maintenance'.DS,
+            'about'       => EE_ADMIN_PAGES.'about'.DS,
+            'support'     => EE_ADMIN_PAGES.'support'.DS,
         );
     }
 
@@ -195,7 +195,7 @@ 
             add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 2);
         }
         // run the admin page factory but ONLY if we are doing an ee admin ajax request
-        if (! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
+        if ( ! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
             try {
                 //this loads the controller for the admin pages which will setup routing etc
                 EE_Registry::instance()->load_core('Admin_Page_Loader');
@@ -247,7 +247,7 @@ 
     public function enable_hidden_ee_nav_menu_metaboxes()
     {
         global $wp_meta_boxes, $pagenow;
-        if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
+        if ( ! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
             return;
         }
         $user = wp_get_current_user();
@@ -318,7 +318,7 @@ 
      */
     public function modify_edit_post_link($link, $id)
     {
-        if (! $post = get_post($id)) {
+        if ( ! $post = get_post($id)) {
             return $link;
         }
         if ($post->post_type === 'espresso_attendees') {
@@ -544,7 +544,7 @@ 
 
         //loop through to remove any critical pages from the array.
         foreach ($critical_pages as $page_id) {
-            $needle = 'value="' . $page_id . '"';
+            $needle = 'value="'.$page_id.'"';
             foreach ($split_output as $key => $haystack) {
                 if (strpos($haystack, $needle) !== false) {
                     unset($split_output[$key]);
@@ -570,7 +570,7 @@ 
         // calls.
         wp_enqueue_script(
             'ee-inject-wp',
-            EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js',
+            EE_ADMIN_URL.'assets/ee-cpt-wp-injects.js',
             array('jquery'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -578,7 +578,7 @@ 
         // register cookie script for future dependencies
         wp_register_script(
             'jquery-cookie',
-            EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js',
+            EE_THIRD_PARTY_URL.'joyride/jquery.cookie.js',
             array('jquery'),
             '2.1',
             true
@@ -587,16 +587,16 @@ 
         // via: add_filter('FHEE_load_joyride', '__return_true' );
         if (apply_filters('FHEE_load_joyride', false)) {
             //joyride style
-            wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
+            wp_register_style('joyride-css', EE_THIRD_PARTY_URL.'joyride/joyride-2.1.css', array(), '2.1');
             wp_register_style(
                 'ee-joyride-css',
-                EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css',
+                EE_GLOBAL_ASSETS_URL.'css/ee-joyride-styles.css',
                 array('joyride-css'),
                 EVENT_ESPRESSO_VERSION
             );
             wp_register_script(
                 'joyride-modernizr',
-                EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js',
+                EE_THIRD_PARTY_URL.'joyride/modernizr.mq.js',
                 array(),
                 '2.1',
                 true
@@ -604,7 +604,7 @@ 
             //joyride JS
             wp_register_script(
                 'jquery-joyride',
-                EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js',
+                EE_THIRD_PARTY_URL.'joyride/jquery.joyride-2.1.js',
                 array('jquery-cookie', 'joyride-modernizr'),
                 '2.1',
                 true
@@ -657,7 +657,7 @@ 
     public function get_persistent_admin_notices()
     {
         // http://www.example.com/wp-admin/admin.php?page=espresso_general_settings&action=critical_pages&critical_pages_nonce=2831ce0f30
-        $args       = array(
+        $args = array(
             'page'   => EE_Registry::instance()->REQ->is_set('page')
                 ? EE_Registry::instance()->REQ->get('page')
                 : '',
@@ -704,21 +704,21 @@ 
                 ),
             )
         );
-        $items['registrations']['url']   = EE_Admin_Page::add_query_args_and_nonce(
+        $items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce(
             array('page' => 'espresso_registrations'),
             admin_url('admin.php')
         );
-        $items['registrations']['text']  = sprintf(
+        $items['registrations']['text'] = sprintf(
             _n('%s Registration', '%s Registrations', $registrations),
             number_format_i18n($registrations)
         );
         $items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
 
-        $items = (array)apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
+        $items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
 
         foreach ($items as $type => $item_properties) {
             $elements[] = sprintf(
-                '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
+                '<a class="ee-dashboard-link-'.$type.'" href="%s" title="%s">%s</a>',
                 $item_properties['url'],
                 $item_properties['title'],
                 $item_properties['text']
@@ -744,10 +744,10 @@ 
         // check for date_format or time_format
         switch ($option) {
             case 'date_format':
-                $date_time_format = $value . ' ' . get_option('time_format');
+                $date_time_format = $value.' '.get_option('time_format');
                 break;
             case 'time_format':
-                $date_time_format = get_option('date_format') . ' ' . $value;
+                $date_time_format = get_option('date_format').' '.$value;
                 break;
             default:
                 $date_time_format = false;
@@ -770,7 +770,7 @@ 
 
 
                 foreach ($error_msg as $error) {
-                    $msg .= '<li>' . $error . '</li>';
+                    $msg .= '<li>'.$error.'</li>';
                 }
 
                 $msg .= '</ul></p><p>'

Indentation +848 added lines, -848 removed lines

@@ -15,395 +15,395 @@ 
 final class EE_Admin implements InterminableInterface
 {
 
-    /**
-     * @access private
-     * @var EE_Admin $_instance
-     */
-    private static $_instance;
-
-
-    /**
-     *@ singleton method used to instantiate class object
-     *@ access public
-     *@ return class instance
-     *
-     * @throws \EE_Error
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Admin) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @return EE_Admin
-     * @throws EE_Error
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     * class constructor
-     *
-     * @throws \EE_Error
-     */
-    protected function __construct()
-    {
-        // define global EE_Admin constants
-        $this->_define_all_constants();
-        // set autoloaders for our admin page classes based on included path information
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_ADMIN);
-        // admin hooks
-        add_filter('plugin_action_links', array($this, 'filter_plugin_actions'), 10, 2);
-        // load EE_Request_Handler early
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'get_request'));
-        add_action('AHEE__EE_System__initialize_last', array($this, 'init'));
-        add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'route_admin_request'), 100, 2);
-        add_action('wp_loaded', array($this, 'wp_loaded'), 100);
-        add_action('admin_init', array($this, 'admin_init'), 100);
-        add_action('admin_enqueue_scripts', array($this, 'enqueue_admin_scripts'), 20);
-        add_action('admin_notices', array($this, 'display_admin_notices'), 10);
-        add_action('network_admin_notices', array($this, 'display_admin_notices'), 10);
-        add_filter('pre_update_option', array($this, 'check_for_invalid_datetime_formats'), 100, 2);
-        add_filter('admin_footer_text', array($this, 'espresso_admin_footer'));
-
-        //reset Environment config (we only do this on admin page loads);
-        EE_Registry::instance()->CFG->environment->recheck_values();
-
-        do_action('AHEE__EE_Admin__loaded');
-    }
-
-
-    /**
-     * _define_all_constants
-     * define constants that are set globally for all admin pages
-     *
-     * @access private
-     * @return void
-     */
-    private function _define_all_constants()
-    {
-        if (! defined('EE_ADMIN_URL')) {
-            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
-            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
-            define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates' . DS);
-            define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
-            define('WP_AJAX_URL', admin_url('admin-ajax.php'));
-        }
-    }
-
-
-    /**
-     *    filter_plugin_actions - adds links to the Plugins page listing
-     *
-     * @access    public
-     * @param    array  $links
-     * @param    string $plugin
-     * @return    array
-     */
-    public function filter_plugin_actions($links, $plugin)
-    {
-        // set $main_file in stone
-        static $main_file;
-        // if $main_file is not set yet
-        if (! $main_file) {
-            $main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
-        }
-        if ($plugin === $main_file) {
-            // compare current plugin to this one
-            if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
-                $maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
-                                    . ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
-                                    . esc_html__('Maintenance Mode Active', 'event_espresso')
-                                    . '</a>';
-                array_unshift($links, $maintenance_link);
-            } else {
-                $org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
-                                     . esc_html__('Settings', 'event_espresso')
-                                     . '</a>';
-                $events_link       = '<a href="admin.php?page=espresso_events">'
-                                     . esc_html__('Events', 'event_espresso')
-                                     . '</a>';
-                // add before other links
-                array_unshift($links, $org_settings_link, $events_link);
-            }
-        }
-        return $links;
-    }
-
-
-    /**
-     *    _get_request
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_request()
-    {
-        EE_Registry::instance()->load_core('Request_Handler');
-        EE_Registry::instance()->load_core('CPT_Strategy');
-    }
-
-
-    /**
-     *    hide_admin_pages_except_maintenance_mode
-     *
-     * @access public
-     * @param array $admin_page_folder_names
-     * @return array
-     */
-    public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array())
-    {
-        return array(
-            'maintenance' => EE_ADMIN_PAGES . 'maintenance' . DS,
-            'about'       => EE_ADMIN_PAGES . 'about' . DS,
-            'support'     => EE_ADMIN_PAGES . 'support' . DS,
-        );
-    }
-
-
-    /**
-     * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
-     * EE_Front_Controller's init phases have run
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function init()
-    {
-        //only enable most of the EE_Admin IF we're not in full maintenance mode
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            //ok so we want to enable the entire admin
-            add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismiss_ee_nag_notice_callback'));
-            add_action('admin_notices', array($this, 'get_persistent_admin_notices'), 9);
-            add_action('network_admin_notices', array($this, 'get_persistent_admin_notices'), 9);
-            //at a glance dashboard widget
-            add_filter('dashboard_glance_items', array($this, 'dashboard_glance_items'), 10);
-            //filter for get_edit_post_link used on comments for custom post types
-            add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 2);
-        }
-        // run the admin page factory but ONLY if we are doing an ee admin ajax request
-        if (! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
-            try {
-                //this loads the controller for the admin pages which will setup routing etc
-                EE_Registry::instance()->load_core('Admin_Page_Loader');
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-        add_filter('content_save_pre', array($this, 'its_eSpresso'), 10, 1);
-        //make sure our CPTs and custom taxonomy metaboxes get shown for first time users
-        add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes'), 10);
-        add_action('admin_head', array($this, 'register_custom_nav_menu_boxes'), 10);
-        //exclude EE critical pages from all nav menus and wp_list_pages
-        add_filter('nav_menu_meta_box_object', array($this, 'remove_pages_from_nav_menu'), 10);
-    }
-
-
-    /**
-     * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
-     * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
-     * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
-     * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
-     * normal property on the post_type object.  It's found ONLY in this particular context.
-     *
-     * @param  object $post_type WP post type object
-     * @return object            WP post type object
-     */
-    public function remove_pages_from_nav_menu($post_type)
-    {
-        //if this isn't the "pages" post type let's get out
-        if ($post_type->name !== 'page') {
-            return $post_type;
-        }
-        $critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-
-        $post_type->_default_query = array(
-            'post__not_in' => $critical_pages,
-        );
-        return $post_type;
-    }
-
-
-    /**
-     * WP by default only shows three metaboxes in "nav-menus.php" for first times users.  We want to make sure our
-     * metaboxes get shown as well
-     *
-     * @access public
-     * @return void
-     */
-    public function enable_hidden_ee_nav_menu_metaboxes()
-    {
-        global $wp_meta_boxes, $pagenow;
-        if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
-            return;
-        }
-        $user = wp_get_current_user();
-        //has this been done yet?
-        if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
-            return;
-        }
-
-        $hidden_meta_boxes  = get_user_option('metaboxhidden_nav-menus', $user->ID);
-        $initial_meta_boxes = apply_filters(
-            'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
-            array(
-                'nav-menu-theme-locations',
-                'add-page',
-                'add-custom-links',
-                'add-category',
-                'add-espresso_events',
-                'add-espresso_venues',
-                'add-espresso_event_categories',
-                'add-espresso_venue_categories',
-                'add-post-type-post',
-                'add-post-type-page',
-            )
-        );
-
-        if (is_array($hidden_meta_boxes)) {
-            foreach ($hidden_meta_boxes as $key => $meta_box_id) {
-                if (in_array($meta_box_id, $initial_meta_boxes)) {
-                    unset($hidden_meta_boxes[$key]);
-                }
-            }
-        }
-
-        update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
-        update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
-    }
-
-
-    /**
-     * This method simply registers custom nav menu boxes for "nav_menus.php route"
-     * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
-     *
-     * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
-     *         addons etc.
-     * @access public
-     * @return void
-     */
-    public function register_custom_nav_menu_boxes()
-    {
-        add_meta_box(
-            'add-extra-nav-menu-pages',
-            esc_html__('Event Espresso Pages', 'event_espresso'),
-            array($this, 'ee_cpt_archive_pages'),
-            'nav-menus',
-            'side',
-            'core'
-        );
-    }
-
-
-    /**
-     * Use this to edit the post link for our cpts so that the edit link points to the correct page.
-     *
-     * @since   4.3.0
-     * @param string $link the original link generated by wp
-     * @param int    $id   post id
-     * @return string  the (maybe) modified link
-     */
-    public function modify_edit_post_link($link, $id)
-    {
-        if (! $post = get_post($id)) {
-            return $link;
-        }
-        if ($post->post_type === 'espresso_attendees') {
-            $query_args = array(
-                'action' => 'edit_attendee',
-                'post'   => $id,
-            );
-            return EEH_URL::add_query_args_and_nonce(
-                $query_args,
-                admin_url('admin.php?page=espresso_registrations')
-            );
-        }
-        return $link;
-    }
-
-
-    public function ee_cpt_archive_pages()
-    {
-        global $nav_menu_selected_id;
-
-        $db_fields   = false;
-        $walker      = new Walker_Nav_Menu_Checklist($db_fields);
-        $current_tab = 'event-archives';
-
-        /*if ( ! empty( $_REQUEST['quick-search-posttype-' . $post_type_name] ) ) {
+	/**
+	 * @access private
+	 * @var EE_Admin $_instance
+	 */
+	private static $_instance;
+
+
+	/**
+	 *@ singleton method used to instantiate class object
+	 *@ access public
+	 *@ return class instance
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Admin) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @return EE_Admin
+	 * @throws EE_Error
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 * class constructor
+	 *
+	 * @throws \EE_Error
+	 */
+	protected function __construct()
+	{
+		// define global EE_Admin constants
+		$this->_define_all_constants();
+		// set autoloaders for our admin page classes based on included path information
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_ADMIN);
+		// admin hooks
+		add_filter('plugin_action_links', array($this, 'filter_plugin_actions'), 10, 2);
+		// load EE_Request_Handler early
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'get_request'));
+		add_action('AHEE__EE_System__initialize_last', array($this, 'init'));
+		add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'route_admin_request'), 100, 2);
+		add_action('wp_loaded', array($this, 'wp_loaded'), 100);
+		add_action('admin_init', array($this, 'admin_init'), 100);
+		add_action('admin_enqueue_scripts', array($this, 'enqueue_admin_scripts'), 20);
+		add_action('admin_notices', array($this, 'display_admin_notices'), 10);
+		add_action('network_admin_notices', array($this, 'display_admin_notices'), 10);
+		add_filter('pre_update_option', array($this, 'check_for_invalid_datetime_formats'), 100, 2);
+		add_filter('admin_footer_text', array($this, 'espresso_admin_footer'));
+
+		//reset Environment config (we only do this on admin page loads);
+		EE_Registry::instance()->CFG->environment->recheck_values();
+
+		do_action('AHEE__EE_Admin__loaded');
+	}
+
+
+	/**
+	 * _define_all_constants
+	 * define constants that are set globally for all admin pages
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _define_all_constants()
+	{
+		if (! defined('EE_ADMIN_URL')) {
+			define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
+			define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
+			define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates' . DS);
+			define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
+			define('WP_AJAX_URL', admin_url('admin-ajax.php'));
+		}
+	}
+
+
+	/**
+	 *    filter_plugin_actions - adds links to the Plugins page listing
+	 *
+	 * @access    public
+	 * @param    array  $links
+	 * @param    string $plugin
+	 * @return    array
+	 */
+	public function filter_plugin_actions($links, $plugin)
+	{
+		// set $main_file in stone
+		static $main_file;
+		// if $main_file is not set yet
+		if (! $main_file) {
+			$main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
+		}
+		if ($plugin === $main_file) {
+			// compare current plugin to this one
+			if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
+				$maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
+									. ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
+									. esc_html__('Maintenance Mode Active', 'event_espresso')
+									. '</a>';
+				array_unshift($links, $maintenance_link);
+			} else {
+				$org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
+									 . esc_html__('Settings', 'event_espresso')
+									 . '</a>';
+				$events_link       = '<a href="admin.php?page=espresso_events">'
+									 . esc_html__('Events', 'event_espresso')
+									 . '</a>';
+				// add before other links
+				array_unshift($links, $org_settings_link, $events_link);
+			}
+		}
+		return $links;
+	}
+
+
+	/**
+	 *    _get_request
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_request()
+	{
+		EE_Registry::instance()->load_core('Request_Handler');
+		EE_Registry::instance()->load_core('CPT_Strategy');
+	}
+
+
+	/**
+	 *    hide_admin_pages_except_maintenance_mode
+	 *
+	 * @access public
+	 * @param array $admin_page_folder_names
+	 * @return array
+	 */
+	public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array())
+	{
+		return array(
+			'maintenance' => EE_ADMIN_PAGES . 'maintenance' . DS,
+			'about'       => EE_ADMIN_PAGES . 'about' . DS,
+			'support'     => EE_ADMIN_PAGES . 'support' . DS,
+		);
+	}
+
+
+	/**
+	 * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
+	 * EE_Front_Controller's init phases have run
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function init()
+	{
+		//only enable most of the EE_Admin IF we're not in full maintenance mode
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			//ok so we want to enable the entire admin
+			add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismiss_ee_nag_notice_callback'));
+			add_action('admin_notices', array($this, 'get_persistent_admin_notices'), 9);
+			add_action('network_admin_notices', array($this, 'get_persistent_admin_notices'), 9);
+			//at a glance dashboard widget
+			add_filter('dashboard_glance_items', array($this, 'dashboard_glance_items'), 10);
+			//filter for get_edit_post_link used on comments for custom post types
+			add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 2);
+		}
+		// run the admin page factory but ONLY if we are doing an ee admin ajax request
+		if (! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
+			try {
+				//this loads the controller for the admin pages which will setup routing etc
+				EE_Registry::instance()->load_core('Admin_Page_Loader');
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+		add_filter('content_save_pre', array($this, 'its_eSpresso'), 10, 1);
+		//make sure our CPTs and custom taxonomy metaboxes get shown for first time users
+		add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes'), 10);
+		add_action('admin_head', array($this, 'register_custom_nav_menu_boxes'), 10);
+		//exclude EE critical pages from all nav menus and wp_list_pages
+		add_filter('nav_menu_meta_box_object', array($this, 'remove_pages_from_nav_menu'), 10);
+	}
+
+
+	/**
+	 * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
+	 * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
+	 * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
+	 * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
+	 * normal property on the post_type object.  It's found ONLY in this particular context.
+	 *
+	 * @param  object $post_type WP post type object
+	 * @return object            WP post type object
+	 */
+	public function remove_pages_from_nav_menu($post_type)
+	{
+		//if this isn't the "pages" post type let's get out
+		if ($post_type->name !== 'page') {
+			return $post_type;
+		}
+		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+
+		$post_type->_default_query = array(
+			'post__not_in' => $critical_pages,
+		);
+		return $post_type;
+	}
+
+
+	/**
+	 * WP by default only shows three metaboxes in "nav-menus.php" for first times users.  We want to make sure our
+	 * metaboxes get shown as well
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function enable_hidden_ee_nav_menu_metaboxes()
+	{
+		global $wp_meta_boxes, $pagenow;
+		if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
+			return;
+		}
+		$user = wp_get_current_user();
+		//has this been done yet?
+		if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
+			return;
+		}
+
+		$hidden_meta_boxes  = get_user_option('metaboxhidden_nav-menus', $user->ID);
+		$initial_meta_boxes = apply_filters(
+			'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
+			array(
+				'nav-menu-theme-locations',
+				'add-page',
+				'add-custom-links',
+				'add-category',
+				'add-espresso_events',
+				'add-espresso_venues',
+				'add-espresso_event_categories',
+				'add-espresso_venue_categories',
+				'add-post-type-post',
+				'add-post-type-page',
+			)
+		);
+
+		if (is_array($hidden_meta_boxes)) {
+			foreach ($hidden_meta_boxes as $key => $meta_box_id) {
+				if (in_array($meta_box_id, $initial_meta_boxes)) {
+					unset($hidden_meta_boxes[$key]);
+				}
+			}
+		}
+
+		update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
+		update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
+	}
+
+
+	/**
+	 * This method simply registers custom nav menu boxes for "nav_menus.php route"
+	 * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
+	 *
+	 * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
+	 *         addons etc.
+	 * @access public
+	 * @return void
+	 */
+	public function register_custom_nav_menu_boxes()
+	{
+		add_meta_box(
+			'add-extra-nav-menu-pages',
+			esc_html__('Event Espresso Pages', 'event_espresso'),
+			array($this, 'ee_cpt_archive_pages'),
+			'nav-menus',
+			'side',
+			'core'
+		);
+	}
+
+
+	/**
+	 * Use this to edit the post link for our cpts so that the edit link points to the correct page.
+	 *
+	 * @since   4.3.0
+	 * @param string $link the original link generated by wp
+	 * @param int    $id   post id
+	 * @return string  the (maybe) modified link
+	 */
+	public function modify_edit_post_link($link, $id)
+	{
+		if (! $post = get_post($id)) {
+			return $link;
+		}
+		if ($post->post_type === 'espresso_attendees') {
+			$query_args = array(
+				'action' => 'edit_attendee',
+				'post'   => $id,
+			);
+			return EEH_URL::add_query_args_and_nonce(
+				$query_args,
+				admin_url('admin.php?page=espresso_registrations')
+			);
+		}
+		return $link;
+	}
+
+
+	public function ee_cpt_archive_pages()
+	{
+		global $nav_menu_selected_id;
+
+		$db_fields   = false;
+		$walker      = new Walker_Nav_Menu_Checklist($db_fields);
+		$current_tab = 'event-archives';
+
+		/*if ( ! empty( $_REQUEST['quick-search-posttype-' . $post_type_name] ) ) {
             $current_tab = 'search';
         }/**/
 
-        $removed_args = array(
-            'action',
-            'customlink-tab',
-            'edit-menu-item',
-            'menu-item',
-            'page-tab',
-            '_wpnonce',
-        );
+		$removed_args = array(
+			'action',
+			'customlink-tab',
+			'edit-menu-item',
+			'menu-item',
+			'page-tab',
+			'_wpnonce',
+		);
 
-        ?>
+		?>
         <div id="posttype-extra-nav-menu-pages" class="posttypediv">
             <ul id="posttype-extra-nav-menu-pages-tabs" class="posttype-tabs add-menu-item-tabs">
                 <li <?php echo('event-archives' === $current_tab ? ' class="tabs"' : ''); ?>>
                     <a class="nav-tab-link" data-type="tabs-panel-posttype-extra-nav-menu-pages-event-archives"
                        href="<?php if ($nav_menu_selected_id) {
-                            echo esc_url(
-                                add_query_arg(
-                                    'extra-nav-menu-pages-tab',
-                                    'event-archives',
-                                    remove_query_arg($removed_args)
-                                )
-                            );
-                       } ?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
+							echo esc_url(
+								add_query_arg(
+									'extra-nav-menu-pages-tab',
+									'event-archives',
+									remove_query_arg($removed_args)
+								)
+							);
+					   } ?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
                         <?php _e('Event Archive Pages', 'event_espresso'); ?>
                     </a>
                 </li>
 
                 <div id="tabs-panel-posttype-extra-nav-menu-pages-event-archives" class="tabs-panel <?php
-                echo('event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive');
-                ?>">
+				echo('event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive');
+				?>">
                     <ul id="extra-nav-menu-pageschecklist-event-archives" class="categorychecklist form-no-clear">
                         <?php
-                        $pages          = $this->_get_extra_nav_menu_pages_items();
-                        $args['walker'] = $walker;
-                        echo walk_nav_menu_tree(
-                            array_map(
-                                array($this, '_setup_extra_nav_menu_pages_items'),
-                                $pages
-                            ),
-                            0,
-                            (object) $args
-                        );
-                        ?>
+						$pages          = $this->_get_extra_nav_menu_pages_items();
+						$args['walker'] = $walker;
+						echo walk_nav_menu_tree(
+							array_map(
+								array($this, '_setup_extra_nav_menu_pages_items'),
+								$pages
+							),
+							0,
+							(object) $args
+						);
+						?>
                     </ul>
                 </div><!-- /.tabs-panel -->
 
                 <p class="button-controls">
                 <span class="list-controls">
                     <a href="<?php
-                    echo esc_url(add_query_arg(
-                        array(
-                            'extra-nav-menu-pages-tab' => 'event-archives',
-                            'selectall'                => 1,
-                        ),
-                        remove_query_arg($removed_args)
-                    ));
-                    ?>#posttype-extra-nav-menu-pages>" class="select-all"><?php _e('Select All'); ?></a>
+					echo esc_url(add_query_arg(
+						array(
+							'extra-nav-menu-pages-tab' => 'event-archives',
+							'selectall'                => 1,
+						),
+						remove_query_arg($removed_args)
+					));
+					?>#posttype-extra-nav-menu-pages>" class="select-all"><?php _e('Select All'); ?></a>
                 </span>
                 <span class="add-to-menu">
                     <input type="submit"<?php wp_nav_menu_disabled_check($nav_menu_selected_id); ?>
@@ -416,485 +416,485 @@ 
 
         </div><!-- /.posttypediv -->
         <?php
-    }
-
-
-    /**
-     * Returns an array of event archive nav items.
-     *
-     * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
-     *        method we use for getting the extra nav menu items
-     * @return array
-     */
-    private function _get_extra_nav_menu_pages_items()
-    {
-        $menuitems[] = array(
-            'title'       => esc_html__('Event List', 'event_espresso'),
-            'url'         => get_post_type_archive_link('espresso_events'),
-            'description' => esc_html__('Archive page for all events.', 'event_espresso'),
-        );
-        return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
-    }
-
-
-    /**
-     * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
-     * the properties and converts it to the menu item object.
-     *
-     * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
-     * @param $menu_item_values
-     * @return stdClass
-     */
-    private function _setup_extra_nav_menu_pages_items($menu_item_values)
-    {
-        $menu_item = new stdClass();
-        $keys      = array(
-            'ID'               => 0,
-            'db_id'            => 0,
-            'menu_item_parent' => 0,
-            'object_id'        => -1,
-            'post_parent'      => 0,
-            'type'             => 'custom',
-            'object'           => '',
-            'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
-            'title'            => '',
-            'url'              => '',
-            'target'           => '',
-            'attr_title'       => '',
-            'description'      => '',
-            'classes'          => array(),
-            'xfn'              => '',
-        );
-
-        foreach ($keys as $key => $value) {
-            $menu_item->{$key} = isset($menu_item_values[$key]) ? $menu_item_values[$key] : $value;
-        }
-        return $menu_item;
-    }
-
-
-    /**
-     * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
-     * EE_Admin_Page route is called.
-     *
-     * @return void
-     */
-    public function route_admin_request()
-    {
-    }
-
-
-    /**
-     * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
-     *
-     * @return void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-    /**
-     * admin_init
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function admin_init()
-    {
-
-        /**
-         * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
-         * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
-         * - check if doing post processing.
-         * - check if doing post processing of one of EE CPTs
-         * - instantiate the corresponding EE CPT model for the post_type being processed.
-         */
-        if (isset($_POST['action'], $_POST['post_type']) && $_POST['action'] === 'editpost') {
-            EE_Registry::instance()->load_core('Register_CPTs');
-            EE_Register_CPTs::instantiate_cpt_models($_POST['post_type']);
-        }
-
-
-        /**
-         * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
-         * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
-         * Pages" tab in the EE General Settings Admin page.
-         * This is for user-proofing.
-         */
-        add_filter('wp_dropdown_pages', array($this, 'modify_dropdown_pages'));
-    }
-
-
-    /**
-     * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
-     *
-     * @param string $output Current output.
-     * @return string
-     */
-    public function modify_dropdown_pages($output)
-    {
-        //get critical pages
-        $critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-
-        //split current output by line break for easier parsing.
-        $split_output = explode("\n", $output);
-
-        //loop through to remove any critical pages from the array.
-        foreach ($critical_pages as $page_id) {
-            $needle = 'value="' . $page_id . '"';
-            foreach ($split_output as $key => $haystack) {
-                if (strpos($haystack, $needle) !== false) {
-                    unset($split_output[$key]);
-                }
-            }
-        }
-
-        //replace output with the new contents
-        return implode("\n", $split_output);
-    }
-
-
-    /**
-     * enqueue all admin scripts that need loaded for admin pages
-     *
-     * @access public
-     * @return void
-     */
-    public function enqueue_admin_scripts()
-    {
-        // this javascript is loaded on every admin page to catch any injections ee needs to add to wp run js.
-        // Note: the intention of this script is to only do TARGETED injections.  I.E, only injecting on certain script
-        // calls.
-        wp_enqueue_script(
-            'ee-inject-wp',
-            EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        // register cookie script for future dependencies
-        wp_register_script(
-            'jquery-cookie',
-            EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js',
-            array('jquery'),
-            '2.1',
-            true
-        );
-        //joyride is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again
-        // via: add_filter('FHEE_load_joyride', '__return_true' );
-        if (apply_filters('FHEE_load_joyride', false)) {
-            //joyride style
-            wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
-            wp_register_style(
-                'ee-joyride-css',
-                EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css',
-                array('joyride-css'),
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_register_script(
-                'joyride-modernizr',
-                EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js',
-                array(),
-                '2.1',
-                true
-            );
-            //joyride JS
-            wp_register_script(
-                'jquery-joyride',
-                EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js',
-                array('jquery-cookie', 'joyride-modernizr'),
-                '2.1',
-                true
-            );
-            // wanna go for a joyride?
-            wp_enqueue_style('ee-joyride-css');
-            wp_enqueue_script('jquery-joyride');
-        }
-    }
-
-
-    /**
-     *    display_admin_notices
-     *
-     * @access    public
-     * @return    string
-     */
-    public function display_admin_notices()
-    {
-        //add non-dismissable notice for datetime changes.  Only valid if EE version is greater than 4.9.46.p and the
-        // site does not have a timezone_string set.
-        if (EE_Register_Addon::_meets_min_core_version_requirement(
-                '4.9.46.p'
-            )
-            && ! get_option('timezone_string')
-        ) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        '%1$sImportant%2$s: Please note some upcoming changes to dates and times in Event Espresso that may affect your website.  Read more about it %3$shere%4$s.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>',
-                    '<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
-                    '</a>'
-                )
-            );
-        }
-        echo EE_Error::get_notices();
-    }
-
-
-    /**
-     *    get_persistent_admin_notices
-     *
-     * @access    public
-     * @return        void
-     */
-    public function get_persistent_admin_notices()
-    {
-        // http://www.example.com/wp-admin/admin.php?page=espresso_general_settings&action=critical_pages&critical_pages_nonce=2831ce0f30
-        $args       = array(
-            'page'   => EE_Registry::instance()->REQ->is_set('page')
-                ? EE_Registry::instance()->REQ->get('page')
-                : '',
-            'action' => EE_Registry::instance()->REQ->is_set('action')
-                ? EE_Registry::instance()->REQ->get('action')
-                : '',
-        );
-        $return_url = EE_Admin_Page::add_query_args_and_nonce($args, EE_ADMIN_URL);
-        echo EE_Error::get_persistent_admin_notices($return_url);
-    }
-
-
-    /**
-     *    dismiss_persistent_admin_notice
-     *
-     * @access    public
-     * @return        void
-     */
-    public function dismiss_ee_nag_notice_callback()
-    {
-        EE_Error::dismiss_persistent_admin_notice();
-    }
-
-
-    /**
-     * @param array $elements
-     * @return array
-     * @throws \EE_Error
-     */
-    public function dashboard_glance_items($elements)
-    {
-        $elements                        = is_array($elements) ? $elements : array($elements);
-        $events                          = EEM_Event::instance()->count();
-        $items['events']['url']          = EE_Admin_Page::add_query_args_and_nonce(
-            array('page' => 'espresso_events'),
-            admin_url('admin.php')
-        );
-        $items['events']['text']         = sprintf(_n('%s Event', '%s Events', $events), number_format_i18n($events));
-        $items['events']['title']        = esc_html__('Click to view all Events', 'event_espresso');
-        $registrations                   = EEM_Registration::instance()->count(
-            array(
-                array(
-                    'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
-                ),
-            )
-        );
-        $items['registrations']['url']   = EE_Admin_Page::add_query_args_and_nonce(
-            array('page' => 'espresso_registrations'),
-            admin_url('admin.php')
-        );
-        $items['registrations']['text']  = sprintf(
-            _n('%s Registration', '%s Registrations', $registrations),
-            number_format_i18n($registrations)
-        );
-        $items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
-
-        $items = (array)apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
-
-        foreach ($items as $type => $item_properties) {
-            $elements[] = sprintf(
-                '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
-                $item_properties['url'],
-                $item_properties['title'],
-                $item_properties['text']
-            );
-        }
-        return $elements;
-    }
-
-
-    /**
-     *    check_for_invalid_datetime_formats
-     *    if an admin changes their date or time format settings on the WP General Settings admin page, verify that
-     *    their selected format can be parsed by PHP
-     *
-     * @access    public
-     * @param    $value
-     * @param    $option
-     * @throws EE_Error
-     * @return    string
-     */
-    public function check_for_invalid_datetime_formats($value, $option)
-    {
-        // check for date_format or time_format
-        switch ($option) {
-            case 'date_format':
-                $date_time_format = $value . ' ' . get_option('time_format');
-                break;
-            case 'time_format':
-                $date_time_format = get_option('date_format') . ' ' . $value;
-                break;
-            default:
-                $date_time_format = false;
-        }
-        // do we have a date_time format to check ?
-        if ($date_time_format) {
-            $error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
-
-            if (is_array($error_msg)) {
-                $msg = '<p>'
-                       . sprintf(
-                           esc_html__(
-                               'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
-                               'event_espresso'
-                           ),
-                           date($date_time_format),
-                           $date_time_format
-                       )
-                       . '</p><p><ul>';
-
-
-                foreach ($error_msg as $error) {
-                    $msg .= '<li>' . $error . '</li>';
-                }
-
-                $msg .= '</ul></p><p>'
-                        . sprintf(
-                            esc_html__(
-                                '%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
-                                'event_espresso'
-                            ),
-                            '<span style="color:#D54E21;">',
-                            '</span>'
-                        )
-                        . '</p>';
-
-                // trigger WP settings error
-                add_settings_error(
-                    'date_format',
-                    'date_format',
-                    $msg
-                );
-
-                // set format to something valid
-                switch ($option) {
-                    case 'date_format':
-                        $value = 'F j, Y';
-                        break;
-                    case 'time_format':
-                        $value = 'g:i a';
-                        break;
-                }
-            }
-        }
-        return $value;
-    }
-
-
-    /**
-     *    its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
-     *
-     * @access    public
-     * @param $content
-     * @return    string
-     */
-    public function its_eSpresso($content)
-    {
-        return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
-    }
-
-
-    /**
-     *    espresso_admin_footer
-     *
-     * @access    public
-     * @return    string
-     */
-    public function espresso_admin_footer()
-    {
-        return \EEH_Template::powered_by_event_espresso('aln-cntr', '', array('utm_content' => 'admin_footer'));
-    }
-
-
-    /**
-     * static method for registering ee admin page.
-     * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
-     *
-     * @since      4.3.0
-     * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
-     * @see        EE_Register_Admin_Page::register()
-     * @param       $page_basename
-     * @param       $page_path
-     * @param array $config
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_ee_admin_page($page_basename, $page_path, $config = array())
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
-                    'event_espresso'
-                ),
-                $page_basename
-            ),
-            '4.3'
-        );
-        if (class_exists('EE_Register_Admin_Page')) {
-            $config['page_path'] = $page_path;
-        }
-        EE_Register_Admin_Page::register($page_basename, $config);
-    }
-
-
-    /**
-     * @deprecated 4.8.41
-     * @access     public
-     * @param  int      $post_ID
-     * @param  \WP_Post $post
-     * @return void
-     */
-    public static function parse_post_content_on_save($post_ID, $post)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.8.41
-     * @access     public
-     * @param  $option
-     * @param  $old_value
-     * @param  $value
-     * @return void
-     */
-    public function reset_page_for_posts_on_change($option, $old_value, $value)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
+	}
+
+
+	/**
+	 * Returns an array of event archive nav items.
+	 *
+	 * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
+	 *        method we use for getting the extra nav menu items
+	 * @return array
+	 */
+	private function _get_extra_nav_menu_pages_items()
+	{
+		$menuitems[] = array(
+			'title'       => esc_html__('Event List', 'event_espresso'),
+			'url'         => get_post_type_archive_link('espresso_events'),
+			'description' => esc_html__('Archive page for all events.', 'event_espresso'),
+		);
+		return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
+	}
+
+
+	/**
+	 * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
+	 * the properties and converts it to the menu item object.
+	 *
+	 * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
+	 * @param $menu_item_values
+	 * @return stdClass
+	 */
+	private function _setup_extra_nav_menu_pages_items($menu_item_values)
+	{
+		$menu_item = new stdClass();
+		$keys      = array(
+			'ID'               => 0,
+			'db_id'            => 0,
+			'menu_item_parent' => 0,
+			'object_id'        => -1,
+			'post_parent'      => 0,
+			'type'             => 'custom',
+			'object'           => '',
+			'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
+			'title'            => '',
+			'url'              => '',
+			'target'           => '',
+			'attr_title'       => '',
+			'description'      => '',
+			'classes'          => array(),
+			'xfn'              => '',
+		);
+
+		foreach ($keys as $key => $value) {
+			$menu_item->{$key} = isset($menu_item_values[$key]) ? $menu_item_values[$key] : $value;
+		}
+		return $menu_item;
+	}
+
+
+	/**
+	 * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
+	 * EE_Admin_Page route is called.
+	 *
+	 * @return void
+	 */
+	public function route_admin_request()
+	{
+	}
+
+
+	/**
+	 * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
+	 *
+	 * @return void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+	/**
+	 * admin_init
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function admin_init()
+	{
+
+		/**
+		 * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
+		 * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
+		 * - check if doing post processing.
+		 * - check if doing post processing of one of EE CPTs
+		 * - instantiate the corresponding EE CPT model for the post_type being processed.
+		 */
+		if (isset($_POST['action'], $_POST['post_type']) && $_POST['action'] === 'editpost') {
+			EE_Registry::instance()->load_core('Register_CPTs');
+			EE_Register_CPTs::instantiate_cpt_models($_POST['post_type']);
+		}
+
+
+		/**
+		 * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
+		 * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
+		 * Pages" tab in the EE General Settings Admin page.
+		 * This is for user-proofing.
+		 */
+		add_filter('wp_dropdown_pages', array($this, 'modify_dropdown_pages'));
+	}
+
+
+	/**
+	 * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
+	 *
+	 * @param string $output Current output.
+	 * @return string
+	 */
+	public function modify_dropdown_pages($output)
+	{
+		//get critical pages
+		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+
+		//split current output by line break for easier parsing.
+		$split_output = explode("\n", $output);
+
+		//loop through to remove any critical pages from the array.
+		foreach ($critical_pages as $page_id) {
+			$needle = 'value="' . $page_id . '"';
+			foreach ($split_output as $key => $haystack) {
+				if (strpos($haystack, $needle) !== false) {
+					unset($split_output[$key]);
+				}
+			}
+		}
+
+		//replace output with the new contents
+		return implode("\n", $split_output);
+	}
+
+
+	/**
+	 * enqueue all admin scripts that need loaded for admin pages
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function enqueue_admin_scripts()
+	{
+		// this javascript is loaded on every admin page to catch any injections ee needs to add to wp run js.
+		// Note: the intention of this script is to only do TARGETED injections.  I.E, only injecting on certain script
+		// calls.
+		wp_enqueue_script(
+			'ee-inject-wp',
+			EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		// register cookie script for future dependencies
+		wp_register_script(
+			'jquery-cookie',
+			EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js',
+			array('jquery'),
+			'2.1',
+			true
+		);
+		//joyride is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again
+		// via: add_filter('FHEE_load_joyride', '__return_true' );
+		if (apply_filters('FHEE_load_joyride', false)) {
+			//joyride style
+			wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
+			wp_register_style(
+				'ee-joyride-css',
+				EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css',
+				array('joyride-css'),
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_register_script(
+				'joyride-modernizr',
+				EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js',
+				array(),
+				'2.1',
+				true
+			);
+			//joyride JS
+			wp_register_script(
+				'jquery-joyride',
+				EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js',
+				array('jquery-cookie', 'joyride-modernizr'),
+				'2.1',
+				true
+			);
+			// wanna go for a joyride?
+			wp_enqueue_style('ee-joyride-css');
+			wp_enqueue_script('jquery-joyride');
+		}
+	}
+
+
+	/**
+	 *    display_admin_notices
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function display_admin_notices()
+	{
+		//add non-dismissable notice for datetime changes.  Only valid if EE version is greater than 4.9.46.p and the
+		// site does not have a timezone_string set.
+		if (EE_Register_Addon::_meets_min_core_version_requirement(
+				'4.9.46.p'
+			)
+			&& ! get_option('timezone_string')
+		) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'%1$sImportant%2$s: Please note some upcoming changes to dates and times in Event Espresso that may affect your website.  Read more about it %3$shere%4$s.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>',
+					'<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
+					'</a>'
+				)
+			);
+		}
+		echo EE_Error::get_notices();
+	}
+
+
+	/**
+	 *    get_persistent_admin_notices
+	 *
+	 * @access    public
+	 * @return        void
+	 */
+	public function get_persistent_admin_notices()
+	{
+		// http://www.example.com/wp-admin/admin.php?page=espresso_general_settings&action=critical_pages&critical_pages_nonce=2831ce0f30
+		$args       = array(
+			'page'   => EE_Registry::instance()->REQ->is_set('page')
+				? EE_Registry::instance()->REQ->get('page')
+				: '',
+			'action' => EE_Registry::instance()->REQ->is_set('action')
+				? EE_Registry::instance()->REQ->get('action')
+				: '',
+		);
+		$return_url = EE_Admin_Page::add_query_args_and_nonce($args, EE_ADMIN_URL);
+		echo EE_Error::get_persistent_admin_notices($return_url);
+	}
+
+
+	/**
+	 *    dismiss_persistent_admin_notice
+	 *
+	 * @access    public
+	 * @return        void
+	 */
+	public function dismiss_ee_nag_notice_callback()
+	{
+		EE_Error::dismiss_persistent_admin_notice();
+	}
+
+
+	/**
+	 * @param array $elements
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function dashboard_glance_items($elements)
+	{
+		$elements                        = is_array($elements) ? $elements : array($elements);
+		$events                          = EEM_Event::instance()->count();
+		$items['events']['url']          = EE_Admin_Page::add_query_args_and_nonce(
+			array('page' => 'espresso_events'),
+			admin_url('admin.php')
+		);
+		$items['events']['text']         = sprintf(_n('%s Event', '%s Events', $events), number_format_i18n($events));
+		$items['events']['title']        = esc_html__('Click to view all Events', 'event_espresso');
+		$registrations                   = EEM_Registration::instance()->count(
+			array(
+				array(
+					'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
+				),
+			)
+		);
+		$items['registrations']['url']   = EE_Admin_Page::add_query_args_and_nonce(
+			array('page' => 'espresso_registrations'),
+			admin_url('admin.php')
+		);
+		$items['registrations']['text']  = sprintf(
+			_n('%s Registration', '%s Registrations', $registrations),
+			number_format_i18n($registrations)
+		);
+		$items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
+
+		$items = (array)apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
+
+		foreach ($items as $type => $item_properties) {
+			$elements[] = sprintf(
+				'<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
+				$item_properties['url'],
+				$item_properties['title'],
+				$item_properties['text']
+			);
+		}
+		return $elements;
+	}
+
+
+	/**
+	 *    check_for_invalid_datetime_formats
+	 *    if an admin changes their date or time format settings on the WP General Settings admin page, verify that
+	 *    their selected format can be parsed by PHP
+	 *
+	 * @access    public
+	 * @param    $value
+	 * @param    $option
+	 * @throws EE_Error
+	 * @return    string
+	 */
+	public function check_for_invalid_datetime_formats($value, $option)
+	{
+		// check for date_format or time_format
+		switch ($option) {
+			case 'date_format':
+				$date_time_format = $value . ' ' . get_option('time_format');
+				break;
+			case 'time_format':
+				$date_time_format = get_option('date_format') . ' ' . $value;
+				break;
+			default:
+				$date_time_format = false;
+		}
+		// do we have a date_time format to check ?
+		if ($date_time_format) {
+			$error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
+
+			if (is_array($error_msg)) {
+				$msg = '<p>'
+					   . sprintf(
+						   esc_html__(
+							   'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
+							   'event_espresso'
+						   ),
+						   date($date_time_format),
+						   $date_time_format
+					   )
+					   . '</p><p><ul>';
+
+
+				foreach ($error_msg as $error) {
+					$msg .= '<li>' . $error . '</li>';
+				}
+
+				$msg .= '</ul></p><p>'
+						. sprintf(
+							esc_html__(
+								'%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
+								'event_espresso'
+							),
+							'<span style="color:#D54E21;">',
+							'</span>'
+						)
+						. '</p>';
+
+				// trigger WP settings error
+				add_settings_error(
+					'date_format',
+					'date_format',
+					$msg
+				);
+
+				// set format to something valid
+				switch ($option) {
+					case 'date_format':
+						$value = 'F j, Y';
+						break;
+					case 'time_format':
+						$value = 'g:i a';
+						break;
+				}
+			}
+		}
+		return $value;
+	}
+
+
+	/**
+	 *    its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
+	 *
+	 * @access    public
+	 * @param $content
+	 * @return    string
+	 */
+	public function its_eSpresso($content)
+	{
+		return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
+	}
+
+
+	/**
+	 *    espresso_admin_footer
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function espresso_admin_footer()
+	{
+		return \EEH_Template::powered_by_event_espresso('aln-cntr', '', array('utm_content' => 'admin_footer'));
+	}
+
+
+	/**
+	 * static method for registering ee admin page.
+	 * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
+	 *
+	 * @since      4.3.0
+	 * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
+	 * @see        EE_Register_Admin_Page::register()
+	 * @param       $page_basename
+	 * @param       $page_path
+	 * @param array $config
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_ee_admin_page($page_basename, $page_path, $config = array())
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
+					'event_espresso'
+				),
+				$page_basename
+			),
+			'4.3'
+		);
+		if (class_exists('EE_Register_Admin_Page')) {
+			$config['page_path'] = $page_path;
+		}
+		EE_Register_Admin_Page::register($page_basename, $config);
+	}
+
+
+	/**
+	 * @deprecated 4.8.41
+	 * @access     public
+	 * @param  int      $post_ID
+	 * @param  \WP_Post $post
+	 * @return void
+	 */
+	public static function parse_post_content_on_save($post_ID, $post)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.8.41
+	 * @access     public
+	 * @param  $option
+	 * @param  $old_value
+	 * @param  $value
+	 * @return void
+	 */
+	public function reset_page_for_posts_on_change($option, $old_value, $value)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
 }

core/libraries/shortcodes/EE_Venue_Shortcodes.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -157,7 +157,7 @@
     /**
      * This retrieves the EE_Venue from the available data object.
      *
-     * @return EE_Venue|null
+     * @return EE_Base_Class|null
      */
     private function _get_venue() {
 

Indentation +284 added lines, -284 removed lines

@@ -16,288 +16,288 @@
 {
 
 
-    /**
-     * Will hold the EE_Event if available
-     *
-     * @var EE_Event
-     */
-    protected $_event;
-
-    /**
-     * Will hold the EE_Venue if available
-     *
-     * @var EE_Venue
-     */
-    protected $_venue;
-
-
-    /**
-     * Initialize properties
-     */
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Venue Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to venue related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[VENUE_TITLE]'             => esc_html__('The title for the event venue', 'event_espresso'),
-            '[VENUE_DESCRIPTION]'       => esc_html__('The description for the event venue', 'event_espresso'),
-            '[VENUE_URL]'               => esc_html__('A url to a webpage for the venue', 'event_espresso'),
-            '[VENUE_IMAGE]'             => esc_html__('An image representing the event venue', 'event_espresso'),
-            '[VENUE_PHONE]'             => esc_html__('The phone number for the venue', 'event_espresso'),
-            '[VENUE_ADDRESS]'           => esc_html__('The address for the venue', 'event_espresso'),
-            '[VENUE_ADDRESS2]'          => esc_html__('Address 2 for the venue', 'event_espresso'),
-            '[VENUE_CITY]'              => esc_html__('The city the venue is in', 'event_espresso'),
-            '[VENUE_STATE]'             => esc_html__('The state the venue is located in', 'event_espresso'),
-            '[VENUE_COUNTRY]'           => esc_html__('The country the venue is located in', 'event_espresso'),
-            '[VENUE_FORMATTED_ADDRESS]' => esc_html__(
-                'This just outputs the venue address in a semantic address format.',
-                'event_espresso'
-            ),
-            '[VENUE_ZIP]'               => esc_html__('The zip code for the venue address', 'event_espresso'),
-            '[VENUE_META_*]'            => esc_html__(
-                'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the venue then it will be output in place of this shortcode.', 
-                'event_espresso'
-            ),
-            '[GOOGLE_MAP_URL]'          => esc_html__(
-                'URL for the google map associated with the venue.', 
-                'event_espresso'
-            ),
-            '[GOOGLE_MAP_LINK]'         => esc_html__('Link to a google map for the venue', 'event_espresso'),
-            '[GOOGLE_MAP_IMAGE]'        => esc_html__('Google map for venue wrapped in image tags', 'event_espresso'),
-        );
-    }
-
-
-    /**
-     * Parse incoming shortcode
-     * @param string $shortcode
-     * @return string
-     */
-    protected function _parser($shortcode)
-    {
-        $this->_venue = $this->_get_venue();
-        //If there is no venue object by now then get out.
-        if ( ! $this->_venue instanceof EE_Venue )
-            return '';
-
-        switch ($shortcode) {
-            case '[VENUE_TITLE]':
-                return $this->_venue('title');
-                break;
-
-            case '[VENUE_DESCRIPTION]':
-                return $this->_venue('description');
-                break;
-
-            case '[VENUE_URL]':
-                return $this->_venue('url');
-                break;
-
-            case '[VENUE_IMAGE]':
-                return $this->_venue('image');
-                break;
-
-            case '[VENUE_PHONE]':
-                return $this->_venue('phone');
-                break;
-
-            case '[VENUE_ADDRESS]':
-                return $this->_venue('address');
-                break;
-
-            case '[VENUE_ADDRESS2]':
-                return $this->_venue('address2');
-                break;
-
-            case '[VENUE_CITY]':
-                return $this->_venue('city');
-                break;
-
-            case '[VENUE_COUNTRY]':
-                return $this->_venue('country');
-                break;
-
-            case '[VENUE_STATE]':
-                return $this->_venue('state');
-                break;
-
-            case '[VENUE_ZIP]':
-                return $this->_venue('zip');
-                break;
-
-            case '[VENUE_FORMATTED_ADDRESS]':
-                return $this->_venue('formatted_address');
-                break;
-
-            case '[GOOGLE_MAP_URL]':
-                return $this->_venue('gmap_url');
-                break;
-
-            case '[GOOGLE_MAP_LINK]':
-                return $this->_venue('gmap_link');
-                break;
-
-            case '[GOOGLE_MAP_IMAGE]':
-                return $this->_venue('gmap_link_img');
-                break;
-
-        }
-
-        if ( strpos( $shortcode, '[VENUE_META_*' ) !== false ) {
-            $shortcode = str_replace( '[VENUE_META_*', '', $shortcode );
-            $shortcode = trim( str_replace( ']', '', $shortcode ) );
-
-            //pull the meta value from the venue post
-            $venue_meta = $this->_venue->get_post_meta( $shortcode, true );
-
-            return ! empty( $venue_meta ) ? $venue_meta : '';
-
-        }
-    }
-    /**
-     * This retrieves the EE_Venue from the available data object.
-     *
-     * @return EE_Venue|null
-     */
-    private function _get_venue() {
-
-        //we need the EE_Event object to get the venue.
-        $this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
-
-        //if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the reg_obj instead.
-        if (empty($this->_event)) {
-            $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-            $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
-
-            $this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration ? $aee->reg_obj->event() : null;
-
-            //if still empty do we have a ticket data item?
-            $this->_event = empty($this->_event)
-                            && $this->_data instanceof EE_Ticket
-                            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->tickets[$this->_data->ID()]['EE_Event']
-                : $this->_event;
-
-            //if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee and use that.
-            $event        = $aee instanceof EE_Messages_Addressee ? reset($aee->events) : array();
-            $this->_event = empty($this->_event) && ! empty($events) ? $event : $this->_event;
-        }
-
-        //If we have an event object use it to pull the venue.
-        if ($this->_event instanceof EE_Event) {
-            return $this->_event->get_first_related('Venue');
-        } 
-
-        return null;
-    }
-
-    /**
-     * This retrieves the specified venue information
-     *
-     * @param string $field  What Venue field to retrieve
-     * @return string What was retrieved!
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    private function _venue($field)
-    {
-
-        if (empty($this->_venue)) {
-            return '';
-        } //no venue so get out.
-
-        switch ($field) {
-            case 'title':
-                return $this->_venue->get('VNU_name');
-                break;
-
-            case 'description':
-                return $this->_venue->get('VNU_desc');
-                break;
-
-            case 'url':
-                $url = $this->_venue->get('VNU_url');
-                return empty($url) ? $this->_venue->get_permalink() : $url;
-                break;
-
-            case 'image':
-                return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
-                           esc_attr__('%s Feature Image', 'event_espresso'),
-                           $this->_venue->get('VNU_name')
-                       ) . '" />';
-                break;
-
-            case 'phone':
-                return $this->_venue->get('VNU_phone');
-                break;
-
-            case 'address':
-                return $this->_venue->get('VNU_address');
-                break;
-
-            case 'address2':
-                return $this->_venue->get('VNU_address2');
-                break;
-
-            case 'city':
-                return $this->_venue->get('VNU_city');
-                break;
-
-            case 'state':
-                $state = $this->_venue->state_obj();
-                return is_object($state) ? $state->get('STA_name') : '';
-                break;
-
-            case 'country':
-                $country = $this->_venue->country_obj();
-                return is_object($country) ? $country->get('CNT_name') : '';
-                break;
-
-            case 'zip':
-                return $this->_venue->get('VNU_zip');
-                break;
-
-            case 'formatted_address':
-                return EEH_Address::format($this->_venue);
-                break;
-
-            case 'gmap_link':
-            case 'gmap_url':
-            case 'gmap_link_img':
-                $atts = $this->get_map_attributes($this->_venue, $field);
-                return EEH_Maps::google_map_link($atts);
-                break;
-        }
-        return '';
-    }
-
-
-    /**
-     * Generates the attributes for retrieving a google_map artifact.
-     * @param EE_Venue $venue
-     * @param string   $field
-     * @return array
-     * @throws EE_Error
-     */
-    protected function get_map_attributes(EE_Venue $venue, $field = 'gmap_link')
-    {
-        $state   = $venue->state_obj();
-        $country = $venue->country_obj();
-        $atts    = array(
-            'id'      => $venue->ID(),
-            'address' => $venue->get('VNU_address'),
-            'city'    => $venue->get('VNU_city'),
-            'state'   => is_object($state) ? $state->get('STA_name') : '',
-            'zip'     => $venue->get('VNU_zip'),
-            'country' => is_object($country) ? $country->get('CNT_name') : '',
-            'type'    => $field === 'gmap_link' ? 'url' : 'map',
-            'map_w'   => 200,
-            'map_h'   => 200,
-        );
-        if ($field === 'gmap_url') {
-            $atts['type'] = 'url_only';
-        }
-        return $atts;
-    }
+	/**
+	 * Will hold the EE_Event if available
+	 *
+	 * @var EE_Event
+	 */
+	protected $_event;
+
+	/**
+	 * Will hold the EE_Venue if available
+	 *
+	 * @var EE_Venue
+	 */
+	protected $_venue;
+
+
+	/**
+	 * Initialize properties
+	 */
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Venue Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to venue related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[VENUE_TITLE]'             => esc_html__('The title for the event venue', 'event_espresso'),
+			'[VENUE_DESCRIPTION]'       => esc_html__('The description for the event venue', 'event_espresso'),
+			'[VENUE_URL]'               => esc_html__('A url to a webpage for the venue', 'event_espresso'),
+			'[VENUE_IMAGE]'             => esc_html__('An image representing the event venue', 'event_espresso'),
+			'[VENUE_PHONE]'             => esc_html__('The phone number for the venue', 'event_espresso'),
+			'[VENUE_ADDRESS]'           => esc_html__('The address for the venue', 'event_espresso'),
+			'[VENUE_ADDRESS2]'          => esc_html__('Address 2 for the venue', 'event_espresso'),
+			'[VENUE_CITY]'              => esc_html__('The city the venue is in', 'event_espresso'),
+			'[VENUE_STATE]'             => esc_html__('The state the venue is located in', 'event_espresso'),
+			'[VENUE_COUNTRY]'           => esc_html__('The country the venue is located in', 'event_espresso'),
+			'[VENUE_FORMATTED_ADDRESS]' => esc_html__(
+				'This just outputs the venue address in a semantic address format.',
+				'event_espresso'
+			),
+			'[VENUE_ZIP]'               => esc_html__('The zip code for the venue address', 'event_espresso'),
+			'[VENUE_META_*]'            => esc_html__(
+				'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the venue then it will be output in place of this shortcode.', 
+				'event_espresso'
+			),
+			'[GOOGLE_MAP_URL]'          => esc_html__(
+				'URL for the google map associated with the venue.', 
+				'event_espresso'
+			),
+			'[GOOGLE_MAP_LINK]'         => esc_html__('Link to a google map for the venue', 'event_espresso'),
+			'[GOOGLE_MAP_IMAGE]'        => esc_html__('Google map for venue wrapped in image tags', 'event_espresso'),
+		);
+	}
+
+
+	/**
+	 * Parse incoming shortcode
+	 * @param string $shortcode
+	 * @return string
+	 */
+	protected function _parser($shortcode)
+	{
+		$this->_venue = $this->_get_venue();
+		//If there is no venue object by now then get out.
+		if ( ! $this->_venue instanceof EE_Venue )
+			return '';
+
+		switch ($shortcode) {
+			case '[VENUE_TITLE]':
+				return $this->_venue('title');
+				break;
+
+			case '[VENUE_DESCRIPTION]':
+				return $this->_venue('description');
+				break;
+
+			case '[VENUE_URL]':
+				return $this->_venue('url');
+				break;
+
+			case '[VENUE_IMAGE]':
+				return $this->_venue('image');
+				break;
+
+			case '[VENUE_PHONE]':
+				return $this->_venue('phone');
+				break;
+
+			case '[VENUE_ADDRESS]':
+				return $this->_venue('address');
+				break;
+
+			case '[VENUE_ADDRESS2]':
+				return $this->_venue('address2');
+				break;
+
+			case '[VENUE_CITY]':
+				return $this->_venue('city');
+				break;
+
+			case '[VENUE_COUNTRY]':
+				return $this->_venue('country');
+				break;
+
+			case '[VENUE_STATE]':
+				return $this->_venue('state');
+				break;
+
+			case '[VENUE_ZIP]':
+				return $this->_venue('zip');
+				break;
+
+			case '[VENUE_FORMATTED_ADDRESS]':
+				return $this->_venue('formatted_address');
+				break;
+
+			case '[GOOGLE_MAP_URL]':
+				return $this->_venue('gmap_url');
+				break;
+
+			case '[GOOGLE_MAP_LINK]':
+				return $this->_venue('gmap_link');
+				break;
+
+			case '[GOOGLE_MAP_IMAGE]':
+				return $this->_venue('gmap_link_img');
+				break;
+
+		}
+
+		if ( strpos( $shortcode, '[VENUE_META_*' ) !== false ) {
+			$shortcode = str_replace( '[VENUE_META_*', '', $shortcode );
+			$shortcode = trim( str_replace( ']', '', $shortcode ) );
+
+			//pull the meta value from the venue post
+			$venue_meta = $this->_venue->get_post_meta( $shortcode, true );
+
+			return ! empty( $venue_meta ) ? $venue_meta : '';
+
+		}
+	}
+	/**
+	 * This retrieves the EE_Venue from the available data object.
+	 *
+	 * @return EE_Venue|null
+	 */
+	private function _get_venue() {
+
+		//we need the EE_Event object to get the venue.
+		$this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
+
+		//if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the reg_obj instead.
+		if (empty($this->_event)) {
+			$aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+			$aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
+
+			$this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration ? $aee->reg_obj->event() : null;
+
+			//if still empty do we have a ticket data item?
+			$this->_event = empty($this->_event)
+							&& $this->_data instanceof EE_Ticket
+							&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']->tickets[$this->_data->ID()]['EE_Event']
+				: $this->_event;
+
+			//if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee and use that.
+			$event        = $aee instanceof EE_Messages_Addressee ? reset($aee->events) : array();
+			$this->_event = empty($this->_event) && ! empty($events) ? $event : $this->_event;
+		}
+
+		//If we have an event object use it to pull the venue.
+		if ($this->_event instanceof EE_Event) {
+			return $this->_event->get_first_related('Venue');
+		} 
+
+		return null;
+	}
+
+	/**
+	 * This retrieves the specified venue information
+	 *
+	 * @param string $field  What Venue field to retrieve
+	 * @return string What was retrieved!
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	private function _venue($field)
+	{
+
+		if (empty($this->_venue)) {
+			return '';
+		} //no venue so get out.
+
+		switch ($field) {
+			case 'title':
+				return $this->_venue->get('VNU_name');
+				break;
+
+			case 'description':
+				return $this->_venue->get('VNU_desc');
+				break;
+
+			case 'url':
+				$url = $this->_venue->get('VNU_url');
+				return empty($url) ? $this->_venue->get_permalink() : $url;
+				break;
+
+			case 'image':
+				return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
+					   . '" alt="' . sprintf(
+						   esc_attr__('%s Feature Image', 'event_espresso'),
+						   $this->_venue->get('VNU_name')
+					   ) . '" />';
+				break;
+
+			case 'phone':
+				return $this->_venue->get('VNU_phone');
+				break;
+
+			case 'address':
+				return $this->_venue->get('VNU_address');
+				break;
+
+			case 'address2':
+				return $this->_venue->get('VNU_address2');
+				break;
+
+			case 'city':
+				return $this->_venue->get('VNU_city');
+				break;
+
+			case 'state':
+				$state = $this->_venue->state_obj();
+				return is_object($state) ? $state->get('STA_name') : '';
+				break;
+
+			case 'country':
+				$country = $this->_venue->country_obj();
+				return is_object($country) ? $country->get('CNT_name') : '';
+				break;
+
+			case 'zip':
+				return $this->_venue->get('VNU_zip');
+				break;
+
+			case 'formatted_address':
+				return EEH_Address::format($this->_venue);
+				break;
+
+			case 'gmap_link':
+			case 'gmap_url':
+			case 'gmap_link_img':
+				$atts = $this->get_map_attributes($this->_venue, $field);
+				return EEH_Maps::google_map_link($atts);
+				break;
+		}
+		return '';
+	}
+
+
+	/**
+	 * Generates the attributes for retrieving a google_map artifact.
+	 * @param EE_Venue $venue
+	 * @param string   $field
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function get_map_attributes(EE_Venue $venue, $field = 'gmap_link')
+	{
+		$state   = $venue->state_obj();
+		$country = $venue->country_obj();
+		$atts    = array(
+			'id'      => $venue->ID(),
+			'address' => $venue->get('VNU_address'),
+			'city'    => $venue->get('VNU_city'),
+			'state'   => is_object($state) ? $state->get('STA_name') : '',
+			'zip'     => $venue->get('VNU_zip'),
+			'country' => is_object($country) ? $country->get('CNT_name') : '',
+			'type'    => $field === 'gmap_link' ? 'url' : 'map',
+			'map_w'   => 200,
+			'map_h'   => 200,
+		);
+		if ($field === 'gmap_url') {
+			$atts['type'] = 'url_only';
+		}
+		return $atts;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -77,7 +77,7 @@ 
     {
         $this->_venue = $this->_get_venue();
         //If there is no venue object by now then get out.
-        if ( ! $this->_venue instanceof EE_Venue )
+        if ( ! $this->_venue instanceof EE_Venue)
             return '';
 
         switch ($shortcode) {
@@ -143,14 +143,14 @@ 
 
         }
 
-        if ( strpos( $shortcode, '[VENUE_META_*' ) !== false ) {
-            $shortcode = str_replace( '[VENUE_META_*', '', $shortcode );
-            $shortcode = trim( str_replace( ']', '', $shortcode ) );
+        if (strpos($shortcode, '[VENUE_META_*') !== false) {
+            $shortcode = str_replace('[VENUE_META_*', '', $shortcode);
+            $shortcode = trim(str_replace(']', '', $shortcode));
 
             //pull the meta value from the venue post
-            $venue_meta = $this->_venue->get_post_meta( $shortcode, true );
+            $venue_meta = $this->_venue->get_post_meta($shortcode, true);
 
-            return ! empty( $venue_meta ) ? $venue_meta : '';
+            return ! empty($venue_meta) ? $venue_meta : '';
 
         }
     }
@@ -221,11 +221,11 @@ 
                 break;
 
             case 'image':
-                return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
+                return '<img src="'.$this->_venue->feature_image_url(array(200, 200,))
+                       . '" alt="'.sprintf(
                            esc_attr__('%s Feature Image', 'event_espresso'),
                            $this->_venue->get('VNU_name')
-                       ) . '" />';
+                       ).'" />';
                 break;
 
             case 'phone':

Braces +3 added lines, -2 removed lines

@@ -77,8 +77,9 @@
     {
         $this->_venue = $this->_get_venue();
         //If there is no venue object by now then get out.
-        if ( ! $this->_venue instanceof EE_Venue )
-            return '';
+        if ( ! $this->_venue instanceof EE_Venue ) {
+                    return '';
+        }
 
         switch ($shortcode) {
             case '[VENUE_TITLE]':

core/services/loaders/LoaderDecoratorInterface.php

Indentation +11 added lines, -11 removed lines

@@ -9,20 +9,20 @@
 interface LoaderDecoratorInterface
 {
 
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @param bool   $shared
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = array(), $shared = true);
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @param bool   $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true);
 
 
 
-    /**
-     * calls reset() on loader if method exists
-     */
-    public function reset();
+	/**
+	 * calls reset() on loader if method exists
+	 */
+	public function reset();
 
 }
 // End of file LoaderInterface.php

core/db_models/EEM_WP_User.model.php

Indentation +123 added lines, -123 removed lines

@@ -3,7 +3,7 @@ 
 use EventEspresso\core\services\orm\ModelFieldFactory;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -19,128 +19,128 @@ 
 class EEM_WP_User extends EEM_Base
 {
 
-    /**
-     * private instance of the EEM_WP_User object
-     *
-     * @type EEM_WP_User
-     */
-    protected static $_instance;
-
-
-
-    /**
-     *    constructor
-     *
-     * @param null              $timezone
-     * @param ModelFieldFactory $model_field_factory
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
-    {
-        $this->singular_item = __('WP_User', 'event_espresso');
-        $this->plural_item = __('WP_Users', 'event_espresso');
-        global $wpdb;
-        $this->_tables = array(
-            'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true),
-        );
-        $this->_fields = array(
-            'WP_User' => array(
-                'ID'                  => $model_field_factory->createPrimaryKeyIntField(
-                    'ID',
-                    __('WP_User ID', 'event_espresso')
-                ),
-                'user_login'          => $model_field_factory->createPlainTextField(
-                    'user_login',
-                    __('User Login', 'event_espresso'),
-                    false
-                ),
-                'user_pass'           => $model_field_factory->createPlainTextField(
-                    'user_pass',
-                    __('User Password', 'event_espresso'),
-                    false
-                ),
-                'user_nicename'       => $model_field_factory->createPlainTextField(
-                    'user_nicename',
-                    __(' User Nice Name', 'event_espresso'),
-                    false
-                ),
-                'user_email'          => $model_field_factory->createEmailField(
-                    'user_email',
-                    __('User Email', 'event_espresso'),
-                    false,
-                    null
-                ),
-                'user_registered'     => $model_field_factory->createDatetimeField(
-                    'user_registered',
-                    __('Date User Registered', 'event_espresso'),
-                    $timezone
-                ),
-                'user_activation_key' => $model_field_factory->createPlainTextField(
-                    'user_activation_key',
-                    __('User Activation Key', 'event_espresso'),
-                    false
-                ),
-                'user_status'         => $model_field_factory->createIntegerField(
-                    'user_status',
-                    __('User Status', 'event_espresso')
-                ),
-                'display_name'        => $model_field_factory->createPlainTextField(
-                    'display_name',
-                    __('Display Name', 'event_espresso'),
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'       => new EE_Has_Many_Relation(),
-            // all models are related to the change log
-            // 'Change_Log'     => new EE_Has_Many_Relation(),
-            'Event'          => new EE_Has_Many_Relation(),
-            'Payment_Method' => new EE_Has_Many_Relation(),
-            'Price'          => new EE_Has_Many_Relation(),
-            'Price_Type'     => new EE_Has_Many_Relation(),
-            'Question'       => new EE_Has_Many_Relation(),
-            'Question_Group' => new EE_Has_Many_Relation(),
-            'Ticket'         => new EE_Has_Many_Relation(),
-            'Venue'          => new EE_Has_Many_Relation(),
-            'Message'        => new EE_Has_Many_Relation(),
-        );
-        $this->_wp_core_model = true;
-        $this->_caps_slug = 'users';
-        $this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read] = 'list';
-        $this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read_admin] = 'list';
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_WP_User();
-        }
-        //@todo: account for create_users controls whether they can create users at all
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * We don't need a foreign key to the WP_User model, we just need its primary key
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function wp_user_field_name()
-    {
-        return $this->primary_key_name();
-    }
-
-
-
-    /**
-     * This WP_User model IS owned, even though it doesn't have a foreign key to itself
-     *
-     * @return boolean
-     */
-    public function is_owned()
-    {
-        return true;
-    }
+	/**
+	 * private instance of the EEM_WP_User object
+	 *
+	 * @type EEM_WP_User
+	 */
+	protected static $_instance;
+
+
+
+	/**
+	 *    constructor
+	 *
+	 * @param null              $timezone
+	 * @param ModelFieldFactory $model_field_factory
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
+	{
+		$this->singular_item = __('WP_User', 'event_espresso');
+		$this->plural_item = __('WP_Users', 'event_espresso');
+		global $wpdb;
+		$this->_tables = array(
+			'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true),
+		);
+		$this->_fields = array(
+			'WP_User' => array(
+				'ID'                  => $model_field_factory->createPrimaryKeyIntField(
+					'ID',
+					__('WP_User ID', 'event_espresso')
+				),
+				'user_login'          => $model_field_factory->createPlainTextField(
+					'user_login',
+					__('User Login', 'event_espresso'),
+					false
+				),
+				'user_pass'           => $model_field_factory->createPlainTextField(
+					'user_pass',
+					__('User Password', 'event_espresso'),
+					false
+				),
+				'user_nicename'       => $model_field_factory->createPlainTextField(
+					'user_nicename',
+					__(' User Nice Name', 'event_espresso'),
+					false
+				),
+				'user_email'          => $model_field_factory->createEmailField(
+					'user_email',
+					__('User Email', 'event_espresso'),
+					false,
+					null
+				),
+				'user_registered'     => $model_field_factory->createDatetimeField(
+					'user_registered',
+					__('Date User Registered', 'event_espresso'),
+					$timezone
+				),
+				'user_activation_key' => $model_field_factory->createPlainTextField(
+					'user_activation_key',
+					__('User Activation Key', 'event_espresso'),
+					false
+				),
+				'user_status'         => $model_field_factory->createIntegerField(
+					'user_status',
+					__('User Status', 'event_espresso')
+				),
+				'display_name'        => $model_field_factory->createPlainTextField(
+					'display_name',
+					__('Display Name', 'event_espresso'),
+					false
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'       => new EE_Has_Many_Relation(),
+			// all models are related to the change log
+			// 'Change_Log'     => new EE_Has_Many_Relation(),
+			'Event'          => new EE_Has_Many_Relation(),
+			'Payment_Method' => new EE_Has_Many_Relation(),
+			'Price'          => new EE_Has_Many_Relation(),
+			'Price_Type'     => new EE_Has_Many_Relation(),
+			'Question'       => new EE_Has_Many_Relation(),
+			'Question_Group' => new EE_Has_Many_Relation(),
+			'Ticket'         => new EE_Has_Many_Relation(),
+			'Venue'          => new EE_Has_Many_Relation(),
+			'Message'        => new EE_Has_Many_Relation(),
+		);
+		$this->_wp_core_model = true;
+		$this->_caps_slug = 'users';
+		$this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read] = 'list';
+		$this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read_admin] = 'list';
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_WP_User();
+		}
+		//@todo: account for create_users controls whether they can create users at all
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * We don't need a foreign key to the WP_User model, we just need its primary key
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function wp_user_field_name()
+	{
+		return $this->primary_key_name();
+	}
+
+
+
+	/**
+	 * This WP_User model IS owned, even though it doesn't have a foreign key to itself
+	 *
+	 * @return boolean
+	 */
+	public function is_owned()
+	{
+		return true;
+	}
 
 
 

Spacing +1 added lines, -1 removed lines

@@ -2,7 +2,7 @@
 
 use EventEspresso\core\services\orm\ModelFieldFactory;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 

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

Indentation +464 added lines, -464 removed lines

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

caffeinated/admin/extend/registrations/Extend_Registrations_Admin_Page.core.php

Indentation +1169 added lines, -1169 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -17,1173 +17,1173 @@ 
 {
 
 
-    /**
-     * This is used to hold the reports template data which is setup early in the request.
-     *
-     * @type array
-     */
-    protected $_reports_template_data = array();
-
-
-
-    /**
-     * Extend_Registrations_Admin_Page constructor.
-     *
-     * @param bool $routing
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        if ( ! defined('REG_CAF_TEMPLATE_PATH')) {
-            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
-            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
-            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
-        }
-    }
-
-
-
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
-        $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
-            ? $this->_req_data['_REG_ID']
-            : 0;
-        // $att_id = ! empty( $this->_req_data['ATT_ID'] ) ? ! is_array( $this->_req_data['ATT_ID'] ) : 0;
-        // $att_id = ! empty( $this->_req_data['post'] ) && ! is_array( $this->_req_data['post'] )
-        // 	? $this->_req_data['post'] : $att_id;
-        $new_page_routes = array(
-            'reports'                  => array(
-                'func'       => '_registration_reports',
-                'capability' => 'ee_read_registrations',
-            ),
-            'registration_checkins'    => array(
-                'func'       => '_registration_checkin_list_table',
-                'capability' => 'ee_read_checkins',
-            ),
-            'newsletter_selected_send' => array(
-                'func'       => '_newsletter_selected_send',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ),
-            'delete_checkin_rows'      => array(
-                'func'       => '_delete_checkin_rows',
-                'noheader'   => true,
-                'capability' => 'ee_delete_checkins',
-            ),
-            'delete_checkin_row'       => array(
-                'func'       => '_delete_checkin_row',
-                'noheader'   => true,
-                'capability' => 'ee_delete_checkin',
-                'obj_id'     => $reg_id,
-            ),
-            'toggle_checkin_status'    => array(
-                'func'       => '_toggle_checkin_status',
-                'noheader'   => true,
-                'capability' => 'ee_edit_checkin',
-                'obj_id'     => $reg_id,
-            ),
-            'event_registrations'      => array(
-                'func'       => '_event_registrations_list_table',
-                'capability' => 'ee_read_checkins',
-            ),
-            'registrations_checkin_report' => array(
-                'func'       => '_registrations_checkin_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_registrations',
-            ),
-        );
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-        $new_page_config = array(
-            'reports'               => array(
-                'nav'           => array(
-                    'label' => __('Reports', 'event_espresso'),
-                    'order' => 30,
-                ),
-                'help_tabs'     => array(
-                    'registrations_reports_help_tab' => array(
-                        'title'    => __('Registration Reports', 'event_espresso'),
-                        'filename' => 'registrations_reports',
-                    ),
-                ),
-                /*'help_tour' => array( 'Registration_Reports_Help_Tour' ),*/
-                'require_nonce' => false,
-            ),
-            'event_registrations'   => array(
-                'nav'           => array(
-                    'label'      => __('Event Check-In', 'event_espresso'),
-                    'order'      => 10,
-                    'persistent' => true,
-                ),
-                'help_tabs'     => array(
-                    'registrations_event_checkin_help_tab'                       => array(
-                        'title'    => __('Registrations Event Check-In', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin',
-                    ),
-                    'registrations_event_checkin_table_column_headings_help_tab' => array(
-                        'title'    => __('Event Check-In Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_table_column_headings',
-                    ),
-                    'registrations_event_checkin_filters_help_tab'               => array(
-                        'title'    => __('Event Check-In Filters', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_filters',
-                    ),
-                    'registrations_event_checkin_views_help_tab'                 => array(
-                        'title'    => __('Event Check-In Views', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_views',
-                    ),
-                    'registrations_event_checkin_other_help_tab'                 => array(
-                        'title'    => __('Event Check-In Other', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_other',
-                    ),
-                ),
-                'help_tour'     => array('Event_Checkin_Help_Tour'),
-                'qtips'         => array('Registration_List_Table_Tips'),
-                'list_table'    => 'EE_Event_Registrations_List_Table',
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-            'registration_checkins' => array(
-                'nav'           => array(
-                    'label'      => __('Check-In Records', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'list_table'    => 'EE_Registration_CheckIn_List_Table',
-                //'help_tour' => array( 'Checkin_Toggle_View_Help_Tour' ),
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-        $this->_page_config['contact_list']['list_table'] = 'Extend_EE_Attendee_Contact_List_Table';
-        $this->_page_config['default']['list_table'] = 'Extend_EE_Registrations_List_Table';
-    }
-
-
-
-    protected function _ajax_hooks()
-    {
-        parent::_ajax_hooks();
-        add_action('wp_ajax_get_newsletter_form_content', array($this, 'get_newsletter_form_content'));
-    }
-
-
-
-    public function load_scripts_styles()
-    {
-        parent::load_scripts_styles();
-        //if newsletter message type is active then let's add filter and load js for it.
-        if (EEH_MSG_Template::is_mt_active('newsletter')) {
-            //enqueue newsletter js
-            wp_enqueue_script(
-                'ee-newsletter-trigger',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
-                array('ee-dialog'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_style(
-                'ee-newsletter-trigger-css',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
-                array(),
-                EVENT_ESPRESSO_VERSION
-            );
-            //hook in buttons for newsletter message type trigger.
-            add_action(
-                'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
-                array($this, 'add_newsletter_action_buttons'),
-                10
-            );
-        }
-    }
-
-
-
-    public function load_scripts_styles_reports()
-    {
-        wp_register_script(
-            'ee-reg-reports-js',
-            REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
-            array('google-charts'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-reg-reports-js');
-        $this->_registration_reports_js_setup();
-    }
-
-
-
-    protected function _add_screen_options_event_registrations()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-
-    protected function _add_screen_options_registration_checkins()
-    {
-        $page_title = $this->_admin_page_title;
-        $this->_admin_page_title = __('Check-In Records', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-
-    protected function _set_list_table_views_event_registrations()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => __('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => ! isset($this->_req_data['event_id'])
-                    ? array()
-                    : array(
-                        'toggle_checkin_status' => __('Toggle Check-In', 'event_espresso'),
-                        //'trash_registrations' => __('Trash Registrations', 'event_espresso')
-                    ),
-            ),
-        );
-    }
-
-
-
-    protected function _set_list_table_views_registration_checkins()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => __('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array('delete_checkin_rows' => __('Delete Check-In Rows', 'event_espresso')),
-            ),
-        );
-    }
-
-
-
-    /**
-     * callback for ajax action.
-     *
-     * @since 4.3.0
-     * @return void (JSON)
-     * @throws \EE_Error
-     */
-    public function get_newsletter_form_content()
-    {
-        //do a nonce check cause we're not coming in from an normal route here.
-        $nonce = isset($this->_req_data['get_newsletter_form_content_nonce']) ? sanitize_text_field(
-            $this->_req_data['get_newsletter_form_content_nonce']
-        ) : '';
-        $nonce_ref = 'get_newsletter_form_content_nonce';
-        $this->_verify_nonce($nonce, $nonce_ref);
-        //let's get the mtp for the incoming MTP_ ID
-        if ( ! isset($this->_req_data['GRP_ID'])) {
-            EE_Error::add_error(
-                __(
-                    'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-        $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']);
-        if ( ! $MTPG instanceof EE_Message_Template_Group) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'The GRP_ID given (%d) does not appear to have a corresponding row in the database.',
-                        'event_espresso'
-                    ),
-                    $this->_req_data['GRP_ID']
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-        $MTPs = $MTPG->context_templates();
-        $MTPs = $MTPs['attendee'];
-        $template_fields = array();
-        /** @var EE_Message_Template $MTP */
-        foreach ($MTPs as $MTP) {
-            $field = $MTP->get('MTP_template_field');
-            if ($field === 'content') {
-                $content = $MTP->get('MTP_content');
-                if ( ! empty($content['newsletter_content'])) {
-                    $template_fields['newsletter_content'] = $content['newsletter_content'];
-                }
-                continue;
-            }
-            $template_fields[$MTP->get('MTP_template_field')] = $MTP->get('MTP_content');
-        }
-        $this->_template_args['success'] = true;
-        $this->_template_args['error'] = false;
-        $this->_template_args['data'] = array(
-            'batch_message_from'    => isset($template_fields['from'])
-                ? $template_fields['from']
-                : '',
-            'batch_message_subject' => isset($template_fields['subject'])
-                ? $template_fields['subject']
-                : '',
-            'batch_message_content' => isset($template_fields['newsletter_content'])
-                ? $template_fields['newsletter_content']
-                : '',
-        );
-        $this->_return_json();
-    }
-
-
-
-    /**
-     * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action
-     *
-     * @since 4.3.0
-     * @param EE_Admin_List_Table $list_table
-     * @return void
-     */
-    public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table)
-    {
-        if ( ! EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'espresso_registrations_newsletter_selected_send'
-        )
-        ) {
-            return;
-        }
-        $routes_to_add_to = array(
-            'contact_list',
-            'event_registrations',
-            'default',
-        );
-        if ($this->_current_page === 'espresso_registrations' && in_array($this->_req_action, $routes_to_add_to)) {
-            if (($this->_req_action === 'event_registrations' && empty($this->_req_data['event_id']))
-                || (isset($this->_req_data['status']) && $this->_req_data['status'] === 'trash')
-            ) {
-                echo '';
-            } else {
-                $button_text = sprintf(
-                    __('Send Batch Message (%s selected)', 'event_espresso'),
-                    '<span class="send-selected-newsletter-count">0</span>'
-                );
-                echo '<button id="selected-batch-send-trigger" class="button secondary-button"><span class="dashicons dashicons-email "></span>'
-                     . $button_text
-                     . '</button>';
-                add_action('admin_footer', array($this, 'newsletter_send_form_skeleton'));
-            }
-        }
-    }
-
-
-
-    public function newsletter_send_form_skeleton()
-    {
-        $list_table = $this->_list_table_object;
-        $codes = array();
-        //need to templates for the newsletter message type for the template selector.
-        $values[] = array('text' => __('Select Template to Use', 'event_espresso'), 'id' => 0);
-        $mtps = EEM_Message_Template_Group::instance()->get_all(
-            array(array('MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email'))
-        );
-        foreach ($mtps as $mtp) {
-            $name = $mtp->name();
-            $values[] = array(
-                'text' => empty($name) ? __('Global', 'event_espresso') : $name,
-                'id'   => $mtp->ID(),
-            );
-        }
-        //need to get a list of shortcodes that are available for the newsletter message type.
-        $shortcodes = EEH_MSG_Template::get_shortcodes('newsletter', 'email', array(), 'attendee', false);
-        foreach ($shortcodes as $field => $shortcode_array) {
-            $codes[$field] = implode(', ', array_keys($shortcode_array));
-        }
-        $shortcodes = $codes;
-        $form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
-        $form_template_args = array(
-            'form_action'       => admin_url('admin.php?page=espresso_registrations'),
-            'form_route'        => 'newsletter_selected_send',
-            'form_nonce_name'   => 'newsletter_selected_send_nonce',
-            'form_nonce'        => wp_create_nonce('newsletter_selected_send_nonce'),
-            'redirect_back_to'  => $this->_req_action,
-            'ajax_nonce'        => wp_create_nonce('get_newsletter_form_content_nonce'),
-            'template_selector' => EEH_Form_Fields::select_input('newsletter_mtp_selected', $values),
-            'shortcodes'        => $shortcodes,
-            'id_type'           => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact' : 'registration',
-        );
-        EEH_Template::display_template($form_template, $form_template_args);
-    }
-
-
-
-    /**
-     * Handles sending selected registrations/contacts a newsletter.
-     *
-     * @since  4.3.0
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _newsletter_selected_send()
-    {
-        $success = true;
-        //first we need to make sure we have a GRP_ID so we know what template we're sending and updating!
-        if (empty($this->_req_data['newsletter_mtp_selected'])) {
-            EE_Error::add_error(
-                __(
-                    'In order to send a message, a Message Template GRP_ID is needed. It was not provided so messages were not sent.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        if ($success) {
-            //update Message template in case there are any changes
-            $Message_Template_Group = EEM_Message_Template_Group::instance()->get_one_by_ID(
-                $this->_req_data['newsletter_mtp_selected']
-            );
-            $Message_Templates = $Message_Template_Group instanceof EE_Message_Template_Group
-                ? $Message_Template_Group->context_templates()
-                : array();
-            if (empty($Message_Templates)) {
-                EE_Error::add_error(
-                    __(
-                        'Unable to retrieve message template fields from the db. Messages not sent.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            //let's just update the specific fields
-            foreach ($Message_Templates['attendee'] as $Message_Template) {
-                if ($Message_Template instanceof EE_Message_Template) {
-                    $field = $Message_Template->get('MTP_template_field');
-                    $content = $Message_Template->get('MTP_content');
-                    $new_content = $content;
-                    switch ($field) {
-                        case 'from' :
-                            $new_content = ! empty($this->_req_data['batch_message']['from'])
-                                ? $this->_req_data['batch_message']['from']
-                                : $content;
-                            break;
-                        case 'subject' :
-                            $new_content = ! empty($this->_req_data['batch_message']['subject'])
-                                ? $this->_req_data['batch_message']['subject']
-                                : $content;
-                            break;
-                        case 'content' :
-                            $new_content = $content;
-                            $new_content['newsletter_content'] = ! empty($this->_req_data['batch_message']['content'])
-                                ? $this->_req_data['batch_message']['content']
-                                : $content['newsletter_content'];
-                            break;
-                        default :
-                            //continue the foreach loop, we don't want to set $new_content nor save.
-                            continue 2;
-                    }
-                    $Message_Template->set('MTP_content', $new_content);
-                    $Message_Template->save();
-                }
-            }
-            //great fields are updated!  now let's make sure we just have contact objects (EE_Attendee).
-            $id_type = ! empty($this->_req_data['batch_message']['id_type'])
-                ? $this->_req_data['batch_message']['id_type']
-                : 'registration';
-            //id_type will affect how we assemble the ids.
-            $ids = ! empty($this->_req_data['batch_message']['ids'])
-                ? json_decode(stripslashes($this->_req_data['batch_message']['ids']))
-                : array();
-            $registrations_used_for_contact_data = array();
-            //using switch because eventually we'll have other contexts that will be used for generating messages.
-            switch ($id_type) {
-                case 'registration' :
-                    $registrations_used_for_contact_data = EEM_Registration::instance()->get_all(
-                        array(
-                            array(
-                                'REG_ID' => array('IN', $ids),
-                            ),
-                        )
-                    );
-                    break;
-                case 'contact' :
-                    $registrations_used_for_contact_data = EEM_Registration::instance()
-                                                                           ->get_latest_registration_for_each_of_given_contacts($ids);
-                    break;
-            }
-            do_action(
-                'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
-                $registrations_used_for_contact_data,
-                $Message_Template_Group->ID()
-            );
-            //kept for backward compat, internally we no longer use this action.
-            //@deprecated 4.8.36.rc.002
-            $contacts = $id_type === 'registration'
-                ? EEM_Attendee::instance()->get_array_of_contacts_from_reg_ids($ids)
-                : EEM_Attendee::instance()->get_all(array(array('ATT_ID' => array('in', $ids))));
-            do_action(
-                'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send',
-                $contacts,
-                $Message_Template_Group->ID()
-            );
-        }
-        $query_args = array(
-            'action' => ! empty($this->_req_data['redirect_back_to'])
-                ? $this->_req_data['redirect_back_to']
-                : 'default',
-        );
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-
-    /**
-     * This is called when javascript is being enqueued to setup the various data needed for the reports js.
-     * Also $this->{$_reports_template_data} property is set for later usage by the _registration_reports method.
-     */
-    protected function _registration_reports_js_setup()
-    {
-        $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_day_report();
-        $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_event_report();
-    }
-
-
-
-    /**
-     *        generates Business Reports regarding Registrations
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _registration_reports()
-    {
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $template_path,
-            $this->_reports_template_data,
-            true
-        );
-        // the final template wrapper
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-
-    /**
-     * Generates Business Report showing total registrations per day.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     * @return string
-     */
-    private function _registrations_per_day_report($period = '-1 month')
-    {
-        $report_ID = 'reg-admin-registrations-per-day-report-dv';
-        $results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
-        $results = (array)$results;
-        $regs = array();
-        $subtitle = '';
-        if ($results) {
-            $column_titles = array();
-            $tracker = 0;
-            foreach ($results as $result) {
-                $report_column_values = array();
-                foreach ($result as $property_name => $property_value) {
-                    $property_value = $property_name === 'Registration_REG_date' ? $property_value
-                        : (int)$property_value;
-                    $report_column_values[] = $property_value;
-                    if ($tracker === 0) {
-                        if ($property_name === 'Registration_REG_date') {
-                            $column_titles[] = __('Date (only days with registrations are shown)', 'event_espresso');
-                        } else {
-                            $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
-                        }
-                    }
-                }
-                $tracker++;
-                $regs[] = $report_column_values;
-            }
-            //make sure the column_titles is pushed to the beginning of the array
-            array_unshift($regs, $column_titles);
-            //setup the date range.
-            $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
-            $ending_date = new DateTime("now", $DateTimeZone);
-            $subtitle = sprintf(
-                _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'),
-                $ending_date->format('Y-m-d')
-            );
-        }
-        $report_title = __('Total Registrations per Day', 'event_espresso');
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'regs'      => $regs,
-            'noResults' => empty($regs),
-            'noRegsMsg' => sprintf(
-                __(
-                    '%sThere are currently no registration records in the last month for this report.%s',
-                    'event_espresso'
-                ),
-                '<h2>' . $report_title . '</h2><p>',
-                '</p>'
-            ),
-        );
-        wp_localize_script('ee-reg-reports-js', 'regPerDay', $report_params);
-        return $report_ID;
-    }
-
-
-
-    /**
-     * Generates Business Report showing total registrations per event.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     * @return string
-     */
-    private function _registrations_per_event_report($period = '-1 month')
-    {
-        $report_ID = 'reg-admin-registrations-per-event-report-dv';
-        $results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
-        $results = (array)$results;
-        $regs = array();
-        $subtitle = '';
-        if ($results) {
-            $column_titles = array();
-            $tracker = 0;
-            foreach ($results as $result) {
-                $report_column_values = array();
-                foreach ($result as $property_name => $property_value) {
-                    $property_value = $property_name === 'Registration_Event' ? wp_trim_words(
-                        $property_value,
-                        4,
-                        '...'
-                    ) : (int)$property_value;
-                    $report_column_values[] = $property_value;
-                    if ($tracker === 0) {
-                        if ($property_name === 'Registration_Event') {
-                            $column_titles[] = __('Event', 'event_espresso');
-                        } else {
-                            $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
-                        }
-                    }
-                }
-                $tracker++;
-                $regs[] = $report_column_values;
-            }
-            //make sure the column_titles is pushed to the beginning of the array
-            array_unshift($regs, $column_titles);
-            //setup the date range.
-            $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
-            $ending_date = new DateTime("now", $DateTimeZone);
-            $subtitle = sprintf(
-                _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'),
-                $ending_date->format('Y-m-d')
-            );
-        }
-        $report_title = __('Total Registrations per Event', 'event_espresso');
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'regs'      => $regs,
-            'noResults' => empty($regs),
-            'noRegsMsg' => sprintf(
-                __(
-                    '%sThere are currently no registration records in the last month for this report.%s',
-                    'event_espresso'
-                ),
-                '<h2>' . $report_title . '</h2><p>',
-                '</p>'
-            ),
-        );
-        wp_localize_script('ee-reg-reports-js', 'regPerEvent', $report_params);
-        return $report_ID;
-    }
-
-
-
-    /**
-     * generates HTML for the Registration Check-in list table (showing all Check-ins for a specific registration)
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _registration_checkin_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $reg_id = isset($this->_req_data['_REGID']) ? $this->_req_data['_REGID'] : null;
-        /** @var EE_Registration $registration */
-        $registration = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        $attendee = $registration->attendee();
-        $this->_admin_page_title .= $this->get_action_link_or_button(
-            'new_registration',
-            'add-registrant',
-            array('event_id' => $registration->event_ID()),
-            'add-new-h2'
-        );
-        $legend_items = array(
-            'checkin'  => array(
-                'class' => 'ee-icon ee-icon-check-in',
-                'desc'  => __('This indicates the attendee has been checked in', 'event_espresso'),
-            ),
-            'checkout' => array(
-                'class' => 'ee-icon ee-icon-check-out',
-                'desc'  => __('This indicates the attendee has been checked out', 'event_espresso'),
-            ),
-        );
-        $this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
-        $dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
-        /** @var EE_Datetime $datetime */
-        $datetime = EEM_Datetime::instance()->get_one_by_ID($dtt_id);
-        $datetime_label = '';
-        if ($datetime instanceof EE_Datetime) {
-            $datetime_label = $datetime->get_dtt_display_name(true);
-            $datetime_label .= ! empty($datetime_label)
-                ? ' (' . $datetime->get_dtt_display_name() . ')'
-                : $datetime->get_dtt_display_name();
-        }
-        $datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
-            ? EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'   => 'event_registrations',
-                    'event_id' => $registration->event_ID(),
-                    'DTT_ID'   => $dtt_id,
-                ),
-                $this->_admin_base_url
-            )
-            : '';
-        $datetime_link = ! empty($datetime_link)
-            ? '<a href="' . $datetime_link . '">'
-              . '<span id="checkin-dtt">'
-              . $datetime_label
-              . '</span></a>'
-            : $datetime_label;
-        $attendee_name = $attendee instanceof EE_Attendee
-            ? $attendee->full_name()
-            : '';
-        $attendee_link = $attendee instanceof EE_Attendee
-            ? $attendee->get_admin_details_link()
-            : '';
-        $attendee_link = ! empty($attendee_link)
-            ? '<a href="' . $attendee->get_admin_details_link() . '"'
-              . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
-              . '<span id="checkin-attendee-name">'
-              . $attendee_name
-              . '</span></a>'
-            : '';
-        $event_link = $registration->event() instanceof EE_Event
-            ? $registration->event()->get_admin_details_link()
-            : '';
-        $event_link = ! empty($event_link)
-            ? '<a href="' . $event_link . '"'
-              . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
-              . '<span id="checkin-event-name">'
-              . $registration->event_name()
-              . '</span>'
-              . '</a>'
-            : '';
-        $this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
-            ? '<h2>' . sprintf(
-                esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
-                $attendee_link,
-                $datetime_link,
-                $event_link
-            ) . '</h2>'
-            : '';
-        $this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
-            ? '<input type="hidden" name="_REGID" value="' . $reg_id . '">' : '';
-        $this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
-            ? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-
-    /**
-     * toggle the Check-in status for the given registration (coming from ajax)
-     *
-     * @return void (JSON)
-     */
-    public function toggle_checkin_status()
-    {
-        //first make sure we have the necessary data
-        if ( ! isset($this->_req_data['_regid'])) {
-            EE_Error::add_error(
-                __(
-                    'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        };
-        //do a nonce check cause we're not coming in from an normal route here.
-        $nonce = isset($this->_req_data['checkinnonce']) ? sanitize_text_field($this->_req_data['checkinnonce'])
-            : '';
-        $nonce_ref = 'checkin_nonce';
-        $this->_verify_nonce($nonce, $nonce_ref);
-        //beautiful! Made it this far so let's get the status.
-        $new_status = $this->_toggle_checkin_status();
-        //setup new class to return via ajax
-        $this->_template_args['admin_page_content'] = 'clickable trigger-checkin checkin-icons checkedin-status-'
-                                                      . $new_status;
-        $this->_template_args['success'] = true;
-        $this->_return_json();
-    }
-
-
-
-    /**
-     * handles toggling the checkin status for the registration,
-     *
-     * @access protected
-     * @return int|void
-     */
-    protected function _toggle_checkin_status()
-    {
-        //first let's get the query args out of the way for the redirect
-        $query_args = array(
-            'action'   => 'event_registrations',
-            'event_id' => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
-            'DTT_ID'   => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null,
-        );
-        $new_status = false;
-        // bulk action check in toggle
-        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // cycle thru checkboxes
-            while (list($REG_ID, $value) = each($this->_req_data['checkbox'])) {
-                $DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
-                $new_status = $this->_toggle_checkin($REG_ID, $DTT_ID);
-            }
-        } elseif (isset($this->_req_data['_regid'])) {
-            //coming from ajax request
-            $DTT_ID = isset($this->_req_data['dttid']) ? $this->_req_data['dttid'] : null;
-            $query_args['DTT_ID'] = $DTT_ID;
-            $new_status = $this->_toggle_checkin($this->_req_data['_regid'], $DTT_ID);
-        } else {
-            EE_Error::add_error(
-                __('Missing some required data to toggle the Check-in', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        if (defined('DOING_AJAX')) {
-            return $new_status;
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-
-    /**
-     * This is toggles a single Check-in for the given registration and datetime.
-     *
-     * @param  int $REG_ID The registration we're toggling
-     * @param  int $DTT_ID The datetime we're toggling
-     * @return int            The new status toggled to.
-     * @throws \EE_Error
-     */
-    private function _toggle_checkin($REG_ID, $DTT_ID)
-    {
-        /** @var EE_Registration $REG */
-        $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-        $new_status = $REG->toggle_checkin_status($DTT_ID);
-        if ($new_status !== false) {
-            EE_Error::add_success($REG->get_checkin_msg($DTT_ID));
-        } else {
-            EE_Error::add_error($REG->get_checkin_msg($DTT_ID, true), __FILE__, __FUNCTION__, __LINE__);
-            $new_status = false;
-        }
-        return $new_status;
-    }
-
-
-
-    /**
-     * Takes care of deleting multiple EE_Checkin table rows
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _delete_checkin_rows()
-    {
-        $query_args = array(
-            'action' => 'registration_checkins',
-            'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
-            '_REGID' => isset($this->_req_data['_REGID']) ? $this->_req_data['_REGID'] : 0,
-        );
-        $errors = 0;
-        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            while (list($CHK_ID, $value) = each($this->_req_data['checkbox'])) {
-                if ( ! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
-                    $errors++;
-                }
-            }
-        } else {
-            EE_Error::add_error(
-                __(
-                    'So, something went wrong with the bulk delete because there was no data received for instructions on WHAT to delete!',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', $query_args, true);
-        }
-        if ($errors > 0) {
-            EE_Error::add_error(
-                sprintf(__('There were %d records that did not delete successfully', 'event_espresso'), $errors),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            EE_Error::add_success(__('Records were successfully deleted', 'event_espresso'));
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-
-    /**
-     * Deletes a single EE_Checkin row
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _delete_checkin_row()
-    {
-        $query_args = array(
-            'action' => 'registration_checkins',
-            'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
-            '_REGID' => isset($this->_req_data['_REGID']) ? $this->_req_data['_REGID'] : 0,
-        );
-        if ( ! empty($this->_req_data['CHK_ID'])) {
-            if ( ! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
-                EE_Error::add_error(
-                    __('Something went wrong and this check-in record was not deleted', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_success(__('Check-In record successfully deleted', 'event_espresso'));
-            }
-        } else {
-            EE_Error::add_error(
-                __(
-                    'In order to delete a Check-in record, there must be a Check-In ID available. There is not. It is not your fault, there is just a gremlin living in the code',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-
-    /**
-     *        generates HTML for the Event Registrations List Table
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _event_registrations_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_admin_page_title .= isset($this->_req_data['event_id'])
-            ? $this->get_action_link_or_button(
-                'new_registration',
-                'add-registrant',
-                array('event_id' => $this->_req_data['event_id']),
-                'add-new-h2',
-                '',
-                false
-            )
-            : '';
-        $legend_items = array(
-            'star-icon'        => array(
-                'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
-                'desc'  => __('This Registrant is the Primary Registrant', 'event_espresso'),
-            ),
-            'checkin'          => array(
-                'class' => 'ee-icon ee-icon-check-in',
-                'desc'  => __('This Registrant has been Checked In', 'event_espresso'),
-            ),
-            'checkout'         => array(
-                'class' => 'ee-icon ee-icon-check-out',
-                'desc'  => __('This Registrant has been Checked Out', 'event_espresso'),
-            ),
-            'nocheckinrecord'  => array(
-                'class' => 'dashicons dashicons-no',
-                'desc'  => __('No Check-in Record has been Created for this Registrant', 'event_espresso'),
-            ),
-            'view_details'     => array(
-                'class' => 'dashicons dashicons-search',
-                'desc'  => __('View All Check-in Records for this Registrant', 'event_espresso'),
-            ),
-            'approved_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
-            ),
-            'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
-            ),
-            'declined_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
-            ),
-            'not_approved'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
-            ),
-            'pending_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
-            ),
-            'wait_list'        => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
-            ),
-        );
-        $this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
-        $event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
-        $this->_template_args['before_list_table'] = ! empty($event_id)
-            ? '<h2>' . sprintf(
-                __('Viewing Registrations for Event: %s', 'event_espresso'),
-                EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
-            ) . '</h2>'
-            : '';
-        //need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on the event.
-        /** @var EE_Event $event */
-        $event = EEM_Event::instance()->get_one_by_ID($event_id);
-        $DTT_ID = ! empty($this->_req_data['DTT_ID']) ? absint($this->_req_data['DTT_ID']) : 0;
-        $datetime = null;
-        if ($event instanceof EE_Event) {
-            $datetimes_on_event = $event->datetimes();
-            if (count($datetimes_on_event) === 1) {
-                $datetime = reset($datetimes_on_event);
-            }
-        }
-        $datetime = $datetime instanceof EE_Datetime ? $datetime : EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
-        if ($datetime instanceof EE_Datetime && $this->_template_args['before_list_table'] !== '') {
-            $this->_template_args['before_list_table'] = substr($this->_template_args['before_list_table'], 0, -5);
-            $this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
-            $this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
-            $this->_template_args['before_list_table'] .= $datetime->name();
-            $this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
-            $this->_template_args['before_list_table'] .= '</span></h2>';
-        }
-        //if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status column
-        //represents
-        if ( ! $datetime instanceof EE_Datetime) {
-            $this->_template_args['before_list_table'] .= '<br><p class="description">'
-                                                          . __('In this view, the check-in status represents the latest check-in record for the registration in that row.',
-                    'event_espresso')
-                                                          . '</p>';
-        }
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-    /**
-     * Download the registrations check-in report (same as the normal registration report, but with different where
-     * conditions)
-     *
-     * @return void ends the request by a redirect or download
-     */
-    public function _registrations_checkin_report()
-    {
-        $this->_registrations_report_base('_get_checkin_query_params_from_request');
-    }
-
-    /**
-     * Gets the query params from the request, plus adds a where condition for the registration status,
-     * because on the checkin page we only ever want to see approved and pending-approval registrations
-     *
-     * @param array     $request
-     * @param int  $per_page
-     * @param bool $count
-     * @return array
-     */
-    protected function _get_checkin_query_params_from_request(
-        $request,
-        $per_page = 10,
-        $count = false
-    ) {
-        $query_params = $this->_get_registration_query_parameters($request, $per_page, $count);
-        //unlike the regular registrations list table,
-        $status_ids_array = apply_filters(
-            'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
-            array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
-        );
-        $query_params[0]['STS_ID'] = array('IN', $status_ids_array);
-        return $query_params;
-    }
-
-
-
-
-    /**
-     * Gets registrations for an event
-     *
-     * @param int    $per_page
-     * @param bool   $count whether to return count or data.
-     * @param bool   $trash
-     * @param string $orderby
-     * @return EE_Registration[]|int
-     * @throws \EE_Error
-     */
-    public function get_event_attendees($per_page = 10, $count = false, $trash = false, $orderby = 'ATT_fname')
-    {
-        //normalize some request params that get setup by the parent `get_registrations` method.
-        $request = $this->_req_data;
-        $request['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : $orderby;
-        $request['order'] =  ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
-        if($trash){
-            $request['status'] = 'trash';
-        }
-        $query_params = $this->_get_checkin_query_params_from_request( $request, $per_page, $count );
-        /**
-         * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
-         * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
-         * @see EEM_Base::get_all()
-         */
-        $query_params['group_by'] = '';
-
-        return $count
-            ? EEM_Registration::instance()->count($query_params)
-            /** @type EE_Registration[] */
-            : EEM_Registration::instance()->get_all($query_params);
-    }
+	/**
+	 * This is used to hold the reports template data which is setup early in the request.
+	 *
+	 * @type array
+	 */
+	protected $_reports_template_data = array();
+
+
+
+	/**
+	 * Extend_Registrations_Admin_Page constructor.
+	 *
+	 * @param bool $routing
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		if ( ! defined('REG_CAF_TEMPLATE_PATH')) {
+			define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
+			define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
+			define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
+		}
+	}
+
+
+
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
+		$reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
+			? $this->_req_data['_REG_ID']
+			: 0;
+		// $att_id = ! empty( $this->_req_data['ATT_ID'] ) ? ! is_array( $this->_req_data['ATT_ID'] ) : 0;
+		// $att_id = ! empty( $this->_req_data['post'] ) && ! is_array( $this->_req_data['post'] )
+		// 	? $this->_req_data['post'] : $att_id;
+		$new_page_routes = array(
+			'reports'                  => array(
+				'func'       => '_registration_reports',
+				'capability' => 'ee_read_registrations',
+			),
+			'registration_checkins'    => array(
+				'func'       => '_registration_checkin_list_table',
+				'capability' => 'ee_read_checkins',
+			),
+			'newsletter_selected_send' => array(
+				'func'       => '_newsletter_selected_send',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			),
+			'delete_checkin_rows'      => array(
+				'func'       => '_delete_checkin_rows',
+				'noheader'   => true,
+				'capability' => 'ee_delete_checkins',
+			),
+			'delete_checkin_row'       => array(
+				'func'       => '_delete_checkin_row',
+				'noheader'   => true,
+				'capability' => 'ee_delete_checkin',
+				'obj_id'     => $reg_id,
+			),
+			'toggle_checkin_status'    => array(
+				'func'       => '_toggle_checkin_status',
+				'noheader'   => true,
+				'capability' => 'ee_edit_checkin',
+				'obj_id'     => $reg_id,
+			),
+			'event_registrations'      => array(
+				'func'       => '_event_registrations_list_table',
+				'capability' => 'ee_read_checkins',
+			),
+			'registrations_checkin_report' => array(
+				'func'       => '_registrations_checkin_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_registrations',
+			),
+		);
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+		$new_page_config = array(
+			'reports'               => array(
+				'nav'           => array(
+					'label' => __('Reports', 'event_espresso'),
+					'order' => 30,
+				),
+				'help_tabs'     => array(
+					'registrations_reports_help_tab' => array(
+						'title'    => __('Registration Reports', 'event_espresso'),
+						'filename' => 'registrations_reports',
+					),
+				),
+				/*'help_tour' => array( 'Registration_Reports_Help_Tour' ),*/
+				'require_nonce' => false,
+			),
+			'event_registrations'   => array(
+				'nav'           => array(
+					'label'      => __('Event Check-In', 'event_espresso'),
+					'order'      => 10,
+					'persistent' => true,
+				),
+				'help_tabs'     => array(
+					'registrations_event_checkin_help_tab'                       => array(
+						'title'    => __('Registrations Event Check-In', 'event_espresso'),
+						'filename' => 'registrations_event_checkin',
+					),
+					'registrations_event_checkin_table_column_headings_help_tab' => array(
+						'title'    => __('Event Check-In Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_table_column_headings',
+					),
+					'registrations_event_checkin_filters_help_tab'               => array(
+						'title'    => __('Event Check-In Filters', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_filters',
+					),
+					'registrations_event_checkin_views_help_tab'                 => array(
+						'title'    => __('Event Check-In Views', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_views',
+					),
+					'registrations_event_checkin_other_help_tab'                 => array(
+						'title'    => __('Event Check-In Other', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_other',
+					),
+				),
+				'help_tour'     => array('Event_Checkin_Help_Tour'),
+				'qtips'         => array('Registration_List_Table_Tips'),
+				'list_table'    => 'EE_Event_Registrations_List_Table',
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+			'registration_checkins' => array(
+				'nav'           => array(
+					'label'      => __('Check-In Records', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'list_table'    => 'EE_Registration_CheckIn_List_Table',
+				//'help_tour' => array( 'Checkin_Toggle_View_Help_Tour' ),
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+		$this->_page_config['contact_list']['list_table'] = 'Extend_EE_Attendee_Contact_List_Table';
+		$this->_page_config['default']['list_table'] = 'Extend_EE_Registrations_List_Table';
+	}
+
+
+
+	protected function _ajax_hooks()
+	{
+		parent::_ajax_hooks();
+		add_action('wp_ajax_get_newsletter_form_content', array($this, 'get_newsletter_form_content'));
+	}
+
+
+
+	public function load_scripts_styles()
+	{
+		parent::load_scripts_styles();
+		//if newsletter message type is active then let's add filter and load js for it.
+		if (EEH_MSG_Template::is_mt_active('newsletter')) {
+			//enqueue newsletter js
+			wp_enqueue_script(
+				'ee-newsletter-trigger',
+				REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
+				array('ee-dialog'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_style(
+				'ee-newsletter-trigger-css',
+				REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
+				array(),
+				EVENT_ESPRESSO_VERSION
+			);
+			//hook in buttons for newsletter message type trigger.
+			add_action(
+				'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
+				array($this, 'add_newsletter_action_buttons'),
+				10
+			);
+		}
+	}
+
+
+
+	public function load_scripts_styles_reports()
+	{
+		wp_register_script(
+			'ee-reg-reports-js',
+			REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
+			array('google-charts'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-reg-reports-js');
+		$this->_registration_reports_js_setup();
+	}
+
+
+
+	protected function _add_screen_options_event_registrations()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+
+	protected function _add_screen_options_registration_checkins()
+	{
+		$page_title = $this->_admin_page_title;
+		$this->_admin_page_title = __('Check-In Records', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+
+	protected function _set_list_table_views_event_registrations()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => __('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => ! isset($this->_req_data['event_id'])
+					? array()
+					: array(
+						'toggle_checkin_status' => __('Toggle Check-In', 'event_espresso'),
+						//'trash_registrations' => __('Trash Registrations', 'event_espresso')
+					),
+			),
+		);
+	}
+
+
+
+	protected function _set_list_table_views_registration_checkins()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => __('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array('delete_checkin_rows' => __('Delete Check-In Rows', 'event_espresso')),
+			),
+		);
+	}
+
+
+
+	/**
+	 * callback for ajax action.
+	 *
+	 * @since 4.3.0
+	 * @return void (JSON)
+	 * @throws \EE_Error
+	 */
+	public function get_newsletter_form_content()
+	{
+		//do a nonce check cause we're not coming in from an normal route here.
+		$nonce = isset($this->_req_data['get_newsletter_form_content_nonce']) ? sanitize_text_field(
+			$this->_req_data['get_newsletter_form_content_nonce']
+		) : '';
+		$nonce_ref = 'get_newsletter_form_content_nonce';
+		$this->_verify_nonce($nonce, $nonce_ref);
+		//let's get the mtp for the incoming MTP_ ID
+		if ( ! isset($this->_req_data['GRP_ID'])) {
+			EE_Error::add_error(
+				__(
+					'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+		$MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']);
+		if ( ! $MTPG instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'The GRP_ID given (%d) does not appear to have a corresponding row in the database.',
+						'event_espresso'
+					),
+					$this->_req_data['GRP_ID']
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+		$MTPs = $MTPG->context_templates();
+		$MTPs = $MTPs['attendee'];
+		$template_fields = array();
+		/** @var EE_Message_Template $MTP */
+		foreach ($MTPs as $MTP) {
+			$field = $MTP->get('MTP_template_field');
+			if ($field === 'content') {
+				$content = $MTP->get('MTP_content');
+				if ( ! empty($content['newsletter_content'])) {
+					$template_fields['newsletter_content'] = $content['newsletter_content'];
+				}
+				continue;
+			}
+			$template_fields[$MTP->get('MTP_template_field')] = $MTP->get('MTP_content');
+		}
+		$this->_template_args['success'] = true;
+		$this->_template_args['error'] = false;
+		$this->_template_args['data'] = array(
+			'batch_message_from'    => isset($template_fields['from'])
+				? $template_fields['from']
+				: '',
+			'batch_message_subject' => isset($template_fields['subject'])
+				? $template_fields['subject']
+				: '',
+			'batch_message_content' => isset($template_fields['newsletter_content'])
+				? $template_fields['newsletter_content']
+				: '',
+		);
+		$this->_return_json();
+	}
+
+
+
+	/**
+	 * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action
+	 *
+	 * @since 4.3.0
+	 * @param EE_Admin_List_Table $list_table
+	 * @return void
+	 */
+	public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table)
+	{
+		if ( ! EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'espresso_registrations_newsletter_selected_send'
+		)
+		) {
+			return;
+		}
+		$routes_to_add_to = array(
+			'contact_list',
+			'event_registrations',
+			'default',
+		);
+		if ($this->_current_page === 'espresso_registrations' && in_array($this->_req_action, $routes_to_add_to)) {
+			if (($this->_req_action === 'event_registrations' && empty($this->_req_data['event_id']))
+				|| (isset($this->_req_data['status']) && $this->_req_data['status'] === 'trash')
+			) {
+				echo '';
+			} else {
+				$button_text = sprintf(
+					__('Send Batch Message (%s selected)', 'event_espresso'),
+					'<span class="send-selected-newsletter-count">0</span>'
+				);
+				echo '<button id="selected-batch-send-trigger" class="button secondary-button"><span class="dashicons dashicons-email "></span>'
+					 . $button_text
+					 . '</button>';
+				add_action('admin_footer', array($this, 'newsletter_send_form_skeleton'));
+			}
+		}
+	}
+
+
+
+	public function newsletter_send_form_skeleton()
+	{
+		$list_table = $this->_list_table_object;
+		$codes = array();
+		//need to templates for the newsletter message type for the template selector.
+		$values[] = array('text' => __('Select Template to Use', 'event_espresso'), 'id' => 0);
+		$mtps = EEM_Message_Template_Group::instance()->get_all(
+			array(array('MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email'))
+		);
+		foreach ($mtps as $mtp) {
+			$name = $mtp->name();
+			$values[] = array(
+				'text' => empty($name) ? __('Global', 'event_espresso') : $name,
+				'id'   => $mtp->ID(),
+			);
+		}
+		//need to get a list of shortcodes that are available for the newsletter message type.
+		$shortcodes = EEH_MSG_Template::get_shortcodes('newsletter', 'email', array(), 'attendee', false);
+		foreach ($shortcodes as $field => $shortcode_array) {
+			$codes[$field] = implode(', ', array_keys($shortcode_array));
+		}
+		$shortcodes = $codes;
+		$form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
+		$form_template_args = array(
+			'form_action'       => admin_url('admin.php?page=espresso_registrations'),
+			'form_route'        => 'newsletter_selected_send',
+			'form_nonce_name'   => 'newsletter_selected_send_nonce',
+			'form_nonce'        => wp_create_nonce('newsletter_selected_send_nonce'),
+			'redirect_back_to'  => $this->_req_action,
+			'ajax_nonce'        => wp_create_nonce('get_newsletter_form_content_nonce'),
+			'template_selector' => EEH_Form_Fields::select_input('newsletter_mtp_selected', $values),
+			'shortcodes'        => $shortcodes,
+			'id_type'           => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact' : 'registration',
+		);
+		EEH_Template::display_template($form_template, $form_template_args);
+	}
+
+
+
+	/**
+	 * Handles sending selected registrations/contacts a newsletter.
+	 *
+	 * @since  4.3.0
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _newsletter_selected_send()
+	{
+		$success = true;
+		//first we need to make sure we have a GRP_ID so we know what template we're sending and updating!
+		if (empty($this->_req_data['newsletter_mtp_selected'])) {
+			EE_Error::add_error(
+				__(
+					'In order to send a message, a Message Template GRP_ID is needed. It was not provided so messages were not sent.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		if ($success) {
+			//update Message template in case there are any changes
+			$Message_Template_Group = EEM_Message_Template_Group::instance()->get_one_by_ID(
+				$this->_req_data['newsletter_mtp_selected']
+			);
+			$Message_Templates = $Message_Template_Group instanceof EE_Message_Template_Group
+				? $Message_Template_Group->context_templates()
+				: array();
+			if (empty($Message_Templates)) {
+				EE_Error::add_error(
+					__(
+						'Unable to retrieve message template fields from the db. Messages not sent.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			//let's just update the specific fields
+			foreach ($Message_Templates['attendee'] as $Message_Template) {
+				if ($Message_Template instanceof EE_Message_Template) {
+					$field = $Message_Template->get('MTP_template_field');
+					$content = $Message_Template->get('MTP_content');
+					$new_content = $content;
+					switch ($field) {
+						case 'from' :
+							$new_content = ! empty($this->_req_data['batch_message']['from'])
+								? $this->_req_data['batch_message']['from']
+								: $content;
+							break;
+						case 'subject' :
+							$new_content = ! empty($this->_req_data['batch_message']['subject'])
+								? $this->_req_data['batch_message']['subject']
+								: $content;
+							break;
+						case 'content' :
+							$new_content = $content;
+							$new_content['newsletter_content'] = ! empty($this->_req_data['batch_message']['content'])
+								? $this->_req_data['batch_message']['content']
+								: $content['newsletter_content'];
+							break;
+						default :
+							//continue the foreach loop, we don't want to set $new_content nor save.
+							continue 2;
+					}
+					$Message_Template->set('MTP_content', $new_content);
+					$Message_Template->save();
+				}
+			}
+			//great fields are updated!  now let's make sure we just have contact objects (EE_Attendee).
+			$id_type = ! empty($this->_req_data['batch_message']['id_type'])
+				? $this->_req_data['batch_message']['id_type']
+				: 'registration';
+			//id_type will affect how we assemble the ids.
+			$ids = ! empty($this->_req_data['batch_message']['ids'])
+				? json_decode(stripslashes($this->_req_data['batch_message']['ids']))
+				: array();
+			$registrations_used_for_contact_data = array();
+			//using switch because eventually we'll have other contexts that will be used for generating messages.
+			switch ($id_type) {
+				case 'registration' :
+					$registrations_used_for_contact_data = EEM_Registration::instance()->get_all(
+						array(
+							array(
+								'REG_ID' => array('IN', $ids),
+							),
+						)
+					);
+					break;
+				case 'contact' :
+					$registrations_used_for_contact_data = EEM_Registration::instance()
+																		   ->get_latest_registration_for_each_of_given_contacts($ids);
+					break;
+			}
+			do_action(
+				'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
+				$registrations_used_for_contact_data,
+				$Message_Template_Group->ID()
+			);
+			//kept for backward compat, internally we no longer use this action.
+			//@deprecated 4.8.36.rc.002
+			$contacts = $id_type === 'registration'
+				? EEM_Attendee::instance()->get_array_of_contacts_from_reg_ids($ids)
+				: EEM_Attendee::instance()->get_all(array(array('ATT_ID' => array('in', $ids))));
+			do_action(
+				'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send',
+				$contacts,
+				$Message_Template_Group->ID()
+			);
+		}
+		$query_args = array(
+			'action' => ! empty($this->_req_data['redirect_back_to'])
+				? $this->_req_data['redirect_back_to']
+				: 'default',
+		);
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+
+	/**
+	 * This is called when javascript is being enqueued to setup the various data needed for the reports js.
+	 * Also $this->{$_reports_template_data} property is set for later usage by the _registration_reports method.
+	 */
+	protected function _registration_reports_js_setup()
+	{
+		$this->_reports_template_data['admin_reports'][] = $this->_registrations_per_day_report();
+		$this->_reports_template_data['admin_reports'][] = $this->_registrations_per_event_report();
+	}
+
+
+
+	/**
+	 *        generates Business Reports regarding Registrations
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _registration_reports()
+	{
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$template_path,
+			$this->_reports_template_data,
+			true
+		);
+		// the final template wrapper
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+
+	/**
+	 * Generates Business Report showing total registrations per day.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 * @return string
+	 */
+	private function _registrations_per_day_report($period = '-1 month')
+	{
+		$report_ID = 'reg-admin-registrations-per-day-report-dv';
+		$results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
+		$results = (array)$results;
+		$regs = array();
+		$subtitle = '';
+		if ($results) {
+			$column_titles = array();
+			$tracker = 0;
+			foreach ($results as $result) {
+				$report_column_values = array();
+				foreach ($result as $property_name => $property_value) {
+					$property_value = $property_name === 'Registration_REG_date' ? $property_value
+						: (int)$property_value;
+					$report_column_values[] = $property_value;
+					if ($tracker === 0) {
+						if ($property_name === 'Registration_REG_date') {
+							$column_titles[] = __('Date (only days with registrations are shown)', 'event_espresso');
+						} else {
+							$column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
+						}
+					}
+				}
+				$tracker++;
+				$regs[] = $report_column_values;
+			}
+			//make sure the column_titles is pushed to the beginning of the array
+			array_unshift($regs, $column_titles);
+			//setup the date range.
+			$DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
+			$beginning_date = new DateTime("now " . $period, $DateTimeZone);
+			$ending_date = new DateTime("now", $DateTimeZone);
+			$subtitle = sprintf(
+				_x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'),
+				$ending_date->format('Y-m-d')
+			);
+		}
+		$report_title = __('Total Registrations per Day', 'event_espresso');
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'regs'      => $regs,
+			'noResults' => empty($regs),
+			'noRegsMsg' => sprintf(
+				__(
+					'%sThere are currently no registration records in the last month for this report.%s',
+					'event_espresso'
+				),
+				'<h2>' . $report_title . '</h2><p>',
+				'</p>'
+			),
+		);
+		wp_localize_script('ee-reg-reports-js', 'regPerDay', $report_params);
+		return $report_ID;
+	}
+
+
+
+	/**
+	 * Generates Business Report showing total registrations per event.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 * @return string
+	 */
+	private function _registrations_per_event_report($period = '-1 month')
+	{
+		$report_ID = 'reg-admin-registrations-per-event-report-dv';
+		$results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
+		$results = (array)$results;
+		$regs = array();
+		$subtitle = '';
+		if ($results) {
+			$column_titles = array();
+			$tracker = 0;
+			foreach ($results as $result) {
+				$report_column_values = array();
+				foreach ($result as $property_name => $property_value) {
+					$property_value = $property_name === 'Registration_Event' ? wp_trim_words(
+						$property_value,
+						4,
+						'...'
+					) : (int)$property_value;
+					$report_column_values[] = $property_value;
+					if ($tracker === 0) {
+						if ($property_name === 'Registration_Event') {
+							$column_titles[] = __('Event', 'event_espresso');
+						} else {
+							$column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
+						}
+					}
+				}
+				$tracker++;
+				$regs[] = $report_column_values;
+			}
+			//make sure the column_titles is pushed to the beginning of the array
+			array_unshift($regs, $column_titles);
+			//setup the date range.
+			$DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
+			$beginning_date = new DateTime("now " . $period, $DateTimeZone);
+			$ending_date = new DateTime("now", $DateTimeZone);
+			$subtitle = sprintf(
+				_x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'),
+				$ending_date->format('Y-m-d')
+			);
+		}
+		$report_title = __('Total Registrations per Event', 'event_espresso');
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'regs'      => $regs,
+			'noResults' => empty($regs),
+			'noRegsMsg' => sprintf(
+				__(
+					'%sThere are currently no registration records in the last month for this report.%s',
+					'event_espresso'
+				),
+				'<h2>' . $report_title . '</h2><p>',
+				'</p>'
+			),
+		);
+		wp_localize_script('ee-reg-reports-js', 'regPerEvent', $report_params);
+		return $report_ID;
+	}
+
+
+
+	/**
+	 * generates HTML for the Registration Check-in list table (showing all Check-ins for a specific registration)
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _registration_checkin_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$reg_id = isset($this->_req_data['_REGID']) ? $this->_req_data['_REGID'] : null;
+		/** @var EE_Registration $registration */
+		$registration = EEM_Registration::instance()->get_one_by_ID($reg_id);
+		$attendee = $registration->attendee();
+		$this->_admin_page_title .= $this->get_action_link_or_button(
+			'new_registration',
+			'add-registrant',
+			array('event_id' => $registration->event_ID()),
+			'add-new-h2'
+		);
+		$legend_items = array(
+			'checkin'  => array(
+				'class' => 'ee-icon ee-icon-check-in',
+				'desc'  => __('This indicates the attendee has been checked in', 'event_espresso'),
+			),
+			'checkout' => array(
+				'class' => 'ee-icon ee-icon-check-out',
+				'desc'  => __('This indicates the attendee has been checked out', 'event_espresso'),
+			),
+		);
+		$this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
+		$dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
+		/** @var EE_Datetime $datetime */
+		$datetime = EEM_Datetime::instance()->get_one_by_ID($dtt_id);
+		$datetime_label = '';
+		if ($datetime instanceof EE_Datetime) {
+			$datetime_label = $datetime->get_dtt_display_name(true);
+			$datetime_label .= ! empty($datetime_label)
+				? ' (' . $datetime->get_dtt_display_name() . ')'
+				: $datetime->get_dtt_display_name();
+		}
+		$datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
+			? EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'   => 'event_registrations',
+					'event_id' => $registration->event_ID(),
+					'DTT_ID'   => $dtt_id,
+				),
+				$this->_admin_base_url
+			)
+			: '';
+		$datetime_link = ! empty($datetime_link)
+			? '<a href="' . $datetime_link . '">'
+			  . '<span id="checkin-dtt">'
+			  . $datetime_label
+			  . '</span></a>'
+			: $datetime_label;
+		$attendee_name = $attendee instanceof EE_Attendee
+			? $attendee->full_name()
+			: '';
+		$attendee_link = $attendee instanceof EE_Attendee
+			? $attendee->get_admin_details_link()
+			: '';
+		$attendee_link = ! empty($attendee_link)
+			? '<a href="' . $attendee->get_admin_details_link() . '"'
+			  . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
+			  . '<span id="checkin-attendee-name">'
+			  . $attendee_name
+			  . '</span></a>'
+			: '';
+		$event_link = $registration->event() instanceof EE_Event
+			? $registration->event()->get_admin_details_link()
+			: '';
+		$event_link = ! empty($event_link)
+			? '<a href="' . $event_link . '"'
+			  . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
+			  . '<span id="checkin-event-name">'
+			  . $registration->event_name()
+			  . '</span>'
+			  . '</a>'
+			: '';
+		$this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
+			? '<h2>' . sprintf(
+				esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
+				$attendee_link,
+				$datetime_link,
+				$event_link
+			) . '</h2>'
+			: '';
+		$this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
+			? '<input type="hidden" name="_REGID" value="' . $reg_id . '">' : '';
+		$this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
+			? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+
+	/**
+	 * toggle the Check-in status for the given registration (coming from ajax)
+	 *
+	 * @return void (JSON)
+	 */
+	public function toggle_checkin_status()
+	{
+		//first make sure we have the necessary data
+		if ( ! isset($this->_req_data['_regid'])) {
+			EE_Error::add_error(
+				__(
+					'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		};
+		//do a nonce check cause we're not coming in from an normal route here.
+		$nonce = isset($this->_req_data['checkinnonce']) ? sanitize_text_field($this->_req_data['checkinnonce'])
+			: '';
+		$nonce_ref = 'checkin_nonce';
+		$this->_verify_nonce($nonce, $nonce_ref);
+		//beautiful! Made it this far so let's get the status.
+		$new_status = $this->_toggle_checkin_status();
+		//setup new class to return via ajax
+		$this->_template_args['admin_page_content'] = 'clickable trigger-checkin checkin-icons checkedin-status-'
+													  . $new_status;
+		$this->_template_args['success'] = true;
+		$this->_return_json();
+	}
+
+
+
+	/**
+	 * handles toggling the checkin status for the registration,
+	 *
+	 * @access protected
+	 * @return int|void
+	 */
+	protected function _toggle_checkin_status()
+	{
+		//first let's get the query args out of the way for the redirect
+		$query_args = array(
+			'action'   => 'event_registrations',
+			'event_id' => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
+			'DTT_ID'   => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null,
+		);
+		$new_status = false;
+		// bulk action check in toggle
+		if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// cycle thru checkboxes
+			while (list($REG_ID, $value) = each($this->_req_data['checkbox'])) {
+				$DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
+				$new_status = $this->_toggle_checkin($REG_ID, $DTT_ID);
+			}
+		} elseif (isset($this->_req_data['_regid'])) {
+			//coming from ajax request
+			$DTT_ID = isset($this->_req_data['dttid']) ? $this->_req_data['dttid'] : null;
+			$query_args['DTT_ID'] = $DTT_ID;
+			$new_status = $this->_toggle_checkin($this->_req_data['_regid'], $DTT_ID);
+		} else {
+			EE_Error::add_error(
+				__('Missing some required data to toggle the Check-in', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		if (defined('DOING_AJAX')) {
+			return $new_status;
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+
+	/**
+	 * This is toggles a single Check-in for the given registration and datetime.
+	 *
+	 * @param  int $REG_ID The registration we're toggling
+	 * @param  int $DTT_ID The datetime we're toggling
+	 * @return int            The new status toggled to.
+	 * @throws \EE_Error
+	 */
+	private function _toggle_checkin($REG_ID, $DTT_ID)
+	{
+		/** @var EE_Registration $REG */
+		$REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+		$new_status = $REG->toggle_checkin_status($DTT_ID);
+		if ($new_status !== false) {
+			EE_Error::add_success($REG->get_checkin_msg($DTT_ID));
+		} else {
+			EE_Error::add_error($REG->get_checkin_msg($DTT_ID, true), __FILE__, __FUNCTION__, __LINE__);
+			$new_status = false;
+		}
+		return $new_status;
+	}
+
+
+
+	/**
+	 * Takes care of deleting multiple EE_Checkin table rows
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _delete_checkin_rows()
+	{
+		$query_args = array(
+			'action' => 'registration_checkins',
+			'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
+			'_REGID' => isset($this->_req_data['_REGID']) ? $this->_req_data['_REGID'] : 0,
+		);
+		$errors = 0;
+		if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			while (list($CHK_ID, $value) = each($this->_req_data['checkbox'])) {
+				if ( ! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
+					$errors++;
+				}
+			}
+		} else {
+			EE_Error::add_error(
+				__(
+					'So, something went wrong with the bulk delete because there was no data received for instructions on WHAT to delete!',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_redirect_after_action(false, '', '', $query_args, true);
+		}
+		if ($errors > 0) {
+			EE_Error::add_error(
+				sprintf(__('There were %d records that did not delete successfully', 'event_espresso'), $errors),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			EE_Error::add_success(__('Records were successfully deleted', 'event_espresso'));
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+
+	/**
+	 * Deletes a single EE_Checkin row
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _delete_checkin_row()
+	{
+		$query_args = array(
+			'action' => 'registration_checkins',
+			'DTT_ID' => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
+			'_REGID' => isset($this->_req_data['_REGID']) ? $this->_req_data['_REGID'] : 0,
+		);
+		if ( ! empty($this->_req_data['CHK_ID'])) {
+			if ( ! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
+				EE_Error::add_error(
+					__('Something went wrong and this check-in record was not deleted', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_success(__('Check-In record successfully deleted', 'event_espresso'));
+			}
+		} else {
+			EE_Error::add_error(
+				__(
+					'In order to delete a Check-in record, there must be a Check-In ID available. There is not. It is not your fault, there is just a gremlin living in the code',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+
+	/**
+	 *        generates HTML for the Event Registrations List Table
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _event_registrations_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_admin_page_title .= isset($this->_req_data['event_id'])
+			? $this->get_action_link_or_button(
+				'new_registration',
+				'add-registrant',
+				array('event_id' => $this->_req_data['event_id']),
+				'add-new-h2',
+				'',
+				false
+			)
+			: '';
+		$legend_items = array(
+			'star-icon'        => array(
+				'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
+				'desc'  => __('This Registrant is the Primary Registrant', 'event_espresso'),
+			),
+			'checkin'          => array(
+				'class' => 'ee-icon ee-icon-check-in',
+				'desc'  => __('This Registrant has been Checked In', 'event_espresso'),
+			),
+			'checkout'         => array(
+				'class' => 'ee-icon ee-icon-check-out',
+				'desc'  => __('This Registrant has been Checked Out', 'event_espresso'),
+			),
+			'nocheckinrecord'  => array(
+				'class' => 'dashicons dashicons-no',
+				'desc'  => __('No Check-in Record has been Created for this Registrant', 'event_espresso'),
+			),
+			'view_details'     => array(
+				'class' => 'dashicons dashicons-search',
+				'desc'  => __('View All Check-in Records for this Registrant', 'event_espresso'),
+			),
+			'approved_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
+			),
+			'cancelled_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
+			),
+			'declined_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
+			),
+			'not_approved'     => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
+			),
+			'pending_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
+			),
+			'wait_list'        => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
+			),
+		);
+		$this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
+		$event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
+		$this->_template_args['before_list_table'] = ! empty($event_id)
+			? '<h2>' . sprintf(
+				__('Viewing Registrations for Event: %s', 'event_espresso'),
+				EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
+			) . '</h2>'
+			: '';
+		//need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on the event.
+		/** @var EE_Event $event */
+		$event = EEM_Event::instance()->get_one_by_ID($event_id);
+		$DTT_ID = ! empty($this->_req_data['DTT_ID']) ? absint($this->_req_data['DTT_ID']) : 0;
+		$datetime = null;
+		if ($event instanceof EE_Event) {
+			$datetimes_on_event = $event->datetimes();
+			if (count($datetimes_on_event) === 1) {
+				$datetime = reset($datetimes_on_event);
+			}
+		}
+		$datetime = $datetime instanceof EE_Datetime ? $datetime : EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
+		if ($datetime instanceof EE_Datetime && $this->_template_args['before_list_table'] !== '') {
+			$this->_template_args['before_list_table'] = substr($this->_template_args['before_list_table'], 0, -5);
+			$this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
+			$this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
+			$this->_template_args['before_list_table'] .= $datetime->name();
+			$this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
+			$this->_template_args['before_list_table'] .= '</span></h2>';
+		}
+		//if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status column
+		//represents
+		if ( ! $datetime instanceof EE_Datetime) {
+			$this->_template_args['before_list_table'] .= '<br><p class="description">'
+														  . __('In this view, the check-in status represents the latest check-in record for the registration in that row.',
+					'event_espresso')
+														  . '</p>';
+		}
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+	/**
+	 * Download the registrations check-in report (same as the normal registration report, but with different where
+	 * conditions)
+	 *
+	 * @return void ends the request by a redirect or download
+	 */
+	public function _registrations_checkin_report()
+	{
+		$this->_registrations_report_base('_get_checkin_query_params_from_request');
+	}
+
+	/**
+	 * Gets the query params from the request, plus adds a where condition for the registration status,
+	 * because on the checkin page we only ever want to see approved and pending-approval registrations
+	 *
+	 * @param array     $request
+	 * @param int  $per_page
+	 * @param bool $count
+	 * @return array
+	 */
+	protected function _get_checkin_query_params_from_request(
+		$request,
+		$per_page = 10,
+		$count = false
+	) {
+		$query_params = $this->_get_registration_query_parameters($request, $per_page, $count);
+		//unlike the regular registrations list table,
+		$status_ids_array = apply_filters(
+			'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
+			array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
+		);
+		$query_params[0]['STS_ID'] = array('IN', $status_ids_array);
+		return $query_params;
+	}
+
+
+
+
+	/**
+	 * Gets registrations for an event
+	 *
+	 * @param int    $per_page
+	 * @param bool   $count whether to return count or data.
+	 * @param bool   $trash
+	 * @param string $orderby
+	 * @return EE_Registration[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_event_attendees($per_page = 10, $count = false, $trash = false, $orderby = 'ATT_fname')
+	{
+		//normalize some request params that get setup by the parent `get_registrations` method.
+		$request = $this->_req_data;
+		$request['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : $orderby;
+		$request['order'] =  ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
+		if($trash){
+			$request['status'] = 'trash';
+		}
+		$query_params = $this->_get_checkin_query_params_from_request( $request, $per_page, $count );
+		/**
+		 * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
+		 * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
+		 * @see EEM_Base::get_all()
+		 */
+		$query_params['group_by'] = '';
+
+		return $count
+			? EEM_Registration::instance()->count($query_params)
+			/** @type EE_Registration[] */
+			: EEM_Registration::instance()->get_all($query_params);
+	}
 
 } //end class Registrations Admin Page

Spacing +39 added lines, -39 removed lines

@@ -35,9 +35,9 @@ 
     {
         parent::__construct($routing);
         if ( ! defined('REG_CAF_TEMPLATE_PATH')) {
-            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
-            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
-            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
+            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'registrations/templates/');
+            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'registrations/assets/');
+            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'registrations/assets/');
         }
     }
 
@@ -45,7 +45,7 @@ 
 
     protected function _extend_page_config()
     {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
+        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'registrations';
         $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
             ? $this->_req_data['_REG_ID']
             : 0;
@@ -178,14 +178,14 @@ 
             //enqueue newsletter js
             wp_enqueue_script(
                 'ee-newsletter-trigger',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
+                REG_CAF_ASSETS_URL.'ee-newsletter-trigger.js',
                 array('ee-dialog'),
                 EVENT_ESPRESSO_VERSION,
                 true
             );
             wp_enqueue_style(
                 'ee-newsletter-trigger-css',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
+                REG_CAF_ASSETS_URL.'ee-newsletter-trigger.css',
                 array(),
                 EVENT_ESPRESSO_VERSION
             );
@@ -204,7 +204,7 @@ 
     {
         wp_register_script(
             'ee-reg-reports-js',
-            REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
+            REG_CAF_ASSETS_URL.'ee-registration-admin-reports.js',
             array('google-charts'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -409,7 +409,7 @@ 
             $codes[$field] = implode(', ', array_keys($shortcode_array));
         }
         $shortcodes = $codes;
-        $form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
+        $form_template = REG_CAF_TEMPLATE_PATH.'newsletter-send-form.template.php';
         $form_template_args = array(
             'form_action'       => admin_url('admin.php?page=espresso_registrations'),
             'form_route'        => 'newsletter_selected_send',
@@ -570,7 +570,7 @@ 
      */
     protected function _registration_reports()
     {
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+        $template_path = EE_ADMIN_TEMPLATE.'admin_reports.template.php';
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             $template_path,
             $this->_reports_template_data,
@@ -592,7 +592,7 @@ 
     {
         $report_ID = 'reg-admin-registrations-per-day-report-dv';
         $results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
-        $results = (array)$results;
+        $results = (array) $results;
         $regs = array();
         $subtitle = '';
         if ($results) {
@@ -602,7 +602,7 @@ 
                 $report_column_values = array();
                 foreach ($result as $property_name => $property_value) {
                     $property_value = $property_name === 'Registration_REG_date' ? $property_value
-                        : (int)$property_value;
+                        : (int) $property_value;
                     $report_column_values[] = $property_value;
                     if ($tracker === 0) {
                         if ($property_name === 'Registration_REG_date') {
@@ -619,7 +619,7 @@ 
             array_unshift($regs, $column_titles);
             //setup the date range.
             $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
+            $beginning_date = new DateTime("now ".$period, $DateTimeZone);
             $ending_date = new DateTime("now", $DateTimeZone);
             $subtitle = sprintf(
                 _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
@@ -639,7 +639,7 @@ 
                     '%sThere are currently no registration records in the last month for this report.%s',
                     'event_espresso'
                 ),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );
@@ -659,7 +659,7 @@ 
     {
         $report_ID = 'reg-admin-registrations-per-event-report-dv';
         $results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
-        $results = (array)$results;
+        $results = (array) $results;
         $regs = array();
         $subtitle = '';
         if ($results) {
@@ -672,7 +672,7 @@ 
                         $property_value,
                         4,
                         '...'
-                    ) : (int)$property_value;
+                    ) : (int) $property_value;
                     $report_column_values[] = $property_value;
                     if ($tracker === 0) {
                         if ($property_name === 'Registration_Event') {
@@ -689,7 +689,7 @@ 
             array_unshift($regs, $column_titles);
             //setup the date range.
             $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
+            $beginning_date = new DateTime("now ".$period, $DateTimeZone);
             $ending_date = new DateTime("now", $DateTimeZone);
             $subtitle = sprintf(
                 _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
@@ -709,7 +709,7 @@ 
                     '%sThere are currently no registration records in the last month for this report.%s',
                     'event_espresso'
                 ),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );
@@ -757,7 +757,7 @@ 
         if ($datetime instanceof EE_Datetime) {
             $datetime_label = $datetime->get_dtt_display_name(true);
             $datetime_label .= ! empty($datetime_label)
-                ? ' (' . $datetime->get_dtt_display_name() . ')'
+                ? ' ('.$datetime->get_dtt_display_name().')'
                 : $datetime->get_dtt_display_name();
         }
         $datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
@@ -771,7 +771,7 @@ 
             )
             : '';
         $datetime_link = ! empty($datetime_link)
-            ? '<a href="' . $datetime_link . '">'
+            ? '<a href="'.$datetime_link.'">'
               . '<span id="checkin-dtt">'
               . $datetime_label
               . '</span></a>'
@@ -783,8 +783,8 @@ 
             ? $attendee->get_admin_details_link()
             : '';
         $attendee_link = ! empty($attendee_link)
-            ? '<a href="' . $attendee->get_admin_details_link() . '"'
-              . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
+            ? '<a href="'.$attendee->get_admin_details_link().'"'
+              . ' title="'.esc_html__('Click for attendee details', 'event_espresso').'">'
               . '<span id="checkin-attendee-name">'
               . $attendee_name
               . '</span></a>'
@@ -793,25 +793,25 @@ 
             ? $registration->event()->get_admin_details_link()
             : '';
         $event_link = ! empty($event_link)
-            ? '<a href="' . $event_link . '"'
-              . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
+            ? '<a href="'.$event_link.'"'
+              . ' title="'.esc_html__('Click here to edit event.', 'event_espresso').'">'
               . '<span id="checkin-event-name">'
               . $registration->event_name()
               . '</span>'
               . '</a>'
             : '';
         $this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
-            ? '<h2>' . sprintf(
+            ? '<h2>'.sprintf(
                 esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
                 $attendee_link,
                 $datetime_link,
                 $event_link
-            ) . '</h2>'
+            ).'</h2>'
             : '';
         $this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
-            ? '<input type="hidden" name="_REGID" value="' . $reg_id . '">' : '';
+            ? '<input type="hidden" name="_REGID" value="'.$reg_id.'">' : '';
         $this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
-            ? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
+            ? '<input type="hidden" name="DTT_ID" value="'.$dtt_id.'">' : '';
         $this->display_admin_list_table_page_with_no_sidebar();
     }
 
@@ -1052,37 +1052,37 @@ 
                 'desc'  => __('View All Check-in Records for this Registrant', 'event_espresso'),
             ),
             'approved_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_approved,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
             ),
             'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_cancelled,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
             ),
             'declined_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_declined,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
             ),
             'not_approved'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_not_approved,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
             ),
             'pending_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_pending_payment,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
             ),
             'wait_list'        => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_wait_list,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
             ),
         );
         $this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
         $event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
         $this->_template_args['before_list_table'] = ! empty($event_id)
-            ? '<h2>' . sprintf(
+            ? '<h2>'.sprintf(
                 __('Viewing Registrations for Event: %s', 'event_espresso'),
                 EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
-            ) . '</h2>'
+            ).'</h2>'
             : '';
         //need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on the event.
         /** @var EE_Event $event */
@@ -1101,7 +1101,7 @@ 
             $this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
             $this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
             $this->_template_args['before_list_table'] .= $datetime->name();
-            $this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
+            $this->_template_args['before_list_table'] .= ' ( '.$datetime->date_and_time_range().' )';
             $this->_template_args['before_list_table'] .= '</span></h2>';
         }
         //if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status column
@@ -1168,11 +1168,11 @@ 
         //normalize some request params that get setup by the parent `get_registrations` method.
         $request = $this->_req_data;
         $request['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : $orderby;
-        $request['order'] =  ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
-        if($trash){
+        $request['order'] = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
+        if ($trash) {
             $request['status'] = 'trash';
         }
-        $query_params = $this->_get_checkin_query_params_from_request( $request, $per_page, $count );
+        $query_params = $this->_get_checkin_query_params_from_request($request, $per_page, $count);
         /**
          * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
          * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093

core/EE_Request_Handler.core.php

Doc Comments +3 added lines, -3 removed lines

@@ -275,7 +275,7 @@ 
 
 
     /**
-     * @param $string
+     * @param string $string
      * @return void
      */
     public function add_output($string)
@@ -327,7 +327,7 @@ 
 
 
     /**
-     * @return    mixed
+     * @return    boolean
      */
     public function is_espresso_page()
     {
@@ -389,7 +389,7 @@ 
     /**
      * remove param
      *
-     * @param $key
+     * @param string $key
      * @return    void
      */
     public function un_set($key)

Indentation +383 added lines, -383 removed lines

@@ -13,389 +13,389 @@
 final class EE_Request_Handler implements InterminableInterface
 {
 
-    /**
-     * @var EE_Request $request
-     */
-    private $request;
-
-    /**
-     * @var array $_notice
-     */
-    private $_notice = array();
-
-    /**
-     * rendered output to be returned to WP
-     *
-     * @var string $_output
-     */
-    private $_output = '';
-
-    /**
-     * whether current request is via AJAX
-     *
-     * @var boolean $ajax
-     */
-    public $ajax = false;
-
-    /**
-     * whether current request is via AJAX from the frontend of the site
-     *
-     * @var boolean $front_ajax
-     */
-    public $front_ajax = false;
-
-
-
-    /**
-     * @param  EE_Request $request
-     */
-    public function __construct(EE_Request $request)
-    {
-        $this->request = $request;
-        $this->ajax = $this->request->ajax;
-        $this->front_ajax = $this->request->front_ajax;
-        do_action('AHEE__EE_Request_Handler__construct__complete');
-    }
-
-
-
-    /**
-     * @param WP $wp
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function parse_request($wp = null)
-    {
-        //if somebody forgot to provide us with WP, that's ok because its global
-        if (! $wp instanceof WP) {
-            global $wp;
-        }
-        $this->set_request_vars($wp);
-    }
-
-
-
-    /**
-     * @param WP $wp
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_request_vars($wp = null)
-    {
-        if (! is_admin()) {
-            // set request post_id
-            $this->request->set('post_id', $this->get_post_id_from_request($wp));
-            // set request post name
-            $this->request->set('post_name', $this->get_post_name_from_request($wp));
-            // set request post_type
-            $this->request->set('post_type', $this->get_post_type_from_request($wp));
-            // true or false ? is this page being used by EE ?
-            $this->set_espresso_page();
-        }
-    }
-
-
-
-    /**
-     * @param WP $wp
-     * @return int
-     */
-    public function get_post_id_from_request($wp = null)
-    {
-        if (! $wp instanceof WP) {
-            global $wp;
-        }
-        $post_id = null;
-        if (isset($wp->query_vars['p'])) {
-            $post_id = $wp->query_vars['p'];
-        }
-        if (! $post_id && isset($wp->query_vars['page_id'])) {
-            $post_id = $wp->query_vars['page_id'];
-        }
-        if (! $post_id && $wp->request !== null && is_numeric(basename($wp->request))) {
-            $post_id = basename($wp->request);
-        }
-        return $post_id;
-    }
-
-
-
-    /**
-     * @param WP $wp
-     * @return string
-     */
-    public function get_post_name_from_request($wp = null)
-    {
-        if (! $wp instanceof WP) {
-            global $wp;
-        }
-        $post_name = null;
-        if (isset($wp->query_vars['name']) && ! empty($wp->query_vars['name'])) {
-            $post_name = $wp->query_vars['name'];
-        }
-        if (! $post_name && isset($wp->query_vars['pagename']) && ! empty($wp->query_vars['pagename'])) {
-            $post_name = $wp->query_vars['pagename'];
-        }
-        if (! $post_name && $wp->request !== null && ! empty($wp->request)) {
-            $possible_post_name = basename($wp->request);
-            if (! is_numeric($possible_post_name)) {
-                /** @type WPDB $wpdb */
-                global $wpdb;
-                $SQL =
-                    "SELECT ID from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s";
-                $possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $possible_post_name));
-                if ($possible_post_name) {
-                    $post_name = $possible_post_name;
-                }
-            }
-        }
-        if (! $post_name && $this->get('post_id')) {
-            /** @type WPDB $wpdb */
-            global $wpdb;
-            $SQL =
-                "SELECT post_name from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d";
-            $possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $this->get('post_id')));
-            if ($possible_post_name) {
-                $post_name = $possible_post_name;
-            }
-        }
-        return $post_name;
-    }
-
-
-
-    /**
-     * @param WP $wp
-     * @return mixed
-     */
-    public function get_post_type_from_request($wp = null)
-    {
-        if (! $wp instanceof WP) {
-            global $wp;
-        }
-        return isset($wp->query_vars['post_type'])
-            ? $wp->query_vars['post_type']
-            : null;
-    }
-
-
-
-    /**
-     * Just a helper method for getting the url for the displayed page.
-     *
-     * @param  WP $wp
-     * @return string
-     */
-    public function get_current_page_permalink($wp = null)
-    {
-        $post_id = $this->get_post_id_from_request($wp);
-        if ($post_id) {
-            $current_page_permalink = get_permalink($post_id);
-        } else {
-            if (! $wp instanceof WP) {
-                global $wp;
-            }
-            if ($wp->request) {
-                $current_page_permalink = site_url($wp->request);
-            } else {
-                $current_page_permalink = esc_url(site_url($_SERVER['REQUEST_URI']));
-            }
-        }
-        return $current_page_permalink;
-    }
-
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function test_for_espresso_page()
-    {
-        global $wp;
-        /** @type EE_CPT_Strategy $EE_CPT_Strategy */
-        $EE_CPT_Strategy = EE_Registry::instance()->load_core('CPT_Strategy');
-        $espresso_CPT_taxonomies = $EE_CPT_Strategy->get_CPT_taxonomies();
-        if (is_array($espresso_CPT_taxonomies)) {
-            foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
-                if (isset($wp->query_vars, $wp->query_vars[$espresso_CPT_taxonomy])) {
-                    return true;
-                }
-            }
-        }
-        // load espresso CPT endpoints
-        $espresso_CPT_endpoints = $EE_CPT_Strategy->get_CPT_endpoints();
-        $post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
-        $post_types = (array)$this->get('post_type');
-        foreach ($post_types as $post_type) {
-            // was a post name passed ?
-            if (isset($post_type_CPT_endpoints[$post_type])) {
-                // kk we know this is an espresso page, but is it a specific post ?
-                if (! $this->get('post_name')) {
-                    // there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
-                    $post_name = isset($post_type_CPT_endpoints[$this->get('post_type')])
-                        ? $post_type_CPT_endpoints[$this->get('post_type')]
-                        : '';
-                    // if the post type matches on of our then set the endpoint
-                    if ($post_name) {
-                        $this->set('post_name', $post_name);
-                    }
-                }
-                return true;
-            }
-        }
-        return false;
-    }
-    /**
-     * @param $key
-     * @param $value
-     * @return    void
-     */
-    public function set_notice($key, $value)
-    {
-        $this->_notice[$key] = $value;
-    }
-
-
-
-    /**
-     * @param $key
-     * @return    mixed
-     */
-    public function get_notice($key)
-    {
-        return isset($this->_notice[$key])
-            ? $this->_notice[$key]
-            : null;
-    }
-
-
-
-    /**
-     * @param $string
-     * @return void
-     */
-    public function add_output($string)
-    {
-        $this->_output .= $string;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function get_output()
-    {
-        return $this->_output;
-    }
-
-
-
-    /**
-     * @param $item
-     * @param $key
-     */
-    public function sanitize_text_field_for_array_walk(&$item, &$key)
-    {
-        $item = strpos($item, 'email') !== false
-            ? sanitize_email($item)
-            : sanitize_text_field($item);
-    }
-
-
-
-    /**
-     * @param null|bool $value
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_espresso_page($value = null)
-    {
-        $this->request->set(
-            'is_espresso_page',
-            ! empty($value)
-                ? $value
-                : $this->test_for_espresso_page()
-        );
-    }
-
-
-
-    /**
-     * @return    mixed
-     */
-    public function is_espresso_page()
-    {
-        return $this->request->is_set('is_espresso_page');
-    }
-
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function params()
-    {
-        return $this->request->params();
-    }
-
-
-
-    /**
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     */
-    public function set($key, $value, $override_ee = false)
-    {
-        $this->request->set($key, $value, $override_ee);
-    }
-
-
-
-    /**
-     * @param      $key
-     * @param null $default
-     * @return    mixed
-     */
-    public function get($key, $default = null)
-    {
-        return $this->request->get($key, $default);
-    }
-
-
-
-    /**
-     * check if param exists
-     *
-     * @param $key
-     * @return    boolean
-     */
-    public function is_set($key)
-    {
-        return $this->request->is_set($key);
-    }
-
-
-
-    /**
-     * remove param
-     *
-     * @param $key
-     * @return    void
-     */
-    public function un_set($key)
-    {
-        $this->request->un_set($key);
-    }
+	/**
+	 * @var EE_Request $request
+	 */
+	private $request;
+
+	/**
+	 * @var array $_notice
+	 */
+	private $_notice = array();
+
+	/**
+	 * rendered output to be returned to WP
+	 *
+	 * @var string $_output
+	 */
+	private $_output = '';
+
+	/**
+	 * whether current request is via AJAX
+	 *
+	 * @var boolean $ajax
+	 */
+	public $ajax = false;
+
+	/**
+	 * whether current request is via AJAX from the frontend of the site
+	 *
+	 * @var boolean $front_ajax
+	 */
+	public $front_ajax = false;
+
+
+
+	/**
+	 * @param  EE_Request $request
+	 */
+	public function __construct(EE_Request $request)
+	{
+		$this->request = $request;
+		$this->ajax = $this->request->ajax;
+		$this->front_ajax = $this->request->front_ajax;
+		do_action('AHEE__EE_Request_Handler__construct__complete');
+	}
+
+
+
+	/**
+	 * @param WP $wp
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function parse_request($wp = null)
+	{
+		//if somebody forgot to provide us with WP, that's ok because its global
+		if (! $wp instanceof WP) {
+			global $wp;
+		}
+		$this->set_request_vars($wp);
+	}
+
+
+
+	/**
+	 * @param WP $wp
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_request_vars($wp = null)
+	{
+		if (! is_admin()) {
+			// set request post_id
+			$this->request->set('post_id', $this->get_post_id_from_request($wp));
+			// set request post name
+			$this->request->set('post_name', $this->get_post_name_from_request($wp));
+			// set request post_type
+			$this->request->set('post_type', $this->get_post_type_from_request($wp));
+			// true or false ? is this page being used by EE ?
+			$this->set_espresso_page();
+		}
+	}
+
+
+
+	/**
+	 * @param WP $wp
+	 * @return int
+	 */
+	public function get_post_id_from_request($wp = null)
+	{
+		if (! $wp instanceof WP) {
+			global $wp;
+		}
+		$post_id = null;
+		if (isset($wp->query_vars['p'])) {
+			$post_id = $wp->query_vars['p'];
+		}
+		if (! $post_id && isset($wp->query_vars['page_id'])) {
+			$post_id = $wp->query_vars['page_id'];
+		}
+		if (! $post_id && $wp->request !== null && is_numeric(basename($wp->request))) {
+			$post_id = basename($wp->request);
+		}
+		return $post_id;
+	}
+
+
+
+	/**
+	 * @param WP $wp
+	 * @return string
+	 */
+	public function get_post_name_from_request($wp = null)
+	{
+		if (! $wp instanceof WP) {
+			global $wp;
+		}
+		$post_name = null;
+		if (isset($wp->query_vars['name']) && ! empty($wp->query_vars['name'])) {
+			$post_name = $wp->query_vars['name'];
+		}
+		if (! $post_name && isset($wp->query_vars['pagename']) && ! empty($wp->query_vars['pagename'])) {
+			$post_name = $wp->query_vars['pagename'];
+		}
+		if (! $post_name && $wp->request !== null && ! empty($wp->request)) {
+			$possible_post_name = basename($wp->request);
+			if (! is_numeric($possible_post_name)) {
+				/** @type WPDB $wpdb */
+				global $wpdb;
+				$SQL =
+					"SELECT ID from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s";
+				$possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $possible_post_name));
+				if ($possible_post_name) {
+					$post_name = $possible_post_name;
+				}
+			}
+		}
+		if (! $post_name && $this->get('post_id')) {
+			/** @type WPDB $wpdb */
+			global $wpdb;
+			$SQL =
+				"SELECT post_name from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d";
+			$possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $this->get('post_id')));
+			if ($possible_post_name) {
+				$post_name = $possible_post_name;
+			}
+		}
+		return $post_name;
+	}
+
+
+
+	/**
+	 * @param WP $wp
+	 * @return mixed
+	 */
+	public function get_post_type_from_request($wp = null)
+	{
+		if (! $wp instanceof WP) {
+			global $wp;
+		}
+		return isset($wp->query_vars['post_type'])
+			? $wp->query_vars['post_type']
+			: null;
+	}
+
+
+
+	/**
+	 * Just a helper method for getting the url for the displayed page.
+	 *
+	 * @param  WP $wp
+	 * @return string
+	 */
+	public function get_current_page_permalink($wp = null)
+	{
+		$post_id = $this->get_post_id_from_request($wp);
+		if ($post_id) {
+			$current_page_permalink = get_permalink($post_id);
+		} else {
+			if (! $wp instanceof WP) {
+				global $wp;
+			}
+			if ($wp->request) {
+				$current_page_permalink = site_url($wp->request);
+			} else {
+				$current_page_permalink = esc_url(site_url($_SERVER['REQUEST_URI']));
+			}
+		}
+		return $current_page_permalink;
+	}
+
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function test_for_espresso_page()
+	{
+		global $wp;
+		/** @type EE_CPT_Strategy $EE_CPT_Strategy */
+		$EE_CPT_Strategy = EE_Registry::instance()->load_core('CPT_Strategy');
+		$espresso_CPT_taxonomies = $EE_CPT_Strategy->get_CPT_taxonomies();
+		if (is_array($espresso_CPT_taxonomies)) {
+			foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
+				if (isset($wp->query_vars, $wp->query_vars[$espresso_CPT_taxonomy])) {
+					return true;
+				}
+			}
+		}
+		// load espresso CPT endpoints
+		$espresso_CPT_endpoints = $EE_CPT_Strategy->get_CPT_endpoints();
+		$post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
+		$post_types = (array)$this->get('post_type');
+		foreach ($post_types as $post_type) {
+			// was a post name passed ?
+			if (isset($post_type_CPT_endpoints[$post_type])) {
+				// kk we know this is an espresso page, but is it a specific post ?
+				if (! $this->get('post_name')) {
+					// there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
+					$post_name = isset($post_type_CPT_endpoints[$this->get('post_type')])
+						? $post_type_CPT_endpoints[$this->get('post_type')]
+						: '';
+					// if the post type matches on of our then set the endpoint
+					if ($post_name) {
+						$this->set('post_name', $post_name);
+					}
+				}
+				return true;
+			}
+		}
+		return false;
+	}
+	/**
+	 * @param $key
+	 * @param $value
+	 * @return    void
+	 */
+	public function set_notice($key, $value)
+	{
+		$this->_notice[$key] = $value;
+	}
+
+
+
+	/**
+	 * @param $key
+	 * @return    mixed
+	 */
+	public function get_notice($key)
+	{
+		return isset($this->_notice[$key])
+			? $this->_notice[$key]
+			: null;
+	}
+
+
+
+	/**
+	 * @param $string
+	 * @return void
+	 */
+	public function add_output($string)
+	{
+		$this->_output .= $string;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function get_output()
+	{
+		return $this->_output;
+	}
+
+
+
+	/**
+	 * @param $item
+	 * @param $key
+	 */
+	public function sanitize_text_field_for_array_walk(&$item, &$key)
+	{
+		$item = strpos($item, 'email') !== false
+			? sanitize_email($item)
+			: sanitize_text_field($item);
+	}
+
+
+
+	/**
+	 * @param null|bool $value
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_espresso_page($value = null)
+	{
+		$this->request->set(
+			'is_espresso_page',
+			! empty($value)
+				? $value
+				: $this->test_for_espresso_page()
+		);
+	}
+
+
+
+	/**
+	 * @return    mixed
+	 */
+	public function is_espresso_page()
+	{
+		return $this->request->is_set('is_espresso_page');
+	}
+
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function params()
+	{
+		return $this->request->params();
+	}
+
+
+
+	/**
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 */
+	public function set($key, $value, $override_ee = false)
+	{
+		$this->request->set($key, $value, $override_ee);
+	}
+
+
+
+	/**
+	 * @param      $key
+	 * @param null $default
+	 * @return    mixed
+	 */
+	public function get($key, $default = null)
+	{
+		return $this->request->get($key, $default);
+	}
+
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param $key
+	 * @return    boolean
+	 */
+	public function is_set($key)
+	{
+		return $this->request->is_set($key);
+	}
+
+
+
+	/**
+	 * remove param
+	 *
+	 * @param $key
+	 * @return    void
+	 */
+	public function un_set($key)
+	{
+		$this->request->un_set($key);
+	}
 
 
 

Spacing +14 added lines, -14 removed lines

@@ -68,7 +68,7 @@ 
     public function parse_request($wp = null)
     {
         //if somebody forgot to provide us with WP, that's ok because its global
-        if (! $wp instanceof WP) {
+        if ( ! $wp instanceof WP) {
             global $wp;
         }
         $this->set_request_vars($wp);
@@ -84,7 +84,7 @@ 
      */
     public function set_request_vars($wp = null)
     {
-        if (! is_admin()) {
+        if ( ! is_admin()) {
             // set request post_id
             $this->request->set('post_id', $this->get_post_id_from_request($wp));
             // set request post name
@@ -104,17 +104,17 @@ 
      */
     public function get_post_id_from_request($wp = null)
     {
-        if (! $wp instanceof WP) {
+        if ( ! $wp instanceof WP) {
             global $wp;
         }
         $post_id = null;
         if (isset($wp->query_vars['p'])) {
             $post_id = $wp->query_vars['p'];
         }
-        if (! $post_id && isset($wp->query_vars['page_id'])) {
+        if ( ! $post_id && isset($wp->query_vars['page_id'])) {
             $post_id = $wp->query_vars['page_id'];
         }
-        if (! $post_id && $wp->request !== null && is_numeric(basename($wp->request))) {
+        if ( ! $post_id && $wp->request !== null && is_numeric(basename($wp->request))) {
             $post_id = basename($wp->request);
         }
         return $post_id;
@@ -128,19 +128,19 @@ 
      */
     public function get_post_name_from_request($wp = null)
     {
-        if (! $wp instanceof WP) {
+        if ( ! $wp instanceof WP) {
             global $wp;
         }
         $post_name = null;
         if (isset($wp->query_vars['name']) && ! empty($wp->query_vars['name'])) {
             $post_name = $wp->query_vars['name'];
         }
-        if (! $post_name && isset($wp->query_vars['pagename']) && ! empty($wp->query_vars['pagename'])) {
+        if ( ! $post_name && isset($wp->query_vars['pagename']) && ! empty($wp->query_vars['pagename'])) {
             $post_name = $wp->query_vars['pagename'];
         }
-        if (! $post_name && $wp->request !== null && ! empty($wp->request)) {
+        if ( ! $post_name && $wp->request !== null && ! empty($wp->request)) {
             $possible_post_name = basename($wp->request);
-            if (! is_numeric($possible_post_name)) {
+            if ( ! is_numeric($possible_post_name)) {
                 /** @type WPDB $wpdb */
                 global $wpdb;
                 $SQL =
@@ -151,7 +151,7 @@ 
                 }
             }
         }
-        if (! $post_name && $this->get('post_id')) {
+        if ( ! $post_name && $this->get('post_id')) {
             /** @type WPDB $wpdb */
             global $wpdb;
             $SQL =
@@ -172,7 +172,7 @@ 
      */
     public function get_post_type_from_request($wp = null)
     {
-        if (! $wp instanceof WP) {
+        if ( ! $wp instanceof WP) {
             global $wp;
         }
         return isset($wp->query_vars['post_type'])
@@ -194,7 +194,7 @@ 
         if ($post_id) {
             $current_page_permalink = get_permalink($post_id);
         } else {
-            if (! $wp instanceof WP) {
+            if ( ! $wp instanceof WP) {
                 global $wp;
             }
             if ($wp->request) {
@@ -229,12 +229,12 @@ 
         // load espresso CPT endpoints
         $espresso_CPT_endpoints = $EE_CPT_Strategy->get_CPT_endpoints();
         $post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
-        $post_types = (array)$this->get('post_type');
+        $post_types = (array) $this->get('post_type');
         foreach ($post_types as $post_type) {
             // was a post name passed ?
             if (isset($post_type_CPT_endpoints[$post_type])) {
                 // kk we know this is an espresso page, but is it a specific post ?
-                if (! $this->get('post_name')) {
+                if ( ! $this->get('post_name')) {
                     // there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
                     $post_name = isset($post_type_CPT_endpoints[$this->get('post_type')])
                         ? $post_type_CPT_endpoints[$this->get('post_type')]