eventespresso / event-espresso-core

caffeinated/modules/ticket_selector_caff/EED_Ticket_Selector_Caff.module.php

Indentation +294 added lines, -294 removed lines

@@ -17,319 +17,319 @@
 {
 
 
-    /**
-     * @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';
+	}
 }

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();
         }

caffeinated/modules/recaptcha_invisible/RecaptchaAdminSettings.php

Indentation +346 added lines, -346 removed lines

@@ -31,362 +31,362 @@
 class RecaptchaAdminSettings
 {
 
-    /**
-     * @var EE_Registration_Config $config
-     */
-    private $config;
+	/**
+	 * @var EE_Registration_Config $config
+	 */
+	private $config;
 
 
-    /**
-     * RecaptchaAdminSettings constructor.
-     *
-     * @param EE_Registration_Config $registration_config
-     */
-    public function __construct(EE_Registration_Config $registration_config)
-    {
-        $this->config = $registration_config;
-    }
+	/**
+	 * RecaptchaAdminSettings constructor.
+	 *
+	 * @param EE_Registration_Config $registration_config
+	 */
+	public function __construct(EE_Registration_Config $registration_config)
+	{
+		$this->config = $registration_config;
+	}
 
 
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function adminSettings()
-    {
-        echo $this->settingsForm()->get_html_and_js();
-    }
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function adminSettings()
+	{
+		echo $this->settingsForm()->get_html_and_js();
+	}
 
 
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function settingsForm()
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'recaptcha_settings_form',
-                'html_id'         => 'recaptcha_settings_form',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__EED_Recaptcha___recaptcha_settings_form__form_subsections',
-                    array(
-                        'main_settings_hdr'       => new EE_Form_Section_HTML(
-                            EEH_HTML::h2(
-                                esc_html__('reCAPTCHA Anti-spam Settings', 'event_espresso')
-                                . EEH_Template::get_help_tab_link('recaptcha_info')
-                            )
-                        ),
-                        'main_settings'           => $this->mainSettings(),
-                        'appearance_settings_hdr' => new EE_Form_Section_HTML(
-                            EEH_HTML::h2(esc_html__('reCAPTCHA Appearance', 'event_espresso'))
-                        ),
-                        'appearance_settings'     => $this->appearanceSettings(),
-                        'required_fields_note'    => new EE_Form_Section_HTML(
-                            EEH_HTML::p(
-                                esc_html__('All fields marked with a * are required fields', 'event_espresso'),
-                                '',
-                                'grey-text'
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function settingsForm()
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'recaptcha_settings_form',
+				'html_id'         => 'recaptcha_settings_form',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__EED_Recaptcha___recaptcha_settings_form__form_subsections',
+					array(
+						'main_settings_hdr'       => new EE_Form_Section_HTML(
+							EEH_HTML::h2(
+								esc_html__('reCAPTCHA Anti-spam Settings', 'event_espresso')
+								. EEH_Template::get_help_tab_link('recaptcha_info')
+							)
+						),
+						'main_settings'           => $this->mainSettings(),
+						'appearance_settings_hdr' => new EE_Form_Section_HTML(
+							EEH_HTML::h2(esc_html__('reCAPTCHA Appearance', 'event_espresso'))
+						),
+						'appearance_settings'     => $this->appearanceSettings(),
+						'required_fields_note'    => new EE_Form_Section_HTML(
+							EEH_HTML::p(
+								esc_html__('All fields marked with a * are required fields', 'event_espresso'),
+								'',
+								'grey-text'
+							)
+						),
+					)
+				),
+			)
+		);
+	}
 
 
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function mainSettings()
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'recaptcha_settings_tbl',
-                'html_id'         => 'recaptcha_settings_tbl',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__EED_Recaptcha___recaptcha_main_settings__form_subsections',
-                    array(
-                        'use_captcha'          => new EE_Yes_No_Input(
-                            array(
-                                'html_label_text'         => esc_html__('Use reCAPTCHA', 'event_espresso'),
-                                'html_help_text'          => sprintf(
-                                    esc_html__(
-                                        'reCAPTCHA is a free service that  protects your website from spam and abuse. It employs advanced risk analysis technology to separate humans from abusive actors. Sign up %1$shere%2$s to receive your Public and Private keys.',
-                                        'event_espresso'
-                                    ),
-                                    '<a href="https://www.google.com/recaptcha/intro/index.html">',
-                                    '</a>'
-                                ),
-                                'default'                 => $this->config->use_captcha !== null
-                                    ? $this->config->use_captcha : false,
-                                'display_html_label_text' => false,
-                            )
-                        ),
-                        'recaptcha_publickey'  => new EE_Text_Input(
-                            array(
-                                'html_label_text' => esc_html__('Site Key', 'event_espresso'),
-                                'html_help_text'  => esc_html__(
-                                    'The site key is used to display the widget on your site.',
-                                    'event_espresso'
-                                ),
-                                'default'         => $this->config->recaptcha_publickey !== null
-                                    ? stripslashes($this->config->recaptcha_publickey) : '',
-                            )
-                        ),
-                        'recaptcha_privatekey' => new EE_Text_Input(
-                            array(
-                                'html_label_text' => esc_html__('Secret Key', 'event_espresso'),
-                                'html_help_text'  => esc_html__(
-                                    'The secret key authorizes communication between your application backend and the reCAPTCHA server to verify the user\'s response. The secret key needs to be kept safe for security purposes.',
-                                    'event_espresso'
-                                ),
-                                'default'         => $this->config->recaptcha_privatekey !== null
-                                    ? stripslashes($this->config->recaptcha_privatekey)
-                                    : '',
-                            )
-                        ),
-                        'recaptcha_protected_forms' => new EE_Checkbox_Multi_Input(
-                            array(
-                                'ticket_selector'   => esc_html__('Ticket Selector', 'event_espresso'),
-                                'registration_form' => esc_html__('Registration Form', 'event_espresso'),
-                            ),
-                            array(
-                                'html_label_text'         => esc_html__(
-                                    'Invisible reCAPTCHA Protection',
-                                    'event_espresso'
-                                ),
-                                'html_help_text'          => esc_html__(
-                                    'Select which Event Espresso forms you would like to enable Invisible reCAPTCHA on.',
-                                    'event_espresso'
-                                ),
-                                'default'                 => is_array($this->config->recaptcha_protected_forms)
-                                    ? $this->config->recaptcha_protected_forms
-                                    : array(),
-                                'display_html_label_text' => false,
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function mainSettings()
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'recaptcha_settings_tbl',
+				'html_id'         => 'recaptcha_settings_tbl',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__EED_Recaptcha___recaptcha_main_settings__form_subsections',
+					array(
+						'use_captcha'          => new EE_Yes_No_Input(
+							array(
+								'html_label_text'         => esc_html__('Use reCAPTCHA', 'event_espresso'),
+								'html_help_text'          => sprintf(
+									esc_html__(
+										'reCAPTCHA is a free service that  protects your website from spam and abuse. It employs advanced risk analysis technology to separate humans from abusive actors. Sign up %1$shere%2$s to receive your Public and Private keys.',
+										'event_espresso'
+									),
+									'<a href="https://www.google.com/recaptcha/intro/index.html">',
+									'</a>'
+								),
+								'default'                 => $this->config->use_captcha !== null
+									? $this->config->use_captcha : false,
+								'display_html_label_text' => false,
+							)
+						),
+						'recaptcha_publickey'  => new EE_Text_Input(
+							array(
+								'html_label_text' => esc_html__('Site Key', 'event_espresso'),
+								'html_help_text'  => esc_html__(
+									'The site key is used to display the widget on your site.',
+									'event_espresso'
+								),
+								'default'         => $this->config->recaptcha_publickey !== null
+									? stripslashes($this->config->recaptcha_publickey) : '',
+							)
+						),
+						'recaptcha_privatekey' => new EE_Text_Input(
+							array(
+								'html_label_text' => esc_html__('Secret Key', 'event_espresso'),
+								'html_help_text'  => esc_html__(
+									'The secret key authorizes communication between your application backend and the reCAPTCHA server to verify the user\'s response. The secret key needs to be kept safe for security purposes.',
+									'event_espresso'
+								),
+								'default'         => $this->config->recaptcha_privatekey !== null
+									? stripslashes($this->config->recaptcha_privatekey)
+									: '',
+							)
+						),
+						'recaptcha_protected_forms' => new EE_Checkbox_Multi_Input(
+							array(
+								'ticket_selector'   => esc_html__('Ticket Selector', 'event_espresso'),
+								'registration_form' => esc_html__('Registration Form', 'event_espresso'),
+							),
+							array(
+								'html_label_text'         => esc_html__(
+									'Invisible reCAPTCHA Protection',
+									'event_espresso'
+								),
+								'html_help_text'          => esc_html__(
+									'Select which Event Espresso forms you would like to enable Invisible reCAPTCHA on.',
+									'event_espresso'
+								),
+								'default'                 => is_array($this->config->recaptcha_protected_forms)
+									? $this->config->recaptcha_protected_forms
+									: array(),
+								'display_html_label_text' => false,
+							)
+						),
+					)
+				),
+			)
+		);
+	}
 
 
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function appearanceSettings()
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'recaptcha_appearance_settings_tbl',
-                'html_id'         => 'recaptcha_appearance_settings_tbl',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__EED_Recaptcha___recaptcha_appearance_settings__form_subsections',
-                    array(
-                        'recaptcha_theme'    => new EE_Radio_Button_Input(
-                            array(
-                                'invisible' => esc_html__('Invisible', 'event_espresso'),
-                                'light'     => esc_html__('Light', 'event_espresso'),
-                                'dark'      => esc_html__('Dark', 'event_espresso'),
-                            ),
-                            array(
-                                'html_label_text'         => esc_html__('Theme', 'event_espresso'),
-                                'html_help_text'          => esc_html__(
-                                    'The color theme of the widget.',
-                                    'event_espresso'
-                                ),
-                                'default'                 => $this->config->recaptcha_theme !== null
-                                    ? $this->config->recaptcha_theme
-                                    : 'invisible',
-                                'display_html_label_text' => false,
-                            )
-                        ),
-                        'recaptcha_badge'     => new EE_Radio_Button_Input(
-                            array(
-                                'bottomleft' => esc_html__('Bottom Left', 'event_espresso'),
-                                'bottomright' => esc_html__('Bottom Right', 'event_espresso'),
-                                'inline' => esc_html__('Inline', 'event_espresso'),
-                            ),
-                            array(
-                                'html_label_text'         => esc_html__(
-                                    'Invisible reCAPTCHA Badge Position',
-                                    'event_espresso'
-                                ),
-                                'html_help_text'          => esc_html__(
-                                    'If using Invisible reCAPTCHA, then this determines the position of the reCAPTCHA badge. "Bottom Left" and "Bottom Right" both will float at the bottom of the screen. "Inline" appears beside the submit button but allows you to control the CSS.',
-                                    'event_espresso'
-                                ),
-                                'default'                 => $this->config->recaptcha_badge !== null
-                                    ? $this->config->recaptcha_badge
-                                    : 'bottomleft',
-                                'display_html_label_text' => false,
-                            )
-                        ),
-                        'recaptcha_type'     => new EE_Radio_Button_Input(
-                            array(
-                                'image' => esc_html__('Image', 'event_espresso'),
-                                'audio' => esc_html__('Audio', 'event_espresso'),
-                            ),
-                            array(
-                                'html_label_text'         => esc_html__('Type', 'event_espresso'),
-                                'html_help_text'          => esc_html__(
-                                    'The type of CAPTCHA to serve.',
-                                    'event_espresso'
-                                ),
-                                'default'                 => $this->config->recaptcha_type !== null
-                                    ? $this->config->recaptcha_type
-                                    : 'image',
-                                'display_html_label_text' => false,
-                            )
-                        ),
-                        'recaptcha_language' => new EE_Select_Input(
-                            array(
-                                'ar'     => esc_html__('Arabic', 'event_espresso'),
-                                'bg'     => esc_html__('Bulgarian', 'event_espresso'),
-                                'ca'     => esc_html__('Catalan', 'event_espresso'),
-                                'zh-CN'  => esc_html__('Chinese (Simplified)', 'event_espresso'),
-                                'zh-TW'  => esc_html__('Chinese (Traditional)	', 'event_espresso'),
-                                'hr'     => esc_html__('Croatian', 'event_espresso'),
-                                'cs'     => esc_html__('Czech', 'event_espresso'),
-                                'da'     => esc_html__('Danish', 'event_espresso'),
-                                'nl'     => esc_html__('Dutch', 'event_espresso'),
-                                'en-GB'  => esc_html__('English (UK)', 'event_espresso'),
-                                'en'     => esc_html__('English (US)', 'event_espresso'),
-                                'fil'    => esc_html__('Filipino', 'event_espresso'),
-                                'fi'     => esc_html__('Finnish', 'event_espresso'),
-                                'fr'     => esc_html__('French', 'event_espresso'),
-                                'fr-CA'  => esc_html__('French (Canadian)', 'event_espresso'),
-                                'de'     => esc_html__('German', 'event_espresso'),
-                                'de-AT'  => esc_html__('German (Austria)', 'event_espresso'),
-                                'de-CH'  => esc_html__('German (Switzerland)', 'event_espresso'),
-                                'el'     => esc_html__('Greek', 'event_espresso'),
-                                'iw'     => esc_html__('Hebrew', 'event_espresso'),
-                                'hi'     => esc_html__('Hindi', 'event_espresso'),
-                                'hu'     => esc_html__('Hungarian', 'event_espresso'),
-                                'id'     => esc_html__('Indonesian', 'event_espresso'),
-                                'it'     => esc_html__('Italian', 'event_espresso'),
-                                'ja'     => esc_html__('Japanese', 'event_espresso'),
-                                'ko'     => esc_html__('Korean', 'event_espresso'),
-                                'lv'     => esc_html__('Latvian', 'event_espresso'),
-                                'lt'     => esc_html__('Lithuanian', 'event_espresso'),
-                                'no'     => esc_html__('Norwegian', 'event_espresso'),
-                                'fa'     => esc_html__('Persian', 'event_espresso'),
-                                'pl'     => esc_html__('Polish', 'event_espresso'),
-                                'pt'     => esc_html__('Portuguese', 'event_espresso'),
-                                'pt-BR'  => esc_html__('Portuguese (Brazil)', 'event_espresso'),
-                                'pt-PT'  => esc_html__('Portuguese (Portugal)', 'event_espresso'),
-                                'ro'     => esc_html__('Romanian', 'event_espresso'),
-                                'ru'     => esc_html__('Russian', 'event_espresso'),
-                                'sr'     => esc_html__('Serbian', 'event_espresso'),
-                                'sk'     => esc_html__('Slovak', 'event_espresso'),
-                                'sl'     => esc_html__('Slovenian', 'event_espresso'),
-                                'es'     => esc_html__('Spanish', 'event_espresso'),
-                                'es-419' => esc_html__('Spanish (Latin America)', 'event_espresso'),
-                                'sv'     => esc_html__('Swedish', 'event_espresso'),
-                                'th'     => esc_html__('Thai', 'event_espresso'),
-                                'tr'     => esc_html__('Turkish', 'event_espresso'),
-                                'uk'     => esc_html__('Ukrainian', 'event_espresso'),
-                                'vi'     => esc_html__('Vietnamese', 'event_espresso'),
-                            ),
-                            array(
-                                'html_label_text' => esc_html__('Language', 'event_espresso'),
-                                'html_help_text'  => esc_html__(
-                                    'Forces the widget to render in a specific language.',
-                                    'event_espresso'
-                                ),
-                                'default'         => $this->config->recaptcha_language !== null
-                                    ? $this->config->recaptcha_language : 'en',
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function appearanceSettings()
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'recaptcha_appearance_settings_tbl',
+				'html_id'         => 'recaptcha_appearance_settings_tbl',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__EED_Recaptcha___recaptcha_appearance_settings__form_subsections',
+					array(
+						'recaptcha_theme'    => new EE_Radio_Button_Input(
+							array(
+								'invisible' => esc_html__('Invisible', 'event_espresso'),
+								'light'     => esc_html__('Light', 'event_espresso'),
+								'dark'      => esc_html__('Dark', 'event_espresso'),
+							),
+							array(
+								'html_label_text'         => esc_html__('Theme', 'event_espresso'),
+								'html_help_text'          => esc_html__(
+									'The color theme of the widget.',
+									'event_espresso'
+								),
+								'default'                 => $this->config->recaptcha_theme !== null
+									? $this->config->recaptcha_theme
+									: 'invisible',
+								'display_html_label_text' => false,
+							)
+						),
+						'recaptcha_badge'     => new EE_Radio_Button_Input(
+							array(
+								'bottomleft' => esc_html__('Bottom Left', 'event_espresso'),
+								'bottomright' => esc_html__('Bottom Right', 'event_espresso'),
+								'inline' => esc_html__('Inline', 'event_espresso'),
+							),
+							array(
+								'html_label_text'         => esc_html__(
+									'Invisible reCAPTCHA Badge Position',
+									'event_espresso'
+								),
+								'html_help_text'          => esc_html__(
+									'If using Invisible reCAPTCHA, then this determines the position of the reCAPTCHA badge. "Bottom Left" and "Bottom Right" both will float at the bottom of the screen. "Inline" appears beside the submit button but allows you to control the CSS.',
+									'event_espresso'
+								),
+								'default'                 => $this->config->recaptcha_badge !== null
+									? $this->config->recaptcha_badge
+									: 'bottomleft',
+								'display_html_label_text' => false,
+							)
+						),
+						'recaptcha_type'     => new EE_Radio_Button_Input(
+							array(
+								'image' => esc_html__('Image', 'event_espresso'),
+								'audio' => esc_html__('Audio', 'event_espresso'),
+							),
+							array(
+								'html_label_text'         => esc_html__('Type', 'event_espresso'),
+								'html_help_text'          => esc_html__(
+									'The type of CAPTCHA to serve.',
+									'event_espresso'
+								),
+								'default'                 => $this->config->recaptcha_type !== null
+									? $this->config->recaptcha_type
+									: 'image',
+								'display_html_label_text' => false,
+							)
+						),
+						'recaptcha_language' => new EE_Select_Input(
+							array(
+								'ar'     => esc_html__('Arabic', 'event_espresso'),
+								'bg'     => esc_html__('Bulgarian', 'event_espresso'),
+								'ca'     => esc_html__('Catalan', 'event_espresso'),
+								'zh-CN'  => esc_html__('Chinese (Simplified)', 'event_espresso'),
+								'zh-TW'  => esc_html__('Chinese (Traditional)	', 'event_espresso'),
+								'hr'     => esc_html__('Croatian', 'event_espresso'),
+								'cs'     => esc_html__('Czech', 'event_espresso'),
+								'da'     => esc_html__('Danish', 'event_espresso'),
+								'nl'     => esc_html__('Dutch', 'event_espresso'),
+								'en-GB'  => esc_html__('English (UK)', 'event_espresso'),
+								'en'     => esc_html__('English (US)', 'event_espresso'),
+								'fil'    => esc_html__('Filipino', 'event_espresso'),
+								'fi'     => esc_html__('Finnish', 'event_espresso'),
+								'fr'     => esc_html__('French', 'event_espresso'),
+								'fr-CA'  => esc_html__('French (Canadian)', 'event_espresso'),
+								'de'     => esc_html__('German', 'event_espresso'),
+								'de-AT'  => esc_html__('German (Austria)', 'event_espresso'),
+								'de-CH'  => esc_html__('German (Switzerland)', 'event_espresso'),
+								'el'     => esc_html__('Greek', 'event_espresso'),
+								'iw'     => esc_html__('Hebrew', 'event_espresso'),
+								'hi'     => esc_html__('Hindi', 'event_espresso'),
+								'hu'     => esc_html__('Hungarian', 'event_espresso'),
+								'id'     => esc_html__('Indonesian', 'event_espresso'),
+								'it'     => esc_html__('Italian', 'event_espresso'),
+								'ja'     => esc_html__('Japanese', 'event_espresso'),
+								'ko'     => esc_html__('Korean', 'event_espresso'),
+								'lv'     => esc_html__('Latvian', 'event_espresso'),
+								'lt'     => esc_html__('Lithuanian', 'event_espresso'),
+								'no'     => esc_html__('Norwegian', 'event_espresso'),
+								'fa'     => esc_html__('Persian', 'event_espresso'),
+								'pl'     => esc_html__('Polish', 'event_espresso'),
+								'pt'     => esc_html__('Portuguese', 'event_espresso'),
+								'pt-BR'  => esc_html__('Portuguese (Brazil)', 'event_espresso'),
+								'pt-PT'  => esc_html__('Portuguese (Portugal)', 'event_espresso'),
+								'ro'     => esc_html__('Romanian', 'event_espresso'),
+								'ru'     => esc_html__('Russian', 'event_espresso'),
+								'sr'     => esc_html__('Serbian', 'event_espresso'),
+								'sk'     => esc_html__('Slovak', 'event_espresso'),
+								'sl'     => esc_html__('Slovenian', 'event_espresso'),
+								'es'     => esc_html__('Spanish', 'event_espresso'),
+								'es-419' => esc_html__('Spanish (Latin America)', 'event_espresso'),
+								'sv'     => esc_html__('Swedish', 'event_espresso'),
+								'th'     => esc_html__('Thai', 'event_espresso'),
+								'tr'     => esc_html__('Turkish', 'event_espresso'),
+								'uk'     => esc_html__('Ukrainian', 'event_espresso'),
+								'vi'     => esc_html__('Vietnamese', 'event_espresso'),
+							),
+							array(
+								'html_label_text' => esc_html__('Language', 'event_espresso'),
+								'html_help_text'  => esc_html__(
+									'Forces the widget to render in a specific language.',
+									'event_espresso'
+								),
+								'default'         => $this->config->recaptcha_language !== null
+									? $this->config->recaptcha_language : 'en',
+							)
+						),
+					)
+				),
+			)
+		);
+	}
 
 
-    /**
-     * @param EE_Registration_Config $EE_Registration_Config
-     * @return EE_Registration_Config
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function updateAdminSettings(EE_Registration_Config $EE_Registration_Config)
-    {
-        try {
-            $recaptcha_settings_form = $this->settingsForm();
-            // if not displaying a form, then check for form submission
-            if ($recaptcha_settings_form->was_submitted()) {
-                // capture form data
-                $recaptcha_settings_form->receive_form_submission();
-                // validate form data
-                if ($recaptcha_settings_form->is_valid()) {
-                    // grab validated data from form
-                    $valid_data = $recaptcha_settings_form->valid_data();
-                    // user proofing recaptcha:  If Use reCAPTCHA is set to yes but we dont' have site or secret keys then set Use reCAPTCHA to FALSE and give error message.
-                    if (
-                        $valid_data['main_settings']['use_captcha']
-                        && (
-                            ! $EE_Registration_Config->use_captcha
-                            && (
-                                empty($valid_data['main_settings']['recaptcha_publickey'])
-                                || empty($valid_data['main_settings']['recaptcha_privatekey'])
-                            )
-                        )
-                        && apply_filters(
-                            'FHEE__Extend_Registration_Form_Admin_Page__check_for_recaptcha_keys',
-                            true,
-                            $EE_Registration_Config
-                        )
-                    ) {
-                        $valid_data['main_settings']['use_captcha'] = false;
-                        EE_Error::add_error(
-                            esc_html__(
-                                'The use reCAPTCHA setting has been reset to "no". In order to enable the reCAPTCHA service, you must enter a Site Key and Secret Key.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                    $EE_Registration_Config->use_captcha          = $valid_data['main_settings']['use_captcha'];
-                    $EE_Registration_Config->recaptcha_publickey  = $valid_data['main_settings']['recaptcha_publickey'];
-                    $EE_Registration_Config->recaptcha_protected_forms = $valid_data['main_settings']['recaptcha_protected_forms'];
-                    $EE_Registration_Config->recaptcha_privatekey = $valid_data['main_settings']['recaptcha_privatekey'];
-                    $EE_Registration_Config->recaptcha_type       = $valid_data['appearance_settings']['recaptcha_type'];
-                    $EE_Registration_Config->recaptcha_theme      = $valid_data['appearance_settings']['recaptcha_theme'];
-                    $EE_Registration_Config->recaptcha_badge      = $valid_data['appearance_settings']['recaptcha_badge'];
-                    $EE_Registration_Config->recaptcha_language   = $valid_data['appearance_settings']['recaptcha_language'];
-                } else {
-                    if ($recaptcha_settings_form->submission_error_message() !== '') {
-                        EE_Error::add_error(
-                            $recaptcha_settings_form->submission_error_message(),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                }
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-        return $EE_Registration_Config;
-    }
+	/**
+	 * @param EE_Registration_Config $EE_Registration_Config
+	 * @return EE_Registration_Config
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function updateAdminSettings(EE_Registration_Config $EE_Registration_Config)
+	{
+		try {
+			$recaptcha_settings_form = $this->settingsForm();
+			// if not displaying a form, then check for form submission
+			if ($recaptcha_settings_form->was_submitted()) {
+				// capture form data
+				$recaptcha_settings_form->receive_form_submission();
+				// validate form data
+				if ($recaptcha_settings_form->is_valid()) {
+					// grab validated data from form
+					$valid_data = $recaptcha_settings_form->valid_data();
+					// user proofing recaptcha:  If Use reCAPTCHA is set to yes but we dont' have site or secret keys then set Use reCAPTCHA to FALSE and give error message.
+					if (
+						$valid_data['main_settings']['use_captcha']
+						&& (
+							! $EE_Registration_Config->use_captcha
+							&& (
+								empty($valid_data['main_settings']['recaptcha_publickey'])
+								|| empty($valid_data['main_settings']['recaptcha_privatekey'])
+							)
+						)
+						&& apply_filters(
+							'FHEE__Extend_Registration_Form_Admin_Page__check_for_recaptcha_keys',
+							true,
+							$EE_Registration_Config
+						)
+					) {
+						$valid_data['main_settings']['use_captcha'] = false;
+						EE_Error::add_error(
+							esc_html__(
+								'The use reCAPTCHA setting has been reset to "no". In order to enable the reCAPTCHA service, you must enter a Site Key and Secret Key.',
+								'event_espresso'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+					$EE_Registration_Config->use_captcha          = $valid_data['main_settings']['use_captcha'];
+					$EE_Registration_Config->recaptcha_publickey  = $valid_data['main_settings']['recaptcha_publickey'];
+					$EE_Registration_Config->recaptcha_protected_forms = $valid_data['main_settings']['recaptcha_protected_forms'];
+					$EE_Registration_Config->recaptcha_privatekey = $valid_data['main_settings']['recaptcha_privatekey'];
+					$EE_Registration_Config->recaptcha_type       = $valid_data['appearance_settings']['recaptcha_type'];
+					$EE_Registration_Config->recaptcha_theme      = $valid_data['appearance_settings']['recaptcha_theme'];
+					$EE_Registration_Config->recaptcha_badge      = $valid_data['appearance_settings']['recaptcha_badge'];
+					$EE_Registration_Config->recaptcha_language   = $valid_data['appearance_settings']['recaptcha_language'];
+				} else {
+					if ($recaptcha_settings_form->submission_error_message() !== '') {
+						EE_Error::add_error(
+							$recaptcha_settings_form->submission_error_message(),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				}
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+		return $EE_Registration_Config;
+	}
 }

modules/events_archive/EED_Events_Archive.module.php

Spacing +15 added lines, -15 removed lines

@@ -123,8 +123,8 @@ 
      */
     public static function set_definitions()
     {
-        define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
+        define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
+        define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)).'templates/');
     }
 
 
