eventespresso / event-espresso-core

caffeinated/modules/ticket_selector_caff/EED_Ticket_Selector_Caff.module.php

Spacing +3 added lines, -3 removed lines

@@ -52,7 +52,7 @@ 
     {
         define(
             'TICKET_SELECTOR_CAFF_TEMPLATES_PATH',
-            str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/'
+            str_replace('\\', '/', plugin_dir_path(__FILE__)).'templates/'
         );
         add_action(
             'AHEE__template_settings__template__before_settings_form',
@@ -107,7 +107,7 @@ 
                     'FHEE__EED_Ticket_Selector_Caff___ticket_selector_settings_form__form_subsections',
                     array(
                         'appearance_settings_hdr' => new EE_Form_Section_HTML(
-                            EEH_HTML::br(2) .
+                            EEH_HTML::br(2).
                             EEH_HTML::h2(esc_html__('Ticket Selector Template Settings', 'event_espresso'))
                         ),
                         'appearance_settings'     => EED_Ticket_Selector_Caff::_ticket_selector_appearance_settings(),
@@ -273,7 +273,7 @@ 
      */
     public static function update_template_settings(EE_Template_Config $CFG, $REQ)
     {
-        if (! $CFG->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config) {
+        if ( ! $CFG->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config) {
             EED_Ticket_Selector::instance()->set_config();
             $CFG->EED_Ticket_Selector = EED_Ticket_Selector::instance()->config();
         }

Indentation +294 added lines, -294 removed lines

@@ -15,319 +15,319 @@
  */
 class EED_Ticket_Selector_Caff extends EED_Ticket_Selector
 {
-    /**
-     * @return EED_Module|EED_Ticket_Selector_Caff
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
+	/**
+	 * @return EED_Module|EED_Ticket_Selector_Caff
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
 
 
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        add_action(
-            'AHEE__ticket_selector_chart_template__ticket_details__after_description',
-            array('EED_Ticket_Selector_Caff', 'ticket_price_details'),
-            10,
-            3
-        );
-    }
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		add_action(
+			'AHEE__ticket_selector_chart_template__ticket_details__after_description',
+			array('EED_Ticket_Selector_Caff', 'ticket_price_details'),
+			10,
+			3
+		);
+	}
 
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        define(
-            'TICKET_SELECTOR_CAFF_TEMPLATES_PATH',
-            str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/'
-        );
-        add_action(
-            'AHEE__template_settings__template__before_settings_form',
-            array('EED_Ticket_Selector_Caff', 'template_settings_form'),
-            10
-        );
-        add_filter(
-            'FHEE__General_Settings_Admin_Page__update_template_settings__data',
-            array('EED_Ticket_Selector_Caff', 'update_template_settings'),
-            10,
-            2
-        );
-    }
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		define(
+			'TICKET_SELECTOR_CAFF_TEMPLATES_PATH',
+			str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/'
+		);
+		add_action(
+			'AHEE__template_settings__template__before_settings_form',
+			array('EED_Ticket_Selector_Caff', 'template_settings_form'),
+			10
+		);
+		add_filter(
+			'FHEE__General_Settings_Admin_Page__update_template_settings__data',
+			array('EED_Ticket_Selector_Caff', 'update_template_settings'),
+			10,
+			2
+		);
+	}
 
 
-    /**
-     * @param \WP $WP
-     */
-    public function run($WP)
-    {
-        $this->set_config();
-    }
+	/**
+	 * @param \WP $WP
+	 */
+	public function run($WP)
+	{
+		$this->set_config();
+	}
 
 
-    /**
-     * @static
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function template_settings_form()
-    {
-        echo EED_Ticket_Selector_Caff::_ticket_selector_settings_form()->get_html();
-    }
+	/**
+	 * @static
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function template_settings_form()
+	{
+		echo EED_Ticket_Selector_Caff::_ticket_selector_settings_form()->get_html();
+	}
 
 
-    /**
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    public static function _ticket_selector_settings_form()
-    {
+	/**
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	public static function _ticket_selector_settings_form()
+	{
 
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'ticket_selector_settings_form',
-                'html_id'         => 'ticket_selector_settings_form',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__EED_Ticket_Selector_Caff___ticket_selector_settings_form__form_subsections',
-                    array(
-                        'appearance_settings_hdr' => new EE_Form_Section_HTML(
-                            EEH_HTML::br(2) .
-                            EEH_HTML::h2(esc_html__('Ticket Selector Template Settings', 'event_espresso'))
-                        ),
-                        'appearance_settings'     => EED_Ticket_Selector_Caff::_ticket_selector_appearance_settings(),
-                    )
-                ),
-            )
-        );
-    }
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'ticket_selector_settings_form',
+				'html_id'         => 'ticket_selector_settings_form',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__EED_Ticket_Selector_Caff___ticket_selector_settings_form__form_subsections',
+					array(
+						'appearance_settings_hdr' => new EE_Form_Section_HTML(
+							EEH_HTML::br(2) .
+							EEH_HTML::h2(esc_html__('Ticket Selector Template Settings', 'event_espresso'))
+						),
+						'appearance_settings'     => EED_Ticket_Selector_Caff::_ticket_selector_appearance_settings(),
+					)
+				),
+			)
+		);
+	}
 
 
-    /**
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    public static function _ticket_selector_appearance_settings()
-    {
-        if (
-            ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
-        ) {
-            EED_Ticket_Selector::instance()->set_config();
-            EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = EED_Ticket_Selector::instance()
-                                                                                                      ->config();
-        }
-        $EE_Ticket_Selector_Config = EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector;
-        // get option for whether to show datetime selector in TS
-        $show_datetime_selector = $EE_Ticket_Selector_Config->getShowDatetimeSelector();
-        // and option for how may datetimes must exist if display is conditional
-        $datetime_selector_threshold = $EE_Ticket_Selector_Config->getDatetimeSelectorThreshold();
+	/**
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	public static function _ticket_selector_appearance_settings()
+	{
+		if (
+			! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
+		) {
+			EED_Ticket_Selector::instance()->set_config();
+			EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = EED_Ticket_Selector::instance()
+																									  ->config();
+		}
+		$EE_Ticket_Selector_Config = EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector;
+		// get option for whether to show datetime selector in TS
+		$show_datetime_selector = $EE_Ticket_Selector_Config->getShowDatetimeSelector();
+		// and option for how may datetimes must exist if display is conditional
+		$datetime_selector_threshold = $EE_Ticket_Selector_Config->getDatetimeSelectorThreshold();
 
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'ticket_selector_settings_tbl',
-                'html_id'         => 'ticket_selector_settings_tbl',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__EED_Ticket_Selector_Caff___ticket_selector_appearance_settings__form_subsections',
-                    array(
-                        'show_ticket_details'         => new EE_Yes_No_Input(
-                            array(
-                                'html_label_text'         => esc_html__(
-                                    'Show Ticket Details?',
-                                    'event_espresso'
-                                ),
-                                'html_help_text'          => esc_html__(
-                                    'This lets you choose whether the extra ticket details section is displayed with the ticket selector.',
-                                    'event_espresso'
-                                ),
-                                'default'                 => isset($EE_Ticket_Selector_Config->show_ticket_details)
-                                    ? $EE_Ticket_Selector_Config->show_ticket_details
-                                    : true,
-                                'display_html_label_text' => false,
-                            )
-                        ),
-                        'show_ticket_sale_columns'    => new EE_Yes_No_Input(
-                            array(
-                                'html_label_text'         => esc_html__(
-                                    'Show Ticket Sale Info?',
-                                    'event_espresso'
-                                ),
-                                'html_help_text'          => esc_html__(
-                                    'This lets you indicate whether information about ticket sales is shown with ticket details in the ticket selector.',
-                                    'event_espresso'
-                                ),
-                                'default'                 => isset($EE_Ticket_Selector_Config->show_ticket_sale_columns)
-                                    ? $EE_Ticket_Selector_Config->show_ticket_sale_columns
-                                    : true,
-                                'display_html_label_text' => false,
-                            )
-                        ),
-                        'show_expired_tickets'        => new EE_Yes_No_Input(
-                            array(
-                                'html_label_text'         => esc_html__(
-                                    'Show Expired Tickets?',
-                                    'event_espresso'
-                                ),
-                                'html_help_text'          => esc_html__(
-                                    'Indicate whether to show expired tickets in the ticket selector',
-                                    'event_espresso'
-                                ),
-                                'default'                 => isset($EE_Ticket_Selector_Config->show_expired_tickets)
-                                    ? $EE_Ticket_Selector_Config->show_expired_tickets
-                                    : true,
-                                'display_html_label_text' => false,
-                            )
-                        ),
-                        'show_datetime_selector'      => new EE_Select_Input(
-                            $EE_Ticket_Selector_Config->getShowDatetimeSelectorOptions(false),
-                            array(
-                                'html_label_text'         => esc_html__(
-                                    'Show Date & Time Filter?',
-                                    'event_espresso'
-                                ),
-                                'html_help_text'          => sprintf(
-                                    esc_html__(
-                                        'Indicates whether or not to display a dropdown select box above each ticket selector that displays dates and times for the available tickets. Ticket options can be unselected, which removes (hides) them from the list of tickets being displayed.%1$sOptions include:%1$s • %2$sdo not show date & time filter%3$s%1$s   this option will NEVER display a date filter, regardless of how many dates exist.%1$s • %2$smaybe show date & time filter%3$s%1$s   this option will conditionally display the date filter when the number of dates for the event matches the value set for "Date Filter Threshold".',
-                                        'event_espresso'
-                                    ),
-                                    '<br>',
-                                    '<strong>',
-                                    '</strong>'
-                                ),
-                                'default'                 => ! empty($show_datetime_selector)
-                                    ? $show_datetime_selector
-                                    : EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
-                                'display_html_label_text' => false,
-                            )
-                        ),
-                        'datetime_selector_threshold' => new EE_Select_Input(
-                            array_combine($r = range(1, 10), $r),
-                            array(
-                                'html_label_text'         => esc_html__(
-                                    'Date & Time Filter Threshold',
-                                    'event_espresso'
-                                ),
-                                'html_help_text'          => esc_html__(
-                                    'The number of unique dates an event has to have before conditionally displaying a date & time filter',
-                                    'event_espresso'
-                                ),
-                                'default'                 => ! empty($datetime_selector_threshold)
-                                    ? $datetime_selector_threshold
-                                    : 3,
-                                'display_html_label_text' => false,
-                            )
-                        ),
-                        'datetime_selector_max_checked' => new EE_Integer_Input(
-                            array(
-                                'html_label_text'         => esc_html__(
-                                    'Date & Time Filter Max Checked',
-                                    'event_espresso'
-                                ),
-                                'html_help_text'          => sprintf(
-                                    esc_html__(
-                                        'Determines the maximum number of dates that will be checked upon initial loading for a Date and Time Filter.%1$sIf set to zero or left blank, then ALL dates will be checked upon initial loading.',
-                                        'event_espresso'
-                                    ),
-                                    '<br>'
-                                ),
-                                'default'                 => $EE_Ticket_Selector_Config->getDatetimeSelectorMaxChecked(),
-                                'display_html_label_text' => false,
-                                'min_value'               => 0,
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'ticket_selector_settings_tbl',
+				'html_id'         => 'ticket_selector_settings_tbl',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__EED_Ticket_Selector_Caff___ticket_selector_appearance_settings__form_subsections',
+					array(
+						'show_ticket_details'         => new EE_Yes_No_Input(
+							array(
+								'html_label_text'         => esc_html__(
+									'Show Ticket Details?',
+									'event_espresso'
+								),
+								'html_help_text'          => esc_html__(
+									'This lets you choose whether the extra ticket details section is displayed with the ticket selector.',
+									'event_espresso'
+								),
+								'default'                 => isset($EE_Ticket_Selector_Config->show_ticket_details)
+									? $EE_Ticket_Selector_Config->show_ticket_details
+									: true,
+								'display_html_label_text' => false,
+							)
+						),
+						'show_ticket_sale_columns'    => new EE_Yes_No_Input(
+							array(
+								'html_label_text'         => esc_html__(
+									'Show Ticket Sale Info?',
+									'event_espresso'
+								),
+								'html_help_text'          => esc_html__(
+									'This lets you indicate whether information about ticket sales is shown with ticket details in the ticket selector.',
+									'event_espresso'
+								),
+								'default'                 => isset($EE_Ticket_Selector_Config->show_ticket_sale_columns)
+									? $EE_Ticket_Selector_Config->show_ticket_sale_columns
+									: true,
+								'display_html_label_text' => false,
+							)
+						),
+						'show_expired_tickets'        => new EE_Yes_No_Input(
+							array(
+								'html_label_text'         => esc_html__(
+									'Show Expired Tickets?',
+									'event_espresso'
+								),
+								'html_help_text'          => esc_html__(
+									'Indicate whether to show expired tickets in the ticket selector',
+									'event_espresso'
+								),
+								'default'                 => isset($EE_Ticket_Selector_Config->show_expired_tickets)
+									? $EE_Ticket_Selector_Config->show_expired_tickets
+									: true,
+								'display_html_label_text' => false,
+							)
+						),
+						'show_datetime_selector'      => new EE_Select_Input(
+							$EE_Ticket_Selector_Config->getShowDatetimeSelectorOptions(false),
+							array(
+								'html_label_text'         => esc_html__(
+									'Show Date & Time Filter?',
+									'event_espresso'
+								),
+								'html_help_text'          => sprintf(
+									esc_html__(
+										'Indicates whether or not to display a dropdown select box above each ticket selector that displays dates and times for the available tickets. Ticket options can be unselected, which removes (hides) them from the list of tickets being displayed.%1$sOptions include:%1$s &bull; %2$sdo not show date & time filter%3$s%1$s &nbsp; this option will NEVER display a date filter, regardless of how many dates exist.%1$s &bull; %2$smaybe show date & time filter%3$s%1$s &nbsp; this option will conditionally display the date filter when the number of dates for the event matches the value set for "Date Filter Threshold".',
+										'event_espresso'
+									),
+									'<br>',
+									'<strong>',
+									'</strong>'
+								),
+								'default'                 => ! empty($show_datetime_selector)
+									? $show_datetime_selector
+									: EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
+								'display_html_label_text' => false,
+							)
+						),
+						'datetime_selector_threshold' => new EE_Select_Input(
+							array_combine($r = range(1, 10), $r),
+							array(
+								'html_label_text'         => esc_html__(
+									'Date & Time Filter Threshold',
+									'event_espresso'
+								),
+								'html_help_text'          => esc_html__(
+									'The number of unique dates an event has to have before conditionally displaying a date & time filter',
+									'event_espresso'
+								),
+								'default'                 => ! empty($datetime_selector_threshold)
+									? $datetime_selector_threshold
+									: 3,
+								'display_html_label_text' => false,
+							)
+						),
+						'datetime_selector_max_checked' => new EE_Integer_Input(
+							array(
+								'html_label_text'         => esc_html__(
+									'Date & Time Filter Max Checked',
+									'event_espresso'
+								),
+								'html_help_text'          => sprintf(
+									esc_html__(
+										'Determines the maximum number of dates that will be checked upon initial loading for a Date and Time Filter.%1$sIf set to zero or left blank, then ALL dates will be checked upon initial loading.',
+										'event_espresso'
+									),
+									'<br>'
+								),
+								'default'                 => $EE_Ticket_Selector_Config->getDatetimeSelectorMaxChecked(),
+								'display_html_label_text' => false,
+								'min_value'               => 0,
+							)
+						),
+					)
+				),
+			)
+		);
+	}
 
 
-    /**
-     * callback for updating template settings
-     *
-     * @since 4.6.18.rc.006
-     * @param EE_Template_Config $CFG
-     * @param array              $REQ incoming request
-     * @return EE_Template_Config
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function update_template_settings(EE_Template_Config $CFG, $REQ)
-    {
-        if (! $CFG->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config) {
-            EED_Ticket_Selector::instance()->set_config();
-            $CFG->EED_Ticket_Selector = EED_Ticket_Selector::instance()->config();
-        }
-        try {
-            $ticket_selector_form = EED_Ticket_Selector_Caff::_ticket_selector_settings_form();
+	/**
+	 * callback for updating template settings
+	 *
+	 * @since 4.6.18.rc.006
+	 * @param EE_Template_Config $CFG
+	 * @param array              $REQ incoming request
+	 * @return EE_Template_Config
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function update_template_settings(EE_Template_Config $CFG, $REQ)
+	{
+		if (! $CFG->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config) {
+			EED_Ticket_Selector::instance()->set_config();
+			$CFG->EED_Ticket_Selector = EED_Ticket_Selector::instance()->config();
+		}
+		try {
+			$ticket_selector_form = EED_Ticket_Selector_Caff::_ticket_selector_settings_form();
 
-            // check for form submission
-            if ($ticket_selector_form->was_submitted()) {
-                // capture form data
-                $ticket_selector_form->receive_form_submission();
+			// check for form submission
+			if ($ticket_selector_form->was_submitted()) {
+				// capture form data
+				$ticket_selector_form->receive_form_submission();
 
-                // validate form data
-                if ($ticket_selector_form->is_valid()) {
-                    // grab validated data from form
-                    $valid_data = $ticket_selector_form->valid_data();
+				// validate form data
+				if ($ticket_selector_form->is_valid()) {
+					// grab validated data from form
+					$valid_data = $ticket_selector_form->valid_data();
 
-                    // set data on config
-                    $CFG->EED_Ticket_Selector->show_ticket_sale_columns = $valid_data['appearance_settings']['show_ticket_sale_columns'];
-                    $CFG->EED_Ticket_Selector->show_ticket_details = $valid_data['appearance_settings']['show_ticket_details'];
-                    $CFG->EED_Ticket_Selector->show_expired_tickets = $valid_data['appearance_settings']['show_expired_tickets'];
-                    $CFG->EED_Ticket_Selector->setShowDatetimeSelector(
-                        $valid_data['appearance_settings']['show_datetime_selector']
-                    );
-                    $CFG->EED_Ticket_Selector->setDatetimeSelectorThreshold(
-                        $valid_data['appearance_settings']['datetime_selector_threshold']
-                    );
-                    $CFG->EED_Ticket_Selector->setDatetimeSelectorMaxChecked(
-                        $valid_data['appearance_settings']['datetime_selector_max_checked']
-                    );
-                } else {
-                    if ($ticket_selector_form->submission_error_message() !== '') {
-                        EE_Error::add_error(
-                            $ticket_selector_form->submission_error_message(),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                }
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
+					// set data on config
+					$CFG->EED_Ticket_Selector->show_ticket_sale_columns = $valid_data['appearance_settings']['show_ticket_sale_columns'];
+					$CFG->EED_Ticket_Selector->show_ticket_details = $valid_data['appearance_settings']['show_ticket_details'];
+					$CFG->EED_Ticket_Selector->show_expired_tickets = $valid_data['appearance_settings']['show_expired_tickets'];
+					$CFG->EED_Ticket_Selector->setShowDatetimeSelector(
+						$valid_data['appearance_settings']['show_datetime_selector']
+					);
+					$CFG->EED_Ticket_Selector->setDatetimeSelectorThreshold(
+						$valid_data['appearance_settings']['datetime_selector_threshold']
+					);
+					$CFG->EED_Ticket_Selector->setDatetimeSelectorMaxChecked(
+						$valid_data['appearance_settings']['datetime_selector_max_checked']
+					);
+				} else {
+					if ($ticket_selector_form->submission_error_message() !== '') {
+						EE_Error::add_error(
+							$ticket_selector_form->submission_error_message(),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				}
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
 
-        return $CFG;
-    }
+		return $CFG;
+	}
 
 
-    /**
-     * @param \EE_Ticket $ticket
-     * @param int        $ticket_price
-     * @param bool       $display_ticket_price
-     */
-    public static function ticket_price_details(EE_Ticket $ticket, $ticket_price = 0, $display_ticket_price = false)
-    {
-        require str_replace('\\', '/', plugin_dir_path(__FILE__))
-                . 'templates/ticket_selector_price_details.template.php';
-    }
+	/**
+	 * @param \EE_Ticket $ticket
+	 * @param int        $ticket_price
+	 * @param bool       $display_ticket_price
+	 */
+	public static function ticket_price_details(EE_Ticket $ticket, $ticket_price = 0, $display_ticket_price = false)
+	{
+		require str_replace('\\', '/', plugin_dir_path(__FILE__))
+				. 'templates/ticket_selector_price_details.template.php';
+	}
 }

core/libraries/line_item_display/EE_SPCO_Line_Item_Display_Strategy.strategy.php

Spacing +19 added lines, -19 removed lines

@@ -84,7 +84,7 @@ 
         $html = '';
         // set some default options and merge with incoming
         $default_options = array(
-            'show_desc' => true,  //    true        false
+            'show_desc' => true, //    true        false
             'odd'       => false,
         );
         $options = array_merge($default_options, (array) $options);
@@ -119,7 +119,7 @@ 
                 $text = esc_html__('Sub-Total', 'event_espresso');
                 if ($line_item->OBJ_type() === 'Event') {
                     $options['event_id'] = $event_id = $line_item->OBJ_ID();
-                    if (! isset($this->_events[ $options['event_id'] ])) {
+                    if ( ! isset($this->_events[$options['event_id']])) {
                         $event = EEM_Event::instance()->get_one_by_ID($options['event_id']);
                         // if event has default reg status of Not Approved, then don't display info on it
                         if (
@@ -130,7 +130,7 @@ 
                             // unless there are registrations for it that are returning to pay
                             if (isset($options['registrations']) && is_array($options['registrations'])) {
                                 foreach ($options['registrations'] as $registration) {
-                                    if (! $registration instanceof EE_Registration) {
+                                    if ( ! $registration instanceof EE_Registration) {
                                         continue;
                                     }
                                     $display_event = $registration->event_ID() === $options['event_id']
@@ -139,11 +139,11 @@ 
                                         : $display_event;
                                 }
                             }
-                            if (! $display_event) {
+                            if ( ! $display_event) {
                                 return '';
                             }
                         }
-                        $this->_events[ $options['event_id'] ] = 0;
+                        $this->_events[$options['event_id']] = 0;
                         $html .= $this->_event_row($line_item);
                         $text = esc_html__('Event Sub-Total', 'event_espresso');
                     }
@@ -154,7 +154,7 @@ 
                     // recursively feed children back into this method
                     $html .= $this->display_line_item($child_line_item, $options, $line_item);
                 }
-                $event_sub_total += isset($options['event_id']) ? $this->_events[ $options['event_id'] ] : 0;
+                $event_sub_total += isset($options['event_id']) ? $this->_events[$options['event_id']] : 0;
                 $sub_total += $event_sub_total;
                 if (
                     (
@@ -263,7 +263,7 @@ 
             'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
             (
                 $options['show_desc']
-                    ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
+                    ? '<span class="line-item-desc-spn smaller-text">: '.$line_item->desc().'</span>'
                     : ''
             ),
             $line_item,
@@ -299,7 +299,7 @@ 
             $line_item->total(),
             $line_item
         );
-        $this->_events[ $options['event_id'] ] += $total;
+        $this->_events[$options['event_id']] += $total;
         // total td
         $html .= EEH_HTML::td(
             EEH_Template::format_currency($total, false, false),
@@ -326,18 +326,18 @@ 
         // start of row
         $row_class = $options['odd'] ? 'item odd' : 'item';
         $html = EEH_HTML::tr('', '', $row_class);
-        $obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() . ': ' : '';
+        $obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n().': ' : '';
         // name && desc
         $name_and_desc = apply_filters(
             'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
-            $obj_name . $line_item->name(),
+            $obj_name.$line_item->name(),
             $line_item
         );
         $name_and_desc .= apply_filters(
             'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
             (
                 $options['show_desc']
-                ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
+                ? '<span class="line-item-desc-spn smaller-text">: '.$line_item->desc().'</span>'
                 : ''
             ),
             $line_item,
@@ -355,7 +355,7 @@ 
         $html .= EEH_HTML::td($name_and_desc, '', 'item_l');
         // price td
         if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c jst-rght');
+            $html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c jst-rght');
         } else {
             $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
         }
@@ -363,8 +363,8 @@ 
         $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
         // $total = $line_item->total() * $line_item->quantity();
         $total = $line_item->total();
-        if (isset($options['event_id'], $this->_events[ $options['event_id'] ])) {
-            $this->_events[ $options['event_id'] ] += $total;
+        if (isset($options['event_id'], $this->_events[$options['event_id']])) {
+            $this->_events[$options['event_id']] += $total;
         }
         // total td
         $html .= EEH_HTML::td(
@@ -459,8 +459,8 @@ 
         // name && desc
         $name_and_desc = $line_item->name();
         $name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">'
-                          . esc_html__(' * taxable items', 'event_espresso') . '</span>';
-        $name_and_desc .= $options['show_desc'] ? '<br/>' . $line_item->desc() : '';
+                          . esc_html__(' * taxable items', 'event_espresso').'</span>';
+        $name_and_desc .= $options['show_desc'] ? '<br/>'.$line_item->desc() : '';
         // name td
         $html .= EEH_HTML::td( /*__FUNCTION__ .*/
             $name_and_desc,
@@ -468,7 +468,7 @@ 
             'item_l sub-item'
         );
         // percent td
-        $html .= EEH_HTML::td($line_item->percent() . '%', '', ' jst-rght', '');
+        $html .= EEH_HTML::td($line_item->percent().'%', '', ' jst-rght', '');
         // empty td (price)
         $html .= EEH_HTML::td(EEH_HTML::nbsp());
         // total td
@@ -613,7 +613,7 @@ 
                     $registration_payments += $registration->registration_payments();
                 }
             }
-            if (! empty($registration_payments)) {
+            if ( ! empty($registration_payments)) {
                 foreach ($registration_payments as $registration_payment) {
                     if ($registration_payment instanceof EE_Registration_Payment) {
                         $owing -= $registration_payment->amount();
@@ -623,7 +623,7 @@ 
                             $payment_desc = sprintf(
                                 esc_html__('Payment%1$s Received: %2$s', 'event_espresso'),
                                 $payment->txn_id_chq_nmbr() !== ''
-                                    ? ' <span class="small-text">(#' . $payment->txn_id_chq_nmbr() . ')</span> '
+                                    ? ' <span class="small-text">(#'.$payment->txn_id_chq_nmbr().')</span> '
                                     : '',
                                 $payment->timestamp()
                             );

Indentation +659 added lines, -659 removed lines

@@ -11,663 +11,663 @@
  */
 class EE_SPCO_Line_Item_Display_Strategy implements EEI_Line_Item_Display
 {
-    /**
-     * array of events
-     *
-     * @type EE_Line_Item[] $_events
-     */
-    private $_events = array();
-
-    /**
-     * whether to display the taxes row or not
-     *
-     * @type bool $_show_taxes
-     */
-    private $_show_taxes = false;
-
-    /**
-     * html for any tax rows
-     *
-     * @type string $_show_taxes
-     */
-    private $_taxes_html = '';
-
-    /**
-     * total amount including tax we can bill for at this time
-     *
-     * @type float $_grand_total
-     */
-    private $_grand_total = 0.00;
-
-    /**
-     * total number of items being billed for
-     *
-     * @type int $_total_items
-     */
-    private $_total_items = 0;
-
-
-
-    /**
-     * @return float
-     */
-    public function grand_total()
-    {
-        return $this->_grand_total;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function total_items()
-    {
-        return $this->_total_items;
-    }
-
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @param EE_Line_Item $parent_line_item
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function display_line_item(
-        EE_Line_Item $line_item,
-        $options = array(),
-        EE_Line_Item $parent_line_item = null
-    ) {
-        $html = '';
-        // set some default options and merge with incoming
-        $default_options = array(
-            'show_desc' => true,  //    true        false
-            'odd'       => false,
-        );
-        $options = array_merge($default_options, (array) $options);
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_line_item:
-                $this->_show_taxes = $line_item->is_taxable() ? true : $this->_show_taxes;
-                if ($line_item->OBJ_type() === 'Ticket') {
-                    // item row
-                    $html .= $this->_ticket_row($line_item, $options);
-                } else {
-                    // item row
-                    $html .= $this->_item_row($line_item, $options);
-                }
-                if (
-                    apply_filters(
-                        'FHEE__EE_SPCO_Line_Item_Display_Strategy__display_line_item__display_sub_line_items',
-                        true
-                    )
-                ) {
-                    // got any kids?
-                    foreach ($line_item->children() as $child_line_item) {
-                        $html .= $this->display_line_item($child_line_item, $options, $line_item);
-                    }
-                }
-                break;
-            case EEM_Line_Item::type_sub_line_item:
-                $html .= $this->_sub_item_row($line_item, $options, $parent_line_item);
-                break;
-            case EEM_Line_Item::type_sub_total:
-                static $sub_total = 0;
-                $event_sub_total = 0;
-                $text = esc_html__('Sub-Total', 'event_espresso');
-                if ($line_item->OBJ_type() === 'Event') {
-                    $options['event_id'] = $event_id = $line_item->OBJ_ID();
-                    if (! isset($this->_events[ $options['event_id'] ])) {
-                        $event = EEM_Event::instance()->get_one_by_ID($options['event_id']);
-                        // if event has default reg status of Not Approved, then don't display info on it
-                        if (
-                            $event instanceof EE_Event
-                            && $event->default_registration_status() === EEM_Registration::status_id_not_approved
-                        ) {
-                            $display_event = false;
-                            // unless there are registrations for it that are returning to pay
-                            if (isset($options['registrations']) && is_array($options['registrations'])) {
-                                foreach ($options['registrations'] as $registration) {
-                                    if (! $registration instanceof EE_Registration) {
-                                        continue;
-                                    }
-                                    $display_event = $registration->event_ID() === $options['event_id']
-                                                     && $registration->status_ID() !== EEM_Registration::status_id_not_approved
-                                        ? true
-                                        : $display_event;
-                                }
-                            }
-                            if (! $display_event) {
-                                return '';
-                            }
-                        }
-                        $this->_events[ $options['event_id'] ] = 0;
-                        $html .= $this->_event_row($line_item);
-                        $text = esc_html__('Event Sub-Total', 'event_espresso');
-                    }
-                }
-                $child_line_items = $line_item->children();
-                // loop thru children
-                foreach ($child_line_items as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options, $line_item);
-                }
-                $event_sub_total += isset($options['event_id']) ? $this->_events[ $options['event_id'] ] : 0;
-                $sub_total += $event_sub_total;
-                if (
-                    (
-                        // event subtotals
-                        $line_item->code() !== 'pre-tax-subtotal' && count($child_line_items) > 1
-                    )
-                    || (
-                        // pre-tax subtotals
-                        $line_item->code() === 'pre-tax-subtotal' && count($this->_events) > 1
-                    )
-                ) {
-                    $options['sub_total'] = $line_item->OBJ_type() === 'Event' ? $event_sub_total : $sub_total;
-                    $html .= $this->_sub_total_row($line_item, $text, $options);
-                }
-                break;
-            case EEM_Line_Item::type_tax:
-                if ($this->_show_taxes) {
-                    $this->_taxes_html .= $this->_tax_row($line_item, $options);
-                }
-                break;
-            case EEM_Line_Item::type_tax_sub_total:
-                if ($this->_show_taxes) {
-                    $child_line_items = $line_item->children();
-                    // loop thru children
-                    foreach ($child_line_items as $child_line_item) {
-                        // recursively feed children back into this method
-                        $html .= $this->display_line_item($child_line_item, $options, $line_item);
-                    }
-                    if (count($child_line_items) > 1) {
-                        $this->_taxes_html .= $this->_total_tax_row($line_item, esc_html__('Tax Total', 'event_espresso'));
-                    }
-                }
-                break;
-            case EEM_Line_Item::type_total:
-                // get all child line items
-                $children = $line_item->children();
-                // loop thru all non-tax child line items
-                foreach ($children as $child_line_item) {
-                    if ($child_line_item->type() !== EEM_Line_Item::type_tax_sub_total) {
-                        // recursively feed children back into this method
-                        $html .= $this->display_line_item($child_line_item, $options, $line_item);
-                    }
-                }
-                // now loop thru  tax child line items
-                foreach ($children as $child_line_item) {
-                    if ($child_line_item->type() === EEM_Line_Item::type_tax_sub_total) {
-                        // recursively feed children back into this method
-                        $html .= $this->display_line_item($child_line_item, $options, $line_item);
-                    }
-                }
-                $html .= $this->_taxes_html;
-                $html .= $this->_total_row($line_item, esc_html__('Total', 'event_espresso'));
-                $html .= $this->_payments_and_amount_owing_rows($line_item, $options);
-                break;
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * _event_row - basically a Heading row displayed once above each event's ticket rows
-     *
-     * @param EE_Line_Item $line_item
-     * @return mixed
-     */
-    private function _event_row(EE_Line_Item $line_item)
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'event-cart-total-row', 'total_tr odd');
-        // event name td
-        $html .= EEH_HTML::td(
-            EEH_HTML::strong($line_item->name()),
-            '',
-            'event-header',
-            '',
-            ' colspan="4"'
-        );
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     * _ticket_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _ticket_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html = EEH_HTML::tr('', '', $row_class);
-        // name && desc
-        $name_and_desc = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
-            $line_item->name(),
-            $line_item
-        );
-        $name_and_desc .= apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
-            (
-                $options['show_desc']
-                    ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
-                    : ''
-            ),
-            $line_item,
-            $options
-        );
-        $name_and_desc .= $line_item->is_taxable() ? ' * ' : '';
-        $name_and_desc = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy___ticket_row__name_and_desc',
-            $name_and_desc,
-            $line_item,
-            $options
-        );
-
-        // name td
-        $html .= EEH_HTML::td( /*__FUNCTION__ .*/
-            $name_and_desc,
-            '',
-            'item_l'
-        );
-        // price td
-        $price = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy___ticket_row__price',
-            $line_item->unit_price_no_code(),
-            $line_item
-        );
-        $html .= EEH_HTML::td($price, '', 'item_c jst-rght');
-        // quantity td
-        $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
-        $this->_total_items += $line_item->quantity();
-        // determine total for line item
-        $total = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy___ticket_row__total',
-            $line_item->total(),
-            $line_item
-        );
-        $this->_events[ $options['event_id'] ] += $total;
-        // total td
-        $html .= EEH_HTML::td(
-            EEH_Template::format_currency($total, false, false),
-            '',
-            'item_r jst-rght'
-        );
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     * _item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _item_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html = EEH_HTML::tr('', '', $row_class);
-        $obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() . ': ' : '';
-        // name && desc
-        $name_and_desc = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
-            $obj_name . $line_item->name(),
-            $line_item
-        );
-        $name_and_desc .= apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
-            (
-                $options['show_desc']
-                ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
-                : ''
-            ),
-            $line_item,
-            $options
-        );
-        $name_and_desc .= $line_item->is_taxable() ? ' * ' : '';
-        $name_and_desc = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy___item_row__name_and_desc',
-            $name_and_desc,
-            $line_item,
-            $options
-        );
-
-        // name td
-        $html .= EEH_HTML::td($name_and_desc, '', 'item_l');
-        // price td
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c jst-rght');
-        } else {
-            $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
-        }
-        // quantity td
-        $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
-        // $total = $line_item->total() * $line_item->quantity();
-        $total = $line_item->total();
-        if (isset($options['event_id'], $this->_events[ $options['event_id'] ])) {
-            $this->_events[ $options['event_id'] ] += $total;
-        }
-        // total td
-        $html .= EEH_HTML::td(
-            EEH_Template::format_currency($total, false, false),
-            '',
-            'item_r jst-rght'
-        );
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     * _sub_item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @param EE_Line_Item $parent_line_item
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _sub_item_row(EE_Line_Item $line_item, $options = array(), EE_Line_Item $parent_line_item = null)
-    {
-        if (
-            $parent_line_item instanceof  EE_Line_Item
-            && $line_item->children() === array()
-            && $line_item->name() === $parent_line_item->name()
-            && apply_filters(
-                'FHEE__EE_SPCO_Line_Item_Display_Strategy___sub_item_row__hide_main_sub_line_item',
-                true
-            )
-        ) {
-            return '';
-        }
-        // start of row
-        $html = EEH_HTML::tr('', '', 'item sub-item-row');
-        // name && desc
-        $name_and_desc = EEH_HTML::span('', '', 'sub-item-row-bullet dashicons dashicons-arrow-right')
-                         . $line_item->name();
-        $name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: '
-                                                  . $line_item->desc()
-                                                  . '</span>' : '';
-        // name td
-        $html .= EEH_HTML::td($name_and_desc, '', 'item_l sub-item');
-        $qty = $parent_line_item instanceof EE_Line_Item ? $parent_line_item->quantity() : 1;
-        // discount/surcharge td
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td(
-                EEH_Template::format_currency(
-                    $line_item->total() / $qty,
-                    false,
-                    false
-                ),
-                '',
-                'item_c jst-rght'
-            );
-        } else {
-            $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
-        }
-        // no quantity td
-        $html .= EEH_HTML::td();
-        // no total td
-        $html .= EEH_HTML::td();
-        // end of row
-        $html .= EEH_HTML::trx();
-        $html = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy___sub_item_row__html',
-            $html,
-            $line_item,
-            $options,
-            $parent_line_item
-        );
-        return $html;
-    }
-
-
-
-    /**
-     * _tax_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _tax_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'item sub-item tax-total');
-        // name && desc
-        $name_and_desc = $line_item->name();
-        $name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">'
-                          . esc_html__(' * taxable items', 'event_espresso') . '</span>';
-        $name_and_desc .= $options['show_desc'] ? '<br/>' . $line_item->desc() : '';
-        // name td
-        $html .= EEH_HTML::td( /*__FUNCTION__ .*/
-            $name_and_desc,
-            '',
-            'item_l sub-item'
-        );
-        // percent td
-        $html .= EEH_HTML::td($line_item->percent() . '%', '', ' jst-rght', '');
-        // empty td (price)
-        $html .= EEH_HTML::td(EEH_HTML::nbsp());
-        // total td
-        $html .= EEH_HTML::td(
-            EEH_Template::format_currency(
-                $line_item->total(),
-                false,
-                false
-            ),
-            '',
-            'item_r jst-rght'
-        );
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     * _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param string       $text
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _total_tax_row(EE_Line_Item $line_item, $text = '')
-    {
-        $html = '';
-        if ($line_item->total()) {
-            // start of row
-            $html = EEH_HTML::tr('', '', 'total_tr odd');
-            // total td
-            $html .= EEH_HTML::td(
-                $text,
-                '',
-                'total_currency total jst-rght',
-                '',
-                ' colspan="2"'
-            );
-            // empty td (price)
-            $html .= EEH_HTML::td(EEH_HTML::nbsp());
-            // total td
-            $html .= EEH_HTML::td(
-                EEH_Template::format_currency($line_item->total(), false, false),
-                '',
-                'total jst-rght'
-            );
-            // end of row
-            $html .= EEH_HTML::trx();
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param string       $text
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _sub_total_row(EE_Line_Item $line_item, $text = '', $options = array())
-    {
-        $html = '';
-        if ($line_item->total()) {
-            // start of row
-            $html = EEH_HTML::tr('', '', 'total_tr odd');
-            // total td
-            $html .= EEH_HTML::td(
-                $text,
-                '',
-                'total_currency total jst-rght',
-                '',
-                ' colspan="3"'
-            );
-            // total td
-            $html .= EEH_HTML::td(
-                EEH_Template::format_currency($options['sub_total'], false, false),
-                '',
-                'total jst-rght'
-            );
-            // end of row
-            $html .= EEH_HTML::trx();
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param string       $text
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _total_row(EE_Line_Item $line_item, $text = '')
-    {
-        // start of row
-        $html = EEH_HTML::tr('', '', 'spco-grand-total total_tr odd');
-        // total td
-        $html .= EEH_HTML::td($text, '', 'total_currency total jst-rght', '', ' colspan="3"');
-        // total td
-        $html .= EEH_HTML::td(
-            EEH_Template::format_currency($line_item->total(), false, false),
-            '',
-            'total jst-rght'
-        );
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     * _payments_and_amount_owing_rows
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _payments_and_amount_owing_rows(EE_Line_Item $line_item, $options = array())
-    {
-        $html = '';
-        $owing = $line_item->total();
-        $transaction = EEM_Transaction::instance()->get_one_by_ID($line_item->TXN_ID());
-        if ($transaction instanceof EE_Transaction) {
-            $registration_payments = array();
-            $registrations = ! empty($options['registrations'])
-                ? $options['registrations']
-                : $transaction->registrations();
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
-                    $registration_payments += $registration->registration_payments();
-                }
-            }
-            if (! empty($registration_payments)) {
-                foreach ($registration_payments as $registration_payment) {
-                    if ($registration_payment instanceof EE_Registration_Payment) {
-                        $owing -= $registration_payment->amount();
-                        $payment = $registration_payment->payment();
-                        $payment_desc = '';
-                        if ($payment instanceof EE_Payment) {
-                            $payment_desc = sprintf(
-                                esc_html__('Payment%1$s Received: %2$s', 'event_espresso'),
-                                $payment->txn_id_chq_nmbr() !== ''
-                                    ? ' <span class="small-text">(#' . $payment->txn_id_chq_nmbr() . ')</span> '
-                                    : '',
-                                $payment->timestamp()
-                            );
-                        }
-                        // start of row
-                        $html .= EEH_HTML::tr('', '', 'total_tr odd');
-                        // payment desc
-                        $html .= EEH_HTML::td($payment_desc, '', '', '', ' colspan="3"');
-                        // total td
-                        $html .= EEH_HTML::td(
-                            EEH_Template::format_currency(
-                                $registration_payment->amount(),
-                                false,
-                                false
-                            ),
-                            '',
-                            'total jst-rght'
-                        );
-                        // end of row
-                        $html .= EEH_HTML::trx();
-                    }
-                }
-                if ($line_item->total()) {
-                    // start of row
-                    $html .= EEH_HTML::tr('', '', 'total_tr odd');
-                    // total td
-                    $html .= EEH_HTML::td(
-                        esc_html__('Amount Owing', 'event_espresso'),
-                        '',
-                        'total_currency total jst-rght',
-                        '',
-                        ' colspan="3"'
-                    );
-                    // total td
-                    $html .= EEH_HTML::td(
-                        EEH_Template::format_currency($owing, false, false),
-                        '',
-                        'total jst-rght'
-                    );
-                    // end of row
-                    $html .= EEH_HTML::trx();
-                }
-            }
-        }
-        $this->_grand_total = $owing;
-        return $html;
-    }
+	/**
+	 * array of events
+	 *
+	 * @type EE_Line_Item[] $_events
+	 */
+	private $_events = array();
+
+	/**
+	 * whether to display the taxes row or not
+	 *
+	 * @type bool $_show_taxes
+	 */
+	private $_show_taxes = false;
+
+	/**
+	 * html for any tax rows
+	 *
+	 * @type string $_show_taxes
+	 */
+	private $_taxes_html = '';
+
+	/**
+	 * total amount including tax we can bill for at this time
+	 *
+	 * @type float $_grand_total
+	 */
+	private $_grand_total = 0.00;
+
+	/**
+	 * total number of items being billed for
+	 *
+	 * @type int $_total_items
+	 */
+	private $_total_items = 0;
+
+
+
+	/**
+	 * @return float
+	 */
+	public function grand_total()
+	{
+		return $this->_grand_total;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function total_items()
+	{
+		return $this->_total_items;
+	}
+
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @param EE_Line_Item $parent_line_item
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function display_line_item(
+		EE_Line_Item $line_item,
+		$options = array(),
+		EE_Line_Item $parent_line_item = null
+	) {
+		$html = '';
+		// set some default options and merge with incoming
+		$default_options = array(
+			'show_desc' => true,  //    true        false
+			'odd'       => false,
+		);
+		$options = array_merge($default_options, (array) $options);
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_line_item:
+				$this->_show_taxes = $line_item->is_taxable() ? true : $this->_show_taxes;
+				if ($line_item->OBJ_type() === 'Ticket') {
+					// item row
+					$html .= $this->_ticket_row($line_item, $options);
+				} else {
+					// item row
+					$html .= $this->_item_row($line_item, $options);
+				}
+				if (
+					apply_filters(
+						'FHEE__EE_SPCO_Line_Item_Display_Strategy__display_line_item__display_sub_line_items',
+						true
+					)
+				) {
+					// got any kids?
+					foreach ($line_item->children() as $child_line_item) {
+						$html .= $this->display_line_item($child_line_item, $options, $line_item);
+					}
+				}
+				break;
+			case EEM_Line_Item::type_sub_line_item:
+				$html .= $this->_sub_item_row($line_item, $options, $parent_line_item);
+				break;
+			case EEM_Line_Item::type_sub_total:
+				static $sub_total = 0;
+				$event_sub_total = 0;
+				$text = esc_html__('Sub-Total', 'event_espresso');
+				if ($line_item->OBJ_type() === 'Event') {
+					$options['event_id'] = $event_id = $line_item->OBJ_ID();
+					if (! isset($this->_events[ $options['event_id'] ])) {
+						$event = EEM_Event::instance()->get_one_by_ID($options['event_id']);
+						// if event has default reg status of Not Approved, then don't display info on it
+						if (
+							$event instanceof EE_Event
+							&& $event->default_registration_status() === EEM_Registration::status_id_not_approved
+						) {
+							$display_event = false;
+							// unless there are registrations for it that are returning to pay
+							if (isset($options['registrations']) && is_array($options['registrations'])) {
+								foreach ($options['registrations'] as $registration) {
+									if (! $registration instanceof EE_Registration) {
+										continue;
+									}
+									$display_event = $registration->event_ID() === $options['event_id']
+													 && $registration->status_ID() !== EEM_Registration::status_id_not_approved
+										? true
+										: $display_event;
+								}
+							}
+							if (! $display_event) {
+								return '';
+							}
+						}
+						$this->_events[ $options['event_id'] ] = 0;
+						$html .= $this->_event_row($line_item);
+						$text = esc_html__('Event Sub-Total', 'event_espresso');
+					}
+				}
+				$child_line_items = $line_item->children();
+				// loop thru children
+				foreach ($child_line_items as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options, $line_item);
+				}
+				$event_sub_total += isset($options['event_id']) ? $this->_events[ $options['event_id'] ] : 0;
+				$sub_total += $event_sub_total;
+				if (
+					(
+						// event subtotals
+						$line_item->code() !== 'pre-tax-subtotal' && count($child_line_items) > 1
+					)
+					|| (
+						// pre-tax subtotals
+						$line_item->code() === 'pre-tax-subtotal' && count($this->_events) > 1
+					)
+				) {
+					$options['sub_total'] = $line_item->OBJ_type() === 'Event' ? $event_sub_total : $sub_total;
+					$html .= $this->_sub_total_row($line_item, $text, $options);
+				}
+				break;
+			case EEM_Line_Item::type_tax:
+				if ($this->_show_taxes) {
+					$this->_taxes_html .= $this->_tax_row($line_item, $options);
+				}
+				break;
+			case EEM_Line_Item::type_tax_sub_total:
+				if ($this->_show_taxes) {
+					$child_line_items = $line_item->children();
+					// loop thru children
+					foreach ($child_line_items as $child_line_item) {
+						// recursively feed children back into this method
+						$html .= $this->display_line_item($child_line_item, $options, $line_item);
+					}
+					if (count($child_line_items) > 1) {
+						$this->_taxes_html .= $this->_total_tax_row($line_item, esc_html__('Tax Total', 'event_espresso'));
+					}
+				}
+				break;
+			case EEM_Line_Item::type_total:
+				// get all child line items
+				$children = $line_item->children();
+				// loop thru all non-tax child line items
+				foreach ($children as $child_line_item) {
+					if ($child_line_item->type() !== EEM_Line_Item::type_tax_sub_total) {
+						// recursively feed children back into this method
+						$html .= $this->display_line_item($child_line_item, $options, $line_item);
+					}
+				}
+				// now loop thru  tax child line items
+				foreach ($children as $child_line_item) {
+					if ($child_line_item->type() === EEM_Line_Item::type_tax_sub_total) {
+						// recursively feed children back into this method
+						$html .= $this->display_line_item($child_line_item, $options, $line_item);
+					}
+				}
+				$html .= $this->_taxes_html;
+				$html .= $this->_total_row($line_item, esc_html__('Total', 'event_espresso'));
+				$html .= $this->_payments_and_amount_owing_rows($line_item, $options);
+				break;
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * _event_row - basically a Heading row displayed once above each event's ticket rows
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return mixed
+	 */
+	private function _event_row(EE_Line_Item $line_item)
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'event-cart-total-row', 'total_tr odd');
+		// event name td
+		$html .= EEH_HTML::td(
+			EEH_HTML::strong($line_item->name()),
+			'',
+			'event-header',
+			'',
+			' colspan="4"'
+		);
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 * _ticket_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _ticket_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html = EEH_HTML::tr('', '', $row_class);
+		// name && desc
+		$name_and_desc = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
+			$line_item->name(),
+			$line_item
+		);
+		$name_and_desc .= apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
+			(
+				$options['show_desc']
+					? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
+					: ''
+			),
+			$line_item,
+			$options
+		);
+		$name_and_desc .= $line_item->is_taxable() ? ' * ' : '';
+		$name_and_desc = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy___ticket_row__name_and_desc',
+			$name_and_desc,
+			$line_item,
+			$options
+		);
+
+		// name td
+		$html .= EEH_HTML::td( /*__FUNCTION__ .*/
+			$name_and_desc,
+			'',
+			'item_l'
+		);
+		// price td
+		$price = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy___ticket_row__price',
+			$line_item->unit_price_no_code(),
+			$line_item
+		);
+		$html .= EEH_HTML::td($price, '', 'item_c jst-rght');
+		// quantity td
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
+		$this->_total_items += $line_item->quantity();
+		// determine total for line item
+		$total = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy___ticket_row__total',
+			$line_item->total(),
+			$line_item
+		);
+		$this->_events[ $options['event_id'] ] += $total;
+		// total td
+		$html .= EEH_HTML::td(
+			EEH_Template::format_currency($total, false, false),
+			'',
+			'item_r jst-rght'
+		);
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 * _item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _item_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html = EEH_HTML::tr('', '', $row_class);
+		$obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() . ': ' : '';
+		// name && desc
+		$name_and_desc = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
+			$obj_name . $line_item->name(),
+			$line_item
+		);
+		$name_and_desc .= apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
+			(
+				$options['show_desc']
+				? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
+				: ''
+			),
+			$line_item,
+			$options
+		);
+		$name_and_desc .= $line_item->is_taxable() ? ' * ' : '';
+		$name_and_desc = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy___item_row__name_and_desc',
+			$name_and_desc,
+			$line_item,
+			$options
+		);
+
+		// name td
+		$html .= EEH_HTML::td($name_and_desc, '', 'item_l');
+		// price td
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c jst-rght');
+		} else {
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
+		}
+		// quantity td
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
+		// $total = $line_item->total() * $line_item->quantity();
+		$total = $line_item->total();
+		if (isset($options['event_id'], $this->_events[ $options['event_id'] ])) {
+			$this->_events[ $options['event_id'] ] += $total;
+		}
+		// total td
+		$html .= EEH_HTML::td(
+			EEH_Template::format_currency($total, false, false),
+			'',
+			'item_r jst-rght'
+		);
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 * _sub_item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @param EE_Line_Item $parent_line_item
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _sub_item_row(EE_Line_Item $line_item, $options = array(), EE_Line_Item $parent_line_item = null)
+	{
+		if (
+			$parent_line_item instanceof  EE_Line_Item
+			&& $line_item->children() === array()
+			&& $line_item->name() === $parent_line_item->name()
+			&& apply_filters(
+				'FHEE__EE_SPCO_Line_Item_Display_Strategy___sub_item_row__hide_main_sub_line_item',
+				true
+			)
+		) {
+			return '';
+		}
+		// start of row
+		$html = EEH_HTML::tr('', '', 'item sub-item-row');
+		// name && desc
+		$name_and_desc = EEH_HTML::span('', '', 'sub-item-row-bullet dashicons dashicons-arrow-right')
+						 . $line_item->name();
+		$name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: '
+												  . $line_item->desc()
+												  . '</span>' : '';
+		// name td
+		$html .= EEH_HTML::td($name_and_desc, '', 'item_l sub-item');
+		$qty = $parent_line_item instanceof EE_Line_Item ? $parent_line_item->quantity() : 1;
+		// discount/surcharge td
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td(
+				EEH_Template::format_currency(
+					$line_item->total() / $qty,
+					false,
+					false
+				),
+				'',
+				'item_c jst-rght'
+			);
+		} else {
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
+		}
+		// no quantity td
+		$html .= EEH_HTML::td();
+		// no total td
+		$html .= EEH_HTML::td();
+		// end of row
+		$html .= EEH_HTML::trx();
+		$html = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy___sub_item_row__html',
+			$html,
+			$line_item,
+			$options,
+			$parent_line_item
+		);
+		return $html;
+	}
+
+
+
+	/**
+	 * _tax_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _tax_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'item sub-item tax-total');
+		// name && desc
+		$name_and_desc = $line_item->name();
+		$name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">'
+						  . esc_html__(' * taxable items', 'event_espresso') . '</span>';
+		$name_and_desc .= $options['show_desc'] ? '<br/>' . $line_item->desc() : '';
+		// name td
+		$html .= EEH_HTML::td( /*__FUNCTION__ .*/
+			$name_and_desc,
+			'',
+			'item_l sub-item'
+		);
+		// percent td
+		$html .= EEH_HTML::td($line_item->percent() . '%', '', ' jst-rght', '');
+		// empty td (price)
+		$html .= EEH_HTML::td(EEH_HTML::nbsp());
+		// total td
+		$html .= EEH_HTML::td(
+			EEH_Template::format_currency(
+				$line_item->total(),
+				false,
+				false
+			),
+			'',
+			'item_r jst-rght'
+		);
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 * _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param string       $text
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _total_tax_row(EE_Line_Item $line_item, $text = '')
+	{
+		$html = '';
+		if ($line_item->total()) {
+			// start of row
+			$html = EEH_HTML::tr('', '', 'total_tr odd');
+			// total td
+			$html .= EEH_HTML::td(
+				$text,
+				'',
+				'total_currency total jst-rght',
+				'',
+				' colspan="2"'
+			);
+			// empty td (price)
+			$html .= EEH_HTML::td(EEH_HTML::nbsp());
+			// total td
+			$html .= EEH_HTML::td(
+				EEH_Template::format_currency($line_item->total(), false, false),
+				'',
+				'total jst-rght'
+			);
+			// end of row
+			$html .= EEH_HTML::trx();
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param string       $text
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _sub_total_row(EE_Line_Item $line_item, $text = '', $options = array())
+	{
+		$html = '';
+		if ($line_item->total()) {
+			// start of row
+			$html = EEH_HTML::tr('', '', 'total_tr odd');
+			// total td
+			$html .= EEH_HTML::td(
+				$text,
+				'',
+				'total_currency total jst-rght',
+				'',
+				' colspan="3"'
+			);
+			// total td
+			$html .= EEH_HTML::td(
+				EEH_Template::format_currency($options['sub_total'], false, false),
+				'',
+				'total jst-rght'
+			);
+			// end of row
+			$html .= EEH_HTML::trx();
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param string       $text
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _total_row(EE_Line_Item $line_item, $text = '')
+	{
+		// start of row
+		$html = EEH_HTML::tr('', '', 'spco-grand-total total_tr odd');
+		// total td
+		$html .= EEH_HTML::td($text, '', 'total_currency total jst-rght', '', ' colspan="3"');
+		// total td
+		$html .= EEH_HTML::td(
+			EEH_Template::format_currency($line_item->total(), false, false),
+			'',
+			'total jst-rght'
+		);
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 * _payments_and_amount_owing_rows
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _payments_and_amount_owing_rows(EE_Line_Item $line_item, $options = array())
+	{
+		$html = '';
+		$owing = $line_item->total();
+		$transaction = EEM_Transaction::instance()->get_one_by_ID($line_item->TXN_ID());
+		if ($transaction instanceof EE_Transaction) {
+			$registration_payments = array();
+			$registrations = ! empty($options['registrations'])
+				? $options['registrations']
+				: $transaction->registrations();
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
+					$registration_payments += $registration->registration_payments();
+				}
+			}
+			if (! empty($registration_payments)) {
+				foreach ($registration_payments as $registration_payment) {
+					if ($registration_payment instanceof EE_Registration_Payment) {
+						$owing -= $registration_payment->amount();
+						$payment = $registration_payment->payment();
+						$payment_desc = '';
+						if ($payment instanceof EE_Payment) {
+							$payment_desc = sprintf(
+								esc_html__('Payment%1$s Received: %2$s', 'event_espresso'),
+								$payment->txn_id_chq_nmbr() !== ''
+									? ' <span class="small-text">(#' . $payment->txn_id_chq_nmbr() . ')</span> '
+									: '',
+								$payment->timestamp()
+							);
+						}
+						// start of row
+						$html .= EEH_HTML::tr('', '', 'total_tr odd');
+						// payment desc
+						$html .= EEH_HTML::td($payment_desc, '', '', '', ' colspan="3"');
+						// total td
+						$html .= EEH_HTML::td(
+							EEH_Template::format_currency(
+								$registration_payment->amount(),
+								false,
+								false
+							),
+							'',
+							'total jst-rght'
+						);
+						// end of row
+						$html .= EEH_HTML::trx();
+					}
+				}
+				if ($line_item->total()) {
+					// start of row
+					$html .= EEH_HTML::tr('', '', 'total_tr odd');
+					// total td
+					$html .= EEH_HTML::td(
+						esc_html__('Amount Owing', 'event_espresso'),
+						'',
+						'total_currency total jst-rght',
+						'',
+						' colspan="3"'
+					);
+					// total td
+					$html .= EEH_HTML::td(
+						EEH_Template::format_currency($owing, false, false),
+						'',
+						'total jst-rght'
+					);
+					// end of row
+					$html .= EEH_HTML::trx();
+				}
+			}
+		}
+		$this->_grand_total = $owing;
+		return $html;
+	}
 }

core/libraries/rest_api/changes/ChangesIn40834.php

Indentation +33 added lines, -33 removed lines

@@ -12,39 +12,39 @@
 class ChangesIn40834 extends ChangesInBase
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function setHooks()
-    {
-        // set a hook to remove the checkout/checkout endpoints if the request
-        // is for lower than 4.8.33
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            array($this, 'removeResponseHeaders'),
-            10,
-            3
-        );
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function setHooks()
+	{
+		// set a hook to remove the checkout/checkout endpoints if the request
+		// is for lower than 4.8.33
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			array($this, 'removeResponseHeaders'),
+			10,
+			3
+		);
+	}
 
 
-    /**
-     * Removes the checkin and checkout endpoints from the index for requests
-     * to api versions lowers than 4.8.33
-     *
-     * @param array  $response_headers
-     * @param Base   $controller
-     * @param string $requested_version
-     * @return array like $routes_on_this_version
-     */
-    public function removeResponseHeaders($response_headers, $controller, $requested_version)
-    {
-        if (
-            $controller instanceof Base
-            && $this->appliesToVersion($requested_version)
-        ) {
-            return array();
-        }
-        return $response_headers;
-    }
+	/**
+	 * Removes the checkin and checkout endpoints from the index for requests
+	 * to api versions lowers than 4.8.33
+	 *
+	 * @param array  $response_headers
+	 * @param Base   $controller
+	 * @param string $requested_version
+	 * @return array like $routes_on_this_version
+	 */
+	public function removeResponseHeaders($response_headers, $controller, $requested_version)
+	{
+		if (
+			$controller instanceof Base
+			&& $this->appliesToVersion($requested_version)
+		) {
+			return array();
+		}
+		return $response_headers;
+	}
 }

