eventespresso / event-espresso-core

core/db_models/EEM_Event.model.php

Spacing +17 added lines, -17 removed lines

@@ -278,7 +278,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();
         $this->model_chain_to_password = '';
         parent::__construct($timezone);
     }
@@ -371,7 +371,7 @@ 
      */
     public function get_all_event_question_groups($EVT_ID = 0)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
@@ -405,7 +405,7 @@ 
      */
     public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     // @codingStandardsIgnoreStart
@@ -448,7 +448,7 @@ 
      */
     public function get_question_groups_for_event($EVT_ID, EE_Registration $registration)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
@@ -867,11 +867,11 @@ 
         $questions = array();
         // get all question groups for event
         $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
+        if ( ! empty($qgs)) {
             foreach ($qgs as $qg) {
                 $qsts = $qg->questions();
-                $questions[ $qg->ID() ] = $qg->model_field_array();
-                $questions[ $qg->ID() ]['QSG_questions'] = array();
+                $questions[$qg->ID()] = $qg->model_field_array();
+                $questions[$qg->ID()]['QSG_questions'] = array();
                 foreach ($qsts as $qst) {
                     if ($qst->is_system_question()) {
                         continue;
@@ -885,26 +885,26 @@ 
                     $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
                     $qst_name = $qstn_id = $qst->ID();
                     $ans_id = $answer->ID();
-                    $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
+                    $qst_name = ! empty($ans_id) ? '['.$qst_name.']['.$ans_id.']' : '['.$qst_name.']';
                     $input_name = '';
                     $input_id = sanitize_key($qst->display_text());
                     $input_class = '';
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn'
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()] = $qst->model_field_array();
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn'
                                                                                            . $input_name
                                                                                            . $qst_name;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id.'-'.$qstn_id;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array();
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['ans_obj'] = $answer;
                     // leave responses as-is, don't convert stuff into html entities please!
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['htmlentities'] = false;
                     if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
                         $QSOs = $qst->options(true, $answer->value());
                         if (is_array($QSOs)) {
                             foreach ($QSOs as $QSO_ID => $QSO) {
-                                $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array();
+                                $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] = $QSO->model_field_array();
                             }
                         }
                     }

Indentation +951 added lines, -951 removed lines

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

core/domain/services/admin/events/data/ConfirmDeletion.php

Indentation +76 added lines, -76 removed lines

@@ -30,86 +30,86 @@
  */
 class ConfirmDeletion
 {
-    /**
-     * @var NodeGroupDao
-     */
-    private $dao;
+	/**
+	 * @var NodeGroupDao
+	 */
+	private $dao;
 
-    /**
-     * ConfirmDeletion constructor.
-     * @param NodeGroupDao $dao
-     */
-    public function __construct(
-        NodeGroupDao $dao
-    ) {
+	/**
+	 * ConfirmDeletion constructor.
+	 * @param NodeGroupDao $dao
+	 */
+	public function __construct(
+		NodeGroupDao $dao
+	) {
 
-        $this->dao = $dao;
-    }
+		$this->dao = $dao;
+	}
 
-    /**
-     * Redirects to the batch job for deleting events if the form submission is valid, otherwise back to the deletion
-     * preview page.
-     * @since 4.10.12.p
-     * @param $request_data
-     * @param $admin_base_url
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     */
-    public function handle($request_data, $admin_base_url)
-    {
-        $deletion_job_code = isset($request_data['deletion_job_code']) ? sanitize_key($request_data['deletion_job_code']) : '';
-        $models_and_ids_to_delete = $this->dao->getModelsAndIdsFromGroup($deletion_job_code);
-        $form = new ConfirmEventDeletionForm($models_and_ids_to_delete['Event']);
-        // Initialize the form from the request, and check if its valid.
-        $form->receive_form_submission($request_data);
-        if ($form->is_valid()) {
-            // Redirect the user to the deletion batch job.
-            EEH_URL::safeRedirectAndExit(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_batch',
-                        'batch' => EED_Batch::batch_job,
-                        'deletion_job_code' => $deletion_job_code,
-                        'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\ExecuteBatchDeletion'),
-                        'return_url' => urlencode(
-                            add_query_arg(
-                                [
-                                    'status' => 'trash'
-                                ],
-                                EVENTS_ADMIN_URL
-                            )
-                        )
-                    ),
-                    admin_url()
-                )
-            );
-        }
-        // Dont' use $form->submission_error_message() because it adds the form input's label in front
-        // of each validation error which ends up looking quite confusing.
-        $validation_errors = $form->get_validation_errors_accumulated();
-        foreach ($validation_errors as $validation_error) {
-            EE_Error::add_error(
-                $validation_error->getMessage(),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
+	/**
+	 * Redirects to the batch job for deleting events if the form submission is valid, otherwise back to the deletion
+	 * preview page.
+	 * @since 4.10.12.p
+	 * @param $request_data
+	 * @param $admin_base_url
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 */
+	public function handle($request_data, $admin_base_url)
+	{
+		$deletion_job_code = isset($request_data['deletion_job_code']) ? sanitize_key($request_data['deletion_job_code']) : '';
+		$models_and_ids_to_delete = $this->dao->getModelsAndIdsFromGroup($deletion_job_code);
+		$form = new ConfirmEventDeletionForm($models_and_ids_to_delete['Event']);
+		// Initialize the form from the request, and check if its valid.
+		$form->receive_form_submission($request_data);
+		if ($form->is_valid()) {
+			// Redirect the user to the deletion batch job.
+			EEH_URL::safeRedirectAndExit(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_batch',
+						'batch' => EED_Batch::batch_job,
+						'deletion_job_code' => $deletion_job_code,
+						'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\ExecuteBatchDeletion'),
+						'return_url' => urlencode(
+							add_query_arg(
+								[
+									'status' => 'trash'
+								],
+								EVENTS_ADMIN_URL
+							)
+						)
+					),
+					admin_url()
+				)
+			);
+		}
+		// Dont' use $form->submission_error_message() because it adds the form input's label in front
+		// of each validation error which ends up looking quite confusing.
+		$validation_errors = $form->get_validation_errors_accumulated();
+		foreach ($validation_errors as $validation_error) {
+			EE_Error::add_error(
+				$validation_error->getMessage(),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
 
-        EEH_URL::safeRedirectAndExit(
-            EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'action' => 'preview_deletion',
-                    'deletion_job_code' => $deletion_job_code
-                ],
-                $admin_base_url
-            )
-        );
-    }
+		EEH_URL::safeRedirectAndExit(
+			EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'action' => 'preview_deletion',
+					'deletion_job_code' => $deletion_job_code
+				],
+				$admin_base_url
+			)
+		);
+	}
 }
 // End of file ConfirmDeletion.php
 // Location: EventEspresso\core\domain\services\admin\events\data/ConfirmDeletion.php

core/db_models/helpers/EE_Table_Base.php

Spacing +5 added lines, -5 removed lines

@@ -93,7 +93,7 @@ 
      */
     public function get_table_name()
     {
-        return $this->get_table_prefix() . $this->_table_name;
+        return $this->get_table_prefix().$this->_table_name;
     }
 
 