@@ -144,7 +144,7 @@ 
      */
     public static function get_iframe_embed_button()
     {
-        if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
+        if ( ! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
             self::$_iframe_embed_button = new EventListIframeEmbedButton();
         }
         return self::$_iframe_embed_button;
@@ -228,10 +228,10 @@ 
         EEH_Event_Query::add_query_filters();
         // set params that will get used by the filters
         EEH_Event_Query::set_query_params(
-            '',    // month
-            '',    // category
-            $config->display_expired_events,    // show_expired
-            'start_date',    // orderby
+            '', // month
+            '', // category
+            $config->display_expired_events, // show_expired
+            'start_date', // orderby
             'ASC'    // sort
         );
         // check what template is loaded
@@ -297,7 +297,7 @@ 
     public function template_include($template = '')
     {
         // don't add content filter for dedicated EE child themes or private posts
-        if (! EEH_Template::is_espresso_theme()) {
+        if ( ! EEH_Template::is_espresso_theme()) {
             /** @type EE_Events_Archive_Config $config */
             $config = $this->config();
             // add status banner ?
@@ -396,7 +396,7 @@ 
     {
         global $post;
         if ($post instanceof WP_Post) {
-            return in_the_loop() && $post->ID == $id ? espresso_event_status_banner($post->ID) . $title : $title;
+            return in_the_loop() && $post->ID == $id ? espresso_event_status_banner($post->ID).$title : $title;
         }
         return $title;
     }
@@ -547,7 +547,7 @@ 
         if (post_password_required()) {
             return $content;
         }
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-datetimes.php').$content;
     }
 
 
@@ -563,7 +563,7 @@ 
         if (post_password_required()) {
             return $content;
         }
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-tickets.php').$content;
     }
 
 
@@ -592,7 +592,7 @@ 
         if (post_password_required()) {
             return $content;
         }
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+        return $content.EEH_Template::locate_template('content-espresso_events-venues.php');
     }
 
 
@@ -777,10 +777,10 @@ 
         // get some style
         if (apply_filters('FHEE_enable_default_espresso_css', false)) {
             // first check uploads folder
-            if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+            if (EEH_File::is_readable(get_stylesheet_directory().$this->theme.'/style.css')) {
                 wp_register_style(
                     $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
+                    get_stylesheet_directory_uri().$this->theme.'/style.css',
                     array('dashicons', 'espresso_default')
                 );
             } else {
@@ -819,7 +819,7 @@ 
             (array) $template_settings->EED_Events_Archive
         );
         EEH_Template::display_template(
-            EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+            EVENTS_ARCHIVE_TEMPLATES_PATH.'admin-event-list-settings.template.php',
             $events_archive_settings
         );
     }

Indentation +1102 added lines, -1102 removed lines

@@ -16,1097 +16,1097 @@ 
 class EED_Events_Archive extends EED_Module
 {
 
-    const EVENT_DETAILS_PRIORITY = 100;
-
-    const EVENT_DATETIMES_PRIORITY = 110;
-
-    const EVENT_TICKETS_PRIORITY = 120;
-
-    const EVENT_VENUES_PRIORITY = 130;
-
-
-    public static $espresso_event_list_ID = 0;
-
-    public static $espresso_grid_event_lists = array();
-
-    /**
-     * @type bool $using_get_the_excerpt
-     */
-    protected static $using_get_the_excerpt = false;
-
-    /**
-     * Used to flag when the event list is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected static $iframe = false;
-
-    /**
-     * @var EventListIframeEmbedButton $_iframe_embed_button
-     */
-    private static $_iframe_embed_button;
-
-    /**
-     * @type EE_Template_Part_Manager $template_parts
-     */
-    protected $template_parts;
-
-
-    /**
-     * @return EED_Events_Archive
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_hooks()
-    {
-        /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
-        $custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-        );
-        $custom_post_types = $custom_post_type_definitions->getDefinitions();
-        EE_Config::register_route(
-            $custom_post_types['espresso_events']['plural_slug'],
-            'Events_Archive',
-            'run'
-        );
-        EE_Config::register_route(
-            'event_list',
-            'Events_Archive',
-            'event_list'
-        );
-        EE_Config::register_route(
-            'iframe',
-            'Events_Archive',
-            'event_list_iframe',
-            'event_list'
-        );
-        add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
-        // hook into the end of the \EE_Admin_Page::_load_page_dependencies()
-        // to load assets for "espresso_events" page on the "default" route (action)
-        add_action(
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__default',
-            array('EED_Events_Archive', 'event_list_iframe_embed_button'),
-            10
-        );
-    }
-
-
-    /**
-     *    set_definitions
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_definitions()
-    {
-        define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
-    }
-
-
-    /**
-     * set up EE_Events_Archive_Config
-     */
-    protected function set_config()
-    {
-        $this->set_config_section('template_settings');
-        $this->set_config_class('EE_Events_Archive_Config');
-        $this->set_config_name('EED_Events_Archive');
-    }
-
-
-    /**
-     * @return EventListIframeEmbedButton
-     */
-    public static function get_iframe_embed_button()
-    {
-        if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
-            self::$_iframe_embed_button = new EventListIframeEmbedButton();
-        }
-        return self::$_iframe_embed_button;
-    }
-
-
-    /**
-     * event_list_iframe_embed_button
-     *
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function event_list_iframe_embed_button()
-    {
-        $iframe_embed_button = EED_Events_Archive::get_iframe_embed_button();
-        $iframe_embed_button->addEmbedButton();
-    }
-
-
-    /**
-     *    initialize_template_parts
-     *
-     * @access    public
-     * @param EE_Events_Archive_Config $config
-     * @return EE_Template_Part_Manager
-     */
-    public function initialize_template_parts(EE_Events_Archive_Config $config = null)
-    {
-        $config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
-        EEH_Autoloader::instance()->register_template_part_autoloaders();
-        $template_parts = new EE_Template_Part_Manager();
-        $template_parts->add_template_part(
-            'tickets',
-            esc_html__('Ticket Selector', 'event_espresso'),
-            'content-espresso_events-tickets.php',
-            $config->display_order_tickets
-        );
-        $template_parts->add_template_part(
-            'datetimes',
-            esc_html__('Dates and Times', 'event_espresso'),
-            'content-espresso_events-datetimes.php',
-            $config->display_order_datetimes
-        );
-        $template_parts->add_template_part(
-            'event',
-            esc_html__('Event Description', 'event_espresso'),
-            'content-espresso_events-details.php',
-            $config->display_order_event
-        );
-        $template_parts->add_template_part(
-            'venue',
-            esc_html__('Venue Information', 'event_espresso'),
-            'content-espresso_events-venues.php',
-            $config->display_order_venue
-        );
-        do_action('AHEE__EED_Event_Archive__initialize_template_parts', $template_parts);
-        return $template_parts;
-    }
-
-
-    /**
-     *    run - initial module setup - this gets called by the EE_Front_Controller if the module route is found in the
-     *    incoming request
-     *
-     * @access    public
-     * @param WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-        do_action('AHEE__EED_Events_Archive__before_run');
-        // ensure valid EE_Events_Archive_Config() object exists
-        $this->set_config();
-        /** @type EE_Events_Archive_Config $config */
-        $config = $this->config();
-        // load other required components
-        $this->load_event_list_assets();
-        // filter the WP posts_join, posts_where, and posts_orderby SQL clauses
-        // add query filters
-        EEH_Event_Query::add_query_filters();
-        // set params that will get used by the filters
-        EEH_Event_Query::set_query_params(
-            '',    // month
-            '',    // category
-            $config->display_expired_events,    // show_expired
-            'start_date',    // orderby
-            'ASC'    // sort
-        );
-        // check what template is loaded
-        add_filter('template_include', array($this, 'template_include'), 999, 1);
-    }
-
-
-    /**
-     * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting
-     *
-     * @return    void
-     */
-    public function event_list()
-    {
-        // ensure valid EE_Events_Archive_Config() object exists
-        $this->set_config();
-        // load other required components
-        $this->load_event_list_assets();
-    }
-
-
-    /**
-     * @access    public
-     * @return    void
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function event_list_iframe()
-    {
-        EED_Events_Archive::$iframe = true;
-        $event_list_iframe          = new EventsArchiveIframe($this);
-        $event_list_iframe->display();
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public static function is_iframe()
-    {
-        return EED_Events_Archive::$iframe;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public static function link_target()
-    {
-        return EED_Events_Archive::$iframe ? ' target="_blank"' : '';
-    }
-
-
-    /**
-     *    template_include
-     *
-     * @access    public
-     * @param string $template
-     * @return    string
-     */
-    public function template_include($template = '')
-    {
-        // don't add content filter for dedicated EE child themes or private posts
-        if (! EEH_Template::is_espresso_theme()) {
-            /** @type EE_Events_Archive_Config $config */
-            $config = $this->config();
-            // add status banner ?
-            if ($config->display_status_banner) {
-                add_filter('the_title', array('EED_Events_Archive', 'the_title'), 100, 2);
-            }
-            // if NOT a custom template
-            if (
-                apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false)
-                || EE_Registry::instance()
-                              ->load_core('Front_Controller')
-                              ->get_selected_template() !== 'archive-espresso_events.php'
-            ) {
-                // don't display entry meta because the existing theme will take care of that
-                add_filter('FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true');
-                // load functions.php file for the theme (loaded by WP if using child theme)
-                EEH_Template::load_espresso_theme_functions();
-                // because we don't know if the theme is using the_excerpt()
-                add_filter(
-                    'the_excerpt',
-                    array('EED_Events_Archive', 'event_details'),
-                    EED_Events_Archive::EVENT_DETAILS_PRIORITY
-                );
-                // or the_content
-                add_filter(
-                    'the_content',
-                    array('EED_Events_Archive', 'event_details'),
-                    EED_Events_Archive::EVENT_DETAILS_PRIORITY
-                );
-                // and just in case they are running get_the_excerpt() which DESTROYS things
-                add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
-                // don't display entry meta because the existing theme will take care of that
-                add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
-            }
-        }
-        return $template;
-    }
-
-
-    /**
-     *    get_the_excerpt - kinda hacky, but if a theme is using get_the_excerpt(), then we need to remove our filters
-     *    on the_content()
-     *
-     * @access    public
-     * @param        string $excerpt
-     * @return        string
-     */
-    public static function get_the_excerpt($excerpt = '')
-    {
-        if (post_password_required()) {
-            return $excerpt;
-        }
-        if (apply_filters('FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false)) {
-            remove_filter(
-                'the_excerpt',
-                array('EED_Events_Archive', 'event_details'),
-                EED_Events_Archive::EVENT_DETAILS_PRIORITY
-            );
-            remove_filter(
-                'the_content',
-                array('EED_Events_Archive', 'event_details'),
-                EED_Events_Archive::EVENT_DETAILS_PRIORITY
-            );
-            $excerpt = EED_Events_Archive::event_details($excerpt);
-        } else {
-            EED_Events_Archive::$using_get_the_excerpt = true;
-            add_filter('wp_trim_excerpt', array('EED_Events_Archive', 'end_get_the_excerpt'), 999, 1);
-        }
-        return $excerpt;
-    }
-
-
-    /**
-     * end_get_the_excerpt
-     *
-     * @access public
-     * @param  string $text
-     * @return string
-     */
-    public static function end_get_the_excerpt($text = '')
-    {
-        EED_Events_Archive::$using_get_the_excerpt = false;
-        return $text;
-    }
-
-
-    /**
-     *    the_title
-     *
-     * @access        public
-     * @param        string $title
-     * @param        string $id
-     * @return        string
-     */
-    public static function the_title($title = '', $id = '')
-    {
-        global $post;
-        if ($post instanceof WP_Post) {
-            return in_the_loop() && $post->ID == $id ? espresso_event_status_banner($post->ID) . $title : $title;
-        }
-        return $title;
-    }
-
-
-    /**
-     *    event_details
-     *
-     * @access    public
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_details($content)
-    {
-        global $post;
-        static $current_post_ID = 0;
-        if (
-            $current_post_ID !== $post->ID
-            && $post->post_type === 'espresso_events'
-            && ! EED_Events_Archive::$using_get_the_excerpt
-            && ! post_password_required()
-            && (
-                apply_filters('FHEE__EES_Espresso_Events__process_shortcode__true', false)
-                || ! apply_filters('FHEE__content_espresso_events__template_loaded', false)
-            )
-        ) {
-            // Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
-            // Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
-            // BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
-            // We want to allow those plugins to still do their thing and have access to our content, but depending on
-            // how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
-            // so the following allows this filter to be applied multiple times, but only once for real
-            $current_post_ID = did_action('loop_start') ? $post->ID : 0;
-            if (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order) {
-                $content = EED_Events_Archive::use_sortable_display_order();
-            } else {
-                $content = EED_Events_Archive::use_filterable_display_order();
-            }
-        }
-        return $content;
-    }
-
-
-    /**
-     *    use_sortable_display_order
-     *
-     * @access    protected
-     * @return string
-     */
-    protected static function use_sortable_display_order()
-    {
-        // no further password checks required atm
-        add_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true');
-        // we need to first remove this callback from being applied to the_content() or the_excerpt()
-        // (otherwise it will recurse and blow up the interweb)
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
-        // now add additional content depending on whether event is using the_excerpt() or the_content()
-        EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts();
-        $content = EEH_Template::locate_template('content-espresso_events-details.php');
-        $content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters($content);
-        // re-add our main filters (or else the next event won't have them)
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
-        remove_filter(
-            'FHEE__EED_Events_Archive__event_details__no_post_password_required',
-            '__return_true'
-        );
-        return $content;
-    }
-
-
-    /**
-     *    use_filterable_display_order
-     *
-     * @access    protected
-     * @return    string
-     */
-    protected static function use_filterable_display_order()
-    {
-        // we need to first remove this callback from being applied to the_content()
-        // (otherwise it will recurse and blow up the interweb)
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
-        // now add additional content depending on whether event is using the_excerpt() or the_content()
-        EED_Events_Archive::_add_additional_excerpt_filters();
-        EED_Events_Archive::_add_additional_content_filters();
-        do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters');
-        // now load our template
-        $content = EEH_Template::locate_template('content-espresso_events-details.php');
-        // re-add our main filters (or else the next event won't have them)
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
-        // but remove the other filters so that they don't get applied to the next post
-        EED_Events_Archive::_remove_additional_events_archive_filters();
-        do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters');
-        // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
-        // return ! empty( $template ) ? $template : $content;
-        return $content;
-    }
-
-
-    /**
-     *    event_datetimes - adds datetimes ABOVE content
-     *
-     * @access    public
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_datetimes($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
-    }
-
-
-    /**
-     *    event_tickets - adds tickets ABOVE content (which includes datetimes)
-     *
-     * @access    public
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_tickets($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
-    }
-
-
-    /**
-     *    event_venues - adds venues BELOW content
-     *
-     * @access    public
-     * @param    string $content
-     * @return    string
-     */
-    public static function event_venue($content)
-    {
-        return EED_Events_Archive::event_venues($content);
-    }
-
-
-    /**
-     *    event_venues - adds venues BELOW content
-     *
-     * @access    public
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_venues($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
-    }
-
-
-    /**
-     *    _add_additional_content_filters
-     *
-     * @access    private
-     * @return        void
-     */
-    private static function _add_additional_excerpt_filters()
-    {
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     *    _add_additional_content_filters
-     *
-     * @access    private
-     * @return        void
-     */
-    private static function _add_additional_content_filters()
-    {
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     *    _remove_additional_events_archive_filters
-     *
-     * @access    private
-     * @return        void
-     */
-    private static function _remove_additional_events_archive_filters()
-    {
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     *    remove_all_events_archive_filters
-     *
-     * @access    public
-     * @return        void
-     */
-    public static function remove_all_events_archive_filters()
-    {
-        // remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
-        remove_filter('the_title', array('EED_Events_Archive', 'the_title'), 1);
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        // don't display entry meta because the existing theme will take care of that
-        remove_filter(
-            'FHEE__content_espresso_events_details_template__display_entry_meta',
-            '__return_false'
-        );
-    }
-
-
-    /**
-     *    load_event_list_assets
-     *
-     * @access    public
-     * @return    void
-     */
-    public function load_event_list_assets()
-    {
-        do_action('AHEE__EED_Events_Archive__before_load_assets');
-        add_filter('FHEE_load_EE_Session', '__return_true');
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
-        if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
-            add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
-        }
-    }
-
-
-    /**
-     *    wp_enqueue_scripts
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_enqueue_scripts()
-    {
-        // get some style
-        if (apply_filters('FHEE_enable_default_espresso_css', false)) {
-            // first check uploads folder
-            if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            } else {
-            }
-            wp_enqueue_style($this->theme);
-        }
-    }
-
-
-    /**
-     *    template_settings_form
-     *
-     * @access    public
-     * @static
-     * @return    string
-     */
-    public static function template_settings_form()
-    {
-        $template_settings = EE_Registry::instance()->CFG->template_settings;
-        $template_settings->EED_Events_Archive = isset($template_settings->EED_Events_Archive)
-            ? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
-        $template_settings->EED_Events_Archive = apply_filters(
-            'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
-            $template_settings->EED_Events_Archive
-        );
-        $events_archive_settings = array(
-            'display_status_banner' => 0,
-            'display_description' => 1,
-            'display_ticket_selector' => 0,
-            'display_datetimes' => 1,
-            'display_venue' => 0,
-            'display_expired_events' => 0,
-        );
-        $events_archive_settings = array_merge(
-            $events_archive_settings,
-            (array) $template_settings->EED_Events_Archive
-        );
-        EEH_Template::display_template(
-            EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
-            $events_archive_settings
-        );
-    }
-
-
-    /**
-     *    update_template_settings
-     *
-     * @access    public
-     * @param    EE_Template_Config $CFG
-     * @param    EE_Request_Handler $REQ
-     * @return    EE_Template_Config
-     */
-    public static function update_template_settings($CFG, $REQ)
-    {
-        $CFG->EED_Events_Archive = new EE_Events_Archive_Config();
-        // unless we are resetting the config...
-        if (
-            ! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
-            || absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
-        ) {
-            $CFG->EED_Events_Archive->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner'])
-                ? absint($REQ['EED_Events_Archive_display_status_banner']) : 0;
-            $CFG->EED_Events_Archive->display_description = isset($REQ['EED_Events_Archive_display_description'])
-                ? absint($REQ['EED_Events_Archive_display_description']) : 1;
-            $CFG->EED_Events_Archive->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
-                ? absint($REQ['EED_Events_Archive_display_ticket_selector']) : 0;
-            $CFG->EED_Events_Archive->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes']) ? absint(
-                $REQ['EED_Events_Archive_display_datetimes']
-            ) : 1;
-            $CFG->EED_Events_Archive->display_venue = isset($REQ['EED_Events_Archive_display_venue']) ? absint(
-                $REQ['EED_Events_Archive_display_venue']
-            ) : 0;
-            $CFG->EED_Events_Archive->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events'])
-                ? absint($REQ['EED_Events_Archive_display_expired_events']) : 0;
-        }
-        return $CFG;
-    }
-
-
-    /**
-     *    event_list_css
-     *
-     * @access    public
-     * @param string $extra_class
-     * @return    string
-     */
-    public static function event_list_css($extra_class = '')
-    {
-        $event_list_css = ! empty($extra_class) ? array($extra_class) : array();
-        $event_list_css[] = 'espresso-event-list-event';
-        return implode(' ', $event_list_css);
-    }
-
-
-    /**
-     *    event_categories
-     *
-     * @access    public
-     * @return    array
-     */
-    public static function event_categories()
-    {
-        return EE_Registry::instance()->load_model('Term')->get_all_ee_categories();
-    }
-
-
-    /**
-     *    display_description
-     *
-     * @access    public
-     * @param $value
-     * @return    bool
-     */
-    public static function display_description($value)
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        $display_description = isset($config->display_description) ? $config->display_description : 1;
-        return $display_description === $value ? true : false;
-    }
-
-
-    /**
-     *    display_ticket_selector
-     *
-     * @access    public
-     * @return    bool
-     */
-    public static function display_ticket_selector()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_ticket_selector) && $config->display_ticket_selector ? true : false;
-    }
-
-
-    /**
-     *    display_venue
-     *
-     * @access    public
-     * @return    bool
-     */
-    public static function display_venue()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_venue) && $config->display_venue && EEH_Venue_View::venue_name() ? true : false;
-    }
-
-
-    /**
-     *    display_datetimes
-     *
-     * @access    public
-     * @return    bool
-     */
-    public static function display_datetimes()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_datetimes) && $config->display_datetimes ? true : false;
-    }
-
-
-    /**
-     *    event_list_title
-     *
-     * @access    public
-     * @return    string
-     */
-    public static function event_list_title()
-    {
-        return apply_filters(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            esc_html__('Upcoming Events', 'event_espresso')
-        );
-    }
-
-
-    // GRAVEYARD
-
-
-    /**
-     * @since 4.4.0
-     */
-    public static function _doing_it_wrong_notice($function = '')
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            sprintf(
-                esc_html__(
-                    'EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s',
-                    'event_espresso'
-                ),
-                $function,
-                '<br />',
-                '4.6.0'
-            ),
-            '4.4.0'
-        );
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public function get_post_data()
-    {
-        EEH_Event_Query::set_query_params();
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public function posts_fields($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_fields($SQL, $wp_query);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_fields_sql_for_orderby($orderby_params = array())
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_fields_sql_for_orderby($orderby_params);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public function posts_join($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join($SQL, $wp_query);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_join_sql_for_terms($join_terms = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join_sql_for_terms($join_terms);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_join_for_orderby($orderby_params = array())
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join_for_orderby($orderby_params);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public function posts_where($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where($SQL, $wp_query);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_where_sql_for_show_expired($show_expired = false)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_show_expired($show_expired);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_event_category_slug($event_category_slug);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_where_sql_for_event_list_month($month = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_event_list_month($month);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public function posts_orderby($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_orderby($SQL, $wp_query);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_orderby_sql($orderby_params = array(), $sort = 'ASC')
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_orderby_sql($orderby_params, $sort);
-    }
+	const EVENT_DETAILS_PRIORITY = 100;
+
+	const EVENT_DATETIMES_PRIORITY = 110;
+
+	const EVENT_TICKETS_PRIORITY = 120;
+
+	const EVENT_VENUES_PRIORITY = 130;
+
+
+	public static $espresso_event_list_ID = 0;
+
+	public static $espresso_grid_event_lists = array();
+
+	/**
+	 * @type bool $using_get_the_excerpt
+	 */
+	protected static $using_get_the_excerpt = false;
+
+	/**
+	 * Used to flag when the event list is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected static $iframe = false;
+
+	/**
+	 * @var EventListIframeEmbedButton $_iframe_embed_button
+	 */
+	private static $_iframe_embed_button;
+
+	/**
+	 * @type EE_Template_Part_Manager $template_parts
+	 */
+	protected $template_parts;
+
+
+	/**
+	 * @return EED_Events_Archive
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_hooks()
+	{
+		/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
+		$custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+		);
+		$custom_post_types = $custom_post_type_definitions->getDefinitions();
+		EE_Config::register_route(
+			$custom_post_types['espresso_events']['plural_slug'],
+			'Events_Archive',
+			'run'
+		);
+		EE_Config::register_route(
+			'event_list',
+			'Events_Archive',
+			'event_list'
+		);
+		EE_Config::register_route(
+			'iframe',
+			'Events_Archive',
+			'event_list_iframe',
+			'event_list'
+		);
+		add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
+		// hook into the end of the \EE_Admin_Page::_load_page_dependencies()
+		// to load assets for "espresso_events" page on the "default" route (action)
+		add_action(
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__default',
+			array('EED_Events_Archive', 'event_list_iframe_embed_button'),
+			10
+		);
+	}
+
+
+	/**
+	 *    set_definitions
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_definitions()
+	{
+		define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
+	}
+
+
+	/**
+	 * set up EE_Events_Archive_Config
+	 */
+	protected function set_config()
+	{
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Events_Archive_Config');
+		$this->set_config_name('EED_Events_Archive');
+	}
+
+
+	/**
+	 * @return EventListIframeEmbedButton
+	 */
+	public static function get_iframe_embed_button()
+	{
+		if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
+			self::$_iframe_embed_button = new EventListIframeEmbedButton();
+		}
+		return self::$_iframe_embed_button;
+	}
+
+
+	/**
+	 * event_list_iframe_embed_button
+	 *
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function event_list_iframe_embed_button()
+	{
+		$iframe_embed_button = EED_Events_Archive::get_iframe_embed_button();
+		$iframe_embed_button->addEmbedButton();
+	}
+
+
+	/**
+	 *    initialize_template_parts
+	 *
+	 * @access    public
+	 * @param EE_Events_Archive_Config $config
+	 * @return EE_Template_Part_Manager
+	 */
+	public function initialize_template_parts(EE_Events_Archive_Config $config = null)
+	{
+		$config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
+		EEH_Autoloader::instance()->register_template_part_autoloaders();
+		$template_parts = new EE_Template_Part_Manager();
+		$template_parts->add_template_part(
+			'tickets',
+			esc_html__('Ticket Selector', 'event_espresso'),
+			'content-espresso_events-tickets.php',
+			$config->display_order_tickets
+		);
+		$template_parts->add_template_part(
+			'datetimes',
+			esc_html__('Dates and Times', 'event_espresso'),
+			'content-espresso_events-datetimes.php',
+			$config->display_order_datetimes
+		);
+		$template_parts->add_template_part(
+			'event',
+			esc_html__('Event Description', 'event_espresso'),
+			'content-espresso_events-details.php',
+			$config->display_order_event
+		);
+		$template_parts->add_template_part(
+			'venue',
+			esc_html__('Venue Information', 'event_espresso'),
+			'content-espresso_events-venues.php',
+			$config->display_order_venue
+		);
+		do_action('AHEE__EED_Event_Archive__initialize_template_parts', $template_parts);
+		return $template_parts;
+	}
+
+
+	/**
+	 *    run - initial module setup - this gets called by the EE_Front_Controller if the module route is found in the
+	 *    incoming request
+	 *
+	 * @access    public
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+		do_action('AHEE__EED_Events_Archive__before_run');
+		// ensure valid EE_Events_Archive_Config() object exists
+		$this->set_config();
+		/** @type EE_Events_Archive_Config $config */
+		$config = $this->config();
+		// load other required components
+		$this->load_event_list_assets();
+		// filter the WP posts_join, posts_where, and posts_orderby SQL clauses
+		// add query filters
+		EEH_Event_Query::add_query_filters();
+		// set params that will get used by the filters
+		EEH_Event_Query::set_query_params(
+			'',    // month
+			'',    // category
+			$config->display_expired_events,    // show_expired
+			'start_date',    // orderby
+			'ASC'    // sort
+		);
+		// check what template is loaded
+		add_filter('template_include', array($this, 'template_include'), 999, 1);
+	}
+
+
+	/**
+	 * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting
+	 *
+	 * @return    void
+	 */
+	public function event_list()
+	{
+		// ensure valid EE_Events_Archive_Config() object exists
+		$this->set_config();
+		// load other required components
+		$this->load_event_list_assets();
+	}
+
+
+	/**
+	 * @access    public
+	 * @return    void
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function event_list_iframe()
+	{
+		EED_Events_Archive::$iframe = true;
+		$event_list_iframe          = new EventsArchiveIframe($this);
+		$event_list_iframe->display();
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public static function is_iframe()
+	{
+		return EED_Events_Archive::$iframe;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public static function link_target()
+	{
+		return EED_Events_Archive::$iframe ? ' target="_blank"' : '';
+	}
+
+
+	/**
+	 *    template_include
+	 *
+	 * @access    public
+	 * @param string $template
+	 * @return    string
+	 */
+	public function template_include($template = '')
+	{
+		// don't add content filter for dedicated EE child themes or private posts
+		if (! EEH_Template::is_espresso_theme()) {
+			/** @type EE_Events_Archive_Config $config */
+			$config = $this->config();
+			// add status banner ?
+			if ($config->display_status_banner) {
+				add_filter('the_title', array('EED_Events_Archive', 'the_title'), 100, 2);
+			}
+			// if NOT a custom template
+			if (
+				apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false)
+				|| EE_Registry::instance()
+							  ->load_core('Front_Controller')
+							  ->get_selected_template() !== 'archive-espresso_events.php'
+			) {
+				// don't display entry meta because the existing theme will take care of that
+				add_filter('FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true');
+				// load functions.php file for the theme (loaded by WP if using child theme)
+				EEH_Template::load_espresso_theme_functions();
+				// because we don't know if the theme is using the_excerpt()
+				add_filter(
+					'the_excerpt',
+					array('EED_Events_Archive', 'event_details'),
+					EED_Events_Archive::EVENT_DETAILS_PRIORITY
+				);
+				// or the_content
+				add_filter(
+					'the_content',
+					array('EED_Events_Archive', 'event_details'),
+					EED_Events_Archive::EVENT_DETAILS_PRIORITY
+				);
+				// and just in case they are running get_the_excerpt() which DESTROYS things
+				add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
+				// don't display entry meta because the existing theme will take care of that
+				add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
+			}
+		}
+		return $template;
+	}
+
+
+	/**
+	 *    get_the_excerpt - kinda hacky, but if a theme is using get_the_excerpt(), then we need to remove our filters
+	 *    on the_content()
+	 *
+	 * @access    public
+	 * @param        string $excerpt
+	 * @return        string
+	 */
+	public static function get_the_excerpt($excerpt = '')
+	{
+		if (post_password_required()) {
+			return $excerpt;
+		}
+		if (apply_filters('FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false)) {
+			remove_filter(
+				'the_excerpt',
+				array('EED_Events_Archive', 'event_details'),
+				EED_Events_Archive::EVENT_DETAILS_PRIORITY
+			);
+			remove_filter(
+				'the_content',
+				array('EED_Events_Archive', 'event_details'),
+				EED_Events_Archive::EVENT_DETAILS_PRIORITY
+			);
+			$excerpt = EED_Events_Archive::event_details($excerpt);
+		} else {
+			EED_Events_Archive::$using_get_the_excerpt = true;
+			add_filter('wp_trim_excerpt', array('EED_Events_Archive', 'end_get_the_excerpt'), 999, 1);
+		}
+		return $excerpt;
+	}
+
+
+	/**
+	 * end_get_the_excerpt
+	 *
+	 * @access public
+	 * @param  string $text
+	 * @return string
+	 */
+	public static function end_get_the_excerpt($text = '')
+	{
+		EED_Events_Archive::$using_get_the_excerpt = false;
+		return $text;
+	}
+
+
+	/**
+	 *    the_title
+	 *
+	 * @access        public
+	 * @param        string $title
+	 * @param        string $id
+	 * @return        string
+	 */
+	public static function the_title($title = '', $id = '')
+	{
+		global $post;
+		if ($post instanceof WP_Post) {
+			return in_the_loop() && $post->ID == $id ? espresso_event_status_banner($post->ID) . $title : $title;
+		}
+		return $title;
+	}
+
+
+	/**
+	 *    event_details
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_details($content)
+	{
+		global $post;
+		static $current_post_ID = 0;
+		if (
+			$current_post_ID !== $post->ID
+			&& $post->post_type === 'espresso_events'
+			&& ! EED_Events_Archive::$using_get_the_excerpt
+			&& ! post_password_required()
+			&& (
+				apply_filters('FHEE__EES_Espresso_Events__process_shortcode__true', false)
+				|| ! apply_filters('FHEE__content_espresso_events__template_loaded', false)
+			)
+		) {
+			// Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
+			// Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
+			// BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
+			// We want to allow those plugins to still do their thing and have access to our content, but depending on
+			// how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
+			// so the following allows this filter to be applied multiple times, but only once for real
+			$current_post_ID = did_action('loop_start') ? $post->ID : 0;
+			if (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order) {
+				$content = EED_Events_Archive::use_sortable_display_order();
+			} else {
+				$content = EED_Events_Archive::use_filterable_display_order();
+			}
+		}
+		return $content;
+	}
+
+
+	/**
+	 *    use_sortable_display_order
+	 *
+	 * @access    protected
+	 * @return string
+	 */
+	protected static function use_sortable_display_order()
+	{
+		// no further password checks required atm
+		add_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true');
+		// we need to first remove this callback from being applied to the_content() or the_excerpt()
+		// (otherwise it will recurse and blow up the interweb)
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
+		// now add additional content depending on whether event is using the_excerpt() or the_content()
+		EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts();
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		$content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters($content);
+		// re-add our main filters (or else the next event won't have them)
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
+		remove_filter(
+			'FHEE__EED_Events_Archive__event_details__no_post_password_required',
+			'__return_true'
+		);
+		return $content;
+	}
+
+
+	/**
+	 *    use_filterable_display_order
+	 *
+	 * @access    protected
+	 * @return    string
+	 */
+	protected static function use_filterable_display_order()
+	{
+		// we need to first remove this callback from being applied to the_content()
+		// (otherwise it will recurse and blow up the interweb)
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
+		// now add additional content depending on whether event is using the_excerpt() or the_content()
+		EED_Events_Archive::_add_additional_excerpt_filters();
+		EED_Events_Archive::_add_additional_content_filters();
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters');
+		// now load our template
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		// re-add our main filters (or else the next event won't have them)
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
+		// but remove the other filters so that they don't get applied to the next post
+		EED_Events_Archive::_remove_additional_events_archive_filters();
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters');
+		// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
+		// return ! empty( $template ) ? $template : $content;
+		return $content;
+	}
+
+
+	/**
+	 *    event_datetimes - adds datetimes ABOVE content
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_datetimes($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+	}
+
+
+	/**
+	 *    event_tickets - adds tickets ABOVE content (which includes datetimes)
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_tickets($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+	}
+
+
+	/**
+	 *    event_venues - adds venues BELOW content
+	 *
+	 * @access    public
+	 * @param    string $content
+	 * @return    string
+	 */
+	public static function event_venue($content)
+	{
+		return EED_Events_Archive::event_venues($content);
+	}
+
+
+	/**
+	 *    event_venues - adds venues BELOW content
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_venues($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+	}
+
+
+	/**
+	 *    _add_additional_content_filters
+	 *
+	 * @access    private
+	 * @return        void
+	 */
+	private static function _add_additional_excerpt_filters()
+	{
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 *    _add_additional_content_filters
+	 *
+	 * @access    private
+	 * @return        void
+	 */
+	private static function _add_additional_content_filters()
+	{
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 *    _remove_additional_events_archive_filters
+	 *
+	 * @access    private
+	 * @return        void
+	 */
+	private static function _remove_additional_events_archive_filters()
+	{
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 *    remove_all_events_archive_filters
+	 *
+	 * @access    public
+	 * @return        void
+	 */
+	public static function remove_all_events_archive_filters()
+	{
+		// remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
+		remove_filter('the_title', array('EED_Events_Archive', 'the_title'), 1);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		// don't display entry meta because the existing theme will take care of that
+		remove_filter(
+			'FHEE__content_espresso_events_details_template__display_entry_meta',
+			'__return_false'
+		);
+	}
+
+
+	/**
+	 *    load_event_list_assets
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function load_event_list_assets()
+	{
+		do_action('AHEE__EED_Events_Archive__before_load_assets');
+		add_filter('FHEE_load_EE_Session', '__return_true');
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
+		if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
+			add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
+		}
+	}
+
+
+	/**
+	 *    wp_enqueue_scripts
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// get some style
+		if (apply_filters('FHEE_enable_default_espresso_css', false)) {
+			// first check uploads folder
+			if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					get_stylesheet_directory_uri() . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			} else {
+			}
+			wp_enqueue_style($this->theme);
+		}
+	}
+
+
+	/**
+	 *    template_settings_form
+	 *
+	 * @access    public
+	 * @static
+	 * @return    string
+	 */
+	public static function template_settings_form()
+	{
+		$template_settings = EE_Registry::instance()->CFG->template_settings;
+		$template_settings->EED_Events_Archive = isset($template_settings->EED_Events_Archive)
+			? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
+		$template_settings->EED_Events_Archive = apply_filters(
+			'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
+			$template_settings->EED_Events_Archive
+		);
+		$events_archive_settings = array(
+			'display_status_banner' => 0,
+			'display_description' => 1,
+			'display_ticket_selector' => 0,
+			'display_datetimes' => 1,
+			'display_venue' => 0,
+			'display_expired_events' => 0,
+		);
+		$events_archive_settings = array_merge(
+			$events_archive_settings,
+			(array) $template_settings->EED_Events_Archive
+		);
+		EEH_Template::display_template(
+			EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+			$events_archive_settings
+		);
+	}
+
+
+	/**
+	 *    update_template_settings
+	 *
+	 * @access    public
+	 * @param    EE_Template_Config $CFG
+	 * @param    EE_Request_Handler $REQ
+	 * @return    EE_Template_Config
+	 */
+	public static function update_template_settings($CFG, $REQ)
+	{
+		$CFG->EED_Events_Archive = new EE_Events_Archive_Config();
+		// unless we are resetting the config...
+		if (
+			! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
+			|| absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
+		) {
+			$CFG->EED_Events_Archive->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner'])
+				? absint($REQ['EED_Events_Archive_display_status_banner']) : 0;
+			$CFG->EED_Events_Archive->display_description = isset($REQ['EED_Events_Archive_display_description'])
+				? absint($REQ['EED_Events_Archive_display_description']) : 1;
+			$CFG->EED_Events_Archive->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
+				? absint($REQ['EED_Events_Archive_display_ticket_selector']) : 0;
+			$CFG->EED_Events_Archive->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes']) ? absint(
+				$REQ['EED_Events_Archive_display_datetimes']
+			) : 1;
+			$CFG->EED_Events_Archive->display_venue = isset($REQ['EED_Events_Archive_display_venue']) ? absint(
+				$REQ['EED_Events_Archive_display_venue']
+			) : 0;
+			$CFG->EED_Events_Archive->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events'])
+				? absint($REQ['EED_Events_Archive_display_expired_events']) : 0;
+		}
+		return $CFG;
+	}
+
+
+	/**
+	 *    event_list_css
+	 *
+	 * @access    public
+	 * @param string $extra_class
+	 * @return    string
+	 */
+	public static function event_list_css($extra_class = '')
+	{
+		$event_list_css = ! empty($extra_class) ? array($extra_class) : array();
+		$event_list_css[] = 'espresso-event-list-event';
+		return implode(' ', $event_list_css);
+	}
+
+
+	/**
+	 *    event_categories
+	 *
+	 * @access    public
+	 * @return    array
+	 */
+	public static function event_categories()
+	{
+		return EE_Registry::instance()->load_model('Term')->get_all_ee_categories();
+	}
+
+
+	/**
+	 *    display_description
+	 *
+	 * @access    public
+	 * @param $value
+	 * @return    bool
+	 */
+	public static function display_description($value)
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		$display_description = isset($config->display_description) ? $config->display_description : 1;
+		return $display_description === $value ? true : false;
+	}
+
+
+	/**
+	 *    display_ticket_selector
+	 *
+	 * @access    public
+	 * @return    bool
+	 */
+	public static function display_ticket_selector()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_ticket_selector) && $config->display_ticket_selector ? true : false;
+	}
+
+
+	/**
+	 *    display_venue
+	 *
+	 * @access    public
+	 * @return    bool
+	 */
+	public static function display_venue()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_venue) && $config->display_venue && EEH_Venue_View::venue_name() ? true : false;
+	}
+
+
+	/**
+	 *    display_datetimes
+	 *
+	 * @access    public
+	 * @return    bool
+	 */
+	public static function display_datetimes()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_datetimes) && $config->display_datetimes ? true : false;
+	}
+
+
+	/**
+	 *    event_list_title
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public static function event_list_title()
+	{
+		return apply_filters(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			esc_html__('Upcoming Events', 'event_espresso')
+		);
+	}
+
+
+	// GRAVEYARD
+
+
+	/**
+	 * @since 4.4.0
+	 */
+	public static function _doing_it_wrong_notice($function = '')
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			sprintf(
+				esc_html__(
+					'EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s',
+					'event_espresso'
+				),
+				$function,
+				'<br />',
+				'4.6.0'
+			),
+			'4.4.0'
+		);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public function get_post_data()
+	{
+		EEH_Event_Query::set_query_params();
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public function posts_fields($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_fields_sql_for_orderby($orderby_params = array())
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields_sql_for_orderby($orderby_params);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public function posts_join($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_join_sql_for_terms($join_terms = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_sql_for_terms($join_terms);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_join_for_orderby($orderby_params = array())
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_for_orderby($orderby_params);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public function posts_where($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_where_sql_for_show_expired($show_expired = false)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_show_expired($show_expired);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_category_slug($event_category_slug);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_where_sql_for_event_list_month($month = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_list_month($month);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public function posts_orderby($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_orderby_sql($orderby_params = array(), $sort = 'ASC')
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby_sql($orderby_params, $sort);
+	}
 }
 
 
@@ -1115,9 +1115,9 @@ 
  */
 function espresso_get_event_list_ID()
 {
-    EED_Events_Archive::$espresso_event_list_ID++;
-    EED_Events_Archive::$espresso_grid_event_lists[] = EED_Events_Archive::$espresso_event_list_ID;
-    return EED_Events_Archive::$espresso_event_list_ID;
+	EED_Events_Archive::$espresso_event_list_ID++;
+	EED_Events_Archive::$espresso_grid_event_lists[] = EED_Events_Archive::$espresso_event_list_ID;
+	return EED_Events_Archive::$espresso_event_list_ID;
 }
 
 /**
@@ -1125,7 +1125,7 @@ 
  */
 function espresso_event_list_title()
 {
-    return EED_Events_Archive::event_list_title();
+	return EED_Events_Archive::event_list_title();
 }
 
 /**
@@ -1134,7 +1134,7 @@ 
  */
 function espresso_event_list_css($extra_class = '')
 {
-    return EED_Events_Archive::event_list_css($extra_class);
+	return EED_Events_Archive::event_list_css($extra_class);
 }
 
 /**
@@ -1142,7 +1142,7 @@ 
  */
 function espresso_get_event_categories()
 {
-    return EED_Events_Archive::event_categories();
+	return EED_Events_Archive::event_categories();
 }
 
 /**
@@ -1150,7 +1150,7 @@ 
  */
 function espresso_display_full_description_in_event_list()
 {
-    return EED_Events_Archive::display_description(2);
+	return EED_Events_Archive::display_description(2);
 }
 
 /**
@@ -1158,7 +1158,7 @@ 
  */
 function espresso_display_excerpt_in_event_list()
 {
-    return EED_Events_Archive::display_description(1);
+	return EED_Events_Archive::display_description(1);
 }
 
 /**
@@ -1166,7 +1166,7 @@ 
  */
 function espresso_display_ticket_selector_in_event_list()
 {
-    return EED_Events_Archive::display_ticket_selector();
+	return EED_Events_Archive::display_ticket_selector();
 }
 
 /**
@@ -1174,7 +1174,7 @@ 
  */
 function espresso_display_venue_in_event_list()
 {
-    return EED_Events_Archive::display_venue();
+	return EED_Events_Archive::display_venue();
 }
 
 /**
@@ -1182,5 +1182,5 @@ 
  */
 function espresso_display_datetimes_in_event_list()
 {
-    return EED_Events_Archive::display_datetimes();
+	return EED_Events_Archive::display_datetimes();
 }

modules/event_single/EED_Event_Single.module.php

Spacing +9 added lines, -9 removed lines

@@ -83,8 +83,8 @@ 
      */
     public static function set_definitions()
     {
-        define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
+        define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
+        define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__).'templates/');
     }
 
 
@@ -226,7 +226,7 @@ 
     {
         global $post;
         return in_the_loop() && $post->ID === (int) $id
-            ? espresso_event_status_banner($post->ID) . $title
+            ? espresso_event_status_banner($post->ID).$title
             : $title;
     }
 
@@ -383,7 +383,7 @@ 
      */
     public static function event_datetimes($content)
     {
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-datetimes.php').$content;
     }
 
 
@@ -395,7 +395,7 @@ 
      */
     public static function event_tickets($content)
     {
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-tickets.php').$content;
     }
 
 
@@ -419,7 +419,7 @@ 
      */
     public static function event_venues($content)
     {
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+        return $content.EEH_Template::locate_template('content-espresso_events-venues.php');
     }
 
 
@@ -449,16 +449,16 @@ 
             && apply_filters('FHEE__EED_Event_Single__wp_enqueue_scripts__enable_css', true)
         ) {
             // first check uploads folder
-            if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+            if (is_readable(get_stylesheet_directory().$this->theme.'/style.css')) {
                 wp_register_style(
                     $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
+                    get_stylesheet_directory_uri().$this->theme.'/style.css',
                     array('dashicons', 'espresso_default')
                 );
             } else {
                 wp_register_style(
                     $this->theme,
-                    EE_TEMPLATES_URL . $this->theme . '/style.css',
+                    EE_TEMPLATES_URL.$this->theme.'/style.css',
                     array('dashicons', 'espresso_default')
                 );
             }

Indentation +469 added lines, -469 removed lines

@@ -14,474 +14,474 @@ 
 class EED_Event_Single extends EED_Module
 {
 
-    const EVENT_DETAILS_PRIORITY = 100;
-    const EVENT_DATETIMES_PRIORITY = 110;
-    const EVENT_TICKETS_PRIORITY = 120;
-    const EVENT_VENUES_PRIORITY = 130;
-
-    /**
-     * @type bool $using_get_the_excerpt
-     */
-    protected static $using_get_the_excerpt = false;
-
-
-    /**
-     * @type EE_Template_Part_Manager $template_parts
-     */
-    protected $template_parts;
-
-
-    /**
-     * @return EED_Module|EED_Event_Single
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_hooks()
-    {
-        add_filter('FHEE_run_EE_wp', '__return_true');
-        add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2);
-        /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
-        $custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-        );
-        $custom_post_types = $custom_post_type_definitions->getDefinitions();
-        EE_Config::register_route(
-            $custom_post_types['espresso_events']['singular_slug'],
-            'Event_Single',
-            'run'
-        );
-    }
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2);
-    }
-
-
-    /**
-     * set_definitions
-     *
-     * @static
-     * @return void
-     */
-    public static function set_definitions()
-    {
-        define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
-    }
-
-
-    /**
-     * set_config
-     *
-     * @void
-     */
-    protected function set_config()
-    {
-        $this->set_config_section('template_settings');
-        $this->set_config_class('EE_Event_Single_Config');
-        $this->set_config_name('EED_Event_Single');
-    }
-
-
-    /**
-     * initialize_template_parts
-     *
-     * @param EE_Config_Base|EE_Event_Single_Config $config
-     * @return EE_Template_Part_Manager
-     */
-    public function initialize_template_parts(EE_Event_Single_Config $config = null)
-    {
-        /** @type EE_Event_Single_Config $config */
-        $config = $config instanceof EE_Event_Single_Config ? $config : $this->config();
-        EEH_Autoloader::instance()->register_template_part_autoloaders();
-        $template_parts = new EE_Template_Part_Manager();
-        $template_parts->add_template_part(
-            'tickets',
-            esc_html__('Ticket Selector', 'event_espresso'),
-            'content-espresso_events-tickets.php',
-            $config->display_order_tickets
-        );
-        $template_parts->add_template_part(
-            'datetimes',
-            esc_html__('Dates and Times', 'event_espresso'),
-            'content-espresso_events-datetimes.php',
-            $config->display_order_datetimes
-        );
-        $template_parts->add_template_part(
-            'event',
-            esc_html__('Event Description', 'event_espresso'),
-            'content-espresso_events-details.php',
-            $config->display_order_event
-        );
-        $template_parts->add_template_part(
-            'venue',
-            esc_html__('Venue Information', 'event_espresso'),
-            'content-espresso_events-venues.php',
-            $config->display_order_venue
-        );
-        do_action('AHEE__EED_Event_Single__initialize_template_parts', $template_parts);
-        return $template_parts;
-    }
-
-
-    /**
-     * run - initial module setup
-     *
-     * @param WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-        // ensure valid EE_Events_Single_Config() object exists
-        $this->set_config();
-        // check what template is loaded
-        add_filter('template_include', array($this, 'template_include'), 999, 1);
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        // load css
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
-    }
-
-
-    /**
-     * template_include
-     *
-     * @param    string $template
-     * @return    string
-     */
-    public function template_include($template)
-    {
-        global $post;
-        /** @type EE_Event_Single_Config $config */
-        $config = $this->config();
-        if ($config->display_status_banner_single) {
-            add_filter('the_title', array('EED_Event_Single', 'the_title'), 100, 2);
-        }
-        // not a custom template?
-        if (
-            ! post_password_required($post)
-            && (
-                apply_filters('FHEE__EED_Event_Single__template_include__allow_custom_selected_template', false)
-                || EE_Registry::instance()
-                              ->load_core('Front_Controller')
-                              ->get_selected_template() !== 'single-espresso_events.php'
-            )
-        ) {
-            EEH_Template::load_espresso_theme_functions();
-            // then add extra event data via hooks
-            add_action('loop_start', array('EED_Event_Single', 'loop_start'));
-            add_filter('get_the_excerpt', array('EED_Event_Single', 'get_the_excerpt'), 1, 1);
-            add_filter(
-                'the_content',
-                array('EED_Event_Single', 'event_details'),
-                EED_Event_Single::EVENT_DETAILS_PRIORITY
-            );
-            add_action('loop_end', array('EED_Event_Single', 'loop_end'));
-            // don't display entry meta because the existing theme will take car of that
-            add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
-        }
-        return $template;
-    }
-
-
-    /**
-     * loop_start
-     *
-     * @param    array $wp_query_array an array containing the WP_Query object
-     * @return    void
-     */
-    public static function loop_start($wp_query_array)
-    {
-        global $post;
-        do_action('AHEE_event_details_before_post', $post, $wp_query_array);
-    }
-
-
-    /**
-     * the_title
-     *
-     * @param    string $title
-     * @param    int    $id
-     * @return    string
-     */
-    public static function the_title($title = '', $id = 0)
-    {
-        global $post;
-        return in_the_loop() && $post->ID === (int) $id
-            ? espresso_event_status_banner($post->ID) . $title
-            : $title;
-    }
-
-
-    /**
-     * get_the_excerpt
-     * kinda hacky, but if a theme is using get_the_excerpt(),
-     * then we need to remove our filters on the_content()
-     *
-     * @param        string $excerpt
-     * @return        string
-     */
-    public static function get_the_excerpt($excerpt = '')
-    {
-        EED_Event_Single::$using_get_the_excerpt = true;
-        add_filter('wp_trim_excerpt', array('EED_Event_Single', 'end_get_the_excerpt'), 999, 1);
-        return $excerpt;
-    }
-
-
-    /**
-     * end_get_the_excerpt
-     *
-     * @param  string $text
-     * @return string
-     */
-    public static function end_get_the_excerpt($text = '')
-    {
-        EED_Event_Single::$using_get_the_excerpt = false;
-        return $text;
-    }
-
-
-    /**
-     * event_details
-     *
-     * @param    string $content
-     * @return    string
-     */
-    public static function event_details($content)
-    {
-        global $post;
-        static $current_post_ID = 0;
-        if (
-            $current_post_ID !== $post->ID
-            && $post->post_type === 'espresso_events'
-            && ! EED_Event_Single::$using_get_the_excerpt
-            && ! post_password_required()
-        ) {
-            // Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
-            // Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
-            // BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
-            // We want to allow those plugins to still do their thing and have access to our content, but depending on
-            // how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
-            // so the following allows this filter to be applied multiple times, but only once for real
-            $current_post_ID = did_action('loop_start') ? $post->ID : 0;
-            if (EE_Registry::instance()->CFG->template_settings->EED_Event_Single->use_sortable_display_order) {
-                // we need to first remove this callback from being applied to the_content()
-                // (otherwise it will recurse and blow up the interweb)
-                remove_filter(
-                    'the_content',
-                    array('EED_Event_Single', 'event_details'),
-                    EED_Event_Single::EVENT_DETAILS_PRIORITY
-                );
-                EED_Event_Single::instance()->template_parts = EED_Event_Single::instance()->initialize_template_parts(
-                );
-                $content = EEH_Template::locate_template('content-espresso_events-details.php');
-                $content = EED_Event_Single::instance()->template_parts->apply_template_part_filters($content);
-                add_filter(
-                    'the_content',
-                    array('EED_Event_Single', 'event_details'),
-                    EED_Event_Single::EVENT_DETAILS_PRIORITY
-                );
-            } else {
-                $content = EED_Event_Single::use_filterable_display_order();
-            }
-        }
-        return $content;
-    }
-
-
-    /**
-     * use_filterable_display_order
-     *
-     * @return string
-     */
-    protected static function use_filterable_display_order()
-    {
-        // since the 'content-espresso_events-details.php' template might be used directly from within a theme,
-        // it uses the_content() for displaying the $post->post_content
-        // so in order to load a template that uses the_content()
-        // from within a callback being used to filter the_content(),
-        // we need to first remove this callback from being applied to the_content()
-        // (otherwise it will recurse and blow up the interweb)
-        remove_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_details'),
-            EED_Event_Single::EVENT_DETAILS_PRIORITY
-        );
-        // now add additional content
-        add_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_datetimes'),
-            EED_Event_Single::EVENT_DATETIMES_PRIORITY,
-            1
-        );
-        add_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_tickets'),
-            EED_Event_Single::EVENT_TICKETS_PRIORITY,
-            1
-        );
-        add_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_venues'),
-            EED_Event_Single::EVENT_VENUES_PRIORITY,
-            1
-        );
-        do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_add_filters');
-        // now load our template
-        $content = EEH_Template::locate_template('content-espresso_events-details.php');
-        // now add our filter back in, plus some others
-        add_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_details'),
-            EED_Event_Single::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_datetimes'),
-            EED_Event_Single::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_tickets'),
-            EED_Event_Single::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Event_Single', 'event_venues'),
-            EED_Event_Single::EVENT_VENUES_PRIORITY
-        );
-        do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_remove_filters');
-        // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
-        return $content;
-    }
-
-
-    /**
-     * event_datetimes - adds datetimes ABOVE content
-     *
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_datetimes($content)
-    {
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
-    }
-
-
-    /**
-     * event_tickets - adds tickets ABOVE content (which includes datetimes)
-     *
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_tickets($content)
-    {
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
-    }
-
-
-    /**
-     * event_venues
-     *
-     * @param    string $content
-     * @return    string
-     */
-    public static function event_venue($content)
-    {
-        return EED_Event_Single::event_venues($content);
-    }
-
-
-    /**
-     * event_venues - adds venues BELOW content
-     *
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_venues($content)
-    {
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
-    }
-
-
-    /**
-     * loop_end
-     *
-     * @param        array $wp_query_array an array containing the WP_Query object
-     * @return        void
-     */
-    public static function loop_end($wp_query_array)
-    {
-        global $post;
-        do_action('AHEE_event_details_after_post', $post, $wp_query_array);
-    }
-
-
-    /**
-     * wp_enqueue_scripts
-     *
-     * @return    void
-     */
-    public function wp_enqueue_scripts()
-    {
-        // get some style
-        if (
-            apply_filters('FHEE_enable_default_espresso_css', true)
-            && apply_filters('FHEE__EED_Event_Single__wp_enqueue_scripts__enable_css', true)
-        ) {
-            // first check uploads folder
-            if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            } else {
-                wp_register_style(
-                    $this->theme,
-                    EE_TEMPLATES_URL . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            }
-            wp_enqueue_script($this->theme);
-            if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
-                add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
-            }
-        }
-    }
-
-
-    /**
-     * display_venue
-     *
-     * @return    bool
-     */
-    public static function display_venue()
-    {
-        /** @type EE_Event_Single_Config $config */
-        $config = EED_Event_Single::instance()->config();
-        $display_venue = $config->display_venue === null ? true : $config->display_venue;
-        $venue_name = EEH_Venue_View::venue_name();
-        return $display_venue && ! empty($venue_name);
-    }
+	const EVENT_DETAILS_PRIORITY = 100;
+	const EVENT_DATETIMES_PRIORITY = 110;
+	const EVENT_TICKETS_PRIORITY = 120;
+	const EVENT_VENUES_PRIORITY = 130;
+
+	/**
+	 * @type bool $using_get_the_excerpt
+	 */
+	protected static $using_get_the_excerpt = false;
+
+
+	/**
+	 * @type EE_Template_Part_Manager $template_parts
+	 */
+	protected $template_parts;
+
+
+	/**
+	 * @return EED_Module|EED_Event_Single
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_hooks()
+	{
+		add_filter('FHEE_run_EE_wp', '__return_true');
+		add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2);
+		/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
+		$custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+		);
+		$custom_post_types = $custom_post_type_definitions->getDefinitions();
+		EE_Config::register_route(
+			$custom_post_types['espresso_events']['singular_slug'],
+			'Event_Single',
+			'run'
+		);
+	}
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2);
+	}
+
+
+	/**
+	 * set_definitions
+	 *
+	 * @static
+	 * @return void
+	 */
+	public static function set_definitions()
+	{
+		define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
+	}
+
+
+	/**
+	 * set_config
+	 *
+	 * @void
+	 */
+	protected function set_config()
+	{
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Event_Single_Config');
+		$this->set_config_name('EED_Event_Single');
+	}
+
+
+	/**
+	 * initialize_template_parts
+	 *
+	 * @param EE_Config_Base|EE_Event_Single_Config $config
+	 * @return EE_Template_Part_Manager
+	 */
+	public function initialize_template_parts(EE_Event_Single_Config $config = null)
+	{
+		/** @type EE_Event_Single_Config $config */
+		$config = $config instanceof EE_Event_Single_Config ? $config : $this->config();
+		EEH_Autoloader::instance()->register_template_part_autoloaders();
+		$template_parts = new EE_Template_Part_Manager();
+		$template_parts->add_template_part(
+			'tickets',
+			esc_html__('Ticket Selector', 'event_espresso'),
+			'content-espresso_events-tickets.php',
+			$config->display_order_tickets
+		);
+		$template_parts->add_template_part(
+			'datetimes',
+			esc_html__('Dates and Times', 'event_espresso'),
+			'content-espresso_events-datetimes.php',
+			$config->display_order_datetimes
+		);
+		$template_parts->add_template_part(
+			'event',
+			esc_html__('Event Description', 'event_espresso'),
+			'content-espresso_events-details.php',
+			$config->display_order_event
+		);
+		$template_parts->add_template_part(
+			'venue',
+			esc_html__('Venue Information', 'event_espresso'),
+			'content-espresso_events-venues.php',
+			$config->display_order_venue
+		);
+		do_action('AHEE__EED_Event_Single__initialize_template_parts', $template_parts);
+		return $template_parts;
+	}
+
+
+	/**
+	 * run - initial module setup
+	 *
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+		// ensure valid EE_Events_Single_Config() object exists
+		$this->set_config();
+		// check what template is loaded
+		add_filter('template_include', array($this, 'template_include'), 999, 1);
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		// load css
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
+	}
+
+
+	/**
+	 * template_include
+	 *
+	 * @param    string $template
+	 * @return    string
+	 */
+	public function template_include($template)
+	{
+		global $post;
+		/** @type EE_Event_Single_Config $config */
+		$config = $this->config();
+		if ($config->display_status_banner_single) {
+			add_filter('the_title', array('EED_Event_Single', 'the_title'), 100, 2);
+		}
+		// not a custom template?
+		if (
+			! post_password_required($post)
+			&& (
+				apply_filters('FHEE__EED_Event_Single__template_include__allow_custom_selected_template', false)
+				|| EE_Registry::instance()
+							  ->load_core('Front_Controller')
+							  ->get_selected_template() !== 'single-espresso_events.php'
+			)
+		) {
+			EEH_Template::load_espresso_theme_functions();
+			// then add extra event data via hooks
+			add_action('loop_start', array('EED_Event_Single', 'loop_start'));
+			add_filter('get_the_excerpt', array('EED_Event_Single', 'get_the_excerpt'), 1, 1);
+			add_filter(
+				'the_content',
+				array('EED_Event_Single', 'event_details'),
+				EED_Event_Single::EVENT_DETAILS_PRIORITY
+			);
+			add_action('loop_end', array('EED_Event_Single', 'loop_end'));
+			// don't display entry meta because the existing theme will take car of that
+			add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
+		}
+		return $template;
+	}
+
+
+	/**
+	 * loop_start
+	 *
+	 * @param    array $wp_query_array an array containing the WP_Query object
+	 * @return    void
+	 */
+	public static function loop_start($wp_query_array)
+	{
+		global $post;
+		do_action('AHEE_event_details_before_post', $post, $wp_query_array);
+	}
+
+
+	/**
+	 * the_title
+	 *
+	 * @param    string $title
+	 * @param    int    $id
+	 * @return    string
+	 */
+	public static function the_title($title = '', $id = 0)
+	{
+		global $post;
+		return in_the_loop() && $post->ID === (int) $id
+			? espresso_event_status_banner($post->ID) . $title
+			: $title;
+	}
+
+
+	/**
+	 * get_the_excerpt
+	 * kinda hacky, but if a theme is using get_the_excerpt(),
+	 * then we need to remove our filters on the_content()
+	 *
+	 * @param        string $excerpt
+	 * @return        string
+	 */
+	public static function get_the_excerpt($excerpt = '')
+	{
+		EED_Event_Single::$using_get_the_excerpt = true;
+		add_filter('wp_trim_excerpt', array('EED_Event_Single', 'end_get_the_excerpt'), 999, 1);
+		return $excerpt;
+	}
+
+
+	/**
+	 * end_get_the_excerpt
+	 *
+	 * @param  string $text
+	 * @return string
+	 */
+	public static function end_get_the_excerpt($text = '')
+	{
+		EED_Event_Single::$using_get_the_excerpt = false;
+		return $text;
+	}
+
+
+	/**
+	 * event_details
+	 *
+	 * @param    string $content
+	 * @return    string
+	 */
+	public static function event_details($content)
+	{
+		global $post;
+		static $current_post_ID = 0;
+		if (
+			$current_post_ID !== $post->ID
+			&& $post->post_type === 'espresso_events'
+			&& ! EED_Event_Single::$using_get_the_excerpt
+			&& ! post_password_required()
+		) {
+			// Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
+			// Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
+			// BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
+			// We want to allow those plugins to still do their thing and have access to our content, but depending on
+			// how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
+			// so the following allows this filter to be applied multiple times, but only once for real
+			$current_post_ID = did_action('loop_start') ? $post->ID : 0;
+			if (EE_Registry::instance()->CFG->template_settings->EED_Event_Single->use_sortable_display_order) {
+				// we need to first remove this callback from being applied to the_content()
+				// (otherwise it will recurse and blow up the interweb)
+				remove_filter(
+					'the_content',
+					array('EED_Event_Single', 'event_details'),
+					EED_Event_Single::EVENT_DETAILS_PRIORITY
+				);
+				EED_Event_Single::instance()->template_parts = EED_Event_Single::instance()->initialize_template_parts(
+				);
+				$content = EEH_Template::locate_template('content-espresso_events-details.php');
+				$content = EED_Event_Single::instance()->template_parts->apply_template_part_filters($content);
+				add_filter(
+					'the_content',
+					array('EED_Event_Single', 'event_details'),
+					EED_Event_Single::EVENT_DETAILS_PRIORITY
+				);
+			} else {
+				$content = EED_Event_Single::use_filterable_display_order();
+			}
+		}
+		return $content;
+	}
+
+
+	/**
+	 * use_filterable_display_order
+	 *
+	 * @return string
+	 */
+	protected static function use_filterable_display_order()
+	{
+		// since the 'content-espresso_events-details.php' template might be used directly from within a theme,
+		// it uses the_content() for displaying the $post->post_content
+		// so in order to load a template that uses the_content()
+		// from within a callback being used to filter the_content(),
+		// we need to first remove this callback from being applied to the_content()
+		// (otherwise it will recurse and blow up the interweb)
+		remove_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_details'),
+			EED_Event_Single::EVENT_DETAILS_PRIORITY
+		);
+		// now add additional content
+		add_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_datetimes'),
+			EED_Event_Single::EVENT_DATETIMES_PRIORITY,
+			1
+		);
+		add_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_tickets'),
+			EED_Event_Single::EVENT_TICKETS_PRIORITY,
+			1
+		);
+		add_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_venues'),
+			EED_Event_Single::EVENT_VENUES_PRIORITY,
+			1
+		);
+		do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_add_filters');
+		// now load our template
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		// now add our filter back in, plus some others
+		add_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_details'),
+			EED_Event_Single::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_datetimes'),
+			EED_Event_Single::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_tickets'),
+			EED_Event_Single::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Event_Single', 'event_venues'),
+			EED_Event_Single::EVENT_VENUES_PRIORITY
+		);
+		do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_remove_filters');
+		// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
+		return $content;
+	}
+
+
+	/**
+	 * event_datetimes - adds datetimes ABOVE content
+	 *
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_datetimes($content)
+	{
+		return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+	}
+
+
+	/**
+	 * event_tickets - adds tickets ABOVE content (which includes datetimes)
+	 *
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_tickets($content)
+	{
+		return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+	}
+
+
+	/**
+	 * event_venues
+	 *
+	 * @param    string $content
+	 * @return    string
+	 */
+	public static function event_venue($content)
+	{
+		return EED_Event_Single::event_venues($content);
+	}
+
+
+	/**
+	 * event_venues - adds venues BELOW content
+	 *
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_venues($content)
+	{
+		return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+	}
+
+
+	/**
+	 * loop_end
+	 *
+	 * @param        array $wp_query_array an array containing the WP_Query object
+	 * @return        void
+	 */
+	public static function loop_end($wp_query_array)
+	{
+		global $post;
+		do_action('AHEE_event_details_after_post', $post, $wp_query_array);
+	}
+
+
+	/**
+	 * wp_enqueue_scripts
+	 *
+	 * @return    void
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// get some style
+		if (
+			apply_filters('FHEE_enable_default_espresso_css', true)
+			&& apply_filters('FHEE__EED_Event_Single__wp_enqueue_scripts__enable_css', true)
+		) {
+			// first check uploads folder
+			if (is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					get_stylesheet_directory_uri() . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			} else {
+				wp_register_style(
+					$this->theme,
+					EE_TEMPLATES_URL . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			}
+			wp_enqueue_script($this->theme);
+			if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
+				add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
+			}
+		}
+	}
+
+
+	/**
+	 * display_venue
+	 *
+	 * @return    bool
+	 */
+	public static function display_venue()
+	{
+		/** @type EE_Event_Single_Config $config */
+		$config = EED_Event_Single::instance()->config();
+		$display_venue = $config->display_venue === null ? true : $config->display_venue;
+		$venue_name = EEH_Venue_View::venue_name();
+		return $display_venue && ! empty($venue_name);
+	}
 }
 
 
@@ -493,5 +493,5 @@ 
  */
 function espresso_display_venue_in_event_details()
 {
-    return EED_Event_Single::display_venue();
+	return EED_Event_Single::display_venue();
 }

core/libraries/line_item_display/EE_Line_Item_Display.class.php

Indentation +52 added lines, -52 removed lines

@@ -15,63 +15,63 @@
 class EE_Line_Item_Display
 {
 
-    private $strategy = null;
+	private $strategy = null;
 
 
-    /**
-     * @param string $context - where/how the line items are being displayed
-     * @param string $other_line_item_display_strategy
-     */
-    public function __construct($context = '', $other_line_item_display_strategy = '')
-    {
-        $context = strtolower($context);
-        switch ($context) {
-            case 'invoice':
-                $this->strategy = new EE_Invoice_Line_Item_Display_Strategy();
-                break;
-            case 'receipt':
-                $this->strategy = new EE_Receipt_Line_Item_Display_Strategy();
-                break;
-            case 'spco':
-                $this->strategy = new EE_SPCO_Line_Item_Display_Strategy();
-                break;
-            default:
-                if (
-                    ! empty($other_line_item_display_strategy) &&
-                    class_exists($other_line_item_display_strategy)
-                ) {
-                    $this->strategy = new  $other_line_item_display_strategy();
-                } else {
-                    $this->strategy = new EE_Default_Line_Item_Display_Strategy();
-                }
-        }
-    }
+	/**
+	 * @param string $context - where/how the line items are being displayed
+	 * @param string $other_line_item_display_strategy
+	 */
+	public function __construct($context = '', $other_line_item_display_strategy = '')
+	{
+		$context = strtolower($context);
+		switch ($context) {
+			case 'invoice':
+				$this->strategy = new EE_Invoice_Line_Item_Display_Strategy();
+				break;
+			case 'receipt':
+				$this->strategy = new EE_Receipt_Line_Item_Display_Strategy();
+				break;
+			case 'spco':
+				$this->strategy = new EE_SPCO_Line_Item_Display_Strategy();
+				break;
+			default:
+				if (
+					! empty($other_line_item_display_strategy) &&
+					class_exists($other_line_item_display_strategy)
+				) {
+					$this->strategy = new  $other_line_item_display_strategy();
+				} else {
+					$this->strategy = new EE_Default_Line_Item_Display_Strategy();
+				}
+		}
+	}
 
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = array())
-    {
-        return $this->strategy->display_line_item($line_item, $options);
-    }
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	public function display_line_item(EE_Line_Item $line_item, $options = array())
+	{
+		return $this->strategy->display_line_item($line_item, $options);
+	}
 
 
-    /**
-     * @return float
-     */
-    public function grand_total()
-    {
-        return $this->strategy->grand_total();
-    }
+	/**
+	 * @return float
+	 */
+	public function grand_total()
+	{
+		return $this->strategy->grand_total();
+	}
 
 
-    /**
-     * @return float
-     */
-    public function total_items()
-    {
-        return $this->strategy->total_items();
-    }
+	/**
+	 * @return float
+	 */
+	public function total_items()
+	{
+		return $this->strategy->total_items();
+	}
 }

core/libraries/line_item_display/EE_SPCO_Line_Item_Display_Strategy.strategy.php

Indentation +659 added lines, -659 removed lines

@@ -12,663 +12,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;
+	}
 }

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()
                             );

core/libraries/rest_api/Capabilities.php

Spacing +11 added lines, -11 removed lines

@@ -99,7 +99,7 @@ 
     ) {
         $has_password = $model->hasPassword();
         if ($has_password) {
-            $entity[ $model->getPasswordField()->get_name() ] = ModelDataTranslator::prepareFieldValueForJson(
+            $entity[$model->getPasswordField()->get_name()] = ModelDataTranslator::prepareFieldValueForJson(
                 $model->getPasswordField(),
                 $model->getPasswordField()->get_default_value(),
                 $model_version_info->requestedVersion()
@@ -109,7 +109,7 @@ 
             if (
                 $has_password
                 && $model->getPasswordField()->fieldIsProtected($field_name)
-                && $entity[ $field_name ]
+                && $entity[$field_name]
             ) {
                 $replacement_value = ModelDataTranslator::prepareFieldValueForJson(
                     $field_obj,
@@ -117,10 +117,10 @@ 
                     $model_version_info->requestedVersion()
                 );
                 if ($model_version_info->fieldHasRenderedFormat($field_obj)) {
-                    $entity[ $field_name ]['rendered'] = $replacement_value;
+                    $entity[$field_name]['rendered'] = $replacement_value;
                 } elseif ($model_version_info->fieldHasPrettyFormat($field_obj)) {
-                    $entity[ $field_name ]['raw'] = $replacement_value;
-                    $entity[ $field_name ]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
+                    $entity[$field_name]['raw'] = $replacement_value;
+                    $entity[$field_name]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
                         $field_obj,
                         $field_obj->prepare_for_pretty_echoing($field_obj->get_default_value()),
                         $model_version_info->requestedVersion()
@@ -131,7 +131,7 @@ 
                     // so just remove it (or rather, set its default)
                     // API clients will just need to look to fields with rendered formats to know if these have
                     // been redacted. Sorry.
-                    $entity[ $field_name ] = $replacement_value;
+                    $entity[$field_name] = $replacement_value;
                 }
             }
         }
@@ -160,11 +160,11 @@ 
         foreach ($model->field_settings() as $field_name => $field_obj) {
             if (
                 $model_version_info->fieldHasRenderedFormat($field_obj)
-                && isset($entity[ $field_name ])
-                && is_array($entity[ $field_name ])
-                && isset($entity[ $field_name ]['raw'])
+                && isset($entity[$field_name])
+                && is_array($entity[$field_name])
+                && isset($entity[$field_name]['raw'])
             ) {
-                unset($entity[ $field_name ]['raw']);
+                unset($entity[$field_name]['raw']);
             }
         }
         // theoretically we may want to filter out specific fields for specific models
@@ -190,7 +190,7 @@ 
      */
     public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
     {
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
             $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),

Indentation +177 added lines, -177 removed lines

@@ -18,190 +18,190 @@
 class Capabilities
 {
 
-    /**
-     * The current user can see at least SOME of these entities.
-     *
-     * @param EEM_Base $model
-     * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
-     * @return boolean
-     */
-    public static function currentUserHasPartialAccessTo($model, $model_context = EEM_Base::caps_read)
-    {
-        if (
-            apply_filters(
-                'FHEE__Capabilities__current_user_has_partial_access_to__override_begin',
-                false,
-                $model,
-                $model
-            )
-        ) {
-            return true;
-        }
-        foreach ($model->caps_missing($model_context) as $capability_name => $restriction_obj) {
-            if ($restriction_obj instanceof \EE_Return_None_Where_Conditions) {
-                return false;
-            }
-        }
-        if (
-            apply_filters(
-                'FHEE__Capabilities__current_user_has_partial_access_to__override_end',
-                false,
-                $model,
-                $model
-            )
-        ) {
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * The current user can see at least SOME of these entities.
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
+	 * @return boolean
+	 */
+	public static function currentUserHasPartialAccessTo($model, $model_context = EEM_Base::caps_read)
+	{
+		if (
+			apply_filters(
+				'FHEE__Capabilities__current_user_has_partial_access_to__override_begin',
+				false,
+				$model,
+				$model
+			)
+		) {
+			return true;
+		}
+		foreach ($model->caps_missing($model_context) as $capability_name => $restriction_obj) {
+			if ($restriction_obj instanceof \EE_Return_None_Where_Conditions) {
+				return false;
+			}
+		}
+		if (
+			apply_filters(
+				'FHEE__Capabilities__current_user_has_partial_access_to__override_end',
+				false,
+				$model,
+				$model
+			)
+		) {
+			return false;
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets an array of all the capabilities the current user is missing that affected
-     * the query
-     *
-     * @param EEM_Base $model
-     * @param string   $request_type one of the constants on WP_JSON_Server
-     * @return array
-     */
-    public static function getMissingPermissions($model, $request_type = EEM_Base::caps_read)
-    {
-        return $model->caps_missing($request_type);
-    }
+	/**
+	 * Gets an array of all the capabilities the current user is missing that affected
+	 * the query
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $request_type one of the constants on WP_JSON_Server
+	 * @return array
+	 */
+	public static function getMissingPermissions($model, $request_type = EEM_Base::caps_read)
+	{
+		return $model->caps_missing($request_type);
+	}
 
 
-    /**
-     * Gets a string of all the capabilities the current user is missing that affected
-     * the query
-     *
-     * @param EEM_Base $model
-     * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
-     * @return string
-     */
-    public static function getMissingPermissionsString($model, $model_context = EEM_Base::caps_read)
-    {
-        return implode(',', array_keys(self::getMissingPermissions($model, $model_context)));
-    }
+	/**
+	 * Gets a string of all the capabilities the current user is missing that affected
+	 * the query
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
+	 * @return string
+	 */
+	public static function getMissingPermissionsString($model, $model_context = EEM_Base::caps_read)
+	{
+		return implode(',', array_keys(self::getMissingPermissions($model, $model_context)));
+	}
 
-    /**
-     * "Removes" password-protected fields. Currently that means setting their values to their default.
-     * @since 4.9.74.p
-     * @param array $entity
-     * @param EEM_Base $model
-     * @param ModelVersionInfo $model_version_info
-     * @return array
-     * @throws EE_Error
-     */
-    public static function filterOutPasswordProtectedFields(
-        $entity,
-        EEM_Base $model,
-        ModelVersionInfo $model_version_info
-    ) {
-        $has_password = $model->hasPassword();
-        if ($has_password) {
-            $entity[ $model->getPasswordField()->get_name() ] = ModelDataTranslator::prepareFieldValueForJson(
-                $model->getPasswordField(),
-                $model->getPasswordField()->get_default_value(),
-                $model_version_info->requestedVersion()
-            );
-        }
-        foreach ($model->field_settings() as $field_name => $field_obj) {
-            if (
-                $has_password
-                && $model->getPasswordField()->fieldIsProtected($field_name)
-                && $entity[ $field_name ]
-            ) {
-                $replacement_value = ModelDataTranslator::prepareFieldValueForJson(
-                    $field_obj,
-                    $field_obj->get_default_value(),
-                    $model_version_info->requestedVersion()
-                );
-                if ($model_version_info->fieldHasRenderedFormat($field_obj)) {
-                    $entity[ $field_name ]['rendered'] = $replacement_value;
-                } elseif ($model_version_info->fieldHasPrettyFormat($field_obj)) {
-                    $entity[ $field_name ]['raw'] = $replacement_value;
-                    $entity[ $field_name ]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
-                        $field_obj,
-                        $field_obj->prepare_for_pretty_echoing($field_obj->get_default_value()),
-                        $model_version_info->requestedVersion()
-                    );
-                } else {
-                    // this is most likely an excerpt field. (These should have also had "rendered" and "raw"
-                    // versions, but we missed that, and can't change it without breaking backward compatibility)
-                    // so just remove it (or rather, set its default)
-                    // API clients will just need to look to fields with rendered formats to know if these have
-                    // been redacted. Sorry.
-                    $entity[ $field_name ] = $replacement_value;
-                }
-            }
-        }
-        return $entity;
-    }
+	/**
+	 * "Removes" password-protected fields. Currently that means setting their values to their default.
+	 * @since 4.9.74.p
+	 * @param array $entity
+	 * @param EEM_Base $model
+	 * @param ModelVersionInfo $model_version_info
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function filterOutPasswordProtectedFields(
+		$entity,
+		EEM_Base $model,
+		ModelVersionInfo $model_version_info
+	) {
+		$has_password = $model->hasPassword();
+		if ($has_password) {
+			$entity[ $model->getPasswordField()->get_name() ] = ModelDataTranslator::prepareFieldValueForJson(
+				$model->getPasswordField(),
+				$model->getPasswordField()->get_default_value(),
+				$model_version_info->requestedVersion()
+			);
+		}
+		foreach ($model->field_settings() as $field_name => $field_obj) {
+			if (
+				$has_password
+				&& $model->getPasswordField()->fieldIsProtected($field_name)
+				&& $entity[ $field_name ]
+			) {
+				$replacement_value = ModelDataTranslator::prepareFieldValueForJson(
+					$field_obj,
+					$field_obj->get_default_value(),
+					$model_version_info->requestedVersion()
+				);
+				if ($model_version_info->fieldHasRenderedFormat($field_obj)) {
+					$entity[ $field_name ]['rendered'] = $replacement_value;
+				} elseif ($model_version_info->fieldHasPrettyFormat($field_obj)) {
+					$entity[ $field_name ]['raw'] = $replacement_value;
+					$entity[ $field_name ]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
+						$field_obj,
+						$field_obj->prepare_for_pretty_echoing($field_obj->get_default_value()),
+						$model_version_info->requestedVersion()
+					);
+				} else {
+					// this is most likely an excerpt field. (These should have also had "rendered" and "raw"
+					// versions, but we missed that, and can't change it without breaking backward compatibility)
+					// so just remove it (or rather, set its default)
+					// API clients will just need to look to fields with rendered formats to know if these have
+					// been redacted. Sorry.
+					$entity[ $field_name ] = $replacement_value;
+				}
+			}
+		}
+		return $entity;
+	}
 
 
-    /**
-     * Takes a entity that's ready to be returned and removes fields which the user shouldn't be able to access.
-     *
-     * @param array $entity
-     * @param EEM_Base $model
-     * @param string $request_type one of the return values from EEM_Base::valid_cap_contexts()
-     * @param ModelVersionInfo $model_version_info
-     * @param string $primary_key_string result of EEM_Base::get_index_primary_key_string(), so that we can
-     *                                               use this with models that have no primary key
-     * @return array ready for converting into json
-     */
-    public static function filterOutInaccessibleEntityFields(
-        $entity,
-        $model,
-        $request_type,
-        $model_version_info,
-        $primary_key_string = null
-    ) {
-        foreach ($model->field_settings() as $field_name => $field_obj) {
-            if (
-                $model_version_info->fieldHasRenderedFormat($field_obj)
-                && isset($entity[ $field_name ])
-                && is_array($entity[ $field_name ])
-                && isset($entity[ $field_name ]['raw'])
-            ) {
-                unset($entity[ $field_name ]['raw']);
-            }
-        }
-        // theoretically we may want to filter out specific fields for specific models
-        return apply_filters(
-            'FHEE__Capabilities__filter_out_inaccessible_entity_fields',
-            $entity,
-            $model,
-            $request_type
-        );
-    }
+	/**
+	 * Takes a entity that's ready to be returned and removes fields which the user shouldn't be able to access.
+	 *
+	 * @param array $entity
+	 * @param EEM_Base $model
+	 * @param string $request_type one of the return values from EEM_Base::valid_cap_contexts()
+	 * @param ModelVersionInfo $model_version_info
+	 * @param string $primary_key_string result of EEM_Base::get_index_primary_key_string(), so that we can
+	 *                                               use this with models that have no primary key
+	 * @return array ready for converting into json
+	 */
+	public static function filterOutInaccessibleEntityFields(
+		$entity,
+		$model,
+		$request_type,
+		$model_version_info,
+		$primary_key_string = null
+	) {
+		foreach ($model->field_settings() as $field_name => $field_obj) {
+			if (
+				$model_version_info->fieldHasRenderedFormat($field_obj)
+				&& isset($entity[ $field_name ])
+				&& is_array($entity[ $field_name ])
+				&& isset($entity[ $field_name ]['raw'])
+			) {
+				unset($entity[ $field_name ]['raw']);
+			}
+		}
+		// theoretically we may want to filter out specific fields for specific models
+		return apply_filters(
+			'FHEE__Capabilities__filter_out_inaccessible_entity_fields',
+			$entity,
+			$model,
+			$request_type
+		);
+	}
 
 
-    /**
-     * Verifies the current user has at least partial access to do this action on this model.
-     * If not, throws an exception (so we can define the code that sets up this error object
-     * once)
-     *
-     * @param EEM_Base $model
-     * @param string   $model_action_context
-     * @param string   $action_name
-     * @return void
-     * @throws RestException
-     */
-    public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
-    {
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
-            $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),
-                sprintf(
-                    esc_html__('Sorry, you are not allowed to %1$s %2$s. Missing permissions: %3$s', 'event_espresso'),
-                    $action_name,
-                    $model_name_plural,
-                    Capabilities::getMissingPermissionsString($model, $model_action_context)
-                ),
-                array('status' => 403)
-            );
-        }
-    }
+	/**
+	 * Verifies the current user has at least partial access to do this action on this model.
+	 * If not, throws an exception (so we can define the code that sets up this error object
+	 * once)
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_action_context
+	 * @param string   $action_name
+	 * @return void
+	 * @throws RestException
+	 */
+	public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
+	{
+		if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
+			$model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),
+				sprintf(
+					esc_html__('Sorry, you are not allowed to %1$s %2$s. Missing permissions: %3$s', 'event_espresso'),
+					$action_name,
+					$model_name_plural,
+					Capabilities::getMissingPermissionsString($model, $model_action_context)
+				),
+				array('status' => 403)
+			);
+		}
+	}
 }

