eventespresso / event-espresso-core

core/db_models/EEM_CPT_Base.model.php

Indentation +558 added lines, -558 removed lines

@@ -16,562 +16,562 @@
 abstract class EEM_CPT_Base extends EEM_Soft_Delete_Base
 {
 
-    const EVENT_CATEGORY_TAXONOMY = 'espresso_event_categories';
-
-    /**
-     * @var string post_status_publish - the wp post status for published cpts
-     */
-    const post_status_publish = 'publish';
-
-    /**
-     * @var string post_status_future - the wp post status for scheduled cpts
-     */
-    const post_status_future = 'future';
-
-    /**
-     * @var string post_status_draft - the wp post status for draft cpts
-     */
-    const post_status_draft = 'draft';
-
-    /**
-     * @var string post_status_pending - the wp post status for pending cpts
-     */
-    const post_status_pending = 'pending';
-
-    /**
-     * @var string post_status_private - the wp post status for private cpts
-     */
-    const post_status_private = 'private';
-
-    /**
-     * @var string post_status_trashed - the wp post status for trashed cpts
-     */
-    const post_status_trashed = 'trash';
-
-    /**
-     * This is an array of custom statuses for the given CPT model (modified by children)
-     * format:
-     * array(
-     *        'status_name' => array(
-     *            'label' => __('Status Name', 'event_espresso'),
-     *            'public' => TRUE //whether a public status or not.
-     *        )
-     * )
-     *
-     * @var array
-     */
-    protected $_custom_stati = array();
-
-
-    /**
-     * Adds a relationship to Term_Taxonomy for each CPT_Base
-     *
-     * @param string $timezone
-     * @throws \EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        // adds a relationship to Term_Taxonomy for all these models. For this to work
-        // Term_Relationship must have a relation to each model subclassing EE_CPT_Base explicitly
-        // eg, in EEM_Term_Relationship, inside the _model_relations array, there must be an entry
-        // with key equalling the subclassing model's model name (eg 'Event' or 'Venue'), and the value
-        // must also be new EE_HABTM_Relation('Term_Relationship');
-        $this->_model_relations['Term_Taxonomy'] = new EE_HABTM_Relation('Term_Relationship');
-        $primary_table_name = null;
-        // add  the common _status field to all CPT primary tables.
-        foreach ($this->_tables as $alias => $table_obj) {
-            if ($table_obj instanceof EE_Primary_Table) {
-                $primary_table_name = $alias;
-            }
-        }
-        // set default wp post statuses if child has not already set.
-        if (! isset($this->_fields[ $primary_table_name ]['status'])) {
-            $this->_fields[ $primary_table_name ]['status'] = new EE_WP_Post_Status_Field(
-                'post_status',
-                __("Event Status", "event_espresso"),
-                false,
-                'draft'
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['to_ping'])) {
-            $this->_fields[ $primary_table_name ]['to_ping'] = new EE_DB_Only_Text_Field(
-                'to_ping',
-                __('To Ping', 'event_espresso'),
-                false,
-                ''
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['pinged'])) {
-            $this->_fields[ $primary_table_name ]['pinged'] = new EE_DB_Only_Text_Field(
-                'pinged',
-                __('Pinged', 'event_espresso'),
-                false,
-                ''
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['comment_status'])) {
-            $this->_fields[ $primary_table_name ]['comment_status'] = new EE_Plain_Text_Field(
-                'comment_status',
-                __('Comment Status', 'event_espresso'),
-                false,
-                'open'
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['ping_status'])) {
-            $this->_fields[ $primary_table_name ]['ping_status'] = new EE_Plain_Text_Field(
-                'ping_status',
-                __('Ping Status', 'event_espresso'),
-                false,
-                'open'
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['post_content_filtered'])) {
-            $this->_fields[ $primary_table_name ]['post_content_filtered'] = new EE_DB_Only_Text_Field(
-                'post_content_filtered',
-                __('Post Content Filtered', 'event_espresso'),
-                false,
-                ''
-            );
-        }
-        if (! isset($this->_model_relations['Post_Meta'])) {
-            // don't block deletes though because we want to maintain the current behaviour
-            $this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false);
-        }
-        if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            // nothing was set during child constructor, so set default
-            $this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type());
-        }
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            // nothing was set during child constructor, so set default
-            // it's ok for child classes to specify this, but generally this is more DRY
-            $this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type());
-        }
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function public_event_stati()
-    {
-        // @see wp-includes/post.php
-        return get_post_stati(array('public' => true));
-    }
-
-
-    /**
-     * Searches for field on this model of type 'deleted_flag'. if it is found,
-     * returns it's name. BUT That doesn't apply to CPTs. We should instead use post_status_field_name
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function deleted_field_name()
-    {
-        throw new EE_Error(
-            sprintf(
-                __(
-                    "EEM_CPT_Base should nto call deleted_field_name! It should instead use post_status_field_name",
-                    "event_espresso"
-                )
-            )
-        );
-    }
-
-
-    /**
-     * Gets the field's name that sets the post status
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function post_status_field_name()
-    {
-        $field = $this->get_a_field_of_type('EE_WP_Post_Status_Field');
-        if ($field) {
-            return $field->get_name();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'We are trying to find the post status flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params like EEM_Base::get_all's $query_params
-     * @return array like EEM_Base::get_all's $query_params
-     */
-    protected function _alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        $post_status_field_name = $this->post_status_field_name();
-        $query_params[0][ $post_status_field_name ] = self::post_status_trashed;
-        return $query_params;
-    }
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
-    {
-        $query_params['default_where_conditions'] = 'minimum';
-        return $query_params;
-    }
-
-
-    /**
-     * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
-     *
-     * @param boolean $delete       true to indicate deletion, false to indicate restoration
-     * @param array   $query_params like EEM_Base::get_all
-     * @return boolean success
-     */
-    public function delete_or_restore($delete = true, $query_params = array())
-    {
-        $post_status_field_name = $this->post_status_field_name();
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        $new_status = $delete ? self::post_status_trashed : 'draft';
-        if ($this->update(array($post_status_field_name => $new_status), $query_params)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * meta_table
-     * returns first EE_Secondary_Table table name
-     *
-     * @access public
-     * @return string
-     */
-    public function meta_table()
-    {
-        $meta_table = $this->_get_other_tables();
-        $meta_table = reset($meta_table);
-        return $meta_table instanceof EE_Secondary_Table ? $meta_table->get_table_name() : null;
-    }
-
-
-    /**
-     * This simply returns an array of the meta table fields (useful for when we just need to update those fields)
-     *
-     * @param  bool $all triggers whether we include DB_Only fields or JUST non DB_Only fields.  Defaults to false (no
-     *                   db only fields)
-     * @return array
-     */
-    public function get_meta_table_fields($all = false)
-    {
-        $all_fields = $fields_to_return = array();
-        foreach ($this->_tables as $alias => $table_obj) {
-            if ($table_obj instanceof EE_Secondary_Table) {
-                $all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields);
-            }
-        }
-        if (! $all) {
-            foreach ($all_fields as $name => $obj) {
-                if ($obj instanceof EE_DB_Only_Field_Base) {
-                    continue;
-                }
-                $fields_to_return[] = $name;
-            }
-        } else {
-            $fields_to_return = array_keys($all_fields);
-        }
-        return $fields_to_return;
-    }
-
-
-    /**
-     * Adds an event category with the specified name and description to the specified
-     * $cpt_model_object. Intelligently adds a term if necessary, and adds a term_taxonomy if necessary,
-     * and adds an entry in the term_relationship if necessary.
-     *
-     * @param EE_CPT_Base $cpt_model_object
-     * @param string      $category_name (used to derive the term slug too)
-     * @param string      $category_description
-     * @param int         $parent_term_taxonomy_id
-     * @return EE_Term_Taxonomy
-     */
-    public function add_event_category(
-        EE_CPT_Base $cpt_model_object,
-        $category_name,
-        $category_description = '',
-        $parent_term_taxonomy_id = null
-    ) {
-        // create term
-        require_once(EE_MODELS . 'EEM_Term.model.php');
-        // first, check for a term by the same name or slug
-        $category_slug = sanitize_title($category_name);
-        $term = EEM_Term::instance()->get_one(
-            array(
-                array(
-                    'OR' => array(
-                        'name' => $category_name,
-                        'slug' => $category_slug,
-                    ),
-                    'Term_Taxonomy.taxonomy' => self::EVENT_CATEGORY_TAXONOMY
-                ),
-            )
-        );
-        if (! $term) {
-            $term = EE_Term::new_instance(
-                array(
-                    'name' => $category_name,
-                    'slug' => $category_slug,
-                )
-            );
-            $term->save();
-        }
-        // make sure there's a term-taxonomy entry too
-        require_once(EE_MODELS . 'EEM_Term_Taxonomy.model.php');
-        $term_taxonomy = EEM_Term_Taxonomy::instance()->get_one(
-            array(
-                array(
-                    'term_id'  => $term->ID(),
-                    'taxonomy' => self::EVENT_CATEGORY_TAXONOMY,
-                ),
-            )
-        );
-        /** @var $term_taxonomy EE_Term_Taxonomy */
-        if (! $term_taxonomy) {
-            $term_taxonomy = EE_Term_Taxonomy::new_instance(
-                array(
-                    'term_id'     => $term->ID(),
-                    'taxonomy'    => self::EVENT_CATEGORY_TAXONOMY,
-                    'description' => $category_description,
-                    'term_count'       => 1,
-                    'parent'      => $parent_term_taxonomy_id,
-                )
-            );
-            $term_taxonomy->save();
-        } else {
-            $term_taxonomy->set_count($term_taxonomy->count() + 1);
-            $term_taxonomy->save();
-        }
-        return $this->add_relationship_to($cpt_model_object, $term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * Removed the category specified by name as having a relation to this event.
-     * Does not remove the term or term_taxonomy.
-     *
-     * @param EE_CPT_Base $cpt_model_object_event
-     * @param string      $category_name name of the event category (term)
-     * @return bool
-     */
-    public function remove_event_category(EE_CPT_Base $cpt_model_object_event, $category_name)
-    {
-        // find the term_taxonomy by that name
-        $term_taxonomy = $this->get_first_related(
-            $cpt_model_object_event,
-            'Term_Taxonomy',
-            array(array('Term.name' => $category_name, 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY))
-        );
-        /** @var $term_taxonomy EE_Term_Taxonomy */
-        if ($term_taxonomy) {
-            $term_taxonomy->set_count($term_taxonomy->count() - 1);
-            $term_taxonomy->save();
-        }
-        return $this->remove_relationship_to($cpt_model_object_event, $term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * This is a wrapper for the WordPress get_the_post_thumbnail() function that returns the feature image for the
-     * given CPT ID.  It accepts the same params as what get_the_post_thumbnail() accepts.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
-     * @access public
-     * @param int          $id   the ID for the cpt we want the feature image for
-     * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
-     *                           representing width and height in pixels (i.e. array(32,32) ).
-     * @param string|array $attr Optional. Query string or array of attributes.
-     * @return string HTML image element
-     */
-    public function get_feature_image($id, $size = 'thumbnail', $attr = '')
-    {
-        return get_the_post_thumbnail($id, $size, $attr);
-    }
-
-
-    /**
-     * Just a handy way to get the list of post statuses currently registered with WP.
-     *
-     * @global array $wp_post_statuses set in wp core for storing all the post stati
-     * @return array
-     */
-    public function get_post_statuses()
-    {
-        global $wp_post_statuses;
-        $statuses = array();
-        foreach ($wp_post_statuses as $post_status => $args_object) {
-            $statuses[ $post_status ] = $args_object->label;
-        }
-        return $statuses;
-    }
-
-
-    /**
-     * public method that can be used to retrieve the protected status array on the instantiated cpt model
-     *
-     * @return array array of statuses.
-     */
-    public function get_status_array()
-    {
-        $statuses = $this->get_post_statuses();
-        // first the global filter
-        $statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses);
-        // now the class specific filter
-        $statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses);
-        return $statuses;
-    }
-
-
-    /**
-     * this returns the post statuses that are NOT the default wordpress status
-     *
-     * @return array
-     */
-    public function get_custom_post_statuses()
-    {
-        $new_stati = array();
-        foreach ($this->_custom_stati as $status => $props) {
-            $new_stati[ $status ] = $props['label'];
-        }
-        return $new_stati;
-    }
-
-
-    /**
-     * Creates a child of EE_CPT_Base given a WP_Post or array of wpdb results which
-     * are a row from the posts table. If we're missing any fields required for the model,
-     * we just fetch the entire entry from the DB (ie, if you want to use this to save DB queries,
-     * make sure you are attaching all the model's fields onto the post)
-     *
-     * @param WP_Post|array $post
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class
-     */
-    public function instantiate_class_from_post_object_orig($post)
-    {
-        $post = (array) $post;
-        $has_all_necessary_fields_for_table = true;
-        // check if the post has fields on the meta table already
-        foreach ($this->_get_other_tables() as $table_obj) {
-            $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
-            foreach ($fields_for_that_table as $field_obj) {
-                if (! isset($post[ $field_obj->get_table_column() ])
-                    && ! isset($post[ $field_obj->get_qualified_column() ])
-                ) {
-                    $has_all_necessary_fields_for_table = false;
-                }
-            }
-        }
-        // if we don't have all the fields we need, then just fetch the proper model from the DB
-        if (! $has_all_necessary_fields_for_table) {
-            return $this->get_one_by_ID($post['ID']);
-        } else {
-            return $this->instantiate_class_from_array_or_object($post);
-        }
-    }
-
-
-    /**
-     * @param null $post
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class
-     */
-    public function instantiate_class_from_post_object($post = null)
-    {
-        if (empty($post)) {
-            global $post;
-        }
-        $post = (array) $post;
-        $tables_needing_to_be_queried = array();
-        // check if the post has fields on the meta table already
-        foreach ($this->get_tables() as $table_obj) {
-            $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
-            foreach ($fields_for_that_table as $field_obj) {
-                if (! isset($post[ $field_obj->get_table_column() ])
-                    && ! isset($post[ $field_obj->get_qualified_column() ])
-                ) {
-                    $tables_needing_to_be_queried[ $table_obj->get_table_alias() ] = $table_obj;
-                }
-            }
-        }
-        // if we don't have all the fields we need, then just fetch the proper model from the DB
-        if ($tables_needing_to_be_queried) {
-            if (count($tables_needing_to_be_queried) == 1
-                && reset($tables_needing_to_be_queried)
-                   instanceof
-                   EE_Secondary_Table
-            ) {
-                // so we're only missing data from a secondary table. Well that's not too hard to query for
-                $table_to_query = reset($tables_needing_to_be_queried);
-                $missing_data = $this->_do_wpdb_query(
-                    'get_row',
-                    array(
-                        'SELECT * FROM '
-                        . $table_to_query->get_table_name()
-                        . ' WHERE '
-                        . $table_to_query->get_fk_on_table()
-                        . ' = '
-                        . $post['ID'],
-                        ARRAY_A,
-                    )
-                );
-                if (! empty($missing_data)) {
-                    $post = array_merge($post, $missing_data);
-                }
-            } else {
-                return $this->get_one_by_ID($post['ID']);
-            }
-        }
-        return $this->instantiate_class_from_array_or_object($post);
-    }
-
-
-    /**
-     * Gets the post type associated with this
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function post_type()
-    {
-        $post_type_field = null;
-        foreach ($this->field_settings(true) as $field_obj) {
-            if ($field_obj instanceof EE_WP_Post_Type_Field) {
-                $post_type_field = $field_obj;
-                break;
-            }
-        }
-        if ($post_type_field == null) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "CPT Model %s should have a field of type EE_WP_Post_Type, but doesnt",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $post_type_field->get_default_value();
-    }
+	const EVENT_CATEGORY_TAXONOMY = 'espresso_event_categories';
+
+	/**
+	 * @var string post_status_publish - the wp post status for published cpts
+	 */
+	const post_status_publish = 'publish';
+
+	/**
+	 * @var string post_status_future - the wp post status for scheduled cpts
+	 */
+	const post_status_future = 'future';
+
+	/**
+	 * @var string post_status_draft - the wp post status for draft cpts
+	 */
+	const post_status_draft = 'draft';
+
+	/**
+	 * @var string post_status_pending - the wp post status for pending cpts
+	 */
+	const post_status_pending = 'pending';
+
+	/**
+	 * @var string post_status_private - the wp post status for private cpts
+	 */
+	const post_status_private = 'private';
+
+	/**
+	 * @var string post_status_trashed - the wp post status for trashed cpts
+	 */
+	const post_status_trashed = 'trash';
+
+	/**
+	 * This is an array of custom statuses for the given CPT model (modified by children)
+	 * format:
+	 * array(
+	 *        'status_name' => array(
+	 *            'label' => __('Status Name', 'event_espresso'),
+	 *            'public' => TRUE //whether a public status or not.
+	 *        )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_custom_stati = array();
+
+
+	/**
+	 * Adds a relationship to Term_Taxonomy for each CPT_Base
+	 *
+	 * @param string $timezone
+	 * @throws \EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		// adds a relationship to Term_Taxonomy for all these models. For this to work
+		// Term_Relationship must have a relation to each model subclassing EE_CPT_Base explicitly
+		// eg, in EEM_Term_Relationship, inside the _model_relations array, there must be an entry
+		// with key equalling the subclassing model's model name (eg 'Event' or 'Venue'), and the value
+		// must also be new EE_HABTM_Relation('Term_Relationship');
+		$this->_model_relations['Term_Taxonomy'] = new EE_HABTM_Relation('Term_Relationship');
+		$primary_table_name = null;
+		// add  the common _status field to all CPT primary tables.
+		foreach ($this->_tables as $alias => $table_obj) {
+			if ($table_obj instanceof EE_Primary_Table) {
+				$primary_table_name = $alias;
+			}
+		}
+		// set default wp post statuses if child has not already set.
+		if (! isset($this->_fields[ $primary_table_name ]['status'])) {
+			$this->_fields[ $primary_table_name ]['status'] = new EE_WP_Post_Status_Field(
+				'post_status',
+				__("Event Status", "event_espresso"),
+				false,
+				'draft'
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['to_ping'])) {
+			$this->_fields[ $primary_table_name ]['to_ping'] = new EE_DB_Only_Text_Field(
+				'to_ping',
+				__('To Ping', 'event_espresso'),
+				false,
+				''
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['pinged'])) {
+			$this->_fields[ $primary_table_name ]['pinged'] = new EE_DB_Only_Text_Field(
+				'pinged',
+				__('Pinged', 'event_espresso'),
+				false,
+				''
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['comment_status'])) {
+			$this->_fields[ $primary_table_name ]['comment_status'] = new EE_Plain_Text_Field(
+				'comment_status',
+				__('Comment Status', 'event_espresso'),
+				false,
+				'open'
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['ping_status'])) {
+			$this->_fields[ $primary_table_name ]['ping_status'] = new EE_Plain_Text_Field(
+				'ping_status',
+				__('Ping Status', 'event_espresso'),
+				false,
+				'open'
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['post_content_filtered'])) {
+			$this->_fields[ $primary_table_name ]['post_content_filtered'] = new EE_DB_Only_Text_Field(
+				'post_content_filtered',
+				__('Post Content Filtered', 'event_espresso'),
+				false,
+				''
+			);
+		}
+		if (! isset($this->_model_relations['Post_Meta'])) {
+			// don't block deletes though because we want to maintain the current behaviour
+			$this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false);
+		}
+		if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			// nothing was set during child constructor, so set default
+			$this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type());
+		}
+		if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			// nothing was set during child constructor, so set default
+			// it's ok for child classes to specify this, but generally this is more DRY
+			$this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type());
+		}
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function public_event_stati()
+	{
+		// @see wp-includes/post.php
+		return get_post_stati(array('public' => true));
+	}
+
+
+	/**
+	 * Searches for field on this model of type 'deleted_flag'. if it is found,
+	 * returns it's name. BUT That doesn't apply to CPTs. We should instead use post_status_field_name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function deleted_field_name()
+	{
+		throw new EE_Error(
+			sprintf(
+				__(
+					"EEM_CPT_Base should nto call deleted_field_name! It should instead use post_status_field_name",
+					"event_espresso"
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the field's name that sets the post status
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function post_status_field_name()
+	{
+		$field = $this->get_a_field_of_type('EE_WP_Post_Status_Field');
+		if ($field) {
+			return $field->get_name();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'We are trying to find the post status flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
+						'event_espresso'
+					),
+					get_class($this),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params like EEM_Base::get_all's $query_params
+	 * @return array like EEM_Base::get_all's $query_params
+	 */
+	protected function _alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		$post_status_field_name = $this->post_status_field_name();
+		$query_params[0][ $post_status_field_name ] = self::post_status_trashed;
+		return $query_params;
+	}
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
+	{
+		$query_params['default_where_conditions'] = 'minimum';
+		return $query_params;
+	}
+
+
+	/**
+	 * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
+	 *
+	 * @param boolean $delete       true to indicate deletion, false to indicate restoration
+	 * @param array   $query_params like EEM_Base::get_all
+	 * @return boolean success
+	 */
+	public function delete_or_restore($delete = true, $query_params = array())
+	{
+		$post_status_field_name = $this->post_status_field_name();
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		$new_status = $delete ? self::post_status_trashed : 'draft';
+		if ($this->update(array($post_status_field_name => $new_status), $query_params)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * meta_table
+	 * returns first EE_Secondary_Table table name
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function meta_table()
+	{
+		$meta_table = $this->_get_other_tables();
+		$meta_table = reset($meta_table);
+		return $meta_table instanceof EE_Secondary_Table ? $meta_table->get_table_name() : null;
+	}
+
+
+	/**
+	 * This simply returns an array of the meta table fields (useful for when we just need to update those fields)
+	 *
+	 * @param  bool $all triggers whether we include DB_Only fields or JUST non DB_Only fields.  Defaults to false (no
+	 *                   db only fields)
+	 * @return array
+	 */
+	public function get_meta_table_fields($all = false)
+	{
+		$all_fields = $fields_to_return = array();
+		foreach ($this->_tables as $alias => $table_obj) {
+			if ($table_obj instanceof EE_Secondary_Table) {
+				$all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields);
+			}
+		}
+		if (! $all) {
+			foreach ($all_fields as $name => $obj) {
+				if ($obj instanceof EE_DB_Only_Field_Base) {
+					continue;
+				}
+				$fields_to_return[] = $name;
+			}
+		} else {
+			$fields_to_return = array_keys($all_fields);
+		}
+		return $fields_to_return;
+	}
+
+
+	/**
+	 * Adds an event category with the specified name and description to the specified
+	 * $cpt_model_object. Intelligently adds a term if necessary, and adds a term_taxonomy if necessary,
+	 * and adds an entry in the term_relationship if necessary.
+	 *
+	 * @param EE_CPT_Base $cpt_model_object
+	 * @param string      $category_name (used to derive the term slug too)
+	 * @param string      $category_description
+	 * @param int         $parent_term_taxonomy_id
+	 * @return EE_Term_Taxonomy
+	 */
+	public function add_event_category(
+		EE_CPT_Base $cpt_model_object,
+		$category_name,
+		$category_description = '',
+		$parent_term_taxonomy_id = null
+	) {
+		// create term
+		require_once(EE_MODELS . 'EEM_Term.model.php');
+		// first, check for a term by the same name or slug
+		$category_slug = sanitize_title($category_name);
+		$term = EEM_Term::instance()->get_one(
+			array(
+				array(
+					'OR' => array(
+						'name' => $category_name,
+						'slug' => $category_slug,
+					),
+					'Term_Taxonomy.taxonomy' => self::EVENT_CATEGORY_TAXONOMY
+				),
+			)
+		);
+		if (! $term) {
+			$term = EE_Term::new_instance(
+				array(
+					'name' => $category_name,
+					'slug' => $category_slug,
+				)
+			);
+			$term->save();
+		}
+		// make sure there's a term-taxonomy entry too
+		require_once(EE_MODELS . 'EEM_Term_Taxonomy.model.php');
+		$term_taxonomy = EEM_Term_Taxonomy::instance()->get_one(
+			array(
+				array(
+					'term_id'  => $term->ID(),
+					'taxonomy' => self::EVENT_CATEGORY_TAXONOMY,
+				),
+			)
+		);
+		/** @var $term_taxonomy EE_Term_Taxonomy */
+		if (! $term_taxonomy) {
+			$term_taxonomy = EE_Term_Taxonomy::new_instance(
+				array(
+					'term_id'     => $term->ID(),
+					'taxonomy'    => self::EVENT_CATEGORY_TAXONOMY,
+					'description' => $category_description,
+					'term_count'       => 1,
+					'parent'      => $parent_term_taxonomy_id,
+				)
+			);
+			$term_taxonomy->save();
+		} else {
+			$term_taxonomy->set_count($term_taxonomy->count() + 1);
+			$term_taxonomy->save();
+		}
+		return $this->add_relationship_to($cpt_model_object, $term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * Removed the category specified by name as having a relation to this event.
+	 * Does not remove the term or term_taxonomy.
+	 *
+	 * @param EE_CPT_Base $cpt_model_object_event
+	 * @param string      $category_name name of the event category (term)
+	 * @return bool
+	 */
+	public function remove_event_category(EE_CPT_Base $cpt_model_object_event, $category_name)
+	{
+		// find the term_taxonomy by that name
+		$term_taxonomy = $this->get_first_related(
+			$cpt_model_object_event,
+			'Term_Taxonomy',
+			array(array('Term.name' => $category_name, 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY))
+		);
+		/** @var $term_taxonomy EE_Term_Taxonomy */
+		if ($term_taxonomy) {
+			$term_taxonomy->set_count($term_taxonomy->count() - 1);
+			$term_taxonomy->save();
+		}
+		return $this->remove_relationship_to($cpt_model_object_event, $term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * This is a wrapper for the WordPress get_the_post_thumbnail() function that returns the feature image for the
+	 * given CPT ID.  It accepts the same params as what get_the_post_thumbnail() accepts.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
+	 * @access public
+	 * @param int          $id   the ID for the cpt we want the feature image for
+	 * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
+	 *                           representing width and height in pixels (i.e. array(32,32) ).
+	 * @param string|array $attr Optional. Query string or array of attributes.
+	 * @return string HTML image element
+	 */
+	public function get_feature_image($id, $size = 'thumbnail', $attr = '')
+	{
+		return get_the_post_thumbnail($id, $size, $attr);
+	}
+
+
+	/**
+	 * Just a handy way to get the list of post statuses currently registered with WP.
+	 *
+	 * @global array $wp_post_statuses set in wp core for storing all the post stati
+	 * @return array
+	 */
+	public function get_post_statuses()
+	{
+		global $wp_post_statuses;
+		$statuses = array();
+		foreach ($wp_post_statuses as $post_status => $args_object) {
+			$statuses[ $post_status ] = $args_object->label;
+		}
+		return $statuses;
+	}
+
+
+	/**
+	 * public method that can be used to retrieve the protected status array on the instantiated cpt model
+	 *
+	 * @return array array of statuses.
+	 */
+	public function get_status_array()
+	{
+		$statuses = $this->get_post_statuses();
+		// first the global filter
+		$statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses);
+		// now the class specific filter
+		$statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses);
+		return $statuses;
+	}
+
+
+	/**
+	 * this returns the post statuses that are NOT the default wordpress status
+	 *
+	 * @return array
+	 */
+	public function get_custom_post_statuses()
+	{
+		$new_stati = array();
+		foreach ($this->_custom_stati as $status => $props) {
+			$new_stati[ $status ] = $props['label'];
+		}
+		return $new_stati;
+	}
+
+
+	/**
+	 * Creates a child of EE_CPT_Base given a WP_Post or array of wpdb results which
+	 * are a row from the posts table. If we're missing any fields required for the model,
+	 * we just fetch the entire entry from the DB (ie, if you want to use this to save DB queries,
+	 * make sure you are attaching all the model's fields onto the post)
+	 *
+	 * @param WP_Post|array $post
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class
+	 */
+	public function instantiate_class_from_post_object_orig($post)
+	{
+		$post = (array) $post;
+		$has_all_necessary_fields_for_table = true;
+		// check if the post has fields on the meta table already
+		foreach ($this->_get_other_tables() as $table_obj) {
+			$fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
+			foreach ($fields_for_that_table as $field_obj) {
+				if (! isset($post[ $field_obj->get_table_column() ])
+					&& ! isset($post[ $field_obj->get_qualified_column() ])
+				) {
+					$has_all_necessary_fields_for_table = false;
+				}
+			}
+		}
+		// if we don't have all the fields we need, then just fetch the proper model from the DB
+		if (! $has_all_necessary_fields_for_table) {
+			return $this->get_one_by_ID($post['ID']);
+		} else {
+			return $this->instantiate_class_from_array_or_object($post);
+		}
+	}
+
+
+	/**
+	 * @param null $post
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class
+	 */
+	public function instantiate_class_from_post_object($post = null)
+	{
+		if (empty($post)) {
+			global $post;
+		}
+		$post = (array) $post;
+		$tables_needing_to_be_queried = array();
+		// check if the post has fields on the meta table already
+		foreach ($this->get_tables() as $table_obj) {
+			$fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
+			foreach ($fields_for_that_table as $field_obj) {
+				if (! isset($post[ $field_obj->get_table_column() ])
+					&& ! isset($post[ $field_obj->get_qualified_column() ])
+				) {
+					$tables_needing_to_be_queried[ $table_obj->get_table_alias() ] = $table_obj;
+				}
+			}
+		}
+		// if we don't have all the fields we need, then just fetch the proper model from the DB
+		if ($tables_needing_to_be_queried) {
+			if (count($tables_needing_to_be_queried) == 1
+				&& reset($tables_needing_to_be_queried)
+				   instanceof
+				   EE_Secondary_Table
+			) {
+				// so we're only missing data from a secondary table. Well that's not too hard to query for
+				$table_to_query = reset($tables_needing_to_be_queried);
+				$missing_data = $this->_do_wpdb_query(
+					'get_row',
+					array(
+						'SELECT * FROM '
+						. $table_to_query->get_table_name()
+						. ' WHERE '
+						. $table_to_query->get_fk_on_table()
+						. ' = '
+						. $post['ID'],
+						ARRAY_A,
+					)
+				);
+				if (! empty($missing_data)) {
+					$post = array_merge($post, $missing_data);
+				}
+			} else {
+				return $this->get_one_by_ID($post['ID']);
+			}
+		}
+		return $this->instantiate_class_from_array_or_object($post);
+	}
+
+
+	/**
+	 * Gets the post type associated with this
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function post_type()
+	{
+		$post_type_field = null;
+		foreach ($this->field_settings(true) as $field_obj) {
+			if ($field_obj instanceof EE_WP_Post_Type_Field) {
+				$post_type_field = $field_obj;
+				break;
+			}
+		}
+		if ($post_type_field == null) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"CPT Model %s should have a field of type EE_WP_Post_Type, but doesnt",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $post_type_field->get_default_value();
+	}
 }

core/EE_Cron_Tasks.core.php

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 use EventEspresso\core\exceptions\InvalidDataTypeException;
 use EventEspresso\core\exceptions\InvalidInterfaceException;
-use EventEspresso\core\services\loaders\Loader;
 use EventEspresso\core\services\loaders\LoaderFactory;
 
 /**

Indentation +586 added lines, -586 removed lines

@@ -15,590 +15,590 @@
 class EE_Cron_Tasks extends EE_Base
 {
 
-    /**
-     * WordPress doesn't allow duplicate crons within 10 minutes of the original,
-     * so we'll set our retry time for just over 10 minutes to avoid that
-     */
-    const reschedule_timeout = 605;
-
-
-    /**
-     * @var EE_Cron_Tasks
-     */
-    private static $_instance;
-
-
-    /**
-     * @return EE_Cron_Tasks
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function instance()
-    {
-        if (! self::$_instance instanceof EE_Cron_Tasks) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @access private
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function __construct()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // verify that WP Cron is enabled
-        if (defined('DISABLE_WP_CRON')
-            && DISABLE_WP_CRON
-            && is_admin()
-            && ! get_option('ee_disabled_wp_cron_check')
-        ) {
-            /**
-             * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
-             * config is loaded.
-             * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
-             * wanting to not have this functionality can just register its own action at a priority after this one to
-             * reverse any changes.
-             */
-            add_action(
-                'AHEE__EE_System__load_core_configuration__complete',
-                function () {
-                    EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
-                    EE_Registry::instance()->NET_CFG->update_config(true, false);
-                    add_option('ee_disabled_wp_cron_check', 1, '', false);
-                }
-            );
-        }
-        // UPDATE TRANSACTION WITH PAYMENT
-        add_action(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-            array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
-            10,
-            2
-        );
-        // ABANDONED / EXPIRED TRANSACTION CHECK
-        add_action(
-            'AHEE__EE_Cron_Tasks__expired_transaction_check',
-            array('EE_Cron_Tasks', 'expired_transaction_check'),
-            10,
-            1
-        );
-        // CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
-        add_action(
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-            array('EE_Cron_Tasks', 'clean_out_junk_transactions')
-        );
-        // logging
-        add_action(
-            'AHEE__EE_System__load_core_configuration__complete',
-            array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
-        );
-        EE_Registry::instance()->load_lib('Messages_Scheduler');
-        // clean out old gateway logs
-        add_action(
-            'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
-            array('EE_Cron_Tasks', 'clean_out_old_gateway_logs')
-        );
-    }
-
-
-    /**
-     * @access protected
-     * @return void
-     */
-    public static function log_scheduled_ee_crons()
-    {
-        $ee_crons = array(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
-            'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-        );
-        $crons = (array) get_option('cron');
-        if (! is_array($crons)) {
-            return;
-        }
-        foreach ($crons as $timestamp => $cron) {
-            /** @var array[] $cron */
-            foreach ($ee_crons as $ee_cron) {
-                if (isset($cron[ $ee_cron ]) && is_array($cron[ $ee_cron ])) {
-                    do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
-                    foreach ($cron[ $ee_cron ] as $ee_cron_details) {
-                        if (! empty($ee_cron_details['args'])) {
-                            do_action(
-                                'AHEE_log',
-                                __CLASS__,
-                                __FUNCTION__,
-                                print_r($ee_cron_details['args'], true),
-                                "{$ee_cron} args"
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * reschedule_cron_for_transactions_if_maintenance_mode
-     * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
-     *
-     * @param string $cron_task
-     * @param array  $TXN_IDs
-     * @return bool
-     * @throws DomainException
-     */
-    public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
-    {
-        if (! method_exists('EE_Cron_Tasks', $cron_task)) {
-            throw new DomainException(
-                sprintf(
-                    __('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
-                    $cron_task
-                )
-            );
-        }
-        // reschedule the cron if we can't hit the db right now
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-            foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
-                // ensure $additional_vars is an array
-                $additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
-                // reset cron job for the TXN
-                call_user_func_array(
-                    array('EE_Cron_Tasks', $cron_task),
-                    array_merge(
-                        array(
-                            time() + (10 * MINUTE_IN_SECONDS),
-                            $TXN_ID,
-                        ),
-                        $additional_vars
-                    )
-                );
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-
-
-    /****************  UPDATE TRANSACTION WITH PAYMENT ****************/
-
-
-    /**
-     * array of TXN IDs and the payment
-     *
-     * @var array
-     */
-    protected static $_update_transactions_with_payment = array();
-
-
-    /**
-     * schedule_update_transaction_with_payment
-     * sets a wp_schedule_single_event() for updating any TXNs that may
-     * require updating due to recently received payments
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function schedule_update_transaction_with_payment(
-        $timestamp,
-        $TXN_ID,
-        $PAY_ID
-    ) {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // validate $TXN_ID and $timestamp
-        $TXN_ID = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-                array($TXN_ID, $PAY_ID)
-            );
-        }
-    }
-
-
-    /**
-     * setup_update_for_transaction_with_payment
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
-     * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
-     * The passed TXN_ID and associated payment gets added to an array, and then
-     * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
-     * 'shutdown' which will actually handle the processing of any
-     * transactions requiring updating, because doing so now would be too early
-     * and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function setup_update_for_transaction_with_payment($TXN_ID = 0, $PAY_ID = 0)
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
-        if (absint($TXN_ID)) {
-            self::$_update_transactions_with_payment[ $TXN_ID ] = $PAY_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'update_transaction_with_payment'),
-                5
-            );
-        }
-    }
-
-
-    /**
-     * update_transaction_with_payment
-     * loops through the self::$_abandoned_transactions array
-     * and attempts to finalize any TXNs that have not been completed
-     * but have had their sessions expired, most likely due to a user not
-     * returning from an off-site payment gateway
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public static function update_transaction_with_payment()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        if (// are there any TXNs that need cleaning up ?
-            empty(self::$_update_transactions_with_payment)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_update_transaction_with_payment',
-                self::$_update_transactions_with_payment
-            )
-        ) {
-            return;
-        }
-        /** @type EE_Payment_Processor $payment_processor */
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        // set revisit flag for payment processor
-        $payment_processor->set_revisit();
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
-            // reschedule the cron if we can't hit the db right now
-            if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-                // reset cron job for updating the TXN
-                EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                    time() + EE_Cron_Tasks::reschedule_timeout,
-                    $TXN_ID,
-                    $PAY_ID
-                );
-                continue;
-            }
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            $payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
-            // verify transaction
-            if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
-                // now try to update the TXN with any payments
-                $payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
-            }
-            unset(self::$_update_transactions_with_payment[ $TXN_ID ]);
-        }
-    }
-
-
-
-    /************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
-
-
-    /*****************  EXPIRED TRANSACTION CHECK *****************/
-
-
-    /**
-     * array of TXN IDs
-     *
-     * @var array
-     */
-    protected static $_expired_transactions = array();
-
-
-    /**
-     * schedule_expired_transaction_check
-     * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     */
-    public static function schedule_expired_transaction_check(
-        $timestamp,
-        $TXN_ID
-    ) {
-        // validate $TXN_ID and $timestamp
-        $TXN_ID = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__expired_transaction_check',
-                array($TXN_ID)
-            );
-        }
-    }
-
-
-    /**
-     * expired_transaction_check
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
-     * which is utilized by wp_schedule_single_event()
-     * in \EED_Single_Page_Checkout::_initialize_transaction().
-     * The passed TXN_ID gets added to an array, and then the
-     * process_expired_transactions() function is hooked into
-     * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
-     * processing of any failed transactions, because doing so now would be
-     * too early and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     */
-    public static function expired_transaction_check($TXN_ID = 0)
-    {
-        if (absint($TXN_ID)) {
-            self::$_expired_transactions[ $TXN_ID ] = $TXN_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'process_expired_transactions'),
-                5
-            );
-        }
-    }
-
-
-    /**
-     * process_expired_transactions
-     * loops through the self::$_expired_transactions array and processes any failed TXNs
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws DomainException
-     * @throws RuntimeException
-     */
-    public static function process_expired_transactions()
-    {
-        if (// are there any TXNs that need cleaning up ?
-            empty(self::$_expired_transactions)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_expired_transaction_check',
-                self::$_expired_transactions
-            )
-        ) {
-            return;
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // set revisit flag for txn processor
-        $transaction_processor->set_revisit();
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_expired_transactions as $TXN_ID) {
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            // verify transaction and whether it is failed or not
-            if ($transaction instanceof EE_Transaction) {
-                switch ($transaction->status_ID()) {
-                    // Completed TXNs
-                    case EEM_Transaction::complete_status_code:
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
-                            $transaction
-                        );
-                        break;
-                    // Overpaid TXNs
-                    case EEM_Transaction::overpaid_status_code:
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
-                            $transaction
-                        );
-                        break;
-                    // Incomplete TXNs
-                    case EEM_Transaction::incomplete_status_code:
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-                            $transaction
-                        );
-                        // todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
-                        break;
-                    // Abandoned TXNs
-                    case EEM_Transaction::abandoned_status_code:
-                        // run hook before updating transaction, primarily so
-                        // EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
-                            $transaction
-                        );
-                        // don't finalize the TXN if it has already been completed
-                        if ($transaction->all_reg_steps_completed() !== true) {
-                            /** @type EE_Payment_Processor $payment_processor */
-                            $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-                            // let's simulate an IPN here which will trigger any notifications that need to go out
-                            $payment_processor->update_txn_based_on_payment(
-                                $transaction,
-                                $transaction->last_payment(),
-                                true,
-                                true
-                            );
-                        }
-                        break;
-                    // Failed TXNs
-                    case EEM_Transaction::failed_status_code:
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-                            $transaction
-                        );
-                        // todo :
-                        // perform garbage collection here and remove clean_out_junk_transactions()
-                        // $registrations = $transaction->registrations();
-                        // if (! empty($registrations)) {
-                        //     foreach ($registrations as $registration) {
-                        //         if ($registration instanceof EE_Registration) {
-                        //             $delete_registration = true;
-                        //             if ($registration->attendee() instanceof EE_Attendee) {
-                        //                 $delete_registration = false;
-                        //             }
-                        //             if ($delete_registration) {
-                        //                 $registration->delete_permanently();
-                        //                 $registration->delete_related_permanently();
-                        //             }
-                        //         }
-                        //     }
-                        // }
-                        break;
-                }
-            }
-            unset(self::$_expired_transactions[ $TXN_ID ]);
-        }
-    }
-
-
-
-    /*************  END OF EXPIRED TRANSACTION CHECK  *************/
-
-
-    /************* START CLEAN UP BOT TRANSACTIONS **********************/
-
-
-    /**
-     * callback for 'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'
-     * which is setup during activation to run on an hourly cron
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws DomainException
-     */
-    public static function clean_out_junk_transactions()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            EED_Ticket_Sales_Monitor::reset_reservation_counts();
-            EEM_Transaction::instance('')->delete_junk_transactions();
-            EEM_Registration::instance('')->delete_registrations_with_no_transaction();
-            EEM_Line_Item::instance('')->delete_line_items_with_no_transaction();
-        }
-    }
-
-
-    /**
-     * Deletes old gateway logs. After about a week we usually don't need them for debugging. But folks can filter that.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function clean_out_old_gateway_logs()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
-            $time_diff_for_comparison = apply_filters(
-                'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
-                '-' . $reg_config->gateway_log_lifespan
-            );
-            EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
-        }
-    }
-
-
-    /*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
-
-
-    /**
-     * @var array
-     */
-    protected static $_abandoned_transactions = array();
-
-
-    /**
-     * @deprecated
-     * @param int $timestamp
-     * @param int $TXN_ID
-     */
-    public static function schedule_finalize_abandoned_transactions_check($timestamp, $TXN_ID)
-    {
-        EE_Cron_Tasks::schedule_expired_transaction_check($timestamp, $TXN_ID);
-    }
-
-
-    /**
-     * @deprecated
-     * @param int $TXN_ID
-     */
-    public static function check_for_abandoned_transactions($TXN_ID = 0)
-    {
-        EE_Cron_Tasks::expired_transaction_check($TXN_ID);
-    }
-
-
-    /**
-     * @deprecated
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public static function finalize_abandoned_transactions()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        if (// are there any TXNs that need cleaning up ?
-            empty(self::$_abandoned_transactions)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_expired_transaction_check',
-                self::$_abandoned_transactions
-            )
-        ) {
-            return;
-        }
-        // combine our arrays of transaction IDs
-        self::$_expired_transactions = self::$_abandoned_transactions + self::$_expired_transactions;
-        // and deal with abandoned transactions here now...
-        EE_Cron_Tasks::process_expired_transactions();
-    }
-
-
-    /*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
+	/**
+	 * WordPress doesn't allow duplicate crons within 10 minutes of the original,
+	 * so we'll set our retry time for just over 10 minutes to avoid that
+	 */
+	const reschedule_timeout = 605;
+
+
+	/**
+	 * @var EE_Cron_Tasks
+	 */
+	private static $_instance;
+
+
+	/**
+	 * @return EE_Cron_Tasks
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function instance()
+	{
+		if (! self::$_instance instanceof EE_Cron_Tasks) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @access private
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function __construct()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// verify that WP Cron is enabled
+		if (defined('DISABLE_WP_CRON')
+			&& DISABLE_WP_CRON
+			&& is_admin()
+			&& ! get_option('ee_disabled_wp_cron_check')
+		) {
+			/**
+			 * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
+			 * config is loaded.
+			 * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
+			 * wanting to not have this functionality can just register its own action at a priority after this one to
+			 * reverse any changes.
+			 */
+			add_action(
+				'AHEE__EE_System__load_core_configuration__complete',
+				function () {
+					EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
+					EE_Registry::instance()->NET_CFG->update_config(true, false);
+					add_option('ee_disabled_wp_cron_check', 1, '', false);
+				}
+			);
+		}
+		// UPDATE TRANSACTION WITH PAYMENT
+		add_action(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+			array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
+			10,
+			2
+		);
+		// ABANDONED / EXPIRED TRANSACTION CHECK
+		add_action(
+			'AHEE__EE_Cron_Tasks__expired_transaction_check',
+			array('EE_Cron_Tasks', 'expired_transaction_check'),
+			10,
+			1
+		);
+		// CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
+		add_action(
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+			array('EE_Cron_Tasks', 'clean_out_junk_transactions')
+		);
+		// logging
+		add_action(
+			'AHEE__EE_System__load_core_configuration__complete',
+			array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
+		);
+		EE_Registry::instance()->load_lib('Messages_Scheduler');
+		// clean out old gateway logs
+		add_action(
+			'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
+			array('EE_Cron_Tasks', 'clean_out_old_gateway_logs')
+		);
+	}
+
+
+	/**
+	 * @access protected
+	 * @return void
+	 */
+	public static function log_scheduled_ee_crons()
+	{
+		$ee_crons = array(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
+			'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+		);
+		$crons = (array) get_option('cron');
+		if (! is_array($crons)) {
+			return;
+		}
+		foreach ($crons as $timestamp => $cron) {
+			/** @var array[] $cron */
+			foreach ($ee_crons as $ee_cron) {
+				if (isset($cron[ $ee_cron ]) && is_array($cron[ $ee_cron ])) {
+					do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
+					foreach ($cron[ $ee_cron ] as $ee_cron_details) {
+						if (! empty($ee_cron_details['args'])) {
+							do_action(
+								'AHEE_log',
+								__CLASS__,
+								__FUNCTION__,
+								print_r($ee_cron_details['args'], true),
+								"{$ee_cron} args"
+							);
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * reschedule_cron_for_transactions_if_maintenance_mode
+	 * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
+	 *
+	 * @param string $cron_task
+	 * @param array  $TXN_IDs
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
+	{
+		if (! method_exists('EE_Cron_Tasks', $cron_task)) {
+			throw new DomainException(
+				sprintf(
+					__('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
+					$cron_task
+				)
+			);
+		}
+		// reschedule the cron if we can't hit the db right now
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+			foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
+				// ensure $additional_vars is an array
+				$additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
+				// reset cron job for the TXN
+				call_user_func_array(
+					array('EE_Cron_Tasks', $cron_task),
+					array_merge(
+						array(
+							time() + (10 * MINUTE_IN_SECONDS),
+							$TXN_ID,
+						),
+						$additional_vars
+					)
+				);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+
+
+	/****************  UPDATE TRANSACTION WITH PAYMENT ****************/
+
+
+	/**
+	 * array of TXN IDs and the payment
+	 *
+	 * @var array
+	 */
+	protected static $_update_transactions_with_payment = array();
+
+
+	/**
+	 * schedule_update_transaction_with_payment
+	 * sets a wp_schedule_single_event() for updating any TXNs that may
+	 * require updating due to recently received payments
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function schedule_update_transaction_with_payment(
+		$timestamp,
+		$TXN_ID,
+		$PAY_ID
+	) {
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// validate $TXN_ID and $timestamp
+		$TXN_ID = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+				array($TXN_ID, $PAY_ID)
+			);
+		}
+	}
+
+
+	/**
+	 * setup_update_for_transaction_with_payment
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
+	 * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
+	 * The passed TXN_ID and associated payment gets added to an array, and then
+	 * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
+	 * 'shutdown' which will actually handle the processing of any
+	 * transactions requiring updating, because doing so now would be too early
+	 * and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function setup_update_for_transaction_with_payment($TXN_ID = 0, $PAY_ID = 0)
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
+		if (absint($TXN_ID)) {
+			self::$_update_transactions_with_payment[ $TXN_ID ] = $PAY_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'update_transaction_with_payment'),
+				5
+			);
+		}
+	}
+
+
+	/**
+	 * update_transaction_with_payment
+	 * loops through the self::$_abandoned_transactions array
+	 * and attempts to finalize any TXNs that have not been completed
+	 * but have had their sessions expired, most likely due to a user not
+	 * returning from an off-site payment gateway
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public static function update_transaction_with_payment()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		if (// are there any TXNs that need cleaning up ?
+			empty(self::$_update_transactions_with_payment)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_update_transaction_with_payment',
+				self::$_update_transactions_with_payment
+			)
+		) {
+			return;
+		}
+		/** @type EE_Payment_Processor $payment_processor */
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		// set revisit flag for payment processor
+		$payment_processor->set_revisit();
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
+			// reschedule the cron if we can't hit the db right now
+			if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+				// reset cron job for updating the TXN
+				EE_Cron_Tasks::schedule_update_transaction_with_payment(
+					time() + EE_Cron_Tasks::reschedule_timeout,
+					$TXN_ID,
+					$PAY_ID
+				);
+				continue;
+			}
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			$payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
+			// verify transaction
+			if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
+				// now try to update the TXN with any payments
+				$payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
+			}
+			unset(self::$_update_transactions_with_payment[ $TXN_ID ]);
+		}
+	}
+
+
+
+	/************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
+
+
+	/*****************  EXPIRED TRANSACTION CHECK *****************/
+
+
+	/**
+	 * array of TXN IDs
+	 *
+	 * @var array
+	 */
+	protected static $_expired_transactions = array();
+
+
+	/**
+	 * schedule_expired_transaction_check
+	 * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 */
+	public static function schedule_expired_transaction_check(
+		$timestamp,
+		$TXN_ID
+	) {
+		// validate $TXN_ID and $timestamp
+		$TXN_ID = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__expired_transaction_check',
+				array($TXN_ID)
+			);
+		}
+	}
+
+
+	/**
+	 * expired_transaction_check
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
+	 * which is utilized by wp_schedule_single_event()
+	 * in \EED_Single_Page_Checkout::_initialize_transaction().
+	 * The passed TXN_ID gets added to an array, and then the
+	 * process_expired_transactions() function is hooked into
+	 * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
+	 * processing of any failed transactions, because doing so now would be
+	 * too early and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 */
+	public static function expired_transaction_check($TXN_ID = 0)
+	{
+		if (absint($TXN_ID)) {
+			self::$_expired_transactions[ $TXN_ID ] = $TXN_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'process_expired_transactions'),
+				5
+			);
+		}
+	}
+
+
+	/**
+	 * process_expired_transactions
+	 * loops through the self::$_expired_transactions array and processes any failed TXNs
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws DomainException
+	 * @throws RuntimeException
+	 */
+	public static function process_expired_transactions()
+	{
+		if (// are there any TXNs that need cleaning up ?
+			empty(self::$_expired_transactions)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_expired_transaction_check',
+				self::$_expired_transactions
+			)
+		) {
+			return;
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// set revisit flag for txn processor
+		$transaction_processor->set_revisit();
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_expired_transactions as $TXN_ID) {
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			// verify transaction and whether it is failed or not
+			if ($transaction instanceof EE_Transaction) {
+				switch ($transaction->status_ID()) {
+					// Completed TXNs
+					case EEM_Transaction::complete_status_code:
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
+							$transaction
+						);
+						break;
+					// Overpaid TXNs
+					case EEM_Transaction::overpaid_status_code:
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
+							$transaction
+						);
+						break;
+					// Incomplete TXNs
+					case EEM_Transaction::incomplete_status_code:
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+							$transaction
+						);
+						// todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
+						break;
+					// Abandoned TXNs
+					case EEM_Transaction::abandoned_status_code:
+						// run hook before updating transaction, primarily so
+						// EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
+							$transaction
+						);
+						// don't finalize the TXN if it has already been completed
+						if ($transaction->all_reg_steps_completed() !== true) {
+							/** @type EE_Payment_Processor $payment_processor */
+							$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+							// let's simulate an IPN here which will trigger any notifications that need to go out
+							$payment_processor->update_txn_based_on_payment(
+								$transaction,
+								$transaction->last_payment(),
+								true,
+								true
+							);
+						}
+						break;
+					// Failed TXNs
+					case EEM_Transaction::failed_status_code:
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+							$transaction
+						);
+						// todo :
+						// perform garbage collection here and remove clean_out_junk_transactions()
+						// $registrations = $transaction->registrations();
+						// if (! empty($registrations)) {
+						//     foreach ($registrations as $registration) {
+						//         if ($registration instanceof EE_Registration) {
+						//             $delete_registration = true;
+						//             if ($registration->attendee() instanceof EE_Attendee) {
+						//                 $delete_registration = false;
+						//             }
+						//             if ($delete_registration) {
+						//                 $registration->delete_permanently();
+						//                 $registration->delete_related_permanently();
+						//             }
+						//         }
+						//     }
+						// }
+						break;
+				}
+			}
+			unset(self::$_expired_transactions[ $TXN_ID ]);
+		}
+	}
+
+
+
+	/*************  END OF EXPIRED TRANSACTION CHECK  *************/
+
+
+	/************* START CLEAN UP BOT TRANSACTIONS **********************/
+
+
+	/**
+	 * callback for 'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'
+	 * which is setup during activation to run on an hourly cron
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws DomainException
+	 */
+	public static function clean_out_junk_transactions()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			EED_Ticket_Sales_Monitor::reset_reservation_counts();
+			EEM_Transaction::instance('')->delete_junk_transactions();
+			EEM_Registration::instance('')->delete_registrations_with_no_transaction();
+			EEM_Line_Item::instance('')->delete_line_items_with_no_transaction();
+		}
+	}
+
+
+	/**
+	 * Deletes old gateway logs. After about a week we usually don't need them for debugging. But folks can filter that.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function clean_out_old_gateway_logs()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
+			$time_diff_for_comparison = apply_filters(
+				'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
+				'-' . $reg_config->gateway_log_lifespan
+			);
+			EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
+		}
+	}
+
+
+	/*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
+
+
+	/**
+	 * @var array
+	 */
+	protected static $_abandoned_transactions = array();
+
+
+	/**
+	 * @deprecated
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 */
+	public static function schedule_finalize_abandoned_transactions_check($timestamp, $TXN_ID)
+	{
+		EE_Cron_Tasks::schedule_expired_transaction_check($timestamp, $TXN_ID);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @param int $TXN_ID
+	 */
+	public static function check_for_abandoned_transactions($TXN_ID = 0)
+	{
+		EE_Cron_Tasks::expired_transaction_check($TXN_ID);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public static function finalize_abandoned_transactions()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		if (// are there any TXNs that need cleaning up ?
+			empty(self::$_abandoned_transactions)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_expired_transaction_check',
+				self::$_abandoned_transactions
+			)
+		) {
+			return;
+		}
+		// combine our arrays of transaction IDs
+		self::$_expired_transactions = self::$_abandoned_transactions + self::$_expired_transactions;
+		// and deal with abandoned transactions here now...
+		EE_Cron_Tasks::process_expired_transactions();
+	}
+
+
+	/*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
 }

Spacing +14 added lines, -14 removed lines

@@ -38,7 +38,7 @@ 
      */
     public static function instance()
     {
-        if (! self::$_instance instanceof EE_Cron_Tasks) {
+        if ( ! self::$_instance instanceof EE_Cron_Tasks) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -71,7 +71,7 @@ 
              */
             add_action(
                 'AHEE__EE_System__load_core_configuration__complete',
-                function () {
+                function() {
                     EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
                     EE_Registry::instance()->NET_CFG->update_config(true, false);
                     add_option('ee_disabled_wp_cron_check', 1, '', false);
@@ -123,16 +123,16 @@ 
             'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
         );
         $crons = (array) get_option('cron');
-        if (! is_array($crons)) {
+        if ( ! is_array($crons)) {
             return;
         }
         foreach ($crons as $timestamp => $cron) {
             /** @var array[] $cron */
             foreach ($ee_crons as $ee_cron) {
-                if (isset($cron[ $ee_cron ]) && is_array($cron[ $ee_cron ])) {
+                if (isset($cron[$ee_cron]) && is_array($cron[$ee_cron])) {
                     do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
-                    foreach ($cron[ $ee_cron ] as $ee_cron_details) {
-                        if (! empty($ee_cron_details['args'])) {
+                    foreach ($cron[$ee_cron] as $ee_cron_details) {
+                        if ( ! empty($ee_cron_details['args'])) {
                             do_action(
                                 'AHEE_log',
                                 __CLASS__,
@@ -159,7 +159,7 @@ 
      */
     public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
     {
-        if (! method_exists('EE_Cron_Tasks', $cron_task)) {
+        if ( ! method_exists('EE_Cron_Tasks', $cron_task)) {
             throw new DomainException(
                 sprintf(
                     __('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
@@ -168,7 +168,7 @@ 
             );
         }
         // reschedule the cron if we can't hit the db right now
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
             foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
                 // ensure $additional_vars is an array
                 $additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
@@ -249,7 +249,7 @@ 
     {
         do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
         if (absint($TXN_ID)) {
-            self::$_update_transactions_with_payment[ $TXN_ID ] = $PAY_ID;
+            self::$_update_transactions_with_payment[$TXN_ID] = $PAY_ID;
             add_action(
                 'shutdown',
                 array('EE_Cron_Tasks', 'update_transaction_with_payment'),
@@ -295,7 +295,7 @@ 
         EE_Registry::instance()->load_model('Transaction');
         foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
             // reschedule the cron if we can't hit the db right now
-            if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+            if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
                 // reset cron job for updating the TXN
                 EE_Cron_Tasks::schedule_update_transaction_with_payment(
                     time() + EE_Cron_Tasks::reschedule_timeout,
@@ -311,7 +311,7 @@ 
                 // now try to update the TXN with any payments
                 $payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
             }
-            unset(self::$_update_transactions_with_payment[ $TXN_ID ]);
+            unset(self::$_update_transactions_with_payment[$TXN_ID]);
         }
     }
 
@@ -372,7 +372,7 @@ 
     public static function expired_transaction_check($TXN_ID = 0)
     {
         if (absint($TXN_ID)) {
-            self::$_expired_transactions[ $TXN_ID ] = $TXN_ID;
+            self::$_expired_transactions[$TXN_ID] = $TXN_ID;
             add_action(
                 'shutdown',
                 array('EE_Cron_Tasks', 'process_expired_transactions'),
@@ -486,7 +486,7 @@ 
                         break;
                 }
             }
-            unset(self::$_expired_transactions[ $TXN_ID ]);
+            unset(self::$_expired_transactions[$TXN_ID]);
         }
     }
 
@@ -533,7 +533,7 @@ 
             $reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
             $time_diff_for_comparison = apply_filters(
                 'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
-                '-' . $reg_config->gateway_log_lifespan
+                '-'.$reg_config->gateway_log_lifespan
             );
             EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
         }

core/EE_Dependency_Map.core.php

Spacing +33 added lines, -33 removed lines

@@ -122,7 +122,7 @@ 
     public static function instance(ClassInterfaceCache $class_cache = null)
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Dependency_Map
+        if ( ! self::$_instance instanceof EE_Dependency_Map
             && $class_cache instanceof ClassInterfaceCache
         ) {
             self::$_instance = new EE_Dependency_Map($class_cache);
@@ -203,18 +203,18 @@ 
     ) {
         $class = trim($class, '\\');
         $registered = false;
-        if (empty(self::$_instance->_dependency_map[ $class ])) {
-            self::$_instance->_dependency_map[ $class ] = array();
+        if (empty(self::$_instance->_dependency_map[$class])) {
+            self::$_instance->_dependency_map[$class] = array();
         }
         // we need to make sure that any aliases used when registering a dependency
         // get resolved to the correct class name
         foreach ($dependencies as $dependency => $load_source) {
             $alias = self::$_instance->getFqnForAlias($dependency);
             if ($overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
-                || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
+                || ! isset(self::$_instance->_dependency_map[$class][$alias])
             ) {
-                unset($dependencies[ $dependency ]);
-                $dependencies[ $alias ] = $load_source;
+                unset($dependencies[$dependency]);
+                $dependencies[$alias] = $load_source;
                 $registered = true;
             }
         }
@@ -224,13 +224,13 @@ 
         // ie: with A = B + C, entries in B take precedence over duplicate entries in C
         // Union is way faster than array_merge() but should be used with caution...
         // especially with numerically indexed arrays
-        $dependencies += self::$_instance->_dependency_map[ $class ];
+        $dependencies += self::$_instance->_dependency_map[$class];
         // now we need to ensure that the resulting dependencies
         // array only has the entries that are required for the class
         // so first count how many dependencies were originally registered for the class
-        $dependency_count = count(self::$_instance->_dependency_map[ $class ]);
+        $dependency_count = count(self::$_instance->_dependency_map[$class]);
         // if that count is non-zero (meaning dependencies were already registered)
-        self::$_instance->_dependency_map[ $class ] = $dependency_count
+        self::$_instance->_dependency_map[$class] = $dependency_count
             // then truncate the  final array to match that count
             ? array_slice($dependencies, 0, $dependency_count)
             // otherwise just take the incoming array because nothing previously existed
@@ -247,13 +247,13 @@ 
      */
     public static function register_class_loader($class_name, $loader = 'load_core')
     {
-        if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
+        if ( ! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
             throw new DomainException(
                 esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
             );
         }
         // check that loader is callable or method starts with "load_" and exists in EE_Registry
-        if (! is_callable($loader)
+        if ( ! is_callable($loader)
             && (
                 strpos($loader, 'load_') !== 0
                 || ! method_exists('EE_Registry', $loader)
@@ -270,8 +270,8 @@ 
             );
         }
         $class_name = self::$_instance->getFqnForAlias($class_name);
-        if (! isset(self::$_instance->_class_loaders[ $class_name ])) {
-            self::$_instance->_class_loaders[ $class_name ] = $loader;
+        if ( ! isset(self::$_instance->_class_loaders[$class_name])) {
+            self::$_instance->_class_loaders[$class_name] = $loader;
             return true;
         }
         return false;
@@ -299,7 +299,7 @@ 
         if (strpos($class_name, 'EEM_') === 0) {
             $class_name = 'LEGACY_MODELS';
         }
-        return isset($this->_dependency_map[ $class_name ]) ? true : false;
+        return isset($this->_dependency_map[$class_name]) ? true : false;
     }
 
 
@@ -317,7 +317,7 @@ 
             $class_name = 'LEGACY_MODELS';
         }
         $dependency = $this->getFqnForAlias($dependency, $class_name);
-        return isset($this->_dependency_map[ $class_name ][ $dependency ])
+        return isset($this->_dependency_map[$class_name][$dependency])
             ? true
             : false;
     }
@@ -338,7 +338,7 @@ 
         }
         $dependency = $this->getFqnForAlias($dependency);
         return $this->has_dependency_for_class($class_name, $dependency)
-            ? $this->_dependency_map[ $class_name ][ $dependency ]
+            ? $this->_dependency_map[$class_name][$dependency]
             : EE_Dependency_Map::not_registered;
     }
 
@@ -354,7 +354,7 @@ 
             return 'load_model';
         }
         $class_name = $this->getFqnForAlias($class_name);
-        return isset($this->_class_loaders[ $class_name ]) ? $this->_class_loaders[ $class_name ] : '';
+        return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : '';
     }
 
 
@@ -788,13 +788,13 @@ 
             'EE_Front_Controller'                          => 'load_core',
             'EE_Module_Request_Router'                     => 'load_core',
             'EE_Registry'                                  => 'load_core',
-            'EE_Request'                                   => function () use (&$legacy_request) {
+            'EE_Request'                                   => function() use (&$legacy_request) {
                 return $legacy_request;
             },
-            'EventEspresso\core\services\request\Request'  => function () use (&$request) {
+            'EventEspresso\core\services\request\Request'  => function() use (&$request) {
                 return $request;
             },
-            'EventEspresso\core\services\request\Response' => function () use (&$response) {
+            'EventEspresso\core\services\request\Response' => function() use (&$response) {
                 return $response;
             },
             'EE_Base'                                      => 'load_core',
@@ -818,7 +818,7 @@ 
             'EE_Messages_Data_Handler_Collection'          => 'load_lib',
             'EE_Message_Template_Group_Collection'         => 'load_lib',
             'EE_Payment_Method_Manager'                    => 'load_lib',
-            'EE_Messages_Generator'                        => function () {
+            'EE_Messages_Generator'                        => function() {
                 return EE_Registry::instance()->load_lib(
                     'Messages_Generator',
                     array(),
@@ -826,7 +826,7 @@ 
                     false
                 );
             },
-            'EE_Messages_Template_Defaults'                => function ($arguments = array()) {
+            'EE_Messages_Template_Defaults'                => function($arguments = array()) {
                 return EE_Registry::instance()->load_lib(
                     'Messages_Template_Defaults',
                     $arguments,
@@ -835,37 +835,37 @@ 
                 );
             },
             // load_helper
-            'EEH_Parse_Shortcodes'                         => function () {
+            'EEH_Parse_Shortcodes'                         => function() {
                 if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
                     return new EEH_Parse_Shortcodes();
                 }
                 return null;
             },
-            'EE_Template_Config'                           => function () {
+            'EE_Template_Config'                           => function() {
                 return EE_Config::instance()->template_settings;
             },
-            'EE_Currency_Config'                           => function () {
+            'EE_Currency_Config'                           => function() {
                 return EE_Config::instance()->currency;
             },
-            'EE_Registration_Config'                       => function () {
+            'EE_Registration_Config'                       => function() {
                 return EE_Config::instance()->registration;
             },
-            'EE_Core_Config'                               => function () {
+            'EE_Core_Config'                               => function() {
                 return EE_Config::instance()->core;
             },
-            'EventEspresso\core\services\loaders\Loader'   => function () {
+            'EventEspresso\core\services\loaders\Loader'   => function() {
                 return LoaderFactory::getLoader();
             },
-            'EE_Network_Config'                            => function () {
+            'EE_Network_Config'                            => function() {
                 return EE_Network_Config::instance();
             },
-            'EE_Config'                                    => function () {
+            'EE_Config'                                    => function() {
                 return EE_Config::instance();
             },
-            'EventEspresso\core\domain\Domain'             => function () {
+            'EventEspresso\core\domain\Domain'             => function() {
                 return DomainFactory::getEventEspressoCoreDomain();
             },
-            'EE_Admin_Config'                              => function () {
+            'EE_Admin_Config'                              => function() {
                 return EE_Config::instance()->admin;
             }
         );
@@ -927,7 +927,7 @@ 
             }
             $this->class_cache->addAlias($fqn, $alias);
         }
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
             $this->class_cache->addAlias(
                 'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices',
                 'EventEspresso\core\services\notices\NoticeConverterInterface'

Indentation +988 added lines, -988 removed lines

@@ -20,992 +20,992 @@
 class EE_Dependency_Map
 {
 
-    /**
-     * This means that the requested class dependency is not present in the dependency map
-     */
-    const not_registered = 0;
-
-    /**
-     * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
-     */
-    const load_new_object = 1;
-
-    /**
-     * This instructs class loaders to return a previously instantiated and cached object for the requested class.
-     * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
-     */
-    const load_from_cache = 2;
-
-    /**
-     * When registering a dependency,
-     * this indicates to keep any existing dependencies that already exist,
-     * and simply discard any new dependencies declared in the incoming data
-     */
-    const KEEP_EXISTING_DEPENDENCIES = 0;
-
-    /**
-     * When registering a dependency,
-     * this indicates to overwrite any existing dependencies that already exist using the incoming data
-     */
-    const OVERWRITE_DEPENDENCIES = 1;
-
-
-    /**
-     * @type EE_Dependency_Map $_instance
-     */
-    protected static $_instance;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * @type RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * @type LegacyRequestInterface $legacy_request
-     */
-    protected $legacy_request;
-
-    /**
-     * @type ResponseInterface $response
-     */
-    protected $response;
-
-    /**
-     * @type LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @type array $_dependency_map
-     */
-    protected $_dependency_map = array();
-
-    /**
-     * @type array $_class_loaders
-     */
-    protected $_class_loaders = array();
-
-
-    /**
-     * EE_Dependency_Map constructor.
-     *
-     * @param ClassInterfaceCache $class_cache
-     */
-    protected function __construct(ClassInterfaceCache $class_cache)
-    {
-        $this->class_cache = $class_cache;
-        do_action('EE_Dependency_Map____construct', $this);
-    }
-
-
-    /**
-     * @return void
-     */
-    public function initialize()
-    {
-        $this->_register_core_dependencies();
-        $this->_register_core_class_loaders();
-        $this->_register_core_aliases();
-    }
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param ClassInterfaceCache|null $class_cache
-     * @return EE_Dependency_Map
-     */
-    public static function instance(ClassInterfaceCache $class_cache = null)
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Dependency_Map
-            && $class_cache instanceof ClassInterfaceCache
-        ) {
-            self::$_instance = new EE_Dependency_Map($class_cache);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param RequestInterface $request
-     */
-    public function setRequest(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
-
-
-    /**
-     * @param LegacyRequestInterface $legacy_request
-     */
-    public function setLegacyRequest(LegacyRequestInterface $legacy_request)
-    {
-        $this->legacy_request = $legacy_request;
-    }
-
-
-    /**
-     * @param ResponseInterface $response
-     */
-    public function setResponse(ResponseInterface $response)
-    {
-        $this->response = $response;
-    }
-
-
-    /**
-     * @param LoaderInterface $loader
-     */
-    public function setLoader(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-
-
-    /**
-     * @param string $class
-     * @param array  $dependencies
-     * @param int    $overwrite
-     * @return bool
-     */
-    public static function register_dependencies(
-        $class,
-        array $dependencies,
-        $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
-    ) {
-        return self::$_instance->registerDependencies($class, $dependencies, $overwrite);
-    }
-
-
-    /**
-     * Assigns an array of class names and corresponding load sources (new or cached)
-     * to the class specified by the first parameter.
-     * IMPORTANT !!!
-     * The order of elements in the incoming $dependencies array MUST match
-     * the order of the constructor parameters for the class in question.
-     * This is especially important when overriding any existing dependencies that are registered.
-     * the third parameter controls whether any duplicate dependencies are overwritten or not.
-     *
-     * @param string $class
-     * @param array  $dependencies
-     * @param int    $overwrite
-     * @return bool
-     */
-    public function registerDependencies(
-        $class,
-        array $dependencies,
-        $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
-    ) {
-        $class = trim($class, '\\');
-        $registered = false;
-        if (empty(self::$_instance->_dependency_map[ $class ])) {
-            self::$_instance->_dependency_map[ $class ] = array();
-        }
-        // we need to make sure that any aliases used when registering a dependency
-        // get resolved to the correct class name
-        foreach ($dependencies as $dependency => $load_source) {
-            $alias = self::$_instance->getFqnForAlias($dependency);
-            if ($overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
-                || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
-            ) {
-                unset($dependencies[ $dependency ]);
-                $dependencies[ $alias ] = $load_source;
-                $registered = true;
-            }
-        }
-        // now add our two lists of dependencies together.
-        // using Union (+=) favours the arrays in precedence from left to right,
-        // so $dependencies is NOT overwritten because it is listed first
-        // ie: with A = B + C, entries in B take precedence over duplicate entries in C
-        // Union is way faster than array_merge() but should be used with caution...
-        // especially with numerically indexed arrays
-        $dependencies += self::$_instance->_dependency_map[ $class ];
-        // now we need to ensure that the resulting dependencies
-        // array only has the entries that are required for the class
-        // so first count how many dependencies were originally registered for the class
-        $dependency_count = count(self::$_instance->_dependency_map[ $class ]);
-        // if that count is non-zero (meaning dependencies were already registered)
-        self::$_instance->_dependency_map[ $class ] = $dependency_count
-            // then truncate the  final array to match that count
-            ? array_slice($dependencies, 0, $dependency_count)
-            // otherwise just take the incoming array because nothing previously existed
-            : $dependencies;
-        return $registered;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $loader
-     * @return bool
-     * @throws DomainException
-     */
-    public static function register_class_loader($class_name, $loader = 'load_core')
-    {
-        if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
-            throw new DomainException(
-                esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
-            );
-        }
-        // check that loader is callable or method starts with "load_" and exists in EE_Registry
-        if (! is_callable($loader)
-            && (
-                strpos($loader, 'load_') !== 0
-                || ! method_exists('EE_Registry', $loader)
-            )
-        ) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '"%1$s" is not a valid loader method on EE_Registry.',
-                        'event_espresso'
-                    ),
-                    $loader
-                )
-            );
-        }
-        $class_name = self::$_instance->getFqnForAlias($class_name);
-        if (! isset(self::$_instance->_class_loaders[ $class_name ])) {
-            self::$_instance->_class_loaders[ $class_name ] = $loader;
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function dependency_map()
-    {
-        return $this->_dependency_map;
-    }
-
-
-    /**
-     * returns TRUE if dependency map contains a listing for the provided class name
-     *
-     * @param string $class_name
-     * @return boolean
-     */
-    public function has($class_name = '')
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        return isset($this->_dependency_map[ $class_name ]) ? true : false;
-    }
-
-
-    /**
-     * returns TRUE if dependency map contains a listing for the provided class name AND dependency
-     *
-     * @param string $class_name
-     * @param string $dependency
-     * @return bool
-     */
-    public function has_dependency_for_class($class_name = '', $dependency = '')
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        $dependency = $this->getFqnForAlias($dependency, $class_name);
-        return isset($this->_dependency_map[ $class_name ][ $dependency ])
-            ? true
-            : false;
-    }
-
-
-    /**
-     * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
-     *
-     * @param string $class_name
-     * @param string $dependency
-     * @return int
-     */
-    public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        $dependency = $this->getFqnForAlias($dependency);
-        return $this->has_dependency_for_class($class_name, $dependency)
-            ? $this->_dependency_map[ $class_name ][ $dependency ]
-            : EE_Dependency_Map::not_registered;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return string | Closure
-     */
-    public function class_loader($class_name)
-    {
-        // all legacy models use load_model()
-        if (strpos($class_name, 'EEM_') === 0) {
-            return 'load_model';
-        }
-        $class_name = $this->getFqnForAlias($class_name);
-        return isset($this->_class_loaders[ $class_name ]) ? $this->_class_loaders[ $class_name ] : '';
-    }
-
-
-    /**
-     * @return array
-     */
-    public function class_loaders()
-    {
-        return $this->_class_loaders;
-    }
-
-
-    /**
-     * adds an alias for a classname
-     *
-     * @param string $fqcn      the class name that should be used (concrete class to replace interface)
-     * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
-     * @param string $for_class the class that has the dependency (is type hinting for the interface)
-     */
-    public function add_alias($fqcn, $alias, $for_class = '')
-    {
-        $this->class_cache->addAlias($fqcn, $alias, $for_class);
-    }
-
-
-    /**
-     * Returns TRUE if the provided fully qualified name IS an alias
-     * WHY?
-     * Because if a class is type hinting for a concretion,
-     * then why would we need to find another class to supply it?
-     * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
-     * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
-     * Don't go looking for some substitute.
-     * Whereas if a class is type hinting for an interface...
-     * then we need to find an actual class to use.
-     * So the interface IS the alias for some other FQN,
-     * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
-     * represents some other class.
-     *
-     * @param string $fqn
-     * @param string $for_class
-     * @return bool
-     */
-    public function isAlias($fqn = '', $for_class = '')
-    {
-        return $this->class_cache->isAlias($fqn, $for_class);
-    }
-
-
-    /**
-     * Returns a FQN for provided alias if one exists, otherwise returns the original $alias
-     * functions recursively, so that multiple aliases can be used to drill down to a FQN
-     *  for example:
-     *      if the following two entries were added to the _aliases array:
-     *          array(
-     *              'interface_alias'           => 'some\namespace\interface'
-     *              'some\namespace\interface'  => 'some\namespace\classname'
-     *          )
-     *      then one could use EE_Registry::instance()->create( 'interface_alias' )
-     *      to load an instance of 'some\namespace\classname'
-     *
-     * @param string $alias
-     * @param string $for_class
-     * @return string
-     */
-    public function getFqnForAlias($alias = '', $for_class = '')
-    {
-        return (string) $this->class_cache->getFqnForAlias($alias, $for_class);
-    }
-
-
-    /**
-     * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
-     * if one exists, or whether a new object should be generated every time the requested class is loaded.
-     * This is done by using the following class constants:
-     *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
-     *        EE_Dependency_Map::load_new_object - generates a new object every time
-     */
-    protected function _register_core_dependencies()
-    {
-        $this->_dependency_map = array(
-            'EE_Request_Handler'                                                                                          => array(
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_System'                                                                                                   => array(
-                'EE_Registry'                                 => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EE_Maintenance_Mode'                         => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Session'                                                                                                  => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
-                'EE_Encryption'                                            => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Cart'                                                                                                     => array(
-                'EE_Session' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Front_Controller'                                                                                         => array(
-                'EE_Registry'              => EE_Dependency_Map::load_from_cache,
-                'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
-                'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messenger_Collection_Loader'                                                                              => array(
-                'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Message_Type_Collection_Loader'                                                                           => array(
-                'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Message_Resource_Manager'                                                                                 => array(
-                'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
-                'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
-                'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Message_Factory'                                                                                          => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_messages'                                                                                                 => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Generator'                                                                                       => array(
-                'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
-                'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
-                'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
-                'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Processor'                                                                                       => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Queue'                                                                                           => array(
-                'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Messages_Template_Defaults'                                                                               => array(
-                'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
-                'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Message_To_Generate_From_Request'                                                                         => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-                'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandBus'                                                             => array(
-                'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\services\commands\CommandHandler'                                                              => array(
-                'EE_Registry'         => EE_Dependency_Map::load_from_cache,
-                'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
-                'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
-                'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
-                'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
-                'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
-                'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler'                                  => array(
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\database\TableManager'                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Data_Migration_Class_Base'                                                                                => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_1_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_2_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_3_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_4_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_5_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_6_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_7_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_8_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_9_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\assets\I18nRegistry'                                                             => array(
-                array(),
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\assets\Registry'                                                                 => array(
-                'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\assets\I18nRegistry'    => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\cache\BasicCacheManager'                                                         => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\cache\PostRelatedCacheManager'                                                   => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\validation\email\EmailValidationService'                                  => array(
-                'EE_Registration_Config'                     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\values\EmailAddress'                                                               => array(
-                null,
-                'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\orm\ModelFieldFactory'                                                           => array(
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'LEGACY_MODELS'                                                                                               => array(
-                null,
-                'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Module_Request_Router'                                                                                    => array(
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Registration_Processor'                                                                                   => array(
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'                                      => array(
-                null,
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
-                'EE_Request'                                                          => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\licensing\LicenseService'                                                        => array(
-                'EventEspresso\core\domain\services\pue\Stats'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\pue\Config' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Admin_Transactions_List_Table'                                                                            => array(
-                null,
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\pue\Stats'                                                                => array(
-                'EventEspresso\core\domain\services\pue\Config'        => EE_Dependency_Map::load_from_cache,
-                'EE_Maintenance_Mode'                                  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\pue\StatsGatherer' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\pue\Config'                                                               => array(
-                'EE_Network_Config' => EE_Dependency_Map::load_from_cache,
-                'EE_Config'         => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\pue\StatsGatherer'                                                        => array(
-                'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
-                'EEM_Event'          => EE_Dependency_Map::load_from_cache,
-                'EEM_Datetime'       => EE_Dependency_Map::load_from_cache,
-                'EEM_Ticket'         => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration'   => EE_Dependency_Map::load_from_cache,
-                'EEM_Transaction'    => EE_Dependency_Map::load_from_cache,
-                'EE_Config'          => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\ExitModal'                                                          => array(
-                'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\PluginUpsells'                                                      => array(
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\caffeinated\modules\recaptcha_invisible\InvisibleRecaptcha'                                    => array(
-                'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
-                'EE_Session'             => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings'                                => array(
-                'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\modules\ticket_selector\ProcessTicketSelector'                                                 => array(
-                'EE_Core_Config'                                                          => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'                             => EE_Dependency_Map::load_from_cache,
-                'EE_Session'                                                              => EE_Dependency_Map::load_from_cache,
-                'EEM_Ticket'                                                              => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker'                                     => array(
-                'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'                              => array(
-                'EE_Core_Config'                             => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'                                => array(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'                               => array(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_CPT_Strategy'                                                                                             => array(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\loaders\ObjectIdentifier'                                                        => array(
-                'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\assets\CoreAssetManager'                                                  => array(
-                'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
-                'EE_Currency_Config'                                 => EE_Dependency_Map::load_from_cache,
-                'EE_Template_Config'                                 => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\policy\PrivacyPolicy' => array(
-                'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendee' => array(
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendeeBillingData' => array(
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
-                'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportCheckins' => array(
-                'EEM_Checkin' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportRegistration' => array(
-                'EEM_Registration' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportTransaction' => array(
-                'EEM_Transaction' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAttendeeData' => array(
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAnswers' => array(
-                'EEM_Answer' => EE_Dependency_Map::load_from_cache,
-                'EEM_Question' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\editor\BlockRegistrationManager'                                                 => array(
-                'EventEspresso\core\services\assets\BlockAssetManagerCollection' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\editor\BlockCollection'      => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'                    => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\editor\blocks\CoreBlocksAssetManager' => array(
-                'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\editor\blocks\widgets\EventAttendees' => array(
-                'EventEspresso\core\domain\entities\editor\blocks\CoreBlocksAssetManager' => self::load_from_cache,
-            ),
-        );
-    }
-
-
-    /**
-     * Registers how core classes are loaded.
-     * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
-     *        'EE_Request_Handler' => 'load_core'
-     *        'EE_Messages_Queue'  => 'load_lib'
-     *        'EEH_Debug_Tools'    => 'load_helper'
-     * or, if greater control is required, by providing a custom closure. For example:
-     *        'Some_Class' => function () {
-     *            return new Some_Class();
-     *        },
-     * This is required for instantiating dependencies
-     * where an interface has been type hinted in a class constructor. For example:
-     *        'Required_Interface' => function () {
-     *            return new A_Class_That_Implements_Required_Interface();
-     *        },
-     */
-    protected function _register_core_class_loaders()
-    {
-        // for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot
-        // be used in a closure.
-        $request = &$this->request;
-        $response = &$this->response;
-        $legacy_request = &$this->legacy_request;
-        // $loader = &$this->loader;
-        $this->_class_loaders = array(
-            // load_core
-            'EE_Capabilities'                              => 'load_core',
-            'EE_Encryption'                                => 'load_core',
-            'EE_Front_Controller'                          => 'load_core',
-            'EE_Module_Request_Router'                     => 'load_core',
-            'EE_Registry'                                  => 'load_core',
-            'EE_Request'                                   => function () use (&$legacy_request) {
-                return $legacy_request;
-            },
-            'EventEspresso\core\services\request\Request'  => function () use (&$request) {
-                return $request;
-            },
-            'EventEspresso\core\services\request\Response' => function () use (&$response) {
-                return $response;
-            },
-            'EE_Base'                                      => 'load_core',
-            'EE_Request_Handler'                           => 'load_core',
-            'EE_Session'                                   => 'load_core',
-            'EE_Cron_Tasks'                                => 'load_core',
-            'EE_System'                                    => 'load_core',
-            'EE_Maintenance_Mode'                          => 'load_core',
-            'EE_Register_CPTs'                             => 'load_core',
-            'EE_Admin'                                     => 'load_core',
-            'EE_CPT_Strategy'                              => 'load_core',
-            // load_lib
-            'EE_Message_Resource_Manager'                  => 'load_lib',
-            'EE_Message_Type_Collection'                   => 'load_lib',
-            'EE_Message_Type_Collection_Loader'            => 'load_lib',
-            'EE_Messenger_Collection'                      => 'load_lib',
-            'EE_Messenger_Collection_Loader'               => 'load_lib',
-            'EE_Messages_Processor'                        => 'load_lib',
-            'EE_Message_Repository'                        => 'load_lib',
-            'EE_Messages_Queue'                            => 'load_lib',
-            'EE_Messages_Data_Handler_Collection'          => 'load_lib',
-            'EE_Message_Template_Group_Collection'         => 'load_lib',
-            'EE_Payment_Method_Manager'                    => 'load_lib',
-            'EE_Messages_Generator'                        => function () {
-                return EE_Registry::instance()->load_lib(
-                    'Messages_Generator',
-                    array(),
-                    false,
-                    false
-                );
-            },
-            'EE_Messages_Template_Defaults'                => function ($arguments = array()) {
-                return EE_Registry::instance()->load_lib(
-                    'Messages_Template_Defaults',
-                    $arguments,
-                    false,
-                    false
-                );
-            },
-            // load_helper
-            'EEH_Parse_Shortcodes'                         => function () {
-                if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
-                    return new EEH_Parse_Shortcodes();
-                }
-                return null;
-            },
-            'EE_Template_Config'                           => function () {
-                return EE_Config::instance()->template_settings;
-            },
-            'EE_Currency_Config'                           => function () {
-                return EE_Config::instance()->currency;
-            },
-            'EE_Registration_Config'                       => function () {
-                return EE_Config::instance()->registration;
-            },
-            'EE_Core_Config'                               => function () {
-                return EE_Config::instance()->core;
-            },
-            'EventEspresso\core\services\loaders\Loader'   => function () {
-                return LoaderFactory::getLoader();
-            },
-            'EE_Network_Config'                            => function () {
-                return EE_Network_Config::instance();
-            },
-            'EE_Config'                                    => function () {
-                return EE_Config::instance();
-            },
-            'EventEspresso\core\domain\Domain'             => function () {
-                return DomainFactory::getEventEspressoCoreDomain();
-            },
-            'EE_Admin_Config'                              => function () {
-                return EE_Config::instance()->admin;
-            }
-        );
-    }
-
-
-    /**
-     * can be used for supplying alternate names for classes,
-     * or for connecting interface names to instantiable classes
-     */
-    protected function _register_core_aliases()
-    {
-        $aliases = array(
-            'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
-            'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
-            'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
-            'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
-            'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
-            'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
-            'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
-            'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
-            'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
-            'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
-            'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
-            'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
-            'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
-            'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
-            'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
-            'CreateTransactionCommandHandler'                                              => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler',
-            'CreateAttendeeCommandHandler'                                                 => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler',
-            'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
-            'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
-            'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
-            'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
-            'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
-            'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
-            'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
-            'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
-            'CommandFactoryInterface'                                                      => 'EventEspresso\core\services\commands\CommandFactoryInterface',
-            'EventEspresso\core\services\commands\CommandFactoryInterface'                 => 'EventEspresso\core\services\commands\CommandFactory',
-            'EventEspresso\core\domain\services\session\SessionIdentifierInterface'        => 'EE_Session',
-            'EmailValidatorInterface'                                                      => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
-            'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface'  => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
-            'NoticeConverterInterface'                                                     => 'EventEspresso\core\services\notices\NoticeConverterInterface',
-            'EventEspresso\core\services\notices\NoticeConverterInterface'                 => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
-            'NoticesContainerInterface'                                                    => 'EventEspresso\core\services\notices\NoticesContainerInterface',
-            'EventEspresso\core\services\notices\NoticesContainerInterface'                => 'EventEspresso\core\services\notices\NoticesContainer',
-            'EventEspresso\core\services\request\RequestInterface'                         => 'EventEspresso\core\services\request\Request',
-            'EventEspresso\core\services\request\ResponseInterface'                        => 'EventEspresso\core\services\request\Response',
-            'EventEspresso\core\domain\DomainInterface'                                    => 'EventEspresso\core\domain\Domain',
-        );
-        foreach ($aliases as $alias => $fqn) {
-            if (is_array($fqn)) {
-                foreach ($fqn as $class => $for_class) {
-                    $this->class_cache->addAlias($class, $alias, $for_class);
-                }
-                continue;
-            }
-            $this->class_cache->addAlias($fqn, $alias);
-        }
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-            $this->class_cache->addAlias(
-                'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices',
-                'EventEspresso\core\services\notices\NoticeConverterInterface'
-            );
-        }
-    }
-
-
-    /**
-     * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
-     * request Primarily used by unit tests.
-     */
-    public function reset()
-    {
-        $this->_register_core_class_loaders();
-        $this->_register_core_dependencies();
-    }
-
-
-    /**
-     * PLZ NOTE: a better name for this method would be is_alias()
-     * because it returns TRUE if the provided fully qualified name IS an alias
-     * WHY?
-     * Because if a class is type hinting for a concretion,
-     * then why would we need to find another class to supply it?
-     * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
-     * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
-     * Don't go looking for some substitute.
-     * Whereas if a class is type hinting for an interface...
-     * then we need to find an actual class to use.
-     * So the interface IS the alias for some other FQN,
-     * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
-     * represents some other class.
-     *
-     * @deprecated 4.9.62.p
-     * @param string $fqn
-     * @param string $for_class
-     * @return bool
-     */
-    public function has_alias($fqn = '', $for_class = '')
-    {
-        return $this->isAlias($fqn, $for_class);
-    }
-
-
-    /**
-     * PLZ NOTE: a better name for this method would be get_fqn_for_alias()
-     * because it returns a FQN for provided alias if one exists, otherwise returns the original $alias
-     * functions recursively, so that multiple aliases can be used to drill down to a FQN
-     *  for example:
-     *      if the following two entries were added to the _aliases array:
-     *          array(
-     *              'interface_alias'           => 'some\namespace\interface'
-     *              'some\namespace\interface'  => 'some\namespace\classname'
-     *          )
-     *      then one could use EE_Registry::instance()->create( 'interface_alias' )
-     *      to load an instance of 'some\namespace\classname'
-     *
-     * @deprecated 4.9.62.p
-     * @param string $alias
-     * @param string $for_class
-     * @return string
-     */
-    public function get_alias($alias = '', $for_class = '')
-    {
-        return $this->getFqnForAlias($alias, $for_class);
-    }
+	/**
+	 * This means that the requested class dependency is not present in the dependency map
+	 */
+	const not_registered = 0;
+
+	/**
+	 * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
+	 */
+	const load_new_object = 1;
+
+	/**
+	 * This instructs class loaders to return a previously instantiated and cached object for the requested class.
+	 * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
+	 */
+	const load_from_cache = 2;
+
+	/**
+	 * When registering a dependency,
+	 * this indicates to keep any existing dependencies that already exist,
+	 * and simply discard any new dependencies declared in the incoming data
+	 */
+	const KEEP_EXISTING_DEPENDENCIES = 0;
+
+	/**
+	 * When registering a dependency,
+	 * this indicates to overwrite any existing dependencies that already exist using the incoming data
+	 */
+	const OVERWRITE_DEPENDENCIES = 1;
+
+
+	/**
+	 * @type EE_Dependency_Map $_instance
+	 */
+	protected static $_instance;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * @type RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * @type LegacyRequestInterface $legacy_request
+	 */
+	protected $legacy_request;
+
+	/**
+	 * @type ResponseInterface $response
+	 */
+	protected $response;
+
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @type array $_dependency_map
+	 */
+	protected $_dependency_map = array();
+
+	/**
+	 * @type array $_class_loaders
+	 */
+	protected $_class_loaders = array();
+
+
+	/**
+	 * EE_Dependency_Map constructor.
+	 *
+	 * @param ClassInterfaceCache $class_cache
+	 */
+	protected function __construct(ClassInterfaceCache $class_cache)
+	{
+		$this->class_cache = $class_cache;
+		do_action('EE_Dependency_Map____construct', $this);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function initialize()
+	{
+		$this->_register_core_dependencies();
+		$this->_register_core_class_loaders();
+		$this->_register_core_aliases();
+	}
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param ClassInterfaceCache|null $class_cache
+	 * @return EE_Dependency_Map
+	 */
+	public static function instance(ClassInterfaceCache $class_cache = null)
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Dependency_Map
+			&& $class_cache instanceof ClassInterfaceCache
+		) {
+			self::$_instance = new EE_Dependency_Map($class_cache);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param RequestInterface $request
+	 */
+	public function setRequest(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @param LegacyRequestInterface $legacy_request
+	 */
+	public function setLegacyRequest(LegacyRequestInterface $legacy_request)
+	{
+		$this->legacy_request = $legacy_request;
+	}
+
+
+	/**
+	 * @param ResponseInterface $response
+	 */
+	public function setResponse(ResponseInterface $response)
+	{
+		$this->response = $response;
+	}
+
+
+	/**
+	 * @param LoaderInterface $loader
+	 */
+	public function setLoader(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param array  $dependencies
+	 * @param int    $overwrite
+	 * @return bool
+	 */
+	public static function register_dependencies(
+		$class,
+		array $dependencies,
+		$overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
+	) {
+		return self::$_instance->registerDependencies($class, $dependencies, $overwrite);
+	}
+
+
+	/**
+	 * Assigns an array of class names and corresponding load sources (new or cached)
+	 * to the class specified by the first parameter.
+	 * IMPORTANT !!!
+	 * The order of elements in the incoming $dependencies array MUST match
+	 * the order of the constructor parameters for the class in question.
+	 * This is especially important when overriding any existing dependencies that are registered.
+	 * the third parameter controls whether any duplicate dependencies are overwritten or not.
+	 *
+	 * @param string $class
+	 * @param array  $dependencies
+	 * @param int    $overwrite
+	 * @return bool
+	 */
+	public function registerDependencies(
+		$class,
+		array $dependencies,
+		$overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
+	) {
+		$class = trim($class, '\\');
+		$registered = false;
+		if (empty(self::$_instance->_dependency_map[ $class ])) {
+			self::$_instance->_dependency_map[ $class ] = array();
+		}
+		// we need to make sure that any aliases used when registering a dependency
+		// get resolved to the correct class name
+		foreach ($dependencies as $dependency => $load_source) {
+			$alias = self::$_instance->getFqnForAlias($dependency);
+			if ($overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
+				|| ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
+			) {
+				unset($dependencies[ $dependency ]);
+				$dependencies[ $alias ] = $load_source;
+				$registered = true;
+			}
+		}
+		// now add our two lists of dependencies together.
+		// using Union (+=) favours the arrays in precedence from left to right,
+		// so $dependencies is NOT overwritten because it is listed first
+		// ie: with A = B + C, entries in B take precedence over duplicate entries in C
+		// Union is way faster than array_merge() but should be used with caution...
+		// especially with numerically indexed arrays
+		$dependencies += self::$_instance->_dependency_map[ $class ];
+		// now we need to ensure that the resulting dependencies
+		// array only has the entries that are required for the class
+		// so first count how many dependencies were originally registered for the class
+		$dependency_count = count(self::$_instance->_dependency_map[ $class ]);
+		// if that count is non-zero (meaning dependencies were already registered)
+		self::$_instance->_dependency_map[ $class ] = $dependency_count
+			// then truncate the  final array to match that count
+			? array_slice($dependencies, 0, $dependency_count)
+			// otherwise just take the incoming array because nothing previously existed
+			: $dependencies;
+		return $registered;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $loader
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public static function register_class_loader($class_name, $loader = 'load_core')
+	{
+		if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
+			throw new DomainException(
+				esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
+			);
+		}
+		// check that loader is callable or method starts with "load_" and exists in EE_Registry
+		if (! is_callable($loader)
+			&& (
+				strpos($loader, 'load_') !== 0
+				|| ! method_exists('EE_Registry', $loader)
+			)
+		) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'"%1$s" is not a valid loader method on EE_Registry.',
+						'event_espresso'
+					),
+					$loader
+				)
+			);
+		}
+		$class_name = self::$_instance->getFqnForAlias($class_name);
+		if (! isset(self::$_instance->_class_loaders[ $class_name ])) {
+			self::$_instance->_class_loaders[ $class_name ] = $loader;
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function dependency_map()
+	{
+		return $this->_dependency_map;
+	}
+
+
+	/**
+	 * returns TRUE if dependency map contains a listing for the provided class name
+	 *
+	 * @param string $class_name
+	 * @return boolean
+	 */
+	public function has($class_name = '')
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		return isset($this->_dependency_map[ $class_name ]) ? true : false;
+	}
+
+
+	/**
+	 * returns TRUE if dependency map contains a listing for the provided class name AND dependency
+	 *
+	 * @param string $class_name
+	 * @param string $dependency
+	 * @return bool
+	 */
+	public function has_dependency_for_class($class_name = '', $dependency = '')
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		$dependency = $this->getFqnForAlias($dependency, $class_name);
+		return isset($this->_dependency_map[ $class_name ][ $dependency ])
+			? true
+			: false;
+	}
+
+
+	/**
+	 * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
+	 *
+	 * @param string $class_name
+	 * @param string $dependency
+	 * @return int
+	 */
+	public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		$dependency = $this->getFqnForAlias($dependency);
+		return $this->has_dependency_for_class($class_name, $dependency)
+			? $this->_dependency_map[ $class_name ][ $dependency ]
+			: EE_Dependency_Map::not_registered;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return string | Closure
+	 */
+	public function class_loader($class_name)
+	{
+		// all legacy models use load_model()
+		if (strpos($class_name, 'EEM_') === 0) {
+			return 'load_model';
+		}
+		$class_name = $this->getFqnForAlias($class_name);
+		return isset($this->_class_loaders[ $class_name ]) ? $this->_class_loaders[ $class_name ] : '';
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function class_loaders()
+	{
+		return $this->_class_loaders;
+	}
+
+
+	/**
+	 * adds an alias for a classname
+	 *
+	 * @param string $fqcn      the class name that should be used (concrete class to replace interface)
+	 * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
+	 * @param string $for_class the class that has the dependency (is type hinting for the interface)
+	 */
+	public function add_alias($fqcn, $alias, $for_class = '')
+	{
+		$this->class_cache->addAlias($fqcn, $alias, $for_class);
+	}
+
+
+	/**
+	 * Returns TRUE if the provided fully qualified name IS an alias
+	 * WHY?
+	 * Because if a class is type hinting for a concretion,
+	 * then why would we need to find another class to supply it?
+	 * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
+	 * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
+	 * Don't go looking for some substitute.
+	 * Whereas if a class is type hinting for an interface...
+	 * then we need to find an actual class to use.
+	 * So the interface IS the alias for some other FQN,
+	 * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
+	 * represents some other class.
+	 *
+	 * @param string $fqn
+	 * @param string $for_class
+	 * @return bool
+	 */
+	public function isAlias($fqn = '', $for_class = '')
+	{
+		return $this->class_cache->isAlias($fqn, $for_class);
+	}
+
+
+	/**
+	 * Returns a FQN for provided alias if one exists, otherwise returns the original $alias
+	 * functions recursively, so that multiple aliases can be used to drill down to a FQN
+	 *  for example:
+	 *      if the following two entries were added to the _aliases array:
+	 *          array(
+	 *              'interface_alias'           => 'some\namespace\interface'
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
+	 *          )
+	 *      then one could use EE_Registry::instance()->create( 'interface_alias' )
+	 *      to load an instance of 'some\namespace\classname'
+	 *
+	 * @param string $alias
+	 * @param string $for_class
+	 * @return string
+	 */
+	public function getFqnForAlias($alias = '', $for_class = '')
+	{
+		return (string) $this->class_cache->getFqnForAlias($alias, $for_class);
+	}
+
+
+	/**
+	 * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
+	 * if one exists, or whether a new object should be generated every time the requested class is loaded.
+	 * This is done by using the following class constants:
+	 *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
+	 *        EE_Dependency_Map::load_new_object - generates a new object every time
+	 */
+	protected function _register_core_dependencies()
+	{
+		$this->_dependency_map = array(
+			'EE_Request_Handler'                                                                                          => array(
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_System'                                                                                                   => array(
+				'EE_Registry'                                 => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EE_Maintenance_Mode'                         => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Session'                                                                                                  => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
+				'EE_Encryption'                                            => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Cart'                                                                                                     => array(
+				'EE_Session' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Front_Controller'                                                                                         => array(
+				'EE_Registry'              => EE_Dependency_Map::load_from_cache,
+				'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
+				'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messenger_Collection_Loader'                                                                              => array(
+				'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Message_Type_Collection_Loader'                                                                           => array(
+				'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Message_Resource_Manager'                                                                                 => array(
+				'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
+				'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
+				'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Message_Factory'                                                                                          => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_messages'                                                                                                 => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Generator'                                                                                       => array(
+				'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
+				'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
+				'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
+				'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Processor'                                                                                       => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Queue'                                                                                           => array(
+				'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Messages_Template_Defaults'                                                                               => array(
+				'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
+				'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Message_To_Generate_From_Request'                                                                         => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+				'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandBus'                                                             => array(
+				'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\services\commands\CommandHandler'                                                              => array(
+				'EE_Registry'         => EE_Dependency_Map::load_from_cache,
+				'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
+				'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
+				'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
+				'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
+				'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
+				'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler'                                  => array(
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\database\TableManager'                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Data_Migration_Class_Base'                                                                                => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_1_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_2_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_3_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_4_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_5_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_6_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_7_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_8_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_9_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\assets\I18nRegistry'                                                             => array(
+				array(),
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\assets\Registry'                                                                 => array(
+				'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\assets\I18nRegistry'    => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\cache\BasicCacheManager'                                                         => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\cache\PostRelatedCacheManager'                                                   => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\validation\email\EmailValidationService'                                  => array(
+				'EE_Registration_Config'                     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\values\EmailAddress'                                                               => array(
+				null,
+				'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\orm\ModelFieldFactory'                                                           => array(
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'LEGACY_MODELS'                                                                                               => array(
+				null,
+				'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Module_Request_Router'                                                                                    => array(
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Registration_Processor'                                                                                   => array(
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'                                      => array(
+				null,
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
+				'EE_Request'                                                          => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\licensing\LicenseService'                                                        => array(
+				'EventEspresso\core\domain\services\pue\Stats'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\pue\Config' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Admin_Transactions_List_Table'                                                                            => array(
+				null,
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\pue\Stats'                                                                => array(
+				'EventEspresso\core\domain\services\pue\Config'        => EE_Dependency_Map::load_from_cache,
+				'EE_Maintenance_Mode'                                  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\pue\StatsGatherer' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\pue\Config'                                                               => array(
+				'EE_Network_Config' => EE_Dependency_Map::load_from_cache,
+				'EE_Config'         => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\pue\StatsGatherer'                                                        => array(
+				'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
+				'EEM_Event'          => EE_Dependency_Map::load_from_cache,
+				'EEM_Datetime'       => EE_Dependency_Map::load_from_cache,
+				'EEM_Ticket'         => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration'   => EE_Dependency_Map::load_from_cache,
+				'EEM_Transaction'    => EE_Dependency_Map::load_from_cache,
+				'EE_Config'          => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\ExitModal'                                                          => array(
+				'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\PluginUpsells'                                                      => array(
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\caffeinated\modules\recaptcha_invisible\InvisibleRecaptcha'                                    => array(
+				'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
+				'EE_Session'             => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings'                                => array(
+				'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\modules\ticket_selector\ProcessTicketSelector'                                                 => array(
+				'EE_Core_Config'                                                          => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'                             => EE_Dependency_Map::load_from_cache,
+				'EE_Session'                                                              => EE_Dependency_Map::load_from_cache,
+				'EEM_Ticket'                                                              => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker'                                     => array(
+				'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'                              => array(
+				'EE_Core_Config'                             => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'                                => array(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'                               => array(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_CPT_Strategy'                                                                                             => array(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\loaders\ObjectIdentifier'                                                        => array(
+				'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\assets\CoreAssetManager'                                                  => array(
+				'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
+				'EE_Currency_Config'                                 => EE_Dependency_Map::load_from_cache,
+				'EE_Template_Config'                                 => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\privacy\policy\PrivacyPolicy' => array(
+				'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendee' => array(
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendeeBillingData' => array(
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
+				'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportCheckins' => array(
+				'EEM_Checkin' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportRegistration' => array(
+				'EEM_Registration' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportTransaction' => array(
+				'EEM_Transaction' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAttendeeData' => array(
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAnswers' => array(
+				'EEM_Answer' => EE_Dependency_Map::load_from_cache,
+				'EEM_Question' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\editor\BlockRegistrationManager'                                                 => array(
+				'EventEspresso\core\services\assets\BlockAssetManagerCollection' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\editor\BlockCollection'      => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'                    => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\editor\blocks\CoreBlocksAssetManager' => array(
+				'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\editor\blocks\widgets\EventAttendees' => array(
+				'EventEspresso\core\domain\entities\editor\blocks\CoreBlocksAssetManager' => self::load_from_cache,
+			),
+		);
+	}
+
+
+	/**
+	 * Registers how core classes are loaded.
+	 * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
+	 *        'EE_Request_Handler' => 'load_core'
+	 *        'EE_Messages_Queue'  => 'load_lib'
+	 *        'EEH_Debug_Tools'    => 'load_helper'
+	 * or, if greater control is required, by providing a custom closure. For example:
+	 *        'Some_Class' => function () {
+	 *            return new Some_Class();
+	 *        },
+	 * This is required for instantiating dependencies
+	 * where an interface has been type hinted in a class constructor. For example:
+	 *        'Required_Interface' => function () {
+	 *            return new A_Class_That_Implements_Required_Interface();
+	 *        },
+	 */
+	protected function _register_core_class_loaders()
+	{
+		// for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot
+		// be used in a closure.
+		$request = &$this->request;
+		$response = &$this->response;
+		$legacy_request = &$this->legacy_request;
+		// $loader = &$this->loader;
+		$this->_class_loaders = array(
+			// load_core
+			'EE_Capabilities'                              => 'load_core',
+			'EE_Encryption'                                => 'load_core',
+			'EE_Front_Controller'                          => 'load_core',
+			'EE_Module_Request_Router'                     => 'load_core',
+			'EE_Registry'                                  => 'load_core',
+			'EE_Request'                                   => function () use (&$legacy_request) {
+				return $legacy_request;
+			},
+			'EventEspresso\core\services\request\Request'  => function () use (&$request) {
+				return $request;
+			},
+			'EventEspresso\core\services\request\Response' => function () use (&$response) {
+				return $response;
+			},
+			'EE_Base'                                      => 'load_core',
+			'EE_Request_Handler'                           => 'load_core',
+			'EE_Session'                                   => 'load_core',
+			'EE_Cron_Tasks'                                => 'load_core',
+			'EE_System'                                    => 'load_core',
+			'EE_Maintenance_Mode'                          => 'load_core',
+			'EE_Register_CPTs'                             => 'load_core',
+			'EE_Admin'                                     => 'load_core',
+			'EE_CPT_Strategy'                              => 'load_core',
+			// load_lib
+			'EE_Message_Resource_Manager'                  => 'load_lib',
+			'EE_Message_Type_Collection'                   => 'load_lib',
+			'EE_Message_Type_Collection_Loader'            => 'load_lib',
+			'EE_Messenger_Collection'                      => 'load_lib',
+			'EE_Messenger_Collection_Loader'               => 'load_lib',
+			'EE_Messages_Processor'                        => 'load_lib',
+			'EE_Message_Repository'                        => 'load_lib',
+			'EE_Messages_Queue'                            => 'load_lib',
+			'EE_Messages_Data_Handler_Collection'          => 'load_lib',
+			'EE_Message_Template_Group_Collection'         => 'load_lib',
+			'EE_Payment_Method_Manager'                    => 'load_lib',
+			'EE_Messages_Generator'                        => function () {
+				return EE_Registry::instance()->load_lib(
+					'Messages_Generator',
+					array(),
+					false,
+					false
+				);
+			},
+			'EE_Messages_Template_Defaults'                => function ($arguments = array()) {
+				return EE_Registry::instance()->load_lib(
+					'Messages_Template_Defaults',
+					$arguments,
+					false,
+					false
+				);
+			},
+			// load_helper
+			'EEH_Parse_Shortcodes'                         => function () {
+				if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
+					return new EEH_Parse_Shortcodes();
+				}
+				return null;
+			},
+			'EE_Template_Config'                           => function () {
+				return EE_Config::instance()->template_settings;
+			},
+			'EE_Currency_Config'                           => function () {
+				return EE_Config::instance()->currency;
+			},
+			'EE_Registration_Config'                       => function () {
+				return EE_Config::instance()->registration;
+			},
+			'EE_Core_Config'                               => function () {
+				return EE_Config::instance()->core;
+			},
+			'EventEspresso\core\services\loaders\Loader'   => function () {
+				return LoaderFactory::getLoader();
+			},
+			'EE_Network_Config'                            => function () {
+				return EE_Network_Config::instance();
+			},
+			'EE_Config'                                    => function () {
+				return EE_Config::instance();
+			},
+			'EventEspresso\core\domain\Domain'             => function () {
+				return DomainFactory::getEventEspressoCoreDomain();
+			},
+			'EE_Admin_Config'                              => function () {
+				return EE_Config::instance()->admin;
+			}
+		);
+	}
+
+
+	/**
+	 * can be used for supplying alternate names for classes,
+	 * or for connecting interface names to instantiable classes
+	 */
+	protected function _register_core_aliases()
+	{
+		$aliases = array(
+			'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
+			'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
+			'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
+			'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
+			'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
+			'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
+			'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
+			'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
+			'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
+			'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
+			'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
+			'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
+			'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
+			'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
+			'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
+			'CreateTransactionCommandHandler'                                              => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler',
+			'CreateAttendeeCommandHandler'                                                 => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler',
+			'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
+			'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
+			'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
+			'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
+			'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
+			'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
+			'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
+			'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
+			'CommandFactoryInterface'                                                      => 'EventEspresso\core\services\commands\CommandFactoryInterface',
+			'EventEspresso\core\services\commands\CommandFactoryInterface'                 => 'EventEspresso\core\services\commands\CommandFactory',
+			'EventEspresso\core\domain\services\session\SessionIdentifierInterface'        => 'EE_Session',
+			'EmailValidatorInterface'                                                      => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
+			'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface'  => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
+			'NoticeConverterInterface'                                                     => 'EventEspresso\core\services\notices\NoticeConverterInterface',
+			'EventEspresso\core\services\notices\NoticeConverterInterface'                 => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
+			'NoticesContainerInterface'                                                    => 'EventEspresso\core\services\notices\NoticesContainerInterface',
+			'EventEspresso\core\services\notices\NoticesContainerInterface'                => 'EventEspresso\core\services\notices\NoticesContainer',
+			'EventEspresso\core\services\request\RequestInterface'                         => 'EventEspresso\core\services\request\Request',
+			'EventEspresso\core\services\request\ResponseInterface'                        => 'EventEspresso\core\services\request\Response',
+			'EventEspresso\core\domain\DomainInterface'                                    => 'EventEspresso\core\domain\Domain',
+		);
+		foreach ($aliases as $alias => $fqn) {
+			if (is_array($fqn)) {
+				foreach ($fqn as $class => $for_class) {
+					$this->class_cache->addAlias($class, $alias, $for_class);
+				}
+				continue;
+			}
+			$this->class_cache->addAlias($fqn, $alias);
+		}
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+			$this->class_cache->addAlias(
+				'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices',
+				'EventEspresso\core\services\notices\NoticeConverterInterface'
+			);
+		}
+	}
+
+
+	/**
+	 * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
+	 * request Primarily used by unit tests.
+	 */
+	public function reset()
+	{
+		$this->_register_core_class_loaders();
+		$this->_register_core_dependencies();
+	}
+
+
+	/**
+	 * PLZ NOTE: a better name for this method would be is_alias()
+	 * because it returns TRUE if the provided fully qualified name IS an alias
+	 * WHY?
+	 * Because if a class is type hinting for a concretion,
+	 * then why would we need to find another class to supply it?
+	 * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
+	 * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
+	 * Don't go looking for some substitute.
+	 * Whereas if a class is type hinting for an interface...
+	 * then we need to find an actual class to use.
+	 * So the interface IS the alias for some other FQN,
+	 * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
+	 * represents some other class.
+	 *
+	 * @deprecated 4.9.62.p
+	 * @param string $fqn
+	 * @param string $for_class
+	 * @return bool
+	 */
+	public function has_alias($fqn = '', $for_class = '')
+	{
+		return $this->isAlias($fqn, $for_class);
+	}
+
+
+	/**
+	 * PLZ NOTE: a better name for this method would be get_fqn_for_alias()
+	 * because it returns a FQN for provided alias if one exists, otherwise returns the original $alias
+	 * functions recursively, so that multiple aliases can be used to drill down to a FQN
+	 *  for example:
+	 *      if the following two entries were added to the _aliases array:
+	 *          array(
+	 *              'interface_alias'           => 'some\namespace\interface'
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
+	 *          )
+	 *      then one could use EE_Registry::instance()->create( 'interface_alias' )
+	 *      to load an instance of 'some\namespace\classname'
+	 *
+	 * @deprecated 4.9.62.p
+	 * @param string $alias
+	 * @param string $for_class
+	 * @return string
+	 */
+	public function get_alias($alias = '', $for_class = '')
+	{
+		return $this->getFqnForAlias($alias, $for_class);
+	}
 }

core/libraries/payment_methods/EE_Gateway.lib.php

Indentation +488 added lines, -488 removed lines

@@ -23,492 +23,492 @@
  */
 abstract class EE_Gateway
 {
-    /**
-     * a constant used as a possible value for $_currencies_supported to indicate
-     * that ALL currencies are supported by this gateway
-     */
-    const all_currencies_supported = 'all_currencies_supported';
-    /**
-     * Where values are 3-letter currency codes
-     *
-     * @var array
-     */
-    protected $_currencies_supported = array();
-    /**
-     * Whether or not this gateway can support SENDING a refund request (ie, initiated by
-     * admin in EE's wp-admin page)
-     *
-     * @var boolean
-     */
-    protected $_supports_sending_refunds = false;
-
-    /**
-     * Whether or not this gateway can support RECEIVING a refund request from the payment
-     * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
-     *
-     * @var boolean
-     */
-    protected $_supports_receiving_refunds = false;
-    /**
-     * Model for querying for existing payments
-     *
-     * @var EEMI_Payment
-     */
-    protected $_pay_model;
-
-    /**
-     * Model used for adding to the payments log
-     *
-     * @var EEMI_Payment_Log
-     */
-    protected $_pay_log;
-
-    /**
-     * Used for formatting some input to gateways
-     *
-     * @var EEHI_Template
-     */
-    protected $_template;
-
-    /**
-     * Concrete class that implements EEHI_Money, used by most gateways
-     *
-     * @var EEHI_Money
-     */
-    protected $_money;
-
-    /**
-     * Concrete class that implements EEHI_Line_Item, used for manipulating the line item tree
-     *
-     * @var EEHI_Line_Item
-     */
-    protected $_line_item;
-
-    /**
-     * @var GatewayDataFormatterInterface
-     */
-    protected $_gateway_data_formatter;
-
-    /**
-     * @var FormatterInterface
-     */
-    protected $_unsupported_character_remover;
-
-    /**
-     * The ID of the payment method using this gateway
-     *
-     * @var int
-     */
-    protected $_ID;
-
-    /**
-     * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
-     */
-    protected $_debug_mode;
-    /**
-     *
-     * @var string $_name name to show for this payment method
-     */
-    protected $_name;
-    /**
-     *
-     * @var string name to show fir this payment method to admin-type users
-     */
-    protected $_admin_name;
-
-    /**
-     * @return EE_Gateway
-     */
-    public function __construct()
-    {
-    }
-
-    /**
-     * We don't want to serialize models as they often have circular structures
-     * (eg a payment model has a reference to each payment model object; and most
-     * payments have a transaction, most transactions have a payment method;
-     * most payment methods have a payment method type; most payment method types
-     * have a gateway. And if a gateway serializes its models, we start at the
-     * beginning again)
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties = get_object_vars($this);
-        unset($properties['_pay_model'], $properties['_pay_log']);
-        return array_keys($properties);
-    }
-
-    /**
-     * Returns whether or not this gateway should support SENDING refunds
-     * see $_supports_sending_refunds
-     *
-     * @return boolean
-     */
-    public function supports_sending_refunds()
-    {
-        return $this->_supports_sending_refunds;
-    }
-
-    /**
-     * Returns whether or not this gateway should support RECEIVING refunds
-     * see $_supports_receiving_refunds
-     *
-     * @return boolean
-     */
-    public function supports_receiving_refunds()
-    {
-        return $this->_supports_receiving_refunds;
-    }
-
-
-    /**
-     * Tries to refund the payment specified, taking into account the extra
-     * refund info. Note that if the gateway's _supports_sending_refunds is false,
-     * this should just throw an exception.
-     *
-     * @param EE_Payment $payment
-     * @param array      $refund_info
-     * @return EE_Payment for the refund
-     * @throws EE_Error
-     */
-    public function do_direct_refund(EE_Payment $payment, $refund_info = null)
-    {
-        return null;
-    }
-
-
-    /**
-     * Sets the payment method's settings so the gateway knows where to send the request
-     * etc
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        foreach ($settings_array as $name => $value) {
-            $property_name = "_" . $name;
-            $this->{$property_name} = $value;
-        }
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEMI_Payment $payment_model
-     */
-    public function set_payment_model($payment_model)
-    {
-        $this->_pay_model = $payment_model;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEMI_Payment_Log $payment_log_model
-     */
-    public function set_payment_log($payment_log_model)
-    {
-        $this->_pay_log = $payment_log_model;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Template $template_helper
-     */
-    public function set_template_helper($template_helper)
-    {
-        $this->_template = $template_helper;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Line_Item $line_item_helper
-     */
-    public function set_line_item_helper($line_item_helper)
-    {
-        $this->_line_item = $line_item_helper;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Money $money_helper
-     */
-    public function set_money_helper($money_helper)
-    {
-        $this->_money = $money_helper;
-    }
-
-
-    /**
-     * Sets the gateway data formatter helper
-     *
-     * @param GatewayDataFormatterInterface $gateway_data_formatter
-     * @throws InvalidEntityException if it's not set properly
-     */
-    public function set_gateway_data_formatter(GatewayDataFormatterInterface $gateway_data_formatter)
-    {
-        if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($gateway_data_formatter)
-                    ? get_class($gateway_data_formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
-            );
-        }
-        $this->_gateway_data_formatter = $gateway_data_formatter;
-    }
-
-    /**
-     * Gets the gateway data formatter
-     *
-     * @return GatewayDataFormatterInterface
-     * @throws InvalidEntityException if it's not set properly
-     */
-    protected function _get_gateway_formatter()
-    {
-        if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($this->_gateway_data_formatter)
-                    ? get_class($this->_gateway_data_formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
-            );
-        }
-        return $this->_gateway_data_formatter;
-    }
-
-
-    /**
-     * Sets the helper which will remove unsupported characters for most gateways
-     *
-     * @param FormatterInterface $formatter
-     * @return FormatterInterface
-     * @throws InvalidEntityException
-     */
-    public function set_unsupported_character_remover(FormatterInterface $formatter)
-    {
-        if (! $formatter instanceof FormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($formatter)
-                    ? get_class($formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
-            );
-        }
-        $this->_unsupported_character_remover = $formatter;
-    }
-
-    /**
-     * Gets the helper which removes characters which gateways might not support, like emojis etc.
-     *
-     * @return FormatterInterface
-     * @throws InvalidEntityException
-     */
-    protected function _get_unsupported_character_remover()
-    {
-        if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($this->_unsupported_character_remover)
-                    ? get_class($this->_unsupported_character_remover)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
-            );
-        }
-        return $this->_unsupported_character_remover;
-    }
-
-
-    /**
-     * @param $message
-     * @param $payment
-     */
-    public function log($message, $payment)
-    {
-        if ($payment instanceof EEI_Payment) {
-            $type = 'Payment';
-            $id = $payment->ID();
-        } else {
-            $type = 'Payment_Method';
-            $id = $this->_ID;
-        }
-        // only log if we're going to store it for longer than the minimum time
-        $reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
-        if ($reg_config->gateway_log_lifespan !== '1 second') {
-            $this->_pay_log->gateway_log($message, $id, $type);
-        }
-    }
-
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @return string
-     * @deprecated since 4.9.31 insetad use
-     *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
-     */
-    public function format_currency($amount)
-    {
-        return $this->_get_gateway_formatter()->formatCurrency($amount);
-    }
-
-    /**
-     * Returns either an array of all the currency codes supported,
-     * or a string indicating they're all supported (EE_gateway::all_currencies_supported)
-     *
-     * @return mixed array or string
-     */
-    public function currencies_supported()
-    {
-        return $this->_currencies_supported;
-    }
-
-    /**
-     * Returns what a simple summing of items and taxes for this transaction. This
-     * can be used to determine if some more complex line items, like promotions,
-     * surcharges, or cancellations occurred (in which case we might want to forget
-     * about creating an itemized list of purchases and instead only send the total due)
-     *
-     * @param EE_Transaction $transaction
-     * @return float
-     */
-    protected function _sum_items_and_taxes(EE_Transaction $transaction)
-    {
-        $total_line_item = $transaction->total_line_item();
-        $total = 0;
-        foreach ($total_line_item->get_items() as $item_line_item) {
-            $total += max($item_line_item->total(), 0);
-        }
-        foreach ($total_line_item->tax_descendants() as $tax_line_item) {
-            $total += max($tax_line_item->total(), 0);
-        }
-        return $total;
-    }
-
-    /**
-     * Determines whether or not we can easily itemize the transaction using only
-     * items and taxes (ie, no promotions or surcharges or cancellations needed)
-     *
-     * @param EEI_Payment $payment
-     * @return boolean
-     */
-    protected function _can_easily_itemize_transaction_for(EEI_Payment $payment)
-    {
-        return $this->_money->compare_floats(
-            $this->_sum_items_and_taxes($payment->transaction()),
-            $payment->transaction()->total()
-        )
-               && $this->_money->compare_floats(
-                   $payment->amount(),
-                   $payment->transaction()->total()
-               );
-    }
-
-    /**
-     * Handles updating the transaction and any other related data based on the payment.
-     * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
-     * but doing so on those functions might be too early. It's possible that the changes
-     * you make to teh transaction or registration or line items may just get overwritten
-     * at that point. Instead, you should store any info you need on the payment during those
-     * functions, and use that information at this step, which client code will decide
-     * for you when it should be called.
-     *
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        // maybe update the transaction or line items or registrations
-        // but most gateways don't need to do this, because they only update the payment
-    }
-
-    /**
-     * Gets the first event for this payment (it's possible that it could be for multiple)
-     *
-     * @param EEI_Payment $payment
-     * @return EEI_Event|null
-     * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event()
-     */
-    protected function _get_first_event_for_payment(EEI_Payment $payment)
-    {
-        return $payment->get_first_event();
-    }
-
-    /**
-     * Gets the name of the first event for which is being paid
-     *
-     * @param EEI_Payment $payment
-     * @return string
-     * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event_name()
-     */
-    protected function _get_first_event_name_for_payment(EEI_Payment $payment)
-    {
-        return $payment->get_first_event_name();
-    }
-
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
-     * @param EE_Payment $payment
-     * @return string
-     */
-    protected function _format_partial_payment_line_item_name(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
-    }
-
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
-     * @param EEI_Payment $payment
-     * @return string
-     */
-    protected function _format_partial_payment_line_item_desc(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
-    }
-
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
-     * @param EEI_Line_Item $line_item
-     * @param EEI_Payment   $payment
-     * @return string
-     */
-    protected function _format_line_item_name(EEI_Line_Item $line_item, EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
-    }
-
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
-     * @param EEI_Line_Item $line_item
-     * @param EEI_Payment   $payment
-     * @return string
-     */
-    protected function _format_line_item_desc(EEI_Line_Item $line_item, EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
-    }
-
-    /**
-     * Gets the order description that should generlly be sent to gateways
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
-     * @param EEI_Payment $payment
-     * @return type
-     */
-    protected function _format_order_description(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatOrderDescription($payment);
-    }
+	/**
+	 * a constant used as a possible value for $_currencies_supported to indicate
+	 * that ALL currencies are supported by this gateway
+	 */
+	const all_currencies_supported = 'all_currencies_supported';
+	/**
+	 * Where values are 3-letter currency codes
+	 *
+	 * @var array
+	 */
+	protected $_currencies_supported = array();
+	/**
+	 * Whether or not this gateway can support SENDING a refund request (ie, initiated by
+	 * admin in EE's wp-admin page)
+	 *
+	 * @var boolean
+	 */
+	protected $_supports_sending_refunds = false;
+
+	/**
+	 * Whether or not this gateway can support RECEIVING a refund request from the payment
+	 * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
+	 *
+	 * @var boolean
+	 */
+	protected $_supports_receiving_refunds = false;
+	/**
+	 * Model for querying for existing payments
+	 *
+	 * @var EEMI_Payment
+	 */
+	protected $_pay_model;
+
+	/**
+	 * Model used for adding to the payments log
+	 *
+	 * @var EEMI_Payment_Log
+	 */
+	protected $_pay_log;
+
+	/**
+	 * Used for formatting some input to gateways
+	 *
+	 * @var EEHI_Template
+	 */
+	protected $_template;
+
+	/**
+	 * Concrete class that implements EEHI_Money, used by most gateways
+	 *
+	 * @var EEHI_Money
+	 */
+	protected $_money;
+
+	/**
+	 * Concrete class that implements EEHI_Line_Item, used for manipulating the line item tree
+	 *
+	 * @var EEHI_Line_Item
+	 */
+	protected $_line_item;
+
+	/**
+	 * @var GatewayDataFormatterInterface
+	 */
+	protected $_gateway_data_formatter;
+
+	/**
+	 * @var FormatterInterface
+	 */
+	protected $_unsupported_character_remover;
+
+	/**
+	 * The ID of the payment method using this gateway
+	 *
+	 * @var int
+	 */
+	protected $_ID;
+
+	/**
+	 * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
+	 */
+	protected $_debug_mode;
+	/**
+	 *
+	 * @var string $_name name to show for this payment method
+	 */
+	protected $_name;
+	/**
+	 *
+	 * @var string name to show fir this payment method to admin-type users
+	 */
+	protected $_admin_name;
+
+	/**
+	 * @return EE_Gateway
+	 */
+	public function __construct()
+	{
+	}
+
+	/**
+	 * We don't want to serialize models as they often have circular structures
+	 * (eg a payment model has a reference to each payment model object; and most
+	 * payments have a transaction, most transactions have a payment method;
+	 * most payment methods have a payment method type; most payment method types
+	 * have a gateway. And if a gateway serializes its models, we start at the
+	 * beginning again)
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties = get_object_vars($this);
+		unset($properties['_pay_model'], $properties['_pay_log']);
+		return array_keys($properties);
+	}
+
+	/**
+	 * Returns whether or not this gateway should support SENDING refunds
+	 * see $_supports_sending_refunds
+	 *
+	 * @return boolean
+	 */
+	public function supports_sending_refunds()
+	{
+		return $this->_supports_sending_refunds;
+	}
+
+	/**
+	 * Returns whether or not this gateway should support RECEIVING refunds
+	 * see $_supports_receiving_refunds
+	 *
+	 * @return boolean
+	 */
+	public function supports_receiving_refunds()
+	{
+		return $this->_supports_receiving_refunds;
+	}
+
+
+	/**
+	 * Tries to refund the payment specified, taking into account the extra
+	 * refund info. Note that if the gateway's _supports_sending_refunds is false,
+	 * this should just throw an exception.
+	 *
+	 * @param EE_Payment $payment
+	 * @param array      $refund_info
+	 * @return EE_Payment for the refund
+	 * @throws EE_Error
+	 */
+	public function do_direct_refund(EE_Payment $payment, $refund_info = null)
+	{
+		return null;
+	}
+
+
+	/**
+	 * Sets the payment method's settings so the gateway knows where to send the request
+	 * etc
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		foreach ($settings_array as $name => $value) {
+			$property_name = "_" . $name;
+			$this->{$property_name} = $value;
+		}
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEMI_Payment $payment_model
+	 */
+	public function set_payment_model($payment_model)
+	{
+		$this->_pay_model = $payment_model;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEMI_Payment_Log $payment_log_model
+	 */
+	public function set_payment_log($payment_log_model)
+	{
+		$this->_pay_log = $payment_log_model;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Template $template_helper
+	 */
+	public function set_template_helper($template_helper)
+	{
+		$this->_template = $template_helper;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Line_Item $line_item_helper
+	 */
+	public function set_line_item_helper($line_item_helper)
+	{
+		$this->_line_item = $line_item_helper;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Money $money_helper
+	 */
+	public function set_money_helper($money_helper)
+	{
+		$this->_money = $money_helper;
+	}
+
+
+	/**
+	 * Sets the gateway data formatter helper
+	 *
+	 * @param GatewayDataFormatterInterface $gateway_data_formatter
+	 * @throws InvalidEntityException if it's not set properly
+	 */
+	public function set_gateway_data_formatter(GatewayDataFormatterInterface $gateway_data_formatter)
+	{
+		if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($gateway_data_formatter)
+					? get_class($gateway_data_formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
+			);
+		}
+		$this->_gateway_data_formatter = $gateway_data_formatter;
+	}
+
+	/**
+	 * Gets the gateway data formatter
+	 *
+	 * @return GatewayDataFormatterInterface
+	 * @throws InvalidEntityException if it's not set properly
+	 */
+	protected function _get_gateway_formatter()
+	{
+		if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($this->_gateway_data_formatter)
+					? get_class($this->_gateway_data_formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
+			);
+		}
+		return $this->_gateway_data_formatter;
+	}
+
+
+	/**
+	 * Sets the helper which will remove unsupported characters for most gateways
+	 *
+	 * @param FormatterInterface $formatter
+	 * @return FormatterInterface
+	 * @throws InvalidEntityException
+	 */
+	public function set_unsupported_character_remover(FormatterInterface $formatter)
+	{
+		if (! $formatter instanceof FormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($formatter)
+					? get_class($formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
+			);
+		}
+		$this->_unsupported_character_remover = $formatter;
+	}
+
+	/**
+	 * Gets the helper which removes characters which gateways might not support, like emojis etc.
+	 *
+	 * @return FormatterInterface
+	 * @throws InvalidEntityException
+	 */
+	protected function _get_unsupported_character_remover()
+	{
+		if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($this->_unsupported_character_remover)
+					? get_class($this->_unsupported_character_remover)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
+			);
+		}
+		return $this->_unsupported_character_remover;
+	}
+
+
+	/**
+	 * @param $message
+	 * @param $payment
+	 */
+	public function log($message, $payment)
+	{
+		if ($payment instanceof EEI_Payment) {
+			$type = 'Payment';
+			$id = $payment->ID();
+		} else {
+			$type = 'Payment_Method';
+			$id = $this->_ID;
+		}
+		// only log if we're going to store it for longer than the minimum time
+		$reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
+		if ($reg_config->gateway_log_lifespan !== '1 second') {
+			$this->_pay_log->gateway_log($message, $id, $type);
+		}
+	}
+
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @return string
+	 * @deprecated since 4.9.31 insetad use
+	 *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
+	 */
+	public function format_currency($amount)
+	{
+		return $this->_get_gateway_formatter()->formatCurrency($amount);
+	}
+
+	/**
+	 * Returns either an array of all the currency codes supported,
+	 * or a string indicating they're all supported (EE_gateway::all_currencies_supported)
+	 *
+	 * @return mixed array or string
+	 */
+	public function currencies_supported()
+	{
+		return $this->_currencies_supported;
+	}
+
+	/**
+	 * Returns what a simple summing of items and taxes for this transaction. This
+	 * can be used to determine if some more complex line items, like promotions,
+	 * surcharges, or cancellations occurred (in which case we might want to forget
+	 * about creating an itemized list of purchases and instead only send the total due)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return float
+	 */
+	protected function _sum_items_and_taxes(EE_Transaction $transaction)
+	{
+		$total_line_item = $transaction->total_line_item();
+		$total = 0;
+		foreach ($total_line_item->get_items() as $item_line_item) {
+			$total += max($item_line_item->total(), 0);
+		}
+		foreach ($total_line_item->tax_descendants() as $tax_line_item) {
+			$total += max($tax_line_item->total(), 0);
+		}
+		return $total;
+	}
+
+	/**
+	 * Determines whether or not we can easily itemize the transaction using only
+	 * items and taxes (ie, no promotions or surcharges or cancellations needed)
+	 *
+	 * @param EEI_Payment $payment
+	 * @return boolean
+	 */
+	protected function _can_easily_itemize_transaction_for(EEI_Payment $payment)
+	{
+		return $this->_money->compare_floats(
+			$this->_sum_items_and_taxes($payment->transaction()),
+			$payment->transaction()->total()
+		)
+			   && $this->_money->compare_floats(
+				   $payment->amount(),
+				   $payment->transaction()->total()
+			   );
+	}
+
+	/**
+	 * Handles updating the transaction and any other related data based on the payment.
+	 * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
+	 * but doing so on those functions might be too early. It's possible that the changes
+	 * you make to teh transaction or registration or line items may just get overwritten
+	 * at that point. Instead, you should store any info you need on the payment during those
+	 * functions, and use that information at this step, which client code will decide
+	 * for you when it should be called.
+	 *
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		// maybe update the transaction or line items or registrations
+		// but most gateways don't need to do this, because they only update the payment
+	}
+
+	/**
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
+	 *
+	 * @param EEI_Payment $payment
+	 * @return EEI_Event|null
+	 * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event()
+	 */
+	protected function _get_first_event_for_payment(EEI_Payment $payment)
+	{
+		return $payment->get_first_event();
+	}
+
+	/**
+	 * Gets the name of the first event for which is being paid
+	 *
+	 * @param EEI_Payment $payment
+	 * @return string
+	 * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event_name()
+	 */
+	protected function _get_first_event_name_for_payment(EEI_Payment $payment)
+	{
+		return $payment->get_first_event_name();
+	}
+
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	protected function _format_partial_payment_line_item_name(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
+	}
+
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
+	 * @param EEI_Payment $payment
+	 * @return string
+	 */
+	protected function _format_partial_payment_line_item_desc(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
+	}
+
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
+	 * @param EEI_Line_Item $line_item
+	 * @param EEI_Payment   $payment
+	 * @return string
+	 */
+	protected function _format_line_item_name(EEI_Line_Item $line_item, EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
+	}
+
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
+	 * @param EEI_Line_Item $line_item
+	 * @param EEI_Payment   $payment
+	 * @return string
+	 */
+	protected function _format_line_item_desc(EEI_Line_Item $line_item, EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
+	}
+
+	/**
+	 * Gets the order description that should generlly be sent to gateways
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
+	 * @param EEI_Payment $payment
+	 * @return type
+	 */
+	protected function _format_order_description(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatOrderDescription($payment);
+	}
 }

admin_pages/payments/Payments_Admin_Page.core.php

Indentation +1121 added lines, -1121 removed lines

@@ -14,1125 +14,1125 @@
 class Payments_Admin_Page extends EE_Admin_Page
 {
 
-    /**
-     * Variables used for when we're re-sorting the logs results, in case
-     * we needed to do two queries and we need to resort
-     *
-     * @var string
-     */
-    private $_sort_logs_again_direction;
-
-
-    /**
-     * @Constructor
-     * @access public
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @return \Payments_Admin_Page
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug = EE_PAYMENTS_PG_SLUG;
-        $this->page_label = __('Payment Methods', 'event_espresso');
-        $this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
-        $this->_admin_base_path = EE_PAYMENTS_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        // todo: all hooks for ajax goes here.
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels = array(
-            'publishbox' => __('Update Settings', 'event_espresso'),
-        );
-    }
-
-
-    protected function _set_page_routes()
-    {
-        /**
-         * 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.
-         * When cap mapping is implemented, some routes will need to use the singular form of
-         * capability method and also include the $id of the payment method for the route.
-         **/
-        $this->_page_routes = array(
-            'default'                   => array(
-                'func'       => '_payment_methods_list',
-                'capability' => 'ee_edit_payment_methods',
-            ),
-            'payment_settings'          => array(
-                'func'       => '_payment_settings',
-                'capability' => 'ee_manage_gateways',
-            ),
-            'activate_payment_method'   => array(
-                'func'       => '_activate_payment_method',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payment_methods',
-            ),
-            'deactivate_payment_method' => array(
-                'func'       => '_deactivate_payment_method',
-                'noheader'   => true,
-                'capability' => 'ee_delete_payment_methods',
-            ),
-            'update_payment_method'     => array(
-                'func'               => '_update_payment_method',
-                'noheader'           => true,
-                'headers_sent_route' => 'default',
-                'capability'         => 'ee_edit_payment_methods',
-            ),
-            'update_payment_settings'   => array(
-                'func'       => '_update_payment_settings',
-                'noheader'   => true,
-                'capability' => 'ee_manage_gateways',
-            ),
-            'payment_log'               => array(
-                'func'       => '_payment_log_overview_list_table',
-                'capability' => 'ee_read_payment_methods',
-            ),
-            'payment_log_details'       => array(
-                'func'       => '_payment_log_details',
-                'capability' => 'ee_read_payment_methods',
-            ),
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $payment_method_list_config = array(
-            'nav'           => array(
-                'label' => __('Payment Methods', 'event_espresso'),
-                'order' => 10,
-            ),
-            'metaboxes'     => $this->_default_espresso_metaboxes,
-            'help_tabs'     => array_merge(
-                array(
-                    'payment_methods_overview_help_tab' => array(
-                        'title'    => __('Payment Methods Overview', 'event_espresso'),
-                        'filename' => 'payment_methods_overview',
-                    ),
-                ),
-                $this->_add_payment_method_help_tabs()
-            ),
-            'help_tour'     => array('Payment_Methods_Selection_Help_Tour'),
-            'require_nonce' => false,
-        );
-        $this->_page_config = array(
-            'default'          => $payment_method_list_config,
-            'payment_settings' => array(
-                'nav'           => array(
-                    'label' => __('Settings', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'help_tabs'     => array(
-                    'payment_methods_settings_help_tab' => array(
-                        'title'    => __('Payment Method Settings', 'event_espresso'),
-                        'filename' => 'payment_methods_settings',
-                    ),
-                ),
-                // 'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'require_nonce' => false,
-            ),
-            'payment_log'      => array(
-                'nav'           => array(
-                    'label' => __("Logs", 'event_espresso'),
-                    'order' => 30,
-                ),
-                'list_table'    => 'Payment_Log_Admin_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function _add_payment_method_help_tabs()
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
-        $all_pmt_help_tabs_config = array();
-        foreach ($payment_method_types as $payment_method_type) {
-            if (! EE_Registry::instance()->CAP->current_user_can(
-                $payment_method_type->cap_name(),
-                'specific_payment_method_type_access'
-            )
-            ) {
-                continue;
-            }
-            foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
-                $template_args = isset($config['template_args']) ? $config['template_args'] : array();
-                $template_args['admin_page_obj'] = $this;
-                $all_pmt_help_tabs_config[ $help_tab_name ] = array(
-                    'title'   => $config['title'],
-                    'content' => EEH_Template::display_template(
-                        $payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
-                        $template_args,
-                        true
-                    ),
-                );
-            }
-        }
-        return $all_pmt_help_tabs_config;
-    }
-
-
-    // none of the below group are currently used for Gateway Settings
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee-text-links');
-        wp_enqueue_script(
-            'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
-            array('espresso-ui-theme', 'ee-datepicker'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-        // styles
-        wp_register_style(
-            'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_payments');
-        wp_enqueue_style('ee-text-links');
-        // scripts
-    }
-
-
-    protected function _payment_methods_list()
-    {
-        /**
-         * first let's ensure payment methods have been setup. We do this here because when people activate a
-         * payment method for the first time (as an addon), it may not setup its capabilities or get registered correctly due
-         * to the loading process.  However, people MUST setup the details for the payment method so its safe to do a
-         * recheck here.
-         */
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        EEM_Payment_Method::instance()->verify_button_urls();
-        // setup tabs, one for each payment method type
-        $tabs = array();
-        $payment_methods = array();
-        foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
-            // we don't want to show admin-only PMTs for now
-            if ($pmt_obj instanceof EE_PMT_Admin_Only) {
-                continue;
-            }
-            // check access
-            if (! EE_Registry::instance()->CAP->current_user_can(
-                $pmt_obj->cap_name(),
-                'specific_payment_method_type_access'
-            )
-            ) {
-                continue;
-            }
-            // check for any active pms of that type
-            $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
-            if (! $payment_method instanceof EE_Payment_Method) {
-                $payment_method = EE_Payment_Method::new_instance(
-                    array(
-                        'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
-                        'PMD_type'       => $pmt_obj->system_name(),
-                        'PMD_name'       => $pmt_obj->pretty_name(),
-                        'PMD_admin_name' => $pmt_obj->pretty_name(),
-                    )
-                );
-            }
-            $payment_methods[ $payment_method->slug() ] = $payment_method;
-        }
-        $payment_methods = apply_filters(
-            'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
-            $payment_methods
-        );
-        foreach ($payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                add_meta_box(
-                    // html id
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
-                    // title
-                    sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
-                    // callback
-                    array($this, 'payment_method_settings_meta_box'),
-                    // post type
-                    null,
-                    // context
-                    'normal',
-                    // priority
-                    'default',
-                    // callback args
-                    array('payment_method' => $payment_method)
-                );
-                // setup for tabbed content
-                $tabs[ $payment_method->slug() ] = array(
-                    'label' => $payment_method->admin_name(),
-                    'class' => $payment_method->active() ? 'gateway-active' : '',
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
-                    'title' => __('Modify this Payment Method', 'event_espresso'),
-                    'slug'  => $payment_method->slug(),
-                );
-            }
-        }
-        $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
-            $tabs,
-            'payment_method_links',
-            '|',
-            $this->_get_active_payment_method_slug()
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *   _get_active_payment_method_slug
-     *
-     * @return string
-     */
-    protected function _get_active_payment_method_slug()
-    {
-        $payment_method_slug = false;
-        // decide which payment method tab to open first, as dictated by the request's 'payment_method'
-        if (isset($this->_req_data['payment_method'])) {
-            // if they provided the current payment method, use it
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
-        }
-        $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
-        // if that didn't work or wasn't provided, find another way to select the current pm
-        if (! $this->_verify_payment_method($payment_method)) {
-            // like, looking for an active one
-            $payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
-            // test that one as well
-            if ($this->_verify_payment_method($payment_method)) {
-                $payment_method_slug = $payment_method->slug();
-            } else {
-                $payment_method_slug = 'paypal_standard';
-            }
-        }
-        return $payment_method_slug;
-    }
-
-
-    /**
-     *    payment_method_settings_meta_box
-     *    returns TRUE if the passed payment method is properly constructed and the logged in user has the correct
-     *    capabilities to access it
-     *
-     * @param \EE_Payment_Method $payment_method
-     * @return boolean
-     */
-    protected function _verify_payment_method($payment_method)
-    {
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
-            && EE_Registry::instance()->CAP->current_user_can(
-                $payment_method->type_obj()->cap_name(),
-                'specific_payment_method_type_access'
-            )
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     *    payment_method_settings_meta_box
-     *
-     * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
-     * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
-     *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
-    {
-        $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
-            ? $metabox['args']['payment_method'] : null;
-        if (! $payment_method instanceof EE_Payment_Method) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Payment method metabox setup incorrectly. No Payment method object was supplied',
-                        'event_espresso'
-                    )
-                )
-            );
-        }
-        $payment_method_scopes = $payment_method->active();
-        // if the payment method really exists show its form, otherwise the activation template
-        if ($payment_method->ID() && ! empty($payment_method_scopes)) {
-            $form = $this->_generate_payment_method_settings_form($payment_method);
-            if ($form->form_data_present_in($this->_req_data)) {
-                $form->receive_form_submission($this->_req_data);
-            }
-            echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
-        } else {
-            echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
-        }
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
-    {
-        if (! $payment_method instanceof EE_Payment_Method) {
-            return new EE_Form_Section_Proper();
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => $payment_method->slug() . '_settings_form',
-                'html_id'         => $payment_method->slug() . '_settings_form',
-                'action'          => EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action'         => 'update_payment_method',
-                        'payment_method' => $payment_method->slug(),
-                    ),
-                    EE_PAYMENTS_ADMIN_URL
-                ),
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
-                    array(
-                        'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
-                        'currency_support'        => $this->_currency_support($payment_method),
-                        'payment_method_settings' => $this->_payment_method_settings($payment_method),
-                        'update'                  => $this->_update_payment_method_button($payment_method),
-                        'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
-                        'fine_print'              => $this->_fine_print(),
-                    ),
-                    $payment_method
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _pci_dss_compliance
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
-    {
-        if ($payment_method->type_obj()->requires_https()) {
-            return new EE_Form_Section_HTML(
-                EEH_HTML::tr(
-                    EEH_HTML::th(
-                        EEH_HTML::label(
-                            EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
-                        )
-                    ) .
-                    EEH_HTML::td(
-                        EEH_HTML::strong(
-                            __(
-                                'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
-                                'event_espresso'
-                            )
-                        )
-                        .
-                        EEH_HTML::br()
-                        .
-                        __('Learn more about ', 'event_espresso')
-                        . EEH_HTML::link(
-                            'https://www.pcisecuritystandards.org/merchants/index.php',
-                            __('PCI DSS compliance', 'event_espresso')
-                        )
-                    )
-                )
-            );
-        } else {
-            return new EE_Form_Section_HTML('');
-        }
-    }
-
-
-    /**
-     * _currency_support
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _currency_support(EE_Payment_Method $payment_method)
-    {
-        if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
-            return new EE_Form_Section_HTML(
-                EEH_HTML::tr(
-                    EEH_HTML::th(
-                        EEH_HTML::label(
-                            EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
-                        )
-                    ) .
-                    EEH_HTML::td(
-                        EEH_HTML::strong(
-                            sprintf(
-                                __(
-                                    'This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
-                                    'event_espresso'
-                                ),
-                                EE_Config::instance()->currency->code
-                            )
-                        )
-                    )
-                )
-            );
-        } else {
-            return new EE_Form_Section_HTML('');
-        }
-    }
-
-
-    /**
-     * _update_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_HTML
-     */
-    protected function _payment_method_settings(EE_Payment_Method $payment_method)
-    {
-        // modify the form so we only have/show fields that will be implemented for this version
-        return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
-    }
-
-
-    /**
-     * Simplifies the form to merely reproduce 4.1's gateway settings functionality
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @param string                 $payment_method_name
-     * @return \EE_Payment_Method_Form
-     * @throws \EE_Error
-     */
-    protected function _simplify_form($form_section, $payment_method_name = '')
-    {
-        if ($form_section instanceof EE_Payment_Method_Form) {
-            $form_section->exclude(
-                array(
-                    'PMD_type', // dont want them changing the type
-                    'PMD_slug', // or the slug (probably never)
-                    'PMD_wp_user', // or the user's ID
-                    'Currency' // or the currency, until the rest of EE supports simultaneous currencies
-                )
-            );
-            return $form_section;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
-                        'event_espresso'
-                    ),
-                    $payment_method_name
-                )
-            );
-        }
-    }
-
-
-    /**
-     * _update_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_HTML
-     */
-    protected function _update_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $update_button = new EE_Submit_Input(
-            array(
-                'name'       => 'submit',
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
-                'default'    => sprintf(
-                    __('Update %s Payment Settings', 'event_espresso'),
-                    $payment_method->admin_name()
-                ),
-                'html_label' => EEH_HTML::nbsp(),
-            )
-        );
-        return new EE_Form_Section_HTML(
-            EEH_HTML::no_row(EEH_HTML::br(2)) .
-            EEH_HTML::tr(
-                EEH_HTML::th(__('Update Settings', 'event_espresso')) .
-                EEH_HTML::td(
-                    $update_button->get_html_for_input()
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _deactivate_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $link_text_and_title = sprintf(
-            __('Deactivate %1$s Payments?', 'event_espresso'),
-            $payment_method->admin_name()
-        );
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
-                EEH_HTML::td(
-                    EEH_HTML::link(
-                        EE_Admin_Page::add_query_args_and_nonce(
-                            array(
-                                'action'         => 'deactivate_payment_method',
-                                'payment_method' => $payment_method->slug(),
-                            ),
-                            EE_PAYMENTS_ADMIN_URL
-                        ),
-                        $link_text_and_title,
-                        $link_text_and_title,
-                        'deactivate_' . $payment_method->slug(),
-                        'espresso-button button-secondary'
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _activate_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $link_text_and_title = sprintf(
-            __('Activate %1$s Payment Method?', 'event_espresso'),
-            $payment_method->admin_name()
-        );
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
-                'action'          => '#',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
-                    array(
-                        new EE_Form_Section_HTML(
-                            EEH_HTML::tr(
-                                EEH_HTML::td(
-                                    $payment_method->type_obj()->introductory_html(),
-                                    '',
-                                    '',
-                                    '',
-                                    'colspan="2"'
-                                )
-                            ) .
-                            EEH_HTML::tr(
-                                EEH_HTML::th(
-                                    EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
-                                ) .
-                                EEH_HTML::td(
-                                    EEH_HTML::link(
-                                        EE_Admin_Page::add_query_args_and_nonce(
-                                            array(
-                                                'action'              => 'activate_payment_method',
-                                                'payment_method_type' => $payment_method->type(),
-                                            ),
-                                            EE_PAYMENTS_ADMIN_URL
-                                        ),
-                                        $link_text_and_title,
-                                        $link_text_and_title,
-                                        'activate_' . $payment_method->slug(),
-                                        'espresso-button-green button-primary'
-                                    )
-                                )
-                            )
-                        ),
-                    ),
-                    $payment_method
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _fine_print
-     *
-     * @access protected
-     * @return \EE_Form_Section_HTML
-     */
-    protected function _fine_print()
-    {
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th() .
-                EEH_HTML::td(
-                    EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
-                )
-            )
-        );
-    }
-
-
-    /**
-     * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
-     *
-     * @global WP_User $current_user
-     */
-    protected function _activate_payment_method()
-    {
-        if (isset($this->_req_data['payment_method_type'])) {
-            $payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
-            // see if one exists
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $payment_method = EE_Payment_Method_Manager::instance()
-                                                       ->activate_a_payment_method_of_type($payment_method_type);
-            $this->_redirect_after_action(
-                1,
-                'Payment Method',
-                'activated',
-                array('action' => 'default', 'payment_method' => $payment_method->slug())
-            );
-        } else {
-            $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
-        }
-    }
-
-
-    /**
-     * Deactivates the payment method with the specified slug, and redirects.
-     */
-    protected function _deactivate_payment_method()
-    {
-        if (isset($this->_req_data['payment_method'])) {
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
-            // deactivate it
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
-            $this->_redirect_after_action(
-                $count_updated,
-                'Payment Method',
-                'deactivated',
-                array('action' => 'default', 'payment_method' => $payment_method_slug)
-            );
-        } else {
-            $this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
-        }
-    }
-
-
-    /**
-     * Processes the payment method form that was submitted. This is slightly trickier than usual form
-     * processing because we first need to identify WHICH form was processed and which payment method
-     * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
-     * form's data is saved and we redirect to the default payment methods page, setting the updated payment method
-     * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
-     * subsequently called 'headers_sent_func' which is _payment_methods_list)
-     *
-     * @return void
-     */
-    protected function _update_payment_method()
-    {
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            // ok let's find which gateway form to use based on the form input
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            /** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
-            $correct_pmt_form_to_use = null;
-            $payment_method = null;
-            foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
-                // get the form and simplify it, like what we do when we display it
-                $pmt_form = $this->_generate_payment_method_settings_form($payment_method);
-                if ($pmt_form->form_data_present_in($this->_req_data)) {
-                    $correct_pmt_form_to_use = $pmt_form;
-                    break;
-                }
-            }
-            // if we couldn't find the correct payment method type...
-            if (! $correct_pmt_form_to_use) {
-                EE_Error::add_error(
-                    __(
-                        "We could not find which payment method type your form submission related to. Please contact support",
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
-            }
-            $correct_pmt_form_to_use->receive_form_submission($this->_req_data);
-            if ($correct_pmt_form_to_use->is_valid()) {
-                $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
-                if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
-                                'event_espresso'
-                            ),
-                            'payment_method_settings'
-                        )
-                    );
-                }
-                $payment_settings_subform->save();
-                /** @var $pm EE_Payment_Method */
-                $this->_redirect_after_action(
-                    true,
-                    'Payment Method',
-                    'updated',
-                    array('action' => 'default', 'payment_method' => $payment_method->slug())
-                );
-            } else {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
-                            'event_espresso'
-                        ),
-                        $payment_method instanceof EE_Payment_Method ? $payment_method->type_obj()->pretty_name()
-                            : __('"(unknown)"', 'event_espresso')
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return;
-    }
-
-
-    /**
-     * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _payment_settings()
-    {
-        $form = $this->getPaymentSettingsForm();
-        $this->_set_add_edit_form_tags('update_payment_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] =  $form->get_html_and_js();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *        _update_payment_settings
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _update_payment_settings()
-    {
-        $form = $this->getPaymentSettingsForm();
-        if ($form->was_submitted($this->_req_data)) {
-            $form->receive_form_submission($this->_req_data);
-            if ($form->is_valid()) {
-                /**
-                 * @var $reg_config EE_Registration_Config
-                 */
-                $loader = LoaderFactory::getLoader();
-                $reg_config = $loader->getShared('EE_Registration_Config');
-                $valid_data = $form->valid_data();
-                $reg_config->show_pending_payment_options = $valid_data['show_pending_payment_options'];
-                $reg_config->gateway_log_lifespan = $valid_data['gateway_log_lifespan'];
-            }
-        }
-        EE_Registry::instance()->CFG = apply_filters(
-            'FHEE__Payments_Admin_Page___update_payment_settings__CFG',
-            EE_Registry::instance()->CFG
-        );
-
-        $cfg =  EE_Registry::instance()->CFG ;
-
-        $what = __('Payment Settings', 'event_espresso');
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        $this->_redirect_after_action(
-            $success,
-            $what,
-            __('updated', 'event_espresso'),
-            array('action' => 'payment_settings')
-        );
-    }
-
-
-    /**
-     * Gets the form used for updating payment settings
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function getPaymentSettingsForm()
-    {
-        /**
-         * @var $reg_config EE_Registration_Config
-         */
-        $reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
-        return new EE_Form_Section_Proper(
-            array(
-                'name' => 'payment-settings',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections' => array(
-                    'show_pending_payment_options' => new EE_Yes_No_Input(
-                        array(
-                            'html_name' => 'show_pending_payment_options',
-                            'default' => $reg_config->show_pending_payment_options,
-                            'html_help_text' => esc_html__(
-                                "If a payment is marked as 'Pending Payment', or if payment is deferred (ie, an offline gateway like Check, Bank, or Invoice is used), then give registrants the option to retry payment. ",
-                                'event_espresso'
-                            )
-                        )
-                    ),
-                    'gateway_log_lifespan' => new \EE_Select_Input(
-                        $reg_config->gatewayLogLifespanOptions(),
-                        array(
-                            'html_label_text' => esc_html__('Gateway Logs Lifespan', 'event_espresso'),
-                            'html_help_text' => esc_html__('If issues arise with payments being made through a payment gateway, it\'s helpful to log non-sensitive communications with the payment gateway. But it\'s a security responsibility, so it\'s a good idea to not keep them for any longer than necessary.', 'event_espresso'),
-                            'default' => $reg_config->gateway_log_lifespan,
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    protected function _payment_log_overview_list_table()
-    {
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    protected function _set_list_table_views_payment_log()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'  => 'all',
-                'label' => __('View All Logs', 'event_espresso'),
-                'count' => 0,
-            ),
-        );
-    }
-
-
-    /**
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return array
-     */
-    public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
-    {
-        EE_Registry::instance()->load_model('Change_Log');
-        // we may need to do multiple queries (joining differently), so we actually wan tan array of query params
-        $query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
-        // check if they've selected a specific payment method
-        if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
-            $query_params[0]['OR*pm_or_pay_pm'] = array(
-                'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
-                'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
-            );
-        }
-        // take into account search
-        if (isset($this->_req_data['s']) && $this->_req_data['s']) {
-            $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
-        }
-        if (isset($this->_req_data['payment-filter-start-date'])
-            && isset($this->_req_data['payment-filter-end-date'])
-        ) {
-            // add date
-            $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
-            $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
-            // make sure our timestamps start and end right at the boundaries for each day
-            $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-            $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
-            // convert to timestamps
-            $start_date = strtotime($start_date);
-            $end_date = strtotime($end_date);
-            // makes sure start date is the lowest value and vice versa
-            $start_date = min($start_date, $end_date);
-            $end_date = max($start_date, $end_date);
-            // convert for query
-            $start_date = EEM_Change_Log::instance()
-                                        ->convert_datetime_for_query(
-                                            'LOG_time',
-                                            date('Y-m-d H:i:s', $start_date),
-                                            'Y-m-d H:i:s'
-                                        );
-            $end_date = EEM_Change_Log::instance()
-                                      ->convert_datetime_for_query(
-                                          'LOG_time',
-                                          date('Y-m-d H:i:s', $end_date),
-                                          'Y-m-d H:i:s'
-                                      );
-            $query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
-        }
-        if ($count) {
-            return EEM_Change_Log::instance()->count($query_params);
-        }
-        if (isset($this->_req_data['order'])) {
-            $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
-                : 'DESC';
-            $query_params['order_by'] = array('LOG_time' => $sort);
-        } else {
-            $query_params['order_by'] = array('LOG_time' => 'DESC');
-        }
-        $offset = ($current_page - 1) * $per_page;
-        if (! isset($this->_req_data['download_results'])) {
-            $query_params['limit'] = array($offset, $per_page);
-        }
-        // now they've requested to instead just download the file instead of viewing it.
-        if (isset($this->_req_data['download_results'])) {
-            $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
-            header('Content-Disposition: attachment');
-            header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
-            echo "<h1>Payment Logs for " . site_url() . "</h1>";
-            echo "<h3>Query:</h3>";
-            var_dump($query_params);
-            echo "<h3>Results:</h3>";
-            var_dump($wpdb_results);
-            die;
-        }
-        $results = EEM_Change_Log::instance()->get_all($query_params);
-        return $results;
-    }
-
-
-    /**
-     * Used by usort to RE-sort log query results, because we lose the ordering
-     * because we're possibly combining the results from two queries
-     *
-     * @param EE_Change_Log $logA
-     * @param EE_Change_Log $logB
-     * @return int
-     */
-    protected function _sort_logs_again($logA, $logB)
-    {
-        $timeA = $logA->get_raw('LOG_time');
-        $timeB = $logB->get_raw('LOG_time');
-        if ($timeA == $timeB) {
-            return 0;
-        }
-        $comparison = $timeA < $timeB ? -1 : 1;
-        if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
-            return $comparison * -1;
-        } else {
-            return $comparison;
-        }
-    }
-
-
-    protected function _payment_log_details()
-    {
-        EE_Registry::instance()->load_model('Change_Log');
-        /** @var $payment_log EE_Change_Log */
-        $payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
-        $payment_method = null;
-        $transaction = null;
-        if ($payment_log instanceof EE_Change_Log) {
-            if ($payment_log->object() instanceof EE_Payment) {
-                $payment_method = $payment_log->object()->payment_method();
-                $transaction = $payment_log->object()->transaction();
-            } elseif ($payment_log->object() instanceof EE_Payment_Method) {
-                $payment_method = $payment_log->object();
-            }
-        }
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
-            array(
-                'payment_log'    => $payment_log,
-                'payment_method' => $payment_method,
-                'transaction'    => $transaction,
-            ),
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
+	/**
+	 * Variables used for when we're re-sorting the logs results, in case
+	 * we needed to do two queries and we need to resort
+	 *
+	 * @var string
+	 */
+	private $_sort_logs_again_direction;
+
+
+	/**
+	 * @Constructor
+	 * @access public
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @return \Payments_Admin_Page
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug = EE_PAYMENTS_PG_SLUG;
+		$this->page_label = __('Payment Methods', 'event_espresso');
+		$this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
+		$this->_admin_base_path = EE_PAYMENTS_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		// todo: all hooks for ajax goes here.
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels = array(
+			'publishbox' => __('Update Settings', 'event_espresso'),
+		);
+	}
+
+
+	protected function _set_page_routes()
+	{
+		/**
+		 * 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.
+		 * When cap mapping is implemented, some routes will need to use the singular form of
+		 * capability method and also include the $id of the payment method for the route.
+		 **/
+		$this->_page_routes = array(
+			'default'                   => array(
+				'func'       => '_payment_methods_list',
+				'capability' => 'ee_edit_payment_methods',
+			),
+			'payment_settings'          => array(
+				'func'       => '_payment_settings',
+				'capability' => 'ee_manage_gateways',
+			),
+			'activate_payment_method'   => array(
+				'func'       => '_activate_payment_method',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payment_methods',
+			),
+			'deactivate_payment_method' => array(
+				'func'       => '_deactivate_payment_method',
+				'noheader'   => true,
+				'capability' => 'ee_delete_payment_methods',
+			),
+			'update_payment_method'     => array(
+				'func'               => '_update_payment_method',
+				'noheader'           => true,
+				'headers_sent_route' => 'default',
+				'capability'         => 'ee_edit_payment_methods',
+			),
+			'update_payment_settings'   => array(
+				'func'       => '_update_payment_settings',
+				'noheader'   => true,
+				'capability' => 'ee_manage_gateways',
+			),
+			'payment_log'               => array(
+				'func'       => '_payment_log_overview_list_table',
+				'capability' => 'ee_read_payment_methods',
+			),
+			'payment_log_details'       => array(
+				'func'       => '_payment_log_details',
+				'capability' => 'ee_read_payment_methods',
+			),
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$payment_method_list_config = array(
+			'nav'           => array(
+				'label' => __('Payment Methods', 'event_espresso'),
+				'order' => 10,
+			),
+			'metaboxes'     => $this->_default_espresso_metaboxes,
+			'help_tabs'     => array_merge(
+				array(
+					'payment_methods_overview_help_tab' => array(
+						'title'    => __('Payment Methods Overview', 'event_espresso'),
+						'filename' => 'payment_methods_overview',
+					),
+				),
+				$this->_add_payment_method_help_tabs()
+			),
+			'help_tour'     => array('Payment_Methods_Selection_Help_Tour'),
+			'require_nonce' => false,
+		);
+		$this->_page_config = array(
+			'default'          => $payment_method_list_config,
+			'payment_settings' => array(
+				'nav'           => array(
+					'label' => __('Settings', 'event_espresso'),
+					'order' => 20,
+				),
+				'help_tabs'     => array(
+					'payment_methods_settings_help_tab' => array(
+						'title'    => __('Payment Method Settings', 'event_espresso'),
+						'filename' => 'payment_methods_settings',
+					),
+				),
+				// 'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'require_nonce' => false,
+			),
+			'payment_log'      => array(
+				'nav'           => array(
+					'label' => __("Logs", 'event_espresso'),
+					'order' => 30,
+				),
+				'list_table'    => 'Payment_Log_Admin_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function _add_payment_method_help_tabs()
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
+		$all_pmt_help_tabs_config = array();
+		foreach ($payment_method_types as $payment_method_type) {
+			if (! EE_Registry::instance()->CAP->current_user_can(
+				$payment_method_type->cap_name(),
+				'specific_payment_method_type_access'
+			)
+			) {
+				continue;
+			}
+			foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
+				$template_args = isset($config['template_args']) ? $config['template_args'] : array();
+				$template_args['admin_page_obj'] = $this;
+				$all_pmt_help_tabs_config[ $help_tab_name ] = array(
+					'title'   => $config['title'],
+					'content' => EEH_Template::display_template(
+						$payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
+						$template_args,
+						true
+					),
+				);
+			}
+		}
+		return $all_pmt_help_tabs_config;
+	}
+
+
+	// none of the below group are currently used for Gateway Settings
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee-text-links');
+		wp_enqueue_script(
+			'espresso_payments',
+			EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
+			array('espresso-ui-theme', 'ee-datepicker'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+		// styles
+		wp_register_style(
+			'espresso_payments',
+			EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_payments');
+		wp_enqueue_style('ee-text-links');
+		// scripts
+	}
+
+
+	protected function _payment_methods_list()
+	{
+		/**
+		 * first let's ensure payment methods have been setup. We do this here because when people activate a
+		 * payment method for the first time (as an addon), it may not setup its capabilities or get registered correctly due
+		 * to the loading process.  However, people MUST setup the details for the payment method so its safe to do a
+		 * recheck here.
+		 */
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		EEM_Payment_Method::instance()->verify_button_urls();
+		// setup tabs, one for each payment method type
+		$tabs = array();
+		$payment_methods = array();
+		foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
+			// we don't want to show admin-only PMTs for now
+			if ($pmt_obj instanceof EE_PMT_Admin_Only) {
+				continue;
+			}
+			// check access
+			if (! EE_Registry::instance()->CAP->current_user_can(
+				$pmt_obj->cap_name(),
+				'specific_payment_method_type_access'
+			)
+			) {
+				continue;
+			}
+			// check for any active pms of that type
+			$payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
+			if (! $payment_method instanceof EE_Payment_Method) {
+				$payment_method = EE_Payment_Method::new_instance(
+					array(
+						'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
+						'PMD_type'       => $pmt_obj->system_name(),
+						'PMD_name'       => $pmt_obj->pretty_name(),
+						'PMD_admin_name' => $pmt_obj->pretty_name(),
+					)
+				);
+			}
+			$payment_methods[ $payment_method->slug() ] = $payment_method;
+		}
+		$payment_methods = apply_filters(
+			'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
+			$payment_methods
+		);
+		foreach ($payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				add_meta_box(
+					// html id
+					'espresso_' . $payment_method->slug() . '_payment_settings',
+					// title
+					sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
+					// callback
+					array($this, 'payment_method_settings_meta_box'),
+					// post type
+					null,
+					// context
+					'normal',
+					// priority
+					'default',
+					// callback args
+					array('payment_method' => $payment_method)
+				);
+				// setup for tabbed content
+				$tabs[ $payment_method->slug() ] = array(
+					'label' => $payment_method->admin_name(),
+					'class' => $payment_method->active() ? 'gateway-active' : '',
+					'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
+					'title' => __('Modify this Payment Method', 'event_espresso'),
+					'slug'  => $payment_method->slug(),
+				);
+			}
+		}
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
+			$tabs,
+			'payment_method_links',
+			'|',
+			$this->_get_active_payment_method_slug()
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *   _get_active_payment_method_slug
+	 *
+	 * @return string
+	 */
+	protected function _get_active_payment_method_slug()
+	{
+		$payment_method_slug = false;
+		// decide which payment method tab to open first, as dictated by the request's 'payment_method'
+		if (isset($this->_req_data['payment_method'])) {
+			// if they provided the current payment method, use it
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
+		}
+		$payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
+		// if that didn't work or wasn't provided, find another way to select the current pm
+		if (! $this->_verify_payment_method($payment_method)) {
+			// like, looking for an active one
+			$payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
+			// test that one as well
+			if ($this->_verify_payment_method($payment_method)) {
+				$payment_method_slug = $payment_method->slug();
+			} else {
+				$payment_method_slug = 'paypal_standard';
+			}
+		}
+		return $payment_method_slug;
+	}
+
+
+	/**
+	 *    payment_method_settings_meta_box
+	 *    returns TRUE if the passed payment method is properly constructed and the logged in user has the correct
+	 *    capabilities to access it
+	 *
+	 * @param \EE_Payment_Method $payment_method
+	 * @return boolean
+	 */
+	protected function _verify_payment_method($payment_method)
+	{
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
+			&& EE_Registry::instance()->CAP->current_user_can(
+				$payment_method->type_obj()->cap_name(),
+				'specific_payment_method_type_access'
+			)
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 *    payment_method_settings_meta_box
+	 *
+	 * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
+	 * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
+	 *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
+	{
+		$payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
+			? $metabox['args']['payment_method'] : null;
+		if (! $payment_method instanceof EE_Payment_Method) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Payment method metabox setup incorrectly. No Payment method object was supplied',
+						'event_espresso'
+					)
+				)
+			);
+		}
+		$payment_method_scopes = $payment_method->active();
+		// if the payment method really exists show its form, otherwise the activation template
+		if ($payment_method->ID() && ! empty($payment_method_scopes)) {
+			$form = $this->_generate_payment_method_settings_form($payment_method);
+			if ($form->form_data_present_in($this->_req_data)) {
+				$form->receive_form_submission($this->_req_data);
+			}
+			echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
+		} else {
+			echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
+		}
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
+	{
+		if (! $payment_method instanceof EE_Payment_Method) {
+			return new EE_Form_Section_Proper();
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => $payment_method->slug() . '_settings_form',
+				'html_id'         => $payment_method->slug() . '_settings_form',
+				'action'          => EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action'         => 'update_payment_method',
+						'payment_method' => $payment_method->slug(),
+					),
+					EE_PAYMENTS_ADMIN_URL
+				),
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
+					array(
+						'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
+						'currency_support'        => $this->_currency_support($payment_method),
+						'payment_method_settings' => $this->_payment_method_settings($payment_method),
+						'update'                  => $this->_update_payment_method_button($payment_method),
+						'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
+						'fine_print'              => $this->_fine_print(),
+					),
+					$payment_method
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _pci_dss_compliance
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
+	{
+		if ($payment_method->type_obj()->requires_https()) {
+			return new EE_Form_Section_HTML(
+				EEH_HTML::tr(
+					EEH_HTML::th(
+						EEH_HTML::label(
+							EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
+						)
+					) .
+					EEH_HTML::td(
+						EEH_HTML::strong(
+							__(
+								'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
+								'event_espresso'
+							)
+						)
+						.
+						EEH_HTML::br()
+						.
+						__('Learn more about ', 'event_espresso')
+						. EEH_HTML::link(
+							'https://www.pcisecuritystandards.org/merchants/index.php',
+							__('PCI DSS compliance', 'event_espresso')
+						)
+					)
+				)
+			);
+		} else {
+			return new EE_Form_Section_HTML('');
+		}
+	}
+
+
+	/**
+	 * _currency_support
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _currency_support(EE_Payment_Method $payment_method)
+	{
+		if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
+			return new EE_Form_Section_HTML(
+				EEH_HTML::tr(
+					EEH_HTML::th(
+						EEH_HTML::label(
+							EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
+						)
+					) .
+					EEH_HTML::td(
+						EEH_HTML::strong(
+							sprintf(
+								__(
+									'This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
+									'event_espresso'
+								),
+								EE_Config::instance()->currency->code
+							)
+						)
+					)
+				)
+			);
+		} else {
+			return new EE_Form_Section_HTML('');
+		}
+	}
+
+
+	/**
+	 * _update_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_HTML
+	 */
+	protected function _payment_method_settings(EE_Payment_Method $payment_method)
+	{
+		// modify the form so we only have/show fields that will be implemented for this version
+		return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
+	}
+
+
+	/**
+	 * Simplifies the form to merely reproduce 4.1's gateway settings functionality
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @param string                 $payment_method_name
+	 * @return \EE_Payment_Method_Form
+	 * @throws \EE_Error
+	 */
+	protected function _simplify_form($form_section, $payment_method_name = '')
+	{
+		if ($form_section instanceof EE_Payment_Method_Form) {
+			$form_section->exclude(
+				array(
+					'PMD_type', // dont want them changing the type
+					'PMD_slug', // or the slug (probably never)
+					'PMD_wp_user', // or the user's ID
+					'Currency' // or the currency, until the rest of EE supports simultaneous currencies
+				)
+			);
+			return $form_section;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
+						'event_espresso'
+					),
+					$payment_method_name
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * _update_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_HTML
+	 */
+	protected function _update_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$update_button = new EE_Submit_Input(
+			array(
+				'name'       => 'submit',
+				'html_id'    => 'save_' . $payment_method->slug() . '_settings',
+				'default'    => sprintf(
+					__('Update %s Payment Settings', 'event_espresso'),
+					$payment_method->admin_name()
+				),
+				'html_label' => EEH_HTML::nbsp(),
+			)
+		);
+		return new EE_Form_Section_HTML(
+			EEH_HTML::no_row(EEH_HTML::br(2)) .
+			EEH_HTML::tr(
+				EEH_HTML::th(__('Update Settings', 'event_espresso')) .
+				EEH_HTML::td(
+					$update_button->get_html_for_input()
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _deactivate_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$link_text_and_title = sprintf(
+			__('Deactivate %1$s Payments?', 'event_espresso'),
+			$payment_method->admin_name()
+		);
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
+				EEH_HTML::td(
+					EEH_HTML::link(
+						EE_Admin_Page::add_query_args_and_nonce(
+							array(
+								'action'         => 'deactivate_payment_method',
+								'payment_method' => $payment_method->slug(),
+							),
+							EE_PAYMENTS_ADMIN_URL
+						),
+						$link_text_and_title,
+						$link_text_and_title,
+						'deactivate_' . $payment_method->slug(),
+						'espresso-button button-secondary'
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _activate_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$link_text_and_title = sprintf(
+			__('Activate %1$s Payment Method?', 'event_espresso'),
+			$payment_method->admin_name()
+		);
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
+				'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
+				'action'          => '#',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
+					array(
+						new EE_Form_Section_HTML(
+							EEH_HTML::tr(
+								EEH_HTML::td(
+									$payment_method->type_obj()->introductory_html(),
+									'',
+									'',
+									'',
+									'colspan="2"'
+								)
+							) .
+							EEH_HTML::tr(
+								EEH_HTML::th(
+									EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
+								) .
+								EEH_HTML::td(
+									EEH_HTML::link(
+										EE_Admin_Page::add_query_args_and_nonce(
+											array(
+												'action'              => 'activate_payment_method',
+												'payment_method_type' => $payment_method->type(),
+											),
+											EE_PAYMENTS_ADMIN_URL
+										),
+										$link_text_and_title,
+										$link_text_and_title,
+										'activate_' . $payment_method->slug(),
+										'espresso-button-green button-primary'
+									)
+								)
+							)
+						),
+					),
+					$payment_method
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _fine_print
+	 *
+	 * @access protected
+	 * @return \EE_Form_Section_HTML
+	 */
+	protected function _fine_print()
+	{
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th() .
+				EEH_HTML::td(
+					EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
+	 *
+	 * @global WP_User $current_user
+	 */
+	protected function _activate_payment_method()
+	{
+		if (isset($this->_req_data['payment_method_type'])) {
+			$payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
+			// see if one exists
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$payment_method = EE_Payment_Method_Manager::instance()
+													   ->activate_a_payment_method_of_type($payment_method_type);
+			$this->_redirect_after_action(
+				1,
+				'Payment Method',
+				'activated',
+				array('action' => 'default', 'payment_method' => $payment_method->slug())
+			);
+		} else {
+			$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
+		}
+	}
+
+
+	/**
+	 * Deactivates the payment method with the specified slug, and redirects.
+	 */
+	protected function _deactivate_payment_method()
+	{
+		if (isset($this->_req_data['payment_method'])) {
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
+			// deactivate it
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
+			$this->_redirect_after_action(
+				$count_updated,
+				'Payment Method',
+				'deactivated',
+				array('action' => 'default', 'payment_method' => $payment_method_slug)
+			);
+		} else {
+			$this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
+		}
+	}
+
+
+	/**
+	 * Processes the payment method form that was submitted. This is slightly trickier than usual form
+	 * processing because we first need to identify WHICH form was processed and which payment method
+	 * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
+	 * form's data is saved and we redirect to the default payment methods page, setting the updated payment method
+	 * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
+	 * subsequently called 'headers_sent_func' which is _payment_methods_list)
+	 *
+	 * @return void
+	 */
+	protected function _update_payment_method()
+	{
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+			// ok let's find which gateway form to use based on the form input
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			/** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
+			$correct_pmt_form_to_use = null;
+			$payment_method = null;
+			foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
+				// get the form and simplify it, like what we do when we display it
+				$pmt_form = $this->_generate_payment_method_settings_form($payment_method);
+				if ($pmt_form->form_data_present_in($this->_req_data)) {
+					$correct_pmt_form_to_use = $pmt_form;
+					break;
+				}
+			}
+			// if we couldn't find the correct payment method type...
+			if (! $correct_pmt_form_to_use) {
+				EE_Error::add_error(
+					__(
+						"We could not find which payment method type your form submission related to. Please contact support",
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
+			}
+			$correct_pmt_form_to_use->receive_form_submission($this->_req_data);
+			if ($correct_pmt_form_to_use->is_valid()) {
+				$payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
+				if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
+								'event_espresso'
+							),
+							'payment_method_settings'
+						)
+					);
+				}
+				$payment_settings_subform->save();
+				/** @var $pm EE_Payment_Method */
+				$this->_redirect_after_action(
+					true,
+					'Payment Method',
+					'updated',
+					array('action' => 'default', 'payment_method' => $payment_method->slug())
+				);
+			} else {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
+							'event_espresso'
+						),
+						$payment_method instanceof EE_Payment_Method ? $payment_method->type_obj()->pretty_name()
+							: __('"(unknown)"', 'event_espresso')
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return;
+	}
+
+
+	/**
+	 * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _payment_settings()
+	{
+		$form = $this->getPaymentSettingsForm();
+		$this->_set_add_edit_form_tags('update_payment_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] =  $form->get_html_and_js();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *        _update_payment_settings
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _update_payment_settings()
+	{
+		$form = $this->getPaymentSettingsForm();
+		if ($form->was_submitted($this->_req_data)) {
+			$form->receive_form_submission($this->_req_data);
+			if ($form->is_valid()) {
+				/**
+				 * @var $reg_config EE_Registration_Config
+				 */
+				$loader = LoaderFactory::getLoader();
+				$reg_config = $loader->getShared('EE_Registration_Config');
+				$valid_data = $form->valid_data();
+				$reg_config->show_pending_payment_options = $valid_data['show_pending_payment_options'];
+				$reg_config->gateway_log_lifespan = $valid_data['gateway_log_lifespan'];
+			}
+		}
+		EE_Registry::instance()->CFG = apply_filters(
+			'FHEE__Payments_Admin_Page___update_payment_settings__CFG',
+			EE_Registry::instance()->CFG
+		);
+
+		$cfg =  EE_Registry::instance()->CFG ;
+
+		$what = __('Payment Settings', 'event_espresso');
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		$this->_redirect_after_action(
+			$success,
+			$what,
+			__('updated', 'event_espresso'),
+			array('action' => 'payment_settings')
+		);
+	}
+
+
+	/**
+	 * Gets the form used for updating payment settings
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function getPaymentSettingsForm()
+	{
+		/**
+		 * @var $reg_config EE_Registration_Config
+		 */
+		$reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
+		return new EE_Form_Section_Proper(
+			array(
+				'name' => 'payment-settings',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections' => array(
+					'show_pending_payment_options' => new EE_Yes_No_Input(
+						array(
+							'html_name' => 'show_pending_payment_options',
+							'default' => $reg_config->show_pending_payment_options,
+							'html_help_text' => esc_html__(
+								"If a payment is marked as 'Pending Payment', or if payment is deferred (ie, an offline gateway like Check, Bank, or Invoice is used), then give registrants the option to retry payment. ",
+								'event_espresso'
+							)
+						)
+					),
+					'gateway_log_lifespan' => new \EE_Select_Input(
+						$reg_config->gatewayLogLifespanOptions(),
+						array(
+							'html_label_text' => esc_html__('Gateway Logs Lifespan', 'event_espresso'),
+							'html_help_text' => esc_html__('If issues arise with payments being made through a payment gateway, it\'s helpful to log non-sensitive communications with the payment gateway. But it\'s a security responsibility, so it\'s a good idea to not keep them for any longer than necessary.', 'event_espresso'),
+							'default' => $reg_config->gateway_log_lifespan,
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	protected function _payment_log_overview_list_table()
+	{
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	protected function _set_list_table_views_payment_log()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'  => 'all',
+				'label' => __('View All Logs', 'event_espresso'),
+				'count' => 0,
+			),
+		);
+	}
+
+
+	/**
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return array
+	 */
+	public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
+	{
+		EE_Registry::instance()->load_model('Change_Log');
+		// we may need to do multiple queries (joining differently), so we actually wan tan array of query params
+		$query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
+		// check if they've selected a specific payment method
+		if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
+			$query_params[0]['OR*pm_or_pay_pm'] = array(
+				'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
+				'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
+			);
+		}
+		// take into account search
+		if (isset($this->_req_data['s']) && $this->_req_data['s']) {
+			$similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
+		}
+		if (isset($this->_req_data['payment-filter-start-date'])
+			&& isset($this->_req_data['payment-filter-end-date'])
+		) {
+			// add date
+			$start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
+			$end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
+			// make sure our timestamps start and end right at the boundaries for each day
+			$start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
+			$end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+			// convert to timestamps
+			$start_date = strtotime($start_date);
+			$end_date = strtotime($end_date);
+			// makes sure start date is the lowest value and vice versa
+			$start_date = min($start_date, $end_date);
+			$end_date = max($start_date, $end_date);
+			// convert for query
+			$start_date = EEM_Change_Log::instance()
+										->convert_datetime_for_query(
+											'LOG_time',
+											date('Y-m-d H:i:s', $start_date),
+											'Y-m-d H:i:s'
+										);
+			$end_date = EEM_Change_Log::instance()
+									  ->convert_datetime_for_query(
+										  'LOG_time',
+										  date('Y-m-d H:i:s', $end_date),
+										  'Y-m-d H:i:s'
+									  );
+			$query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
+		}
+		if ($count) {
+			return EEM_Change_Log::instance()->count($query_params);
+		}
+		if (isset($this->_req_data['order'])) {
+			$sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
+				: 'DESC';
+			$query_params['order_by'] = array('LOG_time' => $sort);
+		} else {
+			$query_params['order_by'] = array('LOG_time' => 'DESC');
+		}
+		$offset = ($current_page - 1) * $per_page;
+		if (! isset($this->_req_data['download_results'])) {
+			$query_params['limit'] = array($offset, $per_page);
+		}
+		// now they've requested to instead just download the file instead of viewing it.
+		if (isset($this->_req_data['download_results'])) {
+			$wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
+			header('Content-Disposition: attachment');
+			header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
+			echo "<h1>Payment Logs for " . site_url() . "</h1>";
+			echo "<h3>Query:</h3>";
+			var_dump($query_params);
+			echo "<h3>Results:</h3>";
+			var_dump($wpdb_results);
+			die;
+		}
+		$results = EEM_Change_Log::instance()->get_all($query_params);
+		return $results;
+	}
+
+
+	/**
+	 * Used by usort to RE-sort log query results, because we lose the ordering
+	 * because we're possibly combining the results from two queries
+	 *
+	 * @param EE_Change_Log $logA
+	 * @param EE_Change_Log $logB
+	 * @return int
+	 */
+	protected function _sort_logs_again($logA, $logB)
+	{
+		$timeA = $logA->get_raw('LOG_time');
+		$timeB = $logB->get_raw('LOG_time');
+		if ($timeA == $timeB) {
+			return 0;
+		}
+		$comparison = $timeA < $timeB ? -1 : 1;
+		if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
+			return $comparison * -1;
+		} else {
+			return $comparison;
+		}
+	}
+
+
+	protected function _payment_log_details()
+	{
+		EE_Registry::instance()->load_model('Change_Log');
+		/** @var $payment_log EE_Change_Log */
+		$payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
+		$payment_method = null;
+		$transaction = null;
+		if ($payment_log instanceof EE_Change_Log) {
+			if ($payment_log->object() instanceof EE_Payment) {
+				$payment_method = $payment_log->object()->payment_method();
+				$transaction = $payment_log->object()->transaction();
+			} elseif ($payment_log->object() instanceof EE_Payment_Method) {
+				$payment_method = $payment_log->object();
+			}
+		}
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
+			array(
+				'payment_log'    => $payment_log,
+				'payment_method' => $payment_method,
+				'transaction'    => $transaction,
+			),
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
 }

Spacing +42 added lines, -42 removed lines

@@ -170,7 +170,7 @@ 
         $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
         $all_pmt_help_tabs_config = array();
         foreach ($payment_method_types as $payment_method_type) {
-            if (! EE_Registry::instance()->CAP->current_user_can(
+            if ( ! EE_Registry::instance()->CAP->current_user_can(
                 $payment_method_type->cap_name(),
                 'specific_payment_method_type_access'
             )
@@ -180,10 +180,10 @@ 
             foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
                 $template_args = isset($config['template_args']) ? $config['template_args'] : array();
                 $template_args['admin_page_obj'] = $this;
-                $all_pmt_help_tabs_config[ $help_tab_name ] = array(
+                $all_pmt_help_tabs_config[$help_tab_name] = array(
                     'title'   => $config['title'],
                     'content' => EEH_Template::display_template(
-                        $payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
+                        $payment_method_type->file_folder().'help_tabs'.DS.$config['filename'].'.help_tab.php',
                         $template_args,
                         true
                     ),
@@ -226,7 +226,7 @@ 
         wp_enqueue_script('ee-text-links');
         wp_enqueue_script(
             'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
+            EE_PAYMENTS_ASSETS_URL.'espresso_payments_admin.js',
             array('espresso-ui-theme', 'ee-datepicker'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -239,7 +239,7 @@ 
         // styles
         wp_register_style(
             'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
+            EE_PAYMENTS_ASSETS_URL.'ee-payments.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
@@ -268,7 +268,7 @@ 
                 continue;
             }
             // check access
-            if (! EE_Registry::instance()->CAP->current_user_can(
+            if ( ! EE_Registry::instance()->CAP->current_user_can(
                 $pmt_obj->cap_name(),
                 'specific_payment_method_type_access'
             )
@@ -277,7 +277,7 @@ 
             }
             // check for any active pms of that type
             $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
-            if (! $payment_method instanceof EE_Payment_Method) {
+            if ( ! $payment_method instanceof EE_Payment_Method) {
                 $payment_method = EE_Payment_Method::new_instance(
                     array(
                         'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
@@ -287,7 +287,7 @@ 
                     )
                 );
             }
-            $payment_methods[ $payment_method->slug() ] = $payment_method;
+            $payment_methods[$payment_method->slug()] = $payment_method;
         }
         $payment_methods = apply_filters(
             'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
@@ -297,7 +297,7 @@ 
             if ($payment_method instanceof EE_Payment_Method) {
                 add_meta_box(
                     // html id
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
+                    'espresso_'.$payment_method->slug().'_payment_settings',
                     // title
                     sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
                     // callback
@@ -312,10 +312,10 @@ 
                     array('payment_method' => $payment_method)
                 );
                 // setup for tabbed content
-                $tabs[ $payment_method->slug() ] = array(
+                $tabs[$payment_method->slug()] = array(
                     'label' => $payment_method->admin_name(),
                     'class' => $payment_method->active() ? 'gateway-active' : '',
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
+                    'href'  => 'espresso_'.$payment_method->slug().'_payment_settings',
                     'title' => __('Modify this Payment Method', 'event_espresso'),
                     'slug'  => $payment_method->slug(),
                 );
@@ -346,7 +346,7 @@ 
         }
         $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
         // if that didn't work or wasn't provided, find another way to select the current pm
-        if (! $this->_verify_payment_method($payment_method)) {
+        if ( ! $this->_verify_payment_method($payment_method)) {
             // like, looking for an active one
             $payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
             // test that one as well
@@ -395,7 +395,7 @@ 
     {
         $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
             ? $metabox['args']['payment_method'] : null;
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -412,7 +412,7 @@ 
             if ($form->form_data_present_in($this->_req_data)) {
                 $form->receive_form_submission($this->_req_data);
             }
-            echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
+            echo $form->form_open().$form->get_html_and_js().$form->form_close();
         } else {
             echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
         }
@@ -428,13 +428,13 @@ 
      */
     protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
     {
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             return new EE_Form_Section_Proper();
         }
         return new EE_Form_Section_Proper(
             array(
-                'name'            => $payment_method->slug() . '_settings_form',
-                'html_id'         => $payment_method->slug() . '_settings_form',
+                'name'            => $payment_method->slug().'_settings_form',
+                'html_id'         => $payment_method->slug().'_settings_form',
                 'action'          => EE_Admin_Page::add_query_args_and_nonce(
                     array(
                         'action'         => 'update_payment_method',
@@ -476,7 +476,7 @@ 
                         EEH_HTML::label(
                             EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
                         )
-                    ) .
+                    ).
                     EEH_HTML::td(
                         EEH_HTML::strong(
                             __(
@@ -510,14 +510,14 @@ 
      */
     protected function _currency_support(EE_Payment_Method $payment_method)
     {
-        if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
+        if ( ! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
             return new EE_Form_Section_HTML(
                 EEH_HTML::tr(
                     EEH_HTML::th(
                         EEH_HTML::label(
                             EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
                         )
-                    ) .
+                    ).
                     EEH_HTML::td(
                         EEH_HTML::strong(
                             sprintf(
@@ -597,7 +597,7 @@ 
         $update_button = new EE_Submit_Input(
             array(
                 'name'       => 'submit',
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
+                'html_id'    => 'save_'.$payment_method->slug().'_settings',
                 'default'    => sprintf(
                     __('Update %s Payment Settings', 'event_espresso'),
                     $payment_method->admin_name()
@@ -606,9 +606,9 @@ 
             )
         );
         return new EE_Form_Section_HTML(
-            EEH_HTML::no_row(EEH_HTML::br(2)) .
+            EEH_HTML::no_row(EEH_HTML::br(2)).
             EEH_HTML::tr(
-                EEH_HTML::th(__('Update Settings', 'event_espresso')) .
+                EEH_HTML::th(__('Update Settings', 'event_espresso')).
                 EEH_HTML::td(
                     $update_button->get_html_for_input()
                 )
@@ -632,7 +632,7 @@ 
         );
         return new EE_Form_Section_HTML(
             EEH_HTML::tr(
-                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
+                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')).
                 EEH_HTML::td(
                     EEH_HTML::link(
                         EE_Admin_Page::add_query_args_and_nonce(
@@ -644,7 +644,7 @@ 
                         ),
                         $link_text_and_title,
                         $link_text_and_title,
-                        'deactivate_' . $payment_method->slug(),
+                        'deactivate_'.$payment_method->slug(),
                         'espresso-button button-secondary'
                     )
                 )
@@ -668,8 +668,8 @@ 
         );
         return new EE_Form_Section_Proper(
             array(
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
+                'name'            => 'activate_'.$payment_method->slug().'_settings_form',
+                'html_id'         => 'activate_'.$payment_method->slug().'_settings_form',
                 'action'          => '#',
                 'layout_strategy' => new EE_Admin_Two_Column_Layout(),
                 'subsections'     => apply_filters(
@@ -684,11 +684,11 @@ 
                                     '',
                                     'colspan="2"'
                                 )
-                            ) .
+                            ).
                             EEH_HTML::tr(
                                 EEH_HTML::th(
                                     EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
-                                ) .
+                                ).
                                 EEH_HTML::td(
                                     EEH_HTML::link(
                                         EE_Admin_Page::add_query_args_and_nonce(
@@ -700,7 +700,7 @@ 
                                         ),
                                         $link_text_and_title,
                                         $link_text_and_title,
-                                        'activate_' . $payment_method->slug(),
+                                        'activate_'.$payment_method->slug(),
                                         'espresso-button-green button-primary'
                                     )
                                 )
@@ -724,7 +724,7 @@ 
     {
         return new EE_Form_Section_HTML(
             EEH_HTML::tr(
-                EEH_HTML::th() .
+                EEH_HTML::th().
                 EEH_HTML::td(
                     EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
                 )
@@ -807,7 +807,7 @@ 
                 }
             }
             // if we couldn't find the correct payment method type...
-            if (! $correct_pmt_form_to_use) {
+            if ( ! $correct_pmt_form_to_use) {
                 EE_Error::add_error(
                     __(
                         "We could not find which payment method type your form submission related to. Please contact support",
@@ -822,7 +822,7 @@ 
             $correct_pmt_form_to_use->receive_form_submission($this->_req_data);
             if ($correct_pmt_form_to_use->is_valid()) {
                 $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
-                if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
+                if ( ! $payment_settings_subform instanceof EE_Payment_Method_Form) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -874,7 +874,7 @@ 
         $form = $this->getPaymentSettingsForm();
         $this->_set_add_edit_form_tags('update_payment_settings');
         $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] =  $form->get_html_and_js();
+        $this->_template_args['admin_page_content'] = $form->get_html_and_js();
         $this->display_admin_page_with_sidebar();
     }
 
@@ -910,7 +910,7 @@ 
             EE_Registry::instance()->CFG
         );
 
-        $cfg =  EE_Registry::instance()->CFG ;
+        $cfg = EE_Registry::instance()->CFG;
 
         $what = __('Payment Settings', 'event_espresso');
         $success = $this->_update_espresso_configuration(
@@ -1011,7 +1011,7 @@ 
         }
         // take into account search
         if (isset($this->_req_data['s']) && $this->_req_data['s']) {
-            $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
+            $similarity_string = array('LIKE', '%'.str_replace("", "%", $this->_req_data['s']).'%');
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
@@ -1031,8 +1031,8 @@ 
             $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
             $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
             // make sure our timestamps start and end right at the boundaries for each day
-            $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-            $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+            $start_date = date('Y-m-d', strtotime($start_date)).' 00:00:00';
+            $end_date = date('Y-m-d', strtotime($end_date)).' 23:59:59';
             // convert to timestamps
             $start_date = strtotime($start_date);
             $end_date = strtotime($end_date);
@@ -1065,15 +1065,15 @@ 
             $query_params['order_by'] = array('LOG_time' => 'DESC');
         }
         $offset = ($current_page - 1) * $per_page;
-        if (! isset($this->_req_data['download_results'])) {
+        if ( ! isset($this->_req_data['download_results'])) {
             $query_params['limit'] = array($offset, $per_page);
         }
         // now they've requested to instead just download the file instead of viewing it.
         if (isset($this->_req_data['download_results'])) {
             $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
             header('Content-Disposition: attachment');
-            header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
-            echo "<h1>Payment Logs for " . site_url() . "</h1>";
+            header("Content-Disposition: attachment; filename=ee_payment_logs_for_".sanitize_key(site_url()));
+            echo "<h1>Payment Logs for ".site_url()."</h1>";
             echo "<h3>Query:</h3>";
             var_dump($query_params);
             echo "<h3>Results:</h3>";
@@ -1125,7 +1125,7 @@ 
             }
         }
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
+            EE_PAYMENTS_TEMPLATE_PATH.'payment_log_details.template.php',
             array(
                 'payment_log'    => $payment_log,
                 'payment_method' => $payment_method,

core/EE_Config.core.php

Indentation +3044 added lines, -3044 removed lines

@@ -13,2438 +13,2438 @@ 
 final class EE_Config implements ResettableInterface
 {
 
-    const OPTION_NAME = 'ee_config';
-
-    const LOG_NAME = 'ee_config_log';
-
-    const LOG_LENGTH = 100;
-
-    const ADDON_OPTION_NAMES = 'ee_config_option_names';
-
-
-    /**
-     *    instance of the EE_Config object
-     *
-     * @var    EE_Config $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @var boolean $_logging_enabled
-     */
-    private static $_logging_enabled = false;
-
-    /**
-     * @var LegacyShortcodesManager $legacy_shortcodes_manager
-     */
-    private $legacy_shortcodes_manager;
-
-    /**
-     * An StdClass whose property names are addon slugs,
-     * and values are their config classes
-     *
-     * @var StdClass
-     */
-    public $addons;
-
-    /**
-     * @var EE_Admin_Config
-     */
-    public $admin;
-
-    /**
-     * @var EE_Core_Config
-     */
-    public $core;
-
-    /**
-     * @var EE_Currency_Config
-     */
-    public $currency;
-
-    /**
-     * @var EE_Organization_Config
-     */
-    public $organization;
-
-    /**
-     * @var EE_Registration_Config
-     */
-    public $registration;
-
-    /**
-     * @var EE_Template_Config
-     */
-    public $template_settings;
-
-    /**
-     * Holds EE environment values.
-     *
-     * @var EE_Environment_Config
-     */
-    public $environment;
-
-    /**
-     * settings pertaining to Google maps
-     *
-     * @var EE_Map_Config
-     */
-    public $map_settings;
-
-    /**
-     * settings pertaining to Taxes
-     *
-     * @var EE_Tax_Config
-     */
-    public $tax_settings;
-
-
-    /**
-     * Settings pertaining to global messages settings.
-     *
-     * @var EE_Messages_Config
-     */
-    public $messages;
-
-    /**
-     * @deprecated
-     * @var EE_Gateway_Config
-     */
-    public $gateway;
-
-    /**
-     * @var    array $_addon_option_names
-     * @access    private
-     */
-    private $_addon_option_names = array();
-
-    /**
-     * @var    array $_module_route_map
-     * @access    private
-     */
-    private static $_module_route_map = array();
-
-    /**
-     * @var    array $_module_forward_map
-     * @access    private
-     */
-    private static $_module_forward_map = array();
-
-    /**
-     * @var    array $_module_view_map
-     * @access    private
-     */
-    private static $_module_view_map = array();
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Config instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Config) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets the config
-     *
-     * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
-     *                               (default) leaves the database alone, and merely resets the EE_Config object to
-     *                               reflect its state in the database
-     * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
-     *                               $_instance as NULL. Useful in case you want to forget about the old instance on
-     *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
-     *                               site was put into maintenance mode)
-     * @return EE_Config
-     */
-    public static function reset($hard_reset = false, $reinstantiate = true)
-    {
-        if (self::$_instance instanceof EE_Config) {
-            if ($hard_reset) {
-                self::$_instance->legacy_shortcodes_manager = null;
-                self::$_instance->_addon_option_names = array();
-                self::$_instance->_initialize_config();
-                self::$_instance->update_espresso_config();
-            }
-            self::$_instance->update_addon_option_names();
-        }
-        self::$_instance = null;
-        // we don't need to reset the static properties imo because those should
-        // only change when a module is added or removed. Currently we don't
-        // support removing a module during a request when it previously existed
-        if ($reinstantiate) {
-            return self::instance();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     *    class constructor
-     *
-     * @access    private
-     */
-    private function __construct()
-    {
-        do_action('AHEE__EE_Config__construct__begin', $this);
-        EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
-        // setup empty config classes
-        $this->_initialize_config();
-        // load existing EE site settings
-        $this->_load_core_config();
-        // confirm everything loaded correctly and set filtered defaults if not
-        $this->_verify_config();
-        //  register shortcodes and modules
-        add_action(
-            'AHEE__EE_System__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_and_modules'),
-            999
-        );
-        //  initialize shortcodes and modules
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
-        // register widgets
-        add_action('widgets_init', array($this, 'widgets_init'), 10);
-        // shutdown
-        add_action('shutdown', array($this, 'shutdown'), 10);
-        // construct__end hook
-        do_action('AHEE__EE_Config__construct__end', $this);
-        // hardcoded hack
-        $this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public static function logging_enabled()
-    {
-        return self::$_logging_enabled;
-    }
-
-
-    /**
-     * use to get the current theme if needed from static context
-     *
-     * @return string current theme set.
-     */
-    public static function get_current_theme()
-    {
-        return isset(self::$_instance->template_settings->current_espresso_theme)
-            ? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
-    }
-
-
-    /**
-     *        _initialize_config
-     *
-     * @access private
-     * @return void
-     */
-    private function _initialize_config()
-    {
-        EE_Config::trim_log();
-        // set defaults
-        $this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
-        $this->addons = new stdClass();
-        // set _module_route_map
-        EE_Config::$_module_route_map = array();
-        // set _module_forward_map
-        EE_Config::$_module_forward_map = array();
-        // set _module_view_map
-        EE_Config::$_module_view_map = array();
-    }
-
-
-    /**
-     *        load core plugin configuration
-     *
-     * @access private
-     * @return void
-     */
-    private function _load_core_config()
-    {
-        // load_core_config__start hook
-        do_action('AHEE__EE_Config___load_core_config__start', $this);
-        $espresso_config = $this->get_espresso_config();
-        foreach ($espresso_config as $config => $settings) {
-            // load_core_config__start hook
-            $settings = apply_filters(
-                'FHEE__EE_Config___load_core_config__config_settings',
-                $settings,
-                $config,
-                $this
-            );
-            if (is_object($settings) && property_exists($this, $config)) {
-                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
-                // call configs populate method to ensure any defaults are set for empty values.
-                if (method_exists($settings, 'populate')) {
-                    $this->{$config}->populate();
-                }
-                if (method_exists($settings, 'do_hooks')) {
-                    $this->{$config}->do_hooks();
-                }
-            }
-        }
-        if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
-            $this->update_espresso_config();
-        }
-        // load_core_config__end hook
-        do_action('AHEE__EE_Config___load_core_config__end', $this);
-    }
-
-
-    /**
-     *    _verify_config
-     *
-     * @access    protected
-     * @return    void
-     */
-    protected function _verify_config()
-    {
-        $this->core = $this->core instanceof EE_Core_Config
-            ? $this->core
-            : new EE_Core_Config();
-        $this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
-        $this->organization = $this->organization instanceof EE_Organization_Config
-            ? $this->organization
-            : new EE_Organization_Config();
-        $this->organization = apply_filters(
-            'FHEE__EE_Config___initialize_config__organization',
-            $this->organization
-        );
-        $this->currency = $this->currency instanceof EE_Currency_Config
-            ? $this->currency
-            : new EE_Currency_Config();
-        $this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
-        $this->registration = $this->registration instanceof EE_Registration_Config
-            ? $this->registration
-            : new EE_Registration_Config();
-        $this->registration = apply_filters(
-            'FHEE__EE_Config___initialize_config__registration',
-            $this->registration
-        );
-        $this->admin = $this->admin instanceof EE_Admin_Config
-            ? $this->admin
-            : new EE_Admin_Config();
-        $this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
-        $this->template_settings = $this->template_settings instanceof EE_Template_Config
-            ? $this->template_settings
-            : new EE_Template_Config();
-        $this->template_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__template_settings',
-            $this->template_settings
-        );
-        $this->map_settings = $this->map_settings instanceof EE_Map_Config
-            ? $this->map_settings
-            : new EE_Map_Config();
-        $this->map_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__map_settings',
-            $this->map_settings
-        );
-        $this->environment = $this->environment instanceof EE_Environment_Config
-            ? $this->environment
-            : new EE_Environment_Config();
-        $this->environment = apply_filters(
-            'FHEE__EE_Config___initialize_config__environment',
-            $this->environment
-        );
-        $this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
-            ? $this->tax_settings
-            : new EE_Tax_Config();
-        $this->tax_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__tax_settings',
-            $this->tax_settings
-        );
-        $this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
-        $this->messages = $this->messages instanceof EE_Messages_Config
-            ? $this->messages
-            : new EE_Messages_Config();
-        $this->gateway = $this->gateway instanceof EE_Gateway_Config
-            ? $this->gateway
-            : new EE_Gateway_Config();
-        $this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
-        $this->legacy_shortcodes_manager = null;
-    }
-
-
-    /**
-     *    get_espresso_config
-     *
-     * @access    public
-     * @return    array of espresso config stuff
-     */
-    public function get_espresso_config()
-    {
-        // grab espresso configuration
-        return apply_filters(
-            'FHEE__EE_Config__get_espresso_config__CFG',
-            get_option(EE_Config::OPTION_NAME, array())
-        );
-    }
-
-
-    /**
-     *    double_check_config_comparison
-     *
-     * @access    public
-     * @param string $option
-     * @param        $old_value
-     * @param        $value
-     */
-    public function double_check_config_comparison($option = '', $old_value, $value)
-    {
-        // make sure we're checking the ee config
-        if ($option === EE_Config::OPTION_NAME) {
-            // run a loose comparison of the old value against the new value for type and properties,
-            // but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
-            if ($value != $old_value) {
-                // if they are NOT the same, then remove the hook,
-                // which means the subsequent update results will be based solely on the update query results
-                // the reason we do this is because, as stated above,
-                // WP update_option performs an exact instance comparison (===) on any update values passed to it
-                // this happens PRIOR to serialization and any subsequent update.
-                // If values are found to match their previous old value,
-                // then WP bails before performing any update.
-                // Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
-                // it just pulled from the db, with the one being passed to it (which will not match).
-                // HOWEVER, once the object is serialized and passed off to MySQL to update,
-                // MySQL MAY ALSO NOT perform the update because
-                // the string it sees in the db looks the same as the new one it has been passed!!!
-                // This results in the query returning an "affected rows" value of ZERO,
-                // which gets returned immediately by WP update_option and looks like an error.
-                remove_action('update_option', array($this, 'check_config_updated'));
-            }
-        }
-    }
-
-
-    /**
-     *    update_espresso_config
-     *
-     * @access   public
-     */
-    protected function _reset_espresso_addon_config()
-    {
-        $this->_addon_option_names = array();
-        foreach ($this->addons as $addon_name => $addon_config_obj) {
-            $addon_config_obj = maybe_unserialize($addon_config_obj);
-            if ($addon_config_obj instanceof EE_Config_Base) {
-                $this->update_config('addons', $addon_name, $addon_config_obj, false);
-            }
-            $this->addons->{$addon_name} = null;
-        }
-    }
-
-
-    /**
-     *    update_espresso_config
-     *
-     * @access   public
-     * @param   bool $add_success
-     * @param   bool $add_error
-     * @return   bool
-     */
-    public function update_espresso_config($add_success = false, $add_error = true)
-    {
-        // don't allow config updates during WP heartbeats
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
-            return false;
-        }
-        // commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
-        // $clone = clone( self::$_instance );
-        // self::$_instance = NULL;
-        do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
-        $this->_reset_espresso_addon_config();
-        // hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
-        // but BEFORE the actual update occurs
-        add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
-        // don't want to persist legacy_shortcodes_manager, but don't want to lose it either
-        $legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
-        $this->legacy_shortcodes_manager = null;
-        // now update "ee_config"
-        $saved = update_option(EE_Config::OPTION_NAME, $this);
-        $this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
-        EE_Config::log(EE_Config::OPTION_NAME);
-        // if not saved... check if the hook we just added still exists;
-        // if it does, it means one of two things:
-        // that update_option bailed at the($value === $old_value) conditional,
-        // or...
-        // the db update query returned 0 rows affected
-        // (probably because the data  value was the same from it's perspective)
-        // so the existence of the hook means that a negative result from update_option is NOT an error,
-        // but just means no update occurred, so don't display an error to the user.
-        // BUT... if update_option returns FALSE, AND the hook is missing,
-        // then it means that something truly went wrong
-        $saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
-        // remove our action since we don't want it in the system anymore
-        remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
-        do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
-        // self::$_instance = $clone;
-        // unset( $clone );
-        // if config remains the same or was updated successfully
-        if ($saved) {
-            if ($add_success) {
-                EE_Error::add_success(
-                    __('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return true;
-        } else {
-            if ($add_error) {
-                EE_Error::add_error(
-                    __('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return false;
-        }
-    }
-
-
-    /**
-     *    _verify_config_params
-     *
-     * @access    private
-     * @param    string         $section
-     * @param    string         $name
-     * @param    string         $config_class
-     * @param    EE_Config_Base $config_obj
-     * @param    array          $tests_to_run
-     * @param    bool           $display_errors
-     * @return    bool    TRUE on success, FALSE on fail
-     */
-    private function _verify_config_params(
-        $section = '',
-        $name = '',
-        $config_class = '',
-        $config_obj = null,
-        $tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
-        $display_errors = true
-    ) {
-        try {
-            foreach ($tests_to_run as $test) {
-                switch ($test) {
-                    // TEST #1 : check that section was set
-                    case 1:
-                        if (empty($section)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'No configuration section has been provided while attempting to save "%s".',
-                                            'event_espresso'
-                                        ),
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #2 : check that settings section exists
-                    case 2:
-                        if (! isset($this->{$section})) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('The "%s" configuration section does not exist.', 'event_espresso'),
-                                        $section
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #3 : check that section is the proper format
-                    case 3:
-                        if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
-                        ) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The "%s" configuration settings have not been formatted correctly.',
-                                            'event_espresso'
-                                        ),
-                                        $section
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #4 : check that config section name has been set
-                    case 4:
-                        if (empty($name)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    __(
-                                        'No name has been provided for the specific configuration section.',
-                                        'event_espresso'
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #5 : check that a config class name has been set
-                    case 5:
-                        if (empty($config_class)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    __(
-                                        'No class name has been provided for the specific configuration section.',
-                                        'event_espresso'
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #6 : verify config class is accessible
-                    case 6:
-                        if (! class_exists($config_class)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
-                                            'event_espresso'
-                                        ),
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #7 : check that config has even been set
-                    case 7:
-                        if (! isset($this->{$section}->{$name})) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
-                                        $section,
-                                        $name
-                                    )
-                                );
-                            }
-                            return false;
-                        } else {
-                            // and make sure it's not serialized
-                            $this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
-                        }
-                        break;
-                    // TEST #8 : check that config is the requested type
-                    case 8:
-                        if (! $this->{$section}->{$name} instanceof $config_class) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
-                                            'event_espresso'
-                                        ),
-                                        $section,
-                                        $name,
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #9 : verify config object
-                    case 9:
-                        if (! $config_obj instanceof EE_Config_Base) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
-                                        print_r($config_obj, true)
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                }
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-        // you have successfully run the gauntlet
-        return true;
-    }
-
-
-    /**
-     *    _generate_config_option_name
-     *
-     * @access        protected
-     * @param        string $section
-     * @param        string $name
-     * @return        string
-     */
-    private function _generate_config_option_name($section = '', $name = '')
-    {
-        return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
-    }
-
-
-    /**
-     *    _set_config_class
-     * ensures that a config class is set, either from a passed config class or one generated from the config name
-     *
-     * @access    private
-     * @param    string $config_class
-     * @param    string $name
-     * @return    string
-     */
-    private function _set_config_class($config_class = '', $name = '')
-    {
-        return ! empty($config_class)
-            ? $config_class
-            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
-    }
-
-
-    /**
-     *    set_config
-     *
-     * @access    protected
-     * @param    string         $section
-     * @param    string         $name
-     * @param    string         $config_class
-     * @param    EE_Config_Base $config_obj
-     * @return    EE_Config_Base
-     */
-    public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
-    {
-        // ensure config class is set to something
-        $config_class = $this->_set_config_class($config_class, $name);
-        // run tests 1-4, 6, and 7 to verify all config params are set and valid
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
-            return null;
-        }
-        $config_option_name = $this->_generate_config_option_name($section, $name);
-        // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
-            $this->_addon_option_names[ $config_option_name ] = $config_class;
-            $this->update_addon_option_names();
-        }
-        // verify the incoming config object but suppress errors
-        if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
-            $config_obj = new $config_class();
-        }
-        if (get_option($config_option_name)) {
-            EE_Config::log($config_option_name);
-            update_option($config_option_name, $config_obj);
-            $this->{$section}->{$name} = $config_obj;
-            return $this->{$section}->{$name};
-        } else {
-            // create a wp-option for this config
-            if (add_option($config_option_name, $config_obj, '', 'no')) {
-                $this->{$section}->{$name} = maybe_unserialize($config_obj);
-                return $this->{$section}->{$name};
-            } else {
-                EE_Error::add_error(
-                    sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return null;
-            }
-        }
-    }
-
-
-    /**
-     *    update_config
-     * Important: the config object must ALREADY be set, otherwise this will produce an error.
-     *
-     * @access    public
-     * @param    string                $section
-     * @param    string                $name
-     * @param    EE_Config_Base|string $config_obj
-     * @param    bool                  $throw_errors
-     * @return    bool
-     */
-    public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
-    {
-        // don't allow config updates during WP heartbeats
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
-            return false;
-        }
-        $config_obj = maybe_unserialize($config_obj);
-        // get class name of the incoming object
-        $config_class = get_class($config_obj);
-        // run tests 1-5 and 9 to verify config
-        if (! $this->_verify_config_params(
-            $section,
-            $name,
-            $config_class,
-            $config_obj,
-            array(1, 2, 3, 4, 7, 9)
-        )
-        ) {
-            return false;
-        }
-        $config_option_name = $this->_generate_config_option_name($section, $name);
-        // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
-            // save new config to db
-            if ($this->set_config($section, $name, $config_class, $config_obj)) {
-                return true;
-            }
-        } else {
-            // first check if the record already exists
-            $existing_config = get_option($config_option_name);
-            $config_obj = serialize($config_obj);
-            // just return if db record is already up to date (NOT type safe comparison)
-            if ($existing_config == $config_obj) {
-                $this->{$section}->{$name} = $config_obj;
-                return true;
-            } elseif (update_option($config_option_name, $config_obj)) {
-                EE_Config::log($config_option_name);
-                // update wp-option for this config class
-                $this->{$section}->{$name} = $config_obj;
-                return true;
-            } elseif ($throw_errors) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
-                            'event_espresso'
-                        ),
-                        $config_class,
-                        'EE_Config->' . $section . '->' . $name
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    get_config
-     *
-     * @access    public
-     * @param    string $section
-     * @param    string $name
-     * @param    string $config_class
-     * @return    mixed EE_Config_Base | NULL
-     */
-    public function get_config($section = '', $name = '', $config_class = '')
-    {
-        // ensure config class is set to something
-        $config_class = $this->_set_config_class($config_class, $name);
-        // run tests 1-4, 6 and 7 to verify that all params have been set
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
-            return null;
-        }
-        // now test if the requested config object exists, but suppress errors
-        if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
-            // config already exists, so pass it back
-            return $this->{$section}->{$name};
-        }
-        // load config option from db if it exists
-        $config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
-        // verify the newly retrieved config object, but suppress errors
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
-            // config is good, so set it and pass it back
-            $this->{$section}->{$name} = $config_obj;
-            return $this->{$section}->{$name};
-        }
-        // oops! $config_obj is not already set and does not exist in the db, so create a new one
-        $config_obj = $this->set_config($section, $name, $config_class);
-        // verify the newly created config object
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
-            return $this->{$section}->{$name};
-        } else {
-            EE_Error::add_error(
-                sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_config_option
-     *
-     * @access    public
-     * @param    string $config_option_name
-     * @return    mixed EE_Config_Base | FALSE
-     */
-    public function get_config_option($config_option_name = '')
-    {
-        // retrieve the wp-option for this config class.
-        $config_option = maybe_unserialize(get_option($config_option_name, array()));
-        if (empty($config_option)) {
-            EE_Config::log($config_option_name . '-NOT-FOUND');
-        }
-        return $config_option;
-    }
-
-
-    /**
-     * log
-     *
-     * @param string $config_option_name
-     */
-    public static function log($config_option_name = '')
-    {
-        if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
-            $config_log = get_option(EE_Config::LOG_NAME, array());
-            // copy incoming $_REQUEST and sanitize it so we can save it
-            $_request = $_REQUEST;
-            array_walk_recursive($_request, 'sanitize_text_field');
-            $config_log[ (string) microtime(true) ] = array(
-                'config_name' => $config_option_name,
-                'request'     => $_request,
-            );
-            update_option(EE_Config::LOG_NAME, $config_log);
-        }
-    }
-
-
-    /**
-     * trim_log
-     * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
-     */
-    public static function trim_log()
-    {
-        if (! EE_Config::logging_enabled()) {
-            return;
-        }
-        $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
-        $log_length = count($config_log);
-        if ($log_length > EE_Config::LOG_LENGTH) {
-            ksort($config_log);
-            $config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
-            update_option(EE_Config::LOG_NAME, $config_log);
-        }
-    }
-
-
-    /**
-     *    get_page_for_posts
-     *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
-     *    wp-option "page_for_posts", or "posts" if no page is selected
-     *
-     * @access    public
-     * @return    string
-     */
-    public static function get_page_for_posts()
-    {
-        $page_for_posts = get_option('page_for_posts');
-        if (! $page_for_posts) {
-            return 'posts';
-        }
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
-        return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
-    }
-
-
-    /**
-     *    register_shortcodes_and_modules.
-     *    At this point, it's too early to tell if we're maintenance mode or not.
-     *    In fact, this is where we give modules a chance to let core know they exist
-     *    so they can help trigger maintenance mode if it's needed
-     *
-     * @access    public
-     * @return    void
-     */
-    public function register_shortcodes_and_modules()
-    {
-        // allow modules to set hooks for the rest of the system
-        EE_Registry::instance()->modules = $this->_register_modules();
-    }
-
-
-    /**
-     *    initialize_shortcodes_and_modules
-     *    meaning they can start adding their hooks to get stuff done
-     *
-     * @access    public
-     * @return    void
-     */
-    public function initialize_shortcodes_and_modules()
-    {
-        // allow modules to set hooks for the rest of the system
-        $this->_initialize_modules();
-    }
-
-
-    /**
-     *    widgets_init
-     *
-     * @access private
-     * @return void
-     */
-    public function widgets_init()
-    {
-        // only init widgets on admin pages when not in complete maintenance, and
-        // on frontend when not in any maintenance mode
-        if (! EE_Maintenance_Mode::instance()->level()
-            || (
-                is_admin()
-                && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
-            )
-        ) {
-            // grab list of installed widgets
-            $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
-            // filter list of modules to register
-            $widgets_to_register = apply_filters(
-                'FHEE__EE_Config__register_widgets__widgets_to_register',
-                $widgets_to_register
-            );
-            if (! empty($widgets_to_register)) {
-                // cycle thru widget folders
-                foreach ($widgets_to_register as $widget_path) {
-                    // add to list of installed widget modules
-                    EE_Config::register_ee_widget($widget_path);
-                }
-            }
-            // filter list of installed modules
-            EE_Registry::instance()->widgets = apply_filters(
-                'FHEE__EE_Config__register_widgets__installed_widgets',
-                EE_Registry::instance()->widgets
-            );
-        }
-    }
-
-
-    /**
-     *    register_ee_widget - makes core aware of this widget
-     *
-     * @access    public
-     * @param    string $widget_path - full path up to and including widget folder
-     * @return    void
-     */
-    public static function register_ee_widget($widget_path = null)
-    {
-        do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
-        $widget_ext = '.widget.php';
-        // make all separators match
-        $widget_path = rtrim(str_replace('/\\', DS, $widget_path), DS);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($widget_path, $widget_ext) !== false) {
-            // grab and shortcode file name from directory name and break apart at dots
-            $file_name = explode('.', basename($widget_path));
-            // take first segment from file name pieces and remove class prefix if it exists
-            $widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
-            // sanitize shortcode directory name
-            $widget = sanitize_key($widget);
-            // now we need to rebuild the shortcode path
-            $widget_path = explode(DS, $widget_path);
-            // remove last segment
-            array_pop($widget_path);
-            // glue it back together
-            $widget_path = implode(DS, $widget_path);
-        } else {
-            // grab and sanitize widget directory name
-            $widget = sanitize_key(basename($widget_path));
-        }
-        // create classname from widget directory name
-        $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
-        // add class prefix
-        $widget_class = 'EEW_' . $widget;
-        // does the widget exist ?
-        if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) {
-            $msg = sprintf(
-                __(
-                    'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
-                    'event_espresso'
-                ),
-                $widget_class,
-                $widget_path . DS . $widget_class . $widget_ext
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        // load the widget class file
-        require_once($widget_path . DS . $widget_class . $widget_ext);
-        // verify that class exists
-        if (! class_exists($widget_class)) {
-            $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        register_widget($widget_class);
-        // add to array of registered widgets
-        EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
-    }
-
-
-    /**
-     *        _register_modules
-     *
-     * @access private
-     * @return array
-     */
-    private function _register_modules()
-    {
-        // grab list of installed modules
-        $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
-        // filter list of modules to register
-        $modules_to_register = apply_filters(
-            'FHEE__EE_Config__register_modules__modules_to_register',
-            $modules_to_register
-        );
-        if (! empty($modules_to_register)) {
-            // loop through folders
-            foreach ($modules_to_register as $module_path) {
-                /**TEMPORARILY EXCLUDE gateways from modules for time being**/
-                if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
-                    && $module_path !== EE_MODULES . 'gateways'
-                ) {
-                    // add to list of installed modules
-                    EE_Config::register_module($module_path);
-                }
-            }
-        }
-        // filter list of installed modules
-        return apply_filters(
-            'FHEE__EE_Config___register_modules__installed_modules',
-            EE_Registry::instance()->modules
-        );
-    }
-
-
-    /**
-     *    register_module - makes core aware of this module
-     *
-     * @access    public
-     * @param    string $module_path - full path up to and including module folder
-     * @return    bool
-     */
-    public static function register_module($module_path = null)
-    {
-        do_action('AHEE__EE_Config__register_module__begin', $module_path);
-        $module_ext = '.module.php';
-        // make all separators match
-        $module_path = str_replace(array('\\', '/'), DS, $module_path);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($module_path, $module_ext) !== false) {
-            // grab and shortcode file name from directory name and break apart at dots
-            $module_file = explode('.', basename($module_path));
-            // now we need to rebuild the shortcode path
-            $module_path = explode(DS, $module_path);
-            // remove last segment
-            array_pop($module_path);
-            // glue it back together
-            $module_path = implode(DS, $module_path) . DS;
-            // take first segment from file name pieces and sanitize it
-            $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
-            // ensure class prefix is added
-            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
-        } else {
-            // we need to generate the filename based off of the folder name
-            // grab and sanitize module name
-            $module = strtolower(basename($module_path));
-            $module = preg_replace('/[^a-z0-9_\-]/', '', $module);
-            // like trailingslashit()
-            $module_path = rtrim($module_path, DS) . DS;
-            // create classname from module directory name
-            $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
-            // add class prefix
-            $module_class = 'EED_' . $module;
-        }
-        // does the module exist ?
-        if (! is_readable($module_path . DS . $module_class . $module_ext)) {
-            $msg = sprintf(
-                __(
-                    'The requested %s module file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $module
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the module class file
-        require_once($module_path . $module_class . $module_ext);
-        // verify that class exists
-        if (! class_exists($module_class)) {
-            $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // add to array of registered modules
-        EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
-        do_action(
-            'AHEE__EE_Config__register_module__complete',
-            $module_class,
-            EE_Registry::instance()->modules->{$module_class}
-        );
-        return true;
-    }
-
-
-    /**
-     *    _initialize_modules
-     *    allow modules to set hooks for the rest of the system
-     *
-     * @access private
-     * @return void
-     */
-    private function _initialize_modules()
-    {
-        // cycle thru shortcode folders
-        foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
-            // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
-            // which set hooks ?
-            if (is_admin()) {
-                // fire immediately
-                call_user_func(array($module_class, 'set_hooks_admin'));
-            } else {
-                // delay until other systems are online
-                add_action(
-                    'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
-                    array($module_class, 'set_hooks')
-                );
-            }
-        }
-    }
-
-
-    /**
-     *    register_route - adds module method routes to route_map
-     *
-     * @access    public
-     * @param    string $route       - "pretty" public alias for module method
-     * @param    string $module      - module name (classname without EED_ prefix)
-     * @param    string $method_name - the actual module method to be routed to
-     * @param    string $key         - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
-        $module = str_replace('EED_', '', $module);
-        $module_class = 'EED_' . $module;
-        if (! isset(EE_Registry::instance()->modules->{$module_class})) {
-            $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (empty($route)) {
-            $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (! method_exists('EED_' . $module, $method_name)) {
-            $msg = sprintf(
-                __('A valid class method for the %s route has not been supplied.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_route_map[ $key ][ $route ] = array('EED_' . $module, $method_name);
-        return true;
-    }
-
-
-    /**
-     *    get_route - get module method route
-     *
-     * @access    public
-     * @param    string $route - "pretty" public alias for module method
-     * @param    string $key   - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_route($route = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_route__begin', $route);
-        $route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
-        if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
-            return EE_Config::$_module_route_map[ $key ][ $route ];
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_routes - get ALL module method routes
-     *
-     * @access    public
-     * @return    array
-     */
-    public static function get_routes()
-    {
-        return EE_Config::$_module_route_map;
-    }
-
-
-    /**
-     *    register_forward - allows modules to forward request to another module for further processing
-     *
-     * @access    public
-     * @param    string       $route   - "pretty" public alias for module method
-     * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
-     *                                 class, allows different forwards to be served based on status
-     * @param    array|string $forward - function name or array( class, method )
-     * @param    string       $key     - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
-            $msg = sprintf(
-                __('The module route %s for this forward has not been registered.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (empty($forward)) {
-            $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (is_array($forward)) {
-            if (! isset($forward[1])) {
-                $msg = sprintf(
-                    __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
-                    $route
-                );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-                return false;
-            }
-            if (! method_exists($forward[0], $forward[1])) {
-                $msg = sprintf(
-                    __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
-                    $forward[1],
-                    $route
-                );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-                return false;
-            }
-        } elseif (! function_exists($forward)) {
-            $msg = sprintf(
-                __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
-                $forward,
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
-        return true;
-    }
-
-
-    /**
-     *    get_forward - get forwarding route
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different forwards to be served based on status
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_forward($route = null, $status = 0, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
-        if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
-            return apply_filters(
-                'FHEE__EE_Config__get_forward',
-                EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
-                $route,
-                $status
-            );
-        }
-        return null;
-    }
-
-
-    /**
-     *    register_forward - allows modules to specify different view templates for different method routes and status
-     *    results
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different views to be served based on status
-     * @param    string  $view
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
-            $msg = sprintf(
-                __('The module route %s for this view has not been registered.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (! is_readable($view)) {
-            $msg = sprintf(
-                __(
-                    'The %s view file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $view
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
-        return true;
-    }
-
-
-    /**
-     *    get_view - get view for route and status
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different views to be served based on status
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_view($route = null, $status = 0, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_view__begin', $route, $status);
-        if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
-            return apply_filters(
-                'FHEE__EE_Config__get_view',
-                EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
-                $route,
-                $status
-            );
-        }
-        return null;
-    }
-
-
-    public function update_addon_option_names()
-    {
-        update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
-    }
-
-
-    public function shutdown()
-    {
-        $this->update_addon_option_names();
-    }
-
-
-    /**
-     * @return LegacyShortcodesManager
-     */
-    public static function getLegacyShortcodesManager()
-    {
-
-        if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
-            EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
-                EE_Registry::instance()
-            );
-        }
-        return EE_Config::instance()->legacy_shortcodes_manager;
-    }
-
-
-    /**
-     * register_shortcode - makes core aware of this shortcode
-     *
-     * @deprecated 4.9.26
-     * @param    string $shortcode_path - full path up to and including shortcode folder
-     * @return    bool
-     */
-    public static function register_shortcode($shortcode_path = null)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
-                'event_espresso'
-            ),
-            '4.9.26'
-        );
-        return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
-    }
-}
-
-/**
- * Base class used for config classes. These classes should generally not have
- * magic functions in use, except we'll allow them to magically set and get stuff...
- * basically, they should just be well-defined stdClasses
- */
-class EE_Config_Base
-{
-
-    /**
-     * Utility function for escaping the value of a property and returning.
-     *
-     * @param string $property property name (checks to see if exists).
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
-     * @throws \EE_Error
-     */
-    public function get_pretty($property)
-    {
-        if (! property_exists($this, $property)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    $property
-                )
-            );
-        }
-        // just handling escaping of strings for now.
-        if (is_string($this->{$property})) {
-            return stripslashes($this->{$property});
-        }
-        return $this->{$property};
-    }
-
-
-    public function populate()
-    {
-        // grab defaults via a new instance of this class.
-        $class_name = get_class($this);
-        $defaults = new $class_name;
-        // loop through the properties for this class and see if they are set.  If they are NOT, then grab the
-        // default from our $defaults object.
-        foreach (get_object_vars($defaults) as $property => $value) {
-            if ($this->{$property} === null) {
-                $this->{$property} = $value;
-            }
-        }
-        // cleanup
-        unset($defaults);
-    }
-
-
-    /**
-     *        __isset
-     *
-     * @param $a
-     * @return bool
-     */
-    public function __isset($a)
-    {
-        return false;
-    }
-
-
-    /**
-     *        __unset
-     *
-     * @param $a
-     * @return bool
-     */
-    public function __unset($a)
-    {
-        return false;
-    }
-
-
-    /**
-     *        __clone
-     */
-    public function __clone()
-    {
-    }
-
-
-    /**
-     *        __wakeup
-     */
-    public function __wakeup()
-    {
-    }
-
-
-    /**
-     *        __destruct
-     */
-    public function __destruct()
-    {
-    }
-}
-
-
-/**
- * Class for defining what's in the EE_Config relating to registration settings
- */
-class EE_Core_Config extends EE_Config_Base
-{
-
-    public $current_blog_id;
-
-    public $ee_ueip_optin;
-
-    public $ee_ueip_has_notified;
-
-    /**
-     * Not to be confused with the 4 critical page variables (See
-     * get_critical_pages_array()), this is just an array of wp posts that have EE
-     * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
-     * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
-     *
-     * @var array
-     */
-    public $post_shortcodes;
-
-    public $module_route_map;
-
-    public $module_forward_map;
-
-    public $module_view_map;
-
-    /**
-     * The next 4 vars are the IDs of critical EE pages.
-     *
-     * @var int
-     */
-    public $reg_page_id;
-
-    public $txn_page_id;
-
-    public $thank_you_page_id;
-
-    public $cancel_page_id;
-
-    /**
-     * The next 4 vars are the URLs of critical EE pages.
-     *
-     * @var int
-     */
-    public $reg_page_url;
-
-    public $txn_page_url;
-
-    public $thank_you_page_url;
-
-    public $cancel_page_url;
-
-    /**
-     * The next vars relate to the custom slugs for EE CPT routes
-     */
-    public $event_cpt_slug;
-
-
-    /**
-     * This caches the _ee_ueip_option in case this config is reset in the same
-     * request across blog switches in a multisite context.
-     * Avoids extra queries to the db for this option.
-     *
-     * @var bool
-     */
-    public static $ee_ueip_option;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default organization settings
-        $this->current_blog_id = get_current_blog_id();
-        $this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
-        $this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
-        $this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
-        $this->post_shortcodes = array();
-        $this->module_route_map = array();
-        $this->module_forward_map = array();
-        $this->module_view_map = array();
-        // critical EE page IDs
-        $this->reg_page_id = 0;
-        $this->txn_page_id = 0;
-        $this->thank_you_page_id = 0;
-        $this->cancel_page_id = 0;
-        // critical EE page URLs
-        $this->reg_page_url = '';
-        $this->txn_page_url = '';
-        $this->thank_you_page_url = '';
-        $this->cancel_page_url = '';
-        // cpt slugs
-        $this->event_cpt_slug = __('events', 'event_espresso');
-        // ueip constant check
-        if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
-            $this->ee_ueip_optin = false;
-            $this->ee_ueip_has_notified = true;
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_critical_pages_array()
-    {
-        return array(
-            $this->reg_page_id,
-            $this->txn_page_id,
-            $this->thank_you_page_id,
-            $this->cancel_page_id,
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_critical_pages_shortcodes_array()
-    {
-        return array(
-            $this->reg_page_id       => 'ESPRESSO_CHECKOUT',
-            $this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
-            $this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
-            $this->cancel_page_id    => 'ESPRESSO_CANCELLED',
-        );
-    }
-
-
-    /**
-     *  gets/returns URL for EE reg_page
-     *
-     * @access    public
-     * @return    string
-     */
-    public function reg_page_url()
-    {
-        if (! $this->reg_page_url) {
-            $this->reg_page_url = add_query_arg(
-                array('uts' => time()),
-                get_permalink($this->reg_page_id)
-            ) . '#checkout';
-        }
-        return $this->reg_page_url;
-    }
-
-
-    /**
-     *  gets/returns URL for EE txn_page
-     *
-     * @param array $query_args like what gets passed to
-     *                          add_query_arg() as the first argument
-     * @access    public
-     * @return    string
-     */
-    public function txn_page_url($query_args = array())
-    {
-        if (! $this->txn_page_url) {
-            $this->txn_page_url = get_permalink($this->txn_page_id);
-        }
-        if ($query_args) {
-            return add_query_arg($query_args, $this->txn_page_url);
-        } else {
-            return $this->txn_page_url;
-        }
-    }
-
-
-    /**
-     *  gets/returns URL for EE thank_you_page
-     *
-     * @param array $query_args like what gets passed to
-     *                          add_query_arg() as the first argument
-     * @access    public
-     * @return    string
-     */
-    public function thank_you_page_url($query_args = array())
-    {
-        if (! $this->thank_you_page_url) {
-            $this->thank_you_page_url = get_permalink($this->thank_you_page_id);
-        }
-        if ($query_args) {
-            return add_query_arg($query_args, $this->thank_you_page_url);
-        } else {
-            return $this->thank_you_page_url;
-        }
-    }
-
-
-    /**
-     *  gets/returns URL for EE cancel_page
-     *
-     * @access    public
-     * @return    string
-     */
-    public function cancel_page_url()
-    {
-        if (! $this->cancel_page_url) {
-            $this->cancel_page_url = get_permalink($this->cancel_page_id);
-        }
-        return $this->cancel_page_url;
-    }
-
-
-    /**
-     * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
-     *
-     * @since 4.7.5
-     */
-    protected function _reset_urls()
-    {
-        $this->reg_page_url = '';
-        $this->txn_page_url = '';
-        $this->cancel_page_url = '';
-        $this->thank_you_page_url = '';
-    }
-
-
-    /**
-     * Used to return what the optin value is set for the EE User Experience Program.
-     * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
-     * on the main site only.
-     *
-     * @return mixed|void
-     */
-    protected function _get_main_ee_ueip_optin()
-    {
-        // if this is the main site then we can just bypass our direct query.
-        if (is_main_site()) {
-            return get_option('ee_ueip_optin', false);
-        }
-        // is this already cached for this request?  If so use it.
-        if (! empty(EE_Core_Config::$ee_ueip_option)) {
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        global $wpdb;
-        $current_network_main_site = is_multisite() ? get_current_site() : null;
-        $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
-        $option = 'ee_ueip_optin';
-        // set correct table for query
-        $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
-        // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
-        // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
-        // re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
-        // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
-        // for the purpose of caching.
-        $pre = apply_filters('pre_option_' . $option, false, $option);
-        if (false !== $pre) {
-            EE_Core_Config::$ee_ueip_option = $pre;
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        $row = $wpdb->get_row(
-            $wpdb->prepare(
-                "SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
-                $option
-            )
-        );
-        if (is_object($row)) {
-            $value = $row->option_value;
-        } else { // option does not exist so use default.
-            return apply_filters('default_option_' . $option, false, $option);
-        }
-        EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
-        return EE_Core_Config::$ee_ueip_option;
-    }
-
-    /**
-     * Utility function for escaping the value of a property and returning.
-     *
-     * @param string $property property name (checks to see if exists).
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
-     * @throws \EE_Error
-     */
-    public function get_pretty($property)
-    {
-        if ($property === 'ee_ueip_optin') {
-            return $this->ee_ueip_optin ? 'yes' : 'no';
-        }
-        return parent::get_pretty($property);
-    }
-
-
-    /**
-     * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
-     * on the object.
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // reset all url properties
-        $this->_reset_urls();
-        // return what to save to db
-        return array_keys(get_object_vars($this));
-    }
-}
-
-
-/**
- * Config class for storing info on the Organization
- */
-class EE_Organization_Config extends EE_Config_Base
-{
-
-    /**
-     * @var string $name
-     * eg EE4.1
-     */
-    public $name;
-
-    /**
-     * @var string $address_1
-     * eg 123 Onna Road
-     */
-    public $address_1;
-
-    /**
-     * @var string $address_2
-     * eg PO Box 123
-     */
-    public $address_2;
-
-    /**
-     * @var string $city
-     * eg Inna City
-     */
-    public $city;
-
-    /**
-     * @var int $STA_ID
-     * eg 4
-     */
-    public $STA_ID;
-
-    /**
-     * @var string $CNT_ISO
-     * eg US
-     */
-    public $CNT_ISO;
-
-    /**
-     * @var string $zip
-     * eg 12345  or V1A 2B3
-     */
-    public $zip;
-
-    /**
-     * @var string $email
-     * eg support@eventespresso.com
-     */
-    public $email;
-
-
-    /**
-     * @var string $phone
-     * eg. 111-111-1111
-     */
-    public $phone;
-
-
-    /**
-     * @var string $vat
-     * VAT/Tax Number
-     */
-    public $vat;
-
-    /**
-     * @var string $logo_url
-     * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
-     */
-    public $logo_url;
-
-
-    /**
-     * The below are all various properties for holding links to organization social network profiles
-     *
-     * @var string
-     */
-    /**
-     * facebook (facebook.com/profile.name)
-     *
-     * @var string
-     */
-    public $facebook;
-
-
-    /**
-     * twitter (twitter.com/twitter_handle)
-     *
-     * @var string
-     */
-    public $twitter;
-
-
-    /**
-     * linkedin (linkedin.com/in/profile_name)
-     *
-     * @var string
-     */
-    public $linkedin;
-
-
-    /**
-     * pinterest (www.pinterest.com/profile_name)
-     *
-     * @var string
-     */
-    public $pinterest;
-
-
-    /**
-     * google+ (google.com/+profileName)
-     *
-     * @var string
-     */
-    public $google;
-
-
-    /**
-     * instagram (instagram.com/handle)
-     *
-     * @var string
-     */
-    public $instagram;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default organization settings
-        // decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
-        $this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
-        $this->address_1 = '123 Onna Road';
-        $this->address_2 = 'PO Box 123';
-        $this->city = 'Inna City';
-        $this->STA_ID = 4;
-        $this->CNT_ISO = 'US';
-        $this->zip = '12345';
-        $this->email = get_bloginfo('admin_email');
-        $this->phone = '';
-        $this->vat = '123456789';
-        $this->logo_url = '';
-        $this->facebook = '';
-        $this->twitter = '';
-        $this->linkedin = '';
-        $this->pinterest = '';
-        $this->google = '';
-        $this->instagram = '';
-    }
-}
-
-
-/**
- * Class for defining what's in the EE_Config relating to currency
- */
-class EE_Currency_Config extends EE_Config_Base
-{
-
-    /**
-     * @var string $code
-     * eg 'US'
-     */
-    public $code;
-
-    /**
-     * @var string $name
-     * eg 'Dollar'
-     */
-    public $name;
-
-    /**
-     * plural name
-     *
-     * @var string $plural
-     * eg 'Dollars'
-     */
-    public $plural;
-
-    /**
-     * currency sign
-     *
-     * @var string $sign
-     * eg '$'
-     */
-    public $sign;
-
-    /**
-     * Whether the currency sign should come before the number or not
-     *
-     * @var boolean $sign_b4
-     */
-    public $sign_b4;
-
-    /**
-     * How many digits should come after the decimal place
-     *
-     * @var int $dec_plc
-     */
-    public $dec_plc;
-
-    /**
-     * Symbol to use for decimal mark
-     *
-     * @var string $dec_mrk
-     * eg '.'
-     */
-    public $dec_mrk;
-
-    /**
-     * Symbol to use for thousands
-     *
-     * @var string $thsnds
-     * eg ','
-     */
-    public $thsnds;
+	const OPTION_NAME = 'ee_config';
+
+	const LOG_NAME = 'ee_config_log';
+
+	const LOG_LENGTH = 100;
+
+	const ADDON_OPTION_NAMES = 'ee_config_option_names';
+
+
+	/**
+	 *    instance of the EE_Config object
+	 *
+	 * @var    EE_Config $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @var boolean $_logging_enabled
+	 */
+	private static $_logging_enabled = false;
+
+	/**
+	 * @var LegacyShortcodesManager $legacy_shortcodes_manager
+	 */
+	private $legacy_shortcodes_manager;
+
+	/**
+	 * An StdClass whose property names are addon slugs,
+	 * and values are their config classes
+	 *
+	 * @var StdClass
+	 */
+	public $addons;
+
+	/**
+	 * @var EE_Admin_Config
+	 */
+	public $admin;
+
+	/**
+	 * @var EE_Core_Config
+	 */
+	public $core;
+
+	/**
+	 * @var EE_Currency_Config
+	 */
+	public $currency;
+
+	/**
+	 * @var EE_Organization_Config
+	 */
+	public $organization;
+
+	/**
+	 * @var EE_Registration_Config
+	 */
+	public $registration;
+
+	/**
+	 * @var EE_Template_Config
+	 */
+	public $template_settings;
+
+	/**
+	 * Holds EE environment values.
+	 *
+	 * @var EE_Environment_Config
+	 */
+	public $environment;
+
+	/**
+	 * settings pertaining to Google maps
+	 *
+	 * @var EE_Map_Config
+	 */
+	public $map_settings;
+
+	/**
+	 * settings pertaining to Taxes
+	 *
+	 * @var EE_Tax_Config
+	 */
+	public $tax_settings;
+
+
+	/**
+	 * Settings pertaining to global messages settings.
+	 *
+	 * @var EE_Messages_Config
+	 */
+	public $messages;
+
+	/**
+	 * @deprecated
+	 * @var EE_Gateway_Config
+	 */
+	public $gateway;
+
+	/**
+	 * @var    array $_addon_option_names
+	 * @access    private
+	 */
+	private $_addon_option_names = array();
+
+	/**
+	 * @var    array $_module_route_map
+	 * @access    private
+	 */
+	private static $_module_route_map = array();
+
+	/**
+	 * @var    array $_module_forward_map
+	 * @access    private
+	 */
+	private static $_module_forward_map = array();
+
+	/**
+	 * @var    array $_module_view_map
+	 * @access    private
+	 */
+	private static $_module_view_map = array();
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Config instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Config) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets the config
+	 *
+	 * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
+	 *                               (default) leaves the database alone, and merely resets the EE_Config object to
+	 *                               reflect its state in the database
+	 * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
+	 *                               $_instance as NULL. Useful in case you want to forget about the old instance on
+	 *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
+	 *                               site was put into maintenance mode)
+	 * @return EE_Config
+	 */
+	public static function reset($hard_reset = false, $reinstantiate = true)
+	{
+		if (self::$_instance instanceof EE_Config) {
+			if ($hard_reset) {
+				self::$_instance->legacy_shortcodes_manager = null;
+				self::$_instance->_addon_option_names = array();
+				self::$_instance->_initialize_config();
+				self::$_instance->update_espresso_config();
+			}
+			self::$_instance->update_addon_option_names();
+		}
+		self::$_instance = null;
+		// we don't need to reset the static properties imo because those should
+		// only change when a module is added or removed. Currently we don't
+		// support removing a module during a request when it previously existed
+		if ($reinstantiate) {
+			return self::instance();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    private
+	 */
+	private function __construct()
+	{
+		do_action('AHEE__EE_Config__construct__begin', $this);
+		EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
+		// setup empty config classes
+		$this->_initialize_config();
+		// load existing EE site settings
+		$this->_load_core_config();
+		// confirm everything loaded correctly and set filtered defaults if not
+		$this->_verify_config();
+		//  register shortcodes and modules
+		add_action(
+			'AHEE__EE_System__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_and_modules'),
+			999
+		);
+		//  initialize shortcodes and modules
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
+		// register widgets
+		add_action('widgets_init', array($this, 'widgets_init'), 10);
+		// shutdown
+		add_action('shutdown', array($this, 'shutdown'), 10);
+		// construct__end hook
+		do_action('AHEE__EE_Config__construct__end', $this);
+		// hardcoded hack
+		$this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public static function logging_enabled()
+	{
+		return self::$_logging_enabled;
+	}
+
+
+	/**
+	 * use to get the current theme if needed from static context
+	 *
+	 * @return string current theme set.
+	 */
+	public static function get_current_theme()
+	{
+		return isset(self::$_instance->template_settings->current_espresso_theme)
+			? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
+	}
+
+
+	/**
+	 *        _initialize_config
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _initialize_config()
+	{
+		EE_Config::trim_log();
+		// set defaults
+		$this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
+		$this->addons = new stdClass();
+		// set _module_route_map
+		EE_Config::$_module_route_map = array();
+		// set _module_forward_map
+		EE_Config::$_module_forward_map = array();
+		// set _module_view_map
+		EE_Config::$_module_view_map = array();
+	}
+
+
+	/**
+	 *        load core plugin configuration
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _load_core_config()
+	{
+		// load_core_config__start hook
+		do_action('AHEE__EE_Config___load_core_config__start', $this);
+		$espresso_config = $this->get_espresso_config();
+		foreach ($espresso_config as $config => $settings) {
+			// load_core_config__start hook
+			$settings = apply_filters(
+				'FHEE__EE_Config___load_core_config__config_settings',
+				$settings,
+				$config,
+				$this
+			);
+			if (is_object($settings) && property_exists($this, $config)) {
+				$this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
+				// call configs populate method to ensure any defaults are set for empty values.
+				if (method_exists($settings, 'populate')) {
+					$this->{$config}->populate();
+				}
+				if (method_exists($settings, 'do_hooks')) {
+					$this->{$config}->do_hooks();
+				}
+			}
+		}
+		if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
+			$this->update_espresso_config();
+		}
+		// load_core_config__end hook
+		do_action('AHEE__EE_Config___load_core_config__end', $this);
+	}
+
+
+	/**
+	 *    _verify_config
+	 *
+	 * @access    protected
+	 * @return    void
+	 */
+	protected function _verify_config()
+	{
+		$this->core = $this->core instanceof EE_Core_Config
+			? $this->core
+			: new EE_Core_Config();
+		$this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
+		$this->organization = $this->organization instanceof EE_Organization_Config
+			? $this->organization
+			: new EE_Organization_Config();
+		$this->organization = apply_filters(
+			'FHEE__EE_Config___initialize_config__organization',
+			$this->organization
+		);
+		$this->currency = $this->currency instanceof EE_Currency_Config
+			? $this->currency
+			: new EE_Currency_Config();
+		$this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
+		$this->registration = $this->registration instanceof EE_Registration_Config
+			? $this->registration
+			: new EE_Registration_Config();
+		$this->registration = apply_filters(
+			'FHEE__EE_Config___initialize_config__registration',
+			$this->registration
+		);
+		$this->admin = $this->admin instanceof EE_Admin_Config
+			? $this->admin
+			: new EE_Admin_Config();
+		$this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
+		$this->template_settings = $this->template_settings instanceof EE_Template_Config
+			? $this->template_settings
+			: new EE_Template_Config();
+		$this->template_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__template_settings',
+			$this->template_settings
+		);
+		$this->map_settings = $this->map_settings instanceof EE_Map_Config
+			? $this->map_settings
+			: new EE_Map_Config();
+		$this->map_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__map_settings',
+			$this->map_settings
+		);
+		$this->environment = $this->environment instanceof EE_Environment_Config
+			? $this->environment
+			: new EE_Environment_Config();
+		$this->environment = apply_filters(
+			'FHEE__EE_Config___initialize_config__environment',
+			$this->environment
+		);
+		$this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
+			? $this->tax_settings
+			: new EE_Tax_Config();
+		$this->tax_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__tax_settings',
+			$this->tax_settings
+		);
+		$this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
+		$this->messages = $this->messages instanceof EE_Messages_Config
+			? $this->messages
+			: new EE_Messages_Config();
+		$this->gateway = $this->gateway instanceof EE_Gateway_Config
+			? $this->gateway
+			: new EE_Gateway_Config();
+		$this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
+		$this->legacy_shortcodes_manager = null;
+	}
+
+
+	/**
+	 *    get_espresso_config
+	 *
+	 * @access    public
+	 * @return    array of espresso config stuff
+	 */
+	public function get_espresso_config()
+	{
+		// grab espresso configuration
+		return apply_filters(
+			'FHEE__EE_Config__get_espresso_config__CFG',
+			get_option(EE_Config::OPTION_NAME, array())
+		);
+	}
+
+
+	/**
+	 *    double_check_config_comparison
+	 *
+	 * @access    public
+	 * @param string $option
+	 * @param        $old_value
+	 * @param        $value
+	 */
+	public function double_check_config_comparison($option = '', $old_value, $value)
+	{
+		// make sure we're checking the ee config
+		if ($option === EE_Config::OPTION_NAME) {
+			// run a loose comparison of the old value against the new value for type and properties,
+			// but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
+			if ($value != $old_value) {
+				// if they are NOT the same, then remove the hook,
+				// which means the subsequent update results will be based solely on the update query results
+				// the reason we do this is because, as stated above,
+				// WP update_option performs an exact instance comparison (===) on any update values passed to it
+				// this happens PRIOR to serialization and any subsequent update.
+				// If values are found to match their previous old value,
+				// then WP bails before performing any update.
+				// Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
+				// it just pulled from the db, with the one being passed to it (which will not match).
+				// HOWEVER, once the object is serialized and passed off to MySQL to update,
+				// MySQL MAY ALSO NOT perform the update because
+				// the string it sees in the db looks the same as the new one it has been passed!!!
+				// This results in the query returning an "affected rows" value of ZERO,
+				// which gets returned immediately by WP update_option and looks like an error.
+				remove_action('update_option', array($this, 'check_config_updated'));
+			}
+		}
+	}
+
+
+	/**
+	 *    update_espresso_config
+	 *
+	 * @access   public
+	 */
+	protected function _reset_espresso_addon_config()
+	{
+		$this->_addon_option_names = array();
+		foreach ($this->addons as $addon_name => $addon_config_obj) {
+			$addon_config_obj = maybe_unserialize($addon_config_obj);
+			if ($addon_config_obj instanceof EE_Config_Base) {
+				$this->update_config('addons', $addon_name, $addon_config_obj, false);
+			}
+			$this->addons->{$addon_name} = null;
+		}
+	}
+
+
+	/**
+	 *    update_espresso_config
+	 *
+	 * @access   public
+	 * @param   bool $add_success
+	 * @param   bool $add_error
+	 * @return   bool
+	 */
+	public function update_espresso_config($add_success = false, $add_error = true)
+	{
+		// don't allow config updates during WP heartbeats
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
+			return false;
+		}
+		// commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
+		// $clone = clone( self::$_instance );
+		// self::$_instance = NULL;
+		do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
+		$this->_reset_espresso_addon_config();
+		// hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
+		// but BEFORE the actual update occurs
+		add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
+		// don't want to persist legacy_shortcodes_manager, but don't want to lose it either
+		$legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
+		$this->legacy_shortcodes_manager = null;
+		// now update "ee_config"
+		$saved = update_option(EE_Config::OPTION_NAME, $this);
+		$this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
+		EE_Config::log(EE_Config::OPTION_NAME);
+		// if not saved... check if the hook we just added still exists;
+		// if it does, it means one of two things:
+		// that update_option bailed at the($value === $old_value) conditional,
+		// or...
+		// the db update query returned 0 rows affected
+		// (probably because the data  value was the same from it's perspective)
+		// so the existence of the hook means that a negative result from update_option is NOT an error,
+		// but just means no update occurred, so don't display an error to the user.
+		// BUT... if update_option returns FALSE, AND the hook is missing,
+		// then it means that something truly went wrong
+		$saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
+		// remove our action since we don't want it in the system anymore
+		remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
+		do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
+		// self::$_instance = $clone;
+		// unset( $clone );
+		// if config remains the same or was updated successfully
+		if ($saved) {
+			if ($add_success) {
+				EE_Error::add_success(
+					__('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return true;
+		} else {
+			if ($add_error) {
+				EE_Error::add_error(
+					__('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return false;
+		}
+	}
+
+
+	/**
+	 *    _verify_config_params
+	 *
+	 * @access    private
+	 * @param    string         $section
+	 * @param    string         $name
+	 * @param    string         $config_class
+	 * @param    EE_Config_Base $config_obj
+	 * @param    array          $tests_to_run
+	 * @param    bool           $display_errors
+	 * @return    bool    TRUE on success, FALSE on fail
+	 */
+	private function _verify_config_params(
+		$section = '',
+		$name = '',
+		$config_class = '',
+		$config_obj = null,
+		$tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
+		$display_errors = true
+	) {
+		try {
+			foreach ($tests_to_run as $test) {
+				switch ($test) {
+					// TEST #1 : check that section was set
+					case 1:
+						if (empty($section)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'No configuration section has been provided while attempting to save "%s".',
+											'event_espresso'
+										),
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #2 : check that settings section exists
+					case 2:
+						if (! isset($this->{$section})) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('The "%s" configuration section does not exist.', 'event_espresso'),
+										$section
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #3 : check that section is the proper format
+					case 3:
+						if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
+						) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The "%s" configuration settings have not been formatted correctly.',
+											'event_espresso'
+										),
+										$section
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #4 : check that config section name has been set
+					case 4:
+						if (empty($name)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									__(
+										'No name has been provided for the specific configuration section.',
+										'event_espresso'
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #5 : check that a config class name has been set
+					case 5:
+						if (empty($config_class)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									__(
+										'No class name has been provided for the specific configuration section.',
+										'event_espresso'
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #6 : verify config class is accessible
+					case 6:
+						if (! class_exists($config_class)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
+											'event_espresso'
+										),
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #7 : check that config has even been set
+					case 7:
+						if (! isset($this->{$section}->{$name})) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
+										$section,
+										$name
+									)
+								);
+							}
+							return false;
+						} else {
+							// and make sure it's not serialized
+							$this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
+						}
+						break;
+					// TEST #8 : check that config is the requested type
+					case 8:
+						if (! $this->{$section}->{$name} instanceof $config_class) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
+											'event_espresso'
+										),
+										$section,
+										$name,
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #9 : verify config object
+					case 9:
+						if (! $config_obj instanceof EE_Config_Base) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
+										print_r($config_obj, true)
+									)
+								);
+							}
+							return false;
+						}
+						break;
+				}
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+		// you have successfully run the gauntlet
+		return true;
+	}
+
+
+	/**
+	 *    _generate_config_option_name
+	 *
+	 * @access        protected
+	 * @param        string $section
+	 * @param        string $name
+	 * @return        string
+	 */
+	private function _generate_config_option_name($section = '', $name = '')
+	{
+		return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
+	}
+
+
+	/**
+	 *    _set_config_class
+	 * ensures that a config class is set, either from a passed config class or one generated from the config name
+	 *
+	 * @access    private
+	 * @param    string $config_class
+	 * @param    string $name
+	 * @return    string
+	 */
+	private function _set_config_class($config_class = '', $name = '')
+	{
+		return ! empty($config_class)
+			? $config_class
+			: str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
+	}
+
+
+	/**
+	 *    set_config
+	 *
+	 * @access    protected
+	 * @param    string         $section
+	 * @param    string         $name
+	 * @param    string         $config_class
+	 * @param    EE_Config_Base $config_obj
+	 * @return    EE_Config_Base
+	 */
+	public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
+	{
+		// ensure config class is set to something
+		$config_class = $this->_set_config_class($config_class, $name);
+		// run tests 1-4, 6, and 7 to verify all config params are set and valid
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+			return null;
+		}
+		$config_option_name = $this->_generate_config_option_name($section, $name);
+		// if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
+			$this->_addon_option_names[ $config_option_name ] = $config_class;
+			$this->update_addon_option_names();
+		}
+		// verify the incoming config object but suppress errors
+		if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
+			$config_obj = new $config_class();
+		}
+		if (get_option($config_option_name)) {
+			EE_Config::log($config_option_name);
+			update_option($config_option_name, $config_obj);
+			$this->{$section}->{$name} = $config_obj;
+			return $this->{$section}->{$name};
+		} else {
+			// create a wp-option for this config
+			if (add_option($config_option_name, $config_obj, '', 'no')) {
+				$this->{$section}->{$name} = maybe_unserialize($config_obj);
+				return $this->{$section}->{$name};
+			} else {
+				EE_Error::add_error(
+					sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return null;
+			}
+		}
+	}
+
+
+	/**
+	 *    update_config
+	 * Important: the config object must ALREADY be set, otherwise this will produce an error.
+	 *
+	 * @access    public
+	 * @param    string                $section
+	 * @param    string                $name
+	 * @param    EE_Config_Base|string $config_obj
+	 * @param    bool                  $throw_errors
+	 * @return    bool
+	 */
+	public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
+	{
+		// don't allow config updates during WP heartbeats
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
+			return false;
+		}
+		$config_obj = maybe_unserialize($config_obj);
+		// get class name of the incoming object
+		$config_class = get_class($config_obj);
+		// run tests 1-5 and 9 to verify config
+		if (! $this->_verify_config_params(
+			$section,
+			$name,
+			$config_class,
+			$config_obj,
+			array(1, 2, 3, 4, 7, 9)
+		)
+		) {
+			return false;
+		}
+		$config_option_name = $this->_generate_config_option_name($section, $name);
+		// check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
+			// save new config to db
+			if ($this->set_config($section, $name, $config_class, $config_obj)) {
+				return true;
+			}
+		} else {
+			// first check if the record already exists
+			$existing_config = get_option($config_option_name);
+			$config_obj = serialize($config_obj);
+			// just return if db record is already up to date (NOT type safe comparison)
+			if ($existing_config == $config_obj) {
+				$this->{$section}->{$name} = $config_obj;
+				return true;
+			} elseif (update_option($config_option_name, $config_obj)) {
+				EE_Config::log($config_option_name);
+				// update wp-option for this config class
+				$this->{$section}->{$name} = $config_obj;
+				return true;
+			} elseif ($throw_errors) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
+							'event_espresso'
+						),
+						$config_class,
+						'EE_Config->' . $section . '->' . $name
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    get_config
+	 *
+	 * @access    public
+	 * @param    string $section
+	 * @param    string $name
+	 * @param    string $config_class
+	 * @return    mixed EE_Config_Base | NULL
+	 */
+	public function get_config($section = '', $name = '', $config_class = '')
+	{
+		// ensure config class is set to something
+		$config_class = $this->_set_config_class($config_class, $name);
+		// run tests 1-4, 6 and 7 to verify that all params have been set
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+			return null;
+		}
+		// now test if the requested config object exists, but suppress errors
+		if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
+			// config already exists, so pass it back
+			return $this->{$section}->{$name};
+		}
+		// load config option from db if it exists
+		$config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
+		// verify the newly retrieved config object, but suppress errors
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
+			// config is good, so set it and pass it back
+			$this->{$section}->{$name} = $config_obj;
+			return $this->{$section}->{$name};
+		}
+		// oops! $config_obj is not already set and does not exist in the db, so create a new one
+		$config_obj = $this->set_config($section, $name, $config_class);
+		// verify the newly created config object
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
+			return $this->{$section}->{$name};
+		} else {
+			EE_Error::add_error(
+				sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_config_option
+	 *
+	 * @access    public
+	 * @param    string $config_option_name
+	 * @return    mixed EE_Config_Base | FALSE
+	 */
+	public function get_config_option($config_option_name = '')
+	{
+		// retrieve the wp-option for this config class.
+		$config_option = maybe_unserialize(get_option($config_option_name, array()));
+		if (empty($config_option)) {
+			EE_Config::log($config_option_name . '-NOT-FOUND');
+		}
+		return $config_option;
+	}
+
+
+	/**
+	 * log
+	 *
+	 * @param string $config_option_name
+	 */
+	public static function log($config_option_name = '')
+	{
+		if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
+			$config_log = get_option(EE_Config::LOG_NAME, array());
+			// copy incoming $_REQUEST and sanitize it so we can save it
+			$_request = $_REQUEST;
+			array_walk_recursive($_request, 'sanitize_text_field');
+			$config_log[ (string) microtime(true) ] = array(
+				'config_name' => $config_option_name,
+				'request'     => $_request,
+			);
+			update_option(EE_Config::LOG_NAME, $config_log);
+		}
+	}
+
+
+	/**
+	 * trim_log
+	 * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
+	 */
+	public static function trim_log()
+	{
+		if (! EE_Config::logging_enabled()) {
+			return;
+		}
+		$config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
+		$log_length = count($config_log);
+		if ($log_length > EE_Config::LOG_LENGTH) {
+			ksort($config_log);
+			$config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
+			update_option(EE_Config::LOG_NAME, $config_log);
+		}
+	}
+
+
+	/**
+	 *    get_page_for_posts
+	 *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
+	 *    wp-option "page_for_posts", or "posts" if no page is selected
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public static function get_page_for_posts()
+	{
+		$page_for_posts = get_option('page_for_posts');
+		if (! $page_for_posts) {
+			return 'posts';
+		}
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
+		return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
+	}
+
+
+	/**
+	 *    register_shortcodes_and_modules.
+	 *    At this point, it's too early to tell if we're maintenance mode or not.
+	 *    In fact, this is where we give modules a chance to let core know they exist
+	 *    so they can help trigger maintenance mode if it's needed
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function register_shortcodes_and_modules()
+	{
+		// allow modules to set hooks for the rest of the system
+		EE_Registry::instance()->modules = $this->_register_modules();
+	}
+
+
+	/**
+	 *    initialize_shortcodes_and_modules
+	 *    meaning they can start adding their hooks to get stuff done
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function initialize_shortcodes_and_modules()
+	{
+		// allow modules to set hooks for the rest of the system
+		$this->_initialize_modules();
+	}
+
+
+	/**
+	 *    widgets_init
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function widgets_init()
+	{
+		// only init widgets on admin pages when not in complete maintenance, and
+		// on frontend when not in any maintenance mode
+		if (! EE_Maintenance_Mode::instance()->level()
+			|| (
+				is_admin()
+				&& EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
+			)
+		) {
+			// grab list of installed widgets
+			$widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
+			// filter list of modules to register
+			$widgets_to_register = apply_filters(
+				'FHEE__EE_Config__register_widgets__widgets_to_register',
+				$widgets_to_register
+			);
+			if (! empty($widgets_to_register)) {
+				// cycle thru widget folders
+				foreach ($widgets_to_register as $widget_path) {
+					// add to list of installed widget modules
+					EE_Config::register_ee_widget($widget_path);
+				}
+			}
+			// filter list of installed modules
+			EE_Registry::instance()->widgets = apply_filters(
+				'FHEE__EE_Config__register_widgets__installed_widgets',
+				EE_Registry::instance()->widgets
+			);
+		}
+	}
+
+
+	/**
+	 *    register_ee_widget - makes core aware of this widget
+	 *
+	 * @access    public
+	 * @param    string $widget_path - full path up to and including widget folder
+	 * @return    void
+	 */
+	public static function register_ee_widget($widget_path = null)
+	{
+		do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
+		$widget_ext = '.widget.php';
+		// make all separators match
+		$widget_path = rtrim(str_replace('/\\', DS, $widget_path), DS);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($widget_path, $widget_ext) !== false) {
+			// grab and shortcode file name from directory name and break apart at dots
+			$file_name = explode('.', basename($widget_path));
+			// take first segment from file name pieces and remove class prefix if it exists
+			$widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
+			// sanitize shortcode directory name
+			$widget = sanitize_key($widget);
+			// now we need to rebuild the shortcode path
+			$widget_path = explode(DS, $widget_path);
+			// remove last segment
+			array_pop($widget_path);
+			// glue it back together
+			$widget_path = implode(DS, $widget_path);
+		} else {
+			// grab and sanitize widget directory name
+			$widget = sanitize_key(basename($widget_path));
+		}
+		// create classname from widget directory name
+		$widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
+		// add class prefix
+		$widget_class = 'EEW_' . $widget;
+		// does the widget exist ?
+		if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) {
+			$msg = sprintf(
+				__(
+					'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
+					'event_espresso'
+				),
+				$widget_class,
+				$widget_path . DS . $widget_class . $widget_ext
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		// load the widget class file
+		require_once($widget_path . DS . $widget_class . $widget_ext);
+		// verify that class exists
+		if (! class_exists($widget_class)) {
+			$msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		register_widget($widget_class);
+		// add to array of registered widgets
+		EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
+	}
+
+
+	/**
+	 *        _register_modules
+	 *
+	 * @access private
+	 * @return array
+	 */
+	private function _register_modules()
+	{
+		// grab list of installed modules
+		$modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
+		// filter list of modules to register
+		$modules_to_register = apply_filters(
+			'FHEE__EE_Config__register_modules__modules_to_register',
+			$modules_to_register
+		);
+		if (! empty($modules_to_register)) {
+			// loop through folders
+			foreach ($modules_to_register as $module_path) {
+				/**TEMPORARILY EXCLUDE gateways from modules for time being**/
+				if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
+					&& $module_path !== EE_MODULES . 'gateways'
+				) {
+					// add to list of installed modules
+					EE_Config::register_module($module_path);
+				}
+			}
+		}
+		// filter list of installed modules
+		return apply_filters(
+			'FHEE__EE_Config___register_modules__installed_modules',
+			EE_Registry::instance()->modules
+		);
+	}
+
+
+	/**
+	 *    register_module - makes core aware of this module
+	 *
+	 * @access    public
+	 * @param    string $module_path - full path up to and including module folder
+	 * @return    bool
+	 */
+	public static function register_module($module_path = null)
+	{
+		do_action('AHEE__EE_Config__register_module__begin', $module_path);
+		$module_ext = '.module.php';
+		// make all separators match
+		$module_path = str_replace(array('\\', '/'), DS, $module_path);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($module_path, $module_ext) !== false) {
+			// grab and shortcode file name from directory name and break apart at dots
+			$module_file = explode('.', basename($module_path));
+			// now we need to rebuild the shortcode path
+			$module_path = explode(DS, $module_path);
+			// remove last segment
+			array_pop($module_path);
+			// glue it back together
+			$module_path = implode(DS, $module_path) . DS;
+			// take first segment from file name pieces and sanitize it
+			$module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
+			// ensure class prefix is added
+			$module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
+		} else {
+			// we need to generate the filename based off of the folder name
+			// grab and sanitize module name
+			$module = strtolower(basename($module_path));
+			$module = preg_replace('/[^a-z0-9_\-]/', '', $module);
+			// like trailingslashit()
+			$module_path = rtrim($module_path, DS) . DS;
+			// create classname from module directory name
+			$module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
+			// add class prefix
+			$module_class = 'EED_' . $module;
+		}
+		// does the module exist ?
+		if (! is_readable($module_path . DS . $module_class . $module_ext)) {
+			$msg = sprintf(
+				__(
+					'The requested %s module file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$module
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the module class file
+		require_once($module_path . $module_class . $module_ext);
+		// verify that class exists
+		if (! class_exists($module_class)) {
+			$msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// add to array of registered modules
+		EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
+		do_action(
+			'AHEE__EE_Config__register_module__complete',
+			$module_class,
+			EE_Registry::instance()->modules->{$module_class}
+		);
+		return true;
+	}
+
+
+	/**
+	 *    _initialize_modules
+	 *    allow modules to set hooks for the rest of the system
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _initialize_modules()
+	{
+		// cycle thru shortcode folders
+		foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
+			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
+			// which set hooks ?
+			if (is_admin()) {
+				// fire immediately
+				call_user_func(array($module_class, 'set_hooks_admin'));
+			} else {
+				// delay until other systems are online
+				add_action(
+					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
+					array($module_class, 'set_hooks')
+				);
+			}
+		}
+	}
+
+
+	/**
+	 *    register_route - adds module method routes to route_map
+	 *
+	 * @access    public
+	 * @param    string $route       - "pretty" public alias for module method
+	 * @param    string $module      - module name (classname without EED_ prefix)
+	 * @param    string $method_name - the actual module method to be routed to
+	 * @param    string $key         - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
+		$module = str_replace('EED_', '', $module);
+		$module_class = 'EED_' . $module;
+		if (! isset(EE_Registry::instance()->modules->{$module_class})) {
+			$msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (empty($route)) {
+			$msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (! method_exists('EED_' . $module, $method_name)) {
+			$msg = sprintf(
+				__('A valid class method for the %s route has not been supplied.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_route_map[ $key ][ $route ] = array('EED_' . $module, $method_name);
+		return true;
+	}
+
+
+	/**
+	 *    get_route - get module method route
+	 *
+	 * @access    public
+	 * @param    string $route - "pretty" public alias for module method
+	 * @param    string $key   - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_route($route = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_route__begin', $route);
+		$route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
+		if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
+			return EE_Config::$_module_route_map[ $key ][ $route ];
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_routes - get ALL module method routes
+	 *
+	 * @access    public
+	 * @return    array
+	 */
+	public static function get_routes()
+	{
+		return EE_Config::$_module_route_map;
+	}
+
+
+	/**
+	 *    register_forward - allows modules to forward request to another module for further processing
+	 *
+	 * @access    public
+	 * @param    string       $route   - "pretty" public alias for module method
+	 * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
+	 *                                 class, allows different forwards to be served based on status
+	 * @param    array|string $forward - function name or array( class, method )
+	 * @param    string       $key     - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+			$msg = sprintf(
+				__('The module route %s for this forward has not been registered.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (empty($forward)) {
+			$msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (is_array($forward)) {
+			if (! isset($forward[1])) {
+				$msg = sprintf(
+					__('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
+					$route
+				);
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+				return false;
+			}
+			if (! method_exists($forward[0], $forward[1])) {
+				$msg = sprintf(
+					__('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
+					$forward[1],
+					$route
+				);
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+				return false;
+			}
+		} elseif (! function_exists($forward)) {
+			$msg = sprintf(
+				__('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
+				$forward,
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
+		return true;
+	}
+
+
+	/**
+	 *    get_forward - get forwarding route
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different forwards to be served based on status
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_forward($route = null, $status = 0, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
+		if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
+			return apply_filters(
+				'FHEE__EE_Config__get_forward',
+				EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
+				$route,
+				$status
+			);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    register_forward - allows modules to specify different view templates for different method routes and status
+	 *    results
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different views to be served based on status
+	 * @param    string  $view
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+			$msg = sprintf(
+				__('The module route %s for this view has not been registered.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (! is_readable($view)) {
+			$msg = sprintf(
+				__(
+					'The %s view file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$view
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
+		return true;
+	}
+
+
+	/**
+	 *    get_view - get view for route and status
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different views to be served based on status
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_view($route = null, $status = 0, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_view__begin', $route, $status);
+		if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
+			return apply_filters(
+				'FHEE__EE_Config__get_view',
+				EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
+				$route,
+				$status
+			);
+		}
+		return null;
+	}
+
+
+	public function update_addon_option_names()
+	{
+		update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
+	}
+
+
+	public function shutdown()
+	{
+		$this->update_addon_option_names();
+	}
+
+
+	/**
+	 * @return LegacyShortcodesManager
+	 */
+	public static function getLegacyShortcodesManager()
+	{
+
+		if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
+			EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
+				EE_Registry::instance()
+			);
+		}
+		return EE_Config::instance()->legacy_shortcodes_manager;
+	}
+
+
+	/**
+	 * register_shortcode - makes core aware of this shortcode
+	 *
+	 * @deprecated 4.9.26
+	 * @param    string $shortcode_path - full path up to and including shortcode folder
+	 * @return    bool
+	 */
+	public static function register_shortcode($shortcode_path = null)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
+				'event_espresso'
+			),
+			'4.9.26'
+		);
+		return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
+	}
+}
 
+/**
+ * Base class used for config classes. These classes should generally not have
+ * magic functions in use, except we'll allow them to magically set and get stuff...
+ * basically, they should just be well-defined stdClasses
+ */
+class EE_Config_Base
+{
 
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param string $CNT_ISO
-     * @throws \EE_Error
-     */
-    public function __construct($CNT_ISO = '')
-    {
-        /** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
-        $table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        // get country code from organization settings or use default
-        $ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
-                   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
-            : '';
-        // but override if requested
-        $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
-        // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
-        if (! empty($CNT_ISO)
-            && EE_Maintenance_Mode::instance()->models_can_query()
-            && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
-        ) {
-            // retrieve the country settings from the db, just in case they have been customized
-            $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
-            if ($country instanceof EE_Country) {
-                $this->code = $country->currency_code();    // currency code: USD, CAD, EUR
-                $this->name = $country->currency_name_single();    // Dollar
-                $this->plural = $country->currency_name_plural();    // Dollars
-                $this->sign = $country->currency_sign();            // currency sign: $
-                $this->sign_b4 = $country->currency_sign_before(
-                );        // currency sign before or after: $TRUE  or  FALSE$
-                $this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
-                $this->dec_mrk = $country->currency_decimal_mark(
-                );    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-                $this->thsnds = $country->currency_thousands_separator(
-                );    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
-            }
-        }
-        // fallback to hardcoded defaults, in case the above failed
-        if (empty($this->code)) {
-            // set default currency settings
-            $this->code = 'USD';    // currency code: USD, CAD, EUR
-            $this->name = __('Dollar', 'event_espresso');    // Dollar
-            $this->plural = __('Dollars', 'event_espresso');    // Dollars
-            $this->sign = '$';    // currency sign: $
-            $this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
-            $this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
-            $this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-            $this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
-        }
-    }
+	/**
+	 * Utility function for escaping the value of a property and returning.
+	 *
+	 * @param string $property property name (checks to see if exists).
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($property)
+	{
+		if (! property_exists($this, $property)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
+						'event_espresso'
+					),
+					get_class($this),
+					$property
+				)
+			);
+		}
+		// just handling escaping of strings for now.
+		if (is_string($this->{$property})) {
+			return stripslashes($this->{$property});
+		}
+		return $this->{$property};
+	}
+
+
+	public function populate()
+	{
+		// grab defaults via a new instance of this class.
+		$class_name = get_class($this);
+		$defaults = new $class_name;
+		// loop through the properties for this class and see if they are set.  If they are NOT, then grab the
+		// default from our $defaults object.
+		foreach (get_object_vars($defaults) as $property => $value) {
+			if ($this->{$property} === null) {
+				$this->{$property} = $value;
+			}
+		}
+		// cleanup
+		unset($defaults);
+	}
+
+
+	/**
+	 *        __isset
+	 *
+	 * @param $a
+	 * @return bool
+	 */
+	public function __isset($a)
+	{
+		return false;
+	}
+
+
+	/**
+	 *        __unset
+	 *
+	 * @param $a
+	 * @return bool
+	 */
+	public function __unset($a)
+	{
+		return false;
+	}
+
+
+	/**
+	 *        __clone
+	 */
+	public function __clone()
+	{
+	}
+
+
+	/**
+	 *        __wakeup
+	 */
+	public function __wakeup()
+	{
+	}
+
+
+	/**
+	 *        __destruct
+	 */
+	public function __destruct()
+	{
+	}
 }
 
 
 /**
  * Class for defining what's in the EE_Config relating to registration settings
  */
-class EE_Registration_Config extends EE_Config_Base
+class EE_Core_Config extends EE_Config_Base
 {
 
-    /**
-     * Default registration status
-     *
-     * @var string $default_STS_ID
-     * eg 'RPP'
-     */
-    public $default_STS_ID;
-
-
-    /**
-     * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
-     * registrations)
-     *
-     * @var int
-     */
-    public $default_maximum_number_of_tickets;
-
-
-    /**
-     * level of validation to apply to email addresses
-     *
-     * @var string $email_validation_level
-     * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
-     */
-    public $email_validation_level;
-
-    /**
-     *    whether or not to show alternate payment options during the reg process if payment status is pending
-     *
-     * @var boolean $show_pending_payment_options
-     */
-    public $show_pending_payment_options;
-
-    /**
-     * Whether to skip the registration confirmation page
-     *
-     * @var boolean $skip_reg_confirmation
-     */
-    public $skip_reg_confirmation;
-
-    /**
-     * an array of SPCO reg steps where:
-     *        the keys denotes the reg step order
-     *        each element consists of an array with the following elements:
-     *            "file_path" => the file path to the EE_SPCO_Reg_Step class
-     *            "class_name" => the specific EE_SPCO_Reg_Step child class name
-     *            "slug" => the URL param used to trigger the reg step
-     *
-     * @var array $reg_steps
-     */
-    public $reg_steps;
-
-    /**
-     * Whether registration confirmation should be the last page of SPCO
-     *
-     * @var boolean $reg_confirmation_last
-     */
-    public $reg_confirmation_last;
-
-    /**
-     * Whether or not to enable the EE Bot Trap
-     *
-     * @var boolean $use_bot_trap
-     */
-    public $use_bot_trap;
-
-    /**
-     * Whether or not to encrypt some data sent by the EE Bot Trap
-     *
-     * @var boolean $use_encryption
-     */
-    public $use_encryption;
-
-    /**
-     * Whether or not to use ReCaptcha
-     *
-     * @var boolean $use_captcha
-     */
-    public $use_captcha;
-
-    /**
-     * ReCaptcha Theme
-     *
-     * @var string $recaptcha_theme
-     *    options: 'dark', 'light', 'invisible'
-     */
-    public $recaptcha_theme;
-
-    /**
-     * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
-     *
-     * @var string $recaptcha_badge
-     *    options: 'bottomright', 'bottomleft', 'inline'
-     */
-    public $recaptcha_badge;
-
-    /**
-     * ReCaptcha Type
-     *
-     * @var string $recaptcha_type
-     *    options: 'audio', 'image'
-     */
-    public $recaptcha_type;
-
-    /**
-     * ReCaptcha language
-     *
-     * @var string $recaptcha_language
-     * eg 'en'
-     */
-    public $recaptcha_language;
-
-    /**
-     * ReCaptcha public key
-     *
-     * @var string $recaptcha_publickey
-     */
-    public $recaptcha_publickey;
-
-    /**
-     * ReCaptcha private key
-     *
-     * @var string $recaptcha_privatekey
-     */
-    public $recaptcha_privatekey;
-
-    /**
-     * array of form names protected by ReCaptcha
-     *
-     * @var array $recaptcha_protected_forms
-     */
-    public $recaptcha_protected_forms;
-
-    /**
-     * ReCaptcha width
-     *
-     * @var int $recaptcha_width
-     * @deprecated
-     */
-    public $recaptcha_width;
-
-    /**
-     * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
-     *
-     * @var boolean $track_invalid_checkout_access
-     */
-    protected $track_invalid_checkout_access = true;
-
-    /**
-     * String describing how long to keep payment logs. Passed into DateTime constructor
-     * @var string
-     */
-    public $gateway_log_lifespan = '1 week';
-
+	public $current_blog_id;
+
+	public $ee_ueip_optin;
+
+	public $ee_ueip_has_notified;
+
+	/**
+	 * Not to be confused with the 4 critical page variables (See
+	 * get_critical_pages_array()), this is just an array of wp posts that have EE
+	 * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
+	 * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
+	 *
+	 * @var array
+	 */
+	public $post_shortcodes;
+
+	public $module_route_map;
+
+	public $module_forward_map;
+
+	public $module_view_map;
+
+	/**
+	 * The next 4 vars are the IDs of critical EE pages.
+	 *
+	 * @var int
+	 */
+	public $reg_page_id;
+
+	public $txn_page_id;
+
+	public $thank_you_page_id;
+
+	public $cancel_page_id;
+
+	/**
+	 * The next 4 vars are the URLs of critical EE pages.
+	 *
+	 * @var int
+	 */
+	public $reg_page_url;
+
+	public $txn_page_url;
+
+	public $thank_you_page_url;
+
+	public $cancel_page_url;
+
+	/**
+	 * The next vars relate to the custom slugs for EE CPT routes
+	 */
+	public $event_cpt_slug;
+
+
+	/**
+	 * This caches the _ee_ueip_option in case this config is reset in the same
+	 * request across blog switches in a multisite context.
+	 * Avoids extra queries to the db for this option.
+	 *
+	 * @var bool
+	 */
+	public static $ee_ueip_option;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default organization settings
+		$this->current_blog_id = get_current_blog_id();
+		$this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
+		$this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
+		$this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
+		$this->post_shortcodes = array();
+		$this->module_route_map = array();
+		$this->module_forward_map = array();
+		$this->module_view_map = array();
+		// critical EE page IDs
+		$this->reg_page_id = 0;
+		$this->txn_page_id = 0;
+		$this->thank_you_page_id = 0;
+		$this->cancel_page_id = 0;
+		// critical EE page URLs
+		$this->reg_page_url = '';
+		$this->txn_page_url = '';
+		$this->thank_you_page_url = '';
+		$this->cancel_page_url = '';
+		// cpt slugs
+		$this->event_cpt_slug = __('events', 'event_espresso');
+		// ueip constant check
+		if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
+			$this->ee_ueip_optin = false;
+			$this->ee_ueip_has_notified = true;
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_critical_pages_array()
+	{
+		return array(
+			$this->reg_page_id,
+			$this->txn_page_id,
+			$this->thank_you_page_id,
+			$this->cancel_page_id,
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_critical_pages_shortcodes_array()
+	{
+		return array(
+			$this->reg_page_id       => 'ESPRESSO_CHECKOUT',
+			$this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
+			$this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
+			$this->cancel_page_id    => 'ESPRESSO_CANCELLED',
+		);
+	}
+
+
+	/**
+	 *  gets/returns URL for EE reg_page
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function reg_page_url()
+	{
+		if (! $this->reg_page_url) {
+			$this->reg_page_url = add_query_arg(
+				array('uts' => time()),
+				get_permalink($this->reg_page_id)
+			) . '#checkout';
+		}
+		return $this->reg_page_url;
+	}
+
+
+	/**
+	 *  gets/returns URL for EE txn_page
+	 *
+	 * @param array $query_args like what gets passed to
+	 *                          add_query_arg() as the first argument
+	 * @access    public
+	 * @return    string
+	 */
+	public function txn_page_url($query_args = array())
+	{
+		if (! $this->txn_page_url) {
+			$this->txn_page_url = get_permalink($this->txn_page_id);
+		}
+		if ($query_args) {
+			return add_query_arg($query_args, $this->txn_page_url);
+		} else {
+			return $this->txn_page_url;
+		}
+	}
+
+
+	/**
+	 *  gets/returns URL for EE thank_you_page
+	 *
+	 * @param array $query_args like what gets passed to
+	 *                          add_query_arg() as the first argument
+	 * @access    public
+	 * @return    string
+	 */
+	public function thank_you_page_url($query_args = array())
+	{
+		if (! $this->thank_you_page_url) {
+			$this->thank_you_page_url = get_permalink($this->thank_you_page_id);
+		}
+		if ($query_args) {
+			return add_query_arg($query_args, $this->thank_you_page_url);
+		} else {
+			return $this->thank_you_page_url;
+		}
+	}
+
+
+	/**
+	 *  gets/returns URL for EE cancel_page
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function cancel_page_url()
+	{
+		if (! $this->cancel_page_url) {
+			$this->cancel_page_url = get_permalink($this->cancel_page_id);
+		}
+		return $this->cancel_page_url;
+	}
+
+
+	/**
+	 * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
+	 *
+	 * @since 4.7.5
+	 */
+	protected function _reset_urls()
+	{
+		$this->reg_page_url = '';
+		$this->txn_page_url = '';
+		$this->cancel_page_url = '';
+		$this->thank_you_page_url = '';
+	}
+
+
+	/**
+	 * Used to return what the optin value is set for the EE User Experience Program.
+	 * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
+	 * on the main site only.
+	 *
+	 * @return mixed|void
+	 */
+	protected function _get_main_ee_ueip_optin()
+	{
+		// if this is the main site then we can just bypass our direct query.
+		if (is_main_site()) {
+			return get_option('ee_ueip_optin', false);
+		}
+		// is this already cached for this request?  If so use it.
+		if (! empty(EE_Core_Config::$ee_ueip_option)) {
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		global $wpdb;
+		$current_network_main_site = is_multisite() ? get_current_site() : null;
+		$current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
+		$option = 'ee_ueip_optin';
+		// set correct table for query
+		$table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
+		// rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
+		// get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
+		// re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
+		// this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
+		// for the purpose of caching.
+		$pre = apply_filters('pre_option_' . $option, false, $option);
+		if (false !== $pre) {
+			EE_Core_Config::$ee_ueip_option = $pre;
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		$row = $wpdb->get_row(
+			$wpdb->prepare(
+				"SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
+				$option
+			)
+		);
+		if (is_object($row)) {
+			$value = $row->option_value;
+		} else { // option does not exist so use default.
+			return apply_filters('default_option_' . $option, false, $option);
+		}
+		EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
+		return EE_Core_Config::$ee_ueip_option;
+	}
+
+	/**
+	 * Utility function for escaping the value of a property and returning.
+	 *
+	 * @param string $property property name (checks to see if exists).
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($property)
+	{
+		if ($property === 'ee_ueip_optin') {
+			return $this->ee_ueip_optin ? 'yes' : 'no';
+		}
+		return parent::get_pretty($property);
+	}
+
+
+	/**
+	 * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
+	 * on the object.
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// reset all url properties
+		$this->_reset_urls();
+		// return what to save to db
+		return array_keys(get_object_vars($this));
+	}
+}
 
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default registration settings
-        $this->default_STS_ID = EEM_Registration::status_id_pending_payment;
-        $this->email_validation_level = 'wp_default';
-        $this->show_pending_payment_options = true;
-        $this->skip_reg_confirmation = true;
-        $this->reg_steps = array();
-        $this->reg_confirmation_last = false;
-        $this->use_bot_trap = true;
-        $this->use_encryption = true;
-        $this->use_captcha = false;
-        $this->recaptcha_theme = 'light';
-        $this->recaptcha_badge = 'bottomleft';
-        $this->recaptcha_type = 'image';
-        $this->recaptcha_language = 'en';
-        $this->recaptcha_publickey = null;
-        $this->recaptcha_privatekey = null;
-        $this->recaptcha_protected_forms = array();
-        $this->recaptcha_width = 500;
-        $this->default_maximum_number_of_tickets = 10;
-        $this->gateway_log_lifespan = '7 days';
-    }
-
-
-    /**
-     * This is called by the config loader and hooks are initialized AFTER the config has been populated.
-     *
-     * @since 4.8.8.rc.019
-     */
-    public function do_hooks()
-    {
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
-    }
 
+/**
+ * Config class for storing info on the Organization
+ */
+class EE_Organization_Config extends EE_Config_Base
+{
 
-    /**
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
-     * EVT_default_registration_status field matches the config setting for default_STS_ID.
-     */
-    public function set_default_reg_status_on_EEM_Event()
-    {
-        EEM_Event::set_default_reg_status($this->default_STS_ID);
-    }
+	/**
+	 * @var string $name
+	 * eg EE4.1
+	 */
+	public $name;
+
+	/**
+	 * @var string $address_1
+	 * eg 123 Onna Road
+	 */
+	public $address_1;
+
+	/**
+	 * @var string $address_2
+	 * eg PO Box 123
+	 */
+	public $address_2;
+
+	/**
+	 * @var string $city
+	 * eg Inna City
+	 */
+	public $city;
+
+	/**
+	 * @var int $STA_ID
+	 * eg 4
+	 */
+	public $STA_ID;
+
+	/**
+	 * @var string $CNT_ISO
+	 * eg US
+	 */
+	public $CNT_ISO;
+
+	/**
+	 * @var string $zip
+	 * eg 12345  or V1A 2B3
+	 */
+	public $zip;
+
+	/**
+	 * @var string $email
+	 * eg support@eventespresso.com
+	 */
+	public $email;
+
+
+	/**
+	 * @var string $phone
+	 * eg. 111-111-1111
+	 */
+	public $phone;
+
+
+	/**
+	 * @var string $vat
+	 * VAT/Tax Number
+	 */
+	public $vat;
+
+	/**
+	 * @var string $logo_url
+	 * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
+	 */
+	public $logo_url;
+
+
+	/**
+	 * The below are all various properties for holding links to organization social network profiles
+	 *
+	 * @var string
+	 */
+	/**
+	 * facebook (facebook.com/profile.name)
+	 *
+	 * @var string
+	 */
+	public $facebook;
+
+
+	/**
+	 * twitter (twitter.com/twitter_handle)
+	 *
+	 * @var string
+	 */
+	public $twitter;
+
+
+	/**
+	 * linkedin (linkedin.com/in/profile_name)
+	 *
+	 * @var string
+	 */
+	public $linkedin;
+
+
+	/**
+	 * pinterest (www.pinterest.com/profile_name)
+	 *
+	 * @var string
+	 */
+	public $pinterest;
+
+
+	/**
+	 * google+ (google.com/+profileName)
+	 *
+	 * @var string
+	 */
+	public $google;
+
+
+	/**
+	 * instagram (instagram.com/handle)
+	 *
+	 * @var string
+	 */
+	public $instagram;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default organization settings
+		// decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
+		$this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
+		$this->address_1 = '123 Onna Road';
+		$this->address_2 = 'PO Box 123';
+		$this->city = 'Inna City';
+		$this->STA_ID = 4;
+		$this->CNT_ISO = 'US';
+		$this->zip = '12345';
+		$this->email = get_bloginfo('admin_email');
+		$this->phone = '';
+		$this->vat = '123456789';
+		$this->logo_url = '';
+		$this->facebook = '';
+		$this->twitter = '';
+		$this->linkedin = '';
+		$this->pinterest = '';
+		$this->google = '';
+		$this->instagram = '';
+	}
+}
 
 
-    /**
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
-     * for Events matches the config setting for default_maximum_number_of_tickets
-     */
-    public function set_default_max_ticket_on_EEM_Event()
-    {
-        EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
-    }
+/**
+ * Class for defining what's in the EE_Config relating to currency
+ */
+class EE_Currency_Config extends EE_Config_Base
+{
 
+	/**
+	 * @var string $code
+	 * eg 'US'
+	 */
+	public $code;
+
+	/**
+	 * @var string $name
+	 * eg 'Dollar'
+	 */
+	public $name;
+
+	/**
+	 * plural name
+	 *
+	 * @var string $plural
+	 * eg 'Dollars'
+	 */
+	public $plural;
+
+	/**
+	 * currency sign
+	 *
+	 * @var string $sign
+	 * eg '$'
+	 */
+	public $sign;
+
+	/**
+	 * Whether the currency sign should come before the number or not
+	 *
+	 * @var boolean $sign_b4
+	 */
+	public $sign_b4;
+
+	/**
+	 * How many digits should come after the decimal place
+	 *
+	 * @var int $dec_plc
+	 */
+	public $dec_plc;
+
+	/**
+	 * Symbol to use for decimal mark
+	 *
+	 * @var string $dec_mrk
+	 * eg '.'
+	 */
+	public $dec_mrk;
+
+	/**
+	 * Symbol to use for thousands
+	 *
+	 * @var string $thsnds
+	 * eg ','
+	 */
+	public $thsnds;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param string $CNT_ISO
+	 * @throws \EE_Error
+	 */
+	public function __construct($CNT_ISO = '')
+	{
+		/** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
+		$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		// get country code from organization settings or use default
+		$ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
+				   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
+			: '';
+		// but override if requested
+		$CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
+		// so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
+		if (! empty($CNT_ISO)
+			&& EE_Maintenance_Mode::instance()->models_can_query()
+			&& $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
+		) {
+			// retrieve the country settings from the db, just in case they have been customized
+			$country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
+			if ($country instanceof EE_Country) {
+				$this->code = $country->currency_code();    // currency code: USD, CAD, EUR
+				$this->name = $country->currency_name_single();    // Dollar
+				$this->plural = $country->currency_name_plural();    // Dollars
+				$this->sign = $country->currency_sign();            // currency sign: $
+				$this->sign_b4 = $country->currency_sign_before(
+				);        // currency sign before or after: $TRUE  or  FALSE$
+				$this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
+				$this->dec_mrk = $country->currency_decimal_mark(
+				);    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+				$this->thsnds = $country->currency_thousands_separator(
+				);    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+			}
+		}
+		// fallback to hardcoded defaults, in case the above failed
+		if (empty($this->code)) {
+			// set default currency settings
+			$this->code = 'USD';    // currency code: USD, CAD, EUR
+			$this->name = __('Dollar', 'event_espresso');    // Dollar
+			$this->plural = __('Dollars', 'event_espresso');    // Dollars
+			$this->sign = '$';    // currency sign: $
+			$this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
+			$this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
+			$this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+			$this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+		}
+	}
+}
 
-    /**
-     * @return boolean
-     */
-    public function track_invalid_checkout_access()
-    {
-        return $this->track_invalid_checkout_access;
-    }
 
+/**
+ * Class for defining what's in the EE_Config relating to registration settings
+ */
+class EE_Registration_Config extends EE_Config_Base
+{
 
-    /**
-     * @param boolean $track_invalid_checkout_access
-     */
-    public function set_track_invalid_checkout_access($track_invalid_checkout_access)
-    {
-        $this->track_invalid_checkout_access = filter_var(
-            $track_invalid_checkout_access,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * Gets the options to make availalbe for the gateway log lifespan
-     * @return array
-     */
-    public function gatewayLogLifespanOptions()
-    {
-        return (array) apply_filters(
-            'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
-            array(
-                '1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
-                '1 day' => esc_html__('1 Day', 'event_espresso'),
-                '7 days' => esc_html__('7 Days', 'event_espresso'),
-                '14 days' => esc_html__('14 Days', 'event_espresso'),
-                '30 days' => esc_html__('30 Days', 'event_espresso')
-            )
-        );
-    }
+	/**
+	 * Default registration status
+	 *
+	 * @var string $default_STS_ID
+	 * eg 'RPP'
+	 */
+	public $default_STS_ID;
+
+
+	/**
+	 * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
+	 * registrations)
+	 *
+	 * @var int
+	 */
+	public $default_maximum_number_of_tickets;
+
+
+	/**
+	 * level of validation to apply to email addresses
+	 *
+	 * @var string $email_validation_level
+	 * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
+	 */
+	public $email_validation_level;
+
+	/**
+	 *    whether or not to show alternate payment options during the reg process if payment status is pending
+	 *
+	 * @var boolean $show_pending_payment_options
+	 */
+	public $show_pending_payment_options;
+
+	/**
+	 * Whether to skip the registration confirmation page
+	 *
+	 * @var boolean $skip_reg_confirmation
+	 */
+	public $skip_reg_confirmation;
+
+	/**
+	 * an array of SPCO reg steps where:
+	 *        the keys denotes the reg step order
+	 *        each element consists of an array with the following elements:
+	 *            "file_path" => the file path to the EE_SPCO_Reg_Step class
+	 *            "class_name" => the specific EE_SPCO_Reg_Step child class name
+	 *            "slug" => the URL param used to trigger the reg step
+	 *
+	 * @var array $reg_steps
+	 */
+	public $reg_steps;
+
+	/**
+	 * Whether registration confirmation should be the last page of SPCO
+	 *
+	 * @var boolean $reg_confirmation_last
+	 */
+	public $reg_confirmation_last;
+
+	/**
+	 * Whether or not to enable the EE Bot Trap
+	 *
+	 * @var boolean $use_bot_trap
+	 */
+	public $use_bot_trap;
+
+	/**
+	 * Whether or not to encrypt some data sent by the EE Bot Trap
+	 *
+	 * @var boolean $use_encryption
+	 */
+	public $use_encryption;
+
+	/**
+	 * Whether or not to use ReCaptcha
+	 *
+	 * @var boolean $use_captcha
+	 */
+	public $use_captcha;
+
+	/**
+	 * ReCaptcha Theme
+	 *
+	 * @var string $recaptcha_theme
+	 *    options: 'dark', 'light', 'invisible'
+	 */
+	public $recaptcha_theme;
+
+	/**
+	 * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
+	 *
+	 * @var string $recaptcha_badge
+	 *    options: 'bottomright', 'bottomleft', 'inline'
+	 */
+	public $recaptcha_badge;
+
+	/**
+	 * ReCaptcha Type
+	 *
+	 * @var string $recaptcha_type
+	 *    options: 'audio', 'image'
+	 */
+	public $recaptcha_type;
+
+	/**
+	 * ReCaptcha language
+	 *
+	 * @var string $recaptcha_language
+	 * eg 'en'
+	 */
+	public $recaptcha_language;
+
+	/**
+	 * ReCaptcha public key
+	 *
+	 * @var string $recaptcha_publickey
+	 */
+	public $recaptcha_publickey;
+
+	/**
+	 * ReCaptcha private key
+	 *
+	 * @var string $recaptcha_privatekey
+	 */
+	public $recaptcha_privatekey;
+
+	/**
+	 * array of form names protected by ReCaptcha
+	 *
+	 * @var array $recaptcha_protected_forms
+	 */
+	public $recaptcha_protected_forms;
+
+	/**
+	 * ReCaptcha width
+	 *
+	 * @var int $recaptcha_width
+	 * @deprecated
+	 */
+	public $recaptcha_width;
+
+	/**
+	 * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
+	 *
+	 * @var boolean $track_invalid_checkout_access
+	 */
+	protected $track_invalid_checkout_access = true;
+
+	/**
+	 * String describing how long to keep payment logs. Passed into DateTime constructor
+	 * @var string
+	 */
+	public $gateway_log_lifespan = '1 week';
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default registration settings
+		$this->default_STS_ID = EEM_Registration::status_id_pending_payment;
+		$this->email_validation_level = 'wp_default';
+		$this->show_pending_payment_options = true;
+		$this->skip_reg_confirmation = true;
+		$this->reg_steps = array();
+		$this->reg_confirmation_last = false;
+		$this->use_bot_trap = true;
+		$this->use_encryption = true;
+		$this->use_captcha = false;
+		$this->recaptcha_theme = 'light';
+		$this->recaptcha_badge = 'bottomleft';
+		$this->recaptcha_type = 'image';
+		$this->recaptcha_language = 'en';
+		$this->recaptcha_publickey = null;
+		$this->recaptcha_privatekey = null;
+		$this->recaptcha_protected_forms = array();
+		$this->recaptcha_width = 500;
+		$this->default_maximum_number_of_tickets = 10;
+		$this->gateway_log_lifespan = '7 days';
+	}
+
+
+	/**
+	 * This is called by the config loader and hooks are initialized AFTER the config has been populated.
+	 *
+	 * @since 4.8.8.rc.019
+	 */
+	public function do_hooks()
+	{
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
+	}
+
+
+	/**
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
+	 * EVT_default_registration_status field matches the config setting for default_STS_ID.
+	 */
+	public function set_default_reg_status_on_EEM_Event()
+	{
+		EEM_Event::set_default_reg_status($this->default_STS_ID);
+	}
+
+
+	/**
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
+	 * for Events matches the config setting for default_maximum_number_of_tickets
+	 */
+	public function set_default_max_ticket_on_EEM_Event()
+	{
+		EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function track_invalid_checkout_access()
+	{
+		return $this->track_invalid_checkout_access;
+	}
+
+
+	/**
+	 * @param boolean $track_invalid_checkout_access
+	 */
+	public function set_track_invalid_checkout_access($track_invalid_checkout_access)
+	{
+		$this->track_invalid_checkout_access = filter_var(
+			$track_invalid_checkout_access,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * Gets the options to make availalbe for the gateway log lifespan
+	 * @return array
+	 */
+	public function gatewayLogLifespanOptions()
+	{
+		return (array) apply_filters(
+			'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
+			array(
+				'1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
+				'1 day' => esc_html__('1 Day', 'event_espresso'),
+				'7 days' => esc_html__('7 Days', 'event_espresso'),
+				'14 days' => esc_html__('14 Days', 'event_espresso'),
+				'30 days' => esc_html__('30 Days', 'event_espresso')
+			)
+		);
+	}
 }
 
 
@@ -2454,154 +2454,154 @@ 
 class EE_Admin_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $use_personnel_manager
-     */
-    public $use_personnel_manager;
-
-    /**
-     * @var boolean $use_dashboard_widget
-     */
-    public $use_dashboard_widget;
-
-    /**
-     * @var int $events_in_dashboard
-     */
-    public $events_in_dashboard;
-
-    /**
-     * @var boolean $use_event_timezones
-     */
-    public $use_event_timezones;
-
-    /**
-     * @var boolean $use_full_logging
-     */
-    public $use_full_logging;
-
-    /**
-     * @var string $log_file_name
-     */
-    public $log_file_name;
-
-    /**
-     * @var string $debug_file_name
-     */
-    public $debug_file_name;
-
-    /**
-     * @var boolean $use_remote_logging
-     */
-    public $use_remote_logging;
-
-    /**
-     * @var string $remote_logging_url
-     */
-    public $remote_logging_url;
-
-    /**
-     * @var boolean $show_reg_footer
-     */
-    public $show_reg_footer;
-
-    /**
-     * @var string $affiliate_id
-     */
-    public $affiliate_id;
-
-    /**
-     * help tours on or off (global setting)
-     *
-     * @var boolean
-     */
-    public $help_tour_activation;
-
-    /**
-     * adds extra layer of encoding to session data to prevent serialization errors
-     * but is incompatible with some server configuration errors
-     * if you get "500 internal server errors" during registration, try turning this on
-     * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
-     *
-     * @var boolean $encode_session_data
-     */
-    private $encode_session_data = false;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default general admin settings
-        $this->use_personnel_manager = true;
-        $this->use_dashboard_widget = true;
-        $this->events_in_dashboard = 30;
-        $this->use_event_timezones = false;
-        $this->use_full_logging = false;
-        $this->use_remote_logging = false;
-        $this->remote_logging_url = null;
-        $this->show_reg_footer = true;
-        $this->affiliate_id = 'default';
-        $this->help_tour_activation = true;
-        $this->encode_session_data = false;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     */
-    public function log_file_name($reset = false)
-    {
-        if (empty($this->log_file_name) || $reset) {
-            $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
-            EE_Config::instance()->update_espresso_config(false, false);
-        }
-        return $this->log_file_name;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     */
-    public function debug_file_name($reset = false)
-    {
-        if (empty($this->debug_file_name) || $reset) {
-            $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
-            EE_Config::instance()->update_espresso_config(false, false);
-        }
-        return $this->debug_file_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function affiliate_id()
-    {
-        return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function encode_session_data()
-    {
-        return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param boolean $encode_session_data
-     */
-    public function set_encode_session_data($encode_session_data)
-    {
-        $this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @var boolean $use_personnel_manager
+	 */
+	public $use_personnel_manager;
+
+	/**
+	 * @var boolean $use_dashboard_widget
+	 */
+	public $use_dashboard_widget;
+
+	/**
+	 * @var int $events_in_dashboard
+	 */
+	public $events_in_dashboard;
+
+	/**
+	 * @var boolean $use_event_timezones
+	 */
+	public $use_event_timezones;
+
+	/**
+	 * @var boolean $use_full_logging
+	 */
+	public $use_full_logging;
+
+	/**
+	 * @var string $log_file_name
+	 */
+	public $log_file_name;
+
+	/**
+	 * @var string $debug_file_name
+	 */
+	public $debug_file_name;
+
+	/**
+	 * @var boolean $use_remote_logging
+	 */
+	public $use_remote_logging;
+
+	/**
+	 * @var string $remote_logging_url
+	 */
+	public $remote_logging_url;
+
+	/**
+	 * @var boolean $show_reg_footer
+	 */
+	public $show_reg_footer;
+
+	/**
+	 * @var string $affiliate_id
+	 */
+	public $affiliate_id;
+
+	/**
+	 * help tours on or off (global setting)
+	 *
+	 * @var boolean
+	 */
+	public $help_tour_activation;
+
+	/**
+	 * adds extra layer of encoding to session data to prevent serialization errors
+	 * but is incompatible with some server configuration errors
+	 * if you get "500 internal server errors" during registration, try turning this on
+	 * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
+	 *
+	 * @var boolean $encode_session_data
+	 */
+	private $encode_session_data = false;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default general admin settings
+		$this->use_personnel_manager = true;
+		$this->use_dashboard_widget = true;
+		$this->events_in_dashboard = 30;
+		$this->use_event_timezones = false;
+		$this->use_full_logging = false;
+		$this->use_remote_logging = false;
+		$this->remote_logging_url = null;
+		$this->show_reg_footer = true;
+		$this->affiliate_id = 'default';
+		$this->help_tour_activation = true;
+		$this->encode_session_data = false;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 */
+	public function log_file_name($reset = false)
+	{
+		if (empty($this->log_file_name) || $reset) {
+			$this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
+		}
+		return $this->log_file_name;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 */
+	public function debug_file_name($reset = false)
+	{
+		if (empty($this->debug_file_name) || $reset) {
+			$this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
+		}
+		return $this->debug_file_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function affiliate_id()
+	{
+		return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function encode_session_data()
+	{
+		return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param boolean $encode_session_data
+	 */
+	public function set_encode_session_data($encode_session_data)
+	{
+		$this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
+	}
 }
 
 
@@ -2611,70 +2611,70 @@ 
 class EE_Template_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $enable_default_style
-     */
-    public $enable_default_style;
-
-    /**
-     * @var string $custom_style_sheet
-     */
-    public $custom_style_sheet;
-
-    /**
-     * @var boolean $display_address_in_regform
-     */
-    public $display_address_in_regform;
-
-    /**
-     * @var int $display_description_on_multi_reg_page
-     */
-    public $display_description_on_multi_reg_page;
-
-    /**
-     * @var boolean $use_custom_templates
-     */
-    public $use_custom_templates;
-
-    /**
-     * @var string $current_espresso_theme
-     */
-    public $current_espresso_theme;
-
-    /**
-     * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
-     */
-    public $EED_Ticket_Selector;
-
-    /**
-     * @var EE_Event_Single_Config $EED_Event_Single
-     */
-    public $EED_Event_Single;
-
-    /**
-     * @var EE_Events_Archive_Config $EED_Events_Archive
-     */
-    public $EED_Events_Archive;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default template settings
-        $this->enable_default_style = true;
-        $this->custom_style_sheet = null;
-        $this->display_address_in_regform = true;
-        $this->display_description_on_multi_reg_page = false;
-        $this->use_custom_templates = false;
-        $this->current_espresso_theme = 'Espresso_Arabica_2014';
-        $this->EED_Event_Single = null;
-        $this->EED_Events_Archive = null;
-        $this->EED_Ticket_Selector = null;
-    }
+	/**
+	 * @var boolean $enable_default_style
+	 */
+	public $enable_default_style;
+
+	/**
+	 * @var string $custom_style_sheet
+	 */
+	public $custom_style_sheet;
+
+	/**
+	 * @var boolean $display_address_in_regform
+	 */
+	public $display_address_in_regform;
+
+	/**
+	 * @var int $display_description_on_multi_reg_page
+	 */
+	public $display_description_on_multi_reg_page;
+
+	/**
+	 * @var boolean $use_custom_templates
+	 */
+	public $use_custom_templates;
+
+	/**
+	 * @var string $current_espresso_theme
+	 */
+	public $current_espresso_theme;
+
+	/**
+	 * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
+	 */
+	public $EED_Ticket_Selector;
+
+	/**
+	 * @var EE_Event_Single_Config $EED_Event_Single
+	 */
+	public $EED_Event_Single;
+
+	/**
+	 * @var EE_Events_Archive_Config $EED_Events_Archive
+	 */
+	public $EED_Events_Archive;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default template settings
+		$this->enable_default_style = true;
+		$this->custom_style_sheet = null;
+		$this->display_address_in_regform = true;
+		$this->display_description_on_multi_reg_page = false;
+		$this->use_custom_templates = false;
+		$this->current_espresso_theme = 'Espresso_Arabica_2014';
+		$this->EED_Event_Single = null;
+		$this->EED_Events_Archive = null;
+		$this->EED_Ticket_Selector = null;
+	}
 }
 
 
@@ -2684,114 +2684,114 @@ 
 class EE_Map_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $use_google_maps
-     */
-    public $use_google_maps;
-
-    /**
-     * @var string $api_key
-     */
-    public $google_map_api_key;
-
-    /**
-     * @var int $event_details_map_width
-     */
-    public $event_details_map_width;
-
-    /**
-     * @var int $event_details_map_height
-     */
-    public $event_details_map_height;
-
-    /**
-     * @var int $event_details_map_zoom
-     */
-    public $event_details_map_zoom;
-
-    /**
-     * @var boolean $event_details_display_nav
-     */
-    public $event_details_display_nav;
-
-    /**
-     * @var boolean $event_details_nav_size
-     */
-    public $event_details_nav_size;
-
-    /**
-     * @var string $event_details_control_type
-     */
-    public $event_details_control_type;
-
-    /**
-     * @var string $event_details_map_align
-     */
-    public $event_details_map_align;
-
-    /**
-     * @var int $event_list_map_width
-     */
-    public $event_list_map_width;
-
-    /**
-     * @var int $event_list_map_height
-     */
-    public $event_list_map_height;
-
-    /**
-     * @var int $event_list_map_zoom
-     */
-    public $event_list_map_zoom;
-
-    /**
-     * @var boolean $event_list_display_nav
-     */
-    public $event_list_display_nav;
-
-    /**
-     * @var boolean $event_list_nav_size
-     */
-    public $event_list_nav_size;
-
-    /**
-     * @var string $event_list_control_type
-     */
-    public $event_list_control_type;
-
-    /**
-     * @var string $event_list_map_align
-     */
-    public $event_list_map_align;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default map settings
-        $this->use_google_maps = true;
-        $this->google_map_api_key = '';
-        // for event details pages (reg page)
-        $this->event_details_map_width = 585;            // ee_map_width_single
-        $this->event_details_map_height = 362;            // ee_map_height_single
-        $this->event_details_map_zoom = 14;            // ee_map_zoom_single
-        $this->event_details_display_nav = true;            // ee_map_nav_display_single
-        $this->event_details_nav_size = false;            // ee_map_nav_size_single
-        $this->event_details_control_type = 'default';        // ee_map_type_control_single
-        $this->event_details_map_align = 'center';            // ee_map_align_single
-        // for event list pages
-        $this->event_list_map_width = 300;            // ee_map_width
-        $this->event_list_map_height = 185;        // ee_map_height
-        $this->event_list_map_zoom = 12;            // ee_map_zoom
-        $this->event_list_display_nav = false;        // ee_map_nav_display
-        $this->event_list_nav_size = true;            // ee_map_nav_size
-        $this->event_list_control_type = 'dropdown';        // ee_map_type_control
-        $this->event_list_map_align = 'center';            // ee_map_align
-    }
+	/**
+	 * @var boolean $use_google_maps
+	 */
+	public $use_google_maps;
+
+	/**
+	 * @var string $api_key
+	 */
+	public $google_map_api_key;
+
+	/**
+	 * @var int $event_details_map_width
+	 */
+	public $event_details_map_width;
+
+	/**
+	 * @var int $event_details_map_height
+	 */
+	public $event_details_map_height;
+
+	/**
+	 * @var int $event_details_map_zoom
+	 */
+	public $event_details_map_zoom;
+
+	/**
+	 * @var boolean $event_details_display_nav
+	 */
+	public $event_details_display_nav;
+
+	/**
+	 * @var boolean $event_details_nav_size
+	 */
+	public $event_details_nav_size;
+
+	/**
+	 * @var string $event_details_control_type
+	 */
+	public $event_details_control_type;
+
+	/**
+	 * @var string $event_details_map_align
+	 */
+	public $event_details_map_align;
+
+	/**
+	 * @var int $event_list_map_width
+	 */
+	public $event_list_map_width;
+
+	/**
+	 * @var int $event_list_map_height
+	 */
+	public $event_list_map_height;
+
+	/**
+	 * @var int $event_list_map_zoom
+	 */
+	public $event_list_map_zoom;
+
+	/**
+	 * @var boolean $event_list_display_nav
+	 */
+	public $event_list_display_nav;
+
+	/**
+	 * @var boolean $event_list_nav_size
+	 */
+	public $event_list_nav_size;
+
+	/**
+	 * @var string $event_list_control_type
+	 */
+	public $event_list_control_type;
+
+	/**
+	 * @var string $event_list_map_align
+	 */
+	public $event_list_map_align;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default map settings
+		$this->use_google_maps = true;
+		$this->google_map_api_key = '';
+		// for event details pages (reg page)
+		$this->event_details_map_width = 585;            // ee_map_width_single
+		$this->event_details_map_height = 362;            // ee_map_height_single
+		$this->event_details_map_zoom = 14;            // ee_map_zoom_single
+		$this->event_details_display_nav = true;            // ee_map_nav_display_single
+		$this->event_details_nav_size = false;            // ee_map_nav_size_single
+		$this->event_details_control_type = 'default';        // ee_map_type_control_single
+		$this->event_details_map_align = 'center';            // ee_map_align_single
+		// for event list pages
+		$this->event_list_map_width = 300;            // ee_map_width
+		$this->event_list_map_height = 185;        // ee_map_height
+		$this->event_list_map_zoom = 12;            // ee_map_zoom
+		$this->event_list_display_nav = false;        // ee_map_nav_display
+		$this->event_list_nav_size = true;            // ee_map_nav_size
+		$this->event_list_control_type = 'dropdown';        // ee_map_type_control
+		$this->event_list_map_align = 'center';            // ee_map_align
+	}
 }
 
 
@@ -2801,46 +2801,46 @@ 
 class EE_Events_Archive_Config extends EE_Config_Base
 {
 
-    public $display_status_banner;
+	public $display_status_banner;
 
-    public $display_description;
+	public $display_description;
 
-    public $display_ticket_selector;
+	public $display_ticket_selector;
 
-    public $display_datetimes;
+	public $display_datetimes;
 
-    public $display_venue;
+	public $display_venue;
 
-    public $display_expired_events;
+	public $display_expired_events;
 
-    public $use_sortable_display_order;
+	public $use_sortable_display_order;
 
-    public $display_order_tickets;
+	public $display_order_tickets;
 
-    public $display_order_datetimes;
+	public $display_order_datetimes;
 
-    public $display_order_event;
+	public $display_order_event;
 
-    public $display_order_venue;
+	public $display_order_venue;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->display_status_banner = 0;
-        $this->display_description = 1;
-        $this->display_ticket_selector = 0;
-        $this->display_datetimes = 1;
-        $this->display_venue = 0;
-        $this->display_expired_events = 0;
-        $this->use_sortable_display_order = false;
-        $this->display_order_tickets = 100;
-        $this->display_order_datetimes = 110;
-        $this->display_order_event = 120;
-        $this->display_order_venue = 130;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->display_status_banner = 0;
+		$this->display_description = 1;
+		$this->display_ticket_selector = 0;
+		$this->display_datetimes = 1;
+		$this->display_venue = 0;
+		$this->display_expired_events = 0;
+		$this->use_sortable_display_order = false;
+		$this->display_order_tickets = 100;
+		$this->display_order_datetimes = 110;
+		$this->display_order_event = 120;
+		$this->display_order_venue = 130;
+	}
 }
 
 
@@ -2850,34 +2850,34 @@ 
 class EE_Event_Single_Config extends EE_Config_Base
 {
 
-    public $display_status_banner_single;
+	public $display_status_banner_single;
 
-    public $display_venue;
+	public $display_venue;
 
-    public $use_sortable_display_order;
+	public $use_sortable_display_order;
 
-    public $display_order_tickets;
+	public $display_order_tickets;
 
-    public $display_order_datetimes;
+	public $display_order_datetimes;
 
-    public $display_order_event;
+	public $display_order_event;
 
-    public $display_order_venue;
+	public $display_order_venue;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->display_status_banner_single = 0;
-        $this->display_venue = 1;
-        $this->use_sortable_display_order = false;
-        $this->display_order_tickets = 100;
-        $this->display_order_datetimes = 110;
-        $this->display_order_event = 120;
-        $this->display_order_venue = 130;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->display_status_banner_single = 0;
+		$this->display_venue = 1;
+		$this->use_sortable_display_order = false;
+		$this->display_order_tickets = 100;
+		$this->display_order_datetimes = 110;
+		$this->display_order_event = 120;
+		$this->display_order_venue = 130;
+	}
 }
 
 
@@ -2887,146 +2887,146 @@ 
 class EE_Ticket_Selector_Config extends EE_Config_Base
 {
 
-    /**
-     * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
-     */
-    const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
-
-    /**
-     * constant to indicate that a datetime selector should only be shown for ticket selectors
-     * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
-     */
-    const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
-
-    /**
-     * @var boolean $show_ticket_sale_columns
-     */
-    public $show_ticket_sale_columns;
-
-    /**
-     * @var boolean $show_ticket_details
-     */
-    public $show_ticket_details;
-
-    /**
-     * @var boolean $show_expired_tickets
-     */
-    public $show_expired_tickets;
-
-    /**
-     * whether or not to display a dropdown box populated with event datetimes
-     * that toggles which tickets are displayed for a ticket selector.
-     * uses one of the *_DATETIME_SELECTOR constants defined above
-     *
-     * @var string $show_datetime_selector
-     */
-    private $show_datetime_selector = 'no_datetime_selector';
-
-    /**
-     * the number of datetimes an event has to have before conditionally displaying a datetime selector
-     *
-     * @var int $datetime_selector_threshold
-     */
-    private $datetime_selector_threshold = 3;
-
-
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->show_ticket_sale_columns = true;
-        $this->show_ticket_details = true;
-        $this->show_expired_tickets = true;
-        $this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
-        $this->datetime_selector_threshold = 3;
-    }
-
-
-    /**
-     * returns true if a datetime selector should be displayed
-     *
-     * @param array $datetimes
-     * @return bool
-     */
-    public function showDatetimeSelector(array $datetimes)
-    {
-        // if the settings are NOT: don't show OR below threshold, THEN active = true
-        return ! (
-            $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
-            || (
-                $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
-                && count($datetimes) < $this->getDatetimeSelectorThreshold()
-            )
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getShowDatetimeSelector()
-    {
-        return $this->show_datetime_selector;
-    }
-
-
-    /**
-     * @param bool $keys_only
-     * @return array
-     */
-    public function getShowDatetimeSelectorOptions($keys_only = true)
-    {
-        return $keys_only
-            ? array(
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
-            )
-            : array(
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
-                    'Do not show date & time filter',
-                    'event_espresso'
-                ),
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
-                    'Maybe show date & time filter',
-                    'event_espresso'
-                ),
-            );
-    }
-
-
-    /**
-     * @param string $show_datetime_selector
-     */
-    public function setShowDatetimeSelector($show_datetime_selector)
-    {
-        $this->show_datetime_selector = in_array(
-            $show_datetime_selector,
-            $this->getShowDatetimeSelectorOptions(),
-            true
-        )
-            ? $show_datetime_selector
-            : \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getDatetimeSelectorThreshold()
-    {
-        return $this->datetime_selector_threshold;
-    }
-
-
-    /**
-     * @param int $datetime_selector_threshold
-     */
-    public function setDatetimeSelectorThreshold($datetime_selector_threshold)
-    {
-        $datetime_selector_threshold = absint($datetime_selector_threshold);
-        $this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
-    }
+	/**
+	 * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
+	 */
+	const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
+
+	/**
+	 * constant to indicate that a datetime selector should only be shown for ticket selectors
+	 * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
+	 */
+	const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
+
+	/**
+	 * @var boolean $show_ticket_sale_columns
+	 */
+	public $show_ticket_sale_columns;
+
+	/**
+	 * @var boolean $show_ticket_details
+	 */
+	public $show_ticket_details;
+
+	/**
+	 * @var boolean $show_expired_tickets
+	 */
+	public $show_expired_tickets;
+
+	/**
+	 * whether or not to display a dropdown box populated with event datetimes
+	 * that toggles which tickets are displayed for a ticket selector.
+	 * uses one of the *_DATETIME_SELECTOR constants defined above
+	 *
+	 * @var string $show_datetime_selector
+	 */
+	private $show_datetime_selector = 'no_datetime_selector';
+
+	/**
+	 * the number of datetimes an event has to have before conditionally displaying a datetime selector
+	 *
+	 * @var int $datetime_selector_threshold
+	 */
+	private $datetime_selector_threshold = 3;
+
+
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->show_ticket_sale_columns = true;
+		$this->show_ticket_details = true;
+		$this->show_expired_tickets = true;
+		$this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
+		$this->datetime_selector_threshold = 3;
+	}
+
+
+	/**
+	 * returns true if a datetime selector should be displayed
+	 *
+	 * @param array $datetimes
+	 * @return bool
+	 */
+	public function showDatetimeSelector(array $datetimes)
+	{
+		// if the settings are NOT: don't show OR below threshold, THEN active = true
+		return ! (
+			$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
+			|| (
+				$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
+				&& count($datetimes) < $this->getDatetimeSelectorThreshold()
+			)
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getShowDatetimeSelector()
+	{
+		return $this->show_datetime_selector;
+	}
+
+
+	/**
+	 * @param bool $keys_only
+	 * @return array
+	 */
+	public function getShowDatetimeSelectorOptions($keys_only = true)
+	{
+		return $keys_only
+			? array(
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
+			)
+			: array(
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
+					'Do not show date & time filter',
+					'event_espresso'
+				),
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
+					'Maybe show date & time filter',
+					'event_espresso'
+				),
+			);
+	}
+
+
+	/**
+	 * @param string $show_datetime_selector
+	 */
+	public function setShowDatetimeSelector($show_datetime_selector)
+	{
+		$this->show_datetime_selector = in_array(
+			$show_datetime_selector,
+			$this->getShowDatetimeSelectorOptions(),
+			true
+		)
+			? $show_datetime_selector
+			: \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getDatetimeSelectorThreshold()
+	{
+		return $this->datetime_selector_threshold;
+	}
+
+
+	/**
+	 * @param int $datetime_selector_threshold
+	 */
+	public function setDatetimeSelectorThreshold($datetime_selector_threshold)
+	{
+		$datetime_selector_threshold = absint($datetime_selector_threshold);
+		$this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
+	}
 }
 
 
@@ -3040,81 +3040,81 @@ 
 class EE_Environment_Config extends EE_Config_Base
 {
 
-    /**
-     * Hold any php environment variables that we want to track.
-     *
-     * @var stdClass;
-     */
-    public $php;
-
-
-    /**
-     *    constructor
-     */
-    public function __construct()
-    {
-        $this->php = new stdClass();
-        $this->_set_php_values();
-    }
-
-
-    /**
-     * This sets the php environment variables.
-     *
-     * @since 4.4.0
-     * @return void
-     */
-    protected function _set_php_values()
-    {
-        $this->php->max_input_vars = ini_get('max_input_vars');
-        $this->php->version = phpversion();
-    }
-
-
-    /**
-     * helper method for determining whether input_count is
-     * reaching the potential maximum the server can handle
-     * according to max_input_vars
-     *
-     * @param int   $input_count the count of input vars.
-     * @return array {
-     *                           An array that represents whether available space and if no available space the error
-     *                           message.
-     * @type bool   $has_space   whether more inputs can be added.
-     * @type string $msg         Any message to be displayed.
-     *                           }
-     */
-    public function max_input_vars_limit_check($input_count = 0)
-    {
-        if (! empty($this->php->max_input_vars)
-            && ($input_count >= $this->php->max_input_vars)
-            && (PHP_MAJOR_VERSION >= 5 && PHP_MINOR_VERSION >= 3 && PHP_RELEASE_VERSION >= 9)
-        ) {
-            return sprintf(
-                __(
-                    'The maximum number of inputs on this page has been exceeded.  You cannot add anymore items (i.e. tickets, datetimes, custom fields) on this page because of your servers PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.',
-                    'event_espresso'
-                ),
-                '<br>',
-                $input_count,
-                $this->php->max_input_vars
-            );
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
-     *
-     * @since 4.4.1
-     * @return void
-     */
-    public function recheck_values()
-    {
-        $this->_set_php_values();
-    }
+	/**
+	 * Hold any php environment variables that we want to track.
+	 *
+	 * @var stdClass;
+	 */
+	public $php;
+
+
+	/**
+	 *    constructor
+	 */
+	public function __construct()
+	{
+		$this->php = new stdClass();
+		$this->_set_php_values();
+	}
+
+
+	/**
+	 * This sets the php environment variables.
+	 *
+	 * @since 4.4.0
+	 * @return void
+	 */
+	protected function _set_php_values()
+	{
+		$this->php->max_input_vars = ini_get('max_input_vars');
+		$this->php->version = phpversion();
+	}
+
+
+	/**
+	 * helper method for determining whether input_count is
+	 * reaching the potential maximum the server can handle
+	 * according to max_input_vars
+	 *
+	 * @param int   $input_count the count of input vars.
+	 * @return array {
+	 *                           An array that represents whether available space and if no available space the error
+	 *                           message.
+	 * @type bool   $has_space   whether more inputs can be added.
+	 * @type string $msg         Any message to be displayed.
+	 *                           }
+	 */
+	public function max_input_vars_limit_check($input_count = 0)
+	{
+		if (! empty($this->php->max_input_vars)
+			&& ($input_count >= $this->php->max_input_vars)
+			&& (PHP_MAJOR_VERSION >= 5 && PHP_MINOR_VERSION >= 3 && PHP_RELEASE_VERSION >= 9)
+		) {
+			return sprintf(
+				__(
+					'The maximum number of inputs on this page has been exceeded.  You cannot add anymore items (i.e. tickets, datetimes, custom fields) on this page because of your servers PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.',
+					'event_espresso'
+				),
+				'<br>',
+				$input_count,
+				$this->php->max_input_vars
+			);
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
+	 *
+	 * @since 4.4.1
+	 * @return void
+	 */
+	public function recheck_values()
+	{
+		$this->_set_php_values();
+	}
 }
 
 
@@ -3128,21 +3128,21 @@ 
 class EE_Tax_Config extends EE_Config_Base
 {
 
-    /*
+	/*
      * flag to indicate whether or not to display ticket prices with the taxes included
      *
      * @var boolean $prices_displayed_including_taxes
      */
-    public $prices_displayed_including_taxes;
+	public $prices_displayed_including_taxes;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->prices_displayed_including_taxes = true;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->prices_displayed_including_taxes = true;
+	}
 }
 
 
@@ -3157,18 +3157,18 @@ 
 class EE_Messages_Config extends EE_Config_Base
 {
 
-    /**
-     * This is an integer representing the deletion threshold in months for when old messages will get deleted.
-     * A value of 0 represents never deleting.  Default is 0.
-     *
-     * @var integer
-     */
-    public $delete_threshold;
-
-    public function __construct()
-    {
-        $this->delete_threshold = 0;
-    }
+	/**
+	 * This is an integer representing the deletion threshold in months for when old messages will get deleted.
+	 * A value of 0 represents never deleting.  Default is 0.
+	 *
+	 * @var integer
+	 */
+	public $delete_threshold;
+
+	public function __construct()
+	{
+		$this->delete_threshold = 0;
+	}
 }
 
 
@@ -3180,31 +3180,31 @@ 
 class EE_Gateway_Config extends EE_Config_Base
 {
 
-    /**
-     * Array with keys that are payment gateways slugs, and values are arrays
-     * with any config info the gateway wants to store
-     *
-     * @var array
-     */
-    public $payment_settings;
-
-    /**
-     * Where keys are gateway slugs, and values are booleans indicating whether or not
-     * the gateway is stored in the uploads directory
-     *
-     * @var array
-     */
-    public $active_gateways;
-
-
-    /**
-     *    class constructor
-     *
-     * @deprecated
-     */
-    public function __construct()
-    {
-        $this->payment_settings = array();
-        $this->active_gateways = array('Invoice' => false);
-    }
+	/**
+	 * Array with keys that are payment gateways slugs, and values are arrays
+	 * with any config info the gateway wants to store
+	 *
+	 * @var array
+	 */
+	public $payment_settings;
+
+	/**
+	 * Where keys are gateway slugs, and values are booleans indicating whether or not
+	 * the gateway is stored in the uploads directory
+	 *
+	 * @var array
+	 */
+	public $active_gateways;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @deprecated
+	 */
+	public function __construct()
+	{
+		$this->payment_settings = array();
+		$this->active_gateways = array('Invoice' => false);
+	}
 }

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.63.rc.009');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.63.rc.009');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }