eventespresso / event-espresso-core

widgets/upcoming_events/EEW_Upcoming_Events.widget.php

Indentation +594 added lines, -594 removed lines

@@ -12,109 +12,109 @@ 
 class EEW_Upcoming_Events extends EspressoWidget
 {
 
-    /**
-     * @var string
-     */
-    private $title;
-    /**
-     * @var string
-     */
-    private $events_category;
-
-    /**
-     * @var bool
-     */
-    private $show_expired;
-
-    /**
-     * @var string
-     */
-    private $image_size;
-
-    /**
-     * @var bool
-     */
-    private $show_desc;
-
-    /**
-     * @var bool
-     */
-    private $show_dates;
-
-    /**
-     * @var string
-     */
-    private $date_limit;
-
-    /**
-     * @var string
-     */
-    private $date_range;
-
-    /**
-     * @var string
-     */
-    private $limit;
-
-    /**
-     * @var string
-     */
-    private $order;
-
-
-    /**
-     * Register widget with WordPress.
-     */
-    public function __construct()
-    {
-        parent::__construct(
-            esc_html__('Event Espresso Upcoming Events', 'event_espresso'),
-            ['description' => esc_html__('A widget to display your upcoming events.', 'event_espresso')]
-        );
-    }
-
-
-    /**
-     * Back-end widget form.
-     *
-     * @param array $instance Previously saved values from database.
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see WP_Widget::form()
-     */
-    public function form($instance)
-    {
-
-        EE_Registry::instance()->load_class('Question_Option', [], false, false, true);
-        // Set up some default widget settings.
-        $defaults = [
-            'title'           => esc_html__('Upcoming Events', 'event_espresso'),
-            'category_name'   => '',
-            'show_expired'    => 0,
-            'show_desc'       => true,
-            'show_dates'      => true,
-            'show_everywhere' => false,
-            'date_limit'      => 2,
-            'limit'           => 10,
-            'sort'            => 'ASC',
-            'date_range'      => false,
-            'image_size'      => 'medium',
-        ];
-
-        $instance = wp_parse_args((array) $instance, $defaults);
-        // don't add HTML labels for EE_Form_Fields generated inputs
-        add_filter('FHEE__EEH_Form_Fields__label_html', '__return_empty_string');
-        $yes_no_values = [
-            EE_Question_Option::new_instance(['QSO_value' => false, 'QSO_desc' => esc_html__('No', 'event_espresso')]),
-            EE_Question_Option::new_instance(['QSO_value' => true, 'QSO_desc' => esc_html__('Yes', 'event_espresso')]),
-        ];
-        $sort_values   = [
-            EE_Question_Option::new_instance(['QSO_value' => 'ASC', 'QSO_desc' => esc_html__('ASC', 'event_espresso')]),
-            EE_Question_Option::new_instance(['QSO_value' => 'DESC', 'QSO_desc' => esc_html__('DESC', 'event_espresso')]),
-        ];
-
-        ?>
+	/**
+	 * @var string
+	 */
+	private $title;
+	/**
+	 * @var string
+	 */
+	private $events_category;
+
+	/**
+	 * @var bool
+	 */
+	private $show_expired;
+
+	/**
+	 * @var string
+	 */
+	private $image_size;
+
+	/**
+	 * @var bool
+	 */
+	private $show_desc;
+
+	/**
+	 * @var bool
+	 */
+	private $show_dates;
+
+	/**
+	 * @var string
+	 */
+	private $date_limit;
+
+	/**
+	 * @var string
+	 */
+	private $date_range;
+
+	/**
+	 * @var string
+	 */
+	private $limit;
+
+	/**
+	 * @var string
+	 */
+	private $order;
+
+
+	/**
+	 * Register widget with WordPress.
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			esc_html__('Event Espresso Upcoming Events', 'event_espresso'),
+			['description' => esc_html__('A widget to display your upcoming events.', 'event_espresso')]
+		);
+	}
+
+
+	/**
+	 * Back-end widget form.
+	 *
+	 * @param array $instance Previously saved values from database.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see WP_Widget::form()
+	 */
+	public function form($instance)
+	{
+
+		EE_Registry::instance()->load_class('Question_Option', [], false, false, true);
+		// Set up some default widget settings.
+		$defaults = [
+			'title'           => esc_html__('Upcoming Events', 'event_espresso'),
+			'category_name'   => '',
+			'show_expired'    => 0,
+			'show_desc'       => true,
+			'show_dates'      => true,
+			'show_everywhere' => false,
+			'date_limit'      => 2,
+			'limit'           => 10,
+			'sort'            => 'ASC',
+			'date_range'      => false,
+			'image_size'      => 'medium',
+		];
+
+		$instance = wp_parse_args((array) $instance, $defaults);
+		// don't add HTML labels for EE_Form_Fields generated inputs
+		add_filter('FHEE__EEH_Form_Fields__label_html', '__return_empty_string');
+		$yes_no_values = [
+			EE_Question_Option::new_instance(['QSO_value' => false, 'QSO_desc' => esc_html__('No', 'event_espresso')]),
+			EE_Question_Option::new_instance(['QSO_value' => true, 'QSO_desc' => esc_html__('Yes', 'event_espresso')]),
+		];
+		$sort_values   = [
+			EE_Question_Option::new_instance(['QSO_value' => 'ASC', 'QSO_desc' => esc_html__('ASC', 'event_espresso')]),
+			EE_Question_Option::new_instance(['QSO_value' => 'DESC', 'QSO_desc' => esc_html__('DESC', 'event_espresso')]),
+		];
+
+		?>
 
         <!-- Widget Title: Text Input -->
 
@@ -151,32 +151,32 @@ 
                 <?php esc_html_e('Show Expired Events:', 'event_espresso'); ?>
             </label>
             <?php
-            $show_expired_options   = $yes_no_values;
-            $show_expired_options[] = EE_Question_Option::new_instance(
-                ['QSO_value' => 2, 'QSO_desc' => esc_html__('Show Only Expired', 'event_espresso')]
-            );
-            echo EEH_Form_Fields::select(
-                esc_html__('Show Expired Events:', 'event_espresso'),
-                $instance['show_expired'],
-                $show_expired_options,
-                $this->fieldName('show_expired'),
-                $this->fieldID('show_expired')
-            );
-            ?>
+			$show_expired_options   = $yes_no_values;
+			$show_expired_options[] = EE_Question_Option::new_instance(
+				['QSO_value' => 2, 'QSO_desc' => esc_html__('Show Only Expired', 'event_espresso')]
+			);
+			echo EEH_Form_Fields::select(
+				esc_html__('Show Expired Events:', 'event_espresso'),
+				$instance['show_expired'],
+				$show_expired_options,
+				$this->fieldName('show_expired'),
+				$this->fieldID('show_expired')
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo $this->fieldID('sort'); ?>">
                 <?php esc_html_e('Sort Events:', 'event_espresso'); ?>
             </label>
             <?php
-            echo EEH_Form_Fields::select(
-                esc_html__('Sort Events:', 'event_espresso'),
-                $instance['sort'],
-                $sort_values,
-                $this->fieldName('sort'),
-                $this->fieldID('sort')
-            );
-            ?>
+			echo EEH_Form_Fields::select(
+				esc_html__('Sort Events:', 'event_espresso'),
+				$instance['sort'],
+				$sort_values,
+				$this->fieldName('sort'),
+				$this->fieldID('sort')
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo $this->fieldID('image_size'); ?>">
@@ -190,42 +190,42 @@ 
                 <?php esc_html_e('Show Description:', 'event_espresso'); ?>
             </label>
             <?php
-            echo EEH_Form_Fields::select(
-                esc_html__('Show Description:', 'event_espresso'),
-                $instance['show_desc'],
-                $yes_no_values,
-                $this->fieldName('show_desc'),
-                $this->fieldID('show_desc')
-            );
-            ?>
+			echo EEH_Form_Fields::select(
+				esc_html__('Show Description:', 'event_espresso'),
+				$instance['show_desc'],
+				$yes_no_values,
+				$this->fieldName('show_desc'),
+				$this->fieldID('show_desc')
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo $this->fieldID('show_dates'); ?>">
                 <?php esc_html_e('Show Dates:', 'event_espresso'); ?>
             </label>
             <?php
-            echo EEH_Form_Fields::select(
-                esc_html__('Show Dates:', 'event_espresso'),
-                $instance['show_dates'],
-                $yes_no_values,
-                $this->fieldName('show_dates'),
-                $this->fieldID('show_dates')
-            );
-            ?>
+			echo EEH_Form_Fields::select(
+				esc_html__('Show Dates:', 'event_espresso'),
+				$instance['show_dates'],
+				$yes_no_values,
+				$this->fieldName('show_dates'),
+				$this->fieldID('show_dates')
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo $this->fieldID('show_everywhere'); ?>">
                 <?php esc_html_e('Show on all Pages:', 'event_espresso'); ?>
             </label>
             <?php
-            echo EEH_Form_Fields::select(
-                esc_html__('Show on all Pages:', 'event_espresso'),
-                $instance['show_everywhere'],
-                $yes_no_values,
-                $this->fieldName('show_everywhere'),
-                $this->fieldID('show_everywhere')
-            );
-            ?>
+			echo EEH_Form_Fields::select(
+				esc_html__('Show on all Pages:', 'event_espresso'),
+				$instance['show_everywhere'],
+				$yes_no_values,
+				$this->fieldName('show_everywhere'),
+				$this->fieldID('show_everywhere')
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo $this->fieldID('date_limit'); ?>">
@@ -243,278 +243,278 @@ 
                 <?php esc_html_e('Show Date Range:', 'event_espresso'); ?>
             </label>
             <?php
-            echo EEH_Form_Fields::select(
-                esc_html__('Show Date Range:', 'event_espresso'),
-                $instance['date_range'],
-                $yes_no_values,
-                $this->fieldName('date_range'),
-                $this->fieldID('date_range')
-            );
-            ?>
+			echo EEH_Form_Fields::select(
+				esc_html__('Show Date Range:', 'event_espresso'),
+				$instance['date_range'],
+				$yes_no_values,
+				$this->fieldName('date_range'),
+				$this->fieldID('date_range')
+			);
+			?>
             <span class="description">
                 <br />
                 <?php esc_html_e(
-                    'This setting will replace the list of dates in the widget.',
-                    'event_espresso'
-                ); ?>
+					'This setting will replace the list of dates in the widget.',
+					'event_espresso'
+				); ?>
             </span>
         </p>
 
         <?php
-    }
-
-
-    /**
-     * Sanitize widget form values as they are saved.
-     *
-     * @param array $new_instance Values just sent to be saved.
-     * @param array $old_instance Previously saved values from database.
-     *
-     * @return array Updated safe values to be saved.
-     * @see WP_Widget::update()
-     *
-     */
-    public function update($new_instance, $old_instance)
-    {
-        $instance                    = $old_instance;
-        $instance['title']           = ! empty($new_instance['title']) ? strip_tags($new_instance['title']) : '';
-        $instance['category_name']   = $new_instance['category_name'];
-        $instance['show_expired']    = $new_instance['show_expired'];
-        $instance['limit']           = $new_instance['limit'];
-        $instance['sort']            = $new_instance['sort'];
-        $instance['image_size']      = $new_instance['image_size'];
-        $instance['show_desc']       = $new_instance['show_desc'];
-        $instance['show_dates']      = $new_instance['show_dates'];
-        $instance['show_everywhere'] = $new_instance['show_everywhere'];
-        $instance['date_limit']      = $new_instance['date_limit'];
-        $instance['date_range']      = $new_instance['date_range'];
-        return $instance;
-    }
-
-
-    /**
-     * Front-end display of widget.
-     *
-     * @param array $args     Widget arguments.
-     * @param array $instance Saved values from database.
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see WP_Widget::widget()
-     *
-     */
-    public function widget($args, $instance)
-    {
-
-        global $post;
-        // make sure there is some kinda post object
-        if ($post instanceof WP_Post) {
-            $before_widget = '';
-            $before_title  = '';
-            $after_title   = '';
-            $after_widget  = '';
-            // but NOT an events archives page, cuz that would be like two event lists on the same page
-            $show_everywhere = ! isset($instance['show_everywhere']) || absint($instance['show_everywhere']);
-            if ($show_everywhere || ! ($post->post_type == 'espresso_events' && is_archive())) {
-                // let's use some of the event helper functions'
-                // make separate vars out of attributes
-                extract($args);
-
-                // grab widget settings
-                $this->parseWidgetSettings($instance);
-                $title = $this->widgetTitle();
-
-                // Before widget (defined by themes).
-                echo $before_widget;
-                // Display the widget title if one was input (before and after defined by themes).
-                if (! empty($title)) {
-                    echo $before_title . $title . $after_title;
-                }
-                echo $this->widgetContent($post);
-                // After widget (defined by themes).
-                echo $after_widget;
-            }
-        }
-    }
-
-
-    /**
-     * make_the_title_a_link
-     * callback for widget_title filter
-     *
-     * @param $title
-     * @return string
-     */
-    public function make_the_title_a_link($title)
-    {
-        return '<a href="' . EEH_Event_View::event_archive_url() . '">' . $title . '</a>';
-    }
-
-
-    /**
-     * @param string $field_name
-     * @return string
-     * @since   4.10.14.p
-     */
-    public function fieldID($field_name)
-    {
-        return esc_attr(parent::get_field_id($field_name));
-    }
-
-
-    /**
-     * @param string $field_name
-     * @return string
-     * @since   4.10.14.p
-     */
-    public function fieldName($field_name)
-    {
-        return esc_attr(parent::get_field_name($field_name));
-    }
-
-
-    /**
-     * @param array $instance
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function eventCategoriesSelector(array $instance)
-    {
-        $event_categories = [];
-        $categories       = EEM_Term::instance()->get_all_ee_categories(true);
-        if ($categories) {
-            foreach ($categories as $category) {
-                if ($category instanceof EE_Term) {
-                    $event_categories[] =
-                        EE_Question_Option::new_instance(
-                            [
-                                'QSO_value' => $category->get('slug'),
-                                'QSO_desc'  => $category->get('name'),
-                            ]
-                        );
-                }
-            }
-        }
-        array_unshift(
-            $event_categories,
-            EE_Question_Option::new_instance(
-                [
-                    'QSO_value' => '',
-                    'QSO_desc'  => esc_html__(' - display all - ', 'event_espresso'),
-                ]
-            )
-        );
-        echo EEH_Form_Fields::select(
-            esc_html__('Event Category:', 'event_espresso'),
-            $instance['category_name'],
-            $event_categories,
-            $this->fieldName('category_name'),
-            $this->fieldID('category_name')
-        );
-    }
-
-
-    /**
-     * @param array $instance
-     * @since   4.10.14.p
-     */
-    private function imageSizeSelector(array $instance)
-    {
-        $image_sizes = [];
-        $sizes       = get_intermediate_image_sizes();
-        if ($sizes) {
-            // loop thru images and create option objects out of them
-            foreach ($sizes as $image_size) {
-                $image_size = trim($image_size);
-                // no big images plz
-                if (! in_array($image_size, ['large', 'post-thumbnail'])) {
-                    $image_sizes[] =
-                        EE_Question_Option::new_instance(['QSO_value' => $image_size, 'QSO_desc' => $image_size]);
-                }
-            }
-            $image_sizes[] =
-                EE_Question_Option::new_instance(
-                    ['QSO_value' => 'none', 'QSO_desc' => esc_html__('don\'t show images', 'event_espresso')]
-                );
-        }
-        echo EEH_Form_Fields::select(
-            esc_html__('Image Size:', 'event_espresso'),
-            $instance['image_size'],
-            $image_sizes,
-            $this->fieldName('image_size'),
-            $this->fieldID('image_size')
-        );
-    }
-
-
-    /**
-     * @param array $instance
-     * @since   4.10.14.p
-     */
-    private function parseWidgetSettings(array $instance)
-    {
-        $this->title = isset($instance['title']) && ! empty($instance['title']) ? $instance['title'] : '';
-        $this->events_category     = isset($instance['category_name']) && ! empty($instance['category_name'])
-            ? $instance['category_name']
-            : false;
-        $this->show_expired = isset($instance['show_expired'])
-            ? filter_var($instance['show_expired'], FILTER_VALIDATE_BOOLEAN)
-            : 0;
-        $this->image_size   = isset($instance['image_size']) && ! empty($instance['image_size'])
-            ? $instance['image_size']
-            : 'medium';
-        $this->show_desc    = ! isset($instance['show_desc'])
-                              || filter_var($instance['show_desc'], FILTER_VALIDATE_BOOLEAN);
-        $this->show_dates   = ! isset($instance['show_dates'])
-                              || filter_var($instance['show_dates'], FILTER_VALIDATE_BOOLEAN);
-        $this->date_limit   = isset($instance['date_limit']) && ! empty($instance['date_limit'])
-            ? $instance['date_limit']
-            : null;
-        $this->date_range   = isset($instance['date_range']) && ! empty($instance['date_range'])
-            ? $instance['date_range']
-            : false;
-        $this->limit        = isset($instance['limit']) ? absint($instance['limit']) : 10;
-        $this->order        = isset($instance['sort']) && $instance['sort'] === 'DESC'
-            ? 'DESC'
-            : 'ASC';
-    }
-
-
-    /**
-     * @return mixed|void
-     * @since   4.10.14.p
-     */
-    private function widgetTitle()
-    {
-        // add function to make the title a link
-        add_filter('widget_title', [$this, 'make_the_title_a_link'], 15);
-        // filter the title
-        $title = apply_filters('widget_title', $this->title);
-        // remove the function from the filter, so it does not affect other widgets
-        remove_filter('widget_title', [$this, 'make_the_title_a_link'], 15);
-        return $title;
-    }
-
-
-    /**
-     * @param WP_Post $post
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function widgetContent(WP_Post $post)
-    {
-        // run the query
-        $events = $this->getUpcomingEvents();
-        if (empty($events)) {
-            return '';
-        }
-        $list_items = '';
-        foreach ($events as $event) {
-            if ($event instanceof EE_Event && (! is_single() || $post->ID != $event->ID())) {
-                $event_url = $this->eventUrl($event);
-                $list_items .= '
+	}
+
+
+	/**
+	 * Sanitize widget form values as they are saved.
+	 *
+	 * @param array $new_instance Values just sent to be saved.
+	 * @param array $old_instance Previously saved values from database.
+	 *
+	 * @return array Updated safe values to be saved.
+	 * @see WP_Widget::update()
+	 *
+	 */
+	public function update($new_instance, $old_instance)
+	{
+		$instance                    = $old_instance;
+		$instance['title']           = ! empty($new_instance['title']) ? strip_tags($new_instance['title']) : '';
+		$instance['category_name']   = $new_instance['category_name'];
+		$instance['show_expired']    = $new_instance['show_expired'];
+		$instance['limit']           = $new_instance['limit'];
+		$instance['sort']            = $new_instance['sort'];
+		$instance['image_size']      = $new_instance['image_size'];
+		$instance['show_desc']       = $new_instance['show_desc'];
+		$instance['show_dates']      = $new_instance['show_dates'];
+		$instance['show_everywhere'] = $new_instance['show_everywhere'];
+		$instance['date_limit']      = $new_instance['date_limit'];
+		$instance['date_range']      = $new_instance['date_range'];
+		return $instance;
+	}
+
+
+	/**
+	 * Front-end display of widget.
+	 *
+	 * @param array $args     Widget arguments.
+	 * @param array $instance Saved values from database.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see WP_Widget::widget()
+	 *
+	 */
+	public function widget($args, $instance)
+	{
+
+		global $post;
+		// make sure there is some kinda post object
+		if ($post instanceof WP_Post) {
+			$before_widget = '';
+			$before_title  = '';
+			$after_title   = '';
+			$after_widget  = '';
+			// but NOT an events archives page, cuz that would be like two event lists on the same page
+			$show_everywhere = ! isset($instance['show_everywhere']) || absint($instance['show_everywhere']);
+			if ($show_everywhere || ! ($post->post_type == 'espresso_events' && is_archive())) {
+				// let's use some of the event helper functions'
+				// make separate vars out of attributes
+				extract($args);
+
+				// grab widget settings
+				$this->parseWidgetSettings($instance);
+				$title = $this->widgetTitle();
+
+				// Before widget (defined by themes).
+				echo $before_widget;
+				// Display the widget title if one was input (before and after defined by themes).
+				if (! empty($title)) {
+					echo $before_title . $title . $after_title;
+				}
+				echo $this->widgetContent($post);
+				// After widget (defined by themes).
+				echo $after_widget;
+			}
+		}
+	}
+
+
+	/**
+	 * make_the_title_a_link
+	 * callback for widget_title filter
+	 *
+	 * @param $title
+	 * @return string
+	 */
+	public function make_the_title_a_link($title)
+	{
+		return '<a href="' . EEH_Event_View::event_archive_url() . '">' . $title . '</a>';
+	}
+
+
+	/**
+	 * @param string $field_name
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	public function fieldID($field_name)
+	{
+		return esc_attr(parent::get_field_id($field_name));
+	}
+
+
+	/**
+	 * @param string $field_name
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	public function fieldName($field_name)
+	{
+		return esc_attr(parent::get_field_name($field_name));
+	}
+
+
+	/**
+	 * @param array $instance
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function eventCategoriesSelector(array $instance)
+	{
+		$event_categories = [];
+		$categories       = EEM_Term::instance()->get_all_ee_categories(true);
+		if ($categories) {
+			foreach ($categories as $category) {
+				if ($category instanceof EE_Term) {
+					$event_categories[] =
+						EE_Question_Option::new_instance(
+							[
+								'QSO_value' => $category->get('slug'),
+								'QSO_desc'  => $category->get('name'),
+							]
+						);
+				}
+			}
+		}
+		array_unshift(
+			$event_categories,
+			EE_Question_Option::new_instance(
+				[
+					'QSO_value' => '',
+					'QSO_desc'  => esc_html__(' - display all - ', 'event_espresso'),
+				]
+			)
+		);
+		echo EEH_Form_Fields::select(
+			esc_html__('Event Category:', 'event_espresso'),
+			$instance['category_name'],
+			$event_categories,
+			$this->fieldName('category_name'),
+			$this->fieldID('category_name')
+		);
+	}
+
+
+	/**
+	 * @param array $instance
+	 * @since   4.10.14.p
+	 */
+	private function imageSizeSelector(array $instance)
+	{
+		$image_sizes = [];
+		$sizes       = get_intermediate_image_sizes();
+		if ($sizes) {
+			// loop thru images and create option objects out of them
+			foreach ($sizes as $image_size) {
+				$image_size = trim($image_size);
+				// no big images plz
+				if (! in_array($image_size, ['large', 'post-thumbnail'])) {
+					$image_sizes[] =
+						EE_Question_Option::new_instance(['QSO_value' => $image_size, 'QSO_desc' => $image_size]);
+				}
+			}
+			$image_sizes[] =
+				EE_Question_Option::new_instance(
+					['QSO_value' => 'none', 'QSO_desc' => esc_html__('don\'t show images', 'event_espresso')]
+				);
+		}
+		echo EEH_Form_Fields::select(
+			esc_html__('Image Size:', 'event_espresso'),
+			$instance['image_size'],
+			$image_sizes,
+			$this->fieldName('image_size'),
+			$this->fieldID('image_size')
+		);
+	}
+
+
+	/**
+	 * @param array $instance
+	 * @since   4.10.14.p
+	 */
+	private function parseWidgetSettings(array $instance)
+	{
+		$this->title = isset($instance['title']) && ! empty($instance['title']) ? $instance['title'] : '';
+		$this->events_category     = isset($instance['category_name']) && ! empty($instance['category_name'])
+			? $instance['category_name']
+			: false;
+		$this->show_expired = isset($instance['show_expired'])
+			? filter_var($instance['show_expired'], FILTER_VALIDATE_BOOLEAN)
+			: 0;
+		$this->image_size   = isset($instance['image_size']) && ! empty($instance['image_size'])
+			? $instance['image_size']
+			: 'medium';
+		$this->show_desc    = ! isset($instance['show_desc'])
+							  || filter_var($instance['show_desc'], FILTER_VALIDATE_BOOLEAN);
+		$this->show_dates   = ! isset($instance['show_dates'])
+							  || filter_var($instance['show_dates'], FILTER_VALIDATE_BOOLEAN);
+		$this->date_limit   = isset($instance['date_limit']) && ! empty($instance['date_limit'])
+			? $instance['date_limit']
+			: null;
+		$this->date_range   = isset($instance['date_range']) && ! empty($instance['date_range'])
+			? $instance['date_range']
+			: false;
+		$this->limit        = isset($instance['limit']) ? absint($instance['limit']) : 10;
+		$this->order        = isset($instance['sort']) && $instance['sort'] === 'DESC'
+			? 'DESC'
+			: 'ASC';
+	}
+
+
+	/**
+	 * @return mixed|void
+	 * @since   4.10.14.p
+	 */
+	private function widgetTitle()
+	{
+		// add function to make the title a link
+		add_filter('widget_title', [$this, 'make_the_title_a_link'], 15);
+		// filter the title
+		$title = apply_filters('widget_title', $this->title);
+		// remove the function from the filter, so it does not affect other widgets
+		remove_filter('widget_title', [$this, 'make_the_title_a_link'], 15);
+		return $title;
+	}
+
+
+	/**
+	 * @param WP_Post $post
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function widgetContent(WP_Post $post)
+	{
+		// run the query
+		$events = $this->getUpcomingEvents();
+		if (empty($events)) {
+			return '';
+		}
+		$list_items = '';
+		foreach ($events as $event) {
+			if ($event instanceof EE_Event && (! is_single() || $post->ID != $event->ID())) {
+				$event_url = $this->eventUrl($event);
+				$list_items .= '
                 <li id="ee-upcoming-events-widget-li-' . esc_attr($event->ID()) . '" 
                     class="ee-upcoming-events-widget-li"
                 >
@@ -525,194 +525,194 @@ 
                     </h5>
                     ' . $this->eventWidgetContent($event, $event_url) . '
                 </li>';
-            }
-        }
-        return '
+			}
+		}
+		return '
             <ul class="ee-upcoming-events-widget-ul">
                 ' . $list_items . '
             </ul>';
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string|null
-     * @throws EE_Error
-     * @since   4.10.14.p
-     */
-    private function eventUrl(EE_Event $event)
-    {
-        return esc_url_raw(
-            apply_filters(
-                'FHEE_EEW_Upcoming_Events__widget__event_url',
-                $event->get_permalink(),
-                $event
-            )
-        );
-    }
-
-
-    /**
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     */
-    private function getUpcomingEvents()
-    {
-        return EEM_Event::instance()->get_all(
-            [
-                $this->queryWhereParams(),
-                'limit'    => '0,' . $this->limit,
-                'order_by' => 'Datetime.DTT_EVT_start',
-                'order'    => $this->order,
-                'group_by' => 'EVT_ID',
-            ]
-        );
-    }
-
-
-    /**
-     * @return mixed|void
-     * @throws EE_Error
-     * @since   4.10.14.p
-     */
-    private function queryWhereParams()
-    {
-        // start to build our where clause
-        $where = [
-            'status' => ['IN', ['publish', 'sold_out']],
-        ];
-        // add category
-        if ($this->events_category) {
-            $where['Term_Taxonomy.taxonomy']  = 'espresso_event_categories';
-            $where['Term_Taxonomy.Term.slug'] = $this->events_category;
-        }
-        // if NOT expired then we want events that start today or in the future
-        // if NOT show expired then we want events that start today or in the future
-        if ($this->show_expired == 0) {
-            $where['Datetime.DTT_EVT_end'] = [
-                '>=',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ];
-        }
-        // if show ONLY expired we want events that ended prior to today
-        if ($this->show_expired == 2) {
-            $where['Datetime.DTT_EVT_end'] = [
-                '<=',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            ];
-        }
-        // allow $where to be filtered
-        return apply_filters('FHEE__EEW_Upcoming_Events__widget__where', $where, $this->events_category, $this->show_expired);
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function linkClass(EE_Event $event)
-    {
-        // how big is the event name ?
-        $name_length = strlen($event->name());
-        switch ($name_length) {
-            case $name_length > 70:
-                return ' three-line';
-            case $name_length > 35:
-                return ' two-line';
-        }
-        return ' one-line';
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @param string   $event_url
-     * @return mixed|string|void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function eventWidgetContent(EE_Event $event, $event_url = '')
-    {
-        if (post_password_required($event->ID())) {
-            return apply_filters(
-                'FHEE_EEW_Upcoming_Events__widget__password_form',
-                get_the_password_form($event->ID()),
-                $event
-            );
-        }
-
-        $content = '';
-        if (has_post_thumbnail($event->ID()) && $this->image_size != 'none') {
-            $content .= '
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string|null
+	 * @throws EE_Error
+	 * @since   4.10.14.p
+	 */
+	private function eventUrl(EE_Event $event)
+	{
+		return esc_url_raw(
+			apply_filters(
+				'FHEE_EEW_Upcoming_Events__widget__event_url',
+				$event->get_permalink(),
+				$event
+			)
+		);
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	private function getUpcomingEvents()
+	{
+		return EEM_Event::instance()->get_all(
+			[
+				$this->queryWhereParams(),
+				'limit'    => '0,' . $this->limit,
+				'order_by' => 'Datetime.DTT_EVT_start',
+				'order'    => $this->order,
+				'group_by' => 'EVT_ID',
+			]
+		);
+	}
+
+
+	/**
+	 * @return mixed|void
+	 * @throws EE_Error
+	 * @since   4.10.14.p
+	 */
+	private function queryWhereParams()
+	{
+		// start to build our where clause
+		$where = [
+			'status' => ['IN', ['publish', 'sold_out']],
+		];
+		// add category
+		if ($this->events_category) {
+			$where['Term_Taxonomy.taxonomy']  = 'espresso_event_categories';
+			$where['Term_Taxonomy.Term.slug'] = $this->events_category;
+		}
+		// if NOT expired then we want events that start today or in the future
+		// if NOT show expired then we want events that start today or in the future
+		if ($this->show_expired == 0) {
+			$where['Datetime.DTT_EVT_end'] = [
+				'>=',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			];
+		}
+		// if show ONLY expired we want events that ended prior to today
+		if ($this->show_expired == 2) {
+			$where['Datetime.DTT_EVT_end'] = [
+				'<=',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			];
+		}
+		// allow $where to be filtered
+		return apply_filters('FHEE__EEW_Upcoming_Events__widget__where', $where, $this->events_category, $this->show_expired);
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function linkClass(EE_Event $event)
+	{
+		// how big is the event name ?
+		$name_length = strlen($event->name());
+		switch ($name_length) {
+			case $name_length > 70:
+				return ' three-line';
+			case $name_length > 35:
+				return ' two-line';
+		}
+		return ' one-line';
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @param string   $event_url
+	 * @return mixed|string|void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function eventWidgetContent(EE_Event $event, $event_url = '')
+	{
+		if (post_password_required($event->ID())) {
+			return apply_filters(
+				'FHEE_EEW_Upcoming_Events__widget__password_form',
+				get_the_password_form($event->ID()),
+				$event
+			);
+		}
+
+		$content = '';
+		if (has_post_thumbnail($event->ID()) && $this->image_size != 'none') {
+			$content .= '
                 <div class="ee-upcoming-events-widget-img-dv">
                     <a class="ee-upcoming-events-widget-img" href="' . $event_url . '">
                         ' . get_the_post_thumbnail($event->ID(), $this->image_size) . '
                     </a>
                 </div>';
-        }
-
-        if ($this->show_dates) {
-            $content .= $this->eventDates($event);
-        }
-
-        if ($this->show_desc) {
-            global $allowedtags;
-            $desc    = $event->short_description(25);
-            $content .= $desc ? '<p style="margin-top: .5em">' . wp_kses($desc, $allowedtags) . '</p>' : '';
-        }
-
-        return $content;
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function eventDates(EE_Event $event)
-    {
-        $date_format        = apply_filters(
-            'FHEE__espresso_event_date_range__date_format',
-            get_option('date_format')
-        );
-        $time_format        = apply_filters(
-            'FHEE__espresso_event_date_range__time_format',
-            get_option('time_format')
-        );
-        $single_date_format = apply_filters(
-            'FHEE__espresso_event_date_range__single_date_format',
-            get_option('date_format')
-        );
-        $single_time_format = apply_filters(
-            'FHEE__espresso_event_date_range__single_time_format',
-            get_option('time_format')
-        );
-        if ($this->date_range == true) {
-            return espresso_event_date_range(
-                $date_format,
-                $time_format,
-                $single_date_format,
-                $single_time_format,
-                $event->ID(),
-                false
-            );
-        }
-        return espresso_list_of_event_dates(
-            $event->ID(),
-            $date_format,
-            $time_format,
-            false,
-            null,
-            true,
-            true,
-            $this->date_limit
-        );
-    }
+		}
+
+		if ($this->show_dates) {
+			$content .= $this->eventDates($event);
+		}
+
+		if ($this->show_desc) {
+			global $allowedtags;
+			$desc    = $event->short_description(25);
+			$content .= $desc ? '<p style="margin-top: .5em">' . wp_kses($desc, $allowedtags) . '</p>' : '';
+		}
+
+		return $content;
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function eventDates(EE_Event $event)
+	{
+		$date_format        = apply_filters(
+			'FHEE__espresso_event_date_range__date_format',
+			get_option('date_format')
+		);
+		$time_format        = apply_filters(
+			'FHEE__espresso_event_date_range__time_format',
+			get_option('time_format')
+		);
+		$single_date_format = apply_filters(
+			'FHEE__espresso_event_date_range__single_date_format',
+			get_option('date_format')
+		);
+		$single_time_format = apply_filters(
+			'FHEE__espresso_event_date_range__single_time_format',
+			get_option('time_format')
+		);
+		if ($this->date_range == true) {
+			return espresso_event_date_range(
+				$date_format,
+				$time_format,
+				$single_date_format,
+				$single_time_format,
+				$event->ID(),
+				false
+			);
+		}
+		return espresso_list_of_event_dates(
+			$event->ID(),
+			$date_format,
+			$time_format,
+			false,
+			null,
+			true,
+			true,
+			$this->date_limit
+		);
+	}
 }

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/');
     }
 
 
@@ -225,7 +225,7 @@ 
     {
         global $post;
         return ((function_exists('wp_is_block_theme') && wp_is_block_theme()) || in_the_loop()) && $post->ID === (int) $id
-            ? espresso_event_status_banner($post->ID) . $title
+            ? espresso_event_status_banner($post->ID).$title
             : $title;
     }
 
@@ -382,7 +382,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;
     }
 
 
@@ -394,7 +394,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;
     }
 
 
@@ -418,7 +418,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');
     }
 
 
@@ -448,16 +448,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 +470 added lines, -470 removed lines

@@ -14,475 +14,475 @@ 
 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
-     * @throws EE_Error
-     */
-    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::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 ((function_exists('wp_is_block_theme') && wp_is_block_theme()) || 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
+	 * @throws EE_Error
+	 */
+	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::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 ((function_exists('wp_is_block_theme') && wp_is_block_theme()) || 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);
+	}
 }
 
 
@@ -494,5 +494,5 @@ 
  */
 function espresso_display_venue_in_event_details()
 {
-    return EED_Event_Single::display_venue();
+	return EED_Event_Single::display_venue();
 }

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;
@@ -227,10 +227,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
@@ -296,7 +296,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 ((function_exists('wp_is_block_theme') && wp_is_block_theme()) || in_the_loop()) && $post->ID == $id
-                ? espresso_event_status_banner($post->ID) . $title
+                ? espresso_event_status_banner($post->ID).$title
                 : $title;
         }
         return $title;
@@ -548,7 +548,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;
     }
 
 
@@ -564,7 +564,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;
     }
 
 
@@ -593,7 +593,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 +1115 added lines, -1115 removed lines

@@ -16,1110 +16,1110 @@ 
 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
-     * @throws EE_Error
-     */
-    public function initialize_template_parts(EE_Events_Archive_Config $config = null)
-    {
-        $config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
-        EEH_Autoloader::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 ((function_exists('wp_is_block_theme') && wp_is_block_theme()) || 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
-     * @throws EE_Error
-     */
-    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    array $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();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    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);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    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);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    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);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    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);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    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);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    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);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    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);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    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);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    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
+	 * @throws EE_Error
+	 */
+	public function initialize_template_parts(EE_Events_Archive_Config $config = null)
+	{
+		$config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
+		EEH_Autoloader::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 ((function_exists('wp_is_block_theme') && wp_is_block_theme()) || 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
+	 * @throws EE_Error
+	 */
+	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    array $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();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	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);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	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);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	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);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	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);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	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);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	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);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	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);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	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);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	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);
+	}
 }
 
 