core/libraries/rest_api/RestIncomingQueryParamMetadata.php

Indentation +701 added lines, -701 removed lines

@@ -28,707 +28,707 @@
  */
 class RestIncomingQueryParamMetadata
 {
-    private $query_param_key;
-    private $query_param_value;
-    /**
-     * @var RestIncomingQueryParamContext
-     */
-    private $context;
-
-    /**
-     * @var EE_Model_Field_Base|null
-     */
-    private $field;
-
-    /**
-     * @var string same as $query_param_key but has the * and anything after it removed
-     */
-    private $query_param_key_sans_stars;
-
-    /**
-     * @var string for timezone or timezone offset
-     */
-    private $timezone;
-
-    /**
-     * @var boolean if the field in $query_param_key is for a GMT field (eg `EVT_modified_gmt`)
-     */
-    private $is_gmt_field = false;
-
-    /**
-     * RestIncomingQueryParamMetadata constructor.
-     * You probably want to call
-     * @param string $query_param_key
-     * @param string $query_param_value
-     * @param RestIncomingQueryParamContext $context
-     */
-    public function __construct($query_param_key, $query_param_value, RestIncomingQueryParamContext $context)
-    {
-        $this->query_param_key = $query_param_key;
-        $this->query_param_value = $query_param_value;
-        $this->context = $context;
-        $this->determineFieldAndTimezone();
-    }
-
-    /**
-     * Gets the query parameter key. This may have been modified (see setQueryParamValue())
-     * @return string
-     */
-    public function getQueryParamKey()
-    {
-        return $this->query_param_key;
-    }
-
-    /**
-     * Modifies the query parameter key passed in (Eg this is done when rewriting the simplified specified operator REST
-     * query parameters into the legacy structure)
-     * @param string|array|int|float $query_param_value
-     */
-    private function setQueryParamValue($query_param_value)
-    {
-        $this->query_param_value = $query_param_value;
-    }
-
-    /**
-     * Gets the original query parameter value passed in.
-     * @return string
-     */
-    public function getQueryParamValue()
-    {
-        return $this->query_param_value;
-    }
-
-    /**
-     * Gets the context object.
-     * @return RestIncomingQueryParamContext
-     */
-    public function getContext()
-    {
-        return $this->context;
-    }
-
-    /**
-     * Sets the query parameter key. This may be used to rewrite a key into its non-GMT alternative.
-     * @param string $query_param_key
-     */
-    private function setQueryParamKey($query_param_key)
-    {
-        $this->query_param_key = $query_param_key;
-    }
-
-    /**
-     * Gets the field the query parameter key indicated. This may be null (in cases where the query parameter key
-     * did not indicate a field, eg if it were `OR`).
-     * @return EE_Model_Field_Base|null
-     */
-    public function getField()
-    {
-        return $this->field;
-    }
-
-    /**
-     * Gets the query parameter key (with the star and everything afterwards removed).
-     * @return string
-     */
-    public function getQueryParamKeySansStars()
-    {
-        return $this->query_param_key_sans_stars;
-    }
-
-    /**
-     * Gets the timezone associated with this model (the site timezone, except for GMT datetime fields).
-     * @return string
-     */
-    public function getTimezone()
-    {
-        return $this->timezone;
-    }
-
-    /**
-     * Returns whether or not this is a GMT field
-     * @return boolean
-     */
-    public function isGmtField()
-    {
-        return $this->is_gmt_field;
-    }
-
-    /**
-     * Sets the field indicated by the query parameter key (might be null).
-     * @param EE_Model_Field_Base|null $field
-     */
-    private function setField(EE_Model_Field_Base $field = null)
-    {
-        $this->field = $field;
-    }
-
-    /**
-     * Sets the query parameter key-with-stars-removed.
-     * @param string $query_param_key_sans_stars
-     */
-    private function setQueryParamKeySansStars($query_param_key_sans_stars)
-    {
-        $this->query_param_key_sans_stars = $query_param_key_sans_stars;
-    }
-
-    /**
-     * Sets the timezone (this could be a timezeon offset string).
-     * @param string $timezone
-     */
-    private function setTimezone($timezone)
-    {
-        $this->timezone = $timezone;
-    }
-
-    /**
-     * @param mixed $is_gmt_field
-     */
-    private function setIsGmtField($is_gmt_field)
-    {
-        $this->is_gmt_field = $is_gmt_field;
-    }
-
-    /**
-     * Determines what field, query param name, and query param name without stars, and timezone to use.
-     * @since 4.9.72.p
-     * @type EE_Model_Field_Base $field
-     * @return void {
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function determineFieldAndTimezone()
-    {
-        $this->setQueryParamKeySansStars(ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
-            $this->getQueryParamKey()
-        ));
-        $this->setField(ModelDataTranslator::deduceFieldFromQueryParam(
-            $this->getQueryParamKeySansStars(),
-            $this->getContext()->getModel()
-        ));
-        // double-check is it a *_gmt field?
-        if (
-            !$this->getField() instanceof EE_Model_Field_Base
-            && ModelDataTranslator::isGmtDateFieldName($this->getQueryParamKeySansStars())
-        ) {
-            // yep, take off '_gmt', and find the field
-            $this->setQueryParamKey(ModelDataTranslator::removeGmtFromFieldName($this->getQueryParamKeySansStars()));
-            $this->setField(ModelDataTranslator::deduceFieldFromQueryParam(
-                $this->getQueryParamKey(),
-                $this->context->getModel()
-            ));
-            $this->setTimezone('UTC');
-            $this->setIsGmtField(true);
-        } elseif ($this->getField() instanceof EE_Datetime_Field) {
-            // so it's not a GMT field. Set the timezone on the model to the default
-            $this->setTimezone(EEH_DTT_Helper::get_valid_timezone_string());
-        } else {
-            // just keep using what's already set for the timezone
-            $this->setTimezone($this->context->getModel()->get_timezone());
-        }
-        $this->assertOnlyAdminCanReadPasswordFields();
-    }
-
-    /**
-     * Throws an exception if a non-admin is trying to query by password.
-     * @since 4.9.74.p
-     * @throws RestException
-     */
-    private function assertOnlyAdminCanReadPasswordFields()
-    {
-        if (
-            $this->getField() instanceof EE_Password_Field
-            && ! current_user_can(EE_Restriction_Generator_Base::get_default_restrictions_cap())
-        ) {
-            // only full admins can query by password. sorry bub!
-            throw new RestException(
-                'only_admins_can_query_by_password',
-                // @codingStandardsIgnoreStart
-                esc_html__('You attempted to filter by a password field without the needed privileges. Only a full admin is allowed to do that.', 'event_espresso'),
-                // @codingStandardsIgnoreEnd
-                array(
-                    'status' => 403
-                )
-            );
-        }
-    }
-
-    /**
-     * Given a ton of input, determines the value to use for the models.
-     * @since 4.9.72.p
-     * @return array|null
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws RestException
-     * @throws DomainException
-     */
-    public function determineConditionsQueryParameterValue()
-    {
-        if ($this->valueIsArrayDuringRead()) {
-            return $this->determineModelValueGivenRestInputArray();
-        }
-        return ModelDataTranslator::prepareFieldValueFromJson(
-            $this->getField(),
-            $this->getQueryParamValue(),
-            $this->getContext()->getRequestedVersion(),
-            $this->getTimezone()
-        );
-    }
-
-    /**
-     * Given that the array value provided was itself an array, handles finding the correct value to pass to the model.
-     * @since 4.9.72.p
-     * @return array|null
-     * @throws RestException
-     */
-    private function determineModelValueGivenRestInputArray()
-    {
-        $this->transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax();
-        // did they specify an operator?
-        if ($this->valueIsLegacySpecifiedOperator()) {
-            $query_param_value = $this->getQueryParamValue();
-            $sub_array_key = $query_param_value[0];
-            $translated_value = array($sub_array_key);
-            if ($this->operatorIsNAry($sub_array_key)) {
-                $translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
-            } elseif ($this->operatorIsTernary($sub_array_key)) {
-                $translated_value[] = array(
-                    $this->prepareValuesFromJson($query_param_value[1][0]),
-                    $this->prepareValuesFromJson($query_param_value[1][1])
-                );
-            } elseif ($this->operatorIsLike($sub_array_key)) {
-                // we want to leave this value mostly-as-is (eg don't force it to be a float
-                // or a boolean or an enum value. Leave it as-is with wildcards etc)
-                // but do verify it at least doesn't have any serialized data
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
-                $translated_value[] = $query_param_value[1];
-            } elseif ($this->operatorIsUnary($sub_array_key)) {
-                // no arguments should have been provided, so don't look for any
-            } elseif ($this->operatorisBinary($sub_array_key)) {
-                // it's a valid operator, but none of the exceptions. Treat it normally.
-                $translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
-            } else {
-                // so they provided a valid operator, but wrong number of arguments
-                $this->throwWrongNumberOfArgsExceptionIfDebugging($sub_array_key);
-                $translated_value = null;
-            }
-        } else {
-            // so they didn't provide a valid operator
-            // if we aren't in debug mode, then just try our best to fulfill the user's request
-            $this->throwInvalidOperatorExceptionIfDebugging();
-            $translated_value = null;
-        }
-        return $translated_value;
-    }
-
-    /**
-     * Returns if this request is a "read" request and the value provided was an array.
-     * This will indicate is such things as `array('<', 123)` and `array('IN', array(1,2,3))` are acceptable or not.
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function valueIsArrayDuringRead()
-    {
-        return !$this->getContext()->isWriting() && is_array($this->getQueryParamValue());
-    }
-
-    /**
-     * Returns if the value provided was an associative array (we should have already verified it's an array of some
-     * sort). If the value is an associative array, it had better be in the simplified specified operator structure.
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function valueIsAssociativeArray()
-    {
-        return !EEH_Array::is_array_numerically_and_sequentially_indexed($this->getQueryParamValue());
-    }
-
-    /**
-     * Checks if the array value is itself an array that fits into the simplified specified operator structure
-     * (eg `array('!=' => 123)`).
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function valueIsSimplifiedSpecifiedOperator()
-    {
-        return count($this->getQueryParamValue()) === 1
-            && array_key_exists(
-                key($this->getQueryParamValue()),
-                $this->getContext()->getModel()->valid_operators()
-            );
-    }
-
-    /**
-     * Throws an exception if the sub-value is an array (eg `array('!=' => array())`). It needs to just be a string,
-     * of either comma-separated-values, or a JSON array.
-     * @since 4.9.72.p
-     * @param $sub_array_key
-     * @param $sub_array_value
-     * @throws RestException
-     */
-    private function assertSubValueIsntArray($sub_array_key, $sub_array_value)
-    {
-        if (is_array($sub_array_value) && EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'csv_or_json_string_only',
-                sprintf(
-                    /* translators: 1: variable name*/
-                    esc_html__(
-                        'The value provided for the operator "%1$s" should be comma-separated value string or a JSON array.',
-                        'event_espresso'
-                    ),
-                    $sub_array_key
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-    }
-
-    /**
-     * Determines if the sub-array key is an operator taking 3 or more operators.
-     * @since 4.9.72.p
-     * @param $sub_array_key
-     * @return boolean
-     */
-    private function subArrayKeyIsNonBinaryOperator($sub_array_key)
-    {
-        return array_key_exists(
-            $sub_array_key,
-            array_merge(
-                $this->getContext()->getModel()->valid_in_style_operators(),
-                $this->getContext()->getModel()->valid_between_style_operators()
-            )
-        );
-    }
-
-    /**
-     * Given that the $sub_array_key is a string, checks if it's an operator taking only 1 argument.
-     * @since 4.9.72.p
-     * @param string $sub_array_key
-     * @return boolean
-     */
-    private function subArrayKeyIsUnaryOperator($sub_array_key)
-    {
-        return array_key_exists(
-            $sub_array_key,
-            $this->getContext()->getModel()->valid_null_style_operators()
-        );
-    }
-
-    /**
-     * Parses the $sub_array_value string into an array (given it could either be a comma-separated-list or a JSON
-     * array). eg `"1,2,3"` or `"[1,2,3]"` into `array(1,2,3)`.
-     * @since 4.9.72.p
-     * @param $sub_array_value
-     * @return array|mixed|object
-     */
-    private function extractQuickStyleSpecifiedOperatorValue($sub_array_value)
-    {
-        // the value should be JSON or CSV
-        $values = json_decode($sub_array_value);
-        if (!is_array($values)) {
-            $values = array_filter(
-                array_map(
-                    'trim',
-                    explode(
-                        ',',
-                        $sub_array_value
-                    )
-                )
-            );
-        }
-        return $values;
-    }
-
-    /**
-     * Throws an exception if the value isn't a simplified specified operator (only called when we expect that).
-     * @since 4.9.72.p
-     * @throws RestException
-     */
-    private function assertSimplifiedSpecifiedOperator()
-    {
-        if (!$this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'numerically_indexed_array_of_values_only',
-                sprintf(
-                    /* translators: 1: variable name*/
-                    esc_html__(
-                        'The array provided for the parameter "%1$s" should be numerically indexed.',
-                        'event_espresso'
-                    ),
-                    $this->getQueryParamKey()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-    }
-
-    /**
-     * If query_param_value were in the simplified specific operator structure, change it into the legacy structure.
-     * @since 4.9.72.p
-     * @throws RestException
-     */
-    private function transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax()
-    {
-        if ($this->valueIsAssociativeArray()) {
-            $this->assertSimplifiedSpecifiedOperator();
-            $query_param_value = $this->getQueryParamValue();
-            $sub_array_value = reset($query_param_value);
-            $sub_array_key = key($query_param_value);
-            $this->assertSubValueIsntArray($sub_array_key, $sub_array_value);
-            // they're doing something like "&where[EVT_ID][IN]=1,2,3" or "&where[EVT_ID][>]=5"
-            if ($this->subArrayKeyIsNonBinaryOperator($sub_array_key)) {
-                $this->setQueryParamValue(array(
-                    $sub_array_key,
-                    $this->extractQuickStyleSpecifiedOperatorValue($sub_array_value)
-                ));
-            } elseif ($this->subArrayKeyIsUnaryOperator($sub_array_key)) {
-                $this->setQueryParamValue(array($sub_array_key));
-            } else {
-                $this->setQueryParamValue(array($sub_array_key, $sub_array_value));
-            }
-        }
-    }
-
-    /**
-     * Returns true is the value is an array using the legacy structure to specify the operator. Eg `array('!=',123)`.
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function valueIsLegacySpecifiedOperator()
-    {
-        $valid_operators = $this->getContext()->getModel()->valid_operators();
-        $query_param_value = $this->getQueryParamValue();
-        return isset($query_param_value[0])
-            && isset($valid_operators[ $query_param_value[0] ]);
-    }
-
-    /**
-     * Returns true if the value specified operator accepts arbitrary number of arguments, like "IN".
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorIsNAry($operator)
-    {
-        $valueArray = $this->getQueryParamValue();
-        return array_key_exists(
-            $operator,
-            $this->getContext()->getModel()->valid_in_style_operators()
-        )
-            && isset($valueArray[1])
-            && is_array($valueArray[1])
-            && !isset($valueArray[2]);
-    }
-
-    /**
-     * Returns true if the operator accepts 3 arguments (eg "BETWEEN").
-     * So we're looking for a value that looks like
-     * `array('BETWEEN', array('2015-01-01T00:00:00', '2016-01-01T00:00:00'))`.
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorIsTernary($operator)
-    {
-        $query_param_value = $this->getQueryParamValue();
-        return array_key_exists($operator, $this->getContext()->getModel()->valid_between_style_operators())
-            && isset($query_param_value[1])
-            && is_array($query_param_value[1])
-            && isset($query_param_value[1][0], $query_param_value[1][1])
-            && !isset($query_param_value[1][2])
-            && !isset($query_param_value[2]);
-    }
-
-    /**
-     * Returns true if the operator is a similar to LIKE, indicating the value may have wildcards we should leave alone.
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorIsLike($operator)
-    {
-        $query_param_value = $this->getQueryParamValue();
-        return array_key_exists($operator, $this->getContext()->getModel()->valid_like_style_operators())
-            && isset($query_param_value[1])
-            && !isset($query_param_value[2]);
-    }
-
-    /**
-     * Returns true if the operator only takes one argument (eg it's like `IS NULL`).
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorIsUnary($operator)
-    {
-        $query_param_value = $this->getQueryParamValue();
-        return array_key_exists($operator, $this->getContext()->getModel()->valid_null_style_operators())
-            && !isset($query_param_value[1]);
-    }
-
-    /**
-     * Returns true if the operator specified is a binary opeator (eg `=`, `!=`)
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorisBinary($operator)
-    {
-        $query_param_value = $this->getQueryParamValue();
-        $model = $this->getContext()->getModel();
-        return isset($query_param_value[1])
-            && !isset($query_param_value[2])
-            && !array_key_exists(
-                $operator,
-                array_merge(
-                    $model->valid_in_style_operators(),
-                    $model->valid_null_style_operators(),
-                    $model->valid_like_style_operators(),
-                    $model->valid_between_style_operators()
-                )
-            );
-    }
-
-    /**
-     * If we're debugging, throws an exception saying that the wrong number of arguments was provided.
-     * @since 4.9.72.p
-     * @param $operator
-     * @throws RestException
-     */
-    private function throwWrongNumberOfArgsExceptionIfDebugging($operator)
-    {
-        if (EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'wrong_number_of_arguments',
-                sprintf(
-                    esc_html__(
-                        'The operator you provided, "%1$s" had the wrong number of arguments',
-                        'event_espresso'
-                    ),
-                    $operator
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-    }
-
-    /**
-     * Wrapper for ModelDataTranslator::prepareFieldValuesFromJson(), just a tad more DRY.
-     * @since 4.9.72.p
-     * @param $value
-     * @return mixed
-     * @throws RestException
-     */
-    private function prepareValuesFromJson($value)
-    {
-        return ModelDataTranslator::prepareFieldValuesFromJson(
-            $this->getField(),
-            $value,
-            $this->getContext()->getRequestedVersion(),
-            $this->getTimezone()
-        );
-    }
-
-    /**
-     * Throws an exception if an invalid operator was specified and we're debugging.
-     * @since 4.9.72.p
-     * @throws RestException
-     */
-    private function throwInvalidOperatorExceptionIfDebugging()
-    {
-        // so they didn't provide a valid operator
-        if (EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'invalid_operator',
-                sprintf(
-                    esc_html__(
-                        'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
-                        'event_espresso'
-                    ),
-                    $this->getQueryParamKey(),
-                    $this->getQueryParamValue()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-    }
-
-    /**
-     * Returns true if the query_param_key was a logic query parameter, eg `OR`, `AND`, `NOT`, `OR*`, etc.
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function isLogicQueryParam()
-    {
-        return in_array($this->getQueryParamKeySansStars(), $this->getContext()->getModel()->logic_query_param_keys());
-    }
-
-
-    /**
-     * If the query param isn't for a field, it must be a nested query parameter which requires different logic.
-     * @since 4.9.72.p
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws RestException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function determineNestedConditionQueryParameters()
-    {
-
-        // so this param doesn't correspond to a field eh?
-        if ($this->getContext()->isWriting()) {
-            // always tell API clients about invalid parameters when they're creating data. Otherwise,
-            // they are probably going to create invalid data
-            throw new RestException(
-                'invalid_field',
-                sprintf(
-                    /* translators: 1: variable name */
-                    esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
-                    $this->getQueryParamKey()
-                )
-            );
-        }
-        // so it's not for a field, is it a logic query param key?
-        if ($this->isLogicQueryParam()) {
-            return ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $this->getQueryParamValue(),
-                $this->getContext()->getModel(),
-                $this->getContext()->getRequestedVersion()
-            );
-        }
-        if (EED_Core_Rest_Api::debugMode()) {
-            // only tell API clients they got it wrong if we're in debug mode
-            // otherwise try our best ot fulfill their request by ignoring this invalid data
-            throw new RestException(
-                'invalid_parameter',
-                sprintf(
-                    /* translators: 1: variable name */
-                    esc_html__(
-                        'You provided an invalid parameter, with key "%1$s"',
-                        'event_espresso'
-                    ),
-                    $this->getQueryParamKey()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-        return null;
-    }
+	private $query_param_key;
+	private $query_param_value;
+	/**
+	 * @var RestIncomingQueryParamContext
+	 */
+	private $context;
+
+	/**
+	 * @var EE_Model_Field_Base|null
+	 */
+	private $field;
+
+	/**
+	 * @var string same as $query_param_key but has the * and anything after it removed
+	 */
+	private $query_param_key_sans_stars;
+
+	/**
+	 * @var string for timezone or timezone offset
+	 */
+	private $timezone;
+
+	/**
+	 * @var boolean if the field in $query_param_key is for a GMT field (eg `EVT_modified_gmt`)
+	 */
+	private $is_gmt_field = false;
+
+	/**
+	 * RestIncomingQueryParamMetadata constructor.
+	 * You probably want to call
+	 * @param string $query_param_key
+	 * @param string $query_param_value
+	 * @param RestIncomingQueryParamContext $context
+	 */
+	public function __construct($query_param_key, $query_param_value, RestIncomingQueryParamContext $context)
+	{
+		$this->query_param_key = $query_param_key;
+		$this->query_param_value = $query_param_value;
+		$this->context = $context;
+		$this->determineFieldAndTimezone();
+	}
+
+	/**
+	 * Gets the query parameter key. This may have been modified (see setQueryParamValue())
+	 * @return string
+	 */
+	public function getQueryParamKey()
+	{
+		return $this->query_param_key;
+	}
+
+	/**
+	 * Modifies the query parameter key passed in (Eg this is done when rewriting the simplified specified operator REST
+	 * query parameters into the legacy structure)
+	 * @param string|array|int|float $query_param_value
+	 */
+	private function setQueryParamValue($query_param_value)
+	{
+		$this->query_param_value = $query_param_value;
+	}
+
+	/**
+	 * Gets the original query parameter value passed in.
+	 * @return string
+	 */
+	public function getQueryParamValue()
+	{
+		return $this->query_param_value;
+	}
+
+	/**
+	 * Gets the context object.
+	 * @return RestIncomingQueryParamContext
+	 */
+	public function getContext()
+	{
+		return $this->context;
+	}
+
+	/**
+	 * Sets the query parameter key. This may be used to rewrite a key into its non-GMT alternative.
+	 * @param string $query_param_key
+	 */
+	private function setQueryParamKey($query_param_key)
+	{
+		$this->query_param_key = $query_param_key;
+	}
+
+	/**
+	 * Gets the field the query parameter key indicated. This may be null (in cases where the query parameter key
+	 * did not indicate a field, eg if it were `OR`).
+	 * @return EE_Model_Field_Base|null
+	 */
+	public function getField()
+	{
+		return $this->field;
+	}
+
+	/**
+	 * Gets the query parameter key (with the star and everything afterwards removed).
+	 * @return string
+	 */
+	public function getQueryParamKeySansStars()
+	{
+		return $this->query_param_key_sans_stars;
+	}
+
+	/**
+	 * Gets the timezone associated with this model (the site timezone, except for GMT datetime fields).
+	 * @return string
+	 */
+	public function getTimezone()
+	{
+		return $this->timezone;
+	}
+
+	/**
+	 * Returns whether or not this is a GMT field
+	 * @return boolean
+	 */
+	public function isGmtField()
+	{
+		return $this->is_gmt_field;
+	}
+
+	/**
+	 * Sets the field indicated by the query parameter key (might be null).
+	 * @param EE_Model_Field_Base|null $field
+	 */
+	private function setField(EE_Model_Field_Base $field = null)
+	{
+		$this->field = $field;
+	}
+
+	/**
+	 * Sets the query parameter key-with-stars-removed.
+	 * @param string $query_param_key_sans_stars
+	 */
+	private function setQueryParamKeySansStars($query_param_key_sans_stars)
+	{
+		$this->query_param_key_sans_stars = $query_param_key_sans_stars;
+	}
+
+	/**
+	 * Sets the timezone (this could be a timezeon offset string).
+	 * @param string $timezone
+	 */
+	private function setTimezone($timezone)
+	{
+		$this->timezone = $timezone;
+	}
+
+	/**
+	 * @param mixed $is_gmt_field
+	 */
+	private function setIsGmtField($is_gmt_field)
+	{
+		$this->is_gmt_field = $is_gmt_field;
+	}
+
+	/**
+	 * Determines what field, query param name, and query param name without stars, and timezone to use.
+	 * @since 4.9.72.p
+	 * @type EE_Model_Field_Base $field
+	 * @return void {
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function determineFieldAndTimezone()
+	{
+		$this->setQueryParamKeySansStars(ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
+			$this->getQueryParamKey()
+		));
+		$this->setField(ModelDataTranslator::deduceFieldFromQueryParam(
+			$this->getQueryParamKeySansStars(),
+			$this->getContext()->getModel()
+		));
+		// double-check is it a *_gmt field?
+		if (
+			!$this->getField() instanceof EE_Model_Field_Base
+			&& ModelDataTranslator::isGmtDateFieldName($this->getQueryParamKeySansStars())
+		) {
+			// yep, take off '_gmt', and find the field
+			$this->setQueryParamKey(ModelDataTranslator::removeGmtFromFieldName($this->getQueryParamKeySansStars()));
+			$this->setField(ModelDataTranslator::deduceFieldFromQueryParam(
+				$this->getQueryParamKey(),
+				$this->context->getModel()
+			));
+			$this->setTimezone('UTC');
+			$this->setIsGmtField(true);
+		} elseif ($this->getField() instanceof EE_Datetime_Field) {
+			// so it's not a GMT field. Set the timezone on the model to the default
+			$this->setTimezone(EEH_DTT_Helper::get_valid_timezone_string());
+		} else {
+			// just keep using what's already set for the timezone
+			$this->setTimezone($this->context->getModel()->get_timezone());
+		}
+		$this->assertOnlyAdminCanReadPasswordFields();
+	}
+
+	/**
+	 * Throws an exception if a non-admin is trying to query by password.
+	 * @since 4.9.74.p
+	 * @throws RestException
+	 */
+	private function assertOnlyAdminCanReadPasswordFields()
+	{
+		if (
+			$this->getField() instanceof EE_Password_Field
+			&& ! current_user_can(EE_Restriction_Generator_Base::get_default_restrictions_cap())
+		) {
+			// only full admins can query by password. sorry bub!
+			throw new RestException(
+				'only_admins_can_query_by_password',
+				// @codingStandardsIgnoreStart
+				esc_html__('You attempted to filter by a password field without the needed privileges. Only a full admin is allowed to do that.', 'event_espresso'),
+				// @codingStandardsIgnoreEnd
+				array(
+					'status' => 403
+				)
+			);
+		}
+	}
+
+	/**
+	 * Given a ton of input, determines the value to use for the models.
+	 * @since 4.9.72.p
+	 * @return array|null
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws RestException
+	 * @throws DomainException
+	 */
+	public function determineConditionsQueryParameterValue()
+	{
+		if ($this->valueIsArrayDuringRead()) {
+			return $this->determineModelValueGivenRestInputArray();
+		}
+		return ModelDataTranslator::prepareFieldValueFromJson(
+			$this->getField(),
+			$this->getQueryParamValue(),
+			$this->getContext()->getRequestedVersion(),
+			$this->getTimezone()
+		);
+	}
+
+	/**
+	 * Given that the array value provided was itself an array, handles finding the correct value to pass to the model.
+	 * @since 4.9.72.p
+	 * @return array|null
+	 * @throws RestException
+	 */
+	private function determineModelValueGivenRestInputArray()
+	{
+		$this->transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax();
+		// did they specify an operator?
+		if ($this->valueIsLegacySpecifiedOperator()) {
+			$query_param_value = $this->getQueryParamValue();
+			$sub_array_key = $query_param_value[0];
+			$translated_value = array($sub_array_key);
+			if ($this->operatorIsNAry($sub_array_key)) {
+				$translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
+			} elseif ($this->operatorIsTernary($sub_array_key)) {
+				$translated_value[] = array(
+					$this->prepareValuesFromJson($query_param_value[1][0]),
+					$this->prepareValuesFromJson($query_param_value[1][1])
+				);
+			} elseif ($this->operatorIsLike($sub_array_key)) {
+				// we want to leave this value mostly-as-is (eg don't force it to be a float
+				// or a boolean or an enum value. Leave it as-is with wildcards etc)
+				// but do verify it at least doesn't have any serialized data
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
+				$translated_value[] = $query_param_value[1];
+			} elseif ($this->operatorIsUnary($sub_array_key)) {
+				// no arguments should have been provided, so don't look for any
+			} elseif ($this->operatorisBinary($sub_array_key)) {
+				// it's a valid operator, but none of the exceptions. Treat it normally.
+				$translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
+			} else {
+				// so they provided a valid operator, but wrong number of arguments
+				$this->throwWrongNumberOfArgsExceptionIfDebugging($sub_array_key);
+				$translated_value = null;
+			}
+		} else {
+			// so they didn't provide a valid operator
+			// if we aren't in debug mode, then just try our best to fulfill the user's request
+			$this->throwInvalidOperatorExceptionIfDebugging();
+			$translated_value = null;
+		}
+		return $translated_value;
+	}
+
+	/**
+	 * Returns if this request is a "read" request and the value provided was an array.
+	 * This will indicate is such things as `array('<', 123)` and `array('IN', array(1,2,3))` are acceptable or not.
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function valueIsArrayDuringRead()
+	{
+		return !$this->getContext()->isWriting() && is_array($this->getQueryParamValue());
+	}
+
+	/**
+	 * Returns if the value provided was an associative array (we should have already verified it's an array of some
+	 * sort). If the value is an associative array, it had better be in the simplified specified operator structure.
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function valueIsAssociativeArray()
+	{
+		return !EEH_Array::is_array_numerically_and_sequentially_indexed($this->getQueryParamValue());
+	}
+
+	/**
+	 * Checks if the array value is itself an array that fits into the simplified specified operator structure
+	 * (eg `array('!=' => 123)`).
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function valueIsSimplifiedSpecifiedOperator()
+	{
+		return count($this->getQueryParamValue()) === 1
+			&& array_key_exists(
+				key($this->getQueryParamValue()),
+				$this->getContext()->getModel()->valid_operators()
+			);
+	}
+
+	/**
+	 * Throws an exception if the sub-value is an array (eg `array('!=' => array())`). It needs to just be a string,
+	 * of either comma-separated-values, or a JSON array.
+	 * @since 4.9.72.p
+	 * @param $sub_array_key
+	 * @param $sub_array_value
+	 * @throws RestException
+	 */
+	private function assertSubValueIsntArray($sub_array_key, $sub_array_value)
+	{
+		if (is_array($sub_array_value) && EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'csv_or_json_string_only',
+				sprintf(
+					/* translators: 1: variable name*/
+					esc_html__(
+						'The value provided for the operator "%1$s" should be comma-separated value string or a JSON array.',
+						'event_espresso'
+					),
+					$sub_array_key
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+	}
+
+	/**
+	 * Determines if the sub-array key is an operator taking 3 or more operators.
+	 * @since 4.9.72.p
+	 * @param $sub_array_key
+	 * @return boolean
+	 */
+	private function subArrayKeyIsNonBinaryOperator($sub_array_key)
+	{
+		return array_key_exists(
+			$sub_array_key,
+			array_merge(
+				$this->getContext()->getModel()->valid_in_style_operators(),
+				$this->getContext()->getModel()->valid_between_style_operators()
+			)
+		);
+	}
+
+	/**
+	 * Given that the $sub_array_key is a string, checks if it's an operator taking only 1 argument.
+	 * @since 4.9.72.p
+	 * @param string $sub_array_key
+	 * @return boolean
+	 */
+	private function subArrayKeyIsUnaryOperator($sub_array_key)
+	{
+		return array_key_exists(
+			$sub_array_key,
+			$this->getContext()->getModel()->valid_null_style_operators()
+		);
+	}
+
+	/**
+	 * Parses the $sub_array_value string into an array (given it could either be a comma-separated-list or a JSON
+	 * array). eg `"1,2,3"` or `"[1,2,3]"` into `array(1,2,3)`.
+	 * @since 4.9.72.p
+	 * @param $sub_array_value
+	 * @return array|mixed|object
+	 */
+	private function extractQuickStyleSpecifiedOperatorValue($sub_array_value)
+	{
+		// the value should be JSON or CSV
+		$values = json_decode($sub_array_value);
+		if (!is_array($values)) {
+			$values = array_filter(
+				array_map(
+					'trim',
+					explode(
+						',',
+						$sub_array_value
+					)
+				)
+			);
+		}
+		return $values;
+	}
+
+	/**
+	 * Throws an exception if the value isn't a simplified specified operator (only called when we expect that).
+	 * @since 4.9.72.p
+	 * @throws RestException
+	 */
+	private function assertSimplifiedSpecifiedOperator()
+	{
+		if (!$this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'numerically_indexed_array_of_values_only',
+				sprintf(
+					/* translators: 1: variable name*/
+					esc_html__(
+						'The array provided for the parameter "%1$s" should be numerically indexed.',
+						'event_espresso'
+					),
+					$this->getQueryParamKey()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+	}
+
+	/**
+	 * If query_param_value were in the simplified specific operator structure, change it into the legacy structure.
+	 * @since 4.9.72.p
+	 * @throws RestException
+	 */
+	private function transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax()
+	{
+		if ($this->valueIsAssociativeArray()) {
+			$this->assertSimplifiedSpecifiedOperator();
+			$query_param_value = $this->getQueryParamValue();
+			$sub_array_value = reset($query_param_value);
+			$sub_array_key = key($query_param_value);
+			$this->assertSubValueIsntArray($sub_array_key, $sub_array_value);
+			// they're doing something like "&where[EVT_ID][IN]=1,2,3" or "&where[EVT_ID][>]=5"
+			if ($this->subArrayKeyIsNonBinaryOperator($sub_array_key)) {
+				$this->setQueryParamValue(array(
+					$sub_array_key,
+					$this->extractQuickStyleSpecifiedOperatorValue($sub_array_value)
+				));
+			} elseif ($this->subArrayKeyIsUnaryOperator($sub_array_key)) {
+				$this->setQueryParamValue(array($sub_array_key));
+			} else {
+				$this->setQueryParamValue(array($sub_array_key, $sub_array_value));
+			}
+		}
+	}
+
+	/**
+	 * Returns true is the value is an array using the legacy structure to specify the operator. Eg `array('!=',123)`.
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function valueIsLegacySpecifiedOperator()
+	{
+		$valid_operators = $this->getContext()->getModel()->valid_operators();
+		$query_param_value = $this->getQueryParamValue();
+		return isset($query_param_value[0])
+			&& isset($valid_operators[ $query_param_value[0] ]);
+	}
+
+	/**
+	 * Returns true if the value specified operator accepts arbitrary number of arguments, like "IN".
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorIsNAry($operator)
+	{
+		$valueArray = $this->getQueryParamValue();
+		return array_key_exists(
+			$operator,
+			$this->getContext()->getModel()->valid_in_style_operators()
+		)
+			&& isset($valueArray[1])
+			&& is_array($valueArray[1])
+			&& !isset($valueArray[2]);
+	}
+
+	/**
+	 * Returns true if the operator accepts 3 arguments (eg "BETWEEN").
+	 * So we're looking for a value that looks like
+	 * `array('BETWEEN', array('2015-01-01T00:00:00', '2016-01-01T00:00:00'))`.
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorIsTernary($operator)
+	{
+		$query_param_value = $this->getQueryParamValue();
+		return array_key_exists($operator, $this->getContext()->getModel()->valid_between_style_operators())
+			&& isset($query_param_value[1])
+			&& is_array($query_param_value[1])
+			&& isset($query_param_value[1][0], $query_param_value[1][1])
+			&& !isset($query_param_value[1][2])
+			&& !isset($query_param_value[2]);
+	}
+
+	/**
+	 * Returns true if the operator is a similar to LIKE, indicating the value may have wildcards we should leave alone.
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorIsLike($operator)
+	{
+		$query_param_value = $this->getQueryParamValue();
+		return array_key_exists($operator, $this->getContext()->getModel()->valid_like_style_operators())
+			&& isset($query_param_value[1])
+			&& !isset($query_param_value[2]);
+	}
+
+	/**
+	 * Returns true if the operator only takes one argument (eg it's like `IS NULL`).
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorIsUnary($operator)
+	{
+		$query_param_value = $this->getQueryParamValue();
+		return array_key_exists($operator, $this->getContext()->getModel()->valid_null_style_operators())
+			&& !isset($query_param_value[1]);
+	}
+
+	/**
+	 * Returns true if the operator specified is a binary opeator (eg `=`, `!=`)
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorisBinary($operator)
+	{
+		$query_param_value = $this->getQueryParamValue();
+		$model = $this->getContext()->getModel();
+		return isset($query_param_value[1])
+			&& !isset($query_param_value[2])
+			&& !array_key_exists(
+				$operator,
+				array_merge(
+					$model->valid_in_style_operators(),
+					$model->valid_null_style_operators(),
+					$model->valid_like_style_operators(),
+					$model->valid_between_style_operators()
+				)
+			);
+	}
+
+	/**
+	 * If we're debugging, throws an exception saying that the wrong number of arguments was provided.
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @throws RestException
+	 */
+	private function throwWrongNumberOfArgsExceptionIfDebugging($operator)
+	{
+		if (EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'wrong_number_of_arguments',
+				sprintf(
+					esc_html__(
+						'The operator you provided, "%1$s" had the wrong number of arguments',
+						'event_espresso'
+					),
+					$operator
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+	}
+
+	/**
+	 * Wrapper for ModelDataTranslator::prepareFieldValuesFromJson(), just a tad more DRY.
+	 * @since 4.9.72.p
+	 * @param $value
+	 * @return mixed
+	 * @throws RestException
+	 */
+	private function prepareValuesFromJson($value)
+	{
+		return ModelDataTranslator::prepareFieldValuesFromJson(
+			$this->getField(),
+			$value,
+			$this->getContext()->getRequestedVersion(),
+			$this->getTimezone()
+		);
+	}
+
+	/**
+	 * Throws an exception if an invalid operator was specified and we're debugging.
+	 * @since 4.9.72.p
+	 * @throws RestException
+	 */
+	private function throwInvalidOperatorExceptionIfDebugging()
+	{
+		// so they didn't provide a valid operator
+		if (EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'invalid_operator',
+				sprintf(
+					esc_html__(
+						'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
+						'event_espresso'
+					),
+					$this->getQueryParamKey(),
+					$this->getQueryParamValue()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+	}
+
+	/**
+	 * Returns true if the query_param_key was a logic query parameter, eg `OR`, `AND`, `NOT`, `OR*`, etc.
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function isLogicQueryParam()
+	{
+		return in_array($this->getQueryParamKeySansStars(), $this->getContext()->getModel()->logic_query_param_keys());
+	}
+
+
+	/**
+	 * If the query param isn't for a field, it must be a nested query parameter which requires different logic.
+	 * @since 4.9.72.p
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws RestException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function determineNestedConditionQueryParameters()
+	{
+
+		// so this param doesn't correspond to a field eh?
+		if ($this->getContext()->isWriting()) {
+			// always tell API clients about invalid parameters when they're creating data. Otherwise,
+			// they are probably going to create invalid data
+			throw new RestException(
+				'invalid_field',
+				sprintf(
+					/* translators: 1: variable name */
+					esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
+					$this->getQueryParamKey()
+				)
+			);
+		}
+		// so it's not for a field, is it a logic query param key?
+		if ($this->isLogicQueryParam()) {
+			return ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$this->getQueryParamValue(),
+				$this->getContext()->getModel(),
+				$this->getContext()->getRequestedVersion()
+			);
+		}
+		if (EED_Core_Rest_Api::debugMode()) {
+			// only tell API clients they got it wrong if we're in debug mode
+			// otherwise try our best ot fulfill their request by ignoring this invalid data
+			throw new RestException(
+				'invalid_parameter',
+				sprintf(
+					/* translators: 1: variable name */
+					esc_html__(
+						'You provided an invalid parameter, with key "%1$s"',
+						'event_espresso'
+					),
+					$this->getQueryParamKey()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+		return null;
+	}
 }
 // End of file RestQueryParamMetadata.php
 // Location: EventEspresso\core\libraries\rest_api/RestQueryParamMetadata.php

Spacing +13 added lines, -13 removed lines

@@ -209,7 +209,7 @@ 
         ));
         // double-check is it a *_gmt field?
         if (
-            !$this->getField() instanceof EE_Model_Field_Base
+            ! $this->getField() instanceof EE_Model_Field_Base
             && ModelDataTranslator::isGmtDateFieldName($this->getQueryParamKeySansStars())
         ) {
             // yep, take off '_gmt', and find the field
@@ -330,7 +330,7 @@ 
      */
     private function valueIsArrayDuringRead()
     {
-        return !$this->getContext()->isWriting() && is_array($this->getQueryParamValue());
+        return ! $this->getContext()->isWriting() && is_array($this->getQueryParamValue());
     }
 
     /**
@@ -341,7 +341,7 @@ 
      */
     private function valueIsAssociativeArray()
     {
-        return !EEH_Array::is_array_numerically_and_sequentially_indexed($this->getQueryParamValue());
+        return ! EEH_Array::is_array_numerically_and_sequentially_indexed($this->getQueryParamValue());
     }
 
     /**
@@ -429,7 +429,7 @@ 
     {
         // the value should be JSON or CSV
         $values = json_decode($sub_array_value);
-        if (!is_array($values)) {
+        if ( ! is_array($values)) {
             $values = array_filter(
                 array_map(
                     'trim',
@@ -450,7 +450,7 @@ 
      */
     private function assertSimplifiedSpecifiedOperator()
     {
-        if (!$this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
+        if ( ! $this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
             throw new RestException(
                 'numerically_indexed_array_of_values_only',
                 sprintf(
@@ -505,7 +505,7 @@ 
         $valid_operators = $this->getContext()->getModel()->valid_operators();
         $query_param_value = $this->getQueryParamValue();
         return isset($query_param_value[0])
-            && isset($valid_operators[ $query_param_value[0] ]);
+            && isset($valid_operators[$query_param_value[0]]);
     }
 
     /**
@@ -523,7 +523,7 @@ 
         )
             && isset($valueArray[1])
             && is_array($valueArray[1])
-            && !isset($valueArray[2]);
+            && ! isset($valueArray[2]);
     }
 
     /**
@@ -541,8 +541,8 @@ 
             && isset($query_param_value[1])
             && is_array($query_param_value[1])
             && isset($query_param_value[1][0], $query_param_value[1][1])
-            && !isset($query_param_value[1][2])
-            && !isset($query_param_value[2]);
+            && ! isset($query_param_value[1][2])
+            && ! isset($query_param_value[2]);
     }
 
     /**
@@ -556,7 +556,7 @@ 
         $query_param_value = $this->getQueryParamValue();
         return array_key_exists($operator, $this->getContext()->getModel()->valid_like_style_operators())
             && isset($query_param_value[1])
-            && !isset($query_param_value[2]);
+            && ! isset($query_param_value[2]);
     }
 
     /**
@@ -569,7 +569,7 @@ 
     {
         $query_param_value = $this->getQueryParamValue();
         return array_key_exists($operator, $this->getContext()->getModel()->valid_null_style_operators())
-            && !isset($query_param_value[1]);
+            && ! isset($query_param_value[1]);
     }
 
     /**
@@ -583,8 +583,8 @@ 
         $query_param_value = $this->getQueryParamValue();
         $model = $this->getContext()->getModel();
         return isset($query_param_value[1])
-            && !isset($query_param_value[2])
-            && !array_key_exists(
+            && ! isset($query_param_value[2])
+            && ! array_key_exists(
                 $operator,
                 array_merge(
                     $model->valid_in_style_operators(),

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;
+	}
 }