core/libraries/rest_api/calculations/Registration.php

Spacing +1 added lines, -1 removed lines

@@ -96,7 +96,7 @@
                     $status_pretty = 'NEVER';
                     break;
             }
-            $checkin_stati[ $datetime_id ] = $status_pretty;
+            $checkin_stati[$datetime_id] = $status_pretty;
         }
         return $checkin_stati;
     }

Indentation +101 added lines, -101 removed lines

@@ -24,109 +24,109 @@
  */
 class Registration extends RegistrationCalculationBase
 {
-    /**
-     * @var EEM_Registration
-     */
-    protected $registration_model;
+	/**
+	 * @var EEM_Registration
+	 */
+	protected $registration_model;
 
-    /**
-     * Registration constructor.
-     * @param EEM_Registration $registration_model
-     */
-    public function __construct(EEM_Registration $registration_model)
-    {
-        $this->registration_model = $registration_model;
-    }
+	/**
+	 * Registration constructor.
+	 * @param EEM_Registration $registration_model
+	 */
+	public function __construct(EEM_Registration $registration_model)
+	{
+		$this->registration_model = $registration_model;
+	}
 
-    /**
-     * Calculates the checkin status for each datetime this registration has access to
-     *
-     * @param array            $wpdb_row
-     * @param WP_REST_Request $request
-     * @param RegistrationControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function datetimeCheckinStati($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) {
-            $reg = $this->registration_model->get_one_by_ID($wpdb_row['Registration.REG_ID']);
-        } else {
-            $reg = null;
-        }
-        if (
-            ! $reg instanceof EE_Registration
-        ) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $wpdb_row['Registration.REG_ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $datetime_ids = EEM_Datetime::instance()->get_col(
-            [
-                [
-                    'Ticket.TKT_ID' => $reg->ticket_ID(),
-                ],
-                'default_where_conditions' => EEM_Base::default_where_conditions_minimum_all,
-            ]
-        );
-        $checkin_stati = array();
-        foreach ($datetime_ids as $datetime_id) {
-            $status = $reg->check_in_status_for_datetime($datetime_id);
-            switch ($status) {
-                case EE_Checkin::status_checked_out:
-                    $status_pretty = 'OUT';
-                    break;
-                case EE_Checkin::status_checked_in:
-                    $status_pretty = 'IN';
-                    break;
-                case EE_Checkin::status_checked_never:
-                default:
-                    $status_pretty = 'NEVER';
-                    break;
-            }
-            $checkin_stati[ $datetime_id ] = $status_pretty;
-        }
-        return $checkin_stati;
-    }
+	/**
+	 * Calculates the checkin status for each datetime this registration has access to
+	 *
+	 * @param array            $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param RegistrationControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function datetimeCheckinStati($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) {
+			$reg = $this->registration_model->get_one_by_ID($wpdb_row['Registration.REG_ID']);
+		} else {
+			$reg = null;
+		}
+		if (
+			! $reg instanceof EE_Registration
+		) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$wpdb_row['Registration.REG_ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$datetime_ids = EEM_Datetime::instance()->get_col(
+			[
+				[
+					'Ticket.TKT_ID' => $reg->ticket_ID(),
+				],
+				'default_where_conditions' => EEM_Base::default_where_conditions_minimum_all,
+			]
+		);
+		$checkin_stati = array();
+		foreach ($datetime_ids as $datetime_id) {
+			$status = $reg->check_in_status_for_datetime($datetime_id);
+			switch ($status) {
+				case EE_Checkin::status_checked_out:
+					$status_pretty = 'OUT';
+					break;
+				case EE_Checkin::status_checked_in:
+					$status_pretty = 'IN';
+					break;
+				case EE_Checkin::status_checked_never:
+				default:
+					$status_pretty = 'NEVER';
+					break;
+			}
+			$checkin_stati[ $datetime_id ] = $status_pretty;
+		}
+		return $checkin_stati;
+	}
 
 
-    /**
-     * Provides an array for all the calculations possible that outlines a json schema for those calculations.
-     * Array is indexed by calculation (snake case) and value is the schema for that calculation.
-     *
-     * @since 4.9.68.p
-     * @return array
-     */
-    public function schemaForCalculations()
-    {
-        return array(
-            'datetime_checkin_stati' => array(
-                'description' => esc_html__(
-                    'Returns the checkin status for each datetime this registration has access to.',
-                    'event_espresso'
-                ),
-                'type' => 'object',
-                'properties' => array(),
-                'additionalProperties' => array(
-                    'description' => esc_html__(
-                        'Keys are date-time ids and values are the check-in status',
-                        'event_espresso'
-                    ),
-                    'type' => 'string'
-                ),
-            ),
-        );
-    }
+	/**
+	 * Provides an array for all the calculations possible that outlines a json schema for those calculations.
+	 * Array is indexed by calculation (snake case) and value is the schema for that calculation.
+	 *
+	 * @since 4.9.68.p
+	 * @return array
+	 */
+	public function schemaForCalculations()
+	{
+		return array(
+			'datetime_checkin_stati' => array(
+				'description' => esc_html__(
+					'Returns the checkin status for each datetime this registration has access to.',
+					'event_espresso'
+				),
+				'type' => 'object',
+				'properties' => array(),
+				'additionalProperties' => array(
+					'description' => esc_html__(
+						'Keys are date-time ids and values are the check-in status',
+						'event_espresso'
+					),
+					'type' => 'string'
+				),
+			),
+		);
+	}
 }