@@ -105,7 +105,7 @@ 
      */
     public function get_table_alias()
     {
-        if (! $this->_table_alias) {
+        if ( ! $this->_table_alias) {
             throw new EE_Error("You must call _construct_finalize_with_alias before using the EE_Table_Base. Did you forget to call parent::__construct at the end of your EEMerimental_Base child's __construct?");
         }
         return $this->_table_alias;
@@ -128,7 +128,7 @@ 
      */
     public function get_fully_qualified_pk_column()
     {
-        return $this->get_table_alias() . "." . $this->get_pk_column();
+        return $this->get_table_alias().".".$this->get_pk_column();
     }
 
 
@@ -139,8 +139,8 @@ 
      */
     public function get_select_join_limit($limit)
     {
-        $limit = is_array($limit) ? 'LIMIT ' . implode(',', array_map('intval', $limit)) : 'LIMIT ' . (int) $limit;
-        return SP . '(SELECT * FROM ' . $this->_table_name . SP . $limit . ') AS ' . $this->_table_alias;
+        $limit = is_array($limit) ? 'LIMIT '.implode(',', array_map('intval', $limit)) : 'LIMIT '.(int) $limit;
+        return SP.'(SELECT * FROM '.$this->_table_name.SP.$limit.') AS '.$this->_table_alias;
     }
 
 

Indentation +147 added lines, -147 removed lines

@@ -6,151 +6,151 @@
  */
 abstract class EE_Table_Base
 {
-    /**
-     * This holds the table_name without the table prefix.
-     *
-     * @var string
-     */
-    public $_table_name;
-
-
-    /**
-     * This holds what is used as the alias for the table in queries.
-     *
-     * @var string
-     */
-    public $_table_alias;
-
-
-    /**
-     * Table's private key column
-     *
-     * @var string
-     */
-    protected $_pk_column;
-
-
-    /**
-     * Whether this table is a global table (in multisite) or specific to site.
-     *
-     * @var bool
-     */
-    protected $_global;
-
-
-    /**
-     * @param string  $table_name with or without wpdb prefix
-     * @param string  $pk_column
-     * @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
-     * @global wpdb   $wpdb
-     */
-    public function __construct($table_name, $pk_column, $global = false)
-    {
-        $this->_global = $global;
-        $prefix        = $this->get_table_prefix();
-        // if they added the prefix, let's remove it because we delay adding the prefix until right when its needed.
-        if (strpos($table_name, $prefix) === 0) {
-            $table_name = substr_replace($table_name, '', 0, strlen($prefix));
-        }
-        $this->_table_name = $table_name;
-        $this->_pk_column  = $pk_column;
-    }
-
-
-    /**
-     * This returns the table prefix for the current model state.
-     *
-     * @return string
-     * @global wpdb $wpdb
-     */
-    public function get_table_prefix()
-    {
-        global $wpdb;
-        if ($this->_global) {
-            return $wpdb->base_prefix;
-        }
-        return $wpdb->get_blog_prefix(EEM_Base::get_model_query_blog_id());
-    }
-
-
-    /**
-     * Used to set the table_alias property
-     *
-     * @param string $table_alias
-     */
-    public function _construct_finalize_with_alias($table_alias)
-    {
-        $this->_table_alias = $table_alias;
-    }
-
-
-    /**
-     * Returns the fully qualified table name for the database (includes the table prefix current for the blog).
-     *
-     * @return string
-     */
-    public function get_table_name()
-    {
-        return $this->get_table_prefix() . $this->_table_name;
-    }
-
-
-    /**
-     * Provides what is currently set as the alias for the table to be used in queries.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_table_alias()
-    {
-        if (! $this->_table_alias) {
-            throw new EE_Error("You must call _construct_finalize_with_alias before using the EE_Table_Base. Did you forget to call parent::__construct at the end of your EEMerimental_Base child's __construct?");
-        }
-        return $this->_table_alias;
-    }
-
-
-    /**
-     * @return string name of column of PK
-     */
-    public function get_pk_column()
-    {
-        return $this->_pk_column;
-    }
-
-
-    /**
-     * returns a string with the table alias, a period, and the private key's column.
-     *
-     * @return string
-     */
-    public function get_fully_qualified_pk_column()
-    {
-        return $this->get_table_alias() . "." . $this->get_pk_column();
-    }
-
-
-    /**
-     * returns the special sql for a inner select with a limit.
-     *
-     * @return string    SQL select
-     */
-    public function get_select_join_limit($limit)
-    {
-        $limit = is_array($limit) ? 'LIMIT ' . implode(',', array_map('intval', $limit)) : 'LIMIT ' . (int) $limit;
-        return SP . '(SELECT * FROM ' . $this->_table_name . SP . $limit . ') AS ' . $this->_table_alias;
-    }
-
-
-    /**
-     * Returns whether or not htis is a global table (ie, on multisite there's
-     * only one of these tables, on the main blog)
-     *
-     * @return boolean
-     */
-    public function is_global()
-    {
-        return $this->_global;
-    }
+	/**
+	 * This holds the table_name without the table prefix.
+	 *
+	 * @var string
+	 */
+	public $_table_name;
+
+
+	/**
+	 * This holds what is used as the alias for the table in queries.
+	 *
+	 * @var string
+	 */
+	public $_table_alias;
+
+
+	/**
+	 * Table's private key column
+	 *
+	 * @var string
+	 */
+	protected $_pk_column;
+
+
+	/**
+	 * Whether this table is a global table (in multisite) or specific to site.
+	 *
+	 * @var bool
+	 */
+	protected $_global;
+
+
+	/**
+	 * @param string  $table_name with or without wpdb prefix
+	 * @param string  $pk_column
+	 * @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
+	 * @global wpdb   $wpdb
+	 */
+	public function __construct($table_name, $pk_column, $global = false)
+	{
+		$this->_global = $global;
+		$prefix        = $this->get_table_prefix();
+		// if they added the prefix, let's remove it because we delay adding the prefix until right when its needed.
+		if (strpos($table_name, $prefix) === 0) {
+			$table_name = substr_replace($table_name, '', 0, strlen($prefix));
+		}
+		$this->_table_name = $table_name;
+		$this->_pk_column  = $pk_column;
+	}
+
+
+	/**
+	 * This returns the table prefix for the current model state.
+	 *
+	 * @return string
+	 * @global wpdb $wpdb
+	 */
+	public function get_table_prefix()
+	{
+		global $wpdb;
+		if ($this->_global) {
+			return $wpdb->base_prefix;
+		}
+		return $wpdb->get_blog_prefix(EEM_Base::get_model_query_blog_id());
+	}
+
+
+	/**
+	 * Used to set the table_alias property
+	 *
+	 * @param string $table_alias
+	 */
+	public function _construct_finalize_with_alias($table_alias)
+	{
+		$this->_table_alias = $table_alias;
+	}
+
+
+	/**
+	 * Returns the fully qualified table name for the database (includes the table prefix current for the blog).
+	 *
+	 * @return string
+	 */
+	public function get_table_name()
+	{
+		return $this->get_table_prefix() . $this->_table_name;
+	}
+
+
+	/**
+	 * Provides what is currently set as the alias for the table to be used in queries.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_table_alias()
+	{
+		if (! $this->_table_alias) {
+			throw new EE_Error("You must call _construct_finalize_with_alias before using the EE_Table_Base. Did you forget to call parent::__construct at the end of your EEMerimental_Base child's __construct?");
+		}
+		return $this->_table_alias;
+	}
+
+
+	/**
+	 * @return string name of column of PK
+	 */
+	public function get_pk_column()
+	{
+		return $this->_pk_column;
+	}
+
+
+	/**
+	 * returns a string with the table alias, a period, and the private key's column.
+	 *
+	 * @return string
+	 */
+	public function get_fully_qualified_pk_column()
+	{
+		return $this->get_table_alias() . "." . $this->get_pk_column();
+	}
+
+
+	/**
+	 * returns the special sql for a inner select with a limit.
+	 *
+	 * @return string    SQL select
+	 */
+	public function get_select_join_limit($limit)
+	{
+		$limit = is_array($limit) ? 'LIMIT ' . implode(',', array_map('intval', $limit)) : 'LIMIT ' . (int) $limit;
+		return SP . '(SELECT * FROM ' . $this->_table_name . SP . $limit . ') AS ' . $this->_table_alias;
+	}
+
+
+	/**
+	 * Returns whether or not htis is a global table (ie, on multisite there's
+	 * only one of these tables, on the main blog)
+	 *
+	 * @return boolean
+	 */
+	public function is_global()
+	{
+		return $this->_global;
+	}
 }

core/domain/DomainFactory.php

Spacing +2 added lines, -2 removed lines

@@ -39,7 +39,7 @@ 
      */
     public static function getShared(FullyQualifiedName $domain_fqcn, array $arguments)
     {
-        if (! isset($arguments[0], $arguments[1])) {
+        if ( ! isset($arguments[0], $arguments[1])) {
             throw new InvalidArgumentException(
                 esc_html__(
                     'You need to pass at least two arguments, representing the addon plugin file and version, in order to generate a Domain class',
@@ -49,7 +49,7 @@ 
         }
         /** @var DomainInterface $domain */
         $domain = LoaderFactory::getLoader()->getShared($domain_fqcn, $arguments);
-        if (! $domain instanceof $domain_fqcn && ! $domain instanceof DomainBase) {
+        if ( ! $domain instanceof $domain_fqcn && ! $domain instanceof DomainBase) {
             throw new DomainException(
                 sprintf(
                     esc_html__(

Indentation +56 added lines, -56 removed lines

@@ -22,62 +22,62 @@
  */
 class DomainFactory
 {
-    /**
-     * @param FullyQualifiedName $domain_fqcn   [required] Fully Qualified Class Name for the Domain class
-     * @param array $arguments                  [required] array of arguments to be passed to the Domain class
-     *                                          constructor. Must at least include the following two value objects:
-     *                                          array(
-     *                                              EventEspresso\core\domain\values\FilePath $plugin_file
-     *                                              EventEspresso\core\domain\values\Version $version
-     *                                          )
-     * @return DomainInterface
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function getShared(FullyQualifiedName $domain_fqcn, array $arguments)
-    {
-        if (! isset($arguments[0], $arguments[1])) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'You need to pass at least two arguments, representing the addon plugin file and version, in order to generate a Domain class',
-                    'event_espresso'
-                )
-            );
-        }
-        /** @var DomainInterface $domain */
-        $domain = LoaderFactory::getLoader()->getShared($domain_fqcn, $arguments);
-        if (! $domain instanceof $domain_fqcn && ! $domain instanceof DomainBase) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The requested Domain class "%1$s" could not be loaded.',
-                        'event_espresso'
-                    ),
-                    $domain_fqcn
-                )
-            );
-        }
-        return $domain;
-    }
+	/**
+	 * @param FullyQualifiedName $domain_fqcn   [required] Fully Qualified Class Name for the Domain class
+	 * @param array $arguments                  [required] array of arguments to be passed to the Domain class
+	 *                                          constructor. Must at least include the following two value objects:
+	 *                                          array(
+	 *                                              EventEspresso\core\domain\values\FilePath $plugin_file
+	 *                                              EventEspresso\core\domain\values\Version $version
+	 *                                          )
+	 * @return DomainInterface
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getShared(FullyQualifiedName $domain_fqcn, array $arguments)
+	{
+		if (! isset($arguments[0], $arguments[1])) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'You need to pass at least two arguments, representing the addon plugin file and version, in order to generate a Domain class',
+					'event_espresso'
+				)
+			);
+		}
+		/** @var DomainInterface $domain */
+		$domain = LoaderFactory::getLoader()->getShared($domain_fqcn, $arguments);
+		if (! $domain instanceof $domain_fqcn && ! $domain instanceof DomainBase) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The requested Domain class "%1$s" could not be loaded.',
+						'event_espresso'
+					),
+					$domain_fqcn
+				)
+			);
+		}
+		return $domain;
+	}
 
 
-    /**
-     * @return Domain
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     * @throws InvalidInterfaceException
-     */
-    public static function getEventEspressoCoreDomain()
-    {
-        $domain = new Domain(
-            new FilePath(EVENT_ESPRESSO_MAIN_FILE),
-            Version::fromString(espresso_version())
-        );
-        LoaderFactory::getLoader()->share('EventEspresso\core\domain\Domain', $domain);
-        return $domain;
-    }
+	/**
+	 * @return Domain
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getEventEspressoCoreDomain()
+	{
+		$domain = new Domain(
+			new FilePath(EVENT_ESPRESSO_MAIN_FILE),
+			Version::fromString(espresso_version())
+		);
+		LoaderFactory::getLoader()->share('EventEspresso\core\domain\Domain', $domain);
+		return $domain;
+	}
 }

core/libraries/plugin_api/EE_Register_Personal_Data_Exporter.lib.php

Spacing +2 added lines, -2 removed lines

@@ -28,7 +28,7 @@ 
      */
     public static function register($identifier = '', array $setup_args = [])
     {
-        self::$exporters[ $identifier ] = $setup_args;
+        self::$exporters[$identifier] = $setup_args;
         // add to list of modules to be registered
         add_filter(
             'FHEE__EventEspresso_core_services_privacy_export_PersonalDataExporterManager__exporters',
@@ -42,7 +42,7 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$exporters[ $identifier ]);
+        unset(self::$exporters[$identifier]);
     }
 
 

Indentation +43 added lines, -43 removed lines

@@ -12,55 +12,55 @@
  */
 class EE_Register_Personal_Data_Exporter implements EEI_Plugin_API
 {
-    /**
-     * FQCN for all privacy policy generators
-     *
-     * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
-     */
-    protected static $exporters = [];
+	/**
+	 * FQCN for all privacy policy generators
+	 *
+	 * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
+	 */
+	protected static $exporters = [];
 
 
-    /**
-     * @param string $identifier
-     * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
-     *                           OR fully qualified class names of privacy policies
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        self::$exporters[ $identifier ] = $setup_args;
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EventEspresso_core_services_privacy_export_PersonalDataExporterManager__exporters',
-            ['EE_Register_Personal_Data_Exporter', 'addExporters']
-        );
-    }
+	/**
+	 * @param string $identifier
+	 * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
+	 *                           OR fully qualified class names of privacy policies
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		self::$exporters[ $identifier ] = $setup_args;
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EventEspresso_core_services_privacy_export_PersonalDataExporterManager__exporters',
+			['EE_Register_Personal_Data_Exporter', 'addExporters']
+		);
+	}
 
 
-    /**
-     * @param string $identifier
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$exporters[ $identifier ]);
-    }
+	/**
+	 * @param string $identifier
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$exporters[ $identifier ]);
+	}
 
 
-    /**
-     * Adds our personal data exporters registered by add-ons
-     *
-     * @param string[] $exporters
-     * @return string[]
-     */
-    public static function addExporters(array $exporters)
-    {
-        foreach (self::$exporters as $exporters_per_addon) {
-            $exporters = array_merge(
-                $exporters,
-                $exporters_per_addon
-            );
-        }
-        return $exporters;
-    }
+	/**
+	 * Adds our personal data exporters registered by add-ons
+	 *
+	 * @param string[] $exporters
+	 * @return string[]
+	 */
+	public static function addExporters(array $exporters)
+	{
+		foreach (self::$exporters as $exporters_per_addon) {
+			$exporters = array_merge(
+				$exporters,
+				$exporters_per_addon
+			);
+		}
+		return $exporters;
+	}
 }
 // End of file EE_Register_Personal_Data_Exporter.lib.php
 // Location: ${NAMESPACE}/EE_Register_Personal_Data_Exporter.lib.php

core/libraries/plugin_api/EE_Register_Personal_Data_Eraser.lib.php

Spacing +2 added lines, -2 removed lines

@@ -28,7 +28,7 @@ 
      */
     public static function register($identifier = '', array $setup_args = [])
     {
-        self::$erasers[ $identifier ] = $setup_args;
+        self::$erasers[$identifier] = $setup_args;
         // add to list of modules to be registered
         add_filter(
             'FHEE__EventEspresso_core_services_privacy_erasure_PersonalDataEraserManager__erasers',
@@ -42,7 +42,7 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$erasers[ $identifier ]);
+        unset(self::$erasers[$identifier]);
     }
 
 

Indentation +43 added lines, -43 removed lines

@@ -12,55 +12,55 @@
  */
 class EE_Register_Personal_Data_Eraser implements EEI_Plugin_API
 {
-    /**
-     * FQCN for all privacy policy generators
-     *
-     * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
-     */
-    protected static $erasers = [];
+	/**
+	 * FQCN for all privacy policy generators
+	 *
+	 * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
+	 */
+	protected static $erasers = [];
 
 
-    /**
-     * @param string $identifier
-     * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
-     *                           OR fully qualified class names of privacy policies
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        self::$erasers[ $identifier ] = $setup_args;
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EventEspresso_core_services_privacy_erasure_PersonalDataEraserManager__erasers',
-            ['EE_Register_Personal_Data_Eraser', 'addErasers']
-        );
-    }
+	/**
+	 * @param string $identifier
+	 * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
+	 *                           OR fully qualified class names of privacy policies
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		self::$erasers[ $identifier ] = $setup_args;
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EventEspresso_core_services_privacy_erasure_PersonalDataEraserManager__erasers',
+			['EE_Register_Personal_Data_Eraser', 'addErasers']
+		);
+	}
 
 
-    /**
-     * @param string $identifier
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$erasers[ $identifier ]);
-    }
+	/**
+	 * @param string $identifier
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$erasers[ $identifier ]);
+	}
 
 
-    /**
-     * Adds our personal data erasers registered by add-ons
-     *
-     * @param string[] $erasers
-     * @return string[]
-     */
-    public static function addErasers(array $erasers)
-    {
-        foreach (self::$erasers as $erasers_per_addon) {
-            $erasers = array_merge(
-                $erasers,
-                $erasers_per_addon
-            );
-        }
-        return $erasers;
-    }
+	/**
+	 * Adds our personal data erasers registered by add-ons
+	 *
+	 * @param string[] $erasers
+	 * @return string[]
+	 */
+	public static function addErasers(array $erasers)
+	{
+		foreach (self::$erasers as $erasers_per_addon) {
+			$erasers = array_merge(
+				$erasers,
+				$erasers_per_addon
+			);
+		}
+		return $erasers;
+	}
 }
 // End of file EE_Register_Personal_Data_Eraser.lib.php
 // Location: ${NAMESPACE}/EE_Register_Personal_Data_Eraser.lib.php

core/libraries/plugin_api/EE_Register_Privacy_Policy.lib.php

Spacing +2 added lines, -2 removed lines

@@ -28,7 +28,7 @@ 
      */
     public static function register($identifier = '', array $setup_args = [])
     {
-        self::$privacy_policies[ $identifier ] = $setup_args;
+        self::$privacy_policies[$identifier] = $setup_args;
         // add to list of modules to be registered
         add_filter(
             'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
@@ -42,7 +42,7 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$privacy_policies[ $identifier ]);
+        unset(self::$privacy_policies[$identifier]);
     }
 
 

Indentation +43 added lines, -43 removed lines

@@ -12,55 +12,55 @@
  */
 class EE_Register_Privacy_Policy implements EEI_Plugin_API
 {
-    /**
-     * FQCN for all privacy policy generators
-     *
-     * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
-     */
-    protected static $privacy_policies = array();
+	/**
+	 * FQCN for all privacy policy generators
+	 *
+	 * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
+	 */
+	protected static $privacy_policies = array();
 
 
-    /**
-     * @param string $identifier
-     * @param array $setup_args can be the fully qualified namespaces each containing only privacy policies,
-     *              OR fully qualified class names of privacy policies
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        self::$privacy_policies[ $identifier ] = $setup_args;
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
-            array('EE_Register_Privacy_Policy', 'addPrivacyPolicies')
-        );
-    }
+	/**
+	 * @param string $identifier
+	 * @param array $setup_args can be the fully qualified namespaces each containing only privacy policies,
+	 *              OR fully qualified class names of privacy policies
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		self::$privacy_policies[ $identifier ] = $setup_args;
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
+			array('EE_Register_Privacy_Policy', 'addPrivacyPolicies')
+		);
+	}
 
 
-    /**
-     * @param string $identifier
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$privacy_policies[ $identifier ]);
-    }
+	/**
+	 * @param string $identifier
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$privacy_policies[ $identifier ]);
+	}
 
 
-    /**
-     * Adds our privacy policy generators registered by add-ons
-     *
-     * @param string[] $privacy_policies
-     * @return string[]
-     */
-    public static function addPrivacyPolicies(array $privacy_policies)
-    {
-        foreach (self::$privacy_policies as $privacy_policies_per_addon) {
-            $privacy_policies = array_merge(
-                $privacy_policies,
-                $privacy_policies_per_addon
-            );
-        }
-        return $privacy_policies;
-    }
+	/**
+	 * Adds our privacy policy generators registered by add-ons
+	 *
+	 * @param string[] $privacy_policies
+	 * @return string[]
+	 */
+	public static function addPrivacyPolicies(array $privacy_policies)
+	{
+		foreach (self::$privacy_policies as $privacy_policies_per_addon) {
+			$privacy_policies = array_merge(
+				$privacy_policies,
+				$privacy_policies_per_addon
+			);
+		}
+		return $privacy_policies;
+	}
 }
 // End of file EE_Register_Privacy_Policy.lib.php
 // Location: ${NAMESPACE}/EE_Register_Privacy_Policy.lib.php

core/services/progress_steps/ProgressStepManager.php

Spacing +9 added lines, -9 removed lines

@@ -75,11 +75,11 @@ 
         $this->setDisplayStrategy($display_strategy_name);
         $this->setDefaultStep($default_step);
         $this->setFormStepUrlKey($form_step_url_key);
-        if (! $collection instanceof CollectionInterface) {
+        if ( ! $collection instanceof CollectionInterface) {
             $collection = new Collection('\EventEspresso\core\services\progress_steps\ProgressStepInterface');
         }
         $this->collection = $collection;
-        if (! $request instanceof RequestInterface) {
+        if ( ! $request instanceof RequestInterface) {
             /** @var RequestInterface $request */
             $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
         }
@@ -94,23 +94,23 @@ 
      */
     protected function setDisplayStrategy($display_strategy_name = 'number_bubbles')
     {
-        if (! is_string($display_strategy_name)) {
+        if ( ! is_string($display_strategy_name)) {
             throw new InvalidDataTypeException('$display_strategy_name', $display_strategy_name, 'string');
         }
         // build up FQCN from incoming display strategy folder name
         $display_strategy_class = 'EventEspresso\core\services\progress_steps\display_strategies\\';
-        $display_strategy_class .= $display_strategy_name . '\\';
+        $display_strategy_class .= $display_strategy_name.'\\';
         $display_strategy_class .= str_replace(' ', '', ucwords(str_replace('_', ' ', $display_strategy_name)));
         $display_strategy_class .= 'ProgressStepsDisplay';
         $display_strategy_class = apply_filters(
             'FHEE__ProgressStepManager__setDisplayStrategy__display_strategy_class',
             $display_strategy_class
         );
-        if (! class_exists($display_strategy_class)) {
+        if ( ! class_exists($display_strategy_class)) {
             throw new InvalidClassException($display_strategy_class);
         }
         $display_strategy = new $display_strategy_class();
-        if (! $display_strategy instanceof ProgressStepsDisplayInterface) {
+        if ( ! $display_strategy instanceof ProgressStepsDisplayInterface) {
             throw new InvalidClassException(
                 $display_strategy_class,
                 sprintf(
@@ -130,7 +130,7 @@ 
      */
     public function setDefaultStep($default_step)
     {
-        if (! is_string($default_step)) {
+        if ( ! is_string($default_step)) {
             throw new InvalidDataTypeException('$default_step', $default_step, 'string');
         }
         $this->default_step = $default_step;
@@ -143,7 +143,7 @@ 
      */
     public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
     {
-        if (! is_string($form_step_url_key)) {
+        if ( ! is_string($form_step_url_key)) {
             throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
         }
         $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
@@ -163,7 +163,7 @@ 
         // grab the step previously known as current, in case we need to revert
         $current_current_step = $this->collection->current();
         // verify that requested step exists
-        if (! $this->collection->has($step)) {
+        if ( ! $this->collection->has($step)) {
             throw new InvalidIdentifierException($step, $this->default_step);
         }
         if ($this->collection->setCurrent($step)) {

Indentation +221 added lines, -221 removed lines

@@ -26,225 +26,225 @@
  */
 class ProgressStepManager
 {
-    /**
-     * @var ProgressStepInterface[]
-     */
-    private $collection;
-
-    /**
-     * @var string
-     */
-    private $default_step;
-
-    /**
-     * the key used for the URL param that denotes the current form step
-     * defaults to 'ee-form-step'
-     *
-     * @var string
-     */
-    private $form_step_url_key = '';
-
-    /**
-     * @var ProgressStepsDisplayInterface
-     */
-    private $display_strategy;
-
-    /**
-     * @var RequestInterface
-     */
-    private $request;
-
-
-    /**
-     * ProgressStepManager constructor
-     *
-     * @param string              $display_strategy_name
-     * @param string              $default_step
-     * @param string              $form_step_url_key
-     * @param CollectionInterface $collection
-     * @param RequestInterface    $request
-     */
-    public function __construct(
-        $display_strategy_name = 'number_bubbles',
-        $default_step = '',
-        $form_step_url_key = '',
-        CollectionInterface $collection = null,
-        RequestInterface $request = null
-    ) {
-        $this->setDisplayStrategy($display_strategy_name);
-        $this->setDefaultStep($default_step);
-        $this->setFormStepUrlKey($form_step_url_key);
-        if (! $collection instanceof CollectionInterface) {
-            $collection = new Collection('\EventEspresso\core\services\progress_steps\ProgressStepInterface');
-        }
-        $this->collection = $collection;
-        if (! $request instanceof RequestInterface) {
-            /** @var RequestInterface $request */
-            $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
-        }
-        $this->request = $request;
-    }
-
-
-    /**
-     * @param string $display_strategy_name
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    protected function setDisplayStrategy($display_strategy_name = 'number_bubbles')
-    {
-        if (! is_string($display_strategy_name)) {
-            throw new InvalidDataTypeException('$display_strategy_name', $display_strategy_name, 'string');
-        }
-        // build up FQCN from incoming display strategy folder name
-        $display_strategy_class = 'EventEspresso\core\services\progress_steps\display_strategies\\';
-        $display_strategy_class .= $display_strategy_name . '\\';
-        $display_strategy_class .= str_replace(' ', '', ucwords(str_replace('_', ' ', $display_strategy_name)));
-        $display_strategy_class .= 'ProgressStepsDisplay';
-        $display_strategy_class = apply_filters(
-            'FHEE__ProgressStepManager__setDisplayStrategy__display_strategy_class',
-            $display_strategy_class
-        );
-        if (! class_exists($display_strategy_class)) {
-            throw new InvalidClassException($display_strategy_class);
-        }
-        $display_strategy = new $display_strategy_class();
-        if (! $display_strategy instanceof ProgressStepsDisplayInterface) {
-            throw new InvalidClassException(
-                $display_strategy_class,
-                sprintf(
-                    esc_html__('The "%1$s" Class needs to be an implementation of the "%1$s" Interface.', 'event_espresso'),
-                    $display_strategy_class,
-                    '\EventEspresso\core\services\progress_steps\display_strategies\ProgressStepsDisplayInterface'
-                )
-            );
-        }
-        $this->display_strategy = $display_strategy;
-    }
-
-
-    /**
-     * @param string $default_step
-     * @throws InvalidDataTypeException
-     */
-    public function setDefaultStep($default_step)
-    {
-        if (! is_string($default_step)) {
-            throw new InvalidDataTypeException('$default_step', $default_step, 'string');
-        }
-        $this->default_step = $default_step;
-    }
-
-
-    /**
-     * @param string $form_step_url_key
-     * @throws InvalidDataTypeException
-     */
-    public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
-    {
-        if (! is_string($form_step_url_key)) {
-            throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
-        }
-        $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
-    }
-
-
-    /**
-     * @param string $step
-     * @throws InvalidIdentifierException
-     */
-    public function setCurrentStep($step = '')
-    {
-        // use incoming value if it's set, otherwise use request param if it's set, otherwise use default
-        $step = ! empty($step)
-            ? $step
-            : $this->request->getRequestParam($this->form_step_url_key, $this->default_step);
-        // grab the step previously known as current, in case we need to revert
-        $current_current_step = $this->collection->current();
-        // verify that requested step exists
-        if (! $this->collection->has($step)) {
-            throw new InvalidIdentifierException($step, $this->default_step);
-        }
-        if ($this->collection->setCurrent($step)) {
-            // if the old boss is the same as the new boss, then nothing changes
-            if ($this->collection->current() !== $current_current_step) {
-                $current_current_step->setIsCurrent(false);
-            }
-            $this->collection->current()->setIsCurrent();
-        } else {
-            $this->collection->setCurrent($current_current_step->id());
-            $current_current_step->setIsCurrent(true);
-        }
-    }
-
-
-    /**
-     * setPreviousStepsCompleted
-     */
-    public function setPreviousStepsCompleted()
-    {
-        $current_current_step = $this->collection->current();
-        $this->collection->rewind();
-        while ($this->collection->valid()) {
-            if ($this->collection->current() === $current_current_step) {
-                break;
-            }
-            $this->setCurrentStepCompleted();
-            $this->collection->next();
-        }
-        $this->collection->setCurrentUsingObject($current_current_step);
-        return false;
-    }
-
-
-    /**
-     * @return ProgressStepInterface
-     */
-    public function currentStep()
-    {
-        return $this->collection->current();
-    }
-
-
-    /**
-     * @return ProgressStepInterface
-     */
-    public function nextStep()
-    {
-        return $this->collection->next();
-    }
-
-
-    /**
-     * @return void
-     */
-    public function enqueueStylesAndScripts()
-    {
-        $this->display_strategy->enqueueStylesAndScripts();
-    }
-
-
-    /**
-     * echos out HTML
-     *
-     * @return string
-     */
-    public function displaySteps()
-    {
-        return EEH_Template::display_template(
-            $this->display_strategy->getTemplate(),
-            array('progress_steps' => $this->collection),
-            true
-        );
-    }
-
-
-    /**
-     * @param bool $completed
-     * @return ProgressStepInterface
-     */
-    public function setCurrentStepCompleted($completed = true)
-    {
-        return $this->collection->current()->setIsCompleted($completed);
-    }
+	/**
+	 * @var ProgressStepInterface[]
+	 */
+	private $collection;
+
+	/**
+	 * @var string
+	 */
+	private $default_step;
+
+	/**
+	 * the key used for the URL param that denotes the current form step
+	 * defaults to 'ee-form-step'
+	 *
+	 * @var string
+	 */
+	private $form_step_url_key = '';
+
+	/**
+	 * @var ProgressStepsDisplayInterface
+	 */
+	private $display_strategy;
+
+	/**
+	 * @var RequestInterface
+	 */
+	private $request;
+
+
+	/**
+	 * ProgressStepManager constructor
+	 *
+	 * @param string              $display_strategy_name
+	 * @param string              $default_step
+	 * @param string              $form_step_url_key
+	 * @param CollectionInterface $collection
+	 * @param RequestInterface    $request
+	 */
+	public function __construct(
+		$display_strategy_name = 'number_bubbles',
+		$default_step = '',
+		$form_step_url_key = '',
+		CollectionInterface $collection = null,
+		RequestInterface $request = null
+	) {
+		$this->setDisplayStrategy($display_strategy_name);
+		$this->setDefaultStep($default_step);
+		$this->setFormStepUrlKey($form_step_url_key);
+		if (! $collection instanceof CollectionInterface) {
+			$collection = new Collection('\EventEspresso\core\services\progress_steps\ProgressStepInterface');
+		}
+		$this->collection = $collection;
+		if (! $request instanceof RequestInterface) {
+			/** @var RequestInterface $request */
+			$request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
+		}
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @param string $display_strategy_name
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	protected function setDisplayStrategy($display_strategy_name = 'number_bubbles')
+	{
+		if (! is_string($display_strategy_name)) {
+			throw new InvalidDataTypeException('$display_strategy_name', $display_strategy_name, 'string');
+		}
+		// build up FQCN from incoming display strategy folder name
+		$display_strategy_class = 'EventEspresso\core\services\progress_steps\display_strategies\\';
+		$display_strategy_class .= $display_strategy_name . '\\';
+		$display_strategy_class .= str_replace(' ', '', ucwords(str_replace('_', ' ', $display_strategy_name)));
+		$display_strategy_class .= 'ProgressStepsDisplay';
+		$display_strategy_class = apply_filters(
+			'FHEE__ProgressStepManager__setDisplayStrategy__display_strategy_class',
+			$display_strategy_class
+		);
+		if (! class_exists($display_strategy_class)) {
+			throw new InvalidClassException($display_strategy_class);
+		}
+		$display_strategy = new $display_strategy_class();
+		if (! $display_strategy instanceof ProgressStepsDisplayInterface) {
+			throw new InvalidClassException(
+				$display_strategy_class,
+				sprintf(
+					esc_html__('The "%1$s" Class needs to be an implementation of the "%1$s" Interface.', 'event_espresso'),
+					$display_strategy_class,
+					'\EventEspresso\core\services\progress_steps\display_strategies\ProgressStepsDisplayInterface'
+				)
+			);
+		}
+		$this->display_strategy = $display_strategy;
+	}
+
+
+	/**
+	 * @param string $default_step
+	 * @throws InvalidDataTypeException
+	 */
+	public function setDefaultStep($default_step)
+	{
+		if (! is_string($default_step)) {
+			throw new InvalidDataTypeException('$default_step', $default_step, 'string');
+		}
+		$this->default_step = $default_step;
+	}
+
+
+	/**
+	 * @param string $form_step_url_key
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
+	{
+		if (! is_string($form_step_url_key)) {
+			throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
+		}
+		$this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
+	}
+
+
+	/**
+	 * @param string $step
+	 * @throws InvalidIdentifierException
+	 */
+	public function setCurrentStep($step = '')
+	{
+		// use incoming value if it's set, otherwise use request param if it's set, otherwise use default
+		$step = ! empty($step)
+			? $step
+			: $this->request->getRequestParam($this->form_step_url_key, $this->default_step);
+		// grab the step previously known as current, in case we need to revert
+		$current_current_step = $this->collection->current();
+		// verify that requested step exists
+		if (! $this->collection->has($step)) {
+			throw new InvalidIdentifierException($step, $this->default_step);
+		}
+		if ($this->collection->setCurrent($step)) {
+			// if the old boss is the same as the new boss, then nothing changes
+			if ($this->collection->current() !== $current_current_step) {
+				$current_current_step->setIsCurrent(false);
+			}
+			$this->collection->current()->setIsCurrent();
+		} else {
+			$this->collection->setCurrent($current_current_step->id());
+			$current_current_step->setIsCurrent(true);
+		}
+	}
+
+
+	/**
+	 * setPreviousStepsCompleted
+	 */
+	public function setPreviousStepsCompleted()
+	{
+		$current_current_step = $this->collection->current();
+		$this->collection->rewind();
+		while ($this->collection->valid()) {
+			if ($this->collection->current() === $current_current_step) {
+				break;
+			}
+			$this->setCurrentStepCompleted();
+			$this->collection->next();
+		}
+		$this->collection->setCurrentUsingObject($current_current_step);
+		return false;
+	}
+
+
+	/**
+	 * @return ProgressStepInterface
+	 */
+	public function currentStep()
+	{
+		return $this->collection->current();
+	}
+
+
+	/**
+	 * @return ProgressStepInterface
+	 */
+	public function nextStep()
+	{
+		return $this->collection->next();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function enqueueStylesAndScripts()
+	{
+		$this->display_strategy->enqueueStylesAndScripts();
+	}
+
+
+	/**
+	 * echos out HTML
+	 *
+	 * @return string
+	 */
+	public function displaySteps()
+	{
+		return EEH_Template::display_template(
+			$this->display_strategy->getTemplate(),
+			array('progress_steps' => $this->collection),
+			true
+		);
+	}
+
+
+	/**
+	 * @param bool $completed
+	 * @return ProgressStepInterface
+	 */
+	public function setCurrentStepCompleted($completed = true)
+	{
+		return $this->collection->current()->setIsCompleted($completed);
+	}
 }

core/libraries/form_sections/form_handlers/SequentialStepFormManager.php

Spacing +12 added lines, -12 removed lines

@@ -140,7 +140,7 @@ 
      */
     protected function setBaseUrl($base_url)
     {
-        if (! is_string($base_url)) {
+        if ( ! is_string($base_url)) {
             throw new InvalidDataTypeException('$base_url', $base_url, 'string');
         }
         if (empty($base_url)) {
@@ -171,7 +171,7 @@ 
      */
     public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
     {
-        if (! is_string($form_step_url_key)) {
+        if ( ! is_string($form_step_url_key)) {
             throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
         }
         $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
@@ -193,7 +193,7 @@ 
      */
     protected function setDefaultFormStep($default_form_step)
     {
-        if (! is_string($default_form_step)) {
+        if ( ! is_string($default_form_step)) {
             throw new InvalidDataTypeException('$default_form_step', $default_form_step, 'string');
         }
         $this->default_form_step = $default_form_step;
@@ -208,7 +208,7 @@ 
     protected function setCurrentStepFromRequest()
     {
         $current_step_slug = $this->request()->getRequestParam($this->formStepUrlKey(), $this->defaultFormStep());
-        if (! $this->form_steps->setCurrent($current_step_slug)) {
+        if ( ! $this->form_steps->setCurrent($current_step_slug)) {
             throw new InvalidIdentifierException(
                 $current_step_slug,
                 $this->defaultFormStep(),
@@ -227,7 +227,7 @@ 
      */
     public function getCurrentStep()
     {
-        if (! $this->form_steps->current() instanceof SequentialStepForm) {
+        if ( ! $this->form_steps->current() instanceof SequentialStepForm) {
             throw new InvalidFormHandlerException($this->form_steps->current());
         }
         return $this->form_steps->current();
@@ -240,7 +240,7 @@ 
      */
     public function formAction()
     {
-        if (! is_string($this->form_action) || empty($this->form_action)) {
+        if ( ! is_string($this->form_action) || empty($this->form_action)) {
             $this->form_action = $this->baseUrl();
         }
         return $this->form_action;
@@ -253,7 +253,7 @@ 
      */
     public function setFormAction($form_action)
     {
-        if (! is_string($form_action)) {
+        if ( ! is_string($form_action)) {
             throw new InvalidDataTypeException('$form_action', $form_action, 'string');
         }
         $this->form_action = $form_action;
@@ -267,7 +267,7 @@ 
      */
     public function addFormActionArgs($form_action_args = array())
     {
-        if (! is_array($form_action_args)) {
+        if ( ! is_array($form_action_args)) {
             throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
         }
         $form_action_args = ! empty($form_action_args)
@@ -332,7 +332,7 @@ 
     protected function getProgressStepsCollection()
     {
         static $collection = null;
-        if (! $collection instanceof ProgressStepCollection) {
+        if ( ! $collection instanceof ProgressStepCollection) {
             $collection = new ProgressStepCollection();
         }
         return $collection;
@@ -354,7 +354,7 @@ 
         /** @var SequentialStepForm $form_step */
         foreach ($this->form_steps as $form_step) {
             // is this step active ?
-            if (! $form_step->initialize()) {
+            if ( ! $form_step->initialize()) {
                 continue;
             }
             $progress_steps_collection->add(
@@ -423,7 +423,7 @@ 
     {
         $form_step = $this->buildCurrentStepForm();
         // no displayable content ? then skip straight to processing
-        if (! $form_step->displayable()) {
+        if ( ! $form_step->displayable()) {
             $this->addFormActionArgs();
             $form_step->setFormAction($this->formAction());
             wp_safe_redirect($form_step->formAction());
@@ -499,7 +499,7 @@ 
     public function displayProgressSteps($return_as_string = true)
     {
         $form_step = $this->getCurrentStep();
-        if (! $form_step->displayable()) {
+        if ( ! $form_step->displayable()) {
             return '';
         }
         $progress_steps = apply_filters(

Indentation +579 added lines, -579 removed lines

@@ -30,583 +30,583 @@
  */
 abstract class SequentialStepFormManager
 {
-    /**
-     * a simplified URL with no form related parameters
-     * that will be used to build the form's redirect URLs
-     *
-     * @var string $base_url
-     */
-    private $base_url = '';
-
-    /**
-     * the key used for the URL param that denotes the current form step
-     * defaults to 'ee-form-step'
-     *
-     * @var string $form_step_url_key
-     */
-    private $form_step_url_key = '';
-
-    /**
-     * @var string $default_form_step
-     */
-    private $default_form_step = '';
-
-    /**
-     * @var string $form_action
-     */
-    private $form_action;
-
-    /**
-     * value of one of the string constant above
-     *
-     * @var string $form_config
-     */
-    private $form_config;
-
-    /**
-     * @var string $progress_step_style
-     */
-    private $progress_step_style = '';
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * @var Collection $form_steps
-     */
-    protected $form_steps;
-
-    /**
-     * @var ProgressStepManager $progress_step_manager
-     */
-    protected $progress_step_manager;
-
-
-    /**
-     * @return Collection|null
-     */
-    abstract protected function getFormStepsCollection();
-
-    // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
-    /**
-     * StepsManager constructor
-     *
-     * @param string                           $base_url
-     * @param string                           $default_form_step
-     * @param string                           $form_action
-     * @param string                           $form_config
-     * @param EE_Request|RequestInterface|null $request
-     * @param string                           $progress_step_style
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $base_url,
-        $default_form_step,
-        $form_action = '',
-        $form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-        $progress_step_style = 'number_bubbles',
-        $request = null
-    ) {
-        $this->setBaseUrl($base_url);
-        $this->setDefaultFormStep($default_form_step);
-        $this->setFormAction($form_action);
-        $this->setFormConfig($form_config);
-        $this->setProgressStepStyle($progress_step_style);
-        $this->request = $request instanceof RequestInterface
-            ? $request
-            : LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function baseUrl()
-    {
-        if (strpos($this->base_url, $this->getCurrentStep()->slug()) === false) {
-            add_query_arg(
-                array($this->form_step_url_key => $this->getCurrentStep()->slug()),
-                $this->base_url
-            );
-        }
-        return $this->base_url;
-    }
-
-
-    /**
-     * @param string $base_url
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function setBaseUrl($base_url)
-    {
-        if (! is_string($base_url)) {
-            throw new InvalidDataTypeException('$base_url', $base_url, 'string');
-        }
-        if (empty($base_url)) {
-            throw new InvalidArgumentException(
-                esc_html__('The base URL can not be an empty string.', 'event_espresso')
-            );
-        }
-        $this->base_url = $base_url;
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidDataTypeException
-     */
-    public function formStepUrlKey()
-    {
-        if (empty($this->form_step_url_key)) {
-            $this->setFormStepUrlKey();
-        }
-        return $this->form_step_url_key;
-    }
-
-
-    /**
-     * @param string $form_step_url_key
-     * @throws InvalidDataTypeException
-     */
-    public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
-    {
-        if (! is_string($form_step_url_key)) {
-            throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
-        }
-        $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function defaultFormStep()
-    {
-        return $this->default_form_step;
-    }
-
-
-    /**
-     * @param $default_form_step
-     * @throws InvalidDataTypeException
-     */
-    protected function setDefaultFormStep($default_form_step)
-    {
-        if (! is_string($default_form_step)) {
-            throw new InvalidDataTypeException('$default_form_step', $default_form_step, 'string');
-        }
-        $this->default_form_step = $default_form_step;
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidIdentifierException
-     * @throws InvalidDataTypeException
-     */
-    protected function setCurrentStepFromRequest()
-    {
-        $current_step_slug = $this->request()->getRequestParam($this->formStepUrlKey(), $this->defaultFormStep());
-        if (! $this->form_steps->setCurrent($current_step_slug)) {
-            throw new InvalidIdentifierException(
-                $current_step_slug,
-                $this->defaultFormStep(),
-                sprintf(
-                    esc_html__('The "%1$s" form step could not be set.', 'event_espresso'),
-                    $current_step_slug
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return SequentialStepFormInterface|object
-     * @throws InvalidFormHandlerException
-     */
-    public function getCurrentStep()
-    {
-        if (! $this->form_steps->current() instanceof SequentialStepForm) {
-            throw new InvalidFormHandlerException($this->form_steps->current());
-        }
-        return $this->form_steps->current();
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function formAction()
-    {
-        if (! is_string($this->form_action) || empty($this->form_action)) {
-            $this->form_action = $this->baseUrl();
-        }
-        return $this->form_action;
-    }
-
-
-    /**
-     * @param string $form_action
-     * @throws InvalidDataTypeException
-     */
-    public function setFormAction($form_action)
-    {
-        if (! is_string($form_action)) {
-            throw new InvalidDataTypeException('$form_action', $form_action, 'string');
-        }
-        $this->form_action = $form_action;
-    }
-
-
-    /**
-     * @param array $form_action_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function addFormActionArgs($form_action_args = array())
-    {
-        if (! is_array($form_action_args)) {
-            throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
-        }
-        $form_action_args = ! empty($form_action_args)
-            ? $form_action_args
-            : array($this->formStepUrlKey() => $this->form_steps->current()->slug());
-        $this->getCurrentStep()->setFormAction(
-            add_query_arg($form_action_args, $this->formAction())
-        );
-        $this->form_action = $this->getCurrentStep()->formAction();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formConfig()
-    {
-        return $this->form_config;
-    }
-
-
-    /**
-     * @param string $form_config
-     */
-    public function setFormConfig($form_config)
-    {
-        $this->form_config = $form_config;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function progressStepStyle()
-    {
-        return $this->progress_step_style;
-    }
-
-
-    /**
-     * @param string $progress_step_style
-     */
-    public function setProgressStepStyle($progress_step_style)
-    {
-        $this->progress_step_style = $progress_step_style;
-    }
-
-
-    /**
-     * @return RequestInterface
-     */
-    public function request()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @return Collection|null
-     * @throws InvalidInterfaceException
-     */
-    protected function getProgressStepsCollection()
-    {
-        static $collection = null;
-        if (! $collection instanceof ProgressStepCollection) {
-            $collection = new ProgressStepCollection();
-        }
-        return $collection;
-    }
-
-
-    /**
-     * @param Collection $progress_steps_collection
-     * @return ProgressStepManager
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     */
-    protected function generateProgressSteps(Collection $progress_steps_collection)
-    {
-        $current_step = $this->getCurrentStep();
-        /** @var SequentialStepForm $form_step */
-        foreach ($this->form_steps as $form_step) {
-            // is this step active ?
-            if (! $form_step->initialize()) {
-                continue;
-            }
-            $progress_steps_collection->add(
-                new ProgressStep(
-                    $form_step->order(),
-                    $form_step->slug(),
-                    $form_step->slug(),
-                    $form_step->formName()
-                ),
-                $form_step->slug()
-            );
-        }
-        // set collection pointer back to current step
-        $this->form_steps->setCurrentUsingObject($current_step);
-        return new ProgressStepManager(
-            $this->progressStepStyle(),
-            $this->defaultFormStep(),
-            $this->formStepUrlKey(),
-            $progress_steps_collection
-        );
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildForm()
-    {
-        $this->buildCurrentStepFormForDisplay();
-    }
-
-
-    /**
-     * @param array $form_data
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    public function processForm($form_data = array())
-    {
-        $this->buildCurrentStepFormForProcessing();
-        $this->processCurrentStepForm($form_data);
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildCurrentStepFormForDisplay()
-    {
-        $form_step = $this->buildCurrentStepForm();
-        // no displayable content ? then skip straight to processing
-        if (! $form_step->displayable()) {
-            $this->addFormActionArgs();
-            $form_step->setFormAction($this->formAction());
-            wp_safe_redirect($form_step->formAction());
-        }
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildCurrentStepFormForProcessing()
-    {
-        $this->buildCurrentStepForm(false);
-    }
-
-
-    /**
-     * @param bool $for_display
-     * @return SequentialStepFormInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    private function buildCurrentStepForm($for_display = true)
-    {
-        $this->form_steps = $this->getFormStepsCollection();
-        $this->setCurrentStepFromRequest();
-        $form_step = $this->getCurrentStep();
-        if ($form_step->submitBtnText() === esc_html__('Submit', 'event_espresso')) {
-            $form_step->setSubmitBtnText(esc_html__('Next Step', 'event_espresso'));
-        }
-        if ($for_display && $form_step->displayable()) {
-            $this->progress_step_manager = $this->generateProgressSteps(
-                $this->getProgressStepsCollection()
-            );
-            $this->progress_step_manager->setCurrentStep(
-                $form_step->slug()
-            );
-            // mark all previous progress steps as completed
-            $this->progress_step_manager->setPreviousStepsCompleted();
-            $this->progress_step_manager->enqueueStylesAndScripts();
-            $this->addFormActionArgs();
-            $form_step->setFormAction($this->formAction());
-        } else {
-            $form_step->setRedirectUrl($this->baseUrl());
-            $form_step->addRedirectArgs(
-                array($this->formStepUrlKey() => $this->form_steps->current()->slug())
-            );
-        }
-        $form_step->generate();
-        if ($for_display) {
-            $form_step->enqueueStylesAndScripts();
-        }
-        return $form_step;
-    }
-
-
-    /**
-     * @param bool $return_as_string
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function displayProgressSteps($return_as_string = true)
-    {
-        $form_step = $this->getCurrentStep();
-        if (! $form_step->displayable()) {
-            return '';
-        }
-        $progress_steps = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__before_steps',
-            ''
-        );
-        $progress_steps .= $this->progress_step_manager->displaySteps();
-        $progress_steps .= apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__after_steps',
-            ''
-        );
-        if ($return_as_string) {
-            return $progress_steps;
-        }
-        echo wp_kses($progress_steps, AllowedTags::getWithFormTags());
-        return '';
-    }
-
-
-    /**
-     * @param bool $return_as_string
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function displayCurrentStepForm($return_as_string = true)
-    {
-        if ($return_as_string) {
-            return $this->getCurrentStep()->display();
-        }
-        echo wp_kses($this->getCurrentStep()->display(), AllowedTags::getWithFormTags());
-        return '';
-    }
-
-
-    /**
-     * @param array $form_data
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function processCurrentStepForm($form_data = array())
-    {
-        // grab instance of current step because after calling next() below,
-        // any calls to getCurrentStep() will return the "next" step because we advanced
-        $current_step = $this->getCurrentStep();
-        try {
-            // form processing should either throw exceptions or return true
-            $current_step->process($form_data);
-        } catch (Exception $e) {
-            // something went wrong, convert the Exception to an EE_Error
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            // prevent redirect to next step or other if exception was thrown
-            if (
-                $current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_NEXT_STEP
-                || $current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_OTHER
-            ) {
-                $current_step->setRedirectTo(SequentialStepForm::REDIRECT_TO_CURRENT_STEP);
-            }
-        }
-        // save notices to a transient so that when we redirect back
-        // to the display portion for this step
-        // those notices can be displayed
-        EE_Error::get_notices(false, true);
-        $this->redirectForm($current_step);
-    }
-
-
-    /**
-     * handles where to go to next
-     *
-     * @param SequentialStepFormInterface $current_step
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function redirectForm(SequentialStepFormInterface $current_step)
-    {
-        $redirect_step = $current_step;
-        switch ($current_step->redirectTo()) {
-            case SequentialStepForm::REDIRECT_TO_OTHER:
-                // going somewhere else, so just check out now
-                wp_safe_redirect($redirect_step->redirectUrl());
-                exit();
-            case SequentialStepForm::REDIRECT_TO_PREV_STEP:
-                $redirect_step = $this->form_steps->previous();
-                break;
-            case SequentialStepForm::REDIRECT_TO_NEXT_STEP:
-                $this->form_steps->next();
-                if ($this->form_steps->valid()) {
-                    $redirect_step = $this->form_steps->current();
-                }
-                break;
-            case SequentialStepForm::REDIRECT_TO_CURRENT_STEP:
-            default:
-                // $redirect_step is already set
-        }
-        $current_step->setRedirectUrl($this->baseUrl());
-        $current_step->addRedirectArgs(
-            // use the slug for whatever step we are redirecting too
-            array($this->formStepUrlKey() => $redirect_step->slug())
-        );
-        wp_safe_redirect($current_step->redirectUrl());
-        exit();
-    }
+	/**
+	 * a simplified URL with no form related parameters
+	 * that will be used to build the form's redirect URLs
+	 *
+	 * @var string $base_url
+	 */
+	private $base_url = '';
+
+	/**
+	 * the key used for the URL param that denotes the current form step
+	 * defaults to 'ee-form-step'
+	 *
+	 * @var string $form_step_url_key
+	 */
+	private $form_step_url_key = '';
+
+	/**
+	 * @var string $default_form_step
+	 */
+	private $default_form_step = '';
+
+	/**
+	 * @var string $form_action
+	 */
+	private $form_action;
+
+	/**
+	 * value of one of the string constant above
+	 *
+	 * @var string $form_config
+	 */
+	private $form_config;
+
+	/**
+	 * @var string $progress_step_style
+	 */
+	private $progress_step_style = '';
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * @var Collection $form_steps
+	 */
+	protected $form_steps;
+
+	/**
+	 * @var ProgressStepManager $progress_step_manager
+	 */
+	protected $progress_step_manager;
+
+
+	/**
+	 * @return Collection|null
+	 */
+	abstract protected function getFormStepsCollection();
+
+	// phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
+	/**
+	 * StepsManager constructor
+	 *
+	 * @param string                           $base_url
+	 * @param string                           $default_form_step
+	 * @param string                           $form_action
+	 * @param string                           $form_config
+	 * @param EE_Request|RequestInterface|null $request
+	 * @param string                           $progress_step_style
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$base_url,
+		$default_form_step,
+		$form_action = '',
+		$form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+		$progress_step_style = 'number_bubbles',
+		$request = null
+	) {
+		$this->setBaseUrl($base_url);
+		$this->setDefaultFormStep($default_form_step);
+		$this->setFormAction($form_action);
+		$this->setFormConfig($form_config);
+		$this->setProgressStepStyle($progress_step_style);
+		$this->request = $request instanceof RequestInterface
+			? $request
+			: LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function baseUrl()
+	{
+		if (strpos($this->base_url, $this->getCurrentStep()->slug()) === false) {
+			add_query_arg(
+				array($this->form_step_url_key => $this->getCurrentStep()->slug()),
+				$this->base_url
+			);
+		}
+		return $this->base_url;
+	}
+
+
+	/**
+	 * @param string $base_url
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function setBaseUrl($base_url)
+	{
+		if (! is_string($base_url)) {
+			throw new InvalidDataTypeException('$base_url', $base_url, 'string');
+		}
+		if (empty($base_url)) {
+			throw new InvalidArgumentException(
+				esc_html__('The base URL can not be an empty string.', 'event_espresso')
+			);
+		}
+		$this->base_url = $base_url;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidDataTypeException
+	 */
+	public function formStepUrlKey()
+	{
+		if (empty($this->form_step_url_key)) {
+			$this->setFormStepUrlKey();
+		}
+		return $this->form_step_url_key;
+	}
+
+
+	/**
+	 * @param string $form_step_url_key
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
+	{
+		if (! is_string($form_step_url_key)) {
+			throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
+		}
+		$this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function defaultFormStep()
+	{
+		return $this->default_form_step;
+	}
+
+
+	/**
+	 * @param $default_form_step
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setDefaultFormStep($default_form_step)
+	{
+		if (! is_string($default_form_step)) {
+			throw new InvalidDataTypeException('$default_form_step', $default_form_step, 'string');
+		}
+		$this->default_form_step = $default_form_step;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setCurrentStepFromRequest()
+	{
+		$current_step_slug = $this->request()->getRequestParam($this->formStepUrlKey(), $this->defaultFormStep());
+		if (! $this->form_steps->setCurrent($current_step_slug)) {
+			throw new InvalidIdentifierException(
+				$current_step_slug,
+				$this->defaultFormStep(),
+				sprintf(
+					esc_html__('The "%1$s" form step could not be set.', 'event_espresso'),
+					$current_step_slug
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return SequentialStepFormInterface|object
+	 * @throws InvalidFormHandlerException
+	 */
+	public function getCurrentStep()
+	{
+		if (! $this->form_steps->current() instanceof SequentialStepForm) {
+			throw new InvalidFormHandlerException($this->form_steps->current());
+		}
+		return $this->form_steps->current();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function formAction()
+	{
+		if (! is_string($this->form_action) || empty($this->form_action)) {
+			$this->form_action = $this->baseUrl();
+		}
+		return $this->form_action;
+	}
+
+
+	/**
+	 * @param string $form_action
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormAction($form_action)
+	{
+		if (! is_string($form_action)) {
+			throw new InvalidDataTypeException('$form_action', $form_action, 'string');
+		}
+		$this->form_action = $form_action;
+	}
+
+
+	/**
+	 * @param array $form_action_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function addFormActionArgs($form_action_args = array())
+	{
+		if (! is_array($form_action_args)) {
+			throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
+		}
+		$form_action_args = ! empty($form_action_args)
+			? $form_action_args
+			: array($this->formStepUrlKey() => $this->form_steps->current()->slug());
+		$this->getCurrentStep()->setFormAction(
+			add_query_arg($form_action_args, $this->formAction())
+		);
+		$this->form_action = $this->getCurrentStep()->formAction();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formConfig()
+	{
+		return $this->form_config;
+	}
+
+
+	/**
+	 * @param string $form_config
+	 */
+	public function setFormConfig($form_config)
+	{
+		$this->form_config = $form_config;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function progressStepStyle()
+	{
+		return $this->progress_step_style;
+	}
+
+
+	/**
+	 * @param string $progress_step_style
+	 */
+	public function setProgressStepStyle($progress_step_style)
+	{
+		$this->progress_step_style = $progress_step_style;
+	}
+
+
+	/**
+	 * @return RequestInterface
+	 */
+	public function request()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @return Collection|null
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getProgressStepsCollection()
+	{
+		static $collection = null;
+		if (! $collection instanceof ProgressStepCollection) {
+			$collection = new ProgressStepCollection();
+		}
+		return $collection;
+	}
+
+
+	/**
+	 * @param Collection $progress_steps_collection
+	 * @return ProgressStepManager
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 */
+	protected function generateProgressSteps(Collection $progress_steps_collection)
+	{
+		$current_step = $this->getCurrentStep();
+		/** @var SequentialStepForm $form_step */
+		foreach ($this->form_steps as $form_step) {
+			// is this step active ?
+			if (! $form_step->initialize()) {
+				continue;
+			}
+			$progress_steps_collection->add(
+				new ProgressStep(
+					$form_step->order(),
+					$form_step->slug(),
+					$form_step->slug(),
+					$form_step->formName()
+				),
+				$form_step->slug()
+			);
+		}
+		// set collection pointer back to current step
+		$this->form_steps->setCurrentUsingObject($current_step);
+		return new ProgressStepManager(
+			$this->progressStepStyle(),
+			$this->defaultFormStep(),
+			$this->formStepUrlKey(),
+			$progress_steps_collection
+		);
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildForm()
+	{
+		$this->buildCurrentStepFormForDisplay();
+	}
+
+
+	/**
+	 * @param array $form_data
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	public function processForm($form_data = array())
+	{
+		$this->buildCurrentStepFormForProcessing();
+		$this->processCurrentStepForm($form_data);
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildCurrentStepFormForDisplay()
+	{
+		$form_step = $this->buildCurrentStepForm();
+		// no displayable content ? then skip straight to processing
+		if (! $form_step->displayable()) {
+			$this->addFormActionArgs();
+			$form_step->setFormAction($this->formAction());
+			wp_safe_redirect($form_step->formAction());
+		}
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildCurrentStepFormForProcessing()
+	{
+		$this->buildCurrentStepForm(false);
+	}
+
+
+	/**
+	 * @param bool $for_display
+	 * @return SequentialStepFormInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	private function buildCurrentStepForm($for_display = true)
+	{
+		$this->form_steps = $this->getFormStepsCollection();
+		$this->setCurrentStepFromRequest();
+		$form_step = $this->getCurrentStep();
+		if ($form_step->submitBtnText() === esc_html__('Submit', 'event_espresso')) {
+			$form_step->setSubmitBtnText(esc_html__('Next Step', 'event_espresso'));
+		}
+		if ($for_display && $form_step->displayable()) {
+			$this->progress_step_manager = $this->generateProgressSteps(
+				$this->getProgressStepsCollection()
+			);
+			$this->progress_step_manager->setCurrentStep(
+				$form_step->slug()
+			);
+			// mark all previous progress steps as completed
+			$this->progress_step_manager->setPreviousStepsCompleted();
+			$this->progress_step_manager->enqueueStylesAndScripts();
+			$this->addFormActionArgs();
+			$form_step->setFormAction($this->formAction());
+		} else {
+			$form_step->setRedirectUrl($this->baseUrl());
+			$form_step->addRedirectArgs(
+				array($this->formStepUrlKey() => $this->form_steps->current()->slug())
+			);
+		}
+		$form_step->generate();
+		if ($for_display) {
+			$form_step->enqueueStylesAndScripts();
+		}
+		return $form_step;
+	}
+
+
+	/**
+	 * @param bool $return_as_string
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function displayProgressSteps($return_as_string = true)
+	{
+		$form_step = $this->getCurrentStep();
+		if (! $form_step->displayable()) {
+			return '';
+		}
+		$progress_steps = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__before_steps',
+			''
+		);
+		$progress_steps .= $this->progress_step_manager->displaySteps();
+		$progress_steps .= apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__after_steps',
+			''
+		);
+		if ($return_as_string) {
+			return $progress_steps;
+		}
+		echo wp_kses($progress_steps, AllowedTags::getWithFormTags());
+		return '';
+	}
+
+
+	/**
+	 * @param bool $return_as_string
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function displayCurrentStepForm($return_as_string = true)
+	{
+		if ($return_as_string) {
+			return $this->getCurrentStep()->display();
+		}
+		echo wp_kses($this->getCurrentStep()->display(), AllowedTags::getWithFormTags());
+		return '';
+	}
+
+
+	/**
+	 * @param array $form_data
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function processCurrentStepForm($form_data = array())
+	{
+		// grab instance of current step because after calling next() below,
+		// any calls to getCurrentStep() will return the "next" step because we advanced
+		$current_step = $this->getCurrentStep();
+		try {
+			// form processing should either throw exceptions or return true
+			$current_step->process($form_data);
+		} catch (Exception $e) {
+			// something went wrong, convert the Exception to an EE_Error
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			// prevent redirect to next step or other if exception was thrown
+			if (
+				$current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_NEXT_STEP
+				|| $current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_OTHER
+			) {
+				$current_step->setRedirectTo(SequentialStepForm::REDIRECT_TO_CURRENT_STEP);
+			}
+		}
+		// save notices to a transient so that when we redirect back
+		// to the display portion for this step
+		// those notices can be displayed
+		EE_Error::get_notices(false, true);
+		$this->redirectForm($current_step);
+	}
+
+
+	/**
+	 * handles where to go to next
+	 *
+	 * @param SequentialStepFormInterface $current_step
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function redirectForm(SequentialStepFormInterface $current_step)
+	{
+		$redirect_step = $current_step;
+		switch ($current_step->redirectTo()) {
+			case SequentialStepForm::REDIRECT_TO_OTHER:
+				// going somewhere else, so just check out now
+				wp_safe_redirect($redirect_step->redirectUrl());
+				exit();
+			case SequentialStepForm::REDIRECT_TO_PREV_STEP:
+				$redirect_step = $this->form_steps->previous();
+				break;
+			case SequentialStepForm::REDIRECT_TO_NEXT_STEP:
+				$this->form_steps->next();
+				if ($this->form_steps->valid()) {
+					$redirect_step = $this->form_steps->current();
+				}
+				break;
+			case SequentialStepForm::REDIRECT_TO_CURRENT_STEP:
+			default:
+				// $redirect_step is already set
+		}
+		$current_step->setRedirectUrl($this->baseUrl());
+		$current_step->addRedirectArgs(
+			// use the slug for whatever step we are redirecting too
+			array($this->formStepUrlKey() => $redirect_step->slug())
+		);
+		wp_safe_redirect($current_step->redirectUrl());
+		exit();
+	}
 }