eventespresso / event-espresso-core

core/db_models/fields/EE_WP_Post_Status_Field.php

Doc Comments -2 removed lines

@@ -32,8 +32,6 @@
      *                                    )
      *                                    )
      * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
-     * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is
-     *                                    set to true, it will be stored as an INT
      */
     public function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array())
     {

Indentation +97 added lines, -97 removed lines

@@ -3,114 +3,114 @@
 class EE_WP_Post_Status_Field extends EE_Enum_Text_Field
 {
 
-    protected $_wp_post_stati;
+	protected $_wp_post_stati;
 
 
-    /**
-     * constructor
-     *
-     * @param string  $table_column       column on table
-     * @param string  $nicename           nice name for column(field)
-     * @param bool    $nullable           is this field nullable
-     * @param string  $default_value      default status
-     * @param array   $new_stati          If additional stati are to be used other than the default WP statuses then
-     *                                    they can be registered via this property.  The format of the array should be
-     *                                    as follows: array(
-     *                                    'status_reference' => array(
-     *                                    'label' => __('Status Reference Label', 'event_espresso')
-     *                                    'public' => true, //'Whether posts of this status should be shown on the
-     *                                    frontend of the site'
-     *                                    'exclude_from_search' => false, //'Whether posts of this status should be
-     *                                    excluded from wp searches'
-     *                                    'show_in_admin_all_list' => true, //whether posts of this status are included
-     *                                    in queries for the admin "all" view in list table views.
-     *                                    'show_in_admin_status_list' => true, //Show in the list of statuses with post
-     *                                    counts at the top of the admin list tables (i.e. Status Reference(2) )
-     *                                    'label_count' => _n_noop( 'Status Reference <span class="count">(%s)</span>',
-     *                                    'Status References <span class="count">(%s)</span>' ), //the text to display
-     *                                    on the admin screen( or you won't see your status count ).
-     *                                    )
-     *                                    )
-     * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
-     * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is
-     *                                    set to true, it will be stored as an INT
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array())
-    {
-        $this->_register_new_stati($new_stati);
-        $this->_set_allowed_enum_values();
-        parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values);
-    }
+	/**
+	 * constructor
+	 *
+	 * @param string  $table_column       column on table
+	 * @param string  $nicename           nice name for column(field)
+	 * @param bool    $nullable           is this field nullable
+	 * @param string  $default_value      default status
+	 * @param array   $new_stati          If additional stati are to be used other than the default WP statuses then
+	 *                                    they can be registered via this property.  The format of the array should be
+	 *                                    as follows: array(
+	 *                                    'status_reference' => array(
+	 *                                    'label' => __('Status Reference Label', 'event_espresso')
+	 *                                    'public' => true, //'Whether posts of this status should be shown on the
+	 *                                    frontend of the site'
+	 *                                    'exclude_from_search' => false, //'Whether posts of this status should be
+	 *                                    excluded from wp searches'
+	 *                                    'show_in_admin_all_list' => true, //whether posts of this status are included
+	 *                                    in queries for the admin "all" view in list table views.
+	 *                                    'show_in_admin_status_list' => true, //Show in the list of statuses with post
+	 *                                    counts at the top of the admin list tables (i.e. Status Reference(2) )
+	 *                                    'label_count' => _n_noop( 'Status Reference <span class="count">(%s)</span>',
+	 *                                    'Status References <span class="count">(%s)</span>' ), //the text to display
+	 *                                    on the admin screen( or you won't see your status count ).
+	 *                                    )
+	 *                                    )
+	 * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
+	 * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is
+	 *                                    set to true, it will be stored as an INT
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array())
+	{
+		$this->_register_new_stati($new_stati);
+		$this->_set_allowed_enum_values();
+		parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values);
+	}
 
 
-    /**
-     * This registers any new statuses sent via the $new_stati array on construct
-     *
-     * @access protected
-     * @param  array $new_stati statuses
-     * @return void
-     */
-    protected function _register_new_stati($new_stati)
-    {
+	/**
+	 * This registers any new statuses sent via the $new_stati array on construct
+	 *
+	 * @access protected
+	 * @param  array $new_stati statuses
+	 * @return void
+	 */
+	protected function _register_new_stati($new_stati)
+	{
 
-        foreach ((array) $new_stati as $status_key => $status_args) {
-            $args = array(
-                'label'                     => isset($status_args['label']) ? $status_args['label'] : $status_key,
-                'public'                    => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : true,
-                'exclude_from_search'       => isset($status_args['exclude_from_search']) && is_bool($status_args['exclude_from_search']) ? $status_args['exclude_from_search'] : false,
-                'show_in_admin_all_list'    => isset($status_args['show_in_admin_all_list']) && is_bool($status_args['show_in_admin_all_list']) ? $status_args['show_in_admin_all_list'] : false,
-                'show_in_admin_status_list' => isset($status_args['show_in_admin_status_list']) && is_bool($status_args['show_in_admin_status_list']) ? $status_args['show_in_admin_status_list'] : true,
-                'label_count'               => isset($status_args['label_count']) ? $status_args['label_count'] : '',
-            );
-            register_post_status($status_key, $status_args);
-        }
-    }
+		foreach ((array) $new_stati as $status_key => $status_args) {
+			$args = array(
+				'label'                     => isset($status_args['label']) ? $status_args['label'] : $status_key,
+				'public'                    => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : true,
+				'exclude_from_search'       => isset($status_args['exclude_from_search']) && is_bool($status_args['exclude_from_search']) ? $status_args['exclude_from_search'] : false,
+				'show_in_admin_all_list'    => isset($status_args['show_in_admin_all_list']) && is_bool($status_args['show_in_admin_all_list']) ? $status_args['show_in_admin_all_list'] : false,
+				'show_in_admin_status_list' => isset($status_args['show_in_admin_status_list']) && is_bool($status_args['show_in_admin_status_list']) ? $status_args['show_in_admin_status_list'] : true,
+				'label_count'               => isset($status_args['label_count']) ? $status_args['label_count'] : '',
+			);
+			register_post_status($status_key, $status_args);
+		}
+	}
 
 
-    /**
-     * This sets the _allowed_enum_values property using the $wp_post_stati array
-     *
-     * @access protected
-     * @regurn void
-     */
-    protected function _set_allowed_enum_values()
-    {
-        // first let's get the post_statuses
-        global $wp_post_statuses;
-        $this->_wp_post_stati = $wp_post_statuses;
+	/**
+	 * This sets the _allowed_enum_values property using the $wp_post_stati array
+	 *
+	 * @access protected
+	 * @regurn void
+	 */
+	protected function _set_allowed_enum_values()
+	{
+		// first let's get the post_statuses
+		global $wp_post_statuses;
+		$this->_wp_post_stati = $wp_post_statuses;
 
-        foreach ($this->_wp_post_stati as $post_status => $args_object) {
-            $this->_allowed_enum_values[ $post_status ] = $args_object->label;
-        }
-    }
+		foreach ($this->_wp_post_stati as $post_status => $args_object) {
+			$this->_allowed_enum_values[ $post_status ] = $args_object->label;
+		}
+	}
 
-    /**
-     * Before calling parent, first double-checks our list of acceptable post
-     * types is up-to-date
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        $this->_set_allowed_enum_values();
-        return parent::prepare_for_set($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * Before calling parent, first double-checks our list of acceptable post
+	 * types is up-to-date
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		$this->_set_allowed_enum_values();
+		return parent::prepare_for_set($value_inputted_for_field_on_model_object);
+	}
 
 
 
-    // helper methods for getting various $wp_post_statuses stuff.
+	// helper methods for getting various $wp_post_statuses stuff.
 
-    /**
-     * This just returns the status object for the given status
-     *
-     * @access public
-     * @see    wp_register_post_status in wp-includes/post.php for a list of properties of the status object
-     * @param  string $status What status object you want
-     * @return std_object         the status object or FALSE if it doesn't exist.
-     */
-    public function get_status_object($status)
-    {
-        return isset($this->_wp_post_stati[ $status ]) ? $this->_wp_post_stati[ $status ] : false;
-    }
+	/**
+	 * This just returns the status object for the given status
+	 *
+	 * @access public
+	 * @see    wp_register_post_status in wp-includes/post.php for a list of properties of the status object
+	 * @param  string $status What status object you want
+	 * @return std_object         the status object or FALSE if it doesn't exist.
+	 */
+	public function get_status_object($status)
+	{
+		return isset($this->_wp_post_stati[ $status ]) ? $this->_wp_post_stati[ $status ] : false;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
         $this->_wp_post_stati = $wp_post_statuses;
 
         foreach ($this->_wp_post_stati as $post_status => $args_object) {
-            $this->_allowed_enum_values[ $post_status ] = $args_object->label;
+            $this->_allowed_enum_values[$post_status] = $args_object->label;
         }
     }
 
@@ -111,6 +111,6 @@ 
      */
     public function get_status_object($status)
     {
-        return isset($this->_wp_post_stati[ $status ]) ? $this->_wp_post_stati[ $status ] : false;
+        return isset($this->_wp_post_stati[$status]) ? $this->_wp_post_stati[$status] : false;
     }
 }

core/db_models/helpers/EE_Model_Query_Info_Carrier.php

Doc Comments +14 added lines, -1 removed lines

@@ -44,19 +44,33 @@ 
    
     private $_group_by_sql;
    
+    /**
+     * @param string $limit_sql
+     */
     public function set_limit_sql($limit_sql)
     {
         $this->_limit_sql = $limit_sql;
     }
     
+    /**
+     * @param string $order_by_sql
+     */
     public function set_order_by_sql($order_by_sql)
     {
         $this->_order_by_sql = $order_by_sql;
     }
+
+    /**
+     * @param string $group_by_sql
+     */
     public function set_group_by_sql($group_by_sql)
     {
         $this->_group_by_sql = $group_by_sql;
     }
+
+    /**
+     * @param string $having_sql
+     */
     public function set_having_sql($having_sql)
     {
         $this->_having_sql = $having_sql;
@@ -81,7 +95,6 @@ 
     *
     * @param type $model_included_name
     * @param type $join_sql
-    * @param type $data_types
     */
     public function __construct($model_included_name = array(), $join_sql = '')
     {

Indentation +90 added lines, -90 removed lines

@@ -14,141 +14,141 @@ 
    /**
     * @var string SQL for performing joins (Eg, "INNER JOIN blah ON blah=blah INNER JOIN FOO ON foo=foo...")
     */
-    private $_join_sql;
+	private $_join_sql;
    /**
     *
     * @var array stating all the models that have been included thus far,so we don't get duplicates.
     * Keys are the model relation chains to them from the queried model
     * (eg, "Registration.Transaction.Payment"), and valuesare model names (eg "Payment")
     */
-    private $_models_included;
+	private $_models_included;
    
    /**
     * After we've acquired all the data types, we can create this sql.
     * @var string
     */
-    private $_where_sql;
+	private $_where_sql;
    /**
     * Full join sql. Eg, in a select query, that's everything after the "FROM", and before the "WHERE", so it includes
     * the declaration of the main model's tables, and then appends all the joining sql to other models
     * @var string
     */
-    private $_main_join_sql;
+	private $_main_join_sql;
    
    
-    private $_limit_sql;
+	private $_limit_sql;
    
-    private $_order_by_sql;
+	private $_order_by_sql;
    
-    private $_having_sql;
+	private $_having_sql;
    
-    private $_group_by_sql;
+	private $_group_by_sql;
    
-    public function set_limit_sql($limit_sql)
-    {
-        $this->_limit_sql = $limit_sql;
-    }
+	public function set_limit_sql($limit_sql)
+	{
+		$this->_limit_sql = $limit_sql;
+	}
     
-    public function set_order_by_sql($order_by_sql)
-    {
-        $this->_order_by_sql = $order_by_sql;
-    }
-    public function set_group_by_sql($group_by_sql)
-    {
-        $this->_group_by_sql = $group_by_sql;
-    }
-    public function set_having_sql($having_sql)
-    {
-        $this->_having_sql = $having_sql;
-    }
-    public function get_limit_sql()
-    {
-        return $this->_limit_sql;
-    }
-    public function get_order_by_sql()
-    {
-        return $this->_order_by_sql;
-    }
-    public function get_group_by_sql()
-    {
-        return $this->_group_by_sql;
-    }
-    public function get_having_sql()
-    {
-        return $this->_having_sql;
-    }
+	public function set_order_by_sql($order_by_sql)
+	{
+		$this->_order_by_sql = $order_by_sql;
+	}
+	public function set_group_by_sql($group_by_sql)
+	{
+		$this->_group_by_sql = $group_by_sql;
+	}
+	public function set_having_sql($having_sql)
+	{
+		$this->_having_sql = $having_sql;
+	}
+	public function get_limit_sql()
+	{
+		return $this->_limit_sql;
+	}
+	public function get_order_by_sql()
+	{
+		return $this->_order_by_sql;
+	}
+	public function get_group_by_sql()
+	{
+		return $this->_group_by_sql;
+	}
+	public function get_having_sql()
+	{
+		return $this->_having_sql;
+	}
    /**
     *
     * @param type $model_included_name
     * @param type $join_sql
     * @param type $data_types
     */
-    public function __construct($model_included_name = array(), $join_sql = '')
-    {
-        $this->_models_included = $model_included_name;
-        $this->_join_sql = $join_sql;
-    }
+	public function __construct($model_included_name = array(), $join_sql = '')
+	{
+		$this->_models_included = $model_included_name;
+		$this->_join_sql = $join_sql;
+	}
    
    /**
     * Merges info from the other EEM_Related_Model_Info_Carrier into this one.
     * @param EE_Model_Query_Info_Carrier $other_model_query_info_carrier
     */
-    public function merge($other_model_query_info_carrier)
-    {
-        if ($other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())) {
-            $model_included_on_other_join_sql_and_data_types_carrier =  $other_model_query_info_carrier->get_model_names_included();
-            $this->_models_included = array_merge($this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier);
-            $this->_join_sql .= $other_model_query_info_carrier->_join_sql;
-        }
-        // otherwise don't merge our data.
-        // yes, this means that we must immediately merge any model data into our grand list
-        // as soon as we get some from ONE model, or else we could reject a EEM_Related_Model_Info_Carrier
-        // which is carrying info from two models WHERE one is already included but the other is NOT
-    }
+	public function merge($other_model_query_info_carrier)
+	{
+		if ($other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())) {
+			$model_included_on_other_join_sql_and_data_types_carrier =  $other_model_query_info_carrier->get_model_names_included();
+			$this->_models_included = array_merge($this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier);
+			$this->_join_sql .= $other_model_query_info_carrier->_join_sql;
+		}
+		// otherwise don't merge our data.
+		// yes, this means that we must immediately merge any model data into our grand list
+		// as soon as we get some from ONE model, or else we could reject a EEM_Related_Model_Info_Carrier
+		// which is carrying info from two models WHERE one is already included but the other is NOT
+	}
    /**
     * Checks whether or not we have already included all the models mentione din $model_names on the query info varrier
     * @param array $model_names just like EE_MOdel_QUery_Info_Carrier::_models_included: keys are model chain paths, values are the model names only
     * @return boolean
     */
-    protected function _have_already_included_one_of_these_models($model_names)
-    {
-        foreach ($this->_models_included as $model_relation_path => $model_included) {
-            if (array_key_exists($model_relation_path, $model_names)) {
-                return true;
-            }
-        }
-        return false;
-    }
+	protected function _have_already_included_one_of_these_models($model_names)
+	{
+		foreach ($this->_models_included as $model_relation_path => $model_included) {
+			if (array_key_exists($model_relation_path, $model_names)) {
+				return true;
+			}
+		}
+		return false;
+	}
    /**
     * Array keys are model names, values are "model relation paths". See EE_Model_Query_Info_Carrier::_models_included for details
     * @return array like EE_Model_Query_Info_Carrier::_models_included
     */
-    public function get_model_names_included()
-    {
-        return $this->_models_included;
-    }
+	public function get_model_names_included()
+	{
+		return $this->_models_included;
+	}
    /**
     * sets the $where_sql for later use from client code
     * @param string $where_sql
     */
-    public function set_where_sql($where_sql)
-    {
-        $this->_where_sql = $where_sql;
-    }
-    public function get_where_sql()
-    {
-        return $this->_where_sql;
-    }
+	public function set_where_sql($where_sql)
+	{
+		$this->_where_sql = $where_sql;
+	}
+	public function get_where_sql()
+	{
+		return $this->_where_sql;
+	}
 
    /**
     * Gets the SQL for joining the main model to other models involves in the query, which was set earlier on
     * the EE_Model_Query_info_Carrier by calling set_main_model_join_sql()
     * @return string
     */
-    public function get_main_model_join_sql()
-    {
-        return $this->_main_join_sql;
-    }
+	public function get_main_model_join_sql()
+	{
+		return $this->_main_join_sql;
+	}
 
 
    /**
@@ -158,12 +158,12 @@ 
     * after the FROM and before the WHERE.)
     * @param string $join_sql
     */
-    public function set_main_model_join_sql($join_sql)
-    {
-        $this->_main_join_sql = $join_sql;
-    }
-    public function get_full_join_sql()
-    {
-        return $this->_main_join_sql . $this->_join_sql;
-    }
+	public function set_main_model_join_sql($join_sql)
+	{
+		$this->_main_join_sql = $join_sql;
+	}
+	public function get_full_join_sql()
+	{
+		return $this->_main_join_sql . $this->_join_sql;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -96,7 +96,7 @@ 
     public function merge($other_model_query_info_carrier)
     {
         if ($other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())) {
-            $model_included_on_other_join_sql_and_data_types_carrier =  $other_model_query_info_carrier->get_model_names_included();
+            $model_included_on_other_join_sql_and_data_types_carrier = $other_model_query_info_carrier->get_model_names_included();
             $this->_models_included = array_merge($this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier);
             $this->_join_sql .= $other_model_query_info_carrier->_join_sql;
         }
@@ -164,6 +164,6 @@ 
     }
     public function get_full_join_sql()
     {
-        return $this->_main_join_sql . $this->_join_sql;
+        return $this->_main_join_sql.$this->_join_sql;
     }
 }

core/db_models/helpers/EE_Secondary_Table.php

Doc Comments +2 added lines, -1 removed lines

@@ -54,7 +54,7 @@ 
      * creates join statement FROM primary table
      * gets SQL like "LEFT JOIN table_name AS table_alias ON other_table_alias.pk = table_alias.fk
      *
-     * @param string $table allows us to set special conditions on the $table_name portion of the join query (i.e. doing a subquery)
+     * @param string $primary_table_alias_with_model_chain_prefix
      * @return string of SQL
      */
     public function get_join_sql($primary_table_alias_with_model_chain_prefix)
@@ -78,6 +78,7 @@ 
      * " LEFT JOIN secondary_table_table AS Secondary ON ..." like get_join_sql, this function returns
      * " LEFT JOIN primary_table AS Primary ON ...".
      * This is useful if the secondary table is already included in the SQL, but the primary table is not yet.
+     * @param string $secondary_table_alias_with_model_chain_prefix
      * @return string
      */
     public function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix)

Indentation +105 added lines, -105 removed lines

