eventespresso / event-espresso-core

admin_pages/maintenance/templates/ee_system_stati_page.template.php

Spacing +7 added lines, -7 removed lines

@@ -7,7 +7,7 @@ 
 
 function ee_resurse_into_array($data) {
 	if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {//is_object($incomplete_class) actually returns false, hence why we check for it
-		$data = (array)$data;
+		$data = (array) $data;
 	}
 	if (is_array($data)) {
 		if (EEH_Array::is_associative_array($data)) {
@@ -19,10 +19,10 @@ 
 						?>
 						<tr>
 							<td>
-								<?php echo $data_key;?>
+								<?php echo $data_key; ?>
 							</td>
 							<td>
-								<?php ee_resurse_into_array($data_values);?>
+								<?php ee_resurse_into_array($data_values); ?>
 							</td>
 						</tr>
 						<?php
@@ -36,19 +36,19 @@ 
 			<ul>
 				<?php
 				foreach ($data as $datum) {
-					echo "<li>";ee_resurse_into_array($datum);echo "</li>";
+					echo "<li>"; ee_resurse_into_array($datum); echo "</li>";
 				}?>
 			</ul>
 			<?php
 		}
-	}else {
+	} else {
 		//simple value
 		echo $data;
 	}
 }
 ?>
 <h1>
-	<?php _e("System Information", "event_espresso");?> <a href="<?php echo $download_system_status_url;?>" class="button-secondary"><?php esc_html_e( 'Download to File', 'event_espresso' );?></a>
+	<?php _e("System Information", "event_espresso"); ?> <a href="<?php echo $download_system_status_url; ?>" class="button-secondary"><?php esc_html_e('Download to File', 'event_espresso'); ?></a>
 </h1>
 <div class="padding">
 
@@ -56,7 +56,7 @@ 
 		<?php
 		foreach ($system_stati as $status_category_slug => $data) {
 			if (is_object($data)) {
-				$data = (array)$data;
+				$data = (array) $data;
 			}
 			?>
 			<thead>

core/services/assets/Registry.php

Indentation +226 added lines, -226 removed lines

@@ -16,234 +16,234 @@
 class Registry
 {
 
-    /**
-     * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
-     * @var array
-     */
-    protected $jsdata = array();
-
-
-    /**
-     * Registry constructor.
-     * Hooking into WP actions for script registry.
-     */
-    public function __construct()
-    {
-        add_action('wp_enqueue_scripts', array($this, 'scripts'), 100);
-        add_action('admin_enqueue_scripts', array($this, 'scripts'), 100);
-        add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
-        add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
-    }
-
-
-    /**
-     * Callback for the WP script actions.
-     * Used to register globally accessible core scripts.
-     * Also used to add the eejs.data object to the source for any js having eejs-core as a dependency.
-     */
-    public function scripts()
-    {
-        global $wp_version;
-        wp_register_script(
-            'eejs-core',
-            EE_PLUGIN_DIR_URL . 'core/services/assets/core_assets/eejs-core.js',
-            array(),
-            espresso_version(),
-            true
-        );
-        //only run this if WordPress 4.4.0 > is in use.
-        if (version_compare($wp_version, '4.4.0', '>')) {
-            //js.api
-            wp_register_script(
-                'eejs-api',
-                EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js',
-                array('underscore', 'eejs-core'),
-                espresso_version(),
-                true
-            );
-            $this->jsdata['eejs_api_nonce'] = wp_create_nonce('wp_rest');
-            $this->jsdata['paths'] = array('rest_route' => rest_url('ee/v4.8.36/'));
-        }
-    }
-
-
-    /**
-     * Call back for the script print in frontend and backend.
-     * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hookpoint.
-     * @since 4.9.31.rc.015
-     */
-    public function enqueueData()
-    {
-        wp_localize_script('eejs-core', 'eejs', array('data' => $this->jsdata));
-    }
-
-
-    /**
-     * Used to add data to eejs.data object.
-     *
-     * Note:  Overriding existing data is not allowed.
-     *
-     * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
-     * If the data you add is something like this:
-     *
-     *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
-     *
-     * It will be exposed in the page source as:
-     *
-     *  eejs.data.my_plugin_data.foo == gar
-     *
-     * @param string       $key   Key used to access your data
-     * @param string|array $value Value to attach to key
-     * @throws InvalidArgumentException
-     */
-    public function addData($key, $value)
-    {
-        if ($this->verifyDataNotExisting($key)) {
-            $this->jsdata[$key] = $value;
-        }
-    }
-
-
-    /**
-     * Similar to addData except this allows for users to push values to an existing key where the values on key are
-     * elements in an array.
-     *
-     * When you use this method, the value you include will be appended to the end of an array on $key.
-     *
-     * So if the $key was 'test' and you added a value of 'my_data' then it would be represented in the javascript object
-     * like this,
-     *
-     * eejs.data.test = [
-     *     my_data,
-     * ]
-     *
-     * If there has already been a scalar value attached to the data object given key, then
-     * this will throw an exception.
-     *
-     * @param string $key          Key to attach data to.
-     * @param string|array $value  Value being registered.
-     * @throws InvalidArgumentException
-     */
-    public function pushData($key, $value)
-    {
-        if (isset($this->jsdata[$key])
-            && ! is_array($this->jsdata[$key])
-        ) {
-            throw new invalidArgumentException(
-                sprintf(
-                    __(
-                        'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
+	/**
+	 * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
+	 * @var array
+	 */
+	protected $jsdata = array();
+
+
+	/**
+	 * Registry constructor.
+	 * Hooking into WP actions for script registry.
+	 */
+	public function __construct()
+	{
+		add_action('wp_enqueue_scripts', array($this, 'scripts'), 100);
+		add_action('admin_enqueue_scripts', array($this, 'scripts'), 100);
+		add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
+		add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
+	}
+
+
+	/**
+	 * Callback for the WP script actions.
+	 * Used to register globally accessible core scripts.
+	 * Also used to add the eejs.data object to the source for any js having eejs-core as a dependency.
+	 */
+	public function scripts()
+	{
+		global $wp_version;
+		wp_register_script(
+			'eejs-core',
+			EE_PLUGIN_DIR_URL . 'core/services/assets/core_assets/eejs-core.js',
+			array(),
+			espresso_version(),
+			true
+		);
+		//only run this if WordPress 4.4.0 > is in use.
+		if (version_compare($wp_version, '4.4.0', '>')) {
+			//js.api
+			wp_register_script(
+				'eejs-api',
+				EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js',
+				array('underscore', 'eejs-core'),
+				espresso_version(),
+				true
+			);
+			$this->jsdata['eejs_api_nonce'] = wp_create_nonce('wp_rest');
+			$this->jsdata['paths'] = array('rest_route' => rest_url('ee/v4.8.36/'));
+		}
+	}
+
+
+	/**
+	 * Call back for the script print in frontend and backend.
+	 * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hookpoint.
+	 * @since 4.9.31.rc.015
+	 */
+	public function enqueueData()
+	{
+		wp_localize_script('eejs-core', 'eejs', array('data' => $this->jsdata));
+	}
+
+
+	/**
+	 * Used to add data to eejs.data object.
+	 *
+	 * Note:  Overriding existing data is not allowed.
+	 *
+	 * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
+	 * If the data you add is something like this:
+	 *
+	 *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
+	 *
+	 * It will be exposed in the page source as:
+	 *
+	 *  eejs.data.my_plugin_data.foo == gar
+	 *
+	 * @param string       $key   Key used to access your data
+	 * @param string|array $value Value to attach to key
+	 * @throws InvalidArgumentException
+	 */
+	public function addData($key, $value)
+	{
+		if ($this->verifyDataNotExisting($key)) {
+			$this->jsdata[$key] = $value;
+		}
+	}
+
+
+	/**
+	 * Similar to addData except this allows for users to push values to an existing key where the values on key are
+	 * elements in an array.
+	 *
+	 * When you use this method, the value you include will be appended to the end of an array on $key.
+	 *
+	 * So if the $key was 'test' and you added a value of 'my_data' then it would be represented in the javascript object
+	 * like this,
+	 *
+	 * eejs.data.test = [
+	 *     my_data,
+	 * ]
+	 *
+	 * If there has already been a scalar value attached to the data object given key, then
+	 * this will throw an exception.
+	 *
+	 * @param string $key          Key to attach data to.
+	 * @param string|array $value  Value being registered.
+	 * @throws InvalidArgumentException
+	 */
+	public function pushData($key, $value)
+	{
+		if (isset($this->jsdata[$key])
+			&& ! is_array($this->jsdata[$key])
+		) {
+			throw new invalidArgumentException(
+				sprintf(
+					__(
+						'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
                          push values to this data element when it is an array.',
-                        'event_espresso'
-                    ),
-                    $key,
-                    __METHOD__
-                )
-            );
-        }
-
-        $this->jsdata[$key][] = $value;
-    }
-
-
-    /**
-     * Used to set content used by javascript for a template.
-     * Note: Overrides of existing registered templates are not allowed.
-     *
-     * @param string $template_reference
-     * @param string $template_content
-     * @throws InvalidArgumentException
-     */
-    public function addTemplate($template_reference, $template_content)
-    {
-        if (! isset($this->jsdata['templates'])) {
-            $this->jsdata['templates'] = array();
-        }
-
-        //no overrides allowed.
-        if (isset($this->jsdata['templates'][$template_reference])) {
-            throw new invalidArgumentException(
-                sprintf(
-                    __(
-                        'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
-                        'event_espresso'
-                    ),
-                    $template_reference
-                )
-            );
-        } else {
-            $this->jsdata['templates'][$template_reference] = $template_content;
-        }
-    }
-
-
-    /**
-     * Retrieve the template content already registered for the given reference.
-     * @param string $template_reference
-     * @return string
-     */
-    public function getTemplate($template_reference)
-    {
-        return isset($this->jsdata['templates'], $this->jsdata['templates'][$template_reference])
-            ? $this->jsdata['templates'][$template_reference]
-            : '';
-    }
-
-
-    /**
-     * Retrieve registered data.
-     *
-     * @param string $key           Name of key to attach data to.
-     * @return mixed                If there is no for the given key, then false is returned.
-     */
-    public function getData($key)
-    {
-        return isset($this->jsdata[$key])
-            ? $this->jsdata[$key]
-            : false;
-    }
-
-
-
-
-    /**
-     * Verifies whether the given data exists already on the jsdata array.
-     *
-     * Overriding data is not allowed.
-     *
-     * @param string       $key          Index for data.
-     * @return bool        If valid then return true.
-     * @throws InvalidArgumentException if data already exists.
-     */
-    protected function verifyDataNotExisting($key)
-    {
-        if (isset($this->jsdata[$key])) {
-            if (is_array($this->jsdata[$key])) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        __(
-                            'The value for %1$s already exists in the Registry::eejs object.
+						'event_espresso'
+					),
+					$key,
+					__METHOD__
+				)
+			);
+		}
+
+		$this->jsdata[$key][] = $value;
+	}
+
+
+	/**
+	 * Used to set content used by javascript for a template.
+	 * Note: Overrides of existing registered templates are not allowed.
+	 *
+	 * @param string $template_reference
+	 * @param string $template_content
+	 * @throws InvalidArgumentException
+	 */
+	public function addTemplate($template_reference, $template_content)
+	{
+		if (! isset($this->jsdata['templates'])) {
+			$this->jsdata['templates'] = array();
+		}
+
+		//no overrides allowed.
+		if (isset($this->jsdata['templates'][$template_reference])) {
+			throw new invalidArgumentException(
+				sprintf(
+					__(
+						'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
+						'event_espresso'
+					),
+					$template_reference
+				)
+			);
+		} else {
+			$this->jsdata['templates'][$template_reference] = $template_content;
+		}
+	}
+
+
+	/**
+	 * Retrieve the template content already registered for the given reference.
+	 * @param string $template_reference
+	 * @return string
+	 */
+	public function getTemplate($template_reference)
+	{
+		return isset($this->jsdata['templates'], $this->jsdata['templates'][$template_reference])
+			? $this->jsdata['templates'][$template_reference]
+			: '';
+	}
+
+
+	/**
+	 * Retrieve registered data.
+	 *
+	 * @param string $key           Name of key to attach data to.
+	 * @return mixed                If there is no for the given key, then false is returned.
+	 */
+	public function getData($key)
+	{
+		return isset($this->jsdata[$key])
+			? $this->jsdata[$key]
+			: false;
+	}
+
+
+
+
+	/**
+	 * Verifies whether the given data exists already on the jsdata array.
+	 *
+	 * Overriding data is not allowed.
+	 *
+	 * @param string       $key          Index for data.
+	 * @return bool        If valid then return true.
+	 * @throws InvalidArgumentException if data already exists.
+	 */
+	protected function verifyDataNotExisting($key)
+	{
+		if (isset($this->jsdata[$key])) {
+			if (is_array($this->jsdata[$key])) {
+				throw new InvalidArgumentException(
+					sprintf(
+						__(
+							'The value for %1$s already exists in the Registry::eejs object.
                             Overrides are not allowed. Since the value of this data is an array, you may want to use the
                             %2$s method to push your value to the array.',
-                            'event_espresso'
-                        ),
-                        $key,
-                        'pushData()'
-                    )
-                );
-            } else {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        __(
-                            'The value for %1$s already exists in the Registry::eejs object. Overrides are not
+							'event_espresso'
+						),
+						$key,
+						'pushData()'
+					)
+				);
+			} else {
+				throw new InvalidArgumentException(
+					sprintf(
+						__(
+							'The value for %1$s already exists in the Registry::eejs object. Overrides are not
                             allowed.  Consider attaching your value to a different key',
-                            'event_espresso'
-                        ),
-                        $key
-                    )
-                );
-            }
-        }
-        return true;
-    }
+							'event_espresso'
+						),
+						$key
+					)
+				);
+			}
+		}
+		return true;
+	}
 }

