eventespresso / event-espresso-core

core/db_models/EEM_Message_Template_Group.model.php

Doc Comments +2 added lines, -2 removed lines

@@ -84,7 +84,7 @@ 
      * @param        $messenger
      * @param string $orderby
      * @param string $order
-     * @return array all (including trashed or inactive) message template group objects for the given messenger
+     * @return EE_Base_Class[] all (including trashed or inactive) message template group objects for the given messenger
      */
     public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
     {
@@ -341,7 +341,7 @@ 
     /**
      * This sends things to the validator for the given messenger and message type.
      *
-     * @param  array $fields the incoming fields to check.
+     * @param  string $fields the incoming fields to check.
      *                       Note this array is in the formatted fields from the form fields setup.
      *                       So we need to reformat this into an array of expected field refs by the validator.
      *                       Note also that this is not only the fields for the Message Template Group

Spacing +23 added lines, -23 removed lines

@@ -44,7 +44,7 @@ 
             'WP_User' => new EE_Belongs_To_Relation()
         );
         foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+            $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_Global('MTP_is_global');
         }
         $this->_caps_slug = 'messages';
 
@@ -71,7 +71,7 @@ 
         $limit = null,
         $count = false
     ) {
-        $query_params = array( array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit);
         return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
     }
 
@@ -89,7 +89,7 @@ 
     public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
     {
         return $this->get_all_deleted_and_undeleted(
-            array( array( 'MTP_messenger' => $messenger ), 'order_by' => array( $orderby => $order ) )
+            array(array('MTP_messenger' => $messenger), 'order_by' => array($orderby => $order))
         );
     }
 
@@ -107,7 +107,7 @@ 
             && $_REQUEST['ee_messenger_filter_by'] != 'none_selected'
             && $_REQUEST['ee_messenger_filter_by'] != 'all'
         ) {
-            $_where['MTP_messenger'] =  $_REQUEST['ee_messenger_filter_by'] ;
+            $_where['MTP_messenger'] = $_REQUEST['ee_messenger_filter_by'];
         }
 
         if (isset($_REQUEST['ee_message_type_filter_by'])
@@ -141,7 +141,7 @@ 
         $global = true,
         $user_check = false
     ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+        $_where = $global ? array('MTP_is_global' => true) : array('MTP_is_global' => false);
         $_where['MTP_is_active'] = true;
         $_where = $this->_maybe_mtp_filters($_where);
 
@@ -155,7 +155,7 @@ 
             $_where['MTP_user_id'] = get_current_user_id();
         }
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -176,7 +176,7 @@ 
     {
         $_where = $this->_maybe_mtp_filters();
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         $r_templates = $count
             ? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
@@ -196,9 +196,9 @@ 
      */
     public function get_all_custom_templates_by_event($EVT_ID, $query_params = array())
     {
-        $where = array_merge($query_params, array( 'Event.EVT_ID' => $EVT_ID ));
+        $where = array_merge($query_params, array('Event.EVT_ID' => $EVT_ID));
         return $this->get_all(
-            array( $where )
+            array($where)
         );
     }
 
@@ -223,11 +223,11 @@ 
         $count = false,
         $global = true
     ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+        $_where = $global ? array('MTP_is_global' => true) : array('MTP_is_global' => false);
         $_where['MTP_is_active'] = true;
         $_where = $this->_maybe_mtp_filters($_where);
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
     }
@@ -265,7 +265,7 @@ 
             'MTP_is_active' => $active
         );
 
