eventespresso / event-espresso-core

core/libraries/messages/messenger/EE_Html_messenger.class.php

Indentation +545 added lines, -545 removed lines

@@ -12,549 +12,549 @@
  */
 class EE_Html_messenger extends EE_messenger
 {
-    /**
-     * The following are the properties that this messenger requires for displaying the html
-     */
-    /**
-     * This is the html body generated by the template via the message type.
-     *
-     * @var string
-     */
-    protected $_content = '';
-
-    /**
-     * This is for the page title that gets displayed.  (Why use "subject"?  Because the "title" tag in html is
-     * equivalent to the "subject" of the page.
-     *
-     * @var string
-     */
-    protected $_subject = '';
-
-
-    /**
-     * EE_Html_messenger constructor.
-     */
-    public function __construct()
-    {
-        // set properties
-        $this->name                = 'html';
-        $this->description         = esc_html__(
-            'This messenger outputs a message to a browser for display.',
-            'event_espresso'
-        );
-        $this->label               = [
-            'singular' => esc_html__('html', 'event_espresso'),
-            'plural'   => esc_html__('html', 'event_espresso'),
-        ];
-        $this->activate_on_install = true;
-        // add the "powered by EE" credit link to the HTML receipt and invoice
-        add_filter(
-            'FHEE__EE_Html_messenger___send_message__main_body',
-            [$this, 'add_powered_by_credit_link_to_receipt_and_invoice'],
-            10,
-            3
-        );
-        parent::__construct();
-    }
-
-
-    /**
-     * HTML Messenger desires execution immediately.
-     *
-     * @return bool
-     * @since  4.9.0
-     * @see    parent::send_now() for documentation.
-     */
-    public function send_now(): bool
-    {
-        return true;
-    }
-
-
-    /**
-     * HTML Messenger allows an empty to field.
-     *
-     * @return bool
-     * @since  4.9.0
-     * @see    parent::allow_empty_to_field() for documentation
-     */
-    public function allow_empty_to_field(): bool
-    {
-        return true;
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = ['events_edit' => true];
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $this->_valid_shortcodes = [];
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_validator_config()
-    {
-        $this->_validator_config = [
-            'subject'                       => [
-                'shortcodes' => ['organization', 'primary_registration_details', 'email', 'transaction'],
-            ],
-            'content'                       => [
-                'shortcodes' => [
-                    'organization',
-                    'primary_registration_list',
-                    'primary_registration_details',
-                    'email',
-                    'transaction',
-                    'event_list',
-                    'payment_list',
-                    'venue',
-                    'line_item_list',
-                    'messenger',
-                    'ticket_list',
-                ],
-            ],
-            'event_list'                    => [
-                'shortcodes' => [
-                    'event',
-                    'ticket_list',
-                    'venue',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                ],
-                'required'   => ['[EVENT_LIST]'],
-            ],
-            'ticket_list'                   => [
-                'shortcodes' => [
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'line_item_list',
-                    'venue',
-                ],
-                'required'   => ['[TICKET_LIST]'],
-            ],
-            'ticket_line_item_no_pms'       => [
-                'shortcodes' => ['line_item', 'ticket'],
-                'required'   => ['[TICKET_LINE_ITEM_LIST]'],
-            ],
-            'ticket_line_item_pms'          => [
-                'shortcodes' => ['line_item', 'ticket', 'line_item_list'],
-                'required'   => ['[TICKET_LINE_ITEM_LIST]'],
-            ],
-            'price_modifier_line_item_list' => [
-                'shortcodes' => ['line_item'],
-                'required'   => ['[PRICE_MODIFIER_LINE_ITEM_LIST]'],
-            ],
-            'datetime_list'                 => [
-                'shortcodes' => ['datetime'],
-                'required'   => ['[DATETIME_LIST]'],
-            ],
-            'attendee_list'                 => [
-                'shortcodes' => ['attendee'],
-                'required'   => ['[ATTENDEE_LIST]'],
-            ],
-            'tax_line_item_list'            => [
-                'shortcodes' => ['line_item'],
-                'required'   => ['[TAX_LINE_ITEM_LIST]'],
-            ],
-            'additional_line_item_list'     => [
-                'shortcodes' => ['line_item'],
-                'required'   => ['[ADDITIONAL_LINE_ITEM_LIST]'],
-            ],
-            'payment_list'                  => [
-                'shortcodes' => ['payment'],
-                'required'   => ['[PAYMENT_LIST_*]'],
-            ],
-        ];
-    }
-
-
-    /**
-     * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger
-     * is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary
-     * (i.e. swap out css files or something else).
-     *
-     * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
-     * @return void
-     * @since 4.5.0
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name === 'pdf') {
-            add_filter('EE_messenger__get_variation__variation', [$this, 'add_html_css'], 10, 8);
-        }
-    }
-
-
-    /**
-     * @param                            $variation_path
-     * @param EE_Messages_Template_Pack  $template_pack
-     * @param                            $messenger_name
-     * @param                            $message_type_name
-     * @param                            $url
-     * @param                            $type
-     * @param                            $variation
-     * @param                            $skip_filters
-     * @return string
-     */
-    public function add_html_css(
-        $variation_path,
-        EE_Messages_Template_Pack $template_pack,
-        $messenger_name,
-        $message_type_name,
-        $url,
-        $type,
-        $variation,
-        $skip_filters
-    ): string {
-        return $template_pack->get_variation(
-            $this->name,
-            $message_type_name,
-            $type,
-            $variation,
-            $url,
-            '.css',
-            $skip_filters
-        );
-    }
-
-
-    /**
-     * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this
-     * messenger can add their own js.
-     *
-     * @return void.
-     */
-    public function enqueue_scripts_styles()
-    {
-        parent::enqueue_scripts_styles();
-        do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles');
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger
-        // but will get used by a messenger field for shortcode replacement
-        // get added to the 'extra' key in an associated array
-        // indexed by the messenger field they relate to.
-        // This is important for the Messages_admin to know what fields to display to the user.
-        // Also, notice that the "values" are equal to the field type
-        // that messages admin will use to know what kind of field to display.
-        // The values ALSO have one index labeled "shortcode".
-        // The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE])
-        // is required in order for this extra field to be displayed.
-        //  If the required shortcode isn't part of the shortcodes array
-        // then the field is not needed and will not be displayed/parsed.
-        $this->_template_fields = [
-            'subject' => [
-                'input'      => 'text',
-                'label'      => esc_html__('Page Title', 'event_espresso'),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ],
-            'content' => '',
-            // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra'   => [
-                'content' => [
-                    'main'                          => [
-                        'input'      => 'wp_editor',
-                        'label'      => esc_html__('Main Content', 'event_espresso'),
-                        'type'       => 'string',
-                        'required'   => true,
-                        'validation' => true,
-                        'format'     => '%s',
-                        'rows'       => '15',
-                    ],
-                    'event_list'                    => [
-                        'input'               => 'wp_editor',
-                        'label'               => '[EVENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'rows'                => '15',
-                        'shortcodes_required' => ['[EVENT_LIST]'],
-                    ],
-                    'ticket_list'                   => [
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => ['[TICKET_LIST]'],
-                    ],
-                    'ticket_line_item_no_pms'       => [
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
-                            'Ticket Line Item List with no Price Modifiers',
-                            'event_espresso'
-                        ),
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[TICKET_LINE_ITEM_LIST]'],
-                    ],
-                    'ticket_line_item_pms'          => [
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
-                            'Ticket Line Item List with Price Modifiers',
-                            'event_espresso'
-                        ),
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[TICKET_LINE_ITEM_LIST]'],
-                    ],
-                    'price_modifier_line_item_list' => [
-                        'input'               => 'textarea',
-                        'label'               => '[PRICE_MODIFIER_LINE_ITEM_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[PRICE_MODIFIER_LINE_ITEM_LIST]'],
-                    ],
-                    'datetime_list'                 => [
-                        'input'               => 'textarea',
-                        'label'               => '[DATETIME_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[DATETIME_LIST]'],
-                    ],
-                    'attendee_list'                 => [
-                        'input'               => 'textarea',
-                        'label'               => '[ATTENDEE_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[ATTENDEE_LIST]'],
-                    ],
-                    'tax_line_item_list'            => [
-                        'input'               => 'textarea',
-                        'label'               => '[TAX_LINE_ITEM_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[TAX_LINE_ITEM_LIST]'],
-                    ],
-                    'additional_line_item_list'     => [
-                        'input'               => 'textarea',
-                        'label'               => '[ADDITIONAL_LINE_ITEM_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[ADDITIONAL_LINE_ITEM_LIST]'],
-                    ],
-                    'payment_list'                  => [
-                        'input'               => 'textarea',
-                        'label'               => '[PAYMENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[PAYMENT_LIST_*]'],
-                    ],
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * @see   definition of this method in parent
-     * @since 4.5.0
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = ['receipt', 'invoice'];
-    }
-
-
-    /**
-     * @see   definition of this method in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = ['receipt', 'invoice'];
-    }
-
-
-    /**
-     * Displays the message in the browser.
-     *
-     * @return void.
-     * @since 4.5.0
-     */
-    protected function _send_message()
-    {
-        $this->_template_args = [
-            'page_title' => $this->_subject,
-            'base_css'   => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'base',
-                $this->_variation
-            ),
-            'print_css'  => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'print',
-                $this->_variation
-            ),
-            'main_css'   => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'main',
-                $this->_variation
-            ),
-            'main_body'  => wpautop(
-                apply_filters(
-                    'FHEE__EE_Html_messenger___send_message__main_body',
-                    $this->_content,
-                    $this->_content,
-                    $this->_incoming_message_type
-                )
-            ),
-        ];
-        $this->_deregister_wp_hooks();
-        add_action('wp_enqueue_scripts', [$this, 'enqueue_scripts_styles']);
-        echo '<!doctype html>' . wp_kses($this->_get_main_template(), AllowedTags::getWithFullTags());
-        exit();
-    }
-
-
-    /**
-     * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't
-     * interfere with our templates.  If users want to add any custom styles or scripts they must use the
-     * AHEE__EE_Html_messenger__enqueue_scripts_styles hook.
-     *
-     * @return void
-     * @since 4.5.0
-     */
-    protected function _deregister_wp_hooks()
-    {
-        remove_all_actions('wp_head');
-        remove_all_actions('wp_footer');
-        remove_all_actions('wp_print_footer_scripts');
-        remove_all_actions('wp_enqueue_scripts');
-        global $wp_scripts, $wp_styles;
-        $wp_scripts = $wp_styles = [];
-        // just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
-        add_action('wp_footer', 'wp_print_footer_scripts');
-        add_action('wp_print_footer_scripts', '_wp_footer_scripts');
-        add_action('wp_head', 'wp_enqueue_scripts');
-    }
-
-
-    /**
-     * Overwrite parent _get_main_template for display_html purposes.
-     *
-     * @param bool $preview
-     * @return string
-     * @since  4.5.0
-     */
-    protected function _get_main_template($preview = false): string
-    {
-        $wrapper_template = $this->_tmp_pack->get_wrapper($this->name);
-        // include message type as a template arg
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _preview()
-    {
-        $this->_send_message();
-    }
-
-
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-
-    /**
-     * add the "powered by EE" credit link to the HTML receipt and invoice
-     *
-     * @param string          $content
-     * @param string          $content_again
-     * @param EE_message_type $incoming_message_type
-     * @return string
-     */
-    public function add_powered_by_credit_link_to_receipt_and_invoice(
-        string $content,
-        string $content_again,
-        EE_message_type $incoming_message_type
-    ): string {
-        if (
-            ($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt')
-            && apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true)
-        ) {
-            $content .= EEH_Template::powered_by_event_espresso(
-                'aln-cntr',
-                '',
-                ['utm_content' => 'messages_system']
-            ) . EEH_HTML::div(EEH_HTML::p('&nbsp;'));
-        }
-        return $content;
-    }
+	/**
+	 * The following are the properties that this messenger requires for displaying the html
+	 */
+	/**
+	 * This is the html body generated by the template via the message type.
+	 *
+	 * @var string
+	 */
+	protected $_content = '';
+
+	/**
+	 * This is for the page title that gets displayed.  (Why use "subject"?  Because the "title" tag in html is
+	 * equivalent to the "subject" of the page.
+	 *
+	 * @var string
+	 */
+	protected $_subject = '';
+
+
+	/**
+	 * EE_Html_messenger constructor.
+	 */
+	public function __construct()
+	{
+		// set properties
+		$this->name                = 'html';
+		$this->description         = esc_html__(
+			'This messenger outputs a message to a browser for display.',
+			'event_espresso'
+		);
+		$this->label               = [
+			'singular' => esc_html__('html', 'event_espresso'),
+			'plural'   => esc_html__('html', 'event_espresso'),
+		];
+		$this->activate_on_install = true;
+		// add the "powered by EE" credit link to the HTML receipt and invoice
+		add_filter(
+			'FHEE__EE_Html_messenger___send_message__main_body',
+			[$this, 'add_powered_by_credit_link_to_receipt_and_invoice'],
+			10,
+			3
+		);
+		parent::__construct();
+	}
+
+
+	/**
+	 * HTML Messenger desires execution immediately.
+	 *
+	 * @return bool
+	 * @since  4.9.0
+	 * @see    parent::send_now() for documentation.
+	 */
+	public function send_now(): bool
+	{
+		return true;
+	}
+
+
+	/**
+	 * HTML Messenger allows an empty to field.
+	 *
+	 * @return bool
+	 * @since  4.9.0
+	 * @see    parent::allow_empty_to_field() for documentation
+	 */
+	public function allow_empty_to_field(): bool
+	{
+		return true;
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = ['events_edit' => true];
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$this->_valid_shortcodes = [];
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_validator_config()
+	{
+		$this->_validator_config = [
+			'subject'                       => [
+				'shortcodes' => ['organization', 'primary_registration_details', 'email', 'transaction'],
+			],
+			'content'                       => [
+				'shortcodes' => [
+					'organization',
+					'primary_registration_list',
+					'primary_registration_details',
+					'email',
+					'transaction',
+					'event_list',
+					'payment_list',
+					'venue',
+					'line_item_list',
+					'messenger',
+					'ticket_list',
+				],
+			],
+			'event_list'                    => [
+				'shortcodes' => [
+					'event',
+					'ticket_list',
+					'venue',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+				],
+				'required'   => ['[EVENT_LIST]'],
+			],
+			'ticket_list'                   => [
+				'shortcodes' => [
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'line_item_list',
+					'venue',
+				],
+				'required'   => ['[TICKET_LIST]'],
+			],
+			'ticket_line_item_no_pms'       => [
+				'shortcodes' => ['line_item', 'ticket'],
+				'required'   => ['[TICKET_LINE_ITEM_LIST]'],
+			],
+			'ticket_line_item_pms'          => [
+				'shortcodes' => ['line_item', 'ticket', 'line_item_list'],
+				'required'   => ['[TICKET_LINE_ITEM_LIST]'],
+			],
+			'price_modifier_line_item_list' => [
+				'shortcodes' => ['line_item'],
+				'required'   => ['[PRICE_MODIFIER_LINE_ITEM_LIST]'],
+			],
+			'datetime_list'                 => [
+				'shortcodes' => ['datetime'],
+				'required'   => ['[DATETIME_LIST]'],
+			],
+			'attendee_list'                 => [
+				'shortcodes' => ['attendee'],
+				'required'   => ['[ATTENDEE_LIST]'],
+			],
+			'tax_line_item_list'            => [
+				'shortcodes' => ['line_item'],
+				'required'   => ['[TAX_LINE_ITEM_LIST]'],
+			],
+			'additional_line_item_list'     => [
+				'shortcodes' => ['line_item'],
+				'required'   => ['[ADDITIONAL_LINE_ITEM_LIST]'],
+			],
+			'payment_list'                  => [
+				'shortcodes' => ['payment'],
+				'required'   => ['[PAYMENT_LIST_*]'],
+			],
+		];
+	}
+
+
+	/**
+	 * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger
+	 * is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary
+	 * (i.e. swap out css files or something else).
+	 *
+	 * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
+	 * @return void
+	 * @since 4.5.0
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name === 'pdf') {
+			add_filter('EE_messenger__get_variation__variation', [$this, 'add_html_css'], 10, 8);
+		}
+	}
+
+
+	/**
+	 * @param                            $variation_path
+	 * @param EE_Messages_Template_Pack  $template_pack
+	 * @param                            $messenger_name
+	 * @param                            $message_type_name
+	 * @param                            $url
+	 * @param                            $type
+	 * @param                            $variation
+	 * @param                            $skip_filters
+	 * @return string
+	 */
+	public function add_html_css(
+		$variation_path,
+		EE_Messages_Template_Pack $template_pack,
+		$messenger_name,
+		$message_type_name,
+		$url,
+		$type,
+		$variation,
+		$skip_filters
+	): string {
+		return $template_pack->get_variation(
+			$this->name,
+			$message_type_name,
+			$type,
+			$variation,
+			$url,
+			'.css',
+			$skip_filters
+		);
+	}
+
+
+	/**
+	 * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this
+	 * messenger can add their own js.
+	 *
+	 * @return void.
+	 */
+	public function enqueue_scripts_styles()
+	{
+		parent::enqueue_scripts_styles();
+		do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles');
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger
+		// but will get used by a messenger field for shortcode replacement
+		// get added to the 'extra' key in an associated array
+		// indexed by the messenger field they relate to.
+		// This is important for the Messages_admin to know what fields to display to the user.
+		// Also, notice that the "values" are equal to the field type
+		// that messages admin will use to know what kind of field to display.
+		// The values ALSO have one index labeled "shortcode".
+		// The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE])
+		// is required in order for this extra field to be displayed.
+		//  If the required shortcode isn't part of the shortcodes array
+		// then the field is not needed and will not be displayed/parsed.
+		$this->_template_fields = [
+			'subject' => [
+				'input'      => 'text',
+				'label'      => esc_html__('Page Title', 'event_espresso'),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			],
+			'content' => '',
+			// left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra'   => [
+				'content' => [
+					'main'                          => [
+						'input'      => 'wp_editor',
+						'label'      => esc_html__('Main Content', 'event_espresso'),
+						'type'       => 'string',
+						'required'   => true,
+						'validation' => true,
+						'format'     => '%s',
+						'rows'       => '15',
+					],
+					'event_list'                    => [
+						'input'               => 'wp_editor',
+						'label'               => '[EVENT_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'rows'                => '15',
+						'shortcodes_required' => ['[EVENT_LIST]'],
+					],
+					'ticket_list'                   => [
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => ['[TICKET_LIST]'],
+					],
+					'ticket_line_item_no_pms'       => [
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
+							'Ticket Line Item List with no Price Modifiers',
+							'event_espresso'
+						),
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[TICKET_LINE_ITEM_LIST]'],
+					],
+					'ticket_line_item_pms'          => [
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
+							'Ticket Line Item List with Price Modifiers',
+							'event_espresso'
+						),
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[TICKET_LINE_ITEM_LIST]'],
+					],
+					'price_modifier_line_item_list' => [
+						'input'               => 'textarea',
+						'label'               => '[PRICE_MODIFIER_LINE_ITEM_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[PRICE_MODIFIER_LINE_ITEM_LIST]'],
+					],
+					'datetime_list'                 => [
+						'input'               => 'textarea',
+						'label'               => '[DATETIME_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[DATETIME_LIST]'],
+					],
+					'attendee_list'                 => [
+						'input'               => 'textarea',
+						'label'               => '[ATTENDEE_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[ATTENDEE_LIST]'],
+					],
+					'tax_line_item_list'            => [
+						'input'               => 'textarea',
+						'label'               => '[TAX_LINE_ITEM_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[TAX_LINE_ITEM_LIST]'],
+					],
+					'additional_line_item_list'     => [
+						'input'               => 'textarea',
+						'label'               => '[ADDITIONAL_LINE_ITEM_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[ADDITIONAL_LINE_ITEM_LIST]'],
+					],
+					'payment_list'                  => [
+						'input'               => 'textarea',
+						'label'               => '[PAYMENT_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[PAYMENT_LIST_*]'],
+					],
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * @see   definition of this method in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = ['receipt', 'invoice'];
+	}
+
+
+	/**
+	 * @see   definition of this method in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = ['receipt', 'invoice'];
+	}
+
+
+	/**
+	 * Displays the message in the browser.
+	 *
+	 * @return void.
+	 * @since 4.5.0
+	 */
+	protected function _send_message()
+	{
+		$this->_template_args = [
+			'page_title' => $this->_subject,
+			'base_css'   => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'base',
+				$this->_variation
+			),
+			'print_css'  => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'print',
+				$this->_variation
+			),
+			'main_css'   => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'main',
+				$this->_variation
+			),
+			'main_body'  => wpautop(
+				apply_filters(
+					'FHEE__EE_Html_messenger___send_message__main_body',
+					$this->_content,
+					$this->_content,
+					$this->_incoming_message_type
+				)
+			),
+		];
+		$this->_deregister_wp_hooks();
+		add_action('wp_enqueue_scripts', [$this, 'enqueue_scripts_styles']);
+		echo '<!doctype html>' . wp_kses($this->_get_main_template(), AllowedTags::getWithFullTags());
+		exit();
+	}
+
+
+	/**
+	 * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't
+	 * interfere with our templates.  If users want to add any custom styles or scripts they must use the
+	 * AHEE__EE_Html_messenger__enqueue_scripts_styles hook.
+	 *
+	 * @return void
+	 * @since 4.5.0
+	 */
+	protected function _deregister_wp_hooks()
+	{
+		remove_all_actions('wp_head');
+		remove_all_actions('wp_footer');
+		remove_all_actions('wp_print_footer_scripts');
+		remove_all_actions('wp_enqueue_scripts');
+		global $wp_scripts, $wp_styles;
+		$wp_scripts = $wp_styles = [];
+		// just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
+		add_action('wp_footer', 'wp_print_footer_scripts');
+		add_action('wp_print_footer_scripts', '_wp_footer_scripts');
+		add_action('wp_head', 'wp_enqueue_scripts');
+	}
+
+
+	/**
+	 * Overwrite parent _get_main_template for display_html purposes.
+	 *
+	 * @param bool $preview
+	 * @return string
+	 * @since  4.5.0
+	 */
+	protected function _get_main_template($preview = false): string
+	{
+		$wrapper_template = $this->_tmp_pack->get_wrapper($this->name);
+		// include message type as a template arg
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _preview()
+	{
+		$this->_send_message();
+	}
+
+
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+
+	/**
+	 * add the "powered by EE" credit link to the HTML receipt and invoice
+	 *
+	 * @param string          $content
+	 * @param string          $content_again
+	 * @param EE_message_type $incoming_message_type
+	 * @return string
+	 */
+	public function add_powered_by_credit_link_to_receipt_and_invoice(
+		string $content,
+		string $content_again,
+		EE_message_type $incoming_message_type
+	): string {
+		if (
+			($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt')
+			&& apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true)
+		) {
+			$content .= EEH_Template::powered_by_event_espresso(
+				'aln-cntr',
+				'',
+				['utm_content' => 'messages_system']
+			) . EEH_HTML::div(EEH_HTML::p('&nbsp;'));
+		}
+		return $content;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -42,7 +42,7 @@ 
             'This messenger outputs a message to a browser for display.',
             'event_espresso'
         );
-        $this->label               = [
+        $this->label = [
             'singular' => esc_html__('html', 'event_espresso'),
             'plural'   => esc_html__('html', 'event_espresso'),
         ];
@@ -314,7 +314,7 @@ 
                     ],
                     'ticket_line_item_no_pms'       => [
                         'input'               => 'textarea',
-                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
+                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>'.esc_html__(
                             'Ticket Line Item List with no Price Modifiers',
                             'event_espresso'
                         ),
@@ -328,7 +328,7 @@ 
                     ],
                     'ticket_line_item_pms'          => [
                         'input'               => 'textarea',
-                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
+                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>'.esc_html__(
                             'Ticket Line Item List with Price Modifiers',
                             'event_espresso'
                         ),