admin_pages/maintenance/Maintenance_Admin_Page.core.php

Indentation +613 added lines, -613 removed lines

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

Spacing +17 added lines, -17 removed lines

@@ -244,13 +244,13 @@ 
                 && $most_recent_migration->is_broken()
             )
         ) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
+            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_migration_was_borked_page.template.php';
             $this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/';
             $this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce(array('action'  => 'confirm_migration_crash_report_sent',
                                                                                         'success' => '0',
             ), EE_MAINTENANCE_ADMIN_URL);
         } elseif ($addons_should_be_upgraded_first) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
+            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_upgrade_addons_before_migrating.template.php';
         } else {
             if ($most_recent_migration
                 && $most_recent_migration instanceof EE_Data_Migration_Script_Base
@@ -277,7 +277,7 @@ 
                         $new_version, $plugin_slug) : 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(
@@ -316,13 +316,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);
@@ -381,7 +381,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',
@@ -418,7 +418,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.',
@@ -466,7 +466,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(
@@ -485,11 +485,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;
     }
 
@@ -503,7 +503,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'
@@ -538,7 +538,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();
@@ -639,9 +639,9 @@ 
         wp_enqueue_script('ee_admin_js');
 //		wp_enqueue_media();
 //		wp_enqueue_script('media-upload');
-        wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL . '/ee-maintenance.js', array('jquery'),
+        wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL.'/ee-maintenance.js', array('jquery'),
             EVENT_ESPRESSO_VERSION, true);
-        wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css', array(),
+        wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL.'ee-maintenance.css', array(),
             EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('espresso_maintenance');
     }

core/entities/models/JsonModelSchema.php

Indentation +116 added lines, -116 removed lines