-        $query_params = array( $_where, 'order_by' => array($orderby=>$order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby=>$order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -305,7 +305,7 @@ 
             $_where['MTP_is_active'] = $active;
         }
 
-        $query_params = array( $_where, 'order_by' => array( $orderby => $order ), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -363,19 +363,19 @@ 
             // first let's figure out if the value['content'] in the current index is an array.
             //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
             if (is_array($value['content'])) {
-                $assembled_fields[ $value['name'] ] = $value['content']['main'];
+                $assembled_fields[$value['name']] = $value['content']['main'];
                 // loop through the content and get the other fields.
                 foreach ($value['content'] as $name => $val) {
                     if ($name == 'main') {
                         continue;
                     }
-                    $assembled_fields[ $name ] = $val;
+                    $assembled_fields[$name] = $val;
                 }
                 continue;
             }
 
             // okay if we're here then this is just a straight field=>$value arrangement
-            $assembled_fields[ $value['name'] ] = $value['content'];
+            $assembled_fields[$value['name']] = $value['content'];
         }
 
         // now we've got the assembled_fields.
@@ -385,9 +385,9 @@ 
         $mt_ref = ucwords(str_replace('_', ' ', $message_type));
         $mt_ref = str_replace(' ', '_', $mt_ref);
 
-        $classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
+        $classname = 'EE_Messages_'.$m_ref.'_'.$mt_ref.'_Validator';
 
-        if (!class_exists($classname)) {
+        if ( ! class_exists($classname)) {
             $msg[] = __('The Validator class was unable to load', 'event_espresso');
             $msg[] = sprintf(
                 __(
@@ -425,12 +425,12 @@ 
         if (empty($messenger_names) && empty($message_type_names)) {
             return 0;
         }
-        if (! empty($messenger_names)) {
-            $query_args[0]['MTP_messenger'] = array( 'IN', (array) $messenger_names );
+        if ( ! empty($messenger_names)) {
+            $query_args[0]['MTP_messenger'] = array('IN', (array) $messenger_names);
         }
-        if (! empty($message_type_names)) {
-            $query_args[0]['MTP_message_type'] = array( 'IN', (array) $message_type_names );
+        if ( ! empty($message_type_names)) {
+            $query_args[0]['MTP_message_type'] = array('IN', (array) $message_type_names);
         }
-        return $this->update(array( 'MTP_is_active' => false ), $query_args);
+        return $this->update(array('MTP_is_active' => false), $query_args);
     }
 }

Indentation +422 added lines, -422 removed lines

@@ -11,426 +11,426 @@
 class EEM_Message_Template_Group extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the EEM_Message_Template_Group object
-    protected static $_instance = null;
-
-
-
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Message Template Group', 'event_espresso');
-        $this->plural_item = __('Message Template Groups', 'event_espresso');
-        $this->_tables = array(
-            'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID')
-        );
-        $this->_fields = array(
-            'Message_Template_Group' => array(
-                'GRP_ID' => new EE_Primary_Key_Int_Field('GRP_ID', __('Message Template Group ID', 'event_espresso')),
-                'MTP_name' => new EE_Plain_Text_Field('MTP_name', __('The name of the template group', 'event_espresso'), false, ''),
-                'MTP_description' => new EE_Simple_HTML_Field('MTP_description', __('A brief description about this template.', 'event_espresso'), false, ''),
-                'MTP_user_id'=> new EE_WP_User_Field('MTP_user_id', __('Template Creator ID', 'event_espresso'), false, get_current_user_id()),
-                'MTP_messenger'=>new EE_Plain_Text_Field('MTP_messenger', __('Messenger Used for Template', 'event_espresso'), false, 'email'),
-                'MTP_message_type'=>new EE_Plain_Text_Field('MTP_message_type', __('Message Type', 'event_espresso'), false, 'registration'),
-                'MTP_is_global'=>new EE_Boolean_Field('MTP_is_global', __('Flag indicating if Template Group is Global', 'event_espresso'), false, true),
-                'MTP_is_override'=>new EE_Boolean_Field('MTP_is_override', __('Flag indicating if Template Group overrides any other Templates for the messenger/messagetype combination', 'event_espresso'), false, false),
-                'MTP_deleted'=>new EE_Trashed_Flag_Field('MTP_deleted', __('Flag indicating whether this has been trashed', 'event_espresso'), false, false),
-                'MTP_is_active'=>new EE_Boolean_Field('MTP_is_active', __('Flag indicating whether template group is active', 'event_espresso'), false, true)
-            )
-        );
-        $this->_model_relations = array(
-            'Message_Template' => new EE_Has_Many_Relation(),
-            'Message' => new EE_Has_Many_Relation(),
-            'Event' => new EE_HABTM_Relation('Event_Message_Template'),
-            'WP_User' => new EE_Belongs_To_Relation()
-        );
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
-        }
-        $this->_caps_slug = 'messages';
-
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * get_all_trashed_message_templates_by_event
-     *
-     * @access public
-     * @param int    $EVT_ID specific event id
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @return array message template objects that are attached to a specific event.
-     */
-    public function get_all_trashed_message_templates_by_event(
-        $EVT_ID,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false
-    ) {
-        $query_params = array( array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit );
-        return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
-    }
-
-
-
-    /**
-     * get_all_message_templates_by_messenger
-     *
-     * @access public
-     * @param        $messenger
-     * @param string $orderby
-     * @param string $order
-     * @return array all (including trashed or inactive) message template group objects for the given messenger
-     */
-    public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
-    {
-        return $this->get_all_deleted_and_undeleted(
-            array( array( 'MTP_messenger' => $messenger ), 'order_by' => array( $orderby => $order ) )
-        );
-    }
-
-
-
-    /**
-     * This simply adds on any messenger/message type filters that may be present in the $_POST global
-     * @param  array  $_where any existing where conditions to append these to.
-     * @return array          original where conditions or original with additional filters.
-     */
-    protected function _maybe_mtp_filters($_where = array())
-    {
-        // account for messenger or message type filters
-        if (isset($_REQUEST['ee_messenger_filter_by'])
-            && $_REQUEST['ee_messenger_filter_by'] != 'none_selected'
-            && $_REQUEST['ee_messenger_filter_by'] != 'all'
-        ) {
-            $_where['MTP_messenger'] =  $_REQUEST['ee_messenger_filter_by'] ;
-        }
-
-        if (isset($_REQUEST['ee_message_type_filter_by'])
-            && $_REQUEST['ee_message_type_filter_by'] != 'none_selected'
-        ) {
-            $_where['MTP_message_type'] = $_REQUEST['ee_message_type_filter_by'];
-        }
-
-        return $_where;
-    }
-
-
-
-    /**
-     * get_all_active_message_templates groups
-     *
-     * @access public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @param bool   $global
-     * @param bool   $user_check
-     * @return array all active (non_trashed, active) message template objects
-     */
-    public function get_all_active_message_templates(
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $global = true,
-        $user_check = false
-    ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
-        $_where['MTP_is_active'] = true;
-        $_where = $this->_maybe_mtp_filters($_where);
-
-        if ($user_check
-            && ! $global
-            && ! EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_others_messages',
-                'get_all_active_message_templates'
-            )
-        ) {
-            $_where['MTP_user_id'] = get_current_user_id();
-        }
-
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     *    retrieve ALL message_template groups from db regardless of wht
-     *
-     * @access    public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @return mixed array on success, FALSE on fail
-     */
-    public function get_all_message_templates($orderby = 'GRP_ID', $order = 'ASC', $limit = null, $count = false)
-    {
-        $_where = $this->_maybe_mtp_filters();
-
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
-
-        $r_templates = $count
-            ? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
-            : $this->get_all_deleted_and_undeleted($query_params);
-
-        return $r_templates;
-    }
-
-
-
-
-    /**
-     * This gets all the custom templates attached to a specific event
-     * @param  int      $EVT_ID         event id
-     * @param  array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return  EE_Message_Template_Group[]
-     */
-    public function get_all_custom_templates_by_event($EVT_ID, $query_params = array())
-    {
-        $where = array_merge($query_params, array( 'Event.EVT_ID' => $EVT_ID ));
-        return $this->get_all(
-            array( $where )
-        );
-    }
-
-
-
-    /**
-     * get_all_trashed_grouped_message_templates
-     * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
-     *
-     * @access public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @param bool   $global
-     * @return \EE_Message_Template_Group[] message template groups.
-     */
-    public function get_all_trashed_grouped_message_templates(
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $global = true
-    ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
-        $_where['MTP_is_active'] = true;
-        $_where = $this->_maybe_mtp_filters($_where);
-
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
-
-        return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
-    }
-
-
-
-    /**
-     * this returns the message template group(s) for a given event, messenger, and message template
-     *
-     * @param  string             $messenger
-     * @param  string             $message_type
-     * @param                     $evt_id
-     * @param  string             $orderby pointless at this point but still included
-     * @param  string             $order
-     * @param  mixed (array|null) $limit   array($offset, $num)
-     * @param  bool               $count   true = just return count, false = objects
-     * @param  bool               $active  ignore "active" or not. (default only return active)
-     * @return \mixed[]) depending on $count.
-     */
-    public function get_event_message_templates_by_m_and_mt_and_evt(
-        $messenger,
-        $message_type,
-        $evt_id,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $active = true
-    ) {
-        $_where = array(
-            'MTP_messenger' => $messenger,
-            'MTP_message_type' => $message_type,
-            'Event.EVT_ID' => $evt_id,
-            'MTP_is_global' => true,
-            'MTP_is_active' => $active
-        );
-
-        $query_params = array( $_where, 'order_by' => array($orderby=>$order), 'limit' => $limit );
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-
-
-    /**
-     * get all GLOBAL message template groups for the given messenger and message type
-     *
-     * @param  string $messenger    slug for messenger
-     * @param  string $message_type slug for message type
-     * @param  string $orderby      what column to orderby
-     * @param  string $order        ASC or DESC
-     * @param  mixed (array|null) $limit array($offset, $num)
-     * @param  bool   $count        true = just return count, false = objects
-     * @param  bool   $active       ignore "active" or not. (default only return active) -
-     *                              'all' means return both inactive AND inactive.
-     * @return array               message template objects that are global (i.e. non-event)
-     */
-    public function get_global_message_template_by_m_and_mt(
-        $messenger,
-        $message_type,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $active = true
-    ) {
-        $_where = array(
-            'MTP_messenger' => $messenger,
-            'MTP_message_type' => $message_type,
-            'MTP_is_global' => true,
-        );
-
-        if ($active != 'all') {
-            $_where['MTP_is_active'] = $active;
-        }
-
-        $query_params = array( $_where, 'order_by' => array( $orderby => $order ), 'limit' => $limit );
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-
-
-    /**
-     * get all custom message template groups for the given messenger and message type
-     * @param  string $messenger    messenger
-     * @param  string $message_type messagetype
-     * @param  array  $query_params same as EEM_Base->get_all()
-     * @return EE_Message_Template_Group[]
-     */
-    public function get_custom_message_template_by_m_and_mt($messenger, $message_type, $query_params = array())
-    {
-        return $this->get_all(
-            array_merge(
-                $query_params,
-                array(
-                    array(
-                        'MTP_is_global'    => false,
-                        'MTP_messenger'    => $messenger,
-                        'MTP_message_type' => $message_type
-                    )
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * This sends things to the validator for the given messenger and message type.
-     *
-     * @param  array $fields the incoming fields to check.
-     *                       Note this array is in the formatted fields from the form fields setup.
-     *                       So we need to reformat this into an array of expected field refs by the validator.
-     *                       Note also that this is not only the fields for the Message Template Group
-     *                       but ALSO for Message Template.
-     * @param string $context      The context the fields were obtained from.
-     * @param string $messenger    The messenger we are validating
-     * @param string $message_type The message type we are validating.
-     * @return mixed If the fields all check out then we return true otherwise error messages are returned
-     *                       (indexed by field name);
-     * @throws \EE_Error
-     */
-    public function validate($fields, $context, $messenger, $message_type)
-    {
-
-        $assembled_fields = array();
-
-        // let's loop through all the fields and set them up in the right format
-        foreach ($fields as $index => $value) {
-            // first let's figure out if the value['content'] in the current index is an array.
-            //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
-            if (is_array($value['content'])) {
-                $assembled_fields[ $value['name'] ] = $value['content']['main'];
-                // loop through the content and get the other fields.
-                foreach ($value['content'] as $name => $val) {
-                    if ($name == 'main') {
-                        continue;
-                    }
-                    $assembled_fields[ $name ] = $val;
-                }
-                continue;
-            }
-
-            // okay if we're here then this is just a straight field=>$value arrangement
-            $assembled_fields[ $value['name'] ] = $value['content'];
-        }
-
-        // now we've got the assembled_fields.
-        // We need to setup the string for the appropriate validator class and call that.
-        $m_ref = ucwords(str_replace('_', ' ', $messenger));
-        $m_ref = str_replace(' ', '_', $m_ref);
-        $mt_ref = ucwords(str_replace('_', ' ', $message_type));
-        $mt_ref = str_replace(' ', '_', $mt_ref);
-
-        $classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
-
-        if (!class_exists($classname)) {
-            $msg[] = __('The Validator class was unable to load', 'event_espresso');
-            $msg[] = sprintf(
-                __(
-                    'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
-                    'event_espresso'
-                ),
-                $classname
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-
-        $a = new ReflectionClass($classname);
-        $_VLD = $a->newInstance($assembled_fields, $context);
-        $result = $_VLD->validate();
-        return $result;
-    }
-
-
-
-    /**
-     * Updates all message template groups matching the incoming arguments to inactive status.
-     *
-     * @param array $messenger_names    The messenger slugs.
-     *                              If empty then all templates matching the message types are marked inactive.
-     *                              Otherwise only templates matching the messengers and message types.
-     * @param array $message_type_names     The message type slugs.
-     *                              If empty then all templates matching the messengers are marked inactive.
-     *                              Otherwise only templates matching the messengers and message types.
-     *
-     * @return int  count of updated records.
-     */
-    public function deactivate_message_template_groups_for($messenger_names = array(), $message_type_names = array())
-    {
-        $query_args = array();
-        if (empty($messenger_names) && empty($message_type_names)) {
-            return 0;
-        }
-        if (! empty($messenger_names)) {
-            $query_args[0]['MTP_messenger'] = array( 'IN', (array) $messenger_names );
-        }
-        if (! empty($message_type_names)) {
-            $query_args[0]['MTP_message_type'] = array( 'IN', (array) $message_type_names );
-        }
-        return $this->update(array( 'MTP_is_active' => false ), $query_args);
-    }
+	// private instance of the EEM_Message_Template_Group object
+	protected static $_instance = null;
+
+
+
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Message Template Group', 'event_espresso');
+		$this->plural_item = __('Message Template Groups', 'event_espresso');
+		$this->_tables = array(
+			'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID')
+		);
+		$this->_fields = array(
+			'Message_Template_Group' => array(
+				'GRP_ID' => new EE_Primary_Key_Int_Field('GRP_ID', __('Message Template Group ID', 'event_espresso')),
+				'MTP_name' => new EE_Plain_Text_Field('MTP_name', __('The name of the template group', 'event_espresso'), false, ''),
+				'MTP_description' => new EE_Simple_HTML_Field('MTP_description', __('A brief description about this template.', 'event_espresso'), false, ''),
+				'MTP_user_id'=> new EE_WP_User_Field('MTP_user_id', __('Template Creator ID', 'event_espresso'), false, get_current_user_id()),
+				'MTP_messenger'=>new EE_Plain_Text_Field('MTP_messenger', __('Messenger Used for Template', 'event_espresso'), false, 'email'),
+				'MTP_message_type'=>new EE_Plain_Text_Field('MTP_message_type', __('Message Type', 'event_espresso'), false, 'registration'),
+				'MTP_is_global'=>new EE_Boolean_Field('MTP_is_global', __('Flag indicating if Template Group is Global', 'event_espresso'), false, true),
+				'MTP_is_override'=>new EE_Boolean_Field('MTP_is_override', __('Flag indicating if Template Group overrides any other Templates for the messenger/messagetype combination', 'event_espresso'), false, false),
+				'MTP_deleted'=>new EE_Trashed_Flag_Field('MTP_deleted', __('Flag indicating whether this has been trashed', 'event_espresso'), false, false),
+				'MTP_is_active'=>new EE_Boolean_Field('MTP_is_active', __('Flag indicating whether template group is active', 'event_espresso'), false, true)
+			)
+		);
+		$this->_model_relations = array(
+			'Message_Template' => new EE_Has_Many_Relation(),
+			'Message' => new EE_Has_Many_Relation(),
+			'Event' => new EE_HABTM_Relation('Event_Message_Template'),
+			'WP_User' => new EE_Belongs_To_Relation()
+		);
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+		}
+		$this->_caps_slug = 'messages';
+
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * get_all_trashed_message_templates_by_event
+	 *
+	 * @access public
+	 * @param int    $EVT_ID specific event id
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @return array message template objects that are attached to a specific event.
+	 */
+	public function get_all_trashed_message_templates_by_event(
+		$EVT_ID,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false
+	) {
+		$query_params = array( array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit );
+		return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
+	}
+
+
+
+	/**
+	 * get_all_message_templates_by_messenger
+	 *
+	 * @access public
+	 * @param        $messenger
+	 * @param string $orderby
+	 * @param string $order
+	 * @return array all (including trashed or inactive) message template group objects for the given messenger
+	 */
+	public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
+	{
+		return $this->get_all_deleted_and_undeleted(
+			array( array( 'MTP_messenger' => $messenger ), 'order_by' => array( $orderby => $order ) )
+		);
+	}
+
+
+
+	/**
+	 * This simply adds on any messenger/message type filters that may be present in the $_POST global
+	 * @param  array  $_where any existing where conditions to append these to.
+	 * @return array          original where conditions or original with additional filters.
+	 */
+	protected function _maybe_mtp_filters($_where = array())
+	{
+		// account for messenger or message type filters
+		if (isset($_REQUEST['ee_messenger_filter_by'])
+			&& $_REQUEST['ee_messenger_filter_by'] != 'none_selected'
+			&& $_REQUEST['ee_messenger_filter_by'] != 'all'
+		) {
+			$_where['MTP_messenger'] =  $_REQUEST['ee_messenger_filter_by'] ;
+		}
+
+		if (isset($_REQUEST['ee_message_type_filter_by'])
+			&& $_REQUEST['ee_message_type_filter_by'] != 'none_selected'
+		) {
+			$_where['MTP_message_type'] = $_REQUEST['ee_message_type_filter_by'];
+		}
+
+		return $_where;
+	}
+
+
+
+	/**
+	 * get_all_active_message_templates groups
+	 *
+	 * @access public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @param bool   $global
+	 * @param bool   $user_check
+	 * @return array all active (non_trashed, active) message template objects
+	 */
+	public function get_all_active_message_templates(
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$global = true,
+		$user_check = false
+	) {
+		$_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+		$_where['MTP_is_active'] = true;
+		$_where = $this->_maybe_mtp_filters($_where);
+
+		if ($user_check
+			&& ! $global
+			&& ! EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_others_messages',
+				'get_all_active_message_templates'
+			)
+		) {
+			$_where['MTP_user_id'] = get_current_user_id();
+		}
+
+		$query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 *    retrieve ALL message_template groups from db regardless of wht
+	 *
+	 * @access    public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @return mixed array on success, FALSE on fail
+	 */
+	public function get_all_message_templates($orderby = 'GRP_ID', $order = 'ASC', $limit = null, $count = false)
+	{
+		$_where = $this->_maybe_mtp_filters();
+
+		$query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+
+		$r_templates = $count
+			? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
+			: $this->get_all_deleted_and_undeleted($query_params);
+
+		return $r_templates;
+	}
+
+
+
+
+	/**
+	 * This gets all the custom templates attached to a specific event
+	 * @param  int      $EVT_ID         event id
+	 * @param  array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return  EE_Message_Template_Group[]
+	 */
+	public function get_all_custom_templates_by_event($EVT_ID, $query_params = array())
+	{
+		$where = array_merge($query_params, array( 'Event.EVT_ID' => $EVT_ID ));
+		return $this->get_all(
+			array( $where )
+		);
+	}
+
+
+
+	/**
+	 * get_all_trashed_grouped_message_templates
+	 * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
+	 *
+	 * @access public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @param bool   $global
+	 * @return \EE_Message_Template_Group[] message template groups.
+	 */
+	public function get_all_trashed_grouped_message_templates(
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$global = true
+	) {
+		$_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+		$_where['MTP_is_active'] = true;
+		$_where = $this->_maybe_mtp_filters($_where);
+
+		$query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+
+		return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
+	}
+
+
+
+	/**
+	 * this returns the message template group(s) for a given event, messenger, and message template
+	 *
+	 * @param  string             $messenger
+	 * @param  string             $message_type
+	 * @param                     $evt_id
+	 * @param  string             $orderby pointless at this point but still included
+	 * @param  string             $order
+	 * @param  mixed (array|null) $limit   array($offset, $num)
+	 * @param  bool               $count   true = just return count, false = objects
+	 * @param  bool               $active  ignore "active" or not. (default only return active)
+	 * @return \mixed[]) depending on $count.
+	 */
+	public function get_event_message_templates_by_m_and_mt_and_evt(
+		$messenger,
+		$message_type,
+		$evt_id,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$active = true
+	) {
+		$_where = array(
+			'MTP_messenger' => $messenger,
+			'MTP_message_type' => $message_type,
+			'Event.EVT_ID' => $evt_id,
+			'MTP_is_global' => true,
+			'MTP_is_active' => $active
+		);
+
+		$query_params = array( $_where, 'order_by' => array($orderby=>$order), 'limit' => $limit );
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+
+
+	/**
+	 * get all GLOBAL message template groups for the given messenger and message type
+	 *
+	 * @param  string $messenger    slug for messenger
+	 * @param  string $message_type slug for message type
+	 * @param  string $orderby      what column to orderby
+	 * @param  string $order        ASC or DESC
+	 * @param  mixed (array|null) $limit array($offset, $num)
+	 * @param  bool   $count        true = just return count, false = objects
+	 * @param  bool   $active       ignore "active" or not. (default only return active) -
+	 *                              'all' means return both inactive AND inactive.
+	 * @return array               message template objects that are global (i.e. non-event)
+	 */
+	public function get_global_message_template_by_m_and_mt(
+		$messenger,
+		$message_type,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$active = true
+	) {
+		$_where = array(
+			'MTP_messenger' => $messenger,
+			'MTP_message_type' => $message_type,
+			'MTP_is_global' => true,
+		);
+
+		if ($active != 'all') {
+			$_where['MTP_is_active'] = $active;
+		}
+
+		$query_params = array( $_where, 'order_by' => array( $orderby => $order ), 'limit' => $limit );
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+
+
+	/**
+	 * get all custom message template groups for the given messenger and message type
+	 * @param  string $messenger    messenger
+	 * @param  string $message_type messagetype
+	 * @param  array  $query_params same as EEM_Base->get_all()
+	 * @return EE_Message_Template_Group[]
+	 */
+	public function get_custom_message_template_by_m_and_mt($messenger, $message_type, $query_params = array())
+	{
+		return $this->get_all(
+			array_merge(
+				$query_params,
+				array(
+					array(
+						'MTP_is_global'    => false,
+						'MTP_messenger'    => $messenger,
+						'MTP_message_type' => $message_type
+					)
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * This sends things to the validator for the given messenger and message type.
+	 *
+	 * @param  array $fields the incoming fields to check.
+	 *                       Note this array is in the formatted fields from the form fields setup.
+	 *                       So we need to reformat this into an array of expected field refs by the validator.
+	 *                       Note also that this is not only the fields for the Message Template Group
+	 *                       but ALSO for Message Template.
+	 * @param string $context      The context the fields were obtained from.
+	 * @param string $messenger    The messenger we are validating
+	 * @param string $message_type The message type we are validating.
+	 * @return mixed If the fields all check out then we return true otherwise error messages are returned
+	 *                       (indexed by field name);
+	 * @throws \EE_Error
+	 */
+	public function validate($fields, $context, $messenger, $message_type)
+	{
+
+		$assembled_fields = array();
+
+		// let's loop through all the fields and set them up in the right format
+		foreach ($fields as $index => $value) {
+			// first let's figure out if the value['content'] in the current index is an array.
+			//  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
+			if (is_array($value['content'])) {
+				$assembled_fields[ $value['name'] ] = $value['content']['main'];
+				// loop through the content and get the other fields.
+				foreach ($value['content'] as $name => $val) {
+					if ($name == 'main') {
+						continue;
+					}
+					$assembled_fields[ $name ] = $val;
+				}
+				continue;
+			}
+
+			// okay if we're here then this is just a straight field=>$value arrangement
+			$assembled_fields[ $value['name'] ] = $value['content'];
+		}
+
+		// now we've got the assembled_fields.
+		// We need to setup the string for the appropriate validator class and call that.
+		$m_ref = ucwords(str_replace('_', ' ', $messenger));
+		$m_ref = str_replace(' ', '_', $m_ref);
+		$mt_ref = ucwords(str_replace('_', ' ', $message_type));
+		$mt_ref = str_replace(' ', '_', $mt_ref);
+
+		$classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
+
+		if (!class_exists($classname)) {
+			$msg[] = __('The Validator class was unable to load', 'event_espresso');
+			$msg[] = sprintf(
+				__(
+					'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
+					'event_espresso'
+				),
+				$classname
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+
+		$a = new ReflectionClass($classname);
+		$_VLD = $a->newInstance($assembled_fields, $context);
+		$result = $_VLD->validate();
+		return $result;
+	}
+
+
+
+	/**
+	 * Updates all message template groups matching the incoming arguments to inactive status.
+	 *
+	 * @param array $messenger_names    The messenger slugs.
+	 *                              If empty then all templates matching the message types are marked inactive.
+	 *                              Otherwise only templates matching the messengers and message types.
+	 * @param array $message_type_names     The message type slugs.
+	 *                              If empty then all templates matching the messengers are marked inactive.
+	 *                              Otherwise only templates matching the messengers and message types.
+	 *
+	 * @return int  count of updated records.
+	 */
+	public function deactivate_message_template_groups_for($messenger_names = array(), $message_type_names = array())
+	{
+		$query_args = array();
+		if (empty($messenger_names) && empty($message_type_names)) {
+			return 0;
+		}
+		if (! empty($messenger_names)) {
+			$query_args[0]['MTP_messenger'] = array( 'IN', (array) $messenger_names );
+		}
+		if (! empty($message_type_names)) {
+			$query_args[0]['MTP_message_type'] = array( 'IN', (array) $message_type_names );
+		}
+		return $this->update(array( 'MTP_is_active' => false ), $query_args);
+	}
 }

core/db_models/EEM_Payment_Method.model.php

Doc Comments +3 added lines, -3 removed lines

@@ -214,7 +214,7 @@ 
     /**
      * Overrides parent ot also check by the slug
      * @see EEM_Base::ensure_is_obj()
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
+     * @param EE_Payment_Method $base_class_obj_or_id
      * @param boolean                      $ensure_is_in_db
      * @return EE_Payment_Method
      * @throws EE_Error
@@ -382,8 +382,8 @@ 
      * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
      * It will ONLY return a payment method for a PAYMENT recorded against the registration.
      *
-     * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
-     * @return EE_Payment|null
+     * @param EE_Registration $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
+     * @return null|EE_Base_Class
      */
     public function get_last_used_for_registration($registration_or_reg_id)
     {

Spacing +14 added lines, -14 removed lines

@@ -44,7 +44,7 @@ 
     {
         $this->singlular_item = __('Payment Method', 'event_espresso');
         $this->plural_item = __('Payment Methods', 'event_espresso');
-        $this->_tables = array( 'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID') );
+        $this->_tables = array('Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'));
         $this->_fields = array(
             'Payment_Method' => array(
                 'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
@@ -78,7 +78,7 @@ 
      */
     public function get_one_by_slug($slug)
     {
-        return $this->get_one(array( array( 'PMD_slug' => $slug ) ));
+        return $this->get_one(array(array('PMD_slug' => $slug)));
     }
 
 
@@ -109,7 +109,7 @@ 
     public function is_valid_scope($scope)
     {
         $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
+        if (isset($scopes[$scope])) {
             return true;
         } else {
             return false;
@@ -127,8 +127,8 @@ 
      */
     public function get_all_active($scope = null, $query_params = array())
     {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
+        if ( ! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+            $query_params['order_by'] = array('PMD_order' => 'ASC', 'PMD_ID' => 'ASC');
         }
         return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
     }
@@ -156,7 +156,7 @@ 
     {
         if ($scope) {
             if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive(array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params);
+                return array_replace_recursive(array(array('PMD_scope' => array('LIKE', "%$scope%"))), $query_params);
             } else {
                 throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
             }
@@ -165,9 +165,9 @@ 
             $count = 0;
             foreach ($this->scopes() as $scope_name => $desc) {
                 $count++;
-                $acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
+                $acceptable_scopes['PMD_scope*'.$count] = array('LIKE', '%'.$scope_name.'%');
             }
-            return array_replace_recursive(array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params);
+            return array_replace_recursive(array(array('OR*active_scope' => $acceptable_scopes)), $query_params);
         }
     }
 
@@ -205,7 +205,7 @@ 
      */
     public function get_one_of_type($type)
     {
-        return $this->get_one(array( array( 'PMD_type' => $type ) ));
+        return $this->get_one(array(array('PMD_type' => $type)));
     }
 
 
@@ -298,7 +298,7 @@ 
         $usable_payment_methods = array();
         foreach ($payment_methods as $key => $payment_method) {
             if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
+                $usable_payment_methods[$key] = $payment_method;
                 // some payment methods enqueue their scripts in EE_PMT_*::__construct
                 // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
                 // its scripts). but for backwards-compat we should continue to do that
@@ -312,7 +312,7 @@ 
                     $payment_method
                 );
                 new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
+                    'auto-deactivated-'.$payment_method->type(),
                     sprintf(
                         __(
                             'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
@@ -320,7 +320,7 @@ 
                         ),
                         $payment_method->admin_name(),
                         '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
+                        '<a href="'.admin_url('plugins.php').'">',
                         '</a>'
                     ),
                     true
@@ -345,7 +345,7 @@ 
         // give addons a chance to override what payment methods are chosen based on the transaction
         return apply_filters(
             'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, array( 'group_by' => 'PMD_type' )),
+            $this->get_all_active($scope, array('group_by' => 'PMD_type')),
             $transaction,
             $scope
         );
@@ -369,7 +369,7 @@ 
             0 => array(
                 'Payment.Registration.REG_ID' => $registration_id,
             ),
-            'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
+            'order_by' => array('Payment.PAY_ID' => 'DESC')
         );
         return $this->get_one($query_params);
     }

Indentation +359 added lines, -359 removed lines

@@ -20,363 +20,363 @@
 class EEM_Payment_Method extends EEM_Base
 {
 
-    const scope_cart = 'CART';
-
-    const scope_admin = 'ADMIN';
-
-    const scope_api = 'API';
-
-    /**
-     *
-     * @type EEM_Payment_Method
-     */
-    protected static $_instance = null;
-
-
-
-    /**
-     * private constructor to prevent direct creation
-     * @Constructor
-     * @access   protected
-     * @return EEM_Payment_Method
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singlular_item = __('Payment Method', 'event_espresso');
-        $this->plural_item = __('Payment Methods', 'event_espresso');
-        $this->_tables = array( 'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID') );
-        $this->_fields = array(
-            'Payment_Method' => array(
-                'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
-                'PMD_type' => new EE_Plain_Text_Field('PMD_type', __("Payment Method Type", 'event_espresso'), false, 'Admin_Only'),
-                'PMD_name' => new EE_Plain_Text_Field('PMD_name', __("Name", 'event_espresso'), false),
-                'PMD_desc' => new EE_Post_Content_Field('PMD_desc', __("Description", 'event_espresso'), false, ''),
-                'PMD_admin_name' => new EE_Plain_Text_Field('PMD_admin_name', __("Admin-Only Name", 'event_espresso'), true),
-                'PMD_admin_desc' => new EE_Post_Content_Field('PMD_admin_desc', __("Admin-Only Description", 'event_espresso'), true),
-                'PMD_slug' => new EE_Slug_Field('PMD_slug', __("Slug", 'event_espresso'), false),
-                'PMD_order' => new EE_Integer_Field('PMD_order', __("Order", 'event_espresso'), false, 0),
-                'PMD_debug_mode' => new EE_Boolean_Field('PMD_debug_mode', __("Debug Mode On?", 'event_espresso'), false, false),
-                'PMD_wp_user' => new EE_WP_User_Field('PMD_wp_user', __("Payment Method Creator ID", 'event_espresso'), false),
-                'PMD_open_by_default' => new EE_Boolean_Field('PMD_open_by_default', __("Open by Default?", 'event_espresso'), false, false), 'PMD_button_url' => new EE_Plain_Text_Field('PMD_button_url', __("Button URL", 'event_espresso'), true, ''),
-                'PMD_scope' => new EE_Serialized_Text_Field('PMD_scope', __("Usable From?", 'event_espresso'), false, array()), // possible values currently are 'CART','ADMIN','API'
-        ) );
-        $this->_model_relations = array(
-            'Payment' => new EE_Has_Many_Relation(),
-            'Currency' => new EE_HABTM_Relation('Currency_Payment_Method'),
-            'Transaction' => new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Gets one by the slug provided
-     * @param string $slug
-     * @return EE_Payment_Method
-     */
-    public function get_one_by_slug($slug)
-    {
-        return $this->get_one(array( array( 'PMD_slug' => $slug ) ));
-    }
-
-
-
-    /**
-     * Gets all the acceptable scopes for payment methods.
-     * Keys are their names as store din the DB, and values are nice names for displaying them
-     * @return array
-     */
-    public function scopes()
-    {
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__scopes',
-            array(
-                self::scope_cart        => __("Front-end Registration Page", 'event_espresso'),
-                self::scope_admin   => __("Admin Registration Page (no online processing)", 'event_espresso')
-            )
-        );
-    }
-
-
-
-    /**
-     * Determines if this is an valid scope
-     * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
-     * @return boolean
-     */
-    public function is_valid_scope($scope)
-    {
-        $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Gets all active payment methods
-     * @param string $scope one of
-     * @param array  $query_params
-     * @throws EE_Error
-     * @return EE_Payment_Method[]
-     */
-    public function get_all_active($scope = null, $query_params = array())
-    {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
-        }
-        return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-    /**
-     * Counts all active gateways in the specified scope
-     * @param string $scope one of EEM_Payment_Method::scope_*
-     * @param array $query_params
-     * @return int
-     */
-    public function count_active($scope = null, $query_params = array())
-    {
-        return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    protected function _get_query_params_for_all_active($scope = null, $query_params = array())
-    {
-        if ($scope) {
-            if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive(array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params);
-            } else {
-                throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
-            }
-        } else {
-            $acceptable_scopes = array();
-            $count = 0;
-            foreach ($this->scopes() as $scope_name => $desc) {
-                $count++;
-                $acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
-            }
-            return array_replace_recursive(array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params);
-        }
-    }
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    public function get_query_params_for_all_active($scope = null, $query_params = array())
-    {
-        return $this->_get_query_params_for_all_active($scope, $query_params);
-    }
-
-
-    /**
-     * Gets one active payment method. see @get_all_active for documentation
-     * @param string $scope
-     * @param array  $query_params
-     * @return EE_Payment_Method
-     */
-    public function get_one_active($scope = null, $query_params = array())
-    {
-        return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-
-    /**
-     * Gets one payment method of that type, regardless of whether its active or not
-     * @param string $type
-     * @return EE_Payment_Method
-     */
-    public function get_one_of_type($type)
-    {
-        return $this->get_one(array( array( 'PMD_type' => $type ) ));
-    }
-
-
-
-    /**
-     * Overrides parent ot also check by the slug
-     * @see EEM_Base::ensure_is_obj()
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
-     * @param boolean                      $ensure_is_in_db
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
-    {
-        // first: check if it's a slug
-        if (is_string($base_class_obj_or_id)) {
-            $obj = $this->get_one_by_slug($base_class_obj_or_id);
-            if ($obj) {
-                return $obj;
-            }
-        }
-        // ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
-        try {
-            return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
-        } catch (EE_Error $e) {
-            // handle it outside the catch
-        }
-        throw new EE_Error(sprintf(__("'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso"), $base_class_obj_or_id));
-    }
-
-
-
-    /**
-     * Gets the ID of this object, or if its a string finds the object's id
-     * associated with that slug
-     * @param mixed $base_obj_or_id_or_slug
-     * @return int
-     */
-    public function ensure_is_ID($base_obj_or_id_or_slug)
-    {
-        if (is_string($base_obj_or_id_or_slug)) {
-            // assume it's a slug
-            $base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
-        }
-        return parent::ensure_is_ID($base_obj_or_id_or_slug);
-    }
-
-
-
-    /**
-     * Verifies the button urls on all the passed payment methods have a valid button url. If not, resets them to their default.
-     * @param EE_Payment_Method[] $payment_methods. If NULL is provided defaults to all payment methods active in the cart
-     */
-    public function verify_button_urls($payment_methods = null)
-    {
-        $payment_methods = is_array($payment_methods) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
-        foreach ($payment_methods as $payment_method) {
-            try {
-                // If there is really no button URL at all, or if the button URLs still point to decaf folder even
-                // though this is a caffeinated install, reset it to the default.
-                $current_button_url = $payment_method->button_url();
-                if (empty($current_button_url)
-                || (
-                        strpos($current_button_url, 'decaf') !== false
-                        && strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
-                    )
-                ) {
-                    $payment_method->save(
-                        [
-                            'PMD_button_url' => $payment_method->type_obj()->default_button_url()
-                        ]
-                    );
-                }
-            } catch (EE_Error $e) {
-                $payment_method->set_active(false);
-            }
-        }
-    }
-
-
-
-    /**
-     * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
-     * but also verifies the payment method type of each is a usable object. If not,
-     * deactivate it, sets a notification, and deactivates it
-     *
-     * @param array $rows
-     * @return EE_Payment_Method[]
-     * @throws InvalidDataTypeException
-     */
-    protected function _create_objects($rows = array())
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_methods = parent::_create_objects($rows);
-        /* @var $payment_methods EE_Payment_Method[] */
-        $usable_payment_methods = array();
-        foreach ($payment_methods as $key => $payment_method) {
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
-                // some payment methods enqueue their scripts in EE_PMT_*::__construct
-                // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
-                // its scripts). but for backwards-compat we should continue to do that
-                $payment_method->type_obj();
-            } elseif ($payment_method->active()) {
-                // only deactivate and notify the admin if the payment is active somewhere
-                $payment_method->deactivate();
-                $payment_method->save();
-                do_action(
-                    'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
-                    $payment_method
-                );
-                new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
-                    sprintf(
-                        __(
-                            'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
-                            'event_espresso'
-                        ),
-                        $payment_method->admin_name(),
-                        '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
-                        '</a>'
-                    ),
-                    true
-                );
-            }
-        }
-        return $usable_payment_methods;
-    }
-
-
-
-    /**
-     * Gets all the payment methods which can be used for transaction
-     * (according to the relations between payment methods and events, and
-     * the currencies used for the transaction and their relation to payment methods)
-     * @param EE_Transaction $transaction
-     * @param string    $scope @see EEM_Payment_Method::get_all_for_events
-     * @return EE_Payment_Method[]
-     */
-    public function get_all_for_transaction($transaction, $scope)
-    {
-        // give addons a chance to override what payment methods are chosen based on the transaction
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, array( 'group_by' => 'PMD_type' )),
-            $transaction,
-            $scope
-        );
-    }
-
-
-    /**
-     * Returns the payment method used for the last payment made for a registration.
-     *
-     * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
-     * It will ONLY return a payment method for a PAYMENT recorded against the registration.
-     *
-     * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
-     * @return EE_Payment|null
-     */
-    public function get_last_used_for_registration($registration_or_reg_id)
-    {
-        $registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
-
-        $query_params = array(
-            0 => array(
-                'Payment.Registration.REG_ID' => $registration_id,
-            ),
-            'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
-        );
-        return $this->get_one($query_params);
-    }
+	const scope_cart = 'CART';
+
+	const scope_admin = 'ADMIN';
+
+	const scope_api = 'API';
+
+	/**
+	 *
+	 * @type EEM_Payment_Method
+	 */
+	protected static $_instance = null;
+
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 * @Constructor
+	 * @access   protected
+	 * @return EEM_Payment_Method
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singlular_item = __('Payment Method', 'event_espresso');
+		$this->plural_item = __('Payment Methods', 'event_espresso');
+		$this->_tables = array( 'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID') );
+		$this->_fields = array(
+			'Payment_Method' => array(
+				'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
+				'PMD_type' => new EE_Plain_Text_Field('PMD_type', __("Payment Method Type", 'event_espresso'), false, 'Admin_Only'),
+				'PMD_name' => new EE_Plain_Text_Field('PMD_name', __("Name", 'event_espresso'), false),
+				'PMD_desc' => new EE_Post_Content_Field('PMD_desc', __("Description", 'event_espresso'), false, ''),
+				'PMD_admin_name' => new EE_Plain_Text_Field('PMD_admin_name', __("Admin-Only Name", 'event_espresso'), true),
+				'PMD_admin_desc' => new EE_Post_Content_Field('PMD_admin_desc', __("Admin-Only Description", 'event_espresso'), true),
+				'PMD_slug' => new EE_Slug_Field('PMD_slug', __("Slug", 'event_espresso'), false),
+				'PMD_order' => new EE_Integer_Field('PMD_order', __("Order", 'event_espresso'), false, 0),
+				'PMD_debug_mode' => new EE_Boolean_Field('PMD_debug_mode', __("Debug Mode On?", 'event_espresso'), false, false),
+				'PMD_wp_user' => new EE_WP_User_Field('PMD_wp_user', __("Payment Method Creator ID", 'event_espresso'), false),
+				'PMD_open_by_default' => new EE_Boolean_Field('PMD_open_by_default', __("Open by Default?", 'event_espresso'), false, false), 'PMD_button_url' => new EE_Plain_Text_Field('PMD_button_url', __("Button URL", 'event_espresso'), true, ''),
+				'PMD_scope' => new EE_Serialized_Text_Field('PMD_scope', __("Usable From?", 'event_espresso'), false, array()), // possible values currently are 'CART','ADMIN','API'
+		) );
+		$this->_model_relations = array(
+			'Payment' => new EE_Has_Many_Relation(),
+			'Currency' => new EE_HABTM_Relation('Currency_Payment_Method'),
+			'Transaction' => new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Gets one by the slug provided
+	 * @param string $slug
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_by_slug($slug)
+	{
+		return $this->get_one(array( array( 'PMD_slug' => $slug ) ));
+	}
+
+
+
+	/**
+	 * Gets all the acceptable scopes for payment methods.
+	 * Keys are their names as store din the DB, and values are nice names for displaying them
+	 * @return array
+	 */
+	public function scopes()
+	{
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__scopes',
+			array(
+				self::scope_cart        => __("Front-end Registration Page", 'event_espresso'),
+				self::scope_admin   => __("Admin Registration Page (no online processing)", 'event_espresso')
+			)
+		);
+	}
+
+
+
+	/**
+	 * Determines if this is an valid scope
+	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
+	 * @return boolean
+	 */
+	public function is_valid_scope($scope)
+	{
+		$scopes = $this->scopes();
+		if (isset($scopes[ $scope ])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Gets all active payment methods
+	 * @param string $scope one of
+	 * @param array  $query_params
+	 * @throws EE_Error
+	 * @return EE_Payment_Method[]
+	 */
+	public function get_all_active($scope = null, $query_params = array())
+	{
+		if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
+		}
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+	/**
+	 * Counts all active gateways in the specified scope
+	 * @param string $scope one of EEM_Payment_Method::scope_*
+	 * @param array $query_params
+	 * @return int
+	 */
+	public function count_active($scope = null, $query_params = array())
+	{
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	protected function _get_query_params_for_all_active($scope = null, $query_params = array())
+	{
+		if ($scope) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive(array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params);
+			} else {
+				throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
+			}
+		} else {
+			$acceptable_scopes = array();
+			$count = 0;
+			foreach ($this->scopes() as $scope_name => $desc) {
+				$count++;
+				$acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
+			}
+			return array_replace_recursive(array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params);
+		}
+	}
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	public function get_query_params_for_all_active($scope = null, $query_params = array())
+	{
+		return $this->_get_query_params_for_all_active($scope, $query_params);
+	}
+
+
+	/**
+	 * Gets one active payment method. see @get_all_active for documentation
+	 * @param string $scope
+	 * @param array  $query_params
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_active($scope = null, $query_params = array())
+	{
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+
+	/**
+	 * Gets one payment method of that type, regardless of whether its active or not
+	 * @param string $type
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_of_type($type)
+	{
+		return $this->get_one(array( array( 'PMD_type' => $type ) ));
+	}
+
+
+
+	/**
+	 * Overrides parent ot also check by the slug
+	 * @see EEM_Base::ensure_is_obj()
+	 * @param string|int|EE_Payment_Method $base_class_obj_or_id
+	 * @param boolean                      $ensure_is_in_db
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
+	{
+		// first: check if it's a slug
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
+				return $obj;
+			}
+		}
+		// ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
+		try {
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
+		} catch (EE_Error $e) {
+			// handle it outside the catch
+		}
+		throw new EE_Error(sprintf(__("'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso"), $base_class_obj_or_id));
+	}
+
+
+
+	/**
+	 * Gets the ID of this object, or if its a string finds the object's id
+	 * associated with that slug
+	 * @param mixed $base_obj_or_id_or_slug
+	 * @return int
+	 */
+	public function ensure_is_ID($base_obj_or_id_or_slug)
+	{
+		if (is_string($base_obj_or_id_or_slug)) {
+			// assume it's a slug
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
+		}
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
+	}
+
+
+
+	/**
+	 * Verifies the button urls on all the passed payment methods have a valid button url. If not, resets them to their default.
+	 * @param EE_Payment_Method[] $payment_methods. If NULL is provided defaults to all payment methods active in the cart
+	 */
+	public function verify_button_urls($payment_methods = null)
+	{
+		$payment_methods = is_array($payment_methods) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
+			try {
+				// If there is really no button URL at all, or if the button URLs still point to decaf folder even
+				// though this is a caffeinated install, reset it to the default.
+				$current_button_url = $payment_method->button_url();
+				if (empty($current_button_url)
+				|| (
+						strpos($current_button_url, 'decaf') !== false
+						&& strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
+					)
+				) {
+					$payment_method->save(
+						[
+							'PMD_button_url' => $payment_method->type_obj()->default_button_url()
+						]
+					);
+				}
+			} catch (EE_Error $e) {
+				$payment_method->set_active(false);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
+	 * but also verifies the payment method type of each is a usable object. If not,
+	 * deactivate it, sets a notification, and deactivates it
+	 *
+	 * @param array $rows
+	 * @return EE_Payment_Method[]
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _create_objects($rows = array())
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_methods = parent::_create_objects($rows);
+		/* @var $payment_methods EE_Payment_Method[] */
+		$usable_payment_methods = array();
+		foreach ($payment_methods as $key => $payment_method) {
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
+				$usable_payment_methods[ $key ] = $payment_method;
+				// some payment methods enqueue their scripts in EE_PMT_*::__construct
+				// which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
+				// its scripts). but for backwards-compat we should continue to do that
+				$payment_method->type_obj();
+			} elseif ($payment_method->active()) {
+				// only deactivate and notify the admin if the payment is active somewhere
+				$payment_method->deactivate();
+				$payment_method->save();
+				do_action(
+					'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
+					$payment_method
+				);
+				new PersistentAdminNotice(
+					'auto-deactivated-' . $payment_method->type(),
+					sprintf(
+						__(
+							'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
+							'event_espresso'
+						),
+						$payment_method->admin_name(),
+						'<br />',
+						'<a href="' . admin_url('plugins.php') . '">',
+						'</a>'
+					),
+					true
+				);
+			}
+		}
+		return $usable_payment_methods;
+	}
+
+
+
+	/**
+	 * Gets all the payment methods which can be used for transaction
+	 * (according to the relations between payment methods and events, and
+	 * the currencies used for the transaction and their relation to payment methods)
+	 * @param EE_Transaction $transaction
+	 * @param string    $scope @see EEM_Payment_Method::get_all_for_events
+	 * @return EE_Payment_Method[]
+	 */
+	public function get_all_for_transaction($transaction, $scope)
+	{
+		// give addons a chance to override what payment methods are chosen based on the transaction
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+			$this->get_all_active($scope, array( 'group_by' => 'PMD_type' )),
+			$transaction,
+			$scope
+		);
+	}
+
+
+	/**
+	 * Returns the payment method used for the last payment made for a registration.
+	 *
+	 * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
+	 * It will ONLY return a payment method for a PAYMENT recorded against the registration.
+	 *
+	 * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
+	 * @return EE_Payment|null
+	 */
+	public function get_last_used_for_registration($registration_or_reg_id)
+	{
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
+
+		$query_params = array(
+			0 => array(
+				'Payment.Registration.REG_ID' => $registration_id,
+			),
+			'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
+		);
+		return $this->get_one($query_params);
+	}
 }

core/db_models/EEM_Price.model.php

Doc Comments +5 added lines, -5 removed lines

@@ -66,7 +66,7 @@ 
      *      instantiate a new price object with blank/empty properties
      *
      *      @access     public
-     *      @return     mixed       array on success, FALSE on fail
+     *      @return     EE_Base_Class|null       array on success, FALSE on fail
      */
     public function get_new_price()
     {
@@ -96,7 +96,7 @@ 
      *
      * @access        public
      * @param int $EVT_ID
-     * @return array on success
+     * @return EE_Base_Class[] on success
      */
     public function get_all_event_prices($EVT_ID = 0)
     {
@@ -223,7 +223,7 @@ 
      * @access public
      * @param \EE_Price $price_a
      * @param \EE_Price $price_b
-     * @return bool false on fail
+     * @return integer false on fail
      */
     public function _sort_event_prices_by_type(EE_Price $price_a, EE_Price $price_b)
     {
@@ -241,7 +241,7 @@ 
      * @access public
      * @param \EE_Price $price_a
      * @param \EE_Price $price_b
-     * @return bool false on fail
+     * @return integer false on fail
      */
     public function _sort_event_prices_by_order(EE_Price $price_a, EE_Price $price_b)
     {
@@ -258,7 +258,7 @@ 
      *
      *      @access     public
      *      @param      int                 $type - PRT_ID
-     *      @return         boolean     false on fail
+     *      @return         EE_Base_Class[]     false on fail
      */
     public function get_all_prices_that_are_type($type = 0)
     {

Indentation +275 added lines, -275 removed lines

@@ -10,279 +10,279 @@
 class EEM_Price extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the EEM_Price object
-    protected static $_instance = null;
-
-
-
-    /**
-     *      private constructor to prevent direct creation
-     *      @Constructor
-     *      @access protected
-     *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     *      @return EEM_Price
-     */
-    protected function __construct($timezone)
-    {
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
-        $this->singular_item = __('Price', 'event_espresso');
-        $this->plural_item = __('Prices', 'event_espresso');
-
-        $this->_tables = array(
-            'Price'=>new EE_Primary_Table('esp_price', 'PRC_ID')
-        );
-        $this->_fields = array(
-            'Price'=> array(
-                'PRC_ID'=>new EE_Primary_Key_Int_Field('PRC_ID', 'Price ID'),
-                'PRT_ID'=>new EE_Foreign_Key_Int_Field('PRT_ID', 'Price type Id', false, null, 'Price_Type'),
-                'PRC_amount'=>new EE_Money_Field('PRC_amount', 'Price Amount', false, 0),
-                'PRC_name'=>new EE_Plain_Text_Field('PRC_name', 'Name of Price', false, ''),
-                'PRC_desc'=>new EE_Post_Content_Field('PRC_desc', 'Price Description', false, ''),
-                'PRC_is_default'=>new EE_Boolean_Field('PRC_is_default', 'Flag indicating whether price is a default price', false, false),
-                'PRC_overrides'=>new EE_Integer_Field('PRC_overrides', 'Price ID for a global Price that will be overridden by this Price  ( for replacing default prices )', true, 0),
-                'PRC_order'=>new EE_Integer_Field('PRC_order', 'Order of Application of Price (lower numbers apply first?)', false, 1),
-                'PRC_deleted'=>new EE_Trashed_Flag_Field('PRC_deleted', 'Flag Indicating if this has been deleted or not', false, false),
-                'PRC_parent' => new EE_Integer_Field('PRC_parent', __('Indicates what PRC_ID is the parent of this PRC_ID', 'event_espresso'), true, 0),
-                'PRC_wp_user' => new EE_WP_User_Field('PRC_wp_user', __('Price Creator ID', 'event_espresso'), false),
-            )
-        );
-        $this->_model_relations = array(
-            'Ticket'=>new EE_HABTM_Relation('Ticket_Price'),
-            'Price_Type'=>new EE_Belongs_To_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('PRC_is_default', 'Ticket.Datetime.Event');
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     *      instantiate a new price object with blank/empty properties
-     *
-     *      @access     public
-     *      @return     mixed       array on success, FALSE on fail
-     */
-    public function get_new_price()
-    {
-        return $this->create_default_object();
-    }
-
-
-
-
-
-    /**
-     *      retrieve  ALL prices from db
-     *
-     *      @access     public
-     *      @return     EE_PRice[]
-     */
-    public function get_all_prices()
-    {
-        // retrieve all prices
-        return $this->get_all(array('order_by'=>array('PRC_amount'=>'ASC')));
-    }
-
-
-
-    /**
-     *        retrieve all active prices for a particular event
-     *
-     * @access        public
-     * @param int $EVT_ID
-     * @return array on success
-     */
-    public function get_all_event_prices($EVT_ID = 0)
-    {
-        return $this->get_all(array(
-            array(
-                'EVT_ID'=>$EVT_ID,
-                'Price_Type.PBT_ID'=>array('!=',  EEM_Price_Type::base_type_tax)
-            ),
-            'order_by'=>$this->_order_by_array_for_get_all_method()
-        ));
-    }
-
-
-    /**
-     *      retrieve all active global prices (that are not taxes (PBT_ID=4)) for a particular event
-     *
-     *      @access     public
-     *      @param      boolean         $count  return count
-     *      @return         array           on success
-     *      @return         boolean     false on fail
-     */
-    public function get_all_default_prices($count = false)
-    {
-        $_where = array(
-            'Price_Type.PBT_ID'=>array('!=',4),
-            'PRC_deleted' => 0,
-            'PRC_is_default' => 1
-        );
-        $_query_params = array(
-            $_where,
-            'order_by'=>$this->_order_by_array_for_get_all_method()
-        );
-        return $count ? $this->count(array($_where)) : $this->get_all($_query_params);
-    }
-
-
-
-
-
-
-
-
-
-
-    /**
-     *      retrieve all prices that are taxes
-     *
-     *      @access     public
-     *      @return         array               on success
-     *      @return         array top-level keys are the price's order and their values are an array,
-     *                      next-level keys are the price's ID, and their values are EE_Price objects
-     */
-    public function get_all_prices_that_are_taxes()
-    {
-        $taxes = array();
-        $all_taxes = $this->get_all(array(
-            array( 'Price_Type.PBT_ID'=>  EEM_Price_Type::base_type_tax ),
-            'order_by' => array( 'Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC' )
-        ));
-        foreach ($all_taxes as $tax) {
-            if ($tax instanceof EE_Price) {
-                $taxes[ $tax->order() ][ $tax->ID() ] = $tax;
-            }
-        }
-        return $taxes;
-    }
-
-
-
-
-
-    /**
-     *      retrieve all prices for an ticket plus default global prices, but not taxes
-     *
-     *      @access     public
-     *      @param int $TKT_ID          the id of the event.  If not included then we assume that this is a new ticket.
-     *      @return         boolean         false on fail
-     */
-    public function get_all_ticket_prices_for_admin($TKT_ID = 0)
-    {
-        $array_of_price_objects = array();
-        if (empty($TKT_ID)) {
-            // if there is no tkt, get prices with no tkt ID, are global, are not a tax, and are active
-            // return that list
-            $default_prices = $this->get_all_default_prices();
-
-            if ($default_prices) {
-                foreach ($default_prices as $price) {
-                    if ($price instanceof EE_Price) {
-                        $array_of_price_objects[ $price->type() ][] = $price;
-                    }
-                }
-                return $array_of_price_objects;
-            } else {
-                return array();
-            }
-        } else {
-            $ticket_prices = $this->get_all(array(
-                array(
-                    'TKT_ID'=>$TKT_ID,
-                    'PRC_deleted' => 0
-                    ),
-                'order_by'=> array('PRC_order' => 'ASC')
-            ));
-        }
-
-        if (!empty($ticket_prices)) {
-            foreach ($ticket_prices as $price) {
-                if ($price instanceof EE_Price) {
-                    $array_of_price_objects[ $price->type() ][] = $price;
-                }
-            }
-            return $array_of_price_objects;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     *        _sort_event_prices_by_type
-     *
-     * @access public
-     * @param \EE_Price $price_a
-     * @param \EE_Price $price_b
-     * @return bool false on fail
-     */
-    public function _sort_event_prices_by_type(EE_Price $price_a, EE_Price $price_b)
-    {
-        if ($price_a->type_obj()->order() == $price_b->type_obj()->order()) {
-            return $this->_sort_event_prices_by_order($price_a, $price_b);
-        }
-        return $price_a->type_obj()->order() < $price_b->type_obj()->order() ? -1 : 1;
-    }
-
-
-
-    /**
-     *        _sort_event_prices_by_order
-     *
-     * @access public
-     * @param \EE_Price $price_a
-     * @param \EE_Price $price_b
-     * @return bool false on fail
-     */
-    public function _sort_event_prices_by_order(EE_Price $price_a, EE_Price $price_b)
-    {
-        if ($price_a->order() == $price_b->order()) {
-            return 0;
-        }
-        return $price_a->order() < $price_b->order() ? -1 : 1;
-    }
-
-
-
-    /**
-     *      get all prices of a specific type
-     *
-     *      @access     public
-     *      @param      int                 $type - PRT_ID
-     *      @return         boolean     false on fail
-     */
-    public function get_all_prices_that_are_type($type = 0)
-    {
-        return $this->get_all(array(
-            array(
-                'PRT_ID'=>$type
-            ),
-            'order_by'=>$this->_order_by_array_for_get_all_method()
-        ));
-    }
-
-
-
-    /**
-     * Returns an array of the normal 'order_by' query parameter provided to the get_all query.
-     * Of course you don't have to use it, but this is the order we usually want to sort prices by
-     * @return array which can be used like so: $this->get_all(array(array(...where stuff...),'order_by'=>$this->_order_by_array_for_get_all_method()));
-     */
-    public function _order_by_array_for_get_all_method()
-    {
-        return array(
-                'PRC_order'=>'ASC',
-                'Price_Type.PRT_order'=>'ASC',
-                'PRC_ID'=>'ASC'
-        );
-    }
+	// private instance of the EEM_Price object
+	protected static $_instance = null;
+
+
+
+	/**
+	 *      private constructor to prevent direct creation
+	 *      @Constructor
+	 *      @access protected
+	 *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 *      @return EEM_Price
+	 */
+	protected function __construct($timezone)
+	{
+		require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+		$this->singular_item = __('Price', 'event_espresso');
+		$this->plural_item = __('Prices', 'event_espresso');
+
+		$this->_tables = array(
+			'Price'=>new EE_Primary_Table('esp_price', 'PRC_ID')
+		);
+		$this->_fields = array(
+			'Price'=> array(
+				'PRC_ID'=>new EE_Primary_Key_Int_Field('PRC_ID', 'Price ID'),
+				'PRT_ID'=>new EE_Foreign_Key_Int_Field('PRT_ID', 'Price type Id', false, null, 'Price_Type'),
+				'PRC_amount'=>new EE_Money_Field('PRC_amount', 'Price Amount', false, 0),
+				'PRC_name'=>new EE_Plain_Text_Field('PRC_name', 'Name of Price', false, ''),
+				'PRC_desc'=>new EE_Post_Content_Field('PRC_desc', 'Price Description', false, ''),
+				'PRC_is_default'=>new EE_Boolean_Field('PRC_is_default', 'Flag indicating whether price is a default price', false, false),
+				'PRC_overrides'=>new EE_Integer_Field('PRC_overrides', 'Price ID for a global Price that will be overridden by this Price  ( for replacing default prices )', true, 0),
+				'PRC_order'=>new EE_Integer_Field('PRC_order', 'Order of Application of Price (lower numbers apply first?)', false, 1),
+				'PRC_deleted'=>new EE_Trashed_Flag_Field('PRC_deleted', 'Flag Indicating if this has been deleted or not', false, false),
+				'PRC_parent' => new EE_Integer_Field('PRC_parent', __('Indicates what PRC_ID is the parent of this PRC_ID', 'event_espresso'), true, 0),
+				'PRC_wp_user' => new EE_WP_User_Field('PRC_wp_user', __('Price Creator ID', 'event_espresso'), false),
+			)
+		);
+		$this->_model_relations = array(
+			'Ticket'=>new EE_HABTM_Relation('Ticket_Price'),
+			'Price_Type'=>new EE_Belongs_To_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('PRC_is_default', 'Ticket.Datetime.Event');
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 *      instantiate a new price object with blank/empty properties
+	 *
+	 *      @access     public
+	 *      @return     mixed       array on success, FALSE on fail
+	 */
+	public function get_new_price()
+	{
+		return $this->create_default_object();
+	}
+
+
+
+
+
+	/**
+	 *      retrieve  ALL prices from db
+	 *
+	 *      @access     public
+	 *      @return     EE_PRice[]
+	 */
+	public function get_all_prices()
+	{
+		// retrieve all prices
+		return $this->get_all(array('order_by'=>array('PRC_amount'=>'ASC')));
+	}
+
+
+
+	/**
+	 *        retrieve all active prices for a particular event
+	 *
+	 * @access        public
+	 * @param int $EVT_ID
+	 * @return array on success
+	 */
+	public function get_all_event_prices($EVT_ID = 0)
+	{
+		return $this->get_all(array(
+			array(
+				'EVT_ID'=>$EVT_ID,
+				'Price_Type.PBT_ID'=>array('!=',  EEM_Price_Type::base_type_tax)
+			),
+			'order_by'=>$this->_order_by_array_for_get_all_method()
+		));
+	}
+
+
+	/**
+	 *      retrieve all active global prices (that are not taxes (PBT_ID=4)) for a particular event
+	 *
+	 *      @access     public
+	 *      @param      boolean         $count  return count
+	 *      @return         array           on success
+	 *      @return         boolean     false on fail
+	 */
+	public function get_all_default_prices($count = false)
+	{
+		$_where = array(
+			'Price_Type.PBT_ID'=>array('!=',4),
+			'PRC_deleted' => 0,
+			'PRC_is_default' => 1
+		);
+		$_query_params = array(
+			$_where,
+			'order_by'=>$this->_order_by_array_for_get_all_method()
+		);
+		return $count ? $this->count(array($_where)) : $this->get_all($_query_params);
+	}
+
+
+
+
+
+
+
+
+
+
+	/**
+	 *      retrieve all prices that are taxes
+	 *
+	 *      @access     public
+	 *      @return         array               on success
+	 *      @return         array top-level keys are the price's order and their values are an array,
+	 *                      next-level keys are the price's ID, and their values are EE_Price objects
+	 */
+	public function get_all_prices_that_are_taxes()
+	{
+		$taxes = array();
+		$all_taxes = $this->get_all(array(
+			array( 'Price_Type.PBT_ID'=>  EEM_Price_Type::base_type_tax ),
+			'order_by' => array( 'Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC' )
+		));
+		foreach ($all_taxes as $tax) {
+			if ($tax instanceof EE_Price) {
+				$taxes[ $tax->order() ][ $tax->ID() ] = $tax;
+			}
+		}
+		return $taxes;
+	}
+
+
+
+
+
+	/**
+	 *      retrieve all prices for an ticket plus default global prices, but not taxes
+	 *
+	 *      @access     public
+	 *      @param int $TKT_ID          the id of the event.  If not included then we assume that this is a new ticket.
+	 *      @return         boolean         false on fail
+	 */
+	public function get_all_ticket_prices_for_admin($TKT_ID = 0)
+	{
+		$array_of_price_objects = array();
+		if (empty($TKT_ID)) {
+			// if there is no tkt, get prices with no tkt ID, are global, are not a tax, and are active
+			// return that list
+			$default_prices = $this->get_all_default_prices();
+
+			if ($default_prices) {
+				foreach ($default_prices as $price) {
+					if ($price instanceof EE_Price) {
+						$array_of_price_objects[ $price->type() ][] = $price;
+					}
+				}
+				return $array_of_price_objects;
+			} else {
+				return array();
+			}
+		} else {
+			$ticket_prices = $this->get_all(array(
+				array(
+					'TKT_ID'=>$TKT_ID,
+					'PRC_deleted' => 0
+					),
+				'order_by'=> array('PRC_order' => 'ASC')
+			));
+		}
+
+		if (!empty($ticket_prices)) {
+			foreach ($ticket_prices as $price) {
+				if ($price instanceof EE_Price) {
+					$array_of_price_objects[ $price->type() ][] = $price;
+				}
+			}
+			return $array_of_price_objects;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 *        _sort_event_prices_by_type
+	 *
+	 * @access public
+	 * @param \EE_Price $price_a
+	 * @param \EE_Price $price_b
+	 * @return bool false on fail
+	 */
+	public function _sort_event_prices_by_type(EE_Price $price_a, EE_Price $price_b)
+	{
+		if ($price_a->type_obj()->order() == $price_b->type_obj()->order()) {
+			return $this->_sort_event_prices_by_order($price_a, $price_b);
+		}
+		return $price_a->type_obj()->order() < $price_b->type_obj()->order() ? -1 : 1;
+	}
+
+
+
+	/**
+	 *        _sort_event_prices_by_order
+	 *
+	 * @access public
+	 * @param \EE_Price $price_a
+	 * @param \EE_Price $price_b
+	 * @return bool false on fail
+	 */
+	public function _sort_event_prices_by_order(EE_Price $price_a, EE_Price $price_b)
+	{
+		if ($price_a->order() == $price_b->order()) {
+			return 0;
+		}
+		return $price_a->order() < $price_b->order() ? -1 : 1;
+	}
+
+
+
+	/**
+	 *      get all prices of a specific type
+	 *
+	 *      @access     public
+	 *      @param      int                 $type - PRT_ID
+	 *      @return         boolean     false on fail
+	 */
+	public function get_all_prices_that_are_type($type = 0)
+	{
+		return $this->get_all(array(
+			array(
+				'PRT_ID'=>$type
+			),
+			'order_by'=>$this->_order_by_array_for_get_all_method()
+		));
+	}
+
+
+
+	/**
+	 * Returns an array of the normal 'order_by' query parameter provided to the get_all query.
+	 * Of course you don't have to use it, but this is the order we usually want to sort prices by
+	 * @return array which can be used like so: $this->get_all(array(array(...where stuff...),'order_by'=>$this->_order_by_array_for_get_all_method()));
+	 */
+	public function _order_by_array_for_get_all_method()
+	{
+		return array(
+				'PRC_order'=>'ASC',
+				'Price_Type.PRT_order'=>'ASC',
+				'PRC_ID'=>'ASC'
+		);
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -24,7 +24,7 @@ 
      */
     protected function __construct($timezone)
     {
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+        require_once(EE_MODELS.'EEM_Price_Type.model.php');
         $this->singular_item = __('Price', 'event_espresso');
         $this->plural_item = __('Prices', 'event_espresso');
 
@@ -52,11 +52,11 @@ 
             'WP_User' => new EE_Belongs_To_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('PRC_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Default_Public('PRC_is_default', 'Ticket.Datetime.Event');
         // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
         parent::__construct($timezone);
     }
 
@@ -103,7 +103,7 @@ 
         return $this->get_all(array(
             array(
                 'EVT_ID'=>$EVT_ID,
-                'Price_Type.PBT_ID'=>array('!=',  EEM_Price_Type::base_type_tax)
+                'Price_Type.PBT_ID'=>array('!=', EEM_Price_Type::base_type_tax)
             ),
             'order_by'=>$this->_order_by_array_for_get_all_method()
         ));
@@ -121,7 +121,7 @@ 
     public function get_all_default_prices($count = false)
     {
         $_where = array(
-            'Price_Type.PBT_ID'=>array('!=',4),
+            'Price_Type.PBT_ID'=>array('!=', 4),
             'PRC_deleted' => 0,
             'PRC_is_default' => 1
         );
@@ -153,12 +153,12 @@ 
     {
         $taxes = array();
         $all_taxes = $this->get_all(array(
-            array( 'Price_Type.PBT_ID'=>  EEM_Price_Type::base_type_tax ),
-            'order_by' => array( 'Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC' )
+            array('Price_Type.PBT_ID'=>  EEM_Price_Type::base_type_tax),
+            'order_by' => array('Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC')
         ));
         foreach ($all_taxes as $tax) {
             if ($tax instanceof EE_Price) {
-                $taxes[ $tax->order() ][ $tax->ID() ] = $tax;
+                $taxes[$tax->order()][$tax->ID()] = $tax;
             }
         }
         return $taxes;
@@ -186,7 +186,7 @@ 
             if ($default_prices) {
                 foreach ($default_prices as $price) {
                     if ($price instanceof EE_Price) {
-                        $array_of_price_objects[ $price->type() ][] = $price;
+                        $array_of_price_objects[$price->type()][] = $price;
                     }
                 }
                 return $array_of_price_objects;
@@ -203,10 +203,10 @@ 
             ));
         }
 
-        if (!empty($ticket_prices)) {
+        if ( ! empty($ticket_prices)) {
             foreach ($ticket_prices as $price) {
                 if ($price instanceof EE_Price) {
-                    $array_of_price_objects[ $price->type() ][] = $price;
+                    $array_of_price_objects[$price->type()][] = $price;
                 }
             }
             return $array_of_price_objects;

core/db_models/EEM_Price_Type.model.php

Doc Comments +2 added lines, -2 removed lines

@@ -27,7 +27,7 @@ 
     /**
      * return an array of Base types. Keys are INTs which are used in the database,
      * values are text-representations of the base type.
-     * @return array
+     * @return integer
      */
     public function get_base_types()
     {
@@ -107,7 +107,7 @@ 
      *      instantiate a new price type object with blank/empty properties
      *
      *      @access     public
-     *      @return     mixed       array on success, FALSE on fail
+     *      @return     EE_Price_Type       array on success, FALSE on fail
      */
     public function get_new_price_type()
     {

Indentation +123 added lines, -123 removed lines

@@ -11,108 +11,108 @@ 
 class EEM_Price_Type extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the Price Type object
-    protected static $_instance = null;
-    // An array of the price type objects
-    public $type = null;
-
-    /**
-    *   Price Base types
-    *
-    *   @access private
-    *   @var int
-    */
-    public $base_types = null;
-
-    /**
-     * return an array of Base types. Keys are INTs which are used in the database,
-     * values are text-representations of the base type.
-     * @return array
-     */
-    public function get_base_types()
-    {
-        return $this->base_types;
-    }
-
-    /**
-     * Gets the name of the base
-     * @param type $base_type_int
-     * @return type
-     */
-    public function get_base_type_name($base_type_int)
-    {
-        return $this->base_types[ $base_type_int ];
-    }
-
-    /**
-     * constants for price base types. In the DB, we decided to store the price base type
-     * as an integer. So, to avoid just having magic numbers everwhere (eg, querying for
-     * all price types with PBT_ID = 2), we define these constants, to make code more understandable.
-     * So, as an example, to query for all price types that are a tax, we'd do
-     * EEM_PRice_Type::instance()->get_all(array(array('PBT_ID'=>EEM_Price_Type::base_type_tax)))
-     * instead of
-     * EEM_Price_Type::instance()->get_all(array(array('PBT_ID'=>2)))
-     * Although the 2nd is shorter, it's much less obvious what it's doing. Also, should these magic IDs ever
-     * change, we can continue to use the constant, by simply change its value.
-     */
-    const base_type_base_price = 1;
-    const base_type_discount = 2;
-    const base_type_surcharge = 3;
-    const base_type_tax = 4;
-    /**
-     *      private constructor to prevent direct creation
-     *      @Constructor
-     *      @access protected
-     *      @return void
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->base_types = array(
-            EEM_Price_Type::base_type_base_price => __('Price', 'event_espresso'),
-            EEM_Price_Type::base_type_discount => __('Discount', 'event_espresso'),
-            EEM_Price_Type::base_type_surcharge => __('Surcharge', 'event_espresso'),
-            EEM_Price_Type::base_type_tax => __('Tax', 'event_espresso') );
-        $this->singular_item = __('Price Type', 'event_espresso');
-        $this->plural_item = __('Price Types', 'event_espresso');
-
-        $this->_tables = array(
-            'Price_Type'=>new EE_Primary_Table('esp_price_type', 'PRT_ID')
-        );
-        $this->_fields = array(
-            'Price_Type'=>array(
-                'PRT_ID'=>new EE_Primary_Key_Int_Field('PRT_ID', __('Price Type ID', 'event_espresso')),
-                'PRT_name'=>new EE_Plain_Text_Field('PRT_name', __('Price Type Name', 'event_espresso'), false, ''),
-                'PBT_ID'=>new EE_Enum_Integer_Field('PBT_ID', __('Price Base type ID, 1 = Price , 2 = Discount , 3 = Surcharge , 4 = Tax', 'event_espresso'), false, EEM_Price_Type::base_type_base_price, $this->base_types),
-                'PRT_is_percent'=>new EE_Boolean_Field('PRT_is_percent', __('Flag indicating price is a percentage', 'event_espresso'), false, false),
-                'PRT_order'=>new EE_Integer_Field('PRT_order', __('Order in which price should be applied. ', 'event_espresso'), false, 0),
-                'PRT_deleted'=>new EE_Trashed_Flag_Field('PRT_deleted', __('Flag indicating price type has been trashed', 'event_espresso'), false, false),
-                'PRT_wp_user' => new EE_WP_User_Field('PRT_wp_user', __('Price Type Creator ID', 'event_espresso'), false),
-            )
-        );
-        $this->_model_relations = array(
-            'Price'=>new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        // all price types are "default" in terms of capability names
-        $this->_caps_slug = 'default_price_types';
-        parent::__construct($timezone);
-    }
-
-
-
-
-    /**
-     *      instantiate a new price type object with blank/empty properties
-     *
-     *      @access     public
-     *      @return     mixed       array on success, FALSE on fail
-     */
-    public function get_new_price_type()
-    {
-        return EE_Price_Type::new_instance();
-    }
+	// private instance of the Price Type object
+	protected static $_instance = null;
+	// An array of the price type objects
+	public $type = null;
+
+	/**
+	 *   Price Base types
+	 *
+	 *   @access private
+	 *   @var int
+	 */
+	public $base_types = null;
+
+	/**
+	 * return an array of Base types. Keys are INTs which are used in the database,
+	 * values are text-representations of the base type.
+	 * @return array
+	 */
+	public function get_base_types()
+	{
+		return $this->base_types;
+	}
+
+	/**
+	 * Gets the name of the base
+	 * @param type $base_type_int
+	 * @return type
+	 */
+	public function get_base_type_name($base_type_int)
+	{
+		return $this->base_types[ $base_type_int ];
+	}
+
+	/**
+	 * constants for price base types. In the DB, we decided to store the price base type
+	 * as an integer. So, to avoid just having magic numbers everwhere (eg, querying for
+	 * all price types with PBT_ID = 2), we define these constants, to make code more understandable.
+	 * So, as an example, to query for all price types that are a tax, we'd do
+	 * EEM_PRice_Type::instance()->get_all(array(array('PBT_ID'=>EEM_Price_Type::base_type_tax)))
+	 * instead of
+	 * EEM_Price_Type::instance()->get_all(array(array('PBT_ID'=>2)))
+	 * Although the 2nd is shorter, it's much less obvious what it's doing. Also, should these magic IDs ever
+	 * change, we can continue to use the constant, by simply change its value.
+	 */
+	const base_type_base_price = 1;
+	const base_type_discount = 2;
+	const base_type_surcharge = 3;
+	const base_type_tax = 4;
+	/**
+	 *      private constructor to prevent direct creation
+	 *      @Constructor
+	 *      @access protected
+	 *      @return void
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->base_types = array(
+			EEM_Price_Type::base_type_base_price => __('Price', 'event_espresso'),
+			EEM_Price_Type::base_type_discount => __('Discount', 'event_espresso'),
+			EEM_Price_Type::base_type_surcharge => __('Surcharge', 'event_espresso'),
+			EEM_Price_Type::base_type_tax => __('Tax', 'event_espresso') );
+		$this->singular_item = __('Price Type', 'event_espresso');
+		$this->plural_item = __('Price Types', 'event_espresso');
+
+		$this->_tables = array(
+			'Price_Type'=>new EE_Primary_Table('esp_price_type', 'PRT_ID')
+		);
+		$this->_fields = array(
+			'Price_Type'=>array(
+				'PRT_ID'=>new EE_Primary_Key_Int_Field('PRT_ID', __('Price Type ID', 'event_espresso')),
+				'PRT_name'=>new EE_Plain_Text_Field('PRT_name', __('Price Type Name', 'event_espresso'), false, ''),
+				'PBT_ID'=>new EE_Enum_Integer_Field('PBT_ID', __('Price Base type ID, 1 = Price , 2 = Discount , 3 = Surcharge , 4 = Tax', 'event_espresso'), false, EEM_Price_Type::base_type_base_price, $this->base_types),
+				'PRT_is_percent'=>new EE_Boolean_Field('PRT_is_percent', __('Flag indicating price is a percentage', 'event_espresso'), false, false),
+				'PRT_order'=>new EE_Integer_Field('PRT_order', __('Order in which price should be applied. ', 'event_espresso'), false, 0),
+				'PRT_deleted'=>new EE_Trashed_Flag_Field('PRT_deleted', __('Flag indicating price type has been trashed', 'event_espresso'), false, false),
+				'PRT_wp_user' => new EE_WP_User_Field('PRT_wp_user', __('Price Type Creator ID', 'event_espresso'), false),
+			)
+		);
+		$this->_model_relations = array(
+			'Price'=>new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		// all price types are "default" in terms of capability names
+		$this->_caps_slug = 'default_price_types';
+		parent::__construct($timezone);
+	}
+
+
+
+
+	/**
+	 *      instantiate a new price type object with blank/empty properties
+	 *
+	 *      @access     public
+	 *      @return     mixed       array on success, FALSE on fail
+	 */
+	public function get_new_price_type()
+	{
+		return EE_Price_Type::new_instance();
+	}
 
 
 
@@ -131,33 +131,33 @@ 
  *
  * @param type $query_params
  * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
-     * that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
-     * which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
+ * that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
+ * which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
  * @return boolean
  */
-    public function delete_permanently($query_params = array(), $allow_blocking = true)
-    {
+	public function delete_permanently($query_params = array(), $allow_blocking = true)
+	{
 
-        $would_be_deleted_price_types = $this->get_all_deleted_and_undeleted($query_params);
-        $would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
+		$would_be_deleted_price_types = $this->get_all_deleted_and_undeleted($query_params);
+		$would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
 
-        $ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
+		$ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
 
-        // check if any prices use this price type
-        $prc_query_params = array(array('PRT_ID'=>array('IN',$would_be_deleted_price_type_ids)));
-        if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
-            $prices_names_and_ids = array();
-            foreach ($prices as $price) {
-                /* @var $price EE_Price */
-                $prices_names_and_ids[] = $price->name()."(".$price->ID().")";
-            }
-            $msg = sprintf(__('The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s', 'event_espresso'), implode(",", $prices_names_and_ids));
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
+		// check if any prices use this price type
+		$prc_query_params = array(array('PRT_ID'=>array('IN',$would_be_deleted_price_type_ids)));
+		if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
+			$prices_names_and_ids = array();
+			foreach ($prices as $price) {
+				/* @var $price EE_Price */
+				$prices_names_and_ids[] = $price->name()."(".$price->ID().")";
+			}
+			$msg = sprintf(__('The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s', 'event_espresso'), implode(",", $prices_names_and_ids));
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
 
 
 
-        return parent::delete_permanently($query_params);
-    }
+		return parent::delete_permanently($query_params);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -41,7 +41,7 @@ 
      */
     public function get_base_type_name($base_type_int)
     {
-        return $this->base_types[ $base_type_int ];
+        return $this->base_types[$base_type_int];
     }
 
     /**
@@ -94,7 +94,7 @@ 
             'WP_User' => new EE_Belongs_To_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         // all price types are "default" in terms of capability names
         $this->_caps_slug = 'default_price_types';
         parent::__construct($timezone);
@@ -141,10 +141,10 @@ 
         $would_be_deleted_price_types = $this->get_all_deleted_and_undeleted($query_params);
         $would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
 
-        $ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
+        $ID = $query_params[0][$this->get_primary_key_field()->get_name()];
 
         // check if any prices use this price type
-        $prc_query_params = array(array('PRT_ID'=>array('IN',$would_be_deleted_price_type_ids)));
+        $prc_query_params = array(array('PRT_ID'=>array('IN', $would_be_deleted_price_type_ids)));
         if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
             $prices_names_and_ids = array();
             foreach ($prices as $price) {

core/db_models/EEM_System_Status.model.php

Doc Comments +2 added lines, -4 removed lines

@@ -15,8 +15,6 @@ 
      *      This function is a singleton method used to instantiate the EEM_Attendee object
      *
      *      @access public
-     *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     *      @return EEM_System_Status
      */
     public static function instance()
     {
@@ -157,7 +155,7 @@ 
 
     /**
      *
-     * @return array like EE_Config class
+     * @return EE_Config like EE_Config class
      */
     public function get_ee_config()
     {
@@ -214,7 +212,7 @@ 
 
     /**
      * Checks if site responds ot HTTPS
-     * @return boolean
+     * @return string
      */
     public function get_https_enabled()
     {

Spacing +14 added lines, -14 removed lines

@@ -93,9 +93,9 @@ 
         $active_plugins = array_map('strtolower', $active_plugins);
         $plugin_info = array();
         foreach ($active_plugins as $plugin) {
-                $plugin_data = @get_plugin_data(WP_PLUGIN_DIR . '/' . $plugin);
+                $plugin_data = @get_plugin_data(WP_PLUGIN_DIR.'/'.$plugin);
 
-                $plugin_info[ $plugin ] = $plugin_data;
+                $plugin_info[$plugin] = $plugin_data;
         }
         return $plugin_info;
     }
@@ -108,9 +108,9 @@ 
     {
         $wp_memory_int = $this->let_to_num(WP_MEMORY_LIMIT);
         if ($wp_memory_int < 67108864) {
-            $wp_memory_to_display = '<mark class="error">' . sprintf(__('%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s', 'event_espresso'), WP_MEMORY_LIMIT, '<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">', '</a>"') . '</mark>';
+            $wp_memory_to_display = '<mark class="error">'.sprintf(__('%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s', 'event_espresso'), WP_MEMORY_LIMIT, '<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">', '</a>"').'</mark>';
         } else {
-            $wp_memory_to_display = '<mark class="yes">' . size_format($wp_memory_int) . '</mark>';
+            $wp_memory_to_display = '<mark class="yes">'.size_format($wp_memory_int).'</mark>';
         }
         return array(
             'name'=>get_bloginfo('name', 'display'),
@@ -149,7 +149,7 @@ 
         $options = EE_Data_Migration_Manager::instance()->get_all_migration_script_options();
         $presentable_migration_scripts = array();
         foreach ($options as $option_array) {
-            $presentable_migration_scripts[ str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix, "", $option_array['option_name']) ] = maybe_unserialize($option_array['option_value']);
+            $presentable_migration_scripts[str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix, "", $option_array['option_name'])] = maybe_unserialize($option_array['option_value']);
         }
         return $presentable_migration_scripts;
 //      return get_option(EE_Data_Migration_Manager::data_migrations_option_name);//EE_Data_Migration_Manager::instance()->get_data_migrations_ran();
@@ -175,18 +175,18 @@ 
 
         $pi = preg_replace(
             array('#^.*<body>(.*)</body>.*$#ms', '#<h2>PHP License</h2>.*$#ms',
-            '#<h1>Configuration</h1>#',  "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
+            '#<h1>Configuration</h1>#', "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
             "#[ \t]+#", '#&nbsp;#', '#  +#', '# class=".*?"#', '%&#039;%',
             '#<tr>(?:.*?)" src="(?:.*?)=(.*?)" alt="PHP Logo" /></a>'
             .'<h1>PHP Version (.*?)</h1>(?:\n+?)</td></tr>#',
             '#<h1><a href="(?:.*?)\?=(.*?)">PHP Credits</a></h1>#',
             '#<tr>(?:.*?)" src="(?:.*?)=(.*?)"(?:.*?)Zend Engine (.*?),(?:.*?)</tr>#',
             "# +#", '#<tr>#', '#</tr>#'),
-            array('$1', '', '', '', '</$1>' . "\n", '<', ' ', ' ', ' ', '', ' ',
+            array('$1', '', '', '', '</$1>'."\n", '<', ' ', ' ', ' ', '', ' ',
             '<h2>PHP Configuration</h2>'."\n".'<tr><td>PHP Version</td><td>$2</td></tr>'.
             "\n".'<tr><td>PHP Egg</td><td>$1</td></tr>',
             '<tr><td>PHP Credits Egg</td><td>$1</td></tr>',
-            '<tr><td>Zend Engine</td><td>$2</td></tr>' . "\n" .
+            '<tr><td>Zend Engine</td><td>$2</td></tr>'."\n".
             '<tr><td>Zend Egg</td><td>$1</td></tr>', ' ', '%S%', '%E%'),
             ob_get_clean()
         );
@@ -206,7 +206,7 @@ 
             foreach ($askapache as $m) {
                 $m2 = isset($m[2]) ? $m[2] : null;
             }
-              $pi[ $n ][ $m[1] ]=(!isset($m[3])||$m2==$m[3]) ? $m2 : array_slice($m, 2);
+              $pi[$n][$m[1]] = ( ! isset($m[3]) || $m2 == $m[3]) ? $m2 : array_slice($m, 2);
         }
 
         return $pi;
@@ -235,8 +235,8 @@ 
      */
     public function get_wp_maintenance_mode()
     {
-        $opened = file_exists(ABSPATH . '.maintenance');
-        return $opened ? sprintf(__('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>', '</strong>') : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso')  ;
+        $opened = file_exists(ABSPATH.'.maintenance');
+        return $opened ? sprintf(__('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>', '</strong>') : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso');
     }
     /**
      * Whether or not logging is enabled
@@ -244,8 +244,8 @@ 
      */
     public function get_logging_enabled()
     {
-            $opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a');
-            return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>') ;
+            $opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR.'/logs/espresso_log.txt', 'a');
+            return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>');
     }
     /**
      *  Whether curl ro fsock works
@@ -262,7 +262,7 @@ 
         } elseif ($curl_works) {
             $status = __('Your server has cURL enabled, fsockopen is disabled.', 'event_espresso');
         } else {
-            $status = __('Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.', 'event_espresso'). '</mark>';
+            $status = __('Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.', 'event_espresso').'</mark>';
         }
         return $status;
     }

Indentation +273 added lines, -273 removed lines

@@ -6,79 +6,79 @@ 
 class EEM_System_Status
 {
 
-    // private instance of the EEM_System_Status object
-    protected static $_instance = null;
+	// private instance of the EEM_System_Status object
+	protected static $_instance = null;
 
 
 
-    /**
-     *      This function is a singleton method used to instantiate the EEM_Attendee object
-     *
-     *      @access public
-     *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     *      @return EEM_System_Status
-     */
-    public static function instance()
-    {
+	/**
+	 *      This function is a singleton method used to instantiate the EEM_Attendee object
+	 *
+	 *      @access public
+	 *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 *      @return EEM_System_Status
+	 */
+	public static function instance()
+	{
 
-        // check if instance of EEM_System_Status already exists
-        if (self::$_instance === null) {
-            // instantiate EEM_System_Status
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-    private function __construct()
-    {
-    }
-    /**
-     *
-     * @return array where each key is a function name on this class, and each value is SOMETHING--
-     * it might be a value, an array, or an object
-     */
-    public function get_system_stati()
-    {
-        return apply_filters(
-            'FHEE__EEM_System_Status__get_system_stati',
-            array(
-                'ee_version'=>$this->get_ee_version(),
-                'ee_activation_history'=>$this->get_ee_activation_history(),
-                'ee_config'=>$this->get_ee_config(),
-                'ee_migration_history'=>$this->get_ee_migration_history(),
-                'active_plugins'=>$this->get_active_plugins(),
-                'wp_settings'=>$this->get_wp_settings(),
-                'wp_maintenance_mode' => $this->get_wp_maintenance_mode(),
-                'https_enabled'=>$this->get_https_enabled(),
-                'logging_enabled' => $this->get_logging_enabled(),
-                'remote_posting' => $this->get_remote_posting(),
-                'php_version'=>$this->php_version(),
-                'php.ini_settings'=>$this->get_php_ini_all(),
-                'php_info'=>$this->get_php_info(),
-            ),
-            $this
-        );
-    }
-    /**
-     *
-     * @return string
-     */
-    public function get_ee_version()
-    {
-        return espresso_version();
-    }
-    /**
-     *
-     * @return string
-     */
-    public function php_version()
-    {
-        return phpversion();
-    }
-    /**
-     *
-     * @return array, where each key is a plugin name (lower-cased), values are sub-arrays.
-     * Sub-arrays like described in wp function get_plugin_data. Ie,     *
-     *  'Name' => 'Plugin Name',
+		// check if instance of EEM_System_Status already exists
+		if (self::$_instance === null) {
+			// instantiate EEM_System_Status
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+	private function __construct()
+	{
+	}
+	/**
+	 *
+	 * @return array where each key is a function name on this class, and each value is SOMETHING--
+	 * it might be a value, an array, or an object
+	 */
+	public function get_system_stati()
+	{
+		return apply_filters(
+			'FHEE__EEM_System_Status__get_system_stati',
+			array(
+				'ee_version'=>$this->get_ee_version(),
+				'ee_activation_history'=>$this->get_ee_activation_history(),
+				'ee_config'=>$this->get_ee_config(),
+				'ee_migration_history'=>$this->get_ee_migration_history(),
+				'active_plugins'=>$this->get_active_plugins(),
+				'wp_settings'=>$this->get_wp_settings(),
+				'wp_maintenance_mode' => $this->get_wp_maintenance_mode(),
+				'https_enabled'=>$this->get_https_enabled(),
+				'logging_enabled' => $this->get_logging_enabled(),
+				'remote_posting' => $this->get_remote_posting(),
+				'php_version'=>$this->php_version(),
+				'php.ini_settings'=>$this->get_php_ini_all(),
+				'php_info'=>$this->get_php_info(),
+			),
+			$this
+		);
+	}
+	/**
+	 *
+	 * @return string
+	 */
+	public function get_ee_version()
+	{
+		return espresso_version();
+	}
+	/**
+	 *
+	 * @return string
+	 */
+	public function php_version()
+	{
+		return phpversion();
+	}
+	/**
+	 *
+	 * @return array, where each key is a plugin name (lower-cased), values are sub-arrays.
+	 * Sub-arrays like described in wp function get_plugin_data. Ie,     *
+	 *  'Name' => 'Plugin Name',
         'PluginURI' => 'Plugin URI',
         'Version' => 'Version',
         'Description' => 'Description',
@@ -87,221 +87,221 @@ 
         'TextDomain' => 'Text Domain',
         'DomainPath' => 'Domain Path',
         'Network' => 'Network',
-     */
-    public function get_active_plugins()
-    {
-        $active_plugins = (array) get_option('active_plugins', array());
-        if (is_multisite()) {
-            $active_plugins = array_merge($active_plugins, get_site_option('active_sitewide_plugins', array()));
-        }
-        $active_plugins = array_map('strtolower', $active_plugins);
-        $plugin_info = array();
-        foreach ($active_plugins as $plugin) {
-                $plugin_data = @get_plugin_data(WP_PLUGIN_DIR . '/' . $plugin);
+	 */
+	public function get_active_plugins()
+	{
+		$active_plugins = (array) get_option('active_plugins', array());
+		if (is_multisite()) {
+			$active_plugins = array_merge($active_plugins, get_site_option('active_sitewide_plugins', array()));
+		}
+		$active_plugins = array_map('strtolower', $active_plugins);
+		$plugin_info = array();
+		foreach ($active_plugins as $plugin) {
+				$plugin_data = @get_plugin_data(WP_PLUGIN_DIR . '/' . $plugin);
 
-                $plugin_info[ $plugin ] = $plugin_data;
-        }
-        return $plugin_info;
-    }
+				$plugin_info[ $plugin ] = $plugin_data;
+		}
+		return $plugin_info;
+	}
 
-    /**
-     *
-     * @return array with keys 'home_url' and 'site_url'
-     */
-    public function get_wp_settings()
-    {
-        $wp_memory_int = $this->let_to_num(WP_MEMORY_LIMIT);
-        if ($wp_memory_int < 67108864) {
-            $wp_memory_to_display = '<mark class="error">' . sprintf(__('%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s', 'event_espresso'), WP_MEMORY_LIMIT, '<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">', '</a>"') . '</mark>';
-        } else {
-            $wp_memory_to_display = '<mark class="yes">' . size_format($wp_memory_int) . '</mark>';
-        }
-        return array(
-            'name'=>get_bloginfo('name', 'display'),
-            'is_multisite'=>is_multisite(),
-            'version'=>  get_bloginfo('version', 'display'),
-            'home_url'=>home_url(),
-            'site_url'=>site_url(),
-            'WP_DEBUG'=>WP_DEBUG,
-            'permalink_structure'=>get_option('permalink_structure'),
-            'theme'=>wp_get_theme(),
-            'gmt_offset'=>get_option('gmt_offset'),
-            'timezone_string'=>get_option('timezone_string'),
-            'admin_email'=>  get_bloginfo('admin_email', 'display'),
-            'language'=>get_bloginfo('language', 'display'),
-            'wp_max_upload_size' => size_format(wp_max_upload_size()),
-            'wp_memory' => $wp_memory_to_display
-            );
-    }
+	/**
+	 *
+	 * @return array with keys 'home_url' and 'site_url'
+	 */
+	public function get_wp_settings()
+	{
+		$wp_memory_int = $this->let_to_num(WP_MEMORY_LIMIT);
+		if ($wp_memory_int < 67108864) {
+			$wp_memory_to_display = '<mark class="error">' . sprintf(__('%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s', 'event_espresso'), WP_MEMORY_LIMIT, '<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">', '</a>"') . '</mark>';
+		} else {
+			$wp_memory_to_display = '<mark class="yes">' . size_format($wp_memory_int) . '</mark>';
+		}
+		return array(
+			'name'=>get_bloginfo('name', 'display'),
+			'is_multisite'=>is_multisite(),
+			'version'=>  get_bloginfo('version', 'display'),
+			'home_url'=>home_url(),
+			'site_url'=>site_url(),
+			'WP_DEBUG'=>WP_DEBUG,
+			'permalink_structure'=>get_option('permalink_structure'),
+			'theme'=>wp_get_theme(),
+			'gmt_offset'=>get_option('gmt_offset'),
+			'timezone_string'=>get_option('timezone_string'),
+			'admin_email'=>  get_bloginfo('admin_email', 'display'),
+			'language'=>get_bloginfo('language', 'display'),
+			'wp_max_upload_size' => size_format(wp_max_upload_size()),
+			'wp_memory' => $wp_memory_to_display
+			);
+	}
 
-    /**
-     * Gets an array of information about the history of ee versions installed
-     * @return array
-     */
-    public function get_ee_activation_history()
-    {
-        return get_option('espresso_db_update');
-    }
+	/**
+	 * Gets an array of information about the history of ee versions installed
+	 * @return array
+	 */
+	public function get_ee_activation_history()
+	{
+		return get_option('espresso_db_update');
+	}
 
 
-    /**
-     * Gets an array where keys are ee versions, and their values are arrays indicating all the different times that version was installed
-     * @return EE_Data_Migration_Script_Base[]
-     */
-    public function get_ee_migration_history()
-    {
-        $options = EE_Data_Migration_Manager::instance()->get_all_migration_script_options();
-        $presentable_migration_scripts = array();
-        foreach ($options as $option_array) {
-            $presentable_migration_scripts[ str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix, "", $option_array['option_name']) ] = maybe_unserialize($option_array['option_value']);
-        }
-        return $presentable_migration_scripts;
+	/**
+	 * Gets an array where keys are ee versions, and their values are arrays indicating all the different times that version was installed
+	 * @return EE_Data_Migration_Script_Base[]
+	 */
+	public function get_ee_migration_history()
+	{
+		$options = EE_Data_Migration_Manager::instance()->get_all_migration_script_options();
+		$presentable_migration_scripts = array();
+		foreach ($options as $option_array) {
+			$presentable_migration_scripts[ str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix, "", $option_array['option_name']) ] = maybe_unserialize($option_array['option_value']);
+		}
+		return $presentable_migration_scripts;
 //      return get_option(EE_Data_Migration_Manager::data_migrations_option_name);//EE_Data_Migration_Manager::instance()->get_data_migrations_ran();
-    }
+	}
 
-    /**
-     *
-     * @return array like EE_Config class
-     */
-    public function get_ee_config()
-    {
-        return EE_Config::instance();
-    }
+	/**
+	 *
+	 * @return array like EE_Config class
+	 */
+	public function get_ee_config()
+	{
+		return EE_Config::instance();
+	}
 
-    /**
-     * Gets an array of php setup info, pilfered from http://www.php.net/manual/en/function.phpinfo.php#87463
-     * @return array like the output of phpinfo(), but in an array
-     */
-    public function get_php_info()
-    {
-        ob_start();
-        phpinfo(-1);
+	/**
+	 * Gets an array of php setup info, pilfered from http://www.php.net/manual/en/function.phpinfo.php#87463
+	 * @return array like the output of phpinfo(), but in an array
+	 */
+	public function get_php_info()
+	{
+		ob_start();
+		phpinfo(-1);
 
-        $pi = preg_replace(
-            array('#^.*<body>(.*)</body>.*$#ms', '#<h2>PHP License</h2>.*$#ms',
-            '#<h1>Configuration</h1>#',  "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
-            "#[ \t]+#", '#&nbsp;#', '#  +#', '# class=".*?"#', '%&#039;%',
-            '#<tr>(?:.*?)" src="(?:.*?)=(.*?)" alt="PHP Logo" /></a>'
-            .'<h1>PHP Version (.*?)</h1>(?:\n+?)</td></tr>#',
-            '#<h1><a href="(?:.*?)\?=(.*?)">PHP Credits</a></h1>#',
-            '#<tr>(?:.*?)" src="(?:.*?)=(.*?)"(?:.*?)Zend Engine (.*?),(?:.*?)</tr>#',
-            "# +#", '#<tr>#', '#</tr>#'),
-            array('$1', '', '', '', '</$1>' . "\n", '<', ' ', ' ', ' ', '', ' ',
-            '<h2>PHP Configuration</h2>'."\n".'<tr><td>PHP Version</td><td>$2</td></tr>'.
-            "\n".'<tr><td>PHP Egg</td><td>$1</td></tr>',
-            '<tr><td>PHP Credits Egg</td><td>$1</td></tr>',
-            '<tr><td>Zend Engine</td><td>$2</td></tr>' . "\n" .
-            '<tr><td>Zend Egg</td><td>$1</td></tr>', ' ', '%S%', '%E%'),
-            ob_get_clean()
-        );
+		$pi = preg_replace(
+			array('#^.*<body>(.*)</body>.*$#ms', '#<h2>PHP License</h2>.*$#ms',
+			'#<h1>Configuration</h1>#',  "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
+			"#[ \t]+#", '#&nbsp;#', '#  +#', '# class=".*?"#', '%&#039;%',
+			'#<tr>(?:.*?)" src="(?:.*?)=(.*?)" alt="PHP Logo" /></a>'
+			.'<h1>PHP Version (.*?)</h1>(?:\n+?)</td></tr>#',
+			'#<h1><a href="(?:.*?)\?=(.*?)">PHP Credits</a></h1>#',
+			'#<tr>(?:.*?)" src="(?:.*?)=(.*?)"(?:.*?)Zend Engine (.*?),(?:.*?)</tr>#',
+			"# +#", '#<tr>#', '#</tr>#'),
+			array('$1', '', '', '', '</$1>' . "\n", '<', ' ', ' ', ' ', '', ' ',
+			'<h2>PHP Configuration</h2>'."\n".'<tr><td>PHP Version</td><td>$2</td></tr>'.
+			"\n".'<tr><td>PHP Egg</td><td>$1</td></tr>',
+			'<tr><td>PHP Credits Egg</td><td>$1</td></tr>',
+			'<tr><td>Zend Engine</td><td>$2</td></tr>' . "\n" .
+			'<tr><td>Zend Egg</td><td>$1</td></tr>', ' ', '%S%', '%E%'),
+			ob_get_clean()
+		);
 
-        $sections = explode('<h2>', strip_tags($pi, '<h2><th><td>'));
-        unset($sections[0]);
+		$sections = explode('<h2>', strip_tags($pi, '<h2><th><td>'));
+		unset($sections[0]);
 
-        $pi = array();
-        foreach ($sections as $section) {
-            $n = substr($section, 0, strpos($section, '</h2>'));
-            preg_match_all(
-                '#%S%(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?%E%#',
-                $section,
-                $askapache,
-                PREG_SET_ORDER
-            );
-            foreach ($askapache as $m) {
-                $m2 = isset($m[2]) ? $m[2] : null;
-            }
-              $pi[ $n ][ $m[1] ]=(!isset($m[3])||$m2==$m[3]) ? $m2 : array_slice($m, 2);
-        }
+		$pi = array();
+		foreach ($sections as $section) {
+			$n = substr($section, 0, strpos($section, '</h2>'));
+			preg_match_all(
+				'#%S%(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?%E%#',
+				$section,
+				$askapache,
+				PREG_SET_ORDER
+			);
+			foreach ($askapache as $m) {
+				$m2 = isset($m[2]) ? $m[2] : null;
+			}
+			  $pi[ $n ][ $m[1] ]=(!isset($m[3])||$m2==$m[3]) ? $m2 : array_slice($m, 2);
+		}
 
-        return $pi;
-    }
+		return $pi;
+	}
 
-    /**
-     * Checks if site responds ot HTTPS
-     * @return boolean
-     */
-    public function get_https_enabled()
-    {
-        $home = str_replace("http://", "https://", home_url());
-        $response = wp_remote_get($home);
-        if ($response instanceof WP_Error) {
-            $error_string = '';
-            foreach ($response->errors as $short_name => $description_array) {
-                $error_string .= "<b>$short_name</b>: ".implode(", ", $description_array);
-            }
-            return $error_string;
-        }
-        return "ok!";
-    }
-    /**
-     * Whether or not a .maintenance file is detected
-     * @return string descripting wp_maintenance_mode status
-     */
-    public function get_wp_maintenance_mode()
-    {
-        $opened = file_exists(ABSPATH . '.maintenance');
-        return $opened ? sprintf(__('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>', '</strong>') : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso')  ;
-    }
-    /**
-     * Whether or not logging is enabled
-     * @return string descripting logging's status
-     */
-    public function get_logging_enabled()
-    {
-            $opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a');
-            return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>') ;
-    }
-    /**
-     *  Whether curl ro fsock works
-     * @return string describing posting's status
-     */
-    public function get_remote_posting()
-    {
-        $fsock_works = function_exists('fsockopen');
-        $curl_works = function_exists('curl_init');
-        if ($fsock_works && $curl_works) {
-            $status = __('Your server has fsockopen and cURL enabled.', 'event_espresso');
-        } elseif ($fsock_works) {
-            $status = __('Your server has fsockopen enabled, cURL is disabled.', 'event_espresso');
-        } elseif ($curl_works) {
-            $status = __('Your server has cURL enabled, fsockopen is disabled.', 'event_espresso');
-        } else {
-            $status = __('Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.', 'event_espresso'). '</mark>';
-        }
-        return $status;
-    }
-    /**
-     * Gets all the php.ini settings
-     * @return array
-     */
-    public function get_php_ini_all()
-    {
-        return ini_get_all();
-    }
-    /**
-     * Transforms the php.ini notation for numbers (like '2M') to an integer.
-     *
-     * @param type $size
-     * @return int
-     */
-    public function let_to_num($size)
-    {
-        $l      = substr($size, -1);
-        $ret    = substr($size, 0, -1);
-        // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
-        switch (strtoupper($l)) {
-            case 'P':
-                $ret *= 1024;
-            case 'T':
-                $ret *= 1024;
-            case 'G':
-                $ret *= 1024;
-            case 'M':
-                $ret *= 1024;
-            case 'K':
-                $ret *= 1024;
-        }
-        // phpcs:enable
-        return $ret;
-    }
+	/**
+	 * Checks if site responds ot HTTPS
+	 * @return boolean
+	 */
+	public function get_https_enabled()
+	{
+		$home = str_replace("http://", "https://", home_url());
+		$response = wp_remote_get($home);
+		if ($response instanceof WP_Error) {
+			$error_string = '';
+			foreach ($response->errors as $short_name => $description_array) {
+				$error_string .= "<b>$short_name</b>: ".implode(", ", $description_array);
+			}
+			return $error_string;
+		}
+		return "ok!";
+	}
+	/**
+	 * Whether or not a .maintenance file is detected
+	 * @return string descripting wp_maintenance_mode status
+	 */
+	public function get_wp_maintenance_mode()
+	{
+		$opened = file_exists(ABSPATH . '.maintenance');
+		return $opened ? sprintf(__('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>', '</strong>') : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso')  ;
+	}
+	/**
+	 * Whether or not logging is enabled
+	 * @return string descripting logging's status
+	 */
+	public function get_logging_enabled()
+	{
+			$opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a');
+			return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>') ;
+	}
+	/**
+	 *  Whether curl ro fsock works
+	 * @return string describing posting's status
+	 */
+	public function get_remote_posting()
+	{
+		$fsock_works = function_exists('fsockopen');
+		$curl_works = function_exists('curl_init');
+		if ($fsock_works && $curl_works) {
+			$status = __('Your server has fsockopen and cURL enabled.', 'event_espresso');
+		} elseif ($fsock_works) {
+			$status = __('Your server has fsockopen enabled, cURL is disabled.', 'event_espresso');
+		} elseif ($curl_works) {
+			$status = __('Your server has cURL enabled, fsockopen is disabled.', 'event_espresso');
+		} else {
+			$status = __('Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.', 'event_espresso'). '</mark>';
+		}
+		return $status;
+	}
+	/**
+	 * Gets all the php.ini settings
+	 * @return array
+	 */
+	public function get_php_ini_all()
+	{
+		return ini_get_all();
+	}
+	/**
+	 * Transforms the php.ini notation for numbers (like '2M') to an integer.
+	 *
+	 * @param type $size
+	 * @return int
+	 */
+	public function let_to_num($size)
+	{
+		$l      = substr($size, -1);
+		$ret    = substr($size, 0, -1);
+		// phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
+		switch (strtoupper($l)) {
+			case 'P':
+				$ret *= 1024;
+			case 'T':
+				$ret *= 1024;
+			case 'G':
+				$ret *= 1024;
+			case 'M':
+				$ret *= 1024;
+			case 'K':
+				$ret *= 1024;
+		}
+		// phpcs:enable
+		return $ret;
+	}
 }

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/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