@@ -474,7 +474,7 @@ 
         ];
         $this->_deregister_wp_hooks();
         add_action('wp_enqueue_scripts', [$this, 'enqueue_scripts_styles']);
-        echo '<!doctype html>' . wp_kses($this->_get_main_template(), AllowedTags::getWithFullTags());
+        echo '<!doctype html>'.wp_kses($this->_get_main_template(), AllowedTags::getWithFullTags());
         exit();
     }
 
@@ -553,7 +553,7 @@ 
                 'aln-cntr',
                 '',
                 ['utm_content' => 'messages_system']
-            ) . EEH_HTML::div(EEH_HTML::p('&nbsp;'));
+            ).EEH_HTML::div(EEH_HTML::p('&nbsp;'));
         }
         return $content;
     }

core/db_classes/EE_Venue.class.php

Indentation +562 added lines, -562 removed lines

@@ -11,566 +11,566 @@
  */
 class EE_Venue extends EE_CPT_Base implements AddressInterface
 {
-    /**
-     *
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Attendee
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->get('VNU_name');
-    }
-
-
-    /**
-     * Gets phone
-     *
-     * @return string
-     */
-    public function phone()
-    {
-        return $this->get('VNU_phone');
-    }
-
-
-    /**
-     * venue_url
-     *
-     * @return string
-     */
-    public function venue_url()
-    {
-        return $this->get('VNU_url');
-    }
-
-
-    /**
-     * Gets desc
-     *
-     * @return string
-     */
-    public function description()
-    {
-        return $this->get('VNU_desc');
-    }
-
-
-    /**
-     * Gets short description (AKA: the excerpt)
-     *
-     * @return string
-     */
-    public function excerpt()
-    {
-        return $this->get('VNU_short_desc');
-    }
-
-
-    /**
-     * Gets identifier
-     *
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->get('VNU_identifier');
-    }
-
-
-    /**
-     * Gets address
-     *
-     * @return string
-     */
-    public function address(): string
-    {
-        return $this->get('VNU_address');
-    }
-
-
-    /**
-     * Gets address2
-     *
-     * @return string
-     */
-    public function address2(): string
-    {
-        return $this->get('VNU_address2');
-    }
-
-
-    /**
-     * Gets city
-     *
-     * @return string
-     */
-    public function city(): string
-    {
-        return $this->get('VNU_city');
-    }
-
-    /**
-     * Gets state
-     *
-     * @return int
-     */
-    public function state_ID(): int
-    {
-        return $this->get('STA_ID');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_abbrev(): string
-    {
-        return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_name(): string
-    {
-        return $this->state_obj() instanceof EE_State ? $this->state_obj()->name() : '';
-    }
-
-
-    /**
-     * Gets the state for this venue
-     *
-     * @return EE_State|null
-     */
-    public function state_obj(): ?EE_State
-    {
-        return $this->get_first_related('State');
-    }
-
-
-    /**
-     * either displays the state abbreviation or the state name, as determined
-     * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     */
-    public function state(): string
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_abbrev();
-        } else {
-            return $this->state_name();
-        }
-    }
-
-
-    /**
-     * country_ID
-     *
-     * @return string
-     */
-    public function country_ID(): string
-    {
-        return $this->get('CNT_ISO');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_name(): string
-    {
-        return $this->country_obj() instanceof EE_Country ? $this->country_obj()->name() : '';
-    }
-
-
-    /**
-     * Gets the country of this venue
-     *
-     * @return EE_Country|null
-     */
-    public function country_obj(): ?EE_Country
-    {
-        return $this->get_first_related('Country');
-    }
-
-
-    /**
-     * either displays the country ISO2 code or the country name, as determined
-     * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     */
-    public function country(): string
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        } else {
-            return $this->country_name();
-        }
-    }
-
-
-    /**
-     * Gets zip
-     *
-     * @return string
-     */
-    public function zip(): string
-    {
-        return $this->get('VNU_zip');
-    }
-
-
-    /**
-     * Gets capacity
-     *
-     * @return int|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function capacity()
-    {
-        return $this->get_pretty('VNU_capacity', 'symbol');
-    }
-
-
-    /**
-     * Gets created
-     *
-     * @return string
-     */
-    public function created()
-    {
-        return $this->get('VNU_created');
-    }
-
-
-    /**
-     * Gets modified
-     *
-     * @return string
-     */
-    public function modified()
-    {
-        return $this->get('VNU_modified');
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     */
-    public function order()
-    {
-        return $this->get('VNU_order');
-    }
-
-
-    /**
-     * Gets wp_user
-     *
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('VNU_wp_user');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function virtual_phone()
-    {
-        return $this->get('VNU_virtual_phone');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function virtual_url()
-    {
-        return $this->get('VNU_virtual_url');
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function enable_for_gmap()
-    {
-        return $this->get('VNU_enable_for_gmap');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function google_map_link()
-    {
-        return $this->get('VNU_google_map_link');
-    }
-
-
-    /**
-     * Gets all events happening at this venue. Query parameters can be added to
-     * fetch a subset of those events.
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param bool  $upcoming
-     * @return EE_Event[]
-     */
-    public function events($query_params = array(), $upcoming = false)
-    {
-        if ($upcoming) {
-            $query_params = array(
-                array(
-                    'status'                 => 'publish',
-                    'Datetime.DTT_EVT_start' => array(
-                        '>',
-                        EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-                    ),
-                ),
-            );
-        }
-        return $this->get_many_related('Event', $query_params);
-    }
-
-
-    /**
-     * Sets address
-     */
-    public function set_address($address = '')
-    {
-        $this->set('VNU_address', $address);
-    }
-
-
-    /**
-     * @param string $address2
-     */
-    public function set_address2($address2 = '')
-    {
-        $this->set('VNU_address2', $address2);
-    }
-
-
-    /**
-     * @param string $city
-     */
-    public function set_city($city = '')
-    {
-        $this->set('VNU_city', $city);
-    }
-
-
-    /**
-     * @param int $state
-     */
-    public function set_state_ID($state = 0)
-    {
-        $this->set('STA_ID', $state);
-    }
-
-
-    /**
-     * Sets the state, given either a state id or state object
-     *
-     * @param EE_State /int $state_id_or_obj
-     * @return EE_State
-     */
-    public function set_state_obj($state_id_or_obj)
-    {
-        return $this->_add_relation_to($state_id_or_obj, 'State');
-    }
-
-
-    /**
-     * @param int $country_ID
-     */
-    public function set_country_ID($country_ID = 0)
-    {
-        $this->set('CNT_ISO', $country_ID);
-    }
-
-
-    /**
-     * Sets the country on the venue
-     *
-     * @param EE_Country /string $country_id_or_obj
-     * @return EE_Country
-     */
-    public function set_country_obj($country_id_or_obj)
-    {
-        return $this->_add_relation_to($country_id_or_obj, 'Country');
-    }
-
-
-    /**
-     * @param string $zip
-     */
-    public function set_zip($zip = '')
-    {
-        $this->set('VNU_zip', $zip);
-    }
-
-
-    /**
-     * @param int $capacity
-     */
-    public function set_capacity($capacity = 0)
-    {
-        $this->set('VNU_capacity', $capacity);
-    }
-
-
-    /**
-     * @param string $created
-     */
-    public function set_created($created = '')
-    {
-        $this->set('VNU_created', $created);
-    }
-
-
-    /**
-     * @param string $desc
-     */
-    public function set_description($desc = '')
-    {
-        $this->set('VNU_desc', $desc);
-    }
-
-
-    /**
-     * @param string $identifier
-     */
-    public function set_identifier($identifier = '')
-    {
-        $this->set('VNU_identifier', $identifier);
-    }
-
-
-    /**
-     * @param string $modified
-     */
-    public function set_modified($modified = '')
-    {
-        $this->set('VNU_modified', $modified);
-    }
-
-
-    /**
-     * @param string $name
-     */
-    public function set_name($name = '')
-    {
-        $this->set('VNU_name', $name);
-    }
-
-
-    /**
-     * @param int $order
-     */
-    public function set_order($order = 0)
-    {
-        $this->set('VNU_order', $order);
-    }
-
-
-    /**
-     * @param string $phone
-     */
-    public function set_phone($phone = '')
-    {
-        $this->set('VNU_phone', $phone);
-    }
-
-
-    /**
-     * @param int $wp_user
-     */
-    public function set_wp_user($wp_user = 1)
-    {
-        $this->set('VNU_wp_user', $wp_user);
-    }
-
-
-    /**
-     * @param string $url
-     */
-    public function set_venue_url($url = '')
-    {
-        $this->set('VNU_url', $url);
-    }
-
-
-    /**
-     * @param string $phone
-     */
-    public function set_virtual_phone($phone = '')
-    {
-        $this->set('VNU_virtual_phone', $phone);
-    }
-
-
-    /**
-     * @param string $url
-     */
-    public function set_virtual_url($url = '')
-    {
-        $this->set('VNU_virtual_url', $url);
-    }
-
-
-    /**
-     * @param string $enable
-     */
-    public function set_enable_for_gmap($enable = '')
-    {
-        $this->set('VNU_enable_for_gmap', $enable);
-    }
-
-
-    /**
-     * @param string $google_map_link
-     */
-    public function set_google_map_link($google_map_link = '')
-    {
-        $this->set('VNU_google_map_link', $google_map_link);
-    }
+	/**
+	 *
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Attendee
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->get('VNU_name');
+	}
+
+
+	/**
+	 * Gets phone
+	 *
+	 * @return string
+	 */
+	public function phone()
+	{
+		return $this->get('VNU_phone');
+	}
+
+
+	/**
+	 * venue_url
+	 *
+	 * @return string
+	 */
+	public function venue_url()
+	{
+		return $this->get('VNU_url');
+	}
+
+
+	/**
+	 * Gets desc
+	 *
+	 * @return string
+	 */
+	public function description()
+	{
+		return $this->get('VNU_desc');
+	}
+
+
+	/**
+	 * Gets short description (AKA: the excerpt)
+	 *
+	 * @return string
+	 */
+	public function excerpt()
+	{
+		return $this->get('VNU_short_desc');
+	}
+
+
+	/**
+	 * Gets identifier
+	 *
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->get('VNU_identifier');
+	}
+
+
+	/**
+	 * Gets address
+	 *
+	 * @return string
+	 */
+	public function address(): string
+	{
+		return $this->get('VNU_address');
+	}
+
+
+	/**
+	 * Gets address2
+	 *
+	 * @return string
+	 */
+	public function address2(): string
+	{
+		return $this->get('VNU_address2');
+	}
+
+
+	/**
+	 * Gets city
+	 *
+	 * @return string
+	 */
+	public function city(): string
+	{
+		return $this->get('VNU_city');
+	}
+
+	/**
+	 * Gets state
+	 *
+	 * @return int
+	 */
+	public function state_ID(): int
+	{
+		return $this->get('STA_ID');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_abbrev(): string
+	{
+		return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_name(): string
+	{
+		return $this->state_obj() instanceof EE_State ? $this->state_obj()->name() : '';
+	}
+
+
+	/**
+	 * Gets the state for this venue
+	 *
+	 * @return EE_State|null
+	 */
+	public function state_obj(): ?EE_State
+	{
+		return $this->get_first_related('State');
+	}
+
+
+	/**
+	 * either displays the state abbreviation or the state name, as determined
+	 * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 */
+	public function state(): string
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_abbrev();
+		} else {
+			return $this->state_name();
+		}
+	}
+
+
+	/**
+	 * country_ID
+	 *
+	 * @return string
+	 */
+	public function country_ID(): string
+	{
+		return $this->get('CNT_ISO');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_name(): string
+	{
+		return $this->country_obj() instanceof EE_Country ? $this->country_obj()->name() : '';
+	}
+
+
+	/**
+	 * Gets the country of this venue
+	 *
+	 * @return EE_Country|null
+	 */
+	public function country_obj(): ?EE_Country
+	{
+		return $this->get_first_related('Country');
+	}
+
+
+	/**
+	 * either displays the country ISO2 code or the country name, as determined
+	 * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 */
+	public function country(): string
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		} else {
+			return $this->country_name();
+		}
+	}
+
+
+	/**
+	 * Gets zip
+	 *
+	 * @return string
+	 */
+	public function zip(): string
+	{
+		return $this->get('VNU_zip');
+	}
+
+
+	/**
+	 * Gets capacity
+	 *
+	 * @return int|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function capacity()
+	{
+		return $this->get_pretty('VNU_capacity', 'symbol');
+	}
+
+
+	/**
+	 * Gets created
+	 *
+	 * @return string
+	 */
+	public function created()
+	{
+		return $this->get('VNU_created');
+	}
+
+
+	/**
+	 * Gets modified
+	 *
+	 * @return string
+	 */
+	public function modified()
+	{
+		return $this->get('VNU_modified');
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->get('VNU_order');
+	}
+
+
+	/**
+	 * Gets wp_user
+	 *
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('VNU_wp_user');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function virtual_phone()
+	{
+		return $this->get('VNU_virtual_phone');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function virtual_url()
+	{
+		return $this->get('VNU_virtual_url');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function enable_for_gmap()
+	{
+		return $this->get('VNU_enable_for_gmap');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function google_map_link()
+	{
+		return $this->get('VNU_google_map_link');
+	}
+
+
+	/**
+	 * Gets all events happening at this venue. Query parameters can be added to
+	 * fetch a subset of those events.
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param bool  $upcoming
+	 * @return EE_Event[]
+	 */
+	public function events($query_params = array(), $upcoming = false)
+	{
+		if ($upcoming) {
+			$query_params = array(
+				array(
+					'status'                 => 'publish',
+					'Datetime.DTT_EVT_start' => array(
+						'>',
+						EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+					),
+				),
+			);
+		}
+		return $this->get_many_related('Event', $query_params);
+	}
+
+
+	/**
+	 * Sets address
+	 */
+	public function set_address($address = '')
+	{
+		$this->set('VNU_address', $address);
+	}
+
+
+	/**
+	 * @param string $address2
+	 */
+	public function set_address2($address2 = '')
+	{
+		$this->set('VNU_address2', $address2);
+	}
+
+
+	/**
+	 * @param string $city
+	 */
+	public function set_city($city = '')
+	{
+		$this->set('VNU_city', $city);
+	}
+
+
+	/**
+	 * @param int $state
+	 */
+	public function set_state_ID($state = 0)
+	{
+		$this->set('STA_ID', $state);
+	}
+
+
+	/**
+	 * Sets the state, given either a state id or state object
+	 *
+	 * @param EE_State /int $state_id_or_obj
+	 * @return EE_State
+	 */
+	public function set_state_obj($state_id_or_obj)
+	{
+		return $this->_add_relation_to($state_id_or_obj, 'State');
+	}
+
+
+	/**
+	 * @param int $country_ID
+	 */
+	public function set_country_ID($country_ID = 0)
+	{
+		$this->set('CNT_ISO', $country_ID);
+	}
+
+
+	/**
+	 * Sets the country on the venue
+	 *
+	 * @param EE_Country /string $country_id_or_obj
+	 * @return EE_Country
+	 */
+	public function set_country_obj($country_id_or_obj)
+	{
+		return $this->_add_relation_to($country_id_or_obj, 'Country');
+	}
+
+
+	/**
+	 * @param string $zip
+	 */
+	public function set_zip($zip = '')
+	{
+		$this->set('VNU_zip', $zip);
+	}
+
+
+	/**
+	 * @param int $capacity
+	 */
+	public function set_capacity($capacity = 0)
+	{
+		$this->set('VNU_capacity', $capacity);
+	}
+
+
+	/**
+	 * @param string $created
+	 */
+	public function set_created($created = '')
+	{
+		$this->set('VNU_created', $created);
+	}
+
+
+	/**
+	 * @param string $desc
+	 */
+	public function set_description($desc = '')
+	{
+		$this->set('VNU_desc', $desc);
+	}
+
+
+	/**
+	 * @param string $identifier
+	 */
+	public function set_identifier($identifier = '')
+	{
+		$this->set('VNU_identifier', $identifier);
+	}
+
+
+	/**
+	 * @param string $modified
+	 */
+	public function set_modified($modified = '')
+	{
+		$this->set('VNU_modified', $modified);
+	}
+
+
+	/**
+	 * @param string $name
+	 */
+	public function set_name($name = '')
+	{
+		$this->set('VNU_name', $name);
+	}
+
+
+	/**
+	 * @param int $order
+	 */
+	public function set_order($order = 0)
+	{
+		$this->set('VNU_order', $order);
+	}
+
+
+	/**
+	 * @param string $phone
+	 */
+	public function set_phone($phone = '')
+	{
+		$this->set('VNU_phone', $phone);
+	}
+
+
+	/**
+	 * @param int $wp_user
+	 */
+	public function set_wp_user($wp_user = 1)
+	{
+		$this->set('VNU_wp_user', $wp_user);
+	}
+
+
+	/**
+	 * @param string $url
+	 */
+	public function set_venue_url($url = '')
+	{
+		$this->set('VNU_url', $url);
+	}
+
+
+	/**
+	 * @param string $phone
+	 */
+	public function set_virtual_phone($phone = '')
+	{
+		$this->set('VNU_virtual_phone', $phone);
+	}
+
+
+	/**
+	 * @param string $url
+	 */
+	public function set_virtual_url($url = '')
+	{
+		$this->set('VNU_virtual_url', $url);
+	}
+
+
+	/**
+	 * @param string $enable
+	 */
+	public function set_enable_for_gmap($enable = '')
+	{
+		$this->set('VNU_enable_for_gmap', $enable);
+	}
+
+
+	/**
+	 * @param string $google_map_link
+	 */
+	public function set_google_map_link($google_map_link = '')
+	{
+		$this->set('VNU_google_map_link', $google_map_link);
+	}
 }

core/db_classes/EE_Attendee.class.php

Indentation +747 added lines, -747 removed lines

@@ -25,751 +25,751 @@
  */
 class EE_Attendee extends EE_CPT_Base implements EEI_Contact, AddressInterface, EEI_Admin_Links, EEI_Attendee
 {
-    /**
-     * Sets some dynamic defaults
-     *
-     * @param array  $fieldValues
-     * @param bool   $bydb
-     * @param string $timezone
-     * @param array  $date_formats
-     * @throws EE_Error
-     */
-    protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
-    {
-        if (! isset($fieldValues['ATT_full_name'])) {
-            $fname = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
-            $lname = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
-            $fieldValues['ATT_full_name'] = $fname . $lname;
-        }
-        if (! isset($fieldValues['ATT_slug'])) {
-            // $fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
-            $fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
-        }
-        if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
-            $fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
-        }
-        parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Attendee
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Attendee First Name
-     *
-     * @access        public
-     * @param string $fname
-     * @throws EE_Error
-     */
-    public function set_fname($fname = '')
-    {
-        $this->set('ATT_fname', $fname);
-    }
-
-
-    /**
-     *        Set Attendee Last Name
-     *
-     * @access        public
-     * @param string $lname
-     * @throws EE_Error
-     */
-    public function set_lname($lname = '')
-    {
-        $this->set('ATT_lname', $lname);
-    }
-
-
-    /**
-     *        Set Attendee Address
-     *
-     * @access        public
-     * @param string $address
-     * @throws EE_Error
-     */
-    public function set_address($address = '')
-    {
-        $this->set('ATT_address', $address);
-    }
-
-
-    /**
-     *        Set Attendee Address2
-     *
-     * @access        public
-     * @param        string $address2
-     * @throws EE_Error
-     */
-    public function set_address2($address2 = '')
-    {
-        $this->set('ATT_address2', $address2);
-    }
-
-
-    /**
-     *        Set Attendee City
-     *
-     * @access        public
-     * @param        string $city
-     * @throws EE_Error
-     */
-    public function set_city($city = '')
-    {
-        $this->set('ATT_city', $city);
-    }
-
-
-    /**
-     *        Set Attendee State ID
-     *
-     * @access        public
-     * @param        int $STA_ID
-     * @throws EE_Error
-     */
-    public function set_state($STA_ID = 0)
-    {
-        $this->set('STA_ID', $STA_ID);
-    }
-
-
-    /**
-     *        Set Attendee Country ISO Code
-     *
-     * @access        public
-     * @param        string $CNT_ISO
-     * @throws EE_Error
-     */
-    public function set_country($CNT_ISO = '')
-    {
-        $this->set('CNT_ISO', $CNT_ISO);
-    }
-
-
-    /**
-     *        Set Attendee Zip/Postal Code
-     *
-     * @access        public
-     * @param        string $zip
-     * @throws EE_Error
-     */
-    public function set_zip($zip = '')
-    {
-        $this->set('ATT_zip', $zip);
-    }
-
-
-    /**
-     *        Set Attendee Email Address
-     *
-     * @access        public
-     * @param        string $email
-     * @throws EE_Error
-     */
-    public function set_email($email = '')
-    {
-        $this->set('ATT_email', $email);
-    }
-
-
-    /**
-     *        Set Attendee Phone
-     *
-     * @access        public
-     * @param        string $phone
-     * @throws EE_Error
-     */
-    public function set_phone($phone = '')
-    {
-        $this->set('ATT_phone', $phone);
-    }
-
-
-    /**
-     *        set deleted
-     *
-     * @access        public
-     * @param        bool $ATT_deleted
-     * @throws EE_Error
-     */
-    public function set_deleted($ATT_deleted = false)
-    {
-        $this->set('ATT_deleted', $ATT_deleted);
-    }
-
-
-    /**
-     * Returns the value for the post_author id saved with the cpt
-     *
-     * @since 4.5.0
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('ATT_author');
-    }
-
-
-    /**
-     *        get Attendee First Name
-     *
-     * @access        public
-     * @return string
-     * @throws EE_Error
-     */
-    public function fname()
-    {
-        return $this->get('ATT_fname');
-    }
-
-
-    /**
-     * echoes out the attendee's first name
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function e_full_name()
-    {
-        echo esc_html($this->full_name());
-    }
-
-
-    /**
-     * Returns the first and last name concatenated together with a space.
-     *
-     * @param bool $apply_html_entities
-     * @return string
-     * @throws EE_Error
-     */
-    public function full_name($apply_html_entities = false)
-    {
-        $full_name = array(
-            $this->fname(),
-            $this->lname(),
-        );
-        $full_name = array_filter($full_name);
-        $full_name = implode(' ', $full_name);
-        return $apply_html_entities ? htmlentities($full_name, ENT_QUOTES, 'UTF-8') : $full_name;
-    }
-
-
-    /**
-     * This returns the value of the `ATT_full_name` field which is usually equivalent to calling `full_name()` unless
-     * the post_title field has been directly modified in the db for the post (espresso_attendees post type) for this
-     * attendee.
-     *
-     * @param bool $apply_html_entities
-     * @return string
-     * @throws EE_Error
-     */
-    public function ATT_full_name($apply_html_entities = false)
-    {
-        return $apply_html_entities
-            ? htmlentities($this->get('ATT_full_name'), ENT_QUOTES, 'UTF-8')
-            : $this->get('ATT_full_name');
-    }
-
-
-    /**
-     *        get Attendee Last Name
-     *
-     * @access        public
-     * @return string
-     * @throws EE_Error
-     */
-    public function lname()
-    {
-        return $this->get('ATT_lname');
-    }
-
-
-    /**
-     * Gets the attendee's full address as an array so client code can decide hwo to display it
-     *
-     * @return array numerically indexed, with each part of the address that is known.
-     * Eg, if the user only responded to state and country,
-     * it would be array(0=>'Alabama',1=>'USA')
-     * @return array
-     * @throws EE_Error
-     */
-    public function full_address_as_array()
-    {
-        $full_address_array = array();
-        $initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
-        foreach ($initial_address_fields as $address_field_name) {
-            $address_fields_value = $this->get($address_field_name);
-            if (! empty($address_fields_value)) {
-                $full_address_array[] = $address_fields_value;
-            }
-        }
-        // now handle state and country
-        $state_obj = $this->state_obj();
-        if ($state_obj instanceof EE_State) {
-            $full_address_array[] = $state_obj->name();
-        }
-        $country_obj = $this->country_obj();
-        if ($country_obj instanceof EE_Country) {
-            $full_address_array[] = $country_obj->name();
-        }
-        // lastly get the xip
-        $zip_value = $this->zip();
-        if (! empty($zip_value)) {
-            $full_address_array[] = $zip_value;
-        }
-        return $full_address_array;
-    }
-
-
-    /**
-     *        get Attendee Address
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function address(): string
-    {
-        return $this->get('ATT_address');
-    }
-
-
-    /**
-     *        get Attendee Address2
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function address2(): string
-    {
-        return $this->get('ATT_address2');
-    }
-
-
-    /**
-     *        get Attendee City
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function city(): string
-    {
-        return $this->get('ATT_city');
-    }
-
-
-    /**
-     * get Attendee State ID
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function state_ID(): int
-    {
-        return $this->get('STA_ID');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function state_abbrev(): string
-    {
-        return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
-    }
-
-
-    /**
-     * Gets the state set to this attendee
-     *
-     * @return EE_State|null
-     * @throws EE_Error
-     */
-    public function state_obj(): ?EE_State
-    {
-        return $this->get_first_related('State');
-    }
-
-
-    /**
-     * Returns the state's name, otherwise 'Unknown'
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function state_name(): string
-    {
-        if ($this->state_obj()) {
-            return $this->state_obj()->name();
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * either displays the state abbreviation or the state name, as determined
-     * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function state(): string
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_abbrev();
-        }
-        return $this->state_name();
-    }
-
-
-    /**
-     *    get Attendee Country ISO Code
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function country_ID(): string
-    {
-        return $this->get('CNT_ISO');
-    }
-
-
-    /**
-     * Gets country set for this attendee
-     *
-     * @return EE_Country|null
-     * @throws EE_Error
-     */
-    public function country_obj(): ?EE_Country
-    {
-        return $this->get_first_related('Country');
-    }
-
-
-    /**
-     * Returns the country's name if known, otherwise 'Unknown'
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function country_name(): string
-    {
-        if ($this->country_obj()) {
-            return $this->country_obj()->name();
-        }
-        return '';
-    }
-
-
-    /**
-     * either displays the country ISO2 code or the country name, as determined
-     * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function country(): string
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        }
-        return $this->country_name();
-    }
-
-
-    /**
-     *        get Attendee Zip/Postal Code
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function zip(): string
-    {
-        return $this->get('ATT_zip');
-    }
-
-
-    /**
-     *        get Attendee Email Address
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function email()
-    {
-        return $this->get('ATT_email');
-    }
-
-
-    /**
-     *        get Attendee Phone #
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function phone()
-    {
-        return $this->get('ATT_phone');
-    }
-
-
-    /**
-     *    get deleted
-     *
-     * @return        bool
-     * @throws EE_Error
-     */
-    public function deleted()
-    {
-        return $this->get('ATT_deleted');
-    }
-
-
-    /**
-     * Gets registrations of this attendee
-     *
-     * @param array $query_params
-     * @return EE_Registration[]
-     * @throws EE_Error
-     */
-    public function get_registrations($query_params = array())
-    {
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Gets the most recent registration of this attendee
-     *
-     * @return EE_Registration
-     * @throws EE_Error
-     */
-    public function get_most_recent_registration()
-    {
-        return $this->get_first_related(
-            'Registration',
-            array('order_by' => array('REG_date' => 'DESC'))
-        ); // null, 'REG_date', 'DESC', '=', 'OBJECT_K');
-    }
-
-
-    /**
-     * Gets the most recent registration for this attend at this event
-     *
-     * @param int $event_id
-     * @return EE_Registration
-     * @throws EE_Error
-     */
-    public function get_most_recent_registration_for_event($event_id)
-    {
-        return $this->get_first_related(
-            'Registration',
-            array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC'))
-        );
-    }
-
-
-    /**
-     * returns any events attached to this attendee ($_Event property);
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function events()
-    {
-        return $this->get_many_related('Event');
-    }
-
-
-    /**
-     * Gets the billing info array where keys match espresso_reg_page_billing_inputs(),
-     * and keys are their cleaned values. @see EE_Attendee::save_and_clean_billing_info_for_payment_method() which was
-     * used to save the billing info
-     *
-     * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
-     * @return EE_Form_Section_Proper|null
-     * @throws EE_Error
-     */
-    public function billing_info_for_payment_method($payment_method)
-    {
-        $pm_type = $payment_method->type_obj();
-        if (! $pm_type instanceof EE_PMT_Base) {
-            return null;
-        }
-        $billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
-        if (! $billing_info) {
-            return null;
-        }
-        $billing_form = $pm_type->billing_form();
-        // double-check the form isn't totally hidden, in which case pretend there is no form
-        $form_totally_hidden = true;
-        foreach ($billing_form->inputs_in_subsections() as $input) {
-            if (! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
-                $form_totally_hidden = false;
-                break;
-            }
-        }
-        if ($form_totally_hidden) {
-            return null;
-        }
-        if ($billing_form instanceof EE_Form_Section_Proper) {
-            $billing_form->receive_form_submission(array($billing_form->name() => $billing_info), false);
-        }
-
-        return $billing_form;
-    }
-
-
-    /**
-     * Gets the postmeta key that holds this attendee's billing info for the
-     * specified payment method
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_billing_info_postmeta_name($payment_method)
-    {
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            return 'billing_info_' . $payment_method->type_obj()->system_name();
-        }
-        return null;
-    }
-
-
-    /**
-     * Saves the billing info to the attendee. @see EE_Attendee::billing_info_for_payment_method() which is used to
-     * retrieve it
-     *
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Payment_Method             $payment_method
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
-    {
-        if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
-            EE_Error::add_error(
-                esc_html__('Cannot save billing info because there is none.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-        );
-            return false;
-        }
-        $billing_form->clean_sensitive_data();
-        return update_post_meta(
-            $this->ID(),
-            $this->get_billing_info_postmeta_name($payment_method),
-            $billing_form->input_values(true)
-        );
-    }
-
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_admin_edit_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_registrations',
-                'action' => 'edit_attendee',
-                'post'   => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_registrations',
-                'action' => 'contact_list',
-            ),
-            admin_url('admin.php')
-        );
-    }
+	/**
+	 * Sets some dynamic defaults
+	 *
+	 * @param array  $fieldValues
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 * @param array  $date_formats
+	 * @throws EE_Error
+	 */
+	protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
+	{
+		if (! isset($fieldValues['ATT_full_name'])) {
+			$fname = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
+			$lname = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
+			$fieldValues['ATT_full_name'] = $fname . $lname;
+		}
+		if (! isset($fieldValues['ATT_slug'])) {
+			// $fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
+			$fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
+		}
+		if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
+			$fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
+		}
+		parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Attendee First Name
+	 *
+	 * @access        public
+	 * @param string $fname
+	 * @throws EE_Error
+	 */
+	public function set_fname($fname = '')
+	{
+		$this->set('ATT_fname', $fname);
+	}
+
+
+	/**
+	 *        Set Attendee Last Name
+	 *
+	 * @access        public
+	 * @param string $lname
+	 * @throws EE_Error
+	 */
+	public function set_lname($lname = '')
+	{
+		$this->set('ATT_lname', $lname);
+	}
+
+
+	/**
+	 *        Set Attendee Address
+	 *
+	 * @access        public
+	 * @param string $address
+	 * @throws EE_Error
+	 */
+	public function set_address($address = '')
+	{
+		$this->set('ATT_address', $address);
+	}
+
+
+	/**
+	 *        Set Attendee Address2
+	 *
+	 * @access        public
+	 * @param        string $address2
+	 * @throws EE_Error
+	 */
+	public function set_address2($address2 = '')
+	{
+		$this->set('ATT_address2', $address2);
+	}
+
+
+	/**
+	 *        Set Attendee City
+	 *
+	 * @access        public
+	 * @param        string $city
+	 * @throws EE_Error
+	 */
+	public function set_city($city = '')
+	{
+		$this->set('ATT_city', $city);
+	}
+
+
+	/**
+	 *        Set Attendee State ID
+	 *
+	 * @access        public
+	 * @param        int $STA_ID
+	 * @throws EE_Error
+	 */
+	public function set_state($STA_ID = 0)
+	{
+		$this->set('STA_ID', $STA_ID);
+	}
+
+
+	/**
+	 *        Set Attendee Country ISO Code
+	 *
+	 * @access        public
+	 * @param        string $CNT_ISO
+	 * @throws EE_Error
+	 */
+	public function set_country($CNT_ISO = '')
+	{
+		$this->set('CNT_ISO', $CNT_ISO);
+	}
+
+
+	/**
+	 *        Set Attendee Zip/Postal Code
+	 *
+	 * @access        public
+	 * @param        string $zip
+	 * @throws EE_Error
+	 */
+	public function set_zip($zip = '')
+	{
+		$this->set('ATT_zip', $zip);
+	}
+
+
+	/**
+	 *        Set Attendee Email Address
+	 *
+	 * @access        public
+	 * @param        string $email
+	 * @throws EE_Error
+	 */
+	public function set_email($email = '')
+	{
+		$this->set('ATT_email', $email);
+	}
+
+
+	/**
+	 *        Set Attendee Phone
+	 *
+	 * @access        public
+	 * @param        string $phone
+	 * @throws EE_Error
+	 */
+	public function set_phone($phone = '')
+	{
+		$this->set('ATT_phone', $phone);
+	}
+
+
+	/**
+	 *        set deleted
+	 *
+	 * @access        public
+	 * @param        bool $ATT_deleted
+	 * @throws EE_Error
+	 */
+	public function set_deleted($ATT_deleted = false)
+	{
+		$this->set('ATT_deleted', $ATT_deleted);
+	}
+
+
+	/**
+	 * Returns the value for the post_author id saved with the cpt
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('ATT_author');
+	}
+
+
+	/**
+	 *        get Attendee First Name
+	 *
+	 * @access        public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function fname()
+	{
+		return $this->get('ATT_fname');
+	}
+
+
+	/**
+	 * echoes out the attendee's first name
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function e_full_name()
+	{
+		echo esc_html($this->full_name());
+	}
+
+
+	/**
+	 * Returns the first and last name concatenated together with a space.
+	 *
+	 * @param bool $apply_html_entities
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function full_name($apply_html_entities = false)
+	{
+		$full_name = array(
+			$this->fname(),
+			$this->lname(),
+		);
+		$full_name = array_filter($full_name);
+		$full_name = implode(' ', $full_name);
+		return $apply_html_entities ? htmlentities($full_name, ENT_QUOTES, 'UTF-8') : $full_name;
+	}
+
+
+	/**
+	 * This returns the value of the `ATT_full_name` field which is usually equivalent to calling `full_name()` unless
+	 * the post_title field has been directly modified in the db for the post (espresso_attendees post type) for this
+	 * attendee.
+	 *
+	 * @param bool $apply_html_entities
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function ATT_full_name($apply_html_entities = false)
+	{
+		return $apply_html_entities
+			? htmlentities($this->get('ATT_full_name'), ENT_QUOTES, 'UTF-8')
+			: $this->get('ATT_full_name');
+	}
+
+
+	/**
+	 *        get Attendee Last Name
+	 *
+	 * @access        public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function lname()
+	{
+		return $this->get('ATT_lname');
+	}
+
+
+	/**
+	 * Gets the attendee's full address as an array so client code can decide hwo to display it
+	 *
+	 * @return array numerically indexed, with each part of the address that is known.
+	 * Eg, if the user only responded to state and country,
+	 * it would be array(0=>'Alabama',1=>'USA')
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function full_address_as_array()
+	{
+		$full_address_array = array();
+		$initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
+		foreach ($initial_address_fields as $address_field_name) {
+			$address_fields_value = $this->get($address_field_name);
+			if (! empty($address_fields_value)) {
+				$full_address_array[] = $address_fields_value;
+			}
+		}
+		// now handle state and country
+		$state_obj = $this->state_obj();
+		if ($state_obj instanceof EE_State) {
+			$full_address_array[] = $state_obj->name();
+		}
+		$country_obj = $this->country_obj();
+		if ($country_obj instanceof EE_Country) {
+			$full_address_array[] = $country_obj->name();
+		}
+		// lastly get the xip
+		$zip_value = $this->zip();
+		if (! empty($zip_value)) {
+			$full_address_array[] = $zip_value;
+		}
+		return $full_address_array;
+	}
+
+
+	/**
+	 *        get Attendee Address
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function address(): string
+	{
+		return $this->get('ATT_address');
+	}
+
+
+	/**
+	 *        get Attendee Address2
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function address2(): string
+	{
+		return $this->get('ATT_address2');
+	}
+
+
+	/**
+	 *        get Attendee City
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function city(): string
+	{
+		return $this->get('ATT_city');
+	}
+
+
+	/**
+	 * get Attendee State ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function state_ID(): int
+	{
+		return $this->get('STA_ID');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state_abbrev(): string
+	{
+		return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
+	}
+
+
+	/**
+	 * Gets the state set to this attendee
+	 *
+	 * @return EE_State|null
+	 * @throws EE_Error
+	 */
+	public function state_obj(): ?EE_State
+	{
+		return $this->get_first_related('State');
+	}
+
+
+	/**
+	 * Returns the state's name, otherwise 'Unknown'
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state_name(): string
+	{
+		if ($this->state_obj()) {
+			return $this->state_obj()->name();
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * either displays the state abbreviation or the state name, as determined
+	 * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state(): string
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_abbrev();
+		}
+		return $this->state_name();
+	}
+
+
+	/**
+	 *    get Attendee Country ISO Code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function country_ID(): string
+	{
+		return $this->get('CNT_ISO');
+	}
+
+
+	/**
+	 * Gets country set for this attendee
+	 *
+	 * @return EE_Country|null
+	 * @throws EE_Error
+	 */
+	public function country_obj(): ?EE_Country
+	{
+		return $this->get_first_related('Country');
+	}
+
+
+	/**
+	 * Returns the country's name if known, otherwise 'Unknown'
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function country_name(): string
+	{
+		if ($this->country_obj()) {
+			return $this->country_obj()->name();
+		}
+		return '';
+	}
+
+
+	/**
+	 * either displays the country ISO2 code or the country name, as determined
+	 * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function country(): string
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		}
+		return $this->country_name();
+	}
+
+
+	/**
+	 *        get Attendee Zip/Postal Code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function zip(): string
+	{
+		return $this->get('ATT_zip');
+	}
+
+
+	/**
+	 *        get Attendee Email Address
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function email()
+	{
+		return $this->get('ATT_email');
+	}
+
+
+	/**
+	 *        get Attendee Phone #
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function phone()
+	{
+		return $this->get('ATT_phone');
+	}
+
+
+	/**
+	 *    get deleted
+	 *
+	 * @return        bool
+	 * @throws EE_Error
+	 */
+	public function deleted()
+	{
+		return $this->get('ATT_deleted');
+	}
+
+
+	/**
+	 * Gets registrations of this attendee
+	 *
+	 * @param array $query_params
+	 * @return EE_Registration[]
+	 * @throws EE_Error
+	 */
+	public function get_registrations($query_params = array())
+	{
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Gets the most recent registration of this attendee
+	 *
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 */
+	public function get_most_recent_registration()
+	{
+		return $this->get_first_related(
+			'Registration',
+			array('order_by' => array('REG_date' => 'DESC'))
+		); // null, 'REG_date', 'DESC', '=', 'OBJECT_K');
+	}
+
+
+	/**
+	 * Gets the most recent registration for this attend at this event
+	 *
+	 * @param int $event_id
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 */
+	public function get_most_recent_registration_for_event($event_id)
+	{
+		return $this->get_first_related(
+			'Registration',
+			array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC'))
+		);
+	}
+
+
+	/**
+	 * returns any events attached to this attendee ($_Event property);
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function events()
+	{
+		return $this->get_many_related('Event');
+	}
+
+
+	/**
+	 * Gets the billing info array where keys match espresso_reg_page_billing_inputs(),
+	 * and keys are their cleaned values. @see EE_Attendee::save_and_clean_billing_info_for_payment_method() which was
+	 * used to save the billing info
+	 *
+	 * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
+	 * @return EE_Form_Section_Proper|null
+	 * @throws EE_Error
+	 */
+	public function billing_info_for_payment_method($payment_method)
+	{
+		$pm_type = $payment_method->type_obj();
+		if (! $pm_type instanceof EE_PMT_Base) {
+			return null;
+		}
+		$billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
+		if (! $billing_info) {
+			return null;
+		}
+		$billing_form = $pm_type->billing_form();
+		// double-check the form isn't totally hidden, in which case pretend there is no form
+		$form_totally_hidden = true;
+		foreach ($billing_form->inputs_in_subsections() as $input) {
+			if (! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+				$form_totally_hidden = false;
+				break;
+			}
+		}
+		if ($form_totally_hidden) {
+			return null;
+		}
+		if ($billing_form instanceof EE_Form_Section_Proper) {
+			$billing_form->receive_form_submission(array($billing_form->name() => $billing_info), false);
+		}
+
+		return $billing_form;
+	}
+
+
+	/**
+	 * Gets the postmeta key that holds this attendee's billing info for the
+	 * specified payment method
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_billing_info_postmeta_name($payment_method)
+	{
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			return 'billing_info_' . $payment_method->type_obj()->system_name();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Saves the billing info to the attendee. @see EE_Attendee::billing_info_for_payment_method() which is used to
+	 * retrieve it
+	 *
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Payment_Method             $payment_method
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
+	{
+		if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
+			EE_Error::add_error(
+				esc_html__('Cannot save billing info because there is none.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+		);
+			return false;
+		}
+		$billing_form->clean_sensitive_data();
+		return update_post_meta(
+			$this->ID(),
+			$this->get_billing_info_postmeta_name($payment_method),
+			$billing_form->input_values(true)
+		);
+	}
+
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_admin_edit_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_registrations',
+				'action' => 'edit_attendee',
+				'post'   => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_registrations',
+				'action' => 'contact_list',
+			),
+			admin_url('admin.php')
+		);
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -36,16 +36,16 @@ 
      */
     protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
     {
-        if (! isset($fieldValues['ATT_full_name'])) {
-            $fname = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
+        if ( ! isset($fieldValues['ATT_full_name'])) {
+            $fname = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'].' ' : '';
             $lname = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
-            $fieldValues['ATT_full_name'] = $fname . $lname;
+            $fieldValues['ATT_full_name'] = $fname.$lname;
         }
-        if (! isset($fieldValues['ATT_slug'])) {
+        if ( ! isset($fieldValues['ATT_slug'])) {
             // $fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
             $fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
         }
-        if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
+        if ( ! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
             $fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
         }
         parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
@@ -325,7 +325,7 @@ 
         $initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
         foreach ($initial_address_fields as $address_field_name) {
             $address_fields_value = $this->get($address_field_name);
-            if (! empty($address_fields_value)) {
+            if ( ! empty($address_fields_value)) {
                 $full_address_array[] = $address_fields_value;
             }
         }
@@ -340,7 +340,7 @@ 
         }
         // lastly get the xip
         $zip_value = $this->zip();
-        if (! empty($zip_value)) {
+        if ( ! empty($zip_value)) {
             $full_address_array[] = $zip_value;
         }
         return $full_address_array;
@@ -622,18 +622,18 @@ 
     public function billing_info_for_payment_method($payment_method)
     {
         $pm_type = $payment_method->type_obj();
-        if (! $pm_type instanceof EE_PMT_Base) {
+        if ( ! $pm_type instanceof EE_PMT_Base) {
             return null;
         }
         $billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
-        if (! $billing_info) {
+        if ( ! $billing_info) {
             return null;
         }
         $billing_form = $pm_type->billing_form();
         // double-check the form isn't totally hidden, in which case pretend there is no form
         $form_totally_hidden = true;
         foreach ($billing_form->inputs_in_subsections() as $input) {
-            if (! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+            if ( ! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
                 $form_totally_hidden = false;
                 break;
             }
@@ -660,7 +660,7 @@ 
     public function get_billing_info_postmeta_name($payment_method)
     {
         if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            return 'billing_info_' . $payment_method->type_obj()->system_name();
+            return 'billing_info_'.$payment_method->type_obj()->system_name();
         }
         return null;
     }
@@ -677,7 +677,7 @@ 
      */
     public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
     {
-        if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
+        if ( ! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
             EE_Error::add_error(
                 esc_html__('Cannot save billing info because there is none.', 'event_espresso'),
                 __FILE__,

core/EE_System.core.php

Indentation +1366 added lines, -1366 removed lines

@@ -26,1370 +26,1370 @@
  */
 final class EE_System implements ResettableInterface
 {
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-    /**
-     * @var EE_System $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int $_req_type
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean $_major_version_change
-     */
-    private $_major_version_change = false;
-
-    /**
-     * A Context DTO dedicated solely to identifying the current request type.
-     *
-     * @var RequestTypeContextCheckerInterface $request_type
-     */
-    private $request_type;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes
-     */
-    private $register_custom_post_types;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies
-     */
-    private $register_custom_taxonomies;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms
-     */
-    private $register_custom_taxonomy_terms;
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Registry|null         $registry
-     * @param LoaderInterface|null     $loader
-     * @param RequestInterface|null    $request
-     * @param EE_Maintenance_Mode|null $maintenance_mode
-     * @return EE_System
-     */
-    public static function instance(
-        EE_Registry $registry = null,
-        LoaderInterface $loader = null,
-        RequestInterface $request = null,
-        EE_Maintenance_Mode $maintenance_mode = null
-    ) {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset()
-    {
-        self::$_instance->_req_type = null;
-        // make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        // we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-    /**
-     * sets hooks for running rest of system
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     * starting EE Addons from any other point may lead to problems
-     *
-     * @param EE_Registry         $registry
-     * @param LoaderInterface     $loader
-     * @param RequestInterface    $request
-     * @param EE_Maintenance_Mode $maintenance_mode
-     */
-    private function __construct(
-        EE_Registry $registry,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        EE_Maintenance_Mode $maintenance_mode
-    ) {
-        $this->registry = $registry;
-        $this->loader = $loader;
-        $this->request = $request;
-        $this->maintenance_mode = $maintenance_mode;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCapabilities'),
-            5
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCommandBus'),
-            7
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadPluginApi'),
-            9
-        );
-        // give caff stuff a chance to play during the activation process too.
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'brewCaffeinated'],
-            9
-        );
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'load_espresso_addons')
-        );
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
-        // detect whether install or upgrade
-        add_action(
-            'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
-            array($this, 'detect_activations_or_upgrades'),
-            3
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'load_core_configuration'),
-            5
-        );
-        // load specifications for matching routes to current request
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'loadRouteMatchSpecifications')
-        );
-        // load specifications for custom post types
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'loadCustomPostTypes')
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_modules_and_widgets'),
-            7
-        );
-        // you wanna get going? I wanna get going... let's get going!
-        add_action(
-            'AHEE__EE_Bootstrap__brew_espresso',
-            array($this, 'brew_espresso'),
-            9
-        );
-        // other housekeeping
-        // exclude EE critical pages from wp_list_pages
-        add_filter(
-            'wp_list_pages_excludes',
-            array($this, 'remove_pages_from_wp_list_pages'),
-            10
-        );
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-    /**
-     * load and setup EE_Capabilities
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCapabilities()
-    {
-        $this->capabilities = $this->loader->getShared('EE_Capabilities');
-        add_action(
-            'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function () {
-                LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            }
-        );
-    }
-
-
-    /**
-     * create and cache the CommandBus, and also add middleware
-     * The CapChecker middleware requires the use of EE_Capabilities
-     * which is why we need to load the CommandBus after Caps are set up
-     * CommandBus middleware operate FIFO - First In First Out
-     * so LocateMovedCommands will run first in order to return any new commands
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCommandBus()
-    {
-        $this->loader->getShared(
-            'CommandBusInterface',
-            array(
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    array(
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\LocateMovedCommands'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadPluginApi()
-    {
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-    }
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     * @throws EE_Error
-     */
-    public function brewCaffeinated()
-    {
-        /** @var Domain $domain */
-        $domain = DomainFactory::getShared(
-            new FullyQualifiedName(
-                'EventEspresso\core\domain\Domain'
-            ),
-            [
-                new FilePath(EVENT_ESPRESSO_MAIN_FILE),
-                Version::fromString(espresso_version()),
-            ]
-        );
-        static $brew;
-        if ($domain->isCaffeinated() && ! $brew instanceof EE_Brewing_Regular) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-            /** @var EE_Brewing_Regular $brew */
-            $brew = LoaderFactory::getLoader()->getShared(EE_Brewing_Regular::class);
-            $brew->initializePUE();
-            add_action(
-                'AHEE__EE_System__load_core_configuration__begin',
-                [$brew, 'caffeinated']
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param string $version_constant
-     * @param string $min_version_required
-     * @param string $load_callback
-     * @param string $plugin_file_constant
-     * @return void
-     */
-    private function deactivateIncompatibleAddon(
-        $addon_name,
-        $version_constant,
-        $min_version_required,
-        $load_callback,
-        $plugin_file_constant
-    ) {
-        if (! defined($version_constant)) {
-            return;
-        }
-        $addon_version = constant($version_constant);
-        if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
-            remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
-            }
-            deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
-            $this->request->unSetRequestParams(['activate', 'activate-multi'], true);
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
-                        'event_espresso'
-                    ),
-                    $addon_name,
-                    $min_version_required
-                ),
-                __FILE__,
-                __FUNCTION__ . "({$addon_name})",
-                __LINE__
-            );
-            EE_Error::get_notices(false, true);
-        }
-    }
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hook point
-     *
-     * @access public
-     * @return void
-     */
-    public function load_espresso_addons()
-    {
-        $this->deactivateIncompatibleAddon(
-            'Wait Lists',
-            'EE_WAIT_LISTS_VERSION',
-            '1.0.0.beta.074',
-            'load_espresso_wait_lists',
-            'EE_WAIT_LISTS_PLUGIN_FILE'
-        );
-        $this->deactivateIncompatibleAddon(
-            'Automated Upcoming Event Notifications',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
-            '1.0.0.beta.091',
-            'load_espresso_automated_upcoming_event_notification',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
-        );
-        do_action('AHEE__EE_System__load_espresso_addons');
-        // if the WP API basic auth plugin isn't already loaded, load it now.
-        // We want it for mobile apps. Just include the entire plugin
-        // also, don't load the basic auth when a plugin is getting activated, because
-        // it could be the basic auth plugin, and it doesn't check if its methods are already defined
-        // and causes a fatal error
-        if (
-            ($this->request->isWordPressApi() || $this->request->isApi())
-            && $this->request->getRequestParam('activate') !== 'true'
-            && ! function_exists('json_basic_auth_handler')
-            && ! function_exists('json_basic_auth_error')
-            && ! in_array(
-                $this->request->getRequestParam('action'),
-                array('activate', 'activate-selected'),
-                true
-            )
-        ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
-        }
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
-    }
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        // first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                // detect teh request type for that addon
-                $addon->detect_req_type();
-            }
-        }
-    }
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type = $this->detect_req_type($espresso_db_update);
-        // EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                // migrations may be required now that we've upgraded
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                // its possible migrations are no longer required
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    private function _handle_core_version_change($espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param mixed $espresso_db_update           the value of the WordPress option.
-     *                                            If not supplied, fetches it from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null)
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if (! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = array();
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = array($espresso_db_update => array());
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = array();
-            // if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    // the key is an int, and the value IS NOT an array
-                    // so it must be numerically-indexed, where values are versions installed...
-                    // fix it!
-                    $version_string = $should_be_array;
-                    $corrected_db_update[ $version_string ] = array('unknown-date');
-                } else {
-                    // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return $espresso_db_update;
-    }
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     * @throws EE_Error
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        // only initialize system if we're not in maintenance mode.
-        if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = $this->loader->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flush();
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if (
-            $request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
-        }
-    }
-
-
-    /**
-     * Initializes the db for all registered addons
-     *
-     * @throws EE_Error
-     */
-    public function initialize_addons()
-    {
-        // foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                $addon->initialize_db_if_no_migrations_required();
-            }
-        }
-    }
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param    array  $version_history
-     * @param    string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
-    {
-        if (! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null)
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update = ! empty($espresso_db_update)
-                ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type = EE_System::detect_req_type_given_activation_history(
-                $espresso_db_update,
-                'ee_espresso_activation',
-                espresso_version()
-            );
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-            $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
-        }
-        return $this->_req_type;
-    }
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    private function _detect_major_version_change($activation_history)
-    {
-        $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts = explode('.', espresso_version());
-        return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
-               && ($previous_version_parts[0] !== $current_version_parts[0]
-                   || $previous_version_parts[1] !== $current_version_parts[1]
-               );
-    }
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change()
-    {
-        return $this->_major_version_change;
-    }
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_*
-     */
-    public static function detect_req_type_given_activation_history(
-        $activation_history_for_addon,
-        $activation_indicator_option_name,
-        $version_to_upgrade_to
-    ) {
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
-        if ($activation_history_for_addon) {
-            // it exists, so this isn't a completely new install
-            // check if this version already in that list of previously installed versions
-            if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
-                // it a version we haven't seen before
-                if ($version_is_higher === 1) {
-                    $req_type = EE_System::req_type_upgrade;
-                } else {
-                    $req_type = EE_System::req_type_downgrade;
-                }
-                delete_option($activation_indicator_option_name);
-            } else {
-                // its not an update. maybe a reactivation?
-                if (get_option($activation_indicator_option_name, false)) {
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        // we've seen this version before, but it's an activation. must be a reactivation
-                        $req_type = EE_System::req_type_reactivation;
-                    } else {// $version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                    delete_option($activation_indicator_option_name);
-                } else {
-                    // we've seen this version before and the activation indicate doesn't show it was just activated
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        // we've seen this version before and it's not an activation. its normal request
-                        $req_type = EE_System::req_type_normal;
-                    } else {// $version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                }
-            }
-        } else {
-            // brand new install
-            $req_type = EE_System::req_type_new_activation;
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
-     *                                             sometimes containing 'unknown-date'
-     * @param string $version_to_upgrade_to        (current version)
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
-    {
-        // find the most recently-activated version
-        $most_recently_active_version =
-            EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
-        return version_compare($version_to_upgrade_to, $most_recently_active_version);
-    }
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    private static function _get_most_recently_active_version_from_activation_history($activation_history)
-    {
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $times_activated) {
-                // check there is a record of when this version was activated. Otherwise,
-                // mark it as unknown
-                if (! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if (
-                        $an_activation !== 'unknown-date'
-                        && $an_activation
-                           > $most_recently_active_version_activation
-                    ) {
-                        $most_recently_active_version = $version;
-                        $most_recently_active_version_activation = $an_activation === 'unknown-date'
-                            ? '1970-01-01 00:00:00'
-                            : $an_activation;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        // if current user is an admin and it's not an ajax or rest request
-        if (
-            ! isset($notices['errors'])
-            && $this->request->isAdmin()
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->capabilities->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = array('page' => 'espresso_about');
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            wp_safe_redirect($url);
-            exit();
-        }
-    }
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->loader->getShared('EE_Load_Textdomain');
-        // load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load and setup EE_Config and EE_Network_Config
-        $config = $this->loader->getShared('EE_Config');
-        $this->loader->getShared('EE_Network_Config');
-        // setup autoloaders
-        // enable logging?
-        $this->loader->getShared('EventEspresso\core\services\orm\TrashLogger');
-        if ($config->admin->use_remote_logging) {
-            $this->loader->getShared('EE_Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        // configure custom post type definitions
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _parse_model_names()
-    {
-        // get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
-        $model_names = array();
-        $non_abstract_db_models = array();
-        foreach ($models as $model) {
-            // get model classname
-            $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
-            }
-            $model_names[ $short_name ] = $classname;
-        }
-        $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters(
-            'FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models
-        );
-    }
-
-
-    /**
-     * @since 4.9.71.p
-     * @throws Exception
-     */
-    public function loadRouteMatchSpecifications()
-    {
-        try {
-            $this->loader->getShared(
-                'EventEspresso\core\services\route_match\RouteMatchSpecificationManager'
-            );
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-        do_action('AHEE__EE_System__loadRouteMatchSpecifications');
-    }
-
-
-    /**
-     * loading CPT related classes earlier so that their definitions are available
-     * but not performing any actual registration with WP core until load_CPTs_and_session() is called
-     *
-     * @since   4.10.21.p
-     */
-    public function loadCustomPostTypes()
-    {
-        $this->register_custom_taxonomies = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
-        );
-        $this->register_custom_post_types = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
-        );
-        $this->register_custom_taxonomy_terms = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
-        );
-        // integrate WP_Query with the EE models
-        $this->loader->getShared('EE_CPT_Strategy');
-        // load legacy EE_Request_Handler in case add-ons still need it
-        $this->loader->getShared('EE_Request_Handler');
-    }
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) {
-            // load, register, and add shortcodes the new way
-            $this->loader->getShared('EventEspresso\core\services\shortcodes\ShortcodesManager');
-        }
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hook point
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
-            'AHEE__EE_System__register_shortcodes_modules_and_addons'
-        );
-        if (! empty($class_names)) {
-            $msg = esc_html__(
-                'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso'
-            );
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - '
-                        . str_replace(
-                            array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
-                            '',
-                            $class_name
-                        ) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= esc_html__(
-                'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso'
-            );
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
-        add_action('init', array($this, 'load_controllers'), 7);
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
-        add_action('init', array($this, 'initialize'), 10);
-        add_action('init', array($this, 'initialize_last'), 100);
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-        $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
-        // caps need to be initialized on every request so that capability maps are set.
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-    }
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if (! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', array());
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        $this->request->unSetRequestParams(['activate'], true);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        $this->register_custom_taxonomies->registerCustomTaxonomies();
-        $this->register_custom_post_types->registerCustomPostTypes();
-        $this->register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
-        // load legacy Custom Post Types and Taxonomies
-        $this->loader->getShared('EE_Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        // let's get it started
-        if (
-            ! $this->maintenance_mode->level()
-            && ($this->request->isFrontend() || $this->request->isFrontAjax())
-        ) {
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-            $this->loader->getShared('EE_Front_Controller');
-        } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) {
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-            $this->loader->getShared('EE_Admin');
-        } elseif ($this->request->isWordPressHeartbeat()) {
-            $this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat');
-        }
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function core_loaded_and_ready()
-    {
-        if (
-            $this->request->isAdmin()
-            || $this->request->isFrontend()
-            || $this->request->isIframe()
-            || $this->request->isWordPressApi()
-        ) {
-            try {
-                $this->loader->getShared('EventEspresso\core\services\assets\I18nRegistry', [[]]);
-                $this->loader->getShared('EventEspresso\core\services\assets\Registry');
-                $this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager');
-                if ($this->canLoadBlocks()) {
-                    $this->loader->getShared(
-                        'EventEspresso\core\services\editor\BlockRegistrationManager'
-                    );
-                }
-            } catch (Exception $exception) {
-                new ExceptionStackTraceDisplay($exception);
-            }
-        }
-        if (
-            $this->request->isAdmin()
-            || $this->request->isEeAjax()
-            || $this->request->isFrontend()
-        ) {
-            $this->loader->getShared('EE_Session');
-        }
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        // always load template tags, because it's faster than checking if it's a front-end request, and many page
-        // builders require these even on the front-end
-        require_once EE_PUBLIC . 'template_tags.php';
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-    }
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-        add_filter(
-            'safe_style_css',
-            function ($styles) {
-                $styles[] = 'display';
-                $styles[] = 'visibility';
-                $styles[] = 'position';
-                $styles[] = 'top';
-                $styles[] = 'right';
-                $styles[] = 'bottom';
-                $styles[] = 'left';
-                $styles[] = 'resize';
-                $styles[] = 'max-width';
-                $styles[] = 'max-height';
-                return $styles;
-            }
-        );
-    }
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize_last()
-    {
-        do_action('AHEE__EE_System__initialize_last');
-        /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-        $rewrite_rules = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-        );
-        $rewrite_rules->flushRewriteRules();
-        add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
-        if (
-            ($this->request->isAjax() || $this->request->isAdmin())
-            && $this->maintenance_mode->models_can_query()
-        ) {
-            $this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
-            $this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager');
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function addEspressoToolbar()
-    {
-        $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
-            array($this->registry->CAP)
-        );
-    }
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if (! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if (! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers)
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param  array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages($exclude_array)
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
-
-
-    /**
-     * Return whether blocks can be registered/loaded or not.
-     * @return bool
-     */
-    private function canLoadBlocks()
-    {
-        return apply_filters('FHEE__EE_System__canLoadBlocks', true)
-               && function_exists('register_block_type')
-               // don't load blocks if in the Divi page builder editor context
-               // @see https://github.com/eventespresso/event-espresso-core/issues/814
-               && ! $this->request->getRequestParam('et_fb', false);
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+	/**
+	 * @var EE_System $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int $_req_type
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean $_major_version_change
+	 */
+	private $_major_version_change = false;
+
+	/**
+	 * A Context DTO dedicated solely to identifying the current request type.
+	 *
+	 * @var RequestTypeContextCheckerInterface $request_type
+	 */
+	private $request_type;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes
+	 */
+	private $register_custom_post_types;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies
+	 */
+	private $register_custom_taxonomies;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms
+	 */
+	private $register_custom_taxonomy_terms;
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Registry|null         $registry
+	 * @param LoaderInterface|null     $loader
+	 * @param RequestInterface|null    $request
+	 * @param EE_Maintenance_Mode|null $maintenance_mode
+	 * @return EE_System
+	 */
+	public static function instance(
+		EE_Registry $registry = null,
+		LoaderInterface $loader = null,
+		RequestInterface $request = null,
+		EE_Maintenance_Mode $maintenance_mode = null
+	) {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset()
+	{
+		self::$_instance->_req_type = null;
+		// make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		// we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+	/**
+	 * sets hooks for running rest of system
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 * starting EE Addons from any other point may lead to problems
+	 *
+	 * @param EE_Registry         $registry
+	 * @param LoaderInterface     $loader
+	 * @param RequestInterface    $request
+	 * @param EE_Maintenance_Mode $maintenance_mode
+	 */
+	private function __construct(
+		EE_Registry $registry,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		EE_Maintenance_Mode $maintenance_mode
+	) {
+		$this->registry = $registry;
+		$this->loader = $loader;
+		$this->request = $request;
+		$this->maintenance_mode = $maintenance_mode;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCapabilities'),
+			5
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCommandBus'),
+			7
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadPluginApi'),
+			9
+		);
+		// give caff stuff a chance to play during the activation process too.
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'brewCaffeinated'],
+			9
+		);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'load_espresso_addons')
+		);
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
+		// detect whether install or upgrade
+		add_action(
+			'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
+			array($this, 'detect_activations_or_upgrades'),
+			3
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'load_core_configuration'),
+			5
+		);
+		// load specifications for matching routes to current request
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'loadRouteMatchSpecifications')
+		);
+		// load specifications for custom post types
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'loadCustomPostTypes')
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_modules_and_widgets'),
+			7
+		);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action(
+			'AHEE__EE_Bootstrap__brew_espresso',
+			array($this, 'brew_espresso'),
+			9
+		);
+		// other housekeeping
+		// exclude EE critical pages from wp_list_pages
+		add_filter(
+			'wp_list_pages_excludes',
+			array($this, 'remove_pages_from_wp_list_pages'),
+			10
+		);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+	/**
+	 * load and setup EE_Capabilities
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCapabilities()
+	{
+		$this->capabilities = $this->loader->getShared('EE_Capabilities');
+		add_action(
+			'AHEE__EE_Capabilities__init_caps__before_initialization',
+			function () {
+				LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			}
+		);
+	}
+
+
+	/**
+	 * create and cache the CommandBus, and also add middleware
+	 * The CapChecker middleware requires the use of EE_Capabilities
+	 * which is why we need to load the CommandBus after Caps are set up
+	 * CommandBus middleware operate FIFO - First In First Out
+	 * so LocateMovedCommands will run first in order to return any new commands
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCommandBus()
+	{
+		$this->loader->getShared(
+			'CommandBusInterface',
+			array(
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					array(
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\LocateMovedCommands'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadPluginApi()
+	{
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+	}
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 * @throws EE_Error
+	 */
+	public function brewCaffeinated()
+	{
+		/** @var Domain $domain */
+		$domain = DomainFactory::getShared(
+			new FullyQualifiedName(
+				'EventEspresso\core\domain\Domain'
+			),
+			[
+				new FilePath(EVENT_ESPRESSO_MAIN_FILE),
+				Version::fromString(espresso_version()),
+			]
+		);
+		static $brew;
+		if ($domain->isCaffeinated() && ! $brew instanceof EE_Brewing_Regular) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+			/** @var EE_Brewing_Regular $brew */
+			$brew = LoaderFactory::getLoader()->getShared(EE_Brewing_Regular::class);
+			$brew->initializePUE();
+			add_action(
+				'AHEE__EE_System__load_core_configuration__begin',
+				[$brew, 'caffeinated']
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param string $version_constant
+	 * @param string $min_version_required
+	 * @param string $load_callback
+	 * @param string $plugin_file_constant
+	 * @return void
+	 */
+	private function deactivateIncompatibleAddon(
+		$addon_name,
+		$version_constant,
+		$min_version_required,
+		$load_callback,
+		$plugin_file_constant
+	) {
+		if (! defined($version_constant)) {
+			return;
+		}
+		$addon_version = constant($version_constant);
+		if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
+			remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
+			if (! function_exists('deactivate_plugins')) {
+				require_once ABSPATH . 'wp-admin/includes/plugin.php';
+			}
+			deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
+			$this->request->unSetRequestParams(['activate', 'activate-multi'], true);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
+						'event_espresso'
+					),
+					$addon_name,
+					$min_version_required
+				),
+				__FILE__,
+				__FUNCTION__ . "({$addon_name})",
+				__LINE__
+			);
+			EE_Error::get_notices(false, true);
+		}
+	}
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hook point
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_espresso_addons()
+	{
+		$this->deactivateIncompatibleAddon(
+			'Wait Lists',
+			'EE_WAIT_LISTS_VERSION',
+			'1.0.0.beta.074',
+			'load_espresso_wait_lists',
+			'EE_WAIT_LISTS_PLUGIN_FILE'
+		);
+		$this->deactivateIncompatibleAddon(
+			'Automated Upcoming Event Notifications',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
+			'1.0.0.beta.091',
+			'load_espresso_automated_upcoming_event_notification',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
+		);
+		do_action('AHEE__EE_System__load_espresso_addons');
+		// if the WP API basic auth plugin isn't already loaded, load it now.
+		// We want it for mobile apps. Just include the entire plugin
+		// also, don't load the basic auth when a plugin is getting activated, because
+		// it could be the basic auth plugin, and it doesn't check if its methods are already defined
+		// and causes a fatal error
+		if (
+			($this->request->isWordPressApi() || $this->request->isApi())
+			&& $this->request->getRequestParam('activate') !== 'true'
+			&& ! function_exists('json_basic_auth_handler')
+			&& ! function_exists('json_basic_auth_error')
+			&& ! in_array(
+				$this->request->getRequestParam('action'),
+				array('activate', 'activate-selected'),
+				true
+			)
+		) {
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
+		}
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
+	}
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		// first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				// detect teh request type for that addon
+				$addon->detect_req_type();
+			}
+		}
+	}
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type = $this->detect_req_type($espresso_db_update);
+		// EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				// migrations may be required now that we've upgraded
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				// its possible migrations are no longer required
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	private function _handle_core_version_change($espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		// get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param mixed $espresso_db_update           the value of the WordPress option.
+	 *                                            If not supplied, fetches it from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null)
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if (! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if (! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = array();
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = array($espresso_db_update => array());
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = array();
+			// if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					// the key is an int, and the value IS NOT an array
+					// so it must be numerically-indexed, where values are versions installed...
+					// fix it!
+					$version_string = $should_be_array;
+					$corrected_db_update[ $version_string ] = array('unknown-date');
+				} else {
+					// ok it checks out
+					$corrected_db_update[ $should_be_version_string ] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return $espresso_db_update;
+	}
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		// only initialize system if we're not in maintenance mode.
+		if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = $this->loader->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flush();
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if (
+			$request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
+		}
+	}
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 *
+	 * @throws EE_Error
+	 */
+	public function initialize_addons()
+	{
+		// foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				$addon->initialize_db_if_no_migrations_required();
+			}
+		}
+	}
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param    array  $version_history
+	 * @param    string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
+	{
+		if (! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null)
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update = ! empty($espresso_db_update)
+				? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type = EE_System::detect_req_type_given_activation_history(
+				$espresso_db_update,
+				'ee_espresso_activation',
+				espresso_version()
+			);
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+			$this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
+		}
+		return $this->_req_type;
+	}
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	private function _detect_major_version_change($activation_history)
+	{
+		$previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts = explode('.', espresso_version());
+		return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
+			   && ($previous_version_parts[0] !== $current_version_parts[0]
+				   || $previous_version_parts[1] !== $current_version_parts[1]
+			   );
+	}
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change()
+	{
+		return $this->_major_version_change;
+	}
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_*
+	 */
+	public static function detect_req_type_given_activation_history(
+		$activation_history_for_addon,
+		$activation_indicator_option_name,
+		$version_to_upgrade_to
+	) {
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
+		if ($activation_history_for_addon) {
+			// it exists, so this isn't a completely new install
+			// check if this version already in that list of previously installed versions
+			if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
+				// it a version we haven't seen before
+				if ($version_is_higher === 1) {
+					$req_type = EE_System::req_type_upgrade;
+				} else {
+					$req_type = EE_System::req_type_downgrade;
+				}
+				delete_option($activation_indicator_option_name);
+			} else {
+				// its not an update. maybe a reactivation?
+				if (get_option($activation_indicator_option_name, false)) {
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						// we've seen this version before, but it's an activation. must be a reactivation
+						$req_type = EE_System::req_type_reactivation;
+					} else {// $version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+					delete_option($activation_indicator_option_name);
+				} else {
+					// we've seen this version before and the activation indicate doesn't show it was just activated
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						// we've seen this version before and it's not an activation. its normal request
+						$req_type = EE_System::req_type_normal;
+					} else {// $version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+				}
+			}
+		} else {
+			// brand new install
+			$req_type = EE_System::req_type_new_activation;
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
+	 *                                             sometimes containing 'unknown-date'
+	 * @param string $version_to_upgrade_to        (current version)
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
+	{
+		// find the most recently-activated version
+		$most_recently_active_version =
+			EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
+		return version_compare($version_to_upgrade_to, $most_recently_active_version);
+	}
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	private static function _get_most_recently_active_version_from_activation_history($activation_history)
+	{
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $times_activated) {
+				// check there is a record of when this version was activated. Otherwise,
+				// mark it as unknown
+				if (! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if (
+						$an_activation !== 'unknown-date'
+						&& $an_activation
+						   > $most_recently_active_version_activation
+					) {
+						$most_recently_active_version = $version;
+						$most_recently_active_version_activation = $an_activation === 'unknown-date'
+							? '1970-01-01 00:00:00'
+							: $an_activation;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		// if current user is an admin and it's not an ajax or rest request
+		if (
+			! isset($notices['errors'])
+			&& $this->request->isAdmin()
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->capabilities->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = array('page' => 'espresso_about');
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			wp_safe_redirect($url);
+			exit();
+		}
+	}
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->loader->getShared('EE_Load_Textdomain');
+		// load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load and setup EE_Config and EE_Network_Config
+		$config = $this->loader->getShared('EE_Config');
+		$this->loader->getShared('EE_Network_Config');
+		// setup autoloaders
+		// enable logging?
+		$this->loader->getShared('EventEspresso\core\services\orm\TrashLogger');
+		if ($config->admin->use_remote_logging) {
+			$this->loader->getShared('EE_Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		// configure custom post type definitions
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _parse_model_names()
+	{
+		// get all the files in the EE_MODELS folder that end in .model.php
+		$models = glob(EE_MODELS . '*.model.php');
+		$model_names = array();
+		$non_abstract_db_models = array();
+		foreach ($models as $model) {
+			// get model classname
+			$classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[ $short_name ] = $classname;
+			}
+			$model_names[ $short_name ] = $classname;
+		}
+		$this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters(
+			'FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models
+		);
+	}
+
+
+	/**
+	 * @since 4.9.71.p
+	 * @throws Exception
+	 */
+	public function loadRouteMatchSpecifications()
+	{
+		try {
+			$this->loader->getShared(
+				'EventEspresso\core\services\route_match\RouteMatchSpecificationManager'
+			);
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+		do_action('AHEE__EE_System__loadRouteMatchSpecifications');
+	}
+
+
+	/**
+	 * loading CPT related classes earlier so that their definitions are available
+	 * but not performing any actual registration with WP core until load_CPTs_and_session() is called
+	 *
+	 * @since   4.10.21.p
+	 */
+	public function loadCustomPostTypes()
+	{
+		$this->register_custom_taxonomies = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
+		);
+		$this->register_custom_post_types = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
+		);
+		$this->register_custom_taxonomy_terms = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
+		);
+		// integrate WP_Query with the EE models
+		$this->loader->getShared('EE_CPT_Strategy');
+		// load legacy EE_Request_Handler in case add-ons still need it
+		$this->loader->getShared('EE_Request_Handler');
+	}
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) {
+			// load, register, and add shortcodes the new way
+			$this->loader->getShared('EventEspresso\core\services\shortcodes\ShortcodesManager');
+		}
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hook point
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
+			'AHEE__EE_System__register_shortcodes_modules_and_addons'
+		);
+		if (! empty($class_names)) {
+			$msg = esc_html__(
+				'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso'
+			);
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - '
+						. str_replace(
+							array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
+							'',
+							$class_name
+						) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= esc_html__(
+				'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso'
+			);
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
+		add_action('init', array($this, 'load_controllers'), 7);
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
+		add_action('init', array($this, 'initialize'), 10);
+		add_action('init', array($this, 'initialize_last'), 100);
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+		$this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
+		// caps need to be initialized on every request so that capability maps are set.
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+	}
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', array());
+		if (! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', array());
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						$this->request->unSetRequestParams(['activate'], true);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		$this->register_custom_taxonomies->registerCustomTaxonomies();
+		$this->register_custom_post_types->registerCustomPostTypes();
+		$this->register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
+		// load legacy Custom Post Types and Taxonomies
+		$this->loader->getShared('EE_Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		// let's get it started
+		if (
+			! $this->maintenance_mode->level()
+			&& ($this->request->isFrontend() || $this->request->isFrontAjax())
+		) {
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+			$this->loader->getShared('EE_Front_Controller');
+		} elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) {
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+			$this->loader->getShared('EE_Admin');
+		} elseif ($this->request->isWordPressHeartbeat()) {
+			$this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat');
+		}
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function core_loaded_and_ready()
+	{
+		if (
+			$this->request->isAdmin()
+			|| $this->request->isFrontend()
+			|| $this->request->isIframe()
+			|| $this->request->isWordPressApi()
+		) {
+			try {
+				$this->loader->getShared('EventEspresso\core\services\assets\I18nRegistry', [[]]);
+				$this->loader->getShared('EventEspresso\core\services\assets\Registry');
+				$this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager');
+				if ($this->canLoadBlocks()) {
+					$this->loader->getShared(
+						'EventEspresso\core\services\editor\BlockRegistrationManager'
+					);
+				}
+			} catch (Exception $exception) {
+				new ExceptionStackTraceDisplay($exception);
+			}
+		}
+		if (
+			$this->request->isAdmin()
+			|| $this->request->isEeAjax()
+			|| $this->request->isFrontend()
+		) {
+			$this->loader->getShared('EE_Session');
+		}
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		// always load template tags, because it's faster than checking if it's a front-end request, and many page
+		// builders require these even on the front-end
+		require_once EE_PUBLIC . 'template_tags.php';
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+	}
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+		add_filter(
+			'safe_style_css',
+			function ($styles) {
+				$styles[] = 'display';
+				$styles[] = 'visibility';
+				$styles[] = 'position';
+				$styles[] = 'top';
+				$styles[] = 'right';
+				$styles[] = 'bottom';
+				$styles[] = 'left';
+				$styles[] = 'resize';
+				$styles[] = 'max-width';
+				$styles[] = 'max-height';
+				return $styles;
+			}
+		);
+	}
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize_last()
+	{
+		do_action('AHEE__EE_System__initialize_last');
+		/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+		$rewrite_rules = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+		);
+		$rewrite_rules->flushRewriteRules();
+		add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
+		if (
+			($this->request->isAjax() || $this->request->isAdmin())
+			&& $this->maintenance_mode->models_can_query()
+		) {
+			$this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
+			$this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager');
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function addEspressoToolbar()
+	{
+		$this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
+			array($this->registry->CAP)
+		);
+	}
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if (! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if (! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if (! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers)
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages($exclude_array)
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
+
+
+	/**
+	 * Return whether blocks can be registered/loaded or not.
+	 * @return bool
+	 */
+	private function canLoadBlocks()
+	{
+		return apply_filters('FHEE__EE_System__canLoadBlocks', true)
+			   && function_exists('register_block_type')
+			   // don't load blocks if in the Divi page builder editor context
+			   // @see https://github.com/eventespresso/event-espresso-core/issues/814
+			   && ! $this->request->getRequestParam('et_fb', false);
+	}
 }

core/helpers/EEH_Schema.helper.php

Indentation +294 added lines, -294 removed lines

@@ -12,298 +12,298 @@
  */
 class EEH_Schema
 {
-    /**
-     * generates JSON-based linked data for an event
-     *
-     * @param EE_Event $event
-     * @throws EE_Error
-     */
-    public static function add_json_linked_data_for_event(EE_Event $event)
-    {
-        // Check we have a valid datetime for the event
-        if (! $event->primary_datetime() instanceof EE_Datetime) {
-            return;
-        }
-
-        $template_args = array(
-            'event_permalink' => '',
-            'event_name' => '',
-            'event_description' => '',
-            'event_start' => '',
-            'event_end' => '',
-            'event_attendance_mode' => '',
-            'event_status' => '',
-            'currency' => '',
-            'event_tickets' => array(),
-            'venue_name' => '',
-            'venue_url' => '',
-            'venue_locality' => '',
-            'venue_region' => '',
-            'venue_address' => '',
-            'event_image' => '',
-        );
-        $template_args['event_permalink'] = $event->get_permalink();
-        $template_args['event_name'] = $event->name();
-        $template_args['event_description'] = wp_strip_all_tags($event->short_description(200));
-        // clone datetime so that date formats don't override those for the original datetime
-        $primary_datetime = clone $event->primary_datetime();
-        $template_args['event_start'] = $primary_datetime->start_date(DateTime::ATOM);
-        $template_args['event_end'] = $primary_datetime->end_date(DateTime::ATOM);
-        unset($primary_datetime);
-        switch ($event->status()) {
-            case EEM_Event::cancelled:
-                $event_status = 'EventCancelled';
-                break;
-            case EEM_Event::postponed:
-                $event_status = 'EventPostponed';
-                break;
-            default:
-                $event_status = 'EventScheduled';
-        }
-        $template_args['event_attendance_mode'] = 'OfflineEventAttendanceMode';
-        $template_args['event_status'] = 'https://schema.org/' . $event_status;
-        $template_args['currency'] = EE_Registry::instance()->CFG->currency->code;
-        foreach ($event->tickets() as $original_ticket) {
-            // clone tickets so that date formats don't override those for the original ticket
-            $ticket = clone $original_ticket;
-            $ID = $ticket->ID();
-            $template_args['event_tickets'][ $ID ]['start_date'] = $ticket->start_date(DateTime::ATOM, null);
-            $template_args['event_tickets'][ $ID ]['end_date'] = $ticket->end_date(DateTime::ATOM, null);
-            $template_args['event_tickets'][ $ID ]['price'] = number_format(
-                $ticket->price(),
-                EE_Registry::instance()->CFG->currency->dec_plc,
-                EE_Registry::instance()->CFG->currency->dec_mrk,
-                ''
-            );
-            switch ($ticket->ticket_status()) {
-                case 'TKO':
-                    $availability = 'InStock';
-                    break;
-                case 'TKS':
-                    $availability = 'SoldOut';
-                    break;
-                default:
-                    $availability = null;
-                    break;
-            }
-            $template_args['event_tickets'][ $ID ]['availability'] = $availability;
-            unset($ticket);
-        }
-        $VNU_ID = espresso_venue_id();
-        if (! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
-            $venue = EEH_Venue_View::get_venue($VNU_ID);
-            $template_args['venue_name'] = get_the_title($VNU_ID);
-            $template_args['venue_url'] = get_permalink($VNU_ID);
-            $template_args['venue_locality'] = $venue->city();
-            $template_args['venue_region'] = $venue->state_name();
-            $template_args['venue_address'] = $venue->address();
-            if ($venue->virtual_url() !== '') {
-                $template_args['event_attendance_mode'] = 'OnlineEventAttendanceMode';
-            }
-            if ($venue->virtual_url() !== '' && $venue->address() !== '') {
-                $template_args['event_attendance_mode'] = 'MixedEventAttendanceMode';
-            }
-        }
-        $template_args['event_image'] = $event->feature_image_url();
-        $template_args = apply_filters(
-            'FHEE__EEH_Schema__add_json_linked_data_for_event__template_args',
-            $template_args,
-            $event,
-            $VNU_ID
-        );
-        extract($template_args, EXTR_OVERWRITE);
-        include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
-    }
-
-
-    /**
-     *    location
-     *    The location of the event, organization or action.
-     *    Should include the Venue name AND schema formatted address info
-     *
-     * @access public
-     * @param string $location
-     * @return string
-     */
-    public static function location($location = null)
-    {
-        return ! empty($location) ? '<div itemprop="location" itemscope itemtype="http://schema.org/Place">'
-                                      . $location
-                                      . '</div>' : '';
-    }
-
-
-
-    /**
-     *    name
-     *    The name of the Event or Venue.
-     *
-     * @access public
-     * @param string $name
-     * @return string
-     */
-    public static function name($name = null)
-    {
-        return ! empty($name) ? '<span itemprop="name">' . $name . '</span>' : '';
-    }
-
-
-
-    /**
-     *    streetAddress
-     *    The street address. For example, 1600 Amphitheatre Pkwy.
-     *
-     * @access public
-     * @param AddressInterface $obj_with_address
-     * @return string
-     */
-    public static function streetAddress(AddressInterface $obj_with_address = null)
-    {
-        return $obj_with_address->address() !== null && $obj_with_address->address() !== ''
-            ? '<span itemprop="streetAddress">' . $obj_with_address->address() . '</span>' : '';
-    }
-
-
-
-    /**
-     *    postOfficeBoxNumber
-     *    The post office box number for PO box addresses.
-     *
-     * @access public
-     * @param AddressInterface $obj_with_address
-     * @return string
-     */
-    public static function postOfficeBoxNumber(AddressInterface $obj_with_address = null)
-    {
-        // regex check for some form of PO Box or P.O. Box, etc, etc, etc
-        if (
-            preg_match(
-                "/^\s*((P(OST)?.?\s*(O(FF(ICE)?)?)?.?\s+(B(IN|OX))?)|B(IN|OX))/i",
-                $obj_with_address->address2()
-            )
-        ) {
-            return $obj_with_address->address2() !== null && $obj_with_address->address2() !== ''
-                ? '<span itemprop="postOfficeBoxNumber">' . $obj_with_address->address2() . '</span>' : '';
-        } else {
-            return $obj_with_address->address2();
-        }
-    }
-
-
-
-    /**
-     *    addressLocality
-     *    The locality (city, town, etc). For example, Mountain View.
-     *
-     * @access public
-     * @param AddressInterface $obj_with_address
-     * @return string
-     */
-    public static function addressLocality(AddressInterface $obj_with_address = null)
-    {
-        return $obj_with_address->city() !== null && $obj_with_address->city() !== ''
-            ? '<span itemprop="addressLocality">' . $obj_with_address->city() . '</span>' : '';
-    }
-
-
-
-    /**
-     *    addressRegion
-     *    The region (state, province, etc). For example, CA.
-     *
-     * @access public
-     * @param AddressInterface $obj_with_address
-     * @return string
-     */
-    public static function addressRegion(AddressInterface $obj_with_address = null)
-    {
-        $state = $obj_with_address->state_name();
-        if (! empty($state)) {
-            return '<span itemprop="addressRegion">' . $state . '</span>';
-        } else {
-            return '';
-        }
-    }
-
-
-
-    /**
-     *    addressCountry
-     *    The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
-     *
-     * @access public
-     * @param AddressInterface $obj_with_address
-     * @return string
-     */
-    public static function addressCountry(AddressInterface $obj_with_address = null)
-    {
-        $country = $obj_with_address->country_name();
-        if (! empty($country)) {
-            return '<span itemprop="addressCountry">' . $country . '</span>';
-        } else {
-            return '';
-        }
-    }
-
-
-
-    /**
-     *    postalCode
-     *    The postal code. For example, 94043.
-     *
-     * @access public
-     * @param AddressInterface $obj_with_address
-     * @return string
-     */
-    public static function postalCode(AddressInterface $obj_with_address = null)
-    {
-        return $obj_with_address->zip() !== null && $obj_with_address->zip() !== '' ? '<span itemprop="postalCode">'
-                                                                                      . $obj_with_address->zip()
-                                                                                      . '</span>' : '';
-    }
-
-
-
-    /**
-     *    telephone
-     *    The telephone number.
-     *
-     * @access public
-     * @param string $phone_nmbr
-     * @return string
-     */
-    public static function telephone($phone_nmbr = null)
-    {
-        return $phone_nmbr !== null && $phone_nmbr !== '' ? '<span itemprop="telephone">' . $phone_nmbr . '</span>'
-            : '';
-    }
-
-
-
-    /**
-     *    URL
-     *    URL of the item as a clickable link
-     *
-     * @access public
-     * @param string $url        - the URL that the link will resolve to
-     * @param string $text       - the text that will be used for the visible link
-     * @param array  $attributes - array of additional link attributes in  attribute_name => value pairs. ie: array( 'title' => 'click here', 'class' => 'link-class' )
-     * @return string (link)
-     */
-    public static function url($url = null, $text = null, $attributes = array())
-    {
-        // Check the URL includes a scheme
-        $parsed_url = parse_url($url);
-        if (empty($parsed_url['scheme'])) {
-            $url = 'https://' . ltrim($url, '/');
-        }
-        $atts = '';
-        foreach ($attributes as $attribute => $value) {
-            $atts .= ' ' . $attribute . '="' . $value . '"';
-        }
-        $text = $text !== null && $text !== '' ? $text : esc_url($url);
-        return ! empty($url)
-            ? '<a itemprop="url" href="' . esc_url_raw($url) . '"' . $atts . '>' . $text . '</a>'
-            : '';
-    }
+	/**
+	 * generates JSON-based linked data for an event
+	 *
+	 * @param EE_Event $event
+	 * @throws EE_Error
+	 */
+	public static function add_json_linked_data_for_event(EE_Event $event)
+	{
+		// Check we have a valid datetime for the event
+		if (! $event->primary_datetime() instanceof EE_Datetime) {
+			return;
+		}
+
+		$template_args = array(
+			'event_permalink' => '',
+			'event_name' => '',
+			'event_description' => '',
+			'event_start' => '',
+			'event_end' => '',
+			'event_attendance_mode' => '',
+			'event_status' => '',
+			'currency' => '',
+			'event_tickets' => array(),
+			'venue_name' => '',
+			'venue_url' => '',
+			'venue_locality' => '',
+			'venue_region' => '',
+			'venue_address' => '',
+			'event_image' => '',
+		);
+		$template_args['event_permalink'] = $event->get_permalink();
+		$template_args['event_name'] = $event->name();
+		$template_args['event_description'] = wp_strip_all_tags($event->short_description(200));
+		// clone datetime so that date formats don't override those for the original datetime
+		$primary_datetime = clone $event->primary_datetime();
+		$template_args['event_start'] = $primary_datetime->start_date(DateTime::ATOM);
+		$template_args['event_end'] = $primary_datetime->end_date(DateTime::ATOM);
+		unset($primary_datetime);
+		switch ($event->status()) {
+			case EEM_Event::cancelled:
+				$event_status = 'EventCancelled';
+				break;
+			case EEM_Event::postponed:
+				$event_status = 'EventPostponed';
+				break;
+			default:
+				$event_status = 'EventScheduled';
+		}
+		$template_args['event_attendance_mode'] = 'OfflineEventAttendanceMode';
+		$template_args['event_status'] = 'https://schema.org/' . $event_status;
+		$template_args['currency'] = EE_Registry::instance()->CFG->currency->code;
+		foreach ($event->tickets() as $original_ticket) {
+			// clone tickets so that date formats don't override those for the original ticket
+			$ticket = clone $original_ticket;
+			$ID = $ticket->ID();
+			$template_args['event_tickets'][ $ID ]['start_date'] = $ticket->start_date(DateTime::ATOM, null);
+			$template_args['event_tickets'][ $ID ]['end_date'] = $ticket->end_date(DateTime::ATOM, null);
+			$template_args['event_tickets'][ $ID ]['price'] = number_format(
+				$ticket->price(),
+				EE_Registry::instance()->CFG->currency->dec_plc,
+				EE_Registry::instance()->CFG->currency->dec_mrk,
+				''
+			);
+			switch ($ticket->ticket_status()) {
+				case 'TKO':
+					$availability = 'InStock';
+					break;
+				case 'TKS':
+					$availability = 'SoldOut';
+					break;
+				default:
+					$availability = null;
+					break;
+			}
+			$template_args['event_tickets'][ $ID ]['availability'] = $availability;
+			unset($ticket);
+		}
+		$VNU_ID = espresso_venue_id();
+		if (! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
+			$venue = EEH_Venue_View::get_venue($VNU_ID);
+			$template_args['venue_name'] = get_the_title($VNU_ID);
+			$template_args['venue_url'] = get_permalink($VNU_ID);
+			$template_args['venue_locality'] = $venue->city();
+			$template_args['venue_region'] = $venue->state_name();
+			$template_args['venue_address'] = $venue->address();
+			if ($venue->virtual_url() !== '') {
+				$template_args['event_attendance_mode'] = 'OnlineEventAttendanceMode';
+			}
+			if ($venue->virtual_url() !== '' && $venue->address() !== '') {
+				$template_args['event_attendance_mode'] = 'MixedEventAttendanceMode';
+			}
+		}
+		$template_args['event_image'] = $event->feature_image_url();
+		$template_args = apply_filters(
+			'FHEE__EEH_Schema__add_json_linked_data_for_event__template_args',
+			$template_args,
+			$event,
+			$VNU_ID
+		);
+		extract($template_args, EXTR_OVERWRITE);
+		include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
+	}
+
+
+	/**
+	 *    location
+	 *    The location of the event, organization or action.
+	 *    Should include the Venue name AND schema formatted address info
+	 *
+	 * @access public
+	 * @param string $location
+	 * @return string
+	 */
+	public static function location($location = null)
+	{
+		return ! empty($location) ? '<div itemprop="location" itemscope itemtype="http://schema.org/Place">'
+									  . $location
+									  . '</div>' : '';
+	}
+
+
+
+	/**
+	 *    name
+	 *    The name of the Event or Venue.
+	 *
+	 * @access public
+	 * @param string $name
+	 * @return string
+	 */
+	public static function name($name = null)
+	{
+		return ! empty($name) ? '<span itemprop="name">' . $name . '</span>' : '';
+	}
+
+
+
+	/**
+	 *    streetAddress
+	 *    The street address. For example, 1600 Amphitheatre Pkwy.
+	 *
+	 * @access public
+	 * @param AddressInterface $obj_with_address
+	 * @return string
+	 */
+	public static function streetAddress(AddressInterface $obj_with_address = null)
+	{
+		return $obj_with_address->address() !== null && $obj_with_address->address() !== ''
+			? '<span itemprop="streetAddress">' . $obj_with_address->address() . '</span>' : '';
+	}
+
+
+
+	/**
+	 *    postOfficeBoxNumber
+	 *    The post office box number for PO box addresses.
+	 *
+	 * @access public
+	 * @param AddressInterface $obj_with_address
+	 * @return string
+	 */
+	public static function postOfficeBoxNumber(AddressInterface $obj_with_address = null)
+	{
+		// regex check for some form of PO Box or P.O. Box, etc, etc, etc
+		if (
+			preg_match(
+				"/^\s*((P(OST)?.?\s*(O(FF(ICE)?)?)?.?\s+(B(IN|OX))?)|B(IN|OX))/i",
+				$obj_with_address->address2()
+			)
+		) {
+			return $obj_with_address->address2() !== null && $obj_with_address->address2() !== ''
+				? '<span itemprop="postOfficeBoxNumber">' . $obj_with_address->address2() . '</span>' : '';
+		} else {
+			return $obj_with_address->address2();
+		}
+	}
+
+
+
+	/**
+	 *    addressLocality
+	 *    The locality (city, town, etc). For example, Mountain View.
+	 *
+	 * @access public
+	 * @param AddressInterface $obj_with_address
+	 * @return string
+	 */
+	public static function addressLocality(AddressInterface $obj_with_address = null)
+	{
+		return $obj_with_address->city() !== null && $obj_with_address->city() !== ''
+			? '<span itemprop="addressLocality">' . $obj_with_address->city() . '</span>' : '';
+	}
+
+
+
+	/**
+	 *    addressRegion
+	 *    The region (state, province, etc). For example, CA.
+	 *
+	 * @access public
+	 * @param AddressInterface $obj_with_address
+	 * @return string
+	 */
+	public static function addressRegion(AddressInterface $obj_with_address = null)
+	{
+		$state = $obj_with_address->state_name();
+		if (! empty($state)) {
+			return '<span itemprop="addressRegion">' . $state . '</span>';
+		} else {
+			return '';
+		}
+	}
+
+
+
+	/**
+	 *    addressCountry
+	 *    The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
+	 *
+	 * @access public
+	 * @param AddressInterface $obj_with_address
+	 * @return string
+	 */
+	public static function addressCountry(AddressInterface $obj_with_address = null)
+	{
+		$country = $obj_with_address->country_name();
+		if (! empty($country)) {
+			return '<span itemprop="addressCountry">' . $country . '</span>';
+		} else {
+			return '';
+		}
+	}
+
+
+
+	/**
+	 *    postalCode
+	 *    The postal code. For example, 94043.
+	 *
+	 * @access public
+	 * @param AddressInterface $obj_with_address
+	 * @return string
+	 */
+	public static function postalCode(AddressInterface $obj_with_address = null)
+	{
+		return $obj_with_address->zip() !== null && $obj_with_address->zip() !== '' ? '<span itemprop="postalCode">'
+																					  . $obj_with_address->zip()
+																					  . '</span>' : '';
+	}
+
+
+
+	/**
+	 *    telephone
+	 *    The telephone number.
+	 *
+	 * @access public
+	 * @param string $phone_nmbr
+	 * @return string
+	 */
+	public static function telephone($phone_nmbr = null)
+	{
+		return $phone_nmbr !== null && $phone_nmbr !== '' ? '<span itemprop="telephone">' . $phone_nmbr . '</span>'
+			: '';
+	}
+
+
+
+	/**
+	 *    URL
+	 *    URL of the item as a clickable link
+	 *
+	 * @access public
+	 * @param string $url        - the URL that the link will resolve to
+	 * @param string $text       - the text that will be used for the visible link
+	 * @param array  $attributes - array of additional link attributes in  attribute_name => value pairs. ie: array( 'title' => 'click here', 'class' => 'link-class' )
+	 * @return string (link)
+	 */
+	public static function url($url = null, $text = null, $attributes = array())
+	{
+		// Check the URL includes a scheme
+		$parsed_url = parse_url($url);
+		if (empty($parsed_url['scheme'])) {
+			$url = 'https://' . ltrim($url, '/');
+		}
+		$atts = '';
+		foreach ($attributes as $attribute => $value) {
+			$atts .= ' ' . $attribute . '="' . $value . '"';
+		}
+		$text = $text !== null && $text !== '' ? $text : esc_url($url);
+		return ! empty($url)
+			? '<a itemprop="url" href="' . esc_url_raw($url) . '"' . $atts . '>' . $text . '</a>'
+			: '';
+	}
 }

Spacing +20 added lines, -20 removed lines

@@ -21,7 +21,7 @@ 
     public static function add_json_linked_data_for_event(EE_Event $event)
     {
         // Check we have a valid datetime for the event
-        if (! $event->primary_datetime() instanceof EE_Datetime) {
+        if ( ! $event->primary_datetime() instanceof EE_Datetime) {
             return;
         }
 
@@ -61,15 +61,15 @@ 
                 $event_status = 'EventScheduled';
         }
         $template_args['event_attendance_mode'] = 'OfflineEventAttendanceMode';
-        $template_args['event_status'] = 'https://schema.org/' . $event_status;
+        $template_args['event_status'] = 'https://schema.org/'.$event_status;
         $template_args['currency'] = EE_Registry::instance()->CFG->currency->code;
         foreach ($event->tickets() as $original_ticket) {
             // clone tickets so that date formats don't override those for the original ticket
             $ticket = clone $original_ticket;
             $ID = $ticket->ID();
-            $template_args['event_tickets'][ $ID ]['start_date'] = $ticket->start_date(DateTime::ATOM, null);
-            $template_args['event_tickets'][ $ID ]['end_date'] = $ticket->end_date(DateTime::ATOM, null);
-            $template_args['event_tickets'][ $ID ]['price'] = number_format(
+            $template_args['event_tickets'][$ID]['start_date'] = $ticket->start_date(DateTime::ATOM, null);
+            $template_args['event_tickets'][$ID]['end_date'] = $ticket->end_date(DateTime::ATOM, null);
+            $template_args['event_tickets'][$ID]['price'] = number_format(
                 $ticket->price(),
                 EE_Registry::instance()->CFG->currency->dec_plc,
                 EE_Registry::instance()->CFG->currency->dec_mrk,
@@ -86,11 +86,11 @@ 
                     $availability = null;
                     break;
             }
-            $template_args['event_tickets'][ $ID ]['availability'] = $availability;
+            $template_args['event_tickets'][$ID]['availability'] = $availability;
             unset($ticket);
         }
         $VNU_ID = espresso_venue_id();
-        if (! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
+        if ( ! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
             $venue = EEH_Venue_View::get_venue($VNU_ID);
             $template_args['venue_name'] = get_the_title($VNU_ID);
             $template_args['venue_url'] = get_permalink($VNU_ID);
@@ -112,7 +112,7 @@ 
             $VNU_ID
         );
         extract($template_args, EXTR_OVERWRITE);
-        include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
+        include EE_TEMPLATES.'json_linked_data_for_event.template.php';
     }
 
 
@@ -144,7 +144,7 @@ 
      */
     public static function name($name = null)
     {
-        return ! empty($name) ? '<span itemprop="name">' . $name . '</span>' : '';
+        return ! empty($name) ? '<span itemprop="name">'.$name.'</span>' : '';
     }
 
 
@@ -160,7 +160,7 @@ 
     public static function streetAddress(AddressInterface $obj_with_address = null)
     {
         return $obj_with_address->address() !== null && $obj_with_address->address() !== ''
-            ? '<span itemprop="streetAddress">' . $obj_with_address->address() . '</span>' : '';
+            ? '<span itemprop="streetAddress">'.$obj_with_address->address().'</span>' : '';
     }
 
 
@@ -183,7 +183,7 @@ 
             )
         ) {
             return $obj_with_address->address2() !== null && $obj_with_address->address2() !== ''
-                ? '<span itemprop="postOfficeBoxNumber">' . $obj_with_address->address2() . '</span>' : '';
+                ? '<span itemprop="postOfficeBoxNumber">'.$obj_with_address->address2().'</span>' : '';
         } else {
             return $obj_with_address->address2();
         }
@@ -202,7 +202,7 @@ 
     public static function addressLocality(AddressInterface $obj_with_address = null)
     {
         return $obj_with_address->city() !== null && $obj_with_address->city() !== ''
-            ? '<span itemprop="addressLocality">' . $obj_with_address->city() . '</span>' : '';
+            ? '<span itemprop="addressLocality">'.$obj_with_address->city().'</span>' : '';
     }
 
 
@@ -218,8 +218,8 @@ 
     public static function addressRegion(AddressInterface $obj_with_address = null)
     {
         $state = $obj_with_address->state_name();
-        if (! empty($state)) {
-            return '<span itemprop="addressRegion">' . $state . '</span>';
+        if ( ! empty($state)) {
+            return '<span itemprop="addressRegion">'.$state.'</span>';
         } else {
             return '';
         }
@@ -238,8 +238,8 @@ 
     public static function addressCountry(AddressInterface $obj_with_address = null)
     {
         $country = $obj_with_address->country_name();
-        if (! empty($country)) {
-            return '<span itemprop="addressCountry">' . $country . '</span>';
+        if ( ! empty($country)) {
+            return '<span itemprop="addressCountry">'.$country.'</span>';
         } else {
             return '';
         }
@@ -274,7 +274,7 @@ 
      */
     public static function telephone($phone_nmbr = null)
     {
-        return $phone_nmbr !== null && $phone_nmbr !== '' ? '<span itemprop="telephone">' . $phone_nmbr . '</span>'
+        return $phone_nmbr !== null && $phone_nmbr !== '' ? '<span itemprop="telephone">'.$phone_nmbr.'</span>'
             : '';
     }
 
@@ -295,15 +295,15 @@ 
         // Check the URL includes a scheme
         $parsed_url = parse_url($url);
         if (empty($parsed_url['scheme'])) {
-            $url = 'https://' . ltrim($url, '/');
+            $url = 'https://'.ltrim($url, '/');
         }
         $atts = '';
         foreach ($attributes as $attribute => $value) {
-            $atts .= ' ' . $attribute . '="' . $value . '"';
+            $atts .= ' '.$attribute.'="'.$value.'"';
         }
         $text = $text !== null && $text !== '' ? $text : esc_url($url);
         return ! empty($url)
-            ? '<a itemprop="url" href="' . esc_url_raw($url) . '"' . $atts . '>' . $text . '</a>'
+            ? '<a itemprop="url" href="'.esc_url_raw($url).'"'.$atts.'>'.$text.'</a>'
             : '';
     }
 }

core/helpers/EEH_Address.helper.php

Indentation +111 added lines, -111 removed lines

@@ -13,124 +13,124 @@
  */
 class EEH_Address
 {
-    /**
-     *    format - output formatted EE object address information
-     *
-     * @access public
-     * @param         object      AddressInterface $obj_with_address
-     * @param string  $type       how the address is formatted. for example: 'multiline' or 'inline'
-     * @param boolean $use_schema whether to apply schema.org formatting to the address
-     * @param bool    $add_wrapper
-     * @return string
-     */
-    public static function format(
-        $obj_with_address = null,
-        $type = 'multiline',
-        $use_schema = true,
-        $add_wrapper = true
-    ) {
-        // check that incoming object implements the AddressInterface interface
-        if (! $obj_with_address instanceof AddressInterface) {
-            $msg = esc_html__('The address could not be formatted.', 'event_espresso');
-            $dev_msg = esc_html__(
-                'The Address Formatter requires passed objects to implement the AddressInterface interface.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-            return null;
-        }
-        // obtain an address formatter
-        $formatter = EEH_Address::_get_formatter($type);
-        // apply schema.org formatting ?
-        $use_schema = ! is_admin() ? $use_schema : false;
-        $formatted_address = $use_schema
-            ? EEH_Address::_schema_formatting($formatter, $obj_with_address)
-            : EEH_Address::_regular_formatting($formatter, $obj_with_address, $add_wrapper);
-        $formatted_address = $add_wrapper && ! $use_schema
-            ? '<div class="espresso-address-dv">' . $formatted_address . '</div>'
-            : $formatted_address;
-        // return the formatted address
-        return $formatted_address;
-    }
+	/**
+	 *    format - output formatted EE object address information
+	 *
+	 * @access public
+	 * @param         object      AddressInterface $obj_with_address
+	 * @param string  $type       how the address is formatted. for example: 'multiline' or 'inline'
+	 * @param boolean $use_schema whether to apply schema.org formatting to the address
+	 * @param bool    $add_wrapper
+	 * @return string
+	 */
+	public static function format(
+		$obj_with_address = null,
+		$type = 'multiline',
+		$use_schema = true,
+		$add_wrapper = true
+	) {
+		// check that incoming object implements the AddressInterface interface
+		if (! $obj_with_address instanceof AddressInterface) {
+			$msg = esc_html__('The address could not be formatted.', 'event_espresso');
+			$dev_msg = esc_html__(
+				'The Address Formatter requires passed objects to implement the AddressInterface interface.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+			return null;
+		}
+		// obtain an address formatter
+		$formatter = EEH_Address::_get_formatter($type);
+		// apply schema.org formatting ?
+		$use_schema = ! is_admin() ? $use_schema : false;
+		$formatted_address = $use_schema
+			? EEH_Address::_schema_formatting($formatter, $obj_with_address)
+			: EEH_Address::_regular_formatting($formatter, $obj_with_address, $add_wrapper);
+		$formatted_address = $add_wrapper && ! $use_schema
+			? '<div class="espresso-address-dv">' . $formatted_address . '</div>'
+			: $formatted_address;
+		// return the formatted address
+		return $formatted_address;
+	}
 
 
 
-    /**
-     *    _get_formatter - obtain the requester formatter class
-     *
-     * @access private
-     * @param string $type how the address is formatted. for example: 'multiline' or 'inline'
-     * @return AddressFormatterInterface
-     */
-    private static function _get_formatter($type)
-    {
-        switch ($type) {
-            case 'multiline':
-                return new EventEspresso\core\services\address\formatters\MultiLineAddressFormatter();
-            case 'inline':
-                return new EventEspresso\core\services\address\formatters\InlineAddressFormatter();
-            default:
-                return new EventEspresso\core\services\address\formatters\NullAddressFormatter();
-        }
-    }
+	/**
+	 *    _get_formatter - obtain the requester formatter class
+	 *
+	 * @access private
+	 * @param string $type how the address is formatted. for example: 'multiline' or 'inline'
+	 * @return AddressFormatterInterface
+	 */
+	private static function _get_formatter($type)
+	{
+		switch ($type) {
+			case 'multiline':
+				return new EventEspresso\core\services\address\formatters\MultiLineAddressFormatter();
+			case 'inline':
+				return new EventEspresso\core\services\address\formatters\InlineAddressFormatter();
+			default:
+				return new EventEspresso\core\services\address\formatters\NullAddressFormatter();
+		}
+	}
 
 
 
-    /**
-     *    _regular_formatting
-     *    adds formatting to an address
-     *
-     * @access private
-     * @param      object AddressInterface_Formatter $formatter
-     * @param      object AddressInterface $obj_with_address
-     * @param bool $add_wrapper
-     * @return string
-     */
-    private static function _regular_formatting(
-        AddressFormatterInterface $formatter,
-        AddressInterface $obj_with_address,
-        $add_wrapper = true
-    ) {
-        $formatted_address = $add_wrapper ? '<div>' : '';
-        $formatted_address .= $formatter->format(
-            $obj_with_address->address(),
-            $obj_with_address->address2(),
-            $obj_with_address->city(),
-            $obj_with_address->state_name(),
-            $obj_with_address->zip(),
-            $obj_with_address->country_name(),
-            $obj_with_address->country_ID()
-        );
-        $formatted_address .= $add_wrapper ? '</div>' : '';
-        // return the formatted address
-        return $formatted_address;
-    }
+	/**
+	 *    _regular_formatting
+	 *    adds formatting to an address
+	 *
+	 * @access private
+	 * @param      object AddressInterface_Formatter $formatter
+	 * @param      object AddressInterface $obj_with_address
+	 * @param bool $add_wrapper
+	 * @return string
+	 */
+	private static function _regular_formatting(
+		AddressFormatterInterface $formatter,
+		AddressInterface $obj_with_address,
+		$add_wrapper = true
+	) {
+		$formatted_address = $add_wrapper ? '<div>' : '';
+		$formatted_address .= $formatter->format(
+			$obj_with_address->address(),
+			$obj_with_address->address2(),
+			$obj_with_address->city(),
+			$obj_with_address->state_name(),
+			$obj_with_address->zip(),
+			$obj_with_address->country_name(),
+			$obj_with_address->country_ID()
+		);
+		$formatted_address .= $add_wrapper ? '</div>' : '';
+		// return the formatted address
+		return $formatted_address;
+	}
 
 
 
-    /**
-     *    _schema_formatting
-     *    adds schema.org formatting to an address
-     *
-     * @access private
-     * @param object AddressFormatterInterface $formatter
-     * @param object AddressInterface $obj_with_address
-     * @return string
-     */
-    private static function _schema_formatting(AddressFormatterInterface $formatter, AddressInterface $obj_with_address)
-    {
-        $formatted_address = '<div itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">';
-        $formatted_address .= $formatter->format(
-            EEH_Schema::streetAddress($obj_with_address),
-            EEH_Schema::postOfficeBoxNumber($obj_with_address),
-            EEH_Schema::addressLocality($obj_with_address),
-            EEH_Schema::addressRegion($obj_with_address),
-            EEH_Schema::postalCode($obj_with_address),
-            EEH_Schema::addressCountry($obj_with_address),
-            $obj_with_address->country_ID()
-        );
-        $formatted_address .= '</div>';
-        // return the formatted address
-        return $formatted_address;
-    }
+	/**
+	 *    _schema_formatting
+	 *    adds schema.org formatting to an address
+	 *
+	 * @access private
+	 * @param object AddressFormatterInterface $formatter
+	 * @param object AddressInterface $obj_with_address
+	 * @return string
+	 */
+	private static function _schema_formatting(AddressFormatterInterface $formatter, AddressInterface $obj_with_address)
+	{
+		$formatted_address = '<div itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">';
+		$formatted_address .= $formatter->format(
+			EEH_Schema::streetAddress($obj_with_address),
+			EEH_Schema::postOfficeBoxNumber($obj_with_address),
+			EEH_Schema::addressLocality($obj_with_address),
+			EEH_Schema::addressRegion($obj_with_address),
+			EEH_Schema::postalCode($obj_with_address),
+			EEH_Schema::addressCountry($obj_with_address),
+			$obj_with_address->country_ID()
+		);
+		$formatted_address .= '</div>';
+		// return the formatted address
+		return $formatted_address;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -30,13 +30,13 @@ 
         $add_wrapper = true
     ) {
         // check that incoming object implements the AddressInterface interface
-        if (! $obj_with_address instanceof AddressInterface) {
+        if ( ! $obj_with_address instanceof AddressInterface) {
             $msg = esc_html__('The address could not be formatted.', 'event_espresso');
             $dev_msg = esc_html__(
                 'The Address Formatter requires passed objects to implement the AddressInterface interface.',
                 'event_espresso'
             );
-            EE_Error::add_error($msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
             return null;
         }
         // obtain an address formatter
@@ -47,7 +47,7 @@ 
             ? EEH_Address::_schema_formatting($formatter, $obj_with_address)
             : EEH_Address::_regular_formatting($formatter, $obj_with_address, $add_wrapper);
         $formatted_address = $add_wrapper && ! $use_schema
-            ? '<div class="espresso-address-dv">' . $formatted_address . '</div>'
+            ? '<div class="espresso-address-dv">'.$formatted_address.'</div>'
             : $formatted_address;
         // return the formatted address
         return $formatted_address;

vendor/autoload.php

Indentation +15 added lines, -15 removed lines

@@ -3,21 +3,21 @@
 // autoload.php @generated by Composer
 
 if (PHP_VERSION_ID < 50600) {
-    if (!headers_sent()) {
-        header('HTTP/1.1 500 Internal Server Error');
-    }
-    $err = 'Composer 2.3.0 dropped support for autoloading on PHP <5.6 and you are running '.PHP_VERSION.', please upgrade PHP or use Composer 2.2 LTS via "composer self-update --2.2". Aborting.'.PHP_EOL;
-    if (!ini_get('display_errors')) {
-        if (PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') {
-            fwrite(STDERR, $err);
-        } elseif (!headers_sent()) {
-            echo $err;
-        }
-    }
-    trigger_error(
-        $err,
-        E_USER_ERROR
-    );
+	if (!headers_sent()) {
+		header('HTTP/1.1 500 Internal Server Error');
+	}
+	$err = 'Composer 2.3.0 dropped support for autoloading on PHP <5.6 and you are running '.PHP_VERSION.', please upgrade PHP or use Composer 2.2 LTS via "composer self-update --2.2". Aborting.'.PHP_EOL;
+	if (!ini_get('display_errors')) {
+		if (PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') {
+			fwrite(STDERR, $err);
+		} elseif (!headers_sent()) {
+			echo $err;
+		}
+	}
+	trigger_error(
+		$err,
+		E_USER_ERROR
+	);
 }
 
 require_once __DIR__ . '/composer/autoload_real.php';

Spacing +4 added lines, -4 removed lines

@@ -3,14 +3,14 @@ 
 // autoload.php @generated by Composer
 
 if (PHP_VERSION_ID < 50600) {
-    if (!headers_sent()) {
+    if ( ! headers_sent()) {
         header('HTTP/1.1 500 Internal Server Error');
     }
     $err = 'Composer 2.3.0 dropped support for autoloading on PHP <5.6 and you are running '.PHP_VERSION.', please upgrade PHP or use Composer 2.2 LTS via "composer self-update --2.2". Aborting.'.PHP_EOL;
-    if (!ini_get('display_errors')) {
+    if ( ! ini_get('display_errors')) {
         if (PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') {
             fwrite(STDERR, $err);
-        } elseif (!headers_sent()) {
+        } elseif ( ! headers_sent()) {
             echo $err;
         }
     }
@@ -20,6 +20,6 @@ 
     );
 }
 
-require_once __DIR__ . '/composer/autoload_real.php';
+require_once __DIR__.'/composer/autoload_real.php';
 
 return ComposerAutoloaderInit400b9a7451a6cbd04853b52d867b55fe::getLoader();

vendor/symfony/css-selector/CssSelectorConverter.php

Indentation +33 added lines, -33 removed lines

@@ -26,42 +26,42 @@
  */
 class CssSelectorConverter
 {
-    private Translator $translator;
-    private array $cache;
+	private Translator $translator;
+	private array $cache;
 
-    private static array $xmlCache = [];
-    private static array $htmlCache = [];
+	private static array $xmlCache = [];
+	private static array $htmlCache = [];
 
-    /**
-     * @param bool $html Whether HTML support should be enabled. Disable it for XML documents
-     */
-    public function __construct(bool $html = true)
-    {
-        $this->translator = new Translator();
+	/**
+	 * @param bool $html Whether HTML support should be enabled. Disable it for XML documents
+	 */
+	public function __construct(bool $html = true)
+	{
+		$this->translator = new Translator();
 
-        if ($html) {
-            $this->translator->registerExtension(new HtmlExtension($this->translator));
-            $this->cache = &self::$htmlCache;
-        } else {
-            $this->cache = &self::$xmlCache;
-        }
+		if ($html) {
+			$this->translator->registerExtension(new HtmlExtension($this->translator));
+			$this->cache = &self::$htmlCache;
+		} else {
+			$this->cache = &self::$xmlCache;
+		}
 
-        $this->translator
-            ->registerParserShortcut(new EmptyStringParser())
-            ->registerParserShortcut(new ElementParser())
-            ->registerParserShortcut(new ClassParser())
-            ->registerParserShortcut(new HashParser())
-        ;
-    }
+		$this->translator
+			->registerParserShortcut(new EmptyStringParser())
+			->registerParserShortcut(new ElementParser())
+			->registerParserShortcut(new ClassParser())
+			->registerParserShortcut(new HashParser())
+		;
+	}
 
-    /**
-     * Translates a CSS expression to its XPath equivalent.
-     *
-     * Optionally, a prefix can be added to the resulting XPath
-     * expression with the $prefix parameter.
-     */
-    public function toXPath(string $cssExpr, string $prefix = 'descendant-or-self::'): string
-    {
-        return $this->cache[$prefix][$cssExpr] ??= $this->translator->cssToXPath($cssExpr, $prefix);
-    }
+	/**
+	 * Translates a CSS expression to its XPath equivalent.
+	 *
+	 * Optionally, a prefix can be added to the resulting XPath
+	 * expression with the $prefix parameter.
+	 */
+	public function toXPath(string $cssExpr, string $prefix = 'descendant-or-self::'): string
+	{
+		return $this->cache[$prefix][$cssExpr] ??= $this->translator->cssToXPath($cssExpr, $prefix);
+	}
 }

vendor/symfony/css-selector/Node/PseudoNode.php

Indentation +31 added lines, -31 removed lines

@@ -23,35 +23,35 @@
  */
 class PseudoNode extends AbstractNode
 {
-    private NodeInterface $selector;
-    private string $identifier;
-
-    public function __construct(NodeInterface $selector, string $identifier)
-    {
-        $this->selector = $selector;
-        $this->identifier = strtolower($identifier);
-    }
-
-    public function getSelector(): NodeInterface
-    {
-        return $this->selector;
-    }
-
-    public function getIdentifier(): string
-    {
-        return $this->identifier;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getSpecificity(): Specificity
-    {
-        return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));
-    }
-
-    public function __toString(): string
-    {
-        return sprintf('%s[%s:%s]', $this->getNodeName(), $this->selector, $this->identifier);
-    }
+	private NodeInterface $selector;
+	private string $identifier;
+
+	public function __construct(NodeInterface $selector, string $identifier)
+	{
+		$this->selector = $selector;
+		$this->identifier = strtolower($identifier);
+	}
+
+	public function getSelector(): NodeInterface
+	{
+		return $this->selector;
+	}
+
+	public function getIdentifier(): string
+	{
+		return $this->identifier;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getSpecificity(): Specificity
+	{
+		return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));
+	}
+
+	public function __toString(): string
+	{
+		return sprintf('%s[%s:%s]', $this->getNodeName(), $this->selector, $this->identifier);
+	}
 }