@@ -25,120 +25,120 @@
 class JsonModelSchema
 {
 
-    /**
-     * @var \EEM_Base
-     */
-    protected $model;
-
-    /**
-     * JsonModelSchema constructor.
-     *
-     * @param \EEM_Base $model
-     */
-    public function __construct(EEM_Base $model)
-    {
-        $this->model = $model;
-    }
-
-    /**
-     * Return the schema for a given model from a given model.
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function getModelSchema()
-    {
-        return $this->getModelSchemaForRelations(
-            $this->model->relation_settings(),
-            $this->getModelSchemaForFields(
-                $this->model->field_settings(),
-                $this->getInitialSchemaStructure()
-            )
-        );
-    }
-
-
-    /**
-     * Get the schema for a given set of model fields.
-     * @param \EE_Model_Field_Base[]     $model_fields
-     * @return array
-     */
-    public function getModelSchemaForFields(array $model_fields, array $schema)
-    {
-        foreach ($model_fields as $field => $model_field) {
-            if (! $model_field instanceof EE_Model_Field_Base) {
-                continue;
-            }
-            $schema['properties'][$field] = $model_field->getSchema();
-
-            //if this is a primary key field add the primary key item
-            if ($model_field instanceof EE_Primary_Key_Field_Base) {
-                $schema['properties'][$field]['primary_key'] = true;
-                if ($model_field instanceof EE_Primary_Key_Int_Field) {
-                    $schema['properties'][$field]['readonly'] = true;
-                }
-            }
-
-            //if this is a foreign key field add the foreign key item
-            if ($model_field instanceof EE_Foreign_Key_Field_Base) {
-                $schema['properties'][$field]['foreign_key'] = array(
-                    'description' => esc_html__('This is a foreign key the points to the given models.', 'event_espresso'),
-                    'type' => 'array',
-                    'enum' => $model_field->get_model_class_names_pointed_to()
-                );
-            }
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Get the schema for a given set of model relations
-     * @param EE_Model_Relation_Base[] $relations_on_model
-     * @return array
-     */
-    public function getModelSchemaForRelations(array $relations_on_model, array $schema)
-    {
-        foreach ($relations_on_model as $model_name => $relation) {
-            if (! $relation instanceof EE_Model_Relation_Base) {
-                continue;
-            }
-            $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
-                ? strtolower($model_name)
-                : EEH_Inflector::pluralize_and_lower($model_name);
-            $schema['properties'][$model_name_for_schema] = $relation->getSchema();
-            $schema['properties'][$model_name_for_schema]['relation_model'] = $model_name;
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Outputs the schema header for a model.
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function getInitialSchemaStructure()
-    {
-        return array(
-            '$schema' => 'http://json-schema.org/draft-04/schema#',
-            'title' => $this->model->get_this_model_name(),
-            'type' => 'object',
-            'properties' => array()
-        );
-    }
-
-
-    /**
-     * Allows one to just use the object as a string to get the json.
-     * eg.
-     *
-     * $json_schema = new JsonModelSchema(EEM_Event::instance());
-     * echo $json_schema; //outputs the schema as a json formatted string.
-     *
-     * @return bool|false|mixed|string
-     */
-    public function __toString()
-    {
-        return wp_json_encode($this->getModelSchema());
-    }
+	/**
+	 * @var \EEM_Base
+	 */
+	protected $model;
+
+	/**
+	 * JsonModelSchema constructor.
+	 *
+	 * @param \EEM_Base $model
+	 */
+	public function __construct(EEM_Base $model)
+	{
+		$this->model = $model;
+	}
+
+	/**
+	 * Return the schema for a given model from a given model.
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function getModelSchema()
+	{
+		return $this->getModelSchemaForRelations(
+			$this->model->relation_settings(),
+			$this->getModelSchemaForFields(
+				$this->model->field_settings(),
+				$this->getInitialSchemaStructure()
+			)
+		);
+	}
+
+
+	/**
+	 * Get the schema for a given set of model fields.
+	 * @param \EE_Model_Field_Base[]     $model_fields
+	 * @return array
+	 */
+	public function getModelSchemaForFields(array $model_fields, array $schema)
+	{
+		foreach ($model_fields as $field => $model_field) {
+			if (! $model_field instanceof EE_Model_Field_Base) {
+				continue;
+			}
+			$schema['properties'][$field] = $model_field->getSchema();
+
+			//if this is a primary key field add the primary key item
+			if ($model_field instanceof EE_Primary_Key_Field_Base) {
+				$schema['properties'][$field]['primary_key'] = true;
+				if ($model_field instanceof EE_Primary_Key_Int_Field) {
+					$schema['properties'][$field]['readonly'] = true;
+				}
+			}
+
+			//if this is a foreign key field add the foreign key item
+			if ($model_field instanceof EE_Foreign_Key_Field_Base) {
+				$schema['properties'][$field]['foreign_key'] = array(
+					'description' => esc_html__('This is a foreign key the points to the given models.', 'event_espresso'),
+					'type' => 'array',
+					'enum' => $model_field->get_model_class_names_pointed_to()
+				);
+			}
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Get the schema for a given set of model relations
+	 * @param EE_Model_Relation_Base[] $relations_on_model
+	 * @return array
+	 */
+	public function getModelSchemaForRelations(array $relations_on_model, array $schema)
+	{
+		foreach ($relations_on_model as $model_name => $relation) {
+			if (! $relation instanceof EE_Model_Relation_Base) {
+				continue;
+			}
+			$model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
+				? strtolower($model_name)
+				: EEH_Inflector::pluralize_and_lower($model_name);
+			$schema['properties'][$model_name_for_schema] = $relation->getSchema();
+			$schema['properties'][$model_name_for_schema]['relation_model'] = $model_name;
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Outputs the schema header for a model.
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function getInitialSchemaStructure()
+	{
+		return array(
+			'$schema' => 'http://json-schema.org/draft-04/schema#',
+			'title' => $this->model->get_this_model_name(),
+			'type' => 'object',
+			'properties' => array()
+		);
+	}
+
+
+	/**
+	 * Allows one to just use the object as a string to get the json.
+	 * eg.
+	 *
+	 * $json_schema = new JsonModelSchema(EEM_Event::instance());
+	 * echo $json_schema; //outputs the schema as a json formatted string.
+	 *
+	 * @return bool|false|mixed|string
+	 */
+	public function __toString()
+	{
+		return wp_json_encode($this->getModelSchema());
+	}
 }

espresso.php

Indentation +219 added lines, -219 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('ABSPATH')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /*
   Plugin Name:		Event Espresso
@@ -40,243 +40,243 @@ 
  * @since            4.0
  */
 if (function_exists('espresso_version')) {
-    /**
-     *    espresso_duplicate_plugin_error
-     *    displays if more than one version of EE is activated at the same time
-     */
-    function espresso_duplicate_plugin_error()
-    {
-        ?>
+	/**
+	 *    espresso_duplicate_plugin_error
+	 *    displays if more than one version of EE is activated at the same time
+	 */
+	function espresso_duplicate_plugin_error()
+	{
+		?>
         <div class="error">
             <p>
                 <?php echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                ); ?>
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+				); ?>
             </p>
         </div>
         <?php
-        espresso_deactivate_plugin(plugin_basename(__FILE__));
-    }
+		espresso_deactivate_plugin(plugin_basename(__FILE__));
+	}
 
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
-    if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
+	if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                            esc_html__(
-                                    'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                                    'event_espresso'
-                            ),
-                            EE_MIN_PHP_VER_REQUIRED,
-                            PHP_VERSION,
-                            '<br/>',
-                            '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+							esc_html__(
+									'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+									'event_espresso'
+							),
+							EE_MIN_PHP_VER_REQUIRED,
+							PHP_VERSION,
+							'<br/>',
+							'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.32.rc.013');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.32.rc.013');
+		}
 
-        // define versions
-        define('EVENT_ESPRESSO_VERSION', espresso_version());
-        define('EE_MIN_WP_VER_REQUIRED', '4.1');
-        define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
-        define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        //used to be DIRECTORY_SEPARATOR, but that caused issues on windows
-        if ( ! defined('DS')) {
-            define('DS', '/');
-        }
-        if ( ! defined('PS')) {
-            define('PS', PATH_SEPARATOR);
-        }
-        if ( ! defined('SP')) {
-            define('SP', ' ');
-        }
-        if ( ! defined('EENL')) {
-            define('EENL', "\n");
-        }
-        define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
-        // define the plugin directory and URL
-        define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
-        // main root folder paths
-        define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
-        define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
-        define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
-        define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
-        define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
-        define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
-        define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
-        define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
-        // core system paths
-        define('EE_ADMIN', EE_CORE . 'admin' . DS);
-        define('EE_CPTS', EE_CORE . 'CPTs' . DS);
-        define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
-        define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
-        define('EE_BUSINESS', EE_CORE . 'business' . DS);
-        define('EE_MODELS', EE_CORE . 'db_models' . DS);
-        define('EE_HELPERS', EE_CORE . 'helpers' . DS);
-        define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
-        define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
-        define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
-        define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
-        define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
-        // gateways
-        define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
-        define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
-        // asset URL paths
-        define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
-        define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
-        define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
-        define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
-        define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
-        define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
-        // define upload paths
-        $uploads = wp_upload_dir();
-        // define the uploads directory and URL
-        define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
-        define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
-        // define the templates directory and URL
-        define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
-        define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
-        // define the gateway directory and URL
-        define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
-        define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
-        // languages folder/path
-        define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
-        define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
-        //check for dompdf fonts in uploads
-        if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
-            define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
-        }
-        //ajax constants
-        define(
-                'EE_FRONT_AJAX',
-                isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
-        );
-        define(
-                'EE_ADMIN_AJAX',
-                isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
-        );
-        //just a handy constant occasionally needed for finding values representing infinity in the DB
-        //you're better to use this than its straight value (currently -1) in case you ever
-        //want to change its default value! or find when -1 means infinity
-        define('EE_INF_IN_DB', -1);
-        define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
-        define('EE_DEBUG', false);
-        // for older WP versions
-        if ( ! defined('MONTH_IN_SECONDS')) {
-            define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
-        }
-        /**
-         *    espresso_plugin_activation
-         *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		// define versions
+		define('EVENT_ESPRESSO_VERSION', espresso_version());
+		define('EE_MIN_WP_VER_REQUIRED', '4.1');
+		define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
+		define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		//used to be DIRECTORY_SEPARATOR, but that caused issues on windows
+		if ( ! defined('DS')) {
+			define('DS', '/');
+		}
+		if ( ! defined('PS')) {
+			define('PS', PATH_SEPARATOR);
+		}
+		if ( ! defined('SP')) {
+			define('SP', ' ');
+		}
+		if ( ! defined('EENL')) {
+			define('EENL', "\n");
+		}
+		define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
+		// define the plugin directory and URL
+		define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
+		// main root folder paths
+		define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
+		define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
+		define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
+		define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
+		define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
+		define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
+		define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
+		define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
+		// core system paths
+		define('EE_ADMIN', EE_CORE . 'admin' . DS);
+		define('EE_CPTS', EE_CORE . 'CPTs' . DS);
+		define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
+		define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
+		define('EE_BUSINESS', EE_CORE . 'business' . DS);
+		define('EE_MODELS', EE_CORE . 'db_models' . DS);
+		define('EE_HELPERS', EE_CORE . 'helpers' . DS);
+		define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
+		define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
+		define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
+		define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
+		define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
+		// gateways
+		define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
+		define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
+		// asset URL paths
+		define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
+		define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
+		define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
+		define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
+		define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
+		define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
+		// define upload paths
+		$uploads = wp_upload_dir();
+		// define the uploads directory and URL
+		define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
+		define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
+		// define the templates directory and URL
+		define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
+		define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
+		// define the gateway directory and URL
+		define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
+		define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
+		// languages folder/path
+		define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
+		define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
+		//check for dompdf fonts in uploads
+		if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
+			define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
+		}
+		//ajax constants
+		define(
+				'EE_FRONT_AJAX',
+				isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
+		);
+		define(
+				'EE_ADMIN_AJAX',
+				isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
+		);
+		//just a handy constant occasionally needed for finding values representing infinity in the DB
+		//you're better to use this than its straight value (currently -1) in case you ever
+		//want to change its default value! or find when -1 means infinity
+		define('EE_INF_IN_DB', -1);
+		define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
+		define('EE_DEBUG', false);
+		// for older WP versions
+		if ( ! defined('MONTH_IN_SECONDS')) {
+			define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
+		}
+		/**
+		 *    espresso_plugin_activation
+		 *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
-        /**
-         *    espresso_load_error_handling
-         *    this function loads EE's class for handling exceptions and errors
-         */
-        function espresso_load_error_handling()
-        {
-            // load debugging tools
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
-                require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
-                EEH_Debug_Tools::instance();
-            }
-            // load error handling
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
-                require_once(EE_CORE . 'EE_Error.core.php');
-            } else {
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
-            }
-        }
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		/**
+		 *    espresso_load_error_handling
+		 *    this function loads EE's class for handling exceptions and errors
+		 */
+		function espresso_load_error_handling()
+		{
+			// load debugging tools
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
+				require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
+				EEH_Debug_Tools::instance();
+			}
+			// load error handling
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
+				require_once(EE_CORE . 'EE_Error.core.php');
+			} else {
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
+			}
+		}
 
-        /**
-         *    espresso_load_required
-         *    given a class name and path, this function will load that file or throw an exception
-         *
-         * @param    string $classname
-         * @param    string $full_path_to_file
-         * @throws    EE_Error
-         */
-        function espresso_load_required($classname, $full_path_to_file)
-        {
-            static $error_handling_loaded = false;
-            if ( ! $error_handling_loaded) {
-                espresso_load_error_handling();
-                $error_handling_loaded = true;
-            }
-            if (is_readable($full_path_to_file)) {
-                require_once($full_path_to_file);
-            } else {
-                throw new EE_Error (
-                        sprintf(
-                                esc_html__(
-                                        'The %s class file could not be located or is not readable due to file permissions.',
-                                        'event_espresso'
-                                ),
-                                $classname
-                        )
-                );
-            }
-        }
+		/**
+		 *    espresso_load_required
+		 *    given a class name and path, this function will load that file or throw an exception
+		 *
+		 * @param    string $classname
+		 * @param    string $full_path_to_file
+		 * @throws    EE_Error
+		 */
+		function espresso_load_required($classname, $full_path_to_file)
+		{
+			static $error_handling_loaded = false;
+			if ( ! $error_handling_loaded) {
+				espresso_load_error_handling();
+				$error_handling_loaded = true;
+			}
+			if (is_readable($full_path_to_file)) {
+				require_once($full_path_to_file);
+			} else {
+				throw new EE_Error (
+						sprintf(
+								esc_html__(
+										'The %s class file could not be located or is not readable due to file permissions.',
+										'event_espresso'
+								),
+								$classname
+						)
+				);
+			}
+		}
 