@@ -1128,9 +1128,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;
 }
 
 /**
@@ -1138,7 +1138,7 @@ 
  */
 function espresso_event_list_title()
 {
-    return EED_Events_Archive::event_list_title();
+	return EED_Events_Archive::event_list_title();
 }
 
 /**
@@ -1147,7 +1147,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);
 }
 
 /**
@@ -1155,7 +1155,7 @@ 
  */
 function espresso_get_event_categories()
 {
-    return EED_Events_Archive::event_categories();
+	return EED_Events_Archive::event_categories();
 }
 
 /**
@@ -1163,7 +1163,7 @@ 
  */
 function espresso_display_full_description_in_event_list()
 {
-    return EED_Events_Archive::display_description(2);
+	return EED_Events_Archive::display_description(2);
 }
 
 /**
@@ -1171,7 +1171,7 @@ 
  */
 function espresso_display_excerpt_in_event_list()
 {
-    return EED_Events_Archive::display_description(1);
+	return EED_Events_Archive::display_description(1);
 }
 
 /**
@@ -1179,7 +1179,7 @@ 
  */
 function espresso_display_ticket_selector_in_event_list()
 {
-    return EED_Events_Archive::display_ticket_selector();
+	return EED_Events_Archive::display_ticket_selector();
 }
 
 /**
@@ -1187,7 +1187,7 @@ 
  */
 function espresso_display_venue_in_event_list()
 {
-    return EED_Events_Archive::display_venue();
+	return EED_Events_Archive::display_venue();
 }
 
 /**
@@ -1195,5 +1195,5 @@ 
  */
 function espresso_display_datetimes_in_event_list()
 {
-    return EED_Events_Archive::display_datetimes();
+	return EED_Events_Archive::display_datetimes();
 }

core/EE_Registry.core.php

Indentation +1724 added lines, -1724 removed lines