@@ -7,118 +7,118 @@
  */
 class EE_Secondary_Table extends EE_Table_Base
 {
-    protected $_extra_join_conditions;
+	protected $_extra_join_conditions;
 
-    /**
-     *
-     * @global type $wpdb
-     * @param string $table_name with or without wpdb prefix
-     * @param string $pk_column name of primary key column on THIS table
-     * @param string $fk_column the name of the COLUMN that is a foreign key to the primary table's primary key
-     * @param string $extra_join_conditions string for additional SQL to add onto the join statement's ON condition
-     * @param boolean $global whether the table is "global" as in there is only 1 table on an entire multisite install,
-     *                  or whether each site on a multisite install has a copy of this table
-     */
-    public function __construct($table_name, $pk_column, $fk_column = null, $extra_join_conditions = null, $global = false)
-    {
-        $this->_fk_on_table = $fk_column;
-        $this->_extra_join_conditions = $extra_join_conditions;
-        parent::__construct($table_name, $pk_column, $global);
-    }
-    public function get_fk_on_table()
-    {
-        return $this->_fk_on_table;
-    }
-    public function _construct_finalize_set_table_to_join_with(EE_Table_Base $table)
-    {
-        $this->_table_to_join_with = $table;
-    }
-    /**
-     *
-     * @return string of sql like "Event.post_type = 'event'", which gets added to
-     * the end of the join statement with the primary table
-     */
-    public function get_extra_join_conditions()
-    {
-        return $this->_extra_join_conditions;
-    }
-    /**
-     *
-     * @return EE_Primary_Table
-     */
-    public function get_table_to_join_with()
-    {
-        return $this->_table_to_join_with;
-    }
-    /**
-     * creates join statement FROM primary table
-     * gets SQL like "LEFT JOIN table_name AS table_alias ON other_table_alias.pk = table_alias.fk
-     *
-     * @param string $table allows us to set special conditions on the $table_name portion of the join query (i.e. doing a subquery)
-     * @return string of SQL
-     */
-    public function get_join_sql($primary_table_alias_with_model_chain_prefix)
-    {
+	/**
+	 *
+	 * @global type $wpdb
+	 * @param string $table_name with or without wpdb prefix
+	 * @param string $pk_column name of primary key column on THIS table
+	 * @param string $fk_column the name of the COLUMN that is a foreign key to the primary table's primary key
+	 * @param string $extra_join_conditions string for additional SQL to add onto the join statement's ON condition
+	 * @param boolean $global whether the table is "global" as in there is only 1 table on an entire multisite install,
+	 *                  or whether each site on a multisite install has a copy of this table
+	 */
+	public function __construct($table_name, $pk_column, $fk_column = null, $extra_join_conditions = null, $global = false)
+	{
+		$this->_fk_on_table = $fk_column;
+		$this->_extra_join_conditions = $extra_join_conditions;
+		parent::__construct($table_name, $pk_column, $global);
+	}
+	public function get_fk_on_table()
+	{
+		return $this->_fk_on_table;
+	}
+	public function _construct_finalize_set_table_to_join_with(EE_Table_Base $table)
+	{
+		$this->_table_to_join_with = $table;
+	}
+	/**
+	 *
+	 * @return string of sql like "Event.post_type = 'event'", which gets added to
+	 * the end of the join statement with the primary table
+	 */
+	public function get_extra_join_conditions()
+	{
+		return $this->_extra_join_conditions;
+	}
+	/**
+	 *
+	 * @return EE_Primary_Table
+	 */
+	public function get_table_to_join_with()
+	{
+		return $this->_table_to_join_with;
+	}
+	/**
+	 * creates join statement FROM primary table
+	 * gets SQL like "LEFT JOIN table_name AS table_alias ON other_table_alias.pk = table_alias.fk
+	 *
+	 * @param string $table allows us to set special conditions on the $table_name portion of the join query (i.e. doing a subquery)
+	 * @return string of SQL
+	 */
+	public function get_join_sql($primary_table_alias_with_model_chain_prefix)
+	{
 
-        $table_name = $this->get_table_name();
-        $secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix) . $this->get_table_alias();
-        $other_table_pk = $this->get_table_to_join_with()->get_pk_column();
-        $fk = $this->get_fk_on_table();
-        $join_sql = " LEFT JOIN $table_name AS $secondary_table_alias ON $primary_table_alias_with_model_chain_prefix.$other_table_pk = $secondary_table_alias.$fk ";
-        if ($this->get_extra_join_conditions()) {
-            $join_sql.="AND ".$this->get_extra_join_conditions();
-        }
-        return $join_sql;
-    }
+		$table_name = $this->get_table_name();
+		$secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix) . $this->get_table_alias();
+		$other_table_pk = $this->get_table_to_join_with()->get_pk_column();
+		$fk = $this->get_fk_on_table();
+		$join_sql = " LEFT JOIN $table_name AS $secondary_table_alias ON $primary_table_alias_with_model_chain_prefix.$other_table_pk = $secondary_table_alias.$fk ";
+		if ($this->get_extra_join_conditions()) {
+			$join_sql.="AND ".$this->get_extra_join_conditions();
+		}
+		return $join_sql;
+	}
 
 
-    /**
-     * Produces join SQL like get_join_sql, except instead of joining the primary table to the
-     * secondary table, does the inverse: joins the secondary table to the primary one. (Eg, isntead of
-     * " LEFT JOIN secondary_table_table AS Secondary ON ..." like get_join_sql, this function returns
-     * " LEFT JOIN primary_table AS Primary ON ...".
-     * This is useful if the secondary table is already included in the SQL, but the primary table is not yet.
-     * @return string
-     */
-    public function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix)
-    {
-        $primary_table_name =$this->get_table_to_join_with()->get_table_name();
-        $primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix) . $this->get_table_to_join_with()->get_table_alias();
-        $primary_table_pk = $this->get_table_to_join_with()->get_pk_column();// $this->get_pk_column();
-        $fk = $this->get_fk_on_table();
-        $join_sql = " LEFT JOIN $primary_table_name AS $primary_table_alias ON $primary_table_alias.$primary_table_pk = $secondary_table_alias_with_model_chain_prefix.$fk ";
-        if ($this->get_extra_join_conditions()) {
-            $join_sql.="AND ".$this->get_extra_join_conditions();
-        }
-        return $join_sql;
-    }
+	/**
+	 * Produces join SQL like get_join_sql, except instead of joining the primary table to the
+	 * secondary table, does the inverse: joins the secondary table to the primary one. (Eg, isntead of
+	 * " LEFT JOIN secondary_table_table AS Secondary ON ..." like get_join_sql, this function returns
+	 * " LEFT JOIN primary_table AS Primary ON ...".
+	 * This is useful if the secondary table is already included in the SQL, but the primary table is not yet.
+	 * @return string
+	 */
+	public function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix)
+	{
+		$primary_table_name =$this->get_table_to_join_with()->get_table_name();
+		$primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix) . $this->get_table_to_join_with()->get_table_alias();
+		$primary_table_pk = $this->get_table_to_join_with()->get_pk_column();// $this->get_pk_column();
+		$fk = $this->get_fk_on_table();
+		$join_sql = " LEFT JOIN $primary_table_name AS $primary_table_alias ON $primary_table_alias.$primary_table_pk = $secondary_table_alias_with_model_chain_prefix.$fk ";
+		if ($this->get_extra_join_conditions()) {
+			$join_sql.="AND ".$this->get_extra_join_conditions();
+		}
+		return $join_sql;
+	}
 
-    /**
-     * This prepares the join on the other table using a select with a internal limit.
-     * @param  mixed (array|string) $limit limit
-     * @return string                       SQL to return
-     */
-    public function get_select_join_limit_join($limit)
-    {
-        // first get the select
-        $select = $this->get_select_join_limit($limit);
-        $join_sql = $this->get_join_sql($select);
-        return $join_sql;
-    }
+	/**
+	 * This prepares the join on the other table using a select with a internal limit.
+	 * @param  mixed (array|string) $limit limit
+	 * @return string                       SQL to return
+	 */
+	public function get_select_join_limit_join($limit)
+	{
+		// first get the select
+		$select = $this->get_select_join_limit($limit);
+		$join_sql = $this->get_join_sql($select);
+		return $join_sql;
+	}
 
 
 
-    public function get_fully_qualified_fk_column()
-    {
-        $table_alias = $this->get_table_alias();
-        $fk = $this->get_fk_on_table();
-        return $table_alias . '.' . $fk;
-    }
+	public function get_fully_qualified_fk_column()
+	{
+		$table_alias = $this->get_table_alias();
+		$fk = $this->get_fk_on_table();
+		return $table_alias . '.' . $fk;
+	}
 
-    public function get_fully_qualified_pk_on_fk_table()
-    {
-        $table_alias = $this->get_table_to_join_with()->get_table_alias();
-        $pk = $this->get_table_to_join_with()->get_pk_column();
-        return $table_alias . '.' . $pk;
-    }
+	public function get_fully_qualified_pk_on_fk_table()
+	{
+		$table_alias = $this->get_table_to_join_with()->get_table_alias();
+		$pk = $this->get_table_to_join_with()->get_pk_column();
+		return $table_alias . '.' . $pk;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -61,12 +61,12 @@ 
     {
 
         $table_name = $this->get_table_name();
-        $secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix) . $this->get_table_alias();
+        $secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix).$this->get_table_alias();
         $other_table_pk = $this->get_table_to_join_with()->get_pk_column();
         $fk = $this->get_fk_on_table();
         $join_sql = " LEFT JOIN $table_name AS $secondary_table_alias ON $primary_table_alias_with_model_chain_prefix.$other_table_pk = $secondary_table_alias.$fk ";
         if ($this->get_extra_join_conditions()) {
-            $join_sql.="AND ".$this->get_extra_join_conditions();
+            $join_sql .= "AND ".$this->get_extra_join_conditions();
         }
         return $join_sql;
     }
@@ -82,13 +82,13 @@ 
      */
     public function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix)
     {
-        $primary_table_name =$this->get_table_to_join_with()->get_table_name();
-        $primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix) . $this->get_table_to_join_with()->get_table_alias();
-        $primary_table_pk = $this->get_table_to_join_with()->get_pk_column();// $this->get_pk_column();
+        $primary_table_name = $this->get_table_to_join_with()->get_table_name();
+        $primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix).$this->get_table_to_join_with()->get_table_alias();
+        $primary_table_pk = $this->get_table_to_join_with()->get_pk_column(); // $this->get_pk_column();
         $fk = $this->get_fk_on_table();
         $join_sql = " LEFT JOIN $primary_table_name AS $primary_table_alias ON $primary_table_alias.$primary_table_pk = $secondary_table_alias_with_model_chain_prefix.$fk ";
         if ($this->get_extra_join_conditions()) {
-            $join_sql.="AND ".$this->get_extra_join_conditions();
+            $join_sql .= "AND ".$this->get_extra_join_conditions();
         }
         return $join_sql;
     }
@@ -112,13 +112,13 @@ 
     {
         $table_alias = $this->get_table_alias();
         $fk = $this->get_fk_on_table();
-        return $table_alias . '.' . $fk;
+        return $table_alias.'.'.$fk;
     }
 
     public function get_fully_qualified_pk_on_fk_table()
     {
         $table_alias = $this->get_table_to_join_with()->get_table_alias();
         $pk = $this->get_table_to_join_with()->get_pk_column();
-        return $table_alias . '.' . $pk;
+        return $table_alias.'.'.$pk;
     }
 }

core/db_models/strategies/EE_CPT_Minimum_Where_Conditions.strategy.php

Doc Comments +4 added lines, -1 removed lines

@@ -18,6 +18,10 @@ 
 
     protected $_post_type;
     protected $_meta_field;
+
+    /**
+     * @param string $post_type
+     */
     public function __construct($post_type, $meta_field_to_chk = '')
     {
         $this->_post_type = $post_type;
@@ -40,7 +44,6 @@ 
     }
     /**
      * Gets the where default where conditions for a custom post type model
-     * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment"
      * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions)
      */
     protected function _get_default_where_conditions()

Indentation +36 added lines, -36 removed lines

@@ -3,7 +3,7 @@ 
 /**
  *
  * Class EE_CPT_Minimum_Where_Conditions
-  *
+ *
  * Strategy specifically for adding where conditions specific to CPT models.
  * But only sets the minimum, so any row of the right type will get used
  *
@@ -16,39 +16,39 @@ 
 class EE_CPT_Minimum_Where_Conditions extends EE_Default_Where_Conditions
 {
 
-    protected $_post_type;
-    protected $_meta_field;
-    public function __construct($post_type, $meta_field_to_chk = '')
-    {
-        $this->_post_type = $post_type;
-        $this->_meta_field = $meta_field_to_chk;
-    }
-    /**
-     * Gets the field with the specified column. Note, this function might not work
-     * properly if two fields refer to columns with the same name on different tables
-     * @param string $column column name
-     * @return EE_Model_Field_Base
-     */
-    protected function _get_field_on_column($column)
-    {
-        $all_fields = $this->_model->field_settings(true);
-        foreach ($all_fields as $field_name => $field_obj) {
-            if ($column == $field_obj->get_table_column()) {
-                return $field_obj;
-            }
-        }
-    }
-    /**
-     * Gets the where default where conditions for a custom post type model
-     * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment"
-     * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions)
-     */
-    protected function _get_default_where_conditions()
-    {
-        // find post_type field
-        $post_type_field = $this->_get_field_on_column('post_type');
-        return array(
-            $post_type_field->get_name() => $this->_post_type
-        );
-    }
+	protected $_post_type;
+	protected $_meta_field;
+	public function __construct($post_type, $meta_field_to_chk = '')
+	{
+		$this->_post_type = $post_type;
+		$this->_meta_field = $meta_field_to_chk;
+	}
+	/**
+	 * Gets the field with the specified column. Note, this function might not work
+	 * properly if two fields refer to columns with the same name on different tables
+	 * @param string $column column name
+	 * @return EE_Model_Field_Base
+	 */
+	protected function _get_field_on_column($column)
+	{
+		$all_fields = $this->_model->field_settings(true);
+		foreach ($all_fields as $field_name => $field_obj) {
+			if ($column == $field_obj->get_table_column()) {
+				return $field_obj;
+			}
+		}
+	}
+	/**
+	 * Gets the where default where conditions for a custom post type model
+	 * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment"
+	 * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions)
+	 */
+	protected function _get_default_where_conditions()
+	{
+		// find post_type field
+		$post_type_field = $this->_get_field_on_column('post_type');
+		return array(
+			$post_type_field->get_name() => $this->_post_type
+		);
+	}
 }

core/db_models/strategies/EE_CPT_Where_Conditions.strategy.php

Doc Comments -1 removed lines

@@ -16,7 +16,6 @@
 {
     /**
      * Gets the where default where conditions for a custom post type model
-     * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment"
      * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions)
      */
     protected function _get_default_where_conditions()

Indentation +16 added lines, -16 removed lines

@@ -3,7 +3,7 @@ 
 /**
  *
  * Class EE_Default_Where_Conditions
-  *
+ *
  * Strategy specifically for adding where conditions specific to CPT models.
  *
  * @package         Event Espresso
@@ -14,19 +14,19 @@ 
  */
 class EE_CPT_Where_Conditions extends EE_CPT_Minimum_Where_Conditions
 {
-    /**
-     * Gets the where default where conditions for a custom post type model
-     * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment"
-     * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions)
-     */
-    protected function _get_default_where_conditions()
-    {
-        $status_field = $this->_get_field_on_column('post_status');
-        return array_merge(
-            parent::_get_default_where_conditions(),
-            array(
-                $status_field->get_name() => array('NOT IN',array('auto-draft','trash') )
-            )
-        );
-    }
+	/**
+	 * Gets the where default where conditions for a custom post type model
+	 * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment"
+	 * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions)
+	 */
+	protected function _get_default_where_conditions()
+	{
+		$status_field = $this->_get_field_on_column('post_status');
+		return array_merge(
+			parent::_get_default_where_conditions(),
+			array(
+				$status_field->get_name() => array('NOT IN',array('auto-draft','trash') )
+			)
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
         return array_merge(
             parent::_get_default_where_conditions(),
             array(
-                $status_field->get_name() => array('NOT IN',array('auto-draft','trash') )
+                $status_field->get_name() => array('NOT IN', array('auto-draft', 'trash'))
             )
         );
     }

core/EE_Deprecated.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -1049,7 +1049,7 @@
 
     /**
      * @deprecated 4.9.0
-     * @return array
+     * @return EE_messenger[]
      */
     public function get_installed_messengers()
     {

Spacing +30 added lines, -30 removed lines

@@ -84,20 +84,20 @@ 
     // loop thru and call doing_it_wrong() or remove any that aren't being used
     foreach ($deprecated_filters as $deprecated_filter => $on) {
         // was this filter called ?
-        if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter)) {
+        if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter)) {
             // only display doing_it_wrong() notice to Event Admins during non-AJAX requests
             if (EE_Registry::instance()->CAP->current_user_can(
                     'ee_read_ee',
                     'hide_doing_it_wrong_for_deprecated_SPCO_filter'
                 ) && ! defined('DOING_AJAX')) {
                 EE_Error::doing_it_wrong(
-                    'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+                    'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter,
                     sprintf(
                         __(
                             'The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"',
                             'event_espresso'
                         ),
-                        'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+                        'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter,
                         '<br />',
                         'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
                         '/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php'
@@ -106,10 +106,10 @@ 
                 );
             }
         } else {
-            unset($deprecated_filters[ $deprecated_filter ]);
+            unset($deprecated_filters[$deprecated_filter]);
         }
     }
-    if (! empty($deprecated_filters)) {
+    if ( ! empty($deprecated_filters)) {
 
         if ($checkout->current_step->slug(
             ) == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) {
@@ -143,7 +143,7 @@ 
                 $submit_button_text = apply_filters(
                                           'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to',
                                           $submit_button_text
-                                      ) . $checkout->next_step->name();
+                                      ).$checkout->next_step->name();
             }
         }
 
@@ -327,7 +327,7 @@ 
             'event_espresso'
         );
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             $msg,
             '4.8.32.rc.000'
         );
@@ -354,7 +354,7 @@ 
 function ee_deprecated_update_attendee_registration_form_old($admin_page)
 {
     // check if the old hooks are in use. If not, do the default
-    if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+    if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
         || ! $admin_page instanceof EE_Admin_Page) {
         return;
     }
@@ -362,7 +362,7 @@ 
     $qstns = isset($req_data['qstn']) ? $req_data['qstn'] : false;
     $REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : false;
     $qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns);