-        espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
-        espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
-        espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
-        new EE_Bootstrap();
-    }
+		espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
+		espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
+		espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
+		new EE_Bootstrap();
+	}
 }
 if ( ! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if ( ! function_exists('deactivate_plugins')) {
-            require_once(ABSPATH . 'wp-admin/includes/plugin.php');
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if ( ! function_exists('deactivate_plugins')) {
+			require_once(ABSPATH . 'wp-admin/includes/plugin.php');
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
\ No newline at end of file

core/db_models/EEM_Line_Item.model.php

Indentation +16 added lines, -16 removed lines

@@ -362,22 +362,22 @@
 
 
 
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    public function get_total_line_items_just_added_to_cart()
-    {
-        return $this->get_all(array(
-            array(
-                'TXN_ID'   => 0,
-                'LIN_type' => 'total',
-                'LIN_timestamp' => array(
-                    '>',
-                    time() - EE_Registry::instance()->SSN->lifespan()
-                ),            )
-        ));
-    }
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	public function get_total_line_items_just_added_to_cart()
+	{
+		return $this->get_all(array(
+			array(
+				'TXN_ID'   => 0,
+				'LIN_type' => 'total',
+				'LIN_timestamp' => array(
+					'>',
+					time() - EE_Registry::instance()->SSN->lifespan()
+				),            )
+		));
+	}
 
 
 

Spacing +60 added lines, -60 removed lines

@@ -105,41 +105,41 @@ 
 	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
 	 * @return \EEM_Line_Item
 	 */
-	protected function __construct( $timezone ) {
-		$this->singular_item = __('Line Item','event_espresso');
-		$this->plural_item = __('Line Items','event_espresso');
+	protected function __construct($timezone) {
+		$this->singular_item = __('Line Item', 'event_espresso');
+		$this->plural_item = __('Line Items', 'event_espresso');
 
 		$this->_tables = array(
-			'Line_Item'=>new EE_Primary_Table('esp_line_item','LIN_ID')
+			'Line_Item'=>new EE_Primary_Table('esp_line_item', 'LIN_ID')
 		);
-		$line_items_can_be_for = apply_filters( 'FHEE__EEM_Line_Item__line_items_can_be_for', array('Ticket','Price', 'Event' ) );
+		$line_items_can_be_for = apply_filters('FHEE__EEM_Line_Item__line_items_can_be_for', array('Ticket', 'Price', 'Event'));
 		$this->_fields = array(
 			'Line_Item' => array(
-				'LIN_ID' 				=> new EE_Primary_Key_Int_Field( 'LIN_ID', __( "ID", "event_espresso" ) ),
-				'LIN_code' 			=> new EE_Slug_Field( 'LIN_code', __( "Code for index into Cart", "event_espresso" ), TRUE ),
-				'TXN_ID' 				=> new EE_Foreign_Key_Int_Field( 'TXN_ID', __( "Transaction ID", "event_espresso" ), TRUE, NULL, 'Transaction' ),
-				'LIN_name' 			=> new EE_Full_HTML_Field( 'LIN_name', __( "Line Item Name", "event_espresso" ), FALSE, '' ),
-				'LIN_desc' 			=> new EE_Full_HTML_Field( 'LIN_desc', __( "Line Item Description", "event_espresso" ), TRUE ),
-				'LIN_unit_price' 	=> new EE_Money_Field( 'LIN_unit_price', __( "Unit Price", "event_espresso" ), FALSE, 0 ),
-				'LIN_percent' 		=> new EE_Float_Field( 'LIN_percent', __( "Percent", "event_espresso" ), FALSE, 0 ),
-				'LIN_is_taxable' 	=> new EE_Boolean_Field( 'LIN_is_taxable', __( "Taxable", "event_espresso" ), FALSE, FALSE ),
-				'LIN_order' 			=> new EE_Integer_Field( 'LIN_order', __( "Order of Application towards total of parent", "event_espresso" ), FALSE, 1 ),
-				'LIN_total' 			=> new EE_Money_Field( 'LIN_total', __( "Total (unit price x quantity)", "event_espresso" ), FALSE, 0 ),
-				'LIN_quantity' 	=> new EE_Integer_Field( 'LIN_quantity', __( "Quantity", "event_espresso" ), TRUE, 1 ),
-				'LIN_parent' 		=> new EE_Integer_Field( 'LIN_parent', __( "Parent ID (this item goes towards that Line Item's total)", "event_espresso" ), TRUE, NULL ),
-				'LIN_type' 			=> new EE_Enum_Text_Field( 'LIN_type', __( "Type", "event_espresso" ), FALSE, 'line-item', array(
+				'LIN_ID' 				=> new EE_Primary_Key_Int_Field('LIN_ID', __("ID", "event_espresso")),
+				'LIN_code' 			=> new EE_Slug_Field('LIN_code', __("Code for index into Cart", "event_espresso"), TRUE),
+				'TXN_ID' 				=> new EE_Foreign_Key_Int_Field('TXN_ID', __("Transaction ID", "event_espresso"), TRUE, NULL, 'Transaction'),
+				'LIN_name' 			=> new EE_Full_HTML_Field('LIN_name', __("Line Item Name", "event_espresso"), FALSE, ''),
+				'LIN_desc' 			=> new EE_Full_HTML_Field('LIN_desc', __("Line Item Description", "event_espresso"), TRUE),
+				'LIN_unit_price' 	=> new EE_Money_Field('LIN_unit_price', __("Unit Price", "event_espresso"), FALSE, 0),
+				'LIN_percent' 		=> new EE_Float_Field('LIN_percent', __("Percent", "event_espresso"), FALSE, 0),
+				'LIN_is_taxable' 	=> new EE_Boolean_Field('LIN_is_taxable', __("Taxable", "event_espresso"), FALSE, FALSE),
+				'LIN_order' 			=> new EE_Integer_Field('LIN_order', __("Order of Application towards total of parent", "event_espresso"), FALSE, 1),
+				'LIN_total' 			=> new EE_Money_Field('LIN_total', __("Total (unit price x quantity)", "event_espresso"), FALSE, 0),
+				'LIN_quantity' 	=> new EE_Integer_Field('LIN_quantity', __("Quantity", "event_espresso"), TRUE, 1),
+				'LIN_parent' 		=> new EE_Integer_Field('LIN_parent', __("Parent ID (this item goes towards that Line Item's total)", "event_espresso"), TRUE, NULL),
+				'LIN_type' 			=> new EE_Enum_Text_Field('LIN_type', __("Type", "event_espresso"), FALSE, 'line-item', array(
 						self::type_line_item		=>  __("Line Item", "event_espresso"),
 						self::type_sub_line_item	=>  __("Sub-Item", "event_espresso"),
 						self::type_sub_total		=>  __("Subtotal", "event_espresso"),
 						self::type_tax_sub_total 	=> __("Tax Subtotal", "event_espresso"),
 						self::type_tax					=>  __("Tax", "event_espresso"),
 						self::type_total				=>  __("Total", "event_espresso"),
-						self::type_cancellation	=> __( 'Cancellation', 'event_espresso' )
+						self::type_cancellation	=> __('Cancellation', 'event_espresso')
 					)
 				),
-				'OBJ_ID' 					=> new EE_Foreign_Key_Int_Field( 'OBJ_ID', __( 'ID of Item purchased.', 'event_espresso' ), TRUE, NULL, $line_items_can_be_for ),
-				'OBJ_type'				=>new EE_Any_Foreign_Model_Name_Field( 'OBJ_type', __( "Model Name this Line Item is for", "event_espresso" ), TRUE, NULL, $line_items_can_be_for ),
-				'LIN_timestamp' => new EE_Datetime_Field('LIN_timestamp', __('When the line item was created','event_espresso'), false, EE_Datetime_Field::now, $timezone ),
+				'OBJ_ID' 					=> new EE_Foreign_Key_Int_Field('OBJ_ID', __('ID of Item purchased.', 'event_espresso'), TRUE, NULL, $line_items_can_be_for),
+				'OBJ_type'				=>new EE_Any_Foreign_Model_Name_Field('OBJ_type', __("Model Name this Line Item is for", "event_espresso"), TRUE, NULL, $line_items_can_be_for),
+				'LIN_timestamp' => new EE_Datetime_Field('LIN_timestamp', __('When the line item was created', 'event_espresso'), false, EE_Datetime_Field::now, $timezone),
 			)
 		);
 		$this->_model_relations = array(
@@ -150,7 +150,7 @@ 
 		);
 		$this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
 		$this->_caps_slug = 'transactions';
-		parent::__construct( $timezone );
+		parent::__construct($timezone);
 	}
 
 
@@ -161,9 +161,9 @@ 
 	 * @param EE_Transaction|int $transaction
 	 * @return EE_Line_Item[]
 	 */
-	public function get_all_of_type_for_transaction( $line_item_type, $transaction ){
-		$transaction = EEM_Transaction::instance()->ensure_is_ID( $transaction );
-		return $this->get_all( array( array(
+	public function get_all_of_type_for_transaction($line_item_type, $transaction) {
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(array(array(
 			'LIN_type' => $line_item_type,
 			'TXN_ID' => $transaction
 		)));
@@ -177,14 +177,14 @@ 
 	 * @param EE_Transaction|int $transaction
 	 * @return EE_Line_Item[]
 	 */
-	public function get_all_non_ticket_line_items_for_transaction( $transaction ) {
-		$transaction = EEM_Transaction::instance()->ensure_is_ID( $transaction );
-		return $this->get_all( array( array(
+	public function get_all_non_ticket_line_items_for_transaction($transaction) {
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(array(array(
 			'LIN_type' => self::type_line_item,
 			'TXN_ID' => $transaction,
 			'OR' => array(
-				'OBJ_type*notticket' => array( '!=', 'Ticket'),
-				'OBJ_type*null' => array( 'IS_NULL' ))
+				'OBJ_type*notticket' => array('!=', 'Ticket'),
+				'OBJ_type*null' => array('IS_NULL'))
 		)));
 	}
 
@@ -194,7 +194,7 @@ 
 	 * because if there are spam bots afoot there will be LOTS of line items
 	 * @return int count of how many deleted
 	 */
-	public function delete_line_items_with_no_transaction(){
+	public function delete_line_items_with_no_transaction() {
 		/** @type WPDB $wpdb */
 		global $wpdb;
 		$time_to_leave_alone = apply_filters(
@@ -202,13 +202,13 @@ 
 		);
 		$query = $wpdb->prepare(
 				'DELETE li
-				FROM ' . $this->table() . ' li
-				LEFT JOIN ' . EEM_Transaction::instance()->table(). ' t ON li.TXN_ID = t.TXN_ID
+				FROM ' . $this->table().' li
+				LEFT JOIN ' . EEM_Transaction::instance()->table().' t ON li.TXN_ID = t.TXN_ID
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
 				// use GMT time because that's what TXN_timestamps are in
-				date(  'Y-m-d H:i:s', time() - $time_to_leave_alone )
+				date('Y-m-d H:i:s', time() - $time_to_leave_alone)
 				);
-		return $wpdb->query( $query );
+		return $wpdb->query($query);
 	}
 
 
@@ -221,10 +221,10 @@ 
 	 * @param \EE_Base_Class $object
 	 * @return EE_Line_Item[]
 	 */
-	public function get_line_item_for_transaction_object( $TXN_ID, EE_Base_Class $object ){
-		return $this->get_all( array( array(
+	public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object) {
+		return $this->get_all(array(array(
 			'TXN_ID' 		=> $TXN_ID,
-			'OBJ_type' 	=> str_replace( 'EE_', '', get_class( $object )),
+			'OBJ_type' 	=> str_replace('EE_', '', get_class($object)),
 			'OBJ_ID' 		=> $object->ID()
 		)));
 	}
@@ -240,16 +240,16 @@ 
 	 * @param array $OBJ_IDs
 	 * @return EE_Line_Item[]
 	 */
-	public function get_object_line_items_for_transaction( $TXN_ID, $OBJ_type = 'Event', $OBJ_IDs = array() ){
+	public function get_object_line_items_for_transaction($TXN_ID, $OBJ_type = 'Event', $OBJ_IDs = array()) {
 		$query_params = array(
 			'OBJ_type' 	=> $OBJ_type,
 			// if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
-			'OBJ_ID' 		=> is_array( $OBJ_IDs ) && ! isset( $OBJ_IDs['IN'] ) ? array( 'IN', $OBJ_IDs ) : $OBJ_IDs
+			'OBJ_ID' 		=> is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs
 		);
-		if ( $TXN_ID ) {
+		if ($TXN_ID) {
 			$query_params['TXN_ID'] = $TXN_ID;
 		}
-		return $this->get_all( array( $query_params ));
+		return $this->get_all(array($query_params));
 	}
 
 
@@ -260,13 +260,13 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return EE_Line_Item[]
 	 */
-	public function get_all_ticket_line_items_for_transaction( EE_Transaction $transaction ) {
-		return $this->get_all( array(
+	public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction) {
+		return $this->get_all(array(
 		   array(
 			   'TXN_ID'   => $transaction->ID(),
 			   'OBJ_type' => 'Ticket',
 		   )
-	   ) );
+	   ));
 	}
 
 
@@ -278,14 +278,14 @@ 
 	 * @param int $TKT_ID
 	 * @return \EE_Line_Item
 	 */
-	public function get_ticket_line_item_for_transaction( $TXN_ID, $TKT_ID ) {
-		return $this->get_one( array(
+	public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID) {
+		return $this->get_one(array(
 		   array(
-			   'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID( $TXN_ID ),
+			   'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
 			   'OBJ_ID'   => $TKT_ID,
 			   'OBJ_type' => 'Ticket',
 		   )
-	   ) );
+	   ));
 	}
 
 
@@ -300,8 +300,8 @@ 
 	 * @param EE_Promotion $promotion
 	 * @return EE_Line_Item
 	 */
-	public function get_existing_promotion_line_item( EE_Line_Item $parent_line_item, EE_Promotion $promotion ) {
-		return $this->get_one( array(
+	public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion) {
+		return $this->get_one(array(
 			array(
 				'TXN_ID' 			=> $parent_line_item->TXN_ID(),
 				'LIN_parent' 	=> $parent_line_item->ID(),
@@ -322,8 +322,8 @@ 
 	 * @param EE_Line_Item $parent_line_item
 	 * @return EE_Line_Item[]
 	 */
-	public function get_all_promotion_line_items( EE_Line_Item $parent_line_item ) {
-		return $this->get_all( array(
+	public function get_all_promotion_line_items(EE_Line_Item $parent_line_item) {
+		return $this->get_all(array(
 			array(
 				'TXN_ID' 			=> $parent_line_item->TXN_ID(),
 				'LIN_parent' 	=> $parent_line_item->ID(),
@@ -340,8 +340,8 @@ 
 	 * @param EE_Registration $registration
 	 * @return EE_Line_ITem
 	 */
-	public function get_line_item_for_registration( EE_Registration $registration ) {
-		return $this->get_one( $this->line_item_for_registration_query_params( $registration ));
+	public function get_line_item_for_registration(EE_Registration $registration) {
+		return $this->get_one($this->line_item_for_registration_query_params($registration));
 	}
 
 	/**
@@ -350,14 +350,14 @@ 
 	 * @param array $original_query_params any extra query params you'd like to be merged with
 	 * @return array like EEM_Base::get_all()'s $query_params
 	 */
-	public function line_item_for_registration_query_params( EE_Registration $registration, $original_query_params = array() ) {
-		return array_replace_recursive( $original_query_params, array(
+	public function line_item_for_registration_query_params(EE_Registration $registration, $original_query_params = array()) {
+		return array_replace_recursive($original_query_params, array(
 			array(
 				'OBJ_ID' => $registration->ticket_ID(),
 				'OBJ_type' => 'Ticket',
 				'TXN_ID' => $registration->transaction_ID()
 			)
-		) );
+		));
 	}
 
 
@@ -375,7 +375,7 @@ 
                 'LIN_timestamp' => array(
                     '>',
                     time() - EE_Registry::instance()->SSN->lifespan()
-                ),            )
+                ),)
         ));
     }
 

modules/ticket_sales_monitor/EED_Ticket_Sales_Monitor.module.php

Indentation +841 added lines, -841 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\exceptions\UnexpectedEntityException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -21,846 +21,846 @@ 
 class EED_Ticket_Sales_Monitor extends EED_Module
 {
 
-    const debug = false;    //	true false
-
-    /**
-     * an array of raw ticket data from EED_Ticket_Selector
-     *
-     * @var array $ticket_selections
-     */
-    protected $ticket_selections = array();
-
-    /**
-     * the raw ticket data from EED_Ticket_Selector is organized in rows
-     * according to how they are displayed in the actual Ticket_Selector
-     * this tracks the current row being processed
-     *
-     * @var int $current_row
-     */
-    protected $current_row = 0;
-
-    /**
-     * an array for tracking names of tickets that have sold out
-     *
-     * @var array $sold_out_tickets
-     */
-    protected $sold_out_tickets = array();
-
-    /**
-     * an array for tracking names of tickets that have had their quantities reduced
-     *
-     * @var array $decremented_tickets
-     */
-    protected $decremented_tickets = array();
-
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        // check ticket reserves AFTER MER does it's check (hence priority 20)
-        add_filter('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
-            array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
-            20, 3
-        );
-        // add notices for sold out tickets
-        add_action('AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-            array('EED_Ticket_Sales_Monitor', 'post_notices'),
-            10
-        );
-        // handle ticket quantities adjusted in cart
-        //add_action(
-        //	'FHEE__EED_Multi_Event_Registration__adjust_line_item_quantity__line_item_quantity_updated',
-        //	array( 'EED_Ticket_Sales_Monitor', 'ticket_quantity_updated' ),
-        //	10, 2
-        //);
-        // handle tickets deleted from cart
-        add_action(
-            'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
-            array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
-            10, 2
-        );
-        // handle emptied carts
-        add_action(
-            'AHEE__EE_Session__reset_cart__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10, 1
-        );
-        add_action(
-            'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10, 1
-        );
-        // handle cancelled registrations
-        add_action(
-            'AHEE__EE_Session__reset_checkout__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
-            10, 1
-        );
-        // cron tasks
-        add_action(
-            'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions__abandoned_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10, 1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10, 1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
-            10, 1
-        );
-    }
-
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Ticket_Sales_Monitor::set_hooks();
-    }
-
-
-
-    /**
-     * @return EED_Ticket_Sales_Monitor|EED_Module
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     *    run
-     *
-     * @access    public
-     * @param WP_Query $WP_Query
-     * @return    void
-     */
-    public function run($WP_Query)
-    {
-    }
-
-
-
-    /********************************** VALIDATE_TICKET_SALE  **********************************/
-
-
-
-    /**
-     *    validate_ticket_sales
-     *    callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
-     *
-     * @access    public
-     * @param int $qty
-     * @param \EE_Ticket $ticket
-     * @return bool
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public static function validate_ticket_sale($qty = 1, EE_Ticket $ticket)
-    {
-        $qty = absint($qty);
-        if ($qty > 0) {
-            $qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
-        }
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '()';
-            echo '<br /><br /><b> RETURNED QTY: ' . $qty . '</b>';
-        }
-        return $qty;
-    }
-
-
-
-    /**
-     *    _validate_ticket_sale
-     * checks whether an individual ticket is available for purchase based on datetime, and ticket details
-     *
-     * @access    protected
-     * @param   \EE_Ticket $ticket
-     * @param int          $qty
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        if ( ! $ticket instanceof EE_Ticket) {
-            return 0;
-        }
-        if (self::debug) {
-            echo '<br /><b> . ticket->ID: ' . $ticket->ID() . '</b>';
-            echo '<br /> . original ticket->reserved: ' . $ticket->reserved();
-        }
-        $ticket->refresh_from_db();
-        // first let's determine the ticket availability based on sales
-        $available = $ticket->qty('saleable');
-        if (self::debug) {
-            echo '<br /> . . . ticket->qty: ' . $ticket->qty();
-            echo '<br /> . . . ticket->sold: ' . $ticket->sold();
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-            echo '<br /> . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
-            echo '<br /> . . . available: ' . $available;
-        }
-        if ($available < 1) {
-            $this->_ticket_sold_out($ticket);
-            return 0;
-        }
-        if (self::debug) {
-            echo '<br /> . . . qty: ' . $qty;
-        }
-        if ($available < $qty) {
-            $qty = $available;
-            if (self::debug) {
-                echo '<br /> . . . QTY ADJUSTED: ' . $qty;
-            }
-            $this->_ticket_quantity_decremented($ticket);
-        }
-        $this->_reserve_ticket($ticket, $qty);
-        return $qty;
-    }
-
-
-
-    /**
-     *  _reserve_ticket
-     *    increments ticket reserved based on quantity passed
-     *
-     * @access    protected
-     * @param    \EE_Ticket $ticket
-     * @param int           $quantity
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        if (self::debug) {
-            echo '<br /><br /> . . . INCREASE RESERVED: ' . $quantity;
-        }
-        $ticket->increase_reserved($quantity);
-        return $ticket->save();
-    }
-
-
-
-    /**
-     * _release_reserved_ticket
-     *
-     * @access protected
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        if (self::debug) {
-            echo '<br /> . . . ticket->ID: ' . $ticket->ID();
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-        }
-        $ticket->decrease_reserved($quantity);
-        if (self::debug) {
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-        }
-        return $ticket->save() ? 1 : 0;
-    }
-
-
-
-    /**
-     *    _ticket_sold_out
-     *    removes quantities within the ticket selector based on zero ticket availability
-     *
-     * @access    protected
-     * @param    \EE_Ticket $ticket
-     * @return    void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_sold_out(EE_Ticket $ticket)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-
-    /**
-     *    _ticket_quantity_decremented
-     *    adjusts quantities within the ticket selector based on decreased ticket availability
-     *
-     * @access    protected
-     * @param    \EE_Ticket $ticket
-     * @return void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_quantity_decremented(EE_Ticket $ticket)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-
-    /**
-     *    _get_ticket_and_event_name
-     *    builds string out of ticket and event name
-     *
-     * @access    protected
-     * @param    \EE_Ticket $ticket
-     * @return string
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _get_ticket_and_event_name(EE_Ticket $ticket)
-    {
-        $event = $ticket->get_related_event();
-        if ($event instanceof EE_Event) {
-            $ticket_name = sprintf(
-                _x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
-                $ticket->name(),
-                $event->name()
-            );
-        } else {
-            $ticket_name = $ticket->name();
-        }
-        return $ticket_name;
-    }
-
-
-
-    /********************************** EVENT CART  **********************************/
-
-
-
-    /**
-     * ticket_quantity_updated
-     * releases or reserves ticket(s) based on quantity passed
-     *
-     * @access public
-     * @param  EE_Line_Item $line_item
-     * @param  int          $quantity
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
-    {
-        $ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
-        if ($ticket instanceof EE_Ticket) {
-            if ($quantity > 0) {
-                EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
-            } else {
-                EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-            }
-        }
-    }
-
-
-
-    /**
-     * ticket_removed_from_cart
-     * releases reserved ticket(s) based on quantity passed
-     *
-     * @access public
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
-    {
-        EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-    }
-
-
-
-    /********************************** POST_NOTICES  **********************************/
-
-
-
-    /**
-     *    post_notices
-     *
-     * @access    public
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function post_notices()
-    {
-        EED_Ticket_Sales_Monitor::instance()->_post_notices();
-    }
-
-
-
-    /**
-     *    _post_notices
-     *
-     * @access    protected
-     * @return    void
-     * @throws EE_Error
-     */
-    protected function _post_notices()
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        $refresh_msg = '';
-        $none_added_msg = '';
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $refresh_msg = __('Please refresh the page to view updated ticket quantities.',
-                'event_espresso');
-            $none_added_msg = __('No tickets were added for the event.', 'event_espresso');
-        }
-        if ( ! empty($this->sold_out_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
-                        __('We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso')
-                    ),
-                    '<br />',
-                    implode('<br />', $this->sold_out_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            // alter code flow in the Ticket Selector for better UX
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
-            $this->sold_out_tickets = array();
-            // and reset the cart
-            EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
-        }
-        if ( ! empty($this->decremented_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
-                        __('We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso')
-                    ),
-                    '<br />',
-                    implode('<br />', $this->decremented_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            $this->decremented_tickets = array();
-        }
-    }
-
-
-
-    /********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
-
-
-
-    /**
-     *    _release_all_reserved_tickets_for_transaction
-     *    releases reserved tickets for all registrations of an EE_Transaction
-     *    by default, will NOT release tickets for finalized transactions
-     *
-     * @access    protected
-     * @param    EE_Transaction $transaction
-     * @return int
-     * @throws EE_Error
-     */
-    protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . transaction->ID: ' . $transaction->ID();
-        }
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        if (self::debug) {
-            // DEBUG LOG
-            EEH_Debug_Tools::log(
-                __CLASS__, __FUNCTION__, __LINE__,
-                array('finalized' => $finalized),
-                false, 'EE_Transaction: ' . $transaction->ID()
-            );
-        }
-        // how many tickets were released
-        $count = 0;
-        if (self::debug) {
-            echo '<br /> . . . finalized: ' . $finalized;
-        }
-        $release_tickets_with_TXN_status = array(
-            EEM_Transaction::failed_status_code,
-            EEM_Transaction::abandoned_status_code,
-            EEM_Transaction::incomplete_status_code,
-        );
-        // if the session is getting cleared BEFORE the TXN has been finalized
-        if ( ! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
-            // let's cancel any reserved tickets
-            $registrations = $transaction->registrations();
-            if ( ! empty($registrations)) {
-                foreach ($registrations as $registration) {
-                    if ($registration instanceof EE_Registration) {
-                        $count += $this->_release_reserved_ticket_for_registration($registration, $transaction);
-                    }
-                }
-            }
-        }
-        return $count;
-    }
-
-
-
-    /**
-     *    _release_reserved_ticket_for_registration
-     *    releases reserved tickets for an EE_Registration
-     *    by default, will NOT release tickets for APPROVED registrations
-     *
-     * @access    protected
-     * @param    EE_Registration $registration
-     * @param    EE_Transaction  $transaction
-     * @return    int
-     * @throws    EE_Error
-     */
-    protected function _release_reserved_ticket_for_registration(
-        EE_Registration $registration,
-        EE_Transaction $transaction
-    ) {
-        $STS_ID = $transaction->status_ID();
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . registration->ID: ' . $registration->ID();
-            echo '<br /> . . registration->status_ID: ' . $registration->status_ID();
-            echo '<br /> . . transaction->status_ID(): ' . $STS_ID;
-        }
-        if (
-            // release Tickets for Failed Transactions and Abandoned Transactions
-            $STS_ID === EEM_Transaction::failed_status_code
-            || $STS_ID === EEM_Transaction::abandoned_status_code
-            || (
-                // also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
-                $STS_ID === EEM_Transaction::incomplete_status_code
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
-            )
-        ) {
-            $ticket = $registration->ticket();
-            if ($ticket instanceof EE_Ticket) {
-                return $this->_release_reserved_ticket($ticket);
-            }
-        }
-        return 0;
-    }
-
-
-
-    /********************************** SESSION_CART_RESET  **********************************/
-
-
-
-    /**
-     *    session_cart_reset
-     * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
-     *
-     * @access    public
-     * @param    EE_Session $session
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function session_cart_reset(EE_Session $session)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        $cart = $session->cart();
-        if ($cart instanceof EE_Cart) {
-            if (self::debug) {
-                echo '<br /><br /> cart instance of EE_Cart: ';
-            }
-            EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart);
-        } else {
-            if (self::debug) {
-                echo '<br /><br /> invalid EE_Cart: ';
-                var_dump($cart);
-            }
-        }
-    }
-
-
-
-    /**
-     *    _session_cart_reset
-     * releases reserved tickets in the EE_Cart
-     *
-     * @access    protected
-     * @param    EE_Cart $cart
-     * @return    void
-     * @throws EE_Error
-     */
-    protected function _session_cart_reset(EE_Cart $cart)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        EE_Registry::instance()->load_helper('Line_Item');
-        $ticket_line_items = $cart->get_tickets();
-        if (empty($ticket_line_items)) {
-            return;
-        }
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (self::debug) {
-                echo '<br /> . ticket_line_item->ID(): ' . $ticket_line_item->ID();
-            }
-            if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
-                if (self::debug) {
-                    echo '<br /> . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
-                }
-                $ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
-                if ($ticket instanceof EE_Ticket) {
-                    if (self::debug) {
-                        echo '<br /> . . ticket->ID(): ' . $ticket->ID();
-                        echo '<br /> . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
-                    }
-                    $this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
-                }
-            }
-        }
-        if (self::debug) {
-            echo '<br /><br /> RESET COMPLETED ';
-        }
-    }
-
-
-
-    /********************************** SESSION_CHECKOUT_RESET  **********************************/
-
-
-
-    /**
-     *    session_checkout_reset
-     * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
-     *
-     * @access    public
-     * @param    EE_Session $session
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function session_checkout_reset(EE_Session $session)
-    {
-        $checkout = $session->checkout();
-        if ($checkout instanceof EE_Checkout) {
-            EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
-        }
-    }
-
-
-
-    /**
-     *    _session_checkout_reset
-     * releases reserved tickets for the EE_Checkout->transaction
-     *
-     * @access    protected
-     * @param    EE_Checkout $checkout
-     * @return    void
-     * @throws EE_Error
-     */
-    protected function _session_checkout_reset(EE_Checkout $checkout)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        // we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
-        if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
-            return;
-        }
-        $this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
-    }
-
-
-
-    /********************************** SESSION_EXPIRED_RESET  **********************************/
-
-
-
-    /**
-     *    session_expired_reset
-     *
-     * @access    public
-     * @param    EE_Session $session
-     * @return    void
-     */
-    public static function session_expired_reset(EE_Session $session)
-    {
-    }
-
-
-
-    /********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
-
-
-
-    /**
-     *    process_abandoned_transactions
-     *    releases reserved tickets for all registrations of an ABANDONED EE_Transaction
-     *    by default, will NOT release tickets for free transactions, or any that have received a payment
-     *
-     * @access    public
-     * @param    EE_Transaction $transaction
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function process_abandoned_transactions(EE_Transaction $transaction)
-    {
-        // is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
-        if ($transaction->is_free() || $transaction->paid() > 0) {
-            if (self::debug) {
-                // DEBUG LOG
-                EEH_Debug_Tools::log(
-                    __CLASS__, __FUNCTION__, __LINE__,
-                    array($transaction),
-                    false, 'EE_Transaction: ' . $transaction->ID()
-                );
-            }
-            return;
-        }
-        // have their been any successful payments made ?
-        $payments = $transaction->payments();
-        foreach ($payments as $payment) {
-            if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
-                if (self::debug) {
-                    // DEBUG LOG
-                    EEH_Debug_Tools::log(
-                        __CLASS__, __FUNCTION__, __LINE__,
-                        array($payment),
-                        false, 'EE_Transaction: ' . $transaction->ID()
-                    );
-                }
-                return;
-            }
-        }
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
-
-
-
-    /**
-     *    process_abandoned_transactions
-     *    releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
-     *
-     * @access    public
-     * @param    EE_Transaction $transaction
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function process_failed_transactions(EE_Transaction $transaction)
-    {
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** RESET RESERVATION COUNTS  *********************************/
-
-
-
-    /**
-     * Resets all ticket and datetime reserved counts to zero
-     * Tickets that are currently associated with a Transaction that is in progress
-     *
-     * @throws \EE_Error
-     * @throws \DomainException
-     */
-    public static function reset_reservation_counts()
-    {
-        $total_tickets_released = 0;
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets = array();
-        $transactions_in_progress = EEM_Transaction::instance()->get_transactions_in_progress();
-        foreach ($transactions_in_progress as $transaction_in_progress) {
-            // if this TXN has been fully completed, then skip it
-            if ($transaction_in_progress->reg_step_completed('finalize_registration')) {
-                continue;
-            }
-            /** @var EE_Transaction $transaction_in_progress */
-            $total_line_item = $transaction_in_progress->total_line_item();
-            // $transaction_in_progress->line
-            if (! $total_line_item instanceof EE_Line_Item) {
-                throw new DomainException(
-                    esc_html__('Transaction does not have a valid Total Line Item associated with it.', 'event_espresso')
-                );
-            }
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_reserved_tickets_for_line_item($total_line_item);
-        }
-        $total_line_items = EEM_Line_Item::instance()->get_total_line_items_just_added_to_cart();
-        foreach ($total_line_items as $total_line_item) {
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_reserved_tickets_for_line_item($total_line_item);
-        }
-        $tickets_with_reservations = EEM_Ticket::instance()->get_tickets_with_reservations();
-        foreach ($tickets_with_reservations as $ticket_with_reservations) {
-            if (! $ticket_with_reservations instanceof EE_Ticket) {
-                continue;
-            }
-            $reserved_qty = $ticket_with_reservations->reserved();
-            foreach ($valid_reserved_tickets as $valid_reserved_ticket) {
-                if(
-                    $valid_reserved_ticket instanceof EE_Line_Item
-                    && $valid_reserved_ticket->OBJ_ID() === $ticket_with_reservations->ID()
-                ) {
-                    $reserved_qty -= $valid_reserved_ticket->quantity();
-                }
-            }
-            if ($reserved_qty > 0) {
-                $ticket_with_reservations->decrease_reserved($reserved_qty);
-                $ticket_with_reservations->save();
-                $total_tickets_released += $reserved_qty;
-            }
-        }
-        return $total_tickets_released;
-    }
-
-
-
-    private static function get_reserved_tickets_for_line_item(EE_Line_Item $total_line_item)
-    {
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets = array();
-        $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if ($ticket_line_item instanceof EE_Line_Item) {
-                $valid_reserved_tickets[] = $ticket_line_item;
-            }
-        }
-        return $valid_reserved_tickets;
-    }
+	const debug = false;    //	true false
+
+	/**
+	 * an array of raw ticket data from EED_Ticket_Selector
+	 *
+	 * @var array $ticket_selections
+	 */
+	protected $ticket_selections = array();
+
+	/**
+	 * the raw ticket data from EED_Ticket_Selector is organized in rows
+	 * according to how they are displayed in the actual Ticket_Selector
+	 * this tracks the current row being processed
+	 *
+	 * @var int $current_row
+	 */
+	protected $current_row = 0;
+
+	/**
+	 * an array for tracking names of tickets that have sold out
+	 *
+	 * @var array $sold_out_tickets
+	 */
+	protected $sold_out_tickets = array();
+
+	/**
+	 * an array for tracking names of tickets that have had their quantities reduced
+	 *
+	 * @var array $decremented_tickets
+	 */
+	protected $decremented_tickets = array();
+
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		// check ticket reserves AFTER MER does it's check (hence priority 20)
+		add_filter('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
+			array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
+			20, 3
+		);
+		// add notices for sold out tickets
+		add_action('AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+			array('EED_Ticket_Sales_Monitor', 'post_notices'),
+			10
+		);
+		// handle ticket quantities adjusted in cart
+		//add_action(
+		//	'FHEE__EED_Multi_Event_Registration__adjust_line_item_quantity__line_item_quantity_updated',
+		//	array( 'EED_Ticket_Sales_Monitor', 'ticket_quantity_updated' ),
+		//	10, 2
+		//);
+		// handle tickets deleted from cart
+		add_action(
+			'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
+			array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
+			10, 2
+		);
+		// handle emptied carts
+		add_action(
+			'AHEE__EE_Session__reset_cart__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10, 1
+		);
+		add_action(
+			'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10, 1
+		);
+		// handle cancelled registrations
+		add_action(
+			'AHEE__EE_Session__reset_checkout__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
+			10, 1
+		);
+		// cron tasks
+		add_action(
+			'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions__abandoned_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10, 1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10, 1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
+			10, 1
+		);
+	}
+
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Ticket_Sales_Monitor::set_hooks();
+	}
+
+
+
+	/**
+	 * @return EED_Ticket_Sales_Monitor|EED_Module
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 *    run
+	 *
+	 * @access    public
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 */
+	public function run($WP_Query)
+	{
+	}
+
+
+
+	/********************************** VALIDATE_TICKET_SALE  **********************************/
+
+
+
+	/**
+	 *    validate_ticket_sales
+	 *    callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
+	 *
+	 * @access    public
+	 * @param int $qty
+	 * @param \EE_Ticket $ticket
+	 * @return bool
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public static function validate_ticket_sale($qty = 1, EE_Ticket $ticket)
+	{
+		$qty = absint($qty);
+		if ($qty > 0) {
+			$qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
+		}
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '()';
+			echo '<br /><br /><b> RETURNED QTY: ' . $qty . '</b>';
+		}
+		return $qty;
+	}
+
+
+
+	/**
+	 *    _validate_ticket_sale
+	 * checks whether an individual ticket is available for purchase based on datetime, and ticket details
+	 *
+	 * @access    protected
+	 * @param   \EE_Ticket $ticket
+	 * @param int          $qty
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		if ( ! $ticket instanceof EE_Ticket) {
+			return 0;
+		}
+		if (self::debug) {
+			echo '<br /><b> . ticket->ID: ' . $ticket->ID() . '</b>';
+			echo '<br /> . original ticket->reserved: ' . $ticket->reserved();
+		}
+		$ticket->refresh_from_db();
+		// first let's determine the ticket availability based on sales
+		$available = $ticket->qty('saleable');
+		if (self::debug) {
+			echo '<br /> . . . ticket->qty: ' . $ticket->qty();
+			echo '<br /> . . . ticket->sold: ' . $ticket->sold();
+			echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+			echo '<br /> . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
+			echo '<br /> . . . available: ' . $available;
+		}
+		if ($available < 1) {
+			$this->_ticket_sold_out($ticket);
+			return 0;
+		}
+		if (self::debug) {
+			echo '<br /> . . . qty: ' . $qty;
+		}
+		if ($available < $qty) {
+			$qty = $available;
+			if (self::debug) {
+				echo '<br /> . . . QTY ADJUSTED: ' . $qty;
+			}
+			$this->_ticket_quantity_decremented($ticket);
+		}
+		$this->_reserve_ticket($ticket, $qty);
+		return $qty;
+	}
+
+
+
+	/**
+	 *  _reserve_ticket
+	 *    increments ticket reserved based on quantity passed
+	 *
+	 * @access    protected
+	 * @param    \EE_Ticket $ticket
+	 * @param int           $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		if (self::debug) {
+			echo '<br /><br /> . . . INCREASE RESERVED: ' . $quantity;
+		}
+		$ticket->increase_reserved($quantity);
+		return $ticket->save();
+	}
+
+
+
+	/**
+	 * _release_reserved_ticket
+	 *
+	 * @access protected
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		if (self::debug) {
+			echo '<br /> . . . ticket->ID: ' . $ticket->ID();
+			echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+		}
+		$ticket->decrease_reserved($quantity);
+		if (self::debug) {
+			echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+		}
+		return $ticket->save() ? 1 : 0;
+	}
+
+
+
+	/**
+	 *    _ticket_sold_out
+	 *    removes quantities within the ticket selector based on zero ticket availability
+	 *
+	 * @access    protected
+	 * @param    \EE_Ticket $ticket
+	 * @return    void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_sold_out(EE_Ticket $ticket)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+
+	/**
+	 *    _ticket_quantity_decremented
+	 *    adjusts quantities within the ticket selector based on decreased ticket availability
+	 *
+	 * @access    protected
+	 * @param    \EE_Ticket $ticket
+	 * @return void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_quantity_decremented(EE_Ticket $ticket)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+
+	/**
+	 *    _get_ticket_and_event_name
+	 *    builds string out of ticket and event name
+	 *
+	 * @access    protected
+	 * @param    \EE_Ticket $ticket
+	 * @return string
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _get_ticket_and_event_name(EE_Ticket $ticket)
+	{
+		$event = $ticket->get_related_event();
+		if ($event instanceof EE_Event) {
+			$ticket_name = sprintf(
+				_x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
+				$ticket->name(),
+				$event->name()
+			);
+		} else {
+			$ticket_name = $ticket->name();
+		}
+		return $ticket_name;
+	}
+
+
+
+	/********************************** EVENT CART  **********************************/
+
+
+
+	/**
+	 * ticket_quantity_updated
+	 * releases or reserves ticket(s) based on quantity passed
+	 *
+	 * @access public
+	 * @param  EE_Line_Item $line_item
+	 * @param  int          $quantity
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
+	{
+		$ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
+		if ($ticket instanceof EE_Ticket) {
+			if ($quantity > 0) {
+				EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
+			} else {
+				EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+			}
+		}
+	}
+
+
+
+	/**
+	 * ticket_removed_from_cart
+	 * releases reserved ticket(s) based on quantity passed
+	 *
+	 * @access public
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
+	{
+		EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+	}
+
+
+
+	/********************************** POST_NOTICES  **********************************/
+
+
+
+	/**
+	 *    post_notices
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function post_notices()
+	{
+		EED_Ticket_Sales_Monitor::instance()->_post_notices();
+	}
+
+
+
+	/**
+	 *    _post_notices
+	 *
+	 * @access    protected
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	protected function _post_notices()
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		$refresh_msg = '';
+		$none_added_msg = '';
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$refresh_msg = __('Please refresh the page to view updated ticket quantities.',
+				'event_espresso');
+			$none_added_msg = __('No tickets were added for the event.', 'event_espresso');
+		}
+		if ( ! empty($this->sold_out_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
+						__('We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso')
+					),
+					'<br />',
+					implode('<br />', $this->sold_out_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			// alter code flow in the Ticket Selector for better UX
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
+			$this->sold_out_tickets = array();
+			// and reset the cart
+			EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
+		}
+		if ( ! empty($this->decremented_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
+						__('We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso')
+					),
+					'<br />',
+					implode('<br />', $this->decremented_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			$this->decremented_tickets = array();
+		}
+	}
+
+
+
+	/********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
+
+
+
+	/**
+	 *    _release_all_reserved_tickets_for_transaction
+	 *    releases reserved tickets for all registrations of an EE_Transaction
+	 *    by default, will NOT release tickets for finalized transactions
+	 *
+	 * @access    protected
+	 * @param    EE_Transaction $transaction
+	 * @return int
+	 * @throws EE_Error
+	 */
+	protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . transaction->ID: ' . $transaction->ID();
+		}
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		if (self::debug) {
+			// DEBUG LOG
+			EEH_Debug_Tools::log(
+				__CLASS__, __FUNCTION__, __LINE__,
+				array('finalized' => $finalized),
+				false, 'EE_Transaction: ' . $transaction->ID()
+			);
+		}
+		// how many tickets were released
+		$count = 0;
+		if (self::debug) {
+			echo '<br /> . . . finalized: ' . $finalized;
+		}
+		$release_tickets_with_TXN_status = array(
+			EEM_Transaction::failed_status_code,
+			EEM_Transaction::abandoned_status_code,
+			EEM_Transaction::incomplete_status_code,
+		);
+		// if the session is getting cleared BEFORE the TXN has been finalized
+		if ( ! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
+			// let's cancel any reserved tickets
+			$registrations = $transaction->registrations();
+			if ( ! empty($registrations)) {
+				foreach ($registrations as $registration) {
+					if ($registration instanceof EE_Registration) {
+						$count += $this->_release_reserved_ticket_for_registration($registration, $transaction);
+					}
+				}
+			}
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 *    _release_reserved_ticket_for_registration
+	 *    releases reserved tickets for an EE_Registration
+	 *    by default, will NOT release tickets for APPROVED registrations
+	 *
+	 * @access    protected
+	 * @param    EE_Registration $registration
+	 * @param    EE_Transaction  $transaction
+	 * @return    int
+	 * @throws    EE_Error
+	 */
+	protected function _release_reserved_ticket_for_registration(
+		EE_Registration $registration,
+		EE_Transaction $transaction
+	) {
+		$STS_ID = $transaction->status_ID();
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . . registration->ID: ' . $registration->ID();
+			echo '<br /> . . registration->status_ID: ' . $registration->status_ID();
+			echo '<br /> . . transaction->status_ID(): ' . $STS_ID;
+		}
+		if (
+			// release Tickets for Failed Transactions and Abandoned Transactions
+			$STS_ID === EEM_Transaction::failed_status_code
+			|| $STS_ID === EEM_Transaction::abandoned_status_code
+			|| (
+				// also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
+				$STS_ID === EEM_Transaction::incomplete_status_code
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
+			)
+		) {
+			$ticket = $registration->ticket();
+			if ($ticket instanceof EE_Ticket) {
+				return $this->_release_reserved_ticket($ticket);
+			}
+		}
+		return 0;
+	}
+
+
+
+	/********************************** SESSION_CART_RESET  **********************************/
+
+
+
+	/**
+	 *    session_cart_reset
+	 * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
+	 *
+	 * @access    public
+	 * @param    EE_Session $session
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function session_cart_reset(EE_Session $session)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		$cart = $session->cart();
+		if ($cart instanceof EE_Cart) {
+			if (self::debug) {
+				echo '<br /><br /> cart instance of EE_Cart: ';
+			}
+			EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart);
+		} else {
+			if (self::debug) {
+				echo '<br /><br /> invalid EE_Cart: ';
+				var_dump($cart);
+			}
+		}
+	}
+
+
+
+	/**
+	 *    _session_cart_reset
+	 * releases reserved tickets in the EE_Cart
+	 *
+	 * @access    protected
+	 * @param    EE_Cart $cart
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	protected function _session_cart_reset(EE_Cart $cart)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		EE_Registry::instance()->load_helper('Line_Item');
+		$ticket_line_items = $cart->get_tickets();
+		if (empty($ticket_line_items)) {
+			return;
+		}
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (self::debug) {
+				echo '<br /> . ticket_line_item->ID(): ' . $ticket_line_item->ID();
+			}
+			if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
+				if (self::debug) {
+					echo '<br /> . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
+				}
+				$ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
+				if ($ticket instanceof EE_Ticket) {
+					if (self::debug) {
+						echo '<br /> . . ticket->ID(): ' . $ticket->ID();
+						echo '<br /> . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
+					}
+					$this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
+				}
+			}
+		}
+		if (self::debug) {
+			echo '<br /><br /> RESET COMPLETED ';
+		}
+	}
+
+
+
+	/********************************** SESSION_CHECKOUT_RESET  **********************************/
+
+
+
+	/**
+	 *    session_checkout_reset
+	 * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
+	 *
+	 * @access    public
+	 * @param    EE_Session $session
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function session_checkout_reset(EE_Session $session)
+	{
+		$checkout = $session->checkout();
+		if ($checkout instanceof EE_Checkout) {
+			EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
+		}
+	}
+
+
+
+	/**
+	 *    _session_checkout_reset
+	 * releases reserved tickets for the EE_Checkout->transaction
+	 *
+	 * @access    protected
+	 * @param    EE_Checkout $checkout
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	protected function _session_checkout_reset(EE_Checkout $checkout)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		// we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
+		if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
+			return;
+		}
+		$this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
+	}
+
+
+
+	/********************************** SESSION_EXPIRED_RESET  **********************************/
+
+
+
+	/**
+	 *    session_expired_reset
+	 *
+	 * @access    public
+	 * @param    EE_Session $session
+	 * @return    void
+	 */
+	public static function session_expired_reset(EE_Session $session)
+	{
+	}
+
+
+
+	/********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
+
+
+
+	/**
+	 *    process_abandoned_transactions
+	 *    releases reserved tickets for all registrations of an ABANDONED EE_Transaction
+	 *    by default, will NOT release tickets for free transactions, or any that have received a payment
+	 *
+	 * @access    public
+	 * @param    EE_Transaction $transaction
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function process_abandoned_transactions(EE_Transaction $transaction)
+	{
+		// is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
+		if ($transaction->is_free() || $transaction->paid() > 0) {
+			if (self::debug) {
+				// DEBUG LOG
+				EEH_Debug_Tools::log(
+					__CLASS__, __FUNCTION__, __LINE__,
+					array($transaction),
+					false, 'EE_Transaction: ' . $transaction->ID()
+				);
+			}
+			return;
+		}
+		// have their been any successful payments made ?
+		$payments = $transaction->payments();
+		foreach ($payments as $payment) {
+			if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
+				if (self::debug) {
+					// DEBUG LOG
+					EEH_Debug_Tools::log(
+						__CLASS__, __FUNCTION__, __LINE__,
+						array($payment),
+						false, 'EE_Transaction: ' . $transaction->ID()
+					);
+				}
+				return;
+			}
+		}
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
+
+
+
+	/**
+	 *    process_abandoned_transactions
+	 *    releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
+	 *
+	 * @access    public
+	 * @param    EE_Transaction $transaction
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function process_failed_transactions(EE_Transaction $transaction)
+	{
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** RESET RESERVATION COUNTS  *********************************/
+
+
+
+	/**
+	 * Resets all ticket and datetime reserved counts to zero
+	 * Tickets that are currently associated with a Transaction that is in progress
+	 *
+	 * @throws \EE_Error
+	 * @throws \DomainException
+	 */
+	public static function reset_reservation_counts()
+	{
+		$total_tickets_released = 0;
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets = array();
+		$transactions_in_progress = EEM_Transaction::instance()->get_transactions_in_progress();
+		foreach ($transactions_in_progress as $transaction_in_progress) {
+			// if this TXN has been fully completed, then skip it
+			if ($transaction_in_progress->reg_step_completed('finalize_registration')) {
+				continue;
+			}
+			/** @var EE_Transaction $transaction_in_progress */
+			$total_line_item = $transaction_in_progress->total_line_item();
+			// $transaction_in_progress->line
+			if (! $total_line_item instanceof EE_Line_Item) {
+				throw new DomainException(
+					esc_html__('Transaction does not have a valid Total Line Item associated with it.', 'event_espresso')
+				);
+			}
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_reserved_tickets_for_line_item($total_line_item);
+		}
+		$total_line_items = EEM_Line_Item::instance()->get_total_line_items_just_added_to_cart();
+		foreach ($total_line_items as $total_line_item) {
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_reserved_tickets_for_line_item($total_line_item);
+		}
+		$tickets_with_reservations = EEM_Ticket::instance()->get_tickets_with_reservations();
+		foreach ($tickets_with_reservations as $ticket_with_reservations) {
+			if (! $ticket_with_reservations instanceof EE_Ticket) {
+				continue;
+			}
+			$reserved_qty = $ticket_with_reservations->reserved();
+			foreach ($valid_reserved_tickets as $valid_reserved_ticket) {
+				if(
+					$valid_reserved_ticket instanceof EE_Line_Item
+					&& $valid_reserved_ticket->OBJ_ID() === $ticket_with_reservations->ID()
+				) {
+					$reserved_qty -= $valid_reserved_ticket->quantity();
+				}
+			}
+			if ($reserved_qty > 0) {
+				$ticket_with_reservations->decrease_reserved($reserved_qty);
+				$ticket_with_reservations->save();
+				$total_tickets_released += $reserved_qty;
+			}
+		}
+		return $total_tickets_released;
+	}
+
+
+
+	private static function get_reserved_tickets_for_line_item(EE_Line_Item $total_line_item)
+	{
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets = array();
+		$ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if ($ticket_line_item instanceof EE_Line_Item) {
+				$valid_reserved_tickets[] = $ticket_line_item;
+			}
+		}
+		return $valid_reserved_tickets;
+	}
 
 }
 // End of file EED_Ticket_Sales_Monitor.module.php