@@ -23,1729 +23,1729 @@
 class EE_Registry implements ResettableInterface
 {
 
-    /**
-     * @var EE_Registry $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Dependency_Map $_dependency_map
-     */
-    protected $_dependency_map;
-
-    /**
-     * @var Mirror
-     */
-    private $mirror;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * @var array $_class_abbreviations
-     */
-    protected $_class_abbreviations = array();
-
-    /**
-     * @var CommandBusInterface $BUS
-     */
-    public $BUS;
-
-    /**
-     * @var EE_Cart $CART
-     */
-    public $CART;
-
-    /**
-     * @var EE_Config $CFG
-     */
-    public $CFG;
-
-    /**
-     * @var EE_Network_Config $NET_CFG
-     */
-    public $NET_CFG;
-
-    /**
-     * RegistryContainer for storing library classes in
-     *
-     * @var RegistryContainer $LIB
-     */
-    public $LIB;
-
-    /**
-     * @var EE_Request_Handler $REQ
-     * @deprecated 4.10.14.p
-     */
-    public $REQ;
-
-    /**
-     * @var EE_Session $SSN
-     */
-    public $SSN;
-
-    /**
-     * @since 4.5.0
-     * @var EE_Capabilities $CAP
-     */
-    public $CAP;
-
-    /**
-     * @since 4.9.0
-     * @var EE_Message_Resource_Manager $MRM
-     */
-    public $MRM;
-
-    /**
-     * @var Registry $AssetsRegistry
-     */
-    public $AssetsRegistry;
-
-    /**
-     * RegistryContainer for holding addons which have registered themselves to work with EE core
-     *
-     * @var EE_Addon[] $addons
-     */
-    public $addons;
-
-    /**
-     * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
-     *
-     * @var EEM_Base[] $models
-     */
-    public $models = array();
-
-    /**
-     * @var EED_Module[] $modules
-     */
-    public $modules;
-
-    /**
-     * @var EES_Shortcode[] $shortcodes
-     */
-    public $shortcodes;
-
-    /**
-     * @var WP_Widget[] $widgets
-     */
-    public $widgets;
-
-    /**
-     * this is an array of all implemented model names (i.e. not the parent abstract models, or models
-     * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
-     * Keys are model "short names" (eg "Event") as used in model relations, and values are
-     * classnames (eg "EEM_Event")
-     *
-     * @var array $non_abstract_db_models
-     */
-    public $non_abstract_db_models = array();
-
-    /**
-     * internationalization for JS strings
-     *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
-     *    in js file:  var translatedString = eei18n.string_key;
-     *
-     * @var array $i18n_js_strings
-     */
-    public static $i18n_js_strings = array();
-
-    /**
-     * $main_file - path to espresso.php
-     *
-     * @var array $main_file
-     */
-    public $main_file;
-
-    /**
-     * array of ReflectionClass objects where the key is the class name
-     *
-     * @deprecated 4.9.62.p
-     * @var ReflectionClass[] $_reflectors
-     */
-    public $_reflectors;
-
-    /**
-     * boolean flag to indicate whether or not to load/save dependencies from/to the cache
-     *
-     * @var boolean $_cache_on
-     */
-    protected $_cache_on = true;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Dependency_Map|null   $dependency_map
-     * @param Mirror|null              $mirror
-     * @param ClassInterfaceCache|null $class_cache
-     * @param ObjectIdentifier|null    $object_identifier
-     * @return EE_Registry instance
-     */
-    public static function instance(
-        EE_Dependency_Map $dependency_map = null,
-        Mirror $mirror = null,
-        ClassInterfaceCache $class_cache = null,
-        ObjectIdentifier $object_identifier = null
-    ) {
-        // check if class object is instantiated
-        if (
-            ! self::$_instance instanceof EE_Registry
-            && $dependency_map instanceof EE_Dependency_Map
-            && $mirror instanceof Mirror
-            && $class_cache instanceof ClassInterfaceCache
-            && $object_identifier instanceof ObjectIdentifier
-        ) {
-            self::$_instance = new self(
-                $dependency_map,
-                $mirror,
-                $class_cache,
-                $object_identifier
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @Constructor
-     * @param  EE_Dependency_Map  $dependency_map
-     * @param Mirror              $mirror
-     * @param ClassInterfaceCache $class_cache
-     * @param ObjectIdentifier    $object_identifier
-     */
-    protected function __construct(
-        EE_Dependency_Map $dependency_map,
-        Mirror $mirror,
-        ClassInterfaceCache $class_cache,
-        ObjectIdentifier $object_identifier
-    ) {
-        $this->_dependency_map = $dependency_map;
-        $this->mirror = $mirror;
-        $this->class_cache = $class_cache;
-        $this->object_identifier = $object_identifier;
-        // $registry_container = new RegistryContainer();
-        $this->LIB = new RegistryContainer();
-        $this->addons = new RegistryContainer();
-        $this->modules = new RegistryContainer();
-        $this->shortcodes = new RegistryContainer();
-        $this->widgets = new RegistryContainer();
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
-    }
-
-
-    /**
-     * initialize
-     *
-     * @throws OutOfBoundsException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize()
-    {
-        $this->_class_abbreviations = apply_filters(
-            'FHEE__EE_Registry____construct___class_abbreviations',
-            array(
-                'EE_Config'                                       => 'CFG',
-                'EE_Session'                                      => 'SSN',
-                'EE_Capabilities'                                 => 'CAP',
-                'EE_Cart'                                         => 'CART',
-                'EE_Network_Config'                               => 'NET_CFG',
-                'EE_Request_Handler'                              => 'REQ',
-                'EE_Message_Resource_Manager'                     => 'MRM',
-                'EventEspresso\core\services\commands\CommandBus' => 'BUS',
-                'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
-            )
-        );
-        $this->load_core('Base', array(), true);
-        // add our request and response objects to the cache
-        $request_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Request'
-        );
-        $this->_set_cached_class(
-            $request_loader(),
-            'EventEspresso\core\services\request\Request'
-        );
-        $response_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Response'
-        );
-        $this->_set_cached_class(
-            $response_loader(),
-            'EventEspresso\core\services\request\Response'
-        );
-        add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
-    }
-
-
-    /**
-     * @return void
-     */
-    public function init()
-    {
-        // Get current page protocol
-        $protocol = is_ssl() ? 'https://' : 'http://';
-        // Output admin-ajax.php URL with same protocol as current page
-        self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
-        self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') && WP_DEBUG;
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function sanitize_i18n_js_strings()
-    {
-        $i18n_js_strings = (array) self::$i18n_js_strings;
-        foreach ($i18n_js_strings as $key => $value) {
-            if (is_scalar($value)) {
-                $decoded_value           = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
-                $i18n_js_strings[ $key ] = wp_strip_all_tags($decoded_value);
-            }
-        }
-        return $i18n_js_strings;
-    }
-
-
-    /**
-     * localize_i18n_js_strings
-     *
-     * @return string
-     */
-    public static function localize_i18n_js_strings()
-    {
-        $i18n_js_strings = EE_Registry::sanitize_i18n_js_strings();
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
-    }
-
-
-    /**
-     * @param mixed string | EED_Module $module
-     * @throws OutOfBoundsException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_module($module)
-    {
-        if ($module instanceof EED_Module) {
-            $module_class = get_class($module);
-            $this->modules->add($module_class, $module);
-        } else {
-            if (! class_exists('EE_Module_Request_Router', false)) {
-                $this->load_core('Module_Request_Router');
-            }
-            EE_Module_Request_Router::module_factory($module);
-        }
-    }
-
-
-    /**
-     * @param string $module_name
-     * @return mixed EED_Module | NULL
-     */
-    public function get_module($module_name = '')
-    {
-        return $this->modules->get($module_name);
-    }
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_core($class_name, $arguments = array(), $load_only = false)
-    {
-        $core_paths = apply_filters(
-            'FHEE__EE_Registry__load_core__core_paths',
-            array(
-                EE_CORE,
-                EE_ADMIN,
-                EE_CPTS,
-                EE_CORE . 'CPTs/',
-                EE_CORE . 'data_migration_scripts/',
-                EE_CORE . 'request_stack/',
-                EE_CORE . 'middleware/',
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $core_paths,
-            'EE_',
-            $class_name,
-            'core',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads service classes
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_service($class_name, $arguments = array(), $load_only = false)
-    {
-        $service_paths = apply_filters(
-            'FHEE__EE_Registry__load_service__service_paths',
-            array(
-                EE_CORE . 'services/',
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $service_paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads data_migration_scripts
-     *
-     * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
-     * @param mixed  $arguments
-     * @return EE_Data_Migration_Script_Base|mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_dms($class_name, $arguments = array())
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
-            'EE_DMS_',
-            $class_name,
-            'dms',
-            $arguments,
-            false,
-            false
-        );
-    }
-
-
-    /**
-     * loads object creating classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: attendee
-     * @param mixed  $arguments  - an array of arguments to pass to the class
-     * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
-     *                           instantiate
-     * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
-     *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
-     * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
-     *                           (default)
-     * @return EE_Base_Class | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
-    {
-        $paths = apply_filters(
-            'FHEE__EE_Registry__load_class__paths',
-            array(
-                EE_CORE,
-                EE_CLASSES,
-                EE_BUSINESS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            $from_db,
-            $cache,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads helper classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEH_Base | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_helper($class_name, $arguments = array(), $load_only = true)
-    {
-        // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
-        $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
-        // retrieve instantiated class
-        return $this->_load(
-            $helper_paths,
-            'EEH_',
-            $class_name,
-            'helper',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @param bool   $cache      whether to cache the object or not.
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
-    {
-        $paths = array(
-            EE_LIBRARIES,
-            EE_LIBRARIES . 'messages/',
-            EE_LIBRARIES . 'shortcodes/',
-            EE_LIBRARIES . 'qtips/',
-            EE_LIBRARIES . 'payment_methods/',
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'lib',
-            $arguments,
-            false,
-            $cache,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEM_Base | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_model($class_name, $arguments = array(), $load_only = false)
-    {
-        $paths = apply_filters(
-            'FHEE__EE_Registry__load_model__paths',
-            array(
-                EE_MODELS,
-                EE_CORE,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EEM_',
-            $class_name,
-            'model',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_model_class($class_name, $arguments = array(), $load_only = true)
-    {
-        $paths = array(
-            EE_MODELS . 'fields/',
-            EE_MODELS . 'helpers/',
-            EE_MODELS . 'relations/',
-            EE_MODELS . 'strategies/',
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            '',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * Determines if $model_name is the name of an actual EE model.
-     *
-     * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
-     * @return boolean
-     */
-    public function is_model_name($model_name)
-    {
-        return isset($this->models[ $model_name ]);
-    }
-
-
-    /**
-     * generic class loader
-     *
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $file_name    - file name  ie:  my_file.php, including extension
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            $path_to_file,
-            '',
-            $file_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $class_name   - full class name  ie:  My_Class
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|EE_Addon|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            $path_to_file,
-            'addon',
-            $class_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * instantiates, caches, and automatically resolves dependencies
-     * for classes that use a Fully Qualified Class Name.
-     * if the class is not capable of being loaded using PSR-4 autoloading,
-     * then you need to use one of the existing load_*() methods
-     * which can resolve the classname and filepath from the passed arguments
-     *
-     * @param bool|string $class_name   Fully Qualified Class Name
-     * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
-     * @return bool|null|mixed          null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function create(
-        $class_name = false,
-        $arguments = array(),
-        $cache = false,
-        $from_db = false,
-        $load_only = false,
-        $addon = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        $class_name = $this->class_cache->getFqnForAlias($class_name);
-        $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
-        // if a non-FQCN was passed, then
-        // verifyClassExists() might return an object
-        // or it could return null if the class just could not be found anywhere
-        if ($class_exists instanceof $class_name || $class_exists === null) {
-            // either way, return the results
-            return $class_exists;
-        }
-        $class_name = $class_exists;
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only) {
-            return true;
-        }
-        $addon = $addon ? 'addon' : '';
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }// obtain the loader method from the dependency map
-        $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
-        if ($loader instanceof Closure) {
-            $class_obj = $loader($arguments);
-        } else {
-            if ($loader && method_exists($this, $loader)) {
-                $class_obj = $this->{$loader}($class_name, $arguments);
-            } else {
-                $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
-            }
-        }
-        if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class(
-                $class_obj,
-                $class_name,
-                $addon,
-                $from_db,
-                $arguments
-            );
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-    /**
-     * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
-     *
-     * @param string|object $class_name
-     * @param array         $arguments
-     * @param int           $attempt
-     * @return mixed
-     */
-    private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1)
-    {
-        if (is_object($class_name) || class_exists($class_name)) {
-            return $class_name;
-        }
-        switch ($attempt) {
-            case 1:
-                // if it's a FQCN then maybe the class is registered with a preceding \
-                $class_name = strpos($class_name, '\\') !== false
-                    ? '\\' . ltrim($class_name, '\\')
-                    : $class_name;
-                break;
-            case 2:
-                //
-                $loader = $this->_dependency_map->class_loader($class_name);
-                if ($loader && method_exists($this, $loader)) {
-                    return $this->{$loader}($class_name, $arguments);
-                }
-                break;
-            case 3:
-            default:
-                return null;
-        }
-        $attempt++;
-        return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
-    }
-
-
-    /**
-     * instantiates, caches, and injects dependencies for classes
-     *
-     * @param array       $file_paths   an array of paths to folders to look in
-     * @param string      $class_prefix EE  or EEM or... ???
-     * @param bool|string $class_name   $class name
-     * @param string      $type         file type - core? class? helper? model?
-     * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @return bool|null|object null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _load(
-        $file_paths = array(),
-        $class_prefix = 'EE_',
-        $class_name = false,
-        $type = 'class',
-        $arguments = array(),
-        $from_db = false,
-        $cache = true,
-        $load_only = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        // strip php file extension
-        $class_name = str_replace('.php', '', trim($class_name));
-        // does the class have a prefix ?
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
-            // make sure $class_prefix is uppercase
-            $class_prefix = strtoupper(trim($class_prefix));
-            // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
-        }
-        $class_name = $this->class_cache->getFqnForAlias($class_name);
-        $class_exists = class_exists($class_name, false);
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only && $class_exists) {
-            return true;
-        }
-        $arguments = is_array($arguments) ? $arguments : array($arguments);
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
-            // get full path to file
-            $path = $this->_resolve_path($class_name, $type, $file_paths);
-            // load the file
-            $loaded = $this->_require_file($path, $class_name, $type, $file_paths);
-            // if we are only loading a file but NOT instantiating an object
-            // then return boolean for whether class was loaded or not
-            if ($load_only) {
-                return $loaded;
-            }
-            // if an object was expected but loading failed, then return nothing
-            if (! $loaded) {
-                return null;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class(
-                $class_obj,
-                $class_name,
-                $class_prefix,
-                $from_db,
-                $arguments
-            );
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $default have to specify something, but not anything that will conflict
-     * @return mixed|string
-     */
-    protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
-    {
-        return isset($this->_class_abbreviations[ $class_name ])
-            ? $this->_class_abbreviations[ $class_name ]
-            : $default;
-    }
-
-
-    /**
-     * attempts to find a cached version of the requested class
-     * by looking in the following places:
-     *        $this->{$class_abbreviation}            ie:    $this->CART
-     *        $this->{$class_name}                        ie:    $this->Some_Class
-     *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
-     *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
-     *
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param array  $arguments
-     * @return mixed
-     */
-    protected function _get_cached_class(
-        $class_name,
-        $class_prefix = '',
-        $arguments = array()
-    ) {
-        if ($class_name === 'EE_Registry') {
-            return $this;
-        }
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            return $this->{$class_abbreviation};
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            return $this->{$class_name};
-        }
-        if ($class_prefix === 'addon' && $this->addons->has($class_name)) {
-            return $this->addons->get($class_name);
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if ($this->LIB->has($object_identifier)) {
-            return $this->LIB->get($object_identifier);
-        }
-        foreach ($this->LIB as $key => $object) {
-            if (
+	/**
+	 * @var EE_Registry $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Dependency_Map $_dependency_map
+	 */
+	protected $_dependency_map;
+
+	/**
+	 * @var Mirror
+	 */
+	private $mirror;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * @var array $_class_abbreviations
+	 */
+	protected $_class_abbreviations = array();
+
+	/**
+	 * @var CommandBusInterface $BUS
+	 */
+	public $BUS;
+
+	/**
+	 * @var EE_Cart $CART
+	 */
+	public $CART;
+
+	/**
+	 * @var EE_Config $CFG
+	 */
+	public $CFG;
+
+	/**
+	 * @var EE_Network_Config $NET_CFG
+	 */
+	public $NET_CFG;
+
+	/**
+	 * RegistryContainer for storing library classes in
+	 *
+	 * @var RegistryContainer $LIB
+	 */
+	public $LIB;
+
+	/**
+	 * @var EE_Request_Handler $REQ
+	 * @deprecated 4.10.14.p
+	 */
+	public $REQ;
+
+	/**
+	 * @var EE_Session $SSN
+	 */
+	public $SSN;
+
+	/**
+	 * @since 4.5.0
+	 * @var EE_Capabilities $CAP
+	 */
+	public $CAP;
+
+	/**
+	 * @since 4.9.0
+	 * @var EE_Message_Resource_Manager $MRM
+	 */
+	public $MRM;
+
+	/**
+	 * @var Registry $AssetsRegistry
+	 */
+	public $AssetsRegistry;
+
+	/**
+	 * RegistryContainer for holding addons which have registered themselves to work with EE core
+	 *
+	 * @var EE_Addon[] $addons
+	 */
+	public $addons;
+
+	/**
+	 * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
+	 *
+	 * @var EEM_Base[] $models
+	 */
+	public $models = array();
+
+	/**
+	 * @var EED_Module[] $modules
+	 */
+	public $modules;
+
+	/**
+	 * @var EES_Shortcode[] $shortcodes
+	 */
+	public $shortcodes;
+
+	/**
+	 * @var WP_Widget[] $widgets
+	 */
+	public $widgets;
+
+	/**
+	 * this is an array of all implemented model names (i.e. not the parent abstract models, or models
+	 * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
+	 * Keys are model "short names" (eg "Event") as used in model relations, and values are
+	 * classnames (eg "EEM_Event")
+	 *
+	 * @var array $non_abstract_db_models
+	 */
+	public $non_abstract_db_models = array();
+
+	/**
+	 * internationalization for JS strings
+	 *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
+	 *    in js file:  var translatedString = eei18n.string_key;
+	 *
+	 * @var array $i18n_js_strings
+	 */
+	public static $i18n_js_strings = array();
+
+	/**
+	 * $main_file - path to espresso.php
+	 *
+	 * @var array $main_file
+	 */
+	public $main_file;
+
+	/**
+	 * array of ReflectionClass objects where the key is the class name
+	 *
+	 * @deprecated 4.9.62.p
+	 * @var ReflectionClass[] $_reflectors
+	 */
+	public $_reflectors;
+
+	/**
+	 * boolean flag to indicate whether or not to load/save dependencies from/to the cache
+	 *
+	 * @var boolean $_cache_on
+	 */
+	protected $_cache_on = true;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Dependency_Map|null   $dependency_map
+	 * @param Mirror|null              $mirror
+	 * @param ClassInterfaceCache|null $class_cache
+	 * @param ObjectIdentifier|null    $object_identifier
+	 * @return EE_Registry instance
+	 */
+	public static function instance(
+		EE_Dependency_Map $dependency_map = null,
+		Mirror $mirror = null,
+		ClassInterfaceCache $class_cache = null,
+		ObjectIdentifier $object_identifier = null
+	) {
+		// check if class object is instantiated
+		if (
+			! self::$_instance instanceof EE_Registry
+			&& $dependency_map instanceof EE_Dependency_Map
+			&& $mirror instanceof Mirror
+			&& $class_cache instanceof ClassInterfaceCache
+			&& $object_identifier instanceof ObjectIdentifier
+		) {
+			self::$_instance = new self(
+				$dependency_map,
+				$mirror,
+				$class_cache,
+				$object_identifier
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @param  EE_Dependency_Map  $dependency_map
+	 * @param Mirror              $mirror
+	 * @param ClassInterfaceCache $class_cache
+	 * @param ObjectIdentifier    $object_identifier
+	 */
+	protected function __construct(
+		EE_Dependency_Map $dependency_map,
+		Mirror $mirror,
+		ClassInterfaceCache $class_cache,
+		ObjectIdentifier $object_identifier
+	) {
+		$this->_dependency_map = $dependency_map;
+		$this->mirror = $mirror;
+		$this->class_cache = $class_cache;
+		$this->object_identifier = $object_identifier;
+		// $registry_container = new RegistryContainer();
+		$this->LIB = new RegistryContainer();
+		$this->addons = new RegistryContainer();
+		$this->modules = new RegistryContainer();
+		$this->shortcodes = new RegistryContainer();
+		$this->widgets = new RegistryContainer();
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
+	}
+
+
+	/**
+	 * initialize
+	 *
+	 * @throws OutOfBoundsException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize()
+	{
+		$this->_class_abbreviations = apply_filters(
+			'FHEE__EE_Registry____construct___class_abbreviations',
+			array(
+				'EE_Config'                                       => 'CFG',
+				'EE_Session'                                      => 'SSN',
+				'EE_Capabilities'                                 => 'CAP',
+				'EE_Cart'                                         => 'CART',
+				'EE_Network_Config'                               => 'NET_CFG',
+				'EE_Request_Handler'                              => 'REQ',
+				'EE_Message_Resource_Manager'                     => 'MRM',
+				'EventEspresso\core\services\commands\CommandBus' => 'BUS',
+				'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
+			)
+		);
+		$this->load_core('Base', array(), true);
+		// add our request and response objects to the cache
+		$request_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Request'
+		);
+		$this->_set_cached_class(
+			$request_loader(),
+			'EventEspresso\core\services\request\Request'
+		);
+		$response_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Response'
+		);
+		$this->_set_cached_class(
+			$response_loader(),
+			'EventEspresso\core\services\request\Response'
+		);
+		add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function init()
+	{
+		// Get current page protocol
+		$protocol = is_ssl() ? 'https://' : 'http://';
+		// Output admin-ajax.php URL with same protocol as current page
+		self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
+		self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') && WP_DEBUG;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function sanitize_i18n_js_strings()
+	{
+		$i18n_js_strings = (array) self::$i18n_js_strings;
+		foreach ($i18n_js_strings as $key => $value) {
+			if (is_scalar($value)) {
+				$decoded_value           = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
+				$i18n_js_strings[ $key ] = wp_strip_all_tags($decoded_value);
+			}
+		}
+		return $i18n_js_strings;
+	}
+
+
+	/**
+	 * localize_i18n_js_strings
+	 *
+	 * @return string
+	 */
+	public static function localize_i18n_js_strings()
+	{
+		$i18n_js_strings = EE_Registry::sanitize_i18n_js_strings();
+		return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+	}
+
+
+	/**
+	 * @param mixed string | EED_Module $module
+	 * @throws OutOfBoundsException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_module($module)
+	{
+		if ($module instanceof EED_Module) {
+			$module_class = get_class($module);
+			$this->modules->add($module_class, $module);
+		} else {
+			if (! class_exists('EE_Module_Request_Router', false)) {
+				$this->load_core('Module_Request_Router');
+			}
+			EE_Module_Request_Router::module_factory($module);
+		}
+	}
+
+
+	/**
+	 * @param string $module_name
+	 * @return mixed EED_Module | NULL
+	 */
+	public function get_module($module_name = '')
+	{
+		return $this->modules->get($module_name);
+	}
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_core($class_name, $arguments = array(), $load_only = false)
+	{
+		$core_paths = apply_filters(
+			'FHEE__EE_Registry__load_core__core_paths',
+			array(
+				EE_CORE,
+				EE_ADMIN,
+				EE_CPTS,
+				EE_CORE . 'CPTs/',
+				EE_CORE . 'data_migration_scripts/',
+				EE_CORE . 'request_stack/',
+				EE_CORE . 'middleware/',
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$core_paths,
+			'EE_',
+			$class_name,
+			'core',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads service classes
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_service($class_name, $arguments = array(), $load_only = false)
+	{
+		$service_paths = apply_filters(
+			'FHEE__EE_Registry__load_service__service_paths',
+			array(
+				EE_CORE . 'services/',
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$service_paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads data_migration_scripts
+	 *
+	 * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
+	 * @param mixed  $arguments
+	 * @return EE_Data_Migration_Script_Base|mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_dms($class_name, $arguments = array())
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
+			'EE_DMS_',
+			$class_name,
+			'dms',
+			$arguments,
+			false,
+			false
+		);
+	}
+
+
+	/**
+	 * loads object creating classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: attendee
+	 * @param mixed  $arguments  - an array of arguments to pass to the class
+	 * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
+	 *                           instantiate
+	 * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
+	 *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
+	 * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
+	 *                           (default)
+	 * @return EE_Base_Class | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
+	{
+		$paths = apply_filters(
+			'FHEE__EE_Registry__load_class__paths',
+			array(
+				EE_CORE,
+				EE_CLASSES,
+				EE_BUSINESS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			$from_db,
+			$cache,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads helper classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEH_Base | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_helper($class_name, $arguments = array(), $load_only = true)
+	{
+		// todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
+		$helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
+		// retrieve instantiated class
+		return $this->_load(
+			$helper_paths,
+			'EEH_',
+			$class_name,
+			'helper',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @param bool   $cache      whether to cache the object or not.
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
+	{
+		$paths = array(
+			EE_LIBRARIES,
+			EE_LIBRARIES . 'messages/',
+			EE_LIBRARIES . 'shortcodes/',
+			EE_LIBRARIES . 'qtips/',
+			EE_LIBRARIES . 'payment_methods/',
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'lib',
+			$arguments,
+			false,
+			$cache,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEM_Base | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_model($class_name, $arguments = array(), $load_only = false)
+	{
+		$paths = apply_filters(
+			'FHEE__EE_Registry__load_model__paths',
+			array(
+				EE_MODELS,
+				EE_CORE,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EEM_',
+			$class_name,
+			'model',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_model_class($class_name, $arguments = array(), $load_only = true)
+	{
+		$paths = array(
+			EE_MODELS . 'fields/',
+			EE_MODELS . 'helpers/',
+			EE_MODELS . 'relations/',
+			EE_MODELS . 'strategies/',
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * Determines if $model_name is the name of an actual EE model.
+	 *
+	 * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
+	 * @return boolean
+	 */
+	public function is_model_name($model_name)
+	{
+		return isset($this->models[ $model_name ]);
+	}
+
+
+	/**
+	 * generic class loader
+	 *
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $file_name    - file name  ie:  my_file.php, including extension
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			$path_to_file,
+			'',
+			$file_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $class_name   - full class name  ie:  My_Class
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|EE_Addon|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			$path_to_file,
+			'addon',
+			$class_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * instantiates, caches, and automatically resolves dependencies
+	 * for classes that use a Fully Qualified Class Name.
+	 * if the class is not capable of being loaded using PSR-4 autoloading,
+	 * then you need to use one of the existing load_*() methods
+	 * which can resolve the classname and filepath from the passed arguments
+	 *
+	 * @param bool|string $class_name   Fully Qualified Class Name
+	 * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
+	 * @return bool|null|mixed          null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function create(
+		$class_name = false,
+		$arguments = array(),
+		$cache = false,
+		$from_db = false,
+		$load_only = false,
+		$addon = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		$class_name = $this->class_cache->getFqnForAlias($class_name);
+		$class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
+		// if a non-FQCN was passed, then
+		// verifyClassExists() might return an object
+		// or it could return null if the class just could not be found anywhere
+		if ($class_exists instanceof $class_name || $class_exists === null) {
+			// either way, return the results
+			return $class_exists;
+		}
+		$class_name = $class_exists;
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only) {
+			return true;
+		}
+		$addon = $addon ? 'addon' : '';
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}// obtain the loader method from the dependency map
+		$loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
+		if ($loader instanceof Closure) {
+			$class_obj = $loader($arguments);
+		} else {
+			if ($loader && method_exists($this, $loader)) {
+				$class_obj = $this->{$loader}($class_name, $arguments);
+			} else {
+				$class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
+			}
+		}
+		if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class(
+				$class_obj,
+				$class_name,
+				$addon,
+				$from_db,
+				$arguments
+			);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+	/**
+	 * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
+	 *
+	 * @param string|object $class_name
+	 * @param array         $arguments
+	 * @param int           $attempt
+	 * @return mixed
+	 */
+	private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1)
+	{
+		if (is_object($class_name) || class_exists($class_name)) {
+			return $class_name;
+		}
+		switch ($attempt) {
+			case 1:
+				// if it's a FQCN then maybe the class is registered with a preceding \
+				$class_name = strpos($class_name, '\\') !== false
+					? '\\' . ltrim($class_name, '\\')
+					: $class_name;
+				break;
+			case 2:
+				//
+				$loader = $this->_dependency_map->class_loader($class_name);
+				if ($loader && method_exists($this, $loader)) {
+					return $this->{$loader}($class_name, $arguments);
+				}
+				break;
+			case 3:
+			default:
+				return null;
+		}
+		$attempt++;
+		return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
+	}
+
+
+	/**
+	 * instantiates, caches, and injects dependencies for classes
+	 *
+	 * @param array       $file_paths   an array of paths to folders to look in
+	 * @param string      $class_prefix EE  or EEM or... ???
+	 * @param bool|string $class_name   $class name
+	 * @param string      $type         file type - core? class? helper? model?
+	 * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @return bool|null|object null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _load(
+		$file_paths = array(),
+		$class_prefix = 'EE_',
+		$class_name = false,
+		$type = 'class',
+		$arguments = array(),
+		$from_db = false,
+		$cache = true,
+		$load_only = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		// strip php file extension
+		$class_name = str_replace('.php', '', trim($class_name));
+		// does the class have a prefix ?
+		if (! empty($class_prefix) && $class_prefix !== 'addon') {
+			// make sure $class_prefix is uppercase
+			$class_prefix = strtoupper(trim($class_prefix));
+			// add class prefix ONCE!!!
+			$class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+		}
+		$class_name = $this->class_cache->getFqnForAlias($class_name);
+		$class_exists = class_exists($class_name, false);
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only && $class_exists) {
+			return true;
+		}
+		$arguments = is_array($arguments) ? $arguments : array($arguments);
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// if the class doesn't already exist.. then we need to try and find the file and load it
+		if (! $class_exists) {
+			// get full path to file
+			$path = $this->_resolve_path($class_name, $type, $file_paths);
+			// load the file
+			$loaded = $this->_require_file($path, $class_name, $type, $file_paths);
+			// if we are only loading a file but NOT instantiating an object
+			// then return boolean for whether class was loaded or not
+			if ($load_only) {
+				return $loaded;
+			}
+			// if an object was expected but loading failed, then return nothing
+			if (! $loaded) {
+				return null;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class(
+				$class_obj,
+				$class_name,
+				$class_prefix,
+				$from_db,
+				$arguments
+			);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $default have to specify something, but not anything that will conflict
+	 * @return mixed|string
+	 */
+	protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
+	{
+		return isset($this->_class_abbreviations[ $class_name ])
+			? $this->_class_abbreviations[ $class_name ]
+			: $default;
+	}
+
+
+	/**
+	 * attempts to find a cached version of the requested class
+	 * by looking in the following places:
+	 *        $this->{$class_abbreviation}            ie:    $this->CART
+	 *        $this->{$class_name}                        ie:    $this->Some_Class
+	 *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
+	 *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	protected function _get_cached_class(
+		$class_name,
+		$class_prefix = '',
+		$arguments = array()
+	) {
+		if ($class_name === 'EE_Registry') {
+			return $this;
+		}
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			return $this->{$class_abbreviation};
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			return $this->{$class_name};
+		}
+		if ($class_prefix === 'addon' && $this->addons->has($class_name)) {
+			return $this->addons->get($class_name);
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if ($this->LIB->has($object_identifier)) {
+			return $this->LIB->get($object_identifier);
+		}
+		foreach ($this->LIB as $key => $object) {
+			if (
 // request does not contain new arguments and therefore no args identifier
-                ! $this->object_identifier->hasArguments($object_identifier)
-                // but previously cached class with args was found
-                && $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
-            ) {
-                return $object;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * removes a cached version of the requested class
-     *
-     * @param string  $class_name
-     * @param boolean $addon
-     * @param array   $arguments
-     * @return boolean
-     */
-    public function clear_cached_class(
-        $class_name,
-        $addon = false,
-        $arguments = array()
-    ) {
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            $this->{$class_abbreviation} = null;
-            return true;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            $this->{$class_name} = null;
-            return true;
-        }
-        if ($addon && $this->addons->has($class_name)) {
-            $this->addons->remove($class_name);
-            return true;
-        }
-        $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if ($this->LIB->has($class_name)) {
-            $this->LIB->remove($class_name);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * _set_cached_class
-     * attempts to cache the instantiated class locally
-     * in one of the following places, in the following order:
-     *        $this->{class_abbreviation}   ie:    $this->CART
-     *        $this->{$class_name}          ie:    $this->Some_Class
-     *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
-     *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
-     *
-     * @param object $class_obj
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param bool   $from_db
-     * @param array  $arguments
-     * @return void
-     */
-    protected function _set_cached_class(
-        $class_obj,
-        $class_name,
-        $class_prefix = '',
-        $from_db = false,
-        $arguments = array()
-    ) {
-        if ($class_name === 'EE_Registry' || empty($class_obj)) {
-            return;
-        }
-        // return newly instantiated class
-        $class_abbreviation = $this->get_class_abbreviation($class_name, '');
-        if ($class_abbreviation) {
-            $this->{$class_abbreviation} = $class_obj;
-            return;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (property_exists($this, $class_name)) {
-            $this->{$class_name} = $class_obj;
-            return;
-        }
-        if ($class_prefix === 'addon') {
-            $this->addons->add($class_name, $class_obj);
-            return;
-        }
-        if (! $from_db) {
-            $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-            $this->LIB->add($class_name, $class_obj);
-        }
-    }
-
-
-    /**
-     * attempts to find a full valid filepath for the requested class.
-     * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
-     * then returns that path if the target file has been found and is readable
-     *
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return string | bool
-     */
-    protected function _resolve_path($class_name, $type = '', $file_paths = array())
-    {
-        // make sure $file_paths is an array
-        $file_paths = is_array($file_paths)
-            ? $file_paths
-            : array($file_paths);
-        // cycle thru paths
-        foreach ($file_paths as $key => $file_path) {
-            // convert all separators to proper /, if no filepath, then use EE_CLASSES
-            $file_path = $file_path
-                ? str_replace(array('/', '\\'), '/', $file_path)
-                : EE_CLASSES;
-            // prep file type
-            $type = ! empty($type)
-                ? trim($type, '.') . '.'
-                : '';
-            // build full file path
-            $file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
-            // does the file exist and can be read ?
-            if (is_readable($file_paths[ $key ])) {
-                return $file_paths[ $key ];
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * basically just performs a require_once()
-     * but with some error handling
-     *
-     * @param  string $path
-     * @param  string $class_name
-     * @param  string $type
-     * @param  array  $file_paths
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _require_file($path, $class_name, $type = '', $file_paths = array())
-    {
-        $this->resolve_legacy_class_parent($class_name);
-        // don't give up! you gotta...
-        try {
-            // does the file exist and can it be read ?
-            if (! $path) {
-                // just in case the file has already been autoloaded,
-                // but discrepancies in the naming schema are preventing it from
-                // being loaded via one of the EE_Registry::load_*() methods,
-                // then let's try one last hail mary before throwing an exception
-                // and call class_exists() again, but with autoloading turned ON
-                if (class_exists($class_name)) {
-                    return true;
-                }
-                // so sorry, can't find the file
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
-                            'event_espresso'
-                        ),
-                        trim($type, '.'),
-                        $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
-                    )
-                );
-            }
-            // get the file
-            require_once($path);
-            // if the class isn't already declared somewhere
-            if (class_exists($class_name, false) === false) {
-                // so sorry, not a class
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %s file %s does not appear to contain the %s Class.',
-                            'event_espresso'
-                        ),
-                        $type,
-                        $path,
-                        $class_name
-                    )
-                );
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Some of our legacy classes that extended a parent class would simply use a require() statement
-     * before their class declaration in order to ensure that the parent class was loaded.
-     * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
-     * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
-     *
-     * @param string $class_name
-     */
-    protected function resolve_legacy_class_parent($class_name = '')
-    {
-        try {
-            $legacy_parent_class_map = array(
-                'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
-            );
-            if (isset($legacy_parent_class_map[ $class_name ])) {
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
-            }
-        } catch (Exception $exception) {
-        }
-    }
-
-
-    /**
-     * _create_object
-     * Attempts to instantiate the requested class via any of the
-     * commonly used instantiation methods employed throughout EE.
-     * The priority for instantiation is as follows:
-     *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
-     *        - model objects via their 'new_instance_from_db' method
-     *        - model objects via their 'new_instance' method
-     *        - "singleton" classes" via their 'instance' method
-     *    - standard instantiable classes via their __constructor
-     * Prior to instantiation, if the classname exists in the dependency_map,
-     * then the constructor for the requested class will be examined to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     *
-     * @param string $class_name
-     * @param array  $arguments
-     * @param string $type
-     * @param bool   $from_db
-     * @return null|object|bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
-    {
-        // create reflection
-        $reflector = $this->mirror->getReflectionClass($class_name);
-        // make sure arguments are an array
-        $arguments = is_array($arguments)
-            ? $arguments
-            : array($arguments);
-        // and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
-        $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
-            ? $arguments
-            : array($arguments);
-        // attempt to inject dependencies ?
-        if ($this->_dependency_map->has($class_name)) {
-            $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
-        }
-        // instantiate the class if possible
-        if ($reflector->isAbstract()) {
-            // nothing to instantiate, loading file was enough
-            // does not throw an exception so $instantiation_mode is unused
-            // $instantiation_mode = "1) no constructor abstract class";
-            return true;
-        }
-        if (
-            empty($arguments)
-            && $this->mirror->getConstructorFromReflection($reflector) === null
-            && $reflector->isInstantiable()
-        ) {
-            // no constructor = static methods only... nothing to instantiate, loading file was enough
-            // $instantiation_mode = "2) no constructor but instantiable";
-            return $reflector->newInstance();
-        }
-        if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
-            // $instantiation_mode = "3) new_instance_from_db()";
-            return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
-        }
-        if (method_exists($class_name, 'new_instance')) {
-            // $instantiation_mode = "4) new_instance()";
-            return call_user_func_array(array($class_name, 'new_instance'), $arguments);
-        }
-        if (method_exists($class_name, 'instance')) {
-            // $instantiation_mode = "5) instance()";
-            return call_user_func_array(array($class_name, 'instance'), $arguments);
-        }
-        if ($reflector->isInstantiable()) {
-            $args_passed_count = count($arguments);
-            $args_required_count = count($this->mirror->getRequiredParameters($class_name));
-            if ($args_passed_count < $args_required_count) {
-                throw new RuntimeException(
-                    sprintf(
-                        __(
-                            'Invalid arguments supplied for the %1$s class, %2$s were required but %3$s were passed.',
-                            'event_espresso'
-                        ),
-                        $class_name,
-                        $args_required_count,
-                        $args_passed_count
-                    )
-                );
-            }
-            // $instantiation_mode = "6) constructor";
-            return $reflector->newInstanceArgs($arguments);
-        }
-        // heh ? something's not right !
-        throw new EE_Error(
-            sprintf(
-                esc_html__('The %s file %s could not be instantiated.', 'event_espresso'),
-                $type,
-                $class_name
-            )
-        );
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    protected function _array_is_numerically_and_sequentially_indexed(array $array)
-    {
-        return ! empty($array)
-            ? array_keys($array) === range(0, count($array) - 1)
-            : true;
-    }
-
-
-    /**
-     * _resolve_dependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @param ReflectionClass $reflector
-     * @param string          $class_name
-     * @param array           $arguments
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, array $arguments = array())
-    {
-        // let's examine the constructor
-        $constructor = $this->mirror->getConstructorFromReflection($reflector);
-        // whu? huh? nothing?
-        if (! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $this->mirror->getParametersFromReflection($reflector);
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all of the constructors expected parameters
-        foreach ($params as $index => $param) {
-            try {
-                // is this a dependency for a specific class ?
-                $param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
-            } catch (ReflectionException $exception) {
-                // uh-oh... most likely a legacy class that has not been autoloaded
-                // let's try to derive the classname from what we have now
-                // and hope that the property var name is close to the class name
-                $param_class = $param->getName();
-                $param_class = str_replace('_', ' ', $param_class);
-                $param_class = ucwords($param_class);
-                $param_class = str_replace(' ', '_', $param_class);
-            }
-            // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
-            $param_class = $this->class_cache->isAlias($param_class, $class_name)
-                ? $this->class_cache->getFqnForAlias($param_class, $class_name)
-                : $param_class;
-            if (
-                // param is not even a class
-                ($param_class === null || $this->parameterIsPrimitive($param_class))
-                // and something already exists in the incoming arguments for this param
-                && array_key_exists($index, $argument_keys)
-                && array_key_exists($argument_keys[ $index ], $arguments)
-            ) {
-                // so let's skip this argument and move on to the next
-                continue;
-            }
-            if (
-                // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
-                $param_class !== null
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
-            ) {
-                // skip this argument and move on to the next
-                continue;
-            }
-            if (
-                // parameter is type hinted as a class, and should be injected
-                $param_class !== null
-                && $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
-            ) {
-                $arguments = $this->_resolve_dependency(
-                    $class_name,
-                    $param_class,
-                    $arguments,
-                    $index
-                );
-            }
-            if (empty($arguments[ $index ])) {
-                $default_value = $this->mirror->getParameterDefaultValue(
-                    $param,
-                    $class_name,
-                    $index
-                );
-                // if there's no default value, and the incoming argument is an array (albeit empty), then use that
-                $arguments[ $index ] = $default_value === null
-                                 && isset($arguments[ $index ])
-                                 && is_array($arguments[ $index ])
-                    ? $arguments[ $index ]
-                    : $default_value;
-            }
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $param_class
-     * @param array  $arguments
-     * @param mixed  $index
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
-    {
-        $dependency = null;
-        // should dependency be loaded from cache ?
-        $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
-            $class_name,
-            $param_class
-        );
-        $cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
-        // we might have a dependency...
-        // let's MAYBE try and find it in our cache if that's what's been requested
-        $cached_class = $cache_on
-            ? $this->_get_cached_class($param_class)
-            : null;
-        // and grab it if it exists
-        if ($cached_class instanceof $param_class) {
-            $dependency = $cached_class;
-        } elseif ($param_class !== $class_name) {
-            // obtain the loader method from the dependency map
-            $loader = $this->_dependency_map->class_loader($param_class);
-            // is loader a custom closure ?
-            if ($loader instanceof Closure) {
-                $dependency = $loader($arguments);
-            } else {
-                // set the cache on property for the recursive loading call
-                $this->_cache_on = $cache_on;
-                // if not, then let's try and load it via the registry
-                if ($loader && method_exists($this, $loader)) {
-                    $dependency = $this->{$loader}($param_class);
-                } else {
-                    $dependency = LoaderFactory::getLoader()->load(
-                        $param_class,
-                        array(),
-                        $cache_on
-                    );
-                }
-            }
-        }
-        // did we successfully find the correct dependency ?
-        if ($dependency instanceof $param_class) {
-            // then let's inject it into the incoming array of arguments at the correct location
-            $arguments[ $index ] = $dependency;
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
-     *
-     * @param string $classname PLEASE NOTE: the class name needs to match what's registered
-     *                          in the EE_Dependency_Map::$_class_loaders array,
-     *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
-     * @param array  $arguments
-     * @return object
-     */
-    public static function factory($classname, $arguments = array())
-    {
-        $loader = self::instance()->_dependency_map->class_loader($classname);
-        if ($loader instanceof Closure) {
-            return $loader($arguments);
-        }
-        if (method_exists(self::instance(), $loader)) {
-            return self::instance()->{$loader}($classname, $arguments);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the addon by its class name
-     *
-     * @param string $class_name
-     * @return EE_Addon
-     */
-    public function getAddon($class_name)
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->addons->{$class_name})) {
-            return $this->addons->{$class_name};
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * removes the addon from the internal cache
-     *
-     * @param string $class_name
-     * @return void
-     */
-    public function removeAddon($class_name)
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        $this->addons->remove($class_name);
-    }
-
-
-    /**
-     * Gets the addon by its name/slug (not classname. For that, just
-     * use the get_addon() method above
-     *
-     * @param string $name
-     * @return EE_Addon
-     */
-    public function get_addon_by_name($name)
-    {
-        foreach ($this->addons as $addon) {
-            if ($addon->name() === $name) {
-                return $addon;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets an array of all the registered addons, where the keys are their names.
-     * (ie, what each returns for their name() function)
-     * They're already available on EE_Registry::instance()->addons as properties,
-     * where each property's name is the addon's classname,
-     * So if you just want to get the addon by classname,
-     * OR use the get_addon() method above.
-     * PLEASE  NOTE:
-     * addons with Fully Qualified Class Names
-     * have had the namespace separators converted to underscores,
-     * so a classname like Fully\Qualified\ClassName
-     * would have been converted to Fully_Qualified_ClassName
-     *
-     * @return EE_Addon[] where the KEYS are the addon's name()
-     */
-    public function get_addons_by_name()
-    {
-        $addons = array();
-        foreach ($this->addons as $addon) {
-            $addons[ $addon->name() ] = $addon;
-        }
-        return $addons;
-    }
-
-
-    /**
-     * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
-     * a stale copy of it around
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function reset_model($model_name)
-    {
-        $model_class_name = strpos($model_name, 'EEM_') !== 0
-            ? "EEM_{$model_name}"
-            : $model_name;
-        if (! $this->LIB->has($model_class_name)) {
-            return null;
-        }
-        $model = $this->LIB->get($model_class_name);
-        if (! $model instanceof EEM_Base) {
-            return null;
-        }
-        // get that model reset it and make sure we nuke the old reference to it
-        if ($model instanceof $model_class_name && is_callable([$model_class_name, 'reset'])) {
-            $this->LIB->remove($model_class_name);
-            $this->LIB->add($model_class_name, $model->reset());
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
-                    $model_name
-                )
-            );
-        }
-        return $model;
-    }
-
-
-    /**
-     * Resets the registry.
-     * The criteria for what gets reset is based on what can be shared between sites on the same request when
-     * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
-     * - $_dependency_map
-     * - $_class_abbreviations
-     * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
-     * - $REQ:  Still on the same request so no need to change.
-     * - $CAP: There is no site specific state in the EE_Capability class.
-     * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
-     * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
-     * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
-     *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
-     *             switch or on the restore.
-     * - $modules
-     * - $shortcodes
-     * - $widgets
-     *
-     * @param boolean $hard             [deprecated]
-     * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
-     *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
-     *                                  sure if you CAN currently reinstantiate the singletons at the moment)
-     * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
-     *                                  client
-     *                                  code instead can just change the model context to a different blog id if
-     *                                  necessary
-     * @return EE_Registry
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
-    {
-        $instance = self::instance();
-        $instance->_cache_on = true;
-        // reset some "special" classes
-        EEH_Activation::reset();
-        $hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
-        $instance->CFG = EE_Config::reset($hard, $reinstantiate);
-        $instance->CART = null;
-        $instance->MRM = null;
-        // messages reset
-        EED_Messages::reset();
-        // handle of objects cached on LIB
-        foreach (array('LIB', 'modules') as $cache) {
-            foreach ($instance->{$cache} as $class_name => $class) {
-                if (self::_reset_and_unset_object($class, $reset_models)) {
-                    unset($instance->{$cache}->{$class_name});
-                }
-            }
-        }
-        return $instance;
-    }
-
-
-    /**
-     * if passed object implements ResettableInterface, then call it's reset() method
-     * if passed object implements InterminableInterface, then return false,
-     * to indicate that it should NOT be cleared from the Registry cache
-     *
-     * @param      $object
-     * @param bool $reset_models
-     * @return bool returns true if cached object should be unset
-     */
-    private static function _reset_and_unset_object($object, $reset_models)
-    {
-        if (! is_object($object)) {
-            // don't unset anything that's not an object
-            return false;
-        }
-        if ($object instanceof EED_Module) {
-            $object::reset();
-            // don't unset modules
-            return false;
-        }
-        if ($object instanceof ResettableInterface) {
-            if ($object instanceof EEM_Base) {
-                if ($reset_models) {
-                    $object->reset();
-                    return true;
-                }
-                return false;
-            }
-            $object->reset();
-            return true;
-        }
-        if (! $object instanceof InterminableInterface) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets all the custom post type models defined
-     *
-     * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
-     */
-    public function cpt_models()
-    {
-        $cpt_models = array();
-        foreach ($this->non_abstract_db_models as $short_name => $classname) {
-            if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[ $short_name ] = $classname;
-            }
-        }
-        return $cpt_models;
-    }
-
-
-    /**
-     * @return \EE_Config
-     */
-    public static function CFG()
-    {
-        return self::instance()->CFG;
-    }
-
-
-    /**
-     * @deprecated 4.9.62.p
-     * @param string $class_name
-     * @return ReflectionClass
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    public function get_ReflectionClass($class_name)
-    {
-        return $this->mirror->getReflectionClass($class_name);
-    }
-
-    private function parameterIsPrimitive(?string $param_class): bool
-    {
-        return in_array(
-            $param_class,
-            [
-                'array',
-                'bool',
-                'float',
-                'int',
-                'string',
-            ]
-        );
-    }
+				! $this->object_identifier->hasArguments($object_identifier)
+				// but previously cached class with args was found
+				&& $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
+			) {
+				return $object;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * removes a cached version of the requested class
+	 *
+	 * @param string  $class_name
+	 * @param boolean $addon
+	 * @param array   $arguments
+	 * @return boolean
+	 */
+	public function clear_cached_class(
+		$class_name,
+		$addon = false,
+		$arguments = array()
+	) {
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			$this->{$class_abbreviation} = null;
+			return true;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			$this->{$class_name} = null;
+			return true;
+		}
+		if ($addon && $this->addons->has($class_name)) {
+			$this->addons->remove($class_name);
+			return true;
+		}
+		$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if ($this->LIB->has($class_name)) {
+			$this->LIB->remove($class_name);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * _set_cached_class
+	 * attempts to cache the instantiated class locally
+	 * in one of the following places, in the following order:
+	 *        $this->{class_abbreviation}   ie:    $this->CART
+	 *        $this->{$class_name}          ie:    $this->Some_Class
+	 *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
+	 *
+	 * @param object $class_obj
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param bool   $from_db
+	 * @param array  $arguments
+	 * @return void
+	 */
+	protected function _set_cached_class(
+		$class_obj,
+		$class_name,
+		$class_prefix = '',
+		$from_db = false,
+		$arguments = array()
+	) {
+		if ($class_name === 'EE_Registry' || empty($class_obj)) {
+			return;
+		}
+		// return newly instantiated class
+		$class_abbreviation = $this->get_class_abbreviation($class_name, '');
+		if ($class_abbreviation) {
+			$this->{$class_abbreviation} = $class_obj;
+			return;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (property_exists($this, $class_name)) {
+			$this->{$class_name} = $class_obj;
+			return;
+		}
+		if ($class_prefix === 'addon') {
+			$this->addons->add($class_name, $class_obj);
+			return;
+		}
+		if (! $from_db) {
+			$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+			$this->LIB->add($class_name, $class_obj);
+		}
+	}
+
+
+	/**
+	 * attempts to find a full valid filepath for the requested class.
+	 * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
+	 * then returns that path if the target file has been found and is readable
+	 *
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return string | bool
+	 */
+	protected function _resolve_path($class_name, $type = '', $file_paths = array())
+	{
+		// make sure $file_paths is an array
+		$file_paths = is_array($file_paths)
+			? $file_paths
+			: array($file_paths);
+		// cycle thru paths
+		foreach ($file_paths as $key => $file_path) {
+			// convert all separators to proper /, if no filepath, then use EE_CLASSES
+			$file_path = $file_path
+				? str_replace(array('/', '\\'), '/', $file_path)
+				: EE_CLASSES;
+			// prep file type
+			$type = ! empty($type)
+				? trim($type, '.') . '.'
+				: '';
+			// build full file path
+			$file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
+			// does the file exist and can be read ?
+			if (is_readable($file_paths[ $key ])) {
+				return $file_paths[ $key ];
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * basically just performs a require_once()
+	 * but with some error handling
+	 *
+	 * @param  string $path
+	 * @param  string $class_name
+	 * @param  string $type
+	 * @param  array  $file_paths
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _require_file($path, $class_name, $type = '', $file_paths = array())
+	{
+		$this->resolve_legacy_class_parent($class_name);
+		// don't give up! you gotta...
+		try {
+			// does the file exist and can it be read ?
+			if (! $path) {
+				// just in case the file has already been autoloaded,
+				// but discrepancies in the naming schema are preventing it from
+				// being loaded via one of the EE_Registry::load_*() methods,
+				// then let's try one last hail mary before throwing an exception
+				// and call class_exists() again, but with autoloading turned ON
+				if (class_exists($class_name)) {
+					return true;
+				}
+				// so sorry, can't find the file
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
+							'event_espresso'
+						),
+						trim($type, '.'),
+						$class_name,
+						'<br />' . implode(',<br />', $file_paths)
+					)
+				);
+			}
+			// get the file
+			require_once($path);
+			// if the class isn't already declared somewhere
+			if (class_exists($class_name, false) === false) {
+				// so sorry, not a class
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %s file %s does not appear to contain the %s Class.',
+							'event_espresso'
+						),
+						$type,
+						$path,
+						$class_name
+					)
+				);
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Some of our legacy classes that extended a parent class would simply use a require() statement
+	 * before their class declaration in order to ensure that the parent class was loaded.
+	 * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
+	 * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
+	 *
+	 * @param string $class_name
+	 */
+	protected function resolve_legacy_class_parent($class_name = '')
+	{
+		try {
+			$legacy_parent_class_map = array(
+				'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
+			);
+			if (isset($legacy_parent_class_map[ $class_name ])) {
+				require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
+			}
+		} catch (Exception $exception) {
+		}
+	}
+
+
+	/**
+	 * _create_object
+	 * Attempts to instantiate the requested class via any of the
+	 * commonly used instantiation methods employed throughout EE.
+	 * The priority for instantiation is as follows:
+	 *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
+	 *        - model objects via their 'new_instance_from_db' method
+	 *        - model objects via their 'new_instance' method
+	 *        - "singleton" classes" via their 'instance' method
+	 *    - standard instantiable classes via their __constructor
+	 * Prior to instantiation, if the classname exists in the dependency_map,
+	 * then the constructor for the requested class will be examined to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 *
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @param string $type
+	 * @param bool   $from_db
+	 * @return null|object|bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
+	{
+		// create reflection
+		$reflector = $this->mirror->getReflectionClass($class_name);
+		// make sure arguments are an array
+		$arguments = is_array($arguments)
+			? $arguments
+			: array($arguments);
+		// and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
+		$arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
+			? $arguments
+			: array($arguments);
+		// attempt to inject dependencies ?
+		if ($this->_dependency_map->has($class_name)) {
+			$arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
+		}
+		// instantiate the class if possible
+		if ($reflector->isAbstract()) {
+			// nothing to instantiate, loading file was enough
+			// does not throw an exception so $instantiation_mode is unused
+			// $instantiation_mode = "1) no constructor abstract class";
+			return true;
+		}
+		if (
+			empty($arguments)
+			&& $this->mirror->getConstructorFromReflection($reflector) === null
+			&& $reflector->isInstantiable()
+		) {
+			// no constructor = static methods only... nothing to instantiate, loading file was enough
+			// $instantiation_mode = "2) no constructor but instantiable";
+			return $reflector->newInstance();
+		}
+		if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
+			// $instantiation_mode = "3) new_instance_from_db()";
+			return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
+		}
+		if (method_exists($class_name, 'new_instance')) {
+			// $instantiation_mode = "4) new_instance()";
+			return call_user_func_array(array($class_name, 'new_instance'), $arguments);
+		}
+		if (method_exists($class_name, 'instance')) {
+			// $instantiation_mode = "5) instance()";
+			return call_user_func_array(array($class_name, 'instance'), $arguments);
+		}
+		if ($reflector->isInstantiable()) {
+			$args_passed_count = count($arguments);
+			$args_required_count = count($this->mirror->getRequiredParameters($class_name));
+			if ($args_passed_count < $args_required_count) {
+				throw new RuntimeException(
+					sprintf(
+						__(
+							'Invalid arguments supplied for the %1$s class, %2$s were required but %3$s were passed.',
+							'event_espresso'
+						),
+						$class_name,
+						$args_required_count,
+						$args_passed_count
+					)
+				);
+			}
+			// $instantiation_mode = "6) constructor";
+			return $reflector->newInstanceArgs($arguments);
+		}
+		// heh ? something's not right !
+		throw new EE_Error(
+			sprintf(
+				esc_html__('The %s file %s could not be instantiated.', 'event_espresso'),
+				$type,
+				$class_name
+			)
+		);
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	protected function _array_is_numerically_and_sequentially_indexed(array $array)
+	{
+		return ! empty($array)
+			? array_keys($array) === range(0, count($array) - 1)
+			: true;
+	}
+
+
+	/**
+	 * _resolve_dependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @param ReflectionClass $reflector
+	 * @param string          $class_name
+	 * @param array           $arguments
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, array $arguments = array())
+	{
+		// let's examine the constructor
+		$constructor = $this->mirror->getConstructorFromReflection($reflector);
+		// whu? huh? nothing?
+		if (! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $this->mirror->getParametersFromReflection($reflector);
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all of the constructors expected parameters
+		foreach ($params as $index => $param) {
+			try {
+				// is this a dependency for a specific class ?
+				$param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
+			} catch (ReflectionException $exception) {
+				// uh-oh... most likely a legacy class that has not been autoloaded
+				// let's try to derive the classname from what we have now
+				// and hope that the property var name is close to the class name
+				$param_class = $param->getName();
+				$param_class = str_replace('_', ' ', $param_class);
+				$param_class = ucwords($param_class);
+				$param_class = str_replace(' ', '_', $param_class);
+			}
+			// BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
+			$param_class = $this->class_cache->isAlias($param_class, $class_name)
+				? $this->class_cache->getFqnForAlias($param_class, $class_name)
+				: $param_class;
+			if (
+				// param is not even a class
+				($param_class === null || $this->parameterIsPrimitive($param_class))
+				// and something already exists in the incoming arguments for this param
+				&& array_key_exists($index, $argument_keys)
+				&& array_key_exists($argument_keys[ $index ], $arguments)
+			) {
+				// so let's skip this argument and move on to the next
+				continue;
+			}
+			if (
+				// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
+				$param_class !== null
+				&& isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
+				&& $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+			) {
+				// skip this argument and move on to the next
+				continue;
+			}
+			if (
+				// parameter is type hinted as a class, and should be injected
+				$param_class !== null
+				&& $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
+			) {
+				$arguments = $this->_resolve_dependency(
+					$class_name,
+					$param_class,
+					$arguments,
+					$index
+				);
+			}
+			if (empty($arguments[ $index ])) {
+				$default_value = $this->mirror->getParameterDefaultValue(
+					$param,
+					$class_name,
+					$index
+				);
+				// if there's no default value, and the incoming argument is an array (albeit empty), then use that
+				$arguments[ $index ] = $default_value === null
+								 && isset($arguments[ $index ])
+								 && is_array($arguments[ $index ])
+					? $arguments[ $index ]
+					: $default_value;
+			}
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $param_class
+	 * @param array  $arguments
+	 * @param mixed  $index
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
+	{
+		$dependency = null;
+		// should dependency be loaded from cache ?
+		$cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
+			$class_name,
+			$param_class
+		);
+		$cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
+		// we might have a dependency...
+		// let's MAYBE try and find it in our cache if that's what's been requested
+		$cached_class = $cache_on
+			? $this->_get_cached_class($param_class)
+			: null;
+		// and grab it if it exists
+		if ($cached_class instanceof $param_class) {
+			$dependency = $cached_class;
+		} elseif ($param_class !== $class_name) {
+			// obtain the loader method from the dependency map
+			$loader = $this->_dependency_map->class_loader($param_class);
+			// is loader a custom closure ?
+			if ($loader instanceof Closure) {
+				$dependency = $loader($arguments);
+			} else {
+				// set the cache on property for the recursive loading call
+				$this->_cache_on = $cache_on;
+				// if not, then let's try and load it via the registry
+				if ($loader && method_exists($this, $loader)) {
+					$dependency = $this->{$loader}($param_class);
+				} else {
+					$dependency = LoaderFactory::getLoader()->load(
+						$param_class,
+						array(),
+						$cache_on
+					);
+				}
+			}
+		}
+		// did we successfully find the correct dependency ?
+		if ($dependency instanceof $param_class) {
+			// then let's inject it into the incoming array of arguments at the correct location
+			$arguments[ $index ] = $dependency;
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
+	 *
+	 * @param string $classname PLEASE NOTE: the class name needs to match what's registered
+	 *                          in the EE_Dependency_Map::$_class_loaders array,
+	 *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
+	 * @param array  $arguments
+	 * @return object
+	 */
+	public static function factory($classname, $arguments = array())
+	{
+		$loader = self::instance()->_dependency_map->class_loader($classname);
+		if ($loader instanceof Closure) {
+			return $loader($arguments);
+		}
+		if (method_exists(self::instance(), $loader)) {
+			return self::instance()->{$loader}($classname, $arguments);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the addon by its class name
+	 *
+	 * @param string $class_name
+	 * @return EE_Addon
+	 */
+	public function getAddon($class_name)
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->addons->{$class_name})) {
+			return $this->addons->{$class_name};
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * removes the addon from the internal cache
+	 *
+	 * @param string $class_name
+	 * @return void
+	 */
+	public function removeAddon($class_name)
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		$this->addons->remove($class_name);
+	}
+
+
+	/**
+	 * Gets the addon by its name/slug (not classname. For that, just
+	 * use the get_addon() method above
+	 *
+	 * @param string $name
+	 * @return EE_Addon
+	 */
+	public function get_addon_by_name($name)
+	{
+		foreach ($this->addons as $addon) {
+			if ($addon->name() === $name) {
+				return $addon;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets an array of all the registered addons, where the keys are their names.
+	 * (ie, what each returns for their name() function)
+	 * They're already available on EE_Registry::instance()->addons as properties,
+	 * where each property's name is the addon's classname,
+	 * So if you just want to get the addon by classname,
+	 * OR use the get_addon() method above.
+	 * PLEASE  NOTE:
+	 * addons with Fully Qualified Class Names
+	 * have had the namespace separators converted to underscores,
+	 * so a classname like Fully\Qualified\ClassName
+	 * would have been converted to Fully_Qualified_ClassName
+	 *
+	 * @return EE_Addon[] where the KEYS are the addon's name()
+	 */
+	public function get_addons_by_name()
+	{
+		$addons = array();
+		foreach ($this->addons as $addon) {
+			$addons[ $addon->name() ] = $addon;
+		}
+		return $addons;
+	}
+
+
+	/**
+	 * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
+	 * a stale copy of it around
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function reset_model($model_name)
+	{
+		$model_class_name = strpos($model_name, 'EEM_') !== 0
+			? "EEM_{$model_name}"
+			: $model_name;
+		if (! $this->LIB->has($model_class_name)) {
+			return null;
+		}
+		$model = $this->LIB->get($model_class_name);
+		if (! $model instanceof EEM_Base) {
+			return null;
+		}
+		// get that model reset it and make sure we nuke the old reference to it
+		if ($model instanceof $model_class_name && is_callable([$model_class_name, 'reset'])) {
+			$this->LIB->remove($model_class_name);
+			$this->LIB->add($model_class_name, $model->reset());
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
+					$model_name
+				)
+			);
+		}
+		return $model;
+	}
+
+
+	/**
+	 * Resets the registry.
+	 * The criteria for what gets reset is based on what can be shared between sites on the same request when
+	 * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
+	 * - $_dependency_map
+	 * - $_class_abbreviations
+	 * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
+	 * - $REQ:  Still on the same request so no need to change.
+	 * - $CAP: There is no site specific state in the EE_Capability class.
+	 * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
+	 * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
+	 * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
+	 *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
+	 *             switch or on the restore.
+	 * - $modules
+	 * - $shortcodes
+	 * - $widgets
+	 *
+	 * @param boolean $hard             [deprecated]
+	 * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
+	 *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
+	 *                                  sure if you CAN currently reinstantiate the singletons at the moment)
+	 * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
+	 *                                  client
+	 *                                  code instead can just change the model context to a different blog id if
+	 *                                  necessary
+	 * @return EE_Registry
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
+	{
+		$instance = self::instance();
+		$instance->_cache_on = true;
+		// reset some "special" classes
+		EEH_Activation::reset();
+		$hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
+		$instance->CFG = EE_Config::reset($hard, $reinstantiate);
+		$instance->CART = null;
+		$instance->MRM = null;
+		// messages reset
+		EED_Messages::reset();
+		// handle of objects cached on LIB
+		foreach (array('LIB', 'modules') as $cache) {
+			foreach ($instance->{$cache} as $class_name => $class) {
+				if (self::_reset_and_unset_object($class, $reset_models)) {
+					unset($instance->{$cache}->{$class_name});
+				}
+			}
+		}
+		return $instance;
+	}
+
+
+	/**
+	 * if passed object implements ResettableInterface, then call it's reset() method
+	 * if passed object implements InterminableInterface, then return false,
+	 * to indicate that it should NOT be cleared from the Registry cache
+	 *
+	 * @param      $object
+	 * @param bool $reset_models
+	 * @return bool returns true if cached object should be unset
+	 */
+	private static function _reset_and_unset_object($object, $reset_models)
+	{
+		if (! is_object($object)) {
+			// don't unset anything that's not an object
+			return false;
+		}
+		if ($object instanceof EED_Module) {
+			$object::reset();
+			// don't unset modules
+			return false;
+		}
+		if ($object instanceof ResettableInterface) {
+			if ($object instanceof EEM_Base) {
+				if ($reset_models) {
+					$object->reset();
+					return true;
+				}
+				return false;
+			}
+			$object->reset();
+			return true;
+		}
+		if (! $object instanceof InterminableInterface) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets all the custom post type models defined
+	 *
+	 * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
+	 */
+	public function cpt_models()
+	{
+		$cpt_models = array();
+		foreach ($this->non_abstract_db_models as $short_name => $classname) {
+			if (is_subclass_of($classname, 'EEM_CPT_Base')) {
+				$cpt_models[ $short_name ] = $classname;
+			}
+		}
+		return $cpt_models;
+	}
+
+
+	/**
+	 * @return \EE_Config
+	 */
+	public static function CFG()
+	{
+		return self::instance()->CFG;
+	}
+
+
+	/**
+	 * @deprecated 4.9.62.p
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	public function get_ReflectionClass($class_name)
+	{
+		return $this->mirror->getReflectionClass($class_name);
+	}
+
+	private function parameterIsPrimitive(?string $param_class): bool
+	{
+		return in_array(
+			$param_class,
+			[
+				'array',
+				'bool',
+				'float',
+				'int',
+				'string',
+			]
+		);
+	}
 }

Spacing +50 added lines, -50 removed lines

@@ -309,7 +309,7 @@ 
         foreach ($i18n_js_strings as $key => $value) {
             if (is_scalar($value)) {
                 $decoded_value           = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
-                $i18n_js_strings[ $key ] = wp_strip_all_tags($decoded_value);
+                $i18n_js_strings[$key] = wp_strip_all_tags($decoded_value);
             }
         }
         return $i18n_js_strings;
@@ -324,7 +324,7 @@ 
     public static function localize_i18n_js_strings()
     {
         $i18n_js_strings = EE_Registry::sanitize_i18n_js_strings();
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+        return '/* <![CDATA[ */ var eei18n = '.wp_json_encode($i18n_js_strings).'; /* ]]> */';
     }
 
 
@@ -343,7 +343,7 @@ 
             $module_class = get_class($module);
             $this->modules->add($module_class, $module);
         } else {
-            if (! class_exists('EE_Module_Request_Router', false)) {
+            if ( ! class_exists('EE_Module_Request_Router', false)) {
                 $this->load_core('Module_Request_Router');
             }
             EE_Module_Request_Router::module_factory($module);
@@ -382,10 +382,10 @@ 
                 EE_CORE,
                 EE_ADMIN,
                 EE_CPTS,
-                EE_CORE . 'CPTs/',
-                EE_CORE . 'data_migration_scripts/',
-                EE_CORE . 'request_stack/',
-                EE_CORE . 'middleware/',
+                EE_CORE.'CPTs/',
+                EE_CORE.'data_migration_scripts/',
+                EE_CORE.'request_stack/',
+                EE_CORE.'middleware/',
             )
         );
         // retrieve instantiated class
@@ -420,7 +420,7 @@ 
         $service_paths = apply_filters(
             'FHEE__EE_Registry__load_service__service_paths',
             array(
-                EE_CORE . 'services/',
+                EE_CORE.'services/',
             )
         );
         // retrieve instantiated class
@@ -555,10 +555,10 @@ 
     {
         $paths = array(
             EE_LIBRARIES,
-            EE_LIBRARIES . 'messages/',
-            EE_LIBRARIES . 'shortcodes/',
-            EE_LIBRARIES . 'qtips/',
-            EE_LIBRARIES . 'payment_methods/',
+            EE_LIBRARIES.'messages/',
+            EE_LIBRARIES.'shortcodes/',
+            EE_LIBRARIES.'qtips/',
+            EE_LIBRARIES.'payment_methods/',
         );
         // retrieve instantiated class
         return $this->_load(
@@ -626,10 +626,10 @@ 
     public function load_model_class($class_name, $arguments = array(), $load_only = true)
     {
         $paths = array(
-            EE_MODELS . 'fields/',
-            EE_MODELS . 'helpers/',
-            EE_MODELS . 'relations/',
-            EE_MODELS . 'strategies/',
+            EE_MODELS.'fields/',
+            EE_MODELS.'helpers/',
+            EE_MODELS.'relations/',
+            EE_MODELS.'strategies/',
         );
         // retrieve instantiated class
         return $this->_load(
@@ -653,7 +653,7 @@ 
      */
     public function is_model_name($model_name)
     {
-        return isset($this->models[ $model_name ]);
+        return isset($this->models[$model_name]);
     }
 
 
@@ -774,7 +774,7 @@ 
                 return $cached_class;
             }
         }// obtain the loader method from the dependency map
-        $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
+        $loader = $this->_dependency_map->class_loader($class_name); // instantiate the requested object
         if ($loader instanceof Closure) {
             $class_obj = $loader($arguments);
         } else {
@@ -816,7 +816,7 @@ 
             case 1:
                 // if it's a FQCN then maybe the class is registered with a preceding \
                 $class_name = strpos($class_name, '\\') !== false
-                    ? '\\' . ltrim($class_name, '\\')
+                    ? '\\'.ltrim($class_name, '\\')
                     : $class_name;
                 break;
             case 2:
@@ -870,11 +870,11 @@ 
         // strip php file extension
         $class_name = str_replace('.php', '', trim($class_name));
         // does the class have a prefix ?
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
+        if ( ! empty($class_prefix) && $class_prefix !== 'addon') {
             // make sure $class_prefix is uppercase
             $class_prefix = strtoupper(trim($class_prefix));
             // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+            $class_name = $class_prefix.str_replace($class_prefix, '', $class_name);
         }
         $class_name = $this->class_cache->getFqnForAlias($class_name);
         $class_exists = class_exists($class_name, false);
@@ -894,7 +894,7 @@ 
             }
         }
         // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
+        if ( ! $class_exists) {
             // get full path to file
             $path = $this->_resolve_path($class_name, $type, $file_paths);
             // load the file
@@ -905,7 +905,7 @@ 
                 return $loaded;
             }
             // if an object was expected but loading failed, then return nothing
-            if (! $loaded) {
+            if ( ! $loaded) {
                 return null;
             }
         }
@@ -933,8 +933,8 @@ 
      */
     protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
     {
-        return isset($this->_class_abbreviations[ $class_name ])
-            ? $this->_class_abbreviations[ $class_name ]
+        return isset($this->_class_abbreviations[$class_name])
+            ? $this->_class_abbreviations[$class_name]
             : $default;
     }
 
@@ -1068,7 +1068,7 @@ 
             $this->addons->add($class_name, $class_obj);
             return;
         }
-        if (! $from_db) {
+        if ( ! $from_db) {
             $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
             $this->LIB->add($class_name, $class_obj);
         }
@@ -1099,13 +1099,13 @@ 
                 : EE_CLASSES;
             // prep file type
             $type = ! empty($type)
-                ? trim($type, '.') . '.'
+                ? trim($type, '.').'.'
                 : '';
             // build full file path
-            $file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
+            $file_paths[$key] = rtrim($file_path, '/').'/'.$class_name.'.'.$type.'php';
             // does the file exist and can be read ?
-            if (is_readable($file_paths[ $key ])) {
-                return $file_paths[ $key ];
+            if (is_readable($file_paths[$key])) {
+                return $file_paths[$key];
             }
         }
         return false;
@@ -1130,7 +1130,7 @@ 
         // don't give up! you gotta...
         try {
             // does the file exist and can it be read ?
-            if (! $path) {
+            if ( ! $path) {
                 // just in case the file has already been autoloaded,
                 // but discrepancies in the naming schema are preventing it from
                 // being loaded via one of the EE_Registry::load_*() methods,
@@ -1148,7 +1148,7 @@ 
                         ),
                         trim($type, '.'),
                         $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
+                        '<br />'.implode(',<br />', $file_paths)
                     )
                 );
             }
@@ -1191,8 +1191,8 @@ 
             $legacy_parent_class_map = array(
                 'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
             );
-            if (isset($legacy_parent_class_map[ $class_name ])) {
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
+            if (isset($legacy_parent_class_map[$class_name])) {
+                require_once EE_PLUGIN_DIR_PATH.$legacy_parent_class_map[$class_name];
             }
         } catch (Exception $exception) {
         }
@@ -1340,7 +1340,7 @@ 
         // let's examine the constructor
         $constructor = $this->mirror->getConstructorFromReflection($reflector);
         // whu? huh? nothing?
-        if (! $constructor) {
+        if ( ! $constructor) {
             return $arguments;
         }
         // get constructor parameters
@@ -1370,7 +1370,7 @@ 
                 ($param_class === null || $this->parameterIsPrimitive($param_class))
                 // and something already exists in the incoming arguments for this param
                 && array_key_exists($index, $argument_keys)
-                && array_key_exists($argument_keys[ $index ], $arguments)
+                && array_key_exists($argument_keys[$index], $arguments)
             ) {
                 // so let's skip this argument and move on to the next
                 continue;
@@ -1378,8 +1378,8 @@ 
             if (
                 // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
                 $param_class !== null
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+                && $arguments[$argument_keys[$index]] instanceof $param_class
             ) {
                 // skip this argument and move on to the next
                 continue;
@@ -1396,17 +1396,17 @@ 
                     $index
                 );
             }
-            if (empty($arguments[ $index ])) {
+            if (empty($arguments[$index])) {
                 $default_value = $this->mirror->getParameterDefaultValue(
                     $param,
                     $class_name,
                     $index
                 );
                 // if there's no default value, and the incoming argument is an array (albeit empty), then use that
-                $arguments[ $index ] = $default_value === null
-                                 && isset($arguments[ $index ])
-                                 && is_array($arguments[ $index ])
-                    ? $arguments[ $index ]
+                $arguments[$index] = $default_value === null
+                                 && isset($arguments[$index])
+                                 && is_array($arguments[$index])
+                    ? $arguments[$index]
                     : $default_value;
             }
         }
@@ -1465,7 +1465,7 @@ 
         // did we successfully find the correct dependency ?
         if ($dependency instanceof $param_class) {
             // then let's inject it into the incoming array of arguments at the correct location
-            $arguments[ $index ] = $dependency;
+            $arguments[$index] = $dependency;
         }
         return $arguments;
     }
@@ -1560,7 +1560,7 @@ 
     {
         $addons = array();
         foreach ($this->addons as $addon) {
-            $addons[ $addon->name() ] = $addon;
+            $addons[$addon->name()] = $addon;
         }
         return $addons;
     }
@@ -1579,11 +1579,11 @@ 
         $model_class_name = strpos($model_name, 'EEM_') !== 0
             ? "EEM_{$model_name}"
             : $model_name;
-        if (! $this->LIB->has($model_class_name)) {
+        if ( ! $this->LIB->has($model_class_name)) {
             return null;
         }
         $model = $this->LIB->get($model_class_name);
-        if (! $model instanceof EEM_Base) {
+        if ( ! $model instanceof EEM_Base) {
             return null;
         }
         // get that model reset it and make sure we nuke the old reference to it
@@ -1670,7 +1670,7 @@ 
      */
     private static function _reset_and_unset_object($object, $reset_models)
     {
-        if (! is_object($object)) {
+        if ( ! is_object($object)) {
             // don't unset anything that's not an object
             return false;
         }
@@ -1690,7 +1690,7 @@ 
             $object->reset();
             return true;
         }
-        if (! $object instanceof InterminableInterface) {
+        if ( ! $object instanceof InterminableInterface) {
             return true;
         }
         return false;
@@ -1707,7 +1707,7 @@ 
         $cpt_models = array();
         foreach ($this->non_abstract_db_models as $short_name => $classname) {
             if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[ $short_name ] = $classname;
+                $cpt_models[$short_name] = $classname;
             }
         }
         return $cpt_models;

core/domain/services/registration/form/v1/RegistrantData.php

Indentation +351 added lines, -351 removed lines

@@ -19,355 +19,355 @@
 class RegistrantData
 {
 
-    /**
-     * @var int
-     */
-    private $attendee_counter = 0;
-
-    /**
-     * @var array
-     */
-    private $registrant_data = [];
-
-    /**
-     * @var bool
-     */
-    private $copy_primary = false;
-
-    /**
-     * @var array
-     */
-    private $required_questions = [];
-
-    /**
-     * @var EE_Registration[]
-     */
-    private $registrations = [];
-
-    /**
-     * @var EE_Answer[][]
-     */
-    private $registrant_answers = [];
-
-    /**
-     * array for tracking reg form data for the primary registrant
-     *
-     * @var array
-     */
-    private $primary_registrant_data;
-
-    /**
-     * the attendee object created for the primary registrant
-     *
-     * @var EE_Attendee
-     */
-    private $primary_registrant;
-
-
-    /**
-     * RegistrantData constructor.
-     */
-    public function __construct()
-    {
-        $this->primary_registrant_data = ['line_item_id' => null,];
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @throws EE_Error
-     */
-    public function initializeRegistrantData(EE_Registration $registration): void
-    {
-        $reg_url_link = $registration->reg_url_link();
-        $this->registrations[ $reg_url_link ] = $registration;
-        $this->registrant_answers[ $reg_url_link ] = $registration->answers();
-        $this->registrant_data[ $reg_url_link ] = [];
-        $this->attendee_counter++;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function attendeeCount(): int
-    {
-        return $this->attendee_counter;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function copyPrimary(): bool
-    {
-        return $this->copy_primary;
-    }
-
-
-    /**
-     * @param bool $copy_primary
-     */
-    public function setCopyPrimary(bool $copy_primary): void
-    {
-        $this->copy_primary = filter_var($copy_primary, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param string $reg_url_link
-     * @return array|null
-     */
-    public function getRegistrant(string $reg_url_link): ?EE_Registration
-    {
-        return $this->registrations[ $reg_url_link ] ?? null;
-    }
-
-
-    /**
-     * @param string $reg_url_link
-     * @return array|null
-     */
-    public function getRegistrantData(string $reg_url_link): ?array
-    {
-        return $this->registrant_data[ $reg_url_link ] ?? null;
-    }
-
-
-    /**
-     * @param string $reg_url_link
-     * @param string $key
-     * @param mixed $value
-     */
-    public function addRegistrantDataValue(string $reg_url_link, string $key, $value): void
-    {
-        $this->registrant_data[ $reg_url_link ][ $key ] = $value;
-    }
-
-
-    /**
-     * ensures that all attendees at least have data for first name, last name, and email address
-     *
-     * @param string $reg_url_link
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ensureCriticalRegistrantDataIsSet(string $reg_url_link): void
-    {
-        if ($this->currentRegistrantIsPrimary()) {
-            return;
-        }
-        // bare minimum critical details include first name, last name, email address
-        $critical_attendee_details = ['ATT_fname', 'ATT_lname', 'ATT_email'];
-        // add address info to critical details?
-        if (
-            apply_filters(
-                'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantData__ensureCriticalRegistrantDataIsSet',
-                false
-            )
-        ) {
-            $critical_attendee_details += [
-                'ATT_address',
-                'ATT_address2',
-                'ATT_city',
-                'STA_ID',
-                'CNT_ISO',
-                'ATT_zip',
-                'ATT_phone',
-            ];
-        }
-        foreach ($critical_attendee_details as $critical_attendee_detail) {
-            if (
-                ! isset($this->registrant_data[ $reg_url_link ][ $critical_attendee_detail ])
-                || empty($this->registrant_data[ $reg_url_link ][ $critical_attendee_detail ])
-            ) {
-                $this->registrant_data[ $reg_url_link ][ $critical_attendee_detail ] = $this->primary_registrant->get(
-                    $critical_attendee_detail
-                );
-            }
-        }
-    }
-
-
-    /**
-     * @param string $reg_url_link
-     * @param array $registrant_data
-     */
-    public function setRegistrantData(string $reg_url_link, array $registrant_data): void
-    {
-        $this->registrant_data[ $reg_url_link ] = $registrant_data;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getRequiredQuestions(): array
-    {
-        return $this->required_questions;
-    }
-
-
-    /**
-     * @param string $identifier
-     * @param string $required_question
-     */
-    public function addRequiredQuestion(string $identifier, string $required_question): void
-    {
-        $this->required_questions[ $identifier ] = $required_question;
-    }
-
-
-    /**
-     * @return EE_Answer[]
-     */
-    public function registrantAnswers(string $reg_url_link): array
-    {
-        return $this->registrant_answers[ $reg_url_link ] ?? [];
-    }
-
-
-    /**
-     * @param string $reg_url_link
-     * @param string $identifier  the answer cache ID
-     * @param EE_Answer $answer
-     */
-    public function addRegistrantAnswer(string $reg_url_link, string $identifier, EE_Answer $answer): void
-    {
-        $this->registrant_answers[ $reg_url_link ][ $identifier ] = $answer;
-    }
-
-
-    /**
-     * @param string $reg_url_link
-     * @param string $identifier
-     * @return EE_Answer|null
-     */
-    public function getRegistrantAnswer(string $reg_url_link, string $identifier): ?EE_Answer
-    {
-        return $this->registrant_answers[ $reg_url_link ][ $identifier ] ?? null;
-    }
-
-
-
-    /**
-     * @param string $reg_url_link
-     * @param string $identifier
-     * @return bool
-     */
-    public function registrantAnswerIsObject(string $reg_url_link, string $identifier): bool
-    {
-        $registrant_answer = $this->getRegistrantAnswer($reg_url_link, $identifier);
-        return $registrant_answer instanceof EE_Answer;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function primaryRegistrantData(): array
-    {
-        return $this->primary_registrant_data;
-    }
-
-
-    /**
-     * @param string $key
-     * @param mixed  $value
-     */
-    public function addPrimaryRegistrantDataValue(string $key, $value): void
-    {
-        $this->primary_registrant_data[ $key ] = $value;
-    }
-
-
-    /**
-     * @param string $key
-     * @return mixed
-     */
-    public function getPrimaryRegistrantDataValue(string $key)
-    {
-        return $this->primary_registrant_data[ $key ] ?? null;
-    }
-
-
-    /**
-     * @param array $primary_registrant_data
-     */
-    public function setPrimaryRegistrantData(array $primary_registrant_data): void
-    {
-        $this->primary_registrant_data = $primary_registrant_data;
-    }
-
-
-    /**
-     * @return EE_Attendee
-     */
-    public function primaryRegistrant(): EE_Attendee
-    {
-        return $this->primary_registrant;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function primaryRegistrantIsValid(): bool
-    {
-        return $this->primary_registrant instanceof EE_Attendee;
-    }
-
-
-    /**
-     * @param EE_Attendee $primary_registrant
-     */
-    public function setPrimaryRegistrant(EE_Attendee $primary_registrant): void
-    {
-        $this->primary_registrant = $primary_registrant;
-    }
-
-
-    /**
-     * @param string $reg_url_link
-     * @return bool
-     */
-    public function currentRegistrantIsPrimary(string $reg_url_link = ''): bool
-    {
-        return $this->attendeeCount() === 1
-            || (
-                $this->attendeeCount() === 1
-                && $reg_url_link !== ''
-                && $this->getPrimaryRegistrantDataValue('reg_url_link') === $reg_url_link
-            );
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function currentRegistrantIsNotPrimary(): bool
-    {
-        return $this->attendeeCount() > 1;
-    }
-
-
-    /**
-     * @param string $reg_url_link
-     * @param string $form_input
-     * @param mixed  $input_value
-     * @return mixed|null
-     */
-    public function saveOrCopyPrimaryRegistrantData(string $reg_url_link, string $form_input, $input_value)
-    {
-        // store a bit of data about the primary attendee
-        if (! empty($input_value) && $this->currentRegistrantIsPrimary($reg_url_link)) {
-            $this->primary_registrant_data[ $form_input ] = $input_value;
-            return $input_value;
-        }
-        // or copy value from primary if incoming value is not set
-        if ($input_value === null && $this->copyPrimary()) {
-            $input_value = $this->getPrimaryRegistrantDataValue($form_input);
-        }
-        return $input_value;
-    }
+	/**
+	 * @var int
+	 */
+	private $attendee_counter = 0;
+
+	/**
+	 * @var array
+	 */
+	private $registrant_data = [];
+
+	/**
+	 * @var bool
+	 */
+	private $copy_primary = false;
+
+	/**
+	 * @var array
+	 */
+	private $required_questions = [];
+
+	/**
+	 * @var EE_Registration[]
+	 */
+	private $registrations = [];
+
+	/**
+	 * @var EE_Answer[][]
+	 */
+	private $registrant_answers = [];
+
+	/**
+	 * array for tracking reg form data for the primary registrant
+	 *
+	 * @var array
+	 */
+	private $primary_registrant_data;
+
+	/**
+	 * the attendee object created for the primary registrant
+	 *
+	 * @var EE_Attendee
+	 */
+	private $primary_registrant;
+
+
+	/**
+	 * RegistrantData constructor.
+	 */
+	public function __construct()
+	{
+		$this->primary_registrant_data = ['line_item_id' => null,];
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @throws EE_Error
+	 */
+	public function initializeRegistrantData(EE_Registration $registration): void
+	{
+		$reg_url_link = $registration->reg_url_link();
+		$this->registrations[ $reg_url_link ] = $registration;
+		$this->registrant_answers[ $reg_url_link ] = $registration->answers();
+		$this->registrant_data[ $reg_url_link ] = [];
+		$this->attendee_counter++;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function attendeeCount(): int
+	{
+		return $this->attendee_counter;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function copyPrimary(): bool
+	{
+		return $this->copy_primary;
+	}
+
+
+	/**
+	 * @param bool $copy_primary
+	 */
+	public function setCopyPrimary(bool $copy_primary): void
+	{
+		$this->copy_primary = filter_var($copy_primary, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param string $reg_url_link
+	 * @return array|null
+	 */
+	public function getRegistrant(string $reg_url_link): ?EE_Registration
+	{
+		return $this->registrations[ $reg_url_link ] ?? null;
+	}
+
+
+	/**
+	 * @param string $reg_url_link
+	 * @return array|null
+	 */
+	public function getRegistrantData(string $reg_url_link): ?array
+	{
+		return $this->registrant_data[ $reg_url_link ] ?? null;
+	}
+
+
+	/**
+	 * @param string $reg_url_link
+	 * @param string $key
+	 * @param mixed $value
+	 */
+	public function addRegistrantDataValue(string $reg_url_link, string $key, $value): void
+	{
+		$this->registrant_data[ $reg_url_link ][ $key ] = $value;
+	}
+
+
+	/**
+	 * ensures that all attendees at least have data for first name, last name, and email address
+	 *
+	 * @param string $reg_url_link
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ensureCriticalRegistrantDataIsSet(string $reg_url_link): void
+	{
+		if ($this->currentRegistrantIsPrimary()) {
+			return;
+		}
+		// bare minimum critical details include first name, last name, email address
+		$critical_attendee_details = ['ATT_fname', 'ATT_lname', 'ATT_email'];
+		// add address info to critical details?
+		if (
+			apply_filters(
+				'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantData__ensureCriticalRegistrantDataIsSet',
+				false
+			)
+		) {
+			$critical_attendee_details += [
+				'ATT_address',
+				'ATT_address2',
+				'ATT_city',
+				'STA_ID',
+				'CNT_ISO',
+				'ATT_zip',
+				'ATT_phone',
+			];
+		}
+		foreach ($critical_attendee_details as $critical_attendee_detail) {
+			if (
+				! isset($this->registrant_data[ $reg_url_link ][ $critical_attendee_detail ])
+				|| empty($this->registrant_data[ $reg_url_link ][ $critical_attendee_detail ])
+			) {
+				$this->registrant_data[ $reg_url_link ][ $critical_attendee_detail ] = $this->primary_registrant->get(
+					$critical_attendee_detail
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $reg_url_link
+	 * @param array $registrant_data
+	 */
+	public function setRegistrantData(string $reg_url_link, array $registrant_data): void
+	{
+		$this->registrant_data[ $reg_url_link ] = $registrant_data;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getRequiredQuestions(): array
+	{
+		return $this->required_questions;
+	}
+
+
+	/**
+	 * @param string $identifier
+	 * @param string $required_question
+	 */
+	public function addRequiredQuestion(string $identifier, string $required_question): void
+	{
+		$this->required_questions[ $identifier ] = $required_question;
+	}
+
+
+	/**
+	 * @return EE_Answer[]
+	 */
+	public function registrantAnswers(string $reg_url_link): array
+	{
+		return $this->registrant_answers[ $reg_url_link ] ?? [];
+	}
+
+
+	/**
+	 * @param string $reg_url_link
+	 * @param string $identifier  the answer cache ID
+	 * @param EE_Answer $answer
+	 */
+	public function addRegistrantAnswer(string $reg_url_link, string $identifier, EE_Answer $answer): void
+	{
+		$this->registrant_answers[ $reg_url_link ][ $identifier ] = $answer;
+	}
+
+
+	/**
+	 * @param string $reg_url_link
+	 * @param string $identifier
+	 * @return EE_Answer|null
+	 */
+	public function getRegistrantAnswer(string $reg_url_link, string $identifier): ?EE_Answer
+	{
+		return $this->registrant_answers[ $reg_url_link ][ $identifier ] ?? null;
+	}
+
+
+
+	/**
+	 * @param string $reg_url_link
+	 * @param string $identifier
+	 * @return bool
+	 */
+	public function registrantAnswerIsObject(string $reg_url_link, string $identifier): bool
+	{
+		$registrant_answer = $this->getRegistrantAnswer($reg_url_link, $identifier);
+		return $registrant_answer instanceof EE_Answer;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function primaryRegistrantData(): array
+	{
+		return $this->primary_registrant_data;
+	}
+
+
+	/**
+	 * @param string $key
+	 * @param mixed  $value
+	 */
+	public function addPrimaryRegistrantDataValue(string $key, $value): void
+	{
+		$this->primary_registrant_data[ $key ] = $value;
+	}
+
+
+	/**
+	 * @param string $key
+	 * @return mixed
+	 */
+	public function getPrimaryRegistrantDataValue(string $key)
+	{
+		return $this->primary_registrant_data[ $key ] ?? null;
+	}
+
+
+	/**
+	 * @param array $primary_registrant_data
+	 */
+	public function setPrimaryRegistrantData(array $primary_registrant_data): void
+	{
+		$this->primary_registrant_data = $primary_registrant_data;
+	}
+
+
+	/**
+	 * @return EE_Attendee
+	 */
+	public function primaryRegistrant(): EE_Attendee
+	{
+		return $this->primary_registrant;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function primaryRegistrantIsValid(): bool
+	{
+		return $this->primary_registrant instanceof EE_Attendee;
+	}
+
+
+	/**
+	 * @param EE_Attendee $primary_registrant
+	 */
+	public function setPrimaryRegistrant(EE_Attendee $primary_registrant): void
+	{
+		$this->primary_registrant = $primary_registrant;
+	}
+
+
+	/**
+	 * @param string $reg_url_link
+	 * @return bool
+	 */
+	public function currentRegistrantIsPrimary(string $reg_url_link = ''): bool
+	{
+		return $this->attendeeCount() === 1
+			|| (
+				$this->attendeeCount() === 1
+				&& $reg_url_link !== ''
+				&& $this->getPrimaryRegistrantDataValue('reg_url_link') === $reg_url_link
+			);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function currentRegistrantIsNotPrimary(): bool
+	{
+		return $this->attendeeCount() > 1;
+	}
+
+
+	/**
+	 * @param string $reg_url_link
+	 * @param string $form_input
+	 * @param mixed  $input_value
+	 * @return mixed|null
+	 */
+	public function saveOrCopyPrimaryRegistrantData(string $reg_url_link, string $form_input, $input_value)
+	{
+		// store a bit of data about the primary attendee
+		if (! empty($input_value) && $this->currentRegistrantIsPrimary($reg_url_link)) {
+			$this->primary_registrant_data[ $form_input ] = $input_value;
+			return $input_value;
+		}
+		// or copy value from primary if incoming value is not set
+		if ($input_value === null && $this->copyPrimary()) {
+			$input_value = $this->getPrimaryRegistrantDataValue($form_input);
+		}
+		return $input_value;
+	}
 }

core/domain/services/registration/form/v1/RegFormDependencyHandler.php

Indentation +58 added lines, -58 removed lines

@@ -7,62 +7,62 @@
 
 class RegFormDependencyHandler extends DependencyHandler
 {
-    /**
-     * @return void
-     */
-    public function registerDependencies()
-    {
-        $reg_form_dependencies = [
-            'EventEspresso\core\domain\services\registration\form\v1\RegForm'                => [
-                null,
-                'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\RegistrantForm'         => [
-                null,
-                null,
-                null,
-                null,
-                null,
-                'EEM_Event_Question_Group' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory' => [
-                null,
-                'EEM_Answer' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionGroup'   => [
-                null,
-                null,
-                null,
-                'EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\CountryOptions'         => [
-                null,
-                'EEM_Answer'  => EE_Dependency_Map::load_from_cache,
-                'EEM_Country' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\StateOptions'           => [
-                null,
-                'EEM_State' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\RegFormHandler'         => [
-                null,
-                'EventEspresso\core\domain\services\registration\form\v1\RegistrantData'         => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\registration\form\v1\RegFormAttendeeFactory' => EE_Dependency_Map::load_from_cache,
-                'EE_Registration_Processor'                                                      => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\RegFormInputHandler'    => [
-                null,
-                null,
-                'EEM_Attendee'                                                           => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\registration\form\v1\RegistrantData' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\RegFormAttendeeFactory' => [
-                'EventEspresso\core\services\commands\CommandBus'                        => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\registration\form\v1\RegistrantData' => EE_Dependency_Map::load_from_cache,
-            ],
-        ];
-        foreach ($reg_form_dependencies as $class => $dependencies) {
-            $this->dependency_map->registerDependencies($class, $dependencies);
-        }
-    }
+	/**
+	 * @return void
+	 */
+	public function registerDependencies()
+	{
+		$reg_form_dependencies = [
+			'EventEspresso\core\domain\services\registration\form\v1\RegForm'                => [
+				null,
+				'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\RegistrantForm'         => [
+				null,
+				null,
+				null,
+				null,
+				null,
+				'EEM_Event_Question_Group' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory' => [
+				null,
+				'EEM_Answer' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionGroup'   => [
+				null,
+				null,
+				null,
+				'EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\CountryOptions'         => [
+				null,
+				'EEM_Answer'  => EE_Dependency_Map::load_from_cache,
+				'EEM_Country' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\StateOptions'           => [
+				null,
+				'EEM_State' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\RegFormHandler'         => [
+				null,
+				'EventEspresso\core\domain\services\registration\form\v1\RegistrantData'         => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\registration\form\v1\RegFormAttendeeFactory' => EE_Dependency_Map::load_from_cache,
+				'EE_Registration_Processor'                                                      => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\RegFormInputHandler'    => [
+				null,
+				null,
+				'EEM_Attendee'                                                           => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\registration\form\v1\RegistrantData' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\RegFormAttendeeFactory' => [
+				'EventEspresso\core\services\commands\CommandBus'                        => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\registration\form\v1\RegistrantData' => EE_Dependency_Map::load_from_cache,
+			],
+		];
+		foreach ($reg_form_dependencies as $class => $dependencies) {
+			$this->dependency_map->registerDependencies($class, $dependencies);
+		}
+	}
 }

core/domain/services/registration/form/v1/RegFormHandler.php

Indentation +279 added lines, -279 removed lines

@@ -18,310 +18,310 @@
 class RegFormHandler
 {
 
-    /**
-     * @var EE_Checkout
-     */
-    public $checkout;
+	/**
+	 * @var EE_Checkout
+	 */
+	public $checkout;
 
-    /**
-     * @var RegFormInputHandler
-     */
-    public $input_handler;
+	/**
+	 * @var RegFormInputHandler
+	 */
+	public $input_handler;
 
-    /**
-     * @var array
-     */
-    private $non_input_form_sections;
+	/**
+	 * @var array
+	 */
+	private $non_input_form_sections;
 
-    /**
-     * @var RegFormAttendeeFactory
-     */
-    private $attendee_factory;
+	/**
+	 * @var RegFormAttendeeFactory
+	 */
+	private $attendee_factory;
 
-    /**
-     * @var RegistrantData
-     */
-    private $registrant_data;
+	/**
+	 * @var RegistrantData
+	 */
+	private $registrant_data;
 
-    /**
-     * @var EE_Registration_Processor
-     */
-    private $registration_processor;
+	/**
+	 * @var EE_Registration_Processor
+	 */
+	private $registration_processor;
 
-    /**
-     * @var bool
-     */
-    private $valid;
+	/**
+	 * @var bool
+	 */
+	private $valid;
 
 
-    /**
-     * RegFormHandler constructor.
-     */
-    public function __construct(
-        EE_Checkout $checkout,
-        RegistrantData $registrant_data,
-        RegFormAttendeeFactory $attendee_factory,
-        EE_Registration_Processor $registration_processor
-    ) {
-        $this->checkout                = $checkout;
-        $this->registrant_data         = $registrant_data;
-        $this->attendee_factory        = $attendee_factory;
-        $this->registration_processor  = $registration_processor;
-        // reg form sections that do not contain inputs
-        $this->non_input_form_sections = [
-            'primary_registrant',
-            'additional_attendee_reg_info',
-            'spco_copy_attendee_chk',
-        ];
-        $this->initializeInputHandler();
-    }
+	/**
+	 * RegFormHandler constructor.
+	 */
+	public function __construct(
+		EE_Checkout $checkout,
+		RegistrantData $registrant_data,
+		RegFormAttendeeFactory $attendee_factory,
+		EE_Registration_Processor $registration_processor
+	) {
+		$this->checkout                = $checkout;
+		$this->registrant_data         = $registrant_data;
+		$this->attendee_factory        = $attendee_factory;
+		$this->registration_processor  = $registration_processor;
+		// reg form sections that do not contain inputs
+		$this->non_input_form_sections = [
+			'primary_registrant',
+			'additional_attendee_reg_info',
+			'spco_copy_attendee_chk',
+		];
+		$this->initializeInputHandler();
+	}
 
 
-    private function initializeInputHandler()
-    {
-        $reg_form = $this->checkout->current_step->reg_form;
-        $required_questions = $reg_form instanceof RegForm ? $reg_form->requiredQuestions() : [];
-        $this->input_handler = LoaderFactory::getShared(
-            RegFormInputHandler::class,
-            [ $this->checkout->reg_url_link, $required_questions ]
-        );
-    }
+	private function initializeInputHandler()
+	{
+		$reg_form = $this->checkout->current_step->reg_form;
+		$required_questions = $reg_form instanceof RegForm ? $reg_form->requiredQuestions() : [];
+		$this->input_handler = LoaderFactory::getShared(
+			RegFormInputHandler::class,
+			[ $this->checkout->reg_url_link, $required_questions ]
+		);
+	}
 
 
-    /**
-     * @return int
-     */
-    public function attendeeCount(): int
-    {
-        return $this->registrant_data->attendeeCount();
-    }
+	/**
+	 * @return int
+	 */
+	public function attendeeCount(): int
+	{
+		return $this->registrant_data->attendeeCount();
+	}
 
 
-    /**
-     * @return bool
-     */
-    private function isInvalid(): bool
-    {
-        $this->valid = false;
-        return $this->valid;
-    }
+	/**
+	 * @return bool
+	 */
+	private function isInvalid(): bool
+	{
+		$this->valid = false;
+		return $this->valid;
+	}
 
 
-    /**
-     * @param EE_Registration[] $registrations
-     * @param array[][]         $reg_form_data
-     * @return bool
-     * @throws EntityNotFoundException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function processRegistrations(array $registrations, array $reg_form_data): bool
-    {
-        // start off optimistic, then trip this to false if anything goes wrong
-        $this->valid = true;
-        foreach ($registrations as $registration) {
-            // verify EE_Registration object
-            if (! $this->isValidRegistration($registration)) {
-                return $this->isInvalid();
-            }
-            $reg_url_link = $registration->reg_url_link();
-            // reg_url_link exists ?
-            if (! $this->isValidRegUrlLink($reg_url_link)) {
-                return $this->isInvalid();
-            }
-            // should this registration be processed during this visit ?
-            if (! $this->checkout->visit_allows_processing_of_this_registration($registration)) {
-                continue;
-            }
-            // if NOT revisiting, then let's save the registration now,
-            // so that we have a REG_ID to use when generating other objects
-            if (! $this->checkout->revisit) {
-                $registration->save();
-            }
-            /**
-             * This allows plugins to trigger a fail on processing of a
-             * registration for any conditions they may have for it to pass.
-             *
-             * @var bool if true is returned by the plugin then the registration processing is halted.
-             */
-            if (
-                apply_filters(
-                    'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegistrations__bypass',
-                    false,
-                    $this->registrant_data->attendeeCount(),
-                    $registration,
-                    $registrations,
-                    $reg_form_data,
-                    $this
-                )
-            ) {
-                return $this->isInvalid();
-            }
+	/**
+	 * @param EE_Registration[] $registrations
+	 * @param array[][]         $reg_form_data
+	 * @return bool
+	 * @throws EntityNotFoundException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function processRegistrations(array $registrations, array $reg_form_data): bool
+	{
+		// start off optimistic, then trip this to false if anything goes wrong
+		$this->valid = true;
+		foreach ($registrations as $registration) {
+			// verify EE_Registration object
+			if (! $this->isValidRegistration($registration)) {
+				return $this->isInvalid();
+			}
+			$reg_url_link = $registration->reg_url_link();
+			// reg_url_link exists ?
+			if (! $this->isValidRegUrlLink($reg_url_link)) {
+				return $this->isInvalid();
+			}
+			// should this registration be processed during this visit ?
+			if (! $this->checkout->visit_allows_processing_of_this_registration($registration)) {
+				continue;
+			}
+			// if NOT revisiting, then let's save the registration now,
+			// so that we have a REG_ID to use when generating other objects
+			if (! $this->checkout->revisit) {
+				$registration->save();
+			}
+			/**
+			 * This allows plugins to trigger a fail on processing of a
+			 * registration for any conditions they may have for it to pass.
+			 *
+			 * @var bool if true is returned by the plugin then the registration processing is halted.
+			 */
+			if (
+				apply_filters(
+					'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegistrations__bypass',
+					false,
+					$this->registrant_data->attendeeCount(),
+					$registration,
+					$registrations,
+					$reg_form_data,
+					$this
+				)
+			) {
+				return $this->isInvalid();
+			}
 
-            // Houston, we have a registration!
-            if (! $this->processRegistration($registration, $reg_url_link, $reg_form_data)) {
-                return $this->isInvalid();
-            }
-        }
-        return $this->valid;
-    }
+			// Houston, we have a registration!
+			if (! $this->processRegistration($registration, $reg_url_link, $reg_form_data)) {
+				return $this->isInvalid();
+			}
+		}
+		return $this->valid;
+	}
 
 
-    /**
-     * @param string $reg_url_link
-     * @return bool
-     */
-    private function isValidRegUrlLink(string $reg_url_link): bool
-    {
-        if (! empty($reg_url_link)) {
-            return true;
-        }
-        EE_Error::add_error(
-            esc_html__(
-                'An invalid or missing line item ID was encountered while attempting to process the registration form.',
-                'event_espresso'
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
+	/**
+	 * @param string $reg_url_link
+	 * @return bool
+	 */
+	private function isValidRegUrlLink(string $reg_url_link): bool
+	{
+		if (! empty($reg_url_link)) {
+			return true;
+		}
+		EE_Error::add_error(
+			esc_html__(
+				'An invalid or missing line item ID was encountered while attempting to process the registration form.',
+				'event_espresso'
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
 
 
-    /**
-     * @param EE_Registration|null $registration
-     * @return bool
-     */
-    private function isValidRegistration(?EE_Registration $registration): bool
-    {
-        // verify EE_Registration object
-        if ($registration instanceof EE_Registration) {
-            return true;
-        }
-        EE_Error::add_error(
-            esc_html__(
-                'An invalid Registration object was discovered when attempting to process your registration information.',
-                'event_espresso'
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
+	/**
+	 * @param EE_Registration|null $registration
+	 * @return bool
+	 */
+	private function isValidRegistration(?EE_Registration $registration): bool
+	{
+		// verify EE_Registration object
+		if ($registration instanceof EE_Registration) {
+			return true;
+		}
+		EE_Error::add_error(
+			esc_html__(
+				'An invalid Registration object was discovered when attempting to process your registration information.',
+				'event_espresso'
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
 
 
-    /**
-     * @param EE_Registration $registration
-     * @param string          $reg_url_link
-     * @param array[][]       $reg_form_data
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processRegistration(
-        EE_Registration $registration,
-        string $reg_url_link,
-        array $reg_form_data
-    ): bool {
-        $this->registrant_data->initializeRegistrantData($registration);
-        if (! $this->processRegFormData($registration, $reg_url_link, $reg_form_data)) {
-            return false;
-        }
-        // RegFormAttendeeFactory
-        if (! $this->attendee_factory->create($registration, $reg_url_link)) {
-            return false;
-        }
-        // at this point, we should have enough details about the registrant to consider the registration
-        // NOT incomplete
-        $this->registration_processor->toggle_incomplete_registration_status_to_default(
-            $registration,
-            false,
-            new Context(
-                'spco_reg_step_attendee_information_process_registrations',
-                esc_html__(
-                    'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
-                    'event_espresso'
-                )
-            )
-        );
-        // we can also consider the TXN to not have been failed, so temporarily upgrade it's status to
-        // abandoned
-        $this->checkout->transaction->toggle_failed_transaction_status();
-        // if we've gotten this far, then let's save what we have
-        $registration->save();
-        // add relation between TXN and registration
-        $this->associateRegistrationWithTransaction($registration);
-        return true;
-    }
+	/**
+	 * @param EE_Registration $registration
+	 * @param string          $reg_url_link
+	 * @param array[][]       $reg_form_data
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processRegistration(
+		EE_Registration $registration,
+		string $reg_url_link,
+		array $reg_form_data
+	): bool {
+		$this->registrant_data->initializeRegistrantData($registration);
+		if (! $this->processRegFormData($registration, $reg_url_link, $reg_form_data)) {
+			return false;
+		}
+		// RegFormAttendeeFactory
+		if (! $this->attendee_factory->create($registration, $reg_url_link)) {
+			return false;
+		}
+		// at this point, we should have enough details about the registrant to consider the registration
+		// NOT incomplete
+		$this->registration_processor->toggle_incomplete_registration_status_to_default(
+			$registration,
+			false,
+			new Context(
+				'spco_reg_step_attendee_information_process_registrations',
+				esc_html__(
+					'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
+					'event_espresso'
+				)
+			)
+		);
+		// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to
+		// abandoned
+		$this->checkout->transaction->toggle_failed_transaction_status();
+		// if we've gotten this far, then let's save what we have
+		$registration->save();
+		// add relation between TXN and registration
+		$this->associateRegistrationWithTransaction($registration);
+		return true;
+	}
 
 
-    /**
-     * @param EE_Registration $registration
-     * @param string          $reg_url_link
-     * @param array           $reg_form_data
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processRegFormData(EE_Registration $registration, string $reg_url_link, array $reg_form_data): bool
-    {
-        if (isset($reg_form_data[ $reg_url_link ])) {
-            // do we need to copy basic info from primary attendee ?
-            $copy_primary = isset($reg_form_data[ $reg_url_link ]['additional_attendee_reg_info'])
-                                  && absint($reg_form_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0;
-            $this->registrant_data->setCopyPrimary($copy_primary);
-            // filter form input data for this registration
-            $reg_form_data[ $reg_url_link ] = (array) apply_filters(
-                'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegFormData__registrant_form_data',
-                $reg_form_data[ $reg_url_link ],
-                $registration
-            );
-            if (isset($reg_form_data['primary_attendee'])) {
-                $primary_reg_url_link = $reg_form_data['primary_attendee'] ?? '';
-                $this->registrant_data->addPrimaryRegistrantDataValue('reg_url_link', $primary_reg_url_link);
-                unset($reg_form_data['primary_attendee']);
-            }
-            // now loop through our array of valid post data && process attendee reg forms
-            foreach ($reg_form_data[ $reg_url_link ] as $form_section => $form_inputs) {
-                if (in_array($form_section, $this->non_input_form_sections, true)) {
-                    continue;
-                }
-                foreach ($form_inputs as $form_input => $input_value) {
-                    $input_processed = $this->input_handler->processFormInput(
-                        $registration,
-                        $reg_url_link,
-                        $form_input,
-                        $input_value
-                    );
-                    if (! $input_processed) {
-                        return false;
-                    }
-                }
-            }
-        }
-        return true;
-    }
+	/**
+	 * @param EE_Registration $registration
+	 * @param string          $reg_url_link
+	 * @param array           $reg_form_data
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processRegFormData(EE_Registration $registration, string $reg_url_link, array $reg_form_data): bool
+	{
+		if (isset($reg_form_data[ $reg_url_link ])) {
+			// do we need to copy basic info from primary attendee ?
+			$copy_primary = isset($reg_form_data[ $reg_url_link ]['additional_attendee_reg_info'])
+								  && absint($reg_form_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0;
+			$this->registrant_data->setCopyPrimary($copy_primary);
+			// filter form input data for this registration
+			$reg_form_data[ $reg_url_link ] = (array) apply_filters(
+				'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegFormData__registrant_form_data',
+				$reg_form_data[ $reg_url_link ],
+				$registration
+			);
+			if (isset($reg_form_data['primary_attendee'])) {
+				$primary_reg_url_link = $reg_form_data['primary_attendee'] ?? '';
+				$this->registrant_data->addPrimaryRegistrantDataValue('reg_url_link', $primary_reg_url_link);
+				unset($reg_form_data['primary_attendee']);
+			}
+			// now loop through our array of valid post data && process attendee reg forms
+			foreach ($reg_form_data[ $reg_url_link ] as $form_section => $form_inputs) {
+				if (in_array($form_section, $this->non_input_form_sections, true)) {
+					continue;
+				}
+				foreach ($form_inputs as $form_input => $input_value) {
+					$input_processed = $this->input_handler->processFormInput(
+						$registration,
+						$reg_url_link,
+						$form_input,
+						$input_value
+					);
+					if (! $input_processed) {
+						return false;
+					}
+				}
+			}
+		}
+		return true;
+	}
 
 
-    /**
-     * @param EE_Registration $registration
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function associateRegistrationWithTransaction(EE_Registration $registration)
-    {
-        // add relation to registration
-        $this->checkout->transaction->_add_relation_to($registration, 'Registration');
-        $this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
-    }
+	/**
+	 * @param EE_Registration $registration
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function associateRegistrationWithTransaction(EE_Registration $registration)
+	{
+		// add relation to registration
+		$this->checkout->transaction->_add_relation_to($registration, 'Registration');
+		$this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
+	}
 }

Spacing +16 added lines, -16 removed lines

@@ -83,7 +83,7 @@ 
         $required_questions = $reg_form instanceof RegForm ? $reg_form->requiredQuestions() : [];
         $this->input_handler = LoaderFactory::getShared(
             RegFormInputHandler::class,
-            [ $this->checkout->reg_url_link, $required_questions ]
+            [$this->checkout->reg_url_link, $required_questions]
         );
     }
 
@@ -125,21 +125,21 @@ 
         $this->valid = true;
         foreach ($registrations as $registration) {
             // verify EE_Registration object
-            if (! $this->isValidRegistration($registration)) {
+            if ( ! $this->isValidRegistration($registration)) {
                 return $this->isInvalid();
             }
             $reg_url_link = $registration->reg_url_link();
             // reg_url_link exists ?
-            if (! $this->isValidRegUrlLink($reg_url_link)) {
+            if ( ! $this->isValidRegUrlLink($reg_url_link)) {
                 return $this->isInvalid();
             }
             // should this registration be processed during this visit ?
-            if (! $this->checkout->visit_allows_processing_of_this_registration($registration)) {
+            if ( ! $this->checkout->visit_allows_processing_of_this_registration($registration)) {
                 continue;
             }
             // if NOT revisiting, then let's save the registration now,
             // so that we have a REG_ID to use when generating other objects
-            if (! $this->checkout->revisit) {
+            if ( ! $this->checkout->revisit) {
                 $registration->save();
             }
             /**
@@ -163,7 +163,7 @@ 
             }
 
             // Houston, we have a registration!
-            if (! $this->processRegistration($registration, $reg_url_link, $reg_form_data)) {
+            if ( ! $this->processRegistration($registration, $reg_url_link, $reg_form_data)) {
                 return $this->isInvalid();
             }
         }
@@ -177,7 +177,7 @@ 
      */
     private function isValidRegUrlLink(string $reg_url_link): bool
     {
-        if (! empty($reg_url_link)) {
+        if ( ! empty($reg_url_link)) {
             return true;
         }
         EE_Error::add_error(
@@ -230,11 +230,11 @@ 
         array $reg_form_data
     ): bool {
         $this->registrant_data->initializeRegistrantData($registration);
-        if (! $this->processRegFormData($registration, $reg_url_link, $reg_form_data)) {
+        if ( ! $this->processRegFormData($registration, $reg_url_link, $reg_form_data)) {
             return false;
         }
         // RegFormAttendeeFactory
-        if (! $this->attendee_factory->create($registration, $reg_url_link)) {
+        if ( ! $this->attendee_factory->create($registration, $reg_url_link)) {
             return false;
         }
         // at this point, we should have enough details about the registrant to consider the registration
@@ -271,15 +271,15 @@ 
      */
     private function processRegFormData(EE_Registration $registration, string $reg_url_link, array $reg_form_data): bool
     {
-        if (isset($reg_form_data[ $reg_url_link ])) {
+        if (isset($reg_form_data[$reg_url_link])) {
             // do we need to copy basic info from primary attendee ?
-            $copy_primary = isset($reg_form_data[ $reg_url_link ]['additional_attendee_reg_info'])
-                                  && absint($reg_form_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0;
+            $copy_primary = isset($reg_form_data[$reg_url_link]['additional_attendee_reg_info'])
+                                  && absint($reg_form_data[$reg_url_link]['additional_attendee_reg_info']) === 0;
             $this->registrant_data->setCopyPrimary($copy_primary);
             // filter form input data for this registration
-            $reg_form_data[ $reg_url_link ] = (array) apply_filters(
+            $reg_form_data[$reg_url_link] = (array) apply_filters(
                 'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegFormData__registrant_form_data',
-                $reg_form_data[ $reg_url_link ],
+                $reg_form_data[$reg_url_link],
                 $registration
             );
             if (isset($reg_form_data['primary_attendee'])) {
@@ -288,7 +288,7 @@ 
                 unset($reg_form_data['primary_attendee']);
             }
             // now loop through our array of valid post data && process attendee reg forms
-            foreach ($reg_form_data[ $reg_url_link ] as $form_section => $form_inputs) {
+            foreach ($reg_form_data[$reg_url_link] as $form_section => $form_inputs) {
                 if (in_array($form_section, $this->non_input_form_sections, true)) {
                     continue;
                 }
@@ -299,7 +299,7 @@ 
                         $form_input,
                         $input_value
                     );
-                    if (! $input_processed) {
+                    if ( ! $input_processed) {
                         return false;
                     }
                 }

core/domain/services/registration/form/v1/CountryOptions.php

Indentation +96 added lines, -96 removed lines

@@ -13,109 +13,109 @@
 
 class CountryOptions
 {
-    /**
-     * the action being performed on the current step
-     *
-     * @var string
-     */
-    public $action = '';
+	/**
+	 * the action being performed on the current step
+	 *
+	 * @var string
+	 */
+	public $action = '';
 
-    /**
-     * @var EEM_Answer
-     */
-    public $answer_model;
+	/**
+	 * @var EEM_Answer
+	 */
+	public $answer_model;
 
-    /**
-     * @var EEM_Country
-     */
-    public $country_model;
+	/**
+	 * @var EEM_Country
+	 */
+	public $country_model;
 
-    /**
-     * @var [][]
-     */
-    private $country_options = [];
+	/**
+	 * @var [][]
+	 */
+	private $country_options = [];
 
 
-    /**
-     * CountryOptions constructor.
-     *
-     * @param string      $action
-     * @param EEM_Answer  $answer_model
-     * @param EEM_Country $country_model
-     */
-    public function __construct(string $action, EEM_Answer $answer_model, EEM_Country $country_model)
-    {
-        $this->action        = $action;
-        $this->answer_model  = $answer_model;
-        $this->country_model = $country_model;
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            [$this, 'forLegacyFormInput'],
-            10,
-            4
-        );
-    }
+	/**
+	 * CountryOptions constructor.
+	 *
+	 * @param string      $action
+	 * @param EEM_Answer  $answer_model
+	 * @param EEM_Country $country_model
+	 */
+	public function __construct(string $action, EEM_Answer $answer_model, EEM_Country $country_model)
+	{
+		$this->action        = $action;
+		$this->answer_model  = $answer_model;
+		$this->country_model = $country_model;
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			[$this, 'forLegacyFormInput'],
+			10,
+			4
+		);
+	}
 
 
-    /**
-     * Gets the list of countries for the form input
-     *
-     * @param array|null           $countries_list deprecated prop from an old hook
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer deprecated prop from an old hook
-     * @return array 2d keys are country IDs, values are their names
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function forLegacyFormInput(
-        array $countries_list = null,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ): array {
-        if (! isset($this->country_options[ $this->action ])) {
-            $this->generateLegacyCountryOptions($question, $registration);
-        }
-        return $this->country_options[ $this->action ];
-    }
+	/**
+	 * Gets the list of countries for the form input
+	 *
+	 * @param array|null           $countries_list deprecated prop from an old hook
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer deprecated prop from an old hook
+	 * @return array 2d keys are country IDs, values are their names
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function forLegacyFormInput(
+		array $countries_list = null,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	): array {
+		if (! isset($this->country_options[ $this->action ])) {
+			$this->generateLegacyCountryOptions($question, $registration);
+		}
+		return $this->country_options[ $this->action ];
+	}
 
 
-    /**
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function generateLegacyCountryOptions(EE_Question $question = null, EE_Registration $registration = null)
-    {
-        // get possibly cached list of countries
-        $countries = $this->action === 'process_reg_step'
-            ? $this->country_model->get_all_countries()
-            : $this->country_model->get_all_active_countries();
-        // start with an empty option
-        $country_options = ['' => ''];
-        if (! empty($countries)) {
-            foreach ($countries as $country) {
-                if ($country instanceof EE_Country) {
-                    $country_options[ $country->ID() ] = $country->name();
-                }
-            }
-        }
-        if ($question instanceof EE_Question && $registration instanceof EE_Registration) {
-            $answer = $this->answer_model->get_one(
-                [['QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()]]
-            );
-        } else {
-            $answer = EE_Answer::new_instance();
-        }
-        $this->country_options[ $this->action ] = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_CountryOptions__generateLegacyCountryOptions__country_options',
-            $country_options,
-            $registration,
-            $question,
-            $answer,
-            $this
-        );
-    }
+	/**
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function generateLegacyCountryOptions(EE_Question $question = null, EE_Registration $registration = null)
+	{
+		// get possibly cached list of countries
+		$countries = $this->action === 'process_reg_step'
+			? $this->country_model->get_all_countries()
+			: $this->country_model->get_all_active_countries();
+		// start with an empty option
+		$country_options = ['' => ''];
+		if (! empty($countries)) {
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$country_options[ $country->ID() ] = $country->name();
+				}
+			}
+		}
+		if ($question instanceof EE_Question && $registration instanceof EE_Registration) {
+			$answer = $this->answer_model->get_one(
+				[['QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()]]
+			);
+		} else {
+			$answer = EE_Answer::new_instance();
+		}
+		$this->country_options[ $this->action ] = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_CountryOptions__generateLegacyCountryOptions__country_options',
+			$country_options,
+			$registration,
+			$question,
+			$answer,
+			$this
+		);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -74,10 +74,10 @@ 
         EE_Registration $registration = null,
         EE_Answer $answer = null
     ): array {
-        if (! isset($this->country_options[ $this->action ])) {
+        if ( ! isset($this->country_options[$this->action])) {
             $this->generateLegacyCountryOptions($question, $registration);
         }
-        return $this->country_options[ $this->action ];
+        return $this->country_options[$this->action];
     }
 
 
@@ -95,10 +95,10 @@ 
             : $this->country_model->get_all_active_countries();
         // start with an empty option
         $country_options = ['' => ''];
-        if (! empty($countries)) {
+        if ( ! empty($countries)) {
             foreach ($countries as $country) {
                 if ($country instanceof EE_Country) {
-                    $country_options[ $country->ID() ] = $country->name();
+                    $country_options[$country->ID()] = $country->name();
                 }
             }
         }
@@ -109,7 +109,7 @@ 
         } else {
             $answer = EE_Answer::new_instance();
         }
-        $this->country_options[ $this->action ] = apply_filters(
+        $this->country_options[$this->action] = apply_filters(
             'FHEE__EventEspresso_core_domain_services_registration_form_v1_CountryOptions__generateLegacyCountryOptions__country_options',
             $country_options,
             $registration,

core/domain/services/registration/form/v1/AutoCopyAttendeeInfoForm.php

Indentation +17 added lines, -17 removed lines

@@ -8,21 +8,21 @@
 class AutoCopyAttendeeInfoForm extends EE_Form_Section_HTML
 {
 
-    /**
-     * CopyAttendeeInfoForm constructor.
-     */
-    public function __construct(string $slug)
-    {
-        parent::__construct(
-            EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $slug . '/_auto_copy_attendee_info.template.php',
-                apply_filters(
-                    'FHEE__EventEspresso_core_domain_services_registration_form_v1_AutoCopyAttendeeInfoForm__construct__template_args',
-                    []
-                ),
-                true,
-                true
-            )
-        );
-    }
+	/**
+	 * CopyAttendeeInfoForm constructor.
+	 */
+	public function __construct(string $slug)
+	{
+		parent::__construct(
+			EEH_Template::locate_template(
+				SPCO_REG_STEPS_PATH . $slug . '/_auto_copy_attendee_info.template.php',
+				apply_filters(
+					'FHEE__EventEspresso_core_domain_services_registration_form_v1_AutoCopyAttendeeInfoForm__construct__template_args',
+					[]
+				),
+				true,
+				true
+			)
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     {
         parent::__construct(
             EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $slug . '/_auto_copy_attendee_info.template.php',
+                SPCO_REG_STEPS_PATH.$slug.'/_auto_copy_attendee_info.template.php',
                 apply_filters(
                     'FHEE__EventEspresso_core_domain_services_registration_form_v1_AutoCopyAttendeeInfoForm__construct__template_args',
                     []