eventespresso / event-espresso-core

modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php

Indentation +653 added lines, -653 removed lines

@@ -13,657 +13,657 @@
  */
 abstract class EE_SPCO_Reg_Step
 {
-    /**
-     *    $_completed - TRUE if this step has fully completed it's duties
-     *
-     * @access protected
-     * @type bool $_completed
-     */
-    protected $_completed = false;
-
-    /**
-     *    $_is_current_step - TRUE if this is the current step
-     *
-     * @access protected
-     * @type bool $_is_current_step
-     */
-    protected $_is_current_step = false;
-
-    /**
-     *    $_order - when the reg step should be run relative to other steps
-     *
-     * @access protected
-     * @type int $_template
-     */
-    protected $_order = 0;
-
-    /**
-     *    $_slug - URL param for this step
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_slug;
-
-    /**
-     *    $_name - Step Name - translatable string
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_name;
-
-    /**
-     *    $_submit_button_text - translatable string that appears on this step's submit button
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_submit_button_text;
-
-    /**
-     *    $_template - template name
-     *
-     * @access protected
-     * @type string $_template
-     */
-    protected $_template;
-
-    /**
-     *    $_reg_form_name - the form input name and id attribute
-     *
-     * @access protected
-     * @var string $_reg_form_name
-     */
-    protected $_reg_form_name;
-
-    /**
-     *    $_success_message - text to display upon successful form submission
-     *
-     * @access private
-     * @var string $_success_message
-     */
-    protected $_success_message;
-
-    /**
-     *    $_instructions - a brief description of how to complete the reg step.
-     *    Usually displayed in conjunction with the previous step's success message.
-     *
-     * @access private
-     * @var string $_instructions
-     */
-    protected $_instructions;
-
-    /**
-     *    $_valid_data - the normalized and validated data for this step
-     *
-     * @access public
-     * @var array $_valid_data
-     */
-    protected $_valid_data = [];
-
-    /**
-     *    $reg_form - the registration form for this step
-     *
-     * @access public
-     * @var EE_Form_Section_Proper $reg_form
-     */
-    public $reg_form;
-
-    /**
-     *    $checkout - EE_Checkout object for handling the properties of the current checkout process
-     *
-     * @access public
-     * @var EE_Checkout $checkout
-     */
-    public $checkout;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-
-    /**
-     * @return void
-     */
-    abstract public function translate_js_strings();
-
-
-    /**
-     * @return void
-     */
-    abstract public function enqueue_styles_and_scripts();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function initialize_reg_step();
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     */
-    abstract public function generate_reg_form();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function process_reg_step();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function update_reg_step();
-
-
-    /**
-     * @return boolean
-     */
-    public function completed()
-    {
-        return $this->_completed;
-    }
-
-
-    /**
-     * set_completed - toggles $_completed to TRUE
-     */
-    public function set_completed()
-    {
-        // DEBUG LOG
-        // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-        $this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
-    }
-
-
-    /**
-     * set_completed - toggles $_completed to FALSE
-     */
-    public function set_not_completed()
-    {
-        $this->_completed = false;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function name()
-    {
-        return $this->_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->_slug;
-    }
-
-
-    /**
-     * submit_button_text
-     * the text that appears on the reg step form submit button
-     *
-     * @return string
-     */
-    public function submit_button_text()
-    {
-        return $this->_submit_button_text;
-    }
-
-
-    /**
-     * set_submit_button_text
-     * sets the text that appears on the reg step form submit button
-     *
-     * @param string $submit_button_text
-     */
-    public function set_submit_button_text($submit_button_text = '')
-    {
-        if (! empty($submit_button_text)) {
-            $this->_submit_button_text = $submit_button_text;
-        } elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            if ($this->checkout->revisit) {
-                $this->_submit_button_text = sprintf(
-                    esc_html__('Update %s', 'event_espresso'),
-                    $this->checkout->current_step->name()
-                );
-            } else {
-                $this->_submit_button_text = sprintf(
-                    esc_html__('Proceed to %s', 'event_espresso'),
-                    $this->checkout->next_step->name()
-                );
-            }
-        }
-        // filters the submit button text
-        $this->_submit_button_text = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-            $this->_submit_button_text,
-            $this->checkout
-        );
-    }
-
-
-    /**
-     * @param boolean $is_current_step
-     */
-    public function set_is_current_step($is_current_step)
-    {
-        $this->_is_current_step = $is_current_step;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function is_current_step()
-    {
-        return $this->_is_current_step;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function is_final_step()
-    {
-        return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration;
-    }
-
-
-    /**
-     * @param int $order
-     */
-    public function set_order($order)
-    {
-        $this->_order = $order;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function order()
-    {
-        return $this->_order;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function template(): string
-    {
-        return $this->_template;
-    }
-
-
-    /**
-     * @param string $template
-     */
-    public function setTemplate(string $template): void
-    {
-        $this->_template = $template;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function success_message()
-    {
-        return $this->_success_message;
-    }
-
-
-    /**
-     * _set_success_message
-     *
-     * @param string $success_message
-     */
-    protected function _set_success_message($success_message)
-    {
-        $this->_success_message = $success_message;
-    }
-
-
-    /**
-     * _reset_success_message
-     *
-     * @return void
-     */
-    protected function _reset_success_message()
-    {
-        $this->_success_message = '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function _instructions()
-    {
-        return $this->_instructions;
-    }
-
-
-    /**
-     * @param string $instructions
-     */
-    public function set_instructions($instructions)
-    {
-        $this->_instructions = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
-            $instructions,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array $valid_data
-     */
-    public function set_valid_data($valid_data)
-    {
-        $this->_valid_data = $valid_data;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function valid_data()
-    {
-        if (empty($this->_valid_data)) {
-            $this->_valid_data = $this->reg_form->valid_data();
-        }
-        return $this->_valid_data;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function reg_form_name()
-    {
-        if (empty($this->_reg_form_name)) {
-            $this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
-        }
-        return $this->_reg_form_name;
-    }
-
-
-    /**
-     * @param string $reg_form_name
-     */
-    protected function set_reg_form_name($reg_form_name)
-    {
-        $this->_reg_form_name = $reg_form_name;
-    }
-
-
-    /**
-     * reg_step_url
-     *
-     * @param string $action
-     * @return string
-     */
-    public function reg_step_url($action = '')
-    {
-        $query_args = ['step' => $this->slug()];
-        if (! empty($action)) {
-            $query_args['action'] = $action;
-        }
-        // final step has no display
-        if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
-            $query_args['action'] = 'process_reg_step';
-        }
-        if ($this->checkout->revisit) {
-            $query_args['revisit'] = true;
-        }
-        if ($this->checkout->reg_url_link) {
-            $query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
-        }
-        return add_query_arg($query_args, $this->checkout->reg_page_base_url);
-    }
-
-
-    /**
-     * creates the default hidden inputs section
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function reg_step_hidden_inputs()
-    {
-        // hidden inputs for admin registrations
-        if ($this->checkout->admin_request) {
-            return new EE_Form_Section_Proper(
-                [
-                    'layout_strategy' => new EE_No_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                    'subsections'     => [
-                        'next_step' => new EE_Fixed_Hidden_Input(
-                            [
-                                'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                                'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                    ? $this->checkout->next_step->slug()
-                                    : '',
-                            ]
-                        ),
-                    ],
-                ]
-            );
-        }
-        // hidden inputs for frontend registrations
-        return new EE_Form_Section_Proper(
-            [
-                'layout_strategy' => new EE_No_Layout(),
-                'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                'subsections'     => [
-                    'action'         => new EE_Fixed_Hidden_Input(
-                        [
-                            'html_name' => 'action',
-                            'html_id'   => 'spco-' . $this->slug() . '-action',
-                            'default'   => apply_filters(
-                                'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
-                                empty($this->checkout->reg_url_link)
-                                    ? 'process_reg_step'
-                                    : 'update_reg_step',
-                                $this
-                            ),
-                        ]
-                    ),
-                    'next_step'      => new EE_Fixed_Hidden_Input(
-                        [
-                            'html_name' => 'next_step',
-                            'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                            'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                ? $this->checkout->next_step->slug()
-                                : '',
-                        ]
-                    ),
-                    'e_reg_url_link' => new EE_Fixed_Hidden_Input(
-                        [
-                            'html_name' => 'e_reg_url_link',
-                            'html_id'   => 'spco-reg_url_link',
-                            'default'   => $this->checkout->reg_url_link,
-                        ]
-                    ),
-                    'revisit'        => new EE_Fixed_Hidden_Input(
-                        [
-                            'html_name' => 'revisit',
-                            'html_id'   => 'spco-revisit',
-                            'default'   => $this->checkout->revisit,
-                        ]
-                    ),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * generate_reg_form_for_actions
-     *
-     * @param array $actions
-     * @return void
-     */
-    public function generate_reg_form_for_actions($actions = [])
-    {
-        $actions                           = array_merge(
-            [
-                'generate_reg_form',
-                'display_spco_reg_step',
-                'process_reg_step',
-                'update_reg_step',
-            ],
-            $actions
-        );
-        $this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true);
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function display_reg_form()
-    {
-        $html = '';
-        if ($this->reg_form instanceof EE_Form_Section_Proper) {
-            do_action('AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form', $this->reg_form, $this);
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
-            if ($this->request->isAjax()) {
-                $this->reg_form->localize_validation_rules();
-                $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-            }
-            $html .= $this->reg_form->get_html();
-            $html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
-        }
-        return $html;
-    }
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function reg_step_submit_button()
-    {
-        if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            return '';
-        }
-        ob_start();
-        do_action(
-            'AHEE__before_spco_whats_next_buttons',
-            $this->slug(),
-            $this->checkout->next_step->slug(),
-            $this->checkout
-        );
-        $html = ob_get_clean();
-        // generate submit button
-        $submit_btn = new EE_Submit_Input(
-            [
-                'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_class'            => 'spco-next-step-btn',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => $this->submit_button_text(),
-            ]
-        );
-        $submit_btn->set_button_css_attributes(true, 'large');
-        $submit_btn_html = $submit_btn->get_html_for_input();
-        $html            .= EEH_HTML::div(
-            apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $submit_btn_html, $this),
-            'spco-' . $this->slug() . '-whats-next-buttons-dv',
-            'spco-whats-next-buttons'
-        );
-        return $html;
-    }
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     */
-    public function div_class()
-    {
-        return $this->is_current_step() ? '' : ' hidden';
-    }
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_lnk_url()
-    {
-        return add_query_arg(['step' => $this->slug()], $this->checkout->reg_page_base_url);
-    }
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_link_class()
-    {
-        return $this->is_current_step() ? ' hidden' : '';
-    }
-
-
-    /**
-     * update_checkout with changes that have been made to the cart
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_checkout()
-    {
-        // grab the cart grand total and reset TXN total
-        $this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
-        $this->checkout->stash_transaction_and_checkout();
-    }
-
-
-    /**
-     *    __sleep
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
-     * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
-     * reg form, because if needed, it will be regenerated anyways
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // remove the reg form and the checkout
-        return array_diff(array_keys(get_object_vars($this)), ['reg_form', 'checkout']);
-    }
-
-
-    /**
-     * @param RequestInterface $request
-     */
-    public function setRequest(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 *    $_completed - TRUE if this step has fully completed it's duties
+	 *
+	 * @access protected
+	 * @type bool $_completed
+	 */
+	protected $_completed = false;
+
+	/**
+	 *    $_is_current_step - TRUE if this is the current step
+	 *
+	 * @access protected
+	 * @type bool $_is_current_step
+	 */
+	protected $_is_current_step = false;
+
+	/**
+	 *    $_order - when the reg step should be run relative to other steps
+	 *
+	 * @access protected
+	 * @type int $_template
+	 */
+	protected $_order = 0;
+
+	/**
+	 *    $_slug - URL param for this step
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_slug;
+
+	/**
+	 *    $_name - Step Name - translatable string
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_name;
+
+	/**
+	 *    $_submit_button_text - translatable string that appears on this step's submit button
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_submit_button_text;
+
+	/**
+	 *    $_template - template name
+	 *
+	 * @access protected
+	 * @type string $_template
+	 */
+	protected $_template;
+
+	/**
+	 *    $_reg_form_name - the form input name and id attribute
+	 *
+	 * @access protected
+	 * @var string $_reg_form_name
+	 */
+	protected $_reg_form_name;
+
+	/**
+	 *    $_success_message - text to display upon successful form submission
+	 *
+	 * @access private
+	 * @var string $_success_message
+	 */
+	protected $_success_message;
+
+	/**
+	 *    $_instructions - a brief description of how to complete the reg step.
+	 *    Usually displayed in conjunction with the previous step's success message.
+	 *
+	 * @access private
+	 * @var string $_instructions
+	 */
+	protected $_instructions;
+
+	/**
+	 *    $_valid_data - the normalized and validated data for this step
+	 *
+	 * @access public
+	 * @var array $_valid_data
+	 */
+	protected $_valid_data = [];
+
+	/**
+	 *    $reg_form - the registration form for this step
+	 *
+	 * @access public
+	 * @var EE_Form_Section_Proper $reg_form
+	 */
+	public $reg_form;
+
+	/**
+	 *    $checkout - EE_Checkout object for handling the properties of the current checkout process
+	 *
+	 * @access public
+	 * @var EE_Checkout $checkout
+	 */
+	public $checkout;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+
+	/**
+	 * @return void
+	 */
+	abstract public function translate_js_strings();
+
+
+	/**
+	 * @return void
+	 */
+	abstract public function enqueue_styles_and_scripts();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function initialize_reg_step();
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 */
+	abstract public function generate_reg_form();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function process_reg_step();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function update_reg_step();
+
+
+	/**
+	 * @return boolean
+	 */
+	public function completed()
+	{
+		return $this->_completed;
+	}
+
+
+	/**
+	 * set_completed - toggles $_completed to TRUE
+	 */
+	public function set_completed()
+	{
+		// DEBUG LOG
+		// $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+		$this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
+	}
+
+
+	/**
+	 * set_completed - toggles $_completed to FALSE
+	 */
+	public function set_not_completed()
+	{
+		$this->_completed = false;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->_slug;
+	}
+
+
+	/**
+	 * submit_button_text
+	 * the text that appears on the reg step form submit button
+	 *
+	 * @return string
+	 */
+	public function submit_button_text()
+	{
+		return $this->_submit_button_text;
+	}
+
+
+	/**
+	 * set_submit_button_text
+	 * sets the text that appears on the reg step form submit button
+	 *
+	 * @param string $submit_button_text
+	 */
+	public function set_submit_button_text($submit_button_text = '')
+	{
+		if (! empty($submit_button_text)) {
+			$this->_submit_button_text = $submit_button_text;
+		} elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			if ($this->checkout->revisit) {
+				$this->_submit_button_text = sprintf(
+					esc_html__('Update %s', 'event_espresso'),
+					$this->checkout->current_step->name()
+				);
+			} else {
+				$this->_submit_button_text = sprintf(
+					esc_html__('Proceed to %s', 'event_espresso'),
+					$this->checkout->next_step->name()
+				);
+			}
+		}
+		// filters the submit button text
+		$this->_submit_button_text = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+			$this->_submit_button_text,
+			$this->checkout
+		);
+	}
+
+
+	/**
+	 * @param boolean $is_current_step
+	 */
+	public function set_is_current_step($is_current_step)
+	{
+		$this->_is_current_step = $is_current_step;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function is_current_step()
+	{
+		return $this->_is_current_step;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function is_final_step()
+	{
+		return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration;
+	}
+
+
+	/**
+	 * @param int $order
+	 */
+	public function set_order($order)
+	{
+		$this->_order = $order;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->_order;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function template(): string
+	{
+		return $this->_template;
+	}
+
+
+	/**
+	 * @param string $template
+	 */
+	public function setTemplate(string $template): void
+	{
+		$this->_template = $template;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function success_message()
+	{
+		return $this->_success_message;
+	}
+
+
+	/**
+	 * _set_success_message
+	 *
+	 * @param string $success_message
+	 */
+	protected function _set_success_message($success_message)
+	{
+		$this->_success_message = $success_message;
+	}
+
+
+	/**
+	 * _reset_success_message
+	 *
+	 * @return void
+	 */
+	protected function _reset_success_message()
+	{
+		$this->_success_message = '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function _instructions()
+	{
+		return $this->_instructions;
+	}
+
+
+	/**
+	 * @param string $instructions
+	 */
+	public function set_instructions($instructions)
+	{
+		$this->_instructions = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
+			$instructions,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array $valid_data
+	 */
+	public function set_valid_data($valid_data)
+	{
+		$this->_valid_data = $valid_data;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function valid_data()
+	{
+		if (empty($this->_valid_data)) {
+			$this->_valid_data = $this->reg_form->valid_data();
+		}
+		return $this->_valid_data;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function reg_form_name()
+	{
+		if (empty($this->_reg_form_name)) {
+			$this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
+		}
+		return $this->_reg_form_name;
+	}
+
+
+	/**
+	 * @param string $reg_form_name
+	 */
+	protected function set_reg_form_name($reg_form_name)
+	{
+		$this->_reg_form_name = $reg_form_name;
+	}
+
+
+	/**
+	 * reg_step_url
+	 *
+	 * @param string $action
+	 * @return string
+	 */
+	public function reg_step_url($action = '')
+	{
+		$query_args = ['step' => $this->slug()];
+		if (! empty($action)) {
+			$query_args['action'] = $action;
+		}
+		// final step has no display
+		if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
+			$query_args['action'] = 'process_reg_step';
+		}
+		if ($this->checkout->revisit) {
+			$query_args['revisit'] = true;
+		}
+		if ($this->checkout->reg_url_link) {
+			$query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
+		}
+		return add_query_arg($query_args, $this->checkout->reg_page_base_url);
+	}
+
+
+	/**
+	 * creates the default hidden inputs section
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function reg_step_hidden_inputs()
+	{
+		// hidden inputs for admin registrations
+		if ($this->checkout->admin_request) {
+			return new EE_Form_Section_Proper(
+				[
+					'layout_strategy' => new EE_No_Layout(),
+					'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+					'subsections'     => [
+						'next_step' => new EE_Fixed_Hidden_Input(
+							[
+								'html_name' => 'next_step',
+								'html_id'   => 'spco-' . $this->slug() . '-next-step',
+								'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+									? $this->checkout->next_step->slug()
+									: '',
+							]
+						),
+					],
+				]
+			);
+		}
+		// hidden inputs for frontend registrations
+		return new EE_Form_Section_Proper(
+			[
+				'layout_strategy' => new EE_No_Layout(),
+				'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+				'subsections'     => [
+					'action'         => new EE_Fixed_Hidden_Input(
+						[
+							'html_name' => 'action',
+							'html_id'   => 'spco-' . $this->slug() . '-action',
+							'default'   => apply_filters(
+								'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
+								empty($this->checkout->reg_url_link)
+									? 'process_reg_step'
+									: 'update_reg_step',
+								$this
+							),
+						]
+					),
+					'next_step'      => new EE_Fixed_Hidden_Input(
+						[
+							'html_name' => 'next_step',
+							'html_id'   => 'spco-' . $this->slug() . '-next-step',
+							'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+								? $this->checkout->next_step->slug()
+								: '',
+						]
+					),
+					'e_reg_url_link' => new EE_Fixed_Hidden_Input(
+						[
+							'html_name' => 'e_reg_url_link',
+							'html_id'   => 'spco-reg_url_link',
+							'default'   => $this->checkout->reg_url_link,
+						]
+					),
+					'revisit'        => new EE_Fixed_Hidden_Input(
+						[
+							'html_name' => 'revisit',
+							'html_id'   => 'spco-revisit',
+							'default'   => $this->checkout->revisit,
+						]
+					),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * generate_reg_form_for_actions
+	 *
+	 * @param array $actions
+	 * @return void
+	 */
+	public function generate_reg_form_for_actions($actions = [])
+	{
+		$actions                           = array_merge(
+			[
+				'generate_reg_form',
+				'display_spco_reg_step',
+				'process_reg_step',
+				'update_reg_step',
+			],
+			$actions
+		);
+		$this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true);
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function display_reg_form()
+	{
+		$html = '';
+		if ($this->reg_form instanceof EE_Form_Section_Proper) {
+			do_action('AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form', $this->reg_form, $this);
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
+			if ($this->request->isAjax()) {
+				$this->reg_form->localize_validation_rules();
+				$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+			}
+			$html .= $this->reg_form->get_html();
+			$html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
+		}
+		return $html;
+	}
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function reg_step_submit_button()
+	{
+		if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			return '';
+		}
+		ob_start();
+		do_action(
+			'AHEE__before_spco_whats_next_buttons',
+			$this->slug(),
+			$this->checkout->next_step->slug(),
+			$this->checkout
+		);
+		$html = ob_get_clean();
+		// generate submit button
+		$submit_btn = new EE_Submit_Input(
+			[
+				'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+				'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+				'html_class'            => 'spco-next-step-btn',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => $this->submit_button_text(),
+			]
+		);
+		$submit_btn->set_button_css_attributes(true, 'large');
+		$submit_btn_html = $submit_btn->get_html_for_input();
+		$html            .= EEH_HTML::div(
+			apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $submit_btn_html, $this),
+			'spco-' . $this->slug() . '-whats-next-buttons-dv',
+			'spco-whats-next-buttons'
+		);
+		return $html;
+	}
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 */
+	public function div_class()
+	{
+		return $this->is_current_step() ? '' : ' hidden';
+	}
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_lnk_url()
+	{
+		return add_query_arg(['step' => $this->slug()], $this->checkout->reg_page_base_url);
+	}
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_link_class()
+	{
+		return $this->is_current_step() ? ' hidden' : '';
+	}
+
+
+	/**
+	 * update_checkout with changes that have been made to the cart
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_checkout()
+	{
+		// grab the cart grand total and reset TXN total
+		$this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
+		$this->checkout->stash_transaction_and_checkout();
+	}
+
+
+	/**
+	 *    __sleep
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
+	 * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
+	 * reg form, because if needed, it will be regenerated anyways
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// remove the reg form and the checkout
+		return array_diff(array_keys(get_object_vars($this)), ['reg_form', 'checkout']);
+	}
+
+
+	/**
+	 * @param RequestInterface $request
+	 */
+	public function setRequest(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -227,7 +227,7 @@ 
      */
     public function set_submit_button_text($submit_button_text = '')
     {
-        if (! empty($submit_button_text)) {
+        if ( ! empty($submit_button_text)) {
             $this->_submit_button_text = $submit_button_text;
         } elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
             if ($this->checkout->revisit) {
@@ -396,7 +396,7 @@ 
     public function reg_form_name()
     {
         if (empty($this->_reg_form_name)) {
-            $this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
+            $this->set_reg_form_name('ee-spco-'.$this->slug().'-reg-step-form');
         }
         return $this->_reg_form_name;
     }
@@ -420,7 +420,7 @@ 
     public function reg_step_url($action = '')
     {
         $query_args = ['step' => $this->slug()];
-        if (! empty($action)) {
+        if ( ! empty($action)) {
             $query_args['action'] = $action;
         }
         // final step has no display
@@ -450,12 +450,12 @@ 
             return new EE_Form_Section_Proper(
                 [
                     'layout_strategy' => new EE_No_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+                    'html_id'         => 'ee-'.$this->slug().'-hidden-inputs',
                     'subsections'     => [
                         'next_step' => new EE_Fixed_Hidden_Input(
                             [
                                 'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
+                                'html_id'   => 'spco-'.$this->slug().'-next-step',
                                 'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
                                     ? $this->checkout->next_step->slug()
                                     : '',
@@ -469,12 +469,12 @@ 
         return new EE_Form_Section_Proper(
             [
                 'layout_strategy' => new EE_No_Layout(),
-                'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+                'html_id'         => 'ee-'.$this->slug().'-hidden-inputs',
                 'subsections'     => [
                     'action'         => new EE_Fixed_Hidden_Input(
                         [
                             'html_name' => 'action',
-                            'html_id'   => 'spco-' . $this->slug() . '-action',
+                            'html_id'   => 'spco-'.$this->slug().'-action',
                             'default'   => apply_filters(
                                 'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
                                 empty($this->checkout->reg_url_link)
@@ -487,7 +487,7 @@ 
                     'next_step'      => new EE_Fixed_Hidden_Input(
                         [
                             'html_name' => 'next_step',
-                            'html_id'   => 'spco-' . $this->slug() . '-next-step',
+                            'html_id'   => 'spco-'.$this->slug().'-next-step',
                             'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
                                 ? $this->checkout->next_step->slug()
                                 : '',
@@ -521,7 +521,7 @@ 
      */
     public function generate_reg_form_for_actions($actions = [])
     {
-        $actions                           = array_merge(
+        $actions = array_merge(
             [
                 'generate_reg_form',
                 'display_spco_reg_step',
@@ -564,7 +564,7 @@ 
      */
     public function reg_step_submit_button()
     {
-        if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+        if ( ! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
             return '';
         }
         ob_start();
@@ -578,18 +578,18 @@ 
         // generate submit button
         $submit_btn = new EE_Submit_Input(
             [
-                'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+                'html_name'             => 'spco-go-to-step-'.$this->checkout->next_step->slug(),
+                'html_id'               => 'spco-go-to-step-'.$this->checkout->next_step->slug(),
                 'html_class'            => 'spco-next-step-btn',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => $this->submit_button_text(),
             ]
         );
         $submit_btn->set_button_css_attributes(true, 'large');
         $submit_btn_html = $submit_btn->get_html_for_input();
-        $html            .= EEH_HTML::div(
+        $html .= EEH_HTML::div(
             apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $submit_btn_html, $this),
-            'spco-' . $this->slug() . '-whats-next-buttons-dv',
+            'spco-'.$this->slug().'-whats-next-buttons-dv',
             'spco-whats-next-buttons'
         );
         return $html;

modules/single_page_checkout/reg_steps/attendee_information/EE_SPCO_Reg_Step_Attendee_Information.class.php

Indentation +858 added lines, -858 removed lines

@@ -23,862 +23,862 @@
  */
 class EE_SPCO_Reg_Step_Attendee_Information extends EE_SPCO_Reg_Step
 {
-    /**
-     * @var RegForm
-     */
-    public $reg_form;
-
-    /**
-     * @var int
-     */
-    protected $reg_form_count = 0;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->_slug    = 'attendee_information';
-        $this->_name    = esc_html__('Attendee Information', 'event_espresso');
-        $this->checkout = $checkout;
-        $this->_reset_success_message();
-        $this->set_instructions(
-            esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
-        );
-    }
-
-
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
-            ' is a required question.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
-            ' is a required question. Please enter a value for at least one of the options.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
-            'Please answer all required questions correctly before proceeding.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
-            esc_html_x(
-                'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
-                'The attendee information was successfully copied.(line break)Please ensure the rest of the registration form is completed before proceeding.',
-                'event_espresso'
-            ),
-            '<br/>'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
-            'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
-            'You must enter a valid email address.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
-            'You must enter a valid email address and answer all other required questions before you can proceed.',
-            'event_espresso'
-        );
-    }
-
-
-    public function enqueue_styles_and_scripts()
-    {
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function initialize_reg_step(): bool
-    {
-        return true;
-    }
-
-
-    /**
-     * @return RegForm
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function generate_reg_form(): RegForm
-    {
-        $this->setLegacyFiltersForRegFormGeneration();
-        /** @var RegFormDependencyHandler $dependency_handler */
-        $dependency_handler = LoaderFactory::getShared(RegFormDependencyHandler::class);
-        $dependency_handler->registerDependencies();
-        // TODO detect if event has a reg form UUID and swap this out for form generated by new reg form builder
-        return LoaderFactory::getShared(RegForm::class, [$this]);
-    }
-
-
-    /**
-     * @since   5.0.0.p
-     */
-    private function setLegacyFiltersForRegFormGeneration()
-    {
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_groups_query_parameters',
-            [$this, 'registrationQuestionGroupsQueryParameters'],
-            1,
-            2
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_group_reg_form',
-            [$this, 'registrationQuestionGroupsRegForm'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__printCopyInfo',
-            [$this, 'registrationRegFormPrintCopyInfo'],
-            1,
-            2
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__related_questions_query_params',
-            [$this, 'registrationRegFormRelatedQuestionsQueryParams'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__before_question_group_questions',
-            [$this, 'registrationRegFormBeforeQuestionGroupQuestions'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__subsections_array',
-            [$this, 'registrationRegFormSubsections'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__after_question_group_questions',
-            [$this, 'registrationRegFormAfterQuestionGroupQuestions'],
-            1,
-            3
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_AutoCopyAttendeeInfoForm__construct__template_args',
-            [$this, 'autoCopyAttendeeInfoTemplateArgs'],
-            1
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_CountryOptions__generateLegacyCountryOptions__country_options',
-            [$this, 'generateQuestionInputCountryOptions'],
-            1,
-            4
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_StateOptions__generateLegacyStateOptions__state_options',
-            [$this, 'generateQuestionInputStateOptions'],
-            1,
-            4
-        );
-    }
-
-
-    /**
-     * @param array           $query_params
-     * @param EE_Registration $registration
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function registrationQuestionGroupsQueryParameters(
-        array $query_params,
-        EE_Registration $registration
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
-            $query_params,
-            $registration,
-            $this
-        );
-    }
-
-
-    /**
-     * @param RegFormQuestions  $question_group_reg_form
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return EE_Form_Section_Proper
-     * @since   5.0.0.p
-     */
-    public function registrationQuestionGroupsRegForm(
-        RegFormQuestions $question_group_reg_form,
-        EE_Registration $registration,
-        EE_Question_Group $question_group
-    ): EE_Form_Section_Proper {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            $question_group_reg_form,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param int $print_copy_info
-     * @param int $attendee_nmbr
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function registrationRegFormPrintCopyInfo(
-        int $print_copy_info,
-        int $attendee_nmbr
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form___printCopyInfo',
-            $print_copy_info,
-            $attendee_nmbr
-        );
-    }
-
-
-    /**
-     * @param array             $query_params
-     * @param EE_Question_Group $question_group
-     * @param EE_Registration   $registration
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function registrationRegFormRelatedQuestionsQueryParams(
-        array $query_params,
-        EE_Question_Group $question_group,
-        EE_Registration $registration
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
-            $query_params,
-            $question_group,
-            $registration,
-            $this
-        );
-    }
-
-
-    /**
-     * @param                   $html
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function registrationRegFormBeforeQuestionGroupQuestions(
-        $html,
-        EE_Registration $registration,
-        EE_Question_Group $question_group
-    ) {
-        return apply_filters(
-            'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
-            $html,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array             $form_subsections
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function registrationRegFormSubsections(
-        array $form_subsections,
-        EE_Registration $registration,
-        EE_Question_Group $question_group
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
-            $form_subsections,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param                   $html
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function registrationRegFormAfterQuestionGroupQuestions(
-        $html,
-        EE_Registration $registration,
-        EE_Question_Group $question_group
-    ) {
-        return apply_filters(
-            'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
-            $html,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array $template_args
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function autoCopyAttendeeInfoTemplateArgs(array $template_args = [])
-    {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
-            $template_args
-        );
-    }
-
-
-    /**
-     * @param array           $country_options
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @param EE_Answer|null  $answer
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function generateQuestionInputCountryOptions(
-        array $country_options,
-        EE_Registration $registration,
-        EE_Question $question,
-        ?EE_Answer $answer
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            $country_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-    }
-
-
-    /**
-     * @param array           $state_options
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @param EE_Answer|null  $answer
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function generateQuestionInputStateOptions(
-        array $state_options,
-        EE_Registration $registration,
-        EE_Question $question,
-        ?EE_Answer $answer
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            $state_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::getRegForm()
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _registrations_reg_form()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalAttendeeRegInfoInput()
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _additional_attendee_reg_info_input()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::questionGroupRegForm()
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _question_group_reg_form()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::questionGroupHeader()
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _question_group_header()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\subsections\CopyAttendeeInfoForm
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _copy_attendee_info_form()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\subsections\AutoCopyAttendeeInfoForm
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _auto_copy_attendee_info()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\subsections\CopyAttendeeInfoForm
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _copy_attendee_info_inputs()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalPrimaryRegistrantInputs()
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _additional_primary_registrant_inputs()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory::create()
-     *
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated   5.0.0.p
-     */
-    public function reg_form_question(EE_Registration $registration, EE_Question $question): EE_Form_Input_Base
-    {
-        /** @var RegFormQuestionFactory $reg_form_question_factory */
-        $reg_form_question_factory = LoaderFactory::getShared(RegFormQuestionFactory::class);
-        return $reg_form_question_factory->create($registration, $question);
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::generateQuestionInput()
-     *
-     * @deprecated   5.0.0.p
-     */
-    private function _generate_question_input()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\utilities\CountryOptions::forLegacyFormInput()
-     *
-     * @param array|null           $countries_list
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer
-     * @return array 2d keys are country IDs, values are their names
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated   5.0.0.p
-     */
-    public function use_cached_countries_for_form_input(
-        array $countries_list = null,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ): array {
-        /** @var CountryOptions $country_options */
-        $country_options = LoaderFactory::getShared(CountryOptions::class, [$this->checkout->action]);
-        return $country_options->forLegacyFormInput($countries_list, $question, $registration, $answer);
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\utilities\StateOptions::forLegacyFormInput()
-     *
-     * @param array|null           $states_list
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer
-     * @return array 2d keys are state IDs, values are their names
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated   5.0.0.p
-     */
-    public function use_cached_states_for_form_input(
-        array $states_list = null,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ): array {
-        /** @var StateOptions $state_options */
-        $state_options = LoaderFactory::getShared(StateOptions::class, [$this->checkout->action]);
-        return $state_options->forLegacyFormInput($states_list, $question, $registration, $answer);
-    }
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  ****************************************/
-    /********************************************************************************************************/
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_reg_step(): bool
-    {
-        $this->setLegacyFiltersForRegFormProcessing();
-        // grab validated data from form
-        $valid_data = $this->checkout->current_step->valid_data();
-        // if we don't have any $valid_data then something went TERRIBLY WRONG !!!
-        if (empty($valid_data)) {
-            return $this->inValidDataError();
-        }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
-            return $this->inValidTransactionError();
-        }
-        // get cached registrations
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        // verify we got the goods
-        if (empty($registrations)) {
-            return $this->noRegistrationsError();
-        }
-        /** @var RegFormHandler $reg_form_handler */
-        $reg_form_handler = LoaderFactory::getNew(RegFormHandler::class, [$this->checkout]);
-        // extract attendee info from form data and save to model objects
-        if (! $reg_form_handler->processRegistrations($registrations, $valid_data)) {
-            // return immediately if the previous step exited early due to errors
-            return false;
-        }
-        // if first pass thru SPCO,
-        // then let's check processed registrations against the total number of tickets in the cart
-        $registrations_processed = $reg_form_handler->attendeeCount();
-        if (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
-            return $this->registrationProcessingError($registrations_processed);
-        }
-        // mark this reg step as completed
-        $this->set_completed();
-        $this->_set_success_message(
-            esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
-        );
-        // do action in case a plugin wants to do something with the data submitted in step 1.
-        // passes EE_Single_Page_Checkout, and it's posted data
-        do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
-        return true;
-    }
-
-
-    /**
-     * @since   5.0.0.p
-     */
-    private function setLegacyFiltersForRegFormProcessing()
-    {
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegistrations__bypass',
-            [$this, 'preRegistrationProcess'],
-            1,
-            5
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegFormData__registrant_form_data',
-            [$this, 'validDataLineItem'],
-            1,
-            2
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormInputHandler__saveRegistrationFormInput',
-            [$this, 'saveRegistrationFormInput'],
-            1,
-            4
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantData__ensureCriticalRegistrantDataIsSet',
-            [$this, 'mergeAddressDetailsWithCriticalAttendeeDetails'],
-            1
-        );
-    }
-
-
-    /**
-     * @param bool            $bypass
-     * @param int             $attendee_count
-     * @param EE_Registration $registration
-     * @param array           $registrations
-     * @param array           $reg_form_data
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function preRegistrationProcess(
-        bool $bypass,
-        int $attendee_count,
-        EE_Registration $registration,
-        array $registrations,
-        array $reg_form_data
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
-            $bypass,
-            $attendee_count,
-            $registration,
-            $registrations,
-            $reg_form_data,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array           $reg_form_data
-     * @param EE_Registration $registration
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function validDataLineItem(array $reg_form_data, EE_Registration $registration)
-    {
-        return apply_filters(
-            'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-            $reg_form_data,
-            $registration
-        );
-    }
-
-
-    /**
-     * @param bool            $save
-     * @param EE_Registration $registration
-     * @param                 $form_input
-     * @param                 $input_value
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function saveRegistrationFormInput(bool $save, EE_Registration $registration, $form_input, $input_value)
-    {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
-            $save,
-            $registration,
-            $form_input,
-            $input_value,
-            $this
-        );
-    }
-
-
-    /**
-     * @param bool $merge_data
-     * @return mixed|void
-     * @since   5.0.0.p
-     */
-    public function mergeAddressDetailsWithCriticalAttendeeDetails(bool $merge_data)
-    {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
-            $merge_data
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @since   5.0.0.p
-     */
-    private function inValidDataError(): bool
-    {
-        EE_Error::add_error(
-            esc_html__('No valid question responses were received.', 'event_espresso'),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-    /**
-     * @return bool
-     * @since   5.0.0.p
-     */
-    private function inValidTransactionError(): bool
-    {
-        EE_Error::add_error(
-            esc_html__(
-                'A valid transaction could not be initiated for processing your registrations.',
-                'event_espresso'
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-    /**
-     * @return bool
-     * @since   5.0.0.p
-     */
-    private function noRegistrationsError(): bool
-    {
-        // combine the old translated string with a new one, in order to not break translations
-        $error_message = esc_html__(
-            'Your form data could not be applied to any valid registrations.',
-            'event_espresso'
-        );
-        $error_message .= sprintf(
-            esc_html_x(
-                '%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.',
-                '(line break)This can sometimes happen if too much time has been taken to complete the registration process.(line break)Please return to the (link)Event List(end link) and reselect your tickets. If the problem continues, please contact the site administrator.',
-                'event_espresso'
-            ),
-            '<a href="' . get_post_type_archive_link(EspressoPostType::EVENTS) . '" >',
-            '</a>',
-            '<br />'
-        );
-        EE_Error::add_error($error_message, __FILE__, __FUNCTION__, __LINE__);
-        return false;
-    }
-
-
-    /**
-     * @param int $registrations_processed
-     * @return bool
-     * @since   5.0.0.p
-     */
-    private function registrationProcessingError(int $registrations_processed): bool
-    {
-        // generate a correctly translated string for all possible singular/plural combinations
-        if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
-            $error_msg = sprintf(
-                esc_html_x(
-                    'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
-                    'There was 1 ticket in the Event Queue, but 2 registrations were processed',
-                    'event_espresso'
-                ),
-                $this->checkout->total_ticket_count,
-                $registrations_processed
-            );
-        } elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
-            $error_msg = sprintf(
-                esc_html_x(
-                    'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
-                    'There was a total of 2 tickets in the Event Queue, but only 1 registration was processed',
-                    'event_espresso'
-                ),
-                $this->checkout->total_ticket_count,
-                $registrations_processed
-            );
-        } else {
-            $error_msg = sprintf(
-                esc_html__(
-                    'There was a total of 2 tickets in the Event Queue, but 2 registrations were processed',
-                    'event_espresso'
-                ),
-                $this->checkout->total_ticket_count,
-                $registrations_processed
-            );
-        }
-        EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        return false;
-    }
-
-
-    /**
-     *    update_reg_step
-     *    this is the final step after a user  revisits the site to edit their attendee information
-     *    this gets called AFTER the process_reg_step() method above
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_reg_step(): bool
-    {
-        // save everything
-        if ($this->process_reg_step()) {
-            $this->checkout->redirect     = true;
-            $this->checkout->redirect_url = add_query_arg(
-                [
-                    'e_reg_url_link' => $this->checkout->reg_url_link,
-                    'revisit'        => true,
-                ],
-                $this->checkout->thank_you_page_url
-            );
-            $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * @var RegForm
+	 */
+	public $reg_form;
+
+	/**
+	 * @var int
+	 */
+	protected $reg_form_count = 0;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->_slug    = 'attendee_information';
+		$this->_name    = esc_html__('Attendee Information', 'event_espresso');
+		$this->checkout = $checkout;
+		$this->_reset_success_message();
+		$this->set_instructions(
+			esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
+		);
+	}
+
+
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
+			' is a required question.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
+			' is a required question. Please enter a value for at least one of the options.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
+			'Please answer all required questions correctly before proceeding.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
+			esc_html_x(
+				'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
+				'The attendee information was successfully copied.(line break)Please ensure the rest of the registration form is completed before proceeding.',
+				'event_espresso'
+			),
+			'<br/>'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
+			'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
+			'You must enter a valid email address.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
+			'You must enter a valid email address and answer all other required questions before you can proceed.',
+			'event_espresso'
+		);
+	}
+
+
+	public function enqueue_styles_and_scripts()
+	{
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function initialize_reg_step(): bool
+	{
+		return true;
+	}
+
+
+	/**
+	 * @return RegForm
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function generate_reg_form(): RegForm
+	{
+		$this->setLegacyFiltersForRegFormGeneration();
+		/** @var RegFormDependencyHandler $dependency_handler */
+		$dependency_handler = LoaderFactory::getShared(RegFormDependencyHandler::class);
+		$dependency_handler->registerDependencies();
+		// TODO detect if event has a reg form UUID and swap this out for form generated by new reg form builder
+		return LoaderFactory::getShared(RegForm::class, [$this]);
+	}
+
+
+	/**
+	 * @since   5.0.0.p
+	 */
+	private function setLegacyFiltersForRegFormGeneration()
+	{
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_groups_query_parameters',
+			[$this, 'registrationQuestionGroupsQueryParameters'],
+			1,
+			2
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_group_reg_form',
+			[$this, 'registrationQuestionGroupsRegForm'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__printCopyInfo',
+			[$this, 'registrationRegFormPrintCopyInfo'],
+			1,
+			2
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__related_questions_query_params',
+			[$this, 'registrationRegFormRelatedQuestionsQueryParams'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__before_question_group_questions',
+			[$this, 'registrationRegFormBeforeQuestionGroupQuestions'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__subsections_array',
+			[$this, 'registrationRegFormSubsections'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormQuestionGroup__generateFormArgs__after_question_group_questions',
+			[$this, 'registrationRegFormAfterQuestionGroupQuestions'],
+			1,
+			3
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_AutoCopyAttendeeInfoForm__construct__template_args',
+			[$this, 'autoCopyAttendeeInfoTemplateArgs'],
+			1
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_CountryOptions__generateLegacyCountryOptions__country_options',
+			[$this, 'generateQuestionInputCountryOptions'],
+			1,
+			4
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_StateOptions__generateLegacyStateOptions__state_options',
+			[$this, 'generateQuestionInputStateOptions'],
+			1,
+			4
+		);
+	}
+
+
+	/**
+	 * @param array           $query_params
+	 * @param EE_Registration $registration
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function registrationQuestionGroupsQueryParameters(
+		array $query_params,
+		EE_Registration $registration
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
+			$query_params,
+			$registration,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param RegFormQuestions  $question_group_reg_form
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return EE_Form_Section_Proper
+	 * @since   5.0.0.p
+	 */
+	public function registrationQuestionGroupsRegForm(
+		RegFormQuestions $question_group_reg_form,
+		EE_Registration $registration,
+		EE_Question_Group $question_group
+	): EE_Form_Section_Proper {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			$question_group_reg_form,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param int $print_copy_info
+	 * @param int $attendee_nmbr
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function registrationRegFormPrintCopyInfo(
+		int $print_copy_info,
+		int $attendee_nmbr
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form___printCopyInfo',
+			$print_copy_info,
+			$attendee_nmbr
+		);
+	}
+
+
+	/**
+	 * @param array             $query_params
+	 * @param EE_Question_Group $question_group
+	 * @param EE_Registration   $registration
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function registrationRegFormRelatedQuestionsQueryParams(
+		array $query_params,
+		EE_Question_Group $question_group,
+		EE_Registration $registration
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
+			$query_params,
+			$question_group,
+			$registration,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param                   $html
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function registrationRegFormBeforeQuestionGroupQuestions(
+		$html,
+		EE_Registration $registration,
+		EE_Question_Group $question_group
+	) {
+		return apply_filters(
+			'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
+			$html,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array             $form_subsections
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function registrationRegFormSubsections(
+		array $form_subsections,
+		EE_Registration $registration,
+		EE_Question_Group $question_group
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
+			$form_subsections,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param                   $html
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function registrationRegFormAfterQuestionGroupQuestions(
+		$html,
+		EE_Registration $registration,
+		EE_Question_Group $question_group
+	) {
+		return apply_filters(
+			'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
+			$html,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array $template_args
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function autoCopyAttendeeInfoTemplateArgs(array $template_args = [])
+	{
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
+			$template_args
+		);
+	}
+
+
+	/**
+	 * @param array           $country_options
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @param EE_Answer|null  $answer
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function generateQuestionInputCountryOptions(
+		array $country_options,
+		EE_Registration $registration,
+		EE_Question $question,
+		?EE_Answer $answer
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			$country_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+	}
+
+
+	/**
+	 * @param array           $state_options
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @param EE_Answer|null  $answer
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function generateQuestionInputStateOptions(
+		array $state_options,
+		EE_Registration $registration,
+		EE_Question $question,
+		?EE_Answer $answer
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			$state_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::getRegForm()
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _registrations_reg_form()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalAttendeeRegInfoInput()
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _additional_attendee_reg_info_input()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::questionGroupRegForm()
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _question_group_reg_form()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::questionGroupHeader()
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _question_group_header()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\subsections\CopyAttendeeInfoForm
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _copy_attendee_info_form()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\subsections\AutoCopyAttendeeInfoForm
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _auto_copy_attendee_info()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\subsections\CopyAttendeeInfoForm
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _copy_attendee_info_inputs()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalPrimaryRegistrantInputs()
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _additional_primary_registrant_inputs()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory::create()
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated   5.0.0.p
+	 */
+	public function reg_form_question(EE_Registration $registration, EE_Question $question): EE_Form_Input_Base
+	{
+		/** @var RegFormQuestionFactory $reg_form_question_factory */
+		$reg_form_question_factory = LoaderFactory::getShared(RegFormQuestionFactory::class);
+		return $reg_form_question_factory->create($registration, $question);
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::generateQuestionInput()
+	 *
+	 * @deprecated   5.0.0.p
+	 */
+	private function _generate_question_input()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\utilities\CountryOptions::forLegacyFormInput()
+	 *
+	 * @param array|null           $countries_list
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer
+	 * @return array 2d keys are country IDs, values are their names
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated   5.0.0.p
+	 */
+	public function use_cached_countries_for_form_input(
+		array $countries_list = null,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	): array {
+		/** @var CountryOptions $country_options */
+		$country_options = LoaderFactory::getShared(CountryOptions::class, [$this->checkout->action]);
+		return $country_options->forLegacyFormInput($countries_list, $question, $registration, $answer);
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\utilities\StateOptions::forLegacyFormInput()
+	 *
+	 * @param array|null           $states_list
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer
+	 * @return array 2d keys are state IDs, values are their names
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated   5.0.0.p
+	 */
+	public function use_cached_states_for_form_input(
+		array $states_list = null,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	): array {
+		/** @var StateOptions $state_options */
+		$state_options = LoaderFactory::getShared(StateOptions::class, [$this->checkout->action]);
+		return $state_options->forLegacyFormInput($states_list, $question, $registration, $answer);
+	}
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  ****************************************/
+	/********************************************************************************************************/
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_reg_step(): bool
+	{
+		$this->setLegacyFiltersForRegFormProcessing();
+		// grab validated data from form
+		$valid_data = $this->checkout->current_step->valid_data();
+		// if we don't have any $valid_data then something went TERRIBLY WRONG !!!
+		if (empty($valid_data)) {
+			return $this->inValidDataError();
+		}
+		if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+			return $this->inValidTransactionError();
+		}
+		// get cached registrations
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		// verify we got the goods
+		if (empty($registrations)) {
+			return $this->noRegistrationsError();
+		}
+		/** @var RegFormHandler $reg_form_handler */
+		$reg_form_handler = LoaderFactory::getNew(RegFormHandler::class, [$this->checkout]);
+		// extract attendee info from form data and save to model objects
+		if (! $reg_form_handler->processRegistrations($registrations, $valid_data)) {
+			// return immediately if the previous step exited early due to errors
+			return false;
+		}
+		// if first pass thru SPCO,
+		// then let's check processed registrations against the total number of tickets in the cart
+		$registrations_processed = $reg_form_handler->attendeeCount();
+		if (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+			return $this->registrationProcessingError($registrations_processed);
+		}
+		// mark this reg step as completed
+		$this->set_completed();
+		$this->_set_success_message(
+			esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
+		);
+		// do action in case a plugin wants to do something with the data submitted in step 1.
+		// passes EE_Single_Page_Checkout, and it's posted data
+		do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
+		return true;
+	}
+
+
+	/**
+	 * @since   5.0.0.p
+	 */
+	private function setLegacyFiltersForRegFormProcessing()
+	{
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegistrations__bypass',
+			[$this, 'preRegistrationProcess'],
+			1,
+			5
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegFormData__registrant_form_data',
+			[$this, 'validDataLineItem'],
+			1,
+			2
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormInputHandler__saveRegistrationFormInput',
+			[$this, 'saveRegistrationFormInput'],
+			1,
+			4
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantData__ensureCriticalRegistrantDataIsSet',
+			[$this, 'mergeAddressDetailsWithCriticalAttendeeDetails'],
+			1
+		);
+	}
+
+
+	/**
+	 * @param bool            $bypass
+	 * @param int             $attendee_count
+	 * @param EE_Registration $registration
+	 * @param array           $registrations
+	 * @param array           $reg_form_data
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function preRegistrationProcess(
+		bool $bypass,
+		int $attendee_count,
+		EE_Registration $registration,
+		array $registrations,
+		array $reg_form_data
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
+			$bypass,
+			$attendee_count,
+			$registration,
+			$registrations,
+			$reg_form_data,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array           $reg_form_data
+	 * @param EE_Registration $registration
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function validDataLineItem(array $reg_form_data, EE_Registration $registration)
+	{
+		return apply_filters(
+			'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+			$reg_form_data,
+			$registration
+		);
+	}
+
+
+	/**
+	 * @param bool            $save
+	 * @param EE_Registration $registration
+	 * @param                 $form_input
+	 * @param                 $input_value
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function saveRegistrationFormInput(bool $save, EE_Registration $registration, $form_input, $input_value)
+	{
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
+			$save,
+			$registration,
+			$form_input,
+			$input_value,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param bool $merge_data
+	 * @return mixed|void
+	 * @since   5.0.0.p
+	 */
+	public function mergeAddressDetailsWithCriticalAttendeeDetails(bool $merge_data)
+	{
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
+			$merge_data
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	private function inValidDataError(): bool
+	{
+		EE_Error::add_error(
+			esc_html__('No valid question responses were received.', 'event_espresso'),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+	/**
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	private function inValidTransactionError(): bool
+	{
+		EE_Error::add_error(
+			esc_html__(
+				'A valid transaction could not be initiated for processing your registrations.',
+				'event_espresso'
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+	/**
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	private function noRegistrationsError(): bool
+	{
+		// combine the old translated string with a new one, in order to not break translations
+		$error_message = esc_html__(
+			'Your form data could not be applied to any valid registrations.',
+			'event_espresso'
+		);
+		$error_message .= sprintf(
+			esc_html_x(
+				'%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.',
+				'(line break)This can sometimes happen if too much time has been taken to complete the registration process.(line break)Please return to the (link)Event List(end link) and reselect your tickets. If the problem continues, please contact the site administrator.',
+				'event_espresso'
+			),
+			'<a href="' . get_post_type_archive_link(EspressoPostType::EVENTS) . '" >',
+			'</a>',
+			'<br />'
+		);
+		EE_Error::add_error($error_message, __FILE__, __FUNCTION__, __LINE__);
+		return false;
+	}
+
+
+	/**
+	 * @param int $registrations_processed
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	private function registrationProcessingError(int $registrations_processed): bool
+	{
+		// generate a correctly translated string for all possible singular/plural combinations
+		if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
+			$error_msg = sprintf(
+				esc_html_x(
+					'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
+					'There was 1 ticket in the Event Queue, but 2 registrations were processed',
+					'event_espresso'
+				),
+				$this->checkout->total_ticket_count,
+				$registrations_processed
+			);
+		} elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
+			$error_msg = sprintf(
+				esc_html_x(
+					'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
+					'There was a total of 2 tickets in the Event Queue, but only 1 registration was processed',
+					'event_espresso'
+				),
+				$this->checkout->total_ticket_count,
+				$registrations_processed
+			);
+		} else {
+			$error_msg = sprintf(
+				esc_html__(
+					'There was a total of 2 tickets in the Event Queue, but 2 registrations were processed',
+					'event_espresso'
+				),
+				$this->checkout->total_ticket_count,
+				$registrations_processed
+			);
+		}
+		EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		return false;
+	}
+
+
+	/**
+	 *    update_reg_step
+	 *    this is the final step after a user  revisits the site to edit their attendee information
+	 *    this gets called AFTER the process_reg_step() method above
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_reg_step(): bool
+	{
+		// save everything
+		if ($this->process_reg_step()) {
+			$this->checkout->redirect     = true;
+			$this->checkout->redirect_url = add_query_arg(
+				[
+					'e_reg_url_link' => $this->checkout->reg_url_link,
+					'revisit'        => true,
+				],
+				$this->checkout->thank_you_page_url
+			);
+			$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+			return true;
+		}
+		return false;
+	}
 }

PaymentMethods/PayPalCommerce/PayPalCheckout/EEG_PayPalCheckout.gateway.php

Indentation +318 added lines, -318 removed lines

@@ -13,335 +13,335 @@
  */
 class EEG_PayPalCheckout extends EE_Onsite_Gateway
 {
-    /**
-     * Currencies supported by this gateway.
-     *
-     * @var array
-     */
-    protected $_currencies_supported = [
-        'AUD',
-        'BRL',
-        'CAD',
-        'CNY',
-        'CZK',
-        'DKK',
-        'EUR',
-        'HKD',
-        'HUF',
-        'ILS',
-        'JPY',
-        'MYR',
-        'MXN',
-        'TWD',
-        'NZD',
-        'NOK',
-        'PHP',
-        'PLN',
-        'GBP',
-        'RUB',
-        'SGD',
-        'SEK',
-        'CHF',
-        'THB',
-        'USD',
-    ];
+	/**
+	 * Currencies supported by this gateway.
+	 *
+	 * @var array
+	 */
+	protected $_currencies_supported = [
+		'AUD',
+		'BRL',
+		'CAD',
+		'CNY',
+		'CZK',
+		'DKK',
+		'EUR',
+		'HKD',
+		'HUF',
+		'ILS',
+		'JPY',
+		'MYR',
+		'MXN',
+		'TWD',
+		'NZD',
+		'NOK',
+		'PHP',
+		'PLN',
+		'GBP',
+		'RUB',
+		'SGD',
+		'SEK',
+		'CHF',
+		'THB',
+		'USD',
+	];
 
 
-    /**
-     * Override the parent.
-     *
-     * @param EE_Payment|null $payment
-     * @param array|null      $billing_info
-     * @return EE_Payment
-     * @throws EE_Error|ReflectionException
-     */
-    public function do_direct_payment($payment, $billing_info = null)
-    {
-        $request         = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $post_parameters = $request->postParams();
-        // Check the payment.
-        $payment = $this->validatePayment($payment, $request);
-        if ($payment->details() === 'error' && $payment->status() === EEM_Payment::status_id_failed) {
-            return $payment;
-        }
-        $transaction    = $payment->transaction();
-        $payment_method = $transaction->payment_method();
-        // Get the order details.
-        $order_id = $request->getRequestParam('pp_order_id');
-        if (! $order_id) {
-            return EEG_PayPalCheckout::updatePaymentStatus(
-                $payment,
-                EEM_Payment::status_id_failed,
-                $post_parameters,
-                esc_html__('Can\'t charge the Order. The Order ID is missing.', 'event_espresso')
-            );
-        }
-        // Capture the order.
-        $capture_status = EED_PayPalCommerce::captureOrder($transaction, $payment_method, $order_id);
-        // Check the order status.
-        $order_status   = $this->isOrderCompleted($order_id, $transaction, $payment_method);
-        if (! $order_status['completed']) {
-            return EEG_PayPalCheckout::updatePaymentStatus(
-                $payment,
-                EEM_Payment::status_id_failed,
-                $order_status,
-                $order_status['message'] ?? ''
-            );
-        }
-        // Looks like all is good. Mark payment as a success.
-        $this->saveBillingDetails($payment, $transaction, $order_status['details'], $billing_info);
-        return EEG_PayPalCheckout::updatePaymentStatus($payment, EEM_Payment::status_id_approved, $capture_status);
-    }
+	/**
+	 * Override the parent.
+	 *
+	 * @param EE_Payment|null $payment
+	 * @param array|null      $billing_info
+	 * @return EE_Payment
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function do_direct_payment($payment, $billing_info = null)
+	{
+		$request         = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$post_parameters = $request->postParams();
+		// Check the payment.
+		$payment = $this->validatePayment($payment, $request);
+		if ($payment->details() === 'error' && $payment->status() === EEM_Payment::status_id_failed) {
+			return $payment;
+		}
+		$transaction    = $payment->transaction();
+		$payment_method = $transaction->payment_method();
+		// Get the order details.
+		$order_id = $request->getRequestParam('pp_order_id');
+		if (! $order_id) {
+			return EEG_PayPalCheckout::updatePaymentStatus(
+				$payment,
+				EEM_Payment::status_id_failed,
+				$post_parameters,
+				esc_html__('Can\'t charge the Order. The Order ID is missing.', 'event_espresso')
+			);
+		}
+		// Capture the order.
+		$capture_status = EED_PayPalCommerce::captureOrder($transaction, $payment_method, $order_id);
+		// Check the order status.
+		$order_status   = $this->isOrderCompleted($order_id, $transaction, $payment_method);
+		if (! $order_status['completed']) {
+			return EEG_PayPalCheckout::updatePaymentStatus(
+				$payment,
+				EEM_Payment::status_id_failed,
+				$order_status,
+				$order_status['message'] ?? ''
+			);
+		}
+		// Looks like all is good. Mark payment as a success.
+		$this->saveBillingDetails($payment, $transaction, $order_status['details'], $billing_info);
+		return EEG_PayPalCheckout::updatePaymentStatus($payment, EEM_Payment::status_id_approved, $capture_status);
+	}
 
 
-    /**
-     * Validate the Order.
-     *
-     * @param string            $order_id
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $payment_method
-     * @return array ['completed' => {boolean}, 'message' => {string}]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function isOrderCompleted(
-        string $order_id,
-        EE_Transaction $transaction,
-        EE_Payment_Method $payment_method
-    ): array
-    {
-        $order_details = EED_PayPalCommerce::getOrderDetails($order_id, $transaction, $payment_method);
-        $conclusion = [
-            'completed' => false,
-            'details'   => $order_details,
-        ];
-        if (! $order_details) {
-            $conclusion['message'] = esc_html__(
-                'Could not validate this payment. The Order details were empty.',
-                'event_espresso'
-            );
-        } elseif (! empty($order_details['error'])) {
-            $conclusion['message'] = $order_details['message'] ?? $order_details['error'];
-        } elseif (empty($order_details['status'])) {
-            $conclusion['message'] = esc_html__(
-                'There was an error with this payment. The status of the Order could not be determined.',
-                'event_espresso'
-            );
-        } elseif ($order_details['status'] !== 'COMPLETED') {
-            $conclusion['message'] = esc_html__(
-                'There was an error with this payment. Order was not approved.',
-                'event_espresso'
-            );
-        } elseif (empty($order_details['purchase_units'][0]['payments']['captures'][0]['status'])) {
-            $conclusion['message'] = esc_html__(
-                'There was an error with this payment. The status of the Payment could not be determined.',
-                'event_espresso'
-            );
-        } elseif ($order_details['purchase_units'][0]['payments']['captures'][0]['status'] !== 'COMPLETED') {
-            $conclusion['message'] = esc_html__(
-                'This payment was declined or failed validation. Please check the billing information you provided.',
-                'event_espresso'
-            );
-        } else {
-            // If we didn't fail on the above, the Order should be considered valid.
-            $conclusion['completed'] = true;
-            $conclusion['message']   = esc_html__('Order Valid.', 'event_espresso');
-        }
-        return $conclusion;
-    }
+	/**
+	 * Validate the Order.
+	 *
+	 * @param string            $order_id
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $payment_method
+	 * @return array ['completed' => {boolean}, 'message' => {string}]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function isOrderCompleted(
+		string $order_id,
+		EE_Transaction $transaction,
+		EE_Payment_Method $payment_method
+	): array
+	{
+		$order_details = EED_PayPalCommerce::getOrderDetails($order_id, $transaction, $payment_method);
+		$conclusion = [
+			'completed' => false,
+			'details'   => $order_details,
+		];
+		if (! $order_details) {
+			$conclusion['message'] = esc_html__(
+				'Could not validate this payment. The Order details were empty.',
+				'event_espresso'
+			);
+		} elseif (! empty($order_details['error'])) {
+			$conclusion['message'] = $order_details['message'] ?? $order_details['error'];
+		} elseif (empty($order_details['status'])) {
+			$conclusion['message'] = esc_html__(
+				'There was an error with this payment. The status of the Order could not be determined.',
+				'event_espresso'
+			);
+		} elseif ($order_details['status'] !== 'COMPLETED') {
+			$conclusion['message'] = esc_html__(
+				'There was an error with this payment. Order was not approved.',
+				'event_espresso'
+			);
+		} elseif (empty($order_details['purchase_units'][0]['payments']['captures'][0]['status'])) {
+			$conclusion['message'] = esc_html__(
+				'There was an error with this payment. The status of the Payment could not be determined.',
+				'event_espresso'
+			);
+		} elseif ($order_details['purchase_units'][0]['payments']['captures'][0]['status'] !== 'COMPLETED') {
+			$conclusion['message'] = esc_html__(
+				'This payment was declined or failed validation. Please check the billing information you provided.',
+				'event_espresso'
+			);
+		} else {
+			// If we didn't fail on the above, the Order should be considered valid.
+			$conclusion['completed'] = true;
+			$conclusion['message']   = esc_html__('Order Valid.', 'event_espresso');
+		}
+		return $conclusion;
+	}
 
 
-    /**
-     * Create an EE Payment.
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function createPayment(EE_Transaction $transaction, EE_Payment_Method $payment_method): EE_Payment
-    {
-        // No payment for this transaction was created at this point.
-        $payment = EE_Payment::new_instance([
-            'PAY_timestamp'     => time(),
-            'TXN_ID'            => $transaction->ID(),
-            'PMD_ID'            => $payment_method->ID(),
-            'PAY_po_number'     => null,
-            'PAY_extra_accntng' => null,
-            'PAY_details'       => null,
-        ]);
-        $payment->save();
-        return $payment;
-    }
+	/**
+	 * Create an EE Payment.
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function createPayment(EE_Transaction $transaction, EE_Payment_Method $payment_method): EE_Payment
+	{
+		// No payment for this transaction was created at this point.
+		$payment = EE_Payment::new_instance([
+			'PAY_timestamp'     => time(),
+			'TXN_ID'            => $transaction->ID(),
+			'PMD_ID'            => $payment_method->ID(),
+			'PAY_po_number'     => null,
+			'PAY_extra_accntng' => null,
+			'PAY_details'       => null,
+		]);
+		$payment->save();
+		return $payment;
+	}
 
 
-    /**
-     * Set a payment error and log the data.
-     *
-     * @param EE_Payment   $payment
-     * @param string       $status
-     * @param array|string $response_data
-     * @param string       $update_message
-     * @return EE_Payment
-     * @throws EE_Error|ReflectionException
-     */
-    public static function updatePaymentStatus(
-        EE_Payment $payment,
-        string $status,
-        $response_data,
-        string $update_message = ''
-    ): EE_Payment {
-        $paypal_pm = ! empty($payment->payment_method())
-            ? EEM_Payment_Method::instance()->get_one_by_slug($payment->payment_method()->name())
-            : null;
-        // Is this a successful payment ?
-        if ($status === EEM_Payment::status_id_approved) {
-            $default_message = esc_html__('Successful payment.', 'event_espresso');
-            $amount          = $response_data['purchase_units'][0]['payments']['captures'][0]['amount']['value'] ?? 0;
-            // Don't set the amount if there is no info on that with this order.
-            if (! empty($amount)) {
-                $payment->set_amount((float) $amount);
-            }
-            $payment->set_txn_id_chq_nmbr(
-                $response_data['purchase_units'][0]['payments']['captures'][0]['id'] ?? $response_data['id']
-            );
-        } else {
-            $default_message = sprintf(
-                esc_html__(
-                    'Your payment could not be processed successfully due to a technical issue.%1$sPlease try again or contact%2$s for assistance.',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email')
-            );
-        }
-        $log_message = $update_message ?: $default_message;
-        PayPalLogger::errorLog($log_message, $response_data, $paypal_pm, false, $payment->transaction());
-        $payment->set_status($status);
-        $payment->set_details($log_message);
-        $payment->set_gateway_response($log_message);
-        $payment->save();
-        return $payment;
-    }
+	/**
+	 * Set a payment error and log the data.
+	 *
+	 * @param EE_Payment   $payment
+	 * @param string       $status
+	 * @param array|string $response_data
+	 * @param string       $update_message
+	 * @return EE_Payment
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function updatePaymentStatus(
+		EE_Payment $payment,
+		string $status,
+		$response_data,
+		string $update_message = ''
+	): EE_Payment {
+		$paypal_pm = ! empty($payment->payment_method())
+			? EEM_Payment_Method::instance()->get_one_by_slug($payment->payment_method()->name())
+			: null;
+		// Is this a successful payment ?
+		if ($status === EEM_Payment::status_id_approved) {
+			$default_message = esc_html__('Successful payment.', 'event_espresso');
+			$amount          = $response_data['purchase_units'][0]['payments']['captures'][0]['amount']['value'] ?? 0;
+			// Don't set the amount if there is no info on that with this order.
+			if (! empty($amount)) {
+				$payment->set_amount((float) $amount);
+			}
+			$payment->set_txn_id_chq_nmbr(
+				$response_data['purchase_units'][0]['payments']['captures'][0]['id'] ?? $response_data['id']
+			);
+		} else {
+			$default_message = sprintf(
+				esc_html__(
+					'Your payment could not be processed successfully due to a technical issue.%1$sPlease try again or contact%2$s for assistance.',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
+			);
+		}
+		$log_message = $update_message ?: $default_message;
+		PayPalLogger::errorLog($log_message, $response_data, $paypal_pm, false, $payment->transaction());
+		$payment->set_status($status);
+		$payment->set_details($log_message);
+		$payment->set_gateway_response($log_message);
+		$payment->save();
+		return $payment;
+	}
 
 
-    /**
-     * Validate the payment.
-     *
-     * @param EE_Payment|null  $payment
-     * @param RequestInterface $request
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function validatePayment(?EE_Payment $payment, RequestInterface $request): EE_Payment
-    {
-        $failed_status = $this->_pay_model->failed_status();
-        // Check the payment.
-        if (! $payment instanceof EE_Payment) {
-            $payment       = EE_Payment::new_instance();
-            $error_message = esc_html__('Error. No associated payment was found.', 'event_espresso');
-            return EEG_PayPalCheckout::updatePaymentStatus(
-                $payment,
-                $failed_status,
-                $request->postParams(),
-                $error_message
-            );
-        }
-        // Check the transaction.
-        $transaction = $payment->transaction();
-        if (! $transaction instanceof EE_Transaction) {
-            $error_message = esc_html__(
-                'Could not process this payment because it has no associated transaction.',
-                'event_espresso'
-            );
-            return EEG_PayPalCheckout::updatePaymentStatus(
-                $payment,
-                $failed_status,
-                $request->postParams(),
-                $error_message
-            );
-        }
-        return $payment;
-    }
+	/**
+	 * Validate the payment.
+	 *
+	 * @param EE_Payment|null  $payment
+	 * @param RequestInterface $request
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function validatePayment(?EE_Payment $payment, RequestInterface $request): EE_Payment
+	{
+		$failed_status = $this->_pay_model->failed_status();
+		// Check the payment.
+		if (! $payment instanceof EE_Payment) {
+			$payment       = EE_Payment::new_instance();
+			$error_message = esc_html__('Error. No associated payment was found.', 'event_espresso');
+			return EEG_PayPalCheckout::updatePaymentStatus(
+				$payment,
+				$failed_status,
+				$request->postParams(),
+				$error_message
+			);
+		}
+		// Check the transaction.
+		$transaction = $payment->transaction();
+		if (! $transaction instanceof EE_Transaction) {
+			$error_message = esc_html__(
+				'Could not process this payment because it has no associated transaction.',
+				'event_espresso'
+			);
+			return EEG_PayPalCheckout::updatePaymentStatus(
+				$payment,
+				$failed_status,
+				$request->postParams(),
+				$error_message
+			);
+		}
+		return $payment;
+	}
 
 
-    /**
-     * Save some transaction details, like billing information.
-     *
-     * @param EE_Payment     $payment
-     * @param EE_Transaction $transaction
-     * @param array          $order
-     * @param array          $billing
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function saveBillingDetails(
-        EE_Payment $payment,
-        EE_Transaction $transaction,
-        array $order,
-        array $billing
-    ): void {
-        $primary_reg = $transaction->primary_registration();
-        $att    = $primary_reg instanceof EE_Registration ? $primary_reg->attendee() : null;
-        if (! $att instanceof EE_Attendee) {
-            // I guess we are done here then. Just save what we have.
-            $payment->set_details($order);
-            return;
-        }
-        // Defaults:
-        $billing['credit_card'] = 'empty';
-        $billing['first_name']  = empty($billing['first_name']) ? ($att->fname() ?: 'empty') : $billing['first_name'];
-        $billing['last_name']   = empty($billing['last_name']) ? ($att->lname() ?: 'empty') : $billing['last_name'];
-        $billing['email']       = empty($billing['email']) ? ($att->email() ?: 'empty') : $billing['email'];
-        $billing['country']     = empty($billing['country']) ? ($att->country() ?: 'empty') : $billing['country'];
-        $billing['city']        = empty($billing['city']) ? ($att->city() ?: 'empty') : $billing['city'];
-        $billing['state']       = empty($billing['state']) ? ($att->state_name() ?: 'empty') : $billing['state'];
-        $billing['address']     = empty($billing['address']) ? ($att->address() ?: 'empty') : $billing['address'];
-        $billing['address2']    = empty($billing['address2']) ? ($att->address2() ?: 'empty') : $billing['address2'];
-        $billing['zip']         = empty($billing['zip']) ? ($att->zip() ?: 'empty') : $billing['zip'];
-        $billing['phone']       = empty($billing['phone']) ? ($att->phone() ?: 'empty') : $billing['phone'];
+	/**
+	 * Save some transaction details, like billing information.
+	 *
+	 * @param EE_Payment     $payment
+	 * @param EE_Transaction $transaction
+	 * @param array          $order
+	 * @param array          $billing
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function saveBillingDetails(
+		EE_Payment $payment,
+		EE_Transaction $transaction,
+		array $order,
+		array $billing
+	): void {
+		$primary_reg = $transaction->primary_registration();
+		$att    = $primary_reg instanceof EE_Registration ? $primary_reg->attendee() : null;
+		if (! $att instanceof EE_Attendee) {
+			// I guess we are done here then. Just save what we have.
+			$payment->set_details($order);
+			return;
+		}
+		// Defaults:
+		$billing['credit_card'] = 'empty';
+		$billing['first_name']  = empty($billing['first_name']) ? ($att->fname() ?: 'empty') : $billing['first_name'];
+		$billing['last_name']   = empty($billing['last_name']) ? ($att->lname() ?: 'empty') : $billing['last_name'];
+		$billing['email']       = empty($billing['email']) ? ($att->email() ?: 'empty') : $billing['email'];
+		$billing['country']     = empty($billing['country']) ? ($att->country() ?: 'empty') : $billing['country'];
+		$billing['city']        = empty($billing['city']) ? ($att->city() ?: 'empty') : $billing['city'];
+		$billing['state']       = empty($billing['state']) ? ($att->state_name() ?: 'empty') : $billing['state'];
+		$billing['address']     = empty($billing['address']) ? ($att->address() ?: 'empty') : $billing['address'];
+		$billing['address2']    = empty($billing['address2']) ? ($att->address2() ?: 'empty') : $billing['address2'];
+		$billing['zip']         = empty($billing['zip']) ? ($att->zip() ?: 'empty') : $billing['zip'];
+		$billing['phone']       = empty($billing['phone']) ? ($att->phone() ?: 'empty') : $billing['phone'];
 
-        // Try getting the payer information from the payment source (PayPal).
-        if (! empty($order['payment_source'])) {
-            // A card (ACDC) payment ?
-            if (! empty($order['payment_source']['card'])) {
-                $payer = $order['payment_source']['card'];
-            // Or maybe a PayPal Express payment ?
-            } elseif (! empty($order['payment_source']['paypal'])) {
-                $payer = $order['payment_source']['paypal'];
-            }
-            if (! empty($payer)) {
-                if (! empty($payer['name'])) {
-                    // Yup, payment_source card vs PayPal have different info about the payer. So need to differentiate.
-                    if (is_string($payer['name'])) {
-                        $full_name                  = explode(' ', $payer['name']);
-                        $billing['first_name'] = $full_name[0] ?? $billing['first_name'];
-                        $billing['last_name']  = $full_name[1] ?? $billing['last_name'];
-                    }
-                    // PayPal info on the Payment:
-                    if (is_array($payer['name'])) {
-                        $billing['first_name'] = $payer['name']['given_name'] ?? $billing['first_name'];
-                        $billing['last_name']  = $payer['name']['surname'] ?? $billing['last_name'];
-                    }
-                }
-                // Possible info on the payer.
-                $billing['credit_card'] = $payer['last_digits'] ?? $billing['credit_card'];
-                $billing['email']       = $payer['email_address'] ?? $billing['email'];
-                $billing['country']     = $payer['address']['country_code'] ?? $billing['country'];
-                $billing['city']        = $payer['address']['city'] ?? $billing['city'];
-                $billing['state']       = $payer['address']['state'] ?? $billing['state'];
-                $billing['address']     = $payer['address']['address'] ?? $billing['address'];
-                $billing['zip']         = $payer['address']['zip'] ?? $billing['zip'];
-            }
-        }
-        // Update attendee billing info in the transaction details.
-        $payment_method = $transaction->payment_method();
-        $post_meta_name = $payment_method->type_obj() instanceof EE_PMT_Base
-            ? 'billing_info_' . $payment_method->type_obj()->system_name()
-            : '';
-        update_post_meta($att->ID(), $post_meta_name, $billing);
-    }
+		// Try getting the payer information from the payment source (PayPal).
+		if (! empty($order['payment_source'])) {
+			// A card (ACDC) payment ?
+			if (! empty($order['payment_source']['card'])) {
+				$payer = $order['payment_source']['card'];
+			// Or maybe a PayPal Express payment ?
+			} elseif (! empty($order['payment_source']['paypal'])) {
+				$payer = $order['payment_source']['paypal'];
+			}
+			if (! empty($payer)) {
+				if (! empty($payer['name'])) {
+					// Yup, payment_source card vs PayPal have different info about the payer. So need to differentiate.
+					if (is_string($payer['name'])) {
+						$full_name                  = explode(' ', $payer['name']);
+						$billing['first_name'] = $full_name[0] ?? $billing['first_name'];
+						$billing['last_name']  = $full_name[1] ?? $billing['last_name'];
+					}
+					// PayPal info on the Payment:
+					if (is_array($payer['name'])) {
+						$billing['first_name'] = $payer['name']['given_name'] ?? $billing['first_name'];
+						$billing['last_name']  = $payer['name']['surname'] ?? $billing['last_name'];
+					}
+				}
+				// Possible info on the payer.
+				$billing['credit_card'] = $payer['last_digits'] ?? $billing['credit_card'];
+				$billing['email']       = $payer['email_address'] ?? $billing['email'];
+				$billing['country']     = $payer['address']['country_code'] ?? $billing['country'];
+				$billing['city']        = $payer['address']['city'] ?? $billing['city'];
+				$billing['state']       = $payer['address']['state'] ?? $billing['state'];
+				$billing['address']     = $payer['address']['address'] ?? $billing['address'];
+				$billing['zip']         = $payer['address']['zip'] ?? $billing['zip'];
+			}
+		}
+		// Update attendee billing info in the transaction details.
+		$payment_method = $transaction->payment_method();
+		$post_meta_name = $payment_method->type_obj() instanceof EE_PMT_Base
+			? 'billing_info_' . $payment_method->type_obj()->system_name()
+			: '';
+		update_post_meta($att->ID(), $post_meta_name, $billing);
+	}
 }

Spacing +16 added lines, -16 removed lines

@@ -68,7 +68,7 @@ 
         $payment_method = $transaction->payment_method();
         // Get the order details.
         $order_id = $request->getRequestParam('pp_order_id');
-        if (! $order_id) {
+        if ( ! $order_id) {
             return EEG_PayPalCheckout::updatePaymentStatus(
                 $payment,
                 EEM_Payment::status_id_failed,
@@ -80,7 +80,7 @@ 
         $capture_status = EED_PayPalCommerce::captureOrder($transaction, $payment_method, $order_id);
         // Check the order status.
         $order_status   = $this->isOrderCompleted($order_id, $transaction, $payment_method);
-        if (! $order_status['completed']) {
+        if ( ! $order_status['completed']) {
             return EEG_PayPalCheckout::updatePaymentStatus(
                 $payment,
                 EEM_Payment::status_id_failed,
@@ -115,12 +115,12 @@ 
             'completed' => false,
             'details'   => $order_details,
         ];
-        if (! $order_details) {
+        if ( ! $order_details) {
             $conclusion['message'] = esc_html__(
                 'Could not validate this payment. The Order details were empty.',
                 'event_espresso'
             );
-        } elseif (! empty($order_details['error'])) {
+        } elseif ( ! empty($order_details['error'])) {
             $conclusion['message'] = $order_details['message'] ?? $order_details['error'];
         } elseif (empty($order_details['status'])) {
             $conclusion['message'] = esc_html__(
@@ -200,7 +200,7 @@ 
             $default_message = esc_html__('Successful payment.', 'event_espresso');
             $amount          = $response_data['purchase_units'][0]['payments']['captures'][0]['amount']['value'] ?? 0;
             // Don't set the amount if there is no info on that with this order.
-            if (! empty($amount)) {
+            if ( ! empty($amount)) {
                 $payment->set_amount((float) $amount);
             }
             $payment->set_txn_id_chq_nmbr(
@@ -239,7 +239,7 @@ 
     {
         $failed_status = $this->_pay_model->failed_status();
         // Check the payment.
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             $payment       = EE_Payment::new_instance();
             $error_message = esc_html__('Error. No associated payment was found.', 'event_espresso');
             return EEG_PayPalCheckout::updatePaymentStatus(
@@ -251,7 +251,7 @@ 
         }
         // Check the transaction.
         $transaction = $payment->transaction();
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             $error_message = esc_html__(
                 'Could not process this payment because it has no associated transaction.',
                 'event_espresso'
@@ -285,8 +285,8 @@ 
         array $billing
     ): void {
         $primary_reg = $transaction->primary_registration();
-        $att    = $primary_reg instanceof EE_Registration ? $primary_reg->attendee() : null;
-        if (! $att instanceof EE_Attendee) {
+        $att = $primary_reg instanceof EE_Registration ? $primary_reg->attendee() : null;
+        if ( ! $att instanceof EE_Attendee) {
             // I guess we are done here then. Just save what we have.
             $payment->set_details($order);
             return;
@@ -305,19 +305,19 @@ 
         $billing['phone']       = empty($billing['phone']) ? ($att->phone() ?: 'empty') : $billing['phone'];
 
         // Try getting the payer information from the payment source (PayPal).
-        if (! empty($order['payment_source'])) {
+        if ( ! empty($order['payment_source'])) {
             // A card (ACDC) payment ?
-            if (! empty($order['payment_source']['card'])) {
+            if ( ! empty($order['payment_source']['card'])) {
                 $payer = $order['payment_source']['card'];
             // Or maybe a PayPal Express payment ?
-            } elseif (! empty($order['payment_source']['paypal'])) {
+            } elseif ( ! empty($order['payment_source']['paypal'])) {
                 $payer = $order['payment_source']['paypal'];
             }
-            if (! empty($payer)) {
-                if (! empty($payer['name'])) {
+            if ( ! empty($payer)) {
+                if ( ! empty($payer['name'])) {
                     // Yup, payment_source card vs PayPal have different info about the payer. So need to differentiate.
                     if (is_string($payer['name'])) {
-                        $full_name                  = explode(' ', $payer['name']);
+                        $full_name = explode(' ', $payer['name']);
                         $billing['first_name'] = $full_name[0] ?? $billing['first_name'];
                         $billing['last_name']  = $full_name[1] ?? $billing['last_name'];
                     }
@@ -340,7 +340,7 @@ 
         // Update attendee billing info in the transaction details.
         $payment_method = $transaction->payment_method();
         $post_meta_name = $payment_method->type_obj() instanceof EE_PMT_Base
-            ? 'billing_info_' . $payment_method->type_obj()->system_name()
+            ? 'billing_info_'.$payment_method->type_obj()->system_name()
             : '';
         update_post_meta($att->ID(), $post_meta_name, $billing);
     }

PaymentMethods/PayPalCommerce/api/orders/CreateOrder.php

Indentation +275 added lines, -275 removed lines

@@ -30,302 +30,302 @@
  */
 class CreateOrder extends OrdersApi
 {
-    /**
-     * Line items total.
-     *
-     * @var float
-     */
-    protected float $items_total = 0.0;
+	/**
+	 * Line items total.
+	 *
+	 * @var float
+	 */
+	protected float $items_total = 0.0;
 
-    /**
-     * Promotions total.
-     *
-     * @var float
-     */
-    protected float $promos_total = 0.0;
+	/**
+	 * Promotions total.
+	 *
+	 * @var float
+	 */
+	protected float $promos_total = 0.0;
 
-    /**
-     * Tax total.
-     *
-     * @var float
-     */
-    protected float $tax_total = 0.0;
+	/**
+	 * Tax total.
+	 *
+	 * @var float
+	 */
+	protected float $tax_total = 0.0;
 
-    /**
-     * Currency.
-     *
-     * @var string
-     */
-    protected string $currency_code;
+	/**
+	 * Currency.
+	 *
+	 * @var string
+	 */
+	protected string $currency_code;
 
-    /**
-     * Billing info.
-     *
-     * @var array
-     */
-    protected array $billing_info;
+	/**
+	 * Billing info.
+	 *
+	 * @var array
+	 */
+	protected array $billing_info;
 
-    /**
-     * Transaction this order is for.
-     *
-     * @var EE_Transaction
-     */
-    protected EE_Transaction $transaction;
+	/**
+	 * Transaction this order is for.
+	 *
+	 * @var EE_Transaction
+	 */
+	protected EE_Transaction $transaction;
 
-    private FeatureFlags $feature;
+	private FeatureFlags $feature;
 
 
-    /**
-     * CreateOrder constructor.
-     *
-     * @param PayPalApi      $api
-     * @param EE_Transaction $transaction
-     * @param array          $billing_info
-     * @param FeatureFlags   $feature
-     */
-    public function __construct(PayPalApi $api, EE_Transaction $transaction, array $billing_info, FeatureFlags $feature)
-    {
-        parent::__construct($api);
-        $this->transaction   = $transaction;
-        $this->feature       = $feature;
-        $this->currency_code = CurrencyManager::currencyCode();
-        $this->sanitizeRequestParameters($billing_info);
-    }
+	/**
+	 * CreateOrder constructor.
+	 *
+	 * @param PayPalApi      $api
+	 * @param EE_Transaction $transaction
+	 * @param array          $billing_info
+	 * @param FeatureFlags   $feature
+	 */
+	public function __construct(PayPalApi $api, EE_Transaction $transaction, array $billing_info, FeatureFlags $feature)
+	{
+		parent::__construct($api);
+		$this->transaction   = $transaction;
+		$this->feature       = $feature;
+		$this->currency_code = CurrencyManager::currencyCode();
+		$this->sanitizeRequestParameters($billing_info);
+	}
 
 
-    /**
-     * Sanitize the array of billing form data.
-     *
-     * @param array $billing_info
-     * @return void
-     */
-    public function sanitizeRequestParameters(array $billing_info): void
-    {
-        $sanitizer       = new RequestSanitizer(new Basic());
-        foreach ($billing_info as $item => $value) {
-            $this->billing_info[ $item ] = $sanitizer->clean($value);
-        }
-    }
+	/**
+	 * Sanitize the array of billing form data.
+	 *
+	 * @param array $billing_info
+	 * @return void
+	 */
+	public function sanitizeRequestParameters(array $billing_info): void
+	{
+		$sanitizer       = new RequestSanitizer(new Basic());
+		foreach ($billing_info as $item => $value) {
+			$this->billing_info[ $item ] = $sanitizer->clean($value);
+		}
+	}
 
 
-    /**
-     * Create PayPal Order.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create(): array
-    {
-        $order_parameters = $this->getParameters();
-        // Create Order request.
-        $create_response = $this->api->sendRequest($order_parameters, $this->request_url);
-        return $this->validateOrder($create_response, $order_parameters);
-    }
+	/**
+	 * Create PayPal Order.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create(): array
+	{
+		$order_parameters = $this->getParameters();
+		// Create Order request.
+		$create_response = $this->api->sendRequest($order_parameters, $this->request_url);
+		return $this->validateOrder($create_response, $order_parameters);
+	}
 
 
-    /**
-     * Form order parameters.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    protected function getParameters(): array
-    {
-        $registrant  = $this->transaction->primary_registration();
-        $attendee    = $registrant->attendee();
-        $event       = $registrant->event();
-        $description = $event->name() ?: sprintf(
-            esc_html__('Tickets for an event at %1$s', 'event_espresso'),
-            get_bloginfo('name')
-        );
-        $parameters  = [
-            'intent'              => 'CAPTURE',
-            'purchase_units'      => [
-                [
-                    'custom_id'   => $this->transaction->ID(),
-                    'description' => substr(wp_strip_all_tags($description), 0, 125),
-                    'items'       => $this->getLineItems(),
-                    'amount'      => [
-                        'value'         => $this->transaction->remaining(),
-                        'currency_code' => $this->currency_code,
-                        'breakdown'     => $this->getBreakdown(),
-                    ],
-                ],
-            ],
-            'application_context' => [
-                'shipping_preference' => 'NO_SHIPPING',
-                'user_action'         => 'PAY_NOW',
-            ],
-            'payer'               => [
-                'email_address' => $attendee->email(),
-                'name'          => [
-                    'given_name' => $attendee->fname(),
-                    'surname'    => $attendee->lname(),
+	/**
+	 * Form order parameters.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	protected function getParameters(): array
+	{
+		$registrant  = $this->transaction->primary_registration();
+		$attendee    = $registrant->attendee();
+		$event       = $registrant->event();
+		$description = $event->name() ?: sprintf(
+			esc_html__('Tickets for an event at %1$s', 'event_espresso'),
+			get_bloginfo('name')
+		);
+		$parameters  = [
+			'intent'              => 'CAPTURE',
+			'purchase_units'      => [
+				[
+					'custom_id'   => $this->transaction->ID(),
+					'description' => substr(wp_strip_all_tags($description), 0, 125),
+					'items'       => $this->getLineItems(),
+					'amount'      => [
+						'value'         => $this->transaction->remaining(),
+						'currency_code' => $this->currency_code,
+						'breakdown'     => $this->getBreakdown(),
+					],
+				],
+			],
+			'application_context' => [
+				'shipping_preference' => 'NO_SHIPPING',
+				'user_action'         => 'PAY_NOW',
+			],
+			'payer'               => [
+				'email_address' => $attendee->email(),
+				'name'          => [
+					'given_name' => $attendee->fname(),
+					'surname'    => $attendee->lname(),
 
-                ],
-            ],
-        ];
-        // Do we have the permissions for the fees ?
-        $scopes = PayPalExtraMetaManager::getPmOption(
-            $this->transaction->payment_method(),
-            Domain::META_KEY_AUTHORIZED_SCOPES
-        );
-        if (
-            (
-                (defined('EE_PPC_USE_PAYMENT_FEES') && EE_PPC_USE_PAYMENT_FEES)
-                || (! defined('EE_PPC_USE_PAYMENT_FEES')
-                    && $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
-                )
-            )
-            && ! empty($scopes) && in_array('partnerfee', $scopes)
-        ) {
-            /** @var PartnerPaymentFees $payment_fees */
-            $payment_fees                                           = LoaderFactory::getShared(PartnerPaymentFees::class);
-            $parameters['purchase_units'][0]['payment_instruction'] = [
-                'platform_fees' => [
-                    [
-                        'amount' => [
-                            'value'         => (string) $payment_fees->getPartnerFee($this->transaction),
-                            'currency_code' => $this->currency_code,
-                        ],
-                    ],
-                ]
-            ];
-        }
-        return $parameters;
-    }
+				],
+			],
+		];
+		// Do we have the permissions for the fees ?
+		$scopes = PayPalExtraMetaManager::getPmOption(
+			$this->transaction->payment_method(),
+			Domain::META_KEY_AUTHORIZED_SCOPES
+		);
+		if (
+			(
+				(defined('EE_PPC_USE_PAYMENT_FEES') && EE_PPC_USE_PAYMENT_FEES)
+				|| (! defined('EE_PPC_USE_PAYMENT_FEES')
+					&& $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
+				)
+			)
+			&& ! empty($scopes) && in_array('partnerfee', $scopes)
+		) {
+			/** @var PartnerPaymentFees $payment_fees */
+			$payment_fees                                           = LoaderFactory::getShared(PartnerPaymentFees::class);
+			$parameters['purchase_units'][0]['payment_instruction'] = [
+				'platform_fees' => [
+					[
+						'amount' => [
+							'value'         => (string) $payment_fees->getPartnerFee($this->transaction),
+							'currency_code' => $this->currency_code,
+						],
+					],
+				]
+			];
+		}
+		return $parameters;
+	}
 
 
-    /**
-     * Itemize the payment. List all the line items, discounts and taxes.
-     *
-     * @return array
-     * @throws EE_Error|ReflectionException
-     */
-    protected function getLineItems(): array
-    {
-        // Order line items.
-        $line_items       = [];
-        $event_line_items = $this->transaction->items_purchased();
-        // List actual line items.
-        foreach ($event_line_items as $line_item) {
-            if (
-                $line_item instanceof EE_Line_Item
-                && $line_item->OBJ_type() !== 'Promotion'
-                && $line_item->quantity() > 0
-            ) {
-                $item_money     = $line_item->unit_price();
-                $li_description = $line_item->desc() ?? esc_html__('Event Ticket', 'event_espresso');
-                $line_items []  = [
-                    'name'        => substr(wp_strip_all_tags($line_item->name()), 0, 126),
-                    'quantity'    => $line_item->quantity(),
-                    'description' => substr(wp_strip_all_tags($li_description), 0, 125),
-                    'unit_amount' => [
-                        'currency_code' => $this->currency_code,
-                        'value'         => $item_money,
-                    ],
-                    'category'    => 'DIGITAL_GOODS',
-                ];
-                // Line item total.
-                $this->items_total += $line_item->pretaxTotal();
-            } elseif ($line_item->OBJ_type() === 'Promotion' && $line_item->quantity() > 0) {
-                // Promotions total.
-                $this->promos_total += $line_item->total();
-            }
-        }
-        // Make sure we have an absolute number with only two decimal laces.
-        $this->items_total  = CurrencyManager::normalizeValue($this->items_total);
-        $this->promos_total = CurrencyManager::normalizeValue($this->promos_total);
-        // If this is a partial payment, apply the paid amount as a promo.
-        if ($this->transaction->paid() > 0) {
-            $this->promos_total += CurrencyManager::normalizeValue($this->transaction->paid());
-        }
-        $this->countTaxTotal();
-        return $line_items;
-    }
+	/**
+	 * Itemize the payment. List all the line items, discounts and taxes.
+	 *
+	 * @return array
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected function getLineItems(): array
+	{
+		// Order line items.
+		$line_items       = [];
+		$event_line_items = $this->transaction->items_purchased();
+		// List actual line items.
+		foreach ($event_line_items as $line_item) {
+			if (
+				$line_item instanceof EE_Line_Item
+				&& $line_item->OBJ_type() !== 'Promotion'
+				&& $line_item->quantity() > 0
+			) {
+				$item_money     = $line_item->unit_price();
+				$li_description = $line_item->desc() ?? esc_html__('Event Ticket', 'event_espresso');
+				$line_items []  = [
+					'name'        => substr(wp_strip_all_tags($line_item->name()), 0, 126),
+					'quantity'    => $line_item->quantity(),
+					'description' => substr(wp_strip_all_tags($li_description), 0, 125),
+					'unit_amount' => [
+						'currency_code' => $this->currency_code,
+						'value'         => $item_money,
+					],
+					'category'    => 'DIGITAL_GOODS',
+				];
+				// Line item total.
+				$this->items_total += $line_item->pretaxTotal();
+			} elseif ($line_item->OBJ_type() === 'Promotion' && $line_item->quantity() > 0) {
+				// Promotions total.
+				$this->promos_total += $line_item->total();
+			}
+		}
+		// Make sure we have an absolute number with only two decimal laces.
+		$this->items_total  = CurrencyManager::normalizeValue($this->items_total);
+		$this->promos_total = CurrencyManager::normalizeValue($this->promos_total);
+		// If this is a partial payment, apply the paid amount as a promo.
+		if ($this->transaction->paid() > 0) {
+			$this->promos_total += CurrencyManager::normalizeValue($this->transaction->paid());
+		}
+		$this->countTaxTotal();
+		return $line_items;
+	}
 
 
-    /**
-     * Count the tax total.
-     *
-     * @return void
-     * @throws EE_Error|ReflectionException
-     */
-    protected function countTaxTotal(): void
-    {
-        // List taxes.
-        $this->tax_total = 0.0;
-        $tax_items       = $this->transaction->tax_items();
-        foreach ($tax_items as $tax_item) {
-            $this->tax_total += $tax_item->total();
-        }
-        $this->tax_total = CurrencyManager::normalizeValue($this->tax_total);
-    }
+	/**
+	 * Count the tax total.
+	 *
+	 * @return void
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected function countTaxTotal(): void
+	{
+		// List taxes.
+		$this->tax_total = 0.0;
+		$tax_items       = $this->transaction->tax_items();
+		foreach ($tax_items as $tax_item) {
+			$this->tax_total += $tax_item->total();
+		}
+		$this->tax_total = CurrencyManager::normalizeValue($this->tax_total);
+	}
 
 
-    /**
-     * Itemize the payment the breakdown list.
-     *
-     * @return array
-     */
-    protected function getBreakdown(): array
-    {
-        $breakdown['item_total'] = [
-            'currency_code' => $this->currency_code,
-            'value'         => $this->items_total,
-        ];
-        $breakdown['tax_total']  = [
-            'currency_code' => $this->currency_code,
-            'value'         => $this->tax_total,
-        ];
-        $breakdown['discount']   = [
-            'currency_code' => $this->currency_code,
-            'value'         => abs($this->promos_total),
-        ];
-        return $breakdown;
-    }
+	/**
+	 * Itemize the payment the breakdown list.
+	 *
+	 * @return array
+	 */
+	protected function getBreakdown(): array
+	{
+		$breakdown['item_total'] = [
+			'currency_code' => $this->currency_code,
+			'value'         => $this->items_total,
+		];
+		$breakdown['tax_total']  = [
+			'currency_code' => $this->currency_code,
+			'value'         => $this->tax_total,
+		];
+		$breakdown['discount']   = [
+			'currency_code' => $this->currency_code,
+			'value'         => abs($this->promos_total),
+		];
+		return $breakdown;
+	}
 
 
-    /**
-     * Makes sure that we have received an Order back from the API call.
-     *
-     * @param $response
-     * @param $parameters
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function validateOrder($response, $parameters): array
-    {
-        PayPalLogger::errorLog(
-            esc_html__('Validating Order Create:', 'event_espresso'),
-            [$this->request_url, $response],
-            $this->transaction->payment_method(),
-            false,
-            $this->transaction
-        );
-        if (! empty($response['error'])) {
-            return $response;
-        }
-        if (! isset($response['id'])) {
-            $message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
-            try {
-                PayPalLogger::errorLog(
-                    $message,
-                    [$this->request_url, $parameters, $response],
-                    $this->transaction->payment_method()
-                );
-            } catch (EE_Error | ReflectionException $e) {
-                error_log("PayPalLogger Error: $message: " . json_encode($response));
-            }
-            return [
-                'error'   => $response['error'] ?? 'missing_order',
-                'message' => $response['message'] ?? $message,
-            ];
-        }
-        return $response;
-    }
+	/**
+	 * Makes sure that we have received an Order back from the API call.
+	 *
+	 * @param $response
+	 * @param $parameters
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function validateOrder($response, $parameters): array
+	{
+		PayPalLogger::errorLog(
+			esc_html__('Validating Order Create:', 'event_espresso'),
+			[$this->request_url, $response],
+			$this->transaction->payment_method(),
+			false,
+			$this->transaction
+		);
+		if (! empty($response['error'])) {
+			return $response;
+		}
+		if (! isset($response['id'])) {
+			$message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
+			try {
+				PayPalLogger::errorLog(
+					$message,
+					[$this->request_url, $parameters, $response],
+					$this->transaction->payment_method()
+				);
+			} catch (EE_Error | ReflectionException $e) {
+				error_log("PayPalLogger Error: $message: " . json_encode($response));
+			}
+			return [
+				'error'   => $response['error'] ?? 'missing_order',
+				'message' => $response['message'] ?? $message,
+			];
+		}
+		return $response;
+	}
 }

espresso.php

Indentation +107 added lines, -107 removed lines

@@ -37,138 +37,138 @@
  * @since       4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time.
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time.
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
 <div class="error">
     <p>
         <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
     </p>
 </div>
 <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '7.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '7.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
 <div class="error">
     <p>
         <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="https://www.php.net/downloads.php">https://php.net/downloads.php</a>'
-                    );
-        ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="https://www.php.net/downloads.php">https://php.net/downloads.php</a>'
+					);
+		?>
     </p>
 </div>
 <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
 
-        require_once __DIR__ . '/vendor/autoload.php';
+		require_once __DIR__ . '/vendor/autoload.php';
 
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version(): string
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '5.0.31.rc.000');
-        }
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version(): string
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '5.0.31.rc.000');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-            update_option('event-espresso-core_allow_tracking', 'no');
-            update_option('event-espresso-core_tracking_notice', 'hide');
-            // Run WP GraphQL activation callback
-            espressoLoadWpGraphQL();
-            graphql_activation_callback();
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+			update_option('event-espresso-core_allow_tracking', 'no');
+			update_option('event-espresso-core_tracking_notice', 'hide');
+			// Run WP GraphQL activation callback
+			espressoLoadWpGraphQL();
+			graphql_activation_callback();
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        /**
-         * espresso_plugin_deactivation
-         */
-        function espresso_plugin_deactivation()
-        {
-            // Run WP GraphQL deactivation callback
-            espressoLoadWpGraphQL();
-            graphql_deactivation_callback();
-            delete_option('event-espresso-core_allow_tracking');
-            delete_option('event-espresso-core_tracking_notice');
-        }
-        register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
+		/**
+		 * espresso_plugin_deactivation
+		 */
+		function espresso_plugin_deactivation()
+		{
+			// Run WP GraphQL deactivation callback
+			espressoLoadWpGraphQL();
+			graphql_deactivation_callback();
+			delete_option('event-espresso-core_allow_tracking');
+			delete_option('event-espresso-core_tracking_notice');
+		}
+		register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin(string $plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin(string $plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
 
 
 if (! function_exists('espressoLoadWpGraphQL')) {
-    function espressoLoadWpGraphQL()
-    {
-        if (
-            ! class_exists('WPGraphQL')
-            && is_readable(__DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php')
-        ) {
-            require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
-        }
-    }
+	function espressoLoadWpGraphQL()
+	{
+		if (
+			! class_exists('WPGraphQL')
+			&& is_readable(__DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php')
+		) {
+			require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
+		}
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -37,7 +37,7 @@ 
  * @since       4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
+    if ( ! function_exists('espresso_duplicate_plugin_error')) {
         /**
          *    espresso_duplicate_plugin_error
          *    displays if more than one version of EE is activated at the same time.
@@ -61,7 +61,7 @@ 
     add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
     define('EE_MIN_PHP_VER_REQUIRED', '7.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+    if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
         /**
          * espresso_minimum_php_version_error
          *
@@ -94,7 +94,7 @@ 
     } else {
         define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
 
-        require_once __DIR__ . '/vendor/autoload.php';
+        require_once __DIR__.'/vendor/autoload.php';
 
         /**
          * espresso_version
@@ -136,12 +136,12 @@ 
         }
         register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
+        require_once __DIR__.'/core/bootstrap_espresso.php';
         bootstrap_espresso();
     }
 }
 
-if (! function_exists('espresso_deactivate_plugin')) {
+if ( ! function_exists('espresso_deactivate_plugin')) {
     /**
      *    deactivate_plugin
      * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
@@ -152,8 +152,8 @@ 
      */
     function espresso_deactivate_plugin(string $plugin_basename = '')
     {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
+        if ( ! function_exists('deactivate_plugins')) {
+            require_once ABSPATH.'wp-admin/includes/plugin.php';
         }
         unset($_GET['activate'], $_REQUEST['activate']);
         deactivate_plugins($plugin_basename);
@@ -161,14 +161,14 @@ 
 }
 
 
-if (! function_exists('espressoLoadWpGraphQL')) {
+if ( ! function_exists('espressoLoadWpGraphQL')) {
     function espressoLoadWpGraphQL()
     {
         if (
             ! class_exists('WPGraphQL')
-            && is_readable(__DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php')
+            && is_readable(__DIR__.'/vendor/wp-graphql/wp-graphql/wp-graphql.php')
         ) {
-            require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
+            require_once __DIR__.'/vendor/wp-graphql/wp-graphql/wp-graphql.php';
         }
     }
 }

core/db_models/EEM_Term_Relationship.model.php

Indentation +213 added lines, -213 removed lines

@@ -9,236 +9,236 @@
  */
 class EEM_Term_Relationship extends EEM_Base
 {
-    protected static ?EEM_Term_Relationship $_instance = null;
+	protected static ?EEM_Term_Relationship $_instance = null;
 
 
-    /**
-     * EEM_Term_Relationship constructor.
-     *
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item       = esc_html__('Term Relationship', 'event_espresso');
-        $this->plural_item         = esc_html__('Term Relationships', 'event_espresso');
-        $this->_tables             = [
-            'Term_Relationship' => new EE_Primary_Table('term_relationships'),
-        ];
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
-        $this->_fields             = [
-            'Term_Relationship' => [
-                'object_id'        => new EE_Foreign_Key_Int_Field(
-                    'object_id',
-                    esc_html__('Object(Post) ID', 'event_espresso'),
-                    false,
-                    0,
-                    $models_this_can_attach_to
-                ),
-                'term_taxonomy_id' => new EE_Foreign_Key_Int_Field(
-                    'term_taxonomy_id',
-                    esc_html__(
-                        'Term (in context of a taxonomy) ID',
-                        'event_espresso'
-                    ),
-                    false,
-                    0,
-                    'Term_Taxonomy'
-                ),
-                'term_order'       => new EE_Integer_Field(
-                    'term_order',
-                    esc_html__('Term Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-            ],
-        ];
-        $this->_model_relations    = [
-            'Term_Taxonomy' => new EE_Belongs_To_Relation(),
-        ];
-        foreach ($models_this_can_attach_to as $model_name) {
-            $this->_model_relations[ $model_name ] = new EE_Belongs_To_Relation();
-        }
-        $this->_wp_core_model                                           = true;
-        $this->_indexes                                                 = [
-            'PRIMARY' => new EE_Primary_Key_Index(['object_id', 'term_taxonomy_id']),
-        ];
-        $path_to_event_model                                            = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Event_Related_Public(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model,
-                EEM_Base::caps_edit
-            );
-        $path_to_tax_model                                              = 'Term_Taxonomy.';
-        // add cap restrictions for editing term relations to the "ee_assign_*"
-        // and for deleting term relations too
-        $cap_contexts_affected = [EEM_Base::caps_edit, EEM_Base::caps_delete];
-        foreach ($cap_contexts_affected as $cap_context_affected) {
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_category'] =
-                new EE_Default_Where_Conditions(
-                    [
-                        $path_to_tax_model . 'taxonomy*ee_assign_event_category' => [
-                            '!=',
-                            'espresso_event_categories',
-                        ],
-                    ]
-                );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category'] =
-                new EE_Default_Where_Conditions(
-                    [
-                        $path_to_tax_model . 'taxonomy*ee_assign_venue_category' => [
-                            '!=',
-                            'espresso_venue_categories',
-                        ],
-                    ]
-                );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type']     =
-                new EE_Default_Where_Conditions(
-                    [
-                        $path_to_tax_model . 'taxonomy*ee_assign_event_type' => ['!=', 'espresso_event_type'],
-                    ]
-                );
-        }
-        parent::__construct($timezone);
-        add_filter(
-            'FHEE__Read__create_model_query_params',
-            ['EEM_Term_Relationship', 'rest_api_query_params'],
-            10,
-            3
-        );
-    }
+	/**
+	 * EEM_Term_Relationship constructor.
+	 *
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item       = esc_html__('Term Relationship', 'event_espresso');
+		$this->plural_item         = esc_html__('Term Relationships', 'event_espresso');
+		$this->_tables             = [
+			'Term_Relationship' => new EE_Primary_Table('term_relationships'),
+		];
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
+		$this->_fields             = [
+			'Term_Relationship' => [
+				'object_id'        => new EE_Foreign_Key_Int_Field(
+					'object_id',
+					esc_html__('Object(Post) ID', 'event_espresso'),
+					false,
+					0,
+					$models_this_can_attach_to
+				),
+				'term_taxonomy_id' => new EE_Foreign_Key_Int_Field(
+					'term_taxonomy_id',
+					esc_html__(
+						'Term (in context of a taxonomy) ID',
+						'event_espresso'
+					),
+					false,
+					0,
+					'Term_Taxonomy'
+				),
+				'term_order'       => new EE_Integer_Field(
+					'term_order',
+					esc_html__('Term Order', 'event_espresso'),
+					false,
+					0
+				),
+			],
+		];
+		$this->_model_relations    = [
+			'Term_Taxonomy' => new EE_Belongs_To_Relation(),
+		];
+		foreach ($models_this_can_attach_to as $model_name) {
+			$this->_model_relations[ $model_name ] = new EE_Belongs_To_Relation();
+		}
+		$this->_wp_core_model                                           = true;
+		$this->_indexes                                                 = [
+			'PRIMARY' => new EE_Primary_Key_Index(['object_id', 'term_taxonomy_id']),
+		];
+		$path_to_event_model                                            = 'Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Event_Related_Public(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model,
+				EEM_Base::caps_edit
+			);
+		$path_to_tax_model                                              = 'Term_Taxonomy.';
+		// add cap restrictions for editing term relations to the "ee_assign_*"
+		// and for deleting term relations too
+		$cap_contexts_affected = [EEM_Base::caps_edit, EEM_Base::caps_delete];
+		foreach ($cap_contexts_affected as $cap_context_affected) {
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_category'] =
+				new EE_Default_Where_Conditions(
+					[
+						$path_to_tax_model . 'taxonomy*ee_assign_event_category' => [
+							'!=',
+							'espresso_event_categories',
+						],
+					]
+				);
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category'] =
+				new EE_Default_Where_Conditions(
+					[
+						$path_to_tax_model . 'taxonomy*ee_assign_venue_category' => [
+							'!=',
+							'espresso_venue_categories',
+						],
+					]
+				);
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type']     =
+				new EE_Default_Where_Conditions(
+					[
+						$path_to_tax_model . 'taxonomy*ee_assign_event_type' => ['!=', 'espresso_event_type'],
+					]
+				);
+		}
+		parent::__construct($timezone);
+		add_filter(
+			'FHEE__Read__create_model_query_params',
+			['EEM_Term_Relationship', 'rest_api_query_params'],
+			10,
+			3
+		);
+	}
 
 
-    /**
-     * Makes sure all term-taxonomy counts are correct
-     *
-     * @param int   $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL
-     * @return int the number of rows affected
-     * @throws EE_Error
-     * @global wpdb $wpdb
-     */
-    public function update_term_taxonomy_counts($term_taxonomy_id = null)
-    {
-        // because this uses a subquery and sometimes assigning to column to be another column's
-        // value, we just write the SQL directly.
-        global $wpdb;
+	/**
+	 * Makes sure all term-taxonomy counts are correct
+	 *
+	 * @param int   $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL
+	 * @return int the number of rows affected
+	 * @throws EE_Error
+	 * @global wpdb $wpdb
+	 */
+	public function update_term_taxonomy_counts($term_taxonomy_id = null)
+	{
+		// because this uses a subquery and sometimes assigning to column to be another column's
+		// value, we just write the SQL directly.
+		global $wpdb;
 
-        $query = "
+		$query = "
                 UPDATE {$wpdb->term_taxonomy} AS tt
                 SET count = (
                     select count(*) as proper_count from {$wpdb->term_relationships} AS tr
                     WHERE tt.term_taxonomy_id = tr.term_taxonomy_id
                 )";
 
-        if ($term_taxonomy_id) {
-            $query .= ' WHERE tt.term_taxonomy_id = %d';
-            $query = $wpdb->prepare(
-                $query,
-                $term_taxonomy_id
-            );
-        }
-        $rows_affected = $this->_do_wpdb_query(
-            'query',
-            [
-                $query,
-            ]
-        );
-        return $rows_affected;
-    }
+		if ($term_taxonomy_id) {
+			$query .= ' WHERE tt.term_taxonomy_id = %d';
+			$query = $wpdb->prepare(
+				$query,
+				$term_taxonomy_id
+			);
+		}
+		$rows_affected = $this->_do_wpdb_query(
+			'query',
+			[
+				$query,
+			]
+		);
+		return $rows_affected;
+	}
 
 
-    /**
-     * Overrides the parent to also make sure term-taxonomy counts are up-to-date after
-     * inserting
-     *
-     * @param array $field_n_values @see EEM_Base::insert
-     * @return boolean
-     */
-    public function insert($field_n_values)
-    {
-        $return = parent::insert($field_n_values);
-        if (isset($field_n_values['term_taxonomy_id'])) {
-            $this->update_term_taxonomy_counts($field_n_values['term_taxonomy_id']);
-        }
-        return $return;
-    }
+	/**
+	 * Overrides the parent to also make sure term-taxonomy counts are up-to-date after
+	 * inserting
+	 *
+	 * @param array $field_n_values @see EEM_Base::insert
+	 * @return boolean
+	 */
+	public function insert($field_n_values)
+	{
+		$return = parent::insert($field_n_values);
+		if (isset($field_n_values['term_taxonomy_id'])) {
+			$this->update_term_taxonomy_counts($field_n_values['term_taxonomy_id']);
+		}
+		return $return;
+	}
 
 
-    /**
-     * Overrides parent so that after an update, we also check the term_taxonomy_counts are
-     * all ok
-     *
-     * @param array   $fields_n_values         see EEM_Base::update
-     * @param array   $query_params            @see
-     *                                         https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
-     *                                         in this model's entity map according to $fields_n_values that match
-     *                                         $query_params. This obviously has some overhead, so you can disable it
-     *                                         by setting this to FALSE, but be aware that model objects being used
-     *                                         could get out-of-sync with the database
-     * @return int
-     */
-    public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
-    {
-        $count = parent::update($fields_n_values, $query_params, $keep_model_objs_in_sync);
-        if ($count) {
-            $this->update_term_taxonomy_counts();
-        }
-        return $count;
-    }
+	/**
+	 * Overrides parent so that after an update, we also check the term_taxonomy_counts are
+	 * all ok
+	 *
+	 * @param array   $fields_n_values         see EEM_Base::update
+	 * @param array   $query_params            @see
+	 *                                         https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
+	 *                                         in this model's entity map according to $fields_n_values that match
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
+	 *                                         by setting this to FALSE, but be aware that model objects being used
+	 *                                         could get out-of-sync with the database
+	 * @return int
+	 */
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
+	{
+		$count = parent::update($fields_n_values, $query_params, $keep_model_objs_in_sync);
+		if ($count) {
+			$this->update_term_taxonomy_counts();
+		}
+		return $count;
+	}
 
 
-    /**
-     * Overrides parent so that after running this, we also double-check
-     * the term taxonomy counts are up-to-date
-     *
-     * @param array   $query_params
-     * @param boolean $block_deletes
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see EEM_Base::delete()
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function delete($query_params, $block_deletes = true)
-    {
-        $count = parent::delete($query_params, $block_deletes);
-        if ($count) {
-            $this->update_term_taxonomy_counts();
-        }
-        return $count;
-    }
+	/**
+	 * Overrides parent so that after running this, we also double-check
+	 * the term taxonomy counts are up-to-date
+	 *
+	 * @param array   $query_params
+	 * @param boolean $block_deletes
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see EEM_Base::delete()
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function delete($query_params, $block_deletes = true)
+	{
+		$count = parent::delete($query_params, $block_deletes);
+		if ($count) {
+			$this->update_term_taxonomy_counts();
+		}
+		return $count;
+	}
 
 
-    /**
-     * Makes sure that during REST API queries, we only return term relationships
-     * for term taxonomies which should be shown in the rest api
-     *
-     * @param array    $model_query_params
-     * @param array    $querystring_query_params
-     * @param EEM_Base $model
-     * @return array
-     */
-    public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
-    {
-        if ($model === EEM_Term_Relationship::instance()) {
-            $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
-                $model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
-            }
-        }
-        return $model_query_params;
-    }
+	/**
+	 * Makes sure that during REST API queries, we only return term relationships
+	 * for term taxonomies which should be shown in the rest api
+	 *
+	 * @param array    $model_query_params
+	 * @param array    $querystring_query_params
+	 * @param EEM_Base $model
+	 * @return array
+	 */
+	public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
+	{
+		if ($model === EEM_Term_Relationship::instance()) {
+			$taxonomies = get_taxonomies(['show_in_rest' => true]);
+			if (! empty($taxonomies)) {
+				$model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
+			}
+		}
+		return $model_query_params;
+	}
 }

core/db_models/EEM_Question.model.php

Indentation +577 added lines, -577 removed lines

@@ -10,581 +10,581 @@
  */
 class EEM_Question extends EEM_Soft_Delete_Base
 {
-    // constant used to indicate that the question type is CHECKBOX
-    const QST_type_checkbox = 'CHECKBOX';
-
-    // constant used to indicate that the question type is COUNTRY
-    const QST_type_country = 'COUNTRY';
-
-    // constant used to indicate that the question type is DATE
-    const QST_type_date = 'DATE';
-
-    // constant used to indicate that the question type is a decimal (float)
-    const QST_type_decimal = 'DECIMAL';
-
-    // constant used to indicate that the question type is DROPDOWN
-    const QST_type_dropdown = 'DROPDOWN';
-
-    // constant used to indicate that the question type is an email input
-    const QST_type_email = 'EMAIL';
-
-    // constant used to indicate that the question type is an email input
-    const QST_type_email_confirm = 'EMAIL_CONFIRM';
-
-    // constant used to indicate that the question type is a TEXTAREA that allows simple html
-    const QST_type_html_textarea = 'HTML_TEXTAREA';
-
-    // constant used to indicate that the question type is an integer (whole number)
-    const QST_type_int = 'INTEGER';
-
-    // constant used to indicate that the question type is a multi-select
-    const QST_type_multi_select = 'MULTI_SELECT';
-
-    // constant used to indicate that the question type is RADIO_BTN
-    const QST_type_radio = 'RADIO_BTN';
-
-    // constant used to indicate that the question type is STATE
-    const QST_type_state = 'STATE';
-
-    // constant used to indicate that the question type is TEXT
-    const QST_type_text = 'TEXT';
-
-    // constant used to indicate that the question type is TEXTAREA
-    const QST_type_textarea = 'TEXTAREA';
-
-    // constant used to indicate that the question type is a valid URL
-    const QST_type_url = 'URL';
-
-    // constant used to indicate that the question type is a US-formatted phone number
-    const QST_type_us_phone = 'US_PHONE';
-
-    // constant used to indicate that the question type is a YEAR
-    const QST_type_year = 'YEAR';
-
-
-    protected static ?EEM_Question $_instance = null;
-
-    /**
-     * lists all the question types which should be allowed. Ideally, this will be extensible.
-     */
-    protected array $_allowed_question_types;
-
-    /**
-     * brief descriptions for all the question types
-     */
-    protected array $_question_descriptions;
-
-    /**
-     * Question types that are interchangeable, even after answers have been provided for them.
-     * Top-level keys are category slugs, next level is an array of question types. If question types
-     * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
-     *
-     * @var array   $_question_type_categories {
-     * @type string $text
-     * @type string $single                    -answer-enum
-     * @type string $multi                     -answer-enum
-     *                                         }
-     */
-    protected array $_question_type_categories;
-
-    /**
-     * Question types that should have an admin-defined max input length
-     */
-    protected array $question_types_with_max_length;
-
-
-    /**
-     * EEM_Question constructor.
-     *
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item                  = esc_html__('Question', 'event_espresso');
-        $this->plural_item                    = esc_html__('Questions', 'event_espresso');
-        $this->_allowed_question_types        = (array) apply_filters(
-            'FHEE__EEM_Question__construct__allowed_question_types',
-            [
-                EEM_Question::QST_type_checkbox      => esc_html__('Checkboxes', 'event_espresso'),
-                EEM_Question::QST_type_country       => esc_html__('Country Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_date          => esc_html__('Date Picker', 'event_espresso'),
-                EEM_Question::QST_type_decimal       => esc_html__('Number', 'event_espresso'),
-                EEM_Question::QST_type_dropdown      => esc_html__('Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_email         => esc_html__('Email', 'event_espresso'),
-                EEM_Question::QST_type_email_confirm => esc_html__('Confirm Email', 'event_espresso'),
-                EEM_Question::QST_type_html_textarea => esc_html__('HTML Textarea', 'event_espresso'),
-                EEM_Question::QST_type_int           => esc_html__('Whole Number', 'event_espresso'),
-                EEM_Question::QST_type_multi_select  => esc_html__('Multi Select', 'event_espresso'),
-                EEM_Question::QST_type_radio         => esc_html__('Radio Buttons', 'event_espresso'),
-                EEM_Question::QST_type_state         => esc_html__('State/Province Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_text          => esc_html__('Text', 'event_espresso'),
-                EEM_Question::QST_type_textarea      => esc_html__('Textarea', 'event_espresso'),
-                EEM_Question::QST_type_url           => esc_html__('URL', 'event_espresso'),
-                EEM_Question::QST_type_us_phone      => esc_html__('USA - Format Phone', 'event_espresso'),
-                EEM_Question::QST_type_year          => esc_html__('Year', 'event_espresso'),
-            ]
-        );
-        $this->_question_descriptions         = (array) apply_filters(
-            'FHEE__EEM_Question__construct__question_descriptions',
-            [
-                EEM_Question::QST_type_checkbox      => esc_html__(
-                    'Allows multiple preset options to be selected',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_country       => esc_html__(
-                    'A dropdown that lists countries',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_date          => esc_html__(
-                    'A popup calendar that allows date selections',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_decimal       => esc_html__(
-                    'A text field that allows number values with decimals',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_dropdown      => esc_html__(
-                    'A dropdown that allows a single selection',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_email         => esc_html__(
-                    'A text field that must contain a valid Email address',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_email_confirm => esc_html__(
-                    'A text field that must contain a valid Email address and be equal to Email field',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_html_textarea => esc_html__(
-                    'A multi line text input field that allows HTML',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_int           => esc_html__(
-                    'A text field that only allows whole numbers (no decimals)',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_multi_select  => esc_html__(
-                    'A dropdown that allows multiple selections',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_radio         => esc_html__(
-                    'Allows a single preset option to be selected',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_state         => esc_html__(
-                    'A dropdown that lists states/provinces',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_text          => esc_html__(
-                    'A single line text input field',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_textarea      => esc_html__(
-                    'A multi line text input field',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_url           => esc_html__(
-                    'A text field that must contain a valid URL',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_us_phone      => esc_html__(
-                    'A text field that must contain a valid US phone number',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_year          => esc_html__(
-                    'A dropdown that lists the last 100 years',
-                    'event_espresso'
-                ),
-            ]
-        );
-        $this->_question_type_categories      = (array) apply_filters(
-            'FHEE__EEM_Question__construct__question_type_categories',
-            [
-                'text'               => [
-                    EEM_Question::QST_type_date,
-                    EEM_Question::QST_type_decimal,
-                    EEM_Question::QST_type_email,
-                    EEM_Question::QST_type_email_confirm,
-                    EEM_Question::QST_type_html_textarea,
-                    EEM_Question::QST_type_int,
-                    EEM_Question::QST_type_text,
-                    EEM_Question::QST_type_textarea,
-                    EEM_Question::QST_type_url,
-                    EEM_Question::QST_type_us_phone,
-                    EEM_Question::QST_type_year,
-                ],
-                'date' => [
-                    EEM_Question::QST_type_date,
-                    EEM_Question::QST_type_year,
-                ],
-                'geographic' => [
-                    EEM_Question::QST_type_country,
-                    EEM_Question::QST_type_state,
-                ],
-                'numeric' => [
-                    EEM_Question::QST_type_decimal,
-                    EEM_Question::QST_type_int,
-                ],
-                'single-answer-enum' => [
-                    EEM_Question::QST_type_dropdown,
-                    EEM_Question::QST_type_radio,
-                ],
-                'multi-answer-enum'  => [
-                    EEM_Question::QST_type_multi_select,
-                    EEM_Question::QST_type_checkbox,
-                ],
-            ]
-        );
-        $this->question_types_with_max_length = (array) apply_filters(
-            'FHEE__EEM_Question___construct__question_types_with_max_length',
-            [
-                EEM_Question::QST_type_html_textarea,
-                EEM_Question::QST_type_text,
-                EEM_Question::QST_type_textarea,
-            ]
-        );
-
-        $this->_tables          = [
-            'Question' => new EE_Primary_Table('esp_question', 'QST_ID'),
-        ];
-        $this->_fields          = [
-            'Question' => [
-                'QST_ID'            => new EE_Primary_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question ID', 'event_espresso')
-                ),
-                'QST_admin_label'   => new EE_Plain_Text_Field(
-                    'QST_admin_label',
-                    esc_html__('Question Label (admin-only)', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QST_admin_only'    => new EE_Boolean_Field(
-                    'QST_admin_only',
-                    esc_html__('Admin-Only Question?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QST_deleted'       => new EE_Trashed_Flag_Field(
-                    'QST_deleted',
-                    esc_html__('Flag Indicating question was deleted', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QST_display_text'  => new EE_Post_Content_Field(
-                    'QST_display_text',
-                    esc_html__('Question Text', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QST_max'           => new EE_Infinite_Integer_Field(
-                    'QST_max',
-                    esc_html__('Max Size', 'event_espresso'),
-                    false,
-                    EE_INF
-                ),
-                'QST_order'         => new EE_Integer_Field(
-                    'QST_order',
-                    esc_html__('Question Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'QST_required'      => new EE_Boolean_Field(
-                    'QST_required',
-                    esc_html__('Required Question?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QST_required_text' => new EE_Simple_HTML_Field(
-                    'QST_required_text',
-                    esc_html__('Text to Display if Not Provided', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QST_system'        => new EE_Plain_Text_Field(
-                    'QST_system',
-                    esc_html__('Internal string ID for question', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'QST_type'          => new EE_Enum_Text_Field(
-                    'QST_type',
-                    esc_html__('Question Type', 'event_espresso'),
-                    false,
-                    'TEXT',
-                    $this->_allowed_question_types
-                ),
-                'QST_wp_user'       => new EE_WP_User_Field(
-                    'QST_wp_user',
-                    esc_html__('Question Creator ID', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Answer'                  => new EE_Has_Many_Relation(),
-            'Question_Group'          => new EE_HABTM_Relation('Question_Group_Question'),
-            // for QST_order column
-            'Question_Group_Question' => new EE_Has_Many_Relation(),
-            'Question_Option'         => new EE_Has_Many_Relation(),
-            'WP_User'                 => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Reg_Form('QST_system');
-
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Returns the list of allowed question types, which are normally:
-     * 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE' but they can be extended
-     *
-     * @return string[]
-     */
-    public function allowed_question_types(): array
-    {
-        return $this->_allowed_question_types;
-    }
-
-
-    /**
-     * Gets all the question types in the same category
-     *
-     * @param string $question_type one of EEM_Question::allowed_question_types(
-     * @return string[] like EEM_Question::allowed_question_types()
-     */
-    public function question_types_in_same_category(string $question_type): array
-    {
-        $question_types = [$question_type];
-        foreach ($this->_question_type_categories as $category => $question_types_in_category) {
-            if (in_array($question_type, $question_types_in_category)) {
-                $question_types = $question_types_in_category;
-                break;
-            }
-        }
-
-        return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
-    }
-
-
-    /**
-     * Determines if the given question type is in the given question type category
-     *
-     * @param string $question_type one of EEM_Question::allowed_question_types()
-     * @param string $category      one of the top-level keys of EEM_Question::question_type_categories()
-     * @return boolean
-     */
-    public function question_type_is_in_category(string $question_type, string $category): bool
-    {
-        if (! isset($this->_question_type_categories[ $category ])) {
-            return false;
-        }
-        return in_array($question_type, $this->_question_type_categories[ $category ]);
-    }
-
-
-    /**
-     * Returns all the question types in the given category
-     *
-     * @param string $category
-     * @return array|mixed
-     */
-    public function question_types_in_category(string $category): array
-    {
-        if (isset($this->_question_type_categories[ $category ])) {
-            return $this->_question_type_categories[ $category ];
-        }
-        return [];
-    }
-
-
-    /**
-     * Returns all the question types that should have question options
-     *
-     * @return array
-     */
-    public function question_types_with_options(): array
-    {
-        return array_merge(
-            $this->question_types_in_category('single-answer-enum'),
-            $this->question_types_in_category('multi-answer-enum')
-        );
-    }
-
-
-    /**
-     * Returns the question type categories 2d array
-     *
-     * @return array see EEM_Question::_question_type_categories
-     */
-    public function question_type_categories(): array
-    {
-        return $this->_question_type_categories;
-    }
-
-
-    /**
-     * Returns an array of all the QST_system values that can be allowed in the system question group
-     * identified by $system_question_group_id
-     *
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function allowed_system_questions_in_system_question_group(string $system_question_group_id): array
-    {
-        $question_system_ids = [];
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = [
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_lname,
-                    EEM_Attendee::system_question_email,
-                    EEM_Attendee::system_question_email_confirm,
-                    EEM_Attendee::system_question_phone,
-                ];
-                break;
-            case EEM_Question_Group::system_address:
-                $question_system_ids = [
-                    EEM_Attendee::system_question_address,
-                    EEM_Attendee::system_question_address2,
-                    EEM_Attendee::system_question_city,
-                    EEM_Attendee::system_question_state,
-                    EEM_Attendee::system_question_country,
-                    EEM_Attendee::system_question_zip,
-                    EEM_Attendee::system_question_phone,
-                ];
-                break;
-        }
-        return apply_filters(
-            'FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return',
-            $question_system_ids,
-            $system_question_group_id
-        );
-    }
-
-
-    /**
-     * Returns an array of all the QST_system values that are required in the system question group
-     * identified by $system_question_group_id
-     *
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function required_system_questions_in_system_question_group(string $system_question_group_id): array
-    {
-        $question_system_ids = null;
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = [
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_email,
-                ];
-                break;
-            default:
-                $question_system_ids = [];
-        }
-        return apply_filters(
-            'FHEE__EEM_Question__system_questions_required_in_system_question_group',
-            $question_system_ids,
-            $system_question_group_id
-        );
-    }
-
-
-    /**
-     * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
-     * which system question QST_ID corresponds to the QST_system 'city', use
-     * EEM_Question::instance()->get_Question_ID_from_system_string('city');
-     *
-     * @param $QST_system
-     * @return int of QST_ID for the question that corresponds to that QST_system
-     * @throws EE_Error
-     */
-    public function get_Question_ID_from_system_string($QST_system): int
-    {
-        return $this->get_var([['QST_system' => $QST_system]]);
-    }
-
-
-    /**
-     * searches the db for the question with the latest question order and returns that value.
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_latest_question_order(): int
-    {
-        $columns_to_select = [
-            'max_order' => ["MAX(QST_order)", "%d"],
-        ];
-        $max               = $this->_get_all_wpdb_results([], ARRAY_A, $columns_to_select);
-        return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
-    }
-
-
-    /**
-     * Returns an array where keys are system question QST_system values,
-     * and values are the highest question max the admin can set on the question
-     * (aka the "max max"; eg, a site admin can change the zip question to have a max
-     * of 5, but no larger than 12)
-     *
-     * @return array
-     */
-    public function system_question_maxes(): array
-    {
-        return [
-            'fname'         => 45,
-            'lname'         => 45,
-            'address'       => 255,
-            'address2'      => 255,
-            'city'          => 45,
-            'zip'           => 12,
-            'email'         => 255,
-            'email_confirm' => 255,
-            'phone'         => 45,
-        ];
-    }
-
-
-    /**
-     * Given a QST_system value, gets the question's largest allowable max input.
-     *
-     * @param string $system_question_value
-     * @return int|float
-     * @see Registration_Form_Admin_Page::system_question_maxes()
-     */
-    public function absolute_max_for_system_question(string $system_question_value)
-    {
-        $maxes = $this->system_question_maxes();
-        return $maxes[ $system_question_value ] ?? EE_INF;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function question_descriptions(): array
-    {
-        return $this->_question_descriptions;
-    }
-
-
-    /**
-     * Returns all the question types that should have an admin-defined max input length
-     *
-     * @return array
-     */
-    public function questionTypesWithMaxLength(): array
-    {
-        return (array) $this->question_types_with_max_length;
-    }
+	// constant used to indicate that the question type is CHECKBOX
+	const QST_type_checkbox = 'CHECKBOX';
+
+	// constant used to indicate that the question type is COUNTRY
+	const QST_type_country = 'COUNTRY';
+
+	// constant used to indicate that the question type is DATE
+	const QST_type_date = 'DATE';
+
+	// constant used to indicate that the question type is a decimal (float)
+	const QST_type_decimal = 'DECIMAL';
+
+	// constant used to indicate that the question type is DROPDOWN
+	const QST_type_dropdown = 'DROPDOWN';
+
+	// constant used to indicate that the question type is an email input
+	const QST_type_email = 'EMAIL';
+
+	// constant used to indicate that the question type is an email input
+	const QST_type_email_confirm = 'EMAIL_CONFIRM';
+
+	// constant used to indicate that the question type is a TEXTAREA that allows simple html
+	const QST_type_html_textarea = 'HTML_TEXTAREA';
+
+	// constant used to indicate that the question type is an integer (whole number)
+	const QST_type_int = 'INTEGER';
+
+	// constant used to indicate that the question type is a multi-select
+	const QST_type_multi_select = 'MULTI_SELECT';
+
+	// constant used to indicate that the question type is RADIO_BTN
+	const QST_type_radio = 'RADIO_BTN';
+
+	// constant used to indicate that the question type is STATE
+	const QST_type_state = 'STATE';
+
+	// constant used to indicate that the question type is TEXT
+	const QST_type_text = 'TEXT';
+
+	// constant used to indicate that the question type is TEXTAREA
+	const QST_type_textarea = 'TEXTAREA';
+
+	// constant used to indicate that the question type is a valid URL
+	const QST_type_url = 'URL';
+
+	// constant used to indicate that the question type is a US-formatted phone number
+	const QST_type_us_phone = 'US_PHONE';
+
+	// constant used to indicate that the question type is a YEAR
+	const QST_type_year = 'YEAR';
+
+
+	protected static ?EEM_Question $_instance = null;
+
+	/**
+	 * lists all the question types which should be allowed. Ideally, this will be extensible.
+	 */
+	protected array $_allowed_question_types;
+
+	/**
+	 * brief descriptions for all the question types
+	 */
+	protected array $_question_descriptions;
+
+	/**
+	 * Question types that are interchangeable, even after answers have been provided for them.
+	 * Top-level keys are category slugs, next level is an array of question types. If question types
+	 * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
+	 *
+	 * @var array   $_question_type_categories {
+	 * @type string $text
+	 * @type string $single                    -answer-enum
+	 * @type string $multi                     -answer-enum
+	 *                                         }
+	 */
+	protected array $_question_type_categories;
+
+	/**
+	 * Question types that should have an admin-defined max input length
+	 */
+	protected array $question_types_with_max_length;
+
+
+	/**
+	 * EEM_Question constructor.
+	 *
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item                  = esc_html__('Question', 'event_espresso');
+		$this->plural_item                    = esc_html__('Questions', 'event_espresso');
+		$this->_allowed_question_types        = (array) apply_filters(
+			'FHEE__EEM_Question__construct__allowed_question_types',
+			[
+				EEM_Question::QST_type_checkbox      => esc_html__('Checkboxes', 'event_espresso'),
+				EEM_Question::QST_type_country       => esc_html__('Country Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_date          => esc_html__('Date Picker', 'event_espresso'),
+				EEM_Question::QST_type_decimal       => esc_html__('Number', 'event_espresso'),
+				EEM_Question::QST_type_dropdown      => esc_html__('Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_email         => esc_html__('Email', 'event_espresso'),
+				EEM_Question::QST_type_email_confirm => esc_html__('Confirm Email', 'event_espresso'),
+				EEM_Question::QST_type_html_textarea => esc_html__('HTML Textarea', 'event_espresso'),
+				EEM_Question::QST_type_int           => esc_html__('Whole Number', 'event_espresso'),
+				EEM_Question::QST_type_multi_select  => esc_html__('Multi Select', 'event_espresso'),
+				EEM_Question::QST_type_radio         => esc_html__('Radio Buttons', 'event_espresso'),
+				EEM_Question::QST_type_state         => esc_html__('State/Province Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_text          => esc_html__('Text', 'event_espresso'),
+				EEM_Question::QST_type_textarea      => esc_html__('Textarea', 'event_espresso'),
+				EEM_Question::QST_type_url           => esc_html__('URL', 'event_espresso'),
+				EEM_Question::QST_type_us_phone      => esc_html__('USA - Format Phone', 'event_espresso'),
+				EEM_Question::QST_type_year          => esc_html__('Year', 'event_espresso'),
+			]
+		);
+		$this->_question_descriptions         = (array) apply_filters(
+			'FHEE__EEM_Question__construct__question_descriptions',
+			[
+				EEM_Question::QST_type_checkbox      => esc_html__(
+					'Allows multiple preset options to be selected',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_country       => esc_html__(
+					'A dropdown that lists countries',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_date          => esc_html__(
+					'A popup calendar that allows date selections',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_decimal       => esc_html__(
+					'A text field that allows number values with decimals',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_dropdown      => esc_html__(
+					'A dropdown that allows a single selection',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_email         => esc_html__(
+					'A text field that must contain a valid Email address',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_email_confirm => esc_html__(
+					'A text field that must contain a valid Email address and be equal to Email field',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_html_textarea => esc_html__(
+					'A multi line text input field that allows HTML',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_int           => esc_html__(
+					'A text field that only allows whole numbers (no decimals)',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_multi_select  => esc_html__(
+					'A dropdown that allows multiple selections',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_radio         => esc_html__(
+					'Allows a single preset option to be selected',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_state         => esc_html__(
+					'A dropdown that lists states/provinces',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_text          => esc_html__(
+					'A single line text input field',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_textarea      => esc_html__(
+					'A multi line text input field',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_url           => esc_html__(
+					'A text field that must contain a valid URL',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_us_phone      => esc_html__(
+					'A text field that must contain a valid US phone number',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_year          => esc_html__(
+					'A dropdown that lists the last 100 years',
+					'event_espresso'
+				),
+			]
+		);
+		$this->_question_type_categories      = (array) apply_filters(
+			'FHEE__EEM_Question__construct__question_type_categories',
+			[
+				'text'               => [
+					EEM_Question::QST_type_date,
+					EEM_Question::QST_type_decimal,
+					EEM_Question::QST_type_email,
+					EEM_Question::QST_type_email_confirm,
+					EEM_Question::QST_type_html_textarea,
+					EEM_Question::QST_type_int,
+					EEM_Question::QST_type_text,
+					EEM_Question::QST_type_textarea,
+					EEM_Question::QST_type_url,
+					EEM_Question::QST_type_us_phone,
+					EEM_Question::QST_type_year,
+				],
+				'date' => [
+					EEM_Question::QST_type_date,
+					EEM_Question::QST_type_year,
+				],
+				'geographic' => [
+					EEM_Question::QST_type_country,
+					EEM_Question::QST_type_state,
+				],
+				'numeric' => [
+					EEM_Question::QST_type_decimal,
+					EEM_Question::QST_type_int,
+				],
+				'single-answer-enum' => [
+					EEM_Question::QST_type_dropdown,
+					EEM_Question::QST_type_radio,
+				],
+				'multi-answer-enum'  => [
+					EEM_Question::QST_type_multi_select,
+					EEM_Question::QST_type_checkbox,
+				],
+			]
+		);
+		$this->question_types_with_max_length = (array) apply_filters(
+			'FHEE__EEM_Question___construct__question_types_with_max_length',
+			[
+				EEM_Question::QST_type_html_textarea,
+				EEM_Question::QST_type_text,
+				EEM_Question::QST_type_textarea,
+			]
+		);
+
+		$this->_tables          = [
+			'Question' => new EE_Primary_Table('esp_question', 'QST_ID'),
+		];
+		$this->_fields          = [
+			'Question' => [
+				'QST_ID'            => new EE_Primary_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question ID', 'event_espresso')
+				),
+				'QST_admin_label'   => new EE_Plain_Text_Field(
+					'QST_admin_label',
+					esc_html__('Question Label (admin-only)', 'event_espresso'),
+					true,
+					''
+				),
+				'QST_admin_only'    => new EE_Boolean_Field(
+					'QST_admin_only',
+					esc_html__('Admin-Only Question?', 'event_espresso'),
+					false,
+					false
+				),
+				'QST_deleted'       => new EE_Trashed_Flag_Field(
+					'QST_deleted',
+					esc_html__('Flag Indicating question was deleted', 'event_espresso'),
+					false,
+					false
+				),
+				'QST_display_text'  => new EE_Post_Content_Field(
+					'QST_display_text',
+					esc_html__('Question Text', 'event_espresso'),
+					true,
+					''
+				),
+				'QST_max'           => new EE_Infinite_Integer_Field(
+					'QST_max',
+					esc_html__('Max Size', 'event_espresso'),
+					false,
+					EE_INF
+				),
+				'QST_order'         => new EE_Integer_Field(
+					'QST_order',
+					esc_html__('Question Order', 'event_espresso'),
+					false,
+					0
+				),
+				'QST_required'      => new EE_Boolean_Field(
+					'QST_required',
+					esc_html__('Required Question?', 'event_espresso'),
+					false,
+					false
+				),
+				'QST_required_text' => new EE_Simple_HTML_Field(
+					'QST_required_text',
+					esc_html__('Text to Display if Not Provided', 'event_espresso'),
+					true,
+					''
+				),
+				'QST_system'        => new EE_Plain_Text_Field(
+					'QST_system',
+					esc_html__('Internal string ID for question', 'event_espresso'),
+					false,
+					''
+				),
+				'QST_type'          => new EE_Enum_Text_Field(
+					'QST_type',
+					esc_html__('Question Type', 'event_espresso'),
+					false,
+					'TEXT',
+					$this->_allowed_question_types
+				),
+				'QST_wp_user'       => new EE_WP_User_Field(
+					'QST_wp_user',
+					esc_html__('Question Creator ID', 'event_espresso'),
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Answer'                  => new EE_Has_Many_Relation(),
+			'Question_Group'          => new EE_HABTM_Relation('Question_Group_Question'),
+			// for QST_order column
+			'Question_Group_Question' => new EE_Has_Many_Relation(),
+			'Question_Option'         => new EE_Has_Many_Relation(),
+			'WP_User'                 => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Reg_Form('QST_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Reg_Form('QST_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Reg_Form('QST_system');
+
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Returns the list of allowed question types, which are normally:
+	 * 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE' but they can be extended
+	 *
+	 * @return string[]
+	 */
+	public function allowed_question_types(): array
+	{
+		return $this->_allowed_question_types;
+	}
+
+
+	/**
+	 * Gets all the question types in the same category
+	 *
+	 * @param string $question_type one of EEM_Question::allowed_question_types(
+	 * @return string[] like EEM_Question::allowed_question_types()
+	 */
+	public function question_types_in_same_category(string $question_type): array
+	{
+		$question_types = [$question_type];
+		foreach ($this->_question_type_categories as $category => $question_types_in_category) {
+			if (in_array($question_type, $question_types_in_category)) {
+				$question_types = $question_types_in_category;
+				break;
+			}
+		}
+
+		return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
+	}
+
+
+	/**
+	 * Determines if the given question type is in the given question type category
+	 *
+	 * @param string $question_type one of EEM_Question::allowed_question_types()
+	 * @param string $category      one of the top-level keys of EEM_Question::question_type_categories()
+	 * @return boolean
+	 */
+	public function question_type_is_in_category(string $question_type, string $category): bool
+	{
+		if (! isset($this->_question_type_categories[ $category ])) {
+			return false;
+		}
+		return in_array($question_type, $this->_question_type_categories[ $category ]);
+	}
+
+
+	/**
+	 * Returns all the question types in the given category
+	 *
+	 * @param string $category
+	 * @return array|mixed
+	 */
+	public function question_types_in_category(string $category): array
+	{
+		if (isset($this->_question_type_categories[ $category ])) {
+			return $this->_question_type_categories[ $category ];
+		}
+		return [];
+	}
+
+
+	/**
+	 * Returns all the question types that should have question options
+	 *
+	 * @return array
+	 */
+	public function question_types_with_options(): array
+	{
+		return array_merge(
+			$this->question_types_in_category('single-answer-enum'),
+			$this->question_types_in_category('multi-answer-enum')
+		);
+	}
+
+
+	/**
+	 * Returns the question type categories 2d array
+	 *
+	 * @return array see EEM_Question::_question_type_categories
+	 */
+	public function question_type_categories(): array
+	{
+		return $this->_question_type_categories;
+	}
+
+
+	/**
+	 * Returns an array of all the QST_system values that can be allowed in the system question group
+	 * identified by $system_question_group_id
+	 *
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function allowed_system_questions_in_system_question_group(string $system_question_group_id): array
+	{
+		$question_system_ids = [];
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = [
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_lname,
+					EEM_Attendee::system_question_email,
+					EEM_Attendee::system_question_email_confirm,
+					EEM_Attendee::system_question_phone,
+				];
+				break;
+			case EEM_Question_Group::system_address:
+				$question_system_ids = [
+					EEM_Attendee::system_question_address,
+					EEM_Attendee::system_question_address2,
+					EEM_Attendee::system_question_city,
+					EEM_Attendee::system_question_state,
+					EEM_Attendee::system_question_country,
+					EEM_Attendee::system_question_zip,
+					EEM_Attendee::system_question_phone,
+				];
+				break;
+		}
+		return apply_filters(
+			'FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return',
+			$question_system_ids,
+			$system_question_group_id
+		);
+	}
+
+
+	/**
+	 * Returns an array of all the QST_system values that are required in the system question group
+	 * identified by $system_question_group_id
+	 *
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function required_system_questions_in_system_question_group(string $system_question_group_id): array
+	{
+		$question_system_ids = null;
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = [
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_email,
+				];
+				break;
+			default:
+				$question_system_ids = [];
+		}
+		return apply_filters(
+			'FHEE__EEM_Question__system_questions_required_in_system_question_group',
+			$question_system_ids,
+			$system_question_group_id
+		);
+	}
+
+
+	/**
+	 * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
+	 * which system question QST_ID corresponds to the QST_system 'city', use
+	 * EEM_Question::instance()->get_Question_ID_from_system_string('city');
+	 *
+	 * @param $QST_system
+	 * @return int of QST_ID for the question that corresponds to that QST_system
+	 * @throws EE_Error
+	 */
+	public function get_Question_ID_from_system_string($QST_system): int
+	{
+		return $this->get_var([['QST_system' => $QST_system]]);
+	}
+
+
+	/**
+	 * searches the db for the question with the latest question order and returns that value.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_latest_question_order(): int
+	{
+		$columns_to_select = [
+			'max_order' => ["MAX(QST_order)", "%d"],
+		];
+		$max               = $this->_get_all_wpdb_results([], ARRAY_A, $columns_to_select);
+		return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
+	}
+
+
+	/**
+	 * Returns an array where keys are system question QST_system values,
+	 * and values are the highest question max the admin can set on the question
+	 * (aka the "max max"; eg, a site admin can change the zip question to have a max
+	 * of 5, but no larger than 12)
+	 *
+	 * @return array
+	 */
+	public function system_question_maxes(): array
+	{
+		return [
+			'fname'         => 45,
+			'lname'         => 45,
+			'address'       => 255,
+			'address2'      => 255,
+			'city'          => 45,
+			'zip'           => 12,
+			'email'         => 255,
+			'email_confirm' => 255,
+			'phone'         => 45,
+		];
+	}
+
+
+	/**
+	 * Given a QST_system value, gets the question's largest allowable max input.
+	 *
+	 * @param string $system_question_value
+	 * @return int|float
+	 * @see Registration_Form_Admin_Page::system_question_maxes()
+	 */
+	public function absolute_max_for_system_question(string $system_question_value)
+	{
+		$maxes = $this->system_question_maxes();
+		return $maxes[ $system_question_value ] ?? EE_INF;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function question_descriptions(): array
+	{
+		return $this->_question_descriptions;
+	}
+
+
+	/**
+	 * Returns all the question types that should have an admin-defined max input length
+	 *
+	 * @return array
+	 */
+	public function questionTypesWithMaxLength(): array
+	{
+		return (array) $this->question_types_with_max_length;
+	}
 }

core/db_models/EEM_Country.model.php

Indentation +211 added lines, -211 removed lines

@@ -11,215 +11,215 @@
  */
 class EEM_Country extends EEM_Base
 {
-    protected static ?EEM_Country $_instance = null;
-
-    // array of all countries
-    private static ?array $_all_countries = null;
-
-    // array of all active countries
-    private static ?array $_active_countries = null;
-
-
-    /**
-     * Resets the country
-     *
-     * @param string|null $timezone
-     * @return EEM_Base|EEM_Country|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reset($timezone = '')
-    {
-        self::$_active_countries = null;
-        self::$_all_countries    = null;
-        return parent::reset($timezone);
-    }
-
-
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Country', 'event_espresso');
-        $this->plural_item   = esc_html__('Countries', 'event_espresso');
-
-        $this->_tables = [
-            'Country' => new EE_Primary_Table('esp_country', 'CNT_ISO'),
-        ];
-
-        $this->_fields          = [
-            'Country' => [
-                'CNT_active'      => new EE_Boolean_Field(
-                    'CNT_active',
-                    esc_html__('Country Appears in Dropdown Select Lists', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'CNT_ISO'         => new EE_Primary_Key_String_Field(
-                    'CNT_ISO',
-                    esc_html__('Country ISO Code', 'event_espresso')
-                ),
-                'CNT_ISO3'        => new EE_All_Caps_Text_Field(
-                    'CNT_ISO3',
-                    esc_html__('Country ISO3 Code', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'RGN_ID'          => new EE_Integer_Field(
-                    'RGN_ID',
-                    esc_html__('Region ID', 'event_espresso'),
-                    false,
-                    0
-                ),
-                // should be a foreign key, but no region table exists yet
-                'CNT_name'        => new EE_Plain_Text_Field(
-                    'CNT_name',
-                    esc_html__('Country Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'CNT_cur_code'    => new EE_All_Caps_Text_Field(
-                    'CNT_cur_code',
-                    esc_html__('Country Currency Code', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_single'  => new EE_Plain_Text_Field(
-                    'CNT_cur_single',
-                    esc_html__('Currency Name Singular', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_plural'  => new EE_Plain_Text_Field(
-                    'CNT_cur_plural',
-                    esc_html__('Currency Name Plural', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_sign'    => new EE_Plain_Text_Field(
-                    'CNT_cur_sign',
-                    esc_html__('Currency Sign', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_sign_b4' => new EE_Boolean_Field(
-                    'CNT_cur_sign_b4',
-                    esc_html__('Currency Sign Before Number', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'CNT_cur_dec_plc' => new EE_Integer_Field(
-                    'CNT_cur_dec_plc',
-                    esc_html__('Currency Decimal Places', 'event_espresso'),
-                    false,
-                    2
-                ),
-                'CNT_cur_dec_mrk' => new EE_Plain_Text_Field(
-                    'CNT_cur_dec_mrk',
-                    esc_html__('Currency Decimal Mark', 'event_espresso'),
-                    false,
-                    '.'
-                ),
-                'CNT_cur_thsnds'  => new EE_Plain_Text_Field(
-                    'CNT_cur_thsnds',
-                    esc_html__('Currency Thousands Separator', 'event_espresso'),
-                    false,
-                    ','
-                ),
-                'CNT_tel_code'    => new EE_Plain_Text_Field(
-                    'CNT_tel_code',
-                    esc_html__('Country Telephone Code', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'CNT_is_EU'       => new EE_Boolean_Field(
-                    'CNT_is_EU',
-                    esc_html__('Country is Member of EU', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Attendee' => new EE_Has_Many_Relation(),
-            'State'    => new EE_Has_Many_Relation(),
-            'Venue'    => new EE_Has_Many_Relation(),
-        ];
-        // only anyone to view, but only those with the default role can do anything
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return EE_Country[]|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_countries(): ?array
-    {
-        if (! self::$_all_countries) {
-            self::$_all_countries = $this->get_all(['order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
-        }
-        return self::$_all_countries;
-    }
-
-
-    /**
-     * Gets and caches the list of active countries. If you know the list of active countries
-     * has changed during this request, first use EEM_Country::reset() to flush the cache
-     *
-     * @return EE_Country[]|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_active_countries(): ?array
-    {
-        if (! self::$_active_countries) {
-            self::$_active_countries =
-                $this->get_all([['CNT_active' => true], 'order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
-        }
-        return self::$_active_countries;
-    }
-
-
-    /**
-     * Gets the country's name by its ISO
-     *
-     * @param string $country_ISO
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_country_name_by_ISO(string $country_ISO): string
-    {
-        $countries = $this->get_all_countries();
-        if (isset($countries[ $country_ISO ]) && $countries[ $country_ISO ] instanceof EE_Country) {
-            return $countries[ $country_ISO ]->name();
-        }
-        $names = $this->get_col([['CNT_ISO' => $country_ISO], 'limit' => 1], 'CNT_name');
-        if (is_array($names) && ! empty($names)) {
-            return reset($names);
-        }
-        return '';
-    }
-
-
-    /**
-     * Gets the country's name by its name
-     *
-     * @param string $country_name
-     * @return EE_Country|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getCountryByName(string $country_name): ?EE_Country
-    {
-        $countries = $this->get_all_countries();
-        foreach ($countries as $country) {
-            if ($country instanceof EE_Country && $country->name() === $country_name) {
-                return $country;
-            }
-        }
-        return $this->get_one([['CNT_name' => $country_name]]);
-    }
+	protected static ?EEM_Country $_instance = null;
+
+	// array of all countries
+	private static ?array $_all_countries = null;
+
+	// array of all active countries
+	private static ?array $_active_countries = null;
+
+
+	/**
+	 * Resets the country
+	 *
+	 * @param string|null $timezone
+	 * @return EEM_Base|EEM_Country|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reset($timezone = '')
+	{
+		self::$_active_countries = null;
+		self::$_all_countries    = null;
+		return parent::reset($timezone);
+	}
+
+
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Country', 'event_espresso');
+		$this->plural_item   = esc_html__('Countries', 'event_espresso');
+
+		$this->_tables = [
+			'Country' => new EE_Primary_Table('esp_country', 'CNT_ISO'),
+		];
+
+		$this->_fields          = [
+			'Country' => [
+				'CNT_active'      => new EE_Boolean_Field(
+					'CNT_active',
+					esc_html__('Country Appears in Dropdown Select Lists', 'event_espresso'),
+					false,
+					true
+				),
+				'CNT_ISO'         => new EE_Primary_Key_String_Field(
+					'CNT_ISO',
+					esc_html__('Country ISO Code', 'event_espresso')
+				),
+				'CNT_ISO3'        => new EE_All_Caps_Text_Field(
+					'CNT_ISO3',
+					esc_html__('Country ISO3 Code', 'event_espresso'),
+					false,
+					''
+				),
+				'RGN_ID'          => new EE_Integer_Field(
+					'RGN_ID',
+					esc_html__('Region ID', 'event_espresso'),
+					false,
+					0
+				),
+				// should be a foreign key, but no region table exists yet
+				'CNT_name'        => new EE_Plain_Text_Field(
+					'CNT_name',
+					esc_html__('Country Name', 'event_espresso'),
+					false,
+					''
+				),
+				'CNT_cur_code'    => new EE_All_Caps_Text_Field(
+					'CNT_cur_code',
+					esc_html__('Country Currency Code', 'event_espresso'),
+					false
+				),
+				'CNT_cur_single'  => new EE_Plain_Text_Field(
+					'CNT_cur_single',
+					esc_html__('Currency Name Singular', 'event_espresso'),
+					false
+				),
+				'CNT_cur_plural'  => new EE_Plain_Text_Field(
+					'CNT_cur_plural',
+					esc_html__('Currency Name Plural', 'event_espresso'),
+					false
+				),
+				'CNT_cur_sign'    => new EE_Plain_Text_Field(
+					'CNT_cur_sign',
+					esc_html__('Currency Sign', 'event_espresso'),
+					false
+				),
+				'CNT_cur_sign_b4' => new EE_Boolean_Field(
+					'CNT_cur_sign_b4',
+					esc_html__('Currency Sign Before Number', 'event_espresso'),
+					false,
+					true
+				),
+				'CNT_cur_dec_plc' => new EE_Integer_Field(
+					'CNT_cur_dec_plc',
+					esc_html__('Currency Decimal Places', 'event_espresso'),
+					false,
+					2
+				),
+				'CNT_cur_dec_mrk' => new EE_Plain_Text_Field(
+					'CNT_cur_dec_mrk',
+					esc_html__('Currency Decimal Mark', 'event_espresso'),
+					false,
+					'.'
+				),
+				'CNT_cur_thsnds'  => new EE_Plain_Text_Field(
+					'CNT_cur_thsnds',
+					esc_html__('Currency Thousands Separator', 'event_espresso'),
+					false,
+					','
+				),
+				'CNT_tel_code'    => new EE_Plain_Text_Field(
+					'CNT_tel_code',
+					esc_html__('Country Telephone Code', 'event_espresso'),
+					false,
+					''
+				),
+				'CNT_is_EU'       => new EE_Boolean_Field(
+					'CNT_is_EU',
+					esc_html__('Country is Member of EU', 'event_espresso'),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Attendee' => new EE_Has_Many_Relation(),
+			'State'    => new EE_Has_Many_Relation(),
+			'Venue'    => new EE_Has_Many_Relation(),
+		];
+		// only anyone to view, but only those with the default role can do anything
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return EE_Country[]|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_countries(): ?array
+	{
+		if (! self::$_all_countries) {
+			self::$_all_countries = $this->get_all(['order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
+		}
+		return self::$_all_countries;
+	}
+
+
+	/**
+	 * Gets and caches the list of active countries. If you know the list of active countries
+	 * has changed during this request, first use EEM_Country::reset() to flush the cache
+	 *
+	 * @return EE_Country[]|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_active_countries(): ?array
+	{
+		if (! self::$_active_countries) {
+			self::$_active_countries =
+				$this->get_all([['CNT_active' => true], 'order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
+		}
+		return self::$_active_countries;
+	}
+
+
+	/**
+	 * Gets the country's name by its ISO
+	 *
+	 * @param string $country_ISO
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_country_name_by_ISO(string $country_ISO): string
+	{
+		$countries = $this->get_all_countries();
+		if (isset($countries[ $country_ISO ]) && $countries[ $country_ISO ] instanceof EE_Country) {
+			return $countries[ $country_ISO ]->name();
+		}
+		$names = $this->get_col([['CNT_ISO' => $country_ISO], 'limit' => 1], 'CNT_name');
+		if (is_array($names) && ! empty($names)) {
+			return reset($names);
+		}
+		return '';
+	}
+
+
+	/**
+	 * Gets the country's name by its name
+	 *
+	 * @param string $country_name
+	 * @return EE_Country|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getCountryByName(string $country_name): ?EE_Country
+	{
+		$countries = $this->get_all_countries();
+		foreach ($countries as $country) {
+			if ($country instanceof EE_Country && $country->name() === $country_name) {
+				return $country;
+			}
+		}
+		return $this->get_one([['CNT_name' => $country_name]]);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -14,10 +14,10 @@ 
     protected static ?EEM_Country $_instance = null;
 
     // array of all countries
-    private static ?array $_all_countries = null;
+    private static ? array $_all_countries = null;
 
     // array of all active countries
-    private static ?array $_active_countries = null;
+    private static ? array $_active_countries = null;
 
 
     /**
@@ -49,7 +49,7 @@ 
             'Country' => new EE_Primary_Table('esp_country', 'CNT_ISO'),
         ];
 
-        $this->_fields          = [
+        $this->_fields = [
             'Country' => [
                 'CNT_active'      => new EE_Boolean_Field(
                     'CNT_active',
@@ -144,7 +144,7 @@ 
             'Venue'    => new EE_Has_Many_Relation(),
         ];
         // only anyone to view, but only those with the default role can do anything
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
 
         parent::__construct($timezone);
     }
@@ -157,7 +157,7 @@ 
      */
     public function get_all_countries(): ?array
     {
-        if (! self::$_all_countries) {
+        if ( ! self::$_all_countries) {
             self::$_all_countries = $this->get_all(['order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
         }
         return self::$_all_countries;
@@ -174,7 +174,7 @@ 
      */
     public function get_all_active_countries(): ?array
     {
-        if (! self::$_active_countries) {
+        if ( ! self::$_active_countries) {
             self::$_active_countries =
                 $this->get_all([['CNT_active' => true], 'order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
         }
@@ -193,8 +193,8 @@ 
     public function get_country_name_by_ISO(string $country_ISO): string
     {
         $countries = $this->get_all_countries();
-        if (isset($countries[ $country_ISO ]) && $countries[ $country_ISO ] instanceof EE_Country) {
-            return $countries[ $country_ISO ]->name();
+        if (isset($countries[$country_ISO]) && $countries[$country_ISO] instanceof EE_Country) {
+            return $countries[$country_ISO]->name();
         }
         $names = $this->get_col([['CNT_ISO' => $country_ISO], 'limit' => 1], 'CNT_name');
         if (is_array($names) && ! empty($names)) {

core/db_models/EEM_Question_Option.model.php

Indentation +79 added lines, -79 removed lines

@@ -9,89 +9,89 @@
  */
 class EEM_Question_Option extends EEM_Soft_Delete_Base
 {
-    protected static ?EEM_Question_Option $_instance = null;
+	protected static ?EEM_Question_Option $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Question Option', 'event_espresso');
-        $this->plural_item   = esc_html__('Question Options', 'event_espresso');
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Question Option', 'event_espresso');
+		$this->plural_item   = esc_html__('Question Options', 'event_espresso');
 
-        $this->_tables          = [
-            'Question_Option' => new EE_Primary_Table('esp_question_option', 'QSO_ID'),
-        ];
-        $this->_fields          = [
-            'Question_Option' => [
-                'QSO_ID'      => new EE_Primary_Key_Int_Field(
-                    'QSO_ID',
-                    esc_html__('Question Option ID', 'event_espresso')
-                ),
-                'QST_ID'      => new EE_Foreign_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Question'
-                ),
-                'QSO_default' => new EE_Boolean_Field(
-                    'QSO_default',
-                    esc_html__('Flag indicating this is the default option', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QSO_deleted' => new EE_Trashed_Flag_Field(
-                    'QSO_deleted',
-                    esc_html__('Flag indicating Option was trashed', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QSO_desc'    => new EE_Post_Content_Field(
-                    'QSO_desc',
-                    esc_html__('Question Option Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'QSO_order'   => new EE_Integer_Field(
-                    'QSO_order',
-                    esc_html__('Question Option Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'QSO_system'  => new EE_Plain_Text_Field(
-                    'QSO_system',
-                    esc_html__('Internal string ID for question option', 'event_espresso'),
-                    true,
-                    null
-                ),
-                'QSO_value'   => new EE_Plain_Text_Field(
-                    'QSO_value',
-                    esc_html__("Question Option Value", "event_espresso"),
-                    false,
-                    ''
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Question' => new EE_Belongs_To_Relation(),
-        ];
+		$this->_tables          = [
+			'Question_Option' => new EE_Primary_Table('esp_question_option', 'QSO_ID'),
+		];
+		$this->_fields          = [
+			'Question_Option' => [
+				'QSO_ID'      => new EE_Primary_Key_Int_Field(
+					'QSO_ID',
+					esc_html__('Question Option ID', 'event_espresso')
+				),
+				'QST_ID'      => new EE_Foreign_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question ID', 'event_espresso'),
+					false,
+					0,
+					'Question'
+				),
+				'QSO_default' => new EE_Boolean_Field(
+					'QSO_default',
+					esc_html__('Flag indicating this is the default option', 'event_espresso'),
+					false,
+					false
+				),
+				'QSO_deleted' => new EE_Trashed_Flag_Field(
+					'QSO_deleted',
+					esc_html__('Flag indicating Option was trashed', 'event_espresso'),
+					false,
+					false
+				),
+				'QSO_desc'    => new EE_Post_Content_Field(
+					'QSO_desc',
+					esc_html__('Question Option Description', 'event_espresso'),
+					false,
+					''
+				),
+				'QSO_order'   => new EE_Integer_Field(
+					'QSO_order',
+					esc_html__('Question Option Order', 'event_espresso'),
+					false,
+					0
+				),
+				'QSO_system'  => new EE_Plain_Text_Field(
+					'QSO_system',
+					esc_html__('Internal string ID for question option', 'event_espresso'),
+					true,
+					null
+				),
+				'QSO_value'   => new EE_Plain_Text_Field(
+					'QSO_value',
+					esc_html__("Question Option Value", "event_espresso"),
+					false,
+					''
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Question' => new EE_Belongs_To_Relation(),
+		];
 
-        $this->_caps_slug              = 'questions';
-        $this->_model_chain_to_wp_user = 'Question';
+		$this->_caps_slug              = 'questions';
+		$this->_model_chain_to_wp_user = 'Question';
 
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Reg_Form('QSO_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Reg_Form('QSO_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Reg_Form('QSO_system');
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Reg_Form('QSO_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Reg_Form('QSO_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Reg_Form('QSO_system');
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 }