core/libraries/rest_api/CalculatedModelFields.php

Spacing +12 added lines, -12 removed lines

@@ -57,7 +57,7 @@ 
      */
     public function mapping($refresh = false)
     {
-        if (! $this->mapping || $refresh) {
+        if ( ! $this->mapping || $refresh) {
             $this->mapping = $this->generateNewMapping();
         }
         return $this->mapping;
@@ -81,7 +81,7 @@ 
         foreach ($models_with_calculated_fields as $model_name) {
             $calculator = $this->factory->createFromModel($model_name);
             foreach (array_keys(call_user_func(array($calculator, 'schemaForCalculations'))) as $field_name) {
-                $mapping[ $model_name ][ $field_name ] = get_class($calculator);
+                $mapping[$model_name][$field_name] = get_class($calculator);
             }
         }
         return apply_filters(
@@ -108,8 +108,8 @@ 
             foreach ($map_for_model as $calculation_index => $calculations_class) {
                 $calculator = $this->factory->createFromClassname($calculations_class);
                 $schema = call_user_func(array($calculator, 'schemaForCalculation'), $calculation_index);
-                if (! empty($schema)) {
-                    $schema_map[ $map_model ][ $calculation_index ] = $schema;
+                if ( ! empty($schema)) {
+                    $schema_map[$map_model][$calculation_index] = $schema;
                 }
             }
         }
@@ -126,8 +126,8 @@ 
     public function retrieveCalculatedFieldsForModel(EEM_Base $model)
     {
         $mapping = $this->mapping();
-        if (isset($mapping[ $model->get_this_model_name() ])) {
-            return array_keys($mapping[ $model->get_this_model_name() ]);
+        if (isset($mapping[$model->get_this_model_name()])) {
+            return array_keys($mapping[$model->get_this_model_name()]);
         }
         return array();
     }
@@ -140,7 +140,7 @@ 
      */
     public function getJsonSchemaForModel(EEM_Base $model)
     {
-        if (! $this->mapping_schema) {
+        if ( ! $this->mapping_schema) {
             $this->mapping_schema = $this->generateNewMappingSchema();
         }
         return array(
@@ -149,8 +149,8 @@ 
                 'event_espresso'
             ),
             'type' => 'object',
-            'properties' => isset($this->mapping_schema[ $model->get_this_model_name() ])
-                ? $this->mapping_schema[ $model->get_this_model_name() ]
+            'properties' => isset($this->mapping_schema[$model->get_this_model_name()])
+                ? $this->mapping_schema[$model->get_this_model_name()]
                 : array(),
             'additionalProperties' => false,
             'readonly' => true,
@@ -179,10 +179,10 @@ 
     ) {
         $mapping = $this->mapping();
         if (
-            isset($mapping[ $model->get_this_model_name() ])
-            && isset($mapping[ $model->get_this_model_name() ][ $field_name ])
+            isset($mapping[$model->get_this_model_name()])
+            && isset($mapping[$model->get_this_model_name()][$field_name])
         ) {
-            $classname = $mapping[ $model->get_this_model_name() ][ $field_name ];
+            $classname = $mapping[$model->get_this_model_name()][$field_name];
             $calculator = $this->factory->createFromClassname($classname);
             $class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
             return call_user_func(array($calculator, $class_method_name), $wpdb_row, $rest_request, $controller);

Indentation +174 added lines, -174 removed lines

@@ -21,178 +21,178 @@
  */
 class CalculatedModelFields
 {
-    /**
-     * @var array
-     */
-    protected $mapping;
-
-    /**
-     * @var array
-     */
-    protected $mapping_schema;
-
-    /**
-     * @var CalculatedModelFieldsFactory
-     */
-    private $factory;
-
-    /**
-     * CalculatedModelFields constructor.
-     * @param CalculatedModelFieldsFactory $factory
-     */
-    public function __construct(CalculatedModelFieldsFactory $factory)
-    {
-        $this->factory = $factory;
-    }
-    /**
-     * @param bool $refresh
-     * @return array top-level-keys are model names (eg "Event")
-     * next-level are the calculated field names AND method names on classes
-     * which perform calculations, values are the fully qualified classnames which do the calculations
-     * These callbacks should accept as arguments:
-     * the wpdb row results,
-     * the WP_Request object,
-     * the controller object
-     */
-    public function mapping($refresh = false)
-    {
-        if (! $this->mapping || $refresh) {
-            $this->mapping = $this->generateNewMapping();
-        }
-        return $this->mapping;
-    }
-
-
-    /**
-     * Generates a new mapping between model calculated fields and their callbacks
-     *
-     * @return array
-     */
-    protected function generateNewMapping()
-    {
-        $mapping = array();
-        $models_with_calculated_fields = array(
-            'Attendee',
-            'Datetime',
-            'Event',
-            'Registration'
-        );
-        foreach ($models_with_calculated_fields as $model_name) {
-            $calculator = $this->factory->createFromModel($model_name);
-            foreach (array_keys(call_user_func(array($calculator, 'schemaForCalculations'))) as $field_name) {
-                $mapping[ $model_name ][ $field_name ] = get_class($calculator);
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping',
-            $mapping
-        );
-    }
-
-
-    /**
-     * Generates the schema for each calculation index in the calculation map.
-     *
-     * @return array
-     * @throws UnexpectedEntityException
-     */
-    protected function generateNewMappingSchema()
-    {
-        $schema_map = array();
-        foreach ($this->mapping() as $map_model => $map_for_model) {
-            /**
-             * @var string $calculation_index
-             * @var string $calculations_class
-             */
-            foreach ($map_for_model as $calculation_index => $calculations_class) {
-                $calculator = $this->factory->createFromClassname($calculations_class);
-                $schema = call_user_func(array($calculator, 'schemaForCalculation'), $calculation_index);
-                if (! empty($schema)) {
-                    $schema_map[ $map_model ][ $calculation_index ] = $schema;
-                }
-            }
-        }
-        return $schema_map;
-    }
-
-
-    /**
-     * Gets the known calculated fields for model
-     *
-     * @param EEM_Base $model
-     * @return array allowable values for this field
-     */
-    public function retrieveCalculatedFieldsForModel(EEM_Base $model)
-    {
-        $mapping = $this->mapping();
-        if (isset($mapping[ $model->get_this_model_name() ])) {
-            return array_keys($mapping[ $model->get_this_model_name() ]);
-        }
-        return array();
-    }
-
-
-    /**
-     * Returns the JsonSchema for the calculated fields on the given model.
-     * @param EEM_Base $model
-     * @return array
-     */
-    public function getJsonSchemaForModel(EEM_Base $model)
-    {
-        if (! $this->mapping_schema) {
-            $this->mapping_schema = $this->generateNewMappingSchema();
-        }
-        return array(
-            'description' => esc_html__(
-                'Available calculated fields for this model.  Fields are only present in the response if explicitly requested',
-                'event_espresso'
-            ),
-            'type' => 'object',
-            'properties' => isset($this->mapping_schema[ $model->get_this_model_name() ])
-                ? $this->mapping_schema[ $model->get_this_model_name() ]
-                : array(),
-            'additionalProperties' => false,
-            'readonly' => true,
-        );
-    }
-
-
-    /**
-     * Retrieves the value for this calculation
-     *
-     * @param EEM_Base $model
-     * @param string $field_name
-     * @param array $wpdb_row
-     * @param $rest_request
-     * @param BaseController $controller
-     * @return mixed|null
-     * @throws RestException
-     * @throws UnexpectedEntityException
-     */
-    public function retrieveCalculatedFieldValue(
-        EEM_Base $model,
-        $field_name,
-        $wpdb_row,
-        $rest_request,
-        Base $controller
-    ) {
-        $mapping = $this->mapping();
-        if (
-            isset($mapping[ $model->get_this_model_name() ])
-            && isset($mapping[ $model->get_this_model_name() ][ $field_name ])
-        ) {
-            $classname = $mapping[ $model->get_this_model_name() ][ $field_name ];
-            $calculator = $this->factory->createFromClassname($classname);
-            $class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
-            return call_user_func(array($calculator, $class_method_name), $wpdb_row, $rest_request, $controller);
-        }
-        throw new RestException(
-            'calculated_field_does_not_exist',
-            sprintf(
-                esc_html__('There is no calculated field %1$s on resource %2$s', 'event_espresso'),
-                $field_name,
-                $model->get_this_model_name()
-            )
-        );
-    }
+	/**
+	 * @var array
+	 */
+	protected $mapping;
+
+	/**
+	 * @var array
+	 */
+	protected $mapping_schema;
+
+	/**
+	 * @var CalculatedModelFieldsFactory
+	 */
+	private $factory;
+
+	/**
+	 * CalculatedModelFields constructor.
+	 * @param CalculatedModelFieldsFactory $factory
+	 */
+	public function __construct(CalculatedModelFieldsFactory $factory)
+	{
+		$this->factory = $factory;
+	}
+	/**
+	 * @param bool $refresh
+	 * @return array top-level-keys are model names (eg "Event")
+	 * next-level are the calculated field names AND method names on classes
+	 * which perform calculations, values are the fully qualified classnames which do the calculations
+	 * These callbacks should accept as arguments:
+	 * the wpdb row results,
+	 * the WP_Request object,
+	 * the controller object
+	 */
+	public function mapping($refresh = false)
+	{
+		if (! $this->mapping || $refresh) {
+			$this->mapping = $this->generateNewMapping();
+		}
+		return $this->mapping;
+	}
+
+
+	/**
+	 * Generates a new mapping between model calculated fields and their callbacks
+	 *
+	 * @return array
+	 */
+	protected function generateNewMapping()
+	{
+		$mapping = array();
+		$models_with_calculated_fields = array(
+			'Attendee',
+			'Datetime',
+			'Event',
+			'Registration'
+		);
+		foreach ($models_with_calculated_fields as $model_name) {
+			$calculator = $this->factory->createFromModel($model_name);
+			foreach (array_keys(call_user_func(array($calculator, 'schemaForCalculations'))) as $field_name) {
+				$mapping[ $model_name ][ $field_name ] = get_class($calculator);
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping',
+			$mapping
+		);
+	}
+
+
+	/**
+	 * Generates the schema for each calculation index in the calculation map.
+	 *
+	 * @return array
+	 * @throws UnexpectedEntityException
+	 */
+	protected function generateNewMappingSchema()
+	{
+		$schema_map = array();
+		foreach ($this->mapping() as $map_model => $map_for_model) {
+			/**
+			 * @var string $calculation_index
+			 * @var string $calculations_class
+			 */
+			foreach ($map_for_model as $calculation_index => $calculations_class) {
+				$calculator = $this->factory->createFromClassname($calculations_class);
+				$schema = call_user_func(array($calculator, 'schemaForCalculation'), $calculation_index);
+				if (! empty($schema)) {
+					$schema_map[ $map_model ][ $calculation_index ] = $schema;
+				}
+			}
+		}
+		return $schema_map;
+	}
+
+
+	/**
+	 * Gets the known calculated fields for model
+	 *
+	 * @param EEM_Base $model
+	 * @return array allowable values for this field
+	 */
+	public function retrieveCalculatedFieldsForModel(EEM_Base $model)
+	{
+		$mapping = $this->mapping();
+		if (isset($mapping[ $model->get_this_model_name() ])) {
+			return array_keys($mapping[ $model->get_this_model_name() ]);
+		}
+		return array();
+	}
+
+
+	/**
+	 * Returns the JsonSchema for the calculated fields on the given model.
+	 * @param EEM_Base $model
+	 * @return array
+	 */
+	public function getJsonSchemaForModel(EEM_Base $model)
+	{
+		if (! $this->mapping_schema) {
+			$this->mapping_schema = $this->generateNewMappingSchema();
+		}
+		return array(
+			'description' => esc_html__(
+				'Available calculated fields for this model.  Fields are only present in the response if explicitly requested',
+				'event_espresso'
+			),
+			'type' => 'object',
+			'properties' => isset($this->mapping_schema[ $model->get_this_model_name() ])
+				? $this->mapping_schema[ $model->get_this_model_name() ]
+				: array(),
+			'additionalProperties' => false,
+			'readonly' => true,
+		);
+	}
+
+
+	/**
+	 * Retrieves the value for this calculation
+	 *
+	 * @param EEM_Base $model
+	 * @param string $field_name
+	 * @param array $wpdb_row
+	 * @param $rest_request
+	 * @param BaseController $controller
+	 * @return mixed|null
+	 * @throws RestException
+	 * @throws UnexpectedEntityException
+	 */
+	public function retrieveCalculatedFieldValue(
+		EEM_Base $model,
+		$field_name,
+		$wpdb_row,
+		$rest_request,
+		Base $controller
+	) {
+		$mapping = $this->mapping();
+		if (
+			isset($mapping[ $model->get_this_model_name() ])
+			&& isset($mapping[ $model->get_this_model_name() ][ $field_name ])
+		) {
+			$classname = $mapping[ $model->get_this_model_name() ][ $field_name ];
+			$calculator = $this->factory->createFromClassname($classname);
+			$class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
+			return call_user_func(array($calculator, $class_method_name), $wpdb_row, $rest_request, $controller);
+		}
+		throw new RestException(
+			'calculated_field_does_not_exist',
+			sprintf(
+				esc_html__('There is no calculated field %1$s on resource %2$s', 'event_espresso'),
+				$field_name,
+				$model->get_this_model_name()
+			)
+		);
+	}
 }

core/libraries/messages/EE_Messages_Base.lib.php

Spacing +9 added lines, -9 removed lines

@@ -196,11 +196,11 @@ 
             ! empty($messenger)
             && $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
         ) {
-            $settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
+            $settings_to_use = $active_messengers[$messenger]['settings'][$messenger.'-message_types'];
         }
 
-        $this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
-            ? $settings_to_use[ $this->name ]['settings']
+        $this->_existing_admin_settings = isset($settings_to_use[$this->name]['settings'])
+            ? $settings_to_use[$this->name]['settings']
             : null;
     }
 
@@ -240,7 +240,7 @@ 
     public function get_valid_shortcodes()
     {
         $valid_shortcodes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_valid_shortcodes',
+            'FHEE__'.get_class($this).'__get_valid_shortcodes',
             $this->_valid_shortcodes,
             $this
         );
@@ -283,19 +283,19 @@ 
     protected function _get_admin_page_content($page, $action, $extra, $actives)
     {
         // we can also further refine the context by action (if present).
-        if (!empty($action)) {
-            $page = $page . '_' . $action;
+        if ( ! empty($action)) {
+            $page = $page.'_'.$action;
         }
 
-        if (!isset($this->admin_registered_pages[ $page ])) {
+        if ( ! isset($this->admin_registered_pages[$page])) {
             // todo: a place to throw an exception?
             // We need to indicate there is no registered page so this function is not being called correctly.
             return false;
         }
         // k made it here so let's call the method
         $content = call_user_func_array(
-            array( $this, '_get_admin_content_' . $page ),
-            array( $actives, $extra )
+            array($this, '_get_admin_content_'.$page),
+            array($actives, $extra)
         );
         if ($content === false) {
             // todo this needs to be an exception once we've got exceptions in place.

Indentation +265 added lines, -265 removed lines

@@ -13,44 +13,44 @@ 
  */
 abstract class EE_Messages_Base extends EE_Base
 {
-    /** DETAILS PROPERTIES **/
-    /**
-     * The following are used to hold details on the type for reference (i.e. on admin screens)
-     * and also used by the EE_message_type object to figure out where to get template data.
-     */
-    public $name;
-    public $description;
-    protected $_messages_item_type; // messenger OR message_type?
-
-
-    /**
-     * This is an array describing the ui facing labels
-     * that will be used whenever the messenger is referenced in the ui
-     *
-     * array(
-     *  'singular' => esc_html__('something'),
-     *  'plural' => esc_html__('somethings')
-     * )
-     *
-     * @var array
-     */
-    public $label;
-
-
-
-
-    /**
-     * This property when set will hold the slugs of all EE admin pages that we will need to retrieve fields for
-     * (and used to determine which callback method to call from the child class)
-     *
-     * structure should be
-     * array(
-     * 'page_action' => true
-     * )
-     *
+	/** DETAILS PROPERTIES **/
+	/**
+	 * The following are used to hold details on the type for reference (i.e. on admin screens)
+	 * and also used by the EE_message_type object to figure out where to get template data.
+	 */
+	public $name;
+	public $description;
+	protected $_messages_item_type; // messenger OR message_type?
+
+
+	/**
+	 * This is an array describing the ui facing labels
+	 * that will be used whenever the messenger is referenced in the ui
+	 *
+	 * array(
+	 *  'singular' => esc_html__('something'),
+	 *  'plural' => esc_html__('somethings')
+	 * )
+	 *
+	 * @var array
+	 */
+	public $label;
+
+
+
+
+	/**
+	 * This property when set will hold the slugs of all EE admin pages that we will need to retrieve fields for
+	 * (and used to determine which callback method to call from the child class)
+	 *
+	 * structure should be
+	 * array(
+	 * 'page_action' => true
+	 * )
+	 *
 *@var array
-     */
-    public $admin_registered_pages = array();
+	 */
+	public $admin_registered_pages = array();
 
 
 
@@ -59,265 +59,265 @@ 
 
 
 
-    /**
-     * this property holds any specific fields for holding any settings related to a messenger (if any needed)
-     * @var array
-     */
-    protected $_admin_settings_fields = array();
+	/**
+	 * this property holds any specific fields for holding any settings related to a messenger (if any needed)
+	 * @var array
+	 */
+	protected $_admin_settings_fields = array();
 
 
 
 
 
-    /**
-     * this property will hold any existing settings that may have been set in the admin.
-     * @var array
-     */
-    protected $_existing_admin_settings = array();
+	/**
+	 * this property will hold any existing settings that may have been set in the admin.
+	 * @var array
+	 */
+	protected $_existing_admin_settings = array();
 
 
 
 
 
-    /**
-     * this property will hold an array of valid shortcodes for this message type and messengers.
-     * #For Message Types:
-     * This is an array of strings that correspond to defined EE_Shortcode libraries and per context.
-     * For example:
-     * array( 'admin' => array('transaction', 'event', 'attendee') )
-     * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
-     * for the admin context;
-     *
-     *
-     * #For Messengers:
-     * For example:
-     * array('subject' => array('transaction', 'event', 'attendee'))
-     * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
-     * for the 'subject' field;
-     * NOTE:  by default, with messengers, if the valid shortcodes for a field is left blank,
-     * that field will inherit whatever are set as valid shortcodes by message_type.
-     * This is so messenger can set specific valid codes for fields and leave other
-     * valid shortcodes up to the message type matched with the messenger.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_valid_shortcodes = array();
+	/**
+	 * this property will hold an array of valid shortcodes for this message type and messengers.
+	 * #For Message Types:
+	 * This is an array of strings that correspond to defined EE_Shortcode libraries and per context.
+	 * For example:
+	 * array( 'admin' => array('transaction', 'event', 'attendee') )
+	 * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
+	 * for the admin context;
+	 *
+	 *
+	 * #For Messengers:
+	 * For example:
+	 * array('subject' => array('transaction', 'event', 'attendee'))
+	 * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
+	 * for the 'subject' field;
+	 * NOTE:  by default, with messengers, if the valid shortcodes for a field is left blank,
+	 * that field will inherit whatever are set as valid shortcodes by message_type.
+	 * This is so messenger can set specific valid codes for fields and leave other
+	 * valid shortcodes up to the message type matched with the messenger.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_valid_shortcodes = array();
 
 
 
 
 
-    public function __construct()
-    {
-        $this->_set_admin_settings_fields();
-        $this->_set_valid_shortcodes();
-        $this->_set_admin_pages();
-    }
+	public function __construct()
+	{
+		$this->_set_admin_settings_fields();
+		$this->_set_valid_shortcodes();
+		$this->_set_admin_pages();
+	}
 
 
 
 
 
-    /**
-     * sets the _admin_settings_fields property which needs to be defined by child classes.
-     * You will want to set the _admin_settings_fields properties as a multi-dimensional array with the following format
-     * array(
-     *      {field_name - also used for setting index} => array(
-     *          'field_type' => {type of field: 'text', 'textarea', 'checkbox'},
-     *          'value_type' => {type of value: 'string', 'int', 'array', 'bool'},
-     *          'required' => {bool, required or not},
-     *          'validation' => {bool, true if we want validation, false if not},
-     *          'format' => {%d, or %s},
-     *          'label' => {label for the field, make sure it's localized},
-     *          'default' => {default value for the setting}
-     *      ),
-     * );
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_admin_settings_fields();
+	/**
+	 * sets the _admin_settings_fields property which needs to be defined by child classes.
+	 * You will want to set the _admin_settings_fields properties as a multi-dimensional array with the following format
+	 * array(
+	 *      {field_name - also used for setting index} => array(
+	 *          'field_type' => {type of field: 'text', 'textarea', 'checkbox'},
+	 *          'value_type' => {type of value: 'string', 'int', 'array', 'bool'},
+	 *          'required' => {bool, required or not},
+	 *          'validation' => {bool, true if we want validation, false if not},
+	 *          'format' => {%d, or %s},
+	 *          'label' => {label for the field, make sure it's localized},
+	 *          'default' => {default value for the setting}
+	 *      ),
+	 * );
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_admin_settings_fields();
 
 
 
 
 
-    /**
-     * sets any properties on whether a message type or messenger interface shows up on a ee administration page.
-     * Child classes have to define this method but don't necessarily have to set the flags
-     * as they will be set to false by default.
-     *
-     * Child classes use this method to set the `_admin_registered_page` property.
-     * That property is to indicate what EE admin pages we have a corresponding callback for in the child class
-     * so Message Type/messenger fields/content is included on that admin page.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_admin_pages();
+	/**
+	 * sets any properties on whether a message type or messenger interface shows up on a ee administration page.
+	 * Child classes have to define this method but don't necessarily have to set the flags
+	 * as they will be set to false by default.
+	 *
+	 * Child classes use this method to set the `_admin_registered_page` property.
+	 * That property is to indicate what EE admin pages we have a corresponding callback for in the child class
+	 * so Message Type/messenger fields/content is included on that admin page.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_admin_pages();
 
 
 
 
 
-    /**
-     * Child classes must declare the $_valid_shortcodes property using this method.
-     * See comments for $_valid_shortcodes property for details on what it is used for.
-     *
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_valid_shortcodes();
+	/**
+	 * Child classes must declare the $_valid_shortcodes property using this method.
+	 * See comments for $_valid_shortcodes property for details on what it is used for.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_valid_shortcodes();
 
 
 
-    /**
-     * sets the _existing_admin_settings property can be overridden by child classes.
-     * We do this so we only do database calls if needed.
-     *
-     * @access protected
-     * @param string $messenger
-     */
-    protected function _set_existing_admin_settings($messenger = '')
-    {
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_messengers = $Message_Resource_Manager->get_active_messengers_option();
-        $settings_to_use = $active_messengers;
-
-        /**
-         * This determines what will be used for the getting the settings.
-         */
-        if (
-            ! empty($messenger)
-            && $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
-        ) {
-            $settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
-        }
-
-        $this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
-            ? $settings_to_use[ $this->name ]['settings']
-            : null;
-    }
-
-
-
-
-
-
-    /**
-     * get_existing_admin_settings
-     * (if needed) sets and returns the _existing_admin_settings property.
-     *
-     * @access public
-     * @param string $messenger
-     * @return array          settings
-     */
-    public function get_existing_admin_settings($messenger = '')
-    {
-        // if admin_settings property empty lets try setting it.
-        if (method_exists($this, '_set_existing_admin_settings') && empty($this->_existing_admin_settings)) {
-            $this->_set_existing_admin_settings($messenger);
-        }
-        return property_exists($this, '_existing_admin_settings')
-            ? $this->_existing_admin_settings
-            : null;
-    }
-
-
-
-
-
-
-    /**
-     * This returns the array of valid shortcodes for a message type or messenger as set by the child in the $_valid_shortcode property.
-     * @return array   an array of valid shortcodes.
-     */
-    public function get_valid_shortcodes()
-    {
-        $valid_shortcodes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_valid_shortcodes',
-            $this->_valid_shortcodes,
-            $this
-        );
-        // The below filter applies to ALL messengers and message types so use with care!
-        $valid_shortcodes = apply_filters('FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this);
-        return $valid_shortcodes;
-    }
-
-
-
-
-    /**
-     * getter that returns the protected admin_settings_fields property
-     *
-     * @access public
-     * @return array admin settings fields
-     */
-    public function get_admin_settings_fields()
-    {
-        return $this->_admin_settings_fields;
-    }
-
-
-
-
-
-    /**
-     * this public method accepts a page slug (for an EE_admin page)
-     * and will return the response from the child class callback function
-     * if that page is registered via the `_admin_registered_page` property set by the child class.
-     *
-     * @param string $page the slug of the EE admin page
-     * @param array $actives an array of active message type (or messenger) objects.
-     * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
-     * @param array $extra This is just an extra argument that can be used
-     *                     to pass additional data for setting up page content.
-     * @access protected
-     * @return string $content for page.
-     */
-    protected function _get_admin_page_content($page, $action, $extra, $actives)
-    {
-        // we can also further refine the context by action (if present).
-        if (!empty($action)) {
-            $page = $page . '_' . $action;
-        }
-
-        if (!isset($this->admin_registered_pages[ $page ])) {
-            // todo: a place to throw an exception?
-            // We need to indicate there is no registered page so this function is not being called correctly.
-            return false;
-        }
-        // k made it here so let's call the method
-        $content = call_user_func_array(
-            array( $this, '_get_admin_content_' . $page ),
-            array( $actives, $extra )
-        );
-        if ($content === false) {
-            // todo this needs to be an exception once we've got exceptions in place.
-            return false;
-        }
-        return $content;
-    }
-
-
-    /**
-     * Allows a message type to specifically exclude template fields for the provided messenger.
-     * Filtered so this can be programmatically altered as well.
-     * @param string $messenger_name name of messenger
-     * @return array
-     */
-    public function excludedFieldsForMessenger($messenger_name)
-    {
-        return apply_filters(
-            'FHEE__EE_Messages_Base__excludedFieldForMessenger',
-            array(),
-            $messenger_name,
-            $this->name,
-            $this
-        );
-    }
+	/**
+	 * sets the _existing_admin_settings property can be overridden by child classes.
+	 * We do this so we only do database calls if needed.
+	 *
+	 * @access protected
+	 * @param string $messenger
+	 */
+	protected function _set_existing_admin_settings($messenger = '')
+	{
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messengers = $Message_Resource_Manager->get_active_messengers_option();
+		$settings_to_use = $active_messengers;
+
+		/**
+		 * This determines what will be used for the getting the settings.
+		 */
+		if (
+			! empty($messenger)
+			&& $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
+		) {
+			$settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
+		}
+
+		$this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
+			? $settings_to_use[ $this->name ]['settings']
+			: null;
+	}
+
+
+
+
+
+
+	/**
+	 * get_existing_admin_settings
+	 * (if needed) sets and returns the _existing_admin_settings property.
+	 *
+	 * @access public
+	 * @param string $messenger
+	 * @return array          settings
+	 */
+	public function get_existing_admin_settings($messenger = '')
+	{
+		// if admin_settings property empty lets try setting it.
+		if (method_exists($this, '_set_existing_admin_settings') && empty($this->_existing_admin_settings)) {
+			$this->_set_existing_admin_settings($messenger);
+		}
+		return property_exists($this, '_existing_admin_settings')
+			? $this->_existing_admin_settings
+			: null;
+	}
+
+
+
+
+
+
+	/**
+	 * This returns the array of valid shortcodes for a message type or messenger as set by the child in the $_valid_shortcode property.
+	 * @return array   an array of valid shortcodes.
+	 */
+	public function get_valid_shortcodes()
+	{
+		$valid_shortcodes = apply_filters(
+			'FHEE__' . get_class($this) . '__get_valid_shortcodes',
+			$this->_valid_shortcodes,
+			$this
+		);
+		// The below filter applies to ALL messengers and message types so use with care!
+		$valid_shortcodes = apply_filters('FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this);
+		return $valid_shortcodes;
+	}
+
+
+
+
+	/**
+	 * getter that returns the protected admin_settings_fields property
+	 *
+	 * @access public
+	 * @return array admin settings fields
+	 */
+	public function get_admin_settings_fields()
+	{
+		return $this->_admin_settings_fields;
+	}
+
+
+
+
+
+	/**
+	 * this public method accepts a page slug (for an EE_admin page)
+	 * and will return the response from the child class callback function
+	 * if that page is registered via the `_admin_registered_page` property set by the child class.
+	 *
+	 * @param string $page the slug of the EE admin page
+	 * @param array $actives an array of active message type (or messenger) objects.
+	 * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
+	 * @param array $extra This is just an extra argument that can be used
+	 *                     to pass additional data for setting up page content.
+	 * @access protected
+	 * @return string $content for page.
+	 */
+	protected function _get_admin_page_content($page, $action, $extra, $actives)
+	{
+		// we can also further refine the context by action (if present).
+		if (!empty($action)) {
+			$page = $page . '_' . $action;
+		}
+
+		if (!isset($this->admin_registered_pages[ $page ])) {
+			// todo: a place to throw an exception?
+			// We need to indicate there is no registered page so this function is not being called correctly.
+			return false;
+		}
+		// k made it here so let's call the method
+		$content = call_user_func_array(
+			array( $this, '_get_admin_content_' . $page ),
+			array( $actives, $extra )
+		);
+		if ($content === false) {
+			// todo this needs to be an exception once we've got exceptions in place.
+			return false;
+		}
+		return $content;
+	}
+
+
+	/**
+	 * Allows a message type to specifically exclude template fields for the provided messenger.
+	 * Filtered so this can be programmatically altered as well.
+	 * @param string $messenger_name name of messenger
+	 * @return array
+	 */
+	public function excludedFieldsForMessenger($messenger_name)
+	{
+		return apply_filters(
+			'FHEE__EE_Messages_Base__excludedFieldForMessenger',
+			array(),
+			$messenger_name,
+			$this->name,
+			$this
+		);
+	}
 }

core/libraries/messages/EE_Messages_Scheduler.lib.php

Spacing +6 added lines, -6 removed lines

@@ -26,7 +26,7 @@ 
     public function __construct()
     {
         // register tasks (and make sure only registered once).
-        if (! has_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'))) {
+        if ( ! has_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'))) {
             add_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'), 10);
         }
 
@@ -77,7 +77,7 @@ 
         EE_Registry::instance()->load_helper('DTT_Helper');
         $tasks['AHEE__EE_Messages_Scheduler__generation'] = 'ee_message_cron';
         $tasks['AHEE__EE_Messages_Scheduler__sending']    = 'ee_message_cron';
-        $tasks['AHEE__EE_Messages_Scheduler__cleanup'] = array( EEH_DTT_Helper::tomorrow(), 'daily');
+        $tasks['AHEE__EE_Messages_Scheduler__cleanup'] = array(EEH_DTT_Helper::tomorrow(), 'daily');
         return $tasks;
     }
 
@@ -96,7 +96,7 @@ 
                 true
             )
         ) {
-            $request_url  = add_query_arg(
+            $request_url = add_query_arg(
                 array_merge(
                     array('ee' => 'msg_cron_trigger'),
                     EE_Messages_Scheduler::get_request_params($task)
@@ -109,7 +109,7 @@ 
                 'sslverify'   => false,
                 'redirection' => 10,
             );
-            $response     = wp_remote_get($request_url, $request_args);
+            $response = wp_remote_get($request_url, $request_args);
             if (is_wp_error($response)) {
                 trigger_error($response->get_error_message());
             }
@@ -129,7 +129,7 @@ 
     public static function get_request_params($task)
     {
         // transient is used for flood control on msg_cron_trigger requests
-        $transient_key = 'ee_trans_' . uniqid($task);
+        $transient_key = 'ee_trans_'.uniqid($task);
         set_transient($transient_key, 1, 5 * MINUTE_IN_SECONDS);
         return array(
             'type' => $task,
@@ -202,7 +202,7 @@ 
             'AHEE__EE_Messages_Scheduler__sending'    => 'ee_message_cron',
         );
         foreach ($message_crons_to_check as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
+            if ( ! wp_next_scheduled($hook_name)) {
                 wp_schedule_event(time(), $frequency, $hook_name);
             }
         }

Indentation +221 added lines, -221 removed lines

@@ -13,225 +13,225 @@
  */
 class EE_Messages_Scheduler extends EE_Base
 {
-    /**
-     * Number of seconds between batch sends/generates on the cron job.
-     * Defaults to 5 minutes in seconds.  If you want to change this interval, you can use the native WordPress
-     * `cron_schedules` filter and modify the existing custom `ee_message_cron` schedule interval added.
-     *
-     * @type int
-     */
-    const message_cron_schedule = 300;
-
-    /**
-     * Constructor
-     */
-    public function __construct()
-    {
-        // register tasks (and make sure only registered once).
-        if (! has_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'))) {
-            add_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'), 10);
-        }
-
-        // register callbacks for scheduled events (but make sure they are set only once).
-        if (
-            ! has_action(
-                'AHEE__EE_Messages_Scheduler__generation',
-                array('EE_Messages_Scheduler', 'batch_generation')
-            )
-        ) {
-            add_action('AHEE__EE_Messages_Scheduler__generation', array('EE_Messages_Scheduler', 'batch_generation'));
-            add_action('AHEE__EE_Messages_Scheduler__sending', array('EE_Messages_Scheduler', 'batch_sending'));
-            add_action('AHEE__EE_Messages_Scheduler__cleanup', array('EE_Messages_Scheduler', 'cleanup'));
-        }
-
-        // add custom schedules
-        add_filter('cron_schedules', array($this, 'custom_schedules'));
-    }
-
-
-    /**
-     * Add custom schedules for wp_cron
-     *
-     * @param $schedules
-     */
-    public function custom_schedules($schedules)
-    {
-        $schedules['ee_message_cron'] = array(
-            'interval' => self::message_cron_schedule,
-            'display'  => esc_html__(
-                'This is the cron time interval for EE Message schedules (defaults to once every 5 minutes)',
-                'event_espresso'
-            ),
-        );
-        return $schedules;
-    }
-
-
-    /**
-     * Callback for FHEE__EEH_Activation__get_cron_tasks that is used to retrieve scheduled Cron events to add and
-     * remove.
-     *
-     * @param array $tasks already existing scheduled tasks
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function register_scheduled_tasks($tasks)
-    {
-        EE_Registry::instance()->load_helper('DTT_Helper');
-        $tasks['AHEE__EE_Messages_Scheduler__generation'] = 'ee_message_cron';
-        $tasks['AHEE__EE_Messages_Scheduler__sending']    = 'ee_message_cron';
-        $tasks['AHEE__EE_Messages_Scheduler__cleanup'] = array( EEH_DTT_Helper::tomorrow(), 'daily');
-        return $tasks;
-    }
-
-
-    /**
-     * This initiates a non-blocking separate request to execute on a scheduled task.
-     * Note: The EED_Messages module has the handlers for these requests.
-     *
-     * @param string $task The task the request is being generated for.
-     */
-    public static function initiate_scheduled_non_blocking_request($task)
-    {
-        if (
-            apply_filters(
-                'EE_Messages_Scheduler__initiate_scheduled_non_blocking_request__do_separate_request',
-                true
-            )
-        ) {
-            $request_url  = add_query_arg(
-                array_merge(
-                    array('ee' => 'msg_cron_trigger'),
-                    EE_Messages_Scheduler::get_request_params($task)
-                ),
-                site_url()
-            );
-            $request_args = array(
-                'timeout'     => 300,
-                'blocking'    => (defined('DOING_CRON') && DOING_CRON)
-                                 || (defined('DOING_AJAX') && DOING_AJAX),
-                'sslverify'   => false,
-                'redirection' => 10,
-            );
-            $response     = wp_remote_get($request_url, $request_args);
-            if (is_wp_error($response)) {
-                trigger_error($response->get_error_message());
-            }
-        } else {
-            EE_Messages_Scheduler::initiate_immediate_request_on_cron($task);
-        }
-    }
-
-
-    /**
-     * This returns
-     * the request params used for a scheduled message task request.
-     *
-     * @param string $task The task the request is for.
-     * @return array
-     */
-    public static function get_request_params($task)
-    {
-        // transient is used for flood control on msg_cron_trigger requests
-        $transient_key = 'ee_trans_' . uniqid($task);
-        set_transient($transient_key, 1, 5 * MINUTE_IN_SECONDS);
-        return array(
-            'type' => $task,
-            'key'  => $transient_key,
-        );
-    }
-
-
-    /**
-     * This is used to execute an immediate call to the run_cron task performed by EED_Messages
-     *
-     * @param string $task The task the request is being generated for.
-     */
-    public static function initiate_immediate_request_on_cron($task)
-    {
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $request_args = EE_Messages_Scheduler::get_request_params($task);
-        // set those request args in the request so it gets picked up
-        foreach ($request_args as $request_key => $request_value) {
-            $request->setRequestParam($request_key, $request_value);
-        }
-        EED_Messages::instance()->run_cron();
-    }
-
-
-    /**
-     * Callback for scheduled AHEE__EE_Messages_Scheduler__generation wp cron event
-     */
-    public static function batch_generation()
-    {
-        /**
-         * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
-         */
-        if (
-            ! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            EE_Messages_Scheduler::initiate_immediate_request_on_cron('generate');
-        }
-    }
-
-
-    /**
-     * Callback for scheduled AHEE__EE_Messages_Scheduler__sending
-     */
-    public static function batch_sending()
-    {
-        /**
-         * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
-         */
-        if (
-            ! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            EE_Messages_Scheduler::initiate_immediate_request_on_cron('send');
-        }
-    }
-
-
-    /**
-     * This is the callback for the `AHEE__EE_Messages_Scheduler__cleanup` scheduled event action.
-     * This runs once a day and if cleanup is active (set via messages settings), it will (by default) delete
-     * permanently from the database messages that have a MSG_modified date older than 30 days.
-     *
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public static function cleanup()
-    {
-        // First, confirm that the generation and sending EE_Messages_Scheduler crons are
-        // set and reschedule them if they are not.
-        $message_crons_to_check = array(
-            'AHEE__EE_Messages_Scheduler__generation' => 'ee_message_cron',
-            'AHEE__EE_Messages_Scheduler__sending'    => 'ee_message_cron',
-        );
-        foreach ($message_crons_to_check as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
-                wp_schedule_event(time(), $frequency, $hook_name);
-            }
-        }
-
-        // check if user has cleanup turned on or if we're in maintenance mode.  If in maintenance mode we'll wait
-        // until the next scheduled event.
-        if (
-            ! EE_Registry::instance()->CFG->messages->delete_threshold
-            || ! EE_Maintenance_Mode::instance()->models_can_query()
-        ) {
-            return;
-        }
-
-        /**
-         * This filter switch allows other code (such as the EE_Worker_Queue add-on) to replace this with its own handling
-         * of deleting messages.
-         */
-        if (apply_filters('FHEE__EE_Messages_Scheduler__cleanup__handle_cleanup_on_cron', true)) {
-            EEM_Message::instance()->delete_old_messages(EE_Registry::instance()->CFG->messages->delete_threshold);
-        }
-    }
+	/**
+	 * Number of seconds between batch sends/generates on the cron job.
+	 * Defaults to 5 minutes in seconds.  If you want to change this interval, you can use the native WordPress
+	 * `cron_schedules` filter and modify the existing custom `ee_message_cron` schedule interval added.
+	 *
+	 * @type int
+	 */
+	const message_cron_schedule = 300;
+
+	/**
+	 * Constructor
+	 */
+	public function __construct()
+	{
+		// register tasks (and make sure only registered once).
+		if (! has_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'))) {
+			add_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'), 10);
+		}
+
+		// register callbacks for scheduled events (but make sure they are set only once).
+		if (
+			! has_action(
+				'AHEE__EE_Messages_Scheduler__generation',
+				array('EE_Messages_Scheduler', 'batch_generation')
+			)
+		) {
+			add_action('AHEE__EE_Messages_Scheduler__generation', array('EE_Messages_Scheduler', 'batch_generation'));
+			add_action('AHEE__EE_Messages_Scheduler__sending', array('EE_Messages_Scheduler', 'batch_sending'));
+			add_action('AHEE__EE_Messages_Scheduler__cleanup', array('EE_Messages_Scheduler', 'cleanup'));
+		}
+
+		// add custom schedules
+		add_filter('cron_schedules', array($this, 'custom_schedules'));
+	}
+
+
+	/**
+	 * Add custom schedules for wp_cron
+	 *
+	 * @param $schedules
+	 */
+	public function custom_schedules($schedules)
+	{
+		$schedules['ee_message_cron'] = array(
+			'interval' => self::message_cron_schedule,
+			'display'  => esc_html__(
+				'This is the cron time interval for EE Message schedules (defaults to once every 5 minutes)',
+				'event_espresso'
+			),
+		);
+		return $schedules;
+	}
+
+
+	/**
+	 * Callback for FHEE__EEH_Activation__get_cron_tasks that is used to retrieve scheduled Cron events to add and
+	 * remove.
+	 *
+	 * @param array $tasks already existing scheduled tasks
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function register_scheduled_tasks($tasks)
+	{
+		EE_Registry::instance()->load_helper('DTT_Helper');
+		$tasks['AHEE__EE_Messages_Scheduler__generation'] = 'ee_message_cron';
+		$tasks['AHEE__EE_Messages_Scheduler__sending']    = 'ee_message_cron';
+		$tasks['AHEE__EE_Messages_Scheduler__cleanup'] = array( EEH_DTT_Helper::tomorrow(), 'daily');
+		return $tasks;
+	}
+
+
+	/**
+	 * This initiates a non-blocking separate request to execute on a scheduled task.
+	 * Note: The EED_Messages module has the handlers for these requests.
+	 *
+	 * @param string $task The task the request is being generated for.
+	 */
+	public static function initiate_scheduled_non_blocking_request($task)
+	{
+		if (
+			apply_filters(
+				'EE_Messages_Scheduler__initiate_scheduled_non_blocking_request__do_separate_request',
+				true
+			)
+		) {
+			$request_url  = add_query_arg(
+				array_merge(
+					array('ee' => 'msg_cron_trigger'),
+					EE_Messages_Scheduler::get_request_params($task)
+				),
+				site_url()
+			);
+			$request_args = array(
+				'timeout'     => 300,
+				'blocking'    => (defined('DOING_CRON') && DOING_CRON)
+								 || (defined('DOING_AJAX') && DOING_AJAX),
+				'sslverify'   => false,
+				'redirection' => 10,
+			);
+			$response     = wp_remote_get($request_url, $request_args);
+			if (is_wp_error($response)) {
+				trigger_error($response->get_error_message());
+			}
+		} else {
+			EE_Messages_Scheduler::initiate_immediate_request_on_cron($task);
+		}
+	}
+
+
+	/**
+	 * This returns
+	 * the request params used for a scheduled message task request.
+	 *
+	 * @param string $task The task the request is for.
+	 * @return array
+	 */
+	public static function get_request_params($task)
+	{
+		// transient is used for flood control on msg_cron_trigger requests
+		$transient_key = 'ee_trans_' . uniqid($task);
+		set_transient($transient_key, 1, 5 * MINUTE_IN_SECONDS);
+		return array(
+			'type' => $task,
+			'key'  => $transient_key,
+		);
+	}
+
+
+	/**
+	 * This is used to execute an immediate call to the run_cron task performed by EED_Messages
+	 *
+	 * @param string $task The task the request is being generated for.
+	 */
+	public static function initiate_immediate_request_on_cron($task)
+	{
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$request_args = EE_Messages_Scheduler::get_request_params($task);
+		// set those request args in the request so it gets picked up
+		foreach ($request_args as $request_key => $request_value) {
+			$request->setRequestParam($request_key, $request_value);
+		}
+		EED_Messages::instance()->run_cron();
+	}
+
+
+	/**
+	 * Callback for scheduled AHEE__EE_Messages_Scheduler__generation wp cron event
+	 */
+	public static function batch_generation()
+	{
+		/**
+		 * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
+		 */
+		if (
+			! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			EE_Messages_Scheduler::initiate_immediate_request_on_cron('generate');
+		}
+	}
+
+
+	/**
+	 * Callback for scheduled AHEE__EE_Messages_Scheduler__sending
+	 */
+	public static function batch_sending()
+	{
+		/**
+		 * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
+		 */
+		if (
+			! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			EE_Messages_Scheduler::initiate_immediate_request_on_cron('send');
+		}
+	}
+
+
+	/**
+	 * This is the callback for the `AHEE__EE_Messages_Scheduler__cleanup` scheduled event action.
+	 * This runs once a day and if cleanup is active (set via messages settings), it will (by default) delete
+	 * permanently from the database messages that have a MSG_modified date older than 30 days.
+	 *
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public static function cleanup()
+	{
+		// First, confirm that the generation and sending EE_Messages_Scheduler crons are
+		// set and reschedule them if they are not.
+		$message_crons_to_check = array(
+			'AHEE__EE_Messages_Scheduler__generation' => 'ee_message_cron',
+			'AHEE__EE_Messages_Scheduler__sending'    => 'ee_message_cron',
+		);
+		foreach ($message_crons_to_check as $hook_name => $frequency) {
+			if (! wp_next_scheduled($hook_name)) {
+				wp_schedule_event(time(), $frequency, $hook_name);
+			}
+		}
+
+		// check if user has cleanup turned on or if we're in maintenance mode.  If in maintenance mode we'll wait
+		// until the next scheduled event.
+		if (
+			! EE_Registry::instance()->CFG->messages->delete_threshold
+			|| ! EE_Maintenance_Mode::instance()->models_can_query()
+		) {
+			return;
+		}
+
+		/**
+		 * This filter switch allows other code (such as the EE_Worker_Queue add-on) to replace this with its own handling
+		 * of deleting messages.
+		 */
+		if (apply_filters('FHEE__EE_Messages_Scheduler__cleanup__handle_cleanup_on_cron', true)) {
+			EEM_Message::instance()->delete_old_messages(EE_Registry::instance()->CFG->messages->delete_threshold);
+		}
+	}
 }

core/libraries/messages/data_class/EE_Messages_incoming_data.core.php

Spacing +47 added lines, -47 removed lines

@@ -332,7 +332,7 @@ 
         $answers            = $questions = $attendees = $line_items = $registrations = array();
         $total_ticket_count = 0;
 
-        if (! empty($this->reg_objs)) {
+        if ( ! empty($this->reg_objs)) {
             $event_attendee_count = array();
             /** @var EE_Registration $reg */
             foreach ($this->reg_objs as $reg) {
@@ -344,7 +344,7 @@ 
 
                 $evt_id = $reg->event_ID();
                 /** @type EE_Ticket $ticket */
-                $ticket          = $reg->get_first_related('Ticket');
+                $ticket = $reg->get_first_related('Ticket');
                 $attendee = $reg->attendee();
                 $event = $reg->event();
                 // if none of the following entities are available, then we can't setup other data reliably,
@@ -358,67 +358,67 @@ 
                 }
                 $relateddatetime = $ticket->datetimes();
                 $total_ticket_count++;
-                $tickets[ $ticket->ID() ]['ticket']                        = $ticket;
-                $tickets[ $ticket->ID() ]['count']                         = is_array($tickets[ $ticket->ID() ])
-                                                                           && isset($tickets[ $ticket->ID() ]['count'])
-                    ? $tickets[ $ticket->ID() ]['count'] + 1
+                $tickets[$ticket->ID()]['ticket']                        = $ticket;
+                $tickets[$ticket->ID()]['count']                         = is_array($tickets[$ticket->ID()])
+                                                                           && isset($tickets[$ticket->ID()]['count'])
+                    ? $tickets[$ticket->ID()]['count'] + 1
                     : 1;
-                $tickets[ $ticket->ID() ]['att_objs'][ $attendee->ID() ] = $attendee;
-                $tickets[ $ticket->ID() ]['dtt_objs']                      = $relateddatetime;
-                $tickets[ $ticket->ID() ]['reg_objs'][ $reg->ID() ]          = $reg;
-                $tickets[ $ticket->ID() ]['EE_Event']                      = $event;
-                $evtcache[ $evt_id ]                                       = $event;
-                $eventsetup[ $evt_id ]['reg_objs'][ $reg->ID() ]             = $reg;
-                $eventsetup[ $evt_id ]['tkt_objs'][ $ticket->ID() ]          = $ticket;
-                $eventsetup[ $evt_id ]['att_objs'][ $attendee->ID() ]    = $attendee;
-                $event_attendee_count[ $evt_id ]                           = isset($event_attendee_count[ $evt_id ])
-                    ? $event_attendee_count[ $evt_id ] + 1
+                $tickets[$ticket->ID()]['att_objs'][$attendee->ID()] = $attendee;
+                $tickets[$ticket->ID()]['dtt_objs']                      = $relateddatetime;
+                $tickets[$ticket->ID()]['reg_objs'][$reg->ID()]          = $reg;
+                $tickets[$ticket->ID()]['EE_Event']                      = $event;
+                $evtcache[$evt_id]                                       = $event;
+                $eventsetup[$evt_id]['reg_objs'][$reg->ID()]             = $reg;
+                $eventsetup[$evt_id]['tkt_objs'][$ticket->ID()]          = $ticket;
+                $eventsetup[$evt_id]['att_objs'][$attendee->ID()] = $attendee;
+                $event_attendee_count[$evt_id]                           = isset($event_attendee_count[$evt_id])
+                    ? $event_attendee_count[$evt_id] + 1
                     : 0;
-                $attendees[ $reg->attendee_ID() ]['line_ref'][]            = $evt_id;
-                $attendees[ $reg->attendee_ID() ]['att_obj']               = $attendee;
-                $attendees[ $reg->attendee_ID() ]['reg_objs'][ $reg->ID() ]  = $reg;
+                $attendees[$reg->attendee_ID()]['line_ref'][]            = $evt_id;
+                $attendees[$reg->attendee_ID()]['att_obj']               = $attendee;
+                $attendees[$reg->attendee_ID()]['reg_objs'][$reg->ID()]  = $reg;
                 // $attendees[ $reg->attendee_ID() ]['registration_id'] = $reg->ID();
-                $attendees[ $reg->attendee_ID() ]['attendee_email']          = $attendee->email();
-                $attendees[ $reg->attendee_ID() ]['tkt_objs'][ $ticket->ID() ] = $ticket;
-                $attendees[ $reg->attendee_ID() ]['evt_objs'][ $evt_id ]       = $event;
+                $attendees[$reg->attendee_ID()]['attendee_email']          = $attendee->email();
+                $attendees[$reg->attendee_ID()]['tkt_objs'][$ticket->ID()] = $ticket;
+                $attendees[$reg->attendee_ID()]['evt_objs'][$evt_id]       = $event;
 
                 // registrations
-                $registrations[ $reg->ID() ]['tkt_obj'] = $ticket;
-                $registrations[ $reg->ID() ]['evt_obj'] = $event;
-                $registrations[ $reg->ID() ]['reg_obj'] = $reg;
-                $registrations[ $reg->ID() ]['att_obj'] = $attendee;
+                $registrations[$reg->ID()]['tkt_obj'] = $ticket;
+                $registrations[$reg->ID()]['evt_obj'] = $event;
+                $registrations[$reg->ID()]['reg_obj'] = $reg;
+                $registrations[$reg->ID()]['att_obj'] = $attendee;
 
                 // set up answer objects
                 $rel_ans = $reg->get_many_related('Answer');
                 foreach ($rel_ans as $ansid => $answer) {
-                    if (! isset($questions[ $ansid ])) {
-                        $questions[ $ansid ] = $answer->get_first_related('Question');
+                    if ( ! isset($questions[$ansid])) {
+                        $questions[$ansid] = $answer->get_first_related('Question');
                     }
-                    $answers[ $ansid ]                               = $answer;
-                    $registrations[ $reg->ID() ]['ans_objs'][ $ansid ] = $answer;
+                    $answers[$ansid] = $answer;
+                    $registrations[$reg->ID()]['ans_objs'][$ansid] = $answer;
                 }
                 /**
                  * @var int $dtt_id
                  * @var EE_Datetime $datetime
                  */
                 foreach ($relateddatetime as $dtt_id => $datetime) {
-                    $eventsetup[ $evt_id ]['dtt_objs'][ $dtt_id ]       = $datetime;
-                    $registrations[ $reg->ID() ]['dtt_objs'][ $dtt_id ] = $datetime;
+                    $eventsetup[$evt_id]['dtt_objs'][$dtt_id]       = $datetime;
+                    $registrations[$reg->ID()]['dtt_objs'][$dtt_id] = $datetime;
 
-                    if (isset($datetimes[ $dtt_id ])) {
+                    if (isset($datetimes[$dtt_id])) {
                         continue; // already have this info in the datetimes array.
                     }
 
-                    $datetimes[ $dtt_id ]['tkt_objs'][]           = $ticket;
-                    $datetimes[ $dtt_id ]['datetime']             = $datetime;
-                    $datetimes[ $dtt_id ]['evt_objs'][ $evt_id ]    = $event;
-                    $datetimes[ $dtt_id ]['reg_objs'][ $reg->ID() ] = $reg;
+                    $datetimes[$dtt_id]['tkt_objs'][]           = $ticket;
+                    $datetimes[$dtt_id]['datetime']             = $datetime;
+                    $datetimes[$dtt_id]['evt_objs'][$evt_id]    = $event;
+                    $datetimes[$dtt_id]['reg_objs'][$reg->ID()] = $reg;
                 }
             }
 
             // let's loop through the unique event=>reg items and setup data on them
 
-            if (! empty($eventsetup)) {
+            if ( ! empty($eventsetup)) {
                 foreach ($eventsetup as $evt_id => $items) {
                     $ticket_line_items_for_event = array();
                     if ($this->txn instanceof EE_Transaction) {
@@ -432,11 +432,11 @@ 
                             )
                         );
                     }
-                    $events[ $evt_id ] = array(
+                    $events[$evt_id] = array(
                         'ID'              => $evt_id,
-                        'event'           => $evtcache[ $evt_id ],
-                        'name'            => $evtcache[ $evt_id ] instanceof EE_Event ? $evtcache[ $evt_id ]->name() : '',
-                        'total_attendees' => $event_attendee_count[ $evt_id ],
+                        'event'           => $evtcache[$evt_id],
+                        'name'            => $evtcache[$evt_id] instanceof EE_Event ? $evtcache[$evt_id]->name() : '',
+                        'total_attendees' => $event_attendee_count[$evt_id],
                         'reg_objs'        => $items['reg_objs'],
                         'tkt_objs'        => $items['tkt_objs'],
                         'att_objs'        => $items['att_objs'],
@@ -447,11 +447,11 @@ 
                     // make sure the tickets have the line items setup for them.
                     foreach ($ticket_line_items_for_event as $line_id => $line_item) {
                         // only add the ticket line items if we already have this ticket in the $tickets array.
-                        if ($line_item instanceof EE_Line_Item && isset($tickets[ $line_item->ticket()->ID() ])) {
-                            $tickets[ $line_item->ticket()->ID() ]['line_item']      = $line_item;
-                            $tickets[ $line_item->ticket()->ID() ]['sub_line_items'] = $line_item->children();
-                            $line_items[ $line_item->ID() ]['children']              = $line_item->children();
-                            $line_items[ $line_item->ID() ]['EE_Ticket']             = $line_item->ticket();
+                        if ($line_item instanceof EE_Line_Item && isset($tickets[$line_item->ticket()->ID()])) {
+                            $tickets[$line_item->ticket()->ID()]['line_item']      = $line_item;
+                            $tickets[$line_item->ticket()->ID()]['sub_line_items'] = $line_item->children();
+                            $line_items[$line_item->ID()]['children']              = $line_item->children();
+                            $line_items[$line_item->ID()]['EE_Ticket']             = $line_item->ticket();
                         }
                     }
                 }

Indentation +518 added lines, -518 removed lines

@@ -16,522 +16,522 @@
  */
 abstract class EE_Messages_incoming_data
 {
-    /**
-     * user id for logged in user when data collected
-     *
-     * @var string $user_id
-     */
-    public $user_id;
-
-    /**
-     * IP Address of browser used
-     *
-     * @var string $ip_address
-     */
-    public $ip_address;
-
-    /**
-     * browser
-     *
-     * @var string $user_agent
-     */
-    public $user_agent;
-
-    /**
-     * Unix timestamp
-     *
-     * @var string $init_access
-     */
-    public $init_access;
-
-    /**
-     * Unix timestamp
-     *
-     * @var string $last_access
-     */
-    public $last_access;
-
-    /**
-     * The registrations details from the cart
-     *
-     * @var array $reg_info
-     */
-    public $reg_info;
-
-    /**
-     * Some data handlers can set what reg status all the registrations are filtered by.
-     * The status should match a EEM_Registration status constant.
-     *
-     * @var string $filtered_reg_status
-     */
-    public $filtered_reg_status;
-
-    /**
-     * will hold an array of events assembled from $reg_info
-     *
-     * @var EE_Event[] $events
-     */
-    public $events;
-
-    /**
-     * holds an array of datetimes assembled from the incoming data.
-     *
-     * @var EE_Datetime[] $datetimes
-     */
-    public $datetimes;
-
-    /**
-     * holds an array of tickets assembled from the incoming data.
-     *
-     * @var EE_Ticket[] $tickets
-     */
-    public $tickets;
-
-    /**
-     * holds an array with a key of parent line item and values are an array of children of that line item.
-     *
-     * @since 4.5.0
-     * @var EE_Line_Item[] $line_items_with_children
-     */
-    public $line_items_with_children;
-
-    /**
-     * will hold an array of attendees assembled from the $reg_info
-     *
-     * @var EE_Attendee[] $attendees
-     */
-    public $attendees;
-
-    /**
-     * will hold an array of cached registration objects and info assembled from reg_info
-     *
-     * @var array $registrations
-     */
-    public $registrations;
-
-    /**
-     * will hold an array of answers assembled from the $reg_info
-     *
-     * @var EE_Answer[] $answers
-     */
-    public $answers;
-
-    /**
-     * will hold an array of questions assembled from the $reg_info (indexed by Answer ID);
-     *
-     * @var EE_Question[] $questions
-     */
-    public $questions;
-
-    /**
-     * Will hold billing data assembled from $billing_info (if present)
-     *
-     * @var mixed (array|null) $billing
-     */
-    public $billing;
-
-    /**
-     * The total amount of tax for the transaction
-     *
-     * @var float $taxes
-     */
-    public $taxes;
-
-    /**
-     * Holds the line items related to taxes
-     *
-     * @since 4.5.0
-     * @var EE_Line_Item[] $tax_line_items
-     */
-    public $tax_line_items;
-
-    /**
-     * Hold the line items which aren't taxes and don't relate
-     * to tickets. So: promotions and miscellaneous charges
-     *
-     * @since 4.5
-     * @var EE_Line_Item[] $additional_line_items
-     */
-    public $additional_line_items;
-
-    /**
-     * Holds the grand total EE_Line_Item
-     *
-     * @var EE_Line_Item $grand_total_line_item
-     */
-    public $grand_total_line_item;
-
-    /**
-     * holds the grand total price object
-     * currently not used.
-     *
-     * @var null $grand_total_price_object
-     */
-    public $grand_total_price_object;
-
-    /**
-     * total number of tickets
-     *
-     * @var int $total_ticket_count
-     */
-    public $total_ticket_count;
-
-    /**
-     * Will hold the final transaction object (EE_Transaction)
-     *
-     * @var EE_Transaction $txn
-     */
-    public $txn;
-
-    /**
-     * Holds the payments related to a transaction
-     *
-     * @since 4.5.0
-     * @var EE_Payment[] $payments
-     */
-    public $payments;
-
-    /**
-     * Holds the first related payment related for a transaction
-     *
-     * @since 4.5.0
-     * @var EE_Payment $payment
-     */
-    public $payment;
-
-    /**
-     * Will hold the label for the txn status
-     *
-     * @var string $txn_status
-     */
-    public $txn_status;
-
-    /**
-     * Will hold the final registration object (EE_Registration)
-     *
-     * @var EE_Registration[] $reg_objs
-     */
-    public $reg_objs;
-
-    /**
-     * Will hold an array of primary attendee data (if present)
-     *
-     * @var array $primary_attendee_data
-     */
-    public $primary_attendee_data;
-
-    /**
-     * This is just an internal object used for passing around the incoming data.
-     *
-     * @var mixed $_data
-     */
-    protected $_data;
-
-    /**
-     * This is just an internal object used for passing around the incoming data.
-     *
-     * @var mixed $incoming_data
-     */
-    public $incoming_data;
-
-    /**
-     * hold objects that might be created
-     *
-     * @type EE_Registration $reg_obj
-     */
-    public $reg_obj;
-
-
-    /**
-     * constructor
-     *
-     * @param mixed $data incoming data object|array.  Suggested that child classes use type hinting for expected
-     *                    data object.  But here parent will be generic because we don't know what's coming in.
-     */
-    public function __construct($data)
-    {
-        $this->_data = $data;
-        $this->_setup_data();
-    }
-
-
-    /**
-     * Every child class has to setup the data object !
-     *
-     * @return void
-     */
-    abstract protected function _setup_data();
-
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param mixed $data The incoming data to be prepped.
-     * @return mixed   The prepped data for db
-     */
-    public static function convert_data_for_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param $data
-     * @return mixed
-     */
-    public static function convert_data_from_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * only purpose is to return the data
-     *
-     * @access public
-     * @return mixed the formatted data object!
-     */
-    public function data()
-    {
-        return $this->_data;
-    }
-
-
-    /**
-     * This helper method can be used by any incoming data handlers to setup the data correctly.  All that is required
-     * is that $this->reg_objs be set.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws EntityNotFoundException
-     */
-    protected function _assemble_data()
-    {
-        // verify that reg_objs is set
-        if (
-            ! is_array($this->reg_objs)
-            && ! reset($this->reg_objs) instanceof EE_Registration
-        ) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to assemble the data correctly, the "reg_objs" property must be an array of EE_Registration objects',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // get all attendee and events associated with the registrations in this transaction
-        $events             = $event_setup = $evtcache = $tickets = $datetimes = array();
-        $answers            = $questions = $attendees = $line_items = $registrations = array();
-        $total_ticket_count = 0;
-
-        if (! empty($this->reg_objs)) {
-            $event_attendee_count = array();
-            /** @var EE_Registration $reg */
-            foreach ($this->reg_objs as $reg) {
-                if (
-                    $this->_skip_registration_for_processing($reg)
-                ) {
-                    continue;
-                }
-
-                $evt_id = $reg->event_ID();
-                /** @type EE_Ticket $ticket */
-                $ticket          = $reg->get_first_related('Ticket');
-                $attendee = $reg->attendee();
-                $event = $reg->event();
-                // if none of the following entities are available, then we can't setup other data reliably,
-                // so let's just skip.
-                if (
-                    ! $ticket instanceof EE_Ticket
-                    || ! $attendee instanceof EE_Attendee
-                    || ! $event instanceof EE_Event
-                ) {
-                    continue;
-                }
-                $relateddatetime = $ticket->datetimes();
-                $total_ticket_count++;
-                $tickets[ $ticket->ID() ]['ticket']                        = $ticket;
-                $tickets[ $ticket->ID() ]['count']                         = is_array($tickets[ $ticket->ID() ])
-                                                                           && isset($tickets[ $ticket->ID() ]['count'])
-                    ? $tickets[ $ticket->ID() ]['count'] + 1
-                    : 1;
-                $tickets[ $ticket->ID() ]['att_objs'][ $attendee->ID() ] = $attendee;
-                $tickets[ $ticket->ID() ]['dtt_objs']                      = $relateddatetime;
-                $tickets[ $ticket->ID() ]['reg_objs'][ $reg->ID() ]          = $reg;
-                $tickets[ $ticket->ID() ]['EE_Event']                      = $event;
-                $evtcache[ $evt_id ]                                       = $event;
-                $eventsetup[ $evt_id ]['reg_objs'][ $reg->ID() ]             = $reg;
-                $eventsetup[ $evt_id ]['tkt_objs'][ $ticket->ID() ]          = $ticket;
-                $eventsetup[ $evt_id ]['att_objs'][ $attendee->ID() ]    = $attendee;
-                $event_attendee_count[ $evt_id ]                           = isset($event_attendee_count[ $evt_id ])
-                    ? $event_attendee_count[ $evt_id ] + 1
-                    : 0;
-                $attendees[ $reg->attendee_ID() ]['line_ref'][]            = $evt_id;
-                $attendees[ $reg->attendee_ID() ]['att_obj']               = $attendee;
-                $attendees[ $reg->attendee_ID() ]['reg_objs'][ $reg->ID() ]  = $reg;
-                // $attendees[ $reg->attendee_ID() ]['registration_id'] = $reg->ID();
-                $attendees[ $reg->attendee_ID() ]['attendee_email']          = $attendee->email();
-                $attendees[ $reg->attendee_ID() ]['tkt_objs'][ $ticket->ID() ] = $ticket;
-                $attendees[ $reg->attendee_ID() ]['evt_objs'][ $evt_id ]       = $event;
-
-                // registrations
-                $registrations[ $reg->ID() ]['tkt_obj'] = $ticket;
-                $registrations[ $reg->ID() ]['evt_obj'] = $event;
-                $registrations[ $reg->ID() ]['reg_obj'] = $reg;
-                $registrations[ $reg->ID() ]['att_obj'] = $attendee;
-
-                // set up answer objects
-                $rel_ans = $reg->get_many_related('Answer');
-                foreach ($rel_ans as $ansid => $answer) {
-                    if (! isset($questions[ $ansid ])) {
-                        $questions[ $ansid ] = $answer->get_first_related('Question');
-                    }
-                    $answers[ $ansid ]                               = $answer;
-                    $registrations[ $reg->ID() ]['ans_objs'][ $ansid ] = $answer;
-                }
-                /**
-                 * @var int $dtt_id
-                 * @var EE_Datetime $datetime
-                 */
-                foreach ($relateddatetime as $dtt_id => $datetime) {
-                    $eventsetup[ $evt_id ]['dtt_objs'][ $dtt_id ]       = $datetime;
-                    $registrations[ $reg->ID() ]['dtt_objs'][ $dtt_id ] = $datetime;
-
-                    if (isset($datetimes[ $dtt_id ])) {
-                        continue; // already have this info in the datetimes array.
-                    }
-
-                    $datetimes[ $dtt_id ]['tkt_objs'][]           = $ticket;
-                    $datetimes[ $dtt_id ]['datetime']             = $datetime;
-                    $datetimes[ $dtt_id ]['evt_objs'][ $evt_id ]    = $event;
-                    $datetimes[ $dtt_id ]['reg_objs'][ $reg->ID() ] = $reg;
-                }
-            }
-
-            // let's loop through the unique event=>reg items and setup data on them
-
-            if (! empty($eventsetup)) {
-                foreach ($eventsetup as $evt_id => $items) {
-                    $ticket_line_items_for_event = array();
-                    if ($this->txn instanceof EE_Transaction) {
-                        $ticket_line_items_for_event = EEM_Line_Item::instance()->get_all(
-                            array(
-                                array(
-                                    'Ticket.Datetime.EVT_ID' => $evt_id,
-                                    'TXN_ID'                 => $this->txn->ID(),
-                                ),
-                                'default_where_conditions' => 'none',
-                            )
-                        );
-                    }
-                    $events[ $evt_id ] = array(
-                        'ID'              => $evt_id,
-                        'event'           => $evtcache[ $evt_id ],
-                        'name'            => $evtcache[ $evt_id ] instanceof EE_Event ? $evtcache[ $evt_id ]->name() : '',
-                        'total_attendees' => $event_attendee_count[ $evt_id ],
-                        'reg_objs'        => $items['reg_objs'],
-                        'tkt_objs'        => $items['tkt_objs'],
-                        'att_objs'        => $items['att_objs'],
-                        'dtt_objs'        => isset($items['dtt_objs']) ? $items['dtt_objs'] : array(),
-                        'line_items'      => $ticket_line_items_for_event,
-                    );
-
-                    // make sure the tickets have the line items setup for them.
-                    foreach ($ticket_line_items_for_event as $line_id => $line_item) {
-                        // only add the ticket line items if we already have this ticket in the $tickets array.
-                        if ($line_item instanceof EE_Line_Item && isset($tickets[ $line_item->ticket()->ID() ])) {
-                            $tickets[ $line_item->ticket()->ID() ]['line_item']      = $line_item;
-                            $tickets[ $line_item->ticket()->ID() ]['sub_line_items'] = $line_item->children();
-                            $line_items[ $line_item->ID() ]['children']              = $line_item->children();
-                            $line_items[ $line_item->ID() ]['EE_Ticket']             = $line_item->ticket();
-                        }
-                    }
-                }
-            }
-
-            $this->grand_total_line_item = $this->txn instanceof EE_Transaction
-                ? $this->txn->total_line_item()
-                : null;
-        }
-
-        // lets set the attendees and events properties
-        $this->attendees                = $attendees;
-        $this->events                   = $events;
-        $this->tickets                  = $tickets;
-        $this->line_items_with_children = $line_items;
-        $this->datetimes                = $datetimes;
-        $this->questions                = $questions;
-        $this->answers                  = $answers;
-        $this->total_ticket_count       = $total_ticket_count;
-        $this->registrations            = $registrations;
-
-        if ($this->txn instanceof EE_Transaction) {
-            $this->tax_line_items        = $this->txn->tax_items();
-            $this->additional_line_items = $this->txn->non_ticket_line_items();
-            $this->payments              = $this->txn->payments();
-
-            // setup primary registration if we have a single transaction object to work with
-
-            // let's get just the primary_attendee_data!  First we get the primary registration object.
-            $primary_reg = $this->txn->primary_registration();
-            // verify
-            if ($primary_reg instanceof EE_Registration) {
-                // get attendee object
-                if ($primary_reg->attendee() instanceof EE_Attendee) {
-                    // now we can setup the primary_attendee_data array
-                    $this->primary_attendee_data = array(
-                        'registration_id' => $primary_reg->ID(),
-                        'att_obj'         => $primary_reg->attendee(),
-                        'reg_obj'         => $primary_reg,
-                        'primary_att_obj' => $primary_reg->attendee(),
-                        'primary_reg_obj' => $primary_reg,
-                    );
-                } else {
-                    EE_Error::add_error(
-                        esc_html__(
-                            'Incoming data does not have a valid Attendee object for the primary registrant.',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'Incoming data does not have a valid Registration object for the primary registrant.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-    /**
-     * This simply considers whether the given registration should be processed or not based on comparison with the
-     * filtered_reg_status property.
-     *
-     * @param EE_Registration $registration
-     * @return bool  returning true means we DO want to skip processing.  returning false means we DON'T want to skip
-     *               processing
-     */
-    protected function _skip_registration_for_processing(EE_Registration $registration)
-    {
-        if (empty($this->filtered_reg_status)) {
-            return false;
-        }
-
-        // if we made it here then we just compare the filtered_reg_status with the registration status and return that
-        return $this->filtered_reg_status !== $registration->status_ID();
-    }
+	/**
+	 * user id for logged in user when data collected
+	 *
+	 * @var string $user_id
+	 */
+	public $user_id;
+
+	/**
+	 * IP Address of browser used
+	 *
+	 * @var string $ip_address
+	 */
+	public $ip_address;
+
+	/**
+	 * browser
+	 *
+	 * @var string $user_agent
+	 */
+	public $user_agent;
+
+	/**
+	 * Unix timestamp
+	 *
+	 * @var string $init_access
+	 */
+	public $init_access;
+
+	/**
+	 * Unix timestamp
+	 *
+	 * @var string $last_access
+	 */
+	public $last_access;
+
+	/**
+	 * The registrations details from the cart
+	 *
+	 * @var array $reg_info
+	 */
+	public $reg_info;
+
+	/**
+	 * Some data handlers can set what reg status all the registrations are filtered by.
+	 * The status should match a EEM_Registration status constant.
+	 *
+	 * @var string $filtered_reg_status
+	 */
+	public $filtered_reg_status;
+
+	/**
+	 * will hold an array of events assembled from $reg_info
+	 *
+	 * @var EE_Event[] $events
+	 */
+	public $events;
+
+	/**
+	 * holds an array of datetimes assembled from the incoming data.
+	 *
+	 * @var EE_Datetime[] $datetimes
+	 */
+	public $datetimes;
+
+	/**
+	 * holds an array of tickets assembled from the incoming data.
+	 *
+	 * @var EE_Ticket[] $tickets
+	 */
+	public $tickets;
+
+	/**
+	 * holds an array with a key of parent line item and values are an array of children of that line item.
+	 *
+	 * @since 4.5.0
+	 * @var EE_Line_Item[] $line_items_with_children
+	 */
+	public $line_items_with_children;
+
+	/**
+	 * will hold an array of attendees assembled from the $reg_info
+	 *
+	 * @var EE_Attendee[] $attendees
+	 */
+	public $attendees;
+
+	/**
+	 * will hold an array of cached registration objects and info assembled from reg_info
+	 *
+	 * @var array $registrations
+	 */
+	public $registrations;
+
+	/**
+	 * will hold an array of answers assembled from the $reg_info
+	 *
+	 * @var EE_Answer[] $answers
+	 */
+	public $answers;
+
+	/**
+	 * will hold an array of questions assembled from the $reg_info (indexed by Answer ID);
+	 *
+	 * @var EE_Question[] $questions
+	 */
+	public $questions;
+
+	/**
+	 * Will hold billing data assembled from $billing_info (if present)
+	 *
+	 * @var mixed (array|null) $billing
+	 */
+	public $billing;
+
+	/**
+	 * The total amount of tax for the transaction
+	 *
+	 * @var float $taxes
+	 */
+	public $taxes;
+
+	/**
+	 * Holds the line items related to taxes
+	 *
+	 * @since 4.5.0
+	 * @var EE_Line_Item[] $tax_line_items
+	 */
+	public $tax_line_items;
+
+	/**
+	 * Hold the line items which aren't taxes and don't relate
+	 * to tickets. So: promotions and miscellaneous charges
+	 *
+	 * @since 4.5
+	 * @var EE_Line_Item[] $additional_line_items
+	 */
+	public $additional_line_items;
+
+	/**
+	 * Holds the grand total EE_Line_Item
+	 *
+	 * @var EE_Line_Item $grand_total_line_item
+	 */
+	public $grand_total_line_item;
+
+	/**
+	 * holds the grand total price object
+	 * currently not used.
+	 *
+	 * @var null $grand_total_price_object
+	 */
+	public $grand_total_price_object;
+
+	/**
+	 * total number of tickets
+	 *
+	 * @var int $total_ticket_count
+	 */
+	public $total_ticket_count;
+
+	/**
+	 * Will hold the final transaction object (EE_Transaction)
+	 *
+	 * @var EE_Transaction $txn
+	 */
+	public $txn;
+
+	/**
+	 * Holds the payments related to a transaction
+	 *
+	 * @since 4.5.0
+	 * @var EE_Payment[] $payments
+	 */
+	public $payments;
+
+	/**
+	 * Holds the first related payment related for a transaction
+	 *
+	 * @since 4.5.0
+	 * @var EE_Payment $payment
+	 */
+	public $payment;
+
+	/**
+	 * Will hold the label for the txn status
+	 *
+	 * @var string $txn_status
+	 */
+	public $txn_status;
+
+	/**
+	 * Will hold the final registration object (EE_Registration)
+	 *
+	 * @var EE_Registration[] $reg_objs
+	 */
+	public $reg_objs;
+
+	/**
+	 * Will hold an array of primary attendee data (if present)
+	 *
+	 * @var array $primary_attendee_data
+	 */
+	public $primary_attendee_data;
+
+	/**
+	 * This is just an internal object used for passing around the incoming data.
+	 *
+	 * @var mixed $_data
+	 */
+	protected $_data;
+
+	/**
+	 * This is just an internal object used for passing around the incoming data.
+	 *
+	 * @var mixed $incoming_data
+	 */
+	public $incoming_data;
+
+	/**
+	 * hold objects that might be created
+	 *
+	 * @type EE_Registration $reg_obj
+	 */
+	public $reg_obj;
+
+
+	/**
+	 * constructor
+	 *
+	 * @param mixed $data incoming data object|array.  Suggested that child classes use type hinting for expected
+	 *                    data object.  But here parent will be generic because we don't know what's coming in.
+	 */
+	public function __construct($data)
+	{
+		$this->_data = $data;
+		$this->_setup_data();
+	}
+
+
+	/**
+	 * Every child class has to setup the data object !
+	 *
+	 * @return void
+	 */
+	abstract protected function _setup_data();
+
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param mixed $data The incoming data to be prepped.
+	 * @return mixed   The prepped data for db
+	 */
+	public static function convert_data_for_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param $data
+	 * @return mixed
+	 */
+	public static function convert_data_from_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * only purpose is to return the data
+	 *
+	 * @access public
+	 * @return mixed the formatted data object!
+	 */
+	public function data()
+	{
+		return $this->_data;
+	}
+
+
+	/**
+	 * This helper method can be used by any incoming data handlers to setup the data correctly.  All that is required
+	 * is that $this->reg_objs be set.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws EntityNotFoundException
+	 */
+	protected function _assemble_data()
+	{
+		// verify that reg_objs is set
+		if (
+			! is_array($this->reg_objs)
+			&& ! reset($this->reg_objs) instanceof EE_Registration
+		) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to assemble the data correctly, the "reg_objs" property must be an array of EE_Registration objects',
+					'event_espresso'
+				)
+			);
+		}
+
+		// get all attendee and events associated with the registrations in this transaction
+		$events             = $event_setup = $evtcache = $tickets = $datetimes = array();
+		$answers            = $questions = $attendees = $line_items = $registrations = array();
+		$total_ticket_count = 0;
+
+		if (! empty($this->reg_objs)) {
+			$event_attendee_count = array();
+			/** @var EE_Registration $reg */
+			foreach ($this->reg_objs as $reg) {
+				if (
+					$this->_skip_registration_for_processing($reg)
+				) {
+					continue;
+				}
+
+				$evt_id = $reg->event_ID();
+				/** @type EE_Ticket $ticket */
+				$ticket          = $reg->get_first_related('Ticket');
+				$attendee = $reg->attendee();
+				$event = $reg->event();
+				// if none of the following entities are available, then we can't setup other data reliably,
+				// so let's just skip.
+				if (
+					! $ticket instanceof EE_Ticket
+					|| ! $attendee instanceof EE_Attendee
+					|| ! $event instanceof EE_Event
+				) {
+					continue;
+				}
+				$relateddatetime = $ticket->datetimes();
+				$total_ticket_count++;
+				$tickets[ $ticket->ID() ]['ticket']                        = $ticket;
+				$tickets[ $ticket->ID() ]['count']                         = is_array($tickets[ $ticket->ID() ])
+																		   && isset($tickets[ $ticket->ID() ]['count'])
+					? $tickets[ $ticket->ID() ]['count'] + 1
+					: 1;
+				$tickets[ $ticket->ID() ]['att_objs'][ $attendee->ID() ] = $attendee;
+				$tickets[ $ticket->ID() ]['dtt_objs']                      = $relateddatetime;
+				$tickets[ $ticket->ID() ]['reg_objs'][ $reg->ID() ]          = $reg;
+				$tickets[ $ticket->ID() ]['EE_Event']                      = $event;
+				$evtcache[ $evt_id ]                                       = $event;
+				$eventsetup[ $evt_id ]['reg_objs'][ $reg->ID() ]             = $reg;
+				$eventsetup[ $evt_id ]['tkt_objs'][ $ticket->ID() ]          = $ticket;
+				$eventsetup[ $evt_id ]['att_objs'][ $attendee->ID() ]    = $attendee;
+				$event_attendee_count[ $evt_id ]                           = isset($event_attendee_count[ $evt_id ])
+					? $event_attendee_count[ $evt_id ] + 1
+					: 0;
+				$attendees[ $reg->attendee_ID() ]['line_ref'][]            = $evt_id;
+				$attendees[ $reg->attendee_ID() ]['att_obj']               = $attendee;
+				$attendees[ $reg->attendee_ID() ]['reg_objs'][ $reg->ID() ]  = $reg;
+				// $attendees[ $reg->attendee_ID() ]['registration_id'] = $reg->ID();
+				$attendees[ $reg->attendee_ID() ]['attendee_email']          = $attendee->email();
+				$attendees[ $reg->attendee_ID() ]['tkt_objs'][ $ticket->ID() ] = $ticket;
+				$attendees[ $reg->attendee_ID() ]['evt_objs'][ $evt_id ]       = $event;
+
+				// registrations
+				$registrations[ $reg->ID() ]['tkt_obj'] = $ticket;
+				$registrations[ $reg->ID() ]['evt_obj'] = $event;
+				$registrations[ $reg->ID() ]['reg_obj'] = $reg;
+				$registrations[ $reg->ID() ]['att_obj'] = $attendee;
+
+				// set up answer objects
+				$rel_ans = $reg->get_many_related('Answer');
+				foreach ($rel_ans as $ansid => $answer) {
+					if (! isset($questions[ $ansid ])) {
+						$questions[ $ansid ] = $answer->get_first_related('Question');
+					}
+					$answers[ $ansid ]                               = $answer;
+					$registrations[ $reg->ID() ]['ans_objs'][ $ansid ] = $answer;
+				}
+				/**
+				 * @var int $dtt_id
+				 * @var EE_Datetime $datetime
+				 */
+				foreach ($relateddatetime as $dtt_id => $datetime) {
+					$eventsetup[ $evt_id ]['dtt_objs'][ $dtt_id ]       = $datetime;
+					$registrations[ $reg->ID() ]['dtt_objs'][ $dtt_id ] = $datetime;
+
+					if (isset($datetimes[ $dtt_id ])) {
+						continue; // already have this info in the datetimes array.
+					}
+
+					$datetimes[ $dtt_id ]['tkt_objs'][]           = $ticket;
+					$datetimes[ $dtt_id ]['datetime']             = $datetime;
+					$datetimes[ $dtt_id ]['evt_objs'][ $evt_id ]    = $event;
+					$datetimes[ $dtt_id ]['reg_objs'][ $reg->ID() ] = $reg;
+				}
+			}
+
+			// let's loop through the unique event=>reg items and setup data on them
+
+			if (! empty($eventsetup)) {
+				foreach ($eventsetup as $evt_id => $items) {
+					$ticket_line_items_for_event = array();
+					if ($this->txn instanceof EE_Transaction) {
+						$ticket_line_items_for_event = EEM_Line_Item::instance()->get_all(
+							array(
+								array(
+									'Ticket.Datetime.EVT_ID' => $evt_id,
+									'TXN_ID'                 => $this->txn->ID(),
+								),
+								'default_where_conditions' => 'none',
+							)
+						);
+					}
+					$events[ $evt_id ] = array(
+						'ID'              => $evt_id,
+						'event'           => $evtcache[ $evt_id ],
+						'name'            => $evtcache[ $evt_id ] instanceof EE_Event ? $evtcache[ $evt_id ]->name() : '',
+						'total_attendees' => $event_attendee_count[ $evt_id ],
+						'reg_objs'        => $items['reg_objs'],
+						'tkt_objs'        => $items['tkt_objs'],
+						'att_objs'        => $items['att_objs'],
+						'dtt_objs'        => isset($items['dtt_objs']) ? $items['dtt_objs'] : array(),
+						'line_items'      => $ticket_line_items_for_event,
+					);
+
+					// make sure the tickets have the line items setup for them.
+					foreach ($ticket_line_items_for_event as $line_id => $line_item) {
+						// only add the ticket line items if we already have this ticket in the $tickets array.
+						if ($line_item instanceof EE_Line_Item && isset($tickets[ $line_item->ticket()->ID() ])) {
+							$tickets[ $line_item->ticket()->ID() ]['line_item']      = $line_item;
+							$tickets[ $line_item->ticket()->ID() ]['sub_line_items'] = $line_item->children();
+							$line_items[ $line_item->ID() ]['children']              = $line_item->children();
+							$line_items[ $line_item->ID() ]['EE_Ticket']             = $line_item->ticket();
+						}
+					}
+				}
+			}
+
+			$this->grand_total_line_item = $this->txn instanceof EE_Transaction
+				? $this->txn->total_line_item()
+				: null;
+		}
+
+		// lets set the attendees and events properties
+		$this->attendees                = $attendees;
+		$this->events                   = $events;
+		$this->tickets                  = $tickets;
+		$this->line_items_with_children = $line_items;
+		$this->datetimes                = $datetimes;
+		$this->questions                = $questions;
+		$this->answers                  = $answers;
+		$this->total_ticket_count       = $total_ticket_count;
+		$this->registrations            = $registrations;
+
+		if ($this->txn instanceof EE_Transaction) {
+			$this->tax_line_items        = $this->txn->tax_items();
+			$this->additional_line_items = $this->txn->non_ticket_line_items();
+			$this->payments              = $this->txn->payments();
+
+			// setup primary registration if we have a single transaction object to work with
+
+			// let's get just the primary_attendee_data!  First we get the primary registration object.
+			$primary_reg = $this->txn->primary_registration();
+			// verify
+			if ($primary_reg instanceof EE_Registration) {
+				// get attendee object
+				if ($primary_reg->attendee() instanceof EE_Attendee) {
+					// now we can setup the primary_attendee_data array
+					$this->primary_attendee_data = array(
+						'registration_id' => $primary_reg->ID(),
+						'att_obj'         => $primary_reg->attendee(),
+						'reg_obj'         => $primary_reg,
+						'primary_att_obj' => $primary_reg->attendee(),
+						'primary_reg_obj' => $primary_reg,
+					);
+				} else {
+					EE_Error::add_error(
+						esc_html__(
+							'Incoming data does not have a valid Attendee object for the primary registrant.',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'Incoming data does not have a valid Registration object for the primary registrant.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+	/**
+	 * This simply considers whether the given registration should be processed or not based on comparison with the
+	 * filtered_reg_status property.
+	 *
+	 * @param EE_Registration $registration
+	 * @return bool  returning true means we DO want to skip processing.  returning false means we DON'T want to skip
+	 *               processing
+	 */
+	protected function _skip_registration_for_processing(EE_Registration $registration)
+	{
+		if (empty($this->filtered_reg_status)) {
+			return false;
+		}
+
+		// if we made it here then we just compare the filtered_reg_status with the registration status and return that
+		return $this->filtered_reg_status !== $registration->status_ID();
+	}
 }

core/libraries/payment_methods/EE_Payment_Method_Manager.lib.php

Spacing +26 added lines, -26 removed lines

@@ -74,7 +74,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Payment_Method_Manager) {
+        if ( ! self::$_instance instanceof EE_Payment_Method_Manager) {
             EE_Registry::instance()->load_lib('PMT_Base');
             self::$_instance = new self();
         }
@@ -105,7 +105,7 @@ 
      */
     public function maybe_register_payment_methods($force_recheck = false)
     {
-        if (! $this->_payment_method_types || $force_recheck) {
+        if ( ! $this->_payment_method_types || $force_recheck) {
             $this->_register_payment_methods();
         }
     }
@@ -119,7 +119,7 @@ 
     protected function _register_payment_methods()
     {
         // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+        $pm_to_register = glob(EE_PAYMENT_METHODS.'*', GLOB_ONLYDIR);
         // filter list of modules to register
         $pm_to_register = apply_filters(
             'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
@@ -159,9 +159,9 @@ 
         // create class name from module directory name
         $module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
         // add class prefix
-        $module_class = 'EE_PMT_' . $module;
+        $module_class = 'EE_PMT_'.$module;
         // does the module exist ?
-        if (! is_readable($payment_method_path . '/' . $module_class . $module_ext)) {
+        if ( ! is_readable($payment_method_path.'/'.$module_class.$module_ext)) {
             $msg = sprintf(
                 esc_html__(
                     'The requested %s payment method file could not be found or is not readable due to file permissions.',
@@ -169,22 +169,22 @@ 
                 ),
                 $module
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the module class file
-        require_once($payment_method_path . '/' . $module_class . $module_ext);
+        require_once($payment_method_path.'/'.$module_class.$module_ext);
         // verify that class exists
-        if (! class_exists($module_class)) {
+        if ( ! class_exists($module_class)) {
             $msg = sprintf(
                 esc_html__('The requested %s module class does not exist.', 'event_espresso'),
                 $module_class
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // add to array of registered modules
-        $this->_payment_method_types[ $module ] = $payment_method_path . '/' . $module_class . $module_ext;
+        $this->_payment_method_types[$module] = $payment_method_path.'/'.$module_class.$module_ext;
         ksort($this->_payment_method_types);
         return true;
     }
@@ -202,12 +202,12 @@ 
         if (
             $force_recheck
             || ! is_array($this->_payment_method_types)
-            || ! isset($this->_payment_method_types[ $payment_method_name ])
+            || ! isset($this->_payment_method_types[$payment_method_name])
         ) {
             $this->maybe_register_payment_methods($force_recheck);
         }
-        if (isset($this->_payment_method_types[ $payment_method_name ])) {
-            require_once($this->_payment_method_types[ $payment_method_name ]);
+        if (isset($this->_payment_method_types[$payment_method_name])) {
+            require_once($this->_payment_method_types[$payment_method_name]);
             return true;
         }
         return false;
@@ -249,8 +249,8 @@ 
         if ($force_recheck || empty($this->payment_method_objects)) {
             $this->maybe_register_payment_methods($force_recheck);
             foreach ($this->payment_method_type_names(true) as $classname) {
-                if (! isset($this->payment_method_objects[ $classname ])) {
-                    $this->payment_method_objects[ $classname ] = new $classname();
+                if ( ! isset($this->payment_method_objects[$classname])) {
+                    $this->payment_method_objects[$classname] = new $classname();
                 }
             }
         }
@@ -279,7 +279,7 @@ 
      */
     public function payment_method_class_from_type($type)
     {
-        return 'EE_PMT_' . $type;
+        return 'EE_PMT_'.$type;
     }
 
 
@@ -295,13 +295,13 @@ 
     {
         $this->maybe_register_payment_methods();
         $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
             if (class_exists($pm_type_class)) {
                 /** @var $pm_type_obj EE_PMT_Base */
                 $pm_type_obj = new $pm_type_class();
                 $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if (! $payment_method) {
+                if ( ! $payment_method) {
                     $payment_method = $this->create_payment_method_of_type($pm_type_obj);
                 }
                 $payment_method->set_type($payment_method_type);
@@ -338,7 +338,7 @@ 
                         'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
                         'event_espresso'
                     ),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
+                    '<a href="'.admin_url('admin.php?page=espresso_messages&action=settings').'">',
                     '</a>'
                 ),
                 true
@@ -364,7 +364,7 @@ 
                 'PMD_type'       => $pm_type_obj->system_name(),
                 'PMD_name'       => $pm_type_obj->defaultFrontendName(),
                 'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
+                'PMD_slug'       => $pm_type_obj->system_name(), // automatically converted to slug
                 'PMD_wp_user'    => $current_user->ID,
                 'PMD_order'      => EEM_Payment_Method::instance()->count(
                     array(array('PMD_type' => array('!=', 'Admin_Only')))
@@ -386,14 +386,14 @@ 
     {
         $pm_type_obj = $payment_method->type_obj();
         $payment_method->set_description($pm_type_obj->default_description());
-        if (! $payment_method->button_url()) {
+        if ( ! $payment_method->button_url()) {
             $payment_method->set_button_url($pm_type_obj->default_button_url());
         }
         // now add setup its default extra meta properties
         $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if (! empty($extra_metas)) {
+        if ( ! empty($extra_metas)) {
             // verify the payment method has an ID before adding extra meta
-            if (! $payment_method->ID()) {
+            if ( ! $payment_method->ID()) {
                 $payment_method->save();
             }
             foreach ($extra_metas as $meta_name => $input) {
@@ -536,10 +536,10 @@ 
                 )
             );
         }
-        if (! isset($payment_method_caps[ $role ])) {
-            $payment_method_caps[ $role ] = array();
+        if ( ! isset($payment_method_caps[$role])) {
+            $payment_method_caps[$role] = array();
         }
-        $payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
+        $payment_method_caps[$role][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
                                           . strtolower($payment_method_name);
         return $payment_method_caps;
     }

Indentation +557 added lines, -557 removed lines

@@ -16,561 +16,561 @@
  */
 class EE_Payment_Method_Manager implements ResettableInterface
 {
-    /**
-     * prefix added to all payment method capabilities names
-     */
-    const   CAPABILITIES_PREFIX = 'ee_payment_method_';
-
-    /**
-     * @var EE_Payment_Method_Manager $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var boolean
-     */
-    protected $payment_method_caps_initialized = false;
-
-    /**
-     * @var array keys are class names without 'EE_PMT_', values are their filepaths
-     */
-    protected $_payment_method_types = array();
-
-    /**
-     * @var EE_PMT_Base[]
-     */
-    protected $payment_method_objects = array();
-
-
-    /**
-     * EE_Payment_Method_Manager constructor.
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function __construct()
-    {
-        // if in admin lets ensure caps are set.
-        if (is_admin()) {
-            $this->_register_payment_methods();
-            // set them immediately
-            $this->initializePaymentMethodCaps();
-            // plus any time they get reset
-            add_filter(
-                'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-                array($this, 'addPaymentMethodCapsDuringReset')
-            );
-        }
-    }
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Payment_Method_Manager instance
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Payment_Method_Manager) {
-            EE_Registry::instance()->load_lib('PMT_Base');
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets the instance and returns a new one
-     *
-     * @return EE_Payment_Method_Manager
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     * If necessary, re-register payment methods
-     *
-     * @param boolean $force_recheck whether to recheck for payment method types,
-     *                               or just re-use the PMTs we found last time we checked during this request (if
-     *                               we have not yet checked during this request, then we need to check anyways)
-     */
-    public function maybe_register_payment_methods($force_recheck = false)
-    {
-        if (! $this->_payment_method_types || $force_recheck) {
-            $this->_register_payment_methods();
-        }
-    }
-
-
-    /**
-     * register_payment_methods
-     *
-     * @return array
-     */
-    protected function _register_payment_methods()
-    {
-        // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
-        // filter list of modules to register
-        $pm_to_register = apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-            $pm_to_register
-        );
-        // remove any duplicates if that should happen for some reason
-        $pm_to_register = array_unique($pm_to_register);
-        // loop through folders
-        foreach ($pm_to_register as $pm_path) {
-            $this->register_payment_method($pm_path);
-        }
-        do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
-        // filter list of installed modules
-        // keep them organized alphabetically by the payment method type's name
-        ksort($this->_payment_method_types);
-        return apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
-            $this->_payment_method_types
-        );
-    }
-
-
-    /**
-     * register_payment_method- makes core aware of this payment method
-     *
-     * @param string $payment_method_path - full path up to and including payment method folder
-     * @return boolean
-     */
-    public function register_payment_method($payment_method_path = '')
-    {
-        do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
-        $module_ext = '.pm.php';
-        // make all separators match
-        $payment_method_path = rtrim(str_replace('/\\', '/', $payment_method_path), '/');
-        // grab and sanitize module name
-        $module_dir = basename($payment_method_path);
-        // create class name from module directory name
-        $module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
-        // add class prefix
-        $module_class = 'EE_PMT_' . $module;
-        // does the module exist ?
-        if (! is_readable($payment_method_path . '/' . $module_class . $module_ext)) {
-            $msg = sprintf(
-                esc_html__(
-                    'The requested %s payment method file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $module
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the module class file
-        require_once($payment_method_path . '/' . $module_class . $module_ext);
-        // verify that class exists
-        if (! class_exists($module_class)) {
-            $msg = sprintf(
-                esc_html__('The requested %s module class does not exist.', 'event_espresso'),
-                $module_class
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // add to array of registered modules
-        $this->_payment_method_types[ $module ] = $payment_method_path . '/' . $module_class . $module_ext;
-        ksort($this->_payment_method_types);
-        return true;
-    }
-
-
-    /**
-     * Checks if a payment method has been registered, and if so includes it
-     *
-     * @param string  $payment_method_name like 'PayPal_Pro', (ie class name without the prefix 'EEPM_')
-     * @param boolean $force_recheck       whether to force re-checking for new payment method types
-     * @return boolean
-     */
-    public function payment_method_type_exists($payment_method_name, $force_recheck = false)
-    {
-        if (
-            $force_recheck
-            || ! is_array($this->_payment_method_types)
-            || ! isset($this->_payment_method_types[ $payment_method_name ])
-        ) {
-            $this->maybe_register_payment_methods($force_recheck);
-        }
-        if (isset($this->_payment_method_types[ $payment_method_name ])) {
-            require_once($this->_payment_method_types[ $payment_method_name ]);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns all the class names of the various payment method types
-     *
-     * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
-     *                               (what you'd find in wp_esp_payment_method.PMD_type)
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return array
-     */
-    public function payment_method_type_names($with_prefixes = false, $force_recheck = false)
-    {
-        $this->maybe_register_payment_methods($force_recheck);
-        if ($with_prefixes) {
-            $classnames = array_keys($this->_payment_method_types);
-            $payment_methods = array();
-            foreach ($classnames as $classname) {
-                $payment_methods[] = $this->payment_method_class_from_type($classname);
-            }
-            return $payment_methods;
-        }
-        return array_keys($this->_payment_method_types);
-    }
-
-
-    /**
-     * Gets an object of each payment method type, none of which are bound to a
-     * payment method instance
-     *
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return EE_PMT_Base[]
-     */
-    public function payment_method_types($force_recheck = false)
-    {
-        if ($force_recheck || empty($this->payment_method_objects)) {
-            $this->maybe_register_payment_methods($force_recheck);
-            foreach ($this->payment_method_type_names(true) as $classname) {
-                if (! isset($this->payment_method_objects[ $classname ])) {
-                    $this->payment_method_objects[ $classname ] = new $classname();
-                }
-            }
-        }
-        return $this->payment_method_objects;
-    }
-
-
-    /**
-     * Changes the payment method's class name into the payment method type's name
-     * (as used on the payment method's table's PMD_type field)
-     *
-     * @param string $classname
-     * @return string
-     */
-    public function payment_method_type_sans_class_prefix($classname)
-    {
-        return str_replace('EE_PMT_', '', $classname);
-    }
-
-
-    /**
-     * Does the opposite of payment-method_type_sans_prefix
-     *
-     * @param string $type
-     * @return string
-     */
-    public function payment_method_class_from_type($type)
-    {
-        return 'EE_PMT_' . $type;
-    }
-
-
-    /**
-     * Activates a payment method of the given type.
-     *
-     * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
-     * @return EE_Payment_Method
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function activate_a_payment_method_of_type($payment_method_type)
-    {
-        $this->maybe_register_payment_methods();
-        $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if (! $payment_method instanceof EE_Payment_Method) {
-            $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
-            if (class_exists($pm_type_class)) {
-                /** @var $pm_type_obj EE_PMT_Base */
-                $pm_type_obj = new $pm_type_class();
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if (! $payment_method) {
-                    $payment_method = $this->create_payment_method_of_type($pm_type_obj);
-                }
-                $payment_method->set_type($payment_method_type);
-                $this->initialize_payment_method($payment_method);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'There is no payment method of type %1$s, so it could not be activated',
-                            'event_espresso'
-                        ),
-                        $pm_type_class
-                    )
-                );
-            }
-        }
-        $payment_method->set_active();
-        $payment_method->save();
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        // if this was the invoice message type, make sure users can view their invoices
-        if (
-            $payment_method->type() === 'Invoice'
-            && (
-            ! EEH_MSG_Template::is_mt_active('invoice')
-            )
-        ) {
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            /** @type EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager->ensure_message_type_is_active('invoice', 'html');
-            new PersistentAdminNotice(
-                'invoice_pm_requirements_notice',
-                sprintf(
-                    esc_html__(
-                        'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
-                        'event_espresso'
-                    ),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
-                    '</a>'
-                ),
-                true
-            );
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     * Creates a payment method of the specified type. Does not save it.
-     *
-     * @global WP_User    $current_user
-     * @param EE_PMT_Base $pm_type_obj
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function create_payment_method_of_type($pm_type_obj)
-    {
-        global $current_user;
-        $payment_method = EE_Payment_Method::new_instance(
-            array(
-                'PMD_type'       => $pm_type_obj->system_name(),
-                'PMD_name'       => $pm_type_obj->defaultFrontendName(),
-                'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
-                'PMD_wp_user'    => $current_user->ID,
-                'PMD_order'      => EEM_Payment_Method::instance()->count(
-                    array(array('PMD_type' => array('!=', 'Admin_Only')))
-                ) * 10,
-            )
-        );
-        return $payment_method;
-    }
-
-
-    /**
-     * Sets the initial payment method properties (including extra meta)
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function initialize_payment_method($payment_method)
-    {
-        $pm_type_obj = $payment_method->type_obj();
-        $payment_method->set_description($pm_type_obj->default_description());
-        if (! $payment_method->button_url()) {
-            $payment_method->set_button_url($pm_type_obj->default_button_url());
-        }
-        // now add setup its default extra meta properties
-        $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if (! empty($extra_metas)) {
-            // verify the payment method has an ID before adding extra meta
-            if (! $payment_method->ID()) {
-                $payment_method->save();
-            }
-            foreach ($extra_metas as $meta_name => $input) {
-                $payment_method->update_extra_meta($meta_name, $input->raw_value());
-            }
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     * Makes sure the payment method is related to the specified payment method
-     *
-     * @deprecated in 4.9.40 because the currency payment method table is being deprecated
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function set_usable_currencies_on_payment_method($payment_method)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
-            esc_html__(
-                'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
-                'event_espresso'
-            ),
-            '4.9.40'
-        );
-        return $payment_method;
-    }
-
-
-    /**
-     * Deactivates a payment method of the given payment method slug.
-     *
-     * @param string $payment_method_slug The slug for the payment method to deactivate.
-     * @return int count of rows updated.
-     * @throws EE_Error
-     */
-    public function deactivate_payment_method($payment_method_slug)
-    {
-        EE_Log::instance()->log(
-            __FILE__,
-            __FUNCTION__,
-            sprintf(
-                esc_html__(
-                    'Payment method with slug %1$s is being deactivated by site admin',
-                    'event_espresso'
-                ),
-                $payment_method_slug
-            ),
-            'payment_method_change'
-        );
-        $count_updated = EEM_Payment_Method::instance()->update(
-            array('PMD_scope' => array()),
-            array(array('PMD_slug' => $payment_method_slug))
-        );
-        do_action(
-            'AHEE__EE_Payment_Method_Manager__deactivate_payment_method__after_deactivating_payment_method',
-            $payment_method_slug,
-            $count_updated
-        );
-        return $count_updated;
-    }
-
-
-    /**
-     * initializes payment method access caps via EE_Capabilities::init_role_caps()
-     * upon EE_Payment_Method_Manager construction
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    protected function initializePaymentMethodCaps()
-    {
-        // don't do this twice
-        if ($this->payment_method_caps_initialized) {
-            return;
-        }
-        EE_Capabilities::instance()->addCaps(
-            $this->getPaymentMethodCaps()
-        );
-        $this->payment_method_caps_initialized = true;
-    }
-
-
-    /**
-     * array  of dynamic payment method access caps.
-     * at the time of writing, october 20 2014, these are the caps added:
-     *  ee_payment_method_admin_only
-     *  ee_payment_method_aim
-     *  ee_payment_method_bank
-     *  ee_payment_method_check
-     *  ee_payment_method_invoice
-     *  ee_payment_method_mijireh
-     *  ee_payment_method_paypal_pro
-     *  ee_payment_method_paypal_standard
-     * Any other payment methods added to core or via addons will also get
-     * their related capability automatically added too, so long as they are
-     * registered properly using EE_Register_Payment_Method::register()
-     *
-     * @return array
-     * @throws DomainException
-     */
-    protected function getPaymentMethodCaps()
-    {
-        $caps = array();
-        foreach ($this->payment_method_type_names() as $payment_method_name) {
-            $caps = $this->addPaymentMethodCap($payment_method_name, $caps);
-        }
-        return $caps;
-    }
-
-
-    /**
-     * @param string $payment_method_name
-     * @param array  $payment_method_caps
-     * @param string $role
-     * @return array
-     * @throws DomainException
-     */
-    public function addPaymentMethodCap($payment_method_name, array $payment_method_caps, $role = 'administrator')
-    {
-        if (empty($payment_method_name)) {
-            throw new DomainException(
-                esc_html__(
-                    'The name of a payment method must be specified to add capabilities.',
-                    'event_espresso'
-                )
-            );
-        }
-        if (empty($role)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'No role was supplied while trying to add capabilities for the %1$s payment method.',
-                        'event_espresso'
-                    ),
-                    $payment_method_name
-                )
-            );
-        }
-        if (! isset($payment_method_caps[ $role ])) {
-            $payment_method_caps[ $role ] = array();
-        }
-        $payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
-                                          . strtolower($payment_method_name);
-        return $payment_method_caps;
-    }
-
-
-    /**
-     * callback for FHEE__EE_Capabilities__init_role_caps__caps_map filter
-     * to add dynamic payment method access caps when capabilities are reset
-     * (or if that filter is called and PM caps are not already set)
-     *
-     * @param array $caps capabilities being filtered
-     * @param bool  $reset
-     * @return array
-     * @throws DomainException
-     */
-    public function addPaymentMethodCapsDuringReset(array $caps, $reset = false)
-    {
-        if ($reset || ! $this->payment_method_caps_initialized) {
-            $this->payment_method_caps_initialized = true;
-            $caps = array_merge_recursive($caps, $this->getPaymentMethodCaps());
-        }
-        return $caps;
-    }
-
-
-    /**
-     * @deprecated 4.9.42
-     * @param $caps
-     * @return mixed
-     */
-    public function add_payment_method_caps($caps)
-    {
-        return $caps;
-    }
+	/**
+	 * prefix added to all payment method capabilities names
+	 */
+	const   CAPABILITIES_PREFIX = 'ee_payment_method_';
+
+	/**
+	 * @var EE_Payment_Method_Manager $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var boolean
+	 */
+	protected $payment_method_caps_initialized = false;
+
+	/**
+	 * @var array keys are class names without 'EE_PMT_', values are their filepaths
+	 */
+	protected $_payment_method_types = array();
+
+	/**
+	 * @var EE_PMT_Base[]
+	 */
+	protected $payment_method_objects = array();
+
+
+	/**
+	 * EE_Payment_Method_Manager constructor.
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function __construct()
+	{
+		// if in admin lets ensure caps are set.
+		if (is_admin()) {
+			$this->_register_payment_methods();
+			// set them immediately
+			$this->initializePaymentMethodCaps();
+			// plus any time they get reset
+			add_filter(
+				'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+				array($this, 'addPaymentMethodCapsDuringReset')
+			);
+		}
+	}
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Payment_Method_Manager instance
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Payment_Method_Manager) {
+			EE_Registry::instance()->load_lib('PMT_Base');
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets the instance and returns a new one
+	 *
+	 * @return EE_Payment_Method_Manager
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 * If necessary, re-register payment methods
+	 *
+	 * @param boolean $force_recheck whether to recheck for payment method types,
+	 *                               or just re-use the PMTs we found last time we checked during this request (if
+	 *                               we have not yet checked during this request, then we need to check anyways)
+	 */
+	public function maybe_register_payment_methods($force_recheck = false)
+	{
+		if (! $this->_payment_method_types || $force_recheck) {
+			$this->_register_payment_methods();
+		}
+	}
+
+
+	/**
+	 * register_payment_methods
+	 *
+	 * @return array
+	 */
+	protected function _register_payment_methods()
+	{
+		// grab list of installed modules
+		$pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+		// filter list of modules to register
+		$pm_to_register = apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+			$pm_to_register
+		);
+		// remove any duplicates if that should happen for some reason
+		$pm_to_register = array_unique($pm_to_register);
+		// loop through folders
+		foreach ($pm_to_register as $pm_path) {
+			$this->register_payment_method($pm_path);
+		}
+		do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
+		// filter list of installed modules
+		// keep them organized alphabetically by the payment method type's name
+		ksort($this->_payment_method_types);
+		return apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
+			$this->_payment_method_types
+		);
+	}
+
+
+	/**
+	 * register_payment_method- makes core aware of this payment method
+	 *
+	 * @param string $payment_method_path - full path up to and including payment method folder
+	 * @return boolean
+	 */
+	public function register_payment_method($payment_method_path = '')
+	{
+		do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
+		$module_ext = '.pm.php';
+		// make all separators match
+		$payment_method_path = rtrim(str_replace('/\\', '/', $payment_method_path), '/');
+		// grab and sanitize module name
+		$module_dir = basename($payment_method_path);
+		// create class name from module directory name
+		$module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
+		// add class prefix
+		$module_class = 'EE_PMT_' . $module;
+		// does the module exist ?
+		if (! is_readable($payment_method_path . '/' . $module_class . $module_ext)) {
+			$msg = sprintf(
+				esc_html__(
+					'The requested %s payment method file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$module
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the module class file
+		require_once($payment_method_path . '/' . $module_class . $module_ext);
+		// verify that class exists
+		if (! class_exists($module_class)) {
+			$msg = sprintf(
+				esc_html__('The requested %s module class does not exist.', 'event_espresso'),
+				$module_class
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// add to array of registered modules
+		$this->_payment_method_types[ $module ] = $payment_method_path . '/' . $module_class . $module_ext;
+		ksort($this->_payment_method_types);
+		return true;
+	}
+
+
+	/**
+	 * Checks if a payment method has been registered, and if so includes it
+	 *
+	 * @param string  $payment_method_name like 'PayPal_Pro', (ie class name without the prefix 'EEPM_')
+	 * @param boolean $force_recheck       whether to force re-checking for new payment method types
+	 * @return boolean
+	 */
+	public function payment_method_type_exists($payment_method_name, $force_recheck = false)
+	{
+		if (
+			$force_recheck
+			|| ! is_array($this->_payment_method_types)
+			|| ! isset($this->_payment_method_types[ $payment_method_name ])
+		) {
+			$this->maybe_register_payment_methods($force_recheck);
+		}
+		if (isset($this->_payment_method_types[ $payment_method_name ])) {
+			require_once($this->_payment_method_types[ $payment_method_name ]);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns all the class names of the various payment method types
+	 *
+	 * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
+	 *                               (what you'd find in wp_esp_payment_method.PMD_type)
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return array
+	 */
+	public function payment_method_type_names($with_prefixes = false, $force_recheck = false)
+	{
+		$this->maybe_register_payment_methods($force_recheck);
+		if ($with_prefixes) {
+			$classnames = array_keys($this->_payment_method_types);
+			$payment_methods = array();
+			foreach ($classnames as $classname) {
+				$payment_methods[] = $this->payment_method_class_from_type($classname);
+			}
+			return $payment_methods;
+		}
+		return array_keys($this->_payment_method_types);
+	}
+
+
+	/**
+	 * Gets an object of each payment method type, none of which are bound to a
+	 * payment method instance
+	 *
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return EE_PMT_Base[]
+	 */
+	public function payment_method_types($force_recheck = false)
+	{
+		if ($force_recheck || empty($this->payment_method_objects)) {
+			$this->maybe_register_payment_methods($force_recheck);
+			foreach ($this->payment_method_type_names(true) as $classname) {
+				if (! isset($this->payment_method_objects[ $classname ])) {
+					$this->payment_method_objects[ $classname ] = new $classname();
+				}
+			}
+		}
+		return $this->payment_method_objects;
+	}
+
+
+	/**
+	 * Changes the payment method's class name into the payment method type's name
+	 * (as used on the payment method's table's PMD_type field)
+	 *
+	 * @param string $classname
+	 * @return string
+	 */
+	public function payment_method_type_sans_class_prefix($classname)
+	{
+		return str_replace('EE_PMT_', '', $classname);
+	}
+
+
+	/**
+	 * Does the opposite of payment-method_type_sans_prefix
+	 *
+	 * @param string $type
+	 * @return string
+	 */
+	public function payment_method_class_from_type($type)
+	{
+		return 'EE_PMT_' . $type;
+	}
+
+
+	/**
+	 * Activates a payment method of the given type.
+	 *
+	 * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
+	 * @return EE_Payment_Method
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function activate_a_payment_method_of_type($payment_method_type)
+	{
+		$this->maybe_register_payment_methods();
+		$payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
+		if (! $payment_method instanceof EE_Payment_Method) {
+			$pm_type_class = $this->payment_method_class_from_type($payment_method_type);
+			if (class_exists($pm_type_class)) {
+				/** @var $pm_type_obj EE_PMT_Base */
+				$pm_type_obj = new $pm_type_class();
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
+				if (! $payment_method) {
+					$payment_method = $this->create_payment_method_of_type($pm_type_obj);
+				}
+				$payment_method->set_type($payment_method_type);
+				$this->initialize_payment_method($payment_method);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'There is no payment method of type %1$s, so it could not be activated',
+							'event_espresso'
+						),
+						$pm_type_class
+					)
+				);
+			}
+		}
+		$payment_method->set_active();
+		$payment_method->save();
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		// if this was the invoice message type, make sure users can view their invoices
+		if (
+			$payment_method->type() === 'Invoice'
+			&& (
+			! EEH_MSG_Template::is_mt_active('invoice')
+			)
+		) {
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			/** @type EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager->ensure_message_type_is_active('invoice', 'html');
+			new PersistentAdminNotice(
+				'invoice_pm_requirements_notice',
+				sprintf(
+					esc_html__(
+						'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
+						'event_espresso'
+					),
+					'<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
+					'</a>'
+				),
+				true
+			);
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 * Creates a payment method of the specified type. Does not save it.
+	 *
+	 * @global WP_User    $current_user
+	 * @param EE_PMT_Base $pm_type_obj
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function create_payment_method_of_type($pm_type_obj)
+	{
+		global $current_user;
+		$payment_method = EE_Payment_Method::new_instance(
+			array(
+				'PMD_type'       => $pm_type_obj->system_name(),
+				'PMD_name'       => $pm_type_obj->defaultFrontendName(),
+				'PMD_admin_name' => $pm_type_obj->pretty_name(),
+				'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
+				'PMD_wp_user'    => $current_user->ID,
+				'PMD_order'      => EEM_Payment_Method::instance()->count(
+					array(array('PMD_type' => array('!=', 'Admin_Only')))
+				) * 10,
+			)
+		);
+		return $payment_method;
+	}
+
+
+	/**
+	 * Sets the initial payment method properties (including extra meta)
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function initialize_payment_method($payment_method)
+	{
+		$pm_type_obj = $payment_method->type_obj();
+		$payment_method->set_description($pm_type_obj->default_description());
+		if (! $payment_method->button_url()) {
+			$payment_method->set_button_url($pm_type_obj->default_button_url());
+		}
+		// now add setup its default extra meta properties
+		$extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
+		if (! empty($extra_metas)) {
+			// verify the payment method has an ID before adding extra meta
+			if (! $payment_method->ID()) {
+				$payment_method->save();
+			}
+			foreach ($extra_metas as $meta_name => $input) {
+				$payment_method->update_extra_meta($meta_name, $input->raw_value());
+			}
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 * Makes sure the payment method is related to the specified payment method
+	 *
+	 * @deprecated in 4.9.40 because the currency payment method table is being deprecated
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function set_usable_currencies_on_payment_method($payment_method)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
+			esc_html__(
+				'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
+				'event_espresso'
+			),
+			'4.9.40'
+		);
+		return $payment_method;
+	}
+
+
+	/**
+	 * Deactivates a payment method of the given payment method slug.
+	 *
+	 * @param string $payment_method_slug The slug for the payment method to deactivate.
+	 * @return int count of rows updated.
+	 * @throws EE_Error
+	 */
+	public function deactivate_payment_method($payment_method_slug)
+	{
+		EE_Log::instance()->log(
+			__FILE__,
+			__FUNCTION__,
+			sprintf(
+				esc_html__(
+					'Payment method with slug %1$s is being deactivated by site admin',
+					'event_espresso'
+				),
+				$payment_method_slug
+			),
+			'payment_method_change'
+		);
+		$count_updated = EEM_Payment_Method::instance()->update(
+			array('PMD_scope' => array()),
+			array(array('PMD_slug' => $payment_method_slug))
+		);
+		do_action(
+			'AHEE__EE_Payment_Method_Manager__deactivate_payment_method__after_deactivating_payment_method',
+			$payment_method_slug,
+			$count_updated
+		);
+		return $count_updated;
+	}
+
+
+	/**
+	 * initializes payment method access caps via EE_Capabilities::init_role_caps()
+	 * upon EE_Payment_Method_Manager construction
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	protected function initializePaymentMethodCaps()
+	{
+		// don't do this twice
+		if ($this->payment_method_caps_initialized) {
+			return;
+		}
+		EE_Capabilities::instance()->addCaps(
+			$this->getPaymentMethodCaps()
+		);
+		$this->payment_method_caps_initialized = true;
+	}
+
+
+	/**
+	 * array  of dynamic payment method access caps.
+	 * at the time of writing, october 20 2014, these are the caps added:
+	 *  ee_payment_method_admin_only
+	 *  ee_payment_method_aim
+	 *  ee_payment_method_bank
+	 *  ee_payment_method_check
+	 *  ee_payment_method_invoice
+	 *  ee_payment_method_mijireh
+	 *  ee_payment_method_paypal_pro
+	 *  ee_payment_method_paypal_standard
+	 * Any other payment methods added to core or via addons will also get
+	 * their related capability automatically added too, so long as they are
+	 * registered properly using EE_Register_Payment_Method::register()
+	 *
+	 * @return array
+	 * @throws DomainException
+	 */
+	protected function getPaymentMethodCaps()
+	{
+		$caps = array();
+		foreach ($this->payment_method_type_names() as $payment_method_name) {
+			$caps = $this->addPaymentMethodCap($payment_method_name, $caps);
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * @param string $payment_method_name
+	 * @param array  $payment_method_caps
+	 * @param string $role
+	 * @return array
+	 * @throws DomainException
+	 */
+	public function addPaymentMethodCap($payment_method_name, array $payment_method_caps, $role = 'administrator')
+	{
+		if (empty($payment_method_name)) {
+			throw new DomainException(
+				esc_html__(
+					'The name of a payment method must be specified to add capabilities.',
+					'event_espresso'
+				)
+			);
+		}
+		if (empty($role)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'No role was supplied while trying to add capabilities for the %1$s payment method.',
+						'event_espresso'
+					),
+					$payment_method_name
+				)
+			);
+		}
+		if (! isset($payment_method_caps[ $role ])) {
+			$payment_method_caps[ $role ] = array();
+		}
+		$payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
+										  . strtolower($payment_method_name);
+		return $payment_method_caps;
+	}
+
+
+	/**
+	 * callback for FHEE__EE_Capabilities__init_role_caps__caps_map filter
+	 * to add dynamic payment method access caps when capabilities are reset
+	 * (or if that filter is called and PM caps are not already set)
+	 *
+	 * @param array $caps capabilities being filtered
+	 * @param bool  $reset
+	 * @return array
+	 * @throws DomainException
+	 */
+	public function addPaymentMethodCapsDuringReset(array $caps, $reset = false)
+	{
+		if ($reset || ! $this->payment_method_caps_initialized) {
+			$this->payment_method_caps_initialized = true;
+			$caps = array_merge_recursive($caps, $this->getPaymentMethodCaps());
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * @deprecated 4.9.42
+	 * @param $caps
+	 * @return mixed
+	 */
+	public function add_payment_method_caps($caps)
+	{
+		return $caps;
+	}
 }