-    if (! $REG_ID || ! $qstns) {
+    if ( ! $REG_ID || ! $qstns) {
         EE_Error::add_error(
             __('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'),
             __FILE__,
@@ -382,7 +382,7 @@ 
 
     foreach ($qstns as $QST_ID => $qstn) {
         // if $qstn isn't an array then it doesn't already have an answer, so let's create the answer
-        if (! is_array($qstn)) {
+        if ( ! is_array($qstn)) {
             $success = $this->_save_new_answer($REG_ID, $QST_ID, $qstn);
             continue;
         }
@@ -399,7 +399,7 @@ 
             );
             $answer = EEM_Answer::instance()->get_one($query_params);
             // this MAY be an array but NOT have an answer because its multi select.  If so then we need to create the answer
-            if (! $answer instanceof EE_Answer) {
+            if ( ! $answer instanceof EE_Answer) {
                 $set_values = array(
                     'QST_ID'    => $QST_ID,
                     'REG_ID'    => $REG_ID,
@@ -440,7 +440,7 @@ 
 function ee_deprecated_reg_questions_meta_box_old($do_default_action, $admin_page, $registration)
 {
     // check if the old hooks are in use. If not, do the default
-    if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+    if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
         || ! $admin_page instanceof EE_Admin_Page) {
         return $do_default_action;
     }
@@ -472,7 +472,7 @@ 
         'reg_questions_form_action' => 'edit_registration',
         'REG_ID'                    => $registration->ID(),
     );
-    $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+    $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php';
     echo EEH_Template::display_template($template_path, $template_args, true);
     // indicate that we should not do the default admin page code
     return false;
@@ -590,7 +590,7 @@ 
     public function _class_is_deprecated($method)
     {
         EE_Error::doing_it_wrong(
-            'EE_messages::' . $method,
+            'EE_messages::'.$method,
             __('EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.'),
             '4.9.0',
             '4.10.0.p'
@@ -729,7 +729,7 @@ 
         $error = false;
         // try to intelligently determine what method we'll call based on the incoming data.
         // if generating and sending are different then generate and send immediately.
-        if (! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
+        if ( ! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
             // in the legacy system, when generating and sending were different, that means all the
             // vars are already in the request object.  So let's just use that.
             try {
@@ -742,7 +742,7 @@ 
                     'event_espresso'
                 );
                 // add specific message for developers if WP_DEBUG in on
-                $error_msg .= '||' . $e->getMessage();
+                $error_msg .= '||'.$e->getMessage();
                 EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
                 $error = true;
             }
@@ -816,7 +816,7 @@ 
             }
         }
         // if no error then return the generated message(s).
-        if (! $error && ! $send) {
+        if ( ! $error && ! $send) {
             $generated_queue = $processor->generate_queue(false);
             // get message and return.
             $generated_queue->get_message_repository()->rewind();
@@ -875,7 +875,7 @@ 
         /** @type EE_Messages_Queue $queue */
         $queue = EE_Registry::instance()->load_lib('Messages_Queue');
         // make sure we have a proper message object
-        if (! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
+        if ( ! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
             $msg = EE_Message_Factory::create(
                 array(
                     'MSG_messenger'    => $messenger,
@@ -887,11 +887,11 @@ 
         } else {
             $msg = $message;
         }
-        if (! $msg instanceof EE_Message) {
+        if ( ! $msg instanceof EE_Message) {
             return false;
         }
         // make sure any content in a content property (if not empty) is set on the MSG_content.
-        if (! empty($msg->content)) {
+        if ( ! empty($msg->content)) {
             $msg->set('MSG_content', $msg->content);
         }
         $queue->add($msg);
@@ -1130,8 +1130,8 @@ 
 
 add_filter(
     'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-    function ($event_list_iframe_css) {
-        if (! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
+    function($event_list_iframe_css) {
+        if ( ! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
             return $event_list_iframe_css;
         }
         deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1150,8 +1150,8 @@ 
 );
 add_filter(
     'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-    function ($event_list_iframe_js) {
-        if (! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
+    function($event_list_iframe_js) {
+        if ( ! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
             return $event_list_iframe_js;
         }
         deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1170,8 +1170,8 @@ 
 );
 add_action(
     'AHEE__EE_Capabilities__addCaps__complete',
-    function ($capabilities_map) {
-        if (! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) {
+    function($capabilities_map) {
+        if ( ! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) {
             return;
         }
         deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1190,8 +1190,8 @@ 
 
 add_filter(
     'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
-    function ($existing_attendee, $registration, $attendee_data) {
-        if (! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) {
+    function($existing_attendee, $registration, $attendee_data) {
+        if ( ! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) {
             return $existing_attendee;
         }
         deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1274,7 +1274,7 @@ 
      */
     public function event_list_title($event_list_title = '')
     {
-        if (! empty($this->title)) {
+        if ( ! empty($this->title)) {
             return $this->title;
         }
         return $event_list_title;
@@ -1417,7 +1417,7 @@ 
             foreach ($model_fields as $field) {
                 if ($label === EEH_Export::get_column_name_for_field($field)) {
                     // re-add the old field name
-                    $new_label = $label . '[' . $field->get_name() . ']';
+                    $new_label = $label.'['.$field->get_name().']';
                     break;
                 }
             }

Indentation +1217 added lines, -1217 removed lines

@@ -39,31 +39,31 @@ 
  * @param string $action_or_filter
  */
 function deprecated_espresso_action_or_filter_doing_it_wrong(
-    $deprecated_filter,
-    $replacement,
-    $replacement_location,
-    $version_deprecated,
-    $version_applies,
-    $action_or_filter = 'action'
+	$deprecated_filter,
+	$replacement,
+	$replacement_location,
+	$version_deprecated,
+	$version_applies,
+	$action_or_filter = 'action'
 ) {
-    $action_or_filter = $action_or_filter === 'action'
-        ? esc_html__('action', 'event_espresso')
-        : esc_html__('filter', 'event_espresso');
-    EE_Error::doing_it_wrong(
-        $deprecated_filter,
-        sprintf(
-            __(
-                'This %1$s is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new %1$s: %4$s"%2$s" found in "%3$s"',
-                'event_espresso'
-            ),
-            $action_or_filter,
-            $replacement,
-            $replacement_location,
-            '<br />'
-        ),
-        $version_deprecated,
-        $version_applies
-    );
+	$action_or_filter = $action_or_filter === 'action'
+		? esc_html__('action', 'event_espresso')
+		: esc_html__('filter', 'event_espresso');
+	EE_Error::doing_it_wrong(
+		$deprecated_filter,
+		sprintf(
+			__(
+				'This %1$s is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new %1$s: %4$s"%2$s" found in "%3$s"',
+				'event_espresso'
+			),
+			$action_or_filter,
+			$replacement,
+			$replacement_location,
+			'<br />'
+		),
+		$version_deprecated,
+		$version_applies
+	);
 }
 
 /**
@@ -75,90 +75,90 @@ 
  */
 function ee_deprecated__registration_checkout__button_text($submit_button_text, EE_Checkout $checkout)
 {
-    // list of old filters
-    $deprecated_filters = array(
-        'update_registration_details' => true,
-        'process_payment'             => true,
-        'finalize_registration'       => true,
-        'and_proceed_to_payment'      => true,
-        'proceed_to'                  => true,
-    );
-    // loop thru and call doing_it_wrong() or remove any that aren't being used
-    foreach ($deprecated_filters as $deprecated_filter => $on) {
-        // was this filter called ?
-        if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter)) {
-            // only display doing_it_wrong() notice to Event Admins during non-AJAX requests
-            if (EE_Registry::instance()->CAP->current_user_can(
-                    'ee_read_ee',
-                    'hide_doing_it_wrong_for_deprecated_SPCO_filter'
-                ) && ! defined('DOING_AJAX')) {
-                EE_Error::doing_it_wrong(
-                    'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
-                    sprintf(
-                        __(
-                            'The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"',
-                            'event_espresso'
-                        ),
-                        'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
-                        '<br />',
-                        'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-                        '/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php'
-                    ),
-                    '4.6.10'
-                );
-            }
-        } else {
-            unset($deprecated_filters[ $deprecated_filter ]);
-        }
-    }
-    if (! empty($deprecated_filters)) {
-
-        if ($checkout->current_step->slug(
-            ) == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) {
-            $submit_button_text = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details',
-                $submit_button_text
-            );
-        } elseif ($checkout->current_step->slug(
-            ) == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) {
-            $submit_button_text = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment',
-                $submit_button_text
-            );
-        } elseif ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug(
-            ) == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) {
-            $submit_button_text = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration',
-                $submit_button_text
-            );
-        }
-        if ($checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            if ($checkout->payment_required() && $checkout->next_step->slug(
-                ) == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) {
-                $submit_button_text .= apply_filters(
-                    'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment',
-                    $submit_button_text
-                );
-            }
-            if ($checkout->next_step->slug(
-                ) != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) {
-                $submit_button_text = apply_filters(
-                                          'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to',
-                                          $submit_button_text
-                                      ) . $checkout->next_step->name();
-            }
-        }
-
-    }
-    return $submit_button_text;
+	// list of old filters
+	$deprecated_filters = array(
+		'update_registration_details' => true,
+		'process_payment'             => true,
+		'finalize_registration'       => true,
+		'and_proceed_to_payment'      => true,
+		'proceed_to'                  => true,
+	);
+	// loop thru and call doing_it_wrong() or remove any that aren't being used
+	foreach ($deprecated_filters as $deprecated_filter => $on) {
+		// was this filter called ?
+		if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter)) {
+			// only display doing_it_wrong() notice to Event Admins during non-AJAX requests
+			if (EE_Registry::instance()->CAP->current_user_can(
+					'ee_read_ee',
+					'hide_doing_it_wrong_for_deprecated_SPCO_filter'
+				) && ! defined('DOING_AJAX')) {
+				EE_Error::doing_it_wrong(
+					'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+					sprintf(
+						__(
+							'The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"',
+							'event_espresso'
+						),
+						'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+						'<br />',
+						'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+						'/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php'
+					),
+					'4.6.10'
+				);
+			}
+		} else {
+			unset($deprecated_filters[ $deprecated_filter ]);
+		}
+	}
+	if (! empty($deprecated_filters)) {
+
+		if ($checkout->current_step->slug(
+			) == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) {
+			$submit_button_text = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details',
+				$submit_button_text
+			);
+		} elseif ($checkout->current_step->slug(
+			) == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) {
+			$submit_button_text = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment',
+				$submit_button_text
+			);
+		} elseif ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug(
+			) == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) {
+			$submit_button_text = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration',
+				$submit_button_text
+			);
+		}
+		if ($checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			if ($checkout->payment_required() && $checkout->next_step->slug(
+				) == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) {
+				$submit_button_text .= apply_filters(
+					'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment',
+					$submit_button_text
+				);
+			}
+			if ($checkout->next_step->slug(
+				) != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) {
+				$submit_button_text = apply_filters(
+										  'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to',
+										  $submit_button_text
+									  ) . $checkout->next_step->name();
+			}
+		}
+
+	}
+	return $submit_button_text;
 
 }
 
 add_filter(
-    'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-    'ee_deprecated__registration_checkout__button_text',
-    10,
-    2
+	'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+	'ee_deprecated__registration_checkout__button_text',
+	10,
+	2
 );
 
 
@@ -170,54 +170,54 @@ 
  */
 function ee_deprecated_finalize_transaction(EE_Checkout $checkout, $status_updates)
 {
-    $action_ref = null;
-    $action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction')
-        ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref;
-    $action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction')
-        ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref;
-    if ($action_ref) {
-
-        EE_Error::doing_it_wrong(
-            $action_ref,
-            sprintf(
-                __(
-                    'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"',
-                    'event_espresso'
-                ),
-                '<br />',
-                '/core/business/EE_Transaction_Processor.class.php',
-                'AHEE__EE_Transaction_Processor__finalize',
-                'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
-                'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
-                'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing'
-            ),
-            '4.6.0'
-        );
-        switch ($action_ref) {
-            case 'AHEE__EE_Transaction__finalize__new_transaction' :
-                do_action(
-                    'AHEE__EE_Transaction__finalize__new_transaction',
-                    $checkout->transaction,
-                    $checkout->admin_request
-                );
-                break;
-            case 'AHEE__EE_Transaction__finalize__all_transaction' :
-                do_action(
-                    'AHEE__EE_Transaction__finalize__new_transaction',
-                    $checkout->transaction,
-                    array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates),
-                    $checkout->admin_request
-                );
-                break;
-        }
-    }
+	$action_ref = null;
+	$action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction')
+		? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref;
+	$action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction')
+		? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref;
+	if ($action_ref) {
+
+		EE_Error::doing_it_wrong(
+			$action_ref,
+			sprintf(
+				__(
+					'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"',
+					'event_espresso'
+				),
+				'<br />',
+				'/core/business/EE_Transaction_Processor.class.php',
+				'AHEE__EE_Transaction_Processor__finalize',
+				'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
+				'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
+				'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing'
+			),
+			'4.6.0'
+		);
+		switch ($action_ref) {
+			case 'AHEE__EE_Transaction__finalize__new_transaction' :
+				do_action(
+					'AHEE__EE_Transaction__finalize__new_transaction',
+					$checkout->transaction,
+					$checkout->admin_request
+				);
+				break;
+			case 'AHEE__EE_Transaction__finalize__all_transaction' :
+				do_action(
+					'AHEE__EE_Transaction__finalize__new_transaction',
+					$checkout->transaction,
+					array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates),
+					$checkout->admin_request
+				);
+				break;
+		}
+	}
 }
 
 add_action(
-    'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
-    'ee_deprecated_finalize_transaction',
-    10,
-    2
+	'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
+	'ee_deprecated_finalize_transaction',
+	10,
+	2
 );
 /**
  * ee_deprecated_finalize_registration
@@ -226,35 +226,35 @@ 
  */
 function ee_deprecated_finalize_registration(EE_Registration $registration)
 {
-    $action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg')
-        ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : null;
-    if ($action_ref) {
-        EE_Error::doing_it_wrong(
-            $action_ref,
-            sprintf(
-                __(
-                    'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"',
-                    'event_espresso'
-                ),
-                '<br />',
-                '/core/business/EE_Registration_Processor.class.php',
-                'AHEE__EE_Registration_Processor__trigger_registration_update_notifications'
-            ),
-            '4.6.0'
-        );
-        do_action(
-            'AHEE__EE_Registration__finalize__update_and_new_reg',
-            $registration,
-            (is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX))
-        );
-    }
+	$action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg')
+		? 'AHEE__EE_Registration__finalize__update_and_new_reg' : null;
+	if ($action_ref) {
+		EE_Error::doing_it_wrong(
+			$action_ref,
+			sprintf(
+				__(
+					'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"',
+					'event_espresso'
+				),
+				'<br />',
+				'/core/business/EE_Registration_Processor.class.php',
+				'AHEE__EE_Registration_Processor__trigger_registration_update_notifications'
+			),
+			'4.6.0'
+		);
+		do_action(
+			'AHEE__EE_Registration__finalize__update_and_new_reg',
+			$registration,
+			(is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX))
+		);
+	}
 }
 
 add_action(
-    'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-    'ee_deprecated_finalize_registration',
-    10,
-    1
+	'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+	'ee_deprecated_finalize_registration',
+	10,
+	1
 );
 
 
@@ -264,44 +264,44 @@ 
  */
 function ee_deprecated_hooks()
 {
-    /**
-     * @var          $hooks       array where keys are hook names, and their values are array{
-     * @type string  $version     when deprecated
-     * @type string  $alternative saying what to use instead
-     * @type boolean $still_works whether or not the hook still works
-     *        }
-     */
-    $hooks = array(
-        'AHEE__EE_System___do_setup_validations' => array(
-            'version'     => '4.6.0',
-            'alternative' => __(
-                'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)',
-                'event_espresso'
-            ),
-            'still_works' => false,
-        ),
-    );
-    foreach ($hooks as $name => $deprecation_info) {
-        if (has_action($name)) {
-            EE_Error::doing_it_wrong(
-                $name,
-                sprintf(
-                    __('This filter is deprecated. %1$s%2$s', 'event_espresso'),
-                    $deprecation_info['still_works'] ? __(
-                        'It *may* work as an attempt to build in backwards compatibility.',
-                        'event_espresso'
-                    ) : __('It has been completely removed.', 'event_espresso'),
-                    isset($deprecation_info['alternative'])
-                        ? $deprecation_info['alternative']
-                        : __(
-                        'Please read the current EE4 documentation further or contact Support.',
-                        'event_espresso'
-                    )
-                ),
-                isset($deprecation_info['version']) ? $deprecation_info['version'] : __('recently', 'event_espresso')
-            );
-        }
-    }
+	/**
+	 * @var          $hooks       array where keys are hook names, and their values are array{
+	 * @type string  $version     when deprecated
+	 * @type string  $alternative saying what to use instead
+	 * @type boolean $still_works whether or not the hook still works
+	 *        }
+	 */
+	$hooks = array(
+		'AHEE__EE_System___do_setup_validations' => array(
+			'version'     => '4.6.0',
+			'alternative' => __(
+				'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)',
+				'event_espresso'
+			),
+			'still_works' => false,
+		),
+	);
+	foreach ($hooks as $name => $deprecation_info) {
+		if (has_action($name)) {
+			EE_Error::doing_it_wrong(
+				$name,
+				sprintf(
+					__('This filter is deprecated. %1$s%2$s', 'event_espresso'),
+					$deprecation_info['still_works'] ? __(
+						'It *may* work as an attempt to build in backwards compatibility.',
+						'event_espresso'
+					) : __('It has been completely removed.', 'event_espresso'),
+					isset($deprecation_info['alternative'])
+						? $deprecation_info['alternative']
+						: __(
+						'Please read the current EE4 documentation further or contact Support.',
+						'event_espresso'
+					)
+				),
+				isset($deprecation_info['version']) ? $deprecation_info['version'] : __('recently', 'event_espresso')
+			);
+		}
+	}
 }
 
 add_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', 'ee_deprecated_hooks');
@@ -316,34 +316,34 @@ 
  */
 function ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
 {
-    $in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns')
-              || has_action(
-                  'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save'
-              );
-    if ($in_use) {
-        $msg = __(
-            'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.'
-            . 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,'
-            . 'use FHEE__EE_Form_Section_Proper__receive_form_submission__req_data to customize the submission data, or AHEE__EE_Form_Section_Proper__receive_form_submission__end '
-            . 'to add other actions after a form submission has been received.',
-            'event_espresso'
-        );
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            $msg,
-            '4.8.32.rc.000'
-        );
-        // it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed
-        if (is_admin() && ! defined('DOING_AJAX')) {
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-    return $in_use;
+	$in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns')
+			  || has_action(
+				  'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save'
+			  );
+	if ($in_use) {
+		$msg = __(
+			'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.'
+			. 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,'
+			. 'use FHEE__EE_Form_Section_Proper__receive_form_submission__req_data to customize the submission data, or AHEE__EE_Form_Section_Proper__receive_form_submission__end '
+			. 'to add other actions after a form submission has been received.',
+			'event_espresso'
+		);
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			$msg,
+			'4.8.32.rc.000'
+		);
+		// it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed
+		if (is_admin() && ! defined('DOING_AJAX')) {
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+	return $in_use;
 }
 
 add_action(
-    'AHEE__Registrations_Admin_Page___registration_details_metabox__start',
-    'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks'
+	'AHEE__Registrations_Admin_Page___registration_details_metabox__start',
+	'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks'
 );
 
 /**
@@ -355,77 +355,77 @@ 
  */
 function ee_deprecated_update_attendee_registration_form_old($admin_page)
 {
-    // check if the old hooks are in use. If not, do the default
-    if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
-        || ! $admin_page instanceof EE_Admin_Page) {
-        return;
-    }
-    $req_data = $admin_page->get_request_data();
-    $qstns = isset($req_data['qstn']) ? $req_data['qstn'] : false;
-    $REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : false;
-    $qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns);
-    if (! $REG_ID || ! $qstns) {
-        EE_Error::add_error(
-            __('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-    $success = true;
-
-    // allow others to get in on this awesome fun   :D
-    do_action(
-        'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save',
-        $REG_ID,
-        $qstns
-    );
-    // loop thru questions... FINALLY!!!
-
-    foreach ($qstns as $QST_ID => $qstn) {
-        // if $qstn isn't an array then it doesn't already have an answer, so let's create the answer
-        if (! is_array($qstn)) {
-            $success = $this->_save_new_answer($REG_ID, $QST_ID, $qstn);
-            continue;
-        }
-
-
-        foreach ($qstn as $ANS_ID => $ANS_value) {
-            // get answer
-            $query_params = array(
-                0 => array(
-                    'ANS_ID' => $ANS_ID,
-                    'REG_ID' => $REG_ID,
-                    'QST_ID' => $QST_ID,
-                ),
-            );
-            $answer = EEM_Answer::instance()->get_one($query_params);
-            // this MAY be an array but NOT have an answer because its multi select.  If so then we need to create the answer
-            if (! $answer instanceof EE_Answer) {
-                $set_values = array(
-                    'QST_ID'    => $QST_ID,
-                    'REG_ID'    => $REG_ID,
-                    'ANS_value' => $qstn,
-                );
-                $success = EEM_Answer::instance()->insert($set_values);
-                continue 2;
-            }
-
-            $answer->set('ANS_value', $ANS_value);
-            $success = $answer->save();
-        }
-    }
-    $what = __('Registration Form', 'event_espresso');
-    $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default');
-    $admin_page->redirect_after_action($success, $what, __('updated', 'event_espresso'), $route);
-    exit;
+	// check if the old hooks are in use. If not, do the default
+	if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+		|| ! $admin_page instanceof EE_Admin_Page) {
+		return;
+	}
+	$req_data = $admin_page->get_request_data();
+	$qstns = isset($req_data['qstn']) ? $req_data['qstn'] : false;
+	$REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : false;
+	$qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns);
+	if (! $REG_ID || ! $qstns) {
+		EE_Error::add_error(
+			__('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+	$success = true;
+
+	// allow others to get in on this awesome fun   :D
+	do_action(
+		'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save',
+		$REG_ID,
+		$qstns
+	);
+	// loop thru questions... FINALLY!!!
+
+	foreach ($qstns as $QST_ID => $qstn) {
+		// if $qstn isn't an array then it doesn't already have an answer, so let's create the answer
+		if (! is_array($qstn)) {
+			$success = $this->_save_new_answer($REG_ID, $QST_ID, $qstn);
+			continue;
+		}
+
+
+		foreach ($qstn as $ANS_ID => $ANS_value) {
+			// get answer
+			$query_params = array(
+				0 => array(
+					'ANS_ID' => $ANS_ID,
+					'REG_ID' => $REG_ID,
+					'QST_ID' => $QST_ID,
+				),
+			);
+			$answer = EEM_Answer::instance()->get_one($query_params);
+			// this MAY be an array but NOT have an answer because its multi select.  If so then we need to create the answer
+			if (! $answer instanceof EE_Answer) {
+				$set_values = array(
+					'QST_ID'    => $QST_ID,
+					'REG_ID'    => $REG_ID,
+					'ANS_value' => $qstn,
+				);
+				$success = EEM_Answer::instance()->insert($set_values);
+				continue 2;
+			}
+
+			$answer->set('ANS_value', $ANS_value);
+			$success = $answer->save();
+		}
+	}
+	$what = __('Registration Form', 'event_espresso');
+	$route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default');
+	$admin_page->redirect_after_action($success, $what, __('updated', 'event_espresso'), $route);
+	exit;
 }
 
 add_action(
-    'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start',
-    'ee_deprecated_update_attendee_registration_form_old',
-    10,
-    1
+	'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start',
+	'ee_deprecated_update_attendee_registration_form_old',
+	10,
+	1
 );
 /**
  * Render the registration admin page's custom questions area in the old fashion
@@ -441,50 +441,50 @@ 
  */
 function ee_deprecated_reg_questions_meta_box_old($do_default_action, $admin_page, $registration)
 {
-    // check if the old hooks are in use. If not, do the default
-    if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
-        || ! $admin_page instanceof EE_Admin_Page) {
-        return $do_default_action;
-    }
-    add_filter(
-        'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
-        array($admin_page, 'form_before_question_group'),
-        10,
-        1
-    );
-    add_filter(
-        'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
-        array($admin_page, 'form_after_question_group'),
-        10,
-        1
-    );
-    add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1);
-    add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1);
-
-    $question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options(
-        $registration,
-        $registration->get(
-            'EVT_ID'
-        )
-    );
-
-    EE_Registry::instance()->load_helper('Form_Fields');
-    $template_args = array(
-        'att_questions'             => EEH_Form_Fields::generate_question_groups_html($question_groups),
-        'reg_questions_form_action' => 'edit_registration',
-        'REG_ID'                    => $registration->ID(),
-    );
-    $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
-    echo EEH_Template::display_template($template_path, $template_args, true);
-    // indicate that we should not do the default admin page code
-    return false;
+	// check if the old hooks are in use. If not, do the default
+	if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+		|| ! $admin_page instanceof EE_Admin_Page) {
+		return $do_default_action;
+	}
+	add_filter(
+		'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
+		array($admin_page, 'form_before_question_group'),
+		10,
+		1
+	);
+	add_filter(
+		'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
+		array($admin_page, 'form_after_question_group'),
+		10,
+		1
+	);
+	add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1);
+	add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1);
+
+	$question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options(
+		$registration,
+		$registration->get(
+			'EVT_ID'
+		)
+	);
+
+	EE_Registry::instance()->load_helper('Form_Fields');
+	$template_args = array(
+		'att_questions'             => EEH_Form_Fields::generate_question_groups_html($question_groups),
+		'reg_questions_form_action' => 'edit_registration',
+		'REG_ID'                    => $registration->ID(),
+	);
+	$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+	echo EEH_Template::display_template($template_path, $template_args, true);
+	// indicate that we should not do the default admin page code
+	return false;
 }
 
 add_action(
-    'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default',
-    'ee_deprecated_reg_questions_meta_box_old',
-    10,
-    3
+	'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default',
+	'ee_deprecated_reg_questions_meta_box_old',
+	10,
+	3
 );
 
 
@@ -501,42 +501,42 @@ 
 class EE_Message_Template_Defaults extends EE_Base
 {
 
-    /**
-     * EE_Message_Template_Defaults constructor.
-     *
-     * @param EE_messages $messages
-     * @param             $messenger_name
-     * @param             $message_type_name
-     * @param int         $GRP_ID
-     * @return EE_Messages_Template_Defaults
-     */
-    public function __construct(
-        EE_messages $messages,
-        $messenger_name,
-        $message_type_name,
-        $GRP_ID = 0
-    ) {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            __(
-                'The class EE_Message_Template_Defaults has been deprecated and replaced by EE_Messages_Template_Defaults.',
-                'event_espresso'
-            ),
-            '4.9.0'
-        );
-        /** @var EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $messenger = $message_resource_manager->get_messenger($messenger_name);
-        $message_type = $message_resource_manager->get_message_type($message_type_name);
-        return EE_Registry::instance()->load_lib(
-            'Messages_Template_Defaults',
-            array(
-                $GRP_ID,
-                $messenger,
-                $message_type,
-            )
-        );
-    }
+	/**
+	 * EE_Message_Template_Defaults constructor.
+	 *
+	 * @param EE_messages $messages
+	 * @param             $messenger_name
+	 * @param             $message_type_name
+	 * @param int         $GRP_ID
+	 * @return EE_Messages_Template_Defaults
+	 */
+	public function __construct(
+		EE_messages $messages,
+		$messenger_name,
+		$message_type_name,
+		$GRP_ID = 0
+	) {
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			__(
+				'The class EE_Message_Template_Defaults has been deprecated and replaced by EE_Messages_Template_Defaults.',
+				'event_espresso'
+			),
+			'4.9.0'
+		);
+		/** @var EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $message_resource_manager->get_messenger($messenger_name);
+		$message_type = $message_resource_manager->get_message_type($message_type_name);
+		return EE_Registry::instance()->load_lib(
+			'Messages_Template_Defaults',
+			array(
+				$GRP_ID,
+				$messenger,
+				$message_type,
+			)
+		);
+	}
 }
 
 
@@ -554,525 +554,525 @@ 
 class EE_messages
 {
 
-    /** @type EE_messenger[] */
-    protected $_active_messengers = array();
-
-    /** @type array */
-    protected $_active_message_types = array();
-
-    /** @type EE_message_type[] */
-    protected $_installed_message_types = array();
-
-    /** @type EE_messenger */
-    protected $_messenger;
-
-    /** @type EE_message_type */
-    protected $_message_type;
-
-    /** @type array */
-    protected $_contexts = array();
-
-    /** @type EE_Message_Resource_Manager $_message_resource_manager */
-    protected $_message_resource_manager;
-
-
-    /**
-     * EE_messages constructor.
-     *
-     * @deprecated 4.9.0
-     */
-    public function __construct()
-    {
-    }
-
-
-    /**
-     * @param string $method
-     */
-    public function _class_is_deprecated($method)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_messages::' . $method,
-            __('EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.'),
-            '4.9.0',
-            '4.10.0.p'
-        );
-        // Please use EE_Message_Resource_Manager instead
-        $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger_name
-     * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive
-     */
-    public function ensure_messenger_is_active($messenger_name)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $message_type message type name
-     * @param        $messenger
-     * @return bool true if it got activated (or was active) and false if not.
-     * @throws \EE_Error
-     */
-    public function ensure_message_type_is_active($message_type, $messenger)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger_name
-     * @param array  $mts_to_activate             (optional) An array of message types to activate with this messenger.
-     *                                             If included we do NOT setup the default message types (assuming they
-     *                                             are already setup.)
-     * @return boolean an array of generated templates or false if nothing generated/activated.
-     */
-    public function activate_messenger($messenger_name, $mts_to_activate = array())
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param EE_messenger    $messenger    messenger used in trigger
-     * @param EE_message_type $message_type message type used in trigger
-     *
-     * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
-     */
-    public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger
-     * @return EE_messenger | null
-     */
-    public function get_messenger_if_active($messenger)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_messenger($messenger);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param EE_Message $message
-     * @return array  An array with 'messenger' and 'message_type' as the index and the corresponding valid object if
-     *                  available.
-     *                  Eg. Valid Messenger and Message Type:
-     *                  array(
-     *                  'messenger' => new EE_Email_messenger(),
-     *                  'message_type' => new EE_Registration_Approved_message_type()
-     *                  )
-     *                  Valid Messenger and Invalid Message Type:
-     *                  array(
-     *                  'messenger' => new EE_Email_messenger(),
-     *                  'message_type' => null
-     *                  )
-     */
-    public function validate_for_use(EE_Message $message)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return array(
-            'messenger'    => $message->messenger_object(),
-            'message_type' => $message->message_type_object(),
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param  string $type                 What type of message are we sending (corresponds to message types)
-     * @param  mixed  $vars                 Data being sent for parsing in the message
-     * @param  string $sending_messenger    if included then we ONLY use the specified messenger for delivery.
-     *                                      Otherwise we cycle through all active messengers.
-     * @param string  $generating_messenger if included then this messenger is used for generating the message
-     *                                      templates (but not for sending).
-     * @param string  $context              If included then only a message type for a specific context will be
-     *                                      generated.
-     * @param bool    $send                 Default TRUE.  If false, then this will just return the generated
-     *                                      EE_messages objects which might be used by the trigger to setup a batch
-     *                                      message (typically html messenger uses it).
-     * @return bool
-     */
-    public function send_message(
-        $type,
-        $vars,
-        $sending_messenger = '',
-        $generating_messenger = '',
-        $context = '',
-        $send = true
-    ) {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        /** @type EE_Messages_Processor $processor */
-        $processor = EE_Registry::instance()->load_lib('Messages_Processor');
-        $error = false;
-        // try to intelligently determine what method we'll call based on the incoming data.
-        // if generating and sending are different then generate and send immediately.
-        if (! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
-            // in the legacy system, when generating and sending were different, that means all the
-            // vars are already in the request object.  So let's just use that.
-            try {
-                /** @type EE_Message_To_Generate_From_Request $mtg */
-                $mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
-                $processor->generate_and_send_now($mtg);
-            } catch (EE_Error $e) {
-                $error_msg = __(
-                    'Please note that a system message failed to send due to a technical issue.',
-                    'event_espresso'
-                );
-                // add specific message for developers if WP_DEBUG in on
-                $error_msg .= '||' . $e->getMessage();
-                EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-                $error = true;
-            }
-        } else {
-            $processor->generate_for_all_active_messengers($type, $vars, $send);
-            // let's find out if there were any errors and how many successfully were queued.
-            $count_errors = $processor->get_queue()->count_STS_in_queue(
-                array(EEM_Message::status_failed, EEM_Message::status_debug_only)
-            );
-            $count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete);
-            $count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry);
-            $count_errors = $count_errors + $count_retry;
-            if ($count_errors > 0) {
-                $error = true;
-                if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) {
-                    $message = sprintf(
-                        __(
-                            'There were %d errors and %d messages successfully queued for generation and sending',
-                            'event_espresso'
-                        ),
-                        $count_errors,
-                        $count_queued
-                    );
-                } elseif ($count_errors > 1 && $count_queued === 1) {
-                    $message = sprintf(
-                        __(
-                            'There were %d errors and %d message successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_errors,
-                        $count_queued
-                    );
-                } elseif ($count_errors === 1 && $count_queued > 1) {
-                    $message = sprintf(
-                        __(
-                            'There was %d error and %d messages successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_errors,
-                        $count_queued
-                    );
-                } else {
-                    $message = sprintf(
-                        __(
-                            'There was %d message that failed to be queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_errors
-                    );
-                }
-                EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__);
-            } else {
-                if ($count_queued === 1) {
-                    $message = sprintf(
-                        __(
-                            '%d message successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_queued
-                    );
-                } else {
-                    $message = sprintf(
-                        __(
-                            '%d messages were successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_queued
-                    );
-                }
-                EE_Error::add_success($message);
-            }
-        }
-        // if no error then return the generated message(s).
-        if (! $error && ! $send) {
-            $generated_queue = $processor->generate_queue(false);
-            // get message and return.
-            $generated_queue->get_message_repository()->rewind();
-            $messages = array();
-            while ($generated_queue->get_message_repository()->valid()) {
-                $message = $generated_queue->get_message_repository()->current();
-                if ($message instanceof EE_Message) {
-                    // set properties that might be expected by add-ons (backward compat)
-                    $message->content = $message->content();
-                    $message->template_pack = $message->get_template_pack();
-                    $message->template_variation = $message->get_template_pack_variation();
-                    $messages[] = $message;
-                }
-                $generated_queue->get_message_repository()->next();
-            }
-            return $messages;
-        }
-        return $error ? false
-            : true; // yeah backwards eh?  Really what we're returning is if there is a total success for all the messages or not.  We'll modify this once we get message recording in place.
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param  string $type      This should correspond with a valid message type
-     * @param  string $context   This should correspond with a valid context for the message type
-     * @param  string $messenger This should correspond with a valid messenger.
-     * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
-     *                           preview
-     * @return string          The body of the message.
-     */
-    public function preview_message($type, $context, $messenger, $send = false)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return EED_Messages::preview_message($type, $context, $messenger, $send);
-    }
-
-
-    /**
-     * @since      4.5.0
-     * @deprecated 4.9.0   Moved to EED_Messages Module
-     * @param string   $messenger    a string matching a valid active messenger in the system
-     * @param string   $message_type Although it seems contrary to the name of the method, a message type name is still
-     *                               required to send along the message type to the messenger because this is used for
-     *                               determining what specific variations might be loaded for the generated message.
-     * @param stdClass $message      a stdClass object in the format expected by the messenger.
-     *
-     * @return bool          success or fail.
-     */
-    public function send_message_with_messenger_only($messenger, $message_type, $message)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        // setup for sending to new method.
-        /** @type EE_Messages_Queue $queue */
-        $queue = EE_Registry::instance()->load_lib('Messages_Queue');
-        // make sure we have a proper message object
-        if (! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
-            $msg = EE_Message_Factory::create(
-                array(
-                    'MSG_messenger'    => $messenger,
-                    'MSG_message_type' => $message_type,
-                    'MSG_content'      => $message->content,
-                    'MSG_subject'      => $message->subject,
-                )
-            );
-        } else {
-            $msg = $message;
-        }
-        if (! $msg instanceof EE_Message) {
-            return false;
-        }
-        // make sure any content in a content property (if not empty) is set on the MSG_content.
-        if (! empty($msg->content)) {
-            $msg->set('MSG_content', $msg->content);
-        }
-        $queue->add($msg);
-        return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param         $messenger
-     * @param  string $message_type message type that the templates are being created for
-     * @param int     $GRP_ID
-     * @param bool    $is_global
-     * @return array|object if creation is successful then we return an array of info, otherwise an error_object is
-     *                      returned.
-     * @throws \EE_Error
-     */
-    public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param  string $messenger_name    name of EE_messenger
-     * @param  string $message_type_name name of EE_message_type
-     * @return array
-     */
-    public function get_fields($messenger_name, $message_type_name)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::get_fields($messenger_name, $message_type_name);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @access     public
-     * @param string $type                we can indicate just returning installed message types
-     *                                    or messengers (or both) via this parameter.
-     * @param bool   $skip_cache          if true then we skip the cache and retrieve via files.
-     * @return array                    multidimensional array of messenger and message_type objects
-     *                                    (messengers index, and message_type index);
-     */
-    public function get_installed($type = 'all', $skip_cache = false)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        if ($skip_cache) {
-            $this->_message_resource_manager->reset_active_messengers_and_message_types();
-        }
-        switch ($type) {
-            case 'messengers' :
-                return array(
-                    'messenger' => $this->_message_resource_manager->installed_messengers(),
-                );
-                break;
-            case 'message_types' :
-                return array(
-                    'message_type' => $this->_message_resource_manager->installed_message_types(),
-                );
-                break;
-            case 'all' :
-            default :
-                return array(
-                    'messenger'    => $this->_message_resource_manager->installed_messengers(),
-                    'message_type' => $this->_message_resource_manager->installed_message_types(),
-                );
-                break;
-        }
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return \EE_messenger[]
-     */
-    public function get_active_messengers()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->active_messengers();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return array array of message_type references (string)
-     */
-    public function get_active_message_types()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->list_of_active_message_types();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return EE_message_type[]
-     */
-    public function get_active_message_type_objects()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_message_type_objects();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @since      4.5.0
-     * @param string $messenger The messenger being checked
-     * @return EE_message_type[]    (or empty array if none present)
-     */
-    public function get_active_message_types_per_messenger($messenger)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger    The string should correspond to the messenger (message types are
-     * @param string $message_type The string should correspond to a message type.
-     * @return EE_message_type|null
-     */
-    public function get_active_message_type($messenger, $message_type)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return array|\EE_message_type[]
-     */
-    public function get_installed_message_types()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->installed_message_types();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return array
-     */
-    public function get_installed_messengers()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->installed_messengers();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param   bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by
-     *                           message type.
-     * @return array
-     */
-    public function get_all_contexts($slugs_only = true)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_all_contexts($slugs_only);
-    }
+	/** @type EE_messenger[] */
+	protected $_active_messengers = array();
+
+	/** @type array */
+	protected $_active_message_types = array();
+
+	/** @type EE_message_type[] */
+	protected $_installed_message_types = array();
+
+	/** @type EE_messenger */
+	protected $_messenger;
+
+	/** @type EE_message_type */
+	protected $_message_type;
+
+	/** @type array */
+	protected $_contexts = array();
+
+	/** @type EE_Message_Resource_Manager $_message_resource_manager */
+	protected $_message_resource_manager;
+
+
+	/**
+	 * EE_messages constructor.
+	 *
+	 * @deprecated 4.9.0
+	 */
+	public function __construct()
+	{
+	}
+
+
+	/**
+	 * @param string $method
+	 */
+	public function _class_is_deprecated($method)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_messages::' . $method,
+			__('EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.'),
+			'4.9.0',
+			'4.10.0.p'
+		);
+		// Please use EE_Message_Resource_Manager instead
+		$this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger_name
+	 * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive
+	 */
+	public function ensure_messenger_is_active($messenger_name)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $message_type message type name
+	 * @param        $messenger
+	 * @return bool true if it got activated (or was active) and false if not.
+	 * @throws \EE_Error
+	 */
+	public function ensure_message_type_is_active($message_type, $messenger)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger_name
+	 * @param array  $mts_to_activate             (optional) An array of message types to activate with this messenger.
+	 *                                             If included we do NOT setup the default message types (assuming they
+	 *                                             are already setup.)
+	 * @return boolean an array of generated templates or false if nothing generated/activated.
+	 */
+	public function activate_messenger($messenger_name, $mts_to_activate = array())
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param EE_messenger    $messenger    messenger used in trigger
+	 * @param EE_message_type $message_type message type used in trigger
+	 *
+	 * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
+	 */
+	public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger
+	 * @return EE_messenger | null
+	 */
+	public function get_messenger_if_active($messenger)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_messenger($messenger);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param EE_Message $message
+	 * @return array  An array with 'messenger' and 'message_type' as the index and the corresponding valid object if
+	 *                  available.
+	 *                  Eg. Valid Messenger and Message Type:
+	 *                  array(
+	 *                  'messenger' => new EE_Email_messenger(),
+	 *                  'message_type' => new EE_Registration_Approved_message_type()
+	 *                  )
+	 *                  Valid Messenger and Invalid Message Type:
+	 *                  array(
+	 *                  'messenger' => new EE_Email_messenger(),
+	 *                  'message_type' => null
+	 *                  )
+	 */
+	public function validate_for_use(EE_Message $message)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return array(
+			'messenger'    => $message->messenger_object(),
+			'message_type' => $message->message_type_object(),
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param  string $type                 What type of message are we sending (corresponds to message types)
+	 * @param  mixed  $vars                 Data being sent for parsing in the message
+	 * @param  string $sending_messenger    if included then we ONLY use the specified messenger for delivery.
+	 *                                      Otherwise we cycle through all active messengers.
+	 * @param string  $generating_messenger if included then this messenger is used for generating the message
+	 *                                      templates (but not for sending).
+	 * @param string  $context              If included then only a message type for a specific context will be
+	 *                                      generated.
+	 * @param bool    $send                 Default TRUE.  If false, then this will just return the generated
+	 *                                      EE_messages objects which might be used by the trigger to setup a batch
+	 *                                      message (typically html messenger uses it).
+	 * @return bool
+	 */
+	public function send_message(
+		$type,
+		$vars,
+		$sending_messenger = '',
+		$generating_messenger = '',
+		$context = '',
+		$send = true
+	) {
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		/** @type EE_Messages_Processor $processor */
+		$processor = EE_Registry::instance()->load_lib('Messages_Processor');
+		$error = false;
+		// try to intelligently determine what method we'll call based on the incoming data.
+		// if generating and sending are different then generate and send immediately.
+		if (! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
+			// in the legacy system, when generating and sending were different, that means all the
+			// vars are already in the request object.  So let's just use that.
+			try {
+				/** @type EE_Message_To_Generate_From_Request $mtg */
+				$mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
+				$processor->generate_and_send_now($mtg);
+			} catch (EE_Error $e) {
+				$error_msg = __(
+					'Please note that a system message failed to send due to a technical issue.',
+					'event_espresso'
+				);
+				// add specific message for developers if WP_DEBUG in on
+				$error_msg .= '||' . $e->getMessage();
+				EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+				$error = true;
+			}
+		} else {
+			$processor->generate_for_all_active_messengers($type, $vars, $send);
+			// let's find out if there were any errors and how many successfully were queued.
+			$count_errors = $processor->get_queue()->count_STS_in_queue(
+				array(EEM_Message::status_failed, EEM_Message::status_debug_only)
+			);
+			$count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete);
+			$count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry);
+			$count_errors = $count_errors + $count_retry;
+			if ($count_errors > 0) {
+				$error = true;
+				if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) {
+					$message = sprintf(
+						__(
+							'There were %d errors and %d messages successfully queued for generation and sending',
+							'event_espresso'
+						),
+						$count_errors,
+						$count_queued
+					);
+				} elseif ($count_errors > 1 && $count_queued === 1) {
+					$message = sprintf(
+						__(
+							'There were %d errors and %d message successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_errors,
+						$count_queued
+					);
+				} elseif ($count_errors === 1 && $count_queued > 1) {
+					$message = sprintf(
+						__(
+							'There was %d error and %d messages successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_errors,
+						$count_queued
+					);
+				} else {
+					$message = sprintf(
+						__(
+							'There was %d message that failed to be queued for generation.',
+							'event_espresso'
+						),
+						$count_errors
+					);
+				}
+				EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__);
+			} else {
+				if ($count_queued === 1) {
+					$message = sprintf(
+						__(
+							'%d message successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_queued
+					);
+				} else {
+					$message = sprintf(
+						__(
+							'%d messages were successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_queued
+					);
+				}
+				EE_Error::add_success($message);
+			}
+		}
+		// if no error then return the generated message(s).
+		if (! $error && ! $send) {
+			$generated_queue = $processor->generate_queue(false);
+			// get message and return.
+			$generated_queue->get_message_repository()->rewind();
+			$messages = array();
+			while ($generated_queue->get_message_repository()->valid()) {
+				$message = $generated_queue->get_message_repository()->current();
+				if ($message instanceof EE_Message) {
+					// set properties that might be expected by add-ons (backward compat)
+					$message->content = $message->content();
+					$message->template_pack = $message->get_template_pack();
+					$message->template_variation = $message->get_template_pack_variation();
+					$messages[] = $message;
+				}
+				$generated_queue->get_message_repository()->next();
+			}
+			return $messages;
+		}
+		return $error ? false
+			: true; // yeah backwards eh?  Really what we're returning is if there is a total success for all the messages or not.  We'll modify this once we get message recording in place.
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param  string $type      This should correspond with a valid message type
+	 * @param  string $context   This should correspond with a valid context for the message type
+	 * @param  string $messenger This should correspond with a valid messenger.
+	 * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
+	 *                           preview
+	 * @return string          The body of the message.
+	 */
+	public function preview_message($type, $context, $messenger, $send = false)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return EED_Messages::preview_message($type, $context, $messenger, $send);
+	}
+
+
+	/**
+	 * @since      4.5.0
+	 * @deprecated 4.9.0   Moved to EED_Messages Module
+	 * @param string   $messenger    a string matching a valid active messenger in the system
+	 * @param string   $message_type Although it seems contrary to the name of the method, a message type name is still
+	 *                               required to send along the message type to the messenger because this is used for
+	 *                               determining what specific variations might be loaded for the generated message.
+	 * @param stdClass $message      a stdClass object in the format expected by the messenger.
+	 *
+	 * @return bool          success or fail.
+	 */
+	public function send_message_with_messenger_only($messenger, $message_type, $message)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		// setup for sending to new method.
+		/** @type EE_Messages_Queue $queue */
+		$queue = EE_Registry::instance()->load_lib('Messages_Queue');
+		// make sure we have a proper message object
+		if (! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
+			$msg = EE_Message_Factory::create(
+				array(
+					'MSG_messenger'    => $messenger,
+					'MSG_message_type' => $message_type,
+					'MSG_content'      => $message->content,
+					'MSG_subject'      => $message->subject,
+				)
+			);
+		} else {
+			$msg = $message;
+		}
+		if (! $msg instanceof EE_Message) {
+			return false;
+		}
+		// make sure any content in a content property (if not empty) is set on the MSG_content.
+		if (! empty($msg->content)) {
+			$msg->set('MSG_content', $msg->content);
+		}
+		$queue->add($msg);
+		return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param         $messenger
+	 * @param  string $message_type message type that the templates are being created for
+	 * @param int     $GRP_ID
+	 * @param bool    $is_global
+	 * @return array|object if creation is successful then we return an array of info, otherwise an error_object is
+	 *                      returned.
+	 * @throws \EE_Error
+	 */
+	public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param  string $messenger_name    name of EE_messenger
+	 * @param  string $message_type_name name of EE_message_type
+	 * @return array
+	 */
+	public function get_fields($messenger_name, $message_type_name)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_fields($messenger_name, $message_type_name);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @access     public
+	 * @param string $type                we can indicate just returning installed message types
+	 *                                    or messengers (or both) via this parameter.
+	 * @param bool   $skip_cache          if true then we skip the cache and retrieve via files.
+	 * @return array                    multidimensional array of messenger and message_type objects
+	 *                                    (messengers index, and message_type index);
+	 */
+	public function get_installed($type = 'all', $skip_cache = false)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		if ($skip_cache) {
+			$this->_message_resource_manager->reset_active_messengers_and_message_types();
+		}
+		switch ($type) {
+			case 'messengers' :
+				return array(
+					'messenger' => $this->_message_resource_manager->installed_messengers(),
+				);
+				break;
+			case 'message_types' :
+				return array(
+					'message_type' => $this->_message_resource_manager->installed_message_types(),
+				);
+				break;
+			case 'all' :
+			default :
+				return array(
+					'messenger'    => $this->_message_resource_manager->installed_messengers(),
+					'message_type' => $this->_message_resource_manager->installed_message_types(),
+				);
+				break;
+		}
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return \EE_messenger[]
+	 */
+	public function get_active_messengers()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->active_messengers();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return array array of message_type references (string)
+	 */
+	public function get_active_message_types()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->list_of_active_message_types();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return EE_message_type[]
+	 */
+	public function get_active_message_type_objects()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_type_objects();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @since      4.5.0
+	 * @param string $messenger The messenger being checked
+	 * @return EE_message_type[]    (or empty array if none present)
+	 */
+	public function get_active_message_types_per_messenger($messenger)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger    The string should correspond to the messenger (message types are
+	 * @param string $message_type The string should correspond to a message type.
+	 * @return EE_message_type|null
+	 */
+	public function get_active_message_type($messenger, $message_type)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return array|\EE_message_type[]
+	 */
+	public function get_installed_message_types()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->installed_message_types();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return array
+	 */
+	public function get_installed_messengers()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->installed_messengers();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param   bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by
+	 *                           message type.
+	 * @return array
+	 */
+	public function get_all_contexts($slugs_only = true)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_all_contexts($slugs_only);
+	}
 
 
 }
@@ -1131,88 +1131,88 @@ 
 
 
 add_filter(
-    'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-    function ($event_list_iframe_css) {
-        if (! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
-            return $event_list_iframe_css;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'FHEE__EventsArchiveIframe__event_list_iframe__css',
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-            '\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
-            '4.9.14',
-            '5.0.0',
-            'filter'
-        );
-        return apply_filters(
-            'FHEE__EventsArchiveIframe__event_list_iframe__css',
-            $event_list_iframe_css
-        );
-    }
+	'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+	function ($event_list_iframe_css) {
+		if (! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
+			return $event_list_iframe_css;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'FHEE__EventsArchiveIframe__event_list_iframe__css',
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+			'\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
+			'4.9.14',
+			'5.0.0',
+			'filter'
+		);
+		return apply_filters(
+			'FHEE__EventsArchiveIframe__event_list_iframe__css',
+			$event_list_iframe_css
+		);
+	}
 );
 add_filter(
-    'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-    function ($event_list_iframe_js) {
-        if (! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
-            return $event_list_iframe_js;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-            '\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
-            '4.9.14',
-            '5.0.0',
-            'filter'
-        );
-        return apply_filters(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            $event_list_iframe_js
-        );
-    }
+	'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+	function ($event_list_iframe_js) {
+		if (! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
+			return $event_list_iframe_js;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+			'\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
+			'4.9.14',
+			'5.0.0',
+			'filter'
+		);
+		return apply_filters(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			$event_list_iframe_js
+		);
+	}
 );
 add_action(
-    'AHEE__EE_Capabilities__addCaps__complete',
-    function ($capabilities_map) {
-        if (! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) {
-            return;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'AHEE__EE_Capabilities__init_role_caps__complete',
-            'AHEE__EE_Capabilities__addCaps__complete',
-            '\EE_Capabilities::addCaps()',
-            '4.9.42',
-            '5.0.0'
-        );
-        do_action(
-            'AHEE__EE_Capabilities__init_role_caps__complete',
-            $capabilities_map
-        );
-    }
+	'AHEE__EE_Capabilities__addCaps__complete',
+	function ($capabilities_map) {
+		if (! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) {
+			return;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'AHEE__EE_Capabilities__init_role_caps__complete',
+			'AHEE__EE_Capabilities__addCaps__complete',
+			'\EE_Capabilities::addCaps()',
+			'4.9.42',
+			'5.0.0'
+		);
+		do_action(
+			'AHEE__EE_Capabilities__init_role_caps__complete',
+			$capabilities_map
+		);
+	}
 );
 
 add_filter(
-    'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
-    function ($existing_attendee, $registration, $attendee_data) {
-        if (! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) {
-            return $existing_attendee;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
-            'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
-            '\EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler::findExistingAttendee()',
-            '4.9.34',
-            '5.0.0',
-            'filter'
-        );
-        return apply_filters(
-            'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
-            $existing_attendee,
-            $registration,
-            $attendee_data
-        );
-    },
-    10,
-    3
+	'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
+	function ($existing_attendee, $registration, $attendee_data) {
+		if (! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) {
+			return $existing_attendee;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
+			'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
+			'\EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler::findExistingAttendee()',
+			'4.9.34',
+			'5.0.0',
+			'filter'
+		);
+		return apply_filters(
+			'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
+			$existing_attendee,
+			$registration,
+			$attendee_data
+		);
+	},
+	10,
+	3
 );
 
 /**
@@ -1223,88 +1223,88 @@ 
 class EE_Event_List_Query extends WP_Query
 {
 
-    private $title;
-
-    private $css_class;
-
-    private $category_slug;
-
-    /**
-     * EE_Event_List_Query constructor.
-     *
-     * @param array $args
-     */
-    public function __construct($args = array())
-    {
-        \EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.',
-                'event_espresso'
-            ),
-            '4.9.27',
-            '5.0.0'
-        );
-        $this->title = isset($args['title']) ? $args['title'] : '';
-        $this->css_class = isset($args['css_class']) ? $args['css_class'] : '';
-        $this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : '';
-        $limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10;
-        // the current "page" we are viewing
-        $paged = max(1, get_query_var('paged'));
-        // Force these args
-        $args = array_merge(
-            $args,
-            array(
-                'post_type'              => 'espresso_events',
-                'posts_per_page'         => $limit,
-                'update_post_term_cache' => false,
-                'update_post_meta_cache' => false,
-                'paged'                  => $paged,
-                'offset'                 => ($paged - 1) * $limit,
-            )
-        );
-        // run the query
-        parent::__construct($args);
-    }
-
-
-    /**
-     * event_list_title
-     *
-     * @param string $event_list_title
-     * @return string
-     */
-    public function event_list_title($event_list_title = '')
-    {
-        if (! empty($this->title)) {
-            return $this->title;
-        }
-        return $event_list_title;
-    }
-
-
-    /**
-     * event_list_css
-     *
-     * @param string $event_list_css
-     * @return string
-     */
-    public function event_list_css($event_list_css = '')
-    {
-        $event_list_css .= ! empty($event_list_css)
-            ? ' '
-            : '';
-        $event_list_css .= ! empty($this->css_class)
-            ? $this->css_class
-            : '';
-        $event_list_css .= ! empty($event_list_css)
-            ? ' '
-            : '';
-        $event_list_css .= ! empty($this->category_slug)
-            ? $this->category_slug
-            : '';
-        return $event_list_css;
-    }
+	private $title;
+
+	private $css_class;
+
+	private $category_slug;
+
+	/**
+	 * EE_Event_List_Query constructor.
+	 *
+	 * @param array $args
+	 */
+	public function __construct($args = array())
+	{
+		\EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.',
+				'event_espresso'
+			),
+			'4.9.27',
+			'5.0.0'
+		);
+		$this->title = isset($args['title']) ? $args['title'] : '';
+		$this->css_class = isset($args['css_class']) ? $args['css_class'] : '';
+		$this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : '';
+		$limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10;
+		// the current "page" we are viewing
+		$paged = max(1, get_query_var('paged'));
+		// Force these args
+		$args = array_merge(
+			$args,
+			array(
+				'post_type'              => 'espresso_events',
+				'posts_per_page'         => $limit,
+				'update_post_term_cache' => false,
+				'update_post_meta_cache' => false,
+				'paged'                  => $paged,
+				'offset'                 => ($paged - 1) * $limit,
+			)
+		);
+		// run the query
+		parent::__construct($args);
+	}
+
+
+	/**
+	 * event_list_title
+	 *
+	 * @param string $event_list_title
+	 * @return string
+	 */
+	public function event_list_title($event_list_title = '')
+	{
+		if (! empty($this->title)) {
+			return $this->title;
+		}
+		return $event_list_title;
+	}
+
+
+	/**
+	 * event_list_css
+	 *
+	 * @param string $event_list_css
+	 * @return string
+	 */
+	public function event_list_css($event_list_css = '')
+	{
+		$event_list_css .= ! empty($event_list_css)
+			? ' '
+			: '';
+		$event_list_css .= ! empty($this->css_class)
+			? $this->css_class
+			: '';
+		$event_list_css .= ! empty($event_list_css)
+			? ' '
+			: '';
+		$event_list_css .= ! empty($this->category_slug)
+			? $this->category_slug
+			: '';
+		return $event_list_css;
+	}
 
 }
 
@@ -1321,75 +1321,75 @@ 
 {
 
 
-    /**
-     *    class constructor
-     *
-     * @deprecated 4.9.59.p
-     */
-    public function __construct()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __CLASS__,
-                'EventEspresso\core\services\licensing\LicenseServices'
-            ),
-            '4.9.59.p'
-        );
-    }
-
-
-    /**
-     * The purpose of this function is to display information about Event Espresso data collection
-     * and a optin selection for extra data collecting by users.
-     *
-     * @param bool $extra
-     * @return string html.
-     * @deprecated 4.9.59.p
-     */
-    public static function espresso_data_collection_optin_text($extra = true)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __METHOD__,
-                'EventEspresso\core\domain\services\Stats::optinText'
-            ),
-            '4.9.59.p'
-        );
-        Stats::optinText($extra);
-    }
-
-    /**
-     * This is a handy helper method for retrieving whether there is an update available for the given plugin.
-     *
-     * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
-     *                          identify plugins. Defaults to core update
-     * @return boolean           True if update available, false if not.
-     * @deprecated 4.9.59.p
-     */
-    public static function is_update_available($basename = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __METHOD__,
-                'EventEspresso\core\services\licensing\LicenseService::isUpdateAvailable'
-            ),
-            '4.9.59.p'
-        );
-        return LicenseService::isUpdateAvailable($basename);
-    }
+	/**
+	 *    class constructor
+	 *
+	 * @deprecated 4.9.59.p
+	 */
+	public function __construct()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__CLASS__,
+				'EventEspresso\core\services\licensing\LicenseServices'
+			),
+			'4.9.59.p'
+		);
+	}
+
+
+	/**
+	 * The purpose of this function is to display information about Event Espresso data collection
+	 * and a optin selection for extra data collecting by users.
+	 *
+	 * @param bool $extra
+	 * @return string html.
+	 * @deprecated 4.9.59.p
+	 */
+	public static function espresso_data_collection_optin_text($extra = true)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__METHOD__,
+				'EventEspresso\core\domain\services\Stats::optinText'
+			),
+			'4.9.59.p'
+		);
+		Stats::optinText($extra);
+	}
+
+	/**
+	 * This is a handy helper method for retrieving whether there is an update available for the given plugin.
+	 *
+	 * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
+	 *                          identify plugins. Defaults to core update
+	 * @return boolean           True if update available, false if not.
+	 * @deprecated 4.9.59.p
+	 */
+	public static function is_update_available($basename = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__METHOD__,
+				'EventEspresso\core\services\licensing\LicenseService::isUpdateAvailable'
+			),
+			'4.9.59.p'
+		);
+		return LicenseService::isUpdateAvailable($basename);
+	}
 }
 
 add_filter(
-    'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
-    'ee_deprecated_registrations_report_csv_legacy_fields',
-    10,
-    2
+	'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
+	'ee_deprecated_registrations_report_csv_legacy_fields',
+	10,
+	2
 );
 /**
  * Filters the CSV row to make it appear like the old labels (which were "$pretty_name[$field_name]").
@@ -1406,96 +1406,96 @@ 
  */
 function ee_deprecated_registrations_report_csv_legacy_fields($csv_row_data, $reg_row)
 {
-    // no need for all this if nobody is using the deprecated filter
-    if (has_filter('FHEE__EE_Export__report_registrations__reg_csv_array')) {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            sprintf(
-                // EE_Error::doing_it_wrong with escape HTML, so don't escape it twice by doing it here too.
-                _x(
-                    'The filter "%1$s" has been deprecated. Please use "%2$s" instead.',
-                    'The filter "FHEE__EE_Export__report_registrations__reg_csv_array" has been deprecated. Please use "FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array" instead.',
-                    'event_espresso'
-                ),
-                'FHEE__EE_Export__report_registrations__reg_csv_array',
-                'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array'
-            ),
-            '4.9.69.p',
-            '4.9.75.p'
-        );
-        // there's code that expected the old csv column headers/labels. Let's oblige. Put it back in the old format!
-        // first: what model fields might be used as column headers? (whose format we need to change)
-        $model_fields = array_merge(
-            EEM_Registration::instance()->field_settings(),
-            EEM_Attendee::instance()->field_settings()
-        );
-        // create an array that uses the legacy column headers/labels.
-        $new_csv_row = array();
-        foreach ($csv_row_data as $label => $value) {
-            $new_label = $label;
-            foreach ($model_fields as $field) {
-                if ($label === EEH_Export::get_column_name_for_field($field)) {
-                    // re-add the old field name
-                    $new_label = $label . '[' . $field->get_name() . ']';
-                    break;
-                }
-            }
-            $new_csv_row[$new_label] = $value;
-        }
-        // before we run it through the deprecated filter, set the method `EEH_Export::get_column_name_for_field()`
-        // to create the old column names, because that's what's in the row temporarily
-        add_filter(
-            'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
-            '__return_true',
-            777
-        );
-        // now, those old filters can be run on this data. Have fun!
-        /**
-         * Deprecated. Use FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array instead.
-         *
-         * Filter to change the contents of each row of the registrations report CSV file.
-         * This can be used to add or remote columns from the CSV file, or change their values.                 *
-         * Note: it has this name because originally that's where this filter resided,
-         * and we've left its name as-is for backward compatibility.
-         * Note when using: all rows in the CSV should have the same columns.
-         *
-         * @param array $reg_csv_array keys are column-header names, and values are that columns' value
-         *                             in this row
-         * @param array $reg_row is the row from the database's wp_esp_registration table
-         */
-        $updated_row = apply_filters(
-            'FHEE__EE_Export__report_registrations__reg_csv_array',
-            $new_csv_row,
-            $reg_row
-        );
-
-        // ok now we can revert to normal for EEH_Export::get_column_name_for_field().
-        remove_filter(
-            'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
-            '__return_true',
-            777
-        );
-
-        // great. Now that the old filters are done, we can remove the ugly square brackets from column headers/labels.
-        $updated_and_restored_row = array();
-        foreach ($updated_row as $label => $value) {
-            $matches = array();
-            if (preg_match(
-                    '~([^\[]*)\[(.*)\]~',
-                    $label,
-                    $matches
-                )
-                && isset(
-                    $matches[0],
-                    $matches[1],
-                    $matches[2]
-                )
-            ) {
-                $label = $matches[1];
-            }
-            $updated_and_restored_row[$label] = $value;
-        }
-        $csv_row_data = $updated_and_restored_row;
-    }
-    return $csv_row_data;
+	// no need for all this if nobody is using the deprecated filter
+	if (has_filter('FHEE__EE_Export__report_registrations__reg_csv_array')) {
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			sprintf(
+				// EE_Error::doing_it_wrong with escape HTML, so don't escape it twice by doing it here too.
+				_x(
+					'The filter "%1$s" has been deprecated. Please use "%2$s" instead.',
+					'The filter "FHEE__EE_Export__report_registrations__reg_csv_array" has been deprecated. Please use "FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array" instead.',
+					'event_espresso'
+				),
+				'FHEE__EE_Export__report_registrations__reg_csv_array',
+				'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array'
+			),
+			'4.9.69.p',
+			'4.9.75.p'
+		);
+		// there's code that expected the old csv column headers/labels. Let's oblige. Put it back in the old format!
+		// first: what model fields might be used as column headers? (whose format we need to change)
+		$model_fields = array_merge(
+			EEM_Registration::instance()->field_settings(),
+			EEM_Attendee::instance()->field_settings()
+		);
+		// create an array that uses the legacy column headers/labels.
+		$new_csv_row = array();
+		foreach ($csv_row_data as $label => $value) {
+			$new_label = $label;
+			foreach ($model_fields as $field) {
+				if ($label === EEH_Export::get_column_name_for_field($field)) {
+					// re-add the old field name
+					$new_label = $label . '[' . $field->get_name() . ']';
+					break;
+				}
+			}
+			$new_csv_row[$new_label] = $value;
+		}
+		// before we run it through the deprecated filter, set the method `EEH_Export::get_column_name_for_field()`
+		// to create the old column names, because that's what's in the row temporarily
+		add_filter(
+			'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
+			'__return_true',
+			777
+		);
+		// now, those old filters can be run on this data. Have fun!
+		/**
+		 * Deprecated. Use FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array instead.
+		 *
+		 * Filter to change the contents of each row of the registrations report CSV file.
+		 * This can be used to add or remote columns from the CSV file, or change their values.                 *
+		 * Note: it has this name because originally that's where this filter resided,
+		 * and we've left its name as-is for backward compatibility.
+		 * Note when using: all rows in the CSV should have the same columns.
+		 *
+		 * @param array $reg_csv_array keys are column-header names, and values are that columns' value
+		 *                             in this row
+		 * @param array $reg_row is the row from the database's wp_esp_registration table
+		 */
+		$updated_row = apply_filters(
+			'FHEE__EE_Export__report_registrations__reg_csv_array',
+			$new_csv_row,
+			$reg_row
+		);
+
+		// ok now we can revert to normal for EEH_Export::get_column_name_for_field().
+		remove_filter(
+			'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
+			'__return_true',
+			777
+		);
+
+		// great. Now that the old filters are done, we can remove the ugly square brackets from column headers/labels.
+		$updated_and_restored_row = array();
+		foreach ($updated_row as $label => $value) {
+			$matches = array();
+			if (preg_match(
+					'~([^\[]*)\[(.*)\]~',
+					$label,
+					$matches
+				)
+				&& isset(
+					$matches[0],
+					$matches[1],
+					$matches[2]
+				)
+			) {
+				$label = $matches[1];
+			}
+			$updated_and_restored_row[$label] = $value;
+		}
+		$csv_row_data = $updated_and_restored_row;
+	}
+	return $csv_row_data;
 }
\ No newline at end of file

core/EE_Object_Collection.core.php

Doc Comments +1 added lines

@@ -84,6 +84,7 @@
      *
      * @access public
      * @param mixed
+     * @param string $info
      * @return null | object
      */
     public function get_by_info($info)

Indentation +156 added lines, -156 removed lines

@@ -16,160 +16,160 @@
 abstract class EE_Object_Collection extends SplObjectStorage implements EEI_Collection
 {
 
-    /**
-     * an interface (or class) name to be used for restricting the type of objects added to the storage
-     * this should be set from within the child class constructor
-     *
-     * @type string $interface
-     */
-    protected $interface;
-
-
-    /**
-     * add
-     *
-     * attaches an object to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     * by calling EE_Object_Collection::set_info()
-     *
-     * @access public
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function add($object, $info = null)
-    {
-        $class = $this->interface;
-        if (! $object instanceof $class) {
-            return false;
-        }
-        $this->attach($object);
-        $this->set_info($object, $info);
-        return $this->contains($object);
-    }
-
-
-    /**
-     * set_info
-     *
-     * Sets the data associated with an object in the Collection
-     * if no $info is supplied, then the spl_object_hash() is used
-     *
-     * @access public
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function set_info($object, $info = null)
-    {
-        $info = ! empty($info) ? $info : spl_object_hash($object);
-        $this->rewind();
-        while ($this->valid()) {
-            if ($object == $this->current()) {
-                $this->setInfo($info);
-                $this->rewind();
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * get_by_info
-     *
-     * finds and returns an object in the Collection based on the info that was set using addObject()
-     * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
-     *
-     * @access public
-     * @param mixed
-     * @return null | object
-     */
-    public function get_by_info($info)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($info === $this->getInfo()) {
-                $object = $this->current();
-                $this->rewind();
-                return $object;
-            }
-            $this->next();
-        }
-        return null;
-    }
-
-
-    /**
-     * has
-     *
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
-     *
-     * @access public
-     * @param object $object
-     * @return bool
-     */
-    public function has($object)
-    {
-        return $this->contains($object);
-    }
-
-
-    /**
-     * remove
-     *
-     * detaches an object from the Collection
-     *
-     * @access public
-     * @param $object
-     * @return bool
-     */
-    public function remove($object)
-    {
-        $this->detach($object);
-        return true;
-    }
-
-
-    /**
-     * set_current
-     *
-     * advances pointer to the provided object
-     *
-     * @access public
-     * @param $object
-     * @return void
-     */
-    public function set_current($object)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current() === $object) {
-                break;
-            }
-            $this->next();
-        }
-    }
-
-
-    /**
-     * set_current_by_info
-     *
-     * advances pointer to the object whose info matches that which was provided
-     *
-     * @access public
-     * @param $info
-     * @return void
-     */
-    public function set_current_by_info($info)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($info === $this->getInfo()) {
-                break;
-            }
-            $this->next();
-        }
-    }
+	/**
+	 * an interface (or class) name to be used for restricting the type of objects added to the storage
+	 * this should be set from within the child class constructor
+	 *
+	 * @type string $interface
+	 */
+	protected $interface;
+
+
+	/**
+	 * add
+	 *
+	 * attaches an object to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 * by calling EE_Object_Collection::set_info()
+	 *
+	 * @access public
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function add($object, $info = null)
+	{
+		$class = $this->interface;
+		if (! $object instanceof $class) {
+			return false;
+		}
+		$this->attach($object);
+		$this->set_info($object, $info);
+		return $this->contains($object);
+	}
+
+
+	/**
+	 * set_info
+	 *
+	 * Sets the data associated with an object in the Collection
+	 * if no $info is supplied, then the spl_object_hash() is used
+	 *
+	 * @access public
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function set_info($object, $info = null)
+	{
+		$info = ! empty($info) ? $info : spl_object_hash($object);
+		$this->rewind();
+		while ($this->valid()) {
+			if ($object == $this->current()) {
+				$this->setInfo($info);
+				$this->rewind();
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * get_by_info
+	 *
+	 * finds and returns an object in the Collection based on the info that was set using addObject()
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
+	 *
+	 * @access public
+	 * @param mixed
+	 * @return null | object
+	 */
+	public function get_by_info($info)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($info === $this->getInfo()) {
+				$object = $this->current();
+				$this->rewind();
+				return $object;
+			}
+			$this->next();
+		}
+		return null;
+	}
+
+
+	/**
+	 * has
+	 *
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
+	 *
+	 * @access public
+	 * @param object $object
+	 * @return bool
+	 */
+	public function has($object)
+	{
+		return $this->contains($object);
+	}
+
+
+	/**
+	 * remove
+	 *
+	 * detaches an object from the Collection
+	 *
+	 * @access public
+	 * @param $object
+	 * @return bool
+	 */
+	public function remove($object)
+	{
+		$this->detach($object);
+		return true;
+	}
+
+
+	/**
+	 * set_current
+	 *
+	 * advances pointer to the provided object
+	 *
+	 * @access public
+	 * @param $object
+	 * @return void
+	 */
+	public function set_current($object)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current() === $object) {
+				break;
+			}
+			$this->next();
+		}
+	}
+
+
+	/**
+	 * set_current_by_info
+	 *
+	 * advances pointer to the object whose info matches that which was provided
+	 *
+	 * @access public
+	 * @param $info
+	 * @return void
+	 */
+	public function set_current_by_info($info)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($info === $this->getInfo()) {
+				break;
+			}
+			$this->next();
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
     public function add($object, $info = null)
     {
         $class = $this->interface;
-        if (! $object instanceof $class) {
+        if ( ! $object instanceof $class) {
             return false;
         }
         $this->attach($object);

core/helpers/EEH_Event_View.helper.php

Doc Comments +4 added lines, -4 removed lines

@@ -22,7 +22,7 @@ 
      * get_event
      * attempts to retrieve an EE_Event object any way it can
      *
-     * @param int|WP_Post $EVT_ID
+     * @param integer $EVT_ID
      * @return EE_Event|null
      * @throws \EE_Error
      */
@@ -115,7 +115,7 @@ 
      *
      *  @access     public
      * @param    int $EVT_ID
-     *  @return     string
+     *  @return     boolean
      */
     public static function event_has_content_or_excerpt($EVT_ID = 0)
     {
@@ -136,7 +136,7 @@ 
      *    event_active_status
      *
      * @access    public
-     * @param null $num_words
+     * @param integer $num_words
      * @param null $more
      * @return    string
      */
@@ -478,7 +478,7 @@ 
      *
      * @access    public
      * @param int $EVT_ID
-     * @param null $include_expired
+     * @param false|null $include_expired
      * @param bool $include_deleted
      * @param null $limit
      * @return EE_Datetime[]

Indentation +569 added lines, -569 removed lines

@@ -11,578 +11,578 @@
 class EEH_Event_View extends EEH_Base
 {
 
-    /**
-     * @var EE_Event $_event
-     */
-    private static $_event = null;
-
-
-
-    /**
-     * get_event
-     * attempts to retrieve an EE_Event object any way it can
-     *
-     * @param int|WP_Post $EVT_ID
-     * @return EE_Event|null
-     * @throws \EE_Error
-     */
-    public static function get_event($EVT_ID = 0)
-    {
-        // international newspaper?
-        global $post;
-        $EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
-            ? $EVT_ID->ID
-            : absint($EVT_ID);
-        // do we already have the Event  you are looking for?
-        if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
-            return EEH_Event_View::$_event;
-        }
-        // reset property so that the new event is cached.
-        EEH_Event_View::$_event = null;
-        if (! $EVT_ID && $post instanceof EE_Event) {
-            EEH_Event_View::$_event = $post;
-            return EEH_Event_View::$_event;
-        }
-        // if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
-        // then let's just use that cached event on the $post object.
-        if ($post instanceof WP_Post
-            && $post->post_type === 'espresso_events'
-            && isset($post->EE_Event)
-            && (
-                $EVT_ID === 0
-                || $EVT_ID === $post->ID
-            )
-        ) {
-            EEH_Event_View::$_event = $post->EE_Event;
-            return EEH_Event_View::$_event;
-        }
-        // If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
-        if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
-            EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        }
-        return EEH_Event_View::$_event;
-    }
-
-
-
-    /**
-     *    display_ticket_selector
-     *
-     * @access    public
-     * @param    int $EVT_ID
-     * @return    boolean
-     */
-    public static function display_ticket_selector($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        return $event instanceof EE_Event ? $event->display_ticket_selector() : false;
-    }
-
-
-
-    /**
-     *    event_status
-     *
-     * @access    public
-     * @param    int $EVT_ID
-     * @return    string
-     */
-    public static function event_status($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        return $event instanceof EE_Event ? $event->pretty_active_status(false) : '';
-    }
-
-
-
-    /**
-     *  event_active_status
-     *
-     *  @access     public
-     * @param    int $EVT_ID
-     *  @return     string
-     */
-    public static function event_active_status($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        return $event instanceof EE_Event ? $event->pretty_active_status() : 'inactive';
-    }
-
-
-
-    /**
-     *  event_has_content_or_excerpt
-     *
-     *  @access     public
-     * @param    int $EVT_ID
-     *  @return     string
-     */
-    public static function event_has_content_or_excerpt($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        $has_content_or_excerpt = false;
-        if ($event instanceof EE_Event) {
-            $has_content_or_excerpt = $event->description() != '' || $event->short_description(null, null, true) != '' ? true : false;
-        }
-        if (is_archive() && ! ( espresso_display_full_description_in_event_list() || espresso_display_excerpt_in_event_list() )) {
-            $has_content_or_excerpt = false;
-        }
-        return $has_content_or_excerpt;
-    }
-
-
-
-    /**
-     *    event_active_status
-     *
-     * @access    public
-     * @param null $num_words
-     * @param null $more
-     * @return    string
-     */
-    public static function event_content_or_excerpt($num_words = null, $more = null)
-    {
-        global $post;
-        ob_start();
-        if (( is_single() ) || ( is_archive() && espresso_display_full_description_in_event_list() )) {
-            // admin has chosen "full description"
-            // for the "Event Espresso - Events > Templates > Display Description" option
-            the_content();
-        } elseif (( is_archive() && espresso_display_excerpt_in_event_list() )) {
-            if (has_excerpt($post->ID)) {
-                // admin has chosen "excerpt (short desc)"
-                // for the "Event Espresso - Events > Templates > Display Description" option
-                // AND an excerpt actually exists
-                the_excerpt();
-            } else {
-                // admin has chosen "excerpt (short desc)"
-                // for the "Event Espresso - Events > Templates > Display Description" option
-                // but NO excerpt actually exists, so we need to create one
-                if (! empty($num_words)) {
-                    if (empty($more)) {
-                        $more_link_text = __('(more…)', 'event_espresso');
-                        $more = ' <a href="' . get_permalink() . '"';
-                        $more .= ' class="more-link"';
-                        $more .= \EED_Events_Archive::link_target();
-                        $more .= '>' . $more_link_text . '</a>';
-                        $more = apply_filters('the_content_more_link', $more, $more_link_text);
-                    }
-                    $content = str_replace('NOMORELINK', '', get_the_content('NOMORELINK'));
-
-                    $content =  wp_trim_words($content, $num_words, ' ') . $more;
-                } else {
-                    $content =  get_the_content();
-                }
-                global $allowedtags;
-                // make sure links are allowed
-                $allowedtags['a'] = isset($allowedtags['a'])
-                    ? $allowedtags['a']
-                    : array();
-                // as well as target attribute
-                $allowedtags['a']['target'] = isset($allowedtags['a']['target'])
-                    ? $allowedtags['a']['target']
-                    : false;
-                // but get previous value so we can reset it
-                $prev_value = $allowedtags['a']['target'];
-                $allowedtags['a']['target'] = true;
-                $content = wp_kses($content, $allowedtags);
-                $content = strip_shortcodes($content);
-                echo apply_filters('the_content', $content);
-                $allowedtags['a']['target'] = $prev_value;
-            }
-        } else {
-            // admin has chosen "none"
-            // for the "Event Espresso - Events > Templates > Display Description" option
-            echo apply_filters('the_content', '');
-        }
-        return ob_get_clean();
-    }
-
-
-
-    /**
-     *  event_tickets_available
-     *
-     *  @access     public
-     * @param    int $EVT_ID
-     *  @return     EE_Ticket[]
-     */
-    public static function event_tickets_available($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        $tickets_available_for_purchase = array();
-        if ($event instanceof EE_Event) {
-            $datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, false);
-            foreach ($datetimes as $datetime) {
-                $tickets_available_for_purchase = array_merge($tickets_available_for_purchase, $datetime->ticket_types_available_for_purchase());
-            }
-        }
-        return $tickets_available_for_purchase;
-    }
-
-
-
-    /**
-     *    the_event_date
-     *
-     * @access    public
-     * @param    int $EVT_ID
-     * @param     bool   $hide_uncategorized
-     * @return    string
-     */
-    public static function event_categories($EVT_ID = 0, $hide_uncategorized = true)
-    {
-        $category_links = array();
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $event_categories = get_the_terms($event->ID(), 'espresso_event_categories');
-            if ($event_categories) {
-                // loop thru terms and create links
-                foreach ($event_categories as $term) {
-                    $url = get_term_link($term, 'espresso_venue_categories');
-                    if (! is_wp_error($url) && (( $hide_uncategorized && strtolower($term->name) != __('uncategorized', 'event_espresso')) || ! $hide_uncategorized )) {
-                        $category_links[] = '<a href="' . esc_url($url)
-                                            . '" rel="tag"'
-                                            . \EED_Events_Archive::link_target()
-                                            .'>'
-                                            . $term->name
-                                            . '</a>';
-                    }
-                }
-            }
-        }
-        return implode(', ', $category_links);
-    }
-
-
-
-    /**
-     *    the_event_date - first date by date order
-     *
-     * @access    public
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @param int    $EVT_ID
-     * @return    string
-     */
-    public static function the_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) :  '';
-    }
-
-
-
-    /**
-     *    the_event_end_date - last date by date order
-     *
-     * @access    public
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @param int    $EVT_ID
-     * @return    string
-     */
-    public static function the_event_end_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
-    }
-
-
-
-    /**
-     *    the_earliest_event_date - first date chronologically
-     *
-     * @access    public
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @param int    $EVT_ID
-     * @return    string
-     */
-    public static function the_earliest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
-    }
-
-
-
-    /**
-     *    the_latest_event_date - latest date chronologically
-     *
-     * @access    public
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @param int    $EVT_ID
-     * @return    string
-     */
-    public static function the_latest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
-    }
-
-
-
-    /**
-     *    event_date_as_calendar_page
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    public static function event_date_as_calendar_page($EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
-        if ($datetime instanceof EE_Datetime) {
-    ?>
+	/**
+	 * @var EE_Event $_event
+	 */
+	private static $_event = null;
+
+
+
+	/**
+	 * get_event
+	 * attempts to retrieve an EE_Event object any way it can
+	 *
+	 * @param int|WP_Post $EVT_ID
+	 * @return EE_Event|null
+	 * @throws \EE_Error
+	 */
+	public static function get_event($EVT_ID = 0)
+	{
+		// international newspaper?
+		global $post;
+		$EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
+			? $EVT_ID->ID
+			: absint($EVT_ID);
+		// do we already have the Event  you are looking for?
+		if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
+			return EEH_Event_View::$_event;
+		}
+		// reset property so that the new event is cached.
+		EEH_Event_View::$_event = null;
+		if (! $EVT_ID && $post instanceof EE_Event) {
+			EEH_Event_View::$_event = $post;
+			return EEH_Event_View::$_event;
+		}
+		// if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
+		// then let's just use that cached event on the $post object.
+		if ($post instanceof WP_Post
+			&& $post->post_type === 'espresso_events'
+			&& isset($post->EE_Event)
+			&& (
+				$EVT_ID === 0
+				|| $EVT_ID === $post->ID
+			)
+		) {
+			EEH_Event_View::$_event = $post->EE_Event;
+			return EEH_Event_View::$_event;
+		}
+		// If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
+		if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
+			EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		}
+		return EEH_Event_View::$_event;
+	}
+
+
+
+	/**
+	 *    display_ticket_selector
+	 *
+	 * @access    public
+	 * @param    int $EVT_ID
+	 * @return    boolean
+	 */
+	public static function display_ticket_selector($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		return $event instanceof EE_Event ? $event->display_ticket_selector() : false;
+	}
+
+
+
+	/**
+	 *    event_status
+	 *
+	 * @access    public
+	 * @param    int $EVT_ID
+	 * @return    string
+	 */
+	public static function event_status($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		return $event instanceof EE_Event ? $event->pretty_active_status(false) : '';
+	}
+
+
+
+	/**
+	 *  event_active_status
+	 *
+	 *  @access     public
+	 * @param    int $EVT_ID
+	 *  @return     string
+	 */
+	public static function event_active_status($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		return $event instanceof EE_Event ? $event->pretty_active_status() : 'inactive';
+	}
+
+
+
+	/**
+	 *  event_has_content_or_excerpt
+	 *
+	 *  @access     public
+	 * @param    int $EVT_ID
+	 *  @return     string
+	 */
+	public static function event_has_content_or_excerpt($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		$has_content_or_excerpt = false;
+		if ($event instanceof EE_Event) {
+			$has_content_or_excerpt = $event->description() != '' || $event->short_description(null, null, true) != '' ? true : false;
+		}
+		if (is_archive() && ! ( espresso_display_full_description_in_event_list() || espresso_display_excerpt_in_event_list() )) {
+			$has_content_or_excerpt = false;
+		}
+		return $has_content_or_excerpt;
+	}
+
+
+
+	/**
+	 *    event_active_status
+	 *
+	 * @access    public
+	 * @param null $num_words
+	 * @param null $more
+	 * @return    string
+	 */
+	public static function event_content_or_excerpt($num_words = null, $more = null)
+	{
+		global $post;
+		ob_start();
+		if (( is_single() ) || ( is_archive() && espresso_display_full_description_in_event_list() )) {
+			// admin has chosen "full description"
+			// for the "Event Espresso - Events > Templates > Display Description" option
+			the_content();
+		} elseif (( is_archive() && espresso_display_excerpt_in_event_list() )) {
+			if (has_excerpt($post->ID)) {
+				// admin has chosen "excerpt (short desc)"
+				// for the "Event Espresso - Events > Templates > Display Description" option
+				// AND an excerpt actually exists
+				the_excerpt();
+			} else {
+				// admin has chosen "excerpt (short desc)"
+				// for the "Event Espresso - Events > Templates > Display Description" option
+				// but NO excerpt actually exists, so we need to create one
+				if (! empty($num_words)) {
+					if (empty($more)) {
+						$more_link_text = __('(more&hellip;)', 'event_espresso');
+						$more = ' <a href="' . get_permalink() . '"';
+						$more .= ' class="more-link"';
+						$more .= \EED_Events_Archive::link_target();
+						$more .= '>' . $more_link_text . '</a>';
+						$more = apply_filters('the_content_more_link', $more, $more_link_text);
+					}
+					$content = str_replace('NOMORELINK', '', get_the_content('NOMORELINK'));
+
+					$content =  wp_trim_words($content, $num_words, ' ') . $more;
+				} else {
+					$content =  get_the_content();
+				}
+				global $allowedtags;
+				// make sure links are allowed
+				$allowedtags['a'] = isset($allowedtags['a'])
+					? $allowedtags['a']
+					: array();
+				// as well as target attribute
+				$allowedtags['a']['target'] = isset($allowedtags['a']['target'])
+					? $allowedtags['a']['target']
+					: false;
+				// but get previous value so we can reset it
+				$prev_value = $allowedtags['a']['target'];
+				$allowedtags['a']['target'] = true;
+				$content = wp_kses($content, $allowedtags);
+				$content = strip_shortcodes($content);
+				echo apply_filters('the_content', $content);
+				$allowedtags['a']['target'] = $prev_value;
+			}
+		} else {
+			// admin has chosen "none"
+			// for the "Event Espresso - Events > Templates > Display Description" option
+			echo apply_filters('the_content', '');
+		}
+		return ob_get_clean();
+	}
+
+
+
+	/**
+	 *  event_tickets_available
+	 *
+	 *  @access     public
+	 * @param    int $EVT_ID
+	 *  @return     EE_Ticket[]
+	 */
+	public static function event_tickets_available($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		$tickets_available_for_purchase = array();
+		if ($event instanceof EE_Event) {
+			$datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, false);
+			foreach ($datetimes as $datetime) {
+				$tickets_available_for_purchase = array_merge($tickets_available_for_purchase, $datetime->ticket_types_available_for_purchase());
+			}
+		}
+		return $tickets_available_for_purchase;
+	}
+
+
+
+	/**
+	 *    the_event_date
+	 *
+	 * @access    public
+	 * @param    int $EVT_ID
+	 * @param     bool   $hide_uncategorized
+	 * @return    string
+	 */
+	public static function event_categories($EVT_ID = 0, $hide_uncategorized = true)
+	{
+		$category_links = array();
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$event_categories = get_the_terms($event->ID(), 'espresso_event_categories');
+			if ($event_categories) {
+				// loop thru terms and create links
+				foreach ($event_categories as $term) {
+					$url = get_term_link($term, 'espresso_venue_categories');
+					if (! is_wp_error($url) && (( $hide_uncategorized && strtolower($term->name) != __('uncategorized', 'event_espresso')) || ! $hide_uncategorized )) {
+						$category_links[] = '<a href="' . esc_url($url)
+											. '" rel="tag"'
+											. \EED_Events_Archive::link_target()
+											.'>'
+											. $term->name
+											. '</a>';
+					}
+				}
+			}
+		}
+		return implode(', ', $category_links);
+	}
+
+
+
+	/**
+	 *    the_event_date - first date by date order
+	 *
+	 * @access    public
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @param int    $EVT_ID
+	 * @return    string
+	 */
+	public static function the_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) :  '';
+	}
+
+
+
+	/**
+	 *    the_event_end_date - last date by date order
+	 *
+	 * @access    public
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @param int    $EVT_ID
+	 * @return    string
+	 */
+	public static function the_event_end_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
+	}
+
+
+
+	/**
+	 *    the_earliest_event_date - first date chronologically
+	 *
+	 * @access    public
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @param int    $EVT_ID
+	 * @return    string
+	 */
+	public static function the_earliest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
+		return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
+	}
+
+
+
+	/**
+	 *    the_latest_event_date - latest date chronologically
+	 *
+	 * @access    public
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @param int    $EVT_ID
+	 * @return    string
+	 */
+	public static function the_latest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
+		return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
+	}
+
+
+
+	/**
+	 *    event_date_as_calendar_page
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	public static function event_date_as_calendar_page($EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
+		if ($datetime instanceof EE_Datetime) {
+	?>
         <div class="event-date-calendar-page-dv">
             <div class="event-date-calendar-page-month-dv"><?php echo $datetime->get_i18n_datetime('DTT_EVT_start', 'M');?></div>
             <div class="event-date-calendar-page-day-dv"><?php echo $datetime->start_date('d');?></div>
         </div>
     <?php
-        }
-    }
-
-
-
-    /**
-     *    get_primary_date_obj - orders date by DTT_order
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    public static function get_primary_date_obj($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $datetimes = $event->get_many_related(
-                'Datetime',
-                array(
-                    'limit' => 1,
-                    'order_by' => array( 'DTT_order' => 'ASC' )
-                )
-            );
-            return reset($datetimes);
-        } else {
-             return false;
-        }
-    }
-
-
-
-    /**
-     *    get_last_date_obj - orders date by DTT_order
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    public static function get_last_date_obj($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $datetimes = $event->get_many_related(
-                'Datetime',
-                array(
-                    'limit' => 1,
-                    'order_by' => array( 'DTT_order' => 'DESC' )
-                )
-            );
-            return end($datetimes);
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     *    get_earliest_date_obj - orders date chronologically
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    public static function get_earliest_date_obj($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $datetimes = $event->get_many_related(
-                'Datetime',
-                array(
-                    'limit' => 1,
-                    'order_by' => array( 'DTT_EVT_start' => 'ASC' )
-                )
-            );
-            return reset($datetimes);
-        } else {
-             return false;
-        }
-    }
-
-
-
-    /**
-     *    get_latest_date_obj - orders date chronologically
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    public static function get_latest_date_obj($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $datetimes = $event->get_many_related(
-                'Datetime',
-                array(
-                    'limit' => 1,
-                    'order_by' => array( 'DTT_EVT_start' => 'DESC' )
-                )
-            );
-            return end($datetimes);
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     *    get_next_upcoming_date_obj - return the next upcoming datetime
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    EE_Datetime|null
-     */
-    public static function get_next_upcoming_date_obj($EVT_ID = 0)
-    {
-        $datetime = EEM_Datetime::instance()->get_one(
-            array(
-                array(
-                    'Event.EVT_ID' => $EVT_ID,
-                    'DTT_EVT_start' => array('>=', current_time('mysql', true))
-                ),
-                'order_by' => array('DTT_EVT_start' => 'asc')
-            )
-        );
-        return $datetime instanceof EE_Datetime ? $datetime : null;
-    }
-
-    /**
-     *    get_all_date_obj
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @param null $include_expired
-     * @param bool $include_deleted
-     * @param null $limit
-     * @return EE_Datetime[]
-     */
-    public static function get_all_date_obj($EVT_ID = 0, $include_expired = null, $include_deleted = false, $limit = null)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($include_expired === null) {
-            if ($event instanceof EE_Event && $event->is_expired()) {
-                $include_expired = true;
-            } else {
-                $include_expired = false;
-            }
-        }
-
-        if ($event instanceof EE_Event) {
-            return $event->datetimes_ordered($include_expired, $include_deleted, $limit);
-        } else {
-             return array();
-        }
-    }
-
-
-
-    /**
-     *    event_link_url
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    public static function event_link_url($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $url = $event->external_url() !== null && $event->external_url() !== '' ? $event->external_url() : get_permalink($event->ID());
-            return preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'http://' . $url;
-        }
-        return null;
-    }
-
-
-
-    /**
-     *    event_phone
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    public static function event_phone($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            return EEH_Schema::telephone($event->phone());
-        }
-        return null;
-    }
-
-
-
-    /**
-     *    edit_event_link
-     *
-     * @access    public
-     * @param int    $EVT_ID
-     * @param string $link
-     * @param string $before
-     * @param string $after
-     * @return    string
-     */
-    public static function edit_event_link($EVT_ID = 0, $link = '', $before = '', $after = '')
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            // can the user edit this post ?
-            if (current_user_can('edit_post', $event->ID())) {
-                // set link text
-                $link_text = ! empty($link) ? $link : __('edit this event', 'event_espresso');
-                // generate nonce
-                $nonce = wp_create_nonce('edit_nonce');
-                // generate url to event editor for this event
-                $url = add_query_arg(array( 'page' => 'espresso_events', 'action' => 'edit', 'post' => $event->ID(), 'edit_nonce' => $nonce ), admin_url());
-                // get edit CPT text
-                $post_type_obj = get_post_type_object('espresso_events');
-                // build final link html
-                $link = '<a class="post-edit-link" href="' . $url . '" ';
-                $link .= ' title="' . esc_attr($post_type_obj->labels->edit_item) . '"';
-                $link .= \EED_Events_Archive::link_target();
-                $link .='>' . $link_text . '</a>';
-                // put it all together
-                return $before . apply_filters('edit_post_link', $link, $event->ID()) . $after;
-            }
-        }
-        return '';
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public static function event_archive_url()
-    {
-        return get_post_type_archive_link('espresso_events');
-    }
+		}
+	}
+
+
+
+	/**
+	 *    get_primary_date_obj - orders date by DTT_order
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	public static function get_primary_date_obj($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$datetimes = $event->get_many_related(
+				'Datetime',
+				array(
+					'limit' => 1,
+					'order_by' => array( 'DTT_order' => 'ASC' )
+				)
+			);
+			return reset($datetimes);
+		} else {
+			 return false;
+		}
+	}
+
+
+
+	/**
+	 *    get_last_date_obj - orders date by DTT_order
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	public static function get_last_date_obj($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$datetimes = $event->get_many_related(
+				'Datetime',
+				array(
+					'limit' => 1,
+					'order_by' => array( 'DTT_order' => 'DESC' )
+				)
+			);
+			return end($datetimes);
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 *    get_earliest_date_obj - orders date chronologically
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	public static function get_earliest_date_obj($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$datetimes = $event->get_many_related(
+				'Datetime',
+				array(
+					'limit' => 1,
+					'order_by' => array( 'DTT_EVT_start' => 'ASC' )
+				)
+			);
+			return reset($datetimes);
+		} else {
+			 return false;
+		}
+	}
+
+
+
+	/**
+	 *    get_latest_date_obj - orders date chronologically
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	public static function get_latest_date_obj($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$datetimes = $event->get_many_related(
+				'Datetime',
+				array(
+					'limit' => 1,
+					'order_by' => array( 'DTT_EVT_start' => 'DESC' )
+				)
+			);
+			return end($datetimes);
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 *    get_next_upcoming_date_obj - return the next upcoming datetime
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    EE_Datetime|null
+	 */
+	public static function get_next_upcoming_date_obj($EVT_ID = 0)
+	{
+		$datetime = EEM_Datetime::instance()->get_one(
+			array(
+				array(
+					'Event.EVT_ID' => $EVT_ID,
+					'DTT_EVT_start' => array('>=', current_time('mysql', true))
+				),
+				'order_by' => array('DTT_EVT_start' => 'asc')
+			)
+		);
+		return $datetime instanceof EE_Datetime ? $datetime : null;
+	}
+
+	/**
+	 *    get_all_date_obj
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @param null $include_expired
+	 * @param bool $include_deleted
+	 * @param null $limit
+	 * @return EE_Datetime[]
+	 */
+	public static function get_all_date_obj($EVT_ID = 0, $include_expired = null, $include_deleted = false, $limit = null)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($include_expired === null) {
+			if ($event instanceof EE_Event && $event->is_expired()) {
+				$include_expired = true;
+			} else {
+				$include_expired = false;
+			}
+		}
+
+		if ($event instanceof EE_Event) {
+			return $event->datetimes_ordered($include_expired, $include_deleted, $limit);
+		} else {
+			 return array();
+		}
+	}
+
+
+
+	/**
+	 *    event_link_url
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	public static function event_link_url($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$url = $event->external_url() !== null && $event->external_url() !== '' ? $event->external_url() : get_permalink($event->ID());
+			return preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'http://' . $url;
+		}
+		return null;
+	}
+
+
+
+	/**
+	 *    event_phone
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	public static function event_phone($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			return EEH_Schema::telephone($event->phone());
+		}
+		return null;
+	}
+
+
+
+	/**
+	 *    edit_event_link
+	 *
+	 * @access    public
+	 * @param int    $EVT_ID
+	 * @param string $link
+	 * @param string $before
+	 * @param string $after
+	 * @return    string
+	 */
+	public static function edit_event_link($EVT_ID = 0, $link = '', $before = '', $after = '')
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			// can the user edit this post ?
+			if (current_user_can('edit_post', $event->ID())) {
+				// set link text
+				$link_text = ! empty($link) ? $link : __('edit this event', 'event_espresso');
+				// generate nonce
+				$nonce = wp_create_nonce('edit_nonce');
+				// generate url to event editor for this event
+				$url = add_query_arg(array( 'page' => 'espresso_events', 'action' => 'edit', 'post' => $event->ID(), 'edit_nonce' => $nonce ), admin_url());
+				// get edit CPT text
+				$post_type_obj = get_post_type_object('espresso_events');
+				// build final link html
+				$link = '<a class="post-edit-link" href="' . $url . '" ';
+				$link .= ' title="' . esc_attr($post_type_obj->labels->edit_item) . '"';
+				$link .= \EED_Events_Archive::link_target();
+				$link .='>' . $link_text . '</a>';
+				// put it all together
+				return $before . apply_filters('edit_post_link', $link, $event->ID()) . $after;
+			}
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public static function event_archive_url()
+	{
+		return get_post_type_archive_link('espresso_events');
+	}
 }

