eventespresso / event-espresso-core

core/EE_System.core.php

Spacing +10 added lines, -10 removed lines

@@ -261,7 +261,7 @@ 
     {
         // set autoloaders for all of the classes implementing EEI_Plugin_API
         // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'plugin_api');
     }
 
 
@@ -295,7 +295,7 @@ 
                 && in_array($_GET['action'], array('activate', 'activate-selected'), true)
             )
         ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
+            include_once EE_THIRD_PARTY.'wp-api-basic-auth'.DS.'basic-auth.php';
         }
         do_action('AHEE__EE_System__load_espresso_addons__complete');
     }
@@ -781,7 +781,7 @@ 
     private function _parse_model_names()
     {
         //get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
+        $models = glob(EE_MODELS.'*.model.php');
         $model_names = array();
         $non_abstract_db_models = array();
         foreach ($models as $model) {
@@ -809,8 +809,8 @@ 
      */
     private function _maybe_brew_regular()
     {
-        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
+        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH.'brewing_regular.php')) {
+            require_once EE_CAFF_PATH.'brewing_regular.php';
         }
     }
 
@@ -860,8 +860,8 @@ 
                 'event_espresso');
             $msg .= '<ul>';
             foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
-                        $class_name) . '</b></li>';
+                $msg .= '<li><b>Event Espresso - '.str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
+                        $class_name).'</b></li>';
             }
             $msg .= '</ul>';
             $msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
@@ -1016,8 +1016,8 @@ 
         $this->registry->load_core('Session');
         do_action('AHEE__EE_System__core_loaded_and_ready');
         // load_espresso_template_tags
-        if (is_readable(EE_PUBLIC . 'template_tags.php')) {
-            require_once(EE_PUBLIC . 'template_tags.php');
+        if (is_readable(EE_PUBLIC.'template_tags.php')) {
+            require_once(EE_PUBLIC.'template_tags.php');
         }
         do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
         $this->registry->create('EventEspresso\core\services\assets\Registry', array(), true);
@@ -1163,7 +1163,7 @@ 
             'href'  => $events_admin_url,
             'meta'  => array(
                 'title' => __('Event Espresso', 'event_espresso'),
-                'class' => $menu_class . 'first',
+                'class' => $menu_class.'first',
             ),
         ));
         //Events

Indentation +1501 added lines, -1501 removed lines

@@ -7,7 +7,7 @@ 
 
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -24,1506 +24,1506 @@ 
 {
 
 
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-
-    /**
-     * @var EE_System $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int $_req_type
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean $_major_version_change
-     */
-    private $_major_version_change = false;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param  EE_Registry $Registry
-     * @return EE_System
-     */
-    public static function instance(EE_Registry $Registry = null)
-    {
-        // check if class object is instantiated
-        if ( ! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($Registry);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset()
-    {
-        self::$_instance->_req_type = null;
-        //make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        //we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-
-    /**
-     *    sets hooks for running rest of system
-     *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     *    starting EE Addons from any other point may lead to problems
-     *
-     * @access private
-     * @param  EE_Registry $Registry
-     */
-    private function __construct(EE_Registry $Registry)
-    {
-        $this->registry = $Registry;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCapabilities'),
-            5
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCommandBus'),
-            7
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadPluginApi'),
-            9
-        );
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'load_espresso_addons')
-        );
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
-        // detect whether install or upgrade
-        add_action(
-            'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
-            array($this, 'detect_activations_or_upgrades'),
-            3
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'load_core_configuration'),
-            5
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_modules_and_widgets'),
-            7
-        );
-        // you wanna get going? I wanna get going... let's get going!
-        add_action(
-            'AHEE__EE_Bootstrap__brew_espresso',
-            array($this, 'brew_espresso'),
-            9
-        );
-        //other housekeeping
-        //exclude EE critical pages from wp_list_pages
-        add_filter(
-            'wp_list_pages_excludes',
-            array($this, 'remove_pages_from_wp_list_pages'),
-            10
-        );
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-
-    /**
-     * load and setup EE_Capabilities
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCapabilities()
-    {
-        $this->registry->load_core('EE_Capabilities');
-        add_action(
-            'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function() {
-                EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            }
-        );
-    }
-
-
-
-    /**
-     * create and cache the CommandBus, and also add middleware
-     * The CapChecker middleware requires the use of EE_Capabilities
-     * which is why we need to load the CommandBus after Caps are set up
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCommandBus()
-    {
-        $this->registry->create(
-            'CommandBusInterface',
-            array(
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    array(
-                        $this->registry->create('CapChecker'),
-                        $this->registry->create('AddActionHook'),
-                    )
-                ),
-            ),
-            true
-        );
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadPluginApi()
-    {
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-    }
-
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hook point
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     */
-    public function load_espresso_addons()
-    {
-        do_action('AHEE__EE_System__load_espresso_addons');
-        //if the WP API basic auth plugin isn't already loaded, load it now.
-        //We want it for mobile apps. Just include the entire plugin
-        //also, don't load the basic auth when a plugin is getting activated, because
-        //it could be the basic auth plugin, and it doesn't check if its methods are already defined
-        //and causes a fatal error
-        if (
-            ! (isset($_GET['activate']) && $_GET['activate'] === 'true')
-            && ! function_exists('json_basic_auth_handler')
-            && ! function_exists('json_basic_auth_error')
-            && ! (
-                isset($_GET['action'])
-                && in_array($_GET['action'], array('activate', 'activate-selected'), true)
-            )
-        ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
-        }
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
-    }
-
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        //first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            //detect teh request type for that addon
-            $addon->detect_activation_or_upgrade();
-        }
-    }
-
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // load M-Mode class
-        $this->registry->load_core('Maintenance_Mode');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type = $this->detect_req_type($espresso_db_update);
-        //EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                //migrations may be required now that we've upgraded
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                //				echo "done upgrade";die;
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                //its possible migrations are no longer required
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                //				$this->_maybe_redirect_to_ee_about();
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    protected function _handle_core_version_change($espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        //get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required'));
-    }
-
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param mixed $espresso_db_update the value of the WordPress option.
-     *                                            If not supplied, fetches it from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null)
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if ( ! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if ( ! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = array();
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = array($espresso_db_update => array());
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = array();
-            //if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    //the key is an int, and the value IS NOT an array
-                    //so it must be numerically-indexed, where values are versions installed...
-                    //fix it!
-                    $version_string = $should_be_array;
-                    $corrected_db_update[$version_string] = array('unknown-date');
-                } else {
-                    //ok it checks out
-                    $corrected_db_update[$should_be_version_string] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return $espresso_db_update;
-    }
-
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     * @throws EE_Error
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        //only initialize system if we're not in maintenance mode.
-        if (EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            update_option('ee_flush_rewrite_rules', true);
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if ($request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
-        }
-    }
-
-
-
-    /**
-     * Initializes the db for all registered addons
-     *
-     * @throws EE_Error
-     */
-    public function initialize_addons()
-    {
-        //foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            $addon->initialize_db_if_no_migrations_required();
-        }
-    }
-
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param    array  $version_history
-     * @param    string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
-    {
-        if ( ! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null)
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type = EE_System::detect_req_type_given_activation_history($espresso_db_update,
-                'ee_espresso_activation', espresso_version());
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-        }
-        return $this->_req_type;
-    }
-
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    protected function _detect_major_version_change($activation_history)
-    {
-        $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts = explode('.', espresso_version());
-        return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
-               && ($previous_version_parts[0] !== $current_version_parts[0]
-                   || $previous_version_parts[1] !== $current_version_parts[1]
-               );
-    }
-
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change()
-    {
-        return $this->_major_version_change;
-    }
-
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_*
-     */
-    public static function detect_req_type_given_activation_history(
-        $activation_history_for_addon,
-        $activation_indicator_option_name,
-        $version_to_upgrade_to
-    ) {
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
-        if ($activation_history_for_addon) {
-            //it exists, so this isn't a completely new install
-            //check if this version already in that list of previously installed versions
-            if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
-                //it a version we haven't seen before
-                if ($version_is_higher === 1) {
-                    $req_type = EE_System::req_type_upgrade;
-                } else {
-                    $req_type = EE_System::req_type_downgrade;
-                }
-                delete_option($activation_indicator_option_name);
-            } else {
-                // its not an update. maybe a reactivation?
-                if (get_option($activation_indicator_option_name, false)) {
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        //we've seen this version before, but it's an activation. must be a reactivation
-                        $req_type = EE_System::req_type_reactivation;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                    delete_option($activation_indicator_option_name);
-                } else {
-                    //we've seen this version before and the activation indicate doesn't show it was just activated
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        //we've seen this version before and it's not an activation. its normal request
-                        $req_type = EE_System::req_type_normal;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                }
-            }
-        } else {
-            //brand new install
-            $req_type = EE_System::req_type_new_activation;
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
-     *                                             sometimes containing 'unknown-date'
-     * @param string $version_to_upgrade_to        (current version)
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
-    {
-        //find the most recently-activated version
-        $most_recently_active_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
-        return version_compare($version_to_upgrade_to, $most_recently_active_version);
-    }
-
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    protected static function _get_most_recently_active_version_from_activation_history($activation_history)
-    {
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $times_activated) {
-                //check there is a record of when this version was activated. Otherwise,
-                //mark it as unknown
-                if ( ! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if ($an_activation !== 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
-                        $most_recently_active_version = $version;
-                        $most_recently_active_version_activation = $an_activation === 'unknown-date'
-                            ? '1970-01-01 00:00:00' : $an_activation;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        //if current user is an admin and it's not an ajax or rest request
-        if (
-            ! (defined('DOING_AJAX') && DOING_AJAX)
-            && ! (defined('REST_REQUEST') && REST_REQUEST)
-            && ! isset($notices['errors'])
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = array('page' => 'espresso_about');
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            wp_safe_redirect($url);
-            exit();
-        }
-    }
-
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     * @throws \ReflectionException
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->registry->load_core('EE_Load_Textdomain');
-        //load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load and setup EE_Config and EE_Network_Config
-        $this->registry->load_core('Config');
-        $this->registry->load_core('Network_Config');
-        // setup autoloaders
-        // enable logging?
-        if ($this->registry->CFG->admin->use_full_logging) {
-            $this->registry->load_core('Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        //load caf stuff a chance to play during the activation process too.
-        $this->_maybe_brew_regular();
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _parse_model_names()
-    {
-        //get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
-        $model_names = array();
-        $non_abstract_db_models = array();
-        foreach ($models as $model) {
-            // get model classname
-            $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[$short_name] = $classname;
-            }
-            $model_names[$short_name] = $classname;
-        }
-        $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models);
-    }
-
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     */
-    private function _maybe_brew_regular()
-    {
-        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-        }
-    }
-
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        try {
-            // load, register, and add shortcodes the new way
-            LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\services\shortcodes\ShortcodesManager',
-                array(
-                    // and the old way, but we'll put it under control of the new system
-                    EE_Config::getLegacyShortcodesManager()
-                )
-            );
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hook point
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
-        if ( ! empty($class_names)) {
-            $msg = __('The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso');
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
-                        $class_name) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso');
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
-        add_action('init', array($this, 'load_controllers'), 7);
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
-        add_action('init', array($this, 'initialize'), 10);
-        add_action('init', array($this, 'initialize_last'), 100);
-        add_action('admin_bar_menu', array($this, 'espresso_toolbar_items'), 100);
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
-            // pew pew pew
-            $this->registry->load_core('PUE');
-            do_action('AHEE__EE_System__brew_espresso__after_pue_init');
-        }
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-        //caps need to be initialized on every request so that capability maps are set.
-        //@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-    }
-
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if ( ! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', array());
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        unset($_GET['activate']);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        //first check if we had previously attempted to setup EE's directories but failed
-        if (EEH_Activation::upload_directories_incomplete()) {
-            EEH_Activation::create_upload_directories();
-        }
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-
-    /**
-     *    load_CPTs_and_session
-     *
-     * @access public
-     * @return    void
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        // register Custom Post Types
-        $this->registry->load_core('Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        // let's get it started
-        if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-            $this->registry->load_core('Front_Controller');
-        } else if ( ! EE_FRONT_AJAX) {
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-            EE_Registry::instance()->load_core('Admin');
-        }
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     */
-    public function core_loaded_and_ready()
-    {
-        $this->registry->load_core('Session');
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        // load_espresso_template_tags
-        if (is_readable(EE_PUBLIC . 'template_tags.php')) {
-            require_once(EE_PUBLIC . 'template_tags.php');
-        }
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-        $this->registry->create('EventEspresso\core\services\assets\Registry', array(), true);
-    }
-
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-    }
-
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize_last()
-    {
-        do_action('AHEE__EE_System__initialize_last');
-    }
-
-
-
-    /**
-     * set_hooks_for_shortcodes_modules_and_addons
-     * this is the best place for other systems to set callbacks for hooking into other parts of EE
-     * this happens at the very beginning of the wp_loaded hook point
-     *
-     * @access public
-     * @return void
-     */
-    public function set_hooks_for_shortcodes_modules_and_addons()
-    {
-        //		do_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons' );
-    }
-
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if ( ! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if ( ! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if ( ! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers)
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-
-    /**
-     *    espresso_toolbar_items
-     *
-     * @access public
-     * @param  WP_Admin_Bar $admin_bar
-     * @return void
-     */
-    public function espresso_toolbar_items(WP_Admin_Bar $admin_bar)
-    {
-        // if in full M-Mode, or its an AJAX request, or user is NOT an admin
-        if (
-            defined('DOING_AJAX')
-            || ! $this->registry->CAP->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
-            || EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
-        ) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $menu_class = 'espresso_menu_item_class';
-        //we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
-        //because they're only defined in each of their respective constructors
-        //and this might be a frontend request, in which case they aren't available
-        $events_admin_url = admin_url('admin.php?page=espresso_events');
-        $reg_admin_url = admin_url('admin.php?page=espresso_registrations');
-        $extensions_admin_url = admin_url('admin.php?page=espresso_packages');
-        //Top Level
-        $admin_bar->add_menu(array(
-            'id'    => 'espresso-toolbar',
-            'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
-                       . _x('Event Espresso', 'admin bar menu group label', 'event_espresso')
-                       . '</span>',
-            'href'  => $events_admin_url,
-            'meta'  => array(
-                'title' => __('Event Espresso', 'event_espresso'),
-                'class' => $menu_class . 'first',
-            ),
-        ));
-        //Events
-        if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events')) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events',
-                'parent' => 'espresso-toolbar',
-                'title'  => __('Events', 'event_espresso'),
-                'href'   => $events_admin_url,
-                'meta'   => array(
-                    'title'  => __('Events', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_edit_events', 'ee_admin_bar_menu_espresso-toolbar-events-new')) {
-            //Events Add New
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-new',
-                'parent' => 'espresso-toolbar-events',
-                'title'  => __('Add New', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'create_new'), $events_admin_url),
-                'meta'   => array(
-                    'title'  => __('Add New', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if (is_single() && (get_post_type() === 'espresso_events')) {
-            //Current post
-            global $post;
-            if ($this->registry->CAP->current_user_can('ee_edit_event',
-                'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID)
-            ) {
-                //Events Edit Current Event
-                $admin_bar->add_menu(array(
-                    'id'     => 'espresso-toolbar-events-edit',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => __('Edit Event', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'edit', 'post' => $post->ID),
-                        $events_admin_url),
-                    'meta'   => array(
-                        'title'  => __('Edit Event', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $menu_class,
-                    ),
-                ));
-            }
-        }
-        //Events View
-        if ($this->registry->CAP->current_user_can('ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-view')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-view',
-                'parent' => 'espresso-toolbar-events',
-                'title'  => __('View', 'event_espresso'),
-                'href'   => $events_admin_url,
-                'meta'   => array(
-                    'title'  => __('View', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events-all')) {
-            //Events View All
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-all',
-                'parent' => 'espresso-toolbar-events-view',
-                'title'  => __('All', 'event_espresso'),
-                'href'   => $events_admin_url,
-                'meta'   => array(
-                    'title'  => __('All', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-today')
-        ) {
-            //Events View Today
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-today',
-                'parent' => 'espresso-toolbar-events-view',
-                'title'  => __('Today', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
-                    $events_admin_url),
-                'meta'   => array(
-                    'title'  => __('Today', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-month')
-        ) {
-            //Events View This Month
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-month',
-                'parent' => 'espresso-toolbar-events-view',
-                'title'  => __('This Month', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
-                    $events_admin_url),
-                'meta'   => array(
-                    'title'  => __('This Month', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations',
-                'parent' => 'espresso-toolbar',
-                'title'  => __('Registrations', 'event_espresso'),
-                'href'   => $reg_admin_url,
-                'meta'   => array(
-                    'title'  => __('Registrations', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today',
-                'parent' => 'espresso-toolbar-registrations',
-                'title'  => __('Today', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
-                    $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Today', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Completed
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-approved',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'today',
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Pending\
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-pending',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Pending', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'     => 'default',
-                    'status'     => 'today',
-                    'reg_status' => EEM_Registration::status_id_pending_payment,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Pending Payment', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Incomplete
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-not-approved',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Not Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'today',
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Not Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Incomplete
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-cancelled',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Cancelled', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'today',
-                    '_reg_status' => EEM_Registration::status_id_cancelled,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Cancelled', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month',
-                'parent' => 'espresso-toolbar-registrations',
-                'title'  => __('This Month', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
-                    $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('This Month', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Approved
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-approved',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Pending
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-pending',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Pending', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Pending', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Not Approved
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-not-approved',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Not Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Not Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Cancelled
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-cancelled',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Cancelled', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_cancelled,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Cancelled', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Extensions & Services
-        if ($this->registry->CAP->current_user_can('ee_read_ee',
-            'ee_admin_bar_menu_espresso-toolbar-extensions-and-services')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-extensions-and-services',
-                'parent' => 'espresso-toolbar',
-                'title'  => __('Extensions & Services', 'event_espresso'),
-                'href'   => $extensions_admin_url,
-                'meta'   => array(
-                    'title'  => __('Extensions & Services', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-    }
-
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param  array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages($exclude_array)
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+
+	/**
+	 * @var EE_System $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int $_req_type
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean $_major_version_change
+	 */
+	private $_major_version_change = false;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param  EE_Registry $Registry
+	 * @return EE_System
+	 */
+	public static function instance(EE_Registry $Registry = null)
+	{
+		// check if class object is instantiated
+		if ( ! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($Registry);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset()
+	{
+		self::$_instance->_req_type = null;
+		//make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		//we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+
+	/**
+	 *    sets hooks for running rest of system
+	 *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 *    starting EE Addons from any other point may lead to problems
+	 *
+	 * @access private
+	 * @param  EE_Registry $Registry
+	 */
+	private function __construct(EE_Registry $Registry)
+	{
+		$this->registry = $Registry;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCapabilities'),
+			5
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCommandBus'),
+			7
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadPluginApi'),
+			9
+		);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'load_espresso_addons')
+		);
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
+		// detect whether install or upgrade
+		add_action(
+			'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
+			array($this, 'detect_activations_or_upgrades'),
+			3
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'load_core_configuration'),
+			5
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_modules_and_widgets'),
+			7
+		);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action(
+			'AHEE__EE_Bootstrap__brew_espresso',
+			array($this, 'brew_espresso'),
+			9
+		);
+		//other housekeeping
+		//exclude EE critical pages from wp_list_pages
+		add_filter(
+			'wp_list_pages_excludes',
+			array($this, 'remove_pages_from_wp_list_pages'),
+			10
+		);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+
+	/**
+	 * load and setup EE_Capabilities
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCapabilities()
+	{
+		$this->registry->load_core('EE_Capabilities');
+		add_action(
+			'AHEE__EE_Capabilities__init_caps__before_initialization',
+			function() {
+				EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			}
+		);
+	}
+
+
+
+	/**
+	 * create and cache the CommandBus, and also add middleware
+	 * The CapChecker middleware requires the use of EE_Capabilities
+	 * which is why we need to load the CommandBus after Caps are set up
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCommandBus()
+	{
+		$this->registry->create(
+			'CommandBusInterface',
+			array(
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					array(
+						$this->registry->create('CapChecker'),
+						$this->registry->create('AddActionHook'),
+					)
+				),
+			),
+			true
+		);
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadPluginApi()
+	{
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+	}
+
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hook point
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function load_espresso_addons()
+	{
+		do_action('AHEE__EE_System__load_espresso_addons');
+		//if the WP API basic auth plugin isn't already loaded, load it now.
+		//We want it for mobile apps. Just include the entire plugin
+		//also, don't load the basic auth when a plugin is getting activated, because
+		//it could be the basic auth plugin, and it doesn't check if its methods are already defined
+		//and causes a fatal error
+		if (
+			! (isset($_GET['activate']) && $_GET['activate'] === 'true')
+			&& ! function_exists('json_basic_auth_handler')
+			&& ! function_exists('json_basic_auth_error')
+			&& ! (
+				isset($_GET['action'])
+				&& in_array($_GET['action'], array('activate', 'activate-selected'), true)
+			)
+		) {
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
+		}
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
+	}
+
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		//first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			//detect teh request type for that addon
+			$addon->detect_activation_or_upgrade();
+		}
+	}
+
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// load M-Mode class
+		$this->registry->load_core('Maintenance_Mode');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type = $this->detect_req_type($espresso_db_update);
+		//EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				//migrations may be required now that we've upgraded
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				//				echo "done upgrade";die;
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				//its possible migrations are no longer required
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				//				$this->_maybe_redirect_to_ee_about();
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	protected function _handle_core_version_change($espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		//get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required'));
+	}
+
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param mixed $espresso_db_update the value of the WordPress option.
+	 *                                            If not supplied, fetches it from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null)
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if ( ! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if ( ! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = array();
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = array($espresso_db_update => array());
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = array();
+			//if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					//the key is an int, and the value IS NOT an array
+					//so it must be numerically-indexed, where values are versions installed...
+					//fix it!
+					$version_string = $should_be_array;
+					$corrected_db_update[$version_string] = array('unknown-date');
+				} else {
+					//ok it checks out
+					$corrected_db_update[$should_be_version_string] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return $espresso_db_update;
+	}
+
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		//only initialize system if we're not in maintenance mode.
+		if (EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			update_option('ee_flush_rewrite_rules', true);
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if ($request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
+		}
+	}
+
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 *
+	 * @throws EE_Error
+	 */
+	public function initialize_addons()
+	{
+		//foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			$addon->initialize_db_if_no_migrations_required();
+		}
+	}
+
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param    array  $version_history
+	 * @param    string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
+	{
+		if ( ! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null)
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type = EE_System::detect_req_type_given_activation_history($espresso_db_update,
+				'ee_espresso_activation', espresso_version());
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+		}
+		return $this->_req_type;
+	}
+
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	protected function _detect_major_version_change($activation_history)
+	{
+		$previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts = explode('.', espresso_version());
+		return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
+			   && ($previous_version_parts[0] !== $current_version_parts[0]
+				   || $previous_version_parts[1] !== $current_version_parts[1]
+			   );
+	}
+
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change()
+	{
+		return $this->_major_version_change;
+	}
+
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_*
+	 */
+	public static function detect_req_type_given_activation_history(
+		$activation_history_for_addon,
+		$activation_indicator_option_name,
+		$version_to_upgrade_to
+	) {
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
+		if ($activation_history_for_addon) {
+			//it exists, so this isn't a completely new install
+			//check if this version already in that list of previously installed versions
+			if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
+				//it a version we haven't seen before
+				if ($version_is_higher === 1) {
+					$req_type = EE_System::req_type_upgrade;
+				} else {
+					$req_type = EE_System::req_type_downgrade;
+				}
+				delete_option($activation_indicator_option_name);
+			} else {
+				// its not an update. maybe a reactivation?
+				if (get_option($activation_indicator_option_name, false)) {
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						//we've seen this version before, but it's an activation. must be a reactivation
+						$req_type = EE_System::req_type_reactivation;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+					delete_option($activation_indicator_option_name);
+				} else {
+					//we've seen this version before and the activation indicate doesn't show it was just activated
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						//we've seen this version before and it's not an activation. its normal request
+						$req_type = EE_System::req_type_normal;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+				}
+			}
+		} else {
+			//brand new install
+			$req_type = EE_System::req_type_new_activation;
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
+	 *                                             sometimes containing 'unknown-date'
+	 * @param string $version_to_upgrade_to        (current version)
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
+	{
+		//find the most recently-activated version
+		$most_recently_active_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
+		return version_compare($version_to_upgrade_to, $most_recently_active_version);
+	}
+
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	protected static function _get_most_recently_active_version_from_activation_history($activation_history)
+	{
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $times_activated) {
+				//check there is a record of when this version was activated. Otherwise,
+				//mark it as unknown
+				if ( ! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if ($an_activation !== 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
+						$most_recently_active_version = $version;
+						$most_recently_active_version_activation = $an_activation === 'unknown-date'
+							? '1970-01-01 00:00:00' : $an_activation;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		//if current user is an admin and it's not an ajax or rest request
+		if (
+			! (defined('DOING_AJAX') && DOING_AJAX)
+			&& ! (defined('REST_REQUEST') && REST_REQUEST)
+			&& ! isset($notices['errors'])
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = array('page' => 'espresso_about');
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			wp_safe_redirect($url);
+			exit();
+		}
+	}
+
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 * @throws \ReflectionException
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->registry->load_core('EE_Load_Textdomain');
+		//load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load and setup EE_Config and EE_Network_Config
+		$this->registry->load_core('Config');
+		$this->registry->load_core('Network_Config');
+		// setup autoloaders
+		// enable logging?
+		if ($this->registry->CFG->admin->use_full_logging) {
+			$this->registry->load_core('Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		//load caf stuff a chance to play during the activation process too.
+		$this->_maybe_brew_regular();
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _parse_model_names()
+	{
+		//get all the files in the EE_MODELS folder that end in .model.php
+		$models = glob(EE_MODELS . '*.model.php');
+		$model_names = array();
+		$non_abstract_db_models = array();
+		foreach ($models as $model) {
+			// get model classname
+			$classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[$short_name] = $classname;
+			}
+			$model_names[$short_name] = $classname;
+		}
+		$this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models);
+	}
+
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 */
+	private function _maybe_brew_regular()
+	{
+		if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+		}
+	}
+
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		try {
+			// load, register, and add shortcodes the new way
+			LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\services\shortcodes\ShortcodesManager',
+				array(
+					// and the old way, but we'll put it under control of the new system
+					EE_Config::getLegacyShortcodesManager()
+				)
+			);
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hook point
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
+		if ( ! empty($class_names)) {
+			$msg = __('The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso');
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
+						$class_name) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso');
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
+		add_action('init', array($this, 'load_controllers'), 7);
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
+		add_action('init', array($this, 'initialize'), 10);
+		add_action('init', array($this, 'initialize_last'), 100);
+		add_action('admin_bar_menu', array($this, 'espresso_toolbar_items'), 100);
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
+			// pew pew pew
+			$this->registry->load_core('PUE');
+			do_action('AHEE__EE_System__brew_espresso__after_pue_init');
+		}
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+		//caps need to be initialized on every request so that capability maps are set.
+		//@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+	}
+
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', array());
+		if ( ! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', array());
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						unset($_GET['activate']);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		//first check if we had previously attempted to setup EE's directories but failed
+		if (EEH_Activation::upload_directories_incomplete()) {
+			EEH_Activation::create_upload_directories();
+		}
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+
+	/**
+	 *    load_CPTs_and_session
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		// register Custom Post Types
+		$this->registry->load_core('Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		// let's get it started
+		if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+			$this->registry->load_core('Front_Controller');
+		} else if ( ! EE_FRONT_AJAX) {
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+			EE_Registry::instance()->load_core('Admin');
+		}
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function core_loaded_and_ready()
+	{
+		$this->registry->load_core('Session');
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		// load_espresso_template_tags
+		if (is_readable(EE_PUBLIC . 'template_tags.php')) {
+			require_once(EE_PUBLIC . 'template_tags.php');
+		}
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+		$this->registry->create('EventEspresso\core\services\assets\Registry', array(), true);
+	}
+
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+	}
+
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize_last()
+	{
+		do_action('AHEE__EE_System__initialize_last');
+	}
+
+
+
+	/**
+	 * set_hooks_for_shortcodes_modules_and_addons
+	 * this is the best place for other systems to set callbacks for hooking into other parts of EE
+	 * this happens at the very beginning of the wp_loaded hook point
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_hooks_for_shortcodes_modules_and_addons()
+	{
+		//		do_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons' );
+	}
+
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if ( ! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if ( ! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if ( ! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers)
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+
+	/**
+	 *    espresso_toolbar_items
+	 *
+	 * @access public
+	 * @param  WP_Admin_Bar $admin_bar
+	 * @return void
+	 */
+	public function espresso_toolbar_items(WP_Admin_Bar $admin_bar)
+	{
+		// if in full M-Mode, or its an AJAX request, or user is NOT an admin
+		if (
+			defined('DOING_AJAX')
+			|| ! $this->registry->CAP->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
+			|| EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
+		) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$menu_class = 'espresso_menu_item_class';
+		//we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
+		//because they're only defined in each of their respective constructors
+		//and this might be a frontend request, in which case they aren't available
+		$events_admin_url = admin_url('admin.php?page=espresso_events');
+		$reg_admin_url = admin_url('admin.php?page=espresso_registrations');
+		$extensions_admin_url = admin_url('admin.php?page=espresso_packages');
+		//Top Level
+		$admin_bar->add_menu(array(
+			'id'    => 'espresso-toolbar',
+			'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
+					   . _x('Event Espresso', 'admin bar menu group label', 'event_espresso')
+					   . '</span>',
+			'href'  => $events_admin_url,
+			'meta'  => array(
+				'title' => __('Event Espresso', 'event_espresso'),
+				'class' => $menu_class . 'first',
+			),
+		));
+		//Events
+		if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events')) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events',
+				'parent' => 'espresso-toolbar',
+				'title'  => __('Events', 'event_espresso'),
+				'href'   => $events_admin_url,
+				'meta'   => array(
+					'title'  => __('Events', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_edit_events', 'ee_admin_bar_menu_espresso-toolbar-events-new')) {
+			//Events Add New
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-new',
+				'parent' => 'espresso-toolbar-events',
+				'title'  => __('Add New', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'create_new'), $events_admin_url),
+				'meta'   => array(
+					'title'  => __('Add New', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if (is_single() && (get_post_type() === 'espresso_events')) {
+			//Current post
+			global $post;
+			if ($this->registry->CAP->current_user_can('ee_edit_event',
+				'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID)
+			) {
+				//Events Edit Current Event
+				$admin_bar->add_menu(array(
+					'id'     => 'espresso-toolbar-events-edit',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => __('Edit Event', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'edit', 'post' => $post->ID),
+						$events_admin_url),
+					'meta'   => array(
+						'title'  => __('Edit Event', 'event_espresso'),
+						'target' => '',
+						'class'  => $menu_class,
+					),
+				));
+			}
+		}
+		//Events View
+		if ($this->registry->CAP->current_user_can('ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-view')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-view',
+				'parent' => 'espresso-toolbar-events',
+				'title'  => __('View', 'event_espresso'),
+				'href'   => $events_admin_url,
+				'meta'   => array(
+					'title'  => __('View', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events-all')) {
+			//Events View All
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-all',
+				'parent' => 'espresso-toolbar-events-view',
+				'title'  => __('All', 'event_espresso'),
+				'href'   => $events_admin_url,
+				'meta'   => array(
+					'title'  => __('All', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-today')
+		) {
+			//Events View Today
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-today',
+				'parent' => 'espresso-toolbar-events-view',
+				'title'  => __('Today', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
+					$events_admin_url),
+				'meta'   => array(
+					'title'  => __('Today', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-month')
+		) {
+			//Events View This Month
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-month',
+				'parent' => 'espresso-toolbar-events-view',
+				'title'  => __('This Month', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
+					$events_admin_url),
+				'meta'   => array(
+					'title'  => __('This Month', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations',
+				'parent' => 'espresso-toolbar',
+				'title'  => __('Registrations', 'event_espresso'),
+				'href'   => $reg_admin_url,
+				'meta'   => array(
+					'title'  => __('Registrations', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today',
+				'parent' => 'espresso-toolbar-registrations',
+				'title'  => __('Today', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
+					$reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Today', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Completed
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-approved',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'today',
+					'_reg_status' => EEM_Registration::status_id_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Pending\
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-pending',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Pending', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'     => 'default',
+					'status'     => 'today',
+					'reg_status' => EEM_Registration::status_id_pending_payment,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Pending Payment', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Incomplete
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-not-approved',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Not Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'today',
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Not Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Incomplete
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-cancelled',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Cancelled', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'today',
+					'_reg_status' => EEM_Registration::status_id_cancelled,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Cancelled', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month',
+				'parent' => 'espresso-toolbar-registrations',
+				'title'  => __('This Month', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
+					$reg_admin_url),
+				'meta'   => array(
+					'title'  => __('This Month', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Approved
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-approved',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Pending
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-pending',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Pending', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Pending', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Not Approved
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-not-approved',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Not Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Not Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Cancelled
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-cancelled',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Cancelled', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_cancelled,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Cancelled', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Extensions & Services
+		if ($this->registry->CAP->current_user_can('ee_read_ee',
+			'ee_admin_bar_menu_espresso-toolbar-extensions-and-services')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-extensions-and-services',
+				'parent' => 'espresso-toolbar',
+				'title'  => __('Extensions & Services', 'event_espresso'),
+				'href'   => $extensions_admin_url,
+				'meta'   => array(
+					'title'  => __('Extensions & Services', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+	}
+
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages($exclude_array)
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
 
 
 

admin_pages/events/Events_Admin_Page.core.php

Indentation +2689 added lines, -2689 removed lines

@@ -15,2696 +15,2696 @@
 class Events_Admin_Page extends EE_Admin_Page_CPT
 {
 
-    /**
-     * This will hold the event object for event_details screen.
-     *
-     * @access protected
-     * @var EE_Event $_event
-     */
-    protected $_event;
-
-
-    /**
-     * This will hold the category object for category_details screen.
-     *
-     * @var stdClass $_category
-     */
-    protected $_category;
-
-
-    /**
-     * This will hold the event model instance
-     *
-     * @var EEM_Event $_event_model
-     */
-    protected $_event_model;
-
-
-
-    /**
-     * @var EE_Event
-     */
-    protected $_cpt_model_obj = false;
-
-
-    /**
-     * Initialize page props for this admin page group.
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug = EVENTS_PG_SLUG;
-        $this->page_label = EVENTS_LABEL;
-        $this->_admin_base_url = EVENTS_ADMIN_URL;
-        $this->_admin_base_path = EVENTS_ADMIN;
-        $this->_cpt_model_names = array(
-            'create_new' => 'EEM_Event',
-            'edit'       => 'EEM_Event',
-        );
-        $this->_cpt_edit_routes = array(
-            'espresso_events' => 'edit',
-        );
-        add_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            array($this, 'verify_event_edit'), 10, 2
-        );
-    }
-
-
-    /**
-     * Sets the ajax hooks used for this admin page group.
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_ee_save_timezone_setting', array($this, 'save_timezonestring_setting'));
-    }
-
-
-    /**
-     * Sets the page properties for this admin page group.
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = EVENTS_LABEL;
-        $this->_labels = array(
-            'buttons'      => array(
-                'add'             => esc_html__('Add New Event', 'event_espresso'),
-                'edit'            => esc_html__('Edit Event', 'event_espresso'),
-                'delete'          => esc_html__('Delete Event', 'event_espresso'),
-                'add_category'    => esc_html__('Add New Category', 'event_espresso'),
-                'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
-                'delete_category' => esc_html__('Delete Category', 'event_espresso'),
-            ),
-            'editor_title' => array(
-                'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
-            ),
-            'publishbox'   => array(
-                'create_new'        => esc_html__('Save New Event', 'event_espresso'),
-                'edit'              => esc_html__('Update Event', 'event_espresso'),
-                'add_category'      => esc_html__('Save New Category', 'event_espresso'),
-                'edit_category'     => esc_html__('Update Category', 'event_espresso'),
-                'template_settings' => esc_html__('Update Settings', 'event_espresso'),
-            ),
-        );
-    }
-
-
-    /**
-     * Sets the page routes property for this admin page group.
-     */
-    protected function _set_page_routes()
-    {
-        //load formatter helper
-        //load field generator helper
-        //is there a evt_id in the request?
-        $evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
-            ? $this->_req_data['EVT_ID']
-            : 0;
-        $evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
-        $this->_page_routes = array(
-            'default'                       => array(
-                'func'       => '_events_overview_list_table',
-                'capability' => 'ee_read_events',
-            ),
-            'create_new'                    => array(
-                'func'       => '_create_new_cpt_item',
-                'capability' => 'ee_edit_events',
-            ),
-            'edit'                          => array(
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $evt_id,
-            ),
-            'copy_event'                    => array(
-                'func'       => '_copy_events',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'trash_event'                   => array(
-                'func'       => '_trash_or_restore_event',
-                'args'       => array('event_status' => 'trash'),
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'trash_events'                  => array(
-                'func'       => '_trash_or_restore_events',
-                'args'       => array('event_status' => 'trash'),
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ),
-            'restore_event'                 => array(
-                'func'       => '_trash_or_restore_event',
-                'args'       => array('event_status' => 'draft'),
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'restore_events'                => array(
-                'func'       => '_trash_or_restore_events',
-                'args'       => array('event_status' => 'draft'),
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ),
-            'delete_event'                  => array(
-                'func'       => '_delete_event',
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'delete_events'                 => array(
-                'func'       => '_delete_events',
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ),
-            'view_report'                   => array(
-                'func'      => '_view_report',
-                'capablity' => 'ee_edit_events',
-            ),
-            'default_event_settings'        => array(
-                'func'       => '_default_event_settings',
-                'capability' => 'manage_options',
-            ),
-            'update_default_event_settings' => array(
-                'func'       => '_update_default_event_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'template_settings'             => array(
-                'func'       => '_template_settings',
-                'capability' => 'manage_options',
-            ),
-            //event category tab related
-            'add_category'                  => array(
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => array('add'),
-            ),
-            'edit_category'                 => array(
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => array('edit'),
-            ),
-            'delete_categories'             => array(
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ),
-            'delete_category'               => array(
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ),
-            'insert_category'               => array(
-                'func'       => '_insert_or_update_category',
-                'args'       => array('new_category' => true),
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ),
-            'update_category'               => array(
-                'func'       => '_insert_or_update_category',
-                'args'       => array('new_category' => false),
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ),
-            'category_list'                 => array(
-                'func'       => '_category_list_table',
-                'capability' => 'ee_manage_event_categories',
-            ),
-        );
-    }
-
-
-    /**
-     * Set the _page_config property for this admin page group.
-     */
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'                => array(
-                'nav'           => array(
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'order' => 10,
-                ),
-                'list_table'    => 'Events_Admin_List_Table',
-                'help_tabs'     => array(
-                    'events_overview_help_tab'                       => array(
-                        'title'    => esc_html__('Events Overview', 'event_espresso'),
-                        'filename' => 'events_overview',
-                    ),
-                    'events_overview_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_overview_table_column_headings',
-                    ),
-                    'events_overview_filters_help_tab'               => array(
-                        'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
-                        'filename' => 'events_overview_filters',
-                    ),
-                    'events_overview_view_help_tab'                  => array(
-                        'title'    => esc_html__('Events Overview Views', 'event_espresso'),
-                        'filename' => 'events_overview_views',
-                    ),
-                    'events_overview_other_help_tab'                 => array(
-                        'title'    => esc_html__('Events Overview Other', 'event_espresso'),
-                        'filename' => 'events_overview_other',
-                    ),
-                ),
-                'help_tour'     => array(
-                    'Event_Overview_Help_Tour',
-                    //'New_Features_Test_Help_Tour' for testing multiple help tour
-                ),
-                'qtips'         => array(
-                    'EE_Event_List_Table_Tips',
-                ),
-                'require_nonce' => false,
-            ),
-            'create_new'             => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Event', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array('_register_event_editor_meta_boxes'),
-                'help_tabs'     => array(
-                    'event_editor_help_tab'                            => array(
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ),
-                    'event_editor_title_richtexteditor_help_tab'       => array(
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ),
-                    'event_editor_venue_details_help_tab'              => array(
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ),
-                    'event_editor_event_datetimes_help_tab'            => array(
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ),
-                    'event_editor_event_tickets_help_tab'              => array(
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ),
-                    'event_editor_event_registration_options_help_tab' => array(
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ),
-                    'event_editor_tags_categories_help_tab'            => array(
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ),
-                    'event_editor_questions_registrants_help_tab'      => array(
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ),
-                    'event_editor_save_new_event_help_tab'             => array(
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ),
-                    'event_editor_other_help_tab'                      => array(
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ),
-                ),
-                'help_tour'     => array(
-                    'Event_Editor_Help_Tour',
-                ),
-                'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
-                'require_nonce' => false,
-            ),
-            'edit'                   => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Event', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['post'])
-                        ? EE_Admin_Page::add_query_args_and_nonce(
-                            array('post' => $this->_req_data['post'], 'action' => 'edit'),
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ),
-                'metaboxes'     => array('_register_event_editor_meta_boxes'),
-                'help_tabs'     => array(
-                    'event_editor_help_tab'                            => array(
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ),
-                    'event_editor_title_richtexteditor_help_tab'       => array(
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ),
-                    'event_editor_venue_details_help_tab'              => array(
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ),
-                    'event_editor_event_datetimes_help_tab'            => array(
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ),
-                    'event_editor_event_tickets_help_tab'              => array(
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ),
-                    'event_editor_event_registration_options_help_tab' => array(
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ),
-                    'event_editor_tags_categories_help_tab'            => array(
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ),
-                    'event_editor_questions_registrants_help_tab'      => array(
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ),
-                    'event_editor_save_new_event_help_tab'             => array(
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ),
-                    'event_editor_other_help_tab'                      => array(
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ),
-                ),
-                /*'help_tour' => array(
+	/**
+	 * This will hold the event object for event_details screen.
+	 *
+	 * @access protected
+	 * @var EE_Event $_event
+	 */
+	protected $_event;
+
+
+	/**
+	 * This will hold the category object for category_details screen.
+	 *
+	 * @var stdClass $_category
+	 */
+	protected $_category;
+
+
+	/**
+	 * This will hold the event model instance
+	 *
+	 * @var EEM_Event $_event_model
+	 */
+	protected $_event_model;
+
+
+
+	/**
+	 * @var EE_Event
+	 */
+	protected $_cpt_model_obj = false;
+
+
+	/**
+	 * Initialize page props for this admin page group.
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug = EVENTS_PG_SLUG;
+		$this->page_label = EVENTS_LABEL;
+		$this->_admin_base_url = EVENTS_ADMIN_URL;
+		$this->_admin_base_path = EVENTS_ADMIN;
+		$this->_cpt_model_names = array(
+			'create_new' => 'EEM_Event',
+			'edit'       => 'EEM_Event',
+		);
+		$this->_cpt_edit_routes = array(
+			'espresso_events' => 'edit',
+		);
+		add_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			array($this, 'verify_event_edit'), 10, 2
+		);
+	}
+
+
+	/**
+	 * Sets the ajax hooks used for this admin page group.
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_ee_save_timezone_setting', array($this, 'save_timezonestring_setting'));
+	}
+
+
+	/**
+	 * Sets the page properties for this admin page group.
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = EVENTS_LABEL;
+		$this->_labels = array(
+			'buttons'      => array(
+				'add'             => esc_html__('Add New Event', 'event_espresso'),
+				'edit'            => esc_html__('Edit Event', 'event_espresso'),
+				'delete'          => esc_html__('Delete Event', 'event_espresso'),
+				'add_category'    => esc_html__('Add New Category', 'event_espresso'),
+				'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
+				'delete_category' => esc_html__('Delete Category', 'event_espresso'),
+			),
+			'editor_title' => array(
+				'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
+			),
+			'publishbox'   => array(
+				'create_new'        => esc_html__('Save New Event', 'event_espresso'),
+				'edit'              => esc_html__('Update Event', 'event_espresso'),
+				'add_category'      => esc_html__('Save New Category', 'event_espresso'),
+				'edit_category'     => esc_html__('Update Category', 'event_espresso'),
+				'template_settings' => esc_html__('Update Settings', 'event_espresso'),
+			),
+		);
+	}
+
+
+	/**
+	 * Sets the page routes property for this admin page group.
+	 */
+	protected function _set_page_routes()
+	{
+		//load formatter helper
+		//load field generator helper
+		//is there a evt_id in the request?
+		$evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
+			? $this->_req_data['EVT_ID']
+			: 0;
+		$evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
+		$this->_page_routes = array(
+			'default'                       => array(
+				'func'       => '_events_overview_list_table',
+				'capability' => 'ee_read_events',
+			),
+			'create_new'                    => array(
+				'func'       => '_create_new_cpt_item',
+				'capability' => 'ee_edit_events',
+			),
+			'edit'                          => array(
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $evt_id,
+			),
+			'copy_event'                    => array(
+				'func'       => '_copy_events',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'trash_event'                   => array(
+				'func'       => '_trash_or_restore_event',
+				'args'       => array('event_status' => 'trash'),
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'trash_events'                  => array(
+				'func'       => '_trash_or_restore_events',
+				'args'       => array('event_status' => 'trash'),
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			),
+			'restore_event'                 => array(
+				'func'       => '_trash_or_restore_event',
+				'args'       => array('event_status' => 'draft'),
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'restore_events'                => array(
+				'func'       => '_trash_or_restore_events',
+				'args'       => array('event_status' => 'draft'),
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			),
+			'delete_event'                  => array(
+				'func'       => '_delete_event',
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'delete_events'                 => array(
+				'func'       => '_delete_events',
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			),
+			'view_report'                   => array(
+				'func'      => '_view_report',
+				'capablity' => 'ee_edit_events',
+			),
+			'default_event_settings'        => array(
+				'func'       => '_default_event_settings',
+				'capability' => 'manage_options',
+			),
+			'update_default_event_settings' => array(
+				'func'       => '_update_default_event_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'template_settings'             => array(
+				'func'       => '_template_settings',
+				'capability' => 'manage_options',
+			),
+			//event category tab related
+			'add_category'                  => array(
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => array('add'),
+			),
+			'edit_category'                 => array(
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => array('edit'),
+			),
+			'delete_categories'             => array(
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			),
+			'delete_category'               => array(
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			),
+			'insert_category'               => array(
+				'func'       => '_insert_or_update_category',
+				'args'       => array('new_category' => true),
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			),
+			'update_category'               => array(
+				'func'       => '_insert_or_update_category',
+				'args'       => array('new_category' => false),
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			),
+			'category_list'                 => array(
+				'func'       => '_category_list_table',
+				'capability' => 'ee_manage_event_categories',
+			),
+		);
+	}
+
+
+	/**
+	 * Set the _page_config property for this admin page group.
+	 */
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'                => array(
+				'nav'           => array(
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'order' => 10,
+				),
+				'list_table'    => 'Events_Admin_List_Table',
+				'help_tabs'     => array(
+					'events_overview_help_tab'                       => array(
+						'title'    => esc_html__('Events Overview', 'event_espresso'),
+						'filename' => 'events_overview',
+					),
+					'events_overview_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'events_overview_table_column_headings',
+					),
+					'events_overview_filters_help_tab'               => array(
+						'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
+						'filename' => 'events_overview_filters',
+					),
+					'events_overview_view_help_tab'                  => array(
+						'title'    => esc_html__('Events Overview Views', 'event_espresso'),
+						'filename' => 'events_overview_views',
+					),
+					'events_overview_other_help_tab'                 => array(
+						'title'    => esc_html__('Events Overview Other', 'event_espresso'),
+						'filename' => 'events_overview_other',
+					),
+				),
+				'help_tour'     => array(
+					'Event_Overview_Help_Tour',
+					//'New_Features_Test_Help_Tour' for testing multiple help tour
+				),
+				'qtips'         => array(
+					'EE_Event_List_Table_Tips',
+				),
+				'require_nonce' => false,
+			),
+			'create_new'             => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Event', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				),
+				'metaboxes'     => array('_register_event_editor_meta_boxes'),
+				'help_tabs'     => array(
+					'event_editor_help_tab'                            => array(
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					),
+					'event_editor_title_richtexteditor_help_tab'       => array(
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					),
+					'event_editor_venue_details_help_tab'              => array(
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					),
+					'event_editor_event_datetimes_help_tab'            => array(
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					),
+					'event_editor_event_tickets_help_tab'              => array(
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					),
+					'event_editor_event_registration_options_help_tab' => array(
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					),
+					'event_editor_tags_categories_help_tab'            => array(
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					),
+					'event_editor_questions_registrants_help_tab'      => array(
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					),
+					'event_editor_save_new_event_help_tab'             => array(
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					),
+					'event_editor_other_help_tab'                      => array(
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					),
+				),
+				'help_tour'     => array(
+					'Event_Editor_Help_Tour',
+				),
+				'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
+				'require_nonce' => false,
+			),
+			'edit'                   => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Event', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['post'])
+						? EE_Admin_Page::add_query_args_and_nonce(
+							array('post' => $this->_req_data['post'], 'action' => 'edit'),
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				),
+				'metaboxes'     => array('_register_event_editor_meta_boxes'),
+				'help_tabs'     => array(
+					'event_editor_help_tab'                            => array(
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					),
+					'event_editor_title_richtexteditor_help_tab'       => array(
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					),
+					'event_editor_venue_details_help_tab'              => array(
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					),
+					'event_editor_event_datetimes_help_tab'            => array(
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					),
+					'event_editor_event_tickets_help_tab'              => array(
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					),
+					'event_editor_event_registration_options_help_tab' => array(
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					),
+					'event_editor_tags_categories_help_tab'            => array(
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					),
+					'event_editor_questions_registrants_help_tab'      => array(
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					),
+					'event_editor_save_new_event_help_tab'             => array(
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					),
+					'event_editor_other_help_tab'                      => array(
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					),
+				),
+				/*'help_tour' => array(
 					'Event_Edit_Help_Tour'
 				),*/
-                'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
-                'require_nonce' => false,
-            ),
-            'default_event_settings' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Default Settings', 'event_espresso'),
-                    'order' => 40,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'labels'        => array(
-                    'publishbox' => esc_html__('Update Settings', 'event_espresso'),
-                ),
-                'help_tabs'     => array(
-                    'default_settings_help_tab'        => array(
-                        'title'    => esc_html__('Default Event Settings', 'event_espresso'),
-                        'filename' => 'events_default_settings',
-                    ),
-                    'default_settings_status_help_tab' => array(
-                        'title'    => esc_html__('Default Registration Status', 'event_espresso'),
-                        'filename' => 'events_default_settings_status',
-                    ),
-                    'default_maximum_tickets_help_tab' => array(
-                        'title' => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
-                        'filename' => 'events_default_settings_max_tickets',
-                    )
-                ),
-                'help_tour'     => array('Event_Default_Settings_Help_Tour'),
-                'require_nonce' => false,
-            ),
-            //template settings
-            'template_settings'      => array(
-                'nav'           => array(
-                    'label' => esc_html__('Templates', 'event_espresso'),
-                    'order' => 30,
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => array(
-                    'general_settings_templates_help_tab' => array(
-                        'title'    => esc_html__('Templates', 'event_espresso'),
-                        'filename' => 'general_settings_templates',
-                    ),
-                ),
-                'help_tour'     => array('Templates_Help_Tour'),
-                'require_nonce' => false,
-            ),
-            //event category stuff
-            'add_category'           => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'help_tabs'     => array(
-                    'add_category_help_tab' => array(
-                        'title'    => esc_html__('Add New Event Category', 'event_espresso'),
-                        'filename' => 'events_add_category',
-                    ),
-                ),
-                'help_tour'     => array('Event_Add_Category_Help_Tour'),
-                'metaboxes'     => array('_publish_post_box'),
-                'require_nonce' => false,
-            ),
-            'edit_category'          => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['EVT_CAT_ID'])
-                        ? add_query_arg(
-                            array('EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']),
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ),
-                'help_tabs'     => array(
-                    'edit_category_help_tab' => array(
-                        'title'    => esc_html__('Edit Event Category', 'event_espresso'),
-                        'filename' => 'events_edit_category',
-                    ),
-                ),
-                /*'help_tour' => array('Event_Edit_Category_Help_Tour'),*/
-                'metaboxes'     => array('_publish_post_box'),
-                'require_nonce' => false,
-            ),
-            'category_list'          => array(
-                'nav'           => array(
-                    'label' => esc_html__('Categories', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'list_table'    => 'Event_Categories_Admin_List_Table',
-                'help_tabs'     => array(
-                    'events_categories_help_tab'                       => array(
-                        'title'    => esc_html__('Event Categories', 'event_espresso'),
-                        'filename' => 'events_categories',
-                    ),
-                    'events_categories_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_categories_table_column_headings',
-                    ),
-                    'events_categories_view_help_tab'                  => array(
-                        'title'    => esc_html__('Event Categories Views', 'event_espresso'),
-                        'filename' => 'events_categories_views',
-                    ),
-                    'events_categories_other_help_tab'                 => array(
-                        'title'    => esc_html__('Event Categories Other', 'event_espresso'),
-                        'filename' => 'events_categories_other',
-                    ),
-                ),
-                'help_tour'     => array(
-                    'Event_Categories_Help_Tour',
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    /**
-     * Used to register any global screen options if necessary for every route in this admin page group.
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-
-    /**
-     * Implementing the screen options for the 'default' route.
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * Implementing screen options for the category list route.
-     */
-    protected function _add_screen_options_category_list()
-    {
-        $page_title = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Categories', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    /**
-     * Used to register any global feature pointers for the admin page group.
-     */
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    /**
-     * Registers and enqueues any global scripts and styles for the entire admin page group.
-     */
-    public function load_scripts_styles()
-    {
-        wp_register_style(
-            'events-admin-css',
-            EVENTS_ASSETS_URL . 'events-admin-page.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('events-admin-css');
-        wp_enqueue_style('ee-cat-admin');
-        //todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details
-        //registers for all views
-        //scripts
-        wp_register_script(
-            'event_editor_js',
-            EVENTS_ASSETS_URL . 'event_editor.js',
-            array('ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_create_new()
-    {
-        $this->load_scripts_styles_edit();
-    }
-
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_edit()
-    {
-        //styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'event-editor-css',
-            EVENTS_ASSETS_URL . 'event-editor.css',
-            array('ee-admin-css'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('event-editor-css');
-        //scripts
-        wp_register_script(
-            'event-datetime-metabox',
-            EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
-            array('event_editor_js', 'ee-datepicker'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_script('event-datetime-metabox');
-    }
-
-
-    /**
-     * Populating the _views property for the category list table view.
-     */
-    protected function _set_list_table_views_category_list()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * For adding anything that fires on the admin_init hook for any route within this admin page group.
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
-            'Do you really want to delete this image? Please remember to update your event to complete the removal.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the admin_notices hook for any route within this admin page group.
-     */
-    public function admin_notices()
-    {
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
-     * this admin page group.
-     */
-    public function admin_footer_scripts()
-    {
-    }
-
-
-
-    /**
-     * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
-     * warning (via EE_Error::add_error());
-     *
-     * @param  EE_Event $event Event object
-     * @param string    $req_type
-     * @return void
-     * @throws EE_Error
-     * @access public
-     */
-    public function verify_event_edit($event = null, $req_type = '')
-    {
-        // don't need to do this when processing
-        if(!empty($req_type)) {
-            return;
-        }
-        // no event?
-        if (empty($event)) {
-            // set event
-            $event = $this->_cpt_model_obj;
-        }
-        // STILL no event?
-        if (! $event instanceof EE_Event) {
-            return;
-        }
-        $orig_status = $event->status();
-        // first check if event is active.
-        if (
-            $orig_status === EEM_Event::cancelled
-            || $orig_status === EEM_Event::postponed
-            || $event->is_expired()
-            || $event->is_inactive()
-        ) {
-            return;
-        }
-        //made it here so it IS active... next check that any of the tickets are sold.
-        if ($event->is_sold_out(true)) {
-            if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
-                EE_Error::add_attention(
-                    sprintf(
-                        esc_html__(
-                            'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
-                            'event_espresso'
-                        ),
-                        EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
-                    )
-                );
-            }
-            return;
-        } else if ($orig_status === EEM_Event::sold_out) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
-                        'event_espresso'
-                    ),
-                    EEH_Template::pretty_status($event->status(), false, 'sentence')
-                )
-            );
-        }
-        //now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
-        if ( ! $event->tickets_on_sale()) {
-            return;
-        }
-        //made it here so show warning
-        $this->_edit_event_warning();
-    }
-
-
-
-    /**
-     * This is the text used for when an event is being edited that is public and has tickets for sale.
-     * When needed, hook this into a EE_Error::add_error() notice.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _edit_event_warning()
-    {
-        // we don't want to add warnings during these requests
-        if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'editpost') {
-            return;
-        }
-        EE_Error::add_attention(
-            esc_html__(
-                'Please be advised that this event has been published and is open for registrations on your website. If you update any registration-related details (i.e. custom questions, messages, tickets, datetimes, etc.) while a registration is in process, the registration process could be interrupted and result in errors for the person registering and potentially incorrect registration or transaction data inside Event Espresso. We recommend editing events during a period of slow traffic, or even temporarily changing the status of an event to "Draft" until your edits are complete.',
-                'event_espresso'
-            )
-        );
-    }
-
-
-
-    /**
-     * When a user is creating a new event, notify them if they haven't set their timezone.
-     * Otherwise, do the normal logic
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _create_new_cpt_item()
-    {
-        $has_timezone_string = get_option('timezone_string');
-        //only nag them about setting their timezone if it's their first event, and they haven't already done it
-        if (! $has_timezone_string && ! EEM_Event::instance()->exists(array())) {
-            EE_Error::add_attention(
-                sprintf(
-                    __(
-                        'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
-                        'event_espresso'
-                    ),
-                    '<br>',
-                    '<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
-                    . EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
-                    . '</select>',
-                    '<button class="button button-secondary timezone-submit">',
-                    '</button><span class="spinner"></span>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return parent::_create_new_cpt_item();
-    }
-
-
-    /**
-     * Sets the _views property for the default route in this admin page group.
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = array(
-            'all'   => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Events', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-            'draft' => array(
-                'slug'        => 'draft',
-                'label'       => esc_html__('Draft', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
-                    'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-
-    /**
-     * Provides the legend item array for the default list table view.
-     * @return array
-     */
-    protected function _event_legend_items()
-    {
-        $items = array(
-            'view_details'   => array(
-                'class' => 'dashicons dashicons-search',
-                'desc'  => esc_html__('View Event', 'event_espresso'),
-            ),
-            'edit_event'     => array(
-                'class' => 'ee-icon ee-icon-calendar-edit',
-                'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
-            ),
-            'view_attendees' => array(
-                'class' => 'dashicons dashicons-groups',
-                'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
-            ),
-        );
-        $items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
-        $statuses = array(
-            'sold_out_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
-            ),
-            'active_status'    => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
-            ),
-            'upcoming_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
-            ),
-            'postponed_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
-            ),
-            'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
-            ),
-            'expired_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
-            ),
-            'inactive_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
-            ),
-        );
-        $statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
-        return array_merge($items, $statuses);
-    }
-
-
-
-    /**
-     * @return EEM_Event
-     */
-    private function _event_model()
-    {
-        if ( ! $this->_event_model instanceof EEM_Event) {
-            $this->_event_model = EE_Registry::instance()->load_model('Event');
-        }
-        return $this->_event_model;
-    }
-
-
-
-    /**
-     * Adds extra buttons to the WP CPT permalink field row.
-     * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
-     *
-     * @param  string $return    the current html
-     * @param  int    $id        the post id for the page
-     * @param  string $new_title What the title is
-     * @param  string $new_slug  what the slug is
-     * @return string            The new html string for the permalink area
-     */
-    public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
-    {
-        //make sure this is only when editing
-        if ( ! empty($id)) {
-            $post = get_post($id);
-            $return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
-                       . esc_html__('Shortcode', 'event_espresso')
-                       . '</a> ';
-            $return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
-                       . $post->ID
-                       . ']">';
-        }
-        return $return;
-    }
-
-
-
-    /**
-     * _events_overview_list_table
-     * This contains the logic for showing the events_overview list
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _events_overview_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table'])
-            ? (array)$this->_template_args['after_list_table']
-            : array();
-        $this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
-                                                                              . EEH_Template::get_button_or_link(
-                get_post_type_archive_link('espresso_events'),
-                esc_html__("View Event Archive Page", "event_espresso"),
-                'button'
-            );
-        $this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items());
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                'create_new',
-                'add',
-                array(),
-                'add-new-h2'
-            );
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-
-    /**
-     * this allows for extra misc actions in the default WP publish box
-     *
-     * @return void
-     */
-    public function extra_misc_actions_publish_box()
-    {
-        $this->_generate_publish_box_extra_content();
-    }
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been saved.
-     * Typically you would use this to save any additional data.
-     * Keep in mind also that "save_post" runs on EVERY post update to the database.
-     * ALSO very important.  When a post transitions from scheduled to published,
-     * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from other meta saves.
-     * So MAKE sure that you handle this accordingly.
-     *
-     * @access protected
-     * @abstract
-     * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
-     * @param  object $post    The post object of the cpt that was saved.
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
-            //get out we're not processing an event save.
-            return;
-        }
-        $event_values = array(
-            'EVT_display_desc'                => ! empty($this->_req_data['display_desc']) ? 1 : 0,
-            'EVT_display_ticket_selector'     => ! empty($this->_req_data['display_ticket_selector']) ? 1 : 0,
-            'EVT_additional_limit'            => min(
-                apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
-                ! empty($this->_req_data['additional_limit']) ? $this->_req_data['additional_limit'] : null
-            ),
-            'EVT_default_registration_status' => ! empty($this->_req_data['EVT_default_registration_status'])
-                ? $this->_req_data['EVT_default_registration_status']
-                : EE_Registry::instance()->CFG->registration->default_STS_ID,
-            'EVT_member_only'                 => ! empty($this->_req_data['member_only']) ? 1 : 0,
-            'EVT_allow_overflow'              => ! empty($this->_req_data['EVT_allow_overflow']) ? 1 : 0,
-            'EVT_timezone_string'             => ! empty($this->_req_data['timezone_string'])
-                ? $this->_req_data['timezone_string'] : null,
-            'EVT_external_URL'                => ! empty($this->_req_data['externalURL'])
-                ? $this->_req_data['externalURL'] : null,
-            'EVT_phone'                       => ! empty($this->_req_data['event_phone'])
-                ? $this->_req_data['event_phone'] : null,
-        );
-        //update event
-        $success = $this->_event_model()->update_by_ID($event_values, $post_id);
-        //get event_object for other metaboxes... though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
-        $get_one_where = array(
-            $this->_event_model()->primary_key_name() => $post_id,
-            'OR' => array(
-                'status' => $post->post_status,
-                // if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
-                // but the returned object here has a status of "publish", so use the original post status as well
-                'status*1' => $this->_req_data['original_post_status'],
-            )
-        );
-        $event = $this->_event_model()->get_one(array($get_one_where));
-        //the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons.
-        $event_update_callbacks = apply_filters(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            array(
-                array($this, '_default_venue_update'),
-                array($this, '_default_tickets_update')
-            )
-        );
-        $att_success = true;
-        foreach ($event_update_callbacks as $e_callback) {
-            $_success = is_callable($e_callback)
-                ? call_user_func($e_callback, $event, $this->_req_data)
-                : false;
-            //if ANY of these updates fail then we want the appropriate global error message
-            $att_success = ! $att_success ? $att_success : $_success;
-        }
-        //any errors?
-        if ($success && false === $att_success) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Event Details saved successfully but something went wrong with saving attachments.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else if ($success === false) {
-            EE_Error::add_error(
-                esc_html__('Event Details did not save successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-
-    /**
-     * @see parent::restore_item()
-     * @param int $post_id
-     * @param int $revision_id
-     */
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-        //copy existing event meta to new post
-        $post_evt = $this->_event_model()->get_one_by_ID($post_id);
-        if ($post_evt instanceof EE_Event) {
-            //meta revision restore
-            $post_evt->restore_revision($revision_id);
-            //related objs restore
-            $post_evt->restore_revision($revision_id, array('Venue', 'Datetime', 'Price'));
-        }
-    }
-
-
-
-    /**
-     * Attach the venue to the Event
-     *
-     * @param  \EE_Event $evtobj Event Object to add the venue to
-     * @param  array     $data   The request data from the form
-     * @return bool           Success or fail.
-     */
-    protected function _default_venue_update(\EE_Event $evtobj, $data)
-    {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
-        $venue_model = EE_Registry::instance()->load_model('Venue');
-        $rows_affected = null;
-        $venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
-        // very important.  If we don't have a venue name...
-        // then we'll get out because not necessary to create empty venue
-        if (empty($data['venue_title'])) {
-            return false;
-        }
-        $venue_array = array(
-            'VNU_wp_user'         => $evtobj->get('EVT_wp_user'),
-            'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
-            'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
-            'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
-            'VNU_short_desc'      => ! empty($data['venue_short_description']) ? $data['venue_short_description']
-                : null,
-            'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
-            'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
-            'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
-            'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
-            'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
-            'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
-            'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
-            'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
-            'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
-            'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
-            'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
-            'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
-            'status'              => 'publish',
-        );
-        //if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
-        if ( ! empty($venue_id)) {
-            $update_where = array($venue_model->primary_key_name() => $venue_id);
-            $rows_affected = $venue_model->update($venue_array, array($update_where));
-            //we've gotta make sure that the venue is always attached to a revision.. add_relation_to should take care of making sure that the relation is already present.
-            $evtobj->_add_relation_to($venue_id, 'Venue');
-            return $rows_affected > 0 ? true : false;
-        } else {
-            //we insert the venue
-            $venue_id = $venue_model->insert($venue_array);
-            $evtobj->_add_relation_to($venue_id, 'Venue');
-            return ! empty($venue_id) ? true : false;
-        }
-        //when we have the ancestor come in it's already been handled by the revision save.
-    }
-
-
-
-    /**
-     * Handles saving everything related to Tickets (datetimes, tickets, prices)
-     *
-     * @param  EE_Event $evtobj The Event object we're attaching data to
-     * @param  array    $data   The request data from the form
-     * @return array
-     */
-    protected function _default_tickets_update(EE_Event $evtobj, $data)
-    {
-        $success = true;
-        $saved_dtt = null;
-        $saved_tickets = array();
-        $incoming_date_formats = array('Y-m-d', 'h:i a');
-        foreach ($data['edit_event_datetimes'] as $row => $dtt) {
-            //trim all values to ensure any excess whitespace is removed.
-            $dtt = array_map('trim', $dtt);
-            $dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end']
-                : $dtt['DTT_EVT_start'];
-            $datetime_values = array(
-                'DTT_ID'        => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null,
-                'DTT_EVT_start' => $dtt['DTT_EVT_start'],
-                'DTT_EVT_end'   => $dtt['DTT_EVT_end'],
-                'DTT_reg_limit' => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'],
-                'DTT_order'     => $row,
-            );
-            //if we have an id then let's get existing object first and then set the new values.  Otherwise we instantiate a new object for save.
-            if ( ! empty($dtt['DTT_ID'])) {
-                $DTM = EE_Registry::instance()
-                                  ->load_model('Datetime', array($evtobj->get_timezone()))
-                                  ->get_one_by_ID($dtt['DTT_ID']);
-                $DTM->set_date_format($incoming_date_formats[0]);
-                $DTM->set_time_format($incoming_date_formats[1]);
-                foreach ($datetime_values as $field => $value) {
-                    $DTM->set($field, $value);
-                }
-                //make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it.  We need to do this so we dont' TRASH the parent DTT.
-                $saved_dtts[$DTM->ID()] = $DTM;
-            } else {
-                $DTM = EE_Registry::instance()->load_class(
-                    'Datetime',
-                    array($datetime_values, $evtobj->get_timezone(), $incoming_date_formats),
-                    false,
-                    false
-                );
-                foreach ($datetime_values as $field => $value) {
-                    $DTM->set($field, $value);
-                }
-            }
-            $DTM->save();
-            $DTT = $evtobj->_add_relation_to($DTM, 'Datetime');
-            //load DTT helper
-            //before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
-            if ($DTT->get_raw('DTT_EVT_start') > $DTT->get_raw('DTT_EVT_end')) {
-                $DTT->set('DTT_EVT_end', $DTT->get('DTT_EVT_start'));
-                $DTT = EEH_DTT_Helper::date_time_add($DTT, 'DTT_EVT_end', 'days');
-                $DTT->save();
-            }
-            //now we got to make sure we add the new DTT_ID to the $saved_dtts array  because it is possible there was a new one created for the autosave.
-            $saved_dtt = $DTT;
-            $success = ! $success ? $success : $DTT;
-            //if ANY of these updates fail then we want the appropriate global error message.
-            // //todo this is actually sucky we need a better error message but this is what it is for now.
-        }
-        //no dtts get deleted so we don't do any of that logic here.
-        //update tickets next
-        $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
-        foreach ($data['edit_tickets'] as $row => $tkt) {
-            $incoming_date_formats = array('Y-m-d', 'h:i a');
-            $update_prices = false;
-            $ticket_price = isset($data['edit_prices'][$row][1]['PRC_amount'])
-                ? $data['edit_prices'][$row][1]['PRC_amount'] : 0;
-            // trim inputs to ensure any excess whitespace is removed.
-            $tkt = array_map('trim', $tkt);
-            if (empty($tkt['TKT_start_date'])) {
-                //let's use now in the set timezone.
-                $now = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
-                $tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]);
-            }
-            if (empty($tkt['TKT_end_date'])) {
-                //use the start date of the first datetime
-                $dtt = $evtobj->first_datetime();
-                $tkt['TKT_end_date'] = $dtt->start_date_and_time(
-                    $incoming_date_formats[0],
-                    $incoming_date_formats[1]
-                );
-            }
-            $TKT_values = array(
-                'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
-                'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
-                'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
-                'TKT_description' => ! empty($tkt['TKT_description']) ? $tkt['TKT_description'] : '',
-                'TKT_start_date'  => $tkt['TKT_start_date'],
-                'TKT_end_date'    => $tkt['TKT_end_date'],
-                'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'],
-                'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'],
-                'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
-                'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
-                'TKT_row'         => $row,
-                'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : $row,
-                'TKT_price'       => $ticket_price,
-            );
-            //if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well.
-            if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
-                $TKT_values['TKT_ID'] = 0;
-                $TKT_values['TKT_is_default'] = 0;
-                $TKT_values['TKT_price'] = $ticket_price;
-                $update_prices = true;
-            }
-            //if we have a TKT_ID then we need to get that existing TKT_obj and update it
-            //we actually do our saves a head of doing any add_relations to because its entirely possible that this ticket didn't removed or added to any datetime in the session but DID have it's items modified.
-            //keep in mind that if the TKT has been sold (and we have changed pricing information), then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
-            if ( ! empty($tkt['TKT_ID'])) {
-                $TKT = EE_Registry::instance()
-                                  ->load_model('Ticket', array($evtobj->get_timezone()))
-                                  ->get_one_by_ID($tkt['TKT_ID']);
-                if ($TKT instanceof EE_Ticket) {
-                    $ticket_sold = $TKT->count_related(
-                        'Registration',
-                        array(
-                            array(
-                                'STS_ID' => array(
-                                    'NOT IN',
-                                    array(EEM_Registration::status_id_incomplete),
-                                ),
-                            ),
-                        )
-                    ) > 0 ? true : false;
-                    //let's just check the total price for the existing ticket and determine if it matches the new total price.  if they are different then we create a new ticket (if tkts sold) if they aren't different then we go ahead and modify existing ticket.
-                    $create_new_TKT = $ticket_sold && $ticket_price != $TKT->get('TKT_price')
-                                      && ! $TKT->get(
-                        'TKT_deleted'
-                    ) ? true : false;
-                    $TKT->set_date_format($incoming_date_formats[0]);
-                    $TKT->set_time_format($incoming_date_formats[1]);
-                    //set new values
-                    foreach ($TKT_values as $field => $value) {
-                        if ($field == 'TKT_qty') {
-                            $TKT->set_qty($value);
-                        } else {
-                            $TKT->set($field, $value);
-                        }
-                    }
-                    //if $create_new_TKT is false then we can safely update the existing ticket.  Otherwise we have to create a new ticket.
-                    if ($create_new_TKT) {
-                        //archive the old ticket first
-                        $TKT->set('TKT_deleted', 1);
-                        $TKT->save();
-                        //make sure this ticket is still recorded in our saved_tkts so we don't run it through the regular trash routine.
-                        $saved_tickets[$TKT->ID()] = $TKT;
-                        //create new ticket that's a copy of the existing except a new id of course (and not archived) AND has the new TKT_price associated with it.
-                        $TKT = clone $TKT;
-                        $TKT->set('TKT_ID', 0);
-                        $TKT->set('TKT_deleted', 0);
-                        $TKT->set('TKT_price', $ticket_price);
-                        $TKT->set('TKT_sold', 0);
-                        //now we need to make sure that $new prices are created as well and attached to new ticket.
-                        $update_prices = true;
-                    }
-                    //make sure price is set if it hasn't been already
-                    $TKT->set('TKT_price', $ticket_price);
-                }
-            } else {
-                //no TKT_id so a new TKT
-                $TKT_values['TKT_price'] = $ticket_price;
-                $TKT = EE_Registry::instance()->load_class('Ticket', array($TKT_values), false, false);
-                if ($TKT instanceof EE_Ticket) {
-                    //need to reset values to properly account for the date formats
-                    $TKT->set_date_format($incoming_date_formats[0]);
-                    $TKT->set_time_format($incoming_date_formats[1]);
-                    $TKT->set_timezone($evtobj->get_timezone());
-                    //set new values
-                    foreach ($TKT_values as $field => $value) {
-                        if ($field == 'TKT_qty') {
-                            $TKT->set_qty($value);
-                        } else {
-                            $TKT->set($field, $value);
-                        }
-                    }
-                    $update_prices = true;
-                }
-            }
-            // cap ticket qty by datetime reg limits
-            $TKT->set_qty(min($TKT->qty(), $TKT->qty('reg_limit')));
-            //update ticket.
-            $TKT->save();
-            //before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
-            if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) {
-                $TKT->set('TKT_end_date', $TKT->get('TKT_start_date'));
-                $TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days');
-                $TKT->save();
-            }
-            //initially let's add the ticket to the dtt
-            $saved_dtt->_add_relation_to($TKT, 'Ticket');
-            $saved_tickets[$TKT->ID()] = $TKT;
-            //add prices to ticket
-            $this->_add_prices_to_ticket($data['edit_prices'][$row], $TKT, $update_prices);
-        }
-        //however now we need to handle permanently deleting tickets via the ui.  Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.  However, it does allow for deleting tickets that have no tickets sold, in which case we want to get rid of permanently because there is no need to save in db.
-        $old_tickets = isset($old_tickets[0]) && $old_tickets[0] == '' ? array() : $old_tickets;
-        $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
-        foreach ($tickets_removed as $id) {
-            $id = absint($id);
-            //get the ticket for this id
-            $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
-            //need to get all the related datetimes on this ticket and remove from every single one of them (remember this process can ONLY kick off if there are NO tkts_sold)
-            $dtts = $tkt_to_remove->get_many_related('Datetime');
-            foreach ($dtts as $dtt) {
-                $tkt_to_remove->_remove_relation_to($dtt, 'Datetime');
-            }
-            //need to do the same for prices (except these prices can also be deleted because again, tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
-            $tkt_to_remove->delete_related_permanently('Price');
-            //finally let's delete this ticket (which should not be blocked at this point b/c we've removed all our relationships)
-            $tkt_to_remove->delete_permanently();
-        }
-        return array($saved_dtt, $saved_tickets);
-    }
-
-
-
-    /**
-     * This attaches a list of given prices to a ticket.
-     * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
-     * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
-     * price info and prices are automatically "archived" via the ticket.
-     *
-     * @access  private
-     * @param array     $prices     Array of prices from the form.
-     * @param EE_Ticket $ticket     EE_Ticket object that prices are being attached to.
-     * @param bool      $new_prices Whether attach existing incoming prices or create new ones.
-     * @return  void
-     */
-    private function _add_prices_to_ticket($prices, EE_Ticket $ticket, $new_prices = false)
-    {
-        foreach ($prices as $row => $prc) {
-            $PRC_values = array(
-                'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
-                'PRT_ID'         => ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null,
-                'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
-                'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
-                'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
-                'PRC_is_default' => 0, //make sure prices are NOT set as default from this context
-                'PRC_order'      => $row,
-            );
-            if ($new_prices || empty($PRC_values['PRC_ID'])) {
-                $PRC_values['PRC_ID'] = 0;
-                $PRC = EE_Registry::instance()->load_class('Price', array($PRC_values), false, false);
-            } else {
-                $PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
-                //update this price with new values
-                foreach ($PRC_values as $field => $newprc) {
-                    $PRC->set($field, $newprc);
-                }
-                $PRC->save();
-            }
-            $ticket->_add_relation_to($PRC, 'Price');
-        }
-    }
-
-
-
-    /**
-     * Add in our autosave ajax handlers
-     *
-     */
-    protected function _ee_autosave_create_new()
-    {
-    }
-
-
-    /**
-     * More autosave handlers.
-     */
-    protected function _ee_autosave_edit()
-    {
-        return; //TEMPORARILY EXITING CAUSE THIS IS A TODO
-    }
-
-
-
-    /**
-     *    _generate_publish_box_extra_content
-     */
-    private function _generate_publish_box_extra_content()
-    {
-        //load formatter helper
-        //args for getting related registrations
-        $approved_query_args = array(
-            array(
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_approved,
-            ),
-        );
-        $not_approved_query_args = array(
-            array(
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_not_approved,
-            ),
-        );
-        $pending_payment_query_args = array(
-            array(
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_pending_payment,
-            ),
-        );
-        // publish box
-        $publish_box_extra_args = array(
-            'view_approved_reg_url'        => add_query_arg(
-                array(
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ),
-                REG_ADMIN_URL
-            ),
-            'view_not_approved_reg_url'    => add_query_arg(
-                array(
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ),
-                REG_ADMIN_URL
-            ),
-            'view_pending_payment_reg_url' => add_query_arg(
-                array(
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
-                ),
-                REG_ADMIN_URL
-            ),
-            'approved_regs'                => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $approved_query_args
-            ),
-            'not_approved_regs'            => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $not_approved_query_args
-            ),
-            'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $pending_payment_query_args
-            ),
-            'misc_pub_section_class'       => apply_filters(
-                'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
-                'misc-pub-section'
-            ),
-        );
-        ob_start();
-        do_action(
-            'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
-            $this->_cpt_model_obj
-        );
-        $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
-        // load template
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
-            $publish_box_extra_args
-        );
-    }
-
-
-
-    /**
-     * @return EE_Event
-     */
-    public function get_event_object()
-    {
-        return $this->_cpt_model_obj;
-    }
-
-
-
-
-    /** METABOXES * */
-    /**
-     * _register_event_editor_meta_boxes
-     * add all metaboxes related to the event_editor
-     *
-     * @return void
-     */
-    protected function _register_event_editor_meta_boxes()
-    {
-        $this->verify_cpt_object();
-        add_meta_box(
-            'espresso_event_editor_tickets',
-            esc_html__('Event Datetime & Ticket', 'event_espresso'),
-            array($this, 'ticket_metabox'),
-            $this->page_slug,
-            'normal',
-            'high'
-        );
-        add_meta_box(
-            'espresso_event_editor_event_options',
-            esc_html__('Event Registration Options', 'event_espresso'),
-            array($this, 'registration_options_meta_box'),
-            $this->page_slug,
-            'side',
-            'default'
-        );
-        // NOTE: if you're looking for other metaboxes in here,
-        // where a metabox has a related management page in the admin
-        // you will find it setup in the related management page's "_Hooks" file.
-        // i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function ticket_metabox()
-    {
-        $existing_datetime_ids = $existing_ticket_ids = array();
-        //defaults for template args
-        $template_args = array(
-            'existing_datetime_ids'    => '',
-            'event_datetime_help_link' => '',
-            'ticket_options_help_link' => '',
-            'time'                     => null,
-            'ticket_rows'              => '',
-            'existing_ticket_ids'      => '',
-            'total_ticket_rows'        => 1,
-            'ticket_js_structure'      => '',
-            'trash_icon'               => 'ee-lock-icon',
-            'disabled'                 => '',
-        );
-        $event_id = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        /**
-         * 1. Start with retrieving Datetimes
-         * 2. Fore each datetime get related tickets
-         * 3. For each ticket get related prices
-         */
-        $times = EE_Registry::instance()->load_model('Datetime')->get_all_event_dates($event_id);
-        /** @type EE_Datetime $first_datetime */
-        $first_datetime = reset($times);
-        //do we get related tickets?
-        if ($first_datetime instanceof EE_Datetime
-            && $first_datetime->ID() !== 0
-        ) {
-            $existing_datetime_ids[] = $first_datetime->get('DTT_ID');
-            $template_args['time'] = $first_datetime;
-            $related_tickets = $first_datetime->tickets(
-                array(
-                    array('OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0)),
-                    'default_where_conditions' => 'none',
-                )
-            );
-            if ( ! empty($related_tickets)) {
-                $template_args['total_ticket_rows'] = count($related_tickets);
-                $row = 0;
-                foreach ($related_tickets as $ticket) {
-                    $existing_ticket_ids[] = $ticket->get('TKT_ID');
-                    $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
-                    $row++;
-                }
-            } else {
-                $template_args['total_ticket_rows'] = 1;
-                /** @type EE_Ticket $ticket */
-                $ticket = EE_Registry::instance()->load_model('Ticket')->create_default_object();
-                $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
-            }
-        } else {
-            $template_args['time'] = $times[0];
-            /** @type EE_Ticket $ticket */
-            $ticket = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets();
-            $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket[1]);
-            // NOTE: we're just sending the first default row
-            // (decaf can't manage default tickets so this should be sufficient);
-        }
-        $template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
-            'event_editor_event_datetimes_help_tab'
-        );
-        $template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
-        $template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
-        $template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids);
-        $template_args['ticket_js_structure'] = $this->_get_ticket_row(
-            EE_Registry::instance()->load_model('Ticket')->create_default_object(),
-            true
-        );
-        $template = apply_filters(
-            'FHEE__Events_Admin_Page__ticket_metabox__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
-        );
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-
-    /**
-     * Setup an individual ticket form for the decaf event editor page
-     *
-     * @access private
-     * @param  EE_Ticket $ticket   the ticket object
-     * @param  boolean   $skeleton whether we're generating a skeleton for js manipulation
-     * @param int        $row
-     * @return string generated html for the ticket row.
-     */
-    private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
-    {
-        $template_args = array(
-            'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
-            'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
-                : '',
-            'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
-            'TKT_ID'              => $ticket->get('TKT_ID'),
-            'TKT_name'            => $ticket->get('TKT_name'),
-            'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
-            'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
-            'TKT_is_default'      => $ticket->get('TKT_is_default'),
-            'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
-            'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
-            'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
-            'trash_icon'          => ($skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')))
-                                     && ( ! empty($ticket) && $ticket->get('TKT_sold') === 0)
-                ? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon',
-            'disabled'            => $skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
-                : ' disabled=disabled',
-        );
-        $price = $ticket->ID() !== 0
-            ? $ticket->get_first_related('Price', array('default_where_conditions' => 'none'))
-            : EE_Registry::instance()->load_model('Price')->create_default_object();
-        $price_args = array(
-            'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
-            'PRC_amount'            => $price->get('PRC_amount'),
-            'PRT_ID'                => $price->get('PRT_ID'),
-            'PRC_ID'                => $price->get('PRC_ID'),
-            'PRC_is_default'        => $price->get('PRC_is_default'),
-        );
-        //make sure we have default start and end dates if skeleton
-        //handle rows that should NOT be empty
-        if (empty($template_args['TKT_start_date'])) {
-            //if empty then the start date will be now.
-            $template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
-        }
-        if (empty($template_args['TKT_end_date'])) {
-            //get the earliest datetime (if present);
-            $earliest_dtt = $this->_cpt_model_obj->ID() > 0
-                ? $this->_cpt_model_obj->get_first_related(
-                    'Datetime',
-                    array('order_by' => array('DTT_EVT_start' => 'ASC'))
-                )
-                : null;
-            if ( ! empty($earliest_dtt)) {
-                $template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a');
-            } else {
-                $template_args['TKT_end_date'] = date(
-                    'Y-m-d h:i a',
-                    mktime(0, 0, 0, date("m"), date("d") + 7, date("Y"))
-                );
-            }
-        }
-        $template_args = array_merge($template_args, $price_args);
-        $template = apply_filters(
-            'FHEE__Events_Admin_Page__get_ticket_row__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
-            $ticket
-        );
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * @throws DomainException
-     */
-    public function registration_options_meta_box()
-    {
-        $yes_no_values = array(
-            array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
-            array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
-        );
-        $default_reg_status_values = EEM_Registration::reg_status_array(
-            array(
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-            ),
-            true
-        );
-        //$template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
-        $template_args['_event'] = $this->_cpt_model_obj;
-        $template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
-        $template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
-        $template_args['default_registration_status'] = EEH_Form_Fields::select_input(
-            'default_reg_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['display_description'] = EEH_Form_Fields::select_input(
-            'display_desc',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_description()
-        );
-        $template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
-            'display_ticket_selector',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_ticket_selector(),
-            '',
-            '',
-            false
-        );
-        $template_args['additional_registration_options'] = apply_filters(
-            'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
-            '',
-            $template_args,
-            $yes_no_values,
-            $default_reg_status_values
-        );
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
-            $template_args
-        );
-    }
-
-
-
-    /**
-     * _get_events()
-     * This method simply returns all the events (for the given _view and paging)
-     *
-     * @access public
-     * @param int  $per_page     count of items per page (20 default);
-     * @param int  $current_page what is the current page being viewed.
-     * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
-     *                           If FALSE then we return an array of event objects
-     *                           that match the given _view and paging parameters.
-     * @return array an array of event objects.
-     */
-    public function get_events($per_page = 10, $current_page = 1, $count = false)
-    {
-        $EEME = $this->_event_model();
-        $offset = ($current_page - 1) * $per_page;
-        $limit = $count ? null : $offset . ',' . $per_page;
-        $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID';
-        $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : "DESC";
-        if (isset($this->_req_data['month_range'])) {
-            $pieces = explode(' ', $this->_req_data['month_range'], 3);
-            //simulate the FIRST day of the month, that fixes issues for months like February
-            //where PHP doesn't know what to assume for date.
-            //@see https://events.codebasehq.com/projects/event-espresso/tickets/10437
-            $month_r = ! empty($pieces[0]) ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
-            $year_r = ! empty($pieces[1]) ? $pieces[1] : '';
-        }
-        $where = array();
-        $status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
-        //determine what post_status our condition will have for the query.
-        switch ($status) {
-            case 'month' :
-            case 'today' :
-            case null :
-            case 'all' :
-                break;
-            case 'draft' :
-                $where['status'] = array('IN', array('draft', 'auto-draft'));
-                break;
-            default :
-                $where['status'] = $status;
-        }
-        //categories?
-        $category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
-            ? $this->_req_data['EVT_CAT'] : null;
-        if ( ! empty ($category)) {
-            $where['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-            $where['Term_Taxonomy.term_id'] = $category;
-        }
-        //date where conditions
-        $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
-        if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] != '') {
-            $DateTime = new DateTime(
-                $year_r . '-' . $month_r . '-01 00:00:00',
-                new DateTimeZone(EEM_Datetime::instance()->get_timezone())
-            );
-            $start = $DateTime->format(implode(' ', $start_formats));
-            $end = $DateTime->setDate($year_r, $month_r, $DateTime
-                ->format('t'))->setTime(23, 59, 59)
-                            ->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
-        } else if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'today') {
-            $DateTime = new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
-            $end = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
-        } else if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'month') {
-            $now = date('Y-m-01');
-            $DateTime = new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
-            $end = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
-                            ->setTime(23, 59, 59)
-                            ->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
-        }
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
-            $where['EVT_wp_user'] = get_current_user_id();
-        } else {
-            if ( ! isset($where['status'])) {
-                if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
-                    $where['OR'] = array(
-                        'status*restrict_private' => array('!=', 'private'),
-                        'AND'                     => array(
-                            'status*inclusive' => array('=', 'private'),
-                            'EVT_wp_user'      => get_current_user_id(),
-                        ),
-                    );
-                }
-            }
-        }
-        if (isset($this->_req_data['EVT_wp_user'])) {
-            if ($this->_req_data['EVT_wp_user'] != get_current_user_id()
-                && EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
-            ) {
-                $where['EVT_wp_user'] = $this->_req_data['EVT_wp_user'];
-            }
-        }
-        //search query handling
-        if (isset($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
-            $where['OR'] = array(
-                'EVT_name'       => array('LIKE', $search_string),
-                'EVT_desc'       => array('LIKE', $search_string),
-                'EVT_short_desc' => array('LIKE', $search_string),
-            );
-        }
-        $where = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $this->_req_data);
-        $query_params = apply_filters(
-            'FHEE__Events_Admin_Page__get_events__query_params',
-            array(
-                $where,
-                'limit'    => $limit,
-                'order_by' => $orderby,
-                'order'    => $order,
-                'group_by' => 'EVT_ID',
-            ),
-            $this->_req_data
-        );
-        //let's first check if we have special requests coming in.
-        if (isset($this->_req_data['active_status'])) {
-            switch ($this->_req_data['active_status']) {
-                case 'upcoming' :
-                    return $EEME->get_upcoming_events($query_params, $count);
-                    break;
-                case 'expired' :
-                    return $EEME->get_expired_events($query_params, $count);
-                    break;
-                case 'active' :
-                    return $EEME->get_active_events($query_params, $count);
-                    break;
-                case 'inactive' :
-                    return $EEME->get_inactive_events($query_params, $count);
-                    break;
-            }
-        }
-        $events = $count ? $EEME->count(array($where), 'EVT_ID', true) : $EEME->get_all($query_params);
-        return $events;
-    }
-
-
-
-    /**
-     * handling for WordPress CPT actions (trash, restore, delete)
-     *
-     * @param string $post_id
-     */
-    public function trash_cpt_item($post_id)
-    {
-        $this->_req_data['EVT_ID'] = $post_id;
-        $this->_trash_or_restore_event('trash', false);
-    }
-
-
-
-    /**
-     * @param string $post_id
-     */
-    public function restore_cpt_item($post_id)
-    {
-        $this->_req_data['EVT_ID'] = $post_id;
-        $this->_trash_or_restore_event('draft', false);
-    }
-
-
-
-    /**
-     * @param string $post_id
-     */
-    public function delete_cpt_item($post_id)
-    {
-        $this->_req_data['EVT_ID'] = $post_id;
-        $this->_delete_event(false);
-    }
-
-
-
-    /**
-     * _trash_or_restore_event
-     *
-     * @access protected
-     * @param  string $event_status
-     * @param bool    $redirect_after
-     */
-    protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
-    {
-        //determine the event id and set to array.
-        $EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : false;
-        // loop thru events
-        if ($EVT_ID) {
-            // clean status
-            $event_status = sanitize_key($event_status);
-            // grab status
-            if ( ! empty($event_status)) {
-                $success = $this->_change_event_status($EVT_ID, $event_status);
-            } else {
-                $success = false;
-                $msg = esc_html__(
-                    'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        } else {
-            $success = false;
-            $msg = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        $action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Event', $action, array('action' => 'default'));
-        }
-    }
-
-
-
-    /**
-     * _trash_or_restore_events
-     *
-     * @access protected
-     * @param  string $event_status
-     * @return void
-     */
-    protected function _trash_or_restore_events($event_status = 'trash')
-    {
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if ( ! empty($event_status)) {
-            $success = true;
-            //determine the event id and set to array.
-            $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
-            // loop thru events
-            foreach ($EVT_IDs as $EVT_ID) {
-                if ($EVT_ID = absint($EVT_ID)) {
-                    $results = $this->_change_event_status($EVT_ID, $event_status);
-                    $success = $results !== false ? $success : false;
-                } else {
-                    $msg = sprintf(
-                        esc_html__(
-                            'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
-                            'event_espresso'
-                        ),
-                        $EVT_ID
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                    $success = false;
-                }
-            }
-        } else {
-            $success = false;
-            $msg = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-        $this->_redirect_after_action($success, 'Events', $action, array('action' => 'default'));
-    }
-
-
-
-    /**
-     * _trash_or_restore_events
-     *
-     * @access  private
-     * @param  int    $EVT_ID
-     * @param  string $event_status
-     * @return bool
-     */
-    private function _change_event_status($EVT_ID = 0, $event_status = '')
-    {
-        // grab event id
-        if ( ! $EVT_ID) {
-            $msg = esc_html__(
-                'An error occurred. No Event ID or an invalid Event ID was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if (empty($event_status)) {
-            $msg = esc_html__(
-                'An error occurred. No Event Status or an invalid Event Status was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // was event trashed or restored ?
-        switch ($event_status) {
-            case 'draft' :
-                $action = 'restored from the trash';
-                $hook = 'AHEE_event_restored_from_trash';
-                break;
-            case 'trash' :
-                $action = 'moved to the trash';
-                $hook = 'AHEE_event_moved_to_trash';
-                break;
-            default :
-                $action = 'updated';
-                $hook = false;
-        }
-        //use class to change status
-        $this->_cpt_model_obj->set_status($event_status);
-        $success = $this->_cpt_model_obj->save();
-        if ($success === false) {
-            $msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if ($hook) {
-            do_action($hook);
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _delete_event
-     *
-     * @access protected
-     * @param bool $redirect_after
-     */
-    protected function _delete_event($redirect_after = true)
-    {
-        //determine the event id and set to array.
-        $EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : null;
-        $EVT_ID = isset($this->_req_data['post']) ? absint($this->_req_data['post']) : $EVT_ID;
-        // loop thru events
-        if ($EVT_ID) {
-            $success = $this->_permanently_delete_event($EVT_ID);
-            // get list of events with no prices
-            $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
-            // remove this event from the list of events with no prices
-            if (isset($espresso_no_ticket_prices[$EVT_ID])) {
-                unset($espresso_no_ticket_prices[$EVT_ID]);
-            }
-            update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
-        } else {
-            $success = false;
-            $msg = esc_html__(
-                'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        if ($redirect_after) {
-            $this->_redirect_after_action(
-                $success,
-                'Event',
-                'deleted',
-                array('action' => 'default', 'status' => 'trash')
-            );
-        }
-    }
-
-
-
-    /**
-     * _delete_events
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _delete_events()
-    {
-        $success = true;
-        // get list of events with no prices
-        $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
-        //determine the event id and set to array.
-        $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
-        // loop thru events
-        foreach ($EVT_IDs as $EVT_ID) {
-            $EVT_ID = absint($EVT_ID);
-            if ($EVT_ID) {
-                $results = $this->_permanently_delete_event($EVT_ID);
-                $success = $results !== false ? $success : false;
-                // remove this event from the list of events with no prices
-                unset($espresso_no_ticket_prices[$EVT_ID]);
-            } else {
-                $success = false;
-                $msg = esc_html__(
-                    'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $this->_redirect_after_action($success, 'Events', 'deleted', array('action' => 'default'));
-    }
-
-
-
-    /**
-     * _permanently_delete_event
-     *
-     * @access  private
-     * @param  int $EVT_ID
-     * @return bool
-     */
-    private function _permanently_delete_event($EVT_ID = 0)
-    {
-        // grab event id
-        if ( ! $EVT_ID) {
-            $msg = esc_html__(
-                'An error occurred. No Event ID or an invalid Event ID was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (
-            ! $this->_cpt_model_obj instanceof EE_Event
-            || $this->_cpt_model_obj->ID() !== $EVT_ID
-        ) {
-            $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        }
-        if ( ! $this->_cpt_model_obj instanceof EE_Event) {
-            return false;
-        }
-        //need to delete related tickets and prices first.
-        $datetimes = $this->_cpt_model_obj->get_many_related('Datetime');
-        foreach ($datetimes as $datetime) {
-            $this->_cpt_model_obj->_remove_relation_to($datetime, 'Datetime');
-            $tickets = $datetime->get_many_related('Ticket');
-            foreach ($tickets as $ticket) {
-                $ticket->_remove_relation_to($datetime, 'Datetime');
-                $ticket->delete_related_permanently('Price');
-                $ticket->delete_permanently();
-            }
-            $datetime->delete();
-        }
-        //what about related venues or terms?
-        $venues = $this->_cpt_model_obj->get_many_related('Venue');
-        foreach ($venues as $venue) {
-            $this->_cpt_model_obj->_remove_relation_to($venue, 'Venue');
-        }
-        //any attached question groups?
-        $question_groups = $this->_cpt_model_obj->get_many_related('Question_Group');
-        if ( ! empty($question_groups)) {
-            foreach ($question_groups as $question_group) {
-                $this->_cpt_model_obj->_remove_relation_to($question_group, 'Question_Group');
-            }
-        }
-        //Message Template Groups
-        $this->_cpt_model_obj->_remove_relations('Message_Template_Group');
-        /** @type EE_Term_Taxonomy[] $term_taxonomies */
-        $term_taxonomies = $this->_cpt_model_obj->term_taxonomies();
-        foreach ($term_taxonomies as $term_taxonomy) {
-            $this->_cpt_model_obj->remove_relation_to_term_taxonomy($term_taxonomy);
-        }
-        $success = $this->_cpt_model_obj->delete_permanently();
-        // did it all go as planned ?
-        if ($success) {
-            $msg = sprintf(esc_html__('Event ID # %d has been deleted.', 'event_espresso'), $EVT_ID);
-            EE_Error::add_success($msg);
-        } else {
-            $msg = sprintf(
-                esc_html__('An error occurred. Event ID # %d could not be deleted.', 'event_espresso'),
-                $EVT_ID
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        do_action('AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted', $EVT_ID);
-        return true;
-    }
-
-
-
-    /**
-     * get total number of events
-     *
-     * @access public
-     * @return int
-     */
-    public function total_events()
-    {
-        $count = EEM_Event::instance()->count(array('caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-
-    /**
-     * get total number of draft events
-     *
-     * @access public
-     * @return int
-     */
-    public function total_events_draft()
-    {
-        $where = array(
-            'status' => array('IN', array('draft', 'auto-draft')),
-        );
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-
-    /**
-     * get total number of trashed events
-     *
-     * @access public
-     * @return int
-     */
-    public function total_trashed_events()
-    {
-        $where = array(
-            'status' => 'trash',
-        );
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-    /**
-     *    _default_event_settings
-     *    This generates the Default Settings Tab
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _default_event_settings()
-    {
-        $this->_set_add_edit_form_tags('update_default_event_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Return the form for event settings.
-     * @return EE_Form_Section_Proper
-     */
-    protected function _default_event_settings_form()
-    {
-        $registration_config = EE_Registry::instance()->CFG->registration;
-        $registration_stati_for_selection = EEM_Registration::reg_status_array(
-        //exclude
-            array(
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_wait_list,
-            ),
-            true
-        );
-        return new EE_Form_Section_Proper(
-            array(
-                'name' => 'update_default_event_settings',
-                'html_id' => 'update_default_event_settings',
-                'html_class' => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections' => apply_filters(
-                    'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
-                    array(
-                        'default_reg_status' => new EE_Select_Input(
-                            $registration_stati_for_selection,
-                            array(
-                                'default' => isset($registration_config->default_STS_ID)
-                                             && array_key_exists(
-                                                $registration_config->default_STS_ID,
-                                                $registration_stati_for_selection
-                                             )
-                                            ? sanitize_text_field($registration_config->default_STS_ID)
-                                            : EEM_Registration::status_id_pending_payment,
-                                'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
-                                                    . EEH_Template::get_help_tab_link(
-                                                        'default_settings_status_help_tab'
-                                                    ),
-                                'html_help_text' => esc_html__(
-                                    'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
-                                    'event_espresso'
-                                )
-                            )
-                        ),
-                        'default_max_tickets' => new EE_Integer_Input(
-                            array(
-                                'default' => isset($registration_config->default_maximum_number_of_tickets)
-                                    ? $registration_config->default_maximum_number_of_tickets
-                                    : EEM_Event::get_default_additional_limit(),
-                                'html_label_text' => esc_html__(
-                                    'Default Maximum Tickets Allowed Per Order:',
-                                    'event_espresso'
-                                ) . EEH_Template::get_help_tab_link(
-                                    'default_maximum_tickets_help_tab"'
-                                    ),
-                                'html_help_text' => esc_html__(
-                                    'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
-                                    'event_espresso'
-                                )
-                            )
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _update_default_event_settings
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _update_default_event_settings()
-    {
-        $registration_config = EE_Registry::instance()->CFG->registration;
-        $form = $this->_default_event_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $valid_data = $form->valid_data();
-                if (isset($valid_data['default_reg_status'])) {
-                    $registration_config->default_STS_ID = $valid_data['default_reg_status'];
-                }
-                if (isset($valid_data['default_max_tickets'])) {
-                    $registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
-                }
-                //update because data was valid!
-                EE_Registry::instance()->CFG->update_espresso_config();
-                EE_Error::overwrite_success();
-                EE_Error::add_success(
-                    __('Default Event Settings were updated', 'event_espresso')
-                );
-            }
-        }
-        $this->_redirect_after_action(0, '', '', array('action' => 'default_event_settings'), true);
-    }
-
-
-
-    /*************        Templates        *************/
-    protected function _template_settings()
-    {
-        $this->_admin_page_title = esc_html__('Template Settings (Preview)', 'event_espresso');
-        $this->_template_args['preview_img'] = '<img src="'
-                                               . EVENTS_ASSETS_URL
-                                               . DS
-                                               . 'images'
-                                               . DS
-                                               . 'caffeinated_template_features.jpg" alt="'
-                                               . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
-                                               . '" />';
-        $this->_template_args['preview_text'] = '<strong>' . esc_html__(
-                'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
-                'event_espresso'
-            ) . '</strong>';
-        $this->display_admin_caf_preview_page('template_settings_tab');
-    }
-
-
-    /** Event Category Stuff **/
-    /**
-     * set the _category property with the category object for the loaded page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_category_object()
-    {
-        if (isset($this->_category->id) && ! empty($this->_category->id)) {
-            return;
-        } //already have the category object so get out.
-        //set default category object
-        $this->_set_empty_category_object();
-        //only set if we've got an id
-        if ( ! isset($this->_req_data['EVT_CAT_ID'])) {
-            return;
-        }
-        $category_id = absint($this->_req_data['EVT_CAT_ID']);
-        $term = get_term($category_id, 'espresso_event_categories');
-        if ( ! empty($term)) {
-            $this->_category->category_name = $term->name;
-            $this->_category->category_identifier = $term->slug;
-            $this->_category->category_desc = $term->description;
-            $this->_category->id = $term->term_id;
-            $this->_category->parent = $term->parent;
-        }
-    }
-
-
-    /**
-     * Clears out category properties.
-     */
-    private function _set_empty_category_object()
-    {
-        $this->_category = new stdClass();
-        $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
-        $this->_category->id = $this->_category->parent = 0;
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _category_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_search_btn_label = esc_html__('Categories', 'event_espresso');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                'add_category',
-                'add_category',
-                array(),
-                'add-new-h2'
-            );
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-
-    /**
-     * Output category details view.
-     */
-    protected function _category_details($view)
-    {
-        //load formatter helper
-        //load field generator helper
-        $route = $view == 'edit' ? 'update_category' : 'insert_category';
-        $this->_set_add_edit_form_tags($route);
-        $this->_set_category_object();
-        $id = ! empty($this->_category->id) ? $this->_category->id : '';
-        $delete_action = 'delete_category';
-        //custom redirect
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'category_list'),
-            $this->_admin_base_url
-        );
-        $this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
-        //take care of contents
-        $this->_template_args['admin_page_content'] = $this->_category_details_content();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    /**
-     * Output category details content.
-     */
-    protected function _category_details_content()
-    {
-        $editor_args['category_desc'] = array(
-            'type'          => 'wp_editor',
-            'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
-            'class'         => 'my_editor_custom',
-            'wpeditor_args' => array('media_buttons' => false),
-        );
-        $_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
-        $all_terms = get_terms(
-            array('espresso_event_categories'),
-            array('hide_empty' => 0, 'exclude' => array($this->_category->id))
-        );
-        //setup category select for term parents.
-        $category_select_values[] = array(
-            'text' => esc_html__('No Parent', 'event_espresso'),
-            'id'   => 0,
-        );
-        foreach ($all_terms as $term) {
-            $category_select_values[] = array(
-                'text' => $term->name,
-                'id'   => $term->term_id,
-            );
-        }
-        $category_select = EEH_Form_Fields::select_input(
-            'category_parent',
-            $category_select_values,
-            $this->_category->parent
-        );
-        $template_args = array(
-            'category'                 => $this->_category,
-            'category_select'          => $category_select,
-            'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
-            'category_desc_editor'     => $_wp_editor['category_desc']['field'],
-            'disable'                  => '',
-            'disabled_message'         => false,
-        );
-        $template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * Handles deleting categories.
-     */
-    protected function _delete_categories()
-    {
-        $cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array)$this->_req_data['EVT_CAT_ID']
-            : (array)$this->_req_data['category_id'];
-        foreach ($cat_ids as $cat_id) {
-            $this->_delete_category($cat_id);
-        }
-        //doesn't matter what page we're coming from... we're going to the same place after delete.
-        $query_args = array(
-            'action' => 'category_list',
-        );
-        $this->_redirect_after_action(0, '', '', $query_args);
-    }
-
-
-
-    /**
-     * Handles deleting specific category.
-     * @param int $cat_id
-     */
-    protected function _delete_category($cat_id)
-    {
-        $cat_id = absint($cat_id);
-        wp_delete_term($cat_id, 'espresso_event_categories');
-    }
-
-
-
-    /**
-     * Handles triggering the update or insertion of a new category.
-     * @param bool $new_category  true means we're triggering the insert of a new category.
-     */
-    protected function _insert_or_update_category($new_category)
-    {
-        $cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true);
-        $success = 0; //we already have a success message so lets not send another.
-        if ($cat_id) {
-            $query_args = array(
-                'action'     => 'edit_category',
-                'EVT_CAT_ID' => $cat_id,
-            );
-        } else {
-            $query_args = array('action' => 'add_category');
-        }
-        $this->_redirect_after_action($success, '', '', $query_args, true);
-    }
-
-
-
-    /**
-     * Inserts or updates category
-     * @param bool $update (true indicates we're updating a category).
-     * @return bool|mixed|string
-     */
-    private function _insert_category($update = false)
-    {
-        $cat_id = $update ? $this->_req_data['EVT_CAT_ID'] : '';
-        $category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : '';
-        $category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : '';
-        $category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0;
-        if (empty($category_name)) {
-            $msg = esc_html__('You must add a name for the category.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $term_args = array(
-            'name'        => $category_name,
-            'description' => $category_desc,
-            'parent'      => $category_parent,
-        );
-        //was the category_identifier input disabled?
-        if (isset($this->_req_data['category_identifier'])) {
-            $term_args['slug'] = $this->_req_data['category_identifier'];
-        }
-        $insert_ids = $update
-            ? wp_update_term($cat_id, 'espresso_event_categories', $term_args)
-            : wp_insert_term($category_name, 'espresso_event_categories', $term_args);
-        if ( ! is_array($insert_ids)) {
-            $msg = esc_html__(
-                'An error occurred and the category has not been saved to the database.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            $cat_id = $insert_ids['term_id'];
-            $msg = sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name);
-            EE_Error::add_success($msg);
-        }
-        return $cat_id;
-    }
-
-
-
-    /**
-     * Gets categories or count of categories matching the arguments in the request.
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return EE_Base_Class[]|EE_Term_Taxonomy[]|int
-     */
-    public function get_categories($per_page = 10, $current_page = 1, $count = false)
-    {
-        //testing term stuff
-        $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id';
-        $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
-        $limit = ($current_page - 1) * $per_page;
-        $where = array('taxonomy' => 'espresso_event_categories');
-        if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
-            $where['OR'] = array(
-                'Term.name'   => array('LIKE', $sstr),
-                'description' => array('LIKE', $sstr),
-            );
-        }
-        $query_params = array(
-            $where,
-            'order_by'   => array($orderby => $order),
-            'limit'      => $limit . ',' . $per_page,
-            'force_join' => array('Term'),
-        );
-        $categories = $count
-            ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
-            : EEM_Term_Taxonomy::instance()->get_all($query_params);
-        return $categories;
-    }
-
-    /* end category stuff */
-    /**************/
-
-
-    /**
-     * Callback for the `ee_save_timezone_setting` ajax action.
-     * @throws EE_Error
-     */
-    public function save_timezonestring_setting()
-    {
-        $timezone_string = isset($this->_req_data['timezone_selected'])
-            ? $this->_req_data['timezone_selected']
-            : '';
-        if  (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false))
-        {
-            EE_Error::add_error(
-                esc_html('An invalid timezone string submitted.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-
-        update_option('timezone_string', $timezone_string);
-        EE_Error::add_success(
-            esc_html__('Your timezone string was updated.', 'event_espresso')
-        );
-        $this->_template_args['success'] = true;
-        $this->_return_json(true, array('action' => 'create_new'));
-    }
+				'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
+				'require_nonce' => false,
+			),
+			'default_event_settings' => array(
+				'nav'           => array(
+					'label' => esc_html__('Default Settings', 'event_espresso'),
+					'order' => 40,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'labels'        => array(
+					'publishbox' => esc_html__('Update Settings', 'event_espresso'),
+				),
+				'help_tabs'     => array(
+					'default_settings_help_tab'        => array(
+						'title'    => esc_html__('Default Event Settings', 'event_espresso'),
+						'filename' => 'events_default_settings',
+					),
+					'default_settings_status_help_tab' => array(
+						'title'    => esc_html__('Default Registration Status', 'event_espresso'),
+						'filename' => 'events_default_settings_status',
+					),
+					'default_maximum_tickets_help_tab' => array(
+						'title' => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
+						'filename' => 'events_default_settings_max_tickets',
+					)
+				),
+				'help_tour'     => array('Event_Default_Settings_Help_Tour'),
+				'require_nonce' => false,
+			),
+			//template settings
+			'template_settings'      => array(
+				'nav'           => array(
+					'label' => esc_html__('Templates', 'event_espresso'),
+					'order' => 30,
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => array(
+					'general_settings_templates_help_tab' => array(
+						'title'    => esc_html__('Templates', 'event_espresso'),
+						'filename' => 'general_settings_templates',
+					),
+				),
+				'help_tour'     => array('Templates_Help_Tour'),
+				'require_nonce' => false,
+			),
+			//event category stuff
+			'add_category'           => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'help_tabs'     => array(
+					'add_category_help_tab' => array(
+						'title'    => esc_html__('Add New Event Category', 'event_espresso'),
+						'filename' => 'events_add_category',
+					),
+				),
+				'help_tour'     => array('Event_Add_Category_Help_Tour'),
+				'metaboxes'     => array('_publish_post_box'),
+				'require_nonce' => false,
+			),
+			'edit_category'          => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['EVT_CAT_ID'])
+						? add_query_arg(
+							array('EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']),
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				),
+				'help_tabs'     => array(
+					'edit_category_help_tab' => array(
+						'title'    => esc_html__('Edit Event Category', 'event_espresso'),
+						'filename' => 'events_edit_category',
+					),
+				),
+				/*'help_tour' => array('Event_Edit_Category_Help_Tour'),*/
+				'metaboxes'     => array('_publish_post_box'),
+				'require_nonce' => false,
+			),
+			'category_list'          => array(
+				'nav'           => array(
+					'label' => esc_html__('Categories', 'event_espresso'),
+					'order' => 20,
+				),
+				'list_table'    => 'Event_Categories_Admin_List_Table',
+				'help_tabs'     => array(
+					'events_categories_help_tab'                       => array(
+						'title'    => esc_html__('Event Categories', 'event_espresso'),
+						'filename' => 'events_categories',
+					),
+					'events_categories_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
+						'filename' => 'events_categories_table_column_headings',
+					),
+					'events_categories_view_help_tab'                  => array(
+						'title'    => esc_html__('Event Categories Views', 'event_espresso'),
+						'filename' => 'events_categories_views',
+					),
+					'events_categories_other_help_tab'                 => array(
+						'title'    => esc_html__('Event Categories Other', 'event_espresso'),
+						'filename' => 'events_categories_other',
+					),
+				),
+				'help_tour'     => array(
+					'Event_Categories_Help_Tour',
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	/**
+	 * Used to register any global screen options if necessary for every route in this admin page group.
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+
+	/**
+	 * Implementing the screen options for the 'default' route.
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * Implementing screen options for the category list route.
+	 */
+	protected function _add_screen_options_category_list()
+	{
+		$page_title = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Categories', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	/**
+	 * Used to register any global feature pointers for the admin page group.
+	 */
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * Registers and enqueues any global scripts and styles for the entire admin page group.
+	 */
+	public function load_scripts_styles()
+	{
+		wp_register_style(
+			'events-admin-css',
+			EVENTS_ASSETS_URL . 'events-admin-page.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('events-admin-css');
+		wp_enqueue_style('ee-cat-admin');
+		//todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details
+		//registers for all views
+		//scripts
+		wp_register_script(
+			'event_editor_js',
+			EVENTS_ASSETS_URL . 'event_editor.js',
+			array('ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_create_new()
+	{
+		$this->load_scripts_styles_edit();
+	}
+
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_edit()
+	{
+		//styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'event-editor-css',
+			EVENTS_ASSETS_URL . 'event-editor.css',
+			array('ee-admin-css'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('event-editor-css');
+		//scripts
+		wp_register_script(
+			'event-datetime-metabox',
+			EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
+			array('event_editor_js', 'ee-datepicker'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_script('event-datetime-metabox');
+	}
+
+
+	/**
+	 * Populating the _views property for the category list table view.
+	 */
+	protected function _set_list_table_views_category_list()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * For adding anything that fires on the admin_init hook for any route within this admin page group.
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
+			'Do you really want to delete this image? Please remember to update your event to complete the removal.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the admin_notices hook for any route within this admin page group.
+	 */
+	public function admin_notices()
+	{
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
+	 * this admin page group.
+	 */
+	public function admin_footer_scripts()
+	{
+	}
+
+
+
+	/**
+	 * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
+	 * warning (via EE_Error::add_error());
+	 *
+	 * @param  EE_Event $event Event object
+	 * @param string    $req_type
+	 * @return void
+	 * @throws EE_Error
+	 * @access public
+	 */
+	public function verify_event_edit($event = null, $req_type = '')
+	{
+		// don't need to do this when processing
+		if(!empty($req_type)) {
+			return;
+		}
+		// no event?
+		if (empty($event)) {
+			// set event
+			$event = $this->_cpt_model_obj;
+		}
+		// STILL no event?
+		if (! $event instanceof EE_Event) {
+			return;
+		}
+		$orig_status = $event->status();
+		// first check if event is active.
+		if (
+			$orig_status === EEM_Event::cancelled
+			|| $orig_status === EEM_Event::postponed
+			|| $event->is_expired()
+			|| $event->is_inactive()
+		) {
+			return;
+		}
+		//made it here so it IS active... next check that any of the tickets are sold.
+		if ($event->is_sold_out(true)) {
+			if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
+				EE_Error::add_attention(
+					sprintf(
+						esc_html__(
+							'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
+							'event_espresso'
+						),
+						EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
+					)
+				);
+			}
+			return;
+		} else if ($orig_status === EEM_Event::sold_out) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
+						'event_espresso'
+					),
+					EEH_Template::pretty_status($event->status(), false, 'sentence')
+				)
+			);
+		}
+		//now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
+		if ( ! $event->tickets_on_sale()) {
+			return;
+		}
+		//made it here so show warning
+		$this->_edit_event_warning();
+	}
+
+
+
+	/**
+	 * This is the text used for when an event is being edited that is public and has tickets for sale.
+	 * When needed, hook this into a EE_Error::add_error() notice.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _edit_event_warning()
+	{
+		// we don't want to add warnings during these requests
+		if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'editpost') {
+			return;
+		}
+		EE_Error::add_attention(
+			esc_html__(
+				'Please be advised that this event has been published and is open for registrations on your website. If you update any registration-related details (i.e. custom questions, messages, tickets, datetimes, etc.) while a registration is in process, the registration process could be interrupted and result in errors for the person registering and potentially incorrect registration or transaction data inside Event Espresso. We recommend editing events during a period of slow traffic, or even temporarily changing the status of an event to "Draft" until your edits are complete.',
+				'event_espresso'
+			)
+		);
+	}
+
+
+
+	/**
+	 * When a user is creating a new event, notify them if they haven't set their timezone.
+	 * Otherwise, do the normal logic
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _create_new_cpt_item()
+	{
+		$has_timezone_string = get_option('timezone_string');
+		//only nag them about setting their timezone if it's their first event, and they haven't already done it
+		if (! $has_timezone_string && ! EEM_Event::instance()->exists(array())) {
+			EE_Error::add_attention(
+				sprintf(
+					__(
+						'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
+						'event_espresso'
+					),
+					'<br>',
+					'<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
+					. EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
+					. '</select>',
+					'<button class="button button-secondary timezone-submit">',
+					'</button><span class="spinner"></span>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return parent::_create_new_cpt_item();
+	}
+
+
+	/**
+	 * Sets the _views property for the default route in this admin page group.
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = array(
+			'all'   => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Events', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+			'draft' => array(
+				'slug'        => 'draft',
+				'label'       => esc_html__('Draft', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
+					'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+
+	/**
+	 * Provides the legend item array for the default list table view.
+	 * @return array
+	 */
+	protected function _event_legend_items()
+	{
+		$items = array(
+			'view_details'   => array(
+				'class' => 'dashicons dashicons-search',
+				'desc'  => esc_html__('View Event', 'event_espresso'),
+			),
+			'edit_event'     => array(
+				'class' => 'ee-icon ee-icon-calendar-edit',
+				'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
+			),
+			'view_attendees' => array(
+				'class' => 'dashicons dashicons-groups',
+				'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
+			),
+		);
+		$items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
+		$statuses = array(
+			'sold_out_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
+			),
+			'active_status'    => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
+			),
+			'upcoming_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
+			),
+			'postponed_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
+			),
+			'cancelled_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
+			),
+			'expired_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
+			),
+			'inactive_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
+			),
+		);
+		$statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
+		return array_merge($items, $statuses);
+	}
+
+
+
+	/**
+	 * @return EEM_Event
+	 */
+	private function _event_model()
+	{
+		if ( ! $this->_event_model instanceof EEM_Event) {
+			$this->_event_model = EE_Registry::instance()->load_model('Event');
+		}
+		return $this->_event_model;
+	}
+
+
+
+	/**
+	 * Adds extra buttons to the WP CPT permalink field row.
+	 * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
+	 *
+	 * @param  string $return    the current html
+	 * @param  int    $id        the post id for the page
+	 * @param  string $new_title What the title is
+	 * @param  string $new_slug  what the slug is
+	 * @return string            The new html string for the permalink area
+	 */
+	public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
+	{
+		//make sure this is only when editing
+		if ( ! empty($id)) {
+			$post = get_post($id);
+			$return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
+					   . esc_html__('Shortcode', 'event_espresso')
+					   . '</a> ';
+			$return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
+					   . $post->ID
+					   . ']">';
+		}
+		return $return;
+	}
+
+
+
+	/**
+	 * _events_overview_list_table
+	 * This contains the logic for showing the events_overview list
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _events_overview_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table'])
+			? (array)$this->_template_args['after_list_table']
+			: array();
+		$this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
+																			  . EEH_Template::get_button_or_link(
+				get_post_type_archive_link('espresso_events'),
+				esc_html__("View Event Archive Page", "event_espresso"),
+				'button'
+			);
+		$this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items());
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+				'create_new',
+				'add',
+				array(),
+				'add-new-h2'
+			);
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+
+	/**
+	 * this allows for extra misc actions in the default WP publish box
+	 *
+	 * @return void
+	 */
+	public function extra_misc_actions_publish_box()
+	{
+		$this->_generate_publish_box_extra_content();
+	}
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been saved.
+	 * Typically you would use this to save any additional data.
+	 * Keep in mind also that "save_post" runs on EVERY post update to the database.
+	 * ALSO very important.  When a post transitions from scheduled to published,
+	 * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from other meta saves.
+	 * So MAKE sure that you handle this accordingly.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
+	 * @param  object $post    The post object of the cpt that was saved.
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
+			//get out we're not processing an event save.
+			return;
+		}
+		$event_values = array(
+			'EVT_display_desc'                => ! empty($this->_req_data['display_desc']) ? 1 : 0,
+			'EVT_display_ticket_selector'     => ! empty($this->_req_data['display_ticket_selector']) ? 1 : 0,
+			'EVT_additional_limit'            => min(
+				apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
+				! empty($this->_req_data['additional_limit']) ? $this->_req_data['additional_limit'] : null
+			),
+			'EVT_default_registration_status' => ! empty($this->_req_data['EVT_default_registration_status'])
+				? $this->_req_data['EVT_default_registration_status']
+				: EE_Registry::instance()->CFG->registration->default_STS_ID,
+			'EVT_member_only'                 => ! empty($this->_req_data['member_only']) ? 1 : 0,
+			'EVT_allow_overflow'              => ! empty($this->_req_data['EVT_allow_overflow']) ? 1 : 0,
+			'EVT_timezone_string'             => ! empty($this->_req_data['timezone_string'])
+				? $this->_req_data['timezone_string'] : null,
+			'EVT_external_URL'                => ! empty($this->_req_data['externalURL'])
+				? $this->_req_data['externalURL'] : null,
+			'EVT_phone'                       => ! empty($this->_req_data['event_phone'])
+				? $this->_req_data['event_phone'] : null,
+		);
+		//update event
+		$success = $this->_event_model()->update_by_ID($event_values, $post_id);
+		//get event_object for other metaboxes... though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
+		$get_one_where = array(
+			$this->_event_model()->primary_key_name() => $post_id,
+			'OR' => array(
+				'status' => $post->post_status,
+				// if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
+				// but the returned object here has a status of "publish", so use the original post status as well
+				'status*1' => $this->_req_data['original_post_status'],
+			)
+		);
+		$event = $this->_event_model()->get_one(array($get_one_where));
+		//the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons.
+		$event_update_callbacks = apply_filters(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			array(
+				array($this, '_default_venue_update'),
+				array($this, '_default_tickets_update')
+			)
+		);
+		$att_success = true;
+		foreach ($event_update_callbacks as $e_callback) {
+			$_success = is_callable($e_callback)
+				? call_user_func($e_callback, $event, $this->_req_data)
+				: false;
+			//if ANY of these updates fail then we want the appropriate global error message
+			$att_success = ! $att_success ? $att_success : $_success;
+		}
+		//any errors?
+		if ($success && false === $att_success) {
+			EE_Error::add_error(
+				esc_html__(
+					'Event Details saved successfully but something went wrong with saving attachments.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else if ($success === false) {
+			EE_Error::add_error(
+				esc_html__('Event Details did not save successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+
+	/**
+	 * @see parent::restore_item()
+	 * @param int $post_id
+	 * @param int $revision_id
+	 */
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+		//copy existing event meta to new post
+		$post_evt = $this->_event_model()->get_one_by_ID($post_id);
+		if ($post_evt instanceof EE_Event) {
+			//meta revision restore
+			$post_evt->restore_revision($revision_id);
+			//related objs restore
+			$post_evt->restore_revision($revision_id, array('Venue', 'Datetime', 'Price'));
+		}
+	}
+
+
+
+	/**
+	 * Attach the venue to the Event
+	 *
+	 * @param  \EE_Event $evtobj Event Object to add the venue to
+	 * @param  array     $data   The request data from the form
+	 * @return bool           Success or fail.
+	 */
+	protected function _default_venue_update(\EE_Event $evtobj, $data)
+	{
+		require_once(EE_MODELS . 'EEM_Venue.model.php');
+		$venue_model = EE_Registry::instance()->load_model('Venue');
+		$rows_affected = null;
+		$venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
+		// very important.  If we don't have a venue name...
+		// then we'll get out because not necessary to create empty venue
+		if (empty($data['venue_title'])) {
+			return false;
+		}
+		$venue_array = array(
+			'VNU_wp_user'         => $evtobj->get('EVT_wp_user'),
+			'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
+			'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
+			'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
+			'VNU_short_desc'      => ! empty($data['venue_short_description']) ? $data['venue_short_description']
+				: null,
+			'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
+			'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
+			'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
+			'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
+			'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
+			'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
+			'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
+			'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
+			'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
+			'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
+			'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
+			'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
+			'status'              => 'publish',
+		);
+		//if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
+		if ( ! empty($venue_id)) {
+			$update_where = array($venue_model->primary_key_name() => $venue_id);
+			$rows_affected = $venue_model->update($venue_array, array($update_where));
+			//we've gotta make sure that the venue is always attached to a revision.. add_relation_to should take care of making sure that the relation is already present.
+			$evtobj->_add_relation_to($venue_id, 'Venue');
+			return $rows_affected > 0 ? true : false;
+		} else {
+			//we insert the venue
+			$venue_id = $venue_model->insert($venue_array);
+			$evtobj->_add_relation_to($venue_id, 'Venue');
+			return ! empty($venue_id) ? true : false;
+		}
+		//when we have the ancestor come in it's already been handled by the revision save.
+	}
+
+
+
+	/**
+	 * Handles saving everything related to Tickets (datetimes, tickets, prices)
+	 *
+	 * @param  EE_Event $evtobj The Event object we're attaching data to
+	 * @param  array    $data   The request data from the form
+	 * @return array
+	 */
+	protected function _default_tickets_update(EE_Event $evtobj, $data)
+	{
+		$success = true;
+		$saved_dtt = null;
+		$saved_tickets = array();
+		$incoming_date_formats = array('Y-m-d', 'h:i a');
+		foreach ($data['edit_event_datetimes'] as $row => $dtt) {
+			//trim all values to ensure any excess whitespace is removed.
+			$dtt = array_map('trim', $dtt);
+			$dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end']
+				: $dtt['DTT_EVT_start'];
+			$datetime_values = array(
+				'DTT_ID'        => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null,
+				'DTT_EVT_start' => $dtt['DTT_EVT_start'],
+				'DTT_EVT_end'   => $dtt['DTT_EVT_end'],
+				'DTT_reg_limit' => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'],
+				'DTT_order'     => $row,
+			);
+			//if we have an id then let's get existing object first and then set the new values.  Otherwise we instantiate a new object for save.
+			if ( ! empty($dtt['DTT_ID'])) {
+				$DTM = EE_Registry::instance()
+								  ->load_model('Datetime', array($evtobj->get_timezone()))
+								  ->get_one_by_ID($dtt['DTT_ID']);
+				$DTM->set_date_format($incoming_date_formats[0]);
+				$DTM->set_time_format($incoming_date_formats[1]);
+				foreach ($datetime_values as $field => $value) {
+					$DTM->set($field, $value);
+				}
+				//make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it.  We need to do this so we dont' TRASH the parent DTT.
+				$saved_dtts[$DTM->ID()] = $DTM;
+			} else {
+				$DTM = EE_Registry::instance()->load_class(
+					'Datetime',
+					array($datetime_values, $evtobj->get_timezone(), $incoming_date_formats),
+					false,
+					false
+				);
+				foreach ($datetime_values as $field => $value) {
+					$DTM->set($field, $value);
+				}
+			}
+			$DTM->save();
+			$DTT = $evtobj->_add_relation_to($DTM, 'Datetime');
+			//load DTT helper
+			//before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
+			if ($DTT->get_raw('DTT_EVT_start') > $DTT->get_raw('DTT_EVT_end')) {
+				$DTT->set('DTT_EVT_end', $DTT->get('DTT_EVT_start'));
+				$DTT = EEH_DTT_Helper::date_time_add($DTT, 'DTT_EVT_end', 'days');
+				$DTT->save();
+			}
+			//now we got to make sure we add the new DTT_ID to the $saved_dtts array  because it is possible there was a new one created for the autosave.
+			$saved_dtt = $DTT;
+			$success = ! $success ? $success : $DTT;
+			//if ANY of these updates fail then we want the appropriate global error message.
+			// //todo this is actually sucky we need a better error message but this is what it is for now.
+		}
+		//no dtts get deleted so we don't do any of that logic here.
+		//update tickets next
+		$old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
+		foreach ($data['edit_tickets'] as $row => $tkt) {
+			$incoming_date_formats = array('Y-m-d', 'h:i a');
+			$update_prices = false;
+			$ticket_price = isset($data['edit_prices'][$row][1]['PRC_amount'])
+				? $data['edit_prices'][$row][1]['PRC_amount'] : 0;
+			// trim inputs to ensure any excess whitespace is removed.
+			$tkt = array_map('trim', $tkt);
+			if (empty($tkt['TKT_start_date'])) {
+				//let's use now in the set timezone.
+				$now = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
+				$tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]);
+			}
+			if (empty($tkt['TKT_end_date'])) {
+				//use the start date of the first datetime
+				$dtt = $evtobj->first_datetime();
+				$tkt['TKT_end_date'] = $dtt->start_date_and_time(
+					$incoming_date_formats[0],
+					$incoming_date_formats[1]
+				);
+			}
+			$TKT_values = array(
+				'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
+				'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
+				'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
+				'TKT_description' => ! empty($tkt['TKT_description']) ? $tkt['TKT_description'] : '',
+				'TKT_start_date'  => $tkt['TKT_start_date'],
+				'TKT_end_date'    => $tkt['TKT_end_date'],
+				'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'],
+				'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'],
+				'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
+				'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
+				'TKT_row'         => $row,
+				'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : $row,
+				'TKT_price'       => $ticket_price,
+			);
+			//if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well.
+			if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
+				$TKT_values['TKT_ID'] = 0;
+				$TKT_values['TKT_is_default'] = 0;
+				$TKT_values['TKT_price'] = $ticket_price;
+				$update_prices = true;
+			}
+			//if we have a TKT_ID then we need to get that existing TKT_obj and update it
+			//we actually do our saves a head of doing any add_relations to because its entirely possible that this ticket didn't removed or added to any datetime in the session but DID have it's items modified.
+			//keep in mind that if the TKT has been sold (and we have changed pricing information), then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
+			if ( ! empty($tkt['TKT_ID'])) {
+				$TKT = EE_Registry::instance()
+								  ->load_model('Ticket', array($evtobj->get_timezone()))
+								  ->get_one_by_ID($tkt['TKT_ID']);
+				if ($TKT instanceof EE_Ticket) {
+					$ticket_sold = $TKT->count_related(
+						'Registration',
+						array(
+							array(
+								'STS_ID' => array(
+									'NOT IN',
+									array(EEM_Registration::status_id_incomplete),
+								),
+							),
+						)
+					) > 0 ? true : false;
+					//let's just check the total price for the existing ticket and determine if it matches the new total price.  if they are different then we create a new ticket (if tkts sold) if they aren't different then we go ahead and modify existing ticket.
+					$create_new_TKT = $ticket_sold && $ticket_price != $TKT->get('TKT_price')
+									  && ! $TKT->get(
+						'TKT_deleted'
+					) ? true : false;
+					$TKT->set_date_format($incoming_date_formats[0]);
+					$TKT->set_time_format($incoming_date_formats[1]);
+					//set new values
+					foreach ($TKT_values as $field => $value) {
+						if ($field == 'TKT_qty') {
+							$TKT->set_qty($value);
+						} else {
+							$TKT->set($field, $value);
+						}
+					}
+					//if $create_new_TKT is false then we can safely update the existing ticket.  Otherwise we have to create a new ticket.
+					if ($create_new_TKT) {
+						//archive the old ticket first
+						$TKT->set('TKT_deleted', 1);
+						$TKT->save();
+						//make sure this ticket is still recorded in our saved_tkts so we don't run it through the regular trash routine.
+						$saved_tickets[$TKT->ID()] = $TKT;
+						//create new ticket that's a copy of the existing except a new id of course (and not archived) AND has the new TKT_price associated with it.
+						$TKT = clone $TKT;
+						$TKT->set('TKT_ID', 0);
+						$TKT->set('TKT_deleted', 0);
+						$TKT->set('TKT_price', $ticket_price);
+						$TKT->set('TKT_sold', 0);
+						//now we need to make sure that $new prices are created as well and attached to new ticket.
+						$update_prices = true;
+					}
+					//make sure price is set if it hasn't been already
+					$TKT->set('TKT_price', $ticket_price);
+				}
+			} else {
+				//no TKT_id so a new TKT
+				$TKT_values['TKT_price'] = $ticket_price;
+				$TKT = EE_Registry::instance()->load_class('Ticket', array($TKT_values), false, false);
+				if ($TKT instanceof EE_Ticket) {
+					//need to reset values to properly account for the date formats
+					$TKT->set_date_format($incoming_date_formats[0]);
+					$TKT->set_time_format($incoming_date_formats[1]);
+					$TKT->set_timezone($evtobj->get_timezone());
+					//set new values
+					foreach ($TKT_values as $field => $value) {
+						if ($field == 'TKT_qty') {
+							$TKT->set_qty($value);
+						} else {
+							$TKT->set($field, $value);
+						}
+					}
+					$update_prices = true;
+				}
+			}
+			// cap ticket qty by datetime reg limits
+			$TKT->set_qty(min($TKT->qty(), $TKT->qty('reg_limit')));
+			//update ticket.
+			$TKT->save();
+			//before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
+			if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) {
+				$TKT->set('TKT_end_date', $TKT->get('TKT_start_date'));
+				$TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days');
+				$TKT->save();
+			}
+			//initially let's add the ticket to the dtt
+			$saved_dtt->_add_relation_to($TKT, 'Ticket');
+			$saved_tickets[$TKT->ID()] = $TKT;
+			//add prices to ticket
+			$this->_add_prices_to_ticket($data['edit_prices'][$row], $TKT, $update_prices);
+		}
+		//however now we need to handle permanently deleting tickets via the ui.  Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.  However, it does allow for deleting tickets that have no tickets sold, in which case we want to get rid of permanently because there is no need to save in db.
+		$old_tickets = isset($old_tickets[0]) && $old_tickets[0] == '' ? array() : $old_tickets;
+		$tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
+		foreach ($tickets_removed as $id) {
+			$id = absint($id);
+			//get the ticket for this id
+			$tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
+			//need to get all the related datetimes on this ticket and remove from every single one of them (remember this process can ONLY kick off if there are NO tkts_sold)
+			$dtts = $tkt_to_remove->get_many_related('Datetime');
+			foreach ($dtts as $dtt) {
+				$tkt_to_remove->_remove_relation_to($dtt, 'Datetime');
+			}
+			//need to do the same for prices (except these prices can also be deleted because again, tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
+			$tkt_to_remove->delete_related_permanently('Price');
+			//finally let's delete this ticket (which should not be blocked at this point b/c we've removed all our relationships)
+			$tkt_to_remove->delete_permanently();
+		}
+		return array($saved_dtt, $saved_tickets);
+	}
+
+
+
+	/**
+	 * This attaches a list of given prices to a ticket.
+	 * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
+	 * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
+	 * price info and prices are automatically "archived" via the ticket.
+	 *
+	 * @access  private
+	 * @param array     $prices     Array of prices from the form.
+	 * @param EE_Ticket $ticket     EE_Ticket object that prices are being attached to.
+	 * @param bool      $new_prices Whether attach existing incoming prices or create new ones.
+	 * @return  void
+	 */
+	private function _add_prices_to_ticket($prices, EE_Ticket $ticket, $new_prices = false)
+	{
+		foreach ($prices as $row => $prc) {
+			$PRC_values = array(
+				'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
+				'PRT_ID'         => ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null,
+				'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
+				'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
+				'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
+				'PRC_is_default' => 0, //make sure prices are NOT set as default from this context
+				'PRC_order'      => $row,
+			);
+			if ($new_prices || empty($PRC_values['PRC_ID'])) {
+				$PRC_values['PRC_ID'] = 0;
+				$PRC = EE_Registry::instance()->load_class('Price', array($PRC_values), false, false);
+			} else {
+				$PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
+				//update this price with new values
+				foreach ($PRC_values as $field => $newprc) {
+					$PRC->set($field, $newprc);
+				}
+				$PRC->save();
+			}
+			$ticket->_add_relation_to($PRC, 'Price');
+		}
+	}
+
+
+
+	/**
+	 * Add in our autosave ajax handlers
+	 *
+	 */
+	protected function _ee_autosave_create_new()
+	{
+	}
+
+
+	/**
+	 * More autosave handlers.
+	 */
+	protected function _ee_autosave_edit()
+	{
+		return; //TEMPORARILY EXITING CAUSE THIS IS A TODO
+	}
+
+
+
+	/**
+	 *    _generate_publish_box_extra_content
+	 */
+	private function _generate_publish_box_extra_content()
+	{
+		//load formatter helper
+		//args for getting related registrations
+		$approved_query_args = array(
+			array(
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_approved,
+			),
+		);
+		$not_approved_query_args = array(
+			array(
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_not_approved,
+			),
+		);
+		$pending_payment_query_args = array(
+			array(
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_pending_payment,
+			),
+		);
+		// publish box
+		$publish_box_extra_args = array(
+			'view_approved_reg_url'        => add_query_arg(
+				array(
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_approved,
+				),
+				REG_ADMIN_URL
+			),
+			'view_not_approved_reg_url'    => add_query_arg(
+				array(
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				),
+				REG_ADMIN_URL
+			),
+			'view_pending_payment_reg_url' => add_query_arg(
+				array(
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
+				),
+				REG_ADMIN_URL
+			),
+			'approved_regs'                => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$approved_query_args
+			),
+			'not_approved_regs'            => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$not_approved_query_args
+			),
+			'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$pending_payment_query_args
+			),
+			'misc_pub_section_class'       => apply_filters(
+				'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
+				'misc-pub-section'
+			),
+		);
+		ob_start();
+		do_action(
+			'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
+			$this->_cpt_model_obj
+		);
+		$publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
+		// load template
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
+			$publish_box_extra_args
+		);
+	}
+
+
+
+	/**
+	 * @return EE_Event
+	 */
+	public function get_event_object()
+	{
+		return $this->_cpt_model_obj;
+	}
+
+
+
+
+	/** METABOXES * */
+	/**
+	 * _register_event_editor_meta_boxes
+	 * add all metaboxes related to the event_editor
+	 *
+	 * @return void
+	 */
+	protected function _register_event_editor_meta_boxes()
+	{
+		$this->verify_cpt_object();
+		add_meta_box(
+			'espresso_event_editor_tickets',
+			esc_html__('Event Datetime & Ticket', 'event_espresso'),
+			array($this, 'ticket_metabox'),
+			$this->page_slug,
+			'normal',
+			'high'
+		);
+		add_meta_box(
+			'espresso_event_editor_event_options',
+			esc_html__('Event Registration Options', 'event_espresso'),
+			array($this, 'registration_options_meta_box'),
+			$this->page_slug,
+			'side',
+			'default'
+		);
+		// NOTE: if you're looking for other metaboxes in here,
+		// where a metabox has a related management page in the admin
+		// you will find it setup in the related management page's "_Hooks" file.
+		// i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function ticket_metabox()
+	{
+		$existing_datetime_ids = $existing_ticket_ids = array();
+		//defaults for template args
+		$template_args = array(
+			'existing_datetime_ids'    => '',
+			'event_datetime_help_link' => '',
+			'ticket_options_help_link' => '',
+			'time'                     => null,
+			'ticket_rows'              => '',
+			'existing_ticket_ids'      => '',
+			'total_ticket_rows'        => 1,
+			'ticket_js_structure'      => '',
+			'trash_icon'               => 'ee-lock-icon',
+			'disabled'                 => '',
+		);
+		$event_id = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		/**
+		 * 1. Start with retrieving Datetimes
+		 * 2. Fore each datetime get related tickets
+		 * 3. For each ticket get related prices
+		 */
+		$times = EE_Registry::instance()->load_model('Datetime')->get_all_event_dates($event_id);
+		/** @type EE_Datetime $first_datetime */
+		$first_datetime = reset($times);
+		//do we get related tickets?
+		if ($first_datetime instanceof EE_Datetime
+			&& $first_datetime->ID() !== 0
+		) {
+			$existing_datetime_ids[] = $first_datetime->get('DTT_ID');
+			$template_args['time'] = $first_datetime;
+			$related_tickets = $first_datetime->tickets(
+				array(
+					array('OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0)),
+					'default_where_conditions' => 'none',
+				)
+			);
+			if ( ! empty($related_tickets)) {
+				$template_args['total_ticket_rows'] = count($related_tickets);
+				$row = 0;
+				foreach ($related_tickets as $ticket) {
+					$existing_ticket_ids[] = $ticket->get('TKT_ID');
+					$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
+					$row++;
+				}
+			} else {
+				$template_args['total_ticket_rows'] = 1;
+				/** @type EE_Ticket $ticket */
+				$ticket = EE_Registry::instance()->load_model('Ticket')->create_default_object();
+				$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
+			}
+		} else {
+			$template_args['time'] = $times[0];
+			/** @type EE_Ticket $ticket */
+			$ticket = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets();
+			$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket[1]);
+			// NOTE: we're just sending the first default row
+			// (decaf can't manage default tickets so this should be sufficient);
+		}
+		$template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
+			'event_editor_event_datetimes_help_tab'
+		);
+		$template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
+		$template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
+		$template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids);
+		$template_args['ticket_js_structure'] = $this->_get_ticket_row(
+			EE_Registry::instance()->load_model('Ticket')->create_default_object(),
+			true
+		);
+		$template = apply_filters(
+			'FHEE__Events_Admin_Page__ticket_metabox__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
+		);
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+
+	/**
+	 * Setup an individual ticket form for the decaf event editor page
+	 *
+	 * @access private
+	 * @param  EE_Ticket $ticket   the ticket object
+	 * @param  boolean   $skeleton whether we're generating a skeleton for js manipulation
+	 * @param int        $row
+	 * @return string generated html for the ticket row.
+	 */
+	private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
+	{
+		$template_args = array(
+			'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
+			'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
+				: '',
+			'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
+			'TKT_ID'              => $ticket->get('TKT_ID'),
+			'TKT_name'            => $ticket->get('TKT_name'),
+			'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
+			'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
+			'TKT_is_default'      => $ticket->get('TKT_is_default'),
+			'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
+			'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
+			'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
+			'trash_icon'          => ($skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')))
+									 && ( ! empty($ticket) && $ticket->get('TKT_sold') === 0)
+				? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon',
+			'disabled'            => $skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
+				: ' disabled=disabled',
+		);
+		$price = $ticket->ID() !== 0
+			? $ticket->get_first_related('Price', array('default_where_conditions' => 'none'))
+			: EE_Registry::instance()->load_model('Price')->create_default_object();
+		$price_args = array(
+			'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
+			'PRC_amount'            => $price->get('PRC_amount'),
+			'PRT_ID'                => $price->get('PRT_ID'),
+			'PRC_ID'                => $price->get('PRC_ID'),
+			'PRC_is_default'        => $price->get('PRC_is_default'),
+		);
+		//make sure we have default start and end dates if skeleton
+		//handle rows that should NOT be empty
+		if (empty($template_args['TKT_start_date'])) {
+			//if empty then the start date will be now.
+			$template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
+		}
+		if (empty($template_args['TKT_end_date'])) {
+			//get the earliest datetime (if present);
+			$earliest_dtt = $this->_cpt_model_obj->ID() > 0
+				? $this->_cpt_model_obj->get_first_related(
+					'Datetime',
+					array('order_by' => array('DTT_EVT_start' => 'ASC'))
+				)
+				: null;
+			if ( ! empty($earliest_dtt)) {
+				$template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a');
+			} else {
+				$template_args['TKT_end_date'] = date(
+					'Y-m-d h:i a',
+					mktime(0, 0, 0, date("m"), date("d") + 7, date("Y"))
+				);
+			}
+		}
+		$template_args = array_merge($template_args, $price_args);
+		$template = apply_filters(
+			'FHEE__Events_Admin_Page__get_ticket_row__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
+			$ticket
+		);
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 */
+	public function registration_options_meta_box()
+	{
+		$yes_no_values = array(
+			array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
+			array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
+		);
+		$default_reg_status_values = EEM_Registration::reg_status_array(
+			array(
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+			),
+			true
+		);
+		//$template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
+		$template_args['_event'] = $this->_cpt_model_obj;
+		$template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
+		$template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
+		$template_args['default_registration_status'] = EEH_Form_Fields::select_input(
+			'default_reg_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['display_description'] = EEH_Form_Fields::select_input(
+			'display_desc',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_description()
+		);
+		$template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
+			'display_ticket_selector',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_ticket_selector(),
+			'',
+			'',
+			false
+		);
+		$template_args['additional_registration_options'] = apply_filters(
+			'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
+			'',
+			$template_args,
+			$yes_no_values,
+			$default_reg_status_values
+		);
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
+			$template_args
+		);
+	}
+
+
+
+	/**
+	 * _get_events()
+	 * This method simply returns all the events (for the given _view and paging)
+	 *
+	 * @access public
+	 * @param int  $per_page     count of items per page (20 default);
+	 * @param int  $current_page what is the current page being viewed.
+	 * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
+	 *                           If FALSE then we return an array of event objects
+	 *                           that match the given _view and paging parameters.
+	 * @return array an array of event objects.
+	 */
+	public function get_events($per_page = 10, $current_page = 1, $count = false)
+	{
+		$EEME = $this->_event_model();
+		$offset = ($current_page - 1) * $per_page;
+		$limit = $count ? null : $offset . ',' . $per_page;
+		$orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID';
+		$order = isset($this->_req_data['order']) ? $this->_req_data['order'] : "DESC";
+		if (isset($this->_req_data['month_range'])) {
+			$pieces = explode(' ', $this->_req_data['month_range'], 3);
+			//simulate the FIRST day of the month, that fixes issues for months like February
+			//where PHP doesn't know what to assume for date.
+			//@see https://events.codebasehq.com/projects/event-espresso/tickets/10437
+			$month_r = ! empty($pieces[0]) ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
+			$year_r = ! empty($pieces[1]) ? $pieces[1] : '';
+		}
+		$where = array();
+		$status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
+		//determine what post_status our condition will have for the query.
+		switch ($status) {
+			case 'month' :
+			case 'today' :
+			case null :
+			case 'all' :
+				break;
+			case 'draft' :
+				$where['status'] = array('IN', array('draft', 'auto-draft'));
+				break;
+			default :
+				$where['status'] = $status;
+		}
+		//categories?
+		$category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
+			? $this->_req_data['EVT_CAT'] : null;
+		if ( ! empty ($category)) {
+			$where['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+			$where['Term_Taxonomy.term_id'] = $category;
+		}
+		//date where conditions
+		$start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
+		if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] != '') {
+			$DateTime = new DateTime(
+				$year_r . '-' . $month_r . '-01 00:00:00',
+				new DateTimeZone(EEM_Datetime::instance()->get_timezone())
+			);
+			$start = $DateTime->format(implode(' ', $start_formats));
+			$end = $DateTime->setDate($year_r, $month_r, $DateTime
+				->format('t'))->setTime(23, 59, 59)
+							->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
+		} else if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'today') {
+			$DateTime = new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
+			$end = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
+		} else if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'month') {
+			$now = date('Y-m-01');
+			$DateTime = new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
+			$end = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
+							->setTime(23, 59, 59)
+							->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
+		}
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+			$where['EVT_wp_user'] = get_current_user_id();
+		} else {
+			if ( ! isset($where['status'])) {
+				if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
+					$where['OR'] = array(
+						'status*restrict_private' => array('!=', 'private'),
+						'AND'                     => array(
+							'status*inclusive' => array('=', 'private'),
+							'EVT_wp_user'      => get_current_user_id(),
+						),
+					);
+				}
+			}
+		}
+		if (isset($this->_req_data['EVT_wp_user'])) {
+			if ($this->_req_data['EVT_wp_user'] != get_current_user_id()
+				&& EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
+			) {
+				$where['EVT_wp_user'] = $this->_req_data['EVT_wp_user'];
+			}
+		}
+		//search query handling
+		if (isset($this->_req_data['s'])) {
+			$search_string = '%' . $this->_req_data['s'] . '%';
+			$where['OR'] = array(
+				'EVT_name'       => array('LIKE', $search_string),
+				'EVT_desc'       => array('LIKE', $search_string),
+				'EVT_short_desc' => array('LIKE', $search_string),
+			);
+		}
+		$where = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $this->_req_data);
+		$query_params = apply_filters(
+			'FHEE__Events_Admin_Page__get_events__query_params',
+			array(
+				$where,
+				'limit'    => $limit,
+				'order_by' => $orderby,
+				'order'    => $order,
+				'group_by' => 'EVT_ID',
+			),
+			$this->_req_data
+		);
+		//let's first check if we have special requests coming in.
+		if (isset($this->_req_data['active_status'])) {
+			switch ($this->_req_data['active_status']) {
+				case 'upcoming' :
+					return $EEME->get_upcoming_events($query_params, $count);
+					break;
+				case 'expired' :
+					return $EEME->get_expired_events($query_params, $count);
+					break;
+				case 'active' :
+					return $EEME->get_active_events($query_params, $count);
+					break;
+				case 'inactive' :
+					return $EEME->get_inactive_events($query_params, $count);
+					break;
+			}
+		}
+		$events = $count ? $EEME->count(array($where), 'EVT_ID', true) : $EEME->get_all($query_params);
+		return $events;
+	}
+
+
+
+	/**
+	 * handling for WordPress CPT actions (trash, restore, delete)
+	 *
+	 * @param string $post_id
+	 */
+	public function trash_cpt_item($post_id)
+	{
+		$this->_req_data['EVT_ID'] = $post_id;
+		$this->_trash_or_restore_event('trash', false);
+	}
+
+
+
+	/**
+	 * @param string $post_id
+	 */
+	public function restore_cpt_item($post_id)
+	{
+		$this->_req_data['EVT_ID'] = $post_id;
+		$this->_trash_or_restore_event('draft', false);
+	}
+
+
+
+	/**
+	 * @param string $post_id
+	 */
+	public function delete_cpt_item($post_id)
+	{
+		$this->_req_data['EVT_ID'] = $post_id;
+		$this->_delete_event(false);
+	}
+
+
+
+	/**
+	 * _trash_or_restore_event
+	 *
+	 * @access protected
+	 * @param  string $event_status
+	 * @param bool    $redirect_after
+	 */
+	protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
+	{
+		//determine the event id and set to array.
+		$EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : false;
+		// loop thru events
+		if ($EVT_ID) {
+			// clean status
+			$event_status = sanitize_key($event_status);
+			// grab status
+			if ( ! empty($event_status)) {
+				$success = $this->_change_event_status($EVT_ID, $event_status);
+			} else {
+				$success = false;
+				$msg = esc_html__(
+					'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		} else {
+			$success = false;
+			$msg = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		$action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Event', $action, array('action' => 'default'));
+		}
+	}
+
+
+
+	/**
+	 * _trash_or_restore_events
+	 *
+	 * @access protected
+	 * @param  string $event_status
+	 * @return void
+	 */
+	protected function _trash_or_restore_events($event_status = 'trash')
+	{
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if ( ! empty($event_status)) {
+			$success = true;
+			//determine the event id and set to array.
+			$EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
+			// loop thru events
+			foreach ($EVT_IDs as $EVT_ID) {
+				if ($EVT_ID = absint($EVT_ID)) {
+					$results = $this->_change_event_status($EVT_ID, $event_status);
+					$success = $results !== false ? $success : false;
+				} else {
+					$msg = sprintf(
+						esc_html__(
+							'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
+							'event_espresso'
+						),
+						$EVT_ID
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+					$success = false;
+				}
+			}
+		} else {
+			$success = false;
+			$msg = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+		$this->_redirect_after_action($success, 'Events', $action, array('action' => 'default'));
+	}
+
+
+
+	/**
+	 * _trash_or_restore_events
+	 *
+	 * @access  private
+	 * @param  int    $EVT_ID
+	 * @param  string $event_status
+	 * @return bool
+	 */
+	private function _change_event_status($EVT_ID = 0, $event_status = '')
+	{
+		// grab event id
+		if ( ! $EVT_ID) {
+			$msg = esc_html__(
+				'An error occurred. No Event ID or an invalid Event ID was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if (empty($event_status)) {
+			$msg = esc_html__(
+				'An error occurred. No Event Status or an invalid Event Status was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// was event trashed or restored ?
+		switch ($event_status) {
+			case 'draft' :
+				$action = 'restored from the trash';
+				$hook = 'AHEE_event_restored_from_trash';
+				break;
+			case 'trash' :
+				$action = 'moved to the trash';
+				$hook = 'AHEE_event_moved_to_trash';
+				break;
+			default :
+				$action = 'updated';
+				$hook = false;
+		}
+		//use class to change status
+		$this->_cpt_model_obj->set_status($event_status);
+		$success = $this->_cpt_model_obj->save();
+		if ($success === false) {
+			$msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if ($hook) {
+			do_action($hook);
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _delete_event
+	 *
+	 * @access protected
+	 * @param bool $redirect_after
+	 */
+	protected function _delete_event($redirect_after = true)
+	{
+		//determine the event id and set to array.
+		$EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : null;
+		$EVT_ID = isset($this->_req_data['post']) ? absint($this->_req_data['post']) : $EVT_ID;
+		// loop thru events
+		if ($EVT_ID) {
+			$success = $this->_permanently_delete_event($EVT_ID);
+			// get list of events with no prices
+			$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
+			// remove this event from the list of events with no prices
+			if (isset($espresso_no_ticket_prices[$EVT_ID])) {
+				unset($espresso_no_ticket_prices[$EVT_ID]);
+			}
+			update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
+		} else {
+			$success = false;
+			$msg = esc_html__(
+				'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		if ($redirect_after) {
+			$this->_redirect_after_action(
+				$success,
+				'Event',
+				'deleted',
+				array('action' => 'default', 'status' => 'trash')
+			);
+		}
+	}
+
+
+
+	/**
+	 * _delete_events
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _delete_events()
+	{
+		$success = true;
+		// get list of events with no prices
+		$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
+		//determine the event id and set to array.
+		$EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
+		// loop thru events
+		foreach ($EVT_IDs as $EVT_ID) {
+			$EVT_ID = absint($EVT_ID);
+			if ($EVT_ID) {
+				$results = $this->_permanently_delete_event($EVT_ID);
+				$success = $results !== false ? $success : false;
+				// remove this event from the list of events with no prices
+				unset($espresso_no_ticket_prices[$EVT_ID]);
+			} else {
+				$success = false;
+				$msg = esc_html__(
+					'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$this->_redirect_after_action($success, 'Events', 'deleted', array('action' => 'default'));
+	}
+
+
+
+	/**
+	 * _permanently_delete_event
+	 *
+	 * @access  private
+	 * @param  int $EVT_ID
+	 * @return bool
+	 */
+	private function _permanently_delete_event($EVT_ID = 0)
+	{
+		// grab event id
+		if ( ! $EVT_ID) {
+			$msg = esc_html__(
+				'An error occurred. No Event ID or an invalid Event ID was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (
+			! $this->_cpt_model_obj instanceof EE_Event
+			|| $this->_cpt_model_obj->ID() !== $EVT_ID
+		) {
+			$this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		}
+		if ( ! $this->_cpt_model_obj instanceof EE_Event) {
+			return false;
+		}
+		//need to delete related tickets and prices first.
+		$datetimes = $this->_cpt_model_obj->get_many_related('Datetime');
+		foreach ($datetimes as $datetime) {
+			$this->_cpt_model_obj->_remove_relation_to($datetime, 'Datetime');
+			$tickets = $datetime->get_many_related('Ticket');
+			foreach ($tickets as $ticket) {
+				$ticket->_remove_relation_to($datetime, 'Datetime');
+				$ticket->delete_related_permanently('Price');
+				$ticket->delete_permanently();
+			}
+			$datetime->delete();
+		}
+		//what about related venues or terms?
+		$venues = $this->_cpt_model_obj->get_many_related('Venue');
+		foreach ($venues as $venue) {
+			$this->_cpt_model_obj->_remove_relation_to($venue, 'Venue');
+		}
+		//any attached question groups?
+		$question_groups = $this->_cpt_model_obj->get_many_related('Question_Group');
+		if ( ! empty($question_groups)) {
+			foreach ($question_groups as $question_group) {
+				$this->_cpt_model_obj->_remove_relation_to($question_group, 'Question_Group');
+			}
+		}
+		//Message Template Groups
+		$this->_cpt_model_obj->_remove_relations('Message_Template_Group');
+		/** @type EE_Term_Taxonomy[] $term_taxonomies */
+		$term_taxonomies = $this->_cpt_model_obj->term_taxonomies();
+		foreach ($term_taxonomies as $term_taxonomy) {
+			$this->_cpt_model_obj->remove_relation_to_term_taxonomy($term_taxonomy);
+		}
+		$success = $this->_cpt_model_obj->delete_permanently();
+		// did it all go as planned ?
+		if ($success) {
+			$msg = sprintf(esc_html__('Event ID # %d has been deleted.', 'event_espresso'), $EVT_ID);
+			EE_Error::add_success($msg);
+		} else {
+			$msg = sprintf(
+				esc_html__('An error occurred. Event ID # %d could not be deleted.', 'event_espresso'),
+				$EVT_ID
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		do_action('AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted', $EVT_ID);
+		return true;
+	}
+
+
+
+	/**
+	 * get total number of events
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function total_events()
+	{
+		$count = EEM_Event::instance()->count(array('caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+
+	/**
+	 * get total number of draft events
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function total_events_draft()
+	{
+		$where = array(
+			'status' => array('IN', array('draft', 'auto-draft')),
+		);
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+
+	/**
+	 * get total number of trashed events
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function total_trashed_events()
+	{
+		$where = array(
+			'status' => 'trash',
+		);
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+	/**
+	 *    _default_event_settings
+	 *    This generates the Default Settings Tab
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _default_event_settings()
+	{
+		$this->_set_add_edit_form_tags('update_default_event_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Return the form for event settings.
+	 * @return EE_Form_Section_Proper
+	 */
+	protected function _default_event_settings_form()
+	{
+		$registration_config = EE_Registry::instance()->CFG->registration;
+		$registration_stati_for_selection = EEM_Registration::reg_status_array(
+		//exclude
+			array(
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_wait_list,
+			),
+			true
+		);
+		return new EE_Form_Section_Proper(
+			array(
+				'name' => 'update_default_event_settings',
+				'html_id' => 'update_default_event_settings',
+				'html_class' => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections' => apply_filters(
+					'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
+					array(
+						'default_reg_status' => new EE_Select_Input(
+							$registration_stati_for_selection,
+							array(
+								'default' => isset($registration_config->default_STS_ID)
+											 && array_key_exists(
+												$registration_config->default_STS_ID,
+												$registration_stati_for_selection
+											 )
+											? sanitize_text_field($registration_config->default_STS_ID)
+											: EEM_Registration::status_id_pending_payment,
+								'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
+													. EEH_Template::get_help_tab_link(
+														'default_settings_status_help_tab'
+													),
+								'html_help_text' => esc_html__(
+									'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
+									'event_espresso'
+								)
+							)
+						),
+						'default_max_tickets' => new EE_Integer_Input(
+							array(
+								'default' => isset($registration_config->default_maximum_number_of_tickets)
+									? $registration_config->default_maximum_number_of_tickets
+									: EEM_Event::get_default_additional_limit(),
+								'html_label_text' => esc_html__(
+									'Default Maximum Tickets Allowed Per Order:',
+									'event_espresso'
+								) . EEH_Template::get_help_tab_link(
+									'default_maximum_tickets_help_tab"'
+									),
+								'html_help_text' => esc_html__(
+									'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
+									'event_espresso'
+								)
+							)
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _update_default_event_settings
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _update_default_event_settings()
+	{
+		$registration_config = EE_Registry::instance()->CFG->registration;
+		$form = $this->_default_event_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$valid_data = $form->valid_data();
+				if (isset($valid_data['default_reg_status'])) {
+					$registration_config->default_STS_ID = $valid_data['default_reg_status'];
+				}
+				if (isset($valid_data['default_max_tickets'])) {
+					$registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
+				}
+				//update because data was valid!
+				EE_Registry::instance()->CFG->update_espresso_config();
+				EE_Error::overwrite_success();
+				EE_Error::add_success(
+					__('Default Event Settings were updated', 'event_espresso')
+				);
+			}
+		}
+		$this->_redirect_after_action(0, '', '', array('action' => 'default_event_settings'), true);
+	}
+
+
+
+	/*************        Templates        *************/
+	protected function _template_settings()
+	{
+		$this->_admin_page_title = esc_html__('Template Settings (Preview)', 'event_espresso');
+		$this->_template_args['preview_img'] = '<img src="'
+											   . EVENTS_ASSETS_URL
+											   . DS
+											   . 'images'
+											   . DS
+											   . 'caffeinated_template_features.jpg" alt="'
+											   . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
+											   . '" />';
+		$this->_template_args['preview_text'] = '<strong>' . esc_html__(
+				'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
+				'event_espresso'
+			) . '</strong>';
+		$this->display_admin_caf_preview_page('template_settings_tab');
+	}
+
+
+	/** Event Category Stuff **/
+	/**
+	 * set the _category property with the category object for the loaded page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_category_object()
+	{
+		if (isset($this->_category->id) && ! empty($this->_category->id)) {
+			return;
+		} //already have the category object so get out.
+		//set default category object
+		$this->_set_empty_category_object();
+		//only set if we've got an id
+		if ( ! isset($this->_req_data['EVT_CAT_ID'])) {
+			return;
+		}
+		$category_id = absint($this->_req_data['EVT_CAT_ID']);
+		$term = get_term($category_id, 'espresso_event_categories');
+		if ( ! empty($term)) {
+			$this->_category->category_name = $term->name;
+			$this->_category->category_identifier = $term->slug;
+			$this->_category->category_desc = $term->description;
+			$this->_category->id = $term->term_id;
+			$this->_category->parent = $term->parent;
+		}
+	}
+
+
+	/**
+	 * Clears out category properties.
+	 */
+	private function _set_empty_category_object()
+	{
+		$this->_category = new stdClass();
+		$this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
+		$this->_category->id = $this->_category->parent = 0;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _category_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_search_btn_label = esc_html__('Categories', 'event_espresso');
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+				'add_category',
+				'add_category',
+				array(),
+				'add-new-h2'
+			);
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+
+	/**
+	 * Output category details view.
+	 */
+	protected function _category_details($view)
+	{
+		//load formatter helper
+		//load field generator helper
+		$route = $view == 'edit' ? 'update_category' : 'insert_category';
+		$this->_set_add_edit_form_tags($route);
+		$this->_set_category_object();
+		$id = ! empty($this->_category->id) ? $this->_category->id : '';
+		$delete_action = 'delete_category';
+		//custom redirect
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'category_list'),
+			$this->_admin_base_url
+		);
+		$this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
+		//take care of contents
+		$this->_template_args['admin_page_content'] = $this->_category_details_content();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	/**
+	 * Output category details content.
+	 */
+	protected function _category_details_content()
+	{
+		$editor_args['category_desc'] = array(
+			'type'          => 'wp_editor',
+			'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
+			'class'         => 'my_editor_custom',
+			'wpeditor_args' => array('media_buttons' => false),
+		);
+		$_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
+		$all_terms = get_terms(
+			array('espresso_event_categories'),
+			array('hide_empty' => 0, 'exclude' => array($this->_category->id))
+		);
+		//setup category select for term parents.
+		$category_select_values[] = array(
+			'text' => esc_html__('No Parent', 'event_espresso'),
+			'id'   => 0,
+		);
+		foreach ($all_terms as $term) {
+			$category_select_values[] = array(
+				'text' => $term->name,
+				'id'   => $term->term_id,
+			);
+		}
+		$category_select = EEH_Form_Fields::select_input(
+			'category_parent',
+			$category_select_values,
+			$this->_category->parent
+		);
+		$template_args = array(
+			'category'                 => $this->_category,
+			'category_select'          => $category_select,
+			'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
+			'category_desc_editor'     => $_wp_editor['category_desc']['field'],
+			'disable'                  => '',
+			'disabled_message'         => false,
+		);
+		$template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * Handles deleting categories.
+	 */
+	protected function _delete_categories()
+	{
+		$cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array)$this->_req_data['EVT_CAT_ID']
+			: (array)$this->_req_data['category_id'];
+		foreach ($cat_ids as $cat_id) {
+			$this->_delete_category($cat_id);
+		}
+		//doesn't matter what page we're coming from... we're going to the same place after delete.
+		$query_args = array(
+			'action' => 'category_list',
+		);
+		$this->_redirect_after_action(0, '', '', $query_args);
+	}
+
+
+
+	/**
+	 * Handles deleting specific category.
+	 * @param int $cat_id
+	 */
+	protected function _delete_category($cat_id)
+	{
+		$cat_id = absint($cat_id);
+		wp_delete_term($cat_id, 'espresso_event_categories');
+	}
+
+
+
+	/**
+	 * Handles triggering the update or insertion of a new category.
+	 * @param bool $new_category  true means we're triggering the insert of a new category.
+	 */
+	protected function _insert_or_update_category($new_category)
+	{
+		$cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true);
+		$success = 0; //we already have a success message so lets not send another.
+		if ($cat_id) {
+			$query_args = array(
+				'action'     => 'edit_category',
+				'EVT_CAT_ID' => $cat_id,
+			);
+		} else {
+			$query_args = array('action' => 'add_category');
+		}
+		$this->_redirect_after_action($success, '', '', $query_args, true);
+	}
+
+
+
+	/**
+	 * Inserts or updates category
+	 * @param bool $update (true indicates we're updating a category).
+	 * @return bool|mixed|string
+	 */
+	private function _insert_category($update = false)
+	{
+		$cat_id = $update ? $this->_req_data['EVT_CAT_ID'] : '';
+		$category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : '';
+		$category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : '';
+		$category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0;
+		if (empty($category_name)) {
+			$msg = esc_html__('You must add a name for the category.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$term_args = array(
+			'name'        => $category_name,
+			'description' => $category_desc,
+			'parent'      => $category_parent,
+		);
+		//was the category_identifier input disabled?
+		if (isset($this->_req_data['category_identifier'])) {
+			$term_args['slug'] = $this->_req_data['category_identifier'];
+		}
+		$insert_ids = $update
+			? wp_update_term($cat_id, 'espresso_event_categories', $term_args)
+			: wp_insert_term($category_name, 'espresso_event_categories', $term_args);
+		if ( ! is_array($insert_ids)) {
+			$msg = esc_html__(
+				'An error occurred and the category has not been saved to the database.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		} else {
+			$cat_id = $insert_ids['term_id'];
+			$msg = sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name);
+			EE_Error::add_success($msg);
+		}
+		return $cat_id;
+	}
+
+
+
+	/**
+	 * Gets categories or count of categories matching the arguments in the request.
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return EE_Base_Class[]|EE_Term_Taxonomy[]|int
+	 */
+	public function get_categories($per_page = 10, $current_page = 1, $count = false)
+	{
+		//testing term stuff
+		$orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id';
+		$order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
+		$limit = ($current_page - 1) * $per_page;
+		$where = array('taxonomy' => 'espresso_event_categories');
+		if (isset($this->_req_data['s'])) {
+			$sstr = '%' . $this->_req_data['s'] . '%';
+			$where['OR'] = array(
+				'Term.name'   => array('LIKE', $sstr),
+				'description' => array('LIKE', $sstr),
+			);
+		}
+		$query_params = array(
+			$where,
+			'order_by'   => array($orderby => $order),
+			'limit'      => $limit . ',' . $per_page,
+			'force_join' => array('Term'),
+		);
+		$categories = $count
+			? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
+			: EEM_Term_Taxonomy::instance()->get_all($query_params);
+		return $categories;
+	}
+
+	/* end category stuff */
+	/**************/
+
+
+	/**
+	 * Callback for the `ee_save_timezone_setting` ajax action.
+	 * @throws EE_Error
+	 */
+	public function save_timezonestring_setting()
+	{
+		$timezone_string = isset($this->_req_data['timezone_selected'])
+			? $this->_req_data['timezone_selected']
+			: '';
+		if  (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false))
+		{
+			EE_Error::add_error(
+				esc_html('An invalid timezone string submitted.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+
+		update_option('timezone_string', $timezone_string);
+		EE_Error::add_success(
+			esc_html__('Your timezone string was updated.', 'event_espresso')
+		);
+		$this->_template_args['success'] = true;
+		$this->_return_json(true, array('action' => 'create_new'));
+	}
 }
 //end class Events_Admin_Page

core/db_classes/EE_Base_Class.class.php

Spacing +20 added lines, -20 removed lines

@@ -155,8 +155,8 @@ 
             list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
         } else {
             //set default formats for date and time
-            $this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
-            $this->_tm_frmt = (string)get_option('time_format', 'g:i a');
+            $this->_dt_frmt = (string) get_option('date_format', 'Y-m-d');
+            $this->_tm_frmt = (string) get_option('time_format', 'g:i a');
         }
         //if db model is instantiating
         if ($bydb) {
@@ -478,7 +478,7 @@ 
      */
     public function get_format($full = true)
     {
-        return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
+        return $full ? $this->_dt_frmt.' '.$this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
     }
 
 
@@ -587,7 +587,7 @@ 
         $model = $this->get_model();
         $model->field_settings_for($fieldname);
         $cache_type = $pretty ? 'pretty' : 'standard';
-        $cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
+        $cache_type .= ! empty($extra_cache_ref) ? '_'.$extra_cache_ref : '';
         if (isset($this->_cached_properties[$fieldname][$cache_type])) {
             return $this->_cached_properties[$fieldname][$cache_type];
         }
@@ -802,7 +802,7 @@ 
         $current_cache_id = ''
     ) {
         // verify that incoming object is of the correct type
-        $obj_class = 'EE_' . $relationName;
+        $obj_class = 'EE_'.$relationName;
         if ($newly_saved_object instanceof $obj_class) {
             /* @type EE_Base_Class $newly_saved_object */
             // now get the type of relation
@@ -1288,7 +1288,7 @@ 
      */
     public function get_i18n_datetime($field_name, $format = '')
     {
-        $format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
+        $format = empty($format) ? $this->_dt_frmt.' '.$this->_tm_frmt : $format;
         return date_i18n(
             $format,
             EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
@@ -1426,8 +1426,8 @@ 
         }
         $original_timezone = $this->_timezone;
         $this->set_timezone($timezone);
-        $fn = (array)$field_name;
-        $args = array_merge($fn, (array)$args);
+        $fn = (array) $field_name;
+        $args = array_merge($fn, (array) $args);
         if ( ! method_exists($this, $callback)) {
             throw new EE_Error(
                 sprintf(
@@ -1439,8 +1439,8 @@ 
                 )
             );
         }
-        $args = (array)$args;
-        $return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
+        $args = (array) $args;
+        $return = $prepend.call_user_func_array(array($this, $callback), $args).$append;
         $this->set_timezone($original_timezone);
         return $return;
     }
@@ -1579,14 +1579,14 @@ 
          * @param array         $set_cols_n_values
          * @param EE_Base_Class $model_object
          */
-        $set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
+        $set_cols_n_values = (array) apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
             $this);
         //set attributes as provided in $set_cols_n_values
         foreach ($set_cols_n_values as $column => $value) {
             $this->set($column, $value);
         }
         // no changes ? then don't do anything
-        if (! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
+        if ( ! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
             return 0;
         }
         /**
@@ -1638,8 +1638,8 @@ 
                                 __('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
                                     'event_espresso'),
                                 get_class($this),
-                                get_class($model) . '::instance()->add_to_entity_map()',
-                                get_class($model) . '::instance()->get_one_by_ID()',
+                                get_class($model).'::instance()->add_to_entity_map()',
+                                get_class($model).'::instance()->get_one_by_ID()',
                                 '<br />'
                             )
                         );
@@ -1772,7 +1772,7 @@ 
      */
     public function get_model()
     {
-        if( ! $this->_model){
+        if ( ! $this->_model) {
             $modelName = self::_get_model_classname(get_class($this));
             $this->_model = self::_get_model_instance_with_name($modelName, $this->_timezone);
         } else {
@@ -1915,7 +1915,7 @@ 
         if (strpos($model_name, "EE_") === 0) {
             $model_classname = str_replace("EE_", "EEM_", $model_name);
         } else {
-            $model_classname = "EEM_" . $model_name;
+            $model_classname = "EEM_".$model_name;
         }
         return $model_classname;
     }
@@ -2302,7 +2302,7 @@ 
      */
     protected function _property_exists($properties)
     {
-        foreach ((array)$properties as $property_name) {
+        foreach ((array) $properties as $property_name) {
             //first make sure this property exists
             if ( ! $this->_fields[$property_name]) {
                 throw new EE_Error(
@@ -2632,8 +2632,8 @@ 
                         __('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
                             'event_espresso'),
                         $this->ID(),
-                        get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                        get_class($this->get_model()) . '::instance()->refresh_entity_map()'
+                        get_class($this->get_model()).'::instance()->add_to_entity_map()',
+                        get_class($this->get_model()).'::instance()->refresh_entity_map()'
                     )
                 );
             }
@@ -2693,7 +2693,7 @@ 
         $model = $this->get_model();
         foreach ($model->relation_settings() as $relation_name => $relation_obj) {
             if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $classname = 'EE_' . $model->get_this_model_name();
+                $classname = 'EE_'.$model->get_this_model_name();
                 if (
                     $this->get_one_from_cache($relation_name) instanceof $classname
                     && $this->get_one_from_cache($relation_name)->ID()

Indentation +2709 added lines, -2709 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 do_action('AHEE_log', __FILE__, ' FILE LOADED', '');
 
@@ -25,2714 +25,2714 @@ 
 abstract class EE_Base_Class
 {
 
-    /**
-     * This is an array of the original properties and values provided during construction
-     * of this model object. (keys are model field names, values are their values).
-     * This list is important to remember so that when we are merging data from the db, we know
-     * which values to override and which to not override.
-     *
-     * @var array
-     */
-    protected $_props_n_values_provided_in_constructor;
-
-    /**
-     * Timezone
-     * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
-     * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
-     * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
-     * access to it.
-     *
-     * @var string
-     */
-    protected $_timezone;
-
-
-
-    /**
-     * date format
-     * pattern or format for displaying dates
-     *
-     * @var string $_dt_frmt
-     */
-    protected $_dt_frmt;
-
-
-
-    /**
-     * time format
-     * pattern or format for displaying time
-     *
-     * @var string $_tm_frmt
-     */
-    protected $_tm_frmt;
-
-
-
-    /**
-     * This property is for holding a cached array of object properties indexed by property name as the key.
-     * The purpose of this is for setting a cache on properties that may have calculated values after a
-     * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
-     * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
-     *
-     * @var array
-     */
-    protected $_cached_properties = array();
-
-    /**
-     * An array containing keys of the related model, and values are either an array of related mode objects or a
-     * single
-     * related model object. see the model's _model_relations. The keys should match those specified. And if the
-     * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
-     * all others have an array)
-     *
-     * @var array
-     */
-    protected $_model_relations = array();
-
-    /**
-     * Array where keys are field names (see the model's _fields property) and values are their values. To see what
-     * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
-     *
-     * @var array
-     */
-    protected $_fields = array();
-
-    /**
-     * @var boolean indicating whether or not this model object is intended to ever be saved
-     * For example, we might create model objects intended to only be used for the duration
-     * of this request and to be thrown away, and if they were accidentally saved
-     * it would be a bug.
-     */
-    protected $_allow_persist = true;
-
-    /**
-     * @var boolean indicating whether or not this model object's properties have changed since construction
-     */
-    protected $_has_changes = false;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $_model;
-
-
-
-    /**
-     * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children
-     * play nice
-     *
-     * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
-     *                                                         layer of the model's _fields array, (eg, EVT_ID,
-     *                                                         TXN_amount, QST_name, etc) and values are their values
-     * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
-     *                                                         corresponding db model or not.
-     * @param string  $timezone                                indicate what timezone you want any datetime fields to
-     *                                                         be in when instantiating a EE_Base_Class object.
-     * @param array   $date_formats                            An array of date formats to set on construct where first
-     *                                                         value is the date_format and second value is the time
-     *                                                         format.
-     * @throws EE_Error
-     */
-    protected function __construct($fieldValues = array(), $bydb = false, $timezone = '', $date_formats = array())
-    {
-        $className = get_class($this);
-        do_action("AHEE__{$className}__construct", $this, $fieldValues);
-        $model = $this->get_model();
-        $model_fields = $model->field_settings(false);
-        // ensure $fieldValues is an array
-        $fieldValues = is_array($fieldValues) ? $fieldValues : array($fieldValues);
-        // EEH_Debug_Tools::printr( $fieldValues, '$fieldValues  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        // verify client code has not passed any invalid field names
-        foreach ($fieldValues as $field_name => $field_value) {
-            if ( ! isset($model_fields[$field_name])) {
-                throw new EE_Error(sprintf(__("Invalid field (%s) passed to constructor of %s. Allowed fields are :%s",
-                    "event_espresso"), $field_name, get_class($this), implode(", ", array_keys($model_fields))));
-            }
-        }
-        // EEH_Debug_Tools::printr( $model_fields, '$model_fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        if ( ! empty($date_formats) && is_array($date_formats)) {
-            list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
-        } else {
-            //set default formats for date and time
-            $this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
-            $this->_tm_frmt = (string)get_option('time_format', 'g:i a');
-        }
-        //if db model is instantiating
-        if ($bydb) {
-            //client code has indicated these field values are from the database
-            foreach ($model_fields as $fieldName => $field) {
-                $this->set_from_db($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null);
-            }
-        } else {
-            //we're constructing a brand
-            //new instance of the model object. Generally, this means we'll need to do more field validation
-            foreach ($model_fields as $fieldName => $field) {
-                $this->set($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null, true);
-            }
-        }
-        //remember what values were passed to this constructor
-        $this->_props_n_values_provided_in_constructor = $fieldValues;
-        //remember in entity mapper
-        if ( ! $bydb && $model->has_primary_key_field() && $this->ID()) {
-            $model->add_to_entity_map($this);
-        }
-        //setup all the relations
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $this->_model_relations[$relation_name] = null;
-            } else {
-                $this->_model_relations[$relation_name] = array();
-            }
-        }
-        /**
-         * Action done at the end of each model object construction
-         *
-         * @param EE_Base_Class $this the model object just created
-         */
-        do_action('AHEE__EE_Base_Class__construct__finished', $this);
-    }
-
-
-
-    /**
-     * Gets whether or not this model object is allowed to persist/be saved to the database.
-     *
-     * @return boolean
-     */
-    public function allow_persist()
-    {
-        return $this->_allow_persist;
-    }
-
-
-
-    /**
-     * Sets whether or not this model object should be allowed to be saved to the DB.
-     * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
-     * you got new information that somehow made you change your mind.
-     *
-     * @param boolean $allow_persist
-     * @return boolean
-     */
-    public function set_allow_persist($allow_persist)
-    {
-        return $this->_allow_persist = $allow_persist;
-    }
-
-
-
-    /**
-     * Gets the field's original value when this object was constructed during this request.
-     * This can be helpful when determining if a model object has changed or not
-     *
-     * @param string $field_name
-     * @return mixed|null
-     * @throws \EE_Error
-     */
-    public function get_original($field_name)
-    {
-        if (isset($this->_props_n_values_provided_in_constructor[$field_name])
-            && $field_settings = $this->get_model()->field_settings_for($field_name)
-        ) {
-            return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[$field_name]);
-        } else {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * @param EE_Base_Class $obj
-     * @return string
-     */
-    public function get_class($obj)
-    {
-        return get_class($obj);
-    }
-
-
-
-    /**
-     * Overrides parent because parent expects old models.
-     * This also doesn't do any validation, and won't work for serialized arrays
-     *
-     * @param    string $field_name
-     * @param    mixed  $field_value
-     * @param bool      $use_default
-     * @throws \EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        // if not using default and nothing has changed, and object has already been setup (has ID),
-        // then don't do anything
-        if (
-            ! $use_default
-            && $this->_fields[$field_name] === $field_value
-            && $this->ID()
-        ) {
-            return;
-        }
-        $model = $this->get_model();
-        $this->_has_changes = true;
-        $field_obj = $model->field_settings_for($field_name);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            //			if ( method_exists( $field_obj, 'set_timezone' )) {
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $field_obj->set_timezone($this->_timezone);
-                $field_obj->set_date_format($this->_dt_frmt);
-                $field_obj->set_time_format($this->_tm_frmt);
-            }
-            $holder_of_value = $field_obj->prepare_for_set($field_value);
-            //should the value be null?
-            if (($field_value === null || $holder_of_value === null || $holder_of_value === '') && $use_default) {
-                $this->_fields[$field_name] = $field_obj->get_default_value();
-                /**
-                 * To save having to refactor all the models, if a default value is used for a
-                 * EE_Datetime_Field, and that value is not null nor is it a DateTime
-                 * object.  Then let's do a set again to ensure that it becomes a DateTime
-                 * object.
-                 *
-                 * @since 4.6.10+
-                 */
-                if (
-                    $field_obj instanceof EE_Datetime_Field
-                    && $this->_fields[$field_name] !== null
-                    && ! $this->_fields[$field_name] instanceof DateTime
-                ) {
-                    empty($this->_fields[$field_name])
-                        ? $this->set($field_name, time())
-                        : $this->set($field_name, $this->_fields[$field_name]);
-                }
-            } else {
-                $this->_fields[$field_name] = $holder_of_value;
-            }
-            //if we're not in the constructor...
-            //now check if what we set was a primary key
-            if (
-                //note: props_n_values_provided_in_constructor is only set at the END of the constructor
-                $this->_props_n_values_provided_in_constructor
-                && $field_value
-                && $field_name === $model->primary_key_name()
-            ) {
-                //if so, we want all this object's fields to be filled either with
-                //what we've explicitly set on this model
-                //or what we have in the db
-                // echo "setting primary key!";
-                $fields_on_model = self::_get_model(get_class($this))->field_settings();
-                $obj_in_db = self::_get_model(get_class($this))->get_one_by_ID($field_value);
-                foreach ($fields_on_model as $field_obj) {
-                    if ( ! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
-                         && $field_obj->get_name() !== $field_name
-                    ) {
-                        $this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
-                    }
-                }
-                //oh this model object has an ID? well make sure its in the entity mapper
-                $model->add_to_entity_map($this);
-            }
-            //let's unset any cache for this field_name from the $_cached_properties property.
-            $this->_clear_cached_property($field_name);
-        } else {
-            throw new EE_Error(sprintf(__("A valid EE_Model_Field_Base could not be found for the given field name: %s",
-                "event_espresso"), $field_name));
-        }
-    }
-
-
-
-    /**
-     * This sets the field value on the db column if it exists for the given $column_name or
-     * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
-     *
-     * @see EE_message::get_column_value for related documentation on the necessity of this method.
-     * @param string $field_name  Must be the exact column name.
-     * @param mixed  $field_value The value to set.
-     * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
-     * @throws \EE_Error
-     */
-    public function set_field_or_extra_meta($field_name, $field_value)
-    {
-        if ($this->get_model()->has_field($field_name)) {
-            $this->set($field_name, $field_value);
-            return true;
-        } else {
-            //ensure this object is saved first so that extra meta can be properly related.
-            $this->save();
-            return $this->update_extra_meta($field_name, $field_value);
-        }
-    }
-
-
-
-    /**
-     * This retrieves the value of the db column set on this class or if that's not present
-     * it will attempt to retrieve from extra_meta if found.
-     * Example Usage:
-     * Via EE_Message child class:
-     * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
-     * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
-     * also have additional main fields specific to the messenger.  The system accommodates those extra
-     * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
-     * value for those extra fields dynamically via the EE_message object.
-     *
-     * @param  string $field_name expecting the fully qualified field name.
-     * @return mixed|null  value for the field if found.  null if not found.
-     * @throws \EE_Error
-     */
-    public function get_field_or_extra_meta($field_name)
-    {
-        if ($this->get_model()->has_field($field_name)) {
-            $column_value = $this->get($field_name);
-        } else {
-            //This isn't a column in the main table, let's see if it is in the extra meta.
-            $column_value = $this->get_extra_meta($field_name, true, null);
-        }
-        return $column_value;
-    }
-
-
-
-    /**
-     * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
-     * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
-     * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
-     * available to all child classes that may be using the EE_Datetime_Field for a field data type.
-     *
-     * @access public
-     * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_timezone($timezone = '')
-    {
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        //make sure we clear all cached properties because they won't be relevant now
-        $this->_clear_cached_properties();
-        //make sure we update field settings and the date for all EE_Datetime_Fields
-        $model_fields = $this->get_model()->field_settings(false);
-        foreach ($model_fields as $field_name => $field_obj) {
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $field_obj->set_timezone($this->_timezone);
-                if (isset($this->_fields[$field_name]) && $this->_fields[$field_name] instanceof DateTime) {
-                    $this->_fields[$field_name]->setTimezone(new DateTimeZone($this->_timezone));
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string timezone string
-     */
-    public function get_timezone()
-    {
-        return $this->_timezone;
-    }
-
-
-
-    /**
-     * This sets the internal date format to what is sent in to be used as the new default for the class
-     * internally instead of wp set date format options
-     *
-     * @since 4.6
-     * @param string $format should be a format recognizable by PHP date() functions.
-     */
-    public function set_date_format($format)
-    {
-        $this->_dt_frmt = $format;
-        //clear cached_properties because they won't be relevant now.
-        $this->_clear_cached_properties();
-    }
-
-
-
-    /**
-     * This sets the internal time format string to what is sent in to be used as the new default for the
-     * class internally instead of wp set time format options.
-     *
-     * @since 4.6
-     * @param string $format should be a format recognizable by PHP date() functions.
-     */
-    public function set_time_format($format)
-    {
-        $this->_tm_frmt = $format;
-        //clear cached_properties because they won't be relevant now.
-        $this->_clear_cached_properties();
-    }
-
-
-
-    /**
-     * This returns the current internal set format for the date and time formats.
-     *
-     * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
-     *                             where the first value is the date format and the second value is the time format.
-     * @return mixed string|array
-     */
-    public function get_format($full = true)
-    {
-        return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
-    }
-
-
-
-    /**
-     * cache
-     * stores the passed model object on the current model object.
-     * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
-     *
-     * @param string        $relationName    one of the keys in the _model_relations array on the model. Eg
-     *                                       'Registration' associated with this model object
-     * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
-     *                                       that could be a payment or a registration)
-     * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
-     *                                       items which will be stored in an array on this object
-     * @throws EE_Error
-     * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
-     *                  related thing, no array)
-     */
-    public function cache($relationName = '', $object_to_cache = null, $cache_id = null)
-    {
-        // its entirely possible that there IS no related object yet in which case there is nothing to cache.
-        if ( ! $object_to_cache instanceof EE_Base_Class) {
-            return false;
-        }
-        // also get "how" the object is related, or throw an error
-        if ( ! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
-            throw new EE_Error(sprintf(__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
-                $relationName, get_class($this)));
-        }
-        // how many things are related ?
-        if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            // if it's a "belongs to" relationship, then there's only one related model object  eg, if this is a registration, there's only 1 attendee for it
-            // so for these model objects just set it to be cached
-            $this->_model_relations[$relationName] = $object_to_cache;
-            $return = true;
-        } else {
-            // otherwise, this is the "many" side of a one to many relationship, so we'll add the object to the array of related objects for that type.
-            // eg: if this is an event, there are many registrations for that event, so we cache the registrations in an array
-            if ( ! is_array($this->_model_relations[$relationName])) {
-                // if for some reason, the cached item is a model object, then stick that in the array, otherwise start with an empty array
-                $this->_model_relations[$relationName] = $this->_model_relations[$relationName] instanceof EE_Base_Class
-                    ? array($this->_model_relations[$relationName]) : array();
-            }
-            // first check for a cache_id which is normally empty
-            if ( ! empty($cache_id)) {
-                // if the cache_id exists, then it means we are purposely trying to cache this with a known key that can then be used to retrieve the object later on
-                $this->_model_relations[$relationName][$cache_id] = $object_to_cache;
-                $return = $cache_id;
-            } elseif ($object_to_cache->ID()) {
-                // OR the cached object originally came from the db, so let's just use it's PK for an ID
-                $this->_model_relations[$relationName][$object_to_cache->ID()] = $object_to_cache;
-                $return = $object_to_cache->ID();
-            } else {
-                // OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
-                $this->_model_relations[$relationName][] = $object_to_cache;
-                // move the internal pointer to the end of the array
-                end($this->_model_relations[$relationName]);
-                // and grab the key so that we can return it
-                $return = key($this->_model_relations[$relationName]);
-            }
-        }
-        return $return;
-    }
-
-
-
-    /**
-     * For adding an item to the cached_properties property.
-     *
-     * @access protected
-     * @param string      $fieldname the property item the corresponding value is for.
-     * @param mixed       $value     The value we are caching.
-     * @param string|null $cache_type
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _set_cached_property($fieldname, $value, $cache_type = null)
-    {
-        //first make sure this property exists
-        $this->get_model()->field_settings_for($fieldname);
-        $cache_type = empty($cache_type) ? 'standard' : $cache_type;
-        $this->_cached_properties[$fieldname][$cache_type] = $value;
-    }
-
-
-
-    /**
-     * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
-     * This also SETS the cache if we return the actual property!
-     *
-     * @param string $fieldname        the name of the property we're trying to retrieve
-     * @param bool   $pretty
-     * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
-     *                                 (in cases where the same property may be used for different outputs
-     *                                 - i.e. datetime, money etc.)
-     *                                 It can also accept certain pre-defined "schema" strings
-     *                                 to define how to output the property.
-     *                                 see the field's prepare_for_pretty_echoing for what strings can be used
-     * @return mixed                   whatever the value for the property is we're retrieving
-     * @throws \EE_Error
-     */
-    protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
-    {
-        //verify the field exists
-        $model = $this->get_model();
-        $model->field_settings_for($fieldname);
-        $cache_type = $pretty ? 'pretty' : 'standard';
-        $cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
-        if (isset($this->_cached_properties[$fieldname][$cache_type])) {
-            return $this->_cached_properties[$fieldname][$cache_type];
-        }
-        $value = $this->_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
-        $this->_set_cached_property($fieldname, $value, $cache_type);
-        return $value;
-    }
-
-
-
-    /**
-     * If the cache didn't fetch the needed item, this fetches it.
-     * @param string $fieldname
-     * @param bool $pretty
-     * @param string $extra_cache_ref
-     * @return mixed
-     */
-    protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
-    {
-        $field_obj = $this->get_model()->field_settings_for($fieldname);
-        // If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
-        if ($field_obj instanceof EE_Datetime_Field) {
-            $this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
-        }
-        if ( ! isset($this->_fields[$fieldname])) {
-            $this->_fields[$fieldname] = null;
-        }
-        $value = $pretty
-            ? $field_obj->prepare_for_pretty_echoing($this->_fields[$fieldname], $extra_cache_ref)
-            : $field_obj->prepare_for_get($this->_fields[$fieldname]);
-        return $value;
-    }
-
-
-
-    /**
-     * set timezone, formats, and output for EE_Datetime_Field objects
-     *
-     * @param \EE_Datetime_Field $datetime_field
-     * @param bool               $pretty
-     * @param null $date_or_time
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _prepare_datetime_field(
-        EE_Datetime_Field $datetime_field,
-        $pretty = false,
-        $date_or_time = null
-    ) {
-        $datetime_field->set_timezone($this->_timezone);
-        $datetime_field->set_date_format($this->_dt_frmt, $pretty);
-        $datetime_field->set_time_format($this->_tm_frmt, $pretty);
-        //set the output returned
-        switch ($date_or_time) {
-            case 'D' :
-                $datetime_field->set_date_time_output('date');
-                break;
-            case 'T' :
-                $datetime_field->set_date_time_output('time');
-                break;
-            default :
-                $datetime_field->set_date_time_output();
-        }
-    }
-
-
-
-    /**
-     * This just takes care of clearing out the cached_properties
-     *
-     * @return void
-     */
-    protected function _clear_cached_properties()
-    {
-        $this->_cached_properties = array();
-    }
-
-
-
-    /**
-     * This just clears out ONE property if it exists in the cache
-     *
-     * @param  string $property_name the property to remove if it exists (from the _cached_properties array)
-     * @return void
-     */
-    protected function _clear_cached_property($property_name)
-    {
-        if (isset($this->_cached_properties[$property_name])) {
-            unset($this->_cached_properties[$property_name]);
-        }
-    }
-
-
-
-    /**
-     * Ensures that this related thing is a model object.
-     *
-     * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
-     * @param string $model_name   name of the related thing, eg 'Attendee',
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
-    {
-        $other_model_instance = self::_get_model_instance_with_name(
-            self::_get_model_classname($model_name),
-            $this->_timezone
-        );
-        return $other_model_instance->ensure_is_obj($object_or_id);
-    }
-
-
-
-    /**
-     * Forgets the cached model of the given relation Name. So the next time we request it,
-     * we will fetch it again from the database. (Handy if you know it's changed somehow).
-     * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
-     * then only remove that one object from our cached array. Otherwise, clear the entire list
-     *
-     * @param string $relationName                         one of the keys in the _model_relations array on the model.
-     *                                                     Eg 'Registration'
-     * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
-     *                                                     if you intend to use $clear_all = TRUE, or the relation only
-     *                                                     has 1 object anyways (ie, it's a BelongsToRelation)
-     * @param bool   $clear_all                            This flags clearing the entire cache relation property if
-     *                                                     this is HasMany or HABTM.
-     * @throws EE_Error
-     * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a
-     *                       relation from all
-     */
-    public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false)
-    {
-        $relationship_to_model = $this->get_model()->related_settings_for($relationName);
-        $index_in_cache = '';
-        if ( ! $relationship_to_model) {
-            throw new EE_Error(
-                sprintf(
-                    __("There is no relationship to %s on a %s. Cannot clear that cache", 'event_espresso'),
-                    $relationName,
-                    get_class($this)
-                )
-            );
-        }
-        if ($clear_all) {
-            $obj_removed = true;
-            $this->_model_relations[$relationName] = null;
-        } elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            $obj_removed = $this->_model_relations[$relationName];
-            $this->_model_relations[$relationName] = null;
-        } else {
-            if ($object_to_remove_or_index_into_array instanceof EE_Base_Class
-                && $object_to_remove_or_index_into_array->ID()
-            ) {
-                $index_in_cache = $object_to_remove_or_index_into_array->ID();
-                if (is_array($this->_model_relations[$relationName])
-                    && ! isset($this->_model_relations[$relationName][$index_in_cache])
-                ) {
-                    $index_found_at = null;
-                    //find this object in the array even though it has a different key
-                    foreach ($this->_model_relations[$relationName] as $index => $obj) {
-                        if (
-                            $obj instanceof EE_Base_Class
-                            && (
-                                $obj == $object_to_remove_or_index_into_array
-                                || $obj->ID() === $object_to_remove_or_index_into_array->ID()
-                            )
-                        ) {
-                            $index_found_at = $index;
-                            break;
-                        }
-                    }
-                    if ($index_found_at) {
-                        $index_in_cache = $index_found_at;
-                    } else {
-                        //it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
-                        //if it wasn't in it to begin with. So we're done
-                        return $object_to_remove_or_index_into_array;
-                    }
-                }
-            } elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
-                //so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
-                foreach ($this->get_all_from_cache($relationName) as $index => $potentially_obj_we_want) {
-                    if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
-                        $index_in_cache = $index;
-                    }
-                }
-            } else {
-                $index_in_cache = $object_to_remove_or_index_into_array;
-            }
-            //supposedly we've found it. But it could just be that the client code
-            //provided a bad index/object
-            if (
-            isset(
-                $this->_model_relations[$relationName],
-                $this->_model_relations[$relationName][$index_in_cache]
-            )
-            ) {
-                $obj_removed = $this->_model_relations[$relationName][$index_in_cache];
-                unset($this->_model_relations[$relationName][$index_in_cache]);
-            } else {
-                //that thing was never cached anyways.
-                $obj_removed = null;
-            }
-        }
-        return $obj_removed;
-    }
-
-
-
-    /**
-     * update_cache_after_object_save
-     * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
-     * obtained after being saved to the db
-     *
-     * @param string         $relationName       - the type of object that is cached
-     * @param \EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
-     * @param string         $current_cache_id   - the ID that was used when originally caching the object
-     * @return boolean TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function update_cache_after_object_save(
-        $relationName,
-        EE_Base_Class $newly_saved_object,
-        $current_cache_id = ''
-    ) {
-        // verify that incoming object is of the correct type
-        $obj_class = 'EE_' . $relationName;
-        if ($newly_saved_object instanceof $obj_class) {
-            /* @type EE_Base_Class $newly_saved_object */
-            // now get the type of relation
-            $relationship_to_model = $this->get_model()->related_settings_for($relationName);
-            // if this is a 1:1 relationship
-            if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-                // then just replace the cached object with the newly saved object
-                $this->_model_relations[$relationName] = $newly_saved_object;
-                return true;
-                // or if it's some kind of sordid feral polyamorous relationship...
-            } elseif (is_array($this->_model_relations[$relationName])
-                      && isset($this->_model_relations[$relationName][$current_cache_id])
-            ) {
-                // then remove the current cached item
-                unset($this->_model_relations[$relationName][$current_cache_id]);
-                // and cache the newly saved object using it's new ID
-                $this->_model_relations[$relationName][$newly_saved_object->ID()] = $newly_saved_object;
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
-     *
-     * @param string $relationName
-     * @return EE_Base_Class
-     */
-    public function get_one_from_cache($relationName)
-    {
-        $cached_array_or_object = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName]
-            : null;
-        if (is_array($cached_array_or_object)) {
-            return array_shift($cached_array_or_object);
-        } else {
-            return $cached_array_or_object;
-        }
-    }
-
-
-
-    /**
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
-     *
-     * @param string $relationName
-     * @throws \EE_Error
-     * @return EE_Base_Class[] NOT necessarily indexed by primary keys
-     */
-    public function get_all_from_cache($relationName)
-    {
-        $objects = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName] : array();
-        // if the result is not an array, but exists, make it an array
-        $objects = is_array($objects) ? $objects : array($objects);
-        //bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
-        //basically, if this model object was stored in the session, and these cached model objects
-        //already have IDs, let's make sure they're in their model's entity mapper
-        //otherwise we will have duplicates next time we call
-        // EE_Registry::instance()->load_model( $relationName )->get_one_by_ID( $result->ID() );
-        $model = EE_Registry::instance()->load_model($relationName);
-        foreach ($objects as $model_object) {
-            if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
-                //ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
-                if ($model_object->ID()) {
-                    $model->add_to_entity_map($model_object);
-                }
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
-                            'event_espresso'
-                        ),
-                        $relationName,
-                        gettype($model_object)
-                    )
-                );
-            }
-        }
-        return $objects;
-    }
-
-
-
-    /**
-     * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param int   $limit              How many objects to return.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function next_x($field_to_order_by = null, $limit = 1, $query_params = array(), $columns_to_select = null)
-    {
-        $model = $this->get_model();
-        $field = empty($field_to_order_by) && $model->has_primary_key_field()
-            ? $model->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $model->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param int   $limit              How many objects to return.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function previous_x(
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = array(),
-        $columns_to_select = null
-    ) {
-        $model = $this->get_model();
-        $field = empty($field_to_order_by) && $model->has_primary_key_field()
-            ? $model->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $model->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Returns the next EE_Base_Class object in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function next($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
-    {
-        $model = $this->get_model();
-        $field = empty($field_to_order_by) && $model->has_primary_key_field()
-            ? $model->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $model->next($current_value, $field, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Returns the previous EE_Base_Class object in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
-     *                                  you can indicate just the column you want returned
-     * @return array|EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function previous($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
-    {
-        $model = $this->get_model();
-        $field = empty($field_to_order_by) && $model->has_primary_key_field()
-            ? $model->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $model->previous($current_value, $field, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Overrides parent because parent expects old models.
-     * This also doesn't do any validation, and won't work for serialized arrays
-     *
-     * @param string $field_name
-     * @param mixed  $field_value_from_db
-     * @throws \EE_Error
-     */
-    public function set_from_db($field_name, $field_value_from_db)
-    {
-        $field_obj = $this->get_model()->field_settings_for($field_name);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            //you would think the DB has no NULLs for non-null label fields right? wrong!
-            //eg, a CPT model object could have an entry in the posts table, but no
-            //entry in the meta table. Meaning that all its columns in the meta table
-            //are null! yikes! so when we find one like that, use defaults for its meta columns
-            if ($field_value_from_db === null) {
-                if ($field_obj->is_nullable()) {
-                    //if the field allows nulls, then let it be null
-                    $field_value = null;
-                } else {
-                    $field_value = $field_obj->get_default_value();
-                }
-            } else {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
-            }
-            $this->_fields[$field_name] = $field_value;
-            $this->_clear_cached_property($field_name);
-        }
-    }
-
-
-
-    /**
-     * verifies that the specified field is of the correct type
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function get($field_name, $extra_cache_ref = null)
-    {
-        return $this->_get_cached_property($field_name, false, $extra_cache_ref);
-    }
-
-
-
-    /**
-     * This method simply returns the RAW unprocessed value for the given property in this class
-     *
-     * @param  string $field_name A valid fieldname
-     * @return mixed              Whatever the raw value stored on the property is.
-     * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
-     */
-    public function get_raw($field_name)
-    {
-        $field_settings = $this->get_model()->field_settings_for($field_name);
-        return $field_settings instanceof EE_Datetime_Field && $this->_fields[$field_name] instanceof DateTime
-            ? $this->_fields[$field_name]->format('U')
-            : $this->_fields[$field_name];
-    }
-
-
-
-    /**
-     * This is used to return the internal DateTime object used for a field that is a
-     * EE_Datetime_Field.
-     *
-     * @param string $field_name               The field name retrieving the DateTime object.
-     * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
-     * @throws \EE_Error
-     *                                         an error is set and false returned.  If the field IS an
-     *                                         EE_Datetime_Field and but the field value is null, then
-     *                                         just null is returned (because that indicates that likely
-     *                                         this field is nullable).
-     */
-    public function get_DateTime_object($field_name)
-    {
-        $field_settings = $this->get_model()->field_settings_for($field_name);
-        if ( ! $field_settings instanceof EE_Datetime_Field) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
-                        'event_espresso'
-                    ),
-                    $field_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $this->_fields[$field_name];
-    }
-
-
-
-    /**
-     * To be used in template to immediately echo out the value, and format it for output.
-     * Eg, should call stripslashes and whatnot before echoing
-     *
-     * @param string $field_name      the name of the field as it appears in the DB
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return void
-     * @throws \EE_Error
-     */
-    public function e($field_name, $extra_cache_ref = null)
-    {
-        echo $this->get_pretty($field_name, $extra_cache_ref);
-    }
-
-
-
-    /**
-     * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
-     * can be easily used as the value of form input.
-     *
-     * @param string $field_name
-     * @return void
-     * @throws \EE_Error
-     */
-    public function f($field_name)
-    {
-        $this->e($field_name, 'form_input');
-    }
-
-
-
-    /**
-     * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this.
-     * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class
-     * to see what options are available.
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function get_pretty($field_name, $extra_cache_ref = null)
-    {
-        return $this->_get_cached_property($field_name, true, $extra_cache_ref);
-    }
-
-
-
-    /**
-     * This simply returns the datetime for the given field name
-     * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
-     * (and the equivalent e_date, e_time, e_datetime).
-     *
-     * @access   protected
-     * @param string   $field_name   Field on the instantiated EE_Base_Class child object
-     * @param string   $dt_frmt      valid datetime format used for date
-     *                               (if '' then we just use the default on the field,
-     *                               if NULL we use the last-used format)
-     * @param string   $tm_frmt      Same as above except this is for time format
-     * @param string   $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
-     * @param  boolean $echo         Whether the dtt is echoing using pretty echoing or just returned using vanilla get
-     * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
-     *                               if field is not a valid dtt field, or void if echoing
-     * @throws \EE_Error
-     */
-    protected function _get_datetime($field_name, $dt_frmt = '', $tm_frmt = '', $date_or_time = '', $echo = false)
-    {
-        // clear cached property
-        $this->_clear_cached_property($field_name);
-        //reset format properties because they are used in get()
-        $this->_dt_frmt = $dt_frmt !== '' ? $dt_frmt : $this->_dt_frmt;
-        $this->_tm_frmt = $tm_frmt !== '' ? $tm_frmt : $this->_tm_frmt;
-        if ($echo) {
-            $this->e($field_name, $date_or_time);
-            return '';
-        }
-        return $this->get($field_name, $date_or_time);
-    }
-
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $format     format for the date returned (if NULL we use default in dt_frmt property)
-     * @return string            datetime value formatted
-     * @throws \EE_Error
-     */
-    public function get_date($field_name, $format = '')
-    {
-        return $this->_get_datetime($field_name, $format, null, 'D');
-    }
-
-
-
-    /**
-     * @param      $field_name
-     * @param string $format
-     * @throws \EE_Error
-     */
-    public function e_date($field_name, $format = '')
-    {
-        $this->_get_datetime($field_name, $format, null, 'D', true);
-    }
-
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $format     format for the time returned ( if NULL we use default in tm_frmt property)
-     * @return string             datetime value formatted
-     * @throws \EE_Error
-     */
-    public function get_time($field_name, $format = '')
-    {
-        return $this->_get_datetime($field_name, null, $format, 'T');
-    }
-
-
-
-    /**
-     * @param      $field_name
-     * @param string $format
-     * @throws \EE_Error
-     */
-    public function e_time($field_name, $format = '')
-    {
-        $this->_get_datetime($field_name, null, $format, 'T', true);
-    }
-
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
-     * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $dt_frmt    format for the date returned (if NULL we use default in dt_frmt property)
-     * @param  string $tm_frmt    format for the time returned (if NULL we use default in tm_frmt property)
-     * @return string             datetime value formatted
-     * @throws \EE_Error
-     */
-    public function get_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
-    {
-        return $this->_get_datetime($field_name, $dt_frmt, $tm_frmt);
-    }
-
-
-
-    /**
-     * @param string $field_name
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @throws \EE_Error
-     */
-    public function e_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
-    {
-        $this->_get_datetime($field_name, $dt_frmt, $tm_frmt, null, true);
-    }
-
-
-
-    /**
-     * Get the i8ln value for a date using the WordPress @see date_i18n function.
-     *
-     * @param string $field_name The EE_Datetime_Field reference for the date being retrieved.
-     * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
-     *                           on the object will be used.
-     * @return string Date and time string in set locale or false if no field exists for the given
-     * @throws \EE_Error
-     *                           field name.
-     */
-    public function get_i18n_datetime($field_name, $format = '')
-    {
-        $format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
-        return date_i18n(
-            $format,
-            EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
-        );
-    }
-
-
-
-    /**
-     * This method validates whether the given field name is a valid field on the model object as well as it is of a
-     * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
-     * thrown.
-     *
-     * @param  string $field_name The field name being checked
-     * @throws EE_Error
-     * @return EE_Datetime_Field
-     */
-    protected function _get_dtt_field_settings($field_name)
-    {
-        $field = $this->get_model()->field_settings_for($field_name);
-        //check if field is dtt
-        if ($field instanceof EE_Datetime_Field) {
-            return $field;
-        } else {
-            throw new EE_Error(sprintf(__('The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
-                'event_espresso'), $field_name, self::_get_model_classname(get_class($this))));
-        }
-    }
-
-
-
-
-    /**
-     * NOTE ABOUT BELOW:
-     * These convenience date and time setters are for setting date and time independently.  In other words you might
-     * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
-     * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
-     * method and make sure you send the entire datetime value for setting.
-     */
-    /**
-     * sets the time on a datetime property
-     *
-     * @access protected
-     * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
-     * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
-     * @throws \EE_Error
-     */
-    protected function _set_time_for($time, $fieldname)
-    {
-        $this->_set_date_time('T', $time, $fieldname);
-    }
-
-
-
-    /**
-     * sets the date on a datetime property
-     *
-     * @access protected
-     * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
-     * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
-     * @throws \EE_Error
-     */
-    protected function _set_date_for($date, $fieldname)
-    {
-        $this->_set_date_time('D', $date, $fieldname);
-    }
-
-
-
-    /**
-     * This takes care of setting a date or time independently on a given model object property. This method also
-     * verifies that the given fieldname matches a model object property and is for a EE_Datetime_Field field
-     *
-     * @access protected
-     * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
-     * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
-     * @param string          $fieldname      the name of the field the date OR time is being set on (must match a
-     *                                        EE_Datetime_Field property)
-     * @throws \EE_Error
-     */
-    protected function _set_date_time($what = 'T', $datetime_value, $fieldname)
-    {
-        $field = $this->_get_dtt_field_settings($fieldname);
-        $field->set_timezone($this->_timezone);
-        $field->set_date_format($this->_dt_frmt);
-        $field->set_time_format($this->_tm_frmt);
-        switch ($what) {
-            case 'T' :
-                $this->_fields[$fieldname] = $field->prepare_for_set_with_new_time(
-                    $datetime_value,
-                    $this->_fields[$fieldname]
-                );
-                break;
-            case 'D' :
-                $this->_fields[$fieldname] = $field->prepare_for_set_with_new_date(
-                    $datetime_value,
-                    $this->_fields[$fieldname]
-                );
-                break;
-            case 'B' :
-                $this->_fields[$fieldname] = $field->prepare_for_set($datetime_value);
-                break;
-        }
-        $this->_clear_cached_property($fieldname);
-    }
-
-
-
-    /**
-     * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
-     * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
-     * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
-     * that could lead to some unexpected results!
-     *
-     * @access public
-     * @param string               $field_name This is the name of the field on the object that contains the date/time
-     *                                         value being returned.
-     * @param string               $callback   must match a valid method in this class (defaults to get_datetime)
-     * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
-     * @param string               $prepend    You can include something to prepend on the timestamp
-     * @param string               $append     You can include something to append on the timestamp
-     * @throws EE_Error
-     * @return string timestamp
-     */
-    public function display_in_my_timezone(
-        $field_name,
-        $callback = 'get_datetime',
-        $args = null,
-        $prepend = '',
-        $append = ''
-    ) {
-        $timezone = EEH_DTT_Helper::get_timezone();
-        if ($timezone === $this->_timezone) {
-            return '';
-        }
-        $original_timezone = $this->_timezone;
-        $this->set_timezone($timezone);
-        $fn = (array)$field_name;
-        $args = array_merge($fn, (array)$args);
-        if ( ! method_exists($this, $callback)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
-                        'event_espresso'
-                    ),
-                    $callback
-                )
-            );
-        }
-        $args = (array)$args;
-        $return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
-        $this->set_timezone($original_timezone);
-        return $return;
-    }
-
-
-
-    /**
-     * Deletes this model object.
-     * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
-     * override
-     * `EE_Base_Class::_delete` NOT this class.
-     *
-     * @return boolean | int
-     * @throws \EE_Error
-     */
-    public function delete()
-    {
-        /**
-         * Called just before the `EE_Base_Class::_delete` method call.
-         * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
-         * should be aware that `_delete` may not always result in a permanent delete.  For example, `EE_Soft_Delete_Base_Class::_delete`
-         * soft deletes (trash) the object and does not permanently delete it.
-         *
-         * @param EE_Base_Class $model_object about to be 'deleted'
-         */
-        do_action('AHEE__EE_Base_Class__delete__before', $this);
-        $result = $this->_delete();
-        /**
-         * Called just after the `EE_Base_Class::_delete` method call.
-         * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
-         * should be aware that `_delete` may not always result in a permanent delete.  For example `EE_Soft_Base_Class::_delete`
-         * soft deletes (trash) the object and does not permanently delete it.
-         *
-         * @param EE_Base_Class $model_object that was just 'deleted'
-         * @param boolean       $result
-         */
-        do_action('AHEE__EE_Base_Class__delete__end', $this, $result);
-        return $result;
-    }
-
-
-
-    /**
-     * Calls the specific delete method for the instantiated class.
-     * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
-     * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
-     * `EE_Base_Class::delete`
-     *
-     * @return bool|int
-     * @throws \EE_Error
-     */
-    protected function _delete()
-    {
-        return $this->delete_permanently();
-    }
-
-
-
-    /**
-     * Deletes this model object permanently from db (but keep in mind related models my block the delete and return an
-     * error)
-     *
-     * @return bool | int
-     * @throws \EE_Error
-     */
-    public function delete_permanently()
-    {
-        /**
-         * Called just before HARD deleting a model object
-         *
-         * @param EE_Base_Class $model_object about to be 'deleted'
-         */
-        do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
-        $model = $this->get_model();
-        $result = $model->delete_permanently_by_ID($this->ID());
-        $this->refresh_cache_of_related_objects();
-        /**
-         * Called just after HARD deleting a model object
-         *
-         * @param EE_Base_Class $model_object that was just 'deleted'
-         * @param boolean       $result
-         */
-        do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
-        return $result;
-    }
-
-
-
-    /**
-     * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
-     * related model objects
-     *
-     * @throws \EE_Error
-     */
-    public function refresh_cache_of_related_objects()
-    {
-        $model = $this->get_model();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ( ! empty($this->_model_relations[$relation_name])) {
-                $related_objects = $this->_model_relations[$relation_name];
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                    //this relation only stores a single model object, not an array
-                    //but let's make it consistent
-                    $related_objects = array($related_objects);
-                }
-                foreach ($related_objects as $related_object) {
-                    //only refresh their cache if they're in memory
-                    if ($related_object instanceof EE_Base_Class) {
-                        $related_object->clear_cache($model->get_this_model_name(), $this);
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *        Saves this object to the database. An array may be supplied to set some values on this
-     * object just before saving.
-     *
-     * @access public
-     * @param array $set_cols_n_values keys are field names, values are their new values,
-     *                                 if provided during the save() method (often client code will change the fields'
-     *                                 values before calling save)
-     * @throws \EE_Error
-     * @return int , 1 on a successful update, the ID of the new entry on insert; 0 on failure or if the model object
-     *                                 isn't allowed to persist (as determined by EE_Base_Class::allow_persist())
-     */
-    public function save($set_cols_n_values = array())
-    {
-        $model = $this->get_model();
-        /**
-         * Filters the fields we're about to save on the model object
-         *
-         * @param array         $set_cols_n_values
-         * @param EE_Base_Class $model_object
-         */
-        $set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
-            $this);
-        //set attributes as provided in $set_cols_n_values
-        foreach ($set_cols_n_values as $column => $value) {
-            $this->set($column, $value);
-        }
-        // no changes ? then don't do anything
-        if (! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
-            return 0;
-        }
-        /**
-         * Saving a model object.
-         * Before we perform a save, this action is fired.
-         *
-         * @param EE_Base_Class $model_object the model object about to be saved.
-         */
-        do_action('AHEE__EE_Base_Class__save__begin', $this);
-        if ( ! $this->allow_persist()) {
-            return 0;
-        }
-        //now get current attribute values
-        $save_cols_n_values = $this->_fields;
-        //if the object already has an ID, update it. Otherwise, insert it
-        //also: change the assumption about values passed to the model NOT being prepare dby the model object. They have been
-        $old_assumption_concerning_value_preparation = $model
-                                                            ->get_assumption_concerning_values_already_prepared_by_model_object();
-        $model->assume_values_already_prepared_by_model_object(true);
-        //does this model have an autoincrement PK?
-        if ($model->has_primary_key_field()) {
-            if ($model->get_primary_key_field()->is_auto_increment()) {
-                //ok check if it's set, if so: update; if not, insert
-                if ( ! empty($save_cols_n_values[$model->primary_key_name()])) {
-                    $results = $model->update_by_ID($save_cols_n_values, $this->ID());
-                } else {
-                    unset($save_cols_n_values[$model->primary_key_name()]);
-                    $results = $model->insert($save_cols_n_values);
-                    if ($results) {
-                        //if successful, set the primary key
-                        //but don't use the normal SET method, because it will check if
-                        //an item with the same ID exists in the mapper & db, then
-                        //will find it in the db (because we just added it) and THAT object
-                        //will get added to the mapper before we can add this one!
-                        //but if we just avoid using the SET method, all that headache can be avoided
-                        $pk_field_name = $model->primary_key_name();
-                        $this->_fields[$pk_field_name] = $results;
-                        $this->_clear_cached_property($pk_field_name);
-                        $model->add_to_entity_map($this);
-                        $this->_update_cached_related_model_objs_fks();
-                    }
-                }
-            } else {//PK is NOT auto-increment
-                //so check if one like it already exists in the db
-                if ($model->exists_by_ID($this->ID())) {
-                    if (WP_DEBUG && ! $this->in_entity_map()) {
-                        throw new EE_Error(
-                            sprintf(
-                                __('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
-                                    'event_espresso'),
-                                get_class($this),
-                                get_class($model) . '::instance()->add_to_entity_map()',
-                                get_class($model) . '::instance()->get_one_by_ID()',
-                                '<br />'
-                            )
-                        );
-                    }
-                    $results = $model->update_by_ID($save_cols_n_values, $this->ID());
-                } else {
-                    $results = $model->insert($save_cols_n_values);
-                    $this->_update_cached_related_model_objs_fks();
-                }
-            }
-        } else {//there is NO primary key
-            $already_in_db = false;
-            foreach ($model->unique_indexes() as $index) {
-                $uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
-                if ($model->exists(array($uniqueness_where_params))) {
-                    $already_in_db = true;
-                }
-            }
-            if ($already_in_db) {
-                $combined_pk_fields_n_values = array_intersect_key($save_cols_n_values,
-                    $model->get_combined_primary_key_fields());
-                $results = $model->update($save_cols_n_values, $combined_pk_fields_n_values);
-            } else {
-                $results = $model->insert($save_cols_n_values);
-            }
-        }
-        //restore the old assumption about values being prepared by the model object
-        $model
-             ->assume_values_already_prepared_by_model_object($old_assumption_concerning_value_preparation);
-        /**
-         * After saving the model object this action is called
-         *
-         * @param EE_Base_Class $model_object which was just saved
-         * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
-         *                                    the new ID (or 0 if an error occurred and it wasn't updated)
-         */
-        do_action('AHEE__EE_Base_Class__save__end', $this, $results);
-        $this->_has_changes = false;
-        return $results;
-    }
-
-
-
-    /**
-     * Updates the foreign key on related models objects pointing to this to have this model object's ID
-     * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
-     * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
-     * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
-     * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
-     * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
-     * or not they exist in the DB (if they do, their DB records will be automatically updated)
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _update_cached_related_model_objs_fks()
-    {
-        $model = $this->get_model();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Has_Many_Relation) {
-                foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
-                    $fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
-                        $model->get_this_model_name()
-                    );
-                    $related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
-                    if ($related_model_obj_in_cache->ID()) {
-                        $related_model_obj_in_cache->save();
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Saves this model object and its NEW cached relations to the database.
-     * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
-     * In order for that to work, we would need to mark model objects as dirty/clean...
-     * because otherwise, there's a potential for infinite looping of saving
-     * Saves the cached related model objects, and ensures the relation between them
-     * and this object and properly setup
-     *
-     * @return int ID of new model object on save; 0 on failure+
-     * @throws \EE_Error
-     */
-    public function save_new_cached_related_model_objs()
-    {
-        //make sure this has been saved
-        if ( ! $this->ID()) {
-            $id = $this->save();
-        } else {
-            $id = $this->ID();
-        }
-        //now save all the NEW cached model objects  (ie they don't exist in the DB)
-        foreach ($this->get_model()->relation_settings() as $relationName => $relationObj) {
-            if ($this->_model_relations[$relationName]) {
-                //is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
-                //or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
-                if ($relationObj instanceof EE_Belongs_To_Relation) {
-                    //add a relation to that relation type (which saves the appropriate thing in the process)
-                    //but ONLY if it DOES NOT exist in the DB
-                    /* @var $related_model_obj EE_Base_Class */
-                    $related_model_obj = $this->_model_relations[$relationName];
-                    //					if( ! $related_model_obj->ID()){
-                    $this->_add_relation_to($related_model_obj, $relationName);
-                    $related_model_obj->save_new_cached_related_model_objs();
-                    //					}
-                } else {
-                    foreach ($this->_model_relations[$relationName] as $related_model_obj) {
-                        //add a relation to that relation type (which saves the appropriate thing in the process)
-                        //but ONLY if it DOES NOT exist in the DB
-                        //						if( ! $related_model_obj->ID()){
-                        $this->_add_relation_to($related_model_obj, $relationName);
-                        $related_model_obj->save_new_cached_related_model_objs();
-                        //						}
-                    }
-                }
-            }
-        }
-        return $id;
-    }
-
-
-
-    /**
-     * for getting a model while instantiated.
-     *
-     * @return \EEM_Base | \EEM_CPT_Base
-     */
-    public function get_model()
-    {
-        if( ! $this->_model){
-            $modelName = self::_get_model_classname(get_class($this));
-            $this->_model = self::_get_model_instance_with_name($modelName, $this->_timezone);
-        } else {
-            $this->_model->set_timezone($this->_timezone);
-        }
-
-        return $this->_model;
-    }
-
-
-
-    /**
-     * @param $props_n_values
-     * @param $classname
-     * @return mixed bool|EE_Base_Class|EEM_CPT_Base
-     * @throws \EE_Error
-     */
-    protected static function _get_object_from_entity_mapper($props_n_values, $classname)
-    {
-        //TODO: will not work for Term_Relationships because they have no PK!
-        $primary_id_ref = self::_get_primary_key_name($classname);
-        if (array_key_exists($primary_id_ref, $props_n_values) && ! empty($props_n_values[$primary_id_ref])) {
-            $id = $props_n_values[$primary_id_ref];
-            return self::_get_model($classname)->get_from_entity_map($id);
-        }
-        return false;
-    }
-
-
-
-    /**
-     * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
-     * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
-     * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
-     * we return false.
-     *
-     * @param  array  $props_n_values   incoming array of properties and their values
-     * @param  string $classname        the classname of the child class
-     * @param null    $timezone
-     * @param array   $date_formats     incoming date_formats in an array where the first value is the
-     *                                  date_format and the second value is the time format
-     * @return mixed (EE_Base_Class|bool)
-     * @throws \EE_Error
-     */
-    protected static function _check_for_object($props_n_values, $classname, $timezone = null, $date_formats = array())
-    {
-        $existing = null;
-        $model = self::_get_model($classname, $timezone);
-        if ($model->has_primary_key_field()) {
-            $primary_id_ref = self::_get_primary_key_name($classname);
-            if (array_key_exists($primary_id_ref, $props_n_values)
-                && ! empty($props_n_values[$primary_id_ref])
-            ) {
-                $existing = $model->get_one_by_ID(
-                    $props_n_values[$primary_id_ref]
-                );
-            }
-        } elseif ($model->has_all_combined_primary_key_fields($props_n_values)) {
-            //no primary key on this model, but there's still a matching item in the DB
-            $existing = self::_get_model($classname, $timezone)->get_one_by_ID(
-                self::_get_model($classname, $timezone)->get_index_primary_key_string($props_n_values)
-            );
-        }
-        if ($existing) {
-            //set date formats if present before setting values
-            if ( ! empty($date_formats) && is_array($date_formats)) {
-                $existing->set_date_format($date_formats[0]);
-                $existing->set_time_format($date_formats[1]);
-            } else {
-                //set default formats for date and time
-                $existing->set_date_format(get_option('date_format'));
-                $existing->set_time_format(get_option('time_format'));
-            }
-            foreach ($props_n_values as $property => $field_value) {
-                $existing->set($property, $field_value);
-            }
-            return $existing;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Gets the EEM_*_Model for this class
-     *
-     * @access public now, as this is more convenient
-     * @param      $classname
-     * @param null $timezone
-     * @throws EE_Error
-     * @return EEM_Base
-     */
-    protected static function _get_model($classname, $timezone = null)
-    {
-        //find model for this class
-        if ( ! $classname) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "What were you thinking calling _get_model(%s)?? You need to specify the class name",
-                        "event_espresso"
-                    ),
-                    $classname
-                )
-            );
-        }
-        $modelName = self::_get_model_classname($classname);
-        return self::_get_model_instance_with_name($modelName, $timezone);
-    }
-
-
-
-    /**
-     * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
-     *
-     * @param string $model_classname
-     * @param null   $timezone
-     * @return EEM_Base
-     */
-    protected static function _get_model_instance_with_name($model_classname, $timezone = null)
-    {
-        $model_classname = str_replace('EEM_', '', $model_classname);
-        $model = EE_Registry::instance()->load_model($model_classname);
-        $model->set_timezone($timezone);
-        return $model;
-    }
-
-
-
-    /**
-     * If a model name is provided (eg Registration), gets the model classname for that model.
-     * Also works if a model class's classname is provided (eg EE_Registration).
-     *
-     * @param null $model_name
-     * @return string like EEM_Attendee
-     */
-    private static function _get_model_classname($model_name = null)
-    {
-        if (strpos($model_name, "EE_") === 0) {
-            $model_classname = str_replace("EE_", "EEM_", $model_name);
-        } else {
-            $model_classname = "EEM_" . $model_name;
-        }
-        return $model_classname;
-    }
-
-
-
-    /**
-     * returns the name of the primary key attribute
-     *
-     * @param null $classname
-     * @throws EE_Error
-     * @return string
-     */
-    protected static function _get_primary_key_name($classname = null)
-    {
-        if ( ! $classname) {
-            throw new EE_Error(
-                sprintf(
-                    __("What were you thinking calling _get_primary_key_name(%s)", "event_espresso"),
-                    $classname
-                )
-            );
-        }
-        return self::_get_model($classname)->get_primary_key_field()->get_name();
-    }
-
-
-
-    /**
-     * Gets the value of the primary key.
-     * If the object hasn't yet been saved, it should be whatever the model field's default was
-     * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
-     * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
-     *
-     * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
-     * @throws \EE_Error
-     */
-    public function ID()
-    {
-        $model = $this->get_model();
-        //now that we know the name of the variable, use a variable variable to get its value and return its
-        if ($model->has_primary_key_field()) {
-            return $this->_fields[$model->primary_key_name()];
-        } else {
-            return $model->get_index_primary_key_string($this->_fields);
-        }
-    }
-
-
-
-    /**
-     * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
-     * model is related to a group of events, the $relationName should be 'Event', and should be a key in the EE
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
-     *
-     * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
-     * @param string $relationName                     eg 'Events','Question',etc.
-     *                                                 an attendee to a group, you also want to specify which role they
-     *                                                 will have in that group. So you would use this parameter to
-     *                                                 specify array('role-column-name'=>'role-id')
-     * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
-     *                                                 allow you to further constrict the relation to being added.
-     *                                                 However, keep in mind that the columns (keys) given must match a
-     *                                                 column on the JOIN table and currently only the HABTM models
-     *                                                 accept these additional conditions.  Also remember that if an
-     *                                                 exact match isn't found for these extra cols/val pairs, then a
-     *                                                 NEW row is created in the join table.
-     * @param null   $cache_id
-     * @throws EE_Error
-     * @return EE_Base_Class the object the relation was added to
-     */
-    public function _add_relation_to(
-        $otherObjectModelObjectOrID,
-        $relationName,
-        $extra_join_model_fields_n_values = array(),
-        $cache_id = null
-    ) {
-        $model = $this->get_model();
-        //if this thing exists in the DB, save the relation to the DB
-        if ($this->ID()) {
-            $otherObject = $model
-                                ->add_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
-                                    $extra_join_model_fields_n_values);
-            //clear cache so future get_many_related and get_first_related() return new results.
-            $this->clear_cache($relationName, $otherObject, true);
-            if ($otherObject instanceof EE_Base_Class) {
-                $otherObject->clear_cache($model->get_this_model_name(), $this);
-            }
-        } else {
-            //this thing doesn't exist in the DB,  so just cache it
-            if ( ! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
-                throw new EE_Error(sprintf(
-                    __('Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
-                        'event_espresso'),
-                    $otherObjectModelObjectOrID,
-                    get_class($this)
-                ));
-            } else {
-                $otherObject = $otherObjectModelObjectOrID;
-            }
-            $this->cache($relationName, $otherObjectModelObjectOrID, $cache_id);
-        }
-        if ($otherObject instanceof EE_Base_Class) {
-            //fix the reciprocal relation too
-            if ($otherObject->ID()) {
-                //its saved so assumed relations exist in the DB, so we can just
-                //clear the cache so future queries use the updated info in the DB
-                $otherObject->clear_cache($model->get_this_model_name(), null, true);
-            } else {
-                //it's not saved, so it caches relations like this
-                $otherObject->cache($model->get_this_model_name(), $this);
-            }
-        }
-        return $otherObject;
-    }
-
-
-
-    /**
-     * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
-     * model is related to a group of events, the $relationName should be 'Events', and should be a key in the EE
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
-     * from the cache
-     *
-     * @param mixed  $otherObjectModelObjectOrID
-     *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
-     *                to the DB yet
-     * @param string $relationName
-     * @param array  $where_query
-     *                You can optionally include an array of key=>value pairs that allow you to further constrict the
-     *                relation to being added. However, keep in mind that the columns (keys) given must match a column
-     *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
-     *                remember that if an exact match isn't found for these extra cols/val pairs, then a NEW row is
-     *                created in the join table.
-     * @return EE_Base_Class the relation was removed from
-     * @throws \EE_Error
-     */
-    public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = array())
-    {
-        if ($this->ID()) {
-            //if this exists in the DB, save the relation change to the DB too
-            $otherObject = $this->get_model()
-                                ->remove_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
-                                    $where_query);
-            $this->clear_cache($relationName, $otherObject);
-        } else {
-            //this doesn't exist in the DB, just remove it from the cache
-            $otherObject = $this->clear_cache($relationName, $otherObjectModelObjectOrID);
-        }
-        if ($otherObject instanceof EE_Base_Class) {
-            $otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
-        }
-        return $otherObject;
-    }
-
-
-
-    /**
-     * Removes ALL the related things for the $relationName.
-     *
-     * @param string $relationName
-     * @param array  $where_query_params like EEM_Base::get_all's $query_params[0] (where conditions)
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function _remove_relations($relationName, $where_query_params = array())
-    {
-        if ($this->ID()) {
-            //if this exists in the DB, save the relation change to the DB too
-            $otherObjects = $this->get_model()->remove_relations($this, $relationName, $where_query_params);
-            $this->clear_cache($relationName, null, true);
-        } else {
-            //this doesn't exist in the DB, just remove it from the cache
-            $otherObjects = $this->clear_cache($relationName, null, true);
-        }
-        if (is_array($otherObjects)) {
-            foreach ($otherObjects as $otherObject) {
-                $otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
-            }
-        }
-        return $otherObjects;
-    }
-
-
-
-    /**
-     * Gets all the related model objects of the specified type. Eg, if the current class if
-     * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
-     * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
-     * because we want to get even deleted items etc.
-     *
-     * @param string $relationName key in the model's _model_relations array
-     * @param array  $query_params like EEM_Base::get_all
-     * @return EE_Base_Class[] Results not necessarily indexed by IDs, because some results might not have primary keys
-     * @throws \EE_Error
-     *                             or might not be saved yet. Consider using EEM_Base::get_IDs() on these results if
-     *                             you want IDs
-     */
-    public function get_many_related($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            //this exists in the DB, so get the related things from either the cache or the DB
-            //if there are query parameters, forget about caching the related model objects.
-            if ($query_params) {
-                $related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
-            } else {
-                //did we already cache the result of this query?
-                $cached_results = $this->get_all_from_cache($relationName);
-                if ( ! $cached_results) {
-                    $related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
-                    //if no query parameters were passed, then we got all the related model objects
-                    //for that relation. We can cache them then.
-                    foreach ($related_model_objects as $related_model_object) {
-                        $this->cache($relationName, $related_model_object);
-                    }
-                } else {
-                    $related_model_objects = $cached_results;
-                }
-            }
-        } else {
-            //this doesn't exist in the DB, so just get the related things from the cache
-            $related_model_objects = $this->get_all_from_cache($relationName);
-        }
-        return $related_model_objects;
-    }
-
-
-
-    /**
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
-     * unless otherwise specified in the $query_params
-     *
-     * @param string $relation_name  model_name like 'Event', or 'Registration'
-     * @param array  $query_params   like EEM_Base::get_all's
-     * @param string $field_to_count name of field to count by. By default, uses primary key
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
-     *                               that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_related($relation_name, $query_params = array(), $field_to_count = null, $distinct = false)
-    {
-        return $this->get_model()->count_related($this, $relation_name, $query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
-     *
-     * @param string $relation_name model_name like 'Event', or 'Registration'
-     * @param array  $query_params  like EEM_Base::get_all's
-     * @param string $field_to_sum  name of field to count by.
-     *                              By default, uses primary key (which doesn't make much sense, so you should probably
-     *                              change it)
-     * @return int
-     */
-    public function sum_related($relation_name, $query_params = array(), $field_to_sum = null)
-    {
-        return $this->get_model()->sum_related($this, $relation_name, $query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Gets the first (ie, one) related model object of the specified type.
-     *
-     * @param string $relationName key in the model's _model_relations array
-     * @param array  $query_params like EEM_Base::get_all
-     * @return EE_Base_Class (not an array, a single object)
-     * @throws \EE_Error
-     */
-    public function get_first_related($relationName, $query_params = array())
-    {
-        $model = $this->get_model();
-        if ($this->ID()) {//this exists in the DB, get from the cache OR the DB
-            //if they've provided some query parameters, don't bother trying to cache the result
-            //also make sure we're not caching the result of get_first_related
-            //on a relation which should have an array of objects (because the cache might have an array of objects)
-            if ($query_params
-                || ! $model->related_settings_for($relationName)
-                     instanceof
-                     EE_Belongs_To_Relation
-            ) {
-                $related_model_object = $model->get_first_related($this, $relationName, $query_params);
-            } else {
-                //first, check if we've already cached the result of this query
-                $cached_result = $this->get_one_from_cache($relationName);
-                if ( ! $cached_result) {
-                    $related_model_object = $model->get_first_related($this, $relationName, $query_params);
-                    $this->cache($relationName, $related_model_object);
-                } else {
-                    $related_model_object = $cached_result;
-                }
-            }
-        } else {
-            $related_model_object = null;
-            //this doesn't exist in the Db, but maybe the relation is of type belongs to, and so the related thing might
-            if ($model->related_settings_for($relationName) instanceof EE_Belongs_To_Relation) {
-                $related_model_object = $model->get_first_related($this, $relationName, $query_params);
-            }
-            //this doesn't exist in the DB and apparently the thing it belongs to doesn't either, just get what's cached on this object
-            if ( ! $related_model_object) {
-                $related_model_object = $this->get_one_from_cache($relationName);
-            }
-        }
-        return $related_model_object;
-    }
-
-
-
-    /**
-     * Does a delete on all related objects of type $relationName and removes
-     * the current model object's relation to them. If they can't be deleted (because
-     * of blocking related model objects) does nothing. If the related model objects are
-     * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
-     * If this model object doesn't exist yet in the DB, just removes its related things
-     *
-     * @param string $relationName
-     * @param array  $query_params like EEM_Base::get_all's
-     * @return int how many deleted
-     * @throws \EE_Error
-     */
-    public function delete_related($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            $count = $this->get_model()->delete_related($this, $relationName, $query_params);
-        } else {
-            $count = count($this->get_all_from_cache($relationName));
-            $this->clear_cache($relationName, null, true);
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * Does a hard delete (ie, removes the DB row) on all related objects of type $relationName and removes
-     * the current model object's relation to them. If they can't be deleted (because
-     * of blocking related model objects) just does a soft delete on it instead, if possible.
-     * If the related thing isn't a soft-deletable model object, this function is identical
-     * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
-     *
-     * @param string $relationName
-     * @param array  $query_params like EEM_Base::get_all's
-     * @return int how many deleted (including those soft deleted)
-     * @throws \EE_Error
-     */
-    public function delete_related_permanently($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            $count = $this->get_model()->delete_related_permanently($this, $relationName, $query_params);
-        } else {
-            $count = count($this->get_all_from_cache($relationName));
-        }
-        $this->clear_cache($relationName, null, true);
-        return $count;
-    }
-
-
-
-    /**
-     * is_set
-     * Just a simple utility function children can use for checking if property exists
-     *
-     * @access  public
-     * @param  string $field_name property to check
-     * @return bool                              TRUE if existing,FALSE if not.
-     */
-    public function is_set($field_name)
-    {
-        return isset($this->_fields[$field_name]);
-    }
-
-
-
-    /**
-     * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
-     * EE_Error exception if they don't
-     *
-     * @param  mixed (string|array) $properties properties to check
-     * @throws EE_Error
-     * @return bool                              TRUE if existing, throw EE_Error if not.
-     */
-    protected function _property_exists($properties)
-    {
-        foreach ((array)$properties as $property_name) {
-            //first make sure this property exists
-            if ( ! $this->_fields[$property_name]) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
-                            'event_espresso'
-                        ),
-                        $property_name
-                    )
-                );
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * This simply returns an array of model fields for this object
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function model_field_array()
-    {
-        $fields = $this->get_model()->field_settings(false);
-        $properties = array();
-        //remove prepended underscore
-        foreach ($fields as $field_name => $settings) {
-            $properties[$field_name] = $this->get($field_name);
-        }
-        return $properties;
-    }
-
-
-
-    /**
-     * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
-     * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
-     * requiring a plugin to extend the EE_Base_Class (which works fine is there's only 1 plugin, but when will that
-     * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
-     * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
-     * was called, and an array of the original arguments passed to the function. Whatever their callback function
-     * returns will be returned by this function. Example: in functions.php (or in a plugin):
-     * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
-     * my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
-     *        return $previousReturnValue.$returnString;
-     * }
-     * require('EE_Answer.class.php');
-     * $answer= EE_Answer::new_instance(array('REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'));
-     * echo $answer->my_callback('monkeys',100);
-     * //will output "you called my_callback! and passed args:monkeys,100"
-     *
-     * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
-     * @param array  $args       array of original arguments passed to the function
-     * @throws EE_Error
-     * @return mixed whatever the plugin which calls add_filter decides
-     */
-    public function __call($methodName, $args)
-    {
-        $className = get_class($this);
-        $tagName = "FHEE__{$className}__{$methodName}";
-        if ( ! has_filter($tagName)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
-                        "event_espresso"
-                    ),
-                    $methodName,
-                    $className,
-                    $tagName
-                )
-            );
-        }
-        return apply_filters($tagName, null, $this, $args);
-    }
-
-
-
-    /**
-     * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
-     * A $previous_value can be specified in case there are many meta rows with the same key
-     *
-     * @param string $meta_key
-     * @param mixed  $meta_value
-     * @param mixed  $previous_value
-     * @return bool|int # of records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
-     * @throws \EE_Error
-     * NOTE: if the values haven't changed, returns 0
-     */
-    public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
-    {
-        $query_params = array(
-            array(
-                'EXM_key'  => $meta_key,
-                'OBJ_ID'   => $this->ID(),
-                'EXM_type' => $this->get_model()->get_this_model_name(),
-            ),
-        );
-        if ($previous_value !== null) {
-            $query_params[0]['EXM_value'] = $meta_value;
-        }
-        $existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
-        if ( ! $existing_rows_like_that) {
-            return $this->add_extra_meta($meta_key, $meta_value);
-        }
-        foreach ($existing_rows_like_that as $existing_row) {
-            $existing_row->save(array('EXM_value' => $meta_value));
-        }
-        return count($existing_rows_like_that);
-    }
-
-
-
-    /**
-     * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
-     * no other extra meta for this model object have the same key. Returns TRUE if the
-     * extra meta row was entered, false if not
-     *
-     * @param string  $meta_key
-     * @param mixed   $meta_value
-     * @param boolean $unique
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function add_extra_meta($meta_key, $meta_value, $unique = false)
-    {
-        if ($unique) {
-            $existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
-                array(
-                    array(
-                        'EXM_key'  => $meta_key,
-                        'OBJ_ID'   => $this->ID(),
-                        'EXM_type' => $this->get_model()->get_this_model_name(),
-                    ),
-                )
-            );
-            if ($existing_extra_meta) {
-                return false;
-            }
-        }
-        $new_extra_meta = EE_Extra_Meta::new_instance(
-            array(
-                'EXM_key'   => $meta_key,
-                'EXM_value' => $meta_value,
-                'OBJ_ID'    => $this->ID(),
-                'EXM_type'  => $this->get_model()->get_this_model_name(),
-            )
-        );
-        $new_extra_meta->save();
-        return true;
-    }
-
-
-
-    /**
-     * Deletes all the extra meta rows for this record as specified by key. If $meta_value
-     * is specified, only deletes extra meta records with that value.
-     *
-     * @param string $meta_key
-     * @param mixed  $meta_value
-     * @return int number of extra meta rows deleted
-     * @throws \EE_Error
-     */
-    public function delete_extra_meta($meta_key, $meta_value = null)
-    {
-        $query_params = array(
-            array(
-                'EXM_key'  => $meta_key,
-                'OBJ_ID'   => $this->ID(),
-                'EXM_type' => $this->get_model()->get_this_model_name(),
-            ),
-        );
-        if ($meta_value !== null) {
-            $query_params[0]['EXM_value'] = $meta_value;
-        }
-        return EEM_Extra_Meta::instance()->delete($query_params);
-    }
-
-
-
-    /**
-     * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
-     * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
-     * You can specify $default is case you haven't found the extra meta
-     *
-     * @param string  $meta_key
-     * @param boolean $single
-     * @param mixed   $default if we don't find anything, what should we return?
-     * @return mixed single value if $single; array if ! $single
-     * @throws \EE_Error
-     */
-    public function get_extra_meta($meta_key, $single = false, $default = null)
-    {
-        if ($single) {
-            $result = $this->get_first_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
-            if ($result instanceof EE_Extra_Meta) {
-                return $result->value();
-            } else {
-                return $default;
-            }
-        } else {
-            $results = $this->get_many_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
-            if ($results) {
-                $values = array();
-                foreach ($results as $result) {
-                    if ($result instanceof EE_Extra_Meta) {
-                        $values[$result->ID()] = $result->value();
-                    }
-                }
-                return $values;
-            } else {
-                return $default;
-            }
-        }
-    }
-
-
-
-    /**
-     * Returns a simple array of all the extra meta associated with this model object.
-     * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
-     * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
-     * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
-     * If $one_of_each_key is false, it will return an array with the top-level keys being
-     * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
-     * finally the extra meta's value as each sub-value. (eg
-     * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
-     *
-     * @param boolean $one_of_each_key
-     * @return array
-     * @throws \EE_Error
-     */
-    public function all_extra_meta_array($one_of_each_key = true)
-    {
-        $return_array = array();
-        if ($one_of_each_key) {
-            $extra_meta_objs = $this->get_many_related('Extra_Meta', array('group_by' => 'EXM_key'));
-            foreach ($extra_meta_objs as $extra_meta_obj) {
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    $return_array[$extra_meta_obj->key()] = $extra_meta_obj->value();
-                }
-            }
-        } else {
-            $extra_meta_objs = $this->get_many_related('Extra_Meta');
-            foreach ($extra_meta_objs as $extra_meta_obj) {
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    if ( ! isset($return_array[$extra_meta_obj->key()])) {
-                        $return_array[$extra_meta_obj->key()] = array();
-                    }
-                    $return_array[$extra_meta_obj->key()][$extra_meta_obj->ID()] = $extra_meta_obj->value();
-                }
-            }
-        }
-        return $return_array;
-    }
-
-
-
-    /**
-     * Gets a pretty nice displayable nice for this model object. Often overridden
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function name()
-    {
-        //find a field that's not a text field
-        $field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
-        if ($field_we_can_use) {
-            return $this->get($field_we_can_use->get_name());
-        } else {
-            $first_few_properties = $this->model_field_array();
-            $first_few_properties = array_slice($first_few_properties, 0, 3);
-            $name_parts = array();
-            foreach ($first_few_properties as $name => $value) {
-                $name_parts[] = "$name:$value";
-            }
-            return implode(",", $name_parts);
-        }
-    }
-
-
-
-    /**
-     * in_entity_map
-     * Checks if this model object has been proven to already be in the entity map
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function in_entity_map()
-    {
-        if ($this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this) {
-            //well, if we looked, did we find it in the entity map?
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * refresh_from_db
-     * Makes sure the fields and values on this model object are in-sync with what's in the database.
-     *
-     * @throws EE_Error if this model object isn't in the entity mapper (because then you should
-     * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
-     */
-    public function refresh_from_db()
-    {
-        if ($this->ID() && $this->in_entity_map()) {
-            $this->get_model()->refresh_entity_map_from_db($this->ID());
-        } else {
-            //if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
-            //if it has an ID but it's not in the map, and you're asking me to refresh it
-            //that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
-            //absolutely nothing in it for this ID
-            if (WP_DEBUG) {
-                throw new EE_Error(
-                    sprintf(
-                        __('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
-                            'event_espresso'),
-                        $this->ID(),
-                        get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                        get_class($this->get_model()) . '::instance()->refresh_entity_map()'
-                    )
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
-     * (probably a bad assumption they have made, oh well)
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        try {
-            return sprintf('%s (%s)', $this->name(), $this->ID());
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            return '';
-        }
-    }
-
-
-
-    /**
-     * Clear related model objects if they're already in the DB, because otherwise when we
-     * UN-serialize this model object we'll need to be careful to add them to the entity map.
-     * This means if we have made changes to those related model objects, and want to unserialize
-     * the this model object on a subsequent request, changes to those related model objects will be lost.
-     * Instead, those related model objects should be directly serialized and stored.
-     * Eg, the following won't work:
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
-     * $att = $reg->attendee();
-     * $att->set( 'ATT_fname', 'Dirk' );
-     * update_option( 'my_option', serialize( $reg ) );
-     * //END REQUEST
-     * //START NEXT REQUEST
-     * $reg = get_option( 'my_option' );
-     * $reg->attendee()->save();
-     * And would need to be replace with:
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
-     * $att = $reg->attendee();
-     * $att->set( 'ATT_fname', 'Dirk' );
-     * update_option( 'my_option', serialize( $reg ) );
-     * //END REQUEST
-     * //START NEXT REQUEST
-     * $att = get_option( 'my_option' );
-     * $att->save();
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function __sleep()
-    {
-        $model = $this->get_model();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $classname = 'EE_' . $model->get_this_model_name();
-                if (
-                    $this->get_one_from_cache($relation_name) instanceof $classname
-                    && $this->get_one_from_cache($relation_name)->ID()
-                ) {
-                    $this->clear_cache($relation_name, $this->get_one_from_cache($relation_name)->ID());
-                }
-            }
-        }
-        $this->_props_n_values_provided_in_constructor = array();
-        $properties_to_serialize = get_object_vars($this);
-        //don't serialize the model. It's big and that risks recursion
-        unset($properties_to_serialize['_model']);
-        return array_keys($properties_to_serialize);
-    }
-
-
-
-    /**
-     * restore _props_n_values_provided_in_constructor
-     * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
-     * and therefore should NOT be used to determine if state change has occurred since initial construction.
-     * At best, you would only be able to detect if state change has occurred during THIS request.
-     */
-    public function __wakeup()
-    {
-        $this->_props_n_values_provided_in_constructor = $this->_fields;
-    }
+	/**
+	 * This is an array of the original properties and values provided during construction
+	 * of this model object. (keys are model field names, values are their values).
+	 * This list is important to remember so that when we are merging data from the db, we know
+	 * which values to override and which to not override.
+	 *
+	 * @var array
+	 */
+	protected $_props_n_values_provided_in_constructor;
+
+	/**
+	 * Timezone
+	 * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
+	 * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
+	 * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
+	 * access to it.
+	 *
+	 * @var string
+	 */
+	protected $_timezone;
+
+
+
+	/**
+	 * date format
+	 * pattern or format for displaying dates
+	 *
+	 * @var string $_dt_frmt
+	 */
+	protected $_dt_frmt;
+
+
+
+	/**
+	 * time format
+	 * pattern or format for displaying time
+	 *
+	 * @var string $_tm_frmt
+	 */
+	protected $_tm_frmt;
+
+
+
+	/**
+	 * This property is for holding a cached array of object properties indexed by property name as the key.
+	 * The purpose of this is for setting a cache on properties that may have calculated values after a
+	 * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
+	 * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
+	 *
+	 * @var array
+	 */
+	protected $_cached_properties = array();
+
+	/**
+	 * An array containing keys of the related model, and values are either an array of related mode objects or a
+	 * single
+	 * related model object. see the model's _model_relations. The keys should match those specified. And if the
+	 * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
+	 * all others have an array)
+	 *
+	 * @var array
+	 */
+	protected $_model_relations = array();
+
+	/**
+	 * Array where keys are field names (see the model's _fields property) and values are their values. To see what
+	 * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
+	 *
+	 * @var array
+	 */
+	protected $_fields = array();
+
+	/**
+	 * @var boolean indicating whether or not this model object is intended to ever be saved
+	 * For example, we might create model objects intended to only be used for the duration
+	 * of this request and to be thrown away, and if they were accidentally saved
+	 * it would be a bug.
+	 */
+	protected $_allow_persist = true;
+
+	/**
+	 * @var boolean indicating whether or not this model object's properties have changed since construction
+	 */
+	protected $_has_changes = false;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model;
+
+
+
+	/**
+	 * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children
+	 * play nice
+	 *
+	 * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
+	 *                                                         layer of the model's _fields array, (eg, EVT_ID,
+	 *                                                         TXN_amount, QST_name, etc) and values are their values
+	 * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
+	 *                                                         corresponding db model or not.
+	 * @param string  $timezone                                indicate what timezone you want any datetime fields to
+	 *                                                         be in when instantiating a EE_Base_Class object.
+	 * @param array   $date_formats                            An array of date formats to set on construct where first
+	 *                                                         value is the date_format and second value is the time
+	 *                                                         format.
+	 * @throws EE_Error
+	 */
+	protected function __construct($fieldValues = array(), $bydb = false, $timezone = '', $date_formats = array())
+	{
+		$className = get_class($this);
+		do_action("AHEE__{$className}__construct", $this, $fieldValues);
+		$model = $this->get_model();
+		$model_fields = $model->field_settings(false);
+		// ensure $fieldValues is an array
+		$fieldValues = is_array($fieldValues) ? $fieldValues : array($fieldValues);
+		// EEH_Debug_Tools::printr( $fieldValues, '$fieldValues  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		// verify client code has not passed any invalid field names
+		foreach ($fieldValues as $field_name => $field_value) {
+			if ( ! isset($model_fields[$field_name])) {
+				throw new EE_Error(sprintf(__("Invalid field (%s) passed to constructor of %s. Allowed fields are :%s",
+					"event_espresso"), $field_name, get_class($this), implode(", ", array_keys($model_fields))));
+			}
+		}
+		// EEH_Debug_Tools::printr( $model_fields, '$model_fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
+		if ( ! empty($date_formats) && is_array($date_formats)) {
+			list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
+		} else {
+			//set default formats for date and time
+			$this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
+			$this->_tm_frmt = (string)get_option('time_format', 'g:i a');
+		}
+		//if db model is instantiating
+		if ($bydb) {
+			//client code has indicated these field values are from the database
+			foreach ($model_fields as $fieldName => $field) {
+				$this->set_from_db($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null);
+			}
+		} else {
+			//we're constructing a brand
+			//new instance of the model object. Generally, this means we'll need to do more field validation
+			foreach ($model_fields as $fieldName => $field) {
+				$this->set($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null, true);
+			}
+		}
+		//remember what values were passed to this constructor
+		$this->_props_n_values_provided_in_constructor = $fieldValues;
+		//remember in entity mapper
+		if ( ! $bydb && $model->has_primary_key_field() && $this->ID()) {
+			$model->add_to_entity_map($this);
+		}
+		//setup all the relations
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$this->_model_relations[$relation_name] = null;
+			} else {
+				$this->_model_relations[$relation_name] = array();
+			}
+		}
+		/**
+		 * Action done at the end of each model object construction
+		 *
+		 * @param EE_Base_Class $this the model object just created
+		 */
+		do_action('AHEE__EE_Base_Class__construct__finished', $this);
+	}
+
+
+
+	/**
+	 * Gets whether or not this model object is allowed to persist/be saved to the database.
+	 *
+	 * @return boolean
+	 */
+	public function allow_persist()
+	{
+		return $this->_allow_persist;
+	}
+
+
+
+	/**
+	 * Sets whether or not this model object should be allowed to be saved to the DB.
+	 * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
+	 * you got new information that somehow made you change your mind.
+	 *
+	 * @param boolean $allow_persist
+	 * @return boolean
+	 */
+	public function set_allow_persist($allow_persist)
+	{
+		return $this->_allow_persist = $allow_persist;
+	}
+
+
+
+	/**
+	 * Gets the field's original value when this object was constructed during this request.
+	 * This can be helpful when determining if a model object has changed or not
+	 *
+	 * @param string $field_name
+	 * @return mixed|null
+	 * @throws \EE_Error
+	 */
+	public function get_original($field_name)
+	{
+		if (isset($this->_props_n_values_provided_in_constructor[$field_name])
+			&& $field_settings = $this->get_model()->field_settings_for($field_name)
+		) {
+			return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[$field_name]);
+		} else {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * @param EE_Base_Class $obj
+	 * @return string
+	 */
+	public function get_class($obj)
+	{
+		return get_class($obj);
+	}
+
+
+
+	/**
+	 * Overrides parent because parent expects old models.
+	 * This also doesn't do any validation, and won't work for serialized arrays
+	 *
+	 * @param    string $field_name
+	 * @param    mixed  $field_value
+	 * @param bool      $use_default
+	 * @throws \EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		// if not using default and nothing has changed, and object has already been setup (has ID),
+		// then don't do anything
+		if (
+			! $use_default
+			&& $this->_fields[$field_name] === $field_value
+			&& $this->ID()
+		) {
+			return;
+		}
+		$model = $this->get_model();
+		$this->_has_changes = true;
+		$field_obj = $model->field_settings_for($field_name);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			//			if ( method_exists( $field_obj, 'set_timezone' )) {
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$field_obj->set_timezone($this->_timezone);
+				$field_obj->set_date_format($this->_dt_frmt);
+				$field_obj->set_time_format($this->_tm_frmt);
+			}
+			$holder_of_value = $field_obj->prepare_for_set($field_value);
+			//should the value be null?
+			if (($field_value === null || $holder_of_value === null || $holder_of_value === '') && $use_default) {
+				$this->_fields[$field_name] = $field_obj->get_default_value();
+				/**
+				 * To save having to refactor all the models, if a default value is used for a
+				 * EE_Datetime_Field, and that value is not null nor is it a DateTime
+				 * object.  Then let's do a set again to ensure that it becomes a DateTime
+				 * object.
+				 *
+				 * @since 4.6.10+
+				 */
+				if (
+					$field_obj instanceof EE_Datetime_Field
+					&& $this->_fields[$field_name] !== null
+					&& ! $this->_fields[$field_name] instanceof DateTime
+				) {
+					empty($this->_fields[$field_name])
+						? $this->set($field_name, time())
+						: $this->set($field_name, $this->_fields[$field_name]);
+				}
+			} else {
+				$this->_fields[$field_name] = $holder_of_value;
+			}
+			//if we're not in the constructor...
+			//now check if what we set was a primary key
+			if (
+				//note: props_n_values_provided_in_constructor is only set at the END of the constructor
+				$this->_props_n_values_provided_in_constructor
+				&& $field_value
+				&& $field_name === $model->primary_key_name()
+			) {
+				//if so, we want all this object's fields to be filled either with
+				//what we've explicitly set on this model
+				//or what we have in the db
+				// echo "setting primary key!";
+				$fields_on_model = self::_get_model(get_class($this))->field_settings();
+				$obj_in_db = self::_get_model(get_class($this))->get_one_by_ID($field_value);
+				foreach ($fields_on_model as $field_obj) {
+					if ( ! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
+						 && $field_obj->get_name() !== $field_name
+					) {
+						$this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
+					}
+				}
+				//oh this model object has an ID? well make sure its in the entity mapper
+				$model->add_to_entity_map($this);
+			}
+			//let's unset any cache for this field_name from the $_cached_properties property.
+			$this->_clear_cached_property($field_name);
+		} else {
+			throw new EE_Error(sprintf(__("A valid EE_Model_Field_Base could not be found for the given field name: %s",
+				"event_espresso"), $field_name));
+		}
+	}
+
+
+
+	/**
+	 * This sets the field value on the db column if it exists for the given $column_name or
+	 * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
+	 *
+	 * @see EE_message::get_column_value for related documentation on the necessity of this method.
+	 * @param string $field_name  Must be the exact column name.
+	 * @param mixed  $field_value The value to set.
+	 * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
+	 * @throws \EE_Error
+	 */
+	public function set_field_or_extra_meta($field_name, $field_value)
+	{
+		if ($this->get_model()->has_field($field_name)) {
+			$this->set($field_name, $field_value);
+			return true;
+		} else {
+			//ensure this object is saved first so that extra meta can be properly related.
+			$this->save();
+			return $this->update_extra_meta($field_name, $field_value);
+		}
+	}
+
+
+
+	/**
+	 * This retrieves the value of the db column set on this class or if that's not present
+	 * it will attempt to retrieve from extra_meta if found.
+	 * Example Usage:
+	 * Via EE_Message child class:
+	 * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
+	 * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
+	 * also have additional main fields specific to the messenger.  The system accommodates those extra
+	 * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
+	 * value for those extra fields dynamically via the EE_message object.
+	 *
+	 * @param  string $field_name expecting the fully qualified field name.
+	 * @return mixed|null  value for the field if found.  null if not found.
+	 * @throws \EE_Error
+	 */
+	public function get_field_or_extra_meta($field_name)
+	{
+		if ($this->get_model()->has_field($field_name)) {
+			$column_value = $this->get($field_name);
+		} else {
+			//This isn't a column in the main table, let's see if it is in the extra meta.
+			$column_value = $this->get_extra_meta($field_name, true, null);
+		}
+		return $column_value;
+	}
+
+
+
+	/**
+	 * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
+	 * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
+	 * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
+	 * available to all child classes that may be using the EE_Datetime_Field for a field data type.
+	 *
+	 * @access public
+	 * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_timezone($timezone = '')
+	{
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
+		//make sure we clear all cached properties because they won't be relevant now
+		$this->_clear_cached_properties();
+		//make sure we update field settings and the date for all EE_Datetime_Fields
+		$model_fields = $this->get_model()->field_settings(false);
+		foreach ($model_fields as $field_name => $field_obj) {
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$field_obj->set_timezone($this->_timezone);
+				if (isset($this->_fields[$field_name]) && $this->_fields[$field_name] instanceof DateTime) {
+					$this->_fields[$field_name]->setTimezone(new DateTimeZone($this->_timezone));
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string timezone string
+	 */
+	public function get_timezone()
+	{
+		return $this->_timezone;
+	}
+
+
+
+	/**
+	 * This sets the internal date format to what is sent in to be used as the new default for the class
+	 * internally instead of wp set date format options
+	 *
+	 * @since 4.6
+	 * @param string $format should be a format recognizable by PHP date() functions.
+	 */
+	public function set_date_format($format)
+	{
+		$this->_dt_frmt = $format;
+		//clear cached_properties because they won't be relevant now.
+		$this->_clear_cached_properties();
+	}
+
+
+
+	/**
+	 * This sets the internal time format string to what is sent in to be used as the new default for the
+	 * class internally instead of wp set time format options.
+	 *
+	 * @since 4.6
+	 * @param string $format should be a format recognizable by PHP date() functions.
+	 */
+	public function set_time_format($format)
+	{
+		$this->_tm_frmt = $format;
+		//clear cached_properties because they won't be relevant now.
+		$this->_clear_cached_properties();
+	}
+
+
+
+	/**
+	 * This returns the current internal set format for the date and time formats.
+	 *
+	 * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
+	 *                             where the first value is the date format and the second value is the time format.
+	 * @return mixed string|array
+	 */
+	public function get_format($full = true)
+	{
+		return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
+	}
+
+
+
+	/**
+	 * cache
+	 * stores the passed model object on the current model object.
+	 * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
+	 *
+	 * @param string        $relationName    one of the keys in the _model_relations array on the model. Eg
+	 *                                       'Registration' associated with this model object
+	 * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
+	 *                                       that could be a payment or a registration)
+	 * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
+	 *                                       items which will be stored in an array on this object
+	 * @throws EE_Error
+	 * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
+	 *                  related thing, no array)
+	 */
+	public function cache($relationName = '', $object_to_cache = null, $cache_id = null)
+	{
+		// its entirely possible that there IS no related object yet in which case there is nothing to cache.
+		if ( ! $object_to_cache instanceof EE_Base_Class) {
+			return false;
+		}
+		// also get "how" the object is related, or throw an error
+		if ( ! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
+			throw new EE_Error(sprintf(__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
+				$relationName, get_class($this)));
+		}
+		// how many things are related ?
+		if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+			// if it's a "belongs to" relationship, then there's only one related model object  eg, if this is a registration, there's only 1 attendee for it
+			// so for these model objects just set it to be cached
+			$this->_model_relations[$relationName] = $object_to_cache;
+			$return = true;
+		} else {
+			// otherwise, this is the "many" side of a one to many relationship, so we'll add the object to the array of related objects for that type.
+			// eg: if this is an event, there are many registrations for that event, so we cache the registrations in an array
+			if ( ! is_array($this->_model_relations[$relationName])) {
+				// if for some reason, the cached item is a model object, then stick that in the array, otherwise start with an empty array
+				$this->_model_relations[$relationName] = $this->_model_relations[$relationName] instanceof EE_Base_Class
+					? array($this->_model_relations[$relationName]) : array();
+			}
+			// first check for a cache_id which is normally empty
+			if ( ! empty($cache_id)) {
+				// if the cache_id exists, then it means we are purposely trying to cache this with a known key that can then be used to retrieve the object later on
+				$this->_model_relations[$relationName][$cache_id] = $object_to_cache;
+				$return = $cache_id;
+			} elseif ($object_to_cache->ID()) {
+				// OR the cached object originally came from the db, so let's just use it's PK for an ID
+				$this->_model_relations[$relationName][$object_to_cache->ID()] = $object_to_cache;
+				$return = $object_to_cache->ID();
+			} else {
+				// OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
+				$this->_model_relations[$relationName][] = $object_to_cache;
+				// move the internal pointer to the end of the array
+				end($this->_model_relations[$relationName]);
+				// and grab the key so that we can return it
+				$return = key($this->_model_relations[$relationName]);
+			}
+		}
+		return $return;
+	}
+
+
+
+	/**
+	 * For adding an item to the cached_properties property.
+	 *
+	 * @access protected
+	 * @param string      $fieldname the property item the corresponding value is for.
+	 * @param mixed       $value     The value we are caching.
+	 * @param string|null $cache_type
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _set_cached_property($fieldname, $value, $cache_type = null)
+	{
+		//first make sure this property exists
+		$this->get_model()->field_settings_for($fieldname);
+		$cache_type = empty($cache_type) ? 'standard' : $cache_type;
+		$this->_cached_properties[$fieldname][$cache_type] = $value;
+	}
+
+
+
+	/**
+	 * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
+	 * This also SETS the cache if we return the actual property!
+	 *
+	 * @param string $fieldname        the name of the property we're trying to retrieve
+	 * @param bool   $pretty
+	 * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
+	 *                                 (in cases where the same property may be used for different outputs
+	 *                                 - i.e. datetime, money etc.)
+	 *                                 It can also accept certain pre-defined "schema" strings
+	 *                                 to define how to output the property.
+	 *                                 see the field's prepare_for_pretty_echoing for what strings can be used
+	 * @return mixed                   whatever the value for the property is we're retrieving
+	 * @throws \EE_Error
+	 */
+	protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
+	{
+		//verify the field exists
+		$model = $this->get_model();
+		$model->field_settings_for($fieldname);
+		$cache_type = $pretty ? 'pretty' : 'standard';
+		$cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
+		if (isset($this->_cached_properties[$fieldname][$cache_type])) {
+			return $this->_cached_properties[$fieldname][$cache_type];
+		}
+		$value = $this->_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
+		$this->_set_cached_property($fieldname, $value, $cache_type);
+		return $value;
+	}
+
+
+
+	/**
+	 * If the cache didn't fetch the needed item, this fetches it.
+	 * @param string $fieldname
+	 * @param bool $pretty
+	 * @param string $extra_cache_ref
+	 * @return mixed
+	 */
+	protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
+	{
+		$field_obj = $this->get_model()->field_settings_for($fieldname);
+		// If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
+		if ($field_obj instanceof EE_Datetime_Field) {
+			$this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
+		}
+		if ( ! isset($this->_fields[$fieldname])) {
+			$this->_fields[$fieldname] = null;
+		}
+		$value = $pretty
+			? $field_obj->prepare_for_pretty_echoing($this->_fields[$fieldname], $extra_cache_ref)
+			: $field_obj->prepare_for_get($this->_fields[$fieldname]);
+		return $value;
+	}
+
+
+
+	/**
+	 * set timezone, formats, and output for EE_Datetime_Field objects
+	 *
+	 * @param \EE_Datetime_Field $datetime_field
+	 * @param bool               $pretty
+	 * @param null $date_or_time
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _prepare_datetime_field(
+		EE_Datetime_Field $datetime_field,
+		$pretty = false,
+		$date_or_time = null
+	) {
+		$datetime_field->set_timezone($this->_timezone);
+		$datetime_field->set_date_format($this->_dt_frmt, $pretty);
+		$datetime_field->set_time_format($this->_tm_frmt, $pretty);
+		//set the output returned
+		switch ($date_or_time) {
+			case 'D' :
+				$datetime_field->set_date_time_output('date');
+				break;
+			case 'T' :
+				$datetime_field->set_date_time_output('time');
+				break;
+			default :
+				$datetime_field->set_date_time_output();
+		}
+	}
+
+
+
+	/**
+	 * This just takes care of clearing out the cached_properties
+	 *
+	 * @return void
+	 */
+	protected function _clear_cached_properties()
+	{
+		$this->_cached_properties = array();
+	}
+
+
+
+	/**
+	 * This just clears out ONE property if it exists in the cache
+	 *
+	 * @param  string $property_name the property to remove if it exists (from the _cached_properties array)
+	 * @return void
+	 */
+	protected function _clear_cached_property($property_name)
+	{
+		if (isset($this->_cached_properties[$property_name])) {
+			unset($this->_cached_properties[$property_name]);
+		}
+	}
+
+
+
+	/**
+	 * Ensures that this related thing is a model object.
+	 *
+	 * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
+	 * @param string $model_name   name of the related thing, eg 'Attendee',
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
+	{
+		$other_model_instance = self::_get_model_instance_with_name(
+			self::_get_model_classname($model_name),
+			$this->_timezone
+		);
+		return $other_model_instance->ensure_is_obj($object_or_id);
+	}
+
+
+
+	/**
+	 * Forgets the cached model of the given relation Name. So the next time we request it,
+	 * we will fetch it again from the database. (Handy if you know it's changed somehow).
+	 * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
+	 * then only remove that one object from our cached array. Otherwise, clear the entire list
+	 *
+	 * @param string $relationName                         one of the keys in the _model_relations array on the model.
+	 *                                                     Eg 'Registration'
+	 * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
+	 *                                                     if you intend to use $clear_all = TRUE, or the relation only
+	 *                                                     has 1 object anyways (ie, it's a BelongsToRelation)
+	 * @param bool   $clear_all                            This flags clearing the entire cache relation property if
+	 *                                                     this is HasMany or HABTM.
+	 * @throws EE_Error
+	 * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a
+	 *                       relation from all
+	 */
+	public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false)
+	{
+		$relationship_to_model = $this->get_model()->related_settings_for($relationName);
+		$index_in_cache = '';
+		if ( ! $relationship_to_model) {
+			throw new EE_Error(
+				sprintf(
+					__("There is no relationship to %s on a %s. Cannot clear that cache", 'event_espresso'),
+					$relationName,
+					get_class($this)
+				)
+			);
+		}
+		if ($clear_all) {
+			$obj_removed = true;
+			$this->_model_relations[$relationName] = null;
+		} elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+			$obj_removed = $this->_model_relations[$relationName];
+			$this->_model_relations[$relationName] = null;
+		} else {
+			if ($object_to_remove_or_index_into_array instanceof EE_Base_Class
+				&& $object_to_remove_or_index_into_array->ID()
+			) {
+				$index_in_cache = $object_to_remove_or_index_into_array->ID();
+				if (is_array($this->_model_relations[$relationName])
+					&& ! isset($this->_model_relations[$relationName][$index_in_cache])
+				) {
+					$index_found_at = null;
+					//find this object in the array even though it has a different key
+					foreach ($this->_model_relations[$relationName] as $index => $obj) {
+						if (
+							$obj instanceof EE_Base_Class
+							&& (
+								$obj == $object_to_remove_or_index_into_array
+								|| $obj->ID() === $object_to_remove_or_index_into_array->ID()
+							)
+						) {
+							$index_found_at = $index;
+							break;
+						}
+					}
+					if ($index_found_at) {
+						$index_in_cache = $index_found_at;
+					} else {
+						//it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
+						//if it wasn't in it to begin with. So we're done
+						return $object_to_remove_or_index_into_array;
+					}
+				}
+			} elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
+				//so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
+				foreach ($this->get_all_from_cache($relationName) as $index => $potentially_obj_we_want) {
+					if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
+						$index_in_cache = $index;
+					}
+				}
+			} else {
+				$index_in_cache = $object_to_remove_or_index_into_array;
+			}
+			//supposedly we've found it. But it could just be that the client code
+			//provided a bad index/object
+			if (
+			isset(
+				$this->_model_relations[$relationName],
+				$this->_model_relations[$relationName][$index_in_cache]
+			)
+			) {
+				$obj_removed = $this->_model_relations[$relationName][$index_in_cache];
+				unset($this->_model_relations[$relationName][$index_in_cache]);
+			} else {
+				//that thing was never cached anyways.
+				$obj_removed = null;
+			}
+		}
+		return $obj_removed;
+	}
+
+
+
+	/**
+	 * update_cache_after_object_save
+	 * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
+	 * obtained after being saved to the db
+	 *
+	 * @param string         $relationName       - the type of object that is cached
+	 * @param \EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
+	 * @param string         $current_cache_id   - the ID that was used when originally caching the object
+	 * @return boolean TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function update_cache_after_object_save(
+		$relationName,
+		EE_Base_Class $newly_saved_object,
+		$current_cache_id = ''
+	) {
+		// verify that incoming object is of the correct type
+		$obj_class = 'EE_' . $relationName;
+		if ($newly_saved_object instanceof $obj_class) {
+			/* @type EE_Base_Class $newly_saved_object */
+			// now get the type of relation
+			$relationship_to_model = $this->get_model()->related_settings_for($relationName);
+			// if this is a 1:1 relationship
+			if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+				// then just replace the cached object with the newly saved object
+				$this->_model_relations[$relationName] = $newly_saved_object;
+				return true;
+				// or if it's some kind of sordid feral polyamorous relationship...
+			} elseif (is_array($this->_model_relations[$relationName])
+					  && isset($this->_model_relations[$relationName][$current_cache_id])
+			) {
+				// then remove the current cached item
+				unset($this->_model_relations[$relationName][$current_cache_id]);
+				// and cache the newly saved object using it's new ID
+				$this->_model_relations[$relationName][$newly_saved_object->ID()] = $newly_saved_object;
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
+	 *
+	 * @param string $relationName
+	 * @return EE_Base_Class
+	 */
+	public function get_one_from_cache($relationName)
+	{
+		$cached_array_or_object = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName]
+			: null;
+		if (is_array($cached_array_or_object)) {
+			return array_shift($cached_array_or_object);
+		} else {
+			return $cached_array_or_object;
+		}
+	}
+
+
+
+	/**
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
+	 *
+	 * @param string $relationName
+	 * @throws \EE_Error
+	 * @return EE_Base_Class[] NOT necessarily indexed by primary keys
+	 */
+	public function get_all_from_cache($relationName)
+	{
+		$objects = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName] : array();
+		// if the result is not an array, but exists, make it an array
+		$objects = is_array($objects) ? $objects : array($objects);
+		//bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
+		//basically, if this model object was stored in the session, and these cached model objects
+		//already have IDs, let's make sure they're in their model's entity mapper
+		//otherwise we will have duplicates next time we call
+		// EE_Registry::instance()->load_model( $relationName )->get_one_by_ID( $result->ID() );
+		$model = EE_Registry::instance()->load_model($relationName);
+		foreach ($objects as $model_object) {
+			if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
+				//ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
+				if ($model_object->ID()) {
+					$model->add_to_entity_map($model_object);
+				}
+			} else {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
+							'event_espresso'
+						),
+						$relationName,
+						gettype($model_object)
+					)
+				);
+			}
+		}
+		return $objects;
+	}
+
+
+
+	/**
+	 * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param int   $limit              How many objects to return.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function next_x($field_to_order_by = null, $limit = 1, $query_params = array(), $columns_to_select = null)
+	{
+		$model = $this->get_model();
+		$field = empty($field_to_order_by) && $model->has_primary_key_field()
+			? $model->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $model->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param int   $limit              How many objects to return.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function previous_x(
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = array(),
+		$columns_to_select = null
+	) {
+		$model = $this->get_model();
+		$field = empty($field_to_order_by) && $model->has_primary_key_field()
+			? $model->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $model->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Returns the next EE_Base_Class object in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function next($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
+	{
+		$model = $this->get_model();
+		$field = empty($field_to_order_by) && $model->has_primary_key_field()
+			? $model->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $model->next($current_value, $field, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Returns the previous EE_Base_Class object in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
+	 *                                  you can indicate just the column you want returned
+	 * @return array|EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function previous($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
+	{
+		$model = $this->get_model();
+		$field = empty($field_to_order_by) && $model->has_primary_key_field()
+			? $model->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $model->previous($current_value, $field, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Overrides parent because parent expects old models.
+	 * This also doesn't do any validation, and won't work for serialized arrays
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value_from_db
+	 * @throws \EE_Error
+	 */
+	public function set_from_db($field_name, $field_value_from_db)
+	{
+		$field_obj = $this->get_model()->field_settings_for($field_name);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			//you would think the DB has no NULLs for non-null label fields right? wrong!
+			//eg, a CPT model object could have an entry in the posts table, but no
+			//entry in the meta table. Meaning that all its columns in the meta table
+			//are null! yikes! so when we find one like that, use defaults for its meta columns
+			if ($field_value_from_db === null) {
+				if ($field_obj->is_nullable()) {
+					//if the field allows nulls, then let it be null
+					$field_value = null;
+				} else {
+					$field_value = $field_obj->get_default_value();
+				}
+			} else {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
+			}
+			$this->_fields[$field_name] = $field_value;
+			$this->_clear_cached_property($field_name);
+		}
+	}
+
+
+
+	/**
+	 * verifies that the specified field is of the correct type
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function get($field_name, $extra_cache_ref = null)
+	{
+		return $this->_get_cached_property($field_name, false, $extra_cache_ref);
+	}
+
+
+
+	/**
+	 * This method simply returns the RAW unprocessed value for the given property in this class
+	 *
+	 * @param  string $field_name A valid fieldname
+	 * @return mixed              Whatever the raw value stored on the property is.
+	 * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
+	 */
+	public function get_raw($field_name)
+	{
+		$field_settings = $this->get_model()->field_settings_for($field_name);
+		return $field_settings instanceof EE_Datetime_Field && $this->_fields[$field_name] instanceof DateTime
+			? $this->_fields[$field_name]->format('U')
+			: $this->_fields[$field_name];
+	}
+
+
+
+	/**
+	 * This is used to return the internal DateTime object used for a field that is a
+	 * EE_Datetime_Field.
+	 *
+	 * @param string $field_name               The field name retrieving the DateTime object.
+	 * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
+	 * @throws \EE_Error
+	 *                                         an error is set and false returned.  If the field IS an
+	 *                                         EE_Datetime_Field and but the field value is null, then
+	 *                                         just null is returned (because that indicates that likely
+	 *                                         this field is nullable).
+	 */
+	public function get_DateTime_object($field_name)
+	{
+		$field_settings = $this->get_model()->field_settings_for($field_name);
+		if ( ! $field_settings instanceof EE_Datetime_Field) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
+						'event_espresso'
+					),
+					$field_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $this->_fields[$field_name];
+	}
+
+
+
+	/**
+	 * To be used in template to immediately echo out the value, and format it for output.
+	 * Eg, should call stripslashes and whatnot before echoing
+	 *
+	 * @param string $field_name      the name of the field as it appears in the DB
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function e($field_name, $extra_cache_ref = null)
+	{
+		echo $this->get_pretty($field_name, $extra_cache_ref);
+	}
+
+
+
+	/**
+	 * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
+	 * can be easily used as the value of form input.
+	 *
+	 * @param string $field_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function f($field_name)
+	{
+		$this->e($field_name, 'form_input');
+	}
+
+
+
+	/**
+	 * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this.
+	 * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class
+	 * to see what options are available.
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($field_name, $extra_cache_ref = null)
+	{
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
+	}
+
+
+
+	/**
+	 * This simply returns the datetime for the given field name
+	 * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
+	 * (and the equivalent e_date, e_time, e_datetime).
+	 *
+	 * @access   protected
+	 * @param string   $field_name   Field on the instantiated EE_Base_Class child object
+	 * @param string   $dt_frmt      valid datetime format used for date
+	 *                               (if '' then we just use the default on the field,
+	 *                               if NULL we use the last-used format)
+	 * @param string   $tm_frmt      Same as above except this is for time format
+	 * @param string   $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
+	 * @param  boolean $echo         Whether the dtt is echoing using pretty echoing or just returned using vanilla get
+	 * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
+	 *                               if field is not a valid dtt field, or void if echoing
+	 * @throws \EE_Error
+	 */
+	protected function _get_datetime($field_name, $dt_frmt = '', $tm_frmt = '', $date_or_time = '', $echo = false)
+	{
+		// clear cached property
+		$this->_clear_cached_property($field_name);
+		//reset format properties because they are used in get()
+		$this->_dt_frmt = $dt_frmt !== '' ? $dt_frmt : $this->_dt_frmt;
+		$this->_tm_frmt = $tm_frmt !== '' ? $tm_frmt : $this->_tm_frmt;
+		if ($echo) {
+			$this->e($field_name, $date_or_time);
+			return '';
+		}
+		return $this->get($field_name, $date_or_time);
+	}
+
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $format     format for the date returned (if NULL we use default in dt_frmt property)
+	 * @return string            datetime value formatted
+	 * @throws \EE_Error
+	 */
+	public function get_date($field_name, $format = '')
+	{
+		return $this->_get_datetime($field_name, $format, null, 'D');
+	}
+
+
+
+	/**
+	 * @param      $field_name
+	 * @param string $format
+	 * @throws \EE_Error
+	 */
+	public function e_date($field_name, $format = '')
+	{
+		$this->_get_datetime($field_name, $format, null, 'D', true);
+	}
+
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $format     format for the time returned ( if NULL we use default in tm_frmt property)
+	 * @return string             datetime value formatted
+	 * @throws \EE_Error
+	 */
+	public function get_time($field_name, $format = '')
+	{
+		return $this->_get_datetime($field_name, null, $format, 'T');
+	}
+
+
+
+	/**
+	 * @param      $field_name
+	 * @param string $format
+	 * @throws \EE_Error
+	 */
+	public function e_time($field_name, $format = '')
+	{
+		$this->_get_datetime($field_name, null, $format, 'T', true);
+	}
+
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
+	 * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $dt_frmt    format for the date returned (if NULL we use default in dt_frmt property)
+	 * @param  string $tm_frmt    format for the time returned (if NULL we use default in tm_frmt property)
+	 * @return string             datetime value formatted
+	 * @throws \EE_Error
+	 */
+	public function get_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
+	{
+		return $this->_get_datetime($field_name, $dt_frmt, $tm_frmt);
+	}
+
+
+
+	/**
+	 * @param string $field_name
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @throws \EE_Error
+	 */
+	public function e_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
+	{
+		$this->_get_datetime($field_name, $dt_frmt, $tm_frmt, null, true);
+	}
+
+
+
+	/**
+	 * Get the i8ln value for a date using the WordPress @see date_i18n function.
+	 *
+	 * @param string $field_name The EE_Datetime_Field reference for the date being retrieved.
+	 * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
+	 *                           on the object will be used.
+	 * @return string Date and time string in set locale or false if no field exists for the given
+	 * @throws \EE_Error
+	 *                           field name.
+	 */
+	public function get_i18n_datetime($field_name, $format = '')
+	{
+		$format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
+		return date_i18n(
+			$format,
+			EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
+		);
+	}
+
+
+
+	/**
+	 * This method validates whether the given field name is a valid field on the model object as well as it is of a
+	 * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
+	 * thrown.
+	 *
+	 * @param  string $field_name The field name being checked
+	 * @throws EE_Error
+	 * @return EE_Datetime_Field
+	 */
+	protected function _get_dtt_field_settings($field_name)
+	{
+		$field = $this->get_model()->field_settings_for($field_name);
+		//check if field is dtt
+		if ($field instanceof EE_Datetime_Field) {
+			return $field;
+		} else {
+			throw new EE_Error(sprintf(__('The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
+				'event_espresso'), $field_name, self::_get_model_classname(get_class($this))));
+		}
+	}
+
+
+
+
+	/**
+	 * NOTE ABOUT BELOW:
+	 * These convenience date and time setters are for setting date and time independently.  In other words you might
+	 * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
+	 * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
+	 * method and make sure you send the entire datetime value for setting.
+	 */
+	/**
+	 * sets the time on a datetime property
+	 *
+	 * @access protected
+	 * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
+	 * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
+	 * @throws \EE_Error
+	 */
+	protected function _set_time_for($time, $fieldname)
+	{
+		$this->_set_date_time('T', $time, $fieldname);
+	}
+
+
+
+	/**
+	 * sets the date on a datetime property
+	 *
+	 * @access protected
+	 * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
+	 * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
+	 * @throws \EE_Error
+	 */
+	protected function _set_date_for($date, $fieldname)
+	{
+		$this->_set_date_time('D', $date, $fieldname);
+	}
+
+
+
+	/**
+	 * This takes care of setting a date or time independently on a given model object property. This method also
+	 * verifies that the given fieldname matches a model object property and is for a EE_Datetime_Field field
+	 *
+	 * @access protected
+	 * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
+	 * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
+	 * @param string          $fieldname      the name of the field the date OR time is being set on (must match a
+	 *                                        EE_Datetime_Field property)
+	 * @throws \EE_Error
+	 */
+	protected function _set_date_time($what = 'T', $datetime_value, $fieldname)
+	{
+		$field = $this->_get_dtt_field_settings($fieldname);
+		$field->set_timezone($this->_timezone);
+		$field->set_date_format($this->_dt_frmt);
+		$field->set_time_format($this->_tm_frmt);
+		switch ($what) {
+			case 'T' :
+				$this->_fields[$fieldname] = $field->prepare_for_set_with_new_time(
+					$datetime_value,
+					$this->_fields[$fieldname]
+				);
+				break;
+			case 'D' :
+				$this->_fields[$fieldname] = $field->prepare_for_set_with_new_date(
+					$datetime_value,
+					$this->_fields[$fieldname]
+				);
+				break;
+			case 'B' :
+				$this->_fields[$fieldname] = $field->prepare_for_set($datetime_value);
+				break;
+		}
+		$this->_clear_cached_property($fieldname);
+	}
+
+
+
+	/**
+	 * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
+	 * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
+	 * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
+	 * that could lead to some unexpected results!
+	 *
+	 * @access public
+	 * @param string               $field_name This is the name of the field on the object that contains the date/time
+	 *                                         value being returned.
+	 * @param string               $callback   must match a valid method in this class (defaults to get_datetime)
+	 * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
+	 * @param string               $prepend    You can include something to prepend on the timestamp
+	 * @param string               $append     You can include something to append on the timestamp
+	 * @throws EE_Error
+	 * @return string timestamp
+	 */
+	public function display_in_my_timezone(
+		$field_name,
+		$callback = 'get_datetime',
+		$args = null,
+		$prepend = '',
+		$append = ''
+	) {
+		$timezone = EEH_DTT_Helper::get_timezone();
+		if ($timezone === $this->_timezone) {
+			return '';
+		}
+		$original_timezone = $this->_timezone;
+		$this->set_timezone($timezone);
+		$fn = (array)$field_name;
+		$args = array_merge($fn, (array)$args);
+		if ( ! method_exists($this, $callback)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
+						'event_espresso'
+					),
+					$callback
+				)
+			);
+		}
+		$args = (array)$args;
+		$return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
+		$this->set_timezone($original_timezone);
+		return $return;
+	}
+
+
+
+	/**
+	 * Deletes this model object.
+	 * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
+	 * override
+	 * `EE_Base_Class::_delete` NOT this class.
+	 *
+	 * @return boolean | int
+	 * @throws \EE_Error
+	 */
+	public function delete()
+	{
+		/**
+		 * Called just before the `EE_Base_Class::_delete` method call.
+		 * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
+		 * should be aware that `_delete` may not always result in a permanent delete.  For example, `EE_Soft_Delete_Base_Class::_delete`
+		 * soft deletes (trash) the object and does not permanently delete it.
+		 *
+		 * @param EE_Base_Class $model_object about to be 'deleted'
+		 */
+		do_action('AHEE__EE_Base_Class__delete__before', $this);
+		$result = $this->_delete();
+		/**
+		 * Called just after the `EE_Base_Class::_delete` method call.
+		 * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
+		 * should be aware that `_delete` may not always result in a permanent delete.  For example `EE_Soft_Base_Class::_delete`
+		 * soft deletes (trash) the object and does not permanently delete it.
+		 *
+		 * @param EE_Base_Class $model_object that was just 'deleted'
+		 * @param boolean       $result
+		 */
+		do_action('AHEE__EE_Base_Class__delete__end', $this, $result);
+		return $result;
+	}
+
+
+
+	/**
+	 * Calls the specific delete method for the instantiated class.
+	 * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
+	 * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
+	 * `EE_Base_Class::delete`
+	 *
+	 * @return bool|int
+	 * @throws \EE_Error
+	 */
+	protected function _delete()
+	{
+		return $this->delete_permanently();
+	}
+
+
+
+	/**
+	 * Deletes this model object permanently from db (but keep in mind related models my block the delete and return an
+	 * error)
+	 *
+	 * @return bool | int
+	 * @throws \EE_Error
+	 */
+	public function delete_permanently()
+	{
+		/**
+		 * Called just before HARD deleting a model object
+		 *
+		 * @param EE_Base_Class $model_object about to be 'deleted'
+		 */
+		do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
+		$model = $this->get_model();
+		$result = $model->delete_permanently_by_ID($this->ID());
+		$this->refresh_cache_of_related_objects();
+		/**
+		 * Called just after HARD deleting a model object
+		 *
+		 * @param EE_Base_Class $model_object that was just 'deleted'
+		 * @param boolean       $result
+		 */
+		do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
+		return $result;
+	}
+
+
+
+	/**
+	 * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
+	 * related model objects
+	 *
+	 * @throws \EE_Error
+	 */
+	public function refresh_cache_of_related_objects()
+	{
+		$model = $this->get_model();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ( ! empty($this->_model_relations[$relation_name])) {
+				$related_objects = $this->_model_relations[$relation_name];
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
+					//this relation only stores a single model object, not an array
+					//but let's make it consistent
+					$related_objects = array($related_objects);
+				}
+				foreach ($related_objects as $related_object) {
+					//only refresh their cache if they're in memory
+					if ($related_object instanceof EE_Base_Class) {
+						$related_object->clear_cache($model->get_this_model_name(), $this);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *        Saves this object to the database. An array may be supplied to set some values on this
+	 * object just before saving.
+	 *
+	 * @access public
+	 * @param array $set_cols_n_values keys are field names, values are their new values,
+	 *                                 if provided during the save() method (often client code will change the fields'
+	 *                                 values before calling save)
+	 * @throws \EE_Error
+	 * @return int , 1 on a successful update, the ID of the new entry on insert; 0 on failure or if the model object
+	 *                                 isn't allowed to persist (as determined by EE_Base_Class::allow_persist())
+	 */
+	public function save($set_cols_n_values = array())
+	{
+		$model = $this->get_model();
+		/**
+		 * Filters the fields we're about to save on the model object
+		 *
+		 * @param array         $set_cols_n_values
+		 * @param EE_Base_Class $model_object
+		 */
+		$set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
+			$this);
+		//set attributes as provided in $set_cols_n_values
+		foreach ($set_cols_n_values as $column => $value) {
+			$this->set($column, $value);
+		}
+		// no changes ? then don't do anything
+		if (! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
+			return 0;
+		}
+		/**
+		 * Saving a model object.
+		 * Before we perform a save, this action is fired.
+		 *
+		 * @param EE_Base_Class $model_object the model object about to be saved.
+		 */
+		do_action('AHEE__EE_Base_Class__save__begin', $this);
+		if ( ! $this->allow_persist()) {
+			return 0;
+		}
+		//now get current attribute values
+		$save_cols_n_values = $this->_fields;
+		//if the object already has an ID, update it. Otherwise, insert it
+		//also: change the assumption about values passed to the model NOT being prepare dby the model object. They have been
+		$old_assumption_concerning_value_preparation = $model
+															->get_assumption_concerning_values_already_prepared_by_model_object();
+		$model->assume_values_already_prepared_by_model_object(true);
+		//does this model have an autoincrement PK?
+		if ($model->has_primary_key_field()) {
+			if ($model->get_primary_key_field()->is_auto_increment()) {
+				//ok check if it's set, if so: update; if not, insert
+				if ( ! empty($save_cols_n_values[$model->primary_key_name()])) {
+					$results = $model->update_by_ID($save_cols_n_values, $this->ID());
+				} else {
+					unset($save_cols_n_values[$model->primary_key_name()]);
+					$results = $model->insert($save_cols_n_values);
+					if ($results) {
+						//if successful, set the primary key
+						//but don't use the normal SET method, because it will check if
+						//an item with the same ID exists in the mapper & db, then
+						//will find it in the db (because we just added it) and THAT object
+						//will get added to the mapper before we can add this one!
+						//but if we just avoid using the SET method, all that headache can be avoided
+						$pk_field_name = $model->primary_key_name();
+						$this->_fields[$pk_field_name] = $results;
+						$this->_clear_cached_property($pk_field_name);
+						$model->add_to_entity_map($this);
+						$this->_update_cached_related_model_objs_fks();
+					}
+				}
+			} else {//PK is NOT auto-increment
+				//so check if one like it already exists in the db
+				if ($model->exists_by_ID($this->ID())) {
+					if (WP_DEBUG && ! $this->in_entity_map()) {
+						throw new EE_Error(
+							sprintf(
+								__('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
+									'event_espresso'),
+								get_class($this),
+								get_class($model) . '::instance()->add_to_entity_map()',
+								get_class($model) . '::instance()->get_one_by_ID()',
+								'<br />'
+							)
+						);
+					}
+					$results = $model->update_by_ID($save_cols_n_values, $this->ID());
+				} else {
+					$results = $model->insert($save_cols_n_values);
+					$this->_update_cached_related_model_objs_fks();
+				}
+			}
+		} else {//there is NO primary key
+			$already_in_db = false;
+			foreach ($model->unique_indexes() as $index) {
+				$uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
+				if ($model->exists(array($uniqueness_where_params))) {
+					$already_in_db = true;
+				}
+			}
+			if ($already_in_db) {
+				$combined_pk_fields_n_values = array_intersect_key($save_cols_n_values,
+					$model->get_combined_primary_key_fields());
+				$results = $model->update($save_cols_n_values, $combined_pk_fields_n_values);
+			} else {
+				$results = $model->insert($save_cols_n_values);
+			}
+		}
+		//restore the old assumption about values being prepared by the model object
+		$model
+			 ->assume_values_already_prepared_by_model_object($old_assumption_concerning_value_preparation);
+		/**
+		 * After saving the model object this action is called
+		 *
+		 * @param EE_Base_Class $model_object which was just saved
+		 * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
+		 *                                    the new ID (or 0 if an error occurred and it wasn't updated)
+		 */
+		do_action('AHEE__EE_Base_Class__save__end', $this, $results);
+		$this->_has_changes = false;
+		return $results;
+	}
+
+
+
+	/**
+	 * Updates the foreign key on related models objects pointing to this to have this model object's ID
+	 * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
+	 * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
+	 * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
+	 * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
+	 * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
+	 * or not they exist in the DB (if they do, their DB records will be automatically updated)
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _update_cached_related_model_objs_fks()
+	{
+		$model = $this->get_model();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Has_Many_Relation) {
+				foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
+					$fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
+						$model->get_this_model_name()
+					);
+					$related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
+					if ($related_model_obj_in_cache->ID()) {
+						$related_model_obj_in_cache->save();
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Saves this model object and its NEW cached relations to the database.
+	 * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
+	 * In order for that to work, we would need to mark model objects as dirty/clean...
+	 * because otherwise, there's a potential for infinite looping of saving
+	 * Saves the cached related model objects, and ensures the relation between them
+	 * and this object and properly setup
+	 *
+	 * @return int ID of new model object on save; 0 on failure+
+	 * @throws \EE_Error
+	 */
+	public function save_new_cached_related_model_objs()
+	{
+		//make sure this has been saved
+		if ( ! $this->ID()) {
+			$id = $this->save();
+		} else {
+			$id = $this->ID();
+		}
+		//now save all the NEW cached model objects  (ie they don't exist in the DB)
+		foreach ($this->get_model()->relation_settings() as $relationName => $relationObj) {
+			if ($this->_model_relations[$relationName]) {
+				//is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
+				//or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
+				if ($relationObj instanceof EE_Belongs_To_Relation) {
+					//add a relation to that relation type (which saves the appropriate thing in the process)
+					//but ONLY if it DOES NOT exist in the DB
+					/* @var $related_model_obj EE_Base_Class */
+					$related_model_obj = $this->_model_relations[$relationName];
+					//					if( ! $related_model_obj->ID()){
+					$this->_add_relation_to($related_model_obj, $relationName);
+					$related_model_obj->save_new_cached_related_model_objs();
+					//					}
+				} else {
+					foreach ($this->_model_relations[$relationName] as $related_model_obj) {
+						//add a relation to that relation type (which saves the appropriate thing in the process)
+						//but ONLY if it DOES NOT exist in the DB
+						//						if( ! $related_model_obj->ID()){
+						$this->_add_relation_to($related_model_obj, $relationName);
+						$related_model_obj->save_new_cached_related_model_objs();
+						//						}
+					}
+				}
+			}
+		}
+		return $id;
+	}
+
+
+
+	/**
+	 * for getting a model while instantiated.
+	 *
+	 * @return \EEM_Base | \EEM_CPT_Base
+	 */
+	public function get_model()
+	{
+		if( ! $this->_model){
+			$modelName = self::_get_model_classname(get_class($this));
+			$this->_model = self::_get_model_instance_with_name($modelName, $this->_timezone);
+		} else {
+			$this->_model->set_timezone($this->_timezone);
+		}
+
+		return $this->_model;
+	}
+
+
+
+	/**
+	 * @param $props_n_values
+	 * @param $classname
+	 * @return mixed bool|EE_Base_Class|EEM_CPT_Base
+	 * @throws \EE_Error
+	 */
+	protected static function _get_object_from_entity_mapper($props_n_values, $classname)
+	{
+		//TODO: will not work for Term_Relationships because they have no PK!
+		$primary_id_ref = self::_get_primary_key_name($classname);
+		if (array_key_exists($primary_id_ref, $props_n_values) && ! empty($props_n_values[$primary_id_ref])) {
+			$id = $props_n_values[$primary_id_ref];
+			return self::_get_model($classname)->get_from_entity_map($id);
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
+	 * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
+	 * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
+	 * we return false.
+	 *
+	 * @param  array  $props_n_values   incoming array of properties and their values
+	 * @param  string $classname        the classname of the child class
+	 * @param null    $timezone
+	 * @param array   $date_formats     incoming date_formats in an array where the first value is the
+	 *                                  date_format and the second value is the time format
+	 * @return mixed (EE_Base_Class|bool)
+	 * @throws \EE_Error
+	 */
+	protected static function _check_for_object($props_n_values, $classname, $timezone = null, $date_formats = array())
+	{
+		$existing = null;
+		$model = self::_get_model($classname, $timezone);
+		if ($model->has_primary_key_field()) {
+			$primary_id_ref = self::_get_primary_key_name($classname);
+			if (array_key_exists($primary_id_ref, $props_n_values)
+				&& ! empty($props_n_values[$primary_id_ref])
+			) {
+				$existing = $model->get_one_by_ID(
+					$props_n_values[$primary_id_ref]
+				);
+			}
+		} elseif ($model->has_all_combined_primary_key_fields($props_n_values)) {
+			//no primary key on this model, but there's still a matching item in the DB
+			$existing = self::_get_model($classname, $timezone)->get_one_by_ID(
+				self::_get_model($classname, $timezone)->get_index_primary_key_string($props_n_values)
+			);
+		}
+		if ($existing) {
+			//set date formats if present before setting values
+			if ( ! empty($date_formats) && is_array($date_formats)) {
+				$existing->set_date_format($date_formats[0]);
+				$existing->set_time_format($date_formats[1]);
+			} else {
+				//set default formats for date and time
+				$existing->set_date_format(get_option('date_format'));
+				$existing->set_time_format(get_option('time_format'));
+			}
+			foreach ($props_n_values as $property => $field_value) {
+				$existing->set($property, $field_value);
+			}
+			return $existing;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Gets the EEM_*_Model for this class
+	 *
+	 * @access public now, as this is more convenient
+	 * @param      $classname
+	 * @param null $timezone
+	 * @throws EE_Error
+	 * @return EEM_Base
+	 */
+	protected static function _get_model($classname, $timezone = null)
+	{
+		//find model for this class
+		if ( ! $classname) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"What were you thinking calling _get_model(%s)?? You need to specify the class name",
+						"event_espresso"
+					),
+					$classname
+				)
+			);
+		}
+		$modelName = self::_get_model_classname($classname);
+		return self::_get_model_instance_with_name($modelName, $timezone);
+	}
+
+
+
+	/**
+	 * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
+	 *
+	 * @param string $model_classname
+	 * @param null   $timezone
+	 * @return EEM_Base
+	 */
+	protected static function _get_model_instance_with_name($model_classname, $timezone = null)
+	{
+		$model_classname = str_replace('EEM_', '', $model_classname);
+		$model = EE_Registry::instance()->load_model($model_classname);
+		$model->set_timezone($timezone);
+		return $model;
+	}
+
+
+
+	/**
+	 * If a model name is provided (eg Registration), gets the model classname for that model.
+	 * Also works if a model class's classname is provided (eg EE_Registration).
+	 *
+	 * @param null $model_name
+	 * @return string like EEM_Attendee
+	 */
+	private static function _get_model_classname($model_name = null)
+	{
+		if (strpos($model_name, "EE_") === 0) {
+			$model_classname = str_replace("EE_", "EEM_", $model_name);
+		} else {
+			$model_classname = "EEM_" . $model_name;
+		}
+		return $model_classname;
+	}
+
+
+
+	/**
+	 * returns the name of the primary key attribute
+	 *
+	 * @param null $classname
+	 * @throws EE_Error
+	 * @return string
+	 */
+	protected static function _get_primary_key_name($classname = null)
+	{
+		if ( ! $classname) {
+			throw new EE_Error(
+				sprintf(
+					__("What were you thinking calling _get_primary_key_name(%s)", "event_espresso"),
+					$classname
+				)
+			);
+		}
+		return self::_get_model($classname)->get_primary_key_field()->get_name();
+	}
+
+
+
+	/**
+	 * Gets the value of the primary key.
+	 * If the object hasn't yet been saved, it should be whatever the model field's default was
+	 * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
+	 * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
+	 *
+	 * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
+	 * @throws \EE_Error
+	 */
+	public function ID()
+	{
+		$model = $this->get_model();
+		//now that we know the name of the variable, use a variable variable to get its value and return its
+		if ($model->has_primary_key_field()) {
+			return $this->_fields[$model->primary_key_name()];
+		} else {
+			return $model->get_index_primary_key_string($this->_fields);
+		}
+	}
+
+
+
+	/**
+	 * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
+	 * model is related to a group of events, the $relationName should be 'Event', and should be a key in the EE
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
+	 *
+	 * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
+	 * @param string $relationName                     eg 'Events','Question',etc.
+	 *                                                 an attendee to a group, you also want to specify which role they
+	 *                                                 will have in that group. So you would use this parameter to
+	 *                                                 specify array('role-column-name'=>'role-id')
+	 * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
+	 *                                                 allow you to further constrict the relation to being added.
+	 *                                                 However, keep in mind that the columns (keys) given must match a
+	 *                                                 column on the JOIN table and currently only the HABTM models
+	 *                                                 accept these additional conditions.  Also remember that if an
+	 *                                                 exact match isn't found for these extra cols/val pairs, then a
+	 *                                                 NEW row is created in the join table.
+	 * @param null   $cache_id
+	 * @throws EE_Error
+	 * @return EE_Base_Class the object the relation was added to
+	 */
+	public function _add_relation_to(
+		$otherObjectModelObjectOrID,
+		$relationName,
+		$extra_join_model_fields_n_values = array(),
+		$cache_id = null
+	) {
+		$model = $this->get_model();
+		//if this thing exists in the DB, save the relation to the DB
+		if ($this->ID()) {
+			$otherObject = $model
+								->add_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
+									$extra_join_model_fields_n_values);
+			//clear cache so future get_many_related and get_first_related() return new results.
+			$this->clear_cache($relationName, $otherObject, true);
+			if ($otherObject instanceof EE_Base_Class) {
+				$otherObject->clear_cache($model->get_this_model_name(), $this);
+			}
+		} else {
+			//this thing doesn't exist in the DB,  so just cache it
+			if ( ! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
+				throw new EE_Error(sprintf(
+					__('Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
+						'event_espresso'),
+					$otherObjectModelObjectOrID,
+					get_class($this)
+				));
+			} else {
+				$otherObject = $otherObjectModelObjectOrID;
+			}
+			$this->cache($relationName, $otherObjectModelObjectOrID, $cache_id);
+		}
+		if ($otherObject instanceof EE_Base_Class) {
+			//fix the reciprocal relation too
+			if ($otherObject->ID()) {
+				//its saved so assumed relations exist in the DB, so we can just
+				//clear the cache so future queries use the updated info in the DB
+				$otherObject->clear_cache($model->get_this_model_name(), null, true);
+			} else {
+				//it's not saved, so it caches relations like this
+				$otherObject->cache($model->get_this_model_name(), $this);
+			}
+		}
+		return $otherObject;
+	}
+
+
+
+	/**
+	 * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
+	 * model is related to a group of events, the $relationName should be 'Events', and should be a key in the EE
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
+	 * from the cache
+	 *
+	 * @param mixed  $otherObjectModelObjectOrID
+	 *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
+	 *                to the DB yet
+	 * @param string $relationName
+	 * @param array  $where_query
+	 *                You can optionally include an array of key=>value pairs that allow you to further constrict the
+	 *                relation to being added. However, keep in mind that the columns (keys) given must match a column
+	 *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
+	 *                remember that if an exact match isn't found for these extra cols/val pairs, then a NEW row is
+	 *                created in the join table.
+	 * @return EE_Base_Class the relation was removed from
+	 * @throws \EE_Error
+	 */
+	public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = array())
+	{
+		if ($this->ID()) {
+			//if this exists in the DB, save the relation change to the DB too
+			$otherObject = $this->get_model()
+								->remove_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
+									$where_query);
+			$this->clear_cache($relationName, $otherObject);
+		} else {
+			//this doesn't exist in the DB, just remove it from the cache
+			$otherObject = $this->clear_cache($relationName, $otherObjectModelObjectOrID);
+		}
+		if ($otherObject instanceof EE_Base_Class) {
+			$otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
+		}
+		return $otherObject;
+	}
+
+
+
+	/**
+	 * Removes ALL the related things for the $relationName.
+	 *
+	 * @param string $relationName
+	 * @param array  $where_query_params like EEM_Base::get_all's $query_params[0] (where conditions)
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function _remove_relations($relationName, $where_query_params = array())
+	{
+		if ($this->ID()) {
+			//if this exists in the DB, save the relation change to the DB too
+			$otherObjects = $this->get_model()->remove_relations($this, $relationName, $where_query_params);
+			$this->clear_cache($relationName, null, true);
+		} else {
+			//this doesn't exist in the DB, just remove it from the cache
+			$otherObjects = $this->clear_cache($relationName, null, true);
+		}
+		if (is_array($otherObjects)) {
+			foreach ($otherObjects as $otherObject) {
+				$otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
+			}
+		}
+		return $otherObjects;
+	}
+
+
+
+	/**
+	 * Gets all the related model objects of the specified type. Eg, if the current class if
+	 * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
+	 * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
+	 * because we want to get even deleted items etc.
+	 *
+	 * @param string $relationName key in the model's _model_relations array
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @return EE_Base_Class[] Results not necessarily indexed by IDs, because some results might not have primary keys
+	 * @throws \EE_Error
+	 *                             or might not be saved yet. Consider using EEM_Base::get_IDs() on these results if
+	 *                             you want IDs
+	 */
+	public function get_many_related($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			//this exists in the DB, so get the related things from either the cache or the DB
+			//if there are query parameters, forget about caching the related model objects.
+			if ($query_params) {
+				$related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
+			} else {
+				//did we already cache the result of this query?
+				$cached_results = $this->get_all_from_cache($relationName);
+				if ( ! $cached_results) {
+					$related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
+					//if no query parameters were passed, then we got all the related model objects
+					//for that relation. We can cache them then.
+					foreach ($related_model_objects as $related_model_object) {
+						$this->cache($relationName, $related_model_object);
+					}
+				} else {
+					$related_model_objects = $cached_results;
+				}
+			}
+		} else {
+			//this doesn't exist in the DB, so just get the related things from the cache
+			$related_model_objects = $this->get_all_from_cache($relationName);
+		}
+		return $related_model_objects;
+	}
+
+
+
+	/**
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
+	 * unless otherwise specified in the $query_params
+	 *
+	 * @param string $relation_name  model_name like 'Event', or 'Registration'
+	 * @param array  $query_params   like EEM_Base::get_all's
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
+	 *                               that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_related($relation_name, $query_params = array(), $field_to_count = null, $distinct = false)
+	{
+		return $this->get_model()->count_related($this, $relation_name, $query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
+	 *
+	 * @param string $relation_name model_name like 'Event', or 'Registration'
+	 * @param array  $query_params  like EEM_Base::get_all's
+	 * @param string $field_to_sum  name of field to count by.
+	 *                              By default, uses primary key (which doesn't make much sense, so you should probably
+	 *                              change it)
+	 * @return int
+	 */
+	public function sum_related($relation_name, $query_params = array(), $field_to_sum = null)
+	{
+		return $this->get_model()->sum_related($this, $relation_name, $query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Gets the first (ie, one) related model object of the specified type.
+	 *
+	 * @param string $relationName key in the model's _model_relations array
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @return EE_Base_Class (not an array, a single object)
+	 * @throws \EE_Error
+	 */
+	public function get_first_related($relationName, $query_params = array())
+	{
+		$model = $this->get_model();
+		if ($this->ID()) {//this exists in the DB, get from the cache OR the DB
+			//if they've provided some query parameters, don't bother trying to cache the result
+			//also make sure we're not caching the result of get_first_related
+			//on a relation which should have an array of objects (because the cache might have an array of objects)
+			if ($query_params
+				|| ! $model->related_settings_for($relationName)
+					 instanceof
+					 EE_Belongs_To_Relation
+			) {
+				$related_model_object = $model->get_first_related($this, $relationName, $query_params);
+			} else {
+				//first, check if we've already cached the result of this query
+				$cached_result = $this->get_one_from_cache($relationName);
+				if ( ! $cached_result) {
+					$related_model_object = $model->get_first_related($this, $relationName, $query_params);
+					$this->cache($relationName, $related_model_object);
+				} else {
+					$related_model_object = $cached_result;
+				}
+			}
+		} else {
+			$related_model_object = null;
+			//this doesn't exist in the Db, but maybe the relation is of type belongs to, and so the related thing might
+			if ($model->related_settings_for($relationName) instanceof EE_Belongs_To_Relation) {
+				$related_model_object = $model->get_first_related($this, $relationName, $query_params);
+			}
+			//this doesn't exist in the DB and apparently the thing it belongs to doesn't either, just get what's cached on this object
+			if ( ! $related_model_object) {
+				$related_model_object = $this->get_one_from_cache($relationName);
+			}
+		}
+		return $related_model_object;
+	}
+
+
+
+	/**
+	 * Does a delete on all related objects of type $relationName and removes
+	 * the current model object's relation to them. If they can't be deleted (because
+	 * of blocking related model objects) does nothing. If the related model objects are
+	 * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
+	 * If this model object doesn't exist yet in the DB, just removes its related things
+	 *
+	 * @param string $relationName
+	 * @param array  $query_params like EEM_Base::get_all's
+	 * @return int how many deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_related($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			$count = $this->get_model()->delete_related($this, $relationName, $query_params);
+		} else {
+			$count = count($this->get_all_from_cache($relationName));
+			$this->clear_cache($relationName, null, true);
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * Does a hard delete (ie, removes the DB row) on all related objects of type $relationName and removes
+	 * the current model object's relation to them. If they can't be deleted (because
+	 * of blocking related model objects) just does a soft delete on it instead, if possible.
+	 * If the related thing isn't a soft-deletable model object, this function is identical
+	 * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
+	 *
+	 * @param string $relationName
+	 * @param array  $query_params like EEM_Base::get_all's
+	 * @return int how many deleted (including those soft deleted)
+	 * @throws \EE_Error
+	 */
+	public function delete_related_permanently($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			$count = $this->get_model()->delete_related_permanently($this, $relationName, $query_params);
+		} else {
+			$count = count($this->get_all_from_cache($relationName));
+		}
+		$this->clear_cache($relationName, null, true);
+		return $count;
+	}
+
+
+
+	/**
+	 * is_set
+	 * Just a simple utility function children can use for checking if property exists
+	 *
+	 * @access  public
+	 * @param  string $field_name property to check
+	 * @return bool                              TRUE if existing,FALSE if not.
+	 */
+	public function is_set($field_name)
+	{
+		return isset($this->_fields[$field_name]);
+	}
+
+
+
+	/**
+	 * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
+	 * EE_Error exception if they don't
+	 *
+	 * @param  mixed (string|array) $properties properties to check
+	 * @throws EE_Error
+	 * @return bool                              TRUE if existing, throw EE_Error if not.
+	 */
+	protected function _property_exists($properties)
+	{
+		foreach ((array)$properties as $property_name) {
+			//first make sure this property exists
+			if ( ! $this->_fields[$property_name]) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
+							'event_espresso'
+						),
+						$property_name
+					)
+				);
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * This simply returns an array of model fields for this object
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function model_field_array()
+	{
+		$fields = $this->get_model()->field_settings(false);
+		$properties = array();
+		//remove prepended underscore
+		foreach ($fields as $field_name => $settings) {
+			$properties[$field_name] = $this->get($field_name);
+		}
+		return $properties;
+	}
+
+
+
+	/**
+	 * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
+	 * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
+	 * requiring a plugin to extend the EE_Base_Class (which works fine is there's only 1 plugin, but when will that
+	 * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
+	 * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
+	 * was called, and an array of the original arguments passed to the function. Whatever their callback function
+	 * returns will be returned by this function. Example: in functions.php (or in a plugin):
+	 * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
+	 * my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
+	 *        return $previousReturnValue.$returnString;
+	 * }
+	 * require('EE_Answer.class.php');
+	 * $answer= EE_Answer::new_instance(array('REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'));
+	 * echo $answer->my_callback('monkeys',100);
+	 * //will output "you called my_callback! and passed args:monkeys,100"
+	 *
+	 * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
+	 * @param array  $args       array of original arguments passed to the function
+	 * @throws EE_Error
+	 * @return mixed whatever the plugin which calls add_filter decides
+	 */
+	public function __call($methodName, $args)
+	{
+		$className = get_class($this);
+		$tagName = "FHEE__{$className}__{$methodName}";
+		if ( ! has_filter($tagName)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
+						"event_espresso"
+					),
+					$methodName,
+					$className,
+					$tagName
+				)
+			);
+		}
+		return apply_filters($tagName, null, $this, $args);
+	}
+
+
+
+	/**
+	 * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
+	 * A $previous_value can be specified in case there are many meta rows with the same key
+	 *
+	 * @param string $meta_key
+	 * @param mixed  $meta_value
+	 * @param mixed  $previous_value
+	 * @return bool|int # of records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
+	 * @throws \EE_Error
+	 * NOTE: if the values haven't changed, returns 0
+	 */
+	public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
+	{
+		$query_params = array(
+			array(
+				'EXM_key'  => $meta_key,
+				'OBJ_ID'   => $this->ID(),
+				'EXM_type' => $this->get_model()->get_this_model_name(),
+			),
+		);
+		if ($previous_value !== null) {
+			$query_params[0]['EXM_value'] = $meta_value;
+		}
+		$existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
+		if ( ! $existing_rows_like_that) {
+			return $this->add_extra_meta($meta_key, $meta_value);
+		}
+		foreach ($existing_rows_like_that as $existing_row) {
+			$existing_row->save(array('EXM_value' => $meta_value));
+		}
+		return count($existing_rows_like_that);
+	}
+
+
+
+	/**
+	 * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
+	 * no other extra meta for this model object have the same key. Returns TRUE if the
+	 * extra meta row was entered, false if not
+	 *
+	 * @param string  $meta_key
+	 * @param mixed   $meta_value
+	 * @param boolean $unique
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function add_extra_meta($meta_key, $meta_value, $unique = false)
+	{
+		if ($unique) {
+			$existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
+				array(
+					array(
+						'EXM_key'  => $meta_key,
+						'OBJ_ID'   => $this->ID(),
+						'EXM_type' => $this->get_model()->get_this_model_name(),
+					),
+				)
+			);
+			if ($existing_extra_meta) {
+				return false;
+			}
+		}
+		$new_extra_meta = EE_Extra_Meta::new_instance(
+			array(
+				'EXM_key'   => $meta_key,
+				'EXM_value' => $meta_value,
+				'OBJ_ID'    => $this->ID(),
+				'EXM_type'  => $this->get_model()->get_this_model_name(),
+			)
+		);
+		$new_extra_meta->save();
+		return true;
+	}
+
+
+
+	/**
+	 * Deletes all the extra meta rows for this record as specified by key. If $meta_value
+	 * is specified, only deletes extra meta records with that value.
+	 *
+	 * @param string $meta_key
+	 * @param mixed  $meta_value
+	 * @return int number of extra meta rows deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_extra_meta($meta_key, $meta_value = null)
+	{
+		$query_params = array(
+			array(
+				'EXM_key'  => $meta_key,
+				'OBJ_ID'   => $this->ID(),
+				'EXM_type' => $this->get_model()->get_this_model_name(),
+			),
+		);
+		if ($meta_value !== null) {
+			$query_params[0]['EXM_value'] = $meta_value;
+		}
+		return EEM_Extra_Meta::instance()->delete($query_params);
+	}
+
+
+
+	/**
+	 * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
+	 * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
+	 * You can specify $default is case you haven't found the extra meta
+	 *
+	 * @param string  $meta_key
+	 * @param boolean $single
+	 * @param mixed   $default if we don't find anything, what should we return?
+	 * @return mixed single value if $single; array if ! $single
+	 * @throws \EE_Error
+	 */
+	public function get_extra_meta($meta_key, $single = false, $default = null)
+	{
+		if ($single) {
+			$result = $this->get_first_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
+			if ($result instanceof EE_Extra_Meta) {
+				return $result->value();
+			} else {
+				return $default;
+			}
+		} else {
+			$results = $this->get_many_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
+			if ($results) {
+				$values = array();
+				foreach ($results as $result) {
+					if ($result instanceof EE_Extra_Meta) {
+						$values[$result->ID()] = $result->value();
+					}
+				}
+				return $values;
+			} else {
+				return $default;
+			}
+		}
+	}
+
+
+
+	/**
+	 * Returns a simple array of all the extra meta associated with this model object.
+	 * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
+	 * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
+	 * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
+	 * If $one_of_each_key is false, it will return an array with the top-level keys being
+	 * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
+	 * finally the extra meta's value as each sub-value. (eg
+	 * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
+	 *
+	 * @param boolean $one_of_each_key
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function all_extra_meta_array($one_of_each_key = true)
+	{
+		$return_array = array();
+		if ($one_of_each_key) {
+			$extra_meta_objs = $this->get_many_related('Extra_Meta', array('group_by' => 'EXM_key'));
+			foreach ($extra_meta_objs as $extra_meta_obj) {
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
+					$return_array[$extra_meta_obj->key()] = $extra_meta_obj->value();
+				}
+			}
+		} else {
+			$extra_meta_objs = $this->get_many_related('Extra_Meta');
+			foreach ($extra_meta_objs as $extra_meta_obj) {
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
+					if ( ! isset($return_array[$extra_meta_obj->key()])) {
+						$return_array[$extra_meta_obj->key()] = array();
+					}
+					$return_array[$extra_meta_obj->key()][$extra_meta_obj->ID()] = $extra_meta_obj->value();
+				}
+			}
+		}
+		return $return_array;
+	}
+
+
+
+	/**
+	 * Gets a pretty nice displayable nice for this model object. Often overridden
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function name()
+	{
+		//find a field that's not a text field
+		$field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
+		if ($field_we_can_use) {
+			return $this->get($field_we_can_use->get_name());
+		} else {
+			$first_few_properties = $this->model_field_array();
+			$first_few_properties = array_slice($first_few_properties, 0, 3);
+			$name_parts = array();
+			foreach ($first_few_properties as $name => $value) {
+				$name_parts[] = "$name:$value";
+			}
+			return implode(",", $name_parts);
+		}
+	}
+
+
+
+	/**
+	 * in_entity_map
+	 * Checks if this model object has been proven to already be in the entity map
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function in_entity_map()
+	{
+		if ($this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this) {
+			//well, if we looked, did we find it in the entity map?
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * refresh_from_db
+	 * Makes sure the fields and values on this model object are in-sync with what's in the database.
+	 *
+	 * @throws EE_Error if this model object isn't in the entity mapper (because then you should
+	 * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
+	 */
+	public function refresh_from_db()
+	{
+		if ($this->ID() && $this->in_entity_map()) {
+			$this->get_model()->refresh_entity_map_from_db($this->ID());
+		} else {
+			//if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
+			//if it has an ID but it's not in the map, and you're asking me to refresh it
+			//that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
+			//absolutely nothing in it for this ID
+			if (WP_DEBUG) {
+				throw new EE_Error(
+					sprintf(
+						__('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
+							'event_espresso'),
+						$this->ID(),
+						get_class($this->get_model()) . '::instance()->add_to_entity_map()',
+						get_class($this->get_model()) . '::instance()->refresh_entity_map()'
+					)
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
+	 * (probably a bad assumption they have made, oh well)
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		try {
+			return sprintf('%s (%s)', $this->name(), $this->ID());
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			return '';
+		}
+	}
+
+
+
+	/**
+	 * Clear related model objects if they're already in the DB, because otherwise when we
+	 * UN-serialize this model object we'll need to be careful to add them to the entity map.
+	 * This means if we have made changes to those related model objects, and want to unserialize
+	 * the this model object on a subsequent request, changes to those related model objects will be lost.
+	 * Instead, those related model objects should be directly serialized and stored.
+	 * Eg, the following won't work:
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
+	 * $att = $reg->attendee();
+	 * $att->set( 'ATT_fname', 'Dirk' );
+	 * update_option( 'my_option', serialize( $reg ) );
+	 * //END REQUEST
+	 * //START NEXT REQUEST
+	 * $reg = get_option( 'my_option' );
+	 * $reg->attendee()->save();
+	 * And would need to be replace with:
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
+	 * $att = $reg->attendee();
+	 * $att->set( 'ATT_fname', 'Dirk' );
+	 * update_option( 'my_option', serialize( $reg ) );
+	 * //END REQUEST
+	 * //START NEXT REQUEST
+	 * $att = get_option( 'my_option' );
+	 * $att->save();
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function __sleep()
+	{
+		$model = $this->get_model();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$classname = 'EE_' . $model->get_this_model_name();
+				if (
+					$this->get_one_from_cache($relation_name) instanceof $classname
+					&& $this->get_one_from_cache($relation_name)->ID()
+				) {
+					$this->clear_cache($relation_name, $this->get_one_from_cache($relation_name)->ID());
+				}
+			}
+		}
+		$this->_props_n_values_provided_in_constructor = array();
+		$properties_to_serialize = get_object_vars($this);
+		//don't serialize the model. It's big and that risks recursion
+		unset($properties_to_serialize['_model']);
+		return array_keys($properties_to_serialize);
+	}
+
+
+
+	/**
+	 * restore _props_n_values_provided_in_constructor
+	 * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
+	 * and therefore should NOT be used to determine if state change has occurred since initial construction.
+	 * At best, you would only be able to detect if state change has occurred during THIS request.
+	 */
+	public function __wakeup()
+	{
+		$this->_props_n_values_provided_in_constructor = $this->_fields;
+	}
 
 
 

core/db_models/EEM_Attendee.model.php

Indentation +399 added lines, -399 removed lines

@@ -17,413 +17,413 @@
 class EEM_Attendee extends EEM_CPT_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
-    /**
-     * QST_system for questions are strings not integers now,
-     * so these constants are deprecated.
-     * Please instead use the EEM_Attendee::system_question_* constants
-     *
-     * @deprecated
-     */
-    const fname_question_id = 1;
+	/**
+	 * QST_system for questions are strings not integers now,
+	 * so these constants are deprecated.
+	 * Please instead use the EEM_Attendee::system_question_* constants
+	 *
+	 * @deprecated
+	 */
+	const fname_question_id = 1;
 
-    /**
-     * @deprecated
-     */
-    const lname_question_id = 2;
+	/**
+	 * @deprecated
+	 */
+	const lname_question_id = 2;
 
 
-    /**
-     * @deprecated
-     */
-    const email_question_id = 3;
+	/**
+	 * @deprecated
+	 */
+	const email_question_id = 3;
 
 
-    /**
-     * @deprecated
-     */
-    const address_question_id = 4;
+	/**
+	 * @deprecated
+	 */
+	const address_question_id = 4;
 
 
-    /**
-     * @deprecated
-     */
-    const address2_question_id = 5;
-
-
-    /**
-     * @deprecated
-     */
-    const city_question_id = 6;
-
-
-    /**
-     * @deprecated
-     */
-    const state_question_id = 7;
-
-
-    /**
-     * @deprecated
-     */
-    const country_question_id = 8;
-
-
-    /**
-     * @deprecated
-     */
-    const zip_question_id = 9;
-
-
-    /**
-     * @deprecated
-     */
-    const phone_question_id = 10;
-
-    /**
-     * When looking for questions that correspond to attendee fields,
-     * look for the question with this QST_system value.
-     * These replace the old constants like EEM_Attendee::*_question_id
-     */
-    const system_question_fname = 'fname';
-
-    const system_question_lname = 'lname';
-
-    const system_question_email = 'email';
-
-    const system_question_address = 'address';
-
-    const system_question_address2 = 'address2';
-
-    const system_question_city = 'city';
-
-    const system_question_state = 'state';
-
-    const system_question_country = 'country';
-
-    const system_question_zip = 'zip';
-
-    const system_question_phone = 'phone';
-
-    /**
-     * Keys are all the EEM_Attendee::system_question_* constants, which are
-     * also all the values of QST_system in the questions table, and values
-     * are their corresponding Attendee field names
-     *
-     * @var array
-     */
-    protected $_system_question_to_attendee_field_name = array(
-        EEM_Attendee::system_question_fname    => 'ATT_fname',
-        EEM_Attendee::system_question_lname    => 'ATT_lname',
-        EEM_Attendee::system_question_email    => 'ATT_email',
-        EEM_Attendee::system_question_address  => 'ATT_address',
-        EEM_Attendee::system_question_address2 => 'ATT_address2',
-        EEM_Attendee::system_question_city     => 'ATT_city',
-        EEM_Attendee::system_question_state    => 'STA_ID',
-        EEM_Attendee::system_question_country  => 'CNT_ISO',
-        EEM_Attendee::system_question_zip      => 'ATT_zip',
-        EEM_Attendee::system_question_phone    => 'ATT_phone',
-    );
-
-
-
-    /**
-     * EEM_Attendee constructor.
-     *
-     * @param null              $timezone
-     * @param ModelFieldFactory $model_field_factory
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
-    {
-        $this->singular_item = esc_html__('Attendee', 'event_espresso');
-        $this->plural_item = esc_html__('Attendees', 'event_espresso');
-        $this->_tables = array(
-            'Attendee_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Attendee_Meta' => new EE_Secondary_Table(
-                'esp_attendee_meta',
-                'ATTM_ID',
-                'ATT_ID'
-            ),
-        );
-        $this->_fields = array(
-            'Attendee_CPT'  => array(
-                'ATT_ID'        => $model_field_factory->createPrimaryKeyIntField(
-                    'ID',
-                    esc_html__('Attendee ID', 'event_espresso')
-                ),
-                'ATT_full_name' => $model_field_factory->createPlainTextField(
-                    'post_title',
-                    esc_html__('Attendee Full Name', 'event_espresso'),
-                    false,
-                    esc_html__('Unknown', 'event_espresso')
-                ),
-                'ATT_bio'       => $model_field_factory->createPostContentField(
-                    'post_content',
-                    esc_html__('Attendee Biography', 'event_espresso'),
-                    false,
-                    esc_html__('No Biography Provided', 'event_espresso')
-                ),
-                'ATT_slug'      => $model_field_factory->createSlugField(
-                    'post_name',
-                    esc_html__('Attendee URL Slug', 'event_espresso')
-                ),
-                'ATT_created'   => $model_field_factory->createDatetimeField(
-                    'post_date',
-                    esc_html__('Time Attendee Created', 'event_espresso')
-                ),
-                'ATT_short_bio' => $model_field_factory->createSimpleHtmlField(
-                    'post_excerpt',
-                    esc_html__('Attendee Short Biography', 'event_espresso'),
-                    true,
-                    esc_html__('No Biography Provided', 'event_espresso')
-                ),
-                'ATT_modified'  => $model_field_factory->createDatetimeField(
-                    'post_modified',
-                    esc_html__('Time Attendee Last Modified', 'event_espresso')
-                ),
-                'ATT_author'    => $model_field_factory->createWpUserField(
-                    'post_author',
-                    esc_html__('Creator ID of the first Event attended', 'event_espresso'),
-                    false
-                ),
-                'ATT_parent'    => $model_field_factory->createDbOnlyIntField(
-                    'post_parent',
-                    esc_html__('Parent Attendee (unused)', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'post_type'     => $model_field_factory->createWpPostTypeField('espresso_attendees'),
-                'status'        => $model_field_factory->createWpPostStatusField(
-                    'post_status',
-                    esc_html__('Attendee Status', 'event_espresso'),
-                    false,
-                    'publish'
-                ),
-            ),
-            'Attendee_Meta' => array(
-                'ATTM_ID'      => $model_field_factory->createDbOnlyIntField(
-                    'ATTM_ID',
-                    esc_html__('Attendee Meta Row ID', 'event_espresso'),
-                    false
-                ),
-                'ATT_ID_fk'    => $model_field_factory->createDbOnlyIntField(
-                    'ATT_ID',
-                    esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'),
-                    false
-                ),
-                'ATT_fname'    => $model_field_factory->createPlainTextField(
-                    'ATT_fname',
-                    esc_html__('First Name', 'event_espresso')
-                ),
-                'ATT_lname'    => $model_field_factory->createPlainTextField(
-                    'ATT_lname',
-                    esc_html__('Last Name', 'event_espresso')
-                ),
-                'ATT_address'  => $model_field_factory->createPlainTextField(
-                    'ATT_address',
-                    esc_html__('Address Part 1', 'event_espresso')
-                ),
-                'ATT_address2' => $model_field_factory->createPlainTextField(
-                    'ATT_address2',
-                    esc_html__('Address Part 2', 'event_espresso')
-                ),
-                'ATT_city'     => $model_field_factory->createPlainTextField(
-                    'ATT_city',
-                    esc_html__('City', 'event_espresso')
-                ),
-                'STA_ID'       => $model_field_factory->createForeignKeyIntField(
-                    'STA_ID',
-                    esc_html__('State', 'event_espresso'),
-                    true,
-                    0,
-                    'State'
-                ),
-                'CNT_ISO'      => $model_field_factory->createForeignKeyStringField(
-                    'CNT_ISO',
-                    esc_html__('Country', 'event_espresso'),
-                    true,
-                    '',
-                    'Country'
-                ),
-                'ATT_zip'      => $model_field_factory->createPlainTextField(
-                    'ATT_zip',
-                    esc_html__('ZIP/Postal Code', 'event_espresso')
-                ),
-                'ATT_email'    => $model_field_factory->createEmailField(
-                    'ATT_email',
-                    esc_html__('Email Address', 'event_espresso')
-                ),
-                'ATT_phone'    => $model_field_factory->createPlainTextField(
-                    'ATT_phone',
-                    esc_html__('Phone', 'event_espresso')
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration'      => new EE_Has_Many_Relation(),
-            'State'             => new EE_Belongs_To_Relation(),
-            'Country'           => new EE_Belongs_To_Relation(),
-            'Event'             => new EE_HABTM_Relation('Registration', false),
-            'WP_User'           => new EE_Belongs_To_Relation(),
-            'Message'           => new EE_Has_Many_Any_Relation(false),
-            //allow deletion of attendees even if they have messages in the queue for them.
-            'Term_Relationship' => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
-        );
-        $this->_caps_slug = 'contacts';
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Gets the name of the field on the attendee model corresponding to the system question string
-     * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name
-     *
-     * @param string $system_question_string
-     * @return string|null if not found
-     */
-    public function get_attendee_field_for_system_question($system_question_string)
-    {
-        return isset($this->_system_question_to_attendee_field_name[$system_question_string])
-            ? $this->_system_question_to_attendee_field_name[$system_question_string]
-            : null;
-    }
-
-
-
-    /**
-     * Gets mapping from esp_question.QST_system values to their corresponding attendee field names
-     *
-     * @return array
-     */
-    public function system_question_to_attendee_field_mapping()
-    {
-        return $this->_system_question_to_attendee_field_name;
-    }
-
-
-
-    /**
-     * Gets all the attendees for a transaction (by using the esp_registration as a join table)
-     *
-     * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID
-     * @return EE_Attendee[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_attendees_for_transaction($transaction_id_or_obj)
-    {
-        return $this->get_all(
-            array(
-                array(
-                    'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction
-                        ? $transaction_id_or_obj->ID()
-                        : $transaction_id_or_obj,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * retrieve  a single attendee from db via their ID
-     *
-     * @param $ATT_ID
-     * @return mixed array on success, FALSE on fail
-     * @deprecated
-     */
-    public function get_attendee_by_ID($ATT_ID = false)
-    {
-        // retrieve a particular EE_Attendee
-        return $this->get_one_by_ID($ATT_ID);
-    }
-
-
-
-    /**
-     * retrieve  a single attendee from db via their ID
-     *
-     * @param array $where_cols_n_values
-     * @return mixed array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function get_attendee($where_cols_n_values = array())
-    {
-        if (empty($where_cols_n_values)) {
-            return false;
-        }
-        $attendee = $this->get_all(array($where_cols_n_values));
-        if (! empty($attendee)) {
-            return array_shift($attendee);
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Search for an existing Attendee record in the DB
-     *
-     * @param array $where_cols_n_values
-     * @return bool|mixed
-     * @throws EE_Error
-     */
-    public function find_existing_attendee($where_cols_n_values = null)
-    {
-        // search by combo of first and last names plus the email address
-        $attendee_data_keys = array(
-            'ATT_fname' => $this->_ATT_fname,
-            'ATT_lname' => $this->_ATT_lname,
-            'ATT_email' => $this->_ATT_email,
-        );
-        // no search params means attendee object already exists.
-        $where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values)
-            ? $where_cols_n_values
-            : $attendee_data_keys;
-        $valid_data = true;
-        // check for required values
-        $valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname'])
-            ? $valid_data
-            : false;
-        $valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname'])
-            ? $valid_data
-            : false;
-        $valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email'])
-            ? $valid_data
-            : false;
-        if ($valid_data) {
-            $attendee = $this->get_attendee($where_cols_n_values);
-            if ($attendee instanceof EE_Attendee) {
-                return $attendee;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Takes an incoming array of EE_Registration ids
-     * and sends back a list of corresponding non duplicate EE_Attendee objects.
-     *
-     * @since  4.3.0
-     * @param  array $ids array of EE_Registration ids
-     * @return EE_Attendee[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_array_of_contacts_from_reg_ids($ids)
-    {
-        $ids = (array)$ids;
-        $_where = array(
-            'Registration.REG_ID' => array('in', $ids),
-        );
-        return $this->get_all(array($_where));
-    }
+	/**
+	 * @deprecated
+	 */
+	const address2_question_id = 5;
+
+
+	/**
+	 * @deprecated
+	 */
+	const city_question_id = 6;
+
+
+	/**
+	 * @deprecated
+	 */
+	const state_question_id = 7;
+
+
+	/**
+	 * @deprecated
+	 */
+	const country_question_id = 8;
+
+
+	/**
+	 * @deprecated
+	 */
+	const zip_question_id = 9;
+
+
+	/**
+	 * @deprecated
+	 */
+	const phone_question_id = 10;
+
+	/**
+	 * When looking for questions that correspond to attendee fields,
+	 * look for the question with this QST_system value.
+	 * These replace the old constants like EEM_Attendee::*_question_id
+	 */
+	const system_question_fname = 'fname';
+
+	const system_question_lname = 'lname';
+
+	const system_question_email = 'email';
+
+	const system_question_address = 'address';
+
+	const system_question_address2 = 'address2';
+
+	const system_question_city = 'city';
+
+	const system_question_state = 'state';
+
+	const system_question_country = 'country';
+
+	const system_question_zip = 'zip';
+
+	const system_question_phone = 'phone';
+
+	/**
+	 * Keys are all the EEM_Attendee::system_question_* constants, which are
+	 * also all the values of QST_system in the questions table, and values
+	 * are their corresponding Attendee field names
+	 *
+	 * @var array
+	 */
+	protected $_system_question_to_attendee_field_name = array(
+		EEM_Attendee::system_question_fname    => 'ATT_fname',
+		EEM_Attendee::system_question_lname    => 'ATT_lname',
+		EEM_Attendee::system_question_email    => 'ATT_email',
+		EEM_Attendee::system_question_address  => 'ATT_address',
+		EEM_Attendee::system_question_address2 => 'ATT_address2',
+		EEM_Attendee::system_question_city     => 'ATT_city',
+		EEM_Attendee::system_question_state    => 'STA_ID',
+		EEM_Attendee::system_question_country  => 'CNT_ISO',
+		EEM_Attendee::system_question_zip      => 'ATT_zip',
+		EEM_Attendee::system_question_phone    => 'ATT_phone',
+	);
+
+
+
+	/**
+	 * EEM_Attendee constructor.
+	 *
+	 * @param null              $timezone
+	 * @param ModelFieldFactory $model_field_factory
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
+	{
+		$this->singular_item = esc_html__('Attendee', 'event_espresso');
+		$this->plural_item = esc_html__('Attendees', 'event_espresso');
+		$this->_tables = array(
+			'Attendee_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Attendee_Meta' => new EE_Secondary_Table(
+				'esp_attendee_meta',
+				'ATTM_ID',
+				'ATT_ID'
+			),
+		);
+		$this->_fields = array(
+			'Attendee_CPT'  => array(
+				'ATT_ID'        => $model_field_factory->createPrimaryKeyIntField(
+					'ID',
+					esc_html__('Attendee ID', 'event_espresso')
+				),
+				'ATT_full_name' => $model_field_factory->createPlainTextField(
+					'post_title',
+					esc_html__('Attendee Full Name', 'event_espresso'),
+					false,
+					esc_html__('Unknown', 'event_espresso')
+				),
+				'ATT_bio'       => $model_field_factory->createPostContentField(
+					'post_content',
+					esc_html__('Attendee Biography', 'event_espresso'),
+					false,
+					esc_html__('No Biography Provided', 'event_espresso')
+				),
+				'ATT_slug'      => $model_field_factory->createSlugField(
+					'post_name',
+					esc_html__('Attendee URL Slug', 'event_espresso')
+				),
+				'ATT_created'   => $model_field_factory->createDatetimeField(
+					'post_date',
+					esc_html__('Time Attendee Created', 'event_espresso')
+				),
+				'ATT_short_bio' => $model_field_factory->createSimpleHtmlField(
+					'post_excerpt',
+					esc_html__('Attendee Short Biography', 'event_espresso'),
+					true,
+					esc_html__('No Biography Provided', 'event_espresso')
+				),
+				'ATT_modified'  => $model_field_factory->createDatetimeField(
+					'post_modified',
+					esc_html__('Time Attendee Last Modified', 'event_espresso')
+				),
+				'ATT_author'    => $model_field_factory->createWpUserField(
+					'post_author',
+					esc_html__('Creator ID of the first Event attended', 'event_espresso'),
+					false
+				),
+				'ATT_parent'    => $model_field_factory->createDbOnlyIntField(
+					'post_parent',
+					esc_html__('Parent Attendee (unused)', 'event_espresso'),
+					false,
+					0
+				),
+				'post_type'     => $model_field_factory->createWpPostTypeField('espresso_attendees'),
+				'status'        => $model_field_factory->createWpPostStatusField(
+					'post_status',
+					esc_html__('Attendee Status', 'event_espresso'),
+					false,
+					'publish'
+				),
+			),
+			'Attendee_Meta' => array(
+				'ATTM_ID'      => $model_field_factory->createDbOnlyIntField(
+					'ATTM_ID',
+					esc_html__('Attendee Meta Row ID', 'event_espresso'),
+					false
+				),
+				'ATT_ID_fk'    => $model_field_factory->createDbOnlyIntField(
+					'ATT_ID',
+					esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'),
+					false
+				),
+				'ATT_fname'    => $model_field_factory->createPlainTextField(
+					'ATT_fname',
+					esc_html__('First Name', 'event_espresso')
+				),
+				'ATT_lname'    => $model_field_factory->createPlainTextField(
+					'ATT_lname',
+					esc_html__('Last Name', 'event_espresso')
+				),
+				'ATT_address'  => $model_field_factory->createPlainTextField(
+					'ATT_address',
+					esc_html__('Address Part 1', 'event_espresso')
+				),
+				'ATT_address2' => $model_field_factory->createPlainTextField(
+					'ATT_address2',
+					esc_html__('Address Part 2', 'event_espresso')
+				),
+				'ATT_city'     => $model_field_factory->createPlainTextField(
+					'ATT_city',
+					esc_html__('City', 'event_espresso')
+				),
+				'STA_ID'       => $model_field_factory->createForeignKeyIntField(
+					'STA_ID',
+					esc_html__('State', 'event_espresso'),
+					true,
+					0,
+					'State'
+				),
+				'CNT_ISO'      => $model_field_factory->createForeignKeyStringField(
+					'CNT_ISO',
+					esc_html__('Country', 'event_espresso'),
+					true,
+					'',
+					'Country'
+				),
+				'ATT_zip'      => $model_field_factory->createPlainTextField(
+					'ATT_zip',
+					esc_html__('ZIP/Postal Code', 'event_espresso')
+				),
+				'ATT_email'    => $model_field_factory->createEmailField(
+					'ATT_email',
+					esc_html__('Email Address', 'event_espresso')
+				),
+				'ATT_phone'    => $model_field_factory->createPlainTextField(
+					'ATT_phone',
+					esc_html__('Phone', 'event_espresso')
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration'      => new EE_Has_Many_Relation(),
+			'State'             => new EE_Belongs_To_Relation(),
+			'Country'           => new EE_Belongs_To_Relation(),
+			'Event'             => new EE_HABTM_Relation('Registration', false),
+			'WP_User'           => new EE_Belongs_To_Relation(),
+			'Message'           => new EE_Has_Many_Any_Relation(false),
+			//allow deletion of attendees even if they have messages in the queue for them.
+			'Term_Relationship' => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
+		);
+		$this->_caps_slug = 'contacts';
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Gets the name of the field on the attendee model corresponding to the system question string
+	 * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name
+	 *
+	 * @param string $system_question_string
+	 * @return string|null if not found
+	 */
+	public function get_attendee_field_for_system_question($system_question_string)
+	{
+		return isset($this->_system_question_to_attendee_field_name[$system_question_string])
+			? $this->_system_question_to_attendee_field_name[$system_question_string]
+			: null;
+	}
+
+
+
+	/**
+	 * Gets mapping from esp_question.QST_system values to their corresponding attendee field names
+	 *
+	 * @return array
+	 */
+	public function system_question_to_attendee_field_mapping()
+	{
+		return $this->_system_question_to_attendee_field_name;
+	}
+
+
+
+	/**
+	 * Gets all the attendees for a transaction (by using the esp_registration as a join table)
+	 *
+	 * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID
+	 * @return EE_Attendee[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_attendees_for_transaction($transaction_id_or_obj)
+	{
+		return $this->get_all(
+			array(
+				array(
+					'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction
+						? $transaction_id_or_obj->ID()
+						: $transaction_id_or_obj,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * retrieve  a single attendee from db via their ID
+	 *
+	 * @param $ATT_ID
+	 * @return mixed array on success, FALSE on fail
+	 * @deprecated
+	 */
+	public function get_attendee_by_ID($ATT_ID = false)
+	{
+		// retrieve a particular EE_Attendee
+		return $this->get_one_by_ID($ATT_ID);
+	}
+
+
+
+	/**
+	 * retrieve  a single attendee from db via their ID
+	 *
+	 * @param array $where_cols_n_values
+	 * @return mixed array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function get_attendee($where_cols_n_values = array())
+	{
+		if (empty($where_cols_n_values)) {
+			return false;
+		}
+		$attendee = $this->get_all(array($where_cols_n_values));
+		if (! empty($attendee)) {
+			return array_shift($attendee);
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Search for an existing Attendee record in the DB
+	 *
+	 * @param array $where_cols_n_values
+	 * @return bool|mixed
+	 * @throws EE_Error
+	 */
+	public function find_existing_attendee($where_cols_n_values = null)
+	{
+		// search by combo of first and last names plus the email address
+		$attendee_data_keys = array(
+			'ATT_fname' => $this->_ATT_fname,
+			'ATT_lname' => $this->_ATT_lname,
+			'ATT_email' => $this->_ATT_email,
+		);
+		// no search params means attendee object already exists.
+		$where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values)
+			? $where_cols_n_values
+			: $attendee_data_keys;
+		$valid_data = true;
+		// check for required values
+		$valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname'])
+			? $valid_data
+			: false;
+		$valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname'])
+			? $valid_data
+			: false;
+		$valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email'])
+			? $valid_data
+			: false;
+		if ($valid_data) {
+			$attendee = $this->get_attendee($where_cols_n_values);
+			if ($attendee instanceof EE_Attendee) {
+				return $attendee;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Takes an incoming array of EE_Registration ids
+	 * and sends back a list of corresponding non duplicate EE_Attendee objects.
+	 *
+	 * @since  4.3.0
+	 * @param  array $ids array of EE_Registration ids
+	 * @return EE_Attendee[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_array_of_contacts_from_reg_ids($ids)
+	{
+		$ids = (array)$ids;
+		$_where = array(
+			'Registration.REG_ID' => array('in', $ids),
+		);
+		return $this->get_all(array($_where));
+	}
 
 
 }

admin_pages/events/Events_Admin_List_Table.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -152,7 +152,7 @@
 
     /**
      * @param EE_Event $item
-     * @return mixed|string
+     * @return string
      * @throws EE_Error
      */
     public function column_id(EE_Event $item)

Indentation +541 added lines, -541 removed lines

@@ -18,545 +18,545 @@
 class Events_Admin_List_Table extends EE_Admin_List_Table
 {
 
-    /**
-     * @var EE_Datetime
-     */
-    private $_dtt;
-
-
-
-    /**
-     * Initial setup of data properties for the list table.
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->_admin_page->get_events($this->_per_page, $this->_current_page);
-        $this->_all_data_count = $this->_admin_page->get_events(0, 0, true);
-    }
-
-
-
-    /**
-     * Set up of additional properties for the list table.
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('event', 'event_espresso'),
-            'plural'   => esc_html__('events', 'event_espresso'),
-            'ajax'     => true, //for now
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-        $this->_columns = array(
-            'cb'              => '<input type="checkbox" />',
-            'id'              => esc_html__('ID', 'event_espresso'),
-            'name'            => esc_html__('Name', 'event_espresso'),
-            'author'          => esc_html__('Author', 'event_espresso'),
-            'venue'           => esc_html__('Venue', 'event_espresso'),
-            'start_date_time' => esc_html__('Event Start', 'event_espresso'),
-            'reg_begins'      => esc_html__('On Sale', 'event_espresso'),
-            'attendees'       => '<span class="dashicons dashicons-groups ee-icon-color-ee-green ee-icon-size-20">'
-                                 . '</span>',
-            //'tkts_sold' => esc_html__('Tickets Sold', 'event_espresso'),
-            'actions'         => esc_html__('Actions', 'event_espresso'),
-        );
-        $this->_sortable_columns = array(
-            'id'              => array('EVT_ID' => true),
-            'name'            => array('EVT_name' => false),
-            'author'          => array('EVT_wp_user' => false),
-            'venue'           => array('Venue.VNU_name' => false),
-            'start_date_time' => array('Datetime.DTT_EVT_start' => false),
-            'reg_begins'      => array('Datetime.Ticket.TKT_start_date' => false),
-        );
-        $this->_primary_column = 'id';
-        $this->_hidden_columns = array('author');
-    }
-
-
-
-    /**
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        return array(); //no filters with decaf
-    }
-
-
-
-    /**
-     * Setup of views properties.
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_admin_page->total_events();
-        $this->_views['draft']['count'] = $this->_admin_page->total_events_draft();
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_events',
-            'espresso_events_trash_events'
-        )) {
-            $this->_views['trash']['count'] = $this->_admin_page->total_trashed_events();
-        }
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_row_class($item)
-    {
-        $class = parent::_get_row_class($item);
-        //add status class
-        $class .= $item instanceof EE_Event
-            ? ' ee-status-strip event-status-' . $item->get_active_status()
-            : '';
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_status(EE_Event $item)
-    {
-        return '<span class="ee-status-strip ee-status-strip-td event-status-'
-               . $item->get_active_status()
-               . '"></span>';
-    }
-
-
-
-    /**
-     * @param  EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_cb($item)
-    {
-        if (! $item instanceof EE_Event) {
-            return '';
-        }
-        $this->_dtt = $item->primary_datetime(); //set this for use in other columns
-        //does event have any attached registrations?
-        $regs = $item->count_related('Registration');
-        return $regs > 0 && $this->_view === 'trash'
-            ? '<span class="ee-lock-icon"></span>'
-            : sprintf(
-                '<input type="checkbox" name="EVT_IDs[]" value="%s" />',
-                $item->ID()
-            );
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return mixed|string
-     * @throws EE_Error
-     */
-    public function column_id(EE_Event $item)
-    {
-        $content = $item->ID();
-        $content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
-        return $content;
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_name(EE_Event $item)
-    {
-        $edit_query_args = array(
-            'action' => 'edit',
-            'post'   => $item->ID(),
-        );
-        $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-        $actions = $this->_column_name_action_setup($item);
-        $status = ''; //$item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
-        $content = '<strong><a class="row-title" href="'
-                   . $edit_link . '">'
-                   . $item->name()
-                   . '</a></strong>'
-                   . $status;
-        $content .= '<br><span class="ee-status-text-small">'
-                    . EEH_Template::pretty_status(
-                $item->get_active_status(),
-                false,
-                'sentence'
-            )
-                    . '</span>';
-        $content .= $this->row_actions($actions);
-        return $content;
-    }
-
-
-
-    /**
-     * Just a method for setting up the actions for the name column
-     *
-     * @param EE_Event $item
-     * @return array array of actions
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _column_name_action_setup(EE_Event $item)
-    {
-        //todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
-            define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
-        }
-        $actions = array();
-        $restore_event_link = '';
-        $delete_event_link = '';
-        $trash_event_link = '';
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_event',
-            'espresso_events_edit',
-            $item->ID()
-        )) {
-            $edit_query_args = array(
-                'action' => 'edit',
-                'post'   => $item->ID(),
-            );
-            $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_link . '"'
-                               . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
-                               . esc_html__('Edit', 'event_espresso')
-                               . '</a>';
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_view_registration'
-            )
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_event',
-                'espresso_registrations_view_registration',
-                $item->ID()
-            )
-        ) {
-            $attendees_query_args = array(
-                'action'   => 'default',
-                'event_id' => $item->ID(),
-            );
-            $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $actions['attendees'] = '<a href="' . $attendees_link . '"'
-                                    . ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
-                                    . esc_html__('Registrations', 'event_espresso')
-                                    . '</a>';
-        }
-        if (
-        EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_event',
-            'espresso_events_trash_event',
-            $item->ID()
-        )
-        ) {
-            $trash_event_query_args = array(
-                'action' => 'trash_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $trash_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $trash_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        if (
-        EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_event',
-            'espresso_events_restore_event',
-            $item->ID()
-        )
-        ) {
-            $restore_event_query_args = array(
-                'action' => 'restore_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $restore_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $restore_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        if (
-        EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_event',
-            'espresso_events_delete_event',
-            $item->ID()
-        )
-        ) {
-            $delete_event_query_args = array(
-                'action' => 'delete_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $delete_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $delete_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        $view_link = get_permalink($item->ID());
-        $actions['view'] = '<a href="' . $view_link . '"'
-                           . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
-                           . esc_html__('View', 'event_espresso')
-                           . '</a>';
-        if ($item->get('status') === 'trash') {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_event',
-                'espresso_events_restore_event',
-                $item->ID()
-            )) {
-                $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
-                                                 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
-                                                 . '">'
-                                                 . esc_html__('Restore from Trash', 'event_espresso')
-                                                 . '</a>';
-            }
-            if (
-                $item->count_related('Registration') === 0
-                && EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_delete_event',
-                    $item->ID()
-                )
-            ) {
-                $actions['delete'] = '<a href="' . $delete_event_link . '"'
-                                     . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
-                                     . esc_html__('Delete Permanently', 'event_espresso')
-                                     . '</a>';
-            }
-        } else {
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_trash_event',
-                    $item->ID()
-                )
-            ) {
-                $actions['move to trash'] = '<a href="' . $trash_event_link . '"'
-                                            . ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
-                                            . esc_html__('Trash', 'event_espresso')
-                                            . '</a>';
-            }
-        }
-        return $actions;
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_author(EE_Event $item)
-    {
-        //user author info
-        $event_author = get_userdata($item->wp_user());
-        $gravatar = get_avatar($item->wp_user(), '15');
-        //filter link
-        $query_args = array(
-            'action'      => 'default',
-            'EVT_wp_user' => $item->wp_user(),
-        );
-        $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
-        return $gravatar . '  <a href="' . $filter_url . '"'
-               . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
-               . $event_author->display_name
-               . '</a>';
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_venue(EE_Event $item)
-    {
-        $venue = $item->get_first_related('Venue');
-        return ! empty($venue)
-            ? $venue->name()
-            : '';
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @throws EE_Error
-     */
-    public function column_start_date_time(EE_Event $item)
-    {
-        echo ! empty($this->_dtt)
-            ? $this->_dtt->get_i18n_datetime('DTT_EVT_start')
-            : esc_html__('No Date was saved for this Event', 'event_espresso');
-        //display in user's timezone?
-        echo ! empty($this->_dtt)
-            ? $this->_dtt->display_in_my_timezone(
-                'DTT_EVT_start',
-                'get_i18n_datetime',
-                '',
-                'My Timezone: '
-            )
-            : '';
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @throws EE_Error
-     */
-    public function column_reg_begins(EE_Event $item)
-    {
-        $reg_start = $item->get_ticket_with_earliest_start_time();
-        echo ! empty($reg_start)
-            ? $reg_start->get_i18n_datetime('TKT_start_date')
-            : esc_html__('No Tickets have been setup for this Event', 'event_espresso');
-        //display in user's timezone?
-        echo ! empty($reg_start)
-            ? $reg_start->display_in_my_timezone(
-                'TKT_start_date',
-                'get_i18n_datetime',
-                '',
-                'My Timezone: '
-            )
-            : '';
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return int|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_attendees(EE_Event $item)
-    {
-        $attendees_query_args = array(
-            'action'   => 'default',
-            'event_id' => $item->ID(),
-        );
-        $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-        $registered_attendees = EEM_Registration::instance()->get_event_registration_count($item->ID());
-        return EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_event',
-            'espresso_registrations_view_registration',
-            $item->ID()
-        )
-               && EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registrations',
-            'espresso_registrations_view_registration'
-        )
-            ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
-            : $registered_attendees;
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_tkts_sold(EE_Event $item)
-    {
-        return EEM_Ticket::instance()->sum(array(array('Datetime.EVT_ID' => $item->ID())), 'TKT_sold');
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_actions(EE_Event $item)
-    {
-        //todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
-            define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
-        }
-        $action_links = array();
-        $view_link = get_permalink($item->ID());
-        $action_links[] = '<a href="' . $view_link . '"'
-                         . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
-        $action_links[] = '<div class="dashicons dashicons-search"></div></a>';
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_event',
-            'espresso_events_edit',
-            $item->ID()
-        )) {
-            $edit_query_args = array(
-                'action' => 'edit',
-                'post'   => $item->ID(),
-            );
-            $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $action_links[] = '<a href="' . $edit_link . '"'
-                             . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
-                             . '<div class="ee-icon ee-icon-calendar-edit"></div>'
-                             . '</a>';
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_view_registration'
-            ) && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_event',
-                'espresso_registrations_view_registration',
-                $item->ID()
-            )
-        ) {
-            $attendees_query_args = array(
-                'action'   => 'default',
-                'event_id' => $item->ID(),
-            );
-            $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $action_links[] = '<a href="' . $attendees_link . '"'
-                             . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
-                             . '<div class="dashicons dashicons-groups"></div>'
-                             . '</a>';
-        }
-        $action_links = apply_filters(
-            'FHEE__Events_Admin_List_Table__column_actions__action_links',
-            $action_links,
-            $item
-        );
-        return $this->_action_string(
-            implode("\n\t", $action_links),
-            $item,
-            'div'
-        );
-    }
+	/**
+	 * @var EE_Datetime
+	 */
+	private $_dtt;
+
+
+
+	/**
+	 * Initial setup of data properties for the list table.
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->_admin_page->get_events($this->_per_page, $this->_current_page);
+		$this->_all_data_count = $this->_admin_page->get_events(0, 0, true);
+	}
+
+
+
+	/**
+	 * Set up of additional properties for the list table.
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('event', 'event_espresso'),
+			'plural'   => esc_html__('events', 'event_espresso'),
+			'ajax'     => true, //for now
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+		$this->_columns = array(
+			'cb'              => '<input type="checkbox" />',
+			'id'              => esc_html__('ID', 'event_espresso'),
+			'name'            => esc_html__('Name', 'event_espresso'),
+			'author'          => esc_html__('Author', 'event_espresso'),
+			'venue'           => esc_html__('Venue', 'event_espresso'),
+			'start_date_time' => esc_html__('Event Start', 'event_espresso'),
+			'reg_begins'      => esc_html__('On Sale', 'event_espresso'),
+			'attendees'       => '<span class="dashicons dashicons-groups ee-icon-color-ee-green ee-icon-size-20">'
+								 . '</span>',
+			//'tkts_sold' => esc_html__('Tickets Sold', 'event_espresso'),
+			'actions'         => esc_html__('Actions', 'event_espresso'),
+		);
+		$this->_sortable_columns = array(
+			'id'              => array('EVT_ID' => true),
+			'name'            => array('EVT_name' => false),
+			'author'          => array('EVT_wp_user' => false),
+			'venue'           => array('Venue.VNU_name' => false),
+			'start_date_time' => array('Datetime.DTT_EVT_start' => false),
+			'reg_begins'      => array('Datetime.Ticket.TKT_start_date' => false),
+		);
+		$this->_primary_column = 'id';
+		$this->_hidden_columns = array('author');
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		return array(); //no filters with decaf
+	}
+
+
+
+	/**
+	 * Setup of views properties.
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_admin_page->total_events();
+		$this->_views['draft']['count'] = $this->_admin_page->total_events_draft();
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_events',
+			'espresso_events_trash_events'
+		)) {
+			$this->_views['trash']['count'] = $this->_admin_page->total_trashed_events();
+		}
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_row_class($item)
+	{
+		$class = parent::_get_row_class($item);
+		//add status class
+		$class .= $item instanceof EE_Event
+			? ' ee-status-strip event-status-' . $item->get_active_status()
+			: '';
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_status(EE_Event $item)
+	{
+		return '<span class="ee-status-strip ee-status-strip-td event-status-'
+			   . $item->get_active_status()
+			   . '"></span>';
+	}
+
+
+
+	/**
+	 * @param  EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_cb($item)
+	{
+		if (! $item instanceof EE_Event) {
+			return '';
+		}
+		$this->_dtt = $item->primary_datetime(); //set this for use in other columns
+		//does event have any attached registrations?
+		$regs = $item->count_related('Registration');
+		return $regs > 0 && $this->_view === 'trash'
+			? '<span class="ee-lock-icon"></span>'
+			: sprintf(
+				'<input type="checkbox" name="EVT_IDs[]" value="%s" />',
+				$item->ID()
+			);
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return mixed|string
+	 * @throws EE_Error
+	 */
+	public function column_id(EE_Event $item)
+	{
+		$content = $item->ID();
+		$content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
+		return $content;
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_name(EE_Event $item)
+	{
+		$edit_query_args = array(
+			'action' => 'edit',
+			'post'   => $item->ID(),
+		);
+		$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+		$actions = $this->_column_name_action_setup($item);
+		$status = ''; //$item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
+		$content = '<strong><a class="row-title" href="'
+				   . $edit_link . '">'
+				   . $item->name()
+				   . '</a></strong>'
+				   . $status;
+		$content .= '<br><span class="ee-status-text-small">'
+					. EEH_Template::pretty_status(
+				$item->get_active_status(),
+				false,
+				'sentence'
+			)
+					. '</span>';
+		$content .= $this->row_actions($actions);
+		return $content;
+	}
+
+
+
+	/**
+	 * Just a method for setting up the actions for the name column
+	 *
+	 * @param EE_Event $item
+	 * @return array array of actions
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _column_name_action_setup(EE_Event $item)
+	{
+		//todo: remove when attendees is active
+		if (! defined('REG_ADMIN_URL')) {
+			define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
+		}
+		$actions = array();
+		$restore_event_link = '';
+		$delete_event_link = '';
+		$trash_event_link = '';
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_event',
+			'espresso_events_edit',
+			$item->ID()
+		)) {
+			$edit_query_args = array(
+				'action' => 'edit',
+				'post'   => $item->ID(),
+			);
+			$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+			$actions['edit'] = '<a href="' . $edit_link . '"'
+							   . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+							   . esc_html__('Edit', 'event_espresso')
+							   . '</a>';
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_view_registration'
+			)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_event',
+				'espresso_registrations_view_registration',
+				$item->ID()
+			)
+		) {
+			$attendees_query_args = array(
+				'action'   => 'default',
+				'event_id' => $item->ID(),
+			);
+			$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+			$actions['attendees'] = '<a href="' . $attendees_link . '"'
+									. ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
+									. esc_html__('Registrations', 'event_espresso')
+									. '</a>';
+		}
+		if (
+		EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_event',
+			'espresso_events_trash_event',
+			$item->ID()
+		)
+		) {
+			$trash_event_query_args = array(
+				'action' => 'trash_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$trash_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$trash_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		if (
+		EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_event',
+			'espresso_events_restore_event',
+			$item->ID()
+		)
+		) {
+			$restore_event_query_args = array(
+				'action' => 'restore_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$restore_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$restore_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		if (
+		EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_event',
+			'espresso_events_delete_event',
+			$item->ID()
+		)
+		) {
+			$delete_event_query_args = array(
+				'action' => 'delete_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$delete_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$delete_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		$view_link = get_permalink($item->ID());
+		$actions['view'] = '<a href="' . $view_link . '"'
+						   . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
+						   . esc_html__('View', 'event_espresso')
+						   . '</a>';
+		if ($item->get('status') === 'trash') {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_event',
+				'espresso_events_restore_event',
+				$item->ID()
+			)) {
+				$actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
+												 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
+												 . '">'
+												 . esc_html__('Restore from Trash', 'event_espresso')
+												 . '</a>';
+			}
+			if (
+				$item->count_related('Registration') === 0
+				&& EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_delete_event',
+					$item->ID()
+				)
+			) {
+				$actions['delete'] = '<a href="' . $delete_event_link . '"'
+									 . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
+									 . esc_html__('Delete Permanently', 'event_espresso')
+									 . '</a>';
+			}
+		} else {
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_trash_event',
+					$item->ID()
+				)
+			) {
+				$actions['move to trash'] = '<a href="' . $trash_event_link . '"'
+											. ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
+											. esc_html__('Trash', 'event_espresso')
+											. '</a>';
+			}
+		}
+		return $actions;
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_author(EE_Event $item)
+	{
+		//user author info
+		$event_author = get_userdata($item->wp_user());
+		$gravatar = get_avatar($item->wp_user(), '15');
+		//filter link
+		$query_args = array(
+			'action'      => 'default',
+			'EVT_wp_user' => $item->wp_user(),
+		);
+		$filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
+		return $gravatar . '  <a href="' . $filter_url . '"'
+			   . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
+			   . $event_author->display_name
+			   . '</a>';
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_venue(EE_Event $item)
+	{
+		$venue = $item->get_first_related('Venue');
+		return ! empty($venue)
+			? $venue->name()
+			: '';
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @throws EE_Error
+	 */
+	public function column_start_date_time(EE_Event $item)
+	{
+		echo ! empty($this->_dtt)
+			? $this->_dtt->get_i18n_datetime('DTT_EVT_start')
+			: esc_html__('No Date was saved for this Event', 'event_espresso');
+		//display in user's timezone?
+		echo ! empty($this->_dtt)
+			? $this->_dtt->display_in_my_timezone(
+				'DTT_EVT_start',
+				'get_i18n_datetime',
+				'',
+				'My Timezone: '
+			)
+			: '';
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @throws EE_Error
+	 */
+	public function column_reg_begins(EE_Event $item)
+	{
+		$reg_start = $item->get_ticket_with_earliest_start_time();
+		echo ! empty($reg_start)
+			? $reg_start->get_i18n_datetime('TKT_start_date')
+			: esc_html__('No Tickets have been setup for this Event', 'event_espresso');
+		//display in user's timezone?
+		echo ! empty($reg_start)
+			? $reg_start->display_in_my_timezone(
+				'TKT_start_date',
+				'get_i18n_datetime',
+				'',
+				'My Timezone: '
+			)
+			: '';
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return int|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_attendees(EE_Event $item)
+	{
+		$attendees_query_args = array(
+			'action'   => 'default',
+			'event_id' => $item->ID(),
+		);
+		$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+		$registered_attendees = EEM_Registration::instance()->get_event_registration_count($item->ID());
+		return EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_event',
+			'espresso_registrations_view_registration',
+			$item->ID()
+		)
+			   && EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registrations',
+			'espresso_registrations_view_registration'
+		)
+			? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
+			: $registered_attendees;
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_tkts_sold(EE_Event $item)
+	{
+		return EEM_Ticket::instance()->sum(array(array('Datetime.EVT_ID' => $item->ID())), 'TKT_sold');
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_actions(EE_Event $item)
+	{
+		//todo: remove when attendees is active
+		if (! defined('REG_ADMIN_URL')) {
+			define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
+		}
+		$action_links = array();
+		$view_link = get_permalink($item->ID());
+		$action_links[] = '<a href="' . $view_link . '"'
+						 . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
+		$action_links[] = '<div class="dashicons dashicons-search"></div></a>';
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_event',
+			'espresso_events_edit',
+			$item->ID()
+		)) {
+			$edit_query_args = array(
+				'action' => 'edit',
+				'post'   => $item->ID(),
+			);
+			$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+			$action_links[] = '<a href="' . $edit_link . '"'
+							 . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+							 . '<div class="ee-icon ee-icon-calendar-edit"></div>'
+							 . '</a>';
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_view_registration'
+			) && EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_event',
+				'espresso_registrations_view_registration',
+				$item->ID()
+			)
+		) {
+			$attendees_query_args = array(
+				'action'   => 'default',
+				'event_id' => $item->ID(),
+			);
+			$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+			$action_links[] = '<a href="' . $attendees_link . '"'
+							 . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
+							 . '<div class="dashicons dashicons-groups"></div>'
+							 . '</a>';
+		}
+		$action_links = apply_filters(
+			'FHEE__Events_Admin_List_Table__column_actions__action_links',
+			$action_links,
+			$item
+		);
+		return $this->_action_string(
+			implode("\n\t", $action_links),
+			$item,
+			'div'
+		);
+	}
 }

Spacing +27 added lines, -27 removed lines

@@ -115,7 +115,7 @@ 
         $class = parent::_get_row_class($item);
         //add status class
         $class .= $item instanceof EE_Event
-            ? ' ee-status-strip event-status-' . $item->get_active_status()
+            ? ' ee-status-strip event-status-'.$item->get_active_status()
             : '';
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
@@ -146,7 +146,7 @@ 
      */
     public function column_cb($item)
     {
-        if (! $item instanceof EE_Event) {
+        if ( ! $item instanceof EE_Event) {
             return '';
         }
         $this->_dtt = $item->primary_datetime(); //set this for use in other columns
@@ -170,7 +170,7 @@ 
     public function column_id(EE_Event $item)
     {
         $content = $item->ID();
-        $content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
+        $content .= '  <span class="show-on-mobile-view-only">'.$item->name().'</span>';
         return $content;
     }
 
@@ -194,7 +194,7 @@ 
         $actions = $this->_column_name_action_setup($item);
         $status = ''; //$item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
         $content = '<strong><a class="row-title" href="'
-                   . $edit_link . '">'
+                   . $edit_link.'">'
                    . $item->name()
                    . '</a></strong>'
                    . $status;
@@ -224,7 +224,7 @@ 
     protected function _column_name_action_setup(EE_Event $item)
     {
         //todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
+        if ( ! defined('REG_ADMIN_URL')) {
             define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
         }
         $actions = array();
@@ -241,8 +241,8 @@ 
                 'post'   => $item->ID(),
             );
             $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_link . '"'
-                               . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+            $actions['edit'] = '<a href="'.$edit_link.'"'
+                               . ' title="'.esc_attr__('Edit Event', 'event_espresso').'">'
                                . esc_html__('Edit', 'event_espresso')
                                . '</a>';
         }
@@ -262,8 +262,8 @@ 
                 'event_id' => $item->ID(),
             );
             $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $actions['attendees'] = '<a href="' . $attendees_link . '"'
-                                    . ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
+            $actions['attendees'] = '<a href="'.$attendees_link.'"'
+                                    . ' title="'.esc_attr__('View Registrations', 'event_espresso').'">'
                                     . esc_html__('Registrations', 'event_espresso')
                                     . '</a>';
         }
@@ -316,8 +316,8 @@ 
             );
         }
         $view_link = get_permalink($item->ID());
-        $actions['view'] = '<a href="' . $view_link . '"'
-                           . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
+        $actions['view'] = '<a href="'.$view_link.'"'
+                           . ' title="'.esc_attr__('View Event', 'event_espresso').'">'
                            . esc_html__('View', 'event_espresso')
                            . '</a>';
         if ($item->get('status') === 'trash') {
@@ -326,8 +326,8 @@ 
                 'espresso_events_restore_event',
                 $item->ID()
             )) {
-                $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
-                                                 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
+                $actions['restore_from_trash'] = '<a href="'.$restore_event_link.'"'
+                                                 . ' title="'.esc_attr__('Restore from Trash', 'event_espresso')
                                                  . '">'
                                                  . esc_html__('Restore from Trash', 'event_espresso')
                                                  . '</a>';
@@ -340,8 +340,8 @@ 
                     $item->ID()
                 )
             ) {
-                $actions['delete'] = '<a href="' . $delete_event_link . '"'
-                                     . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
+                $actions['delete'] = '<a href="'.$delete_event_link.'"'
+                                     . ' title="'.esc_attr__('Delete Permanently', 'event_espresso').'">'
                                      . esc_html__('Delete Permanently', 'event_espresso')
                                      . '</a>';
             }
@@ -353,8 +353,8 @@ 
                     $item->ID()
                 )
             ) {
-                $actions['move to trash'] = '<a href="' . $trash_event_link . '"'
-                                            . ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
+                $actions['move to trash'] = '<a href="'.$trash_event_link.'"'
+                                            . ' title="'.esc_attr__('Trash Event', 'event_espresso').'">'
                                             . esc_html__('Trash', 'event_espresso')
                                             . '</a>';
             }
@@ -380,8 +380,8 @@ 
             'EVT_wp_user' => $item->wp_user(),
         );
         $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
-        return $gravatar . '  <a href="' . $filter_url . '"'
-               . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
+        return $gravatar.'  <a href="'.$filter_url.'"'
+               . ' title="'.esc_attr__('Click to filter events by this author.', 'event_espresso').'">'
                . $event_author->display_name
                . '</a>';
     }
@@ -473,7 +473,7 @@ 
             'ee_read_registrations',
             'espresso_registrations_view_registration'
         )
-            ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
+            ? '<a href="'.$attendees_link.'">'.$registered_attendees.'</a>'
             : $registered_attendees;
     }
 
@@ -505,13 +505,13 @@ 
     public function column_actions(EE_Event $item)
     {
         //todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
+        if ( ! defined('REG_ADMIN_URL')) {
             define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
         }
         $action_links = array();
         $view_link = get_permalink($item->ID());
-        $action_links[] = '<a href="' . $view_link . '"'
-                         . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
+        $action_links[] = '<a href="'.$view_link.'"'
+                         . ' title="'.esc_attr__('View Event', 'event_espresso').'" target="_blank">';
         $action_links[] = '<div class="dashicons dashicons-search"></div></a>';
         if (EE_Registry::instance()->CAP->current_user_can(
             'ee_edit_event',
@@ -523,8 +523,8 @@ 
                 'post'   => $item->ID(),
             );
             $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $action_links[] = '<a href="' . $edit_link . '"'
-                             . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+            $action_links[] = '<a href="'.$edit_link.'"'
+                             . ' title="'.esc_attr__('Edit Event', 'event_espresso').'">'
                              . '<div class="ee-icon ee-icon-calendar-edit"></div>'
                              . '</a>';
         }
@@ -543,8 +543,8 @@ 
                 'event_id' => $item->ID(),
             );
             $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $action_links[] = '<a href="' . $attendees_link . '"'
-                             . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
+            $action_links[] = '<a href="'.$attendees_link.'"'
+                             . ' title="'.esc_attr__('View Registrants', 'event_espresso').'">'
                              . '<div class="dashicons dashicons-groups"></div>'
                              . '</a>';
         }

core/EE_Capabilities.core.php

Indentation +1368 added lines, -1368 removed lines

@@ -18,980 +18,980 @@ 
 final class EE_Capabilities extends EE_Base
 {
 
-    /**
-     * the name of the wp option used to store caps previously initialized
-     */
-    const option_name = 'ee_caps_initialized';
-
-    /**
-     * instance of EE_Capabilities object
-     *
-     * @var EE_Capabilities
-     */
-    private static $_instance;
-
-
-    /**
-     * This is a map of caps that correspond to a default WP_Role.
-     * Array is indexed by Role and values are ee capabilities.
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    private $capabilities_map = array();
-
-    /**
-     * This used to hold an array of EE_Meta_Capability_Map objects
-     * that define the granular capabilities mapped to for a user depending on context.
-     *
-     * @var EE_Meta_Capability_Map[]
-     */
-    private $_meta_caps = array();
-
-    /**
-     * The internal $capabilities_map needs to be initialized before it can be used.
-     * This flag tracks whether that has happened or not.
-     * But for this to work, we need three states to indicate:
-     *      initialization has not occurred at all
-     *      initialization has started but is not complete
-     *      initialization is complete
-     * The reason this is needed is because the addCaps() method
-     * normally requires the $capabilities_map to be initialized,
-     * but is also used during the initialization process.
-     * So:
-     *      If initialized === null, init_caps() will be called before any other methods will run.
-     *      If initialized === false, then init_caps() is in the process of running it's logic.
-     *      If initialized === true, then init_caps() has completed the initialization process.
-     *
-     * @var boolean|null $initialized
-     */
-    private $initialized;
-
-    /**
-     * @var boolean $reset
-     */
-    private $reset = false;
-
-
-
-    /**
-     * singleton method used to instantiate class object
-     *
-     * @since 4.5.0
-     *
-     * @return EE_Capabilities
-     */
-    public static function instance()
-    {
-        //check if instantiated, and if not do so.
-        if (! self::$_instance instanceof EE_Capabilities) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * private constructor
-     *
-     * @since 4.5.0
-     */
-    private function __construct()
-    {
-    }
-
-
-
-    /**
-     * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
-     *
-     * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
-     *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
-     *                    ensures that they are up to date.
-     *
-     * @since 4.5.0
-     * @return bool
-     * @throws EE_Error
-     */
-    public function init_caps($reset = false)
-    {
-        if(! EE_Maintenance_Mode::instance()->models_can_query()){
-            return false;
-        }
-        $this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN);
-        // if reset, then completely delete the cache option and clear the $capabilities_map property.
-        if ($this->reset) {
-            $this->initialized = null;
-            $this->capabilities_map = array();
-            delete_option(self::option_name);
-        }
-        if ($this->initialized === null) {
-            $this->initialized = false;
-            do_action(
-                'AHEE__EE_Capabilities__init_caps__before_initialization',
-                $this->reset
-            );
-            $this->addCaps($this->_init_caps_map());
-            $this->_set_meta_caps();
-            do_action(
-                'AHEE__EE_Capabilities__init_caps__after_initialization',
-                $this->capabilities_map
-            );
-            $this->initialized = true;
-        }
-        // reset $this->reset so that it's not stuck on true if init_caps() gets called again
-        $this->reset = false;
-        return true;
-    }
-
-
-
-    /**
-     * This sets the meta caps property.
-     *
-     * @since 4.5.0
-     * @return void
-     * @throws EE_Error
-     */
-    private function _set_meta_caps()
-    {
-        // get default meta caps and filter the returned array
-        $this->_meta_caps = apply_filters(
-            'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
-            $this->_get_default_meta_caps_array()
-        );
-        //add filter for map_meta_caps but only if models can query.
-        if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
-            add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
-        }
-    }
-
-
-
-    /**
-     * This builds and returns the default meta_caps array only once.
-     *
-     * @since  4.8.28.rc.012
-     * @return array
-     * @throws EE_Error
-     */
-    private function _get_default_meta_caps_array()
-    {
-        static $default_meta_caps = array();
-        // make sure we're only ever initializing the default _meta_caps array once if it's empty.
-        if (empty($default_meta_caps)) {
-            $default_meta_caps = array(
-                //edits
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_event',
-                    array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_venue',
-                    array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_registration',
-                    array('Registration', '', 'ee_edit_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_checkin',
-                    array('Registration', '', 'ee_edit_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_edit_message',
-                    array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_default_ticket',
-                    array('Ticket', '', 'ee_edit_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question',
-                    array('Question', '', '', 'ee_edit_system_questions')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question_group',
-                    array('Question_Group', '', '', 'ee_edit_system_question_groups')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_payment_method',
-                    array('Payment_Method', '', 'ee_edit_others_payment_methods', '')
-                ),
-                //reads
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_event',
-                    array('Event', '', 'ee_read_others_events', 'ee_read_private_events')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_venue',
-                    array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_registration',
-                    array('Registration', '', 'ee_read_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_checkin',
-                    array('Registration', '', 'ee_read_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_read_message',
-                    array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_default_ticket',
-                    array('Ticket', '', 'ee_read_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_payment_method',
-                    array('Payment_Method', '', 'ee_read_others_payment_methods', '')
-                ),
-                //deletes
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_event',
-                    array(
-                        'Event',
-                        'ee_delete_published_events',
-                        'ee_delete_others_events',
-                        'ee_delete_private_events',
-                    )
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_venue',
-                    array(
-                        'Venue',
-                        'ee_delete_published_venues',
-                        'ee_delete_others_venues',
-                        'ee_delete_private_venues',
-                    )
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_registration',
-                    array('Registration', '', 'ee_delete_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_checkin',
-                    array('Registration', '', 'ee_delete_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_delete_message',
-                    array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_default_ticket',
-                    array('Ticket', '', 'ee_delete_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question',
-                    array('Question', '', '', 'delete_system_questions')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question_group',
-                    array('Question_Group', '', '', 'delete_system_question_groups')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_payment_method',
-                    array('Payment_Method', '', 'ee_delete_others_payment_methods', '')
-                ),
-            );
-        }
-        return $default_meta_caps;
-    }
-
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array actual users capabilities
-     * @throws EE_Error
-     */
-    public function map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
-            //loop through our _meta_caps array
-            foreach ($this->_meta_caps as $meta_map) {
-                if (! $meta_map instanceof EE_Meta_Capability_Map) {
-                    continue;
-                }
-                // don't load models if there is no object ID in the args
-                if (! empty($args[0])) {
-                    $meta_map->ensure_is_model();
-                }
-                $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
-            }
-        }
-        return $caps;
-    }
-
-
-
-    /**
-     * This sets up and returns the initial capabilities map for Event Espresso
-     * Note this array is filtered.
-     * It is assumed that all available EE capabilities are assigned to the administrator role.
-     *
-     * @since 4.5.0
-     *
-     * @return array
-     */
-    private function _init_caps_map()
-    {
-        return apply_filters(
-            'FHEE__EE_Capabilities__init_caps_map__caps',
-            array(
-                'administrator'           => array(
-                    //basic access
-                    'ee_read_ee',
-                    //gateways
-                    /**
-                     * note that with payment method capabilities, although we've implemented
-                     * capability mapping which will be used for accessing payment methods owned by
-                     * other users.  This is not fully implemented yet in the payment method ui.
-                     * Currently only the "plural" caps are in active use.
-                     * (Specific payment method caps are in use as well).
-                     **/
-                    'ee_manage_gateways',
-                    'ee_read_payment_methods',
-                    'ee_read_others_payment_methods',
-                    'ee_edit_payment_methods',
-                    'ee_edit_others_payment_methods',
-                    'ee_delete_payment_methods',
-                    //events
-                    'ee_publish_events',
-                    'ee_read_private_events',
-                    'ee_read_others_events',
-                    'ee_read_events',
-                    'ee_edit_events',
-                    'ee_edit_published_events',
-                    'ee_edit_others_events',
-                    'ee_edit_private_events',
-                    'ee_delete_published_events',
-                    'ee_delete_private_events',
-                    'ee_delete_events',
-                    'ee_delete_others_events',
-                    //event categories
-                    'ee_manage_event_categories',
-                    'ee_edit_event_category',
-                    'ee_delete_event_category',
-                    'ee_assign_event_category',
-                    //venues
-                    'ee_publish_venues',
-                    'ee_read_venues',
-                    'ee_read_others_venues',
-                    'ee_read_private_venues',
-                    'ee_edit_venues',
-                    'ee_edit_others_venues',
-                    'ee_edit_published_venues',
-                    'ee_edit_private_venues',
-                    'ee_delete_venues',
-                    'ee_delete_others_venues',
-                    'ee_delete_private_venues',
-                    'ee_delete_published_venues',
-                    //venue categories
-                    'ee_manage_venue_categories',
-                    'ee_edit_venue_category',
-                    'ee_delete_venue_category',
-                    'ee_assign_venue_category',
-                    //contacts
-                    'ee_read_contacts',
-                    'ee_edit_contacts',
-                    'ee_delete_contacts',
-                    //registrations
-                    'ee_read_registrations',
-                    'ee_read_others_registrations',
-                    'ee_edit_registrations',
-                    'ee_edit_others_registrations',
-                    'ee_delete_registrations',
-                    //checkins
-                    'ee_read_others_checkins',
-                    'ee_read_checkins',
-                    'ee_edit_checkins',
-                    'ee_edit_others_checkins',
-                    'ee_delete_checkins',
-                    'ee_delete_others_checkins',
-                    //transactions && payments
-                    'ee_read_transaction',
-                    'ee_read_transactions',
-                    'ee_edit_payments',
-                    'ee_delete_payments',
-                    //messages
-                    'ee_read_messages',
-                    'ee_read_others_messages',
-                    'ee_read_global_messages',
-                    'ee_edit_global_messages',
-                    'ee_edit_messages',
-                    'ee_edit_others_messages',
-                    'ee_delete_messages',
-                    'ee_delete_others_messages',
-                    'ee_delete_global_messages',
-                    'ee_send_message',
-                    //tickets
-                    'ee_read_default_tickets',
-                    'ee_read_others_default_tickets',
-                    'ee_edit_default_tickets',
-                    'ee_edit_others_default_tickets',
-                    'ee_delete_default_tickets',
-                    'ee_delete_others_default_tickets',
-                    //prices
-                    'ee_edit_default_price',
-                    'ee_edit_default_prices',
-                    'ee_delete_default_price',
-                    'ee_delete_default_prices',
-                    'ee_edit_default_price_type',
-                    'ee_edit_default_price_types',
-                    'ee_delete_default_price_type',
-                    'ee_delete_default_price_types',
-                    'ee_read_default_prices',
-                    'ee_read_default_price_types',
-                    //registration form
-                    'ee_edit_questions',
-                    'ee_edit_system_questions',
-                    'ee_read_questions',
-                    'ee_delete_questions',
-                    'ee_edit_question_groups',
-                    'ee_read_question_groups',
-                    'ee_edit_system_question_groups',
-                    'ee_delete_question_groups',
-                    //event_type taxonomy
-                    'ee_assign_event_type',
-                    'ee_manage_event_types',
-                    'ee_edit_event_type',
-                    'ee_delete_event_type',
-                ),
-                'ee_events_administrator' => array(
-                    //core wp caps
-                    'read',
-                    'read_private_pages',
-                    'read_private_posts',
-                    'edit_users',
-                    'edit_posts',
-                    'edit_pages',
-                    'edit_published_posts',
-                    'edit_published_pages',
-                    'edit_private_pages',
-                    'edit_private_posts',
-                    'edit_others_posts',
-                    'edit_others_pages',
-                    'publish_posts',
-                    'publish_pages',
-                    'delete_posts',
-                    'delete_pages',
-                    'delete_private_pages',
-                    'delete_private_posts',
-                    'delete_published_pages',
-                    'delete_published_posts',
-                    'delete_others_posts',
-                    'delete_others_pages',
-                    'manage_categories',
-                    'manage_links',
-                    'moderate_comments',
-                    'unfiltered_html',
-                    'upload_files',
-                    'export',
-                    'import',
-                    'list_users',
-                    'level_1', //required if user with this role shows up in author dropdowns
-                    //basic ee access
-                    'ee_read_ee',
-                    //events
-                    'ee_publish_events',
-                    'ee_read_private_events',
-                    'ee_read_others_events',
-                    'ee_read_event',
-                    'ee_read_events',
-                    'ee_edit_event',
-                    'ee_edit_events',
-                    'ee_edit_published_events',
-                    'ee_edit_others_events',
-                    'ee_edit_private_events',
-                    'ee_delete_published_events',
-                    'ee_delete_private_events',
-                    'ee_delete_event',
-                    'ee_delete_events',
-                    'ee_delete_others_events',
-                    //event categories
-                    'ee_manage_event_categories',
-                    'ee_edit_event_category',
-                    'ee_delete_event_category',
-                    'ee_assign_event_category',
-                    //venues
-                    'ee_publish_venues',
-                    'ee_read_venue',
-                    'ee_read_venues',
-                    'ee_read_others_venues',
-                    'ee_read_private_venues',
-                    'ee_edit_venue',
-                    'ee_edit_venues',
-                    'ee_edit_others_venues',
-                    'ee_edit_published_venues',
-                    'ee_edit_private_venues',
-                    'ee_delete_venue',
-                    'ee_delete_venues',
-                    'ee_delete_others_venues',
-                    'ee_delete_private_venues',
-                    'ee_delete_published_venues',
-                    //venue categories
-                    'ee_manage_venue_categories',
-                    'ee_edit_venue_category',
-                    'ee_delete_venue_category',
-                    'ee_assign_venue_category',
-                    //contacts
-                    'ee_read_contacts',
-                    'ee_edit_contacts',
-                    'ee_delete_contacts',
-                    //registrations
-                    'ee_read_registrations',
-                    'ee_read_others_registrations',
-                    'ee_edit_registration',
-                    'ee_edit_registrations',
-                    'ee_edit_others_registrations',
-                    'ee_delete_registration',
-                    'ee_delete_registrations',
-                    //checkins
-                    'ee_read_others_checkins',
-                    'ee_read_checkins',
-                    'ee_edit_checkins',
-                    'ee_edit_others_checkins',
-                    'ee_delete_checkins',
-                    'ee_delete_others_checkins',
-                    //transactions && payments
-                    'ee_read_transaction',
-                    'ee_read_transactions',
-                    'ee_edit_payments',
-                    'ee_delete_payments',
-                    //messages
-                    'ee_read_messages',
-                    'ee_read_others_messages',
-                    'ee_read_global_messages',
-                    'ee_edit_global_messages',
-                    'ee_edit_messages',
-                    'ee_edit_others_messages',
-                    'ee_delete_messages',
-                    'ee_delete_others_messages',
-                    'ee_delete_global_messages',
-                    'ee_send_message',
-                    //tickets
-                    'ee_read_default_tickets',
-                    'ee_read_others_default_tickets',
-                    'ee_edit_default_tickets',
-                    'ee_edit_others_default_tickets',
-                    'ee_delete_default_tickets',
-                    'ee_delete_others_default_tickets',
-                    //prices
-                    'ee_edit_default_price',
-                    'ee_edit_default_prices',
-                    'ee_delete_default_price',
-                    'ee_delete_default_prices',
-                    'ee_edit_default_price_type',
-                    'ee_edit_default_price_types',
-                    'ee_delete_default_price_type',
-                    'ee_delete_default_price_types',
-                    'ee_read_default_prices',
-                    'ee_read_default_price_types',
-                    //registration form
-                    'ee_edit_questions',
-                    'ee_edit_system_questions',
-                    'ee_read_questions',
-                    'ee_delete_questions',
-                    'ee_edit_question_groups',
-                    'ee_read_question_groups',
-                    'ee_edit_system_question_groups',
-                    'ee_delete_question_groups',
-                    //event_type taxonomy
-                    'ee_assign_event_type',
-                    'ee_manage_event_types',
-                    'ee_edit_event_type',
-                    'ee_delete_event_type',
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    private function setupCapabilitiesMap()
-    {
-        // if the initialization process hasn't even started, then we need to call init_caps()
-        if($this->initialized === null) {
-            return $this->init_caps();
-        }
-        // unless resetting, get caps from db if we haven't already
-        $this->capabilities_map = $this->reset || ! empty($this->capabilities_map)
-            ? $this->capabilities_map
-            : get_option(self::option_name, array());
-        return true;
-    }
-
-
-
-    /**
-     * @param bool $update
-     * @return bool
-     */
-    private function updateCapabilitiesMap($update = true)
-    {
-        return $update ? update_option(self::option_name, $this->capabilities_map) : false;
-    }
-
-
-
-    /**
-     * Adds capabilities to roles.
-     *
-     * @since 4.9.42
-     * @param array $capabilities_to_add array of capabilities to add, indexed by roles.
-     *                                   Note that this should ONLY be called on activation hook
-     *                                   otherwise the caps will be added on every request.
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function addCaps(array $capabilities_to_add)
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-        // and filter the array so others can get in on the fun during resets
-        $capabilities_to_add = apply_filters(
-            'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-            $capabilities_to_add,
-            $this->reset,
-            $this->capabilities_map
-        );
-        $update_capabilities_map = false;
-        // if not reset, see what caps are new for each role. if they're new, add them.
-        foreach ($capabilities_to_add as $role => $caps_for_role) {
-            if (is_array($caps_for_role)) {
-                foreach ($caps_for_role as $cap) {
-                    if (
-                        ! $this->capHasBeenAddedToRole($role, $cap)
-                        && $this->add_cap_to_role($role, $cap, true, false)
-                    ) {
-                        $update_capabilities_map = true;
-                    }
-                }
-            }
-        }
-        // now let's just save the cap that has been set but only if there's been a change.
-        $updated = $this->updateCapabilitiesMap($update_capabilities_map);
-        do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated);
-        return $updated;
-    }
-
-
-
-    /**
-     * Loops through the capabilities map and removes the role caps specified by the incoming array
-     *
-     * @param array $caps_map map of capabilities to be removed (indexed by roles)
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function removeCaps($caps_map)
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-        $update_capabilities_map = false;
-        foreach ($caps_map as $role => $caps_for_role) {
-            if (is_array($caps_for_role)) {
-                foreach ($caps_for_role as $cap) {
-                    if (
-                        $this->capHasBeenAddedToRole($role, $cap)
-                        && $this->remove_cap_from_role($role, $cap, false)
-                    ) {
-                        $update_capabilities_map = true;
-                    }
-                }
-            }
-        }
-        // maybe resave the caps
-        return $this->updateCapabilitiesMap($update_capabilities_map);
-    }
-
-
-
-    /**
-     * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
-     * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
-     * this is a wrapper for $wp_role->add_cap()
-     *
-     * @see   wp-includes/capabilities.php
-     * @since 4.5.0
-     * @param string|WP_Role $role  A WordPress role the capability is being added to
-     * @param string         $cap   The capability being added to the role
-     * @param bool           $grant Whether to grant access to this cap on this role.
-     * @param bool           $update_capabilities_map
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function add_cap_to_role($role, $cap, $grant = true, $update_capabilities_map = true)
-    {
-        // capture incoming value for $role because we may need it to create a new WP_Role
-        $orig_role = $role;
-        $role = $role instanceof WP_Role ? $role : get_role($role);
-        //if the role isn't available then we create it.
-        if (! $role instanceof WP_Role) {
-            // if a plugin wants to create a specific role name then they should create the role before
-            // EE_Capabilities does.  Otherwise this function will create the role name from the slug:
-            // - removes any `ee_` namespacing from the start of the slug.
-            // - replaces `_` with ` ` (empty space).
-            // - sentence case on the resulting string.
-            $role_label = ucwords(str_replace(array('ee_', '_'), array('', ' '), $orig_role));
-            $role = add_role($orig_role, $role_label);
-        }
-        if ($role instanceof WP_Role) {
-            // don't do anything if the capabilities map can not be initialized
-            if (! $this->setupCapabilitiesMap()) {
-                return false;
-            }
-            if (! $this->capHasBeenAddedToRole($role->name, $cap)) {
-                $role->add_cap($cap, $grant);
-                $this->capabilities_map[ $role->name ][] = $cap;
-                $this->updateCapabilitiesMap($update_capabilities_map);
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Functions similarly to add_cap_to_role except removes cap from given role.
-     * Wrapper for $wp_role->remove_cap()
-     *
-     * @see   wp-includes/capabilities.php
-     * @since 4.5.0
-     * @param string|WP_Role $role A WordPress role the capability is being removed from.
-     * @param string         $cap  The capability being removed
-     * @param bool           $update_capabilities_map
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function remove_cap_from_role($role, $cap, $update_capabilities_map = true)
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-        $role = $role instanceof WP_Role ? $role :get_role($role);
-        if ($index = $this->capHasBeenAddedToRole($role->name, $cap, true)) {
-            $role->remove_cap($cap);
-            unset($this->capabilities_map[ $role->name ][ $index ]);
-            $this->updateCapabilitiesMap($update_capabilities_map);
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param string $role_name
-     * @param string $cap
-     * @param bool   $get_index
-     * @return bool|mixed
-     */
-    private function capHasBeenAddedToRole($role_name='', $cap='', $get_index = false)
-    {
-        if (
-            isset($this->capabilities_map[$role_name])
-            && ($index = array_search($cap, $this->capabilities_map[$role_name], true)) !== false
-        ) {
-            return $get_index ? $index : true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Wrapper for the native WP current_user_can() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @since 4.5.0
-     *
-     * @param string $cap     The cap being checked.
-     * @param string $context The context where the current_user_can is being called from.
-     * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
-     *                        filters.
-     *
-     * @return bool  Whether user can or not.
-     */
-    public function current_user_can($cap, $context, $id = 0)
-    {
-        //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
-        $filtered_cap = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can__cap',
-            $filtered_cap,
-            $context,
-            $cap,
-            $id
-        );
-        return ! empty($id)
-            ? current_user_can($filtered_cap, $id)
-            : current_user_can($filtered_cap);
-    }
-
-
-
-    /**
-     * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
-     *
-     * @param int|WP_User $user    Either the user_id or a WP_User object
-     * @param string      $cap     The capability string being checked
-     * @param string      $context The context where the user_can is being called from (used in filters).
-     * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
-     *                             filters)
-     *
-     * @return bool Whether user can or not.
-     */
-    public function user_can($user, $cap, $context, $id = 0)
-    {
-        //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
-        $filtered_cap = apply_filters(
-            'FHEE__EE_Capabilities__user_can__cap',
-            $filtered_cap,
-            $context,
-            $cap,
-            $user,
-            $id
-        );
-        return ! empty($id)
-            ? user_can($user, $filtered_cap, $id)
-            : user_can($user, $filtered_cap);
-    }
-
-
-
-    /**
-     * Wrapper for the native WP current_user_can_for_blog() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @since 4.5.0
-     *
-     * @param int    $blog_id The blog id that is being checked for.
-     * @param string $cap     The cap being checked.
-     * @param string $context The context where the current_user_can is being called from.
-     * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
-     *                        filters.
-     *
-     * @return bool  Whether user can or not.
-     */
-    public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0)
-    {
-        $user_can = ! empty($id)
-            ? current_user_can_for_blog($blog_id, $cap, $id)
-            : current_user_can($blog_id, $cap);
-        //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
-            $user_can,
-            $blog_id,
-            $cap,
-            $id
-        );
-        $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
-            $user_can,
-            $context,
-            $blog_id,
-            $cap,
-            $id
-        );
-        return $user_can;
-    }
-
-
-
-    /**
-     * This helper method just returns an array of registered EE capabilities.
-     *
-     * @since 4.5.0
-     * @param string $role If empty then the entire role/capability map is returned.
-     *                     Otherwise just the capabilities for the given role are returned.
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_ee_capabilities($role = 'administrator')
-    {
-        if (! $this->initialized) {
-            $this->init_caps();
-        }
-        if (empty($role)) {
-            return $this->capabilities_map;
-        }
-        return isset($this->capabilities_map[ $role ])
-            ? $this->capabilities_map[ $role ]
-            : array();
-    }
-
-
-
-    /**
-     * @deprecated 4.9.42
-     * @param bool  $reset      If you need to reset Event Espresso's capabilities,
-     *                          then please use the init_caps() method with the "$reset" parameter set to "true"
-     * @param array $caps_map   Optional.
-     *                          Can be used to send a custom map of roles and capabilities for setting them up.
-     *                          Note that this should ONLY be called on activation hook or some other one-time
-     *                          task otherwise the caps will be added on every request.
-     * @return void
-     * @throws EE_Error
-     */
-    public function init_role_caps($reset = false, $caps_map = array())
-    {
-        // If this method is called directly and reset is set as 'true',
-        // then display a doing it wrong notice, because we want resets to go through init_caps()
-        // to guarantee that everything is set up correctly.
-        // This prevents the capabilities map getting reset incorrectly by direct calls to this method.
-        if ($reset) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".',
-                        'event_espresso'
-                    ),
-                    '$reset',
-                    __METHOD__ . '()',
-                    'EE_Capabilities::init_caps()',
-                    'true'
-                ),
-                '4.9.42',
-                '5.0.0'
-            );
-        }
-        $this->addCaps($caps_map);
-    }
+	/**
+	 * the name of the wp option used to store caps previously initialized
+	 */
+	const option_name = 'ee_caps_initialized';
+
+	/**
+	 * instance of EE_Capabilities object
+	 *
+	 * @var EE_Capabilities
+	 */
+	private static $_instance;
+
+
+	/**
+	 * This is a map of caps that correspond to a default WP_Role.
+	 * Array is indexed by Role and values are ee capabilities.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	private $capabilities_map = array();
+
+	/**
+	 * This used to hold an array of EE_Meta_Capability_Map objects
+	 * that define the granular capabilities mapped to for a user depending on context.
+	 *
+	 * @var EE_Meta_Capability_Map[]
+	 */
+	private $_meta_caps = array();
+
+	/**
+	 * The internal $capabilities_map needs to be initialized before it can be used.
+	 * This flag tracks whether that has happened or not.
+	 * But for this to work, we need three states to indicate:
+	 *      initialization has not occurred at all
+	 *      initialization has started but is not complete
+	 *      initialization is complete
+	 * The reason this is needed is because the addCaps() method
+	 * normally requires the $capabilities_map to be initialized,
+	 * but is also used during the initialization process.
+	 * So:
+	 *      If initialized === null, init_caps() will be called before any other methods will run.
+	 *      If initialized === false, then init_caps() is in the process of running it's logic.
+	 *      If initialized === true, then init_caps() has completed the initialization process.
+	 *
+	 * @var boolean|null $initialized
+	 */
+	private $initialized;
+
+	/**
+	 * @var boolean $reset
+	 */
+	private $reset = false;
+
+
+
+	/**
+	 * singleton method used to instantiate class object
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return EE_Capabilities
+	 */
+	public static function instance()
+	{
+		//check if instantiated, and if not do so.
+		if (! self::$_instance instanceof EE_Capabilities) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * private constructor
+	 *
+	 * @since 4.5.0
+	 */
+	private function __construct()
+	{
+	}
+
+
+
+	/**
+	 * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
+	 *
+	 * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
+	 *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
+	 *                    ensures that they are up to date.
+	 *
+	 * @since 4.5.0
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function init_caps($reset = false)
+	{
+		if(! EE_Maintenance_Mode::instance()->models_can_query()){
+			return false;
+		}
+		$this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN);
+		// if reset, then completely delete the cache option and clear the $capabilities_map property.
+		if ($this->reset) {
+			$this->initialized = null;
+			$this->capabilities_map = array();
+			delete_option(self::option_name);
+		}
+		if ($this->initialized === null) {
+			$this->initialized = false;
+			do_action(
+				'AHEE__EE_Capabilities__init_caps__before_initialization',
+				$this->reset
+			);
+			$this->addCaps($this->_init_caps_map());
+			$this->_set_meta_caps();
+			do_action(
+				'AHEE__EE_Capabilities__init_caps__after_initialization',
+				$this->capabilities_map
+			);
+			$this->initialized = true;
+		}
+		// reset $this->reset so that it's not stuck on true if init_caps() gets called again
+		$this->reset = false;
+		return true;
+	}
+
+
+
+	/**
+	 * This sets the meta caps property.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _set_meta_caps()
+	{
+		// get default meta caps and filter the returned array
+		$this->_meta_caps = apply_filters(
+			'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
+			$this->_get_default_meta_caps_array()
+		);
+		//add filter for map_meta_caps but only if models can query.
+		if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
+			add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
+		}
+	}
+
+
+
+	/**
+	 * This builds and returns the default meta_caps array only once.
+	 *
+	 * @since  4.8.28.rc.012
+	 * @return array
+	 * @throws EE_Error
+	 */
+	private function _get_default_meta_caps_array()
+	{
+		static $default_meta_caps = array();
+		// make sure we're only ever initializing the default _meta_caps array once if it's empty.
+		if (empty($default_meta_caps)) {
+			$default_meta_caps = array(
+				//edits
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_event',
+					array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_venue',
+					array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_registration',
+					array('Registration', '', 'ee_edit_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_checkin',
+					array('Registration', '', 'ee_edit_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_edit_message',
+					array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_default_ticket',
+					array('Ticket', '', 'ee_edit_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question',
+					array('Question', '', '', 'ee_edit_system_questions')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question_group',
+					array('Question_Group', '', '', 'ee_edit_system_question_groups')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_payment_method',
+					array('Payment_Method', '', 'ee_edit_others_payment_methods', '')
+				),
+				//reads
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_event',
+					array('Event', '', 'ee_read_others_events', 'ee_read_private_events')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_venue',
+					array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_registration',
+					array('Registration', '', 'ee_read_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_checkin',
+					array('Registration', '', 'ee_read_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_read_message',
+					array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_default_ticket',
+					array('Ticket', '', 'ee_read_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_payment_method',
+					array('Payment_Method', '', 'ee_read_others_payment_methods', '')
+				),
+				//deletes
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_event',
+					array(
+						'Event',
+						'ee_delete_published_events',
+						'ee_delete_others_events',
+						'ee_delete_private_events',
+					)
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_venue',
+					array(
+						'Venue',
+						'ee_delete_published_venues',
+						'ee_delete_others_venues',
+						'ee_delete_private_venues',
+					)
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_registration',
+					array('Registration', '', 'ee_delete_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_checkin',
+					array('Registration', '', 'ee_delete_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_delete_message',
+					array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_default_ticket',
+					array('Ticket', '', 'ee_delete_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question',
+					array('Question', '', '', 'delete_system_questions')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question_group',
+					array('Question_Group', '', '', 'delete_system_question_groups')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_payment_method',
+					array('Payment_Method', '', 'ee_delete_others_payment_methods', '')
+				),
+			);
+		}
+		return $default_meta_caps;
+	}
+
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array actual users capabilities
+	 * @throws EE_Error
+	 */
+	public function map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
+			//loop through our _meta_caps array
+			foreach ($this->_meta_caps as $meta_map) {
+				if (! $meta_map instanceof EE_Meta_Capability_Map) {
+					continue;
+				}
+				// don't load models if there is no object ID in the args
+				if (! empty($args[0])) {
+					$meta_map->ensure_is_model();
+				}
+				$caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
+			}
+		}
+		return $caps;
+	}
+
+
+
+	/**
+	 * This sets up and returns the initial capabilities map for Event Espresso
+	 * Note this array is filtered.
+	 * It is assumed that all available EE capabilities are assigned to the administrator role.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return array
+	 */
+	private function _init_caps_map()
+	{
+		return apply_filters(
+			'FHEE__EE_Capabilities__init_caps_map__caps',
+			array(
+				'administrator'           => array(
+					//basic access
+					'ee_read_ee',
+					//gateways
+					/**
+					 * note that with payment method capabilities, although we've implemented
+					 * capability mapping which will be used for accessing payment methods owned by
+					 * other users.  This is not fully implemented yet in the payment method ui.
+					 * Currently only the "plural" caps are in active use.
+					 * (Specific payment method caps are in use as well).
+					 **/
+					'ee_manage_gateways',
+					'ee_read_payment_methods',
+					'ee_read_others_payment_methods',
+					'ee_edit_payment_methods',
+					'ee_edit_others_payment_methods',
+					'ee_delete_payment_methods',
+					//events
+					'ee_publish_events',
+					'ee_read_private_events',
+					'ee_read_others_events',
+					'ee_read_events',
+					'ee_edit_events',
+					'ee_edit_published_events',
+					'ee_edit_others_events',
+					'ee_edit_private_events',
+					'ee_delete_published_events',
+					'ee_delete_private_events',
+					'ee_delete_events',
+					'ee_delete_others_events',
+					//event categories
+					'ee_manage_event_categories',
+					'ee_edit_event_category',
+					'ee_delete_event_category',
+					'ee_assign_event_category',
+					//venues
+					'ee_publish_venues',
+					'ee_read_venues',
+					'ee_read_others_venues',
+					'ee_read_private_venues',
+					'ee_edit_venues',
+					'ee_edit_others_venues',
+					'ee_edit_published_venues',
+					'ee_edit_private_venues',
+					'ee_delete_venues',
+					'ee_delete_others_venues',
+					'ee_delete_private_venues',
+					'ee_delete_published_venues',
+					//venue categories
+					'ee_manage_venue_categories',
+					'ee_edit_venue_category',
+					'ee_delete_venue_category',
+					'ee_assign_venue_category',
+					//contacts
+					'ee_read_contacts',
+					'ee_edit_contacts',
+					'ee_delete_contacts',
+					//registrations
+					'ee_read_registrations',
+					'ee_read_others_registrations',
+					'ee_edit_registrations',
+					'ee_edit_others_registrations',
+					'ee_delete_registrations',
+					//checkins
+					'ee_read_others_checkins',
+					'ee_read_checkins',
+					'ee_edit_checkins',
+					'ee_edit_others_checkins',
+					'ee_delete_checkins',
+					'ee_delete_others_checkins',
+					//transactions && payments
+					'ee_read_transaction',
+					'ee_read_transactions',
+					'ee_edit_payments',
+					'ee_delete_payments',
+					//messages
+					'ee_read_messages',
+					'ee_read_others_messages',
+					'ee_read_global_messages',
+					'ee_edit_global_messages',
+					'ee_edit_messages',
+					'ee_edit_others_messages',
+					'ee_delete_messages',
+					'ee_delete_others_messages',
+					'ee_delete_global_messages',
+					'ee_send_message',
+					//tickets
+					'ee_read_default_tickets',
+					'ee_read_others_default_tickets',
+					'ee_edit_default_tickets',
+					'ee_edit_others_default_tickets',
+					'ee_delete_default_tickets',
+					'ee_delete_others_default_tickets',
+					//prices
+					'ee_edit_default_price',
+					'ee_edit_default_prices',
+					'ee_delete_default_price',
+					'ee_delete_default_prices',
+					'ee_edit_default_price_type',
+					'ee_edit_default_price_types',
+					'ee_delete_default_price_type',
+					'ee_delete_default_price_types',
+					'ee_read_default_prices',
+					'ee_read_default_price_types',
+					//registration form
+					'ee_edit_questions',
+					'ee_edit_system_questions',
+					'ee_read_questions',
+					'ee_delete_questions',
+					'ee_edit_question_groups',
+					'ee_read_question_groups',
+					'ee_edit_system_question_groups',
+					'ee_delete_question_groups',
+					//event_type taxonomy
+					'ee_assign_event_type',
+					'ee_manage_event_types',
+					'ee_edit_event_type',
+					'ee_delete_event_type',
+				),
+				'ee_events_administrator' => array(
+					//core wp caps
+					'read',
+					'read_private_pages',
+					'read_private_posts',
+					'edit_users',
+					'edit_posts',
+					'edit_pages',
+					'edit_published_posts',
+					'edit_published_pages',
+					'edit_private_pages',
+					'edit_private_posts',
+					'edit_others_posts',
+					'edit_others_pages',
+					'publish_posts',
+					'publish_pages',
+					'delete_posts',
+					'delete_pages',
+					'delete_private_pages',
+					'delete_private_posts',
+					'delete_published_pages',
+					'delete_published_posts',
+					'delete_others_posts',
+					'delete_others_pages',
+					'manage_categories',
+					'manage_links',
+					'moderate_comments',
+					'unfiltered_html',
+					'upload_files',
+					'export',
+					'import',
+					'list_users',
+					'level_1', //required if user with this role shows up in author dropdowns
+					//basic ee access
+					'ee_read_ee',
+					//events
+					'ee_publish_events',
+					'ee_read_private_events',
+					'ee_read_others_events',
+					'ee_read_event',
+					'ee_read_events',
+					'ee_edit_event',
+					'ee_edit_events',
+					'ee_edit_published_events',
+					'ee_edit_others_events',
+					'ee_edit_private_events',
+					'ee_delete_published_events',
+					'ee_delete_private_events',
+					'ee_delete_event',
+					'ee_delete_events',
+					'ee_delete_others_events',
+					//event categories
+					'ee_manage_event_categories',
+					'ee_edit_event_category',
+					'ee_delete_event_category',
+					'ee_assign_event_category',
+					//venues
+					'ee_publish_venues',
+					'ee_read_venue',
+					'ee_read_venues',
+					'ee_read_others_venues',
+					'ee_read_private_venues',
+					'ee_edit_venue',
+					'ee_edit_venues',
+					'ee_edit_others_venues',
+					'ee_edit_published_venues',
+					'ee_edit_private_venues',
+					'ee_delete_venue',
+					'ee_delete_venues',
+					'ee_delete_others_venues',
+					'ee_delete_private_venues',
+					'ee_delete_published_venues',
+					//venue categories
+					'ee_manage_venue_categories',
+					'ee_edit_venue_category',
+					'ee_delete_venue_category',
+					'ee_assign_venue_category',
+					//contacts
+					'ee_read_contacts',
+					'ee_edit_contacts',
+					'ee_delete_contacts',
+					//registrations
+					'ee_read_registrations',
+					'ee_read_others_registrations',
+					'ee_edit_registration',
+					'ee_edit_registrations',
+					'ee_edit_others_registrations',
+					'ee_delete_registration',
+					'ee_delete_registrations',
+					//checkins
+					'ee_read_others_checkins',
+					'ee_read_checkins',
+					'ee_edit_checkins',
+					'ee_edit_others_checkins',
+					'ee_delete_checkins',
+					'ee_delete_others_checkins',
+					//transactions && payments
+					'ee_read_transaction',
+					'ee_read_transactions',
+					'ee_edit_payments',
+					'ee_delete_payments',
+					//messages
+					'ee_read_messages',
+					'ee_read_others_messages',
+					'ee_read_global_messages',
+					'ee_edit_global_messages',
+					'ee_edit_messages',
+					'ee_edit_others_messages',
+					'ee_delete_messages',
+					'ee_delete_others_messages',
+					'ee_delete_global_messages',
+					'ee_send_message',
+					//tickets
+					'ee_read_default_tickets',
+					'ee_read_others_default_tickets',
+					'ee_edit_default_tickets',
+					'ee_edit_others_default_tickets',
+					'ee_delete_default_tickets',
+					'ee_delete_others_default_tickets',
+					//prices
+					'ee_edit_default_price',
+					'ee_edit_default_prices',
+					'ee_delete_default_price',
+					'ee_delete_default_prices',
+					'ee_edit_default_price_type',
+					'ee_edit_default_price_types',
+					'ee_delete_default_price_type',
+					'ee_delete_default_price_types',
+					'ee_read_default_prices',
+					'ee_read_default_price_types',
+					//registration form
+					'ee_edit_questions',
+					'ee_edit_system_questions',
+					'ee_read_questions',
+					'ee_delete_questions',
+					'ee_edit_question_groups',
+					'ee_read_question_groups',
+					'ee_edit_system_question_groups',
+					'ee_delete_question_groups',
+					//event_type taxonomy
+					'ee_assign_event_type',
+					'ee_manage_event_types',
+					'ee_edit_event_type',
+					'ee_delete_event_type',
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	private function setupCapabilitiesMap()
+	{
+		// if the initialization process hasn't even started, then we need to call init_caps()
+		if($this->initialized === null) {
+			return $this->init_caps();
+		}
+		// unless resetting, get caps from db if we haven't already
+		$this->capabilities_map = $this->reset || ! empty($this->capabilities_map)
+			? $this->capabilities_map
+			: get_option(self::option_name, array());
+		return true;
+	}
+
+
+
+	/**
+	 * @param bool $update
+	 * @return bool
+	 */
+	private function updateCapabilitiesMap($update = true)
+	{
+		return $update ? update_option(self::option_name, $this->capabilities_map) : false;
+	}
+
+
+
+	/**
+	 * Adds capabilities to roles.
+	 *
+	 * @since 4.9.42
+	 * @param array $capabilities_to_add array of capabilities to add, indexed by roles.
+	 *                                   Note that this should ONLY be called on activation hook
+	 *                                   otherwise the caps will be added on every request.
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function addCaps(array $capabilities_to_add)
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+		// and filter the array so others can get in on the fun during resets
+		$capabilities_to_add = apply_filters(
+			'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+			$capabilities_to_add,
+			$this->reset,
+			$this->capabilities_map
+		);
+		$update_capabilities_map = false;
+		// if not reset, see what caps are new for each role. if they're new, add them.
+		foreach ($capabilities_to_add as $role => $caps_for_role) {
+			if (is_array($caps_for_role)) {
+				foreach ($caps_for_role as $cap) {
+					if (
+						! $this->capHasBeenAddedToRole($role, $cap)
+						&& $this->add_cap_to_role($role, $cap, true, false)
+					) {
+						$update_capabilities_map = true;
+					}
+				}
+			}
+		}
+		// now let's just save the cap that has been set but only if there's been a change.
+		$updated = $this->updateCapabilitiesMap($update_capabilities_map);
+		do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated);
+		return $updated;
+	}
+
+
+
+	/**
+	 * Loops through the capabilities map and removes the role caps specified by the incoming array
+	 *
+	 * @param array $caps_map map of capabilities to be removed (indexed by roles)
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function removeCaps($caps_map)
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+		$update_capabilities_map = false;
+		foreach ($caps_map as $role => $caps_for_role) {
+			if (is_array($caps_for_role)) {
+				foreach ($caps_for_role as $cap) {
+					if (
+						$this->capHasBeenAddedToRole($role, $cap)
+						&& $this->remove_cap_from_role($role, $cap, false)
+					) {
+						$update_capabilities_map = true;
+					}
+				}
+			}
+		}
+		// maybe resave the caps
+		return $this->updateCapabilitiesMap($update_capabilities_map);
+	}
+
+
+
+	/**
+	 * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
+	 * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
+	 * this is a wrapper for $wp_role->add_cap()
+	 *
+	 * @see   wp-includes/capabilities.php
+	 * @since 4.5.0
+	 * @param string|WP_Role $role  A WordPress role the capability is being added to
+	 * @param string         $cap   The capability being added to the role
+	 * @param bool           $grant Whether to grant access to this cap on this role.
+	 * @param bool           $update_capabilities_map
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function add_cap_to_role($role, $cap, $grant = true, $update_capabilities_map = true)
+	{
+		// capture incoming value for $role because we may need it to create a new WP_Role
+		$orig_role = $role;
+		$role = $role instanceof WP_Role ? $role : get_role($role);
+		//if the role isn't available then we create it.
+		if (! $role instanceof WP_Role) {
+			// if a plugin wants to create a specific role name then they should create the role before
+			// EE_Capabilities does.  Otherwise this function will create the role name from the slug:
+			// - removes any `ee_` namespacing from the start of the slug.
+			// - replaces `_` with ` ` (empty space).
+			// - sentence case on the resulting string.
+			$role_label = ucwords(str_replace(array('ee_', '_'), array('', ' '), $orig_role));
+			$role = add_role($orig_role, $role_label);
+		}
+		if ($role instanceof WP_Role) {
+			// don't do anything if the capabilities map can not be initialized
+			if (! $this->setupCapabilitiesMap()) {
+				return false;
+			}
+			if (! $this->capHasBeenAddedToRole($role->name, $cap)) {
+				$role->add_cap($cap, $grant);
+				$this->capabilities_map[ $role->name ][] = $cap;
+				$this->updateCapabilitiesMap($update_capabilities_map);
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Functions similarly to add_cap_to_role except removes cap from given role.
+	 * Wrapper for $wp_role->remove_cap()
+	 *
+	 * @see   wp-includes/capabilities.php
+	 * @since 4.5.0
+	 * @param string|WP_Role $role A WordPress role the capability is being removed from.
+	 * @param string         $cap  The capability being removed
+	 * @param bool           $update_capabilities_map
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function remove_cap_from_role($role, $cap, $update_capabilities_map = true)
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+		$role = $role instanceof WP_Role ? $role :get_role($role);
+		if ($index = $this->capHasBeenAddedToRole($role->name, $cap, true)) {
+			$role->remove_cap($cap);
+			unset($this->capabilities_map[ $role->name ][ $index ]);
+			$this->updateCapabilitiesMap($update_capabilities_map);
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param string $role_name
+	 * @param string $cap
+	 * @param bool   $get_index
+	 * @return bool|mixed
+	 */
+	private function capHasBeenAddedToRole($role_name='', $cap='', $get_index = false)
+	{
+		if (
+			isset($this->capabilities_map[$role_name])
+			&& ($index = array_search($cap, $this->capabilities_map[$role_name], true)) !== false
+		) {
+			return $get_index ? $index : true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Wrapper for the native WP current_user_can() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $cap     The cap being checked.
+	 * @param string $context The context where the current_user_can is being called from.
+	 * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
+	 *                        filters.
+	 *
+	 * @return bool  Whether user can or not.
+	 */
+	public function current_user_can($cap, $context, $id = 0)
+	{
+		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
+		$filtered_cap = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can__cap',
+			$filtered_cap,
+			$context,
+			$cap,
+			$id
+		);
+		return ! empty($id)
+			? current_user_can($filtered_cap, $id)
+			: current_user_can($filtered_cap);
+	}
+
+
+
+	/**
+	 * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
+	 *
+	 * @param int|WP_User $user    Either the user_id or a WP_User object
+	 * @param string      $cap     The capability string being checked
+	 * @param string      $context The context where the user_can is being called from (used in filters).
+	 * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
+	 *                             filters)
+	 *
+	 * @return bool Whether user can or not.
+	 */
+	public function user_can($user, $cap, $context, $id = 0)
+	{
+		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
+		$filtered_cap = apply_filters(
+			'FHEE__EE_Capabilities__user_can__cap',
+			$filtered_cap,
+			$context,
+			$cap,
+			$user,
+			$id
+		);
+		return ! empty($id)
+			? user_can($user, $filtered_cap, $id)
+			: user_can($user, $filtered_cap);
+	}
+
+
+
+	/**
+	 * Wrapper for the native WP current_user_can_for_blog() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param int    $blog_id The blog id that is being checked for.
+	 * @param string $cap     The cap being checked.
+	 * @param string $context The context where the current_user_can is being called from.
+	 * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
+	 *                        filters.
+	 *
+	 * @return bool  Whether user can or not.
+	 */
+	public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0)
+	{
+		$user_can = ! empty($id)
+			? current_user_can_for_blog($blog_id, $cap, $id)
+			: current_user_can($blog_id, $cap);
+		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$user_can = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
+			$user_can,
+			$blog_id,
+			$cap,
+			$id
+		);
+		$user_can = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
+			$user_can,
+			$context,
+			$blog_id,
+			$cap,
+			$id
+		);
+		return $user_can;
+	}
+
+
+
+	/**
+	 * This helper method just returns an array of registered EE capabilities.
+	 *
+	 * @since 4.5.0
+	 * @param string $role If empty then the entire role/capability map is returned.
+	 *                     Otherwise just the capabilities for the given role are returned.
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_ee_capabilities($role = 'administrator')
+	{
+		if (! $this->initialized) {
+			$this->init_caps();
+		}
+		if (empty($role)) {
+			return $this->capabilities_map;
+		}
+		return isset($this->capabilities_map[ $role ])
+			? $this->capabilities_map[ $role ]
+			: array();
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.42
+	 * @param bool  $reset      If you need to reset Event Espresso's capabilities,
+	 *                          then please use the init_caps() method with the "$reset" parameter set to "true"
+	 * @param array $caps_map   Optional.
+	 *                          Can be used to send a custom map of roles and capabilities for setting them up.
+	 *                          Note that this should ONLY be called on activation hook or some other one-time
+	 *                          task otherwise the caps will be added on every request.
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function init_role_caps($reset = false, $caps_map = array())
+	{
+		// If this method is called directly and reset is set as 'true',
+		// then display a doing it wrong notice, because we want resets to go through init_caps()
+		// to guarantee that everything is set up correctly.
+		// This prevents the capabilities map getting reset incorrectly by direct calls to this method.
+		if ($reset) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".',
+						'event_espresso'
+					),
+					'$reset',
+					__METHOD__ . '()',
+					'EE_Capabilities::init_caps()',
+					'true'
+				),
+				'4.9.42',
+				'5.0.0'
+			);
+		}
+		$this->addCaps($caps_map);
+	}
 
 
 
@@ -1012,142 +1012,142 @@ 
 abstract class EE_Meta_Capability_Map
 {
 
-    public $meta_cap;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $_model;
-
-    protected $_model_name;
-
-    public $published_cap = '';
-
-    public $others_cap = '';
-
-    public $private_cap = '';
-
-
-    /**
-     * constructor.
-     * Receives the setup arguments for the map.
-     *
-     * @since                        4.5.0
-     *
-     * @param string $meta_cap   What meta capability is this mapping.
-     * @param array  $map_values array {
-     *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
-     *                           capabilities that don't get mapped to.
-     *
-     * @type         $map_values [0] string A string representing the model name. Required.  String's
-     *                               should always be used when Menu Maps are registered via the
-     *                               plugin API as models are not allowed to be instantiated when
-     *                               in maintenance mode 2 (migrations).
-     * @type         $map_values [1] string represents the capability used for published. Optional.
-     * @type         $map_values [2] string represents the capability used for "others". Optional.
-     * @type         $map_values [3] string represents the capability used for private. Optional.
-     *                               }
-     * @throws EE_Error
-     */
-    public function __construct($meta_cap, $map_values)
-    {
-        $this->meta_cap = $meta_cap;
-        //verify there are four args in the $map_values array;
-        if (count($map_values) !== 4) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
-                        'event_espresso'
-                    ),
-                    '<br>' . print_r($map_values, true)
-                )
-            );
-        }
-        //set properties
-        $this->_model = null;
-        $this->_model_name = $map_values[0];
-        $this->published_cap = (string)$map_values[1];
-        $this->others_cap = (string)$map_values[2];
-        $this->private_cap = (string)$map_values[3];
-    }
-
-    /**
-     * Makes it so this object stops filtering caps
-     */
-    public function remove_filters()
-    {
-        remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
-    }
-
-
-    /**
-     * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
-     *
-     * @since 4.5.0
-     * @throws EE_Error
-     *
-     * @return void
-     */
-    public function ensure_is_model()
-    {
-        //is it already instantiated?
-        if ($this->_model instanceof EEM_Base) {
-            return;
-        }
-        //ensure model name is string
-        $this->_model_name = (string)$this->_model_name;
-        //error proof if the name has EEM in it
-        $this->_model_name = str_replace('EEM', '', $this->_model_name);
-        $this->_model = EE_Registry::instance()->load_model($this->_model_name);
-        if (! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    $this->_model
-                )
-            );
-        }
-    }
-
-
-    /**
-     *
-     * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
-     * @since 4.6.x
-     *
-     * @param $caps
-     * @param $cap
-     * @param $user_id
-     * @param $args
-     *
-     * @return array
-     */
-    public function map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        return $this->_map_meta_caps($caps, $cap, $user_id, $args);
-    }
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
+	public $meta_cap;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model;
+
+	protected $_model_name;
+
+	public $published_cap = '';
+
+	public $others_cap = '';
+
+	public $private_cap = '';
+
+
+	/**
+	 * constructor.
+	 * Receives the setup arguments for the map.
+	 *
+	 * @since                        4.5.0
+	 *
+	 * @param string $meta_cap   What meta capability is this mapping.
+	 * @param array  $map_values array {
+	 *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
+	 *                           capabilities that don't get mapped to.
+	 *
+	 * @type         $map_values [0] string A string representing the model name. Required.  String's
+	 *                               should always be used when Menu Maps are registered via the
+	 *                               plugin API as models are not allowed to be instantiated when
+	 *                               in maintenance mode 2 (migrations).
+	 * @type         $map_values [1] string represents the capability used for published. Optional.
+	 * @type         $map_values [2] string represents the capability used for "others". Optional.
+	 * @type         $map_values [3] string represents the capability used for private. Optional.
+	 *                               }
+	 * @throws EE_Error
+	 */
+	public function __construct($meta_cap, $map_values)
+	{
+		$this->meta_cap = $meta_cap;
+		//verify there are four args in the $map_values array;
+		if (count($map_values) !== 4) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
+						'event_espresso'
+					),
+					'<br>' . print_r($map_values, true)
+				)
+			);
+		}
+		//set properties
+		$this->_model = null;
+		$this->_model_name = $map_values[0];
+		$this->published_cap = (string)$map_values[1];
+		$this->others_cap = (string)$map_values[2];
+		$this->private_cap = (string)$map_values[3];
+	}
+
+	/**
+	 * Makes it so this object stops filtering caps
+	 */
+	public function remove_filters()
+	{
+		remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
+	}
+
+
+	/**
+	 * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
+	 *
+	 * @since 4.5.0
+	 * @throws EE_Error
+	 *
+	 * @return void
+	 */
+	public function ensure_is_model()
+	{
+		//is it already instantiated?
+		if ($this->_model instanceof EEM_Base) {
+			return;
+		}
+		//ensure model name is string
+		$this->_model_name = (string)$this->_model_name;
+		//error proof if the name has EEM in it
+		$this->_model_name = str_replace('EEM', '', $this->_model_name);
+		$this->_model = EE_Registry::instance()->load_model($this->_model_name);
+		if (! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
+						'event_espresso'
+					),
+					get_class($this),
+					$this->_model
+				)
+			);
+		}
+	}
+
+
+	/**
+	 *
+	 * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
+	 * @since 4.6.x
+	 *
+	 * @param $caps
+	 * @param $cap
+	 * @param $user_id
+	 * @param $args
+	 *
+	 * @return array
+	 */
+	public function map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		return $this->_map_meta_caps($caps, $cap, $user_id, $args);
+	}
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
 }
 
 
@@ -1163,81 +1163,81 @@ 
 class EE_Meta_Capability_Map_Edit extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        //okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[$key]);
-        }
-
-        //cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        /** @var EE_Base_Class $obj */
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[] = $cap . 's';
-        if ($obj instanceof EE_CPT_Base) {
-            //if the item author is set and the user is the author...
-            if ($obj->wp_user() && $user_id === $obj->wp_user()) {
-                //if obj is published...
-                if ($obj->status() === 'publish') {
-                    $caps[] = $this->published_cap;
-                }
-            } else {
-                //the user is trying to edit someone else's obj
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-                if (! empty($this->published_cap) && $obj->status() === 'publish') {
-                    $caps[] = $this->published_cap;
-                } elseif (! empty($this->private_cap) && $obj->status() === 'private') {
-                    $caps[] = $this->private_cap;
-                }
-            }
-        } else {
-            //not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user')
-                    && $obj->wp_user()
-                    && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if (! $has_cap) {
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		//okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[$key]);
+		}
+
+		//cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		/** @var EE_Base_Class $obj */
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[] = $cap . 's';
+		if ($obj instanceof EE_CPT_Base) {
+			//if the item author is set and the user is the author...
+			if ($obj->wp_user() && $user_id === $obj->wp_user()) {
+				//if obj is published...
+				if ($obj->status() === 'publish') {
+					$caps[] = $this->published_cap;
+				}
+			} else {
+				//the user is trying to edit someone else's obj
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+				if (! empty($this->published_cap) && $obj->status() === 'publish') {
+					$caps[] = $this->published_cap;
+				} elseif (! empty($this->private_cap) && $obj->status() === 'private') {
+					$caps[] = $this->private_cap;
+				}
+			}
+		} else {
+			//not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user')
+					&& $obj->wp_user()
+					&& $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if (! $has_cap) {
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1254,24 +1254,24 @@ 
 class EE_Meta_Capability_Map_Delete extends EE_Meta_Capability_Map_Edit
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        return parent::_map_meta_caps($caps, $cap, $user_id, $args);
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		return parent::_map_meta_caps($caps, $cap, $user_id, $args);
+	}
 }
 
 
@@ -1287,85 +1287,85 @@ 
 class EE_Meta_Capability_Map_Read extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped cap;
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        //okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[$key]);
-        }
-
-        //cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-
-        $caps[] = $cap . 's';
-        if ($obj instanceof EE_CPT_Base) {
-            $status_obj = get_post_status_object($obj->status());
-            if ($status_obj->public) {
-                return $caps;
-            }
-            //if the item author is set and the user is not the author...
-            if ($obj->wp_user() && $obj->wp_user() !== $user_id) {
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-            //yes this means that if users created the private post, they are able to see it regardless of private cap.
-            if ($status_obj->private
-                && ! empty($this->private_cap)
-                && $obj->wp_user() !== $user_id
-            ) {
-                //the user is trying to view a private object for an object they don't own.
-                $caps[] = $this->private_cap;
-            }
-        } else {
-            //not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user')
-                           && $obj->wp_user()
-                           && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if (! $has_cap) {
-                if (! empty($this->private_cap)) {
-                    $caps[] = $this->private_cap;
-                }
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped cap;
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		//okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[$key]);
+		}
+
+		//cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+
+		$caps[] = $cap . 's';
+		if ($obj instanceof EE_CPT_Base) {
+			$status_obj = get_post_status_object($obj->status());
+			if ($status_obj->public) {
+				return $caps;
+			}
+			//if the item author is set and the user is not the author...
+			if ($obj->wp_user() && $obj->wp_user() !== $user_id) {
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+			//yes this means that if users created the private post, they are able to see it regardless of private cap.
+			if ($status_obj->private
+				&& ! empty($this->private_cap)
+				&& $obj->wp_user() !== $user_id
+			) {
+				//the user is trying to view a private object for an object they don't own.
+				$caps[] = $this->private_cap;
+			}
+		} else {
+			//not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user')
+						   && $obj->wp_user()
+						   && $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if (! $has_cap) {
+				if (! empty($this->private_cap)) {
+					$caps[] = $this->private_cap;
+				}
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1382,56 +1382,56 @@ 
 class EE_Meta_Capability_Map_Messages_Cap extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        //okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[$key]);
-        }
-
-        //cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Message_Template_Group) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[] = $cap . 's';
-        $is_global = $obj->is_global();
-        if ($obj->wp_user() && $obj->wp_user() === $user_id) {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            }
-        } else {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            } else {
-                $caps[] = $this->others_cap;
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		//okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[$key]);
+		}
+
+		//cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Message_Template_Group) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[] = $cap . 's';
+		$is_global = $obj->is_global();
+		if ($obj->wp_user() && $obj->wp_user() === $user_id) {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			}
+		} else {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			} else {
+				$caps[] = $this->others_cap;
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1448,40 +1448,40 @@ 
 class EE_Meta_Capability_Map_Registration_Form_Cap extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-        //okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[$key]);
-        }
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[]    = $cap . 's';
-        $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
-        $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
-        if ($is_system) {
-            $caps[] = $this->private_cap;
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+		//okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[$key]);
+		}
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[]    = $cap . 's';
+		$is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
+		$is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
+		if ($is_system) {
+			$caps[] = $this->private_cap;
+		}
+		return $caps;
+	}
 }

Spacing +46 added lines, -46 removed lines

@@ -85,7 +85,7 @@ 
     public static function instance()
     {
         //check if instantiated, and if not do so.
-        if (! self::$_instance instanceof EE_Capabilities) {
+        if ( ! self::$_instance instanceof EE_Capabilities) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -117,7 +117,7 @@ 
      */
     public function init_caps($reset = false)
     {
-        if(! EE_Maintenance_Mode::instance()->models_can_query()){
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
             return false;
         }
         $this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN);
@@ -163,7 +163,7 @@ 
             $this->_get_default_meta_caps_array()
         );
         //add filter for map_meta_caps but only if models can query.
-        if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
+        if ( ! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
             add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
         }
     }
@@ -324,11 +324,11 @@ 
         if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
             //loop through our _meta_caps array
             foreach ($this->_meta_caps as $meta_map) {
-                if (! $meta_map instanceof EE_Meta_Capability_Map) {
+                if ( ! $meta_map instanceof EE_Meta_Capability_Map) {
                     continue;
                 }
                 // don't load models if there is no object ID in the args
-                if (! empty($args[0])) {
+                if ( ! empty($args[0])) {
                     $meta_map->ensure_is_model();
                 }
                 $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
@@ -630,7 +630,7 @@ 
     private function setupCapabilitiesMap()
     {
         // if the initialization process hasn't even started, then we need to call init_caps()
-        if($this->initialized === null) {
+        if ($this->initialized === null) {
             return $this->init_caps();
         }
         // unless resetting, get caps from db if we haven't already
@@ -666,7 +666,7 @@ 
     public function addCaps(array $capabilities_to_add)
     {
         // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
+        if ( ! $this->setupCapabilitiesMap()) {
             return false;
         }
         // and filter the array so others can get in on the fun during resets
@@ -708,7 +708,7 @@ 
     public function removeCaps($caps_map)
     {
         // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
+        if ( ! $this->setupCapabilitiesMap()) {
             return false;
         }
         $update_capabilities_map = false;
@@ -750,7 +750,7 @@ 
         $orig_role = $role;
         $role = $role instanceof WP_Role ? $role : get_role($role);
         //if the role isn't available then we create it.
-        if (! $role instanceof WP_Role) {
+        if ( ! $role instanceof WP_Role) {
             // if a plugin wants to create a specific role name then they should create the role before
             // EE_Capabilities does.  Otherwise this function will create the role name from the slug:
             // - removes any `ee_` namespacing from the start of the slug.
@@ -761,12 +761,12 @@ 
         }
         if ($role instanceof WP_Role) {
             // don't do anything if the capabilities map can not be initialized
-            if (! $this->setupCapabilitiesMap()) {
+            if ( ! $this->setupCapabilitiesMap()) {
                 return false;
             }
-            if (! $this->capHasBeenAddedToRole($role->name, $cap)) {
+            if ( ! $this->capHasBeenAddedToRole($role->name, $cap)) {
                 $role->add_cap($cap, $grant);
-                $this->capabilities_map[ $role->name ][] = $cap;
+                $this->capabilities_map[$role->name][] = $cap;
                 $this->updateCapabilitiesMap($update_capabilities_map);
                 return true;
             }
@@ -791,13 +791,13 @@ 
     public function remove_cap_from_role($role, $cap, $update_capabilities_map = true)
     {
         // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
+        if ( ! $this->setupCapabilitiesMap()) {
             return false;
         }
-        $role = $role instanceof WP_Role ? $role :get_role($role);
+        $role = $role instanceof WP_Role ? $role : get_role($role);
         if ($index = $this->capHasBeenAddedToRole($role->name, $cap, true)) {
             $role->remove_cap($cap);
-            unset($this->capabilities_map[ $role->name ][ $index ]);
+            unset($this->capabilities_map[$role->name][$index]);
             $this->updateCapabilitiesMap($update_capabilities_map);
             return true;
         }
@@ -812,7 +812,7 @@ 
      * @param bool   $get_index
      * @return bool|mixed
      */
-    private function capHasBeenAddedToRole($role_name='', $cap='', $get_index = false)
+    private function capHasBeenAddedToRole($role_name = '', $cap = '', $get_index = false)
     {
         if (
             isset($this->capabilities_map[$role_name])
@@ -844,7 +844,7 @@ 
     public function current_user_can($cap, $context, $id = 0)
     {
         //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
+        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__'.$context, $cap, $id);
         $filtered_cap = apply_filters(
             'FHEE__EE_Capabilities__current_user_can__cap',
             $filtered_cap,
@@ -873,7 +873,7 @@ 
     public function user_can($user, $cap, $context, $id = 0)
     {
         //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
+        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__'.$context, $cap, $user, $id);
         $filtered_cap = apply_filters(
             'FHEE__EE_Capabilities__user_can__cap',
             $filtered_cap,
@@ -913,7 +913,7 @@ 
             : current_user_can($blog_id, $cap);
         //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
         $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
+            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__'.$context,
             $user_can,
             $blog_id,
             $cap,
@@ -943,14 +943,14 @@ 
      */
     public function get_ee_capabilities($role = 'administrator')
     {
-        if (! $this->initialized) {
+        if ( ! $this->initialized) {
             $this->init_caps();
         }
         if (empty($role)) {
             return $this->capabilities_map;
         }
-        return isset($this->capabilities_map[ $role ])
-            ? $this->capabilities_map[ $role ]
+        return isset($this->capabilities_map[$role])
+            ? $this->capabilities_map[$role]
             : array();
     }
 
@@ -982,7 +982,7 @@ 
                         'event_espresso'
                     ),
                     '$reset',
-                    __METHOD__ . '()',
+                    __METHOD__.'()',
                     'EE_Capabilities::init_caps()',
                     'true'
                 ),
@@ -1060,16 +1060,16 @@ 
                         'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
                         'event_espresso'
                     ),
-                    '<br>' . print_r($map_values, true)
+                    '<br>'.print_r($map_values, true)
                 )
             );
         }
         //set properties
         $this->_model = null;
         $this->_model_name = $map_values[0];
-        $this->published_cap = (string)$map_values[1];
-        $this->others_cap = (string)$map_values[2];
-        $this->private_cap = (string)$map_values[3];
+        $this->published_cap = (string) $map_values[1];
+        $this->others_cap = (string) $map_values[2];
+        $this->private_cap = (string) $map_values[3];
     }
 
     /**
@@ -1096,11 +1096,11 @@ 
             return;
         }
         //ensure model name is string
-        $this->_model_name = (string)$this->_model_name;
+        $this->_model_name = (string) $this->_model_name;
         //error proof if the name has EEM in it
         $this->_model_name = str_replace('EEM', '', $this->_model_name);
         $this->_model = EE_Registry::instance()->load_model($this->_model_name);
-        if (! $this->_model instanceof EEM_Base) {
+        if ( ! $this->_model instanceof EEM_Base) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -1195,11 +1195,11 @@ 
         /** @var EE_Base_Class $obj */
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = 'do_not_allow';
             return $caps;
         }
-        $caps[] = $cap . 's';
+        $caps[] = $cap.'s';
         if ($obj instanceof EE_CPT_Base) {
             //if the item author is set and the user is the author...
             if ($obj->wp_user() && $user_id === $obj->wp_user()) {
@@ -1209,12 +1209,12 @@ 
                 }
             } else {
                 //the user is trying to edit someone else's obj
-                if (! empty($this->others_cap)) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
-                if (! empty($this->published_cap) && $obj->status() === 'publish') {
+                if ( ! empty($this->published_cap) && $obj->status() === 'publish') {
                     $caps[] = $this->published_cap;
-                } elseif (! empty($this->private_cap) && $obj->status() === 'private') {
+                } elseif ( ! empty($this->private_cap) && $obj->status() === 'private') {
                     $caps[] = $this->private_cap;
                 }
             }
@@ -1230,8 +1230,8 @@ 
                     EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
                 }
             }
-            if (! $has_cap) {
-                if (! empty($this->others_cap)) {
+            if ( ! $has_cap) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
             }
@@ -1318,12 +1318,12 @@ 
 
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = 'do_not_allow';
             return $caps;
         }
 
-        $caps[] = $cap . 's';
+        $caps[] = $cap.'s';
         if ($obj instanceof EE_CPT_Base) {
             $status_obj = get_post_status_object($obj->status());
             if ($status_obj->public) {
@@ -1331,7 +1331,7 @@ 
             }
             //if the item author is set and the user is not the author...
             if ($obj->wp_user() && $obj->wp_user() !== $user_id) {
-                if (! empty($this->others_cap)) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
             }
@@ -1355,11 +1355,11 @@ 
                     EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
                 }
             }
-            if (! $has_cap) {
-                if (! empty($this->private_cap)) {
+            if ( ! $has_cap) {
+                if ( ! empty($this->private_cap)) {
                     $caps[] = $this->private_cap;
                 }
-                if (! empty($this->others_cap)) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
             }
@@ -1413,11 +1413,11 @@ 
 
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         //if no obj then let's just do cap
-        if (! $obj instanceof EE_Message_Template_Group) {
+        if ( ! $obj instanceof EE_Message_Template_Group) {
             $caps[] = 'do_not_allow';
             return $caps;
         }
-        $caps[] = $cap . 's';
+        $caps[] = $cap.'s';
         $is_global = $obj->is_global();
         if ($obj->wp_user() && $obj->wp_user() === $user_id) {
             if ($is_global) {
@@ -1472,11 +1472,11 @@ 
         }
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = 'do_not_allow';
             return $caps;
         }
-        $caps[]    = $cap . 's';
+        $caps[]    = $cap.'s';
         $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
         $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
         if ($is_system) {

caffeinated/admin/extend/registrations/Extend_EE_Registrations_List_Table.class.php

Indentation +97 added lines, -97 removed lines

@@ -11,104 +11,104 @@
  */
 class Extend_EE_Registrations_List_Table extends EE_Registrations_List_Table
 {
-    /**
-     * REG_date
-     */
-    function column__REG_date(EE_Registration $item)
-    {
-        $date_linked = parent::column__REG_date($item);
-        $actions = array();
-        //Build row actions
-        $check_in_url        = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'   => 'event_registrations',
-            'event_id' => $item->event_ID(),
-        ), REG_ADMIN_URL);
-        $actions['check_in'] = EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registration',
-            'espresso_registrations_registration_checkins',
-            $item->ID()
-        )
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_checkins',
-                'espresso_registrations_registration_checkins'
-            )
-            ? '<a href="' . $check_in_url . '"'
-              . ' title="' . esc_attr__(
-                  'The Check-In List allows you to easily toggle check-in status for this event',
-                  'event_espresso'
-              )
-              . '">' .  esc_html__('View Check-ins', 'event_espresso') . '</a>'
-            :  esc_html__('View Check-ins', 'event_espresso');
+	/**
+	 * REG_date
+	 */
+	function column__REG_date(EE_Registration $item)
+	{
+		$date_linked = parent::column__REG_date($item);
+		$actions = array();
+		//Build row actions
+		$check_in_url        = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'   => 'event_registrations',
+			'event_id' => $item->event_ID(),
+		), REG_ADMIN_URL);
+		$actions['check_in'] = EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registration',
+			'espresso_registrations_registration_checkins',
+			$item->ID()
+		)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_checkins',
+				'espresso_registrations_registration_checkins'
+			)
+			? '<a href="' . $check_in_url . '"'
+			  . ' title="' . esc_attr__(
+				  'The Check-In List allows you to easily toggle check-in status for this event',
+				  'event_espresso'
+			  )
+			  . '">' .  esc_html__('View Check-ins', 'event_espresso') . '</a>'
+			:  esc_html__('View Check-ins', 'event_espresso');
 
-        return sprintf('%1$s %2$s', $date_linked, $this->row_actions($actions));
-    }
+		return sprintf('%1$s %2$s', $date_linked, $this->row_actions($actions));
+	}
 
 
-    /**
-     *        column_default
-     *
-     * @param \EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_DTT_EVT_start(EE_Registration $item)
-    {
-        $remove_defaults = array('default_where_conditions' => 'none');
-        $ticket          = $item->ticket();
-        $datetimes       = $ticket instanceof EE_Ticket ? $ticket->datetimes($remove_defaults) : array();
-        $EVT_ID          = $item->event_ID();
-        $datetime_string = '';
-        foreach ($datetimes as $datetime) {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_checkin',
-                'espresso_registrations_registration_checkins',
-                $item->ID()
-            )) {
-                // open "a" tag and "href"
-                $datetime_string .= '<a href="';
-                // checkin URL
-                $datetime_string .= EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action'   => 'event_registrations',
-                        'event_id' => $EVT_ID,
-                        'DTT_ID'   => $datetime->ID(),
-                    ),
-                    REG_ADMIN_URL
-                );
-                // close "href"
-                $datetime_string .= '"';
-                // open "title" tag
-                $datetime_string .= ' title="';
-                // link title text
-                $datetime_string .= esc_attr__('View Checkins for this Event', 'event_espresso');
-                // close "title" tag and end of "a" tag opening
-                $datetime_string .= '">';
-                // link text
-                $datetime_string .= $datetime->get_i18n_datetime('DTT_EVT_start');
-                // close "a" tag
-                $datetime_string .= '</a>';
-            } else {
-                $datetime_string .= $datetime->get_i18n_datetime('DTT_EVT_start');
-            }
-            // add a "View Registrations" link that filters list by event AND datetime
-            $datetime_string .= $this->row_actions(
-                array(
-                    'event_datetime_filter' => '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
-                        array('event_id' => $EVT_ID, 'datetime_id' => $datetime->ID()),
-                        REG_ADMIN_URL
-                    )
-                                               . '" title="' . sprintf(
-                                                   esc_attr__(
-                                                       'Filter this list to only show registrations for this datetime %s',
-                                                       'event_espresso'
-                                                   ),
-                                                   $datetime->name()
-                                               ) . '">'
-                                               . esc_html__('View Registrations', 'event_espresso')
-                                               . '</a>',
-                )
-            );
-        }
-        return $datetime_string;
-    }
+	/**
+	 *        column_default
+	 *
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_DTT_EVT_start(EE_Registration $item)
+	{
+		$remove_defaults = array('default_where_conditions' => 'none');
+		$ticket          = $item->ticket();
+		$datetimes       = $ticket instanceof EE_Ticket ? $ticket->datetimes($remove_defaults) : array();
+		$EVT_ID          = $item->event_ID();
+		$datetime_string = '';
+		foreach ($datetimes as $datetime) {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_checkin',
+				'espresso_registrations_registration_checkins',
+				$item->ID()
+			)) {
+				// open "a" tag and "href"
+				$datetime_string .= '<a href="';
+				// checkin URL
+				$datetime_string .= EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action'   => 'event_registrations',
+						'event_id' => $EVT_ID,
+						'DTT_ID'   => $datetime->ID(),
+					),
+					REG_ADMIN_URL
+				);
+				// close "href"
+				$datetime_string .= '"';
+				// open "title" tag
+				$datetime_string .= ' title="';
+				// link title text
+				$datetime_string .= esc_attr__('View Checkins for this Event', 'event_espresso');
+				// close "title" tag and end of "a" tag opening
+				$datetime_string .= '">';
+				// link text
+				$datetime_string .= $datetime->get_i18n_datetime('DTT_EVT_start');
+				// close "a" tag
+				$datetime_string .= '</a>';
+			} else {
+				$datetime_string .= $datetime->get_i18n_datetime('DTT_EVT_start');
+			}
+			// add a "View Registrations" link that filters list by event AND datetime
+			$datetime_string .= $this->row_actions(
+				array(
+					'event_datetime_filter' => '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+						array('event_id' => $EVT_ID, 'datetime_id' => $datetime->ID()),
+						REG_ADMIN_URL
+					)
+											   . '" title="' . sprintf(
+												   esc_attr__(
+													   'Filter this list to only show registrations for this datetime %s',
+													   'event_espresso'
+												   ),
+												   $datetime->name()
+											   ) . '">'
+											   . esc_html__('View Registrations', 'event_espresso')
+											   . '</a>',
+				)
+			);
+		}
+		return $datetime_string;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -19,7 +19,7 @@ 
         $date_linked = parent::column__REG_date($item);
         $actions = array();
         //Build row actions
-        $check_in_url        = EE_Admin_Page::add_query_args_and_nonce(array(
+        $check_in_url = EE_Admin_Page::add_query_args_and_nonce(array(
             'action'   => 'event_registrations',
             'event_id' => $item->event_ID(),
         ), REG_ADMIN_URL);
@@ -32,12 +32,12 @@ 
                 'ee_read_checkins',
                 'espresso_registrations_registration_checkins'
             )
-            ? '<a href="' . $check_in_url . '"'
-              . ' title="' . esc_attr__(
+            ? '<a href="'.$check_in_url.'"'
+              . ' title="'.esc_attr__(
                   'The Check-In List allows you to easily toggle check-in status for this event',
                   'event_espresso'
               )
-              . '">' .  esc_html__('View Check-ins', 'event_espresso') . '</a>'
+              . '">'.esc_html__('View Check-ins', 'event_espresso').'</a>'
             :  esc_html__('View Check-ins', 'event_espresso');
 
         return sprintf('%1$s %2$s', $date_linked, $this->row_actions($actions));
@@ -93,17 +93,17 @@ 
             // add a "View Registrations" link that filters list by event AND datetime
             $datetime_string .= $this->row_actions(
                 array(
-                    'event_datetime_filter' => '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+                    'event_datetime_filter' => '<a href="'.EE_Admin_Page::add_query_args_and_nonce(
                         array('event_id' => $EVT_ID, 'datetime_id' => $datetime->ID()),
                         REG_ADMIN_URL
                     )
-                                               . '" title="' . sprintf(
+                                               . '" title="'.sprintf(
                                                    esc_attr__(
                                                        'Filter this list to only show registrations for this datetime %s',
                                                        'event_espresso'
                                                    ),
                                                    $datetime->name()
-                                               ) . '">'
+                                               ).'">'
                                                . esc_html__('View Registrations', 'event_espresso')
                                                . '</a>',
                 )

core/services/loaders/CoreLoader.php

Spacing +2 added lines, -2 removed lines

@@ -39,7 +39,7 @@ 
      */
     public function __construct($generator)
     {
-        if(!($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
+        if ( ! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
             throw new InvalidArgumentException(
                 esc_html__(
                     'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
@@ -61,7 +61,7 @@ 
      */
     public function load($fqcn, $arguments = array(), $shared = true)
     {
-        if($this->generator instanceof EE_Registry) {
+        if ($this->generator instanceof EE_Registry) {
             return $this->generator->create($fqcn, $arguments, $shared);
         }
         $shared = $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW;

Indentation +61 added lines, -61 removed lines

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

core/db_models/EEM_Event.model.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -1,4 +1,4 @@
-<?php use EventEspresso\core\services\orm\ModelFieldFactory;
+<?php 
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');

Indentation +767 added lines, -767 removed lines

@@ -1,7 +1,7 @@ 
 <?php use EventEspresso\core\services\orm\ModelFieldFactory;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 require_once(EE_MODELS . 'EEM_CPT_Base.model.php');
 
@@ -18,772 +18,772 @@ 
 class EEM_Event extends EEM_CPT_Base
 {
 
-    /**
-     * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
-     * event
-     */
-    const sold_out = 'sold_out';
-
-    /**
-     * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
-     * date)
-     */
-    const postponed = 'postponed';
-
-    /**
-     * constant used by status(), indicating that the event will no longer occur
-     */
-    const cancelled = 'cancelled';
-
-
-    /**
-     * @var string
-     */
-    protected static $_default_reg_status;
-
-
-    /**
-     * This is the default for the additional limit field.
-     * @var int
-     */
-    protected static $_default_additional_limit = 10;
-
-
-    /**
-     * private instance of the Event object
-     *
-     * @var EEM_Event
-     */
-    protected static $_instance;
-
-
-
-
-    /**
-     * Adds a relationship to Term_Taxonomy for each CPT_Base
-     *
-     * @param string $timezone
-     * @throws \EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        EE_Registry::instance()->load_model('Registration');
-        $this->singular_item = esc_html__('Event', 'event_espresso');
-        $this->plural_item = esc_html__('Events', 'event_espresso');
-        // to remove Cancelled events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
-        // to remove Postponed events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
-        // to remove Sold Out events from the frontend, copy the following filter to your functions.php file
-        //	add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
-        $this->_custom_stati = apply_filters(
-            'AFEE__EEM_Event__construct___custom_stati',
-            array(
-                EEM_Event::cancelled => array(
-                    'label'  => esc_html__('Cancelled', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
-                ),
-                EEM_Event::postponed => array(
-                    'label'  => esc_html__('Postponed', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
-                ),
-                EEM_Event::sold_out  => array(
-                    'label'  => esc_html__('Sold Out', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
-                ),
-            )
-        );
-        self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment
-            : self::$_default_reg_status;
-        $this->_tables = array(
-            'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
-        );
-        $this->_fields = array(
-            'Event_CPT'  => array(
-                'EVT_ID'         => new EE_Primary_Key_Int_Field('ID',
-                    esc_html__('Post ID for Event', 'event_espresso')),
-                'EVT_name'       => new EE_Plain_Text_Field('post_title', esc_html__('Event Name', 'event_espresso'),
-                    false,
-                    ''),
-                'EVT_desc'       => new EE_Post_Content_Field('post_content',
-                    esc_html__('Event Description', 'event_espresso'),
-                    false, ''),
-                'EVT_slug'       => new EE_Slug_Field('post_name', esc_html__('Event Slug', 'event_espresso'), false,
-                    ''),
-                'EVT_created'    => new EE_Datetime_Field('post_date',
-                    esc_html__('Date/Time Event Created', 'event_espresso'),
-                    false, EE_Datetime_Field::now),
-                'EVT_short_desc' => new EE_Simple_HTML_Field('post_excerpt',
-                    esc_html__('Event Short Description', 'event_espresso'), false, ''),
-                'EVT_modified'   => new EE_Datetime_Field('post_modified',
-                    esc_html__('Date/Time Event Modified', 'event_espresso'), false, EE_Datetime_Field::now),
-                'EVT_wp_user'    => new EE_WP_User_Field('post_author',
-                    esc_html__('Event Creator ID', 'event_espresso'),
-                    false),
-                'parent'         => new EE_Integer_Field('post_parent', esc_html__('Event Parent ID', 'event_espresso'),
-                    false,
-                    0),
-                'EVT_order'      => new EE_Integer_Field('menu_order', esc_html__('Event Menu Order', 'event_espresso'),
-                    false,
-                    1),
-                'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
-                // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
-                'status'         => new EE_WP_Post_Status_Field('post_status',
-                    esc_html__('Event Status', 'event_espresso'),
-                    false, 'draft', $this->_custom_stati),
-            ),
-            'Event_Meta' => array(
-                'EVTM_ID'                         => new EE_DB_Only_Float_Field('EVTM_ID',
-                    esc_html__('Event Meta Row ID', 'event_espresso'), false),
-                'EVT_ID_fk'                       => new EE_DB_Only_Int_Field('EVT_ID',
-                    esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'), false),
-                'EVT_display_desc'                => new EE_Boolean_Field('EVT_display_desc',
-                    esc_html__('Display Description Flag', 'event_espresso'), false, 1),
-                'EVT_display_ticket_selector'     => new EE_Boolean_Field('EVT_display_ticket_selector',
-                    esc_html__('Display Ticket Selector Flag', 'event_espresso'), false, 1),
-                'EVT_visible_on'                  => new EE_Datetime_Field('EVT_visible_on',
-                    esc_html__('Event Visible Date', 'event_espresso'), true, EE_Datetime_Field::now),
-                'EVT_additional_limit'            => new EE_Integer_Field(
-                    'EVT_additional_limit',
-                    esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                    true,
-                    self::$_default_additional_limit
-                ),
-                'EVT_default_registration_status' => new EE_Enum_Text_Field(
-                    'EVT_default_registration_status',
-                    esc_html__('Default Registration Status on this Event', 'event_espresso'), false,
-                    EEM_Event::$_default_reg_status, EEM_Registration::reg_status_array()
-                ),
-                'EVT_member_only'                 => new EE_Boolean_Field('EVT_member_only',
-                    esc_html__('Member-Only Event Flag', 'event_espresso'), false, false),
-                'EVT_phone'                       => new EE_Plain_Text_Field('EVT_phone',
-                    esc_html__('Event Phone Number', 'event_espresso'), false),
-                'EVT_allow_overflow'              => new EE_Boolean_Field('EVT_allow_overflow',
-                    esc_html__('Allow Overflow on Event', 'event_espresso'), false, false),
-                'EVT_timezone_string'             => new EE_Plain_Text_Field('EVT_timezone_string',
-                    esc_html__('Timezone (name) for Event times', 'event_espresso'), false),
-                'EVT_external_URL'                => new EE_Plain_Text_Field('EVT_external_URL',
-                    esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), true),
-                'EVT_donations'                   => new EE_Boolean_Field('EVT_donations',
-                    esc_html__('Accept Donations?', 'event_espresso'), false, false),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration'           => new EE_Has_Many_Relation(),
-            'Datetime'               => new EE_Has_Many_Relation(),
-            'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
-            'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
-            'Term_Relationship'      => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
-            'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
-            'Attendee'               => new EE_HABTM_Relation('Registration'),
-            'WP_User'                => new EE_Belongs_To_Relation(),
-        );
-        //this model is generally available for reading
-        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * @param string $default_reg_status
-     */
-    public static function set_default_reg_status($default_reg_status)
-    {
-        self::$_default_reg_status = $default_reg_status;
-        // if EEM_Event has already been instantiated,
-        // then we need to reset the `EVT_default_reg_status` field to use the new default.
-        if (self::$_instance instanceof EEM_Event) {
-            $default_reg_status = new EE_Enum_Text_Field(
-                'EVT_default_registration_status',
-                esc_html__('Default Registration Status on this Event', 'event_espresso'),
-                false,
-                $default_reg_status,
-                EEM_Registration::reg_status_array()
-            );
-            $default_reg_status->_construct_finalize(
-                'Event_Meta',
-                'EVT_default_registration_status',
-                'EEM_Event'
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
-        }
-    }
-
-
-    /**
-     * Used to override the default for the additional limit field.
-     * @param $additional_limit
-     */
-    public static function set_default_additional_limit($additional_limit)
-    {
-        self::$_default_additional_limit = (int) $additional_limit;
-        if (self::$_instance instanceof EEM_Event) {
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
-                'EVT_additional_limit',
-                __('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                true,
-                self::$_default_additional_limit
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
-                'Event_Meta',
-                'EVT_additional_limit',
-                'EEM_Event'
-            );
-        }
-    }
-
-
-    /**
-     * Return what is currently set as the default additional limit for the event.
-     * @return int
-     */
-    public static function get_default_additional_limit()
-    {
-        return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function get_all_question_groups()
-    {
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            array(
-                array('QSG_deleted' => false),
-                'order_by' => array('QSG_order' => 'ASC'),
-            )
-        );
-    }
-
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int $EVT_ID
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_all_event_question_groups($EVT_ID = 0)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
-            array(
-                array('EVT_ID' => $EVT_ID),
-            )
-        );
-    }
-
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int     $EVT_ID
-     * @param boolean $for_primary_attendee
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
-            array(
-                array(
-                    'EVT_ID'      => $EVT_ID,
-                    'EQG_primary' => $for_primary_attendee,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int             $EVT_ID
-     * @param EE_Registration $registration
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        $where_params = array(
-            'Event_Question_Group.EVT_ID'      => $EVT_ID,
-            'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
-            'QSG_deleted'                      => false,
-        );
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            array(
-                $where_params,
-                'order_by' => array('QSG_order' => 'ASC'),
-            )
-        );
-    }
-
-
-
-    /**
-     * get_question_target_db_column
-     *
-     * @param string $QSG_IDs csv list of $QSG IDs
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_questions_in_groups($QSG_IDs = '')
-    {
-        if (empty($QSG_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question')->get_all(
-            array(
-                array(
-                    'Question_Group.QSG_ID' => array('IN', $QSG_IDs),
-                    'QST_deleted'           => false,
-                    'QST_admin_only'        => is_admin(),
-                ),
-                'order_by' => 'QST_order',
-            )
-        );
-    }
-
-
-
-    /**
-     * get_options_for_question
-     *
-     * @param string $QST_IDs csv list of $QST IDs
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_options_for_question($QST_IDs)
-    {
-        if (empty($QST_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question_Option')->get_all(
-            array(
-                array(
-                    'Question.QST_ID' => array('IN', $QST_IDs),
-                    'QSO_deleted'     => false,
-                ),
-                'order_by' => 'QSO_ID',
-            )
-        );
-    }
-
-
-
-
-
-
-
-    /**
-     * Gets all events that are published
-     * and have event start time earlier than now and an event end time later than now
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_active_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        //if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start******'] = array(
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = array(
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['Datetime.DTT_EVT_end*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_end'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * get all events that are published and have an event start time later than now
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (Note that status and DTT_EVT_start will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        // if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * Gets all events that are published
-     * and have an event end time later than now
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_active_and_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        // add where params for DTT_EVT_end
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['Datetime.DTT_EVT_end*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_end'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * This only returns events that are expired.
-     * They may still be published but all their datetimes have expired.
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_expired_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0]) ? $query_params[0] : array();
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        $exclude_query = $query_params;
-        if (isset($exclude_query[0])) {
-            unset($exclude_query[0]);
-        }
-        $exclude_query[0] = array(
-            'Datetime.DTT_EVT_end' => array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ),
-        );
-        // first get all events that have datetimes where its not expired.
-        $event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
-        $event_ids = array_keys($event_ids);
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $and_condition = array(
-            'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')),
-            'EVT_ID'               => array('NOT IN', $event_ids),
-        );
-        if (isset($where_params['OR'])) {
-            $and_condition['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        // merge remaining $where params with the and conditions.
-        $where_params['AND'] = array_merge($and_condition, $where_params);
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * This basically just returns the events that do not have the publish status.
-     *
-     * @param  array   $query_params An array of query params to further filter on
-     *                               (note that status will be overwritten)
-     * @param  boolean $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_inactive_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0]) ? $query_params[0] : array();
-        // let's add in specific query_params for inactive events.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $where_params['AND']['status'] = array('!=', 'publish');
-        if (isset($where_params['OR'])) {
-            $where_params['AND']['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
-     * because we don't want to override any existing global default prices but instead insert NEW prices that get
-     * attached to the event. See parent for param descriptions
-     *
-     * @param        $id_or_obj
-     * @param        $other_model_id_or_obj
-     * @param string $relationName
-     * @param array  $where_query
-     * @return EE_Base_Class
-     * @throws EE_Error
-     */
-    public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
-    {
-        if ($relationName === 'Price') {
-            //let's get the PRC object for the given ID to make sure that we aren't dealing with a default
-            $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
-            //if EVT_ID = 0, then this is a default
-            if ((int) $prc_chk->get('EVT_ID') === 0) {
-                //let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
-                $prc_chk->set('PRC_ID', 0);
-            }
-            //run parent
-            return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
-        }
-        //otherwise carry on as normal
-        return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
-    }
-
-
-
-    /******************** DEPRECATED METHODS ********************/
-
-
-
-    /**
-     * _get_question_target_db_column
-     *
-     * @deprecated as of 4.8.32.rc.001. Instead consider using
-     *             EE_Registration_Custom_Questions_Form located in
-     *             admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
-     * @access     public
-     * @param    EE_Registration $registration (so existing answers for registration are included)
-     * @param    int             $EVT_ID       so all question groups are included for event (not just answers from
-     *                                         registration).
-     * @throws EE_Error
-     * @return    array
-     */
-    public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
-    {
-        if (empty($EVT_ID)) {
-            throw new EE_Error(__('An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
-                'event_espresso'));
-        }
-        $questions = array();
-        // get all question groups for event
-        $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
-            foreach ($qgs as $qg) {
-                $qsts = $qg->questions();
-                $questions[$qg->ID()] = $qg->model_field_array();
-                $questions[$qg->ID()]['QSG_questions'] = array();
-                foreach ($qsts as $qst) {
-                    if ($qst->is_system_question()) {
-                        continue;
-                    }
-                    $answer = EEM_Answer::instance()->get_one(array(
-                        array(
-                            'QST_ID' => $qst->ID(),
-                            'REG_ID' => $registration->ID(),
-                        ),
-                    ));
-                    $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
-                    $qst_name = $qstn_id = $qst->ID();
-                    $ans_id = $answer->ID();
-                    $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
-                    $input_name = '';
-                    $input_id = sanitize_key($qst->display_text());
-                    $input_class = '';
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()] = $qst->model_field_array();
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn'
-                                                                                           . $input_name
-                                                                                           . $qst_name;
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id . '-' . $qstn_id;
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class;
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array();
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst;
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['ans_obj'] = $answer;
-                    //leave responses as-is, don't convert stuff into html entities please!
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['htmlentities'] = false;
-                    if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
-                        $QSOs = $qst->options(true, $answer->value());
-                        if (is_array($QSOs)) {
-                            foreach ($QSOs as $QSO_ID => $QSO) {
-                                $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] = $QSO->model_field_array();
-                            }
-                        }
-                    }
-                }
-            }
-        }
-        return $questions;
-    }
+	/**
+	 * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
+	 * event
+	 */
+	const sold_out = 'sold_out';
+
+	/**
+	 * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
+	 * date)
+	 */
+	const postponed = 'postponed';
+
+	/**
+	 * constant used by status(), indicating that the event will no longer occur
+	 */
+	const cancelled = 'cancelled';
+
+
+	/**
+	 * @var string
+	 */
+	protected static $_default_reg_status;
+
+
+	/**
+	 * This is the default for the additional limit field.
+	 * @var int
+	 */
+	protected static $_default_additional_limit = 10;
+
+
+	/**
+	 * private instance of the Event object
+	 *
+	 * @var EEM_Event
+	 */
+	protected static $_instance;
+
+
+
+
+	/**
+	 * Adds a relationship to Term_Taxonomy for each CPT_Base
+	 *
+	 * @param string $timezone
+	 * @throws \EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		EE_Registry::instance()->load_model('Registration');
+		$this->singular_item = esc_html__('Event', 'event_espresso');
+		$this->plural_item = esc_html__('Events', 'event_espresso');
+		// to remove Cancelled events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
+		// to remove Postponed events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
+		// to remove Sold Out events from the frontend, copy the following filter to your functions.php file
+		//	add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
+		$this->_custom_stati = apply_filters(
+			'AFEE__EEM_Event__construct___custom_stati',
+			array(
+				EEM_Event::cancelled => array(
+					'label'  => esc_html__('Cancelled', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
+				),
+				EEM_Event::postponed => array(
+					'label'  => esc_html__('Postponed', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
+				),
+				EEM_Event::sold_out  => array(
+					'label'  => esc_html__('Sold Out', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
+				),
+			)
+		);
+		self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment
+			: self::$_default_reg_status;
+		$this->_tables = array(
+			'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
+		);
+		$this->_fields = array(
+			'Event_CPT'  => array(
+				'EVT_ID'         => new EE_Primary_Key_Int_Field('ID',
+					esc_html__('Post ID for Event', 'event_espresso')),
+				'EVT_name'       => new EE_Plain_Text_Field('post_title', esc_html__('Event Name', 'event_espresso'),
+					false,
+					''),
+				'EVT_desc'       => new EE_Post_Content_Field('post_content',
+					esc_html__('Event Description', 'event_espresso'),
+					false, ''),
+				'EVT_slug'       => new EE_Slug_Field('post_name', esc_html__('Event Slug', 'event_espresso'), false,
+					''),
+				'EVT_created'    => new EE_Datetime_Field('post_date',
+					esc_html__('Date/Time Event Created', 'event_espresso'),
+					false, EE_Datetime_Field::now),
+				'EVT_short_desc' => new EE_Simple_HTML_Field('post_excerpt',
+					esc_html__('Event Short Description', 'event_espresso'), false, ''),
+				'EVT_modified'   => new EE_Datetime_Field('post_modified',
+					esc_html__('Date/Time Event Modified', 'event_espresso'), false, EE_Datetime_Field::now),
+				'EVT_wp_user'    => new EE_WP_User_Field('post_author',
+					esc_html__('Event Creator ID', 'event_espresso'),
+					false),
+				'parent'         => new EE_Integer_Field('post_parent', esc_html__('Event Parent ID', 'event_espresso'),
+					false,
+					0),
+				'EVT_order'      => new EE_Integer_Field('menu_order', esc_html__('Event Menu Order', 'event_espresso'),
+					false,
+					1),
+				'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
+				// EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
+				'status'         => new EE_WP_Post_Status_Field('post_status',
+					esc_html__('Event Status', 'event_espresso'),
+					false, 'draft', $this->_custom_stati),
+			),
+			'Event_Meta' => array(
+				'EVTM_ID'                         => new EE_DB_Only_Float_Field('EVTM_ID',
+					esc_html__('Event Meta Row ID', 'event_espresso'), false),
+				'EVT_ID_fk'                       => new EE_DB_Only_Int_Field('EVT_ID',
+					esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'), false),
+				'EVT_display_desc'                => new EE_Boolean_Field('EVT_display_desc',
+					esc_html__('Display Description Flag', 'event_espresso'), false, 1),
+				'EVT_display_ticket_selector'     => new EE_Boolean_Field('EVT_display_ticket_selector',
+					esc_html__('Display Ticket Selector Flag', 'event_espresso'), false, 1),
+				'EVT_visible_on'                  => new EE_Datetime_Field('EVT_visible_on',
+					esc_html__('Event Visible Date', 'event_espresso'), true, EE_Datetime_Field::now),
+				'EVT_additional_limit'            => new EE_Integer_Field(
+					'EVT_additional_limit',
+					esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+					true,
+					self::$_default_additional_limit
+				),
+				'EVT_default_registration_status' => new EE_Enum_Text_Field(
+					'EVT_default_registration_status',
+					esc_html__('Default Registration Status on this Event', 'event_espresso'), false,
+					EEM_Event::$_default_reg_status, EEM_Registration::reg_status_array()
+				),
+				'EVT_member_only'                 => new EE_Boolean_Field('EVT_member_only',
+					esc_html__('Member-Only Event Flag', 'event_espresso'), false, false),
+				'EVT_phone'                       => new EE_Plain_Text_Field('EVT_phone',
+					esc_html__('Event Phone Number', 'event_espresso'), false),
+				'EVT_allow_overflow'              => new EE_Boolean_Field('EVT_allow_overflow',
+					esc_html__('Allow Overflow on Event', 'event_espresso'), false, false),
+				'EVT_timezone_string'             => new EE_Plain_Text_Field('EVT_timezone_string',
+					esc_html__('Timezone (name) for Event times', 'event_espresso'), false),
+				'EVT_external_URL'                => new EE_Plain_Text_Field('EVT_external_URL',
+					esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), true),
+				'EVT_donations'                   => new EE_Boolean_Field('EVT_donations',
+					esc_html__('Accept Donations?', 'event_espresso'), false, false),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration'           => new EE_Has_Many_Relation(),
+			'Datetime'               => new EE_Has_Many_Relation(),
+			'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
+			'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
+			'Term_Relationship'      => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
+			'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
+			'Attendee'               => new EE_HABTM_Relation('Registration'),
+			'WP_User'                => new EE_Belongs_To_Relation(),
+		);
+		//this model is generally available for reading
+		$this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * @param string $default_reg_status
+	 */
+	public static function set_default_reg_status($default_reg_status)
+	{
+		self::$_default_reg_status = $default_reg_status;
+		// if EEM_Event has already been instantiated,
+		// then we need to reset the `EVT_default_reg_status` field to use the new default.
+		if (self::$_instance instanceof EEM_Event) {
+			$default_reg_status = new EE_Enum_Text_Field(
+				'EVT_default_registration_status',
+				esc_html__('Default Registration Status on this Event', 'event_espresso'),
+				false,
+				$default_reg_status,
+				EEM_Registration::reg_status_array()
+			);
+			$default_reg_status->_construct_finalize(
+				'Event_Meta',
+				'EVT_default_registration_status',
+				'EEM_Event'
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
+		}
+	}
+
+
+	/**
+	 * Used to override the default for the additional limit field.
+	 * @param $additional_limit
+	 */
+	public static function set_default_additional_limit($additional_limit)
+	{
+		self::$_default_additional_limit = (int) $additional_limit;
+		if (self::$_instance instanceof EEM_Event) {
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
+				'EVT_additional_limit',
+				__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+				true,
+				self::$_default_additional_limit
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
+				'Event_Meta',
+				'EVT_additional_limit',
+				'EEM_Event'
+			);
+		}
+	}
+
+
+	/**
+	 * Return what is currently set as the default additional limit for the event.
+	 * @return int
+	 */
+	public static function get_default_additional_limit()
+	{
+		return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function get_all_question_groups()
+	{
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			array(
+				array('QSG_deleted' => false),
+				'order_by' => array('QSG_order' => 'ASC'),
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int $EVT_ID
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_all_event_question_groups($EVT_ID = 0)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
+			array(
+				array('EVT_ID' => $EVT_ID),
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int     $EVT_ID
+	 * @param boolean $for_primary_attendee
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
+			array(
+				array(
+					'EVT_ID'      => $EVT_ID,
+					'EQG_primary' => $for_primary_attendee,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int             $EVT_ID
+	 * @param EE_Registration $registration
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		$where_params = array(
+			'Event_Question_Group.EVT_ID'      => $EVT_ID,
+			'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
+			'QSG_deleted'                      => false,
+		);
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			array(
+				$where_params,
+				'order_by' => array('QSG_order' => 'ASC'),
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_question_target_db_column
+	 *
+	 * @param string $QSG_IDs csv list of $QSG IDs
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_questions_in_groups($QSG_IDs = '')
+	{
+		if (empty($QSG_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question')->get_all(
+			array(
+				array(
+					'Question_Group.QSG_ID' => array('IN', $QSG_IDs),
+					'QST_deleted'           => false,
+					'QST_admin_only'        => is_admin(),
+				),
+				'order_by' => 'QST_order',
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_options_for_question
+	 *
+	 * @param string $QST_IDs csv list of $QST IDs
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_options_for_question($QST_IDs)
+	{
+		if (empty($QST_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question_Option')->get_all(
+			array(
+				array(
+					'Question.QST_ID' => array('IN', $QST_IDs),
+					'QSO_deleted'     => false,
+				),
+				'order_by' => 'QSO_ID',
+			)
+		);
+	}
+
+
+
+
+
+
+
+	/**
+	 * Gets all events that are published
+	 * and have event start time earlier than now and an event end time later than now
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_active_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		//if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start******'] = array(
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = array(
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['Datetime.DTT_EVT_end*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_end'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * get all events that are published and have an event start time later than now
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (Note that status and DTT_EVT_start will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		// if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * Gets all events that are published
+	 * and have an event end time later than now
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_active_and_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		// add where params for DTT_EVT_end
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['Datetime.DTT_EVT_end*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_end'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * This only returns events that are expired.
+	 * They may still be published but all their datetimes have expired.
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_expired_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0]) ? $query_params[0] : array();
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		$exclude_query = $query_params;
+		if (isset($exclude_query[0])) {
+			unset($exclude_query[0]);
+		}
+		$exclude_query[0] = array(
+			'Datetime.DTT_EVT_end' => array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			),
+		);
+		// first get all events that have datetimes where its not expired.
+		$event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
+		$event_ids = array_keys($event_ids);
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$and_condition = array(
+			'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')),
+			'EVT_ID'               => array('NOT IN', $event_ids),
+		);
+		if (isset($where_params['OR'])) {
+			$and_condition['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		// merge remaining $where params with the and conditions.
+		$where_params['AND'] = array_merge($and_condition, $where_params);
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * This basically just returns the events that do not have the publish status.
+	 *
+	 * @param  array   $query_params An array of query params to further filter on
+	 *                               (note that status will be overwritten)
+	 * @param  boolean $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_inactive_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0]) ? $query_params[0] : array();
+		// let's add in specific query_params for inactive events.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$where_params['AND']['status'] = array('!=', 'publish');
+		if (isset($where_params['OR'])) {
+			$where_params['AND']['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
+	 * because we don't want to override any existing global default prices but instead insert NEW prices that get
+	 * attached to the event. See parent for param descriptions
+	 *
+	 * @param        $id_or_obj
+	 * @param        $other_model_id_or_obj
+	 * @param string $relationName
+	 * @param array  $where_query
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 */
+	public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
+	{
+		if ($relationName === 'Price') {
+			//let's get the PRC object for the given ID to make sure that we aren't dealing with a default
+			$prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
+			//if EVT_ID = 0, then this is a default
+			if ((int) $prc_chk->get('EVT_ID') === 0) {
+				//let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
+				$prc_chk->set('PRC_ID', 0);
+			}
+			//run parent
+			return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
+		}
+		//otherwise carry on as normal
+		return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
+	}
+
+
+
+	/******************** DEPRECATED METHODS ********************/
+
+
+
+	/**
+	 * _get_question_target_db_column
+	 *
+	 * @deprecated as of 4.8.32.rc.001. Instead consider using
+	 *             EE_Registration_Custom_Questions_Form located in
+	 *             admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
+	 * @access     public
+	 * @param    EE_Registration $registration (so existing answers for registration are included)
+	 * @param    int             $EVT_ID       so all question groups are included for event (not just answers from
+	 *                                         registration).
+	 * @throws EE_Error
+	 * @return    array
+	 */
+	public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
+	{
+		if (empty($EVT_ID)) {
+			throw new EE_Error(__('An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
+				'event_espresso'));
+		}
+		$questions = array();
+		// get all question groups for event
+		$qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
+		if (! empty($qgs)) {
+			foreach ($qgs as $qg) {
+				$qsts = $qg->questions();
+				$questions[$qg->ID()] = $qg->model_field_array();
+				$questions[$qg->ID()]['QSG_questions'] = array();
+				foreach ($qsts as $qst) {
+					if ($qst->is_system_question()) {
+						continue;
+					}
+					$answer = EEM_Answer::instance()->get_one(array(
+						array(
+							'QST_ID' => $qst->ID(),
+							'REG_ID' => $registration->ID(),
+						),
+					));
+					$answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
+					$qst_name = $qstn_id = $qst->ID();
+					$ans_id = $answer->ID();
+					$qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
+					$input_name = '';
+					$input_id = sanitize_key($qst->display_text());
+					$input_class = '';
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()] = $qst->model_field_array();
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn'
+																						   . $input_name
+																						   . $qst_name;
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id . '-' . $qstn_id;
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class;
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array();
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst;
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['ans_obj'] = $answer;
+					//leave responses as-is, don't convert stuff into html entities please!
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['htmlentities'] = false;
+					if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
+						$QSOs = $qst->options(true, $answer->value());
+						if (is_array($QSOs)) {
+							foreach ($QSOs as $QSO_ID => $QSO) {
+								$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] = $QSO->model_field_array();
+							}
+						}
+					}
+				}
+			}
+		}
+		return $questions;
+	}
 
 
 }

Spacing +8 added lines, -8 removed lines

@@ -1,9 +1,9 @@ 
 <?php use EventEspresso\core\services\orm\ModelFieldFactory;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
-require_once(EE_MODELS . 'EEM_CPT_Base.model.php');
+require_once(EE_MODELS.'EEM_CPT_Base.model.php');
 
 
 
@@ -273,7 +273,7 @@ 
      */
     public function get_all_event_question_groups($EVT_ID = 0)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
@@ -302,7 +302,7 @@ 
      */
     public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
@@ -334,7 +334,7 @@ 
      */
     public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
@@ -738,7 +738,7 @@ 
         $questions = array();
         // get all question groups for event
         $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
+        if ( ! empty($qgs)) {
             foreach ($qgs as $qg) {
                 $qsts = $qg->questions();
                 $questions[$qg->ID()] = $qg->model_field_array();
@@ -756,7 +756,7 @@ 
                     $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
                     $qst_name = $qstn_id = $qst->ID();
                     $ans_id = $answer->ID();
-                    $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
+                    $qst_name = ! empty($ans_id) ? '['.$qst_name.']['.$ans_id.']' : '['.$qst_name.']';
                     $input_name = '';
                     $input_id = sanitize_key($qst->display_text());
                     $input_class = '';
@@ -764,7 +764,7 @@ 
                     $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn'
                                                                                            . $input_name
                                                                                            . $qst_name;
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id . '-' . $qstn_id;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id.'-'.$qstn_id;
                     $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class;
                     $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array();
                     $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst;