eventespresso / event-espresso-core

core/db_models/EEM_CPT_Base.model.php

Indentation +514 added lines, -514 removed lines

@@ -18,519 +18,519 @@
 abstract class EEM_CPT_Base extends EEM_Soft_Delete_Base
 {
 
-    /**
-     * @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
-     */
-    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
-     */
-    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,
-                ),
-            ),
-        ));
-        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' => EE_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'    => EE_Event_Category_Taxonomy,
-                'description' => $category_description,
-                '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
-     */
-    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' => EE_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();
-    }
+	/**
+	 * @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
+	 */
+	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
+	 */
+	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,
+				),
+			),
+		));
+		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' => EE_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'    => EE_Event_Category_Taxonomy,
+				'description' => $category_description,
+				'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
+	 */
+	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' => EE_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();
+	}
 
 }

Spacing +5 added lines, -5 removed lines

@@ -287,7 +287,7 @@ 
         $parent_term_taxonomy_id = null
     ) {
         //create term
-        require_once(EE_MODELS . 'EEM_Term.model.php');
+        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(
@@ -306,7 +306,7 @@ 
             $term->save();
         }
         //make sure there's a term-taxonomy entry too
-        require_once(EE_MODELS . 'EEM_Term_Taxonomy.model.php');
+        require_once(EE_MODELS.'EEM_Term_Taxonomy.model.php');
         $term_taxonomy = EEM_Term_Taxonomy::instance()->get_one(array(
             array(
                 'term_id'  => $term->ID(),
@@ -403,7 +403,7 @@ 
         //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);
+        $statuses = apply_filters('FHEE_EEM_'.get_class($this).'__get_status_array', $statuses);
         return $statuses;
     }
 
@@ -436,7 +436,7 @@ 
      */
     public function instantiate_class_from_post_object_orig($post)
     {
-        $post = (array)$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) {
@@ -468,7 +468,7 @@ 
         if (empty($post)) {
             global $post;
         }
-        $post = (array)$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) {

core/db_models/EEM_Venue.model.php

Indentation +79 added lines, -79 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -25,87 +25,87 @@ 
 class EEM_Venue extends EEM_CPT_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Venue', 'event_espresso');
-        $this->plural_item = __('Venues', 'event_espresso');
-        $this->_tables = array(
-            'Venue_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Venue_Meta' => new EE_Secondary_Table('esp_venue_meta', 'VNUM_ID', 'VNU_ID'),
-        );
-        $this->_fields = array(
-            'Venue_CPT'  => array(
-                'VNU_ID'         => new EE_Primary_Key_Int_Field('ID', __("Venue ID", "event_espresso")),
-                'VNU_name'       => new EE_Plain_Text_Field('post_title', __("Venue Name", "event_espresso"), false,
-                    ''),
-                'VNU_desc'       => new EE_Post_Content_Field('post_content', __("Venue Description", "event_espresso"),
-                    false, ''),
-                'VNU_identifier' => new EE_Slug_Field('post_name', __("Venue Identifier", "event_espresso"), false, ''),
-                'VNU_created'    => new EE_Datetime_Field('post_date', __("Date Venue Created", "event_espresso"),
-                    false, EE_Datetime_Field::now),
-                'VNU_short_desc' => new EE_Plain_Text_Field('post_excerpt',
-                    __("Short Description of Venue", "event_espresso"), true, ''),
-                'VNU_modified'   => new EE_Datetime_Field('post_modified', __("Venue Modified Date", "event_espresso"),
-                    false, EE_Datetime_Field::now),
-                'VNU_wp_user'    => new EE_WP_User_Field('post_author', __("Venue Creator ID", "event_espresso"),
-                    false),
-                'parent'         => new EE_Integer_Field('post_parent', __("Venue Parent ID", "event_espresso"), false,
-                    0),
-                'VNU_order'      => new EE_Integer_Field('menu_order', __("Venue order", "event_espresso"), false, 1),
-                'post_type'      => new EE_WP_Post_Type_Field('espresso_venues'),
-                // EE_Plain_Text_Field('post_type', __("Venue post type", "event_espresso"), false, 'espresso_venues'),
-            ),
-            'Venue_Meta' => array(
-                'VNUM_ID'             => new EE_DB_Only_Int_Field('VNUM_ID',
-                    __("ID of Venue Meta Row", "event_espresso"), false),
-                'VNU_ID_fk'           => new EE_DB_Only_Int_Field('VNU_ID',
-                    __("Foreign Key to Venue Post ", "event_espresso"), false),
-                'VNU_address'         => new EE_Plain_Text_Field('VNU_address',
-                    __("Venue Address line 1", "event_espresso"), true, ''),
-                'VNU_address2'        => new EE_Plain_Text_Field('VNU_address2',
-                    __("Venue Address line 2", "event_espresso"), true, ''),
-                'VNU_city'            => new EE_Plain_Text_Field('VNU_city', __("Venue City", "event_espresso"), true,
-                    ''),
-                'STA_ID'              => new EE_Foreign_Key_Int_Field('STA_ID', __("State ID", "event_espresso"), true,
-                    null, 'State'),
-                'CNT_ISO'             => new EE_Foreign_Key_String_Field('CNT_ISO',
-                    __("Country Code", "event_espresso"), true, null, 'Country'),
-                'VNU_zip'             => new EE_Plain_Text_Field('VNU_zip',
-                    __("Venue Zip/Postal Code", "event_espresso"), true),
-                'VNU_phone'           => new EE_Plain_Text_Field('VNU_phone', __("Venue Phone", "event_espresso"),
-                    true),
-                'VNU_capacity'        => new EE_Infinite_Integer_Field('VNU_capacity',
-                    __("Venue Capacity", "event_espresso"), true, EE_INF),
-                'VNU_url'             => new EE_Plain_Text_Field('VNU_url', __('Venue Website', 'event_espresso'),
-                    true),
-                'VNU_virtual_phone'   => new EE_Plain_Text_Field('VNU_virtual_phone',
-                    __('Call in Number', 'event_espresso'), true),
-                'VNU_virtual_url'     => new EE_Plain_Text_Field('VNU_virtual_url', __('Virtual URL', 'event_espresso'),
-                    true),
-                'VNU_google_map_link' => new EE_Plain_Text_Field('VNU_google_map_link',
-                    __('Google Map Link', 'event_espresso'), true),
-                'VNU_enable_for_gmap' => new EE_Boolean_Field('VNU_enable_for_gmap',
-                    __('Show Google Map?', 'event_espresso'), false, false),
-            ),
-        );
-        $this->_model_relations = array(
-            'Event'             => new EE_HABTM_Relation('Event_Venue'),
-            'State'             => new EE_Belongs_To_Relation(),
-            'Country'           => new EE_Belongs_To_Relation(),
-            'Event_Venue'       => new EE_Has_Many_Relation(),
-            'WP_User'           => new EE_Belongs_To_Relation(),
-            'Term_Relationship' => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
-        );
-        //this model is generally available for reading
-        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
-        parent::__construct($timezone);
-    }
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Venue', 'event_espresso');
+		$this->plural_item = __('Venues', 'event_espresso');
+		$this->_tables = array(
+			'Venue_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Venue_Meta' => new EE_Secondary_Table('esp_venue_meta', 'VNUM_ID', 'VNU_ID'),
+		);
+		$this->_fields = array(
+			'Venue_CPT'  => array(
+				'VNU_ID'         => new EE_Primary_Key_Int_Field('ID', __("Venue ID", "event_espresso")),
+				'VNU_name'       => new EE_Plain_Text_Field('post_title', __("Venue Name", "event_espresso"), false,
+					''),
+				'VNU_desc'       => new EE_Post_Content_Field('post_content', __("Venue Description", "event_espresso"),
+					false, ''),
+				'VNU_identifier' => new EE_Slug_Field('post_name', __("Venue Identifier", "event_espresso"), false, ''),
+				'VNU_created'    => new EE_Datetime_Field('post_date', __("Date Venue Created", "event_espresso"),
+					false, EE_Datetime_Field::now),
+				'VNU_short_desc' => new EE_Plain_Text_Field('post_excerpt',
+					__("Short Description of Venue", "event_espresso"), true, ''),
+				'VNU_modified'   => new EE_Datetime_Field('post_modified', __("Venue Modified Date", "event_espresso"),
+					false, EE_Datetime_Field::now),
+				'VNU_wp_user'    => new EE_WP_User_Field('post_author', __("Venue Creator ID", "event_espresso"),
+					false),
+				'parent'         => new EE_Integer_Field('post_parent', __("Venue Parent ID", "event_espresso"), false,
+					0),
+				'VNU_order'      => new EE_Integer_Field('menu_order', __("Venue order", "event_espresso"), false, 1),
+				'post_type'      => new EE_WP_Post_Type_Field('espresso_venues'),
+				// EE_Plain_Text_Field('post_type', __("Venue post type", "event_espresso"), false, 'espresso_venues'),
+			),
+			'Venue_Meta' => array(
+				'VNUM_ID'             => new EE_DB_Only_Int_Field('VNUM_ID',
+					__("ID of Venue Meta Row", "event_espresso"), false),
+				'VNU_ID_fk'           => new EE_DB_Only_Int_Field('VNU_ID',
+					__("Foreign Key to Venue Post ", "event_espresso"), false),
+				'VNU_address'         => new EE_Plain_Text_Field('VNU_address',
+					__("Venue Address line 1", "event_espresso"), true, ''),
+				'VNU_address2'        => new EE_Plain_Text_Field('VNU_address2',
+					__("Venue Address line 2", "event_espresso"), true, ''),
+				'VNU_city'            => new EE_Plain_Text_Field('VNU_city', __("Venue City", "event_espresso"), true,
+					''),
+				'STA_ID'              => new EE_Foreign_Key_Int_Field('STA_ID', __("State ID", "event_espresso"), true,
+					null, 'State'),
+				'CNT_ISO'             => new EE_Foreign_Key_String_Field('CNT_ISO',
+					__("Country Code", "event_espresso"), true, null, 'Country'),
+				'VNU_zip'             => new EE_Plain_Text_Field('VNU_zip',
+					__("Venue Zip/Postal Code", "event_espresso"), true),
+				'VNU_phone'           => new EE_Plain_Text_Field('VNU_phone', __("Venue Phone", "event_espresso"),
+					true),
+				'VNU_capacity'        => new EE_Infinite_Integer_Field('VNU_capacity',
+					__("Venue Capacity", "event_espresso"), true, EE_INF),
+				'VNU_url'             => new EE_Plain_Text_Field('VNU_url', __('Venue Website', 'event_espresso'),
+					true),
+				'VNU_virtual_phone'   => new EE_Plain_Text_Field('VNU_virtual_phone',
+					__('Call in Number', 'event_espresso'), true),
+				'VNU_virtual_url'     => new EE_Plain_Text_Field('VNU_virtual_url', __('Virtual URL', 'event_espresso'),
+					true),
+				'VNU_google_map_link' => new EE_Plain_Text_Field('VNU_google_map_link',
+					__('Google Map Link', 'event_espresso'), true),
+				'VNU_enable_for_gmap' => new EE_Boolean_Field('VNU_enable_for_gmap',
+					__('Show Google Map?', 'event_espresso'), false, false),
+			),
+		);
+		$this->_model_relations = array(
+			'Event'             => new EE_HABTM_Relation('Event_Venue'),
+			'State'             => new EE_Belongs_To_Relation(),
+			'Country'           => new EE_Belongs_To_Relation(),
+			'Event_Venue'       => new EE_Has_Many_Relation(),
+			'WP_User'           => new EE_Belongs_To_Relation(),
+			'Term_Relationship' => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
+		);
+		//this model is generally available for reading
+		$this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
+		parent::__construct($timezone);
+	}
 
 }
 // End of file EEM_Venue.model.php

Spacing +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
  * @author                Michael Nelson
  *                        ------------------------------------------------------------------------
  */
-require_once(EE_MODELS . 'EEM_Base.model.php');
+require_once(EE_MODELS.'EEM_Base.model.php');
 
 
 

core/db_classes/EE_Message.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -697,7 +697,7 @@
     /**
      * Gets any error message.
      *
-     * @return mixed|null
+     * @return string
      */
     public function error_message()
     {

Spacing +2 added lines, -2 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -859,7 +859,7 @@ 
      */
     public function set_messenger_is_executing()
     {
-        $this->set_STS_ID( EEM_Message::status_messenger_executing );
+        $this->set_STS_ID(EEM_Message::status_messenger_executing);
         $this->set_error_message(
             esc_html__(
                 'A message with this status indicates that there was a problem that occurred while the message was being

Indentation +860 added lines, -860 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -12,869 +12,869 @@ 
 class EE_Message extends EE_Base_Class implements EEI_Admin_Links
 {
 
-    /**
-     * @deprecated 4.9.0  Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_pack;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_variation;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type string
-     */
-    public $content = '';
-
-
-    /**
-     * @type EE_messenger $_messenger
-     */
-    protected $_messenger = null;
-
-    /**
-     * @type EE_message_type $_message_type
-     */
-    protected $_message_type = null;
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
-     *                             format.
-     * @return EE_Message
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        //if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
-        if ( ! $has_object) {
-            EE_Registry::instance()->load_helper('URL');
-            $props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
-        }
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Gets MSG_token
-     *
-     * @return int
-     */
-    public function MSG_token()
-    {
-        return $this->get('MSG_token');
-    }
-
-
-    /**
-     * Sets MSG_token
-     *
-     * @param int $MSG_token
-     */
-    public function set_MSG_token($MSG_token)
-    {
-        $this->set('MSG_token', $MSG_token);
-    }
-
-
-    /**
-     * Gets GRP_ID
-     *
-     * @return int
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * Sets GRP_ID
-     *
-     * @param int $GRP_ID
-     */
-    public function set_GRP_ID($GRP_ID)
-    {
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * Gets TXN_ID
-     *
-     * @return int
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * Sets TXN_ID
-     *
-     * @param int $TXN_ID
-     */
-    public function set_TXN_ID($TXN_ID)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets messenger
-     *
-     * @return string
-     */
-    public function messenger()
-    {
-        return $this->get('MSG_messenger');
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param string $messenger
-     */
-    public function set_messenger($messenger)
-    {
-        $this->set('MSG_messenger', $messenger);
-    }
-
-
-    /**
-     * Returns corresponding messenger object for the set messenger on this message
-     *
-     * @return EE_messenger | null
-     */
-    public function messenger_object()
-    {
-        return $this->_messenger;
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param EE_messenger $messenger
-     */
-    public function set_messenger_object(EE_messenger $messenger)
-    {
-        $this->_messenger = $messenger;
-    }
-
-
-    /**
-     * validates messenger
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_messenger($throw_exceptions = false)
-    {
-        if ($this->_messenger instanceof EE_messenger) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->messenger()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * This returns the set localized label for the messenger on this message.
-     * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function messenger_label($plural = false)
-    {
-        $label_type = $plural ? 'plural' : 'singular';
-        $messenger  = $this->messenger_object();
-        return $messenger instanceof EE_messenger ? $messenger->label[$label_type] : $this->messenger();
-    }
-
-
-    /**
-     * Gets message_type
-     *
-     * @return string
-     */
-    public function message_type()
-    {
-        return $this->get('MSG_message_type');
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param string $message_type
-     */
-    public function set_message_type($message_type)
-    {
-        $this->set('MSG_message_type', $message_type);
-    }
-
-
-    /**
-     * Returns the message type object for the set message type on this message
-     *
-     * @return EE_message_type | null
-     */
-    public function message_type_object()
-    {
-        return $this->_message_type;
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param EE_message_type $message_type
-     * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
-     *                                        the message type or not.
-     */
-    public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
-    {
-        $this->_message_type = $message_type;
-        if ($set_priority) {
-            $this->set_priority($this->_message_type->get_priority());
-        }
-    }
-
-
-    /**
-     * validates message_type
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_message_type($throw_exceptions = false)
-    {
-        if ($this->_message_type instanceof EE_message_type) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->message_type()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_valid($throw_exceptions = false)
-    {
-        if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * This validates whether the internal messenger and message type objects are valid for sending.
-     * Three checks are done:
-     * 1. There is a valid messenger object.
-     * 2. There is a valid message type object.
-     * 3. The message type object is active for the messenger.
-     *
-     * @throws EE_Error  But only if $throw_exceptions is set to true.
-     * @param bool $throw_exceptions
-     * @return bool
-     */
-    public function is_valid_for_sending_or_generation($throw_exceptions = false)
-    {
-        $valid = false;
-        if ($this->is_valid($throw_exceptions)) {
-            /** @var EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $valid                    = $message_resource_manager->is_message_type_active_for_messenger($this->messenger(),
-                $this->message_type());
-            if ( ! $valid && $throw_exceptions) {
-                throw new EE_Error(
-                    sprintf(
-                        __('The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
-                            'event_espresso'),
-                        $this->message_type(),
-                        $this->messenger()
-                    )
-                );
-            }
-        }
-        return $valid;
-    }
-
-
-    /**
-     * This returns the set localized label for the message type on this message.
-     * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function message_type_label($plural = false)
-    {
-        $label_type   = $plural ? 'plural' : 'singular';
-        $message_type = $this->message_type_object();
-        return $message_type instanceof EE_message_type ? $message_type->label[$label_type] : str_replace(
-            '_',
-            ' ',
-            $this->message_type()
-        );
-    }
-
-
-    /**
-     * Gets context
-     *
-     * @return string
-     */
-    public function context()
-    {
-        return $this->get('MSG_context');
-    }
-
-
-    /**
-     * This returns the corresponding localized label for the given context slug, if possible from installed message
-     * types. Otherwise, this will just return the set context slug on this object.
-     *
-     * @return string
-     */
-    public function context_label()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $contexts                 = $message_resource_manager->get_all_contexts();
-        return isset($contexts[$this->context()]) ? $contexts[$this->context()] : $this->context();
-    }
-
-
-    /**
-     * Sets context
-     *
-     * @param string $context
-     */
-    public function set_context($context)
-    {
-        $this->set('MSG_context', $context);
-    }
-
-
-    /**
-     * Gets recipient_ID
-     *
-     * @return int
-     */
-    public function recipient_ID()
-    {
-        return $this->get('MSG_recipient_ID');
-    }
-
-
-    /**
-     * Sets recipient_ID
-     *
-     * @param string $recipient_ID
-     */
-    public function set_recipient_ID($recipient_ID)
-    {
-        $this->set('MSG_recipient_ID', $recipient_ID);
-    }
-
-
-    /**
-     * Gets recipient_type
-     *
-     * @return string
-     */
-    public function recipient_type()
-    {
-        return $this->get('MSG_recipient_type');
-    }
-
-
-    /**
-     * Return the related object matching the recipient type and ID.
-     *
-     * @return EE_Base_Class | null
-     */
-    public function recipient_object()
-    {
-        if ( ! $this->recipient_type() || ! $this->recipient_ID()) {
-            return null;
-        }
-
-        return $this->get_first_related($this->recipient_type());
-    }
-
-
-    /**
-     * Sets recipient_type
-     *
-     * @param string $recipient_type
-     */
-    public function set_recipient_type($recipient_type)
-    {
-        $this->set('MSG_recipient_type', $recipient_type);
-    }
-
-
-    /**
-     * Gets content
-     *
-     * @return string
-     */
-    public function content()
-    {
-        return $this->get('MSG_content');
-    }
-
-
-    /**
-     * Sets content
-     *
-     * @param string $content
-     */
-    public function set_content($content)
-    {
-        $this->set('MSG_content', $content);
-    }
-
-
-    /**
-     * Gets subject
-     *
-     * @return string
-     */
-    public function subject()
-    {
-        return $this->get('MSG_subject');
-    }
-
-
-    /**
-     * Sets subject
-     *
-     * @param string $subject
-     */
-    public function set_subject($subject)
-    {
-        $this->set('MSG_subject', $subject);
-    }
-
-
-    /**
-     * Gets to
-     *
-     * @return string
-     */
-    public function to()
-    {
-        $to = $this->get('MSG_to');
-        return empty($to) ? __('No recipient', 'event_espresso') : $to;
-    }
-
-
-    /**
-     * Sets to
-     *
-     * @param string $to
-     */
-    public function set_to($to)
-    {
-        $this->set('MSG_to', $to);
-    }
-
-
-    /**
-     * Gets from
-     *
-     * @return string
-     */
-    public function from()
-    {
-        return $this->get('MSG_from');
-    }
-
-
-    /**
-     * Sets from
-     *
-     * @param string $from
-     */
-    public function set_from($from)
-    {
-        $this->set('MSG_from', $from);
-    }
-
-
-    /**
-     * Gets priority
-     *
-     * @return int
-     */
-    public function priority()
-    {
-        return $this->get('MSG_priority');
-    }
-
-
-    /**
-     * Sets priority
-     * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
-     * this method calls the send_now method to verify that.
-     *
-     * @param int $priority
-     */
-    public function set_priority($priority)
-    {
-        $priority = $this->send_now() ? EEM_Message::priority_high : $priority;
-        parent::set('MSG_priority', $priority);
-    }
-
-
-    /**
-     * Overrides parent::set method so we can capture any sets for priority.
-     *
-     * @see parent::set() for phpdocs
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        if ($field_name === 'MSG_priority') {
-            $this->set_priority($field_value);
-        }
-        parent::set($field_name, $field_value, $use_default);
-    }
-
-
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function send_now()
-    {
-        $send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high : $this->priority();
-        return $send_now === EEM_Message::priority_high ? true : false;
-    }
-
-
-    /**
-     * Gets STS_ID
-     *
-     * @return string
-     */
-    public function STS_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * Sets STS_ID
-     *
-     * @param string $STS_ID
-     */
-    public function set_STS_ID($STS_ID)
-    {
-        $this->set('STS_ID', $STS_ID);
-    }
-
-
-    /**
-     * Gets created
-     *
-     * @return string
-     */
-    public function created()
-    {
-        return $this->get('MSG_created');
-    }
-
-
-    /**
-     * Sets created
-     *
-     * @param string $created
-     */
-    public function set_created($created)
-    {
-        $this->set('MSG_created', $created);
-    }
-
-
-    /**
-     * Gets modified
-     *
-     * @return string
-     */
-    public function modified()
-    {
-        return $this->get('MSG_modified');
-    }
-
-
-    /**
-     * Sets modified
-     *
-     * @param string $modified
-     */
-    public function set_modified($modified)
-    {
-        $this->set('MSG_modified', $modified);
-    }
-
-
-    /**
-     * Sets generation data for this message.
-     *
-     * @param mixed $data
-     */
-    public function set_generation_data($data)
-    {
-        $this->set_field_or_extra_meta('MSG_generation_data', $data);
-    }
-
-
-    /**
-     * Returns any set generation data for this message.
-     *
-     * @return mixed|null
-     */
-    public function get_generation_data()
-    {
-        return $this->get_field_or_extra_meta('MSG_generation_data');
-    }
-
-
-    /**
-     * Gets any error message.
-     *
-     * @return mixed|null
-     */
-    public function error_message()
-    {
-        return $this->get_field_or_extra_meta('MSG_error');
-    }
-
-
-    /**
-     * Sets an error message.
-     *
-     * @param $message
-     * @return bool|int
-     */
-    public function set_error_message($message)
-    {
-        return $this->set_field_or_extra_meta('MSG_error', $message);
-    }
-
-
-    /**
-     * This retrieves the associated template pack with this message.
-     *
-     * @return EE_Messages_Template_Pack | null
-     */
-    public function get_template_pack()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if ( ! empty($this->template_pack)) {
-            return $this->template_pack;
-        }
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-        //if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if ( ! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
-    }
-
-
-    /**
-     * Retrieves the variation used for generating this message.
-     *
-     * @return string
-     */
-    public function get_template_pack_variation()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if ( ! empty($this->template_variation)) {
-            return $this->template_variation;
-        }
-
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-
-        //if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if ( ! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
-    }
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        EE_Registry::instance()->load_helper('MSG_Template');
-        switch ($this->STS_ID()) {
-            case EEM_Message::status_failed :
-            case EEM_Message::status_debug_only :
-                return EEH_MSG_Template::generate_error_display_trigger($this);
-                break;
-
-            case EEM_Message::status_sent :
-                return EEH_MSG_Template::generate_browser_trigger($this);
-                break;
-
-            default :
-                return '';
-        }
-    }
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'default',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
-     * it.
-     * Note this also SAVES the current message object to the db because it adds an error message to accompany the status.
-     *
-     */
-    public function set_messenger_is_executing()
-    {
-        $this->set_STS_ID( EEM_Message::status_messenger_executing );
-        $this->set_error_message(
-            esc_html__(
-                'A message with this status indicates that there was a problem that occurred while the message was being
+	/**
+	 * @deprecated 4.9.0  Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_pack;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_variation;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type string
+	 */
+	public $content = '';
+
+
+	/**
+	 * @type EE_messenger $_messenger
+	 */
+	protected $_messenger = null;
+
+	/**
+	 * @type EE_message_type $_message_type
+	 */
+	protected $_message_type = null;
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
+	 *                             format.
+	 * @return EE_Message
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		//if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
+		if ( ! $has_object) {
+			EE_Registry::instance()->load_helper('URL');
+			$props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
+		}
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Gets MSG_token
+	 *
+	 * @return int
+	 */
+	public function MSG_token()
+	{
+		return $this->get('MSG_token');
+	}
+
+
+	/**
+	 * Sets MSG_token
+	 *
+	 * @param int $MSG_token
+	 */
+	public function set_MSG_token($MSG_token)
+	{
+		$this->set('MSG_token', $MSG_token);
+	}
+
+
+	/**
+	 * Gets GRP_ID
+	 *
+	 * @return int
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * Sets GRP_ID
+	 *
+	 * @param int $GRP_ID
+	 */
+	public function set_GRP_ID($GRP_ID)
+	{
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * Gets TXN_ID
+	 *
+	 * @return int
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * Sets TXN_ID
+	 *
+	 * @param int $TXN_ID
+	 */
+	public function set_TXN_ID($TXN_ID)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets messenger
+	 *
+	 * @return string
+	 */
+	public function messenger()
+	{
+		return $this->get('MSG_messenger');
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param string $messenger
+	 */
+	public function set_messenger($messenger)
+	{
+		$this->set('MSG_messenger', $messenger);
+	}
+
+
+	/**
+	 * Returns corresponding messenger object for the set messenger on this message
+	 *
+	 * @return EE_messenger | null
+	 */
+	public function messenger_object()
+	{
+		return $this->_messenger;
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param EE_messenger $messenger
+	 */
+	public function set_messenger_object(EE_messenger $messenger)
+	{
+		$this->_messenger = $messenger;
+	}
+
+
+	/**
+	 * validates messenger
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_messenger($throw_exceptions = false)
+	{
+		if ($this->_messenger instanceof EE_messenger) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->messenger()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * This returns the set localized label for the messenger on this message.
+	 * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function messenger_label($plural = false)
+	{
+		$label_type = $plural ? 'plural' : 'singular';
+		$messenger  = $this->messenger_object();
+		return $messenger instanceof EE_messenger ? $messenger->label[$label_type] : $this->messenger();
+	}
+
+
+	/**
+	 * Gets message_type
+	 *
+	 * @return string
+	 */
+	public function message_type()
+	{
+		return $this->get('MSG_message_type');
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param string $message_type
+	 */
+	public function set_message_type($message_type)
+	{
+		$this->set('MSG_message_type', $message_type);
+	}
+
+
+	/**
+	 * Returns the message type object for the set message type on this message
+	 *
+	 * @return EE_message_type | null
+	 */
+	public function message_type_object()
+	{
+		return $this->_message_type;
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param EE_message_type $message_type
+	 * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
+	 *                                        the message type or not.
+	 */
+	public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
+	{
+		$this->_message_type = $message_type;
+		if ($set_priority) {
+			$this->set_priority($this->_message_type->get_priority());
+		}
+	}
+
+
+	/**
+	 * validates message_type
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_message_type($throw_exceptions = false)
+	{
+		if ($this->_message_type instanceof EE_message_type) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->message_type()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_valid($throw_exceptions = false)
+	{
+		if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * This validates whether the internal messenger and message type objects are valid for sending.
+	 * Three checks are done:
+	 * 1. There is a valid messenger object.
+	 * 2. There is a valid message type object.
+	 * 3. The message type object is active for the messenger.
+	 *
+	 * @throws EE_Error  But only if $throw_exceptions is set to true.
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 */
+	public function is_valid_for_sending_or_generation($throw_exceptions = false)
+	{
+		$valid = false;
+		if ($this->is_valid($throw_exceptions)) {
+			/** @var EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$valid                    = $message_resource_manager->is_message_type_active_for_messenger($this->messenger(),
+				$this->message_type());
+			if ( ! $valid && $throw_exceptions) {
+				throw new EE_Error(
+					sprintf(
+						__('The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
+							'event_espresso'),
+						$this->message_type(),
+						$this->messenger()
+					)
+				);
+			}
+		}
+		return $valid;
+	}
+
+
+	/**
+	 * This returns the set localized label for the message type on this message.
+	 * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function message_type_label($plural = false)
+	{
+		$label_type   = $plural ? 'plural' : 'singular';
+		$message_type = $this->message_type_object();
+		return $message_type instanceof EE_message_type ? $message_type->label[$label_type] : str_replace(
+			'_',
+			' ',
+			$this->message_type()
+		);
+	}
+
+
+	/**
+	 * Gets context
+	 *
+	 * @return string
+	 */
+	public function context()
+	{
+		return $this->get('MSG_context');
+	}
+
+
+	/**
+	 * This returns the corresponding localized label for the given context slug, if possible from installed message
+	 * types. Otherwise, this will just return the set context slug on this object.
+	 *
+	 * @return string
+	 */
+	public function context_label()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$contexts                 = $message_resource_manager->get_all_contexts();
+		return isset($contexts[$this->context()]) ? $contexts[$this->context()] : $this->context();
+	}
+
+
+	/**
+	 * Sets context
+	 *
+	 * @param string $context
+	 */
+	public function set_context($context)
+	{
+		$this->set('MSG_context', $context);
+	}
+
+
+	/**
+	 * Gets recipient_ID
+	 *
+	 * @return int
+	 */
+	public function recipient_ID()
+	{
+		return $this->get('MSG_recipient_ID');
+	}
+
+
+	/**
+	 * Sets recipient_ID
+	 *
+	 * @param string $recipient_ID
+	 */
+	public function set_recipient_ID($recipient_ID)
+	{
+		$this->set('MSG_recipient_ID', $recipient_ID);
+	}
+
+
+	/**
+	 * Gets recipient_type
+	 *
+	 * @return string
+	 */
+	public function recipient_type()
+	{
+		return $this->get('MSG_recipient_type');
+	}
+
+
+	/**
+	 * Return the related object matching the recipient type and ID.
+	 *
+	 * @return EE_Base_Class | null
+	 */
+	public function recipient_object()
+	{
+		if ( ! $this->recipient_type() || ! $this->recipient_ID()) {
+			return null;
+		}
+
+		return $this->get_first_related($this->recipient_type());
+	}
+
+
+	/**
+	 * Sets recipient_type
+	 *
+	 * @param string $recipient_type
+	 */
+	public function set_recipient_type($recipient_type)
+	{
+		$this->set('MSG_recipient_type', $recipient_type);
+	}
+
+
+	/**
+	 * Gets content
+	 *
+	 * @return string
+	 */
+	public function content()
+	{
+		return $this->get('MSG_content');
+	}
+
+
+	/**
+	 * Sets content
+	 *
+	 * @param string $content
+	 */
+	public function set_content($content)
+	{
+		$this->set('MSG_content', $content);
+	}
+
+
+	/**
+	 * Gets subject
+	 *
+	 * @return string
+	 */
+	public function subject()
+	{
+		return $this->get('MSG_subject');
+	}
+
+
+	/**
+	 * Sets subject
+	 *
+	 * @param string $subject
+	 */
+	public function set_subject($subject)
+	{
+		$this->set('MSG_subject', $subject);
+	}
+
+
+	/**
+	 * Gets to
+	 *
+	 * @return string
+	 */
+	public function to()
+	{
+		$to = $this->get('MSG_to');
+		return empty($to) ? __('No recipient', 'event_espresso') : $to;
+	}
+
+
+	/**
+	 * Sets to
+	 *
+	 * @param string $to
+	 */
+	public function set_to($to)
+	{
+		$this->set('MSG_to', $to);
+	}
+
+
+	/**
+	 * Gets from
+	 *
+	 * @return string
+	 */
+	public function from()
+	{
+		return $this->get('MSG_from');
+	}
+
+
+	/**
+	 * Sets from
+	 *
+	 * @param string $from
+	 */
+	public function set_from($from)
+	{
+		$this->set('MSG_from', $from);
+	}
+
+
+	/**
+	 * Gets priority
+	 *
+	 * @return int
+	 */
+	public function priority()
+	{
+		return $this->get('MSG_priority');
+	}
+
+
+	/**
+	 * Sets priority
+	 * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
+	 * this method calls the send_now method to verify that.
+	 *
+	 * @param int $priority
+	 */
+	public function set_priority($priority)
+	{
+		$priority = $this->send_now() ? EEM_Message::priority_high : $priority;
+		parent::set('MSG_priority', $priority);
+	}
+
+
+	/**
+	 * Overrides parent::set method so we can capture any sets for priority.
+	 *
+	 * @see parent::set() for phpdocs
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		if ($field_name === 'MSG_priority') {
+			$this->set_priority($field_value);
+		}
+		parent::set($field_name, $field_value, $use_default);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function send_now()
+	{
+		$send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high : $this->priority();
+		return $send_now === EEM_Message::priority_high ? true : false;
+	}
+
+
+	/**
+	 * Gets STS_ID
+	 *
+	 * @return string
+	 */
+	public function STS_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * Sets STS_ID
+	 *
+	 * @param string $STS_ID
+	 */
+	public function set_STS_ID($STS_ID)
+	{
+		$this->set('STS_ID', $STS_ID);
+	}
+
+
+	/**
+	 * Gets created
+	 *
+	 * @return string
+	 */
+	public function created()
+	{
+		return $this->get('MSG_created');
+	}
+
+
+	/**
+	 * Sets created
+	 *
+	 * @param string $created
+	 */
+	public function set_created($created)
+	{
+		$this->set('MSG_created', $created);
+	}
+
+
+	/**
+	 * Gets modified
+	 *
+	 * @return string
+	 */
+	public function modified()
+	{
+		return $this->get('MSG_modified');
+	}
+
+
+	/**
+	 * Sets modified
+	 *
+	 * @param string $modified
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('MSG_modified', $modified);
+	}
+
+
+	/**
+	 * Sets generation data for this message.
+	 *
+	 * @param mixed $data
+	 */
+	public function set_generation_data($data)
+	{
+		$this->set_field_or_extra_meta('MSG_generation_data', $data);
+	}
+
+
+	/**
+	 * Returns any set generation data for this message.
+	 *
+	 * @return mixed|null
+	 */
+	public function get_generation_data()
+	{
+		return $this->get_field_or_extra_meta('MSG_generation_data');
+	}
+
+
+	/**
+	 * Gets any error message.
+	 *
+	 * @return mixed|null
+	 */
+	public function error_message()
+	{
+		return $this->get_field_or_extra_meta('MSG_error');
+	}
+
+
+	/**
+	 * Sets an error message.
+	 *
+	 * @param $message
+	 * @return bool|int
+	 */
+	public function set_error_message($message)
+	{
+		return $this->set_field_or_extra_meta('MSG_error', $message);
+	}
+
+
+	/**
+	 * This retrieves the associated template pack with this message.
+	 *
+	 * @return EE_Messages_Template_Pack | null
+	 */
+	public function get_template_pack()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if ( ! empty($this->template_pack)) {
+			return $this->template_pack;
+		}
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+		//if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if ( ! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
+	}
+
+
+	/**
+	 * Retrieves the variation used for generating this message.
+	 *
+	 * @return string
+	 */
+	public function get_template_pack_variation()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if ( ! empty($this->template_variation)) {
+			return $this->template_variation;
+		}
+
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+
+		//if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if ( ! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
+	}
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		EE_Registry::instance()->load_helper('MSG_Template');
+		switch ($this->STS_ID()) {
+			case EEM_Message::status_failed :
+			case EEM_Message::status_debug_only :
+				return EEH_MSG_Template::generate_error_display_trigger($this);
+				break;
+
+			case EEM_Message::status_sent :
+				return EEH_MSG_Template::generate_browser_trigger($this);
+				break;
+
+			default :
+				return '';
+		}
+	}
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'default',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
+	 * it.
+	 * Note this also SAVES the current message object to the db because it adds an error message to accompany the status.
+	 *
+	 */
+	public function set_messenger_is_executing()
+	{
+		$this->set_STS_ID( EEM_Message::status_messenger_executing );
+		$this->set_error_message(
+			esc_html__(
+				'A message with this status indicates that there was a problem that occurred while the message was being
                 processed by the messenger.  It is still possible that the message was sent successfully, but at some
                 point during the processing there was a failure.  This usually is indicative of a timeout issue with PHP 
                 or memory limits being reached.  If you see this repeatedly you may want to consider upgrading the memory 
                 available to PHP on your server.',
-                'event_espresso'
-            )
-        );
-    }
+				'event_espresso'
+			)
+		);
+	}
 }
 /* End of file EE_Message.class.php */
 /* Location: /core/db_classes/EE_Message.class.php */
\ No newline at end of file

core/libraries/messages/EE_Messages_Queue.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -603,7 +603,7 @@
      * @param EE_Message      $message
      * @param EE_messenger    $messenger
      * @param EE_message_type $message_type
-     * @param                 $test_send
+     * @param                 boolean $test_send
      * @return bool   true means all went well, false means, not so much.
      */
     protected function _do_preview(

Indentation +689 added lines, -689 removed lines

@@ -2,7 +2,7 @@ 
 use \EventEspresso\core\exceptions\SendMessageException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -18,693 +18,693 @@ 
 {
 
 
-    /**
-     * @type    string  reference for sending action
-     */
-    const action_sending = 'sending';
-
-    /**
-     * @type    string  reference for generation action
-     */
-    const action_generating = 'generation';
-
-
-    /**
-     * @type EE_Message_Repository $_message_repository
-     */
-    protected $_message_repository;
-
-    /**
-     * Sets the limit of how many messages are generated per process.
-     *
-     * @type int
-     */
-    protected $_batch_count;
-
-
-    /**
-     * This is an array of cached queue items being stored in this object.
-     * The array keys will be the ID of the EE_Message in the db if saved.  If the EE_Message
-     * is not saved to the db then its key will be an increment of "UNS" (i.e. UNS1, UNS2 etc.)
-     *
-     * @type EE_Message[]
-     */
-    protected $_cached_queue_items;
-
-    /**
-     * Tracks the number of unsaved queue items.
-     *
-     * @type int
-     */
-    protected $_unsaved_count = 0;
-
-    /**
-     * used to record if a do_messenger_hooks has already been called for a message type.  This prevents multiple
-     * hooks getting fired if users have setup their action/filter hooks to prevent duplicate calls.
-     *
-     * @type array
-     */
-    protected $_did_hook = array();
-
-
-    /**
-     * Constructor.
-     * Setup all the initial properties and load a EE_Message_Repository.
-     *
-     * @param \EE_Message_Repository $message_repository
-     */
-    public function __construct(EE_Message_Repository $message_repository)
-    {
-        $this->_batch_count        = apply_filters('FHEE__EE_Messages_Queue___batch_count', 50);
-        $this->_message_repository = $message_repository;
-    }
-
-
-    /**
-     * Add a EE_Message object to the queue
-     *
-     * @param EE_Message $message
-     * @param array      $data         This will be an array of data to attach to the object in the repository.  If the
-     *                                 object is persisted, this data will be saved on an extra_meta object related to
-     *                                 EE_Message.
-     * @param  bool      $preview      Whether this EE_Message represents a preview or not.
-     * @param  bool      $test_send    This indicates whether to do a test send instead of actual send. A test send will
-     *                                 use the messenger send method but typically is based on preview data.
-     * @return bool          Whether the message was successfully added to the repository or not.
-     */
-    public function add(EE_Message $message, $data = array(), $preview = false, $test_send = false)
-    {
-        $data['preview']   = $preview;
-        $data['test_send'] = $test_send;
-        return $this->_message_repository->add($message, $data);
-    }
-
-
-    /**
-     * Removes EE_Message from _queue that matches the given EE_Message if the pointer is on a matching EE_Message
-     *
-     * @param EE_Message $message The message to detach from the queue
-     * @param bool       $persist This flag indicates whether to attempt to delete the object from the db as well.
-     * @return bool
-     */
-    public function remove(EE_Message $message, $persist = false)
-    {
-        if ($persist && $this->_message_repository->current() !== $message) {
-            //get pointer on right message
-            if ($this->_message_repository->has($message)) {
-                $this->_message_repository->rewind();
-                while ($this->_message_repository->valid()) {
-                    if ($this->_message_repository->current() === $message) {
-                        break;
-                    }
-                    $this->_message_repository->next();
-                }
-            } else {
-                return false;
-            }
-        }
-        return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove($message);
-    }
-
-
-    /**
-     * Persists all queued EE_Message objects to the db.
-     *
-     * @param bool $do_hooks_only       @see EE_Message_Repository::saveAll
-     * @return array @see EE_Messages_Repository::saveAll() for return values.
-     */
-    public function save($do_hooks_only = false)
-    {
-        return $this->_message_repository->saveAll($do_hooks_only);
-    }
-
-
-    /**
-     * @return EE_Message_Repository
-     */
-    public function get_message_repository()
-    {
-        return $this->_message_repository;
-    }
-
-
-    /**
-     * This does the following things:
-     * 1. Checks if there is a lock on generation (prevents race conditions).  If there is a lock then exits (return
-     * false).
-     * 2. If no lock, sets lock, then retrieves a batch of non-generated EE_Message objects and adds to queue
-     * 3. Returns bool.  True = batch ready.  False = no batch ready (or nothing available for generation).
-     * Note: Callers should make sure they release the lock otherwise batch generation will be prevented from
-     * continuing. The lock is on a transient that is set to expire after one hour as a fallback in case locks are not
-     * removed.
-     *
-     * @return bool  true if successfully retrieved batch, false no batch ready.
-     */
-    public function get_batch_to_generate()
-    {
-        if ($this->is_locked(EE_Messages_Queue::action_generating)) {
-            return false;
-        }
-
-        //lock batch generation to prevent race conditions.
-        $this->lock_queue(EE_Messages_Queue::action_generating);
-
-        $query_args = array(
-            // key 0 = where conditions
-            0          => array('STS_ID' => EEM_Message::status_incomplete),
-            'order_by' => $this->_get_priority_orderby(),
-            'limit'    => $this->_batch_count,
-        );
-        $messages   = EEM_Message::instance()->get_all($query_args);
-
-        if ( ! $messages) {
-            return false; //nothing to generate
-        }
-
-        foreach ($messages as $message) {
-            if ($message instanceof EE_Message) {
-                $data = $message->all_extra_meta_array();
-                $this->add($message, $data);
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This does the following things:
-     * 1. Checks if there is a lock on sending (prevents race conditions).  If there is a lock then exits (return
-     * false).
-     * 2. Grabs the allowed number of messages to send for the rate_limit.  If cannot send any more messages, then
-     * return false.
-     * 2. If no lock, sets lock, then retrieves a batch of EE_Message objects, adds to queue and triggers execution.
-     * 3. On success or unsuccessful send, sets status appropriately.
-     * 4. Saves messages via the queue
-     * 5. Releases lock.
-     *
-     * @return bool  true on success, false if something preventing sending (i.e. lock set).  Note: true does not
-     *               necessarily mean that all messages were successfully sent.  It just means that this method
-     *               successfully completed. On true, client may want to call $this->count_STS_in_queue(
-     *               EEM_Message::status_failed ) to see if any failed EE_Message objects.  Each failed message object
-     *               will also have a saved error message on it to assist with notifying user.
-     */
-    public function get_to_send_batch_and_send()
-    {
-        $rate_limit = $this->get_rate_limit();
-        if ($rate_limit < 1 || $this->is_locked(EE_Messages_Queue::action_sending)) {
-            return false;
-        }
-
-        $this->lock_queue(EE_Messages_Queue::action_sending);
-
-        $batch = $this->_batch_count < $rate_limit ? $this->_batch_count : $rate_limit;
-
-        $query_args = array(
-            // key 0 = where conditions
-            0          => array('STS_ID' => array('IN', EEM_Message::instance()->stati_indicating_to_send())),
-            'order_by' => $this->_get_priority_orderby(),
-            'limit'    => $batch,
-        );
-
-        $messages_to_send = EEM_Message::instance()->get_all($query_args);
-
-
-        //any to send?
-        if ( ! $messages_to_send) {
-            $this->unlock_queue(EE_Messages_Queue::action_sending);
-            return false;
-        }
-
-        $queue_count = 0;
-
-        //add to queue.
-        foreach ($messages_to_send as $message) {
-            if ($message instanceof EE_Message) {
-                $queue_count++;
-                $this->add($message);
-            }
-        }
-
-        //send messages  (this also updates the rate limit)
-        $this->execute();
-
-        //release lock
-        $this->unlock_queue(EE_Messages_Queue::action_sending);
-        //update rate limit
-        $this->set_rate_limit($queue_count);
-        return true;
-    }
-
-
-    /**
-     * Locks the queue so that no other queues can call the "batch" methods.
-     *
-     * @param   string $type The type of queue being locked.
-     */
-    public function lock_queue($type = EE_Messages_Queue::action_generating)
-    {
-        update_option($this->_get_lock_key($type), $this->_get_lock_expiry($type));
-    }
-
-
-    /**
-     * Unlocks the queue so that batch methods can be used.
-     *
-     * @param   string $type The type of queue being unlocked.
-     */
-    public function unlock_queue($type = EE_Messages_Queue::action_generating)
-    {
-        delete_option($this->_get_lock_key($type));
-    }
-
-
-    /**
-     * Retrieve the key used for the lock transient.
-     *
-     * @param string $type The type of lock.
-     * @return string
-     */
-    protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
-    {
-        return '_ee_lock_' . $type;
-    }
-
-
-    /**
-     * Retrieve the expiry time for the lock transient.
-     *
-     * @param string $type The type of lock
-     * @return int   time to expiry in seconds.
-     */
-    protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
-    {
-        return time() + (int) apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
-    }
-
-
-    /**
-     * Returns the key used for rate limit transient.
-     *
-     * @return string
-     */
-    protected function _get_rate_limit_key()
-    {
-        return '_ee_rate_limit';
-    }
-
-
-    /**
-     * Returns the rate limit expiry time.
-     *
-     * @return int
-     */
-    protected function _get_rate_limit_expiry()
-    {
-        return time() + (int) apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
-    }
-
-
-    /**
-     * Returns the default rate limit for sending messages.
-     *
-     * @return int
-     */
-    protected function _default_rate_limit()
-    {
-        return (int) apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
-    }
-
-
-    /**
-     * Return the orderby array for priority.
-     *
-     * @return array
-     */
-    protected function _get_priority_orderby()
-    {
-        return array(
-            'MSG_priority' => 'ASC',
-            'MSG_modified' => 'DESC',
-        );
-    }
-
-
-    /**
-     * Returns whether batch methods are "locked" or not.
-     *
-     * @param  string $type The type of lock being checked for.
-     * @return bool
-     */
-    public function is_locked($type = EE_Messages_Queue::action_generating)
-    {
-        $lock = (int) get_option($this->_get_lock_key($type), 0);
-        /**
-         * This filters the default is_locked behaviour.
-         */
-        $is_locked = filter_var(
-            apply_filters(
-                'FHEE__EE_Messages_Queue__is_locked',
-                $lock > time(),
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-
-        /**
-         * @see usage of this filter in EE_Messages_Queue::initiate_request_by_priority() method.
-         *            Also implemented here because messages processed on the same request should not have any locks applied.
-         */
-        if (
-            apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $is_locked = false;
-        }
-
-
-        return $is_locked;
-    }
-
-
-    /**
-     * Retrieves the rate limit that may be cached as a transient.
-     * If the rate limit is not set, then this sets the default rate limit and expiry and returns it.
-     *
-     * @param bool $return_expiry  If true then return the expiry time not the rate_limit.
-     * @return int
-     */
-    protected function get_rate_limit($return_expiry = false)
-    {
-        $stored_rate_info = get_option($this->_get_rate_limit_key(), array());
-        $rate_limit = isset($stored_rate_info[0])
-            ? (int) $stored_rate_info[0]
-            : 0;
-        $expiry = isset($stored_rate_info[1])
-            ? (int) $stored_rate_info[1]
-            : 0;
-        //set the default for tracking?
-        if (empty($stored_rate_info) || time() > $expiry) {
-            $expiry = $this->_get_rate_limit_expiry();
-            $rate_limit = $this->_default_rate_limit();
-            update_option($this->_get_rate_limit_key(), array($rate_limit, $expiry));
-        }
-        return $return_expiry ? $expiry : $rate_limit;
-    }
-
-
-    /**
-     * This updates existing rate limit with the new limit which is the old minus the batch.
-     *
-     * @param int $batch_completed This sets the new rate limit based on the given batch that was completed.
-     */
-    protected function set_rate_limit($batch_completed)
-    {
-        //first get the most up to date rate limit (in case its expired and reset)
-        $rate_limit = $this->get_rate_limit();
-        $expiry = $this->get_rate_limit(true);
-        $new_limit  = $rate_limit - $batch_completed;
-        //updating the transient option directly to avoid resetting the expiry.
-
-        update_option($this->_get_rate_limit_key(), array($new_limit, $expiry));
-    }
-
-
-    /**
-     * This method checks the queue for ANY EE_Message objects with a priority matching the given priority passed in.
-     * If that exists, then we immediately initiate a non-blocking request to do the requested action type.
-     * Note: Keep in mind that there is the possibility that the request will not execute if there is already another
-     * request running on a queue for the given task.
-     *
-     * @param string $task     This indicates what type of request is going to be initiated.
-     * @param int    $priority This indicates the priority that triggers initiating the request.
-     */
-    public function initiate_request_by_priority($task = 'generate', $priority = EEM_Message::priority_high)
-    {
-        //determine what status is matched with the priority as part of the trigger conditions.
-        $status = $task == 'generate'
-            ? EEM_Message::status_incomplete
-            : EEM_Message::instance()->stati_indicating_to_send();
-        // always make sure we save because either this will get executed immediately on a separate request
-        // or remains in the queue for the regularly scheduled queue batch.
-        $this->save();
-        /**
-         * This filter/option allows users to override processing of messages on separate requests and instead have everything
-         * happen on the same request.  If this is utilized remember:
-         * - message priorities don't matter
-         * - existing unprocessed messages in the queue will not get processed unless manually triggered.
-         * - things will be perceived to take longer to happen for end users (i.e. registrations) because of the additional
-         *   processing happening on the same request.
-         * - any race condition protection (locks) are removed because they don't apply when things are processed on
-         *   the same request.
-         */
-        if (
-            apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $messages_processor = EE_Registry::instance()->load_lib('Messages_Processor');
-            if ($messages_processor instanceof EE_Messages_Processor) {
-                return $messages_processor->process_immediately_from_queue($this);
-            }
-            //if we get here then that means the messages processor couldn't be loaded so messages will just remain
-            //queued for manual triggering by end user.
-        }
-
-        if ($this->_message_repository->count_by_priority_and_status($priority, $status)) {
-            EE_Messages_Scheduler::initiate_scheduled_non_blocking_request($task);
-        }
-    }
-
-
-    /**
-     *  Loops through the EE_Message objects in the _queue and calls the messenger send methods for each message.
-     *
-     * @param   bool     $save                    Used to indicate whether to save the message queue after sending
-     *                                            (default will save).
-     * @param   mixed    $sending_messenger       (optional) When the sending messenger is different than
-     *                                            what is on the EE_Message object in the queue.
-     *                                            For instance, showing the browser view of an email message,
-     *                                            or giving a pdf generated view of an html document.
-     *                                            This should be an instance of EE_messenger but if you call this
-     *                                            method
-     *                                            intending it to be a sending messenger but a valid one could not be
-     *                                            retrieved then send in an instance of EE_Error that contains the
-     *                                            related error message.
-     * @param   bool|int $by_priority             When set, this indicates that only messages
-     *                                            matching the given priority should be executed.
-     * @return int        Number of messages sent.  Note, 0 does not mean that no messages were processed.
-     *                                            Also, if the messenger is an request type messenger (or a preview),
-     *                                            its entirely possible that the messenger will exit before
-     */
-    public function execute($save = true, $sending_messenger = null, $by_priority = false)
-    {
-        $messages_sent   = 0;
-        $this->_did_hook = array();
-        $this->_message_repository->rewind();
-
-        while ($this->_message_repository->valid()) {
-            $error_messages = array();
-            /** @type EE_Message $message */
-            $message = $this->_message_repository->current();
-            //only process things that are queued for sending
-            if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
-                $this->_message_repository->next();
-                continue;
-            }
-            //if $by_priority is set and does not match then continue;
-            if ($by_priority && $by_priority != $message->priority()) {
-                $this->_message_repository->next();
-                continue;
-            }
-            //error checking
-            if (! $message->valid_messenger()) {
-                $error_messages[] = sprintf(
-                    __('The %s messenger is not active at time of sending.', 'event_espresso'),
-                    $message->messenger()
-                );
-            }
-            if (! $message->valid_message_type()) {
-                $error_messages[] = sprintf(
-                    __('The %s message type is not active at the time of sending.', 'event_espresso'),
-                    $message->message_type()
-                );
-            }
-            // if there was supposed to be a sending messenger for this message, but it was invalid/inactive,
-            // then it will instead be an EE_Error object, so let's check for that
-            if ($sending_messenger instanceof EE_Error) {
-                $error_messages[] = $sending_messenger->getMessage();
-            }
-            // if there are no errors, then let's process the message
-            if (empty($error_messages)) {
-                if ($save) {
-                    $message->set_messenger_is_executing();
-                }
-                if ($this->_process_message($message, $sending_messenger)) {
-                    $messages_sent++;
-                }
-            }
-            $this->_set_error_message($message, $error_messages);
-            //add modified time
-            $message->set_modified(time());
-            //we save each message after its processed to make sure its status persists in case PHP times-out or runs
-            //out of memory. @see https://events.codebasehq.com/projects/event-espresso/tickets/10281
-            if ($save) {
-                $message->save();
-            }
-
-            $this->_message_repository->next();
-        }
-        if ($save) {
-            $this->save(true);
-        }
-        return $messages_sent;
-    }
-
-
-    /**
-     * _process_message
-     *
-     * @param EE_Message $message
-     * @param mixed      $sending_messenger (optional)
-     * @return bool
-     */
-    protected function _process_message(EE_Message $message, $sending_messenger = null)
-    {
-        // these *should* have been validated in the execute() method above
-        $messenger    = $message->messenger_object();
-        $message_type = $message->message_type_object();
-        //do actions for sending messenger if it differs from generating messenger and swap values.
-        if (
-            $sending_messenger instanceof EE_messenger
-            && $messenger instanceof EE_messenger
-            && $sending_messenger->name != $messenger->name
-        ) {
-            $messenger->do_secondary_messenger_hooks($sending_messenger->name);
-            $messenger = $sending_messenger;
-        }
-        // send using messenger, but double check objects
-        if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
-            //set hook for message type (but only if not using another messenger to send).
-            if ( ! isset($this->_did_hook[$message_type->name])) {
-                $message_type->do_messenger_hooks($messenger);
-                $this->_did_hook[$message_type->name] = 1;
-            }
-            //if preview then use preview method
-            return $this->_message_repository->is_preview()
-                ? $this->_do_preview($message, $messenger, $message_type, $this->_message_repository->is_test_send())
-                : $this->_do_send($message, $messenger, $message_type);
-        }
-        return false;
-    }
-
-
-    /**
-     * The intention of this method is to count how many EE_Message objects
-     * are in the queue with a given status.
-     * Example usage:
-     * After a caller calls the "EE_Message_Queue::execute()" method, the caller can check if there were any failed
-     * sends by calling $queue->count_STS_in_queue( EEM_Message_Queue::status_failed ).
-     *
-     * @param array|string $status Stati to check for in queue
-     * @return int  Count of EE_Message's matching the given status.
-     */
-    public function count_STS_in_queue($status)
-    {
-        $count  = 0;
-        $status = is_array($status) ? $status : array($status);
-        $this->_message_repository->rewind();
-        foreach ($this->_message_repository as $message) {
-            if (in_array($message->STS_ID(), $status)) {
-                $count++;
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * Executes the get_preview method on the provided messenger.
-     *
-     * @param EE_Message      $message
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @param                 $test_send
-     * @return bool   true means all went well, false means, not so much.
-     */
-    protected function _do_preview(
-        EE_Message $message,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $test_send
-    ) {
-        if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
-            if ( ! $test_send) {
-                $message->set_content($preview);
-            }
-            $message->set_STS_ID(EEM_Message::status_sent);
-            return true;
-        } else {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            return false;
-        }
-    }
-
-
-    /**
-     * Executes the send method on the provided messenger
-     * EE_Messengers are expected to:
-     * - return true if the send was successful.
-     * - return false if the send was unsuccessful but can be tried again.
-     * - throw an Exception if the send was unsuccessful and cannot be tried again.
-     *
-     * @param EE_Message      $message
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @return bool true means all went well, false means, not so much.
-     */
-    protected function _do_send(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type)
-    {
-        try {
-            if ($messenger->send_message($message, $message_type)) {
-                $message->set_STS_ID(EEM_Message::status_sent);
-                return true;
-            } else {
-                $message->set_STS_ID(EEM_Message::status_retry);
-                return false;
-            }
-        } catch (SendMessageException $e) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message($e->getMessage());
-            return false;
-        }
-    }
-
-
-    /**
-     * This sets any necessary error messages on the message object and its status to failed.
-     *
-     * @param EE_Message $message
-     * @param array      $error_messages the response from the messenger.
-     */
-    protected function _set_error_message(EE_Message $message, $error_messages)
-    {
-        $error_messages = (array)$error_messages;
-        if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
-            $notices          = EE_Error::has_notices();
-            $error_messages[] = __(
-                'Messenger and Message Type were valid and active, but the messenger send method failed.',
-                'event_espresso'
-            );
-            if ($notices === 1) {
-                $notices           = EE_Error::get_vanilla_notices();
-                $notices['errors'] = isset($notices['errors']) ? $notices['errors'] : array();
-                $error_messages[]  = implode("\n", $notices['errors']);
-            }
-        }
-        if (count($error_messages) > 0) {
-            $msg = __('Message was not executed successfully.', 'event_espresso');
-            $msg = $msg . "\n" . implode("\n", $error_messages);
-            $message->set_error_message($msg);
-        }
-    }
+	/**
+	 * @type    string  reference for sending action
+	 */
+	const action_sending = 'sending';
+
+	/**
+	 * @type    string  reference for generation action
+	 */
+	const action_generating = 'generation';
+
+
+	/**
+	 * @type EE_Message_Repository $_message_repository
+	 */
+	protected $_message_repository;
+
+	/**
+	 * Sets the limit of how many messages are generated per process.
+	 *
+	 * @type int
+	 */
+	protected $_batch_count;
+
+
+	/**
+	 * This is an array of cached queue items being stored in this object.
+	 * The array keys will be the ID of the EE_Message in the db if saved.  If the EE_Message
+	 * is not saved to the db then its key will be an increment of "UNS" (i.e. UNS1, UNS2 etc.)
+	 *
+	 * @type EE_Message[]
+	 */
+	protected $_cached_queue_items;
+
+	/**
+	 * Tracks the number of unsaved queue items.
+	 *
+	 * @type int
+	 */
+	protected $_unsaved_count = 0;
+
+	/**
+	 * used to record if a do_messenger_hooks has already been called for a message type.  This prevents multiple
+	 * hooks getting fired if users have setup their action/filter hooks to prevent duplicate calls.
+	 *
+	 * @type array
+	 */
+	protected $_did_hook = array();
+
+
+	/**
+	 * Constructor.
+	 * Setup all the initial properties and load a EE_Message_Repository.
+	 *
+	 * @param \EE_Message_Repository $message_repository
+	 */
+	public function __construct(EE_Message_Repository $message_repository)
+	{
+		$this->_batch_count        = apply_filters('FHEE__EE_Messages_Queue___batch_count', 50);
+		$this->_message_repository = $message_repository;
+	}
+
+
+	/**
+	 * Add a EE_Message object to the queue
+	 *
+	 * @param EE_Message $message
+	 * @param array      $data         This will be an array of data to attach to the object in the repository.  If the
+	 *                                 object is persisted, this data will be saved on an extra_meta object related to
+	 *                                 EE_Message.
+	 * @param  bool      $preview      Whether this EE_Message represents a preview or not.
+	 * @param  bool      $test_send    This indicates whether to do a test send instead of actual send. A test send will
+	 *                                 use the messenger send method but typically is based on preview data.
+	 * @return bool          Whether the message was successfully added to the repository or not.
+	 */
+	public function add(EE_Message $message, $data = array(), $preview = false, $test_send = false)
+	{
+		$data['preview']   = $preview;
+		$data['test_send'] = $test_send;
+		return $this->_message_repository->add($message, $data);
+	}
+
+
+	/**
+	 * Removes EE_Message from _queue that matches the given EE_Message if the pointer is on a matching EE_Message
+	 *
+	 * @param EE_Message $message The message to detach from the queue
+	 * @param bool       $persist This flag indicates whether to attempt to delete the object from the db as well.
+	 * @return bool
+	 */
+	public function remove(EE_Message $message, $persist = false)
+	{
+		if ($persist && $this->_message_repository->current() !== $message) {
+			//get pointer on right message
+			if ($this->_message_repository->has($message)) {
+				$this->_message_repository->rewind();
+				while ($this->_message_repository->valid()) {
+					if ($this->_message_repository->current() === $message) {
+						break;
+					}
+					$this->_message_repository->next();
+				}
+			} else {
+				return false;
+			}
+		}
+		return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove($message);
+	}
+
+
+	/**
+	 * Persists all queued EE_Message objects to the db.
+	 *
+	 * @param bool $do_hooks_only       @see EE_Message_Repository::saveAll
+	 * @return array @see EE_Messages_Repository::saveAll() for return values.
+	 */
+	public function save($do_hooks_only = false)
+	{
+		return $this->_message_repository->saveAll($do_hooks_only);
+	}
+
+
+	/**
+	 * @return EE_Message_Repository
+	 */
+	public function get_message_repository()
+	{
+		return $this->_message_repository;
+	}
+
+
+	/**
+	 * This does the following things:
+	 * 1. Checks if there is a lock on generation (prevents race conditions).  If there is a lock then exits (return
+	 * false).
+	 * 2. If no lock, sets lock, then retrieves a batch of non-generated EE_Message objects and adds to queue
+	 * 3. Returns bool.  True = batch ready.  False = no batch ready (or nothing available for generation).
+	 * Note: Callers should make sure they release the lock otherwise batch generation will be prevented from
+	 * continuing. The lock is on a transient that is set to expire after one hour as a fallback in case locks are not
+	 * removed.
+	 *
+	 * @return bool  true if successfully retrieved batch, false no batch ready.
+	 */
+	public function get_batch_to_generate()
+	{
+		if ($this->is_locked(EE_Messages_Queue::action_generating)) {
+			return false;
+		}
+
+		//lock batch generation to prevent race conditions.
+		$this->lock_queue(EE_Messages_Queue::action_generating);
+
+		$query_args = array(
+			// key 0 = where conditions
+			0          => array('STS_ID' => EEM_Message::status_incomplete),
+			'order_by' => $this->_get_priority_orderby(),
+			'limit'    => $this->_batch_count,
+		);
+		$messages   = EEM_Message::instance()->get_all($query_args);
+
+		if ( ! $messages) {
+			return false; //nothing to generate
+		}
+
+		foreach ($messages as $message) {
+			if ($message instanceof EE_Message) {
+				$data = $message->all_extra_meta_array();
+				$this->add($message, $data);
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This does the following things:
+	 * 1. Checks if there is a lock on sending (prevents race conditions).  If there is a lock then exits (return
+	 * false).
+	 * 2. Grabs the allowed number of messages to send for the rate_limit.  If cannot send any more messages, then
+	 * return false.
+	 * 2. If no lock, sets lock, then retrieves a batch of EE_Message objects, adds to queue and triggers execution.
+	 * 3. On success or unsuccessful send, sets status appropriately.
+	 * 4. Saves messages via the queue
+	 * 5. Releases lock.
+	 *
+	 * @return bool  true on success, false if something preventing sending (i.e. lock set).  Note: true does not
+	 *               necessarily mean that all messages were successfully sent.  It just means that this method
+	 *               successfully completed. On true, client may want to call $this->count_STS_in_queue(
+	 *               EEM_Message::status_failed ) to see if any failed EE_Message objects.  Each failed message object
+	 *               will also have a saved error message on it to assist with notifying user.
+	 */
+	public function get_to_send_batch_and_send()
+	{
+		$rate_limit = $this->get_rate_limit();
+		if ($rate_limit < 1 || $this->is_locked(EE_Messages_Queue::action_sending)) {
+			return false;
+		}
+
+		$this->lock_queue(EE_Messages_Queue::action_sending);
+
+		$batch = $this->_batch_count < $rate_limit ? $this->_batch_count : $rate_limit;
+
+		$query_args = array(
+			// key 0 = where conditions
+			0          => array('STS_ID' => array('IN', EEM_Message::instance()->stati_indicating_to_send())),
+			'order_by' => $this->_get_priority_orderby(),
+			'limit'    => $batch,
+		);
+
+		$messages_to_send = EEM_Message::instance()->get_all($query_args);
+
+
+		//any to send?
+		if ( ! $messages_to_send) {
+			$this->unlock_queue(EE_Messages_Queue::action_sending);
+			return false;
+		}
+
+		$queue_count = 0;
+
+		//add to queue.
+		foreach ($messages_to_send as $message) {
+			if ($message instanceof EE_Message) {
+				$queue_count++;
+				$this->add($message);
+			}
+		}
+
+		//send messages  (this also updates the rate limit)
+		$this->execute();
+
+		//release lock
+		$this->unlock_queue(EE_Messages_Queue::action_sending);
+		//update rate limit
+		$this->set_rate_limit($queue_count);
+		return true;
+	}
+
+
+	/**
+	 * Locks the queue so that no other queues can call the "batch" methods.
+	 *
+	 * @param   string $type The type of queue being locked.
+	 */
+	public function lock_queue($type = EE_Messages_Queue::action_generating)
+	{
+		update_option($this->_get_lock_key($type), $this->_get_lock_expiry($type));
+	}
+
+
+	/**
+	 * Unlocks the queue so that batch methods can be used.
+	 *
+	 * @param   string $type The type of queue being unlocked.
+	 */
+	public function unlock_queue($type = EE_Messages_Queue::action_generating)
+	{
+		delete_option($this->_get_lock_key($type));
+	}
+
+
+	/**
+	 * Retrieve the key used for the lock transient.
+	 *
+	 * @param string $type The type of lock.
+	 * @return string
+	 */
+	protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
+	{
+		return '_ee_lock_' . $type;
+	}
+
+
+	/**
+	 * Retrieve the expiry time for the lock transient.
+	 *
+	 * @param string $type The type of lock
+	 * @return int   time to expiry in seconds.
+	 */
+	protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
+	{
+		return time() + (int) apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
+	}
+
+
+	/**
+	 * Returns the key used for rate limit transient.
+	 *
+	 * @return string
+	 */
+	protected function _get_rate_limit_key()
+	{
+		return '_ee_rate_limit';
+	}
+
+
+	/**
+	 * Returns the rate limit expiry time.
+	 *
+	 * @return int
+	 */
+	protected function _get_rate_limit_expiry()
+	{
+		return time() + (int) apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
+	}
+
+
+	/**
+	 * Returns the default rate limit for sending messages.
+	 *
+	 * @return int
+	 */
+	protected function _default_rate_limit()
+	{
+		return (int) apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
+	}
+
+
+	/**
+	 * Return the orderby array for priority.
+	 *
+	 * @return array
+	 */
+	protected function _get_priority_orderby()
+	{
+		return array(
+			'MSG_priority' => 'ASC',
+			'MSG_modified' => 'DESC',
+		);
+	}
+
+
+	/**
+	 * Returns whether batch methods are "locked" or not.
+	 *
+	 * @param  string $type The type of lock being checked for.
+	 * @return bool
+	 */
+	public function is_locked($type = EE_Messages_Queue::action_generating)
+	{
+		$lock = (int) get_option($this->_get_lock_key($type), 0);
+		/**
+		 * This filters the default is_locked behaviour.
+		 */
+		$is_locked = filter_var(
+			apply_filters(
+				'FHEE__EE_Messages_Queue__is_locked',
+				$lock > time(),
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+
+		/**
+		 * @see usage of this filter in EE_Messages_Queue::initiate_request_by_priority() method.
+		 *            Also implemented here because messages processed on the same request should not have any locks applied.
+		 */
+		if (
+			apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$is_locked = false;
+		}
+
+
+		return $is_locked;
+	}
+
+
+	/**
+	 * Retrieves the rate limit that may be cached as a transient.
+	 * If the rate limit is not set, then this sets the default rate limit and expiry and returns it.
+	 *
+	 * @param bool $return_expiry  If true then return the expiry time not the rate_limit.
+	 * @return int
+	 */
+	protected function get_rate_limit($return_expiry = false)
+	{
+		$stored_rate_info = get_option($this->_get_rate_limit_key(), array());
+		$rate_limit = isset($stored_rate_info[0])
+			? (int) $stored_rate_info[0]
+			: 0;
+		$expiry = isset($stored_rate_info[1])
+			? (int) $stored_rate_info[1]
+			: 0;
+		//set the default for tracking?
+		if (empty($stored_rate_info) || time() > $expiry) {
+			$expiry = $this->_get_rate_limit_expiry();
+			$rate_limit = $this->_default_rate_limit();
+			update_option($this->_get_rate_limit_key(), array($rate_limit, $expiry));
+		}
+		return $return_expiry ? $expiry : $rate_limit;
+	}
+
+
+	/**
+	 * This updates existing rate limit with the new limit which is the old minus the batch.
+	 *
+	 * @param int $batch_completed This sets the new rate limit based on the given batch that was completed.
+	 */
+	protected function set_rate_limit($batch_completed)
+	{
+		//first get the most up to date rate limit (in case its expired and reset)
+		$rate_limit = $this->get_rate_limit();
+		$expiry = $this->get_rate_limit(true);
+		$new_limit  = $rate_limit - $batch_completed;
+		//updating the transient option directly to avoid resetting the expiry.
+
+		update_option($this->_get_rate_limit_key(), array($new_limit, $expiry));
+	}
+
+
+	/**
+	 * This method checks the queue for ANY EE_Message objects with a priority matching the given priority passed in.
+	 * If that exists, then we immediately initiate a non-blocking request to do the requested action type.
+	 * Note: Keep in mind that there is the possibility that the request will not execute if there is already another
+	 * request running on a queue for the given task.
+	 *
+	 * @param string $task     This indicates what type of request is going to be initiated.
+	 * @param int    $priority This indicates the priority that triggers initiating the request.
+	 */
+	public function initiate_request_by_priority($task = 'generate', $priority = EEM_Message::priority_high)
+	{
+		//determine what status is matched with the priority as part of the trigger conditions.
+		$status = $task == 'generate'
+			? EEM_Message::status_incomplete
+			: EEM_Message::instance()->stati_indicating_to_send();
+		// always make sure we save because either this will get executed immediately on a separate request
+		// or remains in the queue for the regularly scheduled queue batch.
+		$this->save();
+		/**
+		 * This filter/option allows users to override processing of messages on separate requests and instead have everything
+		 * happen on the same request.  If this is utilized remember:
+		 * - message priorities don't matter
+		 * - existing unprocessed messages in the queue will not get processed unless manually triggered.
+		 * - things will be perceived to take longer to happen for end users (i.e. registrations) because of the additional
+		 *   processing happening on the same request.
+		 * - any race condition protection (locks) are removed because they don't apply when things are processed on
+		 *   the same request.
+		 */
+		if (
+			apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$messages_processor = EE_Registry::instance()->load_lib('Messages_Processor');
+			if ($messages_processor instanceof EE_Messages_Processor) {
+				return $messages_processor->process_immediately_from_queue($this);
+			}
+			//if we get here then that means the messages processor couldn't be loaded so messages will just remain
+			//queued for manual triggering by end user.
+		}
+
+		if ($this->_message_repository->count_by_priority_and_status($priority, $status)) {
+			EE_Messages_Scheduler::initiate_scheduled_non_blocking_request($task);
+		}
+	}
+
+
+	/**
+	 *  Loops through the EE_Message objects in the _queue and calls the messenger send methods for each message.
+	 *
+	 * @param   bool     $save                    Used to indicate whether to save the message queue after sending
+	 *                                            (default will save).
+	 * @param   mixed    $sending_messenger       (optional) When the sending messenger is different than
+	 *                                            what is on the EE_Message object in the queue.
+	 *                                            For instance, showing the browser view of an email message,
+	 *                                            or giving a pdf generated view of an html document.
+	 *                                            This should be an instance of EE_messenger but if you call this
+	 *                                            method
+	 *                                            intending it to be a sending messenger but a valid one could not be
+	 *                                            retrieved then send in an instance of EE_Error that contains the
+	 *                                            related error message.
+	 * @param   bool|int $by_priority             When set, this indicates that only messages
+	 *                                            matching the given priority should be executed.
+	 * @return int        Number of messages sent.  Note, 0 does not mean that no messages were processed.
+	 *                                            Also, if the messenger is an request type messenger (or a preview),
+	 *                                            its entirely possible that the messenger will exit before
+	 */
+	public function execute($save = true, $sending_messenger = null, $by_priority = false)
+	{
+		$messages_sent   = 0;
+		$this->_did_hook = array();
+		$this->_message_repository->rewind();
+
+		while ($this->_message_repository->valid()) {
+			$error_messages = array();
+			/** @type EE_Message $message */
+			$message = $this->_message_repository->current();
+			//only process things that are queued for sending
+			if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+				$this->_message_repository->next();
+				continue;
+			}
+			//if $by_priority is set and does not match then continue;
+			if ($by_priority && $by_priority != $message->priority()) {
+				$this->_message_repository->next();
+				continue;
+			}
+			//error checking
+			if (! $message->valid_messenger()) {
+				$error_messages[] = sprintf(
+					__('The %s messenger is not active at time of sending.', 'event_espresso'),
+					$message->messenger()
+				);
+			}
+			if (! $message->valid_message_type()) {
+				$error_messages[] = sprintf(
+					__('The %s message type is not active at the time of sending.', 'event_espresso'),
+					$message->message_type()
+				);
+			}
+			// if there was supposed to be a sending messenger for this message, but it was invalid/inactive,
+			// then it will instead be an EE_Error object, so let's check for that
+			if ($sending_messenger instanceof EE_Error) {
+				$error_messages[] = $sending_messenger->getMessage();
+			}
+			// if there are no errors, then let's process the message
+			if (empty($error_messages)) {
+				if ($save) {
+					$message->set_messenger_is_executing();
+				}
+				if ($this->_process_message($message, $sending_messenger)) {
+					$messages_sent++;
+				}
+			}
+			$this->_set_error_message($message, $error_messages);
+			//add modified time
+			$message->set_modified(time());
+			//we save each message after its processed to make sure its status persists in case PHP times-out or runs
+			//out of memory. @see https://events.codebasehq.com/projects/event-espresso/tickets/10281
+			if ($save) {
+				$message->save();
+			}
+
+			$this->_message_repository->next();
+		}
+		if ($save) {
+			$this->save(true);
+		}
+		return $messages_sent;
+	}
+
+
+	/**
+	 * _process_message
+	 *
+	 * @param EE_Message $message
+	 * @param mixed      $sending_messenger (optional)
+	 * @return bool
+	 */
+	protected function _process_message(EE_Message $message, $sending_messenger = null)
+	{
+		// these *should* have been validated in the execute() method above
+		$messenger    = $message->messenger_object();
+		$message_type = $message->message_type_object();
+		//do actions for sending messenger if it differs from generating messenger and swap values.
+		if (
+			$sending_messenger instanceof EE_messenger
+			&& $messenger instanceof EE_messenger
+			&& $sending_messenger->name != $messenger->name
+		) {
+			$messenger->do_secondary_messenger_hooks($sending_messenger->name);
+			$messenger = $sending_messenger;
+		}
+		// send using messenger, but double check objects
+		if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
+			//set hook for message type (but only if not using another messenger to send).
+			if ( ! isset($this->_did_hook[$message_type->name])) {
+				$message_type->do_messenger_hooks($messenger);
+				$this->_did_hook[$message_type->name] = 1;
+			}
+			//if preview then use preview method
+			return $this->_message_repository->is_preview()
+				? $this->_do_preview($message, $messenger, $message_type, $this->_message_repository->is_test_send())
+				: $this->_do_send($message, $messenger, $message_type);
+		}
+		return false;
+	}
+
+
+	/**
+	 * The intention of this method is to count how many EE_Message objects
+	 * are in the queue with a given status.
+	 * Example usage:
+	 * After a caller calls the "EE_Message_Queue::execute()" method, the caller can check if there were any failed
+	 * sends by calling $queue->count_STS_in_queue( EEM_Message_Queue::status_failed ).
+	 *
+	 * @param array|string $status Stati to check for in queue
+	 * @return int  Count of EE_Message's matching the given status.
+	 */
+	public function count_STS_in_queue($status)
+	{
+		$count  = 0;
+		$status = is_array($status) ? $status : array($status);
+		$this->_message_repository->rewind();
+		foreach ($this->_message_repository as $message) {
+			if (in_array($message->STS_ID(), $status)) {
+				$count++;
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Executes the get_preview method on the provided messenger.
+	 *
+	 * @param EE_Message      $message
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @param                 $test_send
+	 * @return bool   true means all went well, false means, not so much.
+	 */
+	protected function _do_preview(
+		EE_Message $message,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$test_send
+	) {
+		if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
+			if ( ! $test_send) {
+				$message->set_content($preview);
+			}
+			$message->set_STS_ID(EEM_Message::status_sent);
+			return true;
+		} else {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			return false;
+		}
+	}
+
+
+	/**
+	 * Executes the send method on the provided messenger
+	 * EE_Messengers are expected to:
+	 * - return true if the send was successful.
+	 * - return false if the send was unsuccessful but can be tried again.
+	 * - throw an Exception if the send was unsuccessful and cannot be tried again.
+	 *
+	 * @param EE_Message      $message
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @return bool true means all went well, false means, not so much.
+	 */
+	protected function _do_send(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type)
+	{
+		try {
+			if ($messenger->send_message($message, $message_type)) {
+				$message->set_STS_ID(EEM_Message::status_sent);
+				return true;
+			} else {
+				$message->set_STS_ID(EEM_Message::status_retry);
+				return false;
+			}
+		} catch (SendMessageException $e) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message($e->getMessage());
+			return false;
+		}
+	}
+
+
+	/**
+	 * This sets any necessary error messages on the message object and its status to failed.
+	 *
+	 * @param EE_Message $message
+	 * @param array      $error_messages the response from the messenger.
+	 */
+	protected function _set_error_message(EE_Message $message, $error_messages)
+	{
+		$error_messages = (array)$error_messages;
+		if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
+			$notices          = EE_Error::has_notices();
+			$error_messages[] = __(
+				'Messenger and Message Type were valid and active, but the messenger send method failed.',
+				'event_espresso'
+			);
+			if ($notices === 1) {
+				$notices           = EE_Error::get_vanilla_notices();
+				$notices['errors'] = isset($notices['errors']) ? $notices['errors'] : array();
+				$error_messages[]  = implode("\n", $notices['errors']);
+			}
+		}
+		if (count($error_messages) > 0) {
+			$msg = __('Message was not executed successfully.', 'event_espresso');
+			$msg = $msg . "\n" . implode("\n", $error_messages);
+			$message->set_error_message($msg);
+		}
+	}
 
 } //end EE_Messages_Queue class

Spacing +8 added lines, -8 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 use \EventEspresso\core\exceptions\SendMessageException;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -175,7 +175,7 @@ 
             'order_by' => $this->_get_priority_orderby(),
             'limit'    => $this->_batch_count,
         );
-        $messages   = EEM_Message::instance()->get_all($query_args);
+        $messages = EEM_Message::instance()->get_all($query_args);
 
         if ( ! $messages) {
             return false; //nothing to generate
@@ -286,7 +286,7 @@ 
      */
     protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
     {
-        return '_ee_lock_' . $type;
+        return '_ee_lock_'.$type;
     }
 
 
@@ -506,7 +506,7 @@ 
             /** @type EE_Message $message */
             $message = $this->_message_repository->current();
             //only process things that are queued for sending
-            if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+            if ( ! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
                 $this->_message_repository->next();
                 continue;
             }
@@ -516,13 +516,13 @@ 
                 continue;
             }
             //error checking
-            if (! $message->valid_messenger()) {
+            if ( ! $message->valid_messenger()) {
                 $error_messages[] = sprintf(
                     __('The %s messenger is not active at time of sending.', 'event_espresso'),
                     $message->messenger()
                 );
             }
-            if (! $message->valid_message_type()) {
+            if ( ! $message->valid_message_type()) {
                 $error_messages[] = sprintf(
                     __('The %s message type is not active at the time of sending.', 'event_espresso'),
                     $message->message_type()
@@ -687,7 +687,7 @@ 
      */
     protected function _set_error_message(EE_Message $message, $error_messages)
     {
-        $error_messages = (array)$error_messages;
+        $error_messages = (array) $error_messages;
         if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
             $notices          = EE_Error::has_notices();
             $error_messages[] = __(
@@ -702,7 +702,7 @@ 
         }
         if (count($error_messages) > 0) {
             $msg = __('Message was not executed successfully.', 'event_espresso');
-            $msg = $msg . "\n" . implode("\n", $error_messages);
+            $msg = $msg."\n".implode("\n", $error_messages);
             $message->set_error_message($msg);
         }
     }

core/db_models/EEM_Status.model.php

Spacing +3 added lines, -3 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 /**
@@ -12,7 +12,7 @@ 
  * @ version            4.0
  * ------------------------------------------------------------------------
  */
-require_once(EE_MODELS . 'EEM_Base.model.php');
+require_once(EE_MODELS.'EEM_Base.model.php');
 
 /**
  * Class EEM_Status
@@ -49,7 +49,7 @@ 
                     false,
                     'event',
                     array(
-                        'event'        => __("Event", "event_espresso"),//deprecated
+                        'event'        => __("Event", "event_espresso"), //deprecated
                         'registration' => __("Registration", "event_espresso"),
                         'transaction'  => __("Transaction", "event_espresso"),
                         'payment'      => __("Payment", "event_espresso"),

Indentation +275 added lines, -275 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -25,291 +25,291 @@ 
 class EEM_Status extends EEM_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @return EEM_Status
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item    = __('Status', 'event_espresso');
-        $this->plural_item      = __('Stati', 'event_espresso');
-        $this->_tables          = array(
-            'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
-        );
-        $this->_fields          = array(
-            'StatusTable' => array(
-                'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', __('Status ID', 'event_espresso')),
-                'STS_code'     => new EE_Plain_Text_Field('STS_code', __('Status Code', 'event_espresso'), false, ''),
-                'STS_type'     => new EE_Enum_Text_Field(
-                    'STS_type',
-                    __("Type", "event_espresso"),
-                    false,
-                    'event',
-                    array(
-                        'event'        => __("Event", "event_espresso"),//deprecated
-                        'registration' => __("Registration", "event_espresso"),
-                        'transaction'  => __("Transaction", "event_espresso"),
-                        'payment'      => __("Payment", "event_espresso"),
-                        'email'        => __("Email", "event_espresso"),
-                        'message'      => __("Message", "event_espresso"),
-                    )),
-                'STS_can_edit' => new EE_Boolean_Field('STS_can_edit', __('Editable?', 'event_espresso'), false, false),
-                'STS_desc'     => new EE_Simple_HTML_Field('STS_desc', __("Description", "event_espresso"), false, ''),
-                'STS_open'     => new EE_Boolean_Field('STS_open', __("Open?", "event_espresso"), false, false),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration' => new EE_Has_Many_Relation(),
-            'Transaction'  => new EE_Has_Many_Relation(),
-            'Payment'      => new EE_Has_Many_Relation(),
-        );
-        //this model is generally available for reading
-        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
+	/**
+	 * @return EEM_Status
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item    = __('Status', 'event_espresso');
+		$this->plural_item      = __('Stati', 'event_espresso');
+		$this->_tables          = array(
+			'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
+		);
+		$this->_fields          = array(
+			'StatusTable' => array(
+				'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', __('Status ID', 'event_espresso')),
+				'STS_code'     => new EE_Plain_Text_Field('STS_code', __('Status Code', 'event_espresso'), false, ''),
+				'STS_type'     => new EE_Enum_Text_Field(
+					'STS_type',
+					__("Type", "event_espresso"),
+					false,
+					'event',
+					array(
+						'event'        => __("Event", "event_espresso"),//deprecated
+						'registration' => __("Registration", "event_espresso"),
+						'transaction'  => __("Transaction", "event_espresso"),
+						'payment'      => __("Payment", "event_espresso"),
+						'email'        => __("Email", "event_espresso"),
+						'message'      => __("Message", "event_espresso"),
+					)),
+				'STS_can_edit' => new EE_Boolean_Field('STS_can_edit', __('Editable?', 'event_espresso'), false, false),
+				'STS_desc'     => new EE_Simple_HTML_Field('STS_desc', __("Description", "event_espresso"), false, ''),
+				'STS_open'     => new EE_Boolean_Field('STS_open', __("Open?", "event_espresso"), false, false),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration' => new EE_Has_Many_Relation(),
+			'Transaction'  => new EE_Has_Many_Relation(),
+			'Payment'      => new EE_Has_Many_Relation(),
+		);
+		//this model is generally available for reading
+		$this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * This method provides the localized singular or plural string for a given status id
-     *
-     * @param  array   $statuses This should be an array of statuses in the format array( $status_id, $status_code ).
-     *                           That way if there isn't a translation in the index we'll return the default code.
-     * @param  boolean $plural   Whether to return plural string or not. Note, nearly all of the plural strings are the
-     *                           same as the singular (in English), however, this may NOT be the case with other
-     *                           languages
-     * @param  string  $schema   This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
-     *                           the status string returned ( UPPER, lower, Sentence)
-     * @throws EE_Error
-     * @return array             an array of translated strings for the incoming status id.
-     */
-    public function localized_status($statuses, $plural = false, $schema = 'upper')
-    {
-        //note these are all in lower case because ucwords() on upper case will NOT convert.
-        $translation_array = array(
-            EEM_Registration::status_id_pending_payment => array(
-                __('pending payment', 'event_espresso'), //singular
-                __('pending payments', 'event_espresso') //plural
-            ),
-            EEM_Registration::status_id_approved        => array(
-                __('approved', 'event_espresso'), //singular
-                __('approved', 'event_espresso') //plural
-            ),
-            EEM_Registration::status_id_not_approved    => array(
-                __('not approved', 'event_espresso'),
-                __('not approved', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_cancelled       => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_incomplete      => array(
-                __('incomplete', 'event_espresso'),
-                __('incomplete', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_declined        => array(
-                __('declined', 'event_espresso'),
-                __('declined', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_wait_list       => array(
-                __('wait list', 'event_espresso'),
-                __('wait list', 'event_espresso'),
-            ),
-            EEM_Transaction::overpaid_status_code       => array(
-                __('overpaid', 'event_espresso'),
-                __('overpaid', 'event_espresso'),
-            ),
-            EEM_Transaction::complete_status_code       => array(
-                __('complete', 'event_espresso'),
-                __('complete', 'event_espresso'),
-            ),
-            EEM_Transaction::incomplete_status_code     => array(
-                __('incomplete', 'event_espresso'),
-                __('incomplete', 'event_espresso'),
-            ),
-            EEM_Transaction::failed_status_code         => array(
-                __('failed', 'event_espresso'),
-                __('failed', 'event_espresso'),
-            ),
-            EEM_Transaction::abandoned_status_code      => array(
-                __('abandoned', 'event_espresso'),
-                __('abandoned', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_approved             => array(
-                __('accepted', 'event_espresso'),
-                __('accepted', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_pending              => array(
-                __('pending', 'event_espresso'),
-                __('pending', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_cancelled            => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_declined             => array(
-                __('declined', 'event_espresso'),
-                __('declined', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_failed               => array(
-                __('failed', 'event_espresso'),
-                __('failed', 'event_espresso'),
-            ),
-            //following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
-            EEM_Event::sold_out                         => array(
-                __('sold out', 'event_espresso'),
-                __('sold out', 'event_espresso'),
-            ),
-            EEM_Event::postponed                        => array(
-                __('postponed', 'event_espresso'),
-                __('Postponed', 'event_espresso'),
-            ),
-            EEM_Event::cancelled                        => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EE_Ticket::archived                         => array(
-                __('archived', 'event_espresso'),
-                __('archived', 'event_espresso'),
-            ),
-            EE_Ticket::expired                          => array(
-                __('expired', 'event_espresso'),
-                __('expired', 'event_espresso'),
-            ),
-            EE_Ticket::sold_out                         => array(
-                __('sold out', 'event_espresso'),
-                __('sold out', 'event_espresso'),
-            ),
-            EE_Ticket::pending                          => array(
-                __('upcoming', 'event_espresso'),
-                __('upcoming', 'event_espresso'),
-            ),
-            EE_Ticket::onsale                           => array(
-                __('on sale', 'event_espresso'),
-                __('on sale', 'event_espresso'),
-            ),
-            EE_Datetime::cancelled                      => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EE_Datetime::sold_out                       => array(
-                __('sold out', 'event_espresso'),
-                __('sold out', 'event_espresso'),
-            ),
-            EE_Datetime::expired                        => array(
-                __('expired', 'event_espresso'),
-                __('expired', 'event_espresso'),
-            ),
-            EE_Datetime::inactive                       => array(
-                __('inactive', 'event_espresso'),
-                __('inactive', 'event_espresso'),
-            ),
-            EE_Datetime::upcoming                       => array(
-                __('upcoming', 'event_espresso'),
-                __('upcoming', 'event_espresso'),
-            ),
-            EE_Datetime::active                         => array(
-                __('active', 'event_espresso'),
-                __('active', 'event_espresso'),
-            ),
-            EE_Datetime::postponed                      => array(
-                __('postponed', 'event_espresso'),
-                __('postponed', 'event_espresso'),
-            ),
-            //messages related
-            EEM_Message::status_sent                    => array(
-                __('sent', 'event_espresso'),
-                __('sent', 'event_espresso'),
-            ),
-            EEM_Message::status_idle                    => array(
-                __('queued for sending', 'event_espresso'),
-                __('queued for sending', 'event_espresso'),
-            ),
-            EEM_Message::status_failed                  => array(
-                __('failed', 'event_espresso'),
-                __('failed', 'event_espresso'),
-            ),
-            EEM_Message::status_debug_only              => array(
-                __('debug only', 'event_espresso'),
-                __('debug only', 'event_espresso'),
-            ),
-            EEM_Message::status_messenger_executing     => array(
-                __('messenger is executing', 'event_espresso'),
-                __('messenger is executing', 'event_espresso'),
-            ),
-            EEM_Message::status_resend                  => array(
-                __('queued for resending', 'event_espresso'),
-                __('queued for resending', 'event_espresso'),
-            ),
-            EEM_Message::status_incomplete              => array(
-                __('queued for generating', 'event_espresso'),
-                __('queued for generating', 'event_espresso'),
-            ),
-            EEM_Message::status_retry                   => array(
-                __('failed sending, can be retried', 'event_espresso'),
-                __('failed sending, can be retried', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_publish           => array(
-                __('published', 'event_espresso'),
-                __('published', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_future            => array(
-                __('scheduled', 'event_espresso'),
-                __('scheduled', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_draft             => array(
-                __('draft', 'event_espresso'),
-                __('draft', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_pending           => array(
-                __('pending', 'event_espresso'),
-                __('pending', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_private           => array(
-                __('private', 'event_espresso'),
-                __('private', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_trashed           => array(
-                __('trashed', 'event_espresso'),
-                __('trashed', 'event_espresso'),
-            ),
-        );
+	/**
+	 * This method provides the localized singular or plural string for a given status id
+	 *
+	 * @param  array   $statuses This should be an array of statuses in the format array( $status_id, $status_code ).
+	 *                           That way if there isn't a translation in the index we'll return the default code.
+	 * @param  boolean $plural   Whether to return plural string or not. Note, nearly all of the plural strings are the
+	 *                           same as the singular (in English), however, this may NOT be the case with other
+	 *                           languages
+	 * @param  string  $schema   This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
+	 *                           the status string returned ( UPPER, lower, Sentence)
+	 * @throws EE_Error
+	 * @return array             an array of translated strings for the incoming status id.
+	 */
+	public function localized_status($statuses, $plural = false, $schema = 'upper')
+	{
+		//note these are all in lower case because ucwords() on upper case will NOT convert.
+		$translation_array = array(
+			EEM_Registration::status_id_pending_payment => array(
+				__('pending payment', 'event_espresso'), //singular
+				__('pending payments', 'event_espresso') //plural
+			),
+			EEM_Registration::status_id_approved        => array(
+				__('approved', 'event_espresso'), //singular
+				__('approved', 'event_espresso') //plural
+			),
+			EEM_Registration::status_id_not_approved    => array(
+				__('not approved', 'event_espresso'),
+				__('not approved', 'event_espresso'),
+			),
+			EEM_Registration::status_id_cancelled       => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EEM_Registration::status_id_incomplete      => array(
+				__('incomplete', 'event_espresso'),
+				__('incomplete', 'event_espresso'),
+			),
+			EEM_Registration::status_id_declined        => array(
+				__('declined', 'event_espresso'),
+				__('declined', 'event_espresso'),
+			),
+			EEM_Registration::status_id_wait_list       => array(
+				__('wait list', 'event_espresso'),
+				__('wait list', 'event_espresso'),
+			),
+			EEM_Transaction::overpaid_status_code       => array(
+				__('overpaid', 'event_espresso'),
+				__('overpaid', 'event_espresso'),
+			),
+			EEM_Transaction::complete_status_code       => array(
+				__('complete', 'event_espresso'),
+				__('complete', 'event_espresso'),
+			),
+			EEM_Transaction::incomplete_status_code     => array(
+				__('incomplete', 'event_espresso'),
+				__('incomplete', 'event_espresso'),
+			),
+			EEM_Transaction::failed_status_code         => array(
+				__('failed', 'event_espresso'),
+				__('failed', 'event_espresso'),
+			),
+			EEM_Transaction::abandoned_status_code      => array(
+				__('abandoned', 'event_espresso'),
+				__('abandoned', 'event_espresso'),
+			),
+			EEM_Payment::status_id_approved             => array(
+				__('accepted', 'event_espresso'),
+				__('accepted', 'event_espresso'),
+			),
+			EEM_Payment::status_id_pending              => array(
+				__('pending', 'event_espresso'),
+				__('pending', 'event_espresso'),
+			),
+			EEM_Payment::status_id_cancelled            => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EEM_Payment::status_id_declined             => array(
+				__('declined', 'event_espresso'),
+				__('declined', 'event_espresso'),
+			),
+			EEM_Payment::status_id_failed               => array(
+				__('failed', 'event_espresso'),
+				__('failed', 'event_espresso'),
+			),
+			//following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
+			EEM_Event::sold_out                         => array(
+				__('sold out', 'event_espresso'),
+				__('sold out', 'event_espresso'),
+			),
+			EEM_Event::postponed                        => array(
+				__('postponed', 'event_espresso'),
+				__('Postponed', 'event_espresso'),
+			),
+			EEM_Event::cancelled                        => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EE_Ticket::archived                         => array(
+				__('archived', 'event_espresso'),
+				__('archived', 'event_espresso'),
+			),
+			EE_Ticket::expired                          => array(
+				__('expired', 'event_espresso'),
+				__('expired', 'event_espresso'),
+			),
+			EE_Ticket::sold_out                         => array(
+				__('sold out', 'event_espresso'),
+				__('sold out', 'event_espresso'),
+			),
+			EE_Ticket::pending                          => array(
+				__('upcoming', 'event_espresso'),
+				__('upcoming', 'event_espresso'),
+			),
+			EE_Ticket::onsale                           => array(
+				__('on sale', 'event_espresso'),
+				__('on sale', 'event_espresso'),
+			),
+			EE_Datetime::cancelled                      => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EE_Datetime::sold_out                       => array(
+				__('sold out', 'event_espresso'),
+				__('sold out', 'event_espresso'),
+			),
+			EE_Datetime::expired                        => array(
+				__('expired', 'event_espresso'),
+				__('expired', 'event_espresso'),
+			),
+			EE_Datetime::inactive                       => array(
+				__('inactive', 'event_espresso'),
+				__('inactive', 'event_espresso'),
+			),
+			EE_Datetime::upcoming                       => array(
+				__('upcoming', 'event_espresso'),
+				__('upcoming', 'event_espresso'),
+			),
+			EE_Datetime::active                         => array(
+				__('active', 'event_espresso'),
+				__('active', 'event_espresso'),
+			),
+			EE_Datetime::postponed                      => array(
+				__('postponed', 'event_espresso'),
+				__('postponed', 'event_espresso'),
+			),
+			//messages related
+			EEM_Message::status_sent                    => array(
+				__('sent', 'event_espresso'),
+				__('sent', 'event_espresso'),
+			),
+			EEM_Message::status_idle                    => array(
+				__('queued for sending', 'event_espresso'),
+				__('queued for sending', 'event_espresso'),
+			),
+			EEM_Message::status_failed                  => array(
+				__('failed', 'event_espresso'),
+				__('failed', 'event_espresso'),
+			),
+			EEM_Message::status_debug_only              => array(
+				__('debug only', 'event_espresso'),
+				__('debug only', 'event_espresso'),
+			),
+			EEM_Message::status_messenger_executing     => array(
+				__('messenger is executing', 'event_espresso'),
+				__('messenger is executing', 'event_espresso'),
+			),
+			EEM_Message::status_resend                  => array(
+				__('queued for resending', 'event_espresso'),
+				__('queued for resending', 'event_espresso'),
+			),
+			EEM_Message::status_incomplete              => array(
+				__('queued for generating', 'event_espresso'),
+				__('queued for generating', 'event_espresso'),
+			),
+			EEM_Message::status_retry                   => array(
+				__('failed sending, can be retried', 'event_espresso'),
+				__('failed sending, can be retried', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_publish           => array(
+				__('published', 'event_espresso'),
+				__('published', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_future            => array(
+				__('scheduled', 'event_espresso'),
+				__('scheduled', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_draft             => array(
+				__('draft', 'event_espresso'),
+				__('draft', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_pending           => array(
+				__('pending', 'event_espresso'),
+				__('pending', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_private           => array(
+				__('private', 'event_espresso'),
+				__('private', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_trashed           => array(
+				__('trashed', 'event_espresso'),
+				__('trashed', 'event_espresso'),
+			),
+		);
 
-        $translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
+		$translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
 
-        if ( ! is_array($statuses)) {
-            throw new EE_Error(__('The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
-                'event_espresso'));
-        }
+		if ( ! is_array($statuses)) {
+			throw new EE_Error(__('The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
+				'event_espresso'));
+		}
 
-        $translation = array();
+		$translation = array();
 
-        foreach ($statuses as $id => $code) {
-            if (isset($translation_array[$id])) {
-                $translation[$id] = $plural ? $translation_array[$id][1] : $translation_array[$id][0];
-            } else {
-                $translation[$id] = $code;
-            }
+		foreach ($statuses as $id => $code) {
+			if (isset($translation_array[$id])) {
+				$translation[$id] = $plural ? $translation_array[$id][1] : $translation_array[$id][0];
+			} else {
+				$translation[$id] = $code;
+			}
 
-            //schema
-            switch ($schema) {
-                case 'lower' :
-                    $translation[$id] = strtolower($translation[$id]); //even though these start in lower case, this will catch any statuses added via filter.
-                    break;
-                case 'sentence' :
-                    $translation[$id] = ucwords($translation[$id]);
-                    break;
-                case 'upper' :
-                    $translation[$id] = strtoupper($translation[$id]);
-                    break;
-            }
-        }
+			//schema
+			switch ($schema) {
+				case 'lower' :
+					$translation[$id] = strtolower($translation[$id]); //even though these start in lower case, this will catch any statuses added via filter.
+					break;
+				case 'sentence' :
+					$translation[$id] = ucwords($translation[$id]);
+					break;
+				case 'upper' :
+					$translation[$id] = strtoupper($translation[$id]);
+					break;
+			}
+		}
 
-        return $translation;
-    }
+		return $translation;
+	}
 
 
 }

admin_pages/messages/EE_Message_List_Table.class.php

Indentation +427 added lines, -427 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -15,430 +15,430 @@ 
 {
 
 
-    /**
-     * @return Messages_Admin_Page
-     */
-    public function get_admin_page()
-    {
-        return $this->_admin_page;
-    }
-
-
-    protected function _setup_data()
-    {
-        $this->_data           = $this->_get_messages($this->_per_page, $this->_view);
-        $this->_all_data_count = $this->_get_messages($this->_per_page, $this->_view, true);
-    }
-
-
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => __('Message', 'event_espresso'),
-            'plural'   => __('Messages', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->get_admin_page()->get_current_screen()->id,
-        );
-
-        $this->_columns = array(
-            'cb'           => '<input type="checkbox" />',
-            'to'           => __('To', 'event_espresso'),
-            'from'         => __('From', 'event_espresso'),
-            'messenger'    => __('Messenger', 'event_espresso'),
-            'message_type' => __('Message Type', 'event_espresso'),
-            'context'      => __('Context', 'event_espresso'),
-            'modified'     => __('Modified', 'event_espresso'),
-            'action'       => __('Actions', 'event_espresso'),
-            'msg_id'       => __('ID', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            'modified'     => array('MSG_modified' => true),
-            'message_type' => array('MSG_message_type' => false),
-            'messenger'    => array('MSG_messenger' => false),
-            'to'           => array('MSG_to' => false),
-            'from'         => array('MSG_from' => false),
-            'context'      => array('MSG_context' => false),
-            'msg_id'       => array('MSG_ID', false),
-        );
-
-        $this->_primary_column = 'to';
-
-        $this->_hidden_columns = array(
-            'msg_id',
-        );
-    }
-
-
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param  object $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        $class = parent::_get_row_class($item);
-        //add status class
-        $class .= ' ee-status-strip msg-status-' . $item->STS_ID();
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * _get_table_filters
-     * We use this to assemble and return any filters that are associated with this table that help further refine what
-     * get's shown in the table.
-     *
-     * @abstract
-     * @access protected
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_table_filters()
-    {
-        $filters = array();
-
-        //get select_inputs
-        $select_inputs = array(
-            $this->_get_messengers_dropdown_filter(),
-            $this->_get_message_types_dropdown_filter(),
-            $this->_get_contexts_for_message_types_dropdown_filter(),
-        );
-
-        //set filters to select inputs if they aren't empty
-        foreach ($select_inputs as $select_input) {
-            if ($select_input) {
-                $filters[] = $select_input;
-            }
-        }
-        return $filters;
-    }
-
-
-    protected function _add_view_counts()
-    {
-        foreach ($this->_views as $view => $args) {
-            $this->_views[$view]['count'] = $this->_get_messages($this->_per_page, $view, true, true);
-        }
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string   checkbox
-     * @throws \EE_Error
-     */
-    public function column_cb($message)
-    {
-        return sprintf('<input type="checkbox" name="MSG_ID[%s]" value="1" />', $message->ID());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_msg_id(EE_Message $message)
-    {
-        return $message->ID();
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string    The recipient of the message
-     * @throws \EE_Error
-     */
-    public function column_to(EE_Message $message)
-    {
-        EE_Registry::instance()->load_helper('URL');
-        $actions           = array();
-        $actions['delete'] = '<a href="'
-                             . EEH_URL::add_query_args_and_nonce(
-                array(
-                    'page'   => 'espresso_messages',
-                    'action' => 'delete_ee_message',
-                    'MSG_ID' => $message->ID(),
-                ),
-                admin_url('admin.php')
-            )
-                             . '">' . __('Delete', 'event_espresso') . '</a>';
-        return esc_html($message->to()) . $this->row_actions($actions);
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string   The sender of the message
-     */
-    public function column_from(EE_Message $message)
-    {
-        return esc_html($message->from());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string  The messenger used to send the message.
-     */
-    public function column_messenger(EE_Message $message)
-    {
-        return ucwords($message->messenger_label());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string  The message type used to generate the message.
-     */
-    public function column_message_type(EE_Message $message)
-    {
-        return ucwords($message->message_type_label());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string  The context the message was generated for.
-     */
-    public function column_context(EE_Message $message)
-    {
-        return $message->context_label();
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string    The timestamp when this message was last modified.
-     */
-    public function column_modified(EE_Message $message)
-    {
-        return $message->modified();
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string   Actions that can be done on the current message.
-     */
-    public function column_action(EE_Message $message)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $action_links = array(
-            'view'                => EEH_MSG_Template::get_message_action_link('view', $message),
-            'error'               => EEH_MSG_Template::get_message_action_link('error', $message),
-            'generate_now'        => EEH_MSG_Template::get_message_action_link('generate_now', $message),
-            'send_now'            => EEH_MSG_Template::get_message_action_link('send_now', $message),
-            'queue_for_resending' => EEH_MSG_Template::get_message_action_link('queue_for_resending', $message),
-            'view_transaction'    => EEH_MSG_Template::get_message_action_link('view_transaction', $message),
-        );
-        $content      = '';
-        switch ($message->STS_ID()) {
-            case EEM_Message::status_sent :
-                $content = $action_links['view'] . $action_links['queue_for_resending'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_resend :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_retry :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['error'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_failed :
-            case EEM_Message::status_debug_only :
-                $content = $action_links['error'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_idle :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_incomplete;
-                $content = $action_links['generate_now'] . $action_links['view_transaction'];
-                break;
-        }
-        return $content;
-    }
-
-
-    /**
-     * Retrieve the EE_Message objects for the list table.
-     *
-     * @param int    $perpage The number of items per page
-     * @param string $view    The view items are being retrieved for
-     * @param bool   $count   Whether to just return a count or not.
-     * @param bool   $all     Disregard any paging info (no limit on data returned).
-     * @return int|EE_Message[]
-     * @throws \EE_Error
-     */
-    protected function _get_messages($perpage = 10, $view = 'all', $count = false, $all = false)
-    {
-
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
-            ? $this->_req_data['paged']
-            : 1;
-
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $perpage;
-
-        $offset       = ($current_page - 1) * $per_page;
-        $limit        = $all || $count ? null : array($offset, $per_page);
-        $query_params = array(
-            'order_by' => empty($this->_req_data['orderby']) ? 'MSG_modified' : $this->_req_data['orderby'],
-            'order'    => empty($this->_req_data['order']) ? 'DESC' : $this->_req_data['order'],
-            'limit'    => $limit,
-        );
-
-        /**
-         * Any filters coming in from other routes?
-         */
-        if (isset($this->_req_data['filterby'])) {
-            $query_params = array_merge($query_params, EEM_Message::instance()->filter_by_query_params());
-            if ( ! $count) {
-                $query_params['group_by'] = 'MSG_ID';
-            }
-        }
-
-        //view conditionals
-        if ($view !== 'all' && $count && $all) {
-            $query_params[0]['AND*view_conditional'] = array(
-                'STS_ID' => strtoupper($view),
-            );
-        }
-
-        if (! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
-            $query_params[0]['AND*view_conditional'] = $this->_req_data === EEM_Message::status_failed
-                ? array(
-                    'STS_ID' => array(
-                        'IN',
-                        array(EEM_Message::status_failed, EEM_Message::status_messenger_executing)
-                    )
-                )
-                : array( 'STS_ID' => strtoupper($this->_req_data['status']) );
-        }
-
-        if (! $all && ! empty($this->_req_data['s'])) {
-            $search_string         = '%' . $this->_req_data['s'] . '%';
-            $query_params[0]['OR'] = array(
-                'MSG_to'      => array('LIKE', $search_string),
-                'MSG_from'    => array('LIKE', $search_string),
-                'MSG_subject' => array('LIKE', $search_string),
-                'MSG_content' => array('LIKE', $search_string),
-            );
-        }
-
-        //account for debug only status.  We don't show Messages with the EEM_Message::status_debug_only to clients when
-        //the messages system is in debug mode.
-        //Note: for backward compat with previous iterations, this is necessary because there may be EEM_Message::status_debug_only
-        //messages in the database.
-        if (! EEM_Message::debug()) {
-            $query_params[0]['AND*debug_only_conditional'] = array(
-                'STS_ID' => array('!=', EEM_Message::status_debug_only),
-            );
-        }
-
-        //account for filters
-        if (! $all
-            && isset($this->_req_data['ee_messenger_filter_by'])
-            && $this->_req_data['ee_messenger_filter_by'] !== 'none_selected'
-        ) {
-            $query_params[0]['AND*messenger_filter'] = array(
-                'MSG_messenger' => $this->_req_data['ee_messenger_filter_by'],
-            );
-        }
-        if (! $all
-            && ! empty($this->_req_data['ee_message_type_filter_by'])
-            && $this->_req_data['ee_message_type_filter_by'] !== 'none_selected'
-        ) {
-            $query_params[0]['AND*message_type_filter'] = array(
-                'MSG_message_type' => $this->_req_data['ee_message_type_filter_by'],
-            );
-        }
-
-        if (! $all
-            && ! empty($this->_req_data['ee_context_filter_by'])
-            && $this->_req_data['ee_context_filter_by'] !== 'none_selected'
-        ) {
-            $query_params[0]['AND*context_filter'] = array(
-                'MSG_context' => array('IN', explode(',', $this->_req_data['ee_context_filter_by'])),
-            );
-        }
-
-        return $count
-            /** @type int */
-            ? EEM_Message::instance()->count($query_params, null, true)
-            /** @type EE_Message[] */
-            : EEM_Message::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for messengers.
-     *
-     * @return string
-     */
-    protected function _get_messengers_dropdown_filter()
-    {
-        $messenger_options                    = array();
-        $active_messages_grouped_by_messenger = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
-
-        //setup array of messenger options
-        foreach ($active_messages_grouped_by_messenger as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $messenger_options[$active_message->messenger()] = ucwords($active_message->messenger_label());
-            }
-        }
-        return $this->get_admin_page()->get_messengers_select_input($messenger_options);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for message types
-     *
-     * @return string
-     */
-    protected function _get_message_types_dropdown_filter()
-    {
-        $message_type_options                    = array();
-        $active_messages_grouped_by_message_type = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
-
-        //setup array of message type options
-        foreach ($active_messages_grouped_by_message_type as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type_options[$active_message->message_type()] = ucwords($active_message->message_type_label());
-            }
-        }
-        return $this->get_admin_page()->get_message_types_select_input($message_type_options);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for message type contexts
-     *
-     * @return string
-     */
-    protected function _get_contexts_for_message_types_dropdown_filter()
-    {
-        $context_options                    = array();
-        $active_messages_grouped_by_context = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
-
-        //setup array of context options
-        foreach ($active_messages_grouped_by_context as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type = $active_message->message_type_object();
-                if ($message_type instanceof EE_message_type) {
-                    foreach ($message_type->get_contexts() as $context => $context_details) {
-                        if (isset($context_details['label'])) {
-                            $context_options[$context] = $context_details['label'];
-                        }
-                    }
-                }
-            }
-        }
-        return $this->get_admin_page()->get_contexts_for_message_types_select_input($context_options);
-    }
+	/**
+	 * @return Messages_Admin_Page
+	 */
+	public function get_admin_page()
+	{
+		return $this->_admin_page;
+	}
+
+
+	protected function _setup_data()
+	{
+		$this->_data           = $this->_get_messages($this->_per_page, $this->_view);
+		$this->_all_data_count = $this->_get_messages($this->_per_page, $this->_view, true);
+	}
+
+
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => __('Message', 'event_espresso'),
+			'plural'   => __('Messages', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->get_admin_page()->get_current_screen()->id,
+		);
+
+		$this->_columns = array(
+			'cb'           => '<input type="checkbox" />',
+			'to'           => __('To', 'event_espresso'),
+			'from'         => __('From', 'event_espresso'),
+			'messenger'    => __('Messenger', 'event_espresso'),
+			'message_type' => __('Message Type', 'event_espresso'),
+			'context'      => __('Context', 'event_espresso'),
+			'modified'     => __('Modified', 'event_espresso'),
+			'action'       => __('Actions', 'event_espresso'),
+			'msg_id'       => __('ID', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			'modified'     => array('MSG_modified' => true),
+			'message_type' => array('MSG_message_type' => false),
+			'messenger'    => array('MSG_messenger' => false),
+			'to'           => array('MSG_to' => false),
+			'from'         => array('MSG_from' => false),
+			'context'      => array('MSG_context' => false),
+			'msg_id'       => array('MSG_ID', false),
+		);
+
+		$this->_primary_column = 'to';
+
+		$this->_hidden_columns = array(
+			'msg_id',
+		);
+	}
+
+
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param  object $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		$class = parent::_get_row_class($item);
+		//add status class
+		$class .= ' ee-status-strip msg-status-' . $item->STS_ID();
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * _get_table_filters
+	 * We use this to assemble and return any filters that are associated with this table that help further refine what
+	 * get's shown in the table.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = array();
+
+		//get select_inputs
+		$select_inputs = array(
+			$this->_get_messengers_dropdown_filter(),
+			$this->_get_message_types_dropdown_filter(),
+			$this->_get_contexts_for_message_types_dropdown_filter(),
+		);
+
+		//set filters to select inputs if they aren't empty
+		foreach ($select_inputs as $select_input) {
+			if ($select_input) {
+				$filters[] = $select_input;
+			}
+		}
+		return $filters;
+	}
+
+
+	protected function _add_view_counts()
+	{
+		foreach ($this->_views as $view => $args) {
+			$this->_views[$view]['count'] = $this->_get_messages($this->_per_page, $view, true, true);
+		}
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string   checkbox
+	 * @throws \EE_Error
+	 */
+	public function column_cb($message)
+	{
+		return sprintf('<input type="checkbox" name="MSG_ID[%s]" value="1" />', $message->ID());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_msg_id(EE_Message $message)
+	{
+		return $message->ID();
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string    The recipient of the message
+	 * @throws \EE_Error
+	 */
+	public function column_to(EE_Message $message)
+	{
+		EE_Registry::instance()->load_helper('URL');
+		$actions           = array();
+		$actions['delete'] = '<a href="'
+							 . EEH_URL::add_query_args_and_nonce(
+				array(
+					'page'   => 'espresso_messages',
+					'action' => 'delete_ee_message',
+					'MSG_ID' => $message->ID(),
+				),
+				admin_url('admin.php')
+			)
+							 . '">' . __('Delete', 'event_espresso') . '</a>';
+		return esc_html($message->to()) . $this->row_actions($actions);
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string   The sender of the message
+	 */
+	public function column_from(EE_Message $message)
+	{
+		return esc_html($message->from());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string  The messenger used to send the message.
+	 */
+	public function column_messenger(EE_Message $message)
+	{
+		return ucwords($message->messenger_label());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string  The message type used to generate the message.
+	 */
+	public function column_message_type(EE_Message $message)
+	{
+		return ucwords($message->message_type_label());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string  The context the message was generated for.
+	 */
+	public function column_context(EE_Message $message)
+	{
+		return $message->context_label();
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string    The timestamp when this message was last modified.
+	 */
+	public function column_modified(EE_Message $message)
+	{
+		return $message->modified();
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string   Actions that can be done on the current message.
+	 */
+	public function column_action(EE_Message $message)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$action_links = array(
+			'view'                => EEH_MSG_Template::get_message_action_link('view', $message),
+			'error'               => EEH_MSG_Template::get_message_action_link('error', $message),
+			'generate_now'        => EEH_MSG_Template::get_message_action_link('generate_now', $message),
+			'send_now'            => EEH_MSG_Template::get_message_action_link('send_now', $message),
+			'queue_for_resending' => EEH_MSG_Template::get_message_action_link('queue_for_resending', $message),
+			'view_transaction'    => EEH_MSG_Template::get_message_action_link('view_transaction', $message),
+		);
+		$content      = '';
+		switch ($message->STS_ID()) {
+			case EEM_Message::status_sent :
+				$content = $action_links['view'] . $action_links['queue_for_resending'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_resend :
+				$content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_retry :
+				$content = $action_links['view'] . $action_links['send_now'] . $action_links['error'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_failed :
+			case EEM_Message::status_debug_only :
+				$content = $action_links['error'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_idle :
+				$content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_incomplete;
+				$content = $action_links['generate_now'] . $action_links['view_transaction'];
+				break;
+		}
+		return $content;
+	}
+
+
+	/**
+	 * Retrieve the EE_Message objects for the list table.
+	 *
+	 * @param int    $perpage The number of items per page
+	 * @param string $view    The view items are being retrieved for
+	 * @param bool   $count   Whether to just return a count or not.
+	 * @param bool   $all     Disregard any paging info (no limit on data returned).
+	 * @return int|EE_Message[]
+	 * @throws \EE_Error
+	 */
+	protected function _get_messages($perpage = 10, $view = 'all', $count = false, $all = false)
+	{
+
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
+			? $this->_req_data['paged']
+			: 1;
+
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $perpage;
+
+		$offset       = ($current_page - 1) * $per_page;
+		$limit        = $all || $count ? null : array($offset, $per_page);
+		$query_params = array(
+			'order_by' => empty($this->_req_data['orderby']) ? 'MSG_modified' : $this->_req_data['orderby'],
+			'order'    => empty($this->_req_data['order']) ? 'DESC' : $this->_req_data['order'],
+			'limit'    => $limit,
+		);
+
+		/**
+		 * Any filters coming in from other routes?
+		 */
+		if (isset($this->_req_data['filterby'])) {
+			$query_params = array_merge($query_params, EEM_Message::instance()->filter_by_query_params());
+			if ( ! $count) {
+				$query_params['group_by'] = 'MSG_ID';
+			}
+		}
+
+		//view conditionals
+		if ($view !== 'all' && $count && $all) {
+			$query_params[0]['AND*view_conditional'] = array(
+				'STS_ID' => strtoupper($view),
+			);
+		}
+
+		if (! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
+			$query_params[0]['AND*view_conditional'] = $this->_req_data === EEM_Message::status_failed
+				? array(
+					'STS_ID' => array(
+						'IN',
+						array(EEM_Message::status_failed, EEM_Message::status_messenger_executing)
+					)
+				)
+				: array( 'STS_ID' => strtoupper($this->_req_data['status']) );
+		}
+
+		if (! $all && ! empty($this->_req_data['s'])) {
+			$search_string         = '%' . $this->_req_data['s'] . '%';
+			$query_params[0]['OR'] = array(
+				'MSG_to'      => array('LIKE', $search_string),
+				'MSG_from'    => array('LIKE', $search_string),
+				'MSG_subject' => array('LIKE', $search_string),
+				'MSG_content' => array('LIKE', $search_string),
+			);
+		}
+
+		//account for debug only status.  We don't show Messages with the EEM_Message::status_debug_only to clients when
+		//the messages system is in debug mode.
+		//Note: for backward compat with previous iterations, this is necessary because there may be EEM_Message::status_debug_only
+		//messages in the database.
+		if (! EEM_Message::debug()) {
+			$query_params[0]['AND*debug_only_conditional'] = array(
+				'STS_ID' => array('!=', EEM_Message::status_debug_only),
+			);
+		}
+
+		//account for filters
+		if (! $all
+			&& isset($this->_req_data['ee_messenger_filter_by'])
+			&& $this->_req_data['ee_messenger_filter_by'] !== 'none_selected'
+		) {
+			$query_params[0]['AND*messenger_filter'] = array(
+				'MSG_messenger' => $this->_req_data['ee_messenger_filter_by'],
+			);
+		}
+		if (! $all
+			&& ! empty($this->_req_data['ee_message_type_filter_by'])
+			&& $this->_req_data['ee_message_type_filter_by'] !== 'none_selected'
+		) {
+			$query_params[0]['AND*message_type_filter'] = array(
+				'MSG_message_type' => $this->_req_data['ee_message_type_filter_by'],
+			);
+		}
+
+		if (! $all
+			&& ! empty($this->_req_data['ee_context_filter_by'])
+			&& $this->_req_data['ee_context_filter_by'] !== 'none_selected'
+		) {
+			$query_params[0]['AND*context_filter'] = array(
+				'MSG_context' => array('IN', explode(',', $this->_req_data['ee_context_filter_by'])),
+			);
+		}
+
+		return $count
+			/** @type int */
+			? EEM_Message::instance()->count($query_params, null, true)
+			/** @type EE_Message[] */
+			: EEM_Message::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for messengers.
+	 *
+	 * @return string
+	 */
+	protected function _get_messengers_dropdown_filter()
+	{
+		$messenger_options                    = array();
+		$active_messages_grouped_by_messenger = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
+
+		//setup array of messenger options
+		foreach ($active_messages_grouped_by_messenger as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$messenger_options[$active_message->messenger()] = ucwords($active_message->messenger_label());
+			}
+		}
+		return $this->get_admin_page()->get_messengers_select_input($messenger_options);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for message types
+	 *
+	 * @return string
+	 */
+	protected function _get_message_types_dropdown_filter()
+	{
+		$message_type_options                    = array();
+		$active_messages_grouped_by_message_type = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
+
+		//setup array of message type options
+		foreach ($active_messages_grouped_by_message_type as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type_options[$active_message->message_type()] = ucwords($active_message->message_type_label());
+			}
+		}
+		return $this->get_admin_page()->get_message_types_select_input($message_type_options);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for message type contexts
+	 *
+	 * @return string
+	 */
+	protected function _get_contexts_for_message_types_dropdown_filter()
+	{
+		$context_options                    = array();
+		$active_messages_grouped_by_context = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
+
+		//setup array of context options
+		foreach ($active_messages_grouped_by_context as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type = $active_message->message_type_object();
+				if ($message_type instanceof EE_message_type) {
+					foreach ($message_type->get_contexts() as $context => $context_details) {
+						if (isset($context_details['label'])) {
+							$context_options[$context] = $context_details['label'];
+						}
+					}
+				}
+			}
+		}
+		return $this->get_admin_page()->get_contexts_for_message_types_select_input($context_options);
+	}
 } //end EE_Message_List_Table class
\ No newline at end of file

Spacing +19 added lines, -19 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -81,7 +81,7 @@ 
     {
         $class = parent::_get_row_class($item);
         //add status class
-        $class .= ' ee-status-strip msg-status-' . $item->STS_ID();
+        $class .= ' ee-status-strip msg-status-'.$item->STS_ID();
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
         }
@@ -168,8 +168,8 @@ 
                 ),
                 admin_url('admin.php')
             )
-                             . '">' . __('Delete', 'event_espresso') . '</a>';
-        return esc_html($message->to()) . $this->row_actions($actions);
+                             . '">'.__('Delete', 'event_espresso').'</a>';
+        return esc_html($message->to()).$this->row_actions($actions);
     }
 
 
@@ -238,26 +238,26 @@ 
             'queue_for_resending' => EEH_MSG_Template::get_message_action_link('queue_for_resending', $message),
             'view_transaction'    => EEH_MSG_Template::get_message_action_link('view_transaction', $message),
         );
-        $content      = '';
+        $content = '';
         switch ($message->STS_ID()) {
             case EEM_Message::status_sent :
-                $content = $action_links['view'] . $action_links['queue_for_resending'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['queue_for_resending'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_resend :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['send_now'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_retry :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['error'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['send_now'].$action_links['error'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_failed :
             case EEM_Message::status_debug_only :
-                $content = $action_links['error'] . $action_links['view_transaction'];
+                $content = $action_links['error'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_idle :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['send_now'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_incomplete;
-                $content = $action_links['generate_now'] . $action_links['view_transaction'];
+                $content = $action_links['generate_now'].$action_links['view_transaction'];
                 break;
         }
         return $content;
@@ -310,7 +310,7 @@ 
             );
         }
 
-        if (! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
+        if ( ! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
             $query_params[0]['AND*view_conditional'] = $this->_req_data === EEM_Message::status_failed
                 ? array(
                     'STS_ID' => array(
@@ -318,11 +318,11 @@ 
                         array(EEM_Message::status_failed, EEM_Message::status_messenger_executing)
                     )
                 )
-                : array( 'STS_ID' => strtoupper($this->_req_data['status']) );
+                : array('STS_ID' => strtoupper($this->_req_data['status']));
         }
 
-        if (! $all && ! empty($this->_req_data['s'])) {
-            $search_string         = '%' . $this->_req_data['s'] . '%';
+        if ( ! $all && ! empty($this->_req_data['s'])) {
+            $search_string         = '%'.$this->_req_data['s'].'%';
             $query_params[0]['OR'] = array(
                 'MSG_to'      => array('LIKE', $search_string),
                 'MSG_from'    => array('LIKE', $search_string),
@@ -335,14 +335,14 @@ 
         //the messages system is in debug mode.
         //Note: for backward compat with previous iterations, this is necessary because there may be EEM_Message::status_debug_only
         //messages in the database.
-        if (! EEM_Message::debug()) {
+        if ( ! EEM_Message::debug()) {
             $query_params[0]['AND*debug_only_conditional'] = array(
                 'STS_ID' => array('!=', EEM_Message::status_debug_only),
             );
         }
 
         //account for filters
-        if (! $all
+        if ( ! $all
             && isset($this->_req_data['ee_messenger_filter_by'])
             && $this->_req_data['ee_messenger_filter_by'] !== 'none_selected'
         ) {
@@ -350,7 +350,7 @@ 
                 'MSG_messenger' => $this->_req_data['ee_messenger_filter_by'],
             );
         }
-        if (! $all
+        if ( ! $all
             && ! empty($this->_req_data['ee_message_type_filter_by'])
             && $this->_req_data['ee_message_type_filter_by'] !== 'none_selected'
         ) {
@@ -359,7 +359,7 @@ 
             );
         }
 
-        if (! $all
+        if ( ! $all
             && ! empty($this->_req_data['ee_context_filter_by'])
             && $this->_req_data['ee_context_filter_by'] !== 'none_selected'
         ) {

caffeinated/admin/extend/registration_form/Extend_Registration_Form_Admin_Page.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -504,7 +504,7 @@
      *
      * @param int                  $id
      * @param EEM_Soft_Delete_Base $model
-     * @return boolean
+     * @return integer
      */
     protected function _delete_item($id, $model)
     {

Spacing +34 added lines, -34 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -32,11 +32,11 @@ 
      */
     public function __construct($routing = true)
     {
-        define('REGISTRATION_FORM_CAF_ADMIN', EE_CORE_CAF_ADMIN_EXTEND . 'registration_form' . DS);
-        define('REGISTRATION_FORM_CAF_ASSETS_PATH', REGISTRATION_FORM_CAF_ADMIN . 'assets' . DS);
-        define('REGISTRATION_FORM_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/assets/');
-        define('REGISTRATION_FORM_CAF_TEMPLATE_PATH', REGISTRATION_FORM_CAF_ADMIN . 'templates' . DS);
-        define('REGISTRATION_FORM_CAF_TEMPLATE_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/templates/');
+        define('REGISTRATION_FORM_CAF_ADMIN', EE_CORE_CAF_ADMIN_EXTEND.'registration_form'.DS);
+        define('REGISTRATION_FORM_CAF_ASSETS_PATH', REGISTRATION_FORM_CAF_ADMIN.'assets'.DS);
+        define('REGISTRATION_FORM_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'registration_form/assets/');
+        define('REGISTRATION_FORM_CAF_TEMPLATE_PATH', REGISTRATION_FORM_CAF_ADMIN.'templates'.DS);
+        define('REGISTRATION_FORM_CAF_TEMPLATE_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'registration_form/templates/');
         parent::__construct($routing);
     }
 
@@ -47,7 +47,7 @@ 
         $qst_id = ! empty($this->_req_data['QST_ID']) && ! is_array($this->_req_data['QST_ID']) ? $this->_req_data['QST_ID'] : 0;
         $qsg_id = ! empty($this->_req_data['QSG_ID']) && ! is_array($this->_req_data['QSG_ID']) ? $this->_req_data['QSG_ID'] : 0;
 
-        $new_page_routes    = array(
+        $new_page_routes = array(
             'question_groups'    => array(
                 'func'       => '_question_groups_overview_list_table',
                 'capability' => 'ee_read_question_groups',
@@ -310,7 +310,7 @@ 
 
 
         //additional labels
-        $new_labels               = array(
+        $new_labels = array(
             'add_question'          => esc_html__('Add New Question', 'event_espresso'),
             'delete_question'       => esc_html__('Delete Question', 'event_espresso'),
             'add_question_group'    => esc_html__('Add New Question Group', 'event_espresso'),
@@ -354,7 +354,7 @@ 
      */
     public function load_sortable_question_script()
     {
-        wp_register_script('ee-question-sortable', REGISTRATION_FORM_CAF_ASSETS_URL . 'ee_question_order.js',
+        wp_register_script('ee-question-sortable', REGISTRATION_FORM_CAF_ASSETS_URL.'ee_question_order.js',
             array('jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
         wp_enqueue_script('ee-question-sortable');
     }
@@ -420,7 +420,7 @@ 
 
     protected function _questions_overview_list_table()
     {
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
                 'add_question',
                 'add_question',
                 array(),
@@ -433,7 +433,7 @@ 
     protected function _question_groups_overview_list_table()
     {
         $this->_search_btn_label = esc_html__('Question Groups', 'event_espresso');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
                 'add_question_group',
                 'add_question_group',
                 array(),
@@ -477,20 +477,20 @@ 
     {
         $success = 0;
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             // if array has more than one element than success message should be plural
             $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
             // cycle thru bulk action checkboxes
             while (list($ID, $value) = each($this->_req_data['checkbox'])) {
-                if (! $this->_delete_item($ID, $model)) {
+                if ( ! $this->_delete_item($ID, $model)) {
                     $success = 0;
                 }
             }
 
-        } elseif (! empty($this->_req_data['QSG_ID'])) {
+        } elseif ( ! empty($this->_req_data['QSG_ID'])) {
             $success = $this->_delete_item($this->_req_data['QSG_ID'], $model);
 
-        } elseif (! empty($this->_req_data['QST_ID'])) {
+        } elseif ( ! empty($this->_req_data['QST_ID'])) {
             $success = $this->_delete_item($this->_req_data['QST_ID'], $model);
         } else {
             EE_Error::add_error(sprintf(esc_html__("No Questions or Question Groups were selected for deleting. This error usually shows when you've attempted to delete via bulk action but there were no selections.",
@@ -534,7 +534,7 @@ 
                 $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
         }
         // add ID to title if editing
-        $this->_admin_page_title = $ID ? $this->_admin_page_title . ' # ' . $ID : $this->_admin_page_title;
+        $this->_admin_page_title = $ID ? $this->_admin_page_title.' # '.$ID : $this->_admin_page_title;
         if ($ID) {
             /** @var EE_Question_Group $questionGroup */
             $questionGroup            = $this->_question_group_model->get_one_by_ID($ID);
@@ -553,7 +553,7 @@ 
 
         $redirect_URL = add_query_arg(array('action' => 'question_groups'), $this->_admin_base_url);
         $this->_set_publish_post_box_vars('id', $ID, false, $redirect_URL);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'question_groups_main_meta_box.template.php',
+        $this->_template_args['admin_page_content'] = EEH_Template::display_template(REGISTRATION_FORM_CAF_TEMPLATE_PATH.'question_groups_main_meta_box.template.php',
             $this->_template_args, true);
 
         // the details template wrapper
@@ -600,13 +600,13 @@ 
         $question_group = $this->_question_group_model->get_one_by_ID($QSG_ID);
         $questions      = $question_group->questions();
         // make sure system phone question is added to list of questions for this group
-        if (! isset($questions[$phone_question_id])) {
+        if ( ! isset($questions[$phone_question_id])) {
             $questions[$phone_question_id] = EEM_Question::instance()->get_one_by_ID($phone_question_id);
         }
 
         foreach ($questions as $question_ID => $question) {
             // first we always check for order.
-            if (! empty($this->_req_data['question_orders'][$question_ID])) {
+            if ( ! empty($this->_req_data['question_orders'][$question_ID])) {
                 //update question order
                 $question_group->update_question_order($question_ID, $this->_req_data['question_orders'][$question_ID]);
             }
@@ -654,7 +654,7 @@ 
      */
     public function _duplicate_question()
     {
-        $question_ID = (int)$this->_req_data['QST_ID'];
+        $question_ID = (int) $this->_req_data['QST_ID'];
         $question    = EEM_Question::instance()->get_one_by_ID($question_ID);
         if ($question instanceof EE_Question) {
             $new_question = $question->duplicate();
@@ -690,7 +690,7 @@ 
      */
     protected function _trash_question()
     {
-        $success    = $this->_question_model->delete_by_ID((int)$this->_req_data['QST_ID']);
+        $success    = $this->_question_model->delete_by_ID((int) $this->_req_data['QST_ID']);
         $query_args = array('action' => 'default', 'status' => 'all');
         $this->_redirect_after_action($success, $this->_question_model->item_name($success), 'trashed', $query_args);
     }
@@ -722,12 +722,12 @@ 
         //echo "trash $trash";
         //var_dump($this->_req_data['checkbox']);die;
         if (isset($this->_req_data['checkbox'])) {
-            if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+            if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
                 // if array has more than one element than success message should be plural
                 $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
                 // cycle thru bulk action checkboxes
                 while (list($ID, $value) = each($this->_req_data['checkbox'])) {
-                    if (! $model->delete_or_restore_by_ID($trash, absint($ID))) {
+                    if ( ! $model->delete_or_restore_by_ID($trash, absint($ID))) {
                         $success = 0;
                     }
                 }
@@ -735,7 +735,7 @@ 
             } else {
                 // grab single id and delete
                 $ID = absint($this->_req_data['checkbox']);
-                if (! $model->delete_or_restore_by_ID($trash, $ID)) {
+                if ( ! $model->delete_or_restore_by_ID($trash, $ID)) {
                     $success = 0;
                 }
             }
@@ -744,14 +744,14 @@ 
             // delete via trash link
             // grab single id and delete
             $ID = absint($this->_req_data[$model->primary_key_name()]);
-            if (! $model->delete_or_restore_by_ID($trash, $ID)) {
+            if ( ! $model->delete_or_restore_by_ID($trash, $ID)) {
                 $success = 0;
             }
 
         }
 
 
-        $action = $model instanceof EEM_Question ? 'default' : 'question_groups';//strtolower( $model->item_name(2) );
+        $action = $model instanceof EEM_Question ? 'default' : 'question_groups'; //strtolower( $model->item_name(2) );
         //echo "action :$action";
         //$action = 'questions' ? 'default' : $action;
         if ($trash) {
@@ -845,13 +845,13 @@ 
             : array();
 
         $perpage = ! empty($this->_req_data['perpage'])
-            ? (int)$this->_req_data['perpage']
+            ? (int) $this->_req_data['perpage']
             : null;
         $curpage = ! empty($this->_req_data['curpage'])
-            ? (int)$this->_req_data['curpage']
+            ? (int) $this->_req_data['curpage']
             : null;
 
-        if (! empty($row_ids)) {
+        if ( ! empty($row_ids)) {
             //figure out where we start the row_id count at for the current page.
             $qsgcount = empty($curpage) ? 0 : ($curpage - 1) * $perpage;
 
@@ -898,14 +898,14 @@ 
             array($this, 'email_validation_settings_form'),
             2
         );
-        $this->_template_args = (array)apply_filters(
+        $this->_template_args = (array) apply_filters(
             'FHEE__Extend_Registration_Form_Admin_Page___reg_form_settings___template_args',
             $this->_template_args
         );
         $this->_set_add_edit_form_tags('update_reg_form_settings');
         $this->_set_publish_post_box_vars(null, false, false, null, false);
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'reg_form_settings.template.php',
+            REGISTRATION_FORM_CAF_TEMPLATE_PATH.'reg_form_settings.template.php',
             $this->_template_args,
             true
         );
@@ -925,7 +925,7 @@ 
             'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
             EE_Registry::instance()->CFG->registration
         );
-        $success                                   = $this->_update_espresso_configuration(
+        $success = $this->_update_espresso_configuration(
             esc_html__('Registration Form Options', 'event_espresso'),
             EE_Registry::instance()->CFG,
             __FILE__, __FUNCTION__, __LINE__
@@ -1022,7 +1022,7 @@ 
                                 $prev_email_validation_level = 'basic';
                             }
                             // confirm our i18n email validation will work on the server
-                            if (! $this->_verify_pcre_support($EE_Registration_Config, $email_validation_level)) {
+                            if ( ! $this->_verify_pcre_support($EE_Registration_Config, $email_validation_level)) {
                                 // or reset email validation level to previous value
                                 $email_validation_level = $prev_email_validation_level;
                             }
@@ -1064,7 +1064,7 @@ 
     private function _verify_pcre_support(EE_Registration_Config $EE_Registration_Config, $email_validation_level)
     {
         // first check that PCRE is enabled
-        if (! defined('PREG_BAD_UTF8_ERROR')) {
+        if ( ! defined('PREG_BAD_UTF8_ERROR')) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(

Indentation +1088 added lines, -1088 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -25,1093 +25,1093 @@ 
 {
 
 
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @access public
-     */
-    public function __construct($routing = true)
-    {
-        define('REGISTRATION_FORM_CAF_ADMIN', EE_CORE_CAF_ADMIN_EXTEND . 'registration_form' . DS);
-        define('REGISTRATION_FORM_CAF_ASSETS_PATH', REGISTRATION_FORM_CAF_ADMIN . 'assets' . DS);
-        define('REGISTRATION_FORM_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/assets/');
-        define('REGISTRATION_FORM_CAF_TEMPLATE_PATH', REGISTRATION_FORM_CAF_ADMIN . 'templates' . DS);
-        define('REGISTRATION_FORM_CAF_TEMPLATE_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/templates/');
-        parent::__construct($routing);
-    }
-
-
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = REGISTRATION_FORM_CAF_ADMIN;
-        $qst_id = ! empty($this->_req_data['QST_ID']) && ! is_array($this->_req_data['QST_ID']) ? $this->_req_data['QST_ID'] : 0;
-        $qsg_id = ! empty($this->_req_data['QSG_ID']) && ! is_array($this->_req_data['QSG_ID']) ? $this->_req_data['QSG_ID'] : 0;
-
-        $new_page_routes    = array(
-            'question_groups'    => array(
-                'func'       => '_question_groups_overview_list_table',
-                'capability' => 'ee_read_question_groups',
-            ),
-            'add_question'       => array(
-                'func'       => '_edit_question',
-                'capability' => 'ee_edit_questions',
-            ),
-            'insert_question'    => array(
-                'func'       => '_insert_or_update_question',
-                'args'       => array('new_question' => true),
-                'capability' => 'ee_edit_questions',
-                'noheader'   => true,
-            ),
-            'duplicate_question' => array(
-                'func'       => '_duplicate_question',
-                'capability' => 'ee_edit_questions',
-                'noheader'   => true,
-            ),
-            'trash_question'     => array(
-                'func'       => '_trash_question',
-                'capability' => 'ee_delete_question',
-                'obj_id'     => $qst_id,
-                'noheader'   => true,
-            ),
-
-            'restore_question' => array(
-                'func'       => '_trash_or_restore_questions',
-                'capability' => 'ee_delete_question',
-                'obj_id'     => $qst_id,
-                'args'       => array('trash' => false),
-                'noheader'   => true,
-            ),
-
-            'delete_question' => array(
-                'func'       => '_delete_question',
-                'capability' => 'ee_delete_question',
-                'obj_id'     => $qst_id,
-                'noheader'   => true,
-            ),
-
-            'trash_questions' => array(
-                'func'       => '_trash_or_restore_questions',
-                'capability' => 'ee_delete_questions',
-                'args'       => array('trash' => true),
-                'noheader'   => true,
-            ),
-
-            'restore_questions' => array(
-                'func'       => '_trash_or_restore_questions',
-                'capability' => 'ee_delete_questions',
-                'args'       => array('trash' => false),
-                'noheader'   => true,
-            ),
-
-            'delete_questions' => array(
-                'func'       => '_delete_questions',
-                'args'       => array(),
-                'capability' => 'ee_delete_questions',
-                'noheader'   => true,
-            ),
-
-            'add_question_group' => array(
-                'func'       => '_edit_question_group',
-                'capability' => 'ee_edit_question_groups',
-            ),
-
-            'edit_question_group' => array(
-                'func'       => '_edit_question_group',
-                'capability' => 'ee_edit_question_group',
-                'obj_id'     => $qsg_id,
-                'args'       => array('edit'),
-            ),
-
-            'delete_question_groups' => array(
-                'func'       => '_delete_question_groups',
-                'capability' => 'ee_delete_question_groups',
-                'noheader'   => true,
-            ),
-
-            'delete_question_group' => array(
-                'func'       => '_delete_question_groups',
-                'capability' => 'ee_delete_question_group',
-                'obj_id'     => $qsg_id,
-                'noheader'   => true,
-            ),
-
-            'trash_question_group' => array(
-                'func'       => '_trash_or_restore_question_groups',
-                'args'       => array('trash' => true),
-                'capability' => 'ee_delete_question_group',
-                'obj_id'     => $qsg_id,
-                'noheader'   => true,
-            ),
-
-            'restore_question_group' => array(
-                'func'       => '_trash_or_restore_question_groups',
-                'args'       => array('trash' => false),
-                'capability' => 'ee_delete_question_group',
-                'obj_id'     => $qsg_id,
-                'noheader'   => true,
-            ),
-
-            'insert_question_group' => array(
-                'func'       => '_insert_or_update_question_group',
-                'args'       => array('new_question_group' => true),
-                'capability' => 'ee_edit_question_groups',
-                'noheader'   => true,
-            ),
-
-            'update_question_group' => array(
-                'func'       => '_insert_or_update_question_group',
-                'args'       => array('new_question_group' => false),
-                'capability' => 'ee_edit_question_group',
-                'obj_id'     => $qsg_id,
-                'noheader'   => true,
-            ),
-
-            'trash_question_groups' => array(
-                'func'       => '_trash_or_restore_question_groups',
-                'args'       => array('trash' => true),
-                'capability' => 'ee_delete_question_groups',
-                'noheader'   => array('trash' => false),
-            ),
-
-            'restore_question_groups' => array(
-                'func'       => '_trash_or_restore_question_groups',
-                'args'       => array('trash' => false),
-                'capability' => 'ee_delete_question_groups',
-                'noheader'   => true,
-            ),
-
-
-            'espresso_update_question_group_order' => array(
-                'func'       => 'update_question_group_order',
-                'capability' => 'ee_edit_question_groups',
-                'noheader'   => true,
-            ),
-
-            'view_reg_form_settings' => array(
-                'func'       => '_reg_form_settings',
-                'capability' => 'manage_options',
-            ),
-
-            'update_reg_form_settings' => array(
-                'func'       => '_update_reg_form_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-        );
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-
-        $new_page_config    = array(
-
-            'question_groups' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Question Groups', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'list_table'    => 'Registration_Form_Question_Groups_Admin_List_Table',
-                'help_tabs'     => array(
-                    'registration_form_question_groups_help_tab'                           => array(
-                        'title'    => esc_html__('Question Groups', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups',
-                    ),
-                    'registration_form_question_groups_table_column_headings_help_tab'     => array(
-                        'title'    => esc_html__('Question Groups Table Column Headings', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups_table_column_headings',
-                    ),
-                    'registration_form_question_groups_views_bulk_actions_search_help_tab' => array(
-                        'title'    => esc_html__('Question Groups Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups_views_bulk_actions_search',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Form_Question_Groups_Help_Tour'),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-                'qtips'         => array(
-                    'EE_Registration_Form_Tips',
-                ),
-            ),
-
-            'add_question' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Question', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'registration_form_add_question_help_tab' => array(
-                        'title'    => esc_html__('Add Question', 'event_espresso'),
-                        'filename' => 'registration_form_add_question',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Form_Add_Question_Help_Tour'),
-                'require_nonce' => false,
-            ),
-
-            'add_question_group' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Question Group', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'registration_form_add_question_group_help_tab' => array(
-                        'title'    => esc_html__('Add Question Group', 'event_espresso'),
-                        'filename' => 'registration_form_add_question_group',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Form_Add_Question_Group_Help_Tour'),
-                'require_nonce' => false,
-            ),
-
-            'edit_question_group' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Question Group', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['question_group_id']) ? add_query_arg(array('question_group_id' => $this->_req_data['question_group_id']),
-                        $this->_current_page_view_url) : $this->_admin_base_url,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'registration_form_edit_question_group_help_tab' => array(
-                        'title'    => esc_html__('Edit Question Group', 'event_espresso'),
-                        'filename' => 'registration_form_edit_question_group',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Form_Edit_Question_Group_Help_Tour'),
-                'require_nonce' => false,
-            ),
-
-            'view_reg_form_settings' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Reg Form Settings', 'event_espresso'),
-                    'order' => 40,
-                ),
-                'labels'        => array(
-                    'publishbox' => esc_html__('Update Settings', 'event_espresso'),
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'registration_form_reg_form_settings_help_tab' => array(
-                        'title'    => esc_html__('Registration Form Settings', 'event_espresso'),
-                        'filename' => 'registration_form_reg_form_settings',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Form_Settings_Help_Tour'),
-                'require_nonce' => false,
-            ),
-
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-
-        //change the list table we're going to use so it's the NEW list table!
-        $this->_page_config['default']['list_table'] = 'Extend_Registration_Form_Questions_Admin_List_Table';
-
-
-        //additional labels
-        $new_labels               = array(
-            'add_question'          => esc_html__('Add New Question', 'event_espresso'),
-            'delete_question'       => esc_html__('Delete Question', 'event_espresso'),
-            'add_question_group'    => esc_html__('Add New Question Group', 'event_espresso'),
-            'edit_question_group'   => esc_html__('Edit Question Group', 'event_espresso'),
-            'delete_question_group' => esc_html__('Delete Question Group', 'event_espresso'),
-        );
-        $this->_labels['buttons'] = array_merge($this->_labels['buttons'], $new_labels);
-
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_espresso_update_question_group_order', array($this, 'update_question_group_order'));
-    }
-
-
-    public function load_scripts_styles_question_groups()
-    {
-        wp_enqueue_script('espresso_ajax_table_sorting');
-    }
-
-
-    public function load_scripts_styles_add_question_group()
-    {
-        $this->load_scripts_styles_forms();
-        $this->load_sortable_question_script();
-    }
-
-    public function load_scripts_styles_edit_question_group()
-    {
-        $this->load_scripts_styles_forms();
-        $this->load_sortable_question_script();
-    }
-
-
-    /**
-     * registers and enqueues script for questions
-     *
-     * @return void
-     */
-    public function load_sortable_question_script()
-    {
-        wp_register_script('ee-question-sortable', REGISTRATION_FORM_CAF_ASSETS_URL . 'ee_question_order.js',
-            array('jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
-        wp_enqueue_script('ee-question-sortable');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Questions', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_questions' => esc_html__('Trash', 'event_espresso'),
-                ),
-            ),
-        );
-
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_questions',
-            'espresso_registration_form_trash_questions')
-        ) {
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'delete_questions'  => esc_html__('Delete Permanently', 'event_espresso'),
-                    'restore_questions' => esc_html__('Restore', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    protected function _set_list_table_views_question_groups()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_question_groups' => esc_html__('Trash', 'event_espresso'),
-                ),
-            ),
-        );
-
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_question_groups',
-            'espresso_registration_form_trash_question_groups')
-        ) {
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'delete_question_groups'  => esc_html__('Delete Permanently', 'event_espresso'),
-                    'restore_question_groups' => esc_html__('Restore', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    protected function _questions_overview_list_table()
-    {
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                'add_question',
-                'add_question',
-                array(),
-                'add-new-h2'
-            );
-        parent::_questions_overview_list_table();
-    }
-
-
-    protected function _question_groups_overview_list_table()
-    {
-        $this->_search_btn_label = esc_html__('Question Groups', 'event_espresso');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                'add_question_group',
-                'add_question_group',
-                array(),
-                'add-new-h2'
-            );
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    protected function _delete_question()
-    {
-        $success = $this->_delete_items($this->_question_model);
-        $this->_redirect_after_action(
-            $success,
-            $this->_question_model->item_name($success),
-            'deleted',
-            array('action' => 'default', 'status' => 'all')
-        );
-    }
-
-
-    protected function _delete_questions()
-    {
-        $success = $this->_delete_items($this->_question_model);
-        $this->_redirect_after_action(
-            $success,
-            $this->_question_model->item_name($success),
-            'deleted permanently',
-            array('action' => 'default', 'status' => 'trash')
-        );
-    }
-
-
-    /**
-     * Performs the deletion of a single or multiple questions or question groups.
-     *
-     * @param EEM_Soft_Delete_Base $model
-     * @return int number of items deleted permanently
-     */
-    private function _delete_items(EEM_Soft_Delete_Base $model)
-    {
-        $success = 0;
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element than success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-            // cycle thru bulk action checkboxes
-            while (list($ID, $value) = each($this->_req_data['checkbox'])) {
-                if (! $this->_delete_item($ID, $model)) {
-                    $success = 0;
-                }
-            }
-
-        } elseif (! empty($this->_req_data['QSG_ID'])) {
-            $success = $this->_delete_item($this->_req_data['QSG_ID'], $model);
-
-        } elseif (! empty($this->_req_data['QST_ID'])) {
-            $success = $this->_delete_item($this->_req_data['QST_ID'], $model);
-        } else {
-            EE_Error::add_error(sprintf(esc_html__("No Questions or Question Groups were selected for deleting. This error usually shows when you've attempted to delete via bulk action but there were no selections.",
-                "event_espresso")), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return $success;
-    }
-
-    /**
-     * Deletes the specified question (and its associated question options) or question group
-     *
-     * @param int                  $id
-     * @param EEM_Soft_Delete_Base $model
-     * @return boolean
-     */
-    protected function _delete_item($id, $model)
-    {
-        if ($model instanceof EEM_Question) {
-            EEM_Question_Option::instance()->delete_permanently(array(array('QST_ID' => absint($id))));
-        }
-        return $model->delete_permanently_by_ID(absint($id));
-    }
-
-
-    /******************************    QUESTION GROUPS    ******************************/
-
-
-    protected function _edit_question_group($type = 'add')
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $ID = isset($this->_req_data['QSG_ID']) && ! empty($this->_req_data['QSG_ID']) ? absint($this->_req_data['QSG_ID']) : false;
-
-        switch ($this->_req_action) {
-            case 'add_question_group' :
-                $this->_admin_page_title = esc_html__('Add Question Group', 'event_espresso');
-                break;
-            case 'edit_question_group' :
-                $this->_admin_page_title = esc_html__('Edit Question Group', 'event_espresso');
-                break;
-            default :
-                $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
-        }
-        // add ID to title if editing
-        $this->_admin_page_title = $ID ? $this->_admin_page_title . ' # ' . $ID : $this->_admin_page_title;
-        if ($ID) {
-            /** @var EE_Question_Group $questionGroup */
-            $questionGroup            = $this->_question_group_model->get_one_by_ID($ID);
-            $additional_hidden_fields = array('QSG_ID' => array('type' => 'hidden', 'value' => $ID));
-            $this->_set_add_edit_form_tags('update_question_group', $additional_hidden_fields);
-        } else {
-            /** @var EE_Question_Group $questionGroup */
-            $questionGroup = EEM_Question_Group::instance()->create_default_object();
-            $questionGroup->set_order_to_latest();
-            $this->_set_add_edit_form_tags('insert_question_group');
-        }
-        $this->_template_args['values']         = $this->_yes_no_values;
-        $this->_template_args['all_questions']  = $questionGroup->questions_in_and_not_in_group();
-        $this->_template_args['QSG_ID']         = $ID ? $ID : true;
-        $this->_template_args['question_group'] = $questionGroup;
-
-        $redirect_URL = add_query_arg(array('action' => 'question_groups'), $this->_admin_base_url);
-        $this->_set_publish_post_box_vars('id', $ID, false, $redirect_URL);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'question_groups_main_meta_box.template.php',
-            $this->_template_args, true);
-
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _delete_question_groups()
-    {
-        $success = $this->_delete_items($this->_question_group_model);
-        $this->_redirect_after_action($success, $this->_question_group_model->item_name($success),
-            'deleted permanently', array('action' => 'question_groups', 'status' => 'trash'));
-    }
-
-
-    /**
-     * @param bool $new_question_group
-     */
-    protected function _insert_or_update_question_group($new_question_group = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $set_column_values = $this->_set_column_values_for($this->_question_group_model);
-        if ($new_question_group) {
-            $QSG_ID  = $this->_question_group_model->insert($set_column_values);
-            $success = $QSG_ID ? 1 : 0;
-        } else {
-            $QSG_ID = absint($this->_req_data['QSG_ID']);
-            unset($set_column_values['QSG_ID']);
-            $success = $this->_question_group_model->update($set_column_values, array(array('QSG_ID' => $QSG_ID)));
-        }
-        $phone_question_id = EEM_Question::instance()->get_Question_ID_from_system_string(EEM_Attendee::system_question_phone);
-        // update the existing related questions
-        // BUT FIRST...  delete the phone question from the Question_Group_Question if it is being added to this question group (therefore removed from the existing group)
-        if (isset($this->_req_data['questions'], $this->_req_data['questions'][$phone_question_id])) {
-            // delete where QST ID = system phone question ID and Question Group ID is NOT this group
-            EEM_Question_Group_Question::instance()->delete(array(
-                array(
-                    'QST_ID' => $phone_question_id,
-                    'QSG_ID' => array('!=', $QSG_ID),
-                ),
-            ));
-        }
-        /** @type EE_Question_Group $question_group */
-        $question_group = $this->_question_group_model->get_one_by_ID($QSG_ID);
-        $questions      = $question_group->questions();
-        // make sure system phone question is added to list of questions for this group
-        if (! isset($questions[$phone_question_id])) {
-            $questions[$phone_question_id] = EEM_Question::instance()->get_one_by_ID($phone_question_id);
-        }
-
-        foreach ($questions as $question_ID => $question) {
-            // first we always check for order.
-            if (! empty($this->_req_data['question_orders'][$question_ID])) {
-                //update question order
-                $question_group->update_question_order($question_ID, $this->_req_data['question_orders'][$question_ID]);
-            }
-
-            // then we always check if adding or removing.
-            if (isset($this->_req_data['questions'], $this->_req_data['questions'][$question_ID])) {
-                $question_group->add_question($question_ID);
-            } else {
-                // not found, remove it (but only if not a system question for the personal group with the exception of lname system question - we allow removal of it)
-                if (
-                in_array(
-                    $question->system_ID(),
-                    EEM_Question::instance()->required_system_questions_in_system_question_group($question_group->system_group())
-                )
-                ) {
-                    continue;
-                } else {
-                    $question_group->remove_question($question_ID);
-                }
-            }
-        }
-        // save new related questions
-        if (isset($this->_req_data['questions'])) {
-            foreach ($this->_req_data['questions'] as $QST_ID) {
-                $question_group->add_question($QST_ID);
-                if (isset($this->_req_data['question_orders'][$QST_ID])) {
-                    $question_group->update_question_order($QST_ID, $this->_req_data['question_orders'][$QST_ID]);
-                }
-            }
-        }
-
-        if ($success !== false) {
-            $msg = $new_question_group ? sprintf(esc_html__('The %s has been created', 'event_espresso'),
-                $this->_question_group_model->item_name()) : sprintf(esc_html__('The %s has been updated',
-                'event_espresso'), $this->_question_group_model->item_name());
-            EE_Error::add_success($msg);
-        }
-        $this->_redirect_after_action(false, '', '', array('action' => 'edit_question_group', 'QSG_ID' => $QSG_ID),
-            true);
-
-    }
-
-    /**
-     * duplicates a question and all its question options and redirects to the new question.
-     */
-    public function _duplicate_question()
-    {
-        $question_ID = (int)$this->_req_data['QST_ID'];
-        $question    = EEM_Question::instance()->get_one_by_ID($question_ID);
-        if ($question instanceof EE_Question) {
-            $new_question = $question->duplicate();
-            if ($new_question instanceof EE_Question) {
-                $this->_redirect_after_action(true, esc_html__('Question', 'event_espresso'),
-                    esc_html__('Duplicated', 'event_espresso'),
-                    array('action' => 'edit_question', 'QST_ID' => $new_question->ID()), true);
-            } else {
-                global $wpdb;
-                EE_Error::add_error(sprintf(esc_html__('Could not duplicate question with ID %1$d because: %2$s',
-                    'event_espresso'), $question_ID, $wpdb->last_error), __FILE__, __FUNCTION__, __LINE__);
-                $this->_redirect_after_action(false, '', '', array('action' => 'default'), false);
-            }
-        } else {
-            EE_Error::add_error(sprintf(esc_html__('Could not duplicate question with ID %d because it didn\'t exist!',
-                'event_espresso'), $question_ID), __FILE__, __FUNCTION__, __LINE__);
-            $this->_redirect_after_action(false, '', '', array('action' => 'default'), false);
-        }
-    }
-
-
-    /**
-     * @param bool $trash
-     */
-    protected function _trash_or_restore_question_groups($trash = true)
-    {
-        $this->_trash_or_restore_items($this->_question_group_model, $trash);
-    }
-
-
-    /**
-     *_trash_question
-     */
-    protected function _trash_question()
-    {
-        $success    = $this->_question_model->delete_by_ID((int)$this->_req_data['QST_ID']);
-        $query_args = array('action' => 'default', 'status' => 'all');
-        $this->_redirect_after_action($success, $this->_question_model->item_name($success), 'trashed', $query_args);
-    }
-
-
-    /**
-     * @param bool $trash
-     */
-    protected function _trash_or_restore_questions($trash = true)
-    {
-        $this->_trash_or_restore_items($this->_question_model, $trash);
-    }
-
-
-    /**
-     * Internally used to delete or restore items, using the request data. Meant to be
-     * flexible between question or question groups
-     *
-     * @param EEM_Soft_Delete_Base $model
-     * @param boolean              $trash whether to trash or restore
-     */
-    private function _trash_or_restore_items(EEM_Soft_Delete_Base $model, $trash = true)
-    {
-
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-
-        $success = 1;
-        //Checkboxes
-        //echo "trash $trash";
-        //var_dump($this->_req_data['checkbox']);die;
-        if (isset($this->_req_data['checkbox'])) {
-            if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-                // if array has more than one element than success message should be plural
-                $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-                // cycle thru bulk action checkboxes
-                while (list($ID, $value) = each($this->_req_data['checkbox'])) {
-                    if (! $model->delete_or_restore_by_ID($trash, absint($ID))) {
-                        $success = 0;
-                    }
-                }
-
-            } else {
-                // grab single id and delete
-                $ID = absint($this->_req_data['checkbox']);
-                if (! $model->delete_or_restore_by_ID($trash, $ID)) {
-                    $success = 0;
-                }
-            }
-
-        } else {
-            // delete via trash link
-            // grab single id and delete
-            $ID = absint($this->_req_data[$model->primary_key_name()]);
-            if (! $model->delete_or_restore_by_ID($trash, $ID)) {
-                $success = 0;
-            }
-
-        }
-
-
-        $action = $model instanceof EEM_Question ? 'default' : 'question_groups';//strtolower( $model->item_name(2) );
-        //echo "action :$action";
-        //$action = 'questions' ? 'default' : $action;
-        if ($trash) {
-            $action_desc = 'trashed';
-            $status      = 'trash';
-        } else {
-            $action_desc = 'restored';
-            $status      = 'all';
-        }
-        $this->_redirect_after_action($success, $model->item_name($success), $action_desc,
-            array('action' => $action, 'status' => $status));
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return \EE_Soft_Delete_Base_Class[]|int
-     */
-    public function get_trashed_questions($per_page, $current_page = 1, $count = false)
-    {
-        $query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
-
-        if ($count) {
-            //note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
-            $where   = isset($query_params[0]) ? array($query_params[0]) : array();
-            $results = $this->_question_model->count_deleted($where);
-        } else {
-            //note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
-            $results = $this->_question_model->get_all_deleted($query_params);
-        }
-        return $results;
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return \EE_Soft_Delete_Base_Class[]
-     */
-    public function get_question_groups($per_page, $current_page = 1, $count = false)
-    {
-        $questionGroupModel = EEM_Question_Group::instance();
-        $query_params       = $this->get_query_params($questionGroupModel, $per_page, $current_page);
-        if ($count) {
-            $where   = isset($query_params[0]) ? array($query_params[0]) : array();
-            $results = $questionGroupModel->count($where);
-        } else {
-            $results = $questionGroupModel->get_all($query_params);
-        }
-        return $results;
-    }
-
-
-    /**
-     * @param      $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return \EE_Soft_Delete_Base_Class[]|int
-     */
-    public function get_trashed_question_groups($per_page, $current_page = 1, $count = false)
-    {
-        $questionGroupModel = EEM_Question_Group::instance();
-        $query_params       = $this->get_query_params($questionGroupModel, $per_page, $current_page);
-        if ($count) {
-            $where                 = isset($query_params[0]) ? array($query_params[0]) : array();
-            $query_params['limit'] = null;
-            $results               = $questionGroupModel->count_deleted($where);
-        } else {
-            $results = $questionGroupModel->get_all_deleted($query_params);
-        }
-        return $results;
-    }
-
-
-    /**
-     * method for performing updates to question order
-     *
-     * @return array results array
-     */
-    public function update_question_group_order()
-    {
-
-        $success = esc_html__('Question group order was updated successfully.', 'event_espresso');
-
-        // grab our row IDs
-        $row_ids = isset($this->_req_data['row_ids']) && ! empty($this->_req_data['row_ids'])
-            ? explode(',', rtrim($this->_req_data['row_ids'], ','))
-            : array();
-
-        $perpage = ! empty($this->_req_data['perpage'])
-            ? (int)$this->_req_data['perpage']
-            : null;
-        $curpage = ! empty($this->_req_data['curpage'])
-            ? (int)$this->_req_data['curpage']
-            : null;
-
-        if (! empty($row_ids)) {
-            //figure out where we start the row_id count at for the current page.
-            $qsgcount = empty($curpage) ? 0 : ($curpage - 1) * $perpage;
-
-            $row_count = count($row_ids);
-            for ($i = 0; $i < $row_count; $i++) {
-                //Update the questions when re-ordering
-                $updated = EEM_Question_Group::instance()->update(
-                    array('QSG_order' => $qsgcount),
-                    array(array('QSG_ID' => $row_ids[$i]))
-                );
-                if ($updated === false) {
-                    $success = false;
-                }
-                $qsgcount++;
-            }
-        } else {
-            $success = false;
-        }
-
-        $errors = ! $success
-            ? esc_html__('An error occurred. The question group order was not updated.', 'event_espresso')
-            : false;
-
-        echo wp_json_encode(array('return_data' => false, 'success' => $success, 'errors' => $errors));
-        die();
-
-    }
-
-
-
-    /***************************************        REGISTRATION SETTINGS        ***************************************/
-
-
-    /**
-     * _reg_form_settings
-     *
-     * @throws \EE_Error
-     */
-    protected function _reg_form_settings()
-    {
-        $this->_template_args['values'] = $this->_yes_no_values;
-        add_action(
-            'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
-            array($this, 'email_validation_settings_form'),
-            2
-        );
-        $this->_template_args = (array)apply_filters(
-            'FHEE__Extend_Registration_Form_Admin_Page___reg_form_settings___template_args',
-            $this->_template_args
-        );
-        $this->_set_add_edit_form_tags('update_reg_form_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'reg_form_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * _update_reg_form_settings
-     */
-    protected function _update_reg_form_settings()
-    {
-        EE_Registry::instance()->CFG->registration = $this->update_email_validation_settings_form(
-            EE_Registry::instance()->CFG->registration
-        );
-        EE_Registry::instance()->CFG->registration = apply_filters(
-            'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
-            EE_Registry::instance()->CFG->registration
-        );
-        $success                                   = $this->_update_espresso_configuration(
-            esc_html__('Registration Form Options', 'event_espresso'),
-            EE_Registry::instance()->CFG,
-            __FILE__, __FUNCTION__, __LINE__
-        );
-        $this->_redirect_after_action($success, esc_html__('Registration Form Options', 'event_espresso'), 'updated',
-            array('action' => 'view_reg_form_settings'));
-    }
-
-
-    /**
-     * email_validation_settings_form
-     *
-     * @access    public
-     * @return    void
-     * @throws \EE_Error
-     */
-    public function email_validation_settings_form()
-    {
-        echo $this->_email_validation_settings_form()->get_html();
-    }
-
-
-    /**
-     * _email_validation_settings_form
-     *
-     * @access protected
-     * @return EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    protected function _email_validation_settings_form()
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'email_validation_settings',
-                'html_id'         => 'email_validation_settings',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Extend_Registration_Form_Admin_Page___email_validation_settings_form__form_subsections',
-                    array(
-                        'email_validation_hdr'   => new EE_Form_Section_HTML(
-                            EEH_HTML::h2(esc_html__('Email Validation Settings', 'event_espresso'))
-                        ),
-                        'email_validation_level' => new EE_Select_Input(
-                            array(
-                                'basic'      => esc_html__('Basic', 'event_espresso'),
-                                'wp_default' => esc_html__('WordPress Default', 'event_espresso'),
-                                'i18n'       => esc_html__('International', 'event_espresso'),
-                                'i18n_dns'   => esc_html__('International + DNS Check', 'event_espresso'),
-                            ),
-                            array(
-                                'html_label_text' => esc_html__('Email Validation Level', 'event_espresso')
-                                                     . EEH_Template::get_help_tab_link('email_validation_info'),
-                                'html_help_text'  => esc_html__('These levels range from basic validation ( ie: text@text.text ) to more advanced checks against international email addresses (ie: üñîçøðé@example.com ) with additional MX and A record checks to confirm the domain actually exists. More information on on each level can be found within the help section.',
-                                    'event_espresso'),
-                                'default'         => isset(EE_Registry::instance()->CFG->registration->email_validation_level)
-                                    ? EE_Registry::instance()->CFG->registration->email_validation_level
-                                    : 'wp_default',
-                                'required'        => false,
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * update_email_validation_settings_form
-     *
-     * @access    public
-     * @param \EE_Registration_Config $EE_Registration_Config
-     * @return \EE_Registration_Config
-     */
-    public function update_email_validation_settings_form(EE_Registration_Config $EE_Registration_Config)
-    {
-        $prev_email_validation_level = $EE_Registration_Config->email_validation_level;
-        try {
-            $email_validation_settings_form = $this->_email_validation_settings_form();
-            // if not displaying a form, then check for form submission
-            if ($email_validation_settings_form->was_submitted()) {
-                // capture form data
-                $email_validation_settings_form->receive_form_submission();
-                // validate form data
-                if ($email_validation_settings_form->is_valid()) {
-                    // grab validated data from form
-                    $valid_data = $email_validation_settings_form->valid_data();
-                    if (isset($valid_data['email_validation_level'])) {
-                        $email_validation_level = $valid_data['email_validation_level'];
-                        // now if they want to use international email addresses
-                        if ($email_validation_level === 'i18n' || $email_validation_level === 'i18n_dns') {
-                            // in case we need to reset their email validation level,
-                            // make sure that the previous value wasn't already set to one of the i18n options.
-                            if ($prev_email_validation_level === 'i18n' || $prev_email_validation_level === 'i18n_dns') {
-                                // if so, then reset it back to "basic" since that is the only other option that,
-                                // despite offering poor validation, supports i18n email addresses
-                                $prev_email_validation_level = 'basic';
-                            }
-                            // confirm our i18n email validation will work on the server
-                            if (! $this->_verify_pcre_support($EE_Registration_Config, $email_validation_level)) {
-                                // or reset email validation level to previous value
-                                $email_validation_level = $prev_email_validation_level;
-                            }
-                        }
-                        $EE_Registration_Config->email_validation_level = $email_validation_level;
-                    } else {
-                        EE_Error::add_error(
-                            esc_html__(
-                                'Invalid or missing Email Validation settings. Please refresh the form and try again.',
-                                'event_espresso'
-                            ),
-                            __FILE__, __FUNCTION__, __LINE__
-                        );
-                    }
-                } else {
-                    if ($email_validation_settings_form->submission_error_message() !== '') {
-                        EE_Error::add_error(
-                            $email_validation_settings_form->submission_error_message(),
-                            __FILE__, __FUNCTION__, __LINE__
-                        );
-                    }
-                }
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-        return $EE_Registration_Config;
-    }
-
-
-    /**
-     * confirms that the server's PHP version has the PCRE module enabled,
-     * and that the PCRE version works with our i18n email validation
-     *
-     * @param \EE_Registration_Config $EE_Registration_Config
-     * @param string                  $email_validation_level
-     * @return bool
-     */
-    private function _verify_pcre_support(EE_Registration_Config $EE_Registration_Config, $email_validation_level)
-    {
-        // first check that PCRE is enabled
-        if (! defined('PREG_BAD_UTF8_ERROR')) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry, but it appears that your server\'s version of PHP was not compiled with PCRE unicode support.%1$sPlease contact your hosting company and ask them whether the PCRE compiled with your version of PHP on your server can be been built with the "--enable-unicode-properties" and "--enable-utf8" configuration switches to enable more complex regex expressions.%1$sIf they are unable, or unwilling to do so, then your server will not support international email addresses using UTF-8 unicode characters. This means you will either have to lower your email validation level to "Basic" or "WordPress Default", or switch to a hosting company that has/can enable PCRE unicode support on the server.',
-                        'event_espresso'
-                    ),
-                    '<br />'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        } else {
-            // PCRE support is enabled, but let's still
-            // perform a test to see if the server will support it.
-            // but first, save the updated validation level to the config,
-            // so that the validation strategy picks it up.
-            // this will get bumped back down if it doesn't work
-            $EE_Registration_Config->email_validation_level = $email_validation_level;
-            try {
-                $email_validator    = new EE_Email_Validation_Strategy();
-                $i18n_email_address = apply_filters(
-                    'FHEE__Extend_Registration_Form_Admin_Page__update_email_validation_settings_form__i18n_email_address',
-                    'jägerjürgen@deutschland.com'
-                );
-                $email_validator->validate($i18n_email_address);
-            } catch (Exception $e) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'We\'re sorry, but it appears that your server\'s configuration will not support the "International" or "International + DNS Check" email validation levels.%1$sTo correct this issue, please consult with your hosting company regarding your server\'s PCRE settings.%1$sIt is recommended that your PHP version be configured to use PCRE 8.10 or newer.%1$sMore information regarding PCRE versions and installation can be found here: %2$s',
-                            'event_espresso'
-                        ),
-                        '<br />',
-                        '<a href="http://php.net/manual/en/pcre.installation.php" target="_blank">http://php.net/manual/en/pcre.installation.php</a>'
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @access public
+	 */
+	public function __construct($routing = true)
+	{
+		define('REGISTRATION_FORM_CAF_ADMIN', EE_CORE_CAF_ADMIN_EXTEND . 'registration_form' . DS);
+		define('REGISTRATION_FORM_CAF_ASSETS_PATH', REGISTRATION_FORM_CAF_ADMIN . 'assets' . DS);
+		define('REGISTRATION_FORM_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/assets/');
+		define('REGISTRATION_FORM_CAF_TEMPLATE_PATH', REGISTRATION_FORM_CAF_ADMIN . 'templates' . DS);
+		define('REGISTRATION_FORM_CAF_TEMPLATE_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/templates/');
+		parent::__construct($routing);
+	}
+
+
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = REGISTRATION_FORM_CAF_ADMIN;
+		$qst_id = ! empty($this->_req_data['QST_ID']) && ! is_array($this->_req_data['QST_ID']) ? $this->_req_data['QST_ID'] : 0;
+		$qsg_id = ! empty($this->_req_data['QSG_ID']) && ! is_array($this->_req_data['QSG_ID']) ? $this->_req_data['QSG_ID'] : 0;
+
+		$new_page_routes    = array(
+			'question_groups'    => array(
+				'func'       => '_question_groups_overview_list_table',
+				'capability' => 'ee_read_question_groups',
+			),
+			'add_question'       => array(
+				'func'       => '_edit_question',
+				'capability' => 'ee_edit_questions',
+			),
+			'insert_question'    => array(
+				'func'       => '_insert_or_update_question',
+				'args'       => array('new_question' => true),
+				'capability' => 'ee_edit_questions',
+				'noheader'   => true,
+			),
+			'duplicate_question' => array(
+				'func'       => '_duplicate_question',
+				'capability' => 'ee_edit_questions',
+				'noheader'   => true,
+			),
+			'trash_question'     => array(
+				'func'       => '_trash_question',
+				'capability' => 'ee_delete_question',
+				'obj_id'     => $qst_id,
+				'noheader'   => true,
+			),
+
+			'restore_question' => array(
+				'func'       => '_trash_or_restore_questions',
+				'capability' => 'ee_delete_question',
+				'obj_id'     => $qst_id,
+				'args'       => array('trash' => false),
+				'noheader'   => true,
+			),
+
+			'delete_question' => array(
+				'func'       => '_delete_question',
+				'capability' => 'ee_delete_question',
+				'obj_id'     => $qst_id,
+				'noheader'   => true,
+			),
+
+			'trash_questions' => array(
+				'func'       => '_trash_or_restore_questions',
+				'capability' => 'ee_delete_questions',
+				'args'       => array('trash' => true),
+				'noheader'   => true,
+			),
+
+			'restore_questions' => array(
+				'func'       => '_trash_or_restore_questions',
+				'capability' => 'ee_delete_questions',
+				'args'       => array('trash' => false),
+				'noheader'   => true,
+			),
+
+			'delete_questions' => array(
+				'func'       => '_delete_questions',
+				'args'       => array(),
+				'capability' => 'ee_delete_questions',
+				'noheader'   => true,
+			),
+
+			'add_question_group' => array(
+				'func'       => '_edit_question_group',
+				'capability' => 'ee_edit_question_groups',
+			),
+
+			'edit_question_group' => array(
+				'func'       => '_edit_question_group',
+				'capability' => 'ee_edit_question_group',
+				'obj_id'     => $qsg_id,
+				'args'       => array('edit'),
+			),
+
+			'delete_question_groups' => array(
+				'func'       => '_delete_question_groups',
+				'capability' => 'ee_delete_question_groups',
+				'noheader'   => true,
+			),
+
+			'delete_question_group' => array(
+				'func'       => '_delete_question_groups',
+				'capability' => 'ee_delete_question_group',
+				'obj_id'     => $qsg_id,
+				'noheader'   => true,
+			),
+
+			'trash_question_group' => array(
+				'func'       => '_trash_or_restore_question_groups',
+				'args'       => array('trash' => true),
+				'capability' => 'ee_delete_question_group',
+				'obj_id'     => $qsg_id,
+				'noheader'   => true,
+			),
+
+			'restore_question_group' => array(
+				'func'       => '_trash_or_restore_question_groups',
+				'args'       => array('trash' => false),
+				'capability' => 'ee_delete_question_group',
+				'obj_id'     => $qsg_id,
+				'noheader'   => true,
+			),
+
+			'insert_question_group' => array(
+				'func'       => '_insert_or_update_question_group',
+				'args'       => array('new_question_group' => true),
+				'capability' => 'ee_edit_question_groups',
+				'noheader'   => true,
+			),
+
+			'update_question_group' => array(
+				'func'       => '_insert_or_update_question_group',
+				'args'       => array('new_question_group' => false),
+				'capability' => 'ee_edit_question_group',
+				'obj_id'     => $qsg_id,
+				'noheader'   => true,
+			),
+
+			'trash_question_groups' => array(
+				'func'       => '_trash_or_restore_question_groups',
+				'args'       => array('trash' => true),
+				'capability' => 'ee_delete_question_groups',
+				'noheader'   => array('trash' => false),
+			),
+
+			'restore_question_groups' => array(
+				'func'       => '_trash_or_restore_question_groups',
+				'args'       => array('trash' => false),
+				'capability' => 'ee_delete_question_groups',
+				'noheader'   => true,
+			),
+
+
+			'espresso_update_question_group_order' => array(
+				'func'       => 'update_question_group_order',
+				'capability' => 'ee_edit_question_groups',
+				'noheader'   => true,
+			),
+
+			'view_reg_form_settings' => array(
+				'func'       => '_reg_form_settings',
+				'capability' => 'manage_options',
+			),
+
+			'update_reg_form_settings' => array(
+				'func'       => '_update_reg_form_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+		);
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+
+		$new_page_config    = array(
+
+			'question_groups' => array(
+				'nav'           => array(
+					'label' => esc_html__('Question Groups', 'event_espresso'),
+					'order' => 20,
+				),
+				'list_table'    => 'Registration_Form_Question_Groups_Admin_List_Table',
+				'help_tabs'     => array(
+					'registration_form_question_groups_help_tab'                           => array(
+						'title'    => esc_html__('Question Groups', 'event_espresso'),
+						'filename' => 'registration_form_question_groups',
+					),
+					'registration_form_question_groups_table_column_headings_help_tab'     => array(
+						'title'    => esc_html__('Question Groups Table Column Headings', 'event_espresso'),
+						'filename' => 'registration_form_question_groups_table_column_headings',
+					),
+					'registration_form_question_groups_views_bulk_actions_search_help_tab' => array(
+						'title'    => esc_html__('Question Groups Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'registration_form_question_groups_views_bulk_actions_search',
+					),
+				),
+				'help_tour'     => array('Registration_Form_Question_Groups_Help_Tour'),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+				'qtips'         => array(
+					'EE_Registration_Form_Tips',
+				),
+			),
+
+			'add_question' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Question', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'registration_form_add_question_help_tab' => array(
+						'title'    => esc_html__('Add Question', 'event_espresso'),
+						'filename' => 'registration_form_add_question',
+					),
+				),
+				'help_tour'     => array('Registration_Form_Add_Question_Help_Tour'),
+				'require_nonce' => false,
+			),
+
+			'add_question_group' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Question Group', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'registration_form_add_question_group_help_tab' => array(
+						'title'    => esc_html__('Add Question Group', 'event_espresso'),
+						'filename' => 'registration_form_add_question_group',
+					),
+				),
+				'help_tour'     => array('Registration_Form_Add_Question_Group_Help_Tour'),
+				'require_nonce' => false,
+			),
+
+			'edit_question_group' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Question Group', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['question_group_id']) ? add_query_arg(array('question_group_id' => $this->_req_data['question_group_id']),
+						$this->_current_page_view_url) : $this->_admin_base_url,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'registration_form_edit_question_group_help_tab' => array(
+						'title'    => esc_html__('Edit Question Group', 'event_espresso'),
+						'filename' => 'registration_form_edit_question_group',
+					),
+				),
+				'help_tour'     => array('Registration_Form_Edit_Question_Group_Help_Tour'),
+				'require_nonce' => false,
+			),
+
+			'view_reg_form_settings' => array(
+				'nav'           => array(
+					'label' => esc_html__('Reg Form Settings', 'event_espresso'),
+					'order' => 40,
+				),
+				'labels'        => array(
+					'publishbox' => esc_html__('Update Settings', 'event_espresso'),
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'registration_form_reg_form_settings_help_tab' => array(
+						'title'    => esc_html__('Registration Form Settings', 'event_espresso'),
+						'filename' => 'registration_form_reg_form_settings',
+					),
+				),
+				'help_tour'     => array('Registration_Form_Settings_Help_Tour'),
+				'require_nonce' => false,
+			),
+
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+
+		//change the list table we're going to use so it's the NEW list table!
+		$this->_page_config['default']['list_table'] = 'Extend_Registration_Form_Questions_Admin_List_Table';
+
+
+		//additional labels
+		$new_labels               = array(
+			'add_question'          => esc_html__('Add New Question', 'event_espresso'),
+			'delete_question'       => esc_html__('Delete Question', 'event_espresso'),
+			'add_question_group'    => esc_html__('Add New Question Group', 'event_espresso'),
+			'edit_question_group'   => esc_html__('Edit Question Group', 'event_espresso'),
+			'delete_question_group' => esc_html__('Delete Question Group', 'event_espresso'),
+		);
+		$this->_labels['buttons'] = array_merge($this->_labels['buttons'], $new_labels);
+
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_espresso_update_question_group_order', array($this, 'update_question_group_order'));
+	}
+
+
+	public function load_scripts_styles_question_groups()
+	{
+		wp_enqueue_script('espresso_ajax_table_sorting');
+	}
+
+
+	public function load_scripts_styles_add_question_group()
+	{
+		$this->load_scripts_styles_forms();
+		$this->load_sortable_question_script();
+	}
+
+	public function load_scripts_styles_edit_question_group()
+	{
+		$this->load_scripts_styles_forms();
+		$this->load_sortable_question_script();
+	}
+
+
+	/**
+	 * registers and enqueues script for questions
+	 *
+	 * @return void
+	 */
+	public function load_sortable_question_script()
+	{
+		wp_register_script('ee-question-sortable', REGISTRATION_FORM_CAF_ASSETS_URL . 'ee_question_order.js',
+			array('jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
+		wp_enqueue_script('ee-question-sortable');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Questions', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_questions' => esc_html__('Trash', 'event_espresso'),
+				),
+			),
+		);
+
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_questions',
+			'espresso_registration_form_trash_questions')
+		) {
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'delete_questions'  => esc_html__('Delete Permanently', 'event_espresso'),
+					'restore_questions' => esc_html__('Restore', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	protected function _set_list_table_views_question_groups()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_question_groups' => esc_html__('Trash', 'event_espresso'),
+				),
+			),
+		);
+
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_question_groups',
+			'espresso_registration_form_trash_question_groups')
+		) {
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'delete_question_groups'  => esc_html__('Delete Permanently', 'event_espresso'),
+					'restore_question_groups' => esc_html__('Restore', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	protected function _questions_overview_list_table()
+	{
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+				'add_question',
+				'add_question',
+				array(),
+				'add-new-h2'
+			);
+		parent::_questions_overview_list_table();
+	}
+
+
+	protected function _question_groups_overview_list_table()
+	{
+		$this->_search_btn_label = esc_html__('Question Groups', 'event_espresso');
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+				'add_question_group',
+				'add_question_group',
+				array(),
+				'add-new-h2'
+			);
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	protected function _delete_question()
+	{
+		$success = $this->_delete_items($this->_question_model);
+		$this->_redirect_after_action(
+			$success,
+			$this->_question_model->item_name($success),
+			'deleted',
+			array('action' => 'default', 'status' => 'all')
+		);
+	}
+
+
+	protected function _delete_questions()
+	{
+		$success = $this->_delete_items($this->_question_model);
+		$this->_redirect_after_action(
+			$success,
+			$this->_question_model->item_name($success),
+			'deleted permanently',
+			array('action' => 'default', 'status' => 'trash')
+		);
+	}
+
+
+	/**
+	 * Performs the deletion of a single or multiple questions or question groups.
+	 *
+	 * @param EEM_Soft_Delete_Base $model
+	 * @return int number of items deleted permanently
+	 */
+	private function _delete_items(EEM_Soft_Delete_Base $model)
+	{
+		$success = 0;
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element than success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			// cycle thru bulk action checkboxes
+			while (list($ID, $value) = each($this->_req_data['checkbox'])) {
+				if (! $this->_delete_item($ID, $model)) {
+					$success = 0;
+				}
+			}
+
+		} elseif (! empty($this->_req_data['QSG_ID'])) {
+			$success = $this->_delete_item($this->_req_data['QSG_ID'], $model);
+
+		} elseif (! empty($this->_req_data['QST_ID'])) {
+			$success = $this->_delete_item($this->_req_data['QST_ID'], $model);
+		} else {
+			EE_Error::add_error(sprintf(esc_html__("No Questions or Question Groups were selected for deleting. This error usually shows when you've attempted to delete via bulk action but there were no selections.",
+				"event_espresso")), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return $success;
+	}
+
+	/**
+	 * Deletes the specified question (and its associated question options) or question group
+	 *
+	 * @param int                  $id
+	 * @param EEM_Soft_Delete_Base $model
+	 * @return boolean
+	 */
+	protected function _delete_item($id, $model)
+	{
+		if ($model instanceof EEM_Question) {
+			EEM_Question_Option::instance()->delete_permanently(array(array('QST_ID' => absint($id))));
+		}
+		return $model->delete_permanently_by_ID(absint($id));
+	}
+
+
+	/******************************    QUESTION GROUPS    ******************************/
+
+
+	protected function _edit_question_group($type = 'add')
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$ID = isset($this->_req_data['QSG_ID']) && ! empty($this->_req_data['QSG_ID']) ? absint($this->_req_data['QSG_ID']) : false;
+
+		switch ($this->_req_action) {
+			case 'add_question_group' :
+				$this->_admin_page_title = esc_html__('Add Question Group', 'event_espresso');
+				break;
+			case 'edit_question_group' :
+				$this->_admin_page_title = esc_html__('Edit Question Group', 'event_espresso');
+				break;
+			default :
+				$this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
+		}
+		// add ID to title if editing
+		$this->_admin_page_title = $ID ? $this->_admin_page_title . ' # ' . $ID : $this->_admin_page_title;
+		if ($ID) {
+			/** @var EE_Question_Group $questionGroup */
+			$questionGroup            = $this->_question_group_model->get_one_by_ID($ID);
+			$additional_hidden_fields = array('QSG_ID' => array('type' => 'hidden', 'value' => $ID));
+			$this->_set_add_edit_form_tags('update_question_group', $additional_hidden_fields);
+		} else {
+			/** @var EE_Question_Group $questionGroup */
+			$questionGroup = EEM_Question_Group::instance()->create_default_object();
+			$questionGroup->set_order_to_latest();
+			$this->_set_add_edit_form_tags('insert_question_group');
+		}
+		$this->_template_args['values']         = $this->_yes_no_values;
+		$this->_template_args['all_questions']  = $questionGroup->questions_in_and_not_in_group();
+		$this->_template_args['QSG_ID']         = $ID ? $ID : true;
+		$this->_template_args['question_group'] = $questionGroup;
+
+		$redirect_URL = add_query_arg(array('action' => 'question_groups'), $this->_admin_base_url);
+		$this->_set_publish_post_box_vars('id', $ID, false, $redirect_URL);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'question_groups_main_meta_box.template.php',
+			$this->_template_args, true);
+
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _delete_question_groups()
+	{
+		$success = $this->_delete_items($this->_question_group_model);
+		$this->_redirect_after_action($success, $this->_question_group_model->item_name($success),
+			'deleted permanently', array('action' => 'question_groups', 'status' => 'trash'));
+	}
+
+
+	/**
+	 * @param bool $new_question_group
+	 */
+	protected function _insert_or_update_question_group($new_question_group = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$set_column_values = $this->_set_column_values_for($this->_question_group_model);
+		if ($new_question_group) {
+			$QSG_ID  = $this->_question_group_model->insert($set_column_values);
+			$success = $QSG_ID ? 1 : 0;
+		} else {
+			$QSG_ID = absint($this->_req_data['QSG_ID']);
+			unset($set_column_values['QSG_ID']);
+			$success = $this->_question_group_model->update($set_column_values, array(array('QSG_ID' => $QSG_ID)));
+		}
+		$phone_question_id = EEM_Question::instance()->get_Question_ID_from_system_string(EEM_Attendee::system_question_phone);
+		// update the existing related questions
+		// BUT FIRST...  delete the phone question from the Question_Group_Question if it is being added to this question group (therefore removed from the existing group)
+		if (isset($this->_req_data['questions'], $this->_req_data['questions'][$phone_question_id])) {
+			// delete where QST ID = system phone question ID and Question Group ID is NOT this group
+			EEM_Question_Group_Question::instance()->delete(array(
+				array(
+					'QST_ID' => $phone_question_id,
+					'QSG_ID' => array('!=', $QSG_ID),
+				),
+			));
+		}
+		/** @type EE_Question_Group $question_group */
+		$question_group = $this->_question_group_model->get_one_by_ID($QSG_ID);
+		$questions      = $question_group->questions();
+		// make sure system phone question is added to list of questions for this group
+		if (! isset($questions[$phone_question_id])) {
+			$questions[$phone_question_id] = EEM_Question::instance()->get_one_by_ID($phone_question_id);
+		}
+
+		foreach ($questions as $question_ID => $question) {
+			// first we always check for order.
+			if (! empty($this->_req_data['question_orders'][$question_ID])) {
+				//update question order
+				$question_group->update_question_order($question_ID, $this->_req_data['question_orders'][$question_ID]);
+			}
+
+			// then we always check if adding or removing.
+			if (isset($this->_req_data['questions'], $this->_req_data['questions'][$question_ID])) {
+				$question_group->add_question($question_ID);
+			} else {
+				// not found, remove it (but only if not a system question for the personal group with the exception of lname system question - we allow removal of it)
+				if (
+				in_array(
+					$question->system_ID(),
+					EEM_Question::instance()->required_system_questions_in_system_question_group($question_group->system_group())
+				)
+				) {
+					continue;
+				} else {
+					$question_group->remove_question($question_ID);
+				}
+			}
+		}
+		// save new related questions
+		if (isset($this->_req_data['questions'])) {
+			foreach ($this->_req_data['questions'] as $QST_ID) {
+				$question_group->add_question($QST_ID);
+				if (isset($this->_req_data['question_orders'][$QST_ID])) {
+					$question_group->update_question_order($QST_ID, $this->_req_data['question_orders'][$QST_ID]);
+				}
+			}
+		}
+
+		if ($success !== false) {
+			$msg = $new_question_group ? sprintf(esc_html__('The %s has been created', 'event_espresso'),
+				$this->_question_group_model->item_name()) : sprintf(esc_html__('The %s has been updated',
+				'event_espresso'), $this->_question_group_model->item_name());
+			EE_Error::add_success($msg);
+		}
+		$this->_redirect_after_action(false, '', '', array('action' => 'edit_question_group', 'QSG_ID' => $QSG_ID),
+			true);
+
+	}
+
+	/**
+	 * duplicates a question and all its question options and redirects to the new question.
+	 */
+	public function _duplicate_question()
+	{
+		$question_ID = (int)$this->_req_data['QST_ID'];
+		$question    = EEM_Question::instance()->get_one_by_ID($question_ID);
+		if ($question instanceof EE_Question) {
+			$new_question = $question->duplicate();
+			if ($new_question instanceof EE_Question) {
+				$this->_redirect_after_action(true, esc_html__('Question', 'event_espresso'),
+					esc_html__('Duplicated', 'event_espresso'),
+					array('action' => 'edit_question', 'QST_ID' => $new_question->ID()), true);
+			} else {
+				global $wpdb;
+				EE_Error::add_error(sprintf(esc_html__('Could not duplicate question with ID %1$d because: %2$s',
+					'event_espresso'), $question_ID, $wpdb->last_error), __FILE__, __FUNCTION__, __LINE__);
+				$this->_redirect_after_action(false, '', '', array('action' => 'default'), false);
+			}
+		} else {
+			EE_Error::add_error(sprintf(esc_html__('Could not duplicate question with ID %d because it didn\'t exist!',
+				'event_espresso'), $question_ID), __FILE__, __FUNCTION__, __LINE__);
+			$this->_redirect_after_action(false, '', '', array('action' => 'default'), false);
+		}
+	}
+
+
+	/**
+	 * @param bool $trash
+	 */
+	protected function _trash_or_restore_question_groups($trash = true)
+	{
+		$this->_trash_or_restore_items($this->_question_group_model, $trash);
+	}
+
+
+	/**
+	 *_trash_question
+	 */
+	protected function _trash_question()
+	{
+		$success    = $this->_question_model->delete_by_ID((int)$this->_req_data['QST_ID']);
+		$query_args = array('action' => 'default', 'status' => 'all');
+		$this->_redirect_after_action($success, $this->_question_model->item_name($success), 'trashed', $query_args);
+	}
+
+
+	/**
+	 * @param bool $trash
+	 */
+	protected function _trash_or_restore_questions($trash = true)
+	{
+		$this->_trash_or_restore_items($this->_question_model, $trash);
+	}
+
+
+	/**
+	 * Internally used to delete or restore items, using the request data. Meant to be
+	 * flexible between question or question groups
+	 *
+	 * @param EEM_Soft_Delete_Base $model
+	 * @param boolean              $trash whether to trash or restore
+	 */
+	private function _trash_or_restore_items(EEM_Soft_Delete_Base $model, $trash = true)
+	{
+
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+
+		$success = 1;
+		//Checkboxes
+		//echo "trash $trash";
+		//var_dump($this->_req_data['checkbox']);die;
+		if (isset($this->_req_data['checkbox'])) {
+			if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+				// if array has more than one element than success message should be plural
+				$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+				// cycle thru bulk action checkboxes
+				while (list($ID, $value) = each($this->_req_data['checkbox'])) {
+					if (! $model->delete_or_restore_by_ID($trash, absint($ID))) {
+						$success = 0;
+					}
+				}
+
+			} else {
+				// grab single id and delete
+				$ID = absint($this->_req_data['checkbox']);
+				if (! $model->delete_or_restore_by_ID($trash, $ID)) {
+					$success = 0;
+				}
+			}
+
+		} else {
+			// delete via trash link
+			// grab single id and delete
+			$ID = absint($this->_req_data[$model->primary_key_name()]);
+			if (! $model->delete_or_restore_by_ID($trash, $ID)) {
+				$success = 0;
+			}
+
+		}
+
+
+		$action = $model instanceof EEM_Question ? 'default' : 'question_groups';//strtolower( $model->item_name(2) );
+		//echo "action :$action";
+		//$action = 'questions' ? 'default' : $action;
+		if ($trash) {
+			$action_desc = 'trashed';
+			$status      = 'trash';
+		} else {
+			$action_desc = 'restored';
+			$status      = 'all';
+		}
+		$this->_redirect_after_action($success, $model->item_name($success), $action_desc,
+			array('action' => $action, 'status' => $status));
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return \EE_Soft_Delete_Base_Class[]|int
+	 */
+	public function get_trashed_questions($per_page, $current_page = 1, $count = false)
+	{
+		$query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
+
+		if ($count) {
+			//note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
+			$where   = isset($query_params[0]) ? array($query_params[0]) : array();
+			$results = $this->_question_model->count_deleted($where);
+		} else {
+			//note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
+			$results = $this->_question_model->get_all_deleted($query_params);
+		}
+		return $results;
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return \EE_Soft_Delete_Base_Class[]
+	 */
+	public function get_question_groups($per_page, $current_page = 1, $count = false)
+	{
+		$questionGroupModel = EEM_Question_Group::instance();
+		$query_params       = $this->get_query_params($questionGroupModel, $per_page, $current_page);
+		if ($count) {
+			$where   = isset($query_params[0]) ? array($query_params[0]) : array();
+			$results = $questionGroupModel->count($where);
+		} else {
+			$results = $questionGroupModel->get_all($query_params);
+		}
+		return $results;
+	}
+
+
+	/**
+	 * @param      $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return \EE_Soft_Delete_Base_Class[]|int
+	 */
+	public function get_trashed_question_groups($per_page, $current_page = 1, $count = false)
+	{
+		$questionGroupModel = EEM_Question_Group::instance();
+		$query_params       = $this->get_query_params($questionGroupModel, $per_page, $current_page);
+		if ($count) {
+			$where                 = isset($query_params[0]) ? array($query_params[0]) : array();
+			$query_params['limit'] = null;
+			$results               = $questionGroupModel->count_deleted($where);
+		} else {
+			$results = $questionGroupModel->get_all_deleted($query_params);
+		}
+		return $results;
+	}
+
+
+	/**
+	 * method for performing updates to question order
+	 *
+	 * @return array results array
+	 */
+	public function update_question_group_order()
+	{
+
+		$success = esc_html__('Question group order was updated successfully.', 'event_espresso');
+
+		// grab our row IDs
+		$row_ids = isset($this->_req_data['row_ids']) && ! empty($this->_req_data['row_ids'])
+			? explode(',', rtrim($this->_req_data['row_ids'], ','))
+			: array();
+
+		$perpage = ! empty($this->_req_data['perpage'])
+			? (int)$this->_req_data['perpage']
+			: null;
+		$curpage = ! empty($this->_req_data['curpage'])
+			? (int)$this->_req_data['curpage']
+			: null;
+
+		if (! empty($row_ids)) {
+			//figure out where we start the row_id count at for the current page.
+			$qsgcount = empty($curpage) ? 0 : ($curpage - 1) * $perpage;
+
+			$row_count = count($row_ids);
+			for ($i = 0; $i < $row_count; $i++) {
+				//Update the questions when re-ordering
+				$updated = EEM_Question_Group::instance()->update(
+					array('QSG_order' => $qsgcount),
+					array(array('QSG_ID' => $row_ids[$i]))
+				);
+				if ($updated === false) {
+					$success = false;
+				}
+				$qsgcount++;
+			}
+		} else {
+			$success = false;
+		}
+
+		$errors = ! $success
+			? esc_html__('An error occurred. The question group order was not updated.', 'event_espresso')
+			: false;
+
+		echo wp_json_encode(array('return_data' => false, 'success' => $success, 'errors' => $errors));
+		die();
+
+	}
+
+
+
+	/***************************************        REGISTRATION SETTINGS        ***************************************/
+
+
+	/**
+	 * _reg_form_settings
+	 *
+	 * @throws \EE_Error
+	 */
+	protected function _reg_form_settings()
+	{
+		$this->_template_args['values'] = $this->_yes_no_values;
+		add_action(
+			'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
+			array($this, 'email_validation_settings_form'),
+			2
+		);
+		$this->_template_args = (array)apply_filters(
+			'FHEE__Extend_Registration_Form_Admin_Page___reg_form_settings___template_args',
+			$this->_template_args
+		);
+		$this->_set_add_edit_form_tags('update_reg_form_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'reg_form_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * _update_reg_form_settings
+	 */
+	protected function _update_reg_form_settings()
+	{
+		EE_Registry::instance()->CFG->registration = $this->update_email_validation_settings_form(
+			EE_Registry::instance()->CFG->registration
+		);
+		EE_Registry::instance()->CFG->registration = apply_filters(
+			'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
+			EE_Registry::instance()->CFG->registration
+		);
+		$success                                   = $this->_update_espresso_configuration(
+			esc_html__('Registration Form Options', 'event_espresso'),
+			EE_Registry::instance()->CFG,
+			__FILE__, __FUNCTION__, __LINE__
+		);
+		$this->_redirect_after_action($success, esc_html__('Registration Form Options', 'event_espresso'), 'updated',
+			array('action' => 'view_reg_form_settings'));
+	}
+
+
+	/**
+	 * email_validation_settings_form
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public function email_validation_settings_form()
+	{
+		echo $this->_email_validation_settings_form()->get_html();
+	}
+
+
+	/**
+	 * _email_validation_settings_form
+	 *
+	 * @access protected
+	 * @return EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	protected function _email_validation_settings_form()
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'email_validation_settings',
+				'html_id'         => 'email_validation_settings',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Extend_Registration_Form_Admin_Page___email_validation_settings_form__form_subsections',
+					array(
+						'email_validation_hdr'   => new EE_Form_Section_HTML(
+							EEH_HTML::h2(esc_html__('Email Validation Settings', 'event_espresso'))
+						),
+						'email_validation_level' => new EE_Select_Input(
+							array(
+								'basic'      => esc_html__('Basic', 'event_espresso'),
+								'wp_default' => esc_html__('WordPress Default', 'event_espresso'),
+								'i18n'       => esc_html__('International', 'event_espresso'),
+								'i18n_dns'   => esc_html__('International + DNS Check', 'event_espresso'),
+							),
+							array(
+								'html_label_text' => esc_html__('Email Validation Level', 'event_espresso')
+													 . EEH_Template::get_help_tab_link('email_validation_info'),
+								'html_help_text'  => esc_html__('These levels range from basic validation ( ie: text@text.text ) to more advanced checks against international email addresses (ie: üñîçøðé@example.com ) with additional MX and A record checks to confirm the domain actually exists. More information on on each level can be found within the help section.',
+									'event_espresso'),
+								'default'         => isset(EE_Registry::instance()->CFG->registration->email_validation_level)
+									? EE_Registry::instance()->CFG->registration->email_validation_level
+									: 'wp_default',
+								'required'        => false,
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * update_email_validation_settings_form
+	 *
+	 * @access    public
+	 * @param \EE_Registration_Config $EE_Registration_Config
+	 * @return \EE_Registration_Config
+	 */
+	public function update_email_validation_settings_form(EE_Registration_Config $EE_Registration_Config)
+	{
+		$prev_email_validation_level = $EE_Registration_Config->email_validation_level;
+		try {
+			$email_validation_settings_form = $this->_email_validation_settings_form();
+			// if not displaying a form, then check for form submission
+			if ($email_validation_settings_form->was_submitted()) {
+				// capture form data
+				$email_validation_settings_form->receive_form_submission();
+				// validate form data
+				if ($email_validation_settings_form->is_valid()) {
+					// grab validated data from form
+					$valid_data = $email_validation_settings_form->valid_data();
+					if (isset($valid_data['email_validation_level'])) {
+						$email_validation_level = $valid_data['email_validation_level'];
+						// now if they want to use international email addresses
+						if ($email_validation_level === 'i18n' || $email_validation_level === 'i18n_dns') {
+							// in case we need to reset their email validation level,
+							// make sure that the previous value wasn't already set to one of the i18n options.
+							if ($prev_email_validation_level === 'i18n' || $prev_email_validation_level === 'i18n_dns') {
+								// if so, then reset it back to "basic" since that is the only other option that,
+								// despite offering poor validation, supports i18n email addresses
+								$prev_email_validation_level = 'basic';
+							}
+							// confirm our i18n email validation will work on the server
+							if (! $this->_verify_pcre_support($EE_Registration_Config, $email_validation_level)) {
+								// or reset email validation level to previous value
+								$email_validation_level = $prev_email_validation_level;
+							}
+						}
+						$EE_Registration_Config->email_validation_level = $email_validation_level;
+					} else {
+						EE_Error::add_error(
+							esc_html__(
+								'Invalid or missing Email Validation settings. Please refresh the form and try again.',
+								'event_espresso'
+							),
+							__FILE__, __FUNCTION__, __LINE__
+						);
+					}
+				} else {
+					if ($email_validation_settings_form->submission_error_message() !== '') {
+						EE_Error::add_error(
+							$email_validation_settings_form->submission_error_message(),
+							__FILE__, __FUNCTION__, __LINE__
+						);
+					}
+				}
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+		return $EE_Registration_Config;
+	}
+
+
+	/**
+	 * confirms that the server's PHP version has the PCRE module enabled,
+	 * and that the PCRE version works with our i18n email validation
+	 *
+	 * @param \EE_Registration_Config $EE_Registration_Config
+	 * @param string                  $email_validation_level
+	 * @return bool
+	 */
+	private function _verify_pcre_support(EE_Registration_Config $EE_Registration_Config, $email_validation_level)
+	{
+		// first check that PCRE is enabled
+		if (! defined('PREG_BAD_UTF8_ERROR')) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry, but it appears that your server\'s version of PHP was not compiled with PCRE unicode support.%1$sPlease contact your hosting company and ask them whether the PCRE compiled with your version of PHP on your server can be been built with the "--enable-unicode-properties" and "--enable-utf8" configuration switches to enable more complex regex expressions.%1$sIf they are unable, or unwilling to do so, then your server will not support international email addresses using UTF-8 unicode characters. This means you will either have to lower your email validation level to "Basic" or "WordPress Default", or switch to a hosting company that has/can enable PCRE unicode support on the server.',
+						'event_espresso'
+					),
+					'<br />'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		} else {
+			// PCRE support is enabled, but let's still
+			// perform a test to see if the server will support it.
+			// but first, save the updated validation level to the config,
+			// so that the validation strategy picks it up.
+			// this will get bumped back down if it doesn't work
+			$EE_Registration_Config->email_validation_level = $email_validation_level;
+			try {
+				$email_validator    = new EE_Email_Validation_Strategy();
+				$i18n_email_address = apply_filters(
+					'FHEE__Extend_Registration_Form_Admin_Page__update_email_validation_settings_form__i18n_email_address',
+					'jägerjürgen@deutschland.com'
+				);
+				$email_validator->validate($i18n_email_address);
+			} catch (Exception $e) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'We\'re sorry, but it appears that your server\'s configuration will not support the "International" or "International + DNS Check" email validation levels.%1$sTo correct this issue, please consult with your hosting company regarding your server\'s PCRE settings.%1$sIt is recommended that your PHP version be configured to use PCRE 8.10 or newer.%1$sMore information regarding PCRE versions and installation can be found here: %2$s',
+							'event_espresso'
+						),
+						'<br />',
+						'<a href="http://php.net/manual/en/pcre.installation.php" target="_blank">http://php.net/manual/en/pcre.installation.php</a>'
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
 
 
 }

core/wordpress-shims.php

Indentation +40 added lines, -40 removed lines

@@ -5,51 +5,51 @@
  * it does not override any existing definition of the function in WP.
  */
 if ( ! function_exists( 'get_preview_post_link' ) ) {
-    /**
-     * Function was added in WordPress 4.4.0
-     * @param null   $post
-     * @param array  $query_args
-     * @param string $preview_link
-     * @return mixed
-     */
-    function get_preview_post_link($post = null, $query_args = array(), $preview_link = '')
-    {
-        $post = get_post($post);
-        if (! $post) {
-            return '';
-        }
+	/**
+	 * Function was added in WordPress 4.4.0
+	 * @param null   $post
+	 * @param array  $query_args
+	 * @param string $preview_link
+	 * @return mixed
+	 */
+	function get_preview_post_link($post = null, $query_args = array(), $preview_link = '')
+	{
+		$post = get_post($post);
+		if (! $post) {
+			return '';
+		}
 
-        $post_type_object = get_post_type_object($post->post_type);
-        if (is_post_type_viewable($post_type_object)) {
-            if (! $preview_link) {
-                $preview_link = set_url_scheme(get_permalink($post));
-            }
+		$post_type_object = get_post_type_object($post->post_type);
+		if (is_post_type_viewable($post_type_object)) {
+			if (! $preview_link) {
+				$preview_link = set_url_scheme(get_permalink($post));
+			}
 
-            $query_args['preview'] = 'true';
-            $preview_link          = add_query_arg($query_args, $preview_link);
-        }
+			$query_args['preview'] = 'true';
+			$preview_link          = add_query_arg($query_args, $preview_link);
+		}
 
-        /**
-         * Filters the URL used for a post preview.
-         *
-         * @since 2.0.5
-         * @since 4.0.0 Added the `$post` parameter.
-         * @param string  $preview_link URL used for the post preview.
-         * @param WP_Post $post         Post object.
-         */
-        return apply_filters('preview_post_link', $preview_link, $post);
-    }
+		/**
+		 * Filters the URL used for a post preview.
+		 *
+		 * @since 2.0.5
+		 * @since 4.0.0 Added the `$post` parameter.
+		 * @param string  $preview_link URL used for the post preview.
+		 * @param WP_Post $post         Post object.
+		 */
+		return apply_filters('preview_post_link', $preview_link, $post);
+	}
 }
 
 if ( ! function_exists( 'is_post_type_viewable' ) ) {
-    function is_post_type_viewable( $post_type ) {
-        if ( is_scalar( $post_type ) ) {
-            $post_type = get_post_type_object( $post_type );
-            if ( ! $post_type ) {
-                return false;
-            }
-        }
+	function is_post_type_viewable( $post_type ) {
+		if ( is_scalar( $post_type ) ) {
+			$post_type = get_post_type_object( $post_type );
+			if ( ! $post_type ) {
+				return false;
+			}
+		}
      
-        return $post_type->publicly_queryable || ( $post_type->_builtin && $post_type->public );
-    }
+		return $post_type->publicly_queryable || ( $post_type->_builtin && $post_type->public );
+	}
 }
\ No newline at end of file

Spacing +9 added lines, -9 removed lines

@@ -4,7 +4,7 @@ 
  * Note: this file should only be required right before calling the function the shim is for.  This is to ensure that
  * it does not override any existing definition of the function in WP.
  */
-if ( ! function_exists( 'get_preview_post_link' ) ) {
+if ( ! function_exists('get_preview_post_link')) {
     /**
      * Function was added in WordPress 4.4.0
      * @param null   $post
@@ -15,13 +15,13 @@ 
     function get_preview_post_link($post = null, $query_args = array(), $preview_link = '')
     {
         $post = get_post($post);
-        if (! $post) {
+        if ( ! $post) {
             return '';
         }
 
         $post_type_object = get_post_type_object($post->post_type);
         if (is_post_type_viewable($post_type_object)) {
-            if (! $preview_link) {
+            if ( ! $preview_link) {
                 $preview_link = set_url_scheme(get_permalink($post));
             }
 
@@ -41,15 +41,15 @@ 
     }
 }
 
-if ( ! function_exists( 'is_post_type_viewable' ) ) {
-    function is_post_type_viewable( $post_type ) {
-        if ( is_scalar( $post_type ) ) {
-            $post_type = get_post_type_object( $post_type );
-            if ( ! $post_type ) {
+if ( ! function_exists('is_post_type_viewable')) {
+    function is_post_type_viewable($post_type) {
+        if (is_scalar($post_type)) {
+            $post_type = get_post_type_object($post_type);
+            if ( ! $post_type) {
                 return false;
             }
         }
      
-        return $post_type->publicly_queryable || ( $post_type->_builtin && $post_type->public );
+        return $post_type->publicly_queryable || ($post_type->_builtin && $post_type->public);
     }
 }
\ No newline at end of file

core/helpers/EEH_File.helper.php

Indentation +2 added lines, -2 removed lines

@@ -325,8 +325,8 @@
 		//eg if given "/var/something/somewhere/", we want to get "somewhere"'s
 		//parent folder, "/var/something/"
 		$ds = strlen($file_or_folder_path) > 1
-            ? strrpos($file_or_folder_path, DS, -2)
-            : strlen($file_or_folder_path);
+			? strrpos($file_or_folder_path, DS, -2)
+			: strlen($file_or_folder_path);
 		return substr($file_or_folder_path, 0, $ds + 1);
 	}
 

Doc Comments -2 removed lines

@@ -658,8 +658,6 @@
 	 * converts it into a "remote" filepath (the filepath the currently-in-use
 	 * $wp_filesystem needs to use access the folder or file).
 	 * See http://wordpress.stackexchange.com/questions/124900/using-wp-filesystem-in-plugins
-	 * @param WP_Filesystem_Base $wp_filesystem we aren't initially sure which one
-	 * is in use, so you need to provide it
 	 * @param string $local_filepath the filepath to the folder/file locally
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return string the remote filepath (eg the filepath the filesystem method, eg

Spacing +174 added lines, -174 removed lines

@@ -38,30 +38,30 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return WP_Filesystem_Base
 	 */
-	private static function _get_wp_filesystem( $filepath = null) {
-		if( apply_filters(
+	private static function _get_wp_filesystem($filepath = null) {
+		if (apply_filters(
 				'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct',
-				$filepath && EEH_File::is_in_uploads_folder( $filepath ),
-				$filepath ) ) {
-			if( ! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct ) {
-				require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
+				$filepath && EEH_File::is_in_uploads_folder($filepath),
+				$filepath )) {
+			if ( ! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) {
+				require_once(ABSPATH.'wp-admin/includes/class-wp-filesystem-base.php');
 				$method = 'direct';
-				$wp_filesystem_direct_file = apply_filters( 'filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method );
+				$wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH.'wp-admin/includes/class-wp-filesystem-'.$method.'.php', $method);
 				//check constants defined, just like in wp-admin/includes/file.php's WP_Filesystem()
-				if ( ! defined('FS_CHMOD_DIR') ) {
-					define('FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) );
+				if ( ! defined('FS_CHMOD_DIR')) {
+					define('FS_CHMOD_DIR', (fileperms(ABSPATH) & 0777 | 0755));
 				}
-				if ( ! defined('FS_CHMOD_FILE') ) {
-					define('FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) );
+				if ( ! defined('FS_CHMOD_FILE')) {
+					define('FS_CHMOD_FILE', (fileperms(ABSPATH.'index.php') & 0777 | 0644));
 				}
-				require_once( $wp_filesystem_direct_file );
-				EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct( array() );
+				require_once($wp_filesystem_direct_file);
+				EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct(array());
 			}
 			return EEH_File::$_wp_filesystem_direct;
 		}
 		global $wp_filesystem;
 		// no filesystem setup ???
-		if ( ! $wp_filesystem instanceof WP_Filesystem_Base ) {
+		if ( ! $wp_filesystem instanceof WP_Filesystem_Base) {
 			// if some eager beaver's just trying to get in there too early...
 			// let them do it, because we are one of those eager beavers! :P
 			/**
@@ -74,34 +74,34 @@ 
 			 * and there may be troubles if the WP files are owned by a different user
 			 * than the server user. But both of these issues should exist in 4.4 and earlier too
 			 */
-			if ( FALSE && ! did_action( 'wp_loaded' )) {
+			if (FALSE && ! did_action('wp_loaded')) {
 				$msg = __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso');
-				if ( WP_DEBUG ) {
-					$msg .= '<br />' .  __('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
+				if (WP_DEBUG) {
+					$msg .= '<br />'.__('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
 				}
-				throw new EE_Error( $msg );
+				throw new EE_Error($msg);
 			} else {
 				// should be loaded if we are past the wp_loaded hook...
-				if ( ! function_exists( 'WP_Filesystem' )) {
-					require_once( ABSPATH . 'wp-admin/includes/file.php' );
-					require_once( ABSPATH . 'wp-admin/includes/template.php' );
+				if ( ! function_exists('WP_Filesystem')) {
+					require_once(ABSPATH.'wp-admin/includes/file.php');
+					require_once(ABSPATH.'wp-admin/includes/template.php');
 				}
 				// turn on output buffering so that we can capture the credentials form
 				ob_start();
-				$credentials = request_filesystem_credentials( '' );
+				$credentials = request_filesystem_credentials('');
 				// store credentials form for the time being
 				EEH_File::$_credentials_form = ob_get_clean();
 				// basically check for direct or previously configured access
-				if ( ! WP_Filesystem( $credentials ) ) {
+				if ( ! WP_Filesystem($credentials)) {
 					// if credentials do NOT exist
-					if ( $credentials === FALSE ) {
-						add_action( 'admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999 );
-						throw new EE_Error( __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'));
-					} elseif( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->get_error_code() ) {
-						add_action( 'admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999 );
+					if ($credentials === FALSE) {
+						add_action('admin_notices', array('EEH_File', 'display_request_filesystem_credentials_form'), 999);
+						throw new EE_Error(__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'));
+					} elseif (is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code()) {
+						add_action('admin_notices', array('EEH_File', 'display_request_filesystem_credentials_form'), 999);
 						throw new EE_Error(
 								sprintf(
-										__( 'WP Filesystem Error: $1%s', 'event_espresso' ),
+										__('WP Filesystem Error: $1%s', 'event_espresso'),
 										$wp_filesystem->errors->get_error_message() ) );
 					}
 				}
@@ -114,8 +114,8 @@ 
 	 * display_request_filesystem_credentials_form
 	 */
 	public static function display_request_filesystem_credentials_form() {
-		if ( ! empty( EEH_File::$_credentials_form )) {
-			echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>';
+		if ( ! empty(EEH_File::$_credentials_form)) {
+			echo '<div class="updated espresso-notices-attention"><p>'.EEH_File::$_credentials_form.'</p></div>';
 		}
 	}
 
@@ -133,29 +133,29 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function verify_filepath_and_permissions( $full_file_path = '', $file_name = '', $file_ext = '', $type_of_file = '' ) {
+	public static function verify_filepath_and_permissions($full_file_path = '', $file_name = '', $file_ext = '', $type_of_file = '') {
 		// load WP_Filesystem and set file permissions
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
-		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
-		if ( ! $wp_filesystem->is_readable( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) )) {
-			$file_name = ! empty( $type_of_file ) ? $file_name . ' ' . $type_of_file : $file_name;
-			$file_name .= ! empty( $file_ext ) ? ' file' : ' folder';
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		if ( ! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+			$file_name = ! empty($type_of_file) ? $file_name.' '.$type_of_file : $file_name;
+			$file_name .= ! empty($file_ext) ? ' file' : ' folder';
 			$msg = sprintf(
-				__( 'The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso' ),
+				__('The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso'),
 				$file_name,
 				'<br />'
 			);
-			if ( EEH_File::exists( $full_file_path )) {
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path, $type_of_file );
+			if (EEH_File::exists($full_file_path)) {
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, $type_of_file);
 			} else {
 				// no file permissions means the file was not found
 				$msg .= sprintf(
-					__( 'Please ensure the following path is correct: "%s".', 'event_espresso' ),
+					__('Please ensure the following path is correct: "%s".', 'event_espresso'),
 					$full_file_path
 				);
 			}
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				throw new EE_Error( $msg . '||' . $msg );
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				throw new EE_Error($msg.'||'.$msg);
 			}
 			return FALSE;
 		}
@@ -173,24 +173,24 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return string
 	 */
-	private static function _permissions_error_for_unreadable_filepath( $full_file_path = '', $type_of_file = '' ){
+	private static function _permissions_error_for_unreadable_filepath($full_file_path = '', $type_of_file = '') {
 		// load WP_Filesystem and set file permissions
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
 		// check file permissions
-		$perms = $wp_filesystem->getchmod( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) );
-		if ( $perms ) {
+		$perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
+		if ($perms) {
 			// file permissions exist, but way be set incorrectly
-			$type_of_file = ! empty( $type_of_file ) ? $type_of_file . ' ' : '';
-			$type_of_file .= ! empty( $type_of_file ) ? 'file' : 'folder';
+			$type_of_file = ! empty($type_of_file) ? $type_of_file.' ' : '';
+			$type_of_file .= ! empty($type_of_file) ? 'file' : 'folder';
 			return sprintf(
-				__( 'File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso' ),
+				__('File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso'),
 				$type_of_file,
 				$perms
 			);
 		} else {
 			// file exists but file permissions could not be read ?!?!
 			return sprintf(
-				__( 'Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".', 'event_espresso' ),
+				__('Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".', 'event_espresso'),
 				$full_file_path
 			);
 		}
@@ -208,35 +208,35 @@ 
 	 * can't write to it
 	 * @return bool false if folder isn't writable; true if it exists and is writeable,
 	 */
-	public static function ensure_folder_exists_and_is_writable( $folder = '' ){
-		if ( empty( $folder )) {
+	public static function ensure_folder_exists_and_is_writable($folder = '') {
+		if (empty($folder)) {
 			return false;
 		}
 		// remove ending DS
-		$folder = EEH_File::standardise_directory_separators( rtrim( $folder, '/\\' ));
-		$parent_folder = EEH_File::get_parent_folder( $folder );
+		$folder = EEH_File::standardise_directory_separators(rtrim($folder, '/\\'));
+		$parent_folder = EEH_File::get_parent_folder($folder);
 		// add DS to folder
-		$folder = EEH_File::end_with_directory_separator( $folder );
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $folder );
-		if ( ! $wp_filesystem->is_dir( EEH_File::convert_local_filepath_to_remote_filepath( $folder ) ) ) {
+		$folder = EEH_File::end_with_directory_separator($folder);
+		$wp_filesystem = EEH_File::_get_wp_filesystem($folder);
+		if ( ! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
 			//ok so it doesn't exist. Does its parent? Can we write to it?
-			if(	! EEH_File::ensure_folder_exists_and_is_writable( $parent_folder ) ) {
+			if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
 				return false;
 			}
-			if ( ! EEH_File::verify_is_writable( $parent_folder, 'folder' )) {
+			if ( ! EEH_File::verify_is_writable($parent_folder, 'folder')) {
 				return false;
 			} else {
-				if ( ! $wp_filesystem->mkdir( EEH_File::convert_local_filepath_to_remote_filepath(  $folder ) ) ) {
-					if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-						$msg = sprintf( __( '"%s" could not be created.', 'event_espresso' ), $folder );
-						$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $folder );
-						throw new EE_Error( $msg );
+				if ( ! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
+					if (defined('WP_DEBUG') && WP_DEBUG) {
+						$msg = sprintf(__('"%s" could not be created.', 'event_espresso'), $folder);
+						$msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder);
+						throw new EE_Error($msg);
 					}
 					return false;
 				}
-				EEH_File::add_index_file( $folder );
+				EEH_File::add_index_file($folder);
 			}
-		} elseif ( ! EEH_File::verify_is_writable( $folder, 'folder' )) {
+		} elseif ( ! EEH_File::verify_is_writable($folder, 'folder')) {
 			return false;
 		}
 		return true;
@@ -251,15 +251,15 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function verify_is_writable( $full_path = '', $file_or_folder = 'folder' ){
+	public static function verify_is_writable($full_path = '', $file_or_folder = 'folder') {
 		// load WP_Filesystem and set file permissions
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_path );
-		$full_path = EEH_File::standardise_directory_separators( $full_path );
-		if ( ! $wp_filesystem->is_writable( EEH_File::convert_local_filepath_to_remote_filepath( $full_path ) ) ) {
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				$msg = sprintf( __( 'The "%1$s" %2$s is not writable.', 'event_espresso' ), $full_path, $file_or_folder );
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_path );
-				throw new EE_Error( $msg );
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_path);
+		$full_path = EEH_File::standardise_directory_separators($full_path);
+		if ( ! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path);
+				throw new EE_Error($msg);
 			}
 			return FALSE;
 		}
@@ -276,25 +276,25 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function ensure_file_exists_and_is_writable( $full_file_path = '' ) {
+	public static function ensure_file_exists_and_is_writable($full_file_path = '') {
 		// load WP_Filesystem and set file permissions
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
-		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
-		$parent_folder = EEH_File::get_parent_folder( $full_file_path );
-		if ( ! EEH_File::exists( $full_file_path )) {
-			if( ! EEH_File::ensure_folder_exists_and_is_writable( $parent_folder ) ) {
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		$parent_folder = EEH_File::get_parent_folder($full_file_path);
+		if ( ! EEH_File::exists($full_file_path)) {
+			if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
 				return false;
 			}
-			if ( ! $wp_filesystem->touch( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) ) ) {
-				if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-					$msg = sprintf( __( 'The "%s" file could not be created.', 'event_espresso' ), $full_file_path );
-					$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path );
-					throw new EE_Error( $msg );
+			if ( ! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+				if (defined('WP_DEBUG') && WP_DEBUG) {
+					$msg = sprintf(__('The "%s" file could not be created.', 'event_espresso'), $full_file_path);
+					$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
+					throw new EE_Error($msg);
 				}
 				return false;
 			}
 		}
-		if ( ! EEH_File::verify_is_writable( $full_file_path, 'file' )) {
+		if ( ! EEH_File::verify_is_writable($full_file_path, 'file')) {
 			return false;
 		}
 		return true;
@@ -306,7 +306,7 @@ 
 	 * @param string $file_or_folder_path
 	 * @return string parent folder, ENDING with a directory separator
 	 */
-	public static function get_parent_folder( $file_or_folder_path ) {
+	public static function get_parent_folder($file_or_folder_path) {
 		//find the last DS, ignoring a DS on the very end
 		//eg if given "/var/something/somewhere/", we want to get "somewhere"'s
 		//parent folder, "/var/something/"
@@ -328,12 +328,12 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return string
 	 */
-	public static function get_file_contents( $full_file_path = '' ){
-		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
-		if ( EEH_File::verify_filepath_and_permissions( $full_file_path, EEH_File::get_filename_from_filepath( $full_file_path ) , EEH_File::get_file_extension( $full_file_path ))) {
+	public static function get_file_contents($full_file_path = '') {
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		if (EEH_File::verify_filepath_and_permissions($full_file_path, EEH_File::get_filename_from_filepath($full_file_path), EEH_File::get_file_extension($full_file_path))) {
 			// load WP_Filesystem and set file permissions
-			$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
-			return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) );
+			$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+			return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
 		}
 		return '';
 	}
@@ -348,26 +348,26 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function write_to_file( $full_file_path = '', $file_contents = '', $file_type = '' ){
-		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
-		$file_type = ! empty( $file_type ) ? rtrim( $file_type, ' ' ) . ' ' : '';
-		$folder = EEH_File::remove_filename_from_filepath( $full_file_path );
-		if ( ! EEH_File::verify_is_writable( $folder, 'folder' )) {
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				$msg = sprintf( __( 'The %1$sfile located at "%2$s" is not writable.', 'event_espresso' ), $file_type, $full_file_path );
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path );
-				throw new EE_Error( $msg );
+	public static function write_to_file($full_file_path = '', $file_contents = '', $file_type = '') {
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		$file_type = ! empty($file_type) ? rtrim($file_type, ' ').' ' : '';
+		$folder = EEH_File::remove_filename_from_filepath($full_file_path);
+		if ( ! EEH_File::verify_is_writable($folder, 'folder')) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'), $file_type, $full_file_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
+				throw new EE_Error($msg);
 			}
 			return FALSE;
 		}
 		// load WP_Filesystem and set file permissions
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
 		// write the file
-		if ( ! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ), $file_contents )) {
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				$msg = sprintf( __( 'The %1$sfile located at "%2$s" could not be written to.', 'event_espresso' ), $file_type, $full_file_path );
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path, 'f' );
-				throw new EE_Error( $msg );
+		if ( ! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'), $file_type, $full_file_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f');
+				throw new EE_Error($msg);
 			}
 			return FALSE;
 		}
@@ -383,9 +383,9 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return boolean
 	 */
-	public static function delete( $filepath, $recursive = false, $type = false ) {
+	public static function delete($filepath, $recursive = false, $type = false) {
 		$wp_filesystem = EEH_File::_get_wp_filesystem();
-		return $wp_filesystem->delete( $filepath, $recursive, $type ) ? TRUE : FALSE;
+		return $wp_filesystem->delete($filepath, $recursive, $type) ? TRUE : FALSE;
 	}
 
 
@@ -397,9 +397,9 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function exists( $full_file_path = '' ) {
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
-		return $wp_filesystem->exists( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) ) ? TRUE : FALSE;
+	public static function exists($full_file_path = '') {
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		return $wp_filesystem->exists(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)) ? TRUE : FALSE;
 	}
 
 
@@ -412,9 +412,9 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function is_readable( $full_file_path = '' ) {
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
-		if( $wp_filesystem->is_readable( EEH_File::convert_local_filepath_to_remote_filepath(  $full_file_path ) ) ) {
+	public static function is_readable($full_file_path = '') {
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		if ($wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
 			return true;
 		} else {
 			return false;
@@ -430,8 +430,8 @@ 
 	 * @param string $full_file_path
 	 * @return string
 	 */
-	public static function remove_filename_from_filepath( $full_file_path = '' ) {
-		return pathinfo( $full_file_path, PATHINFO_DIRNAME );
+	public static function remove_filename_from_filepath($full_file_path = '') {
+		return pathinfo($full_file_path, PATHINFO_DIRNAME);
 	}
 
 
@@ -441,8 +441,8 @@ 
 	 * @param string $full_file_path
 	 * @return string
 	 */
-	public static function get_filename_from_filepath( $full_file_path = '' ) {
-		return pathinfo( $full_file_path, PATHINFO_BASENAME );
+	public static function get_filename_from_filepath($full_file_path = '') {
+		return pathinfo($full_file_path, PATHINFO_BASENAME);
 	}
 
 
@@ -452,8 +452,8 @@ 
 	 * @param string $full_file_path
 	 * @return string
 	 */
-	public static function get_file_extension( $full_file_path = '' ) {
-		return pathinfo( $full_file_path, PATHINFO_EXTENSION );
+	public static function get_file_extension($full_file_path = '') {
+		return pathinfo($full_file_path, PATHINFO_EXTENSION);
 	}
 
 
@@ -464,10 +464,10 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return bool
 	 */
-	public static function add_htaccess_deny_from_all( $folder = '' ) {
-		$folder = EEH_File::standardise_and_end_with_directory_separator( $folder );
-		if ( ! EEH_File::exists( $folder . '.htaccess' ) ) {
-			if ( ! EEH_File::write_to_file( $folder . '.htaccess', 'deny from all', '.htaccess' )) {
+	public static function add_htaccess_deny_from_all($folder = '') {
+		$folder = EEH_File::standardise_and_end_with_directory_separator($folder);
+		if ( ! EEH_File::exists($folder.'.htaccess')) {
+			if ( ! EEH_File::write_to_file($folder.'.htaccess', 'deny from all', '.htaccess')) {
 				return FALSE;
 			}
 		}
@@ -481,10 +481,10 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return boolean
 	 */
-	public static function add_index_file( $folder ) {
-		$folder = EEH_File::standardise_and_end_with_directory_separator( $folder );
-		if ( ! EEH_File::exists( $folder . 'index.php' ) ) {
-			if ( ! EEH_File::write_to_file( $folder . 'index.php', 'You are not permitted to read from this folder', '.php' )) {
+	public static function add_index_file($folder) {
+		$folder = EEH_File::standardise_and_end_with_directory_separator($folder);
+		if ( ! EEH_File::exists($folder.'index.php')) {
+			if ( ! EEH_File::write_to_file($folder.'index.php', 'You are not permitted to read from this folder', '.php')) {
 				return false;
 			}
 		}
@@ -499,11 +499,11 @@ 
 	 * @param string $file_path
 	 * @return string
 	 */
-	public static function get_classname_from_filepath_with_standard_filename( $file_path ){
+	public static function get_classname_from_filepath_with_standard_filename($file_path) {
 		//extract file from path
-		$filename = basename( $file_path );
+		$filename = basename($file_path);
 		//now remove the first period and everything after
-		$pos_of_first_period = strpos( $filename,'.' );
+		$pos_of_first_period = strpos($filename, '.');
 		return substr($filename, 0, $pos_of_first_period);
 	}
 
@@ -515,8 +515,8 @@ 
 	 * @param string $file_path
 	 * @return string
 	 */
-	public static function standardise_directory_separators( $file_path ){
-		return str_replace( array( '\\', '/' ), DS, $file_path );
+	public static function standardise_directory_separators($file_path) {
+		return str_replace(array('\\', '/'), DS, $file_path);
 	}
 
 
@@ -527,8 +527,8 @@ 
 	 * @param string $file_path
 	 * @return string
 	 */
-	public static function end_with_directory_separator( $file_path ){
-		return rtrim( $file_path, '/\\' ) . DS;
+	public static function end_with_directory_separator($file_path) {
+		return rtrim($file_path, '/\\').DS;
 	}
 
 
@@ -538,8 +538,8 @@ 
 	 * @param $file_path
 	 * @return string
 	 */
-	public static function standardise_and_end_with_directory_separator( $file_path ){
-		return self::end_with_directory_separator( self::standardise_directory_separators( $file_path ));
+	public static function standardise_and_end_with_directory_separator($file_path) {
+		return self::end_with_directory_separator(self::standardise_directory_separators($file_path));
 	}
 
 
@@ -556,21 +556,21 @@ 
 	 *		if $index_numerically == FALSE (Default) keys are what the class names SHOULD be;
 	 *		 and values are their filepaths
 	 */
-	public static function get_contents_of_folders( $folder_paths = array(), $index_numerically = FALSE ){
+	public static function get_contents_of_folders($folder_paths = array(), $index_numerically = FALSE) {
 		$class_to_folder_path = array();
-		foreach( $folder_paths as $folder_path ){
-			$folder_path = self::standardise_and_end_with_directory_separator( $folder_path );
+		foreach ($folder_paths as $folder_path) {
+			$folder_path = self::standardise_and_end_with_directory_separator($folder_path);
 			// load WP_Filesystem and set file permissions
-			$files_in_folder = glob( $folder_path . '*' );
+			$files_in_folder = glob($folder_path.'*');
 			$class_to_folder_path = array();
-			if ( $files_in_folder ) {
-				foreach( $files_in_folder as $file_path ){
+			if ($files_in_folder) {
+				foreach ($files_in_folder as $file_path) {
 					//only add files, not folders
-					if ( ! is_dir( $file_path )) {
-						if ( $index_numerically ) {
+					if ( ! is_dir($file_path)) {
+						if ($index_numerically) {
 							$class_to_folder_path[] = $file_path;
 						} else {
-							$classname = self::get_classname_from_filepath_with_standard_filename( $file_path );
+							$classname = self::get_classname_from_filepath_with_standard_filename($file_path);
 							$class_to_folder_path[$classname] = $file_path;
 						}
 					}
@@ -590,39 +590,39 @@ 
 	 * @throws EE_Error if filesystem credentials are required
 	 * @return boolean success
 	 */
-	public static function copy( $source_file, $destination_file, $overwrite = FALSE ){
-		$full_source_path = EEH_File::standardise_directory_separators( $source_file );
-		if( ! EEH_File::exists( $full_source_path ) ){
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				$msg = sprintf( __( 'The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso' ), $full_source_path );
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_source_path );
-				throw new EE_Error( $msg );
+	public static function copy($source_file, $destination_file, $overwrite = FALSE) {
+		$full_source_path = EEH_File::standardise_directory_separators($source_file);
+		if ( ! EEH_File::exists($full_source_path)) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'), $full_source_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path);
+				throw new EE_Error($msg);
 			}
 			return FALSE;
 		}
 
-		$full_dest_path = EEH_File::standardise_directory_separators( $destination_file );
-		$folder = EEH_File::remove_filename_from_filepath( $full_dest_path );
-		if ( ! EEH_File::verify_is_writable( $folder, 'folder' )) {
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				$msg = sprintf( __( 'The file located at "%2$s" is not writable.', 'event_espresso' ), $full_dest_path );
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_dest_path );
-				throw new EE_Error( $msg );
+		$full_dest_path = EEH_File::standardise_directory_separators($destination_file);
+		$folder = EEH_File::remove_filename_from_filepath($full_dest_path);
+		if ( ! EEH_File::verify_is_writable($folder, 'folder')) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The file located at "%2$s" is not writable.', 'event_espresso'), $full_dest_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path);
+				throw new EE_Error($msg);
 			}
 			return FALSE;
 		}
 
 		// load WP_Filesystem and set file permissions
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $destination_file );
+		$wp_filesystem = EEH_File::_get_wp_filesystem($destination_file);
 		// write the file
 		if ( ! $wp_filesystem->copy(
-						EEH_File::convert_local_filepath_to_remote_filepath( $full_source_path ),
-						EEH_File::convert_local_filepath_to_remote_filepath( $full_dest_path ),
+						EEH_File::convert_local_filepath_to_remote_filepath($full_source_path),
+						EEH_File::convert_local_filepath_to_remote_filepath($full_dest_path),
 						$overwrite )) {
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-				$msg = sprintf( __( 'Attempted writing to file %1$s, but could not, probably because of permissions issues', 'event_espresso' ), $full_source_path );
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_source_path, 'f' );
-				throw new EE_Error( $msg );
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('Attempted writing to file %1$s, but could not, probably because of permissions issues', 'event_espresso'), $full_source_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path, 'f');
+				throw new EE_Error($msg);
 			}
 			return FALSE;
 		}
@@ -634,9 +634,9 @@ 
 	 * @param string $filepath
 	 * @return boolean
 	 */
-	public static function is_in_uploads_folder( $filepath ) {
+	public static function is_in_uploads_folder($filepath) {
 		$uploads = wp_upload_dir();
-		return strpos( $filepath, $uploads[ 'basedir' ] ) === 0 ? true : false;
+		return strpos($filepath, $uploads['basedir']) === 0 ? true : false;
 	}
 
 	/**
@@ -651,9 +651,9 @@ 
 	 * @return string the remote filepath (eg the filepath the filesystem method, eg
 	 * ftp or ssh, will use to access the folder
 	 */
-	public static function convert_local_filepath_to_remote_filepath( $local_filepath ) {
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $local_filepath );
-		return str_replace( WP_CONTENT_DIR . DS, $wp_filesystem->wp_content_dir(), $local_filepath );
+	public static function convert_local_filepath_to_remote_filepath($local_filepath) {
+		$wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath);
+		return str_replace(WP_CONTENT_DIR.DS, $wp_filesystem->wp_content_dir(), $local_filepath);
 	}
 }
 // End of file EEH_File.helper.php

Braces +3 added lines, -1 removed lines

@@ -1,4 +1,6 @@
-<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
+}
 
 /**
  *