Spacing +31 added lines, -31 removed lines

@@ -39,7 +39,7 @@ 
         }
         // reset property so that the new event is cached.
         EEH_Event_View::$_event = null;
-        if (! $EVT_ID && $post instanceof EE_Event) {
+        if ( ! $EVT_ID && $post instanceof EE_Event) {
             EEH_Event_View::$_event = $post;
             return EEH_Event_View::$_event;
         }
@@ -57,7 +57,7 @@ 
             return EEH_Event_View::$_event;
         }
         // If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
-        if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
+        if ( ! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
             EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
         }
         return EEH_Event_View::$_event;
@@ -124,7 +124,7 @@ 
         if ($event instanceof EE_Event) {
             $has_content_or_excerpt = $event->description() != '' || $event->short_description(null, null, true) != '' ? true : false;
         }
-        if (is_archive() && ! ( espresso_display_full_description_in_event_list() || espresso_display_excerpt_in_event_list() )) {
+        if (is_archive() && ! (espresso_display_full_description_in_event_list() || espresso_display_excerpt_in_event_list())) {
             $has_content_or_excerpt = false;
         }
         return $has_content_or_excerpt;
@@ -144,11 +144,11 @@ 
     {
         global $post;
         ob_start();
-        if (( is_single() ) || ( is_archive() && espresso_display_full_description_in_event_list() )) {
+        if ((is_single()) || (is_archive() && espresso_display_full_description_in_event_list())) {
             // admin has chosen "full description"
             // for the "Event Espresso - Events > Templates > Display Description" option
             the_content();
-        } elseif (( is_archive() && espresso_display_excerpt_in_event_list() )) {
+        } elseif ((is_archive() && espresso_display_excerpt_in_event_list())) {
             if (has_excerpt($post->ID)) {
                 // admin has chosen "excerpt (short desc)"
                 // for the "Event Espresso - Events > Templates > Display Description" option
@@ -158,20 +158,20 @@ 
                 // admin has chosen "excerpt (short desc)"
                 // for the "Event Espresso - Events > Templates > Display Description" option
                 // but NO excerpt actually exists, so we need to create one
-                if (! empty($num_words)) {
+                if ( ! empty($num_words)) {
                     if (empty($more)) {
                         $more_link_text = __('(more…)', 'event_espresso');
-                        $more = ' <a href="' . get_permalink() . '"';
+                        $more = ' <a href="'.get_permalink().'"';
                         $more .= ' class="more-link"';
                         $more .= \EED_Events_Archive::link_target();
-                        $more .= '>' . $more_link_text . '</a>';
+                        $more .= '>'.$more_link_text.'</a>';
                         $more = apply_filters('the_content_more_link', $more, $more_link_text);
                     }
                     $content = str_replace('NOMORELINK', '', get_the_content('NOMORELINK'));
 
-                    $content =  wp_trim_words($content, $num_words, ' ') . $more;
+                    $content = wp_trim_words($content, $num_words, ' ').$more;
                 } else {
-                    $content =  get_the_content();
+                    $content = get_the_content();
                 }
                 global $allowedtags;
                 // make sure links are allowed
@@ -240,8 +240,8 @@ 
                 // loop thru terms and create links
                 foreach ($event_categories as $term) {
                     $url = get_term_link($term, 'espresso_venue_categories');
-                    if (! is_wp_error($url) && (( $hide_uncategorized && strtolower($term->name) != __('uncategorized', 'event_espresso')) || ! $hide_uncategorized )) {
-                        $category_links[] = '<a href="' . esc_url($url)
+                    if ( ! is_wp_error($url) && (($hide_uncategorized && strtolower($term->name) != __('uncategorized', 'event_espresso')) || ! $hide_uncategorized)) {
+                        $category_links[] = '<a href="'.esc_url($url)
                                             . '" rel="tag"'
                                             . \EED_Events_Archive::link_target()
                                             .'>'
@@ -268,8 +268,8 @@ 
     public static function the_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
     {
         $datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) :  '';
+        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
     }
 
 
@@ -286,7 +286,7 @@ 
     public static function the_event_end_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
     {
         $datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
+        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
         return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
     }
 
@@ -304,8 +304,8 @@ 
     public static function the_earliest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
     {
         $datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
+        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
     }
 
 
@@ -322,8 +322,8 @@ 
     public static function the_latest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
     {
         $datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
+        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
     }
 
 
@@ -341,8 +341,8 @@ 
         if ($datetime instanceof EE_Datetime) {
     ?>
         <div class="event-date-calendar-page-dv">
-            <div class="event-date-calendar-page-month-dv"><?php echo $datetime->get_i18n_datetime('DTT_EVT_start', 'M');?></div>
-            <div class="event-date-calendar-page-day-dv"><?php echo $datetime->start_date('d');?></div>
+            <div class="event-date-calendar-page-month-dv"><?php echo $datetime->get_i18n_datetime('DTT_EVT_start', 'M'); ?></div>
+            <div class="event-date-calendar-page-day-dv"><?php echo $datetime->start_date('d'); ?></div>
         </div>
     <?php
         }
@@ -365,7 +365,7 @@ 
                 'Datetime',
                 array(
                     'limit' => 1,
-                    'order_by' => array( 'DTT_order' => 'ASC' )
+                    'order_by' => array('DTT_order' => 'ASC')
                 )
             );
             return reset($datetimes);
@@ -391,7 +391,7 @@ 
                 'Datetime',
                 array(
                     'limit' => 1,
-                    'order_by' => array( 'DTT_order' => 'DESC' )
+                    'order_by' => array('DTT_order' => 'DESC')
                 )
             );
             return end($datetimes);
@@ -417,7 +417,7 @@ 
                 'Datetime',
                 array(
                     'limit' => 1,
-                    'order_by' => array( 'DTT_EVT_start' => 'ASC' )
+                    'order_by' => array('DTT_EVT_start' => 'ASC')
                 )
             );
             return reset($datetimes);
@@ -443,7 +443,7 @@ 
                 'Datetime',
                 array(
                     'limit' => 1,
-                    'order_by' => array( 'DTT_EVT_start' => 'DESC' )
+                    'order_by' => array('DTT_EVT_start' => 'DESC')
                 )
             );
             return end($datetimes);
@@ -515,7 +515,7 @@ 
         $event = EEH_Event_View::get_event($EVT_ID);
         if ($event instanceof EE_Event) {
             $url = $event->external_url() !== null && $event->external_url() !== '' ? $event->external_url() : get_permalink($event->ID());
-            return preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'http://' . $url;
+            return preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'http://'.$url;
         }
         return null;
     }
@@ -561,16 +561,16 @@ 
                 // generate nonce
                 $nonce = wp_create_nonce('edit_nonce');
                 // generate url to event editor for this event
-                $url = add_query_arg(array( 'page' => 'espresso_events', 'action' => 'edit', 'post' => $event->ID(), 'edit_nonce' => $nonce ), admin_url());
+                $url = add_query_arg(array('page' => 'espresso_events', 'action' => 'edit', 'post' => $event->ID(), 'edit_nonce' => $nonce), admin_url());
                 // get edit CPT text
                 $post_type_obj = get_post_type_object('espresso_events');
                 // build final link html
-                $link = '<a class="post-edit-link" href="' . $url . '" ';
-                $link .= ' title="' . esc_attr($post_type_obj->labels->edit_item) . '"';
+                $link = '<a class="post-edit-link" href="'.$url.'" ';
+                $link .= ' title="'.esc_attr($post_type_obj->labels->edit_item).'"';
                 $link .= \EED_Events_Archive::link_target();
-                $link .='>' . $link_text . '</a>';
+                $link .= '>'.$link_text.'</a>';
                 // put it all together
-                return $before . apply_filters('edit_post_link', $link, $event->ID()) . $after;
+                return $before.apply_filters('edit_post_link', $link, $event->ID()).$after;
             }
         }
         return '';

core/helpers/EEH_File.helper.php

Doc Comments -2 removed lines

@@ -673,8 +673,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

Indentation +661 added lines, -661 removed lines

@@ -24,665 +24,665 @@
 class EEH_File extends EEH_Base implements EEHI_File
 {
 
-    /**
-     * @var string $_credentials_form
-     */
-    private static $_credentials_form;
-
-    protected static $_wp_filesystem_direct;
-
-    /**
-     * @param string|null $filepath the filepath we want to work in. If its in the
-     * wp uploads directory, we'll want to just use the filesystem directly.
-     * If not provided, we have to assume its not in the uploads directory
-     * @throws EE_Error if filesystem credentials are required
-     * @return WP_Filesystem_Base
-     */
-    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');
-                $method = 'direct';
-                $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_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());
-            }
-            return EEH_File::$_wp_filesystem_direct;
-        }
-        global $wp_filesystem;
-        // no filesystem setup ???
-        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
-            /**
-             * more explanations are probably merited. http://codex.wordpress.org/Filesystem_API#Initializing_WP_Filesystem_Base
-             * says WP_Filesystem should be used after 'wp_loaded', but currently EE's activation process
-             * is setup to mostly happen on 'init', and refactoring to have it happen on
-             * 'wp_loaded' is too much work on a BETA milestone.
-             * So this fix is expected to work if the WP files are owned by the server user,
-             * but probably not if the user needs to enter their FTP credentials to modify files
-             * 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')) {
-                $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');
-                }
-                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');
-                }
-                // turn on output buffering so that we can capture the credentials form
-                ob_start();
-                $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 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);
-                        throw new EE_Error(
-                            sprintf(
-                                __('WP Filesystem Error: $1%s', 'event_espresso'),
-                                $wp_filesystem->errors->get_error_message()
-                            )
-                        );
-                    }
-                }
-            }
-        }
-        return $wp_filesystem;
-    }
-
-    /**
-     * 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>';
-        }
-    }
-
-
-
-    /**
-     *    verify_filepath_and_permissions
-     *    checks that a file is readable and has sufficient file permissions set to access
-     *
-     * @access public
-     * @param string $full_file_path - full server path to the folder or file
-     * @param string $file_name      - name of file if checking a file
-     * @param string $file_ext       - file extension (ie: "php") if checking a file
-     * @param string $type_of_file   - general type of file (ie: "module"), this is only used to improve error messages
-     * @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 = '')
-    {
-        // 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';
-            $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'),
-                $file_name,
-                '<br />'
-            );
-            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'),
-                    $full_file_path
-                );
-            }
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                throw new EE_Error($msg . '||' . $msg);
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _permissions_error_for_unreadable_filepath - attempts to determine why permissions are set incorrectly for a file or folder
-     *
-     * @access private
-     * @param string $full_file_path - full server path to the folder or file
-     * @param string $type_of_file - general type of file (ie: "module"), this is only used to improve error messages
-     * @throws EE_Error if filesystem credentials are required
-     * @return string
-     */
-    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);
-        // check file permissions
-        $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';
-            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'),
-                $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'),
-                $full_file_path
-            );
-        }
-    }
-
-
-
-    /**
-     * ensure_folder_exists_and_is_writable
-     * ensures that a folder exists and is writable, will attempt to create folder if it does not exist
-     * Also ensures all the parent folders exist, and if not tries to create them.
-     * Also, if this function creates the folder, adds a .htaccess file and index.html file
-     * @param string $folder
-     * @throws EE_Error if the folder exists and is writeable, but for some reason we
-     * 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)) {
-            return false;
-        }
-        // remove ending DS
-        $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))) {
-            // 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)) {
-                return false;
-            }
-            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);
-                    }
-                    return false;
-                }
-                EEH_File::add_index_file($folder);
-            }
-        } elseif (! EEH_File::verify_is_writable($folder, 'folder')) {
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * verify_is_writable - checks if a file or folder is writable
-     * @param string $full_path      - full server path to file or folder
-     * @param string $file_or_folder - whether checking a file or folder
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    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);
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * ensure_file_exists_and_is_writable
-     * ensures that a file exists and is writable, will attempt to create file if it does not exist.
-     * Also ensures all the parent folders exist, and if not tries to create them.
-     * @param string $full_file_path
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    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)) {
-                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);
-                }
-                return false;
-            }
-        }
-        if (! EEH_File::verify_is_writable($full_file_path, 'file')) {
-            return false;
-        }
-        return true;
-    }
-
-    /**
-     * Gets the parent folder. If provided with file, gets the folder that contains it.
-     * If provided a folder, gets its parent folder.
-     * @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)
-    {
-        // 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/"
-        $ds = strlen($file_or_folder_path) > 1
-            ? strrpos($file_or_folder_path, DS, -2)
-            : strlen($file_or_folder_path);
-        return substr($file_or_folder_path, 0, $ds + 1);
-    }
-
-    // public static function ensure_folder_exists_recursively( $folder ) {
-    //
-    // }
-
-
-
-    /**
-     * get_file_contents
-     * @param string $full_file_path
-     * @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))) {
-            // 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));
-        }
-        return '';
-    }
-
-
-
-    /**
-     * write_file
-     * @param string $full_file_path
-     * @param string $file_contents - the content to be written to the file
-     * @param string $file_type
-     * @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);
-            }
-            return false;
-        }
-        // load WP_Filesystem and set file permissions
-        $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);
-            }
-            return false;
-        }
-        return true;
-    }
-
-    /**
-     * Wrapper for WP_Filesystem_Base::delete
-     *
-     * @param string $filepath
-     * @param boolean $recursive
-     * @param boolean|string $type 'd' for directory, 'f' for file
-     * @throws EE_Error if filesystem credentials are required
-     * @return boolean
-     */
-    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;
-    }
-
-
-
-    /**
-     * exists
-     * checks if a file exists using the WP filesystem
-     * @param string $full_file_path
-     * @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;
-    }
-
-
-
-    /**
-     * is_readable
-     * checks if a file is_readable using the WP filesystem
-     *
-     * @param string $full_file_path
-     * @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))) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * remove_filename_from_filepath
-     * given a full path to a file including the filename itself, this removes  the filename and returns the path, up to, but NOT including the filename OR slash
-     *
-     * @param string $full_file_path
-     * @return string
-     */
-    public static function remove_filename_from_filepath($full_file_path = '')
-    {
-        return pathinfo($full_file_path, PATHINFO_DIRNAME);
-    }
-
-
-    /**
-     * get_filename_from_filepath. Arguably the same as basename()
-     *
-     * @param string $full_file_path
-     * @return string
-     */
-    public static function get_filename_from_filepath($full_file_path = '')
-    {
-        return pathinfo($full_file_path, PATHINFO_BASENAME);
-    }
-
-
-    /**
-     * get_file_extension
-     *
-     * @param string $full_file_path
-     * @return string
-     */
-    public static function get_file_extension($full_file_path = '')
-    {
-        return pathinfo($full_file_path, PATHINFO_EXTENSION);
-    }
-
-
-
-    /**
-     * add_htaccess_deny_from_all so the webserver cannot access this folder
-     * @param string $folder
-     * @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')) {
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-    /**
-     * Adds an index file to this folder, so folks can't list all the file's contents
-     * @param string $folder
-     * @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')) {
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * Given that the file in $file_path has the normal name, (ie, CLASSNAME.whatever.php),
-     * extract that classname.
-     * @param string $file_path
-     * @return string
-     */
-    public static function get_classname_from_filepath_with_standard_filename($file_path)
-    {
-        // extract file from path
-        $filename = basename($file_path);
-        // now remove the first period and everything after
-        $pos_of_first_period = strpos($filename, '.');
-        return substr($filename, 0, $pos_of_first_period);
-    }
-
-
-
-    /**
-     * standardise_directory_separators
-     *  convert all directory separators in a file path to whatever is set for DS
-     * @param string $file_path
-     * @return string
-     */
-    public static function standardise_directory_separators($file_path)
-    {
-        return str_replace(array( '\\', '/' ), DS, $file_path);
-    }
-
-
-
-    /**
-     * end_with_directory_separator
-     *  ensures that file path ends with DS
-     * @param string $file_path
-     * @return string
-     */
-    public static function end_with_directory_separator($file_path)
-    {
-        return rtrim($file_path, '/\\') . DS;
-    }
-
-
-
-    /**
-     * shorthand for both EEH_FIle::end_with_directory_separator AND EEH_File::standardise_directory_separators
-     * @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));
-    }
-
-
-
-    /**
-     * takes the folder name (with or without trailing slash) and finds the files it in,
-     * and what the class's name inside of each should be.
-     * @param array $folder_paths
-     * @param boolean $index_numerically if TRUE, the returned array will be indexed numerically;
-     *      if FALSE (Default), returned array will be indexed by the filenames minus extensions.
-     *      Set it TRUE if you know there are files in the directory with the same name but different extensions
-     * @throws EE_Error if filesystem credentials are required
-     * @return array if $index_numerically == TRUE keys are numeric ,
-     *      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)
-    {
-        $class_to_folder_path = array();
-        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 . '*');
-            $class_to_folder_path = array();
-            if ($files_in_folder) {
-                foreach ($files_in_folder as $file_path) {
-                    // only add files, not folders
-                    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);
-                            $class_to_folder_path[ $classname ] = $file_path;
-                        }
-                    }
-                }
-            }
-        }
-        return $class_to_folder_path;
-    }
-
-
-
-    /**
-     * Copies a file. Mostly a wrapper of WP_Filesystem::copy
-     * @param string $source_file
-     * @param string $destination_file
-     * @param boolean $overwrite
-     * @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);
-            }
-            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);
-            }
-            return false;
-        }
-
-        // load WP_Filesystem and set file permissions
-        $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),
-            $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);
-            }
-            return false;
-        }
-        return true;
-    }
-
-    /**
-     * Reports whether or not the filepath is in the EE uploads folder or not
-     * @param string $filepath
-     * @return boolean
-     */
-    public static function is_in_uploads_folder($filepath)
-    {
-        $uploads = wp_upload_dir();
-        return strpos($filepath, $uploads['basedir']) === 0 ? true : false;
-    }
-
-    /**
-     * Given a "local" filepath (what you probably thought was the only filepath),
-     * 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
-     * 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);
-    }
+	/**
+	 * @var string $_credentials_form
+	 */
+	private static $_credentials_form;
+
+	protected static $_wp_filesystem_direct;
+
+	/**
+	 * @param string|null $filepath the filepath we want to work in. If its in the
+	 * wp uploads directory, we'll want to just use the filesystem directly.
+	 * If not provided, we have to assume its not in the uploads directory
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return WP_Filesystem_Base
+	 */
+	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');
+				$method = 'direct';
+				$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_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());
+			}
+			return EEH_File::$_wp_filesystem_direct;
+		}
+		global $wp_filesystem;
+		// no filesystem setup ???
+		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
+			/**
+			 * more explanations are probably merited. http://codex.wordpress.org/Filesystem_API#Initializing_WP_Filesystem_Base
+			 * says WP_Filesystem should be used after 'wp_loaded', but currently EE's activation process
+			 * is setup to mostly happen on 'init', and refactoring to have it happen on
+			 * 'wp_loaded' is too much work on a BETA milestone.
+			 * So this fix is expected to work if the WP files are owned by the server user,
+			 * but probably not if the user needs to enter their FTP credentials to modify files
+			 * 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')) {
+				$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');
+				}
+				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');
+				}
+				// turn on output buffering so that we can capture the credentials form
+				ob_start();
+				$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 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);
+						throw new EE_Error(
+							sprintf(
+								__('WP Filesystem Error: $1%s', 'event_espresso'),
+								$wp_filesystem->errors->get_error_message()
+							)
+						);
+					}
+				}
+			}
+		}
+		return $wp_filesystem;
+	}
+
+	/**
+	 * 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>';
+		}
+	}
+
+
+
+	/**
+	 *    verify_filepath_and_permissions
+	 *    checks that a file is readable and has sufficient file permissions set to access
+	 *
+	 * @access public
+	 * @param string $full_file_path - full server path to the folder or file
+	 * @param string $file_name      - name of file if checking a file
+	 * @param string $file_ext       - file extension (ie: "php") if checking a file
+	 * @param string $type_of_file   - general type of file (ie: "module"), this is only used to improve error messages
+	 * @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 = '')
+	{
+		// 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';
+			$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'),
+				$file_name,
+				'<br />'
+			);
+			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'),
+					$full_file_path
+				);
+			}
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				throw new EE_Error($msg . '||' . $msg);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _permissions_error_for_unreadable_filepath - attempts to determine why permissions are set incorrectly for a file or folder
+	 *
+	 * @access private
+	 * @param string $full_file_path - full server path to the folder or file
+	 * @param string $type_of_file - general type of file (ie: "module"), this is only used to improve error messages
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return string
+	 */
+	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);
+		// check file permissions
+		$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';
+			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'),
+				$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'),
+				$full_file_path
+			);
+		}
+	}
+
+
+
+	/**
+	 * ensure_folder_exists_and_is_writable
+	 * ensures that a folder exists and is writable, will attempt to create folder if it does not exist
+	 * Also ensures all the parent folders exist, and if not tries to create them.
+	 * Also, if this function creates the folder, adds a .htaccess file and index.html file
+	 * @param string $folder
+	 * @throws EE_Error if the folder exists and is writeable, but for some reason we
+	 * 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)) {
+			return false;
+		}
+		// remove ending DS
+		$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))) {
+			// 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)) {
+				return false;
+			}
+			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);
+					}
+					return false;
+				}
+				EEH_File::add_index_file($folder);
+			}
+		} elseif (! EEH_File::verify_is_writable($folder, 'folder')) {
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * verify_is_writable - checks if a file or folder is writable
+	 * @param string $full_path      - full server path to file or folder
+	 * @param string $file_or_folder - whether checking a file or folder
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	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);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * ensure_file_exists_and_is_writable
+	 * ensures that a file exists and is writable, will attempt to create file if it does not exist.
+	 * Also ensures all the parent folders exist, and if not tries to create them.
+	 * @param string $full_file_path
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	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)) {
+				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);
+				}
+				return false;
+			}
+		}
+		if (! EEH_File::verify_is_writable($full_file_path, 'file')) {
+			return false;
+		}
+		return true;
+	}
+
+	/**
+	 * Gets the parent folder. If provided with file, gets the folder that contains it.
+	 * If provided a folder, gets its parent folder.
+	 * @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)
+	{
+		// 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/"
+		$ds = strlen($file_or_folder_path) > 1
+			? strrpos($file_or_folder_path, DS, -2)
+			: strlen($file_or_folder_path);
+		return substr($file_or_folder_path, 0, $ds + 1);
+	}
+
+	// public static function ensure_folder_exists_recursively( $folder ) {
+	//
+	// }
+
+
+
+	/**
+	 * get_file_contents
+	 * @param string $full_file_path
+	 * @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))) {
+			// 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));
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * write_file
+	 * @param string $full_file_path
+	 * @param string $file_contents - the content to be written to the file
+	 * @param string $file_type
+	 * @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);
+			}
+			return false;
+		}
+		// load WP_Filesystem and set file permissions
+		$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);
+			}
+			return false;
+		}
+		return true;
+	}
+
+	/**
+	 * Wrapper for WP_Filesystem_Base::delete
+	 *
+	 * @param string $filepath
+	 * @param boolean $recursive
+	 * @param boolean|string $type 'd' for directory, 'f' for file
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return boolean
+	 */
+	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;
+	}
+
+
+
+	/**
+	 * exists
+	 * checks if a file exists using the WP filesystem
+	 * @param string $full_file_path
+	 * @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;
+	}
+
+
+
+	/**
+	 * is_readable
+	 * checks if a file is_readable using the WP filesystem
+	 *
+	 * @param string $full_file_path
+	 * @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))) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * remove_filename_from_filepath
+	 * given a full path to a file including the filename itself, this removes  the filename and returns the path, up to, but NOT including the filename OR slash
+	 *
+	 * @param string $full_file_path
+	 * @return string
+	 */
+	public static function remove_filename_from_filepath($full_file_path = '')
+	{
+		return pathinfo($full_file_path, PATHINFO_DIRNAME);
+	}
+
+
+	/**
+	 * get_filename_from_filepath. Arguably the same as basename()
+	 *
+	 * @param string $full_file_path
+	 * @return string
+	 */
+	public static function get_filename_from_filepath($full_file_path = '')
+	{
+		return pathinfo($full_file_path, PATHINFO_BASENAME);
+	}
+
+
+	/**
+	 * get_file_extension
+	 *
+	 * @param string $full_file_path
+	 * @return string
+	 */
+	public static function get_file_extension($full_file_path = '')
+	{
+		return pathinfo($full_file_path, PATHINFO_EXTENSION);
+	}
+
+
+
+	/**
+	 * add_htaccess_deny_from_all so the webserver cannot access this folder
+	 * @param string $folder
+	 * @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')) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+	/**
+	 * Adds an index file to this folder, so folks can't list all the file's contents
+	 * @param string $folder
+	 * @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')) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * Given that the file in $file_path has the normal name, (ie, CLASSNAME.whatever.php),
+	 * extract that classname.
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function get_classname_from_filepath_with_standard_filename($file_path)
+	{
+		// extract file from path
+		$filename = basename($file_path);
+		// now remove the first period and everything after
+		$pos_of_first_period = strpos($filename, '.');
+		return substr($filename, 0, $pos_of_first_period);
+	}
+
+
+
+	/**
+	 * standardise_directory_separators
+	 *  convert all directory separators in a file path to whatever is set for DS
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function standardise_directory_separators($file_path)
+	{
+		return str_replace(array( '\\', '/' ), DS, $file_path);
+	}
+
+
+
+	/**
+	 * end_with_directory_separator
+	 *  ensures that file path ends with DS
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function end_with_directory_separator($file_path)
+	{
+		return rtrim($file_path, '/\\') . DS;
+	}
+
+
+
+	/**
+	 * shorthand for both EEH_FIle::end_with_directory_separator AND EEH_File::standardise_directory_separators
+	 * @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));
+	}
+
+
+
+	/**
+	 * takes the folder name (with or without trailing slash) and finds the files it in,
+	 * and what the class's name inside of each should be.
+	 * @param array $folder_paths
+	 * @param boolean $index_numerically if TRUE, the returned array will be indexed numerically;
+	 *      if FALSE (Default), returned array will be indexed by the filenames minus extensions.
+	 *      Set it TRUE if you know there are files in the directory with the same name but different extensions
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return array if $index_numerically == TRUE keys are numeric ,
+	 *      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)
+	{
+		$class_to_folder_path = array();
+		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 . '*');
+			$class_to_folder_path = array();
+			if ($files_in_folder) {
+				foreach ($files_in_folder as $file_path) {
+					// only add files, not folders
+					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);
+							$class_to_folder_path[ $classname ] = $file_path;
+						}
+					}
+				}
+			}
+		}
+		return $class_to_folder_path;
+	}
+
+
+
+	/**
+	 * Copies a file. Mostly a wrapper of WP_Filesystem::copy
+	 * @param string $source_file
+	 * @param string $destination_file
+	 * @param boolean $overwrite
+	 * @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);
+			}
+			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);
+			}
+			return false;
+		}
+
+		// load WP_Filesystem and set file permissions
+		$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),
+			$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);
+			}
+			return false;
+		}
+		return true;
+	}
+
+	/**
+	 * Reports whether or not the filepath is in the EE uploads folder or not
+	 * @param string $filepath
+	 * @return boolean
+	 */
+	public static function is_in_uploads_folder($filepath)
+	{
+		$uploads = wp_upload_dir();
+		return strpos($filepath, $uploads['basedir']) === 0 ? true : false;
+	}
+
+	/**
+	 * Given a "local" filepath (what you probably thought was the only filepath),
+	 * 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
+	 * 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);
+	}
 }

Spacing +48 added lines, -48 removed lines

@@ -44,17 +44,17 @@ 
             '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');
+        )) {
+            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());
@@ -63,7 +63,7 @@ 
         }
         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
             /**
@@ -79,14 +79,14 @@ 
             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');
+                    $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);
             } 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();
@@ -94,13 +94,13 @@ 
                 // 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);
+                        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);
+                        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'),
@@ -119,8 +119,8 @@ 
      */
     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>';
         }
     }
 
@@ -143,8 +143,8 @@ 
         // 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;
+        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'),
@@ -161,7 +161,7 @@ 
                 );
             }
             if (defined('WP_DEBUG') && WP_DEBUG) {
-                throw new EE_Error($msg . '||' . $msg);
+                throw new EE_Error($msg.'||'.$msg);
             }
             return false;
         }
@@ -187,7 +187,7 @@ 
         $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) ? $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'),
@@ -226,15 +226,15 @@ 
         // 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))) {
+        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 ( ! $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);
@@ -244,7 +244,7 @@ 
                 }
                 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;
@@ -264,7 +264,7 @@ 
         // 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 ( ! $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);
@@ -291,11 +291,11 @@ 
         $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)) {
+        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 ( ! $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);
@@ -304,7 +304,7 @@ 
                 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;
@@ -363,9 +363,9 @@ 
     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, ' ') . ' ' : '';
+        $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 ( ! 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);
@@ -376,7 +376,7 @@ 
         // load WP_Filesystem and set file permissions
         $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 ( ! $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');
@@ -486,8 +486,8 @@ 
     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')) {
+        if ( ! EEH_File::exists($folder.'.htaccess')) {
+            if ( ! EEH_File::write_to_file($folder.'.htaccess', 'deny from all', '.htaccess')) {
                 return false;
             }
         }
@@ -504,8 +504,8 @@ 
     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')) {
+        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;
             }
         }
@@ -539,7 +539,7 @@ 
      */
     public static function standardise_directory_separators($file_path)
     {
-        return str_replace(array( '\\', '/' ), DS, $file_path);
+        return str_replace(array('\\', '/'), DS, $file_path);
     }
 
 
@@ -552,7 +552,7 @@ 
      */
     public static function end_with_directory_separator($file_path)
     {
-        return rtrim($file_path, '/\\') . DS;
+        return rtrim($file_path, '/\\').DS;
     }
 
 
@@ -587,17 +587,17 @@ 
         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) {
                     // only add files, not folders
-                    if (! is_dir($file_path)) {
+                    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);
-                            $class_to_folder_path[ $classname ] = $file_path;
+                            $class_to_folder_path[$classname] = $file_path;
                         }
                     }
                 }
@@ -619,7 +619,7 @@ 
     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 ( ! 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);
@@ -630,7 +630,7 @@ 
 
         $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 ( ! 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);
@@ -642,7 +642,7 @@ 
         // load WP_Filesystem and set file permissions
         $wp_filesystem = EEH_File::_get_wp_filesystem($destination_file);
         // write the file
-        if (! $wp_filesystem->copy(
+        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),
             $overwrite
@@ -683,6 +683,6 @@ 
     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);
+        return str_replace(WP_CONTENT_DIR.DS, $wp_filesystem->wp_content_dir(), $local_filepath);
     }
 }