eventespresso / event-espresso-core

core/db_classes/EE_Payment_Method.class.php

Spacing +8 added lines, -8 removed lines

@@ -445,11 +445,11 @@ 
      */
     public function type_obj()
     {
-        if (! $this->_type_obj) {
+        if ( ! $this->_type_obj) {
             EE_Registry::instance()->load_lib('Payment_Method_Manager');
             if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
                 $class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
-                if (! class_exists($class_name)) {
+                if ( ! class_exists($class_name)) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -458,7 +458,7 @@ 
                             ),
                             $class_name,
                             '<br />',
-                            '<a href="' . admin_url('plugins.php') . '">',
+                            '<a href="'.admin_url('plugins.php').'">',
                             '</a>'
                         )
                     );
@@ -499,7 +499,7 @@ 
         foreach ($fields as $key => $value) {
             if (strpos($key, 'PMD_') === 0) {
                 $key_sans_model_prefix = str_replace('PMD_', '', $key);
-                $combined_settings_array [ $key_sans_model_prefix ] = $value;
+                $combined_settings_array [$key_sans_model_prefix] = $value;
             }
         }
         $combined_settings_array = array_merge($extra_meta, $combined_settings_array);
@@ -522,14 +522,14 @@ 
 		 <div id="'
                . $this->slug()
                . '-payment-option-dv" class="'
-               . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
+               . $payment_occurs.'-payment-gateway reg-page-payment-option-dv'.$css_class.'">
 			<a id="payment-gateway-button-' . $this->slug()
                . '" class="reg-page-payment-option-lnk" rel="'
-               . $this->slug() . '" href="' . $url . '" >
-				<img src="' . $this->button_url() . '" alt="' . sprintf(
+               . $this->slug().'" href="'.$url.'" >
+				<img src="' . $this->button_url().'" alt="'.sprintf(
                    esc_attr__('Pay using %s', 'event_espresso'),
                    $this->get_pretty('PMD_name', 'form_input')
-               ) . '" />
+               ).'" />
 			</a>
 		</div>
 ';

Indentation +572 added lines, -572 removed lines

@@ -13,582 +13,582 @@
  */
 class EE_Payment_Method extends EE_Base_Class
 {
-    /**
-     * Payment Method type object, which has all the info about this type of payment method,
-     * including functions for processing payments, to get settings forms, etc.
-     *
-     * @var EE_PMT_Base
-     */
-    protected $_type_obj;
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values, false);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-
-    /**
-     * Checks if there is a payment method class of the given 'PMD_type', and if so returns the classname.
-     * Otherwise returns a normal EE_Payment_Method
-     *
-     * @param array $props_n_values where 'PMD_type' is a gateway name like 'Paypal_Standard','Invoice',etc (basically
-     *                              the classname minus 'EEPM_')
-     * @return string
-     */
-    // private static function _payment_method_type($props_n_values)
-    // {
-    //     EE_Registry::instance()->load_lib('Payment_Method_Manager');
-    //     $type_string = isset($props_n_values['PMD_type']) ? $props_n_values['PMD_type'] : null;
-    //     if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($type_string)) {
-    //         return 'EEPM_' . $type_string;
-    //     } else {
-    //         return __CLASS__;
-    //     }
-    // }
-
-
-    /**
-     * Gets whether this payment method can be used anywhere at all (ie frontend cart, admin, etc)
-     *
-     * @return boolean
-     */
-    public function active()
-    {
-        return array_intersect(array_keys(EEM_Payment_Method::instance()->scopes()), $this->scope());
-    }
-
-
-    /**
-     * Sets this PM as active by making it usable within the CART scope. Offline gateways
-     * are also usable from the admin-scope as well. DOES NOT SAVE it
-     *
-     * @throws EE_Error
-     */
-    public function set_active()
-    {
-        $default_scopes = array(EEM_Payment_Method::scope_cart);
-        if (
-            $this->type_obj() &&
-            $this->type_obj()->payment_occurs() === EE_PMT_Base::offline
-        ) {
-            $default_scopes[] = EEM_Payment_Method::scope_admin;
-        }
-        $this->set_scope($default_scopes);
-    }
-
-
-    /**
-     * Makes this payment method apply to NO scopes at all. DOES NOT SAVE it.
-     */
-    public function deactivate()
-    {
-        $this->set_scope(array());
-    }
-
-
-    /**
-     * Gets button_url
-     *
-     * @return string
-     */
-    public function button_url()
-    {
-        return $this->get('PMD_button_url');
-    }
-
-
-    /**
-     * Sets button_url
-     *
-     * @param string $button_url
-     */
-    public function set_button_url($button_url)
-    {
-        $this->set('PMD_button_url', $button_url);
-    }
-
-
-    /**
-     * Gets debug_mode
-     *
-     * @return boolean
-     */
-    public function debug_mode()
-    {
-        return (bool) $this->get('PMD_debug_mode');
-    }
-
-
-    /**
-     * Sets debug_mode
-     *
-     * @param boolean $debug_mode
-     */
-    public function set_debug_mode($debug_mode)
-    {
-        $this->set('PMD_debug_mode', $debug_mode);
-    }
-
-
-    /**
-     * Gets description
-     *
-     * @return string
-     */
-    public function description()
-    {
-        return $this->get('PMD_desc');
-    }
-
-
-    /**
-     * Sets description
-     *
-     * @param string $description
-     */
-    public function set_description($description)
-    {
-        $this->set('PMD_desc', $description);
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->get('PMD_name');
-    }
-
-
-    /**
-     * Sets name
-     *
-     * @param string $name
-     */
-    public function set_name($name)
-    {
-        $this->set('PMD_name', $name);
-    }
-
-
-    /**
-     * Gets open_by_default
-     *
-     * @return boolean
-     */
-    public function open_by_default()
-    {
-        return $this->get('PMD_open_by_default');
-    }
-
-
-    /**
-     * Sets open_by_default
-     *
-     * @param boolean $open_by_default
-     */
-    public function set_open_by_default($open_by_default)
-    {
-        $this->set('PMD_open_by_default', $open_by_default);
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     */
-    public function order()
-    {
-        return $this->get('PMD_order');
-    }
-
-
-    /**
-     * Sets order
-     *
-     * @param int $order
-     */
-    public function set_order($order)
-    {
-        $this->set('PMD_order', $order);
-    }
-
-
-    /**
-     * Gets slug
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->get('PMD_slug');
-    }
-
-
-    /**
-     * Sets slug
-     *
-     * @param string $slug
-     */
-    public function set_slug($slug)
-    {
-        $this->set('PMD_slug', $slug);
-    }
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     */
-    public function type()
-    {
-        return $this->get('PMD_type');
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     */
-    public function set_type($type)
-    {
-        $this->set('PMD_type', $type);
-    }
-
-
-    /**
-     * Gets wp_user
-     *
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('PMD_wp_user');
-    }
-
-
-    /**
-     * Sets wp_user
-     *
-     * @param int $wp_user_id
-     */
-    public function set_wp_user($wp_user_id)
-    {
-        $this->set('PMD_wp_user', $wp_user_id);
-    }
-
-    /**
-     * Overrides parent so when PMD_type is changed we refresh the _type_obj
-     *
-     * @param string $field_name
-     * @param mixed $field_value
-     * @param boolean $use_default
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        if ($field_name === 'PMD_type') {
-            // the type has probably changed, so forget about its old type object
-            $this->_type_obj = null;
-        }
-        parent::set($field_name, $field_value, $use_default);
-    }
-
-
-    /**
-     * Gets admin_name
-     *
-     * @return string
-     */
-    public function admin_name()
-    {
-        return $this->get('PMD_admin_name');
-    }
-
-
-    /**
-     * Sets admin_name
-     *
-     * @param string $admin_name
-     */
-    public function set_admin_name($admin_name)
-    {
-        $this->set('PMD_admin_name', $admin_name);
-    }
-
-
-    /**
-     * Gets admin_desc
-     *
-     * @return string
-     */
-    public function admin_desc()
-    {
-        return $this->get('PMD_admin_desc');
-    }
-
-
-    /**
-     * Sets admin_desc
-     *
-     * @param string $admin_desc
-     */
-    public function set_admin_desc($admin_desc)
-    {
-        $this->set('PMD_admin_desc', $admin_desc);
-    }
-
-
-    /**
-     * Gets scope
-     *
-     * @return array
-     */
-    public function scope()
-    {
-        return $this->get('PMD_scope');
-    }
-
-
-    /**
-     * Sets scope
-     *
-     * @param array $scope
-     */
-    public function set_scope($scope)
-    {
-        $this->set('PMD_scope', $scope);
-    }
-
-
-    /**
-     * Gets the payment method type for this payment method instance
-     *
-     * @return EE_PMT_Base
-     * @throws EE_Error
-     */
-    public function type_obj()
-    {
-        if (! $this->_type_obj) {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
-                $class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
-                if (! class_exists($class_name)) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'An attempt to use the "%1$s" payment method failed, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated? It can be reactivated on the %3$sPlugins Admin Page%4$s',
-                                'event_espresso'
-                            ),
-                            $class_name,
-                            '<br />',
-                            '<a href="' . admin_url('plugins.php') . '">',
-                            '</a>'
-                        )
-                    );
-                }
-                $r = new ReflectionClass($class_name);
-                $this->_type_obj = $r->newInstanceArgs(array($this));
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'A payment method of type "%1$s" does not exist. Only ones existing are: %2$s',
-                            'event_espresso'
-                        ),
-                        $this->type(),
-                        implode(',', EE_Payment_Method_Manager::instance()->payment_method_type_names())
-                    )
-                );
-            }
-        }
-        return $this->_type_obj;
-    }
-
-
-    /**
-     * Returns a simple array of key-value pairs combining the payment method's fields (without the 'PMD_' prefix)
-     * and the extra meta. Mostly used for passing off ot gateways.     *
-     *
-     * @return array
-     */
-    public function settings_array()
-    {
-        $fields = $this->model_field_array();
-        $extra_meta = $this->all_extra_meta_array();
-        // remove the model's prefix from the fields
-        $combined_settings_array = array();
-        foreach ($fields as $key => $value) {
-            if (strpos($key, 'PMD_') === 0) {
-                $key_sans_model_prefix = str_replace('PMD_', '', $key);
-                $combined_settings_array [ $key_sans_model_prefix ] = $value;
-            }
-        }
-        $combined_settings_array = array_merge($extra_meta, $combined_settings_array);
-        return $combined_settings_array;
-    }
-
-
-    /**
-     * Gets the HTML for displaying the payment method on a page.
-     *
-     * @param string $url
-     * @param string $css_class
-     * @return string of HTML for displaying the button
-     * @throws EE_Error
-     */
-    public function button_html($url = '', $css_class = '')
-    {
-        $payment_occurs = $this->type_obj()->payment_occurs();
-        return '
+	/**
+	 * Payment Method type object, which has all the info about this type of payment method,
+	 * including functions for processing payments, to get settings forms, etc.
+	 *
+	 * @var EE_PMT_Base
+	 */
+	protected $_type_obj;
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values, false);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+
+	/**
+	 * Checks if there is a payment method class of the given 'PMD_type', and if so returns the classname.
+	 * Otherwise returns a normal EE_Payment_Method
+	 *
+	 * @param array $props_n_values where 'PMD_type' is a gateway name like 'Paypal_Standard','Invoice',etc (basically
+	 *                              the classname minus 'EEPM_')
+	 * @return string
+	 */
+	// private static function _payment_method_type($props_n_values)
+	// {
+	//     EE_Registry::instance()->load_lib('Payment_Method_Manager');
+	//     $type_string = isset($props_n_values['PMD_type']) ? $props_n_values['PMD_type'] : null;
+	//     if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($type_string)) {
+	//         return 'EEPM_' . $type_string;
+	//     } else {
+	//         return __CLASS__;
+	//     }
+	// }
+
+
+	/**
+	 * Gets whether this payment method can be used anywhere at all (ie frontend cart, admin, etc)
+	 *
+	 * @return boolean
+	 */
+	public function active()
+	{
+		return array_intersect(array_keys(EEM_Payment_Method::instance()->scopes()), $this->scope());
+	}
+
+
+	/**
+	 * Sets this PM as active by making it usable within the CART scope. Offline gateways
+	 * are also usable from the admin-scope as well. DOES NOT SAVE it
+	 *
+	 * @throws EE_Error
+	 */
+	public function set_active()
+	{
+		$default_scopes = array(EEM_Payment_Method::scope_cart);
+		if (
+			$this->type_obj() &&
+			$this->type_obj()->payment_occurs() === EE_PMT_Base::offline
+		) {
+			$default_scopes[] = EEM_Payment_Method::scope_admin;
+		}
+		$this->set_scope($default_scopes);
+	}
+
+
+	/**
+	 * Makes this payment method apply to NO scopes at all. DOES NOT SAVE it.
+	 */
+	public function deactivate()
+	{
+		$this->set_scope(array());
+	}
+
+
+	/**
+	 * Gets button_url
+	 *
+	 * @return string
+	 */
+	public function button_url()
+	{
+		return $this->get('PMD_button_url');
+	}
+
+
+	/**
+	 * Sets button_url
+	 *
+	 * @param string $button_url
+	 */
+	public function set_button_url($button_url)
+	{
+		$this->set('PMD_button_url', $button_url);
+	}
+
+
+	/**
+	 * Gets debug_mode
+	 *
+	 * @return boolean
+	 */
+	public function debug_mode()
+	{
+		return (bool) $this->get('PMD_debug_mode');
+	}
+
+
+	/**
+	 * Sets debug_mode
+	 *
+	 * @param boolean $debug_mode
+	 */
+	public function set_debug_mode($debug_mode)
+	{
+		$this->set('PMD_debug_mode', $debug_mode);
+	}
+
+
+	/**
+	 * Gets description
+	 *
+	 * @return string
+	 */
+	public function description()
+	{
+		return $this->get('PMD_desc');
+	}
+
+
+	/**
+	 * Sets description
+	 *
+	 * @param string $description
+	 */
+	public function set_description($description)
+	{
+		$this->set('PMD_desc', $description);
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->get('PMD_name');
+	}
+
+
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 */
+	public function set_name($name)
+	{
+		$this->set('PMD_name', $name);
+	}
+
+
+	/**
+	 * Gets open_by_default
+	 *
+	 * @return boolean
+	 */
+	public function open_by_default()
+	{
+		return $this->get('PMD_open_by_default');
+	}
+
+
+	/**
+	 * Sets open_by_default
+	 *
+	 * @param boolean $open_by_default
+	 */
+	public function set_open_by_default($open_by_default)
+	{
+		$this->set('PMD_open_by_default', $open_by_default);
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->get('PMD_order');
+	}
+
+
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 */
+	public function set_order($order)
+	{
+		$this->set('PMD_order', $order);
+	}
+
+
+	/**
+	 * Gets slug
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->get('PMD_slug');
+	}
+
+
+	/**
+	 * Sets slug
+	 *
+	 * @param string $slug
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('PMD_slug', $slug);
+	}
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->get('PMD_type');
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 */
+	public function set_type($type)
+	{
+		$this->set('PMD_type', $type);
+	}
+
+
+	/**
+	 * Gets wp_user
+	 *
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('PMD_wp_user');
+	}
+
+
+	/**
+	 * Sets wp_user
+	 *
+	 * @param int $wp_user_id
+	 */
+	public function set_wp_user($wp_user_id)
+	{
+		$this->set('PMD_wp_user', $wp_user_id);
+	}
+
+	/**
+	 * Overrides parent so when PMD_type is changed we refresh the _type_obj
+	 *
+	 * @param string $field_name
+	 * @param mixed $field_value
+	 * @param boolean $use_default
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		if ($field_name === 'PMD_type') {
+			// the type has probably changed, so forget about its old type object
+			$this->_type_obj = null;
+		}
+		parent::set($field_name, $field_value, $use_default);
+	}
+
+
+	/**
+	 * Gets admin_name
+	 *
+	 * @return string
+	 */
+	public function admin_name()
+	{
+		return $this->get('PMD_admin_name');
+	}
+
+
+	/**
+	 * Sets admin_name
+	 *
+	 * @param string $admin_name
+	 */
+	public function set_admin_name($admin_name)
+	{
+		$this->set('PMD_admin_name', $admin_name);
+	}
+
+
+	/**
+	 * Gets admin_desc
+	 *
+	 * @return string
+	 */
+	public function admin_desc()
+	{
+		return $this->get('PMD_admin_desc');
+	}
+
+
+	/**
+	 * Sets admin_desc
+	 *
+	 * @param string $admin_desc
+	 */
+	public function set_admin_desc($admin_desc)
+	{
+		$this->set('PMD_admin_desc', $admin_desc);
+	}
+
+
+	/**
+	 * Gets scope
+	 *
+	 * @return array
+	 */
+	public function scope()
+	{
+		return $this->get('PMD_scope');
+	}
+
+
+	/**
+	 * Sets scope
+	 *
+	 * @param array $scope
+	 */
+	public function set_scope($scope)
+	{
+		$this->set('PMD_scope', $scope);
+	}
+
+
+	/**
+	 * Gets the payment method type for this payment method instance
+	 *
+	 * @return EE_PMT_Base
+	 * @throws EE_Error
+	 */
+	public function type_obj()
+	{
+		if (! $this->_type_obj) {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
+				$class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
+				if (! class_exists($class_name)) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'An attempt to use the "%1$s" payment method failed, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated? It can be reactivated on the %3$sPlugins Admin Page%4$s',
+								'event_espresso'
+							),
+							$class_name,
+							'<br />',
+							'<a href="' . admin_url('plugins.php') . '">',
+							'</a>'
+						)
+					);
+				}
+				$r = new ReflectionClass($class_name);
+				$this->_type_obj = $r->newInstanceArgs(array($this));
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'A payment method of type "%1$s" does not exist. Only ones existing are: %2$s',
+							'event_espresso'
+						),
+						$this->type(),
+						implode(',', EE_Payment_Method_Manager::instance()->payment_method_type_names())
+					)
+				);
+			}
+		}
+		return $this->_type_obj;
+	}
+
+
+	/**
+	 * Returns a simple array of key-value pairs combining the payment method's fields (without the 'PMD_' prefix)
+	 * and the extra meta. Mostly used for passing off ot gateways.     *
+	 *
+	 * @return array
+	 */
+	public function settings_array()
+	{
+		$fields = $this->model_field_array();
+		$extra_meta = $this->all_extra_meta_array();
+		// remove the model's prefix from the fields
+		$combined_settings_array = array();
+		foreach ($fields as $key => $value) {
+			if (strpos($key, 'PMD_') === 0) {
+				$key_sans_model_prefix = str_replace('PMD_', '', $key);
+				$combined_settings_array [ $key_sans_model_prefix ] = $value;
+			}
+		}
+		$combined_settings_array = array_merge($extra_meta, $combined_settings_array);
+		return $combined_settings_array;
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the payment method on a page.
+	 *
+	 * @param string $url
+	 * @param string $css_class
+	 * @return string of HTML for displaying the button
+	 * @throws EE_Error
+	 */
+	public function button_html($url = '', $css_class = '')
+	{
+		$payment_occurs = $this->type_obj()->payment_occurs();
+		return '
 		 <div id="'
-               . $this->slug()
-               . '-payment-option-dv" class="'
-               . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
+			   . $this->slug()
+			   . '-payment-option-dv" class="'
+			   . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
 			<a id="payment-gateway-button-' . $this->slug()
-               . '" class="reg-page-payment-option-lnk" rel="'
-               . $this->slug() . '" href="' . $url . '" >
+			   . '" class="reg-page-payment-option-lnk" rel="'
+			   . $this->slug() . '" href="' . $url . '" >
 				<img src="' . $this->button_url() . '" alt="' . sprintf(
-                   esc_attr__('Pay using %s', 'event_espresso'),
-                   $this->get_pretty('PMD_name', 'form_input')
-               ) . '" />
+				   esc_attr__('Pay using %s', 'event_espresso'),
+				   $this->get_pretty('PMD_name', 'form_input')
+			   ) . '" />
 			</a>
 		</div>
 ';
-    }
-
-
-    /**
-     * Gets all the currencies which are an option for this payment method
-     * (as defined by the gateway and the currently active currencies)
-     *
-     * @return EE_Currency[]
-     * @throws EE_Error
-     */
-    public function get_all_usable_currencies()
-    {
-        return EEM_Currency::instance()->get_all_currencies_usable_by($this->type_obj());
-    }
-
-
-    /**
-     * Reports whether or not this payment method can be used for this payment method
-     *
-     * @param string $currency_code currency ID (code)
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function usable_for_currency($currency_code)
-    {
-        foreach ($this->get_all_usable_currencies() as $currency_obj) {
-            if ($currency_obj->ID() === $currency_code) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method's gateway is an instance of EE_Onsite_Gateway
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_on_site()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::onsite;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method's gateway is an instance of EE_Offsite_Gateway
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_off_site()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::offsite;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method does not utilize a gateway
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_off_line()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::offline;
-    }
-
-    /**
-     * Overrides default __sleep so the object type is NOT cached.
-     * This way we can rely on the normal EE_Payment_Method::type_obj() logic
-     * to load the required classes, and don't need them at the time of unserialization
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties = get_object_vars($this);
-        unset($properties['_type_obj']);
-        return array_keys($properties);
-    }
-
-
-    /**
-     * Overrides parent to add some logging for when payment methods get deactivated
-     *
-     * @param array $set_cols_n_values
-     * @return int @see EE_Base_Class::save()
-     * @throws EE_Error
-     */
-    public function save($set_cols_n_values = array())
-    {
-        $results = parent::save($set_cols_n_values);
-        if ($this->get_original('PMD_scope') !== $this->get('PMD_scope')) {
-            /** @var CurrentPage $current_page */
-            $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-            EE_Log::instance()->log(
-                __FILE__,
-                __FUNCTION__,
-                sprintf(
-                    esc_html__('Set new scope on payment method %1$s to %2$s from %3$s on URL %4$s', 'event_espresso'),
-                    $this->name(),
-                    serialize($this->get_original('PMD_scope')),
-                    serialize($this->get('PMD_scope')),
-                    $current_page->getPermalink()
-                ),
-                'payment_method_change'
-            );
-        }
-        return $results;
-    }
+	}
+
+
+	/**
+	 * Gets all the currencies which are an option for this payment method
+	 * (as defined by the gateway and the currently active currencies)
+	 *
+	 * @return EE_Currency[]
+	 * @throws EE_Error
+	 */
+	public function get_all_usable_currencies()
+	{
+		return EEM_Currency::instance()->get_all_currencies_usable_by($this->type_obj());
+	}
+
+
+	/**
+	 * Reports whether or not this payment method can be used for this payment method
+	 *
+	 * @param string $currency_code currency ID (code)
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function usable_for_currency($currency_code)
+	{
+		foreach ($this->get_all_usable_currencies() as $currency_obj) {
+			if ($currency_obj->ID() === $currency_code) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method's gateway is an instance of EE_Onsite_Gateway
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_on_site()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::onsite;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method's gateway is an instance of EE_Offsite_Gateway
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_off_site()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::offsite;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method does not utilize a gateway
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_off_line()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::offline;
+	}
+
+	/**
+	 * Overrides default __sleep so the object type is NOT cached.
+	 * This way we can rely on the normal EE_Payment_Method::type_obj() logic
+	 * to load the required classes, and don't need them at the time of unserialization
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties = get_object_vars($this);
+		unset($properties['_type_obj']);
+		return array_keys($properties);
+	}
+
+
+	/**
+	 * Overrides parent to add some logging for when payment methods get deactivated
+	 *
+	 * @param array $set_cols_n_values
+	 * @return int @see EE_Base_Class::save()
+	 * @throws EE_Error
+	 */
+	public function save($set_cols_n_values = array())
+	{
+		$results = parent::save($set_cols_n_values);
+		if ($this->get_original('PMD_scope') !== $this->get('PMD_scope')) {
+			/** @var CurrentPage $current_page */
+			$current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+			EE_Log::instance()->log(
+				__FILE__,
+				__FUNCTION__,
+				sprintf(
+					esc_html__('Set new scope on payment method %1$s to %2$s from %3$s on URL %4$s', 'event_espresso'),
+					$this->name(),
+					serialize($this->get_original('PMD_scope')),
+					serialize($this->get('PMD_scope')),
+					$current_page->getPermalink()
+				),
+				'payment_method_change'
+			);
+		}
+		return $results;
+	}
 }

core/domain/services/graphql/enums/TicketVisibilityEnum.php

Spacing +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
      */
     public function __construct()
     {
-        $this->setName($this->namespace . 'TicketVisibilityEnum');
+        $this->setName($this->namespace.'TicketVisibilityEnum');
         $this->setDescription(esc_html__('Where the ticket can be viewed throughout the UI', 'event_espresso'));
         parent::__construct();
     }

Indentation +18 added lines, -18 removed lines

@@ -17,24 +17,24 @@
  */
 class TicketVisibilityEnum extends EnumBase
 {
-    /**
-     * TicketVisibilityEnum constructor.
-     */
-    public function __construct()
-    {
-        $this->setName($this->namespace . 'TicketVisibilityEnum');
-        $this->setDescription(esc_html__('Where the ticket can be viewed throughout the UI', 'event_espresso'));
-        parent::__construct();
-    }
+	/**
+	 * TicketVisibilityEnum constructor.
+	 */
+	public function __construct()
+	{
+		$this->setName($this->namespace . 'TicketVisibilityEnum');
+		$this->setDescription(esc_html__('Where the ticket can be viewed throughout the UI', 'event_espresso'));
+		parent::__construct();
+	}
 
 
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function getValues()
-    {
-        return EEM_Ticket::instance()->getTicketVisibilityValues();
-    }
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function getValues()
+	{
+		return EEM_Ticket::instance()->getTicketVisibilityValues();
+	}
 }

core/domain/services/graphql/data/mutations/TicketMutation.php

Spacing +9 added lines, -9 removed lines

@@ -35,7 +35,7 @@ 
     {
         $args = [];
 
-        if (! empty($input['datetimes'])) {
+        if ( ! empty($input['datetimes'])) {
             $args['datetimes'] = array_map('sanitize_text_field', (array) $input['datetimes']);
         }
 
@@ -43,7 +43,7 @@ 
             $args['TKT_description'] = wp_kses_post($input['description']);
         }
 
-        if (! empty($input['endDate'])) {
+        if ( ! empty($input['endDate'])) {
             $args['TKT_end_date'] = new DateTime(sanitize_text_field($input['endDate']));
         }
 
@@ -79,9 +79,9 @@ 
             $args['TKT_order'] = (int) $input['order'];
         }
 
-        if (! empty($input['parent'])) {
+        if ( ! empty($input['parent'])) {
             $parts = Relay::fromGlobalId(sanitize_text_field($input['parent']));
-            $args['TKT_parent'] = (! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
+            $args['TKT_parent'] = ( ! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
         }
 
         // price can be 0
@@ -114,7 +114,7 @@ 
             $args['TKT_sold'] = (int) $input['sold'];
         }
 
-        if (! empty($input['startDate'])) {
+        if ( ! empty($input['startDate'])) {
             $args['TKT_start_date'] = new DateTime(sanitize_text_field($input['startDate']));
         }
 
@@ -122,9 +122,9 @@ 
             $args['TKT_uses'] = (int) $input['uses'];
         }
 
-        if (! empty($input['wpUser'])) {
+        if ( ! empty($input['wpUser'])) {
             $parts = Relay::fromGlobalId(sanitize_text_field($input['wpUser']));
-            $args['TKT_wp_user'] = (! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
+            $args['TKT_wp_user'] = ( ! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
         }
 
         if (array_key_exists('visibility', $input)) {
@@ -159,7 +159,7 @@ 
         // @todo replace loop with single query
         foreach ($datetimes as $ID) {
             $parts = Relay::fromGlobalId($ID);
-            if (! empty($parts['id']) && absint($parts['id'])) {
+            if ( ! empty($parts['id']) && absint($parts['id'])) {
                 $entity->_add_relation_to(
                     $parts['id'],
                     $relationName
@@ -189,7 +189,7 @@ 
         // @todo replace loop with single query
         foreach ($prices as $ID) {
             $parts = Relay::fromGlobalId($ID);
-            if (! empty($parts['id']) && absint($parts['id'])) {
+            if ( ! empty($parts['id']) && absint($parts['id'])) {
                 $entity->_add_relation_to(
                     $parts['id'],
                     $relationName

Indentation +191 added lines, -191 removed lines

@@ -22,195 +22,195 @@
  */
 class TicketMutation
 {
-    /**
-     * Maps the GraphQL input to a format that the model functions can use
-     *
-     * @param array $input Data coming from the GraphQL mutation query input
-     * @return array
-     * @throws Exception
-     */
-    public static function prepareFields($input)
-    {
-        $args = [];
-
-        if (! empty($input['datetimes'])) {
-            $args['datetimes'] = array_map('sanitize_text_field', (array) $input['datetimes']);
-        }
-
-        if (isset($input['description'])) {
-            $args['TKT_description'] = wp_kses_post($input['description']);
-        }
-
-        if (! empty($input['endDate'])) {
-            $args['TKT_end_date'] = new DateTime(sanitize_text_field($input['endDate']));
-        }
-
-        if (array_key_exists('isDefault', $input)) {
-            $args['TKT_is_default'] = (bool) $input['isDefault'];
-        }
-
-        if (array_key_exists('isRequired', $input)) {
-            $args['TKT_required'] = (bool) $input['isRequired'];
-        }
-
-        if (array_key_exists('isTaxable', $input)) {
-            $args['TKT_taxable'] = (bool) $input['isTaxable'];
-        }
-
-        if (array_key_exists('isTrashed', $input)) {
-            $args['TKT_deleted'] = (bool) $input['isTrashed'];
-        }
-
-        if (array_key_exists('max', $input)) {
-            $args['TKT_max'] = (int) $input['max'];
-        }
-
-        if (array_key_exists('min', $input)) {
-            $args['TKT_min'] = (int) $input['min'];
-        }
-
-        if (isset($input['name'])) {
-            $args['TKT_name'] = sanitize_text_field($input['name']);
-        }
-
-        if (array_key_exists('order', $input)) {
-            $args['TKT_order'] = (int) $input['order'];
-        }
-
-        if (! empty($input['parent'])) {
-            $parts = Relay::fromGlobalId(sanitize_text_field($input['parent']));
-            $args['TKT_parent'] = (! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
-        }
-
-        // price can be 0
-        if (array_key_exists('price', $input)) {
-            $args['TKT_price'] = (float) $input['price'];
-        }
-
-        // prices can be an empty array when all prices are deleted
-        if (array_key_exists('prices', $input) && is_array($input['prices'])) {
-            $args['prices'] = array_map('sanitize_text_field', $input['prices']);
-        }
-
-        if (array_key_exists('quantity', $input)) {
-            $args['TKT_qty'] = (int) $input['quantity'];
-        }
-
-        if (array_key_exists('reserved', $input)) {
-            $args['TKT_reserved'] = (int) $input['reserved'];
-        }
-
-        if (array_key_exists('reverseCalculate', $input)) {
-            $args['TKT_reverse_calculate'] = (bool) $input['reverseCalculate'];
-        }
-
-        if (array_key_exists('row', $input)) {
-            $args['TKT_row'] = (int) $input['row'];
-        }
-
-        if (array_key_exists('sold', $input)) {
-            $args['TKT_sold'] = (int) $input['sold'];
-        }
-
-        if (! empty($input['startDate'])) {
-            $args['TKT_start_date'] = new DateTime(sanitize_text_field($input['startDate']));
-        }
-
-        if (array_key_exists('uses', $input)) {
-            $args['TKT_uses'] = (int) $input['uses'];
-        }
-
-        if (! empty($input['wpUser'])) {
-            $parts = Relay::fromGlobalId(sanitize_text_field($input['wpUser']));
-            $args['TKT_wp_user'] = (! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
-        }
-
-        if (array_key_exists('visibility', $input)) {
-            $args['TKT_visibility'] = (int) $input['visibility'];
-        }
-
-        return apply_filters(
-            'FHEE__EventEspresso_core_domain_services_graphql_data_mutations__ticket_args',
-            $args,
-            $input
-        );
-    }
-
-
-    /**
-     * Sets the related datetimes for the given ticket.
-     *
-     * @param EE_Ticket $entity    The Ticket instance.
-     * @param array     $datetimes Array of datetime IDs to relate.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function setRelatedDatetimes($entity, $datetimes)
-    {
-        $relationName = 'Datetime';
-        // Remove all the existing related datetimes
-
-        $entity->_remove_relations($relationName);
-        // @todo replace loop with single query
-        foreach ($datetimes as $ID) {
-            $parts = Relay::fromGlobalId($ID);
-            if (! empty($parts['id']) && absint($parts['id'])) {
-                $entity->_add_relation_to(
-                    $parts['id'],
-                    $relationName
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Sets the related prices for the given ticket.
-     *
-     * @param EE_Ticket $entity The Ticket instance.
-     * @param array     $prices Array of entity IDs to relate.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function setRelatedPrices($entity, $prices)
-    {
-        $relationName = 'Price';
-        // Remove all the existing related entities
-        $entity->_remove_relations($relationName);
-
-        // @todo replace loop with single query
-        foreach ($prices as $ID) {
-            $parts = Relay::fromGlobalId($ID);
-            if (! empty($parts['id']) && absint($parts['id'])) {
-                $entity->_add_relation_to(
-                    $parts['id'],
-                    $relationName
-                );
-            }
-        }
-    }
-
-
-    /**
-     * @param EE_Ticket  $ticket_entity
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function addDefaultPrices($ticket_entity)
-    {
-        /** @var DefaultPrices $default_prices */
-        $default_prices = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\services\admin\entities\DefaultPrices'
-        );
-        $default_prices->create($ticket_entity);
-    }
+	/**
+	 * Maps the GraphQL input to a format that the model functions can use
+	 *
+	 * @param array $input Data coming from the GraphQL mutation query input
+	 * @return array
+	 * @throws Exception
+	 */
+	public static function prepareFields($input)
+	{
+		$args = [];
+
+		if (! empty($input['datetimes'])) {
+			$args['datetimes'] = array_map('sanitize_text_field', (array) $input['datetimes']);
+		}
+
+		if (isset($input['description'])) {
+			$args['TKT_description'] = wp_kses_post($input['description']);
+		}
+
+		if (! empty($input['endDate'])) {
+			$args['TKT_end_date'] = new DateTime(sanitize_text_field($input['endDate']));
+		}
+
+		if (array_key_exists('isDefault', $input)) {
+			$args['TKT_is_default'] = (bool) $input['isDefault'];
+		}
+
+		if (array_key_exists('isRequired', $input)) {
+			$args['TKT_required'] = (bool) $input['isRequired'];
+		}
+
+		if (array_key_exists('isTaxable', $input)) {
+			$args['TKT_taxable'] = (bool) $input['isTaxable'];
+		}
+
+		if (array_key_exists('isTrashed', $input)) {
+			$args['TKT_deleted'] = (bool) $input['isTrashed'];
+		}
+
+		if (array_key_exists('max', $input)) {
+			$args['TKT_max'] = (int) $input['max'];
+		}
+
+		if (array_key_exists('min', $input)) {
+			$args['TKT_min'] = (int) $input['min'];
+		}
+
+		if (isset($input['name'])) {
+			$args['TKT_name'] = sanitize_text_field($input['name']);
+		}
+
+		if (array_key_exists('order', $input)) {
+			$args['TKT_order'] = (int) $input['order'];
+		}
+
+		if (! empty($input['parent'])) {
+			$parts = Relay::fromGlobalId(sanitize_text_field($input['parent']));
+			$args['TKT_parent'] = (! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
+		}
+
+		// price can be 0
+		if (array_key_exists('price', $input)) {
+			$args['TKT_price'] = (float) $input['price'];
+		}
+
+		// prices can be an empty array when all prices are deleted
+		if (array_key_exists('prices', $input) && is_array($input['prices'])) {
+			$args['prices'] = array_map('sanitize_text_field', $input['prices']);
+		}
+
+		if (array_key_exists('quantity', $input)) {
+			$args['TKT_qty'] = (int) $input['quantity'];
+		}
+
+		if (array_key_exists('reserved', $input)) {
+			$args['TKT_reserved'] = (int) $input['reserved'];
+		}
+
+		if (array_key_exists('reverseCalculate', $input)) {
+			$args['TKT_reverse_calculate'] = (bool) $input['reverseCalculate'];
+		}
+
+		if (array_key_exists('row', $input)) {
+			$args['TKT_row'] = (int) $input['row'];
+		}
+
+		if (array_key_exists('sold', $input)) {
+			$args['TKT_sold'] = (int) $input['sold'];
+		}
+
+		if (! empty($input['startDate'])) {
+			$args['TKT_start_date'] = new DateTime(sanitize_text_field($input['startDate']));
+		}
+
+		if (array_key_exists('uses', $input)) {
+			$args['TKT_uses'] = (int) $input['uses'];
+		}
+
+		if (! empty($input['wpUser'])) {
+			$parts = Relay::fromGlobalId(sanitize_text_field($input['wpUser']));
+			$args['TKT_wp_user'] = (! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
+		}
+
+		if (array_key_exists('visibility', $input)) {
+			$args['TKT_visibility'] = (int) $input['visibility'];
+		}
+
+		return apply_filters(
+			'FHEE__EventEspresso_core_domain_services_graphql_data_mutations__ticket_args',
+			$args,
+			$input
+		);
+	}
+
+
+	/**
+	 * Sets the related datetimes for the given ticket.
+	 *
+	 * @param EE_Ticket $entity    The Ticket instance.
+	 * @param array     $datetimes Array of datetime IDs to relate.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function setRelatedDatetimes($entity, $datetimes)
+	{
+		$relationName = 'Datetime';
+		// Remove all the existing related datetimes
+
+		$entity->_remove_relations($relationName);
+		// @todo replace loop with single query
+		foreach ($datetimes as $ID) {
+			$parts = Relay::fromGlobalId($ID);
+			if (! empty($parts['id']) && absint($parts['id'])) {
+				$entity->_add_relation_to(
+					$parts['id'],
+					$relationName
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Sets the related prices for the given ticket.
+	 *
+	 * @param EE_Ticket $entity The Ticket instance.
+	 * @param array     $prices Array of entity IDs to relate.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function setRelatedPrices($entity, $prices)
+	{
+		$relationName = 'Price';
+		// Remove all the existing related entities
+		$entity->_remove_relations($relationName);
+
+		// @todo replace loop with single query
+		foreach ($prices as $ID) {
+			$parts = Relay::fromGlobalId($ID);
+			if (! empty($parts['id']) && absint($parts['id'])) {
+				$entity->_add_relation_to(
+					$parts['id'],
+					$relationName
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * @param EE_Ticket  $ticket_entity
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function addDefaultPrices($ticket_entity)
+	{
+		/** @var DefaultPrices $default_prices */
+		$default_prices = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\services\admin\entities\DefaultPrices'
+		);
+		$default_prices->create($ticket_entity);
+	}
 }

core/domain/entities/users/EventManagers.php

Spacing +6 added lines, -6 removed lines

@@ -71,8 +71,8 @@ 
             if ($role instanceof WP_Role) {
                 foreach ($this->capabilities as $capability) {
                     // we're using the role name as the array index to prevent duplicates
-                    if (! isset($event_manager_roles[ $role->name ]) && $role->has_cap($capability)) {
-                        $event_manager_roles[ $role->name ] = $role;
+                    if ( ! isset($event_manager_roles[$role->name]) && $role->has_cap($capability)) {
+                        $event_manager_roles[$role->name] = $role;
                     }
                 }
             }
@@ -89,7 +89,7 @@ 
             $this->user_list = [];
         }
         // begin to build our query
-        $SQL      = "SELECT u1.ID, u1.display_name FROM $wpdb->users AS u1 "
+        $SQL = "SELECT u1.ID, u1.display_name FROM $wpdb->users AS u1 "
                     . "INNER JOIN $wpdb->usermeta AS u2 ON u1.ID = u2.user_id "
                     . "AND u2.meta_key='{$wpdb->prefix}capabilities' "
                     . 'WHERE';
@@ -97,18 +97,18 @@ 
         foreach ($this->roles as $role) {
             // for each role, add a WHERE clause
             if ($role instanceof WP_Role) {
-                $SQL .= $operator . ' u2.meta_value LIKE \'%"' . $role->name . '"%\' ';
+                $SQL .= $operator.' u2.meta_value LIKE \'%"'.$role->name.'"%\' ';
                 // subsequent clauses will use OR so that any role is accepted
                 $operator = 'OR';
             }
         }
         foreach ($this->capabilities as $capability) {
             // for each capability, add a WHERE clause
-            $SQL .= $operator . ' u2.meta_value LIKE \'%"' . $capability . '";b:1;%\' ';
+            $SQL .= $operator.' u2.meta_value LIKE \'%"'.$capability.'";b:1;%\' ';
             // subsequent clauses will use OR so that any role is accepted
             $operator = 'OR';
         }
-        $SQL   .= 'ORDER BY user_id ASC';
+        $SQL .= 'ORDER BY user_id ASC';
         $users = $wpdb->get_results($SQL);
 
         $this->user_list = ! empty($users) ? $users : [];

Indentation +140 added lines, -140 removed lines

@@ -15,144 +15,144 @@
  */
 class EventManagers
 {
-    /**
-     * @var string[]
-     */
-    private $capabilities = [];
-
-    /**
-     * @var WP_Role[]
-     */
-    private $roles = [];
-
-    /**
-     * @var array
-     */
-    private $user_list = [];
-
-    /**
-     * @var WP_Role[]
-     */
-    private $wp_roles;
-
-
-    /**
-     * EventManagerRoles constructor.
-     */
-    public function __construct()
-    {
-        global $wp_roles;
-        // first let's grab ALL of the WP_Role objects
-        $this->wp_roles = $wp_roles->role_objects;
-        $this->setCapabilities();
-        $this->buildRolesArray();
-        $this->buildUserList();
-    }
-
-
-    /**
-     * @return void
-     */
-    private function setCapabilities()
-    {
-        // filter a list of capabilities we want to use to define an event manager
-        $capabilities = (array) apply_filters(
-            'FHEE__EventEspresso_core_domain_services_capabilities_EventManagers__setCapabilities',
-            ['ee_edit_events', 'ee_edit_event'],
-            $this->wp_roles
-        );
-        $this->capabilities = array_map('sanitize_text_field', $capabilities);
-    }
-
-
-    /**
-     * @return void
-     */
-    private function buildRolesArray()
-    {
-        // we'll use this array to capture all of the WP_Role objects that have any of the caps we are targeting
-        $event_manager_roles = [];
-        foreach ($this->wp_roles as $role) {
-            if ($role instanceof WP_Role) {
-                foreach ($this->capabilities as $capability) {
-                    // we're using the role name as the array index to prevent duplicates
-                    if (! isset($event_manager_roles[ $role->name ]) && $role->has_cap($capability)) {
-                        $event_manager_roles[ $role->name ] = $role;
-                    }
-                }
-            }
-        }
-        $this->roles = $event_manager_roles;
-    }
-
-
-    /**
-     * @return void
-     */
-    private function buildUserList()
-    {
-        global $wpdb;
-        // no roles ?!!? then nothing to query for
-        if (empty($this->roles)) {
-            $this->user_list = [];
-        }
-        // begin to build our query
-        $SQL      = "SELECT u1.ID, u1.display_name FROM $wpdb->users AS u1 "
-                    . "INNER JOIN $wpdb->usermeta AS u2 ON u1.ID = u2.user_id "
-                    . "AND u2.meta_key='{$wpdb->prefix}capabilities' "
-                    . 'WHERE';
-        $operator = '';
-        foreach ($this->roles as $role) {
-            // for each role, add a WHERE clause
-            if ($role instanceof WP_Role) {
-                $SQL .= $operator . ' u2.meta_value LIKE \'%"' . $role->name . '"%\' ';
-                // subsequent clauses will use OR so that any role is accepted
-                $operator = 'OR';
-            }
-        }
-        foreach ($this->capabilities as $capability) {
-            // for each capability, add a WHERE clause
-            $SQL .= $operator . ' u2.meta_value LIKE \'%"' . $capability . '";b:1;%\' ';
-            // subsequent clauses will use OR so that any role is accepted
-            $operator = 'OR';
-        }
-        $SQL   .= 'ORDER BY user_id ASC';
-        $users = $wpdb->get_results($SQL);
-
-        $this->user_list = ! empty($users) ? $users : [];
-    }
-
-
-    /**
-     * @return array
-     */
-    public function capabilities()
-    {
-        return $this->capabilities;
-    }
-
-
-    /**
-     * Returns a list of WP_Role objects that have "event manager" capabilities
-     * The list of "event manager" capabilities is filtered but defaults to:
-     *      - 'ee_edit_events'
-     *      - 'ee_edit_event'
-     *
-     * @return WP_Role[]
-     */
-    public function roles()
-    {
-        return $this->roles;
-    }
-
-
-    /**
-     * Returns a list of users that have any of the Event Manager roles
-     *
-     * @return stdClass[]
-     */
-    public function userList()
-    {
-        return $this->user_list;
-    }
+	/**
+	 * @var string[]
+	 */
+	private $capabilities = [];
+
+	/**
+	 * @var WP_Role[]
+	 */
+	private $roles = [];
+
+	/**
+	 * @var array
+	 */
+	private $user_list = [];
+
+	/**
+	 * @var WP_Role[]
+	 */
+	private $wp_roles;
+
+
+	/**
+	 * EventManagerRoles constructor.
+	 */
+	public function __construct()
+	{
+		global $wp_roles;
+		// first let's grab ALL of the WP_Role objects
+		$this->wp_roles = $wp_roles->role_objects;
+		$this->setCapabilities();
+		$this->buildRolesArray();
+		$this->buildUserList();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function setCapabilities()
+	{
+		// filter a list of capabilities we want to use to define an event manager
+		$capabilities = (array) apply_filters(
+			'FHEE__EventEspresso_core_domain_services_capabilities_EventManagers__setCapabilities',
+			['ee_edit_events', 'ee_edit_event'],
+			$this->wp_roles
+		);
+		$this->capabilities = array_map('sanitize_text_field', $capabilities);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function buildRolesArray()
+	{
+		// we'll use this array to capture all of the WP_Role objects that have any of the caps we are targeting
+		$event_manager_roles = [];
+		foreach ($this->wp_roles as $role) {
+			if ($role instanceof WP_Role) {
+				foreach ($this->capabilities as $capability) {
+					// we're using the role name as the array index to prevent duplicates
+					if (! isset($event_manager_roles[ $role->name ]) && $role->has_cap($capability)) {
+						$event_manager_roles[ $role->name ] = $role;
+					}
+				}
+			}
+		}
+		$this->roles = $event_manager_roles;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function buildUserList()
+	{
+		global $wpdb;
+		// no roles ?!!? then nothing to query for
+		if (empty($this->roles)) {
+			$this->user_list = [];
+		}
+		// begin to build our query
+		$SQL      = "SELECT u1.ID, u1.display_name FROM $wpdb->users AS u1 "
+					. "INNER JOIN $wpdb->usermeta AS u2 ON u1.ID = u2.user_id "
+					. "AND u2.meta_key='{$wpdb->prefix}capabilities' "
+					. 'WHERE';
+		$operator = '';
+		foreach ($this->roles as $role) {
+			// for each role, add a WHERE clause
+			if ($role instanceof WP_Role) {
+				$SQL .= $operator . ' u2.meta_value LIKE \'%"' . $role->name . '"%\' ';
+				// subsequent clauses will use OR so that any role is accepted
+				$operator = 'OR';
+			}
+		}
+		foreach ($this->capabilities as $capability) {
+			// for each capability, add a WHERE clause
+			$SQL .= $operator . ' u2.meta_value LIKE \'%"' . $capability . '";b:1;%\' ';
+			// subsequent clauses will use OR so that any role is accepted
+			$operator = 'OR';
+		}
+		$SQL   .= 'ORDER BY user_id ASC';
+		$users = $wpdb->get_results($SQL);
+
+		$this->user_list = ! empty($users) ? $users : [];
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function capabilities()
+	{
+		return $this->capabilities;
+	}
+
+
+	/**
+	 * Returns a list of WP_Role objects that have "event manager" capabilities
+	 * The list of "event manager" capabilities is filtered but defaults to:
+	 *      - 'ee_edit_events'
+	 *      - 'ee_edit_event'
+	 *
+	 * @return WP_Role[]
+	 */
+	public function roles()
+	{
+		return $this->roles;
+	}
+
+
+	/**
+	 * Returns a list of users that have any of the Event Manager roles
+	 *
+	 * @return stdClass[]
+	 */
+	public function userList()
+	{
+		return $this->user_list;
+	}
 }

core/db_models/EEM_Message.model.php

Spacing +8 added lines, -8 removed lines

@@ -126,7 +126,7 @@ 
             self::priority_low    => esc_html__('low', 'event_espresso'),
         );
 
-        $this->_fields          = array(
+        $this->_fields = array(
             'Message' => array(
                 'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
                 'MSG_token'          => new EE_Plain_Text_Field(
@@ -436,7 +436,7 @@ 
                         );
                         break;
                     default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
+                        $query_params[0]['AND**filter_by']['OR**filter_by_'.$request_key][$model_name.'.'.$request_key] = $request_value;
                         break;
                 }
             }
@@ -499,8 +499,8 @@ 
         if ($label_parts) {
             // prepend to the last element of $label_parts an "and".
             if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+                $label_parts_index_to_prepend = count($label_parts) - 1;
+                $label_parts[$label_parts_index_to_prepend] = 'and'.$label_parts[$label_parts_index_to_prepend];
             }
 
             $pretty_label .= sprintf(
@@ -560,7 +560,7 @@ 
             $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
         }
 
-        if (! is_null($set_debug)) {
+        if ( ! is_null($set_debug)) {
             $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
         }
 
@@ -627,13 +627,13 @@ 
             )
         );
 
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+        if ( ! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
             global $wpdb;
             $number_deleted = $wpdb->query('
                 DELETE
-                FROM ' . $this->table() . '
+                FROM ' . $this->table().'
                 WHERE
-                    MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
+                    MSG_ID IN (' . implode(",", $message_ids_to_delete).')
             ');
         }
 

Indentation +640 added lines, -640 removed lines

@@ -12,649 +12,649 @@
  */
 class EEM_Message extends EEM_Base implements EEI_Query_Filter
 {
-    // private instance of the Message object
-    protected static $_instance = null;
-
-
-    /**
-     * This priority indicates a message should be generated and sent ASAP
-     *
-     * @type int
-     */
-    const priority_high = 10;
-
-
-    /**
-     * This priority indicates a message should be generated ASAP and queued for sending.
-     *
-     * @type
-     */
-    const priority_medium = 20;
-
-
-    /**
-     * This priority indicates a message should be queued for generating.
-     *
-     * @type int
-     */
-    const priority_low = 30;
-
-
-    /**
-     * indicates this message was sent at the time modified
-     */
-    const status_sent = 'MSN';
-
-
-    /**
-     * indicates this message is waiting to be sent
-     */
-    const status_idle = 'MID';
-
-
-    /**
-     * indicates an attempt was a made to send this message
-     * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
-     * appear to the end user.
-     */
-    const status_failed = 'MFL';
-
-
-    /**
-     * indicates the message has been flagged for resending (at the time modified).
-     */
-    const status_resend = 'MRS';
-
-
-    /**
-     * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
-     * this status when added to the queue.
-     */
-    const status_incomplete = 'MIC';
-
-
-    /**
-     * Indicates everything was generated fine for the message, however, the messenger was unable to send.
-     * This status means that its possible to retry sending the message.
-     */
-    const status_retry = 'MRT';
-
-
-    /**
-     * This is used for more informational messages that may not indicate anything is broken but still cannot be
-     * generated or sent correctly. An example of a message that would get flagged this way would be when a not
-     * approved message was queued for generation, but at time of generation, the attached registration(s) are
-     * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
-     * in the db and be viewable in the message activity list table when the messages system is in debug mode.
-     *
-     * @see EEM_Message::debug()
-     */
-    const status_debug_only = 'MDO';
-
-
-    /**
-     * This status is given to messages it is processed by the messenger send method.
-     * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
-     * indicative of a PHP timeout or memory limit issue.
-     */
-    const status_messenger_executing = 'MEX';
-
-
-    /**
-     *    Private constructor to prevent direct creation.
-     *
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
-     *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
-     *                         the date time model field objects.  Default is null (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Message', 'event_espresso');
-        $this->plural_item   = esc_html__('Messages', 'event_espresso');
-
-        $this->_tables = array(
-            'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
-        );
-
-        $allowed_priority = array(
-            self::priority_high   => esc_html__('high', 'event_espresso'),
-            self::priority_medium => esc_html__('medium', 'event_espresso'),
-            self::priority_low    => esc_html__('low', 'event_espresso'),
-        );
-
-        $this->_fields          = array(
-            'Message' => array(
-                'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
-                'MSG_token'          => new EE_Plain_Text_Field(
-                    'MSG_token',
-                    esc_html__(
-                        'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
-                        'event_espresso'
-                    ),
-                    false,
-                    EEH_URL::generate_unique_token()
-                ),
-                'GRP_ID'             => new EE_Foreign_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
-                    true,
-                    0,
-                    'Message_Template_Group'
-                ),
-                'TXN_ID'             => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__(
-                        'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
-                        'event_espresso'
-                    ),
-                    true,
-                    0,
-                    'Transaction'
-                ),
-                'MSG_messenger'      => new EE_Plain_Text_Field(
-                    'MSG_messenger',
-                    esc_html__(
-                        'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
-                        'event_espresso'
-                    ),
-                    false,
-                    'email'
-                ),
-                'MSG_message_type'   => new EE_Plain_Text_Field(
-                    'MSG_message_type',
-                    esc_html__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
-                    false,
-                    'receipt'
-                ),
-                'MSG_context'        => new EE_Plain_Text_Field('MSG_context', esc_html__('Context', 'event_espresso'), false),
-                'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
-                    'MSG_recipient_ID',
-                    esc_html__('Recipient ID', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
-                    'MSG_recipient_type',
-                    esc_html__('Recipient Type', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_content',
-                    esc_html__('Content', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_to',
-                    esc_html__('Address To', 'event_espresso'),
-                    true
-                ),
-                'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_from',
-                    esc_html__('Address From', 'event_espresso'),
-                    true
-                ),
-                'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_subject',
-                    esc_html__('Subject', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_priority'       => new EE_Enum_Integer_Field(
-                    'MSG_priority',
-                    esc_html__('Priority', 'event_espresso'),
-                    false,
-                    self::priority_low,
-                    $allowed_priority
-                ),
-                'STS_ID'             => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status', 'event_espresso'),
-                    false,
-                    self::status_incomplete,
-                    'Status'
-                ),
-                'MSG_created'        => new EE_Datetime_Field(
-                    'MSG_created',
-                    esc_html__('Created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'MSG_modified'       => new EE_Datetime_Field(
-                    'MSG_modified',
-                    esc_html__('Modified', 'event_espresso'),
-                    true,
-                    EE_Datetime_Field::now
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'               => new EE_Belongs_To_Any_Relation(),
-            'Registration'           => new EE_Belongs_To_Any_Relation(),
-            'WP_User'                => new EE_Belongs_To_Any_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-            'Transaction'            => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return EE_Message
-     * @throws EE_Error
-     */
-    public function create_default_object()
-    {
-        /** @type EE_Message $message */
-        $message = parent::create_default_object();
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values
-     * @return EE_Message
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        /** @type EE_Message $message */
-        $message = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given attendee.
-     *
-     * @param EE_Attendee|int $attendee
-     * @param string          $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function message_sent_for_attendee($attendee, $message_type)
-    {
-        $attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
-        return $this->exists(array(
-            array(
-                'Attendee.ATT_ID'  => $attendee_ID,
-                'MSG_message_type' => $message_type,
-                'STS_ID'           => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given registration
-     *
-     * @param EE_Registration|int $registration
-     * @param string              $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function message_sent_for_registration($registration, $message_type)
-    {
-        $registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
-        return $this->exists(array(
-            array(
-                'Registration.REG_ID' => $registrationID,
-                'MSG_message_type'    => $message_type,
-                'STS_ID'              => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * This retrieves an EE_Message object from the db matching the given token string.
-     *
-     * @param string $token
-     * @return EE_Message
-     * @throws EE_Error
-     */
-    public function get_one_by_token($token)
-    {
-        return $this->get_one(array(
-            array(
-                'MSG_token' => $token,
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns stati that indicate the message HAS been sent
-     *
-     * @return array of strings for possible stati
-     */
-    public function stati_indicating_sent()
-    {
-        return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
-    }
-
-
-    /**
-     * Returns stati that indicate the message is waiting to be sent.
-     *
-     * @return array of strings for possible stati.
-     */
-    public function stati_indicating_to_send()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__stati_indicating_to_send',
-            array(self::status_idle, self::status_resend)
-        );
-    }
-
-
-    /**
-     * Returns stati that indicate the message has failed sending
-     *
-     * @return array  array of strings for possible stati.
-     */
-    public function stati_indicating_failed_sending()
-    {
-        $failed_stati = array(
-            self::status_failed,
-            self::status_retry,
-            self::status_messenger_executing,
-        );
-        // if WP_DEBUG is set, then let's include debug_only fails
-        if (WP_DEBUG) {
-            $failed_stati[] = self::status_debug_only;
-        }
-        return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
-    }
-
-
-    /**
-     * Returns filterable array of all EEM_Message statuses.
-     *
-     * @return array
-     */
-    public function all_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__all_statuses',
-            array(
-                EEM_Message::status_sent,
-                EEM_Message::status_incomplete,
-                EEM_Message::status_idle,
-                EEM_Message::status_resend,
-                EEM_Message::status_retry,
-                EEM_Message::status_failed,
-                EEM_Message::status_messenger_executing,
-                EEM_Message::status_debug_only,
-            )
-        );
-    }
-
-    /**
-     * Detects any specific query variables in the request and uses those to setup appropriate
-     * filter for any queries.
-     *
-     * @return array
-     */
-    public function filter_by_query_params()
-    {
-        /** @var RequestInterface $request */
-        $request = EEM_Base::$loader->getShared(RequestInterface::class);
-        // expected possible query_vars, the key in this array matches an expected key in the request,
-        // the value, matches the corresponding EEM_Base child reference.
-        $expected_vars   = $this->_expected_vars_for_query_inject();
-        $query_params[0] = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $request_value = $request->getRequestParam($request_key);
-            if ($request_value) {
-                // special case
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
-                            'Transaction.Registration.REG_ID' => $request_value,
-                        );
-                        break;
-                    case 'EVT_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
-                            'Transaction.Registration.EVT_ID' => $request_value,
-                        );
-                        break;
-                    default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
-                        break;
-                }
-            }
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_pretty_label_for_results()
-    {
-        /** @var RequestInterface $request */
-        $request = EEM_Base::$loader->getShared(RequestInterface::class);
-        $expected_vars = $this->_expected_vars_for_query_inject();
-        $pretty_label  = '';
-        $label_parts   = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $model_name = strpos($model_name, 'EEM_', true) === 0 ? $model_name : "EEM_{$model_name}";
-            $model = EEM_Base::$loader->getShared($model_name);
-            $model_field_value = $request->getRequestParam($request_key);
-            if ($model instanceof EEM_Base && $model_field_value !== '') {
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Registration with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'ATT_ID':
-                        /** @var EE_Attendee $attendee */
-                        $attendee      = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $attendee instanceof EE_Attendee
-                            ? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
-                            : sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'ID':
-                        /** @var EE_WP_User $wpUser */
-                        $wpUser        = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $wpUser instanceof EE_WP_User
-                            ? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
-                            : sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'TXN_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Transaction with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'EVT_ID':
-                        /** @var EE_Event $Event */
-                        $Event         = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $Event instanceof EE_Event
-                            ? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
-                            : sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                }
-            }
-        }
-
-        if ($label_parts) {
-            // prepend to the last element of $label_parts an "and".
-            if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
-            }
-
-            $pretty_label .= sprintf(
-                esc_html_x(
-                    'Showing messages for %s',
-                    'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
-                    'event_espresso'
-                ),
-                implode(', ', $label_parts)
-            );
-        }
-        return $pretty_label;
-    }
-
-
-    /**
-     * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
-     * The array is in the format:
-     * array(
-     *  {$field_name} => {$model_name}
-     * );
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    protected function _expected_vars_for_query_inject()
-    {
-        return array(
-            '_REG_ID' => 'Registration',
-            'ATT_ID'  => 'Attendee',
-            'ID'      => 'WP_User',
-            'TXN_ID'  => 'Transaction',
-            'EVT_ID'  => 'Event',
-        );
-    }
-
-
-    /**
-     * This returns whether EEM_Message is in debug mode or not.
-     * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
-     * generating/sending messages. Debug mode can be set by either:
-     * 1. Sending in a value for the $set_debug argument
-     * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
-     * 3. Overriding the above via the provided filter.
-     *
-     * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
-     *                                  provided boolean. When no argument is provided (default null) then the debug
-     *                                  mode will be returned.
-     * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
-     */
-    public static function debug($set_debug = null)
-    {
-        static $is_debugging = null;
-
-        // initialize (use constant if set).
-        if (is_null($set_debug) && is_null($is_debugging)) {
-            $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
-        }
-
-        if (! is_null($set_debug)) {
-            $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
-        }
-
-        // return filtered value
-        return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
-    }
-
-
-    /**
-     * Deletes old messages meeting certain criteria for removal from the database.
-     * By default, this will delete messages that:
-     * - are older than the value of the delete_threshold in months.
-     * - have a STS_ID other than EEM_Message::status_idle
-     *
-     * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in
-     *                              months.
-     * @return bool|false|int Either the number of records affected or false if there was an error (you can call
-     *                              $wpdb->last_error to find out what the error was.
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function delete_old_messages($delete_threshold = 6)
-    {
-        $number_deleted = 0;
-        /**
-         * Allows code to change the boundary for what messages are kept.
-         * Uses the value of the `delete_threshold` variable by default.
-         *
-         * @param int $seconds seconds that will be subtracted from the timestamp for now.
-         * @return int
-         */
-        $time_to_leave_alone = absint(
-            apply_filters(
-                'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
-                ((int) $delete_threshold) * MONTH_IN_SECONDS
-            )
-        );
-
-
-        /**
-         * Allows code to change what message stati are ignored when deleting.
-         * Defaults to only ignore EEM_Message::status_idle messages.
-         *
-         * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
-         */
-        $message_stati_to_keep = (array) apply_filters(
-            'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
-            array(
-                EEM_Message::status_idle
-            )
-        );
-
-        // first get all the ids of messages being deleted
-        $message_ids_to_delete = EEM_Message::instance()->get_col(
-            array(
-                0 => array(
-                    'STS_ID' => array('NOT_IN', $message_stati_to_keep),
-                    'MSG_modified' => array('<', time() - $time_to_leave_alone)
-                ),
-                'limit' => apply_filters(
-                    'EEM_Message__delete_old_messages__limit',
-                    2000,
-                    $delete_threshold
-                )
-            )
-        );
-
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
-            global $wpdb;
-            $number_deleted = $wpdb->query('
+	// private instance of the Message object
+	protected static $_instance = null;
+
+
+	/**
+	 * This priority indicates a message should be generated and sent ASAP
+	 *
+	 * @type int
+	 */
+	const priority_high = 10;
+
+
+	/**
+	 * This priority indicates a message should be generated ASAP and queued for sending.
+	 *
+	 * @type
+	 */
+	const priority_medium = 20;
+
+
+	/**
+	 * This priority indicates a message should be queued for generating.
+	 *
+	 * @type int
+	 */
+	const priority_low = 30;
+
+
+	/**
+	 * indicates this message was sent at the time modified
+	 */
+	const status_sent = 'MSN';
+
+
+	/**
+	 * indicates this message is waiting to be sent
+	 */
+	const status_idle = 'MID';
+
+
+	/**
+	 * indicates an attempt was a made to send this message
+	 * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
+	 * appear to the end user.
+	 */
+	const status_failed = 'MFL';
+
+
+	/**
+	 * indicates the message has been flagged for resending (at the time modified).
+	 */
+	const status_resend = 'MRS';
+
+
+	/**
+	 * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
+	 * this status when added to the queue.
+	 */
+	const status_incomplete = 'MIC';
+
+
+	/**
+	 * Indicates everything was generated fine for the message, however, the messenger was unable to send.
+	 * This status means that its possible to retry sending the message.
+	 */
+	const status_retry = 'MRT';
+
+
+	/**
+	 * This is used for more informational messages that may not indicate anything is broken but still cannot be
+	 * generated or sent correctly. An example of a message that would get flagged this way would be when a not
+	 * approved message was queued for generation, but at time of generation, the attached registration(s) are
+	 * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
+	 * in the db and be viewable in the message activity list table when the messages system is in debug mode.
+	 *
+	 * @see EEM_Message::debug()
+	 */
+	const status_debug_only = 'MDO';
+
+
+	/**
+	 * This status is given to messages it is processed by the messenger send method.
+	 * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
+	 * indicative of a PHP timeout or memory limit issue.
+	 */
+	const status_messenger_executing = 'MEX';
+
+
+	/**
+	 *    Private constructor to prevent direct creation.
+	 *
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
+	 *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
+	 *                         the date time model field objects.  Default is null (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Message', 'event_espresso');
+		$this->plural_item   = esc_html__('Messages', 'event_espresso');
+
+		$this->_tables = array(
+			'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
+		);
+
+		$allowed_priority = array(
+			self::priority_high   => esc_html__('high', 'event_espresso'),
+			self::priority_medium => esc_html__('medium', 'event_espresso'),
+			self::priority_low    => esc_html__('low', 'event_espresso'),
+		);
+
+		$this->_fields          = array(
+			'Message' => array(
+				'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
+				'MSG_token'          => new EE_Plain_Text_Field(
+					'MSG_token',
+					esc_html__(
+						'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
+						'event_espresso'
+					),
+					false,
+					EEH_URL::generate_unique_token()
+				),
+				'GRP_ID'             => new EE_Foreign_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
+					true,
+					0,
+					'Message_Template_Group'
+				),
+				'TXN_ID'             => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__(
+						'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
+						'event_espresso'
+					),
+					true,
+					0,
+					'Transaction'
+				),
+				'MSG_messenger'      => new EE_Plain_Text_Field(
+					'MSG_messenger',
+					esc_html__(
+						'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
+						'event_espresso'
+					),
+					false,
+					'email'
+				),
+				'MSG_message_type'   => new EE_Plain_Text_Field(
+					'MSG_message_type',
+					esc_html__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
+					false,
+					'receipt'
+				),
+				'MSG_context'        => new EE_Plain_Text_Field('MSG_context', esc_html__('Context', 'event_espresso'), false),
+				'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
+					'MSG_recipient_ID',
+					esc_html__('Recipient ID', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
+					'MSG_recipient_type',
+					esc_html__('Recipient Type', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_content',
+					esc_html__('Content', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
+					'MSG_to',
+					esc_html__('Address To', 'event_espresso'),
+					true
+				),
+				'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
+					'MSG_from',
+					esc_html__('Address From', 'event_espresso'),
+					true
+				),
+				'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_subject',
+					esc_html__('Subject', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_priority'       => new EE_Enum_Integer_Field(
+					'MSG_priority',
+					esc_html__('Priority', 'event_espresso'),
+					false,
+					self::priority_low,
+					$allowed_priority
+				),
+				'STS_ID'             => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status', 'event_espresso'),
+					false,
+					self::status_incomplete,
+					'Status'
+				),
+				'MSG_created'        => new EE_Datetime_Field(
+					'MSG_created',
+					esc_html__('Created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'MSG_modified'       => new EE_Datetime_Field(
+					'MSG_modified',
+					esc_html__('Modified', 'event_espresso'),
+					true,
+					EE_Datetime_Field::now
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'               => new EE_Belongs_To_Any_Relation(),
+			'Registration'           => new EE_Belongs_To_Any_Relation(),
+			'WP_User'                => new EE_Belongs_To_Any_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+			'Transaction'            => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return EE_Message
+	 * @throws EE_Error
+	 */
+	public function create_default_object()
+	{
+		/** @type EE_Message $message */
+		$message = parent::create_default_object();
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values
+	 * @return EE_Message
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		/** @type EE_Message $message */
+		$message = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given attendee.
+	 *
+	 * @param EE_Attendee|int $attendee
+	 * @param string          $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function message_sent_for_attendee($attendee, $message_type)
+	{
+		$attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
+		return $this->exists(array(
+			array(
+				'Attendee.ATT_ID'  => $attendee_ID,
+				'MSG_message_type' => $message_type,
+				'STS_ID'           => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given registration
+	 *
+	 * @param EE_Registration|int $registration
+	 * @param string              $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function message_sent_for_registration($registration, $message_type)
+	{
+		$registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
+		return $this->exists(array(
+			array(
+				'Registration.REG_ID' => $registrationID,
+				'MSG_message_type'    => $message_type,
+				'STS_ID'              => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * This retrieves an EE_Message object from the db matching the given token string.
+	 *
+	 * @param string $token
+	 * @return EE_Message
+	 * @throws EE_Error
+	 */
+	public function get_one_by_token($token)
+	{
+		return $this->get_one(array(
+			array(
+				'MSG_token' => $token,
+			),
+		));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message HAS been sent
+	 *
+	 * @return array of strings for possible stati
+	 */
+	public function stati_indicating_sent()
+	{
+		return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message is waiting to be sent.
+	 *
+	 * @return array of strings for possible stati.
+	 */
+	public function stati_indicating_to_send()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__stati_indicating_to_send',
+			array(self::status_idle, self::status_resend)
+		);
+	}
+
+
+	/**
+	 * Returns stati that indicate the message has failed sending
+	 *
+	 * @return array  array of strings for possible stati.
+	 */
+	public function stati_indicating_failed_sending()
+	{
+		$failed_stati = array(
+			self::status_failed,
+			self::status_retry,
+			self::status_messenger_executing,
+		);
+		// if WP_DEBUG is set, then let's include debug_only fails
+		if (WP_DEBUG) {
+			$failed_stati[] = self::status_debug_only;
+		}
+		return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
+	}
+
+
+	/**
+	 * Returns filterable array of all EEM_Message statuses.
+	 *
+	 * @return array
+	 */
+	public function all_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__all_statuses',
+			array(
+				EEM_Message::status_sent,
+				EEM_Message::status_incomplete,
+				EEM_Message::status_idle,
+				EEM_Message::status_resend,
+				EEM_Message::status_retry,
+				EEM_Message::status_failed,
+				EEM_Message::status_messenger_executing,
+				EEM_Message::status_debug_only,
+			)
+		);
+	}
+
+	/**
+	 * Detects any specific query variables in the request and uses those to setup appropriate
+	 * filter for any queries.
+	 *
+	 * @return array
+	 */
+	public function filter_by_query_params()
+	{
+		/** @var RequestInterface $request */
+		$request = EEM_Base::$loader->getShared(RequestInterface::class);
+		// expected possible query_vars, the key in this array matches an expected key in the request,
+		// the value, matches the corresponding EEM_Base child reference.
+		$expected_vars   = $this->_expected_vars_for_query_inject();
+		$query_params[0] = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$request_value = $request->getRequestParam($request_key);
+			if ($request_value) {
+				// special case
+				switch ($request_key) {
+					case '_REG_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
+							'Transaction.Registration.REG_ID' => $request_value,
+						);
+						break;
+					case 'EVT_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
+							'Transaction.Registration.EVT_ID' => $request_value,
+						);
+						break;
+					default:
+						$query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
+						break;
+				}
+			}
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_pretty_label_for_results()
+	{
+		/** @var RequestInterface $request */
+		$request = EEM_Base::$loader->getShared(RequestInterface::class);
+		$expected_vars = $this->_expected_vars_for_query_inject();
+		$pretty_label  = '';
+		$label_parts   = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$model_name = strpos($model_name, 'EEM_', true) === 0 ? $model_name : "EEM_{$model_name}";
+			$model = EEM_Base::$loader->getShared($model_name);
+			$model_field_value = $request->getRequestParam($request_key);
+			if ($model instanceof EEM_Base && $model_field_value !== '') {
+				switch ($request_key) {
+					case '_REG_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Registration with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'ATT_ID':
+						/** @var EE_Attendee $attendee */
+						$attendee      = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $attendee instanceof EE_Attendee
+							? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
+							: sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'ID':
+						/** @var EE_WP_User $wpUser */
+						$wpUser        = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $wpUser instanceof EE_WP_User
+							? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
+							: sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'TXN_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Transaction with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'EVT_ID':
+						/** @var EE_Event $Event */
+						$Event         = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $Event instanceof EE_Event
+							? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
+							: sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
+						break;
+				}
+			}
+		}
+
+		if ($label_parts) {
+			// prepend to the last element of $label_parts an "and".
+			if (count($label_parts) > 1) {
+				$label_parts_index_to_prepend               = count($label_parts) - 1;
+				$label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+			}
+
+			$pretty_label .= sprintf(
+				esc_html_x(
+					'Showing messages for %s',
+					'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
+					'event_espresso'
+				),
+				implode(', ', $label_parts)
+			);
+		}
+		return $pretty_label;
+	}
+
+
+	/**
+	 * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
+	 * The array is in the format:
+	 * array(
+	 *  {$field_name} => {$model_name}
+	 * );
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	protected function _expected_vars_for_query_inject()
+	{
+		return array(
+			'_REG_ID' => 'Registration',
+			'ATT_ID'  => 'Attendee',
+			'ID'      => 'WP_User',
+			'TXN_ID'  => 'Transaction',
+			'EVT_ID'  => 'Event',
+		);
+	}
+
+
+	/**
+	 * This returns whether EEM_Message is in debug mode or not.
+	 * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
+	 * generating/sending messages. Debug mode can be set by either:
+	 * 1. Sending in a value for the $set_debug argument
+	 * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
+	 * 3. Overriding the above via the provided filter.
+	 *
+	 * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
+	 *                                  provided boolean. When no argument is provided (default null) then the debug
+	 *                                  mode will be returned.
+	 * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
+	 */
+	public static function debug($set_debug = null)
+	{
+		static $is_debugging = null;
+
+		// initialize (use constant if set).
+		if (is_null($set_debug) && is_null($is_debugging)) {
+			$is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
+		}
+
+		if (! is_null($set_debug)) {
+			$is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
+		}
+
+		// return filtered value
+		return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
+	}
+
+
+	/**
+	 * Deletes old messages meeting certain criteria for removal from the database.
+	 * By default, this will delete messages that:
+	 * - are older than the value of the delete_threshold in months.
+	 * - have a STS_ID other than EEM_Message::status_idle
+	 *
+	 * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in
+	 *                              months.
+	 * @return bool|false|int Either the number of records affected or false if there was an error (you can call
+	 *                              $wpdb->last_error to find out what the error was.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function delete_old_messages($delete_threshold = 6)
+	{
+		$number_deleted = 0;
+		/**
+		 * Allows code to change the boundary for what messages are kept.
+		 * Uses the value of the `delete_threshold` variable by default.
+		 *
+		 * @param int $seconds seconds that will be subtracted from the timestamp for now.
+		 * @return int
+		 */
+		$time_to_leave_alone = absint(
+			apply_filters(
+				'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
+				((int) $delete_threshold) * MONTH_IN_SECONDS
+			)
+		);
+
+
+		/**
+		 * Allows code to change what message stati are ignored when deleting.
+		 * Defaults to only ignore EEM_Message::status_idle messages.
+		 *
+		 * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
+		 */
+		$message_stati_to_keep = (array) apply_filters(
+			'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
+			array(
+				EEM_Message::status_idle
+			)
+		);
+
+		// first get all the ids of messages being deleted
+		$message_ids_to_delete = EEM_Message::instance()->get_col(
+			array(
+				0 => array(
+					'STS_ID' => array('NOT_IN', $message_stati_to_keep),
+					'MSG_modified' => array('<', time() - $time_to_leave_alone)
+				),
+				'limit' => apply_filters(
+					'EEM_Message__delete_old_messages__limit',
+					2000,
+					$delete_threshold
+				)
+			)
+		);
+
+		if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+			global $wpdb;
+			$number_deleted = $wpdb->query('
                 DELETE
                 FROM ' . $this->table() . '
                 WHERE
                     MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
             ');
-        }
-
-        /**
-         * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
-         * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
-         * below.
-         */
-        if ($number_deleted !== false) {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
-        } else {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
-        }
-        return $number_deleted;
-    }
+		}
+
+		/**
+		 * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
+		 * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
+		 * below.
+		 */
+		if ($number_deleted !== false) {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
+		} else {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
+		}
+		return $number_deleted;
+	}
 }

core/db_models/fields/EE_Field_With_Model_Name.php

Spacing +2 added lines, -2 removed lines

@@ -79,10 +79,10 @@
         $model_names = [];
         if (is_array($this->_model_name_pointed_to)) {
             foreach ($this->_model_name_pointed_to as $model_name) {
-                $model_names[] = "EE_" . $model_name;
+                $model_names[] = "EE_".$model_name;
             }
         } else {
-            $model_names = ["EE_" . $this->_model_name_pointed_to];
+            $model_names = ["EE_".$this->_model_name_pointed_to];
         }
         return $model_names;
     }

Indentation +80 added lines, -80 removed lines

@@ -8,94 +8,94 @@
  */
 abstract class EE_Field_With_Model_Name extends EE_Model_Field_Base
 {
-    /**
-     * Usually the name of a single model. However, as in the case for custom post types,
-     * it can actually be an array of models
-     *
-     * @var string[]
-     */
-    protected $_model_name_pointed_to;
+	/**
+	 * Usually the name of a single model. However, as in the case for custom post types,
+	 * it can actually be an array of models
+	 *
+	 * @var string[]
+	 */
+	protected $_model_name_pointed_to;
 
 
-    /**
-     * @param string          $table_column  name of column for field
-     * @param string          $nicename      should be internationalized with __('blah','event_espresso')
-     * @param boolean         $nullable
-     * @param int|string      $default_value data type should match field type
-     * @param string|string[] $model_name    eg 'Event','Answer','Term', etc.
-     *                                       Basically its the model class's name without the "EEM_"
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
-    {
-        $this->_model_name_pointed_to = (array) $model_name;
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-    }
+	/**
+	 * @param string          $table_column  name of column for field
+	 * @param string          $nicename      should be internationalized with __('blah','event_espresso')
+	 * @param boolean         $nullable
+	 * @param int|string      $default_value data type should match field type
+	 * @param string|string[] $model_name    eg 'Event','Answer','Term', etc.
+	 *                                       Basically its the model class's name without the "EEM_"
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
+	{
+		$this->_model_name_pointed_to = (array) $model_name;
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+	}
 
 
-    /**
-     * Returns the name of the model(s) pointed to
-     *
-     * @return string[] string or array of strings
-     * @deprecated since version 4.6.7
-     */
-    public function get_model_name_pointed_to()
-    {
-        EE_Error::doing_it_wrong(
-            'get_model_name_pointed_to',
-            esc_html__(
-                'This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
-                'event_espresso'
-            ),
-            '4.6.7'
-        );
-        return $this->_model_name_pointed_to;
-    }
+	/**
+	 * Returns the name of the model(s) pointed to
+	 *
+	 * @return string[] string or array of strings
+	 * @deprecated since version 4.6.7
+	 */
+	public function get_model_name_pointed_to()
+	{
+		EE_Error::doing_it_wrong(
+			'get_model_name_pointed_to',
+			esc_html__(
+				'This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
+				'event_espresso'
+			),
+			'4.6.7'
+		);
+		return $this->_model_name_pointed_to;
+	}
 
 
-    /**
-     * Gets the model names pointed to by this field, always as an array
-     * (even if there's only one)
-     *
-     * @return string[] of model names pointed to by this field
-     */
-    public function get_model_names_pointed_to()
-    {
-        return is_array($this->_model_name_pointed_to)
-            ? $this->_model_name_pointed_to
-            : [$this->_model_name_pointed_to];
-    }
+	/**
+	 * Gets the model names pointed to by this field, always as an array
+	 * (even if there's only one)
+	 *
+	 * @return string[] of model names pointed to by this field
+	 */
+	public function get_model_names_pointed_to()
+	{
+		return is_array($this->_model_name_pointed_to)
+			? $this->_model_name_pointed_to
+			: [$this->_model_name_pointed_to];
+	}
 
 
-    /**
-     * Returns the model's classname (eg EE_Event instead of just Event)
-     *
-     * @return string[]
-     */
-    public function get_model_class_names_pointed_to()
-    {
-        $model_names = [];
-        if (is_array($this->_model_name_pointed_to)) {
-            foreach ($this->_model_name_pointed_to as $model_name) {
-                $model_names[] = "EE_" . $model_name;
-            }
-        } else {
-            $model_names = ["EE_" . $this->_model_name_pointed_to];
-        }
-        return $model_names;
-    }
+	/**
+	 * Returns the model's classname (eg EE_Event instead of just Event)
+	 *
+	 * @return string[]
+	 */
+	public function get_model_class_names_pointed_to()
+	{
+		$model_names = [];
+		if (is_array($this->_model_name_pointed_to)) {
+			foreach ($this->_model_name_pointed_to as $model_name) {
+				$model_names[] = "EE_" . $model_name;
+			}
+		} else {
+			$model_names = ["EE_" . $this->_model_name_pointed_to];
+		}
+		return $model_names;
+	}
 
 
-    /**
-     * @param int|EE_Base_Class $model_obj
-     * @return bool
-     */
-    public function is_model_obj_of_type_pointed_to($model_obj)
-    {
-        foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
-            if ($model_obj instanceof $model_obj_classname) {
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * @param int|EE_Base_Class $model_obj
+	 * @return bool
+	 */
+	public function is_model_obj_of_type_pointed_to($model_obj)
+	{
+		foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
+			if ($model_obj instanceof $model_obj_classname) {
+				return true;
+			}
+		}
+		return false;
+	}
 }

core/db_models/fields/EE_WP_Post_Type_Field.php.php

Indentation +8 added lines, -8 removed lines

@@ -5,12 +5,12 @@
  */
 class EE_WP_Post_Type_Field extends EE_DB_Only_Text_Field
 {
-    /**
-     * @param string $post_type the exact string to be used for the post type
-     *                          of all these post type model objects/rows
-     */
-    public function __construct($post_type)
-    {
-        parent::__construct('post_type', esc_html__("Post Type", 'event_espresso'), false, $post_type);
-    }
+	/**
+	 * @param string $post_type the exact string to be used for the post type
+	 *                          of all these post type model objects/rows
+	 */
+	public function __construct($post_type)
+	{
+		parent::__construct('post_type', esc_html__("Post Type", 'event_espresso'), false, $post_type);
+	}
 }

core/services/form/meta/inputs/Phone.php

Spacing +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
      */
     public function __construct()
     {
-        $this->regex_patterns     = (array) apply_filters(
+        $this->regex_patterns = (array) apply_filters(
             'FHEE__EventEspresso_core_services_form_meta_inputs_Phone__regex_patterns',
             [
                 'de_DE' => Phone::PATTERN_DE,

Indentation +93 added lines, -93 removed lines

@@ -4,109 +4,109 @@
 
 class Phone
 {
-    /**
-     * indicates that the HTML input type is 'tel'
-     */
-    const INPUT_TYPE = 'tel';
+	/**
+	 * indicates that the HTML input type is 'tel'
+	 */
+	const INPUT_TYPE = 'tel';
 
-    /**
-     * indicates that the 'tel' input regex pattern is for a US formatted phone number, examples:
-     *      ##########
-     *      ###-###-####
-     *      ### ### ####
-     *      (###)-###-####
-     *      (###) ###-####
-     *
-     * captures the intl code to the first group (+1) and the rest of the number to group 2
-     *      +1 (###) ###-####
-     */
-    const PATTERN_US = '(\+?\d{1,3})?[\ \-]?(\(?\d{3}\)?[\ \-]?\d{3}[\ \-]?\d{4})';
+	/**
+	 * indicates that the 'tel' input regex pattern is for a US formatted phone number, examples:
+	 *      ##########
+	 *      ###-###-####
+	 *      ### ### ####
+	 *      (###)-###-####
+	 *      (###) ###-####
+	 *
+	 * captures the intl code to the first group (+1) and the rest of the number to group 2
+	 *      +1 (###) ###-####
+	 */
+	const PATTERN_US = '(\+?\d{1,3})?[\ \-]?(\(?\d{3}\)?[\ \-]?\d{3}[\ \-]?\d{4})';
 
-    /**
-     * indicates that the 'tel' input regex pattern is for a UK formatted phone number, examples:
-     *      (###) #### ####
-     *      (####) ### ####
-     *      (#####) ## ####
-     *
-     * captures the intl code to the first group (+44) and the rest of the number to group 2
-     *      +44 (###) #### ####
-     */
-    const PATTERN_UK = '(\+?44)?[\ ]?(\(?(?:(?:\d{3,5})|(?:\d{4} \d{2}))\)?[\-\ ]?\d{2,4}[\-\ ]?\d{2,4})';
+	/**
+	 * indicates that the 'tel' input regex pattern is for a UK formatted phone number, examples:
+	 *      (###) #### ####
+	 *      (####) ### ####
+	 *      (#####) ## ####
+	 *
+	 * captures the intl code to the first group (+44) and the rest of the number to group 2
+	 *      +44 (###) #### ####
+	 */
+	const PATTERN_UK = '(\+?44)?[\ ]?(\(?(?:(?:\d{3,5})|(?:\d{4} \d{2}))\)?[\-\ ]?\d{2,4}[\-\ ]?\d{2,4})';
 
-    /**
-     * indicates that the 'tel' input regex pattern is for a France formatted phone number, examples:
-     *      0# ## ## ## ##
-     *      0### ## ## ##
-     *
-     * captures the intl code to the first group (+33) and the rest of the number to group 2
-     *      +33 # ## ## ## ##
-     *      0033 # ## ## ## ##
-     */
-    const PATTERN_FR = '((?:\+|00)33)?[\ \.\-]*((?:(?:\(0\)[\ \.\-]{0,3})?|0)[1-9](?:(?:[\ \.\-]?\d{2}){4}|\d{2}(?:[\ \.\-]?\d{3}){2}))';
+	/**
+	 * indicates that the 'tel' input regex pattern is for a France formatted phone number, examples:
+	 *      0# ## ## ## ##
+	 *      0### ## ## ##
+	 *
+	 * captures the intl code to the first group (+33) and the rest of the number to group 2
+	 *      +33 # ## ## ## ##
+	 *      0033 # ## ## ## ##
+	 */
+	const PATTERN_FR = '((?:\+|00)33)?[\ \.\-]*((?:(?:\(0\)[\ \.\-]{0,3})?|0)[1-9](?:(?:[\ \.\-]?\d{2}){4}|\d{2}(?:[\ \.\-]?\d{3}){2}))';
 
-    /**
-     * indicates that the 'tel' input regex pattern is for a German formatted phone number, examples:
-     *      (0##) ####-####
-     *      (0###) ####-####
-     *      (0####) ###-####
-     *      (03####) ##-####
-     *
-     * captures the intl code to the first group (+49) and the rest of the number to group 2
-     *      +49 (0##) ####-####
-     */
-    const PATTERN_DE = '(\+?49)?[\ \.\-]?(\(?(?:[\d \-\)\–\/\(]+){6,}\)?(?:[\ \.\-–\/]?)(?:[\d]+))';
+	/**
+	 * indicates that the 'tel' input regex pattern is for a German formatted phone number, examples:
+	 *      (0##) ####-####
+	 *      (0###) ####-####
+	 *      (0####) ###-####
+	 *      (03####) ##-####
+	 *
+	 * captures the intl code to the first group (+49) and the rest of the number to group 2
+	 *      +49 (0##) ####-####
+	 */
+	const PATTERN_DE = '(\+?49)?[\ \.\-]?(\(?(?:[\d \-\)\–\/\(]+){6,}\)?(?:[\ \.\-–\/]?)(?:[\d]+))';
 
-    /**
-     * @var array
-     */
-    private $regex_patterns;
+	/**
+	 * @var array
+	 */
+	private $regex_patterns;
 
-    /**
-     * @var array
-     */
-    private $valid_type_options;
+	/**
+	 * @var array
+	 */
+	private $valid_type_options;
 
 
-    /**
-     * Phone constructor.
-     */
-    public function __construct()
-    {
-        $this->regex_patterns     = (array) apply_filters(
-            'FHEE__EventEspresso_core_services_form_meta_inputs_Phone__regex_patterns',
-            [
-                'de_DE' => Phone::PATTERN_DE,
-                'fr_FR' => Phone::PATTERN_FR,
-                'en_UK' => Phone::PATTERN_UK,
-                'en_US' => Phone::PATTERN_US,
-            ]
-        );
-        $this->valid_type_options = apply_filters(
-            'FHEE__EventEspresso_core_services_form_meta_inputs_Phone__valid_type_options',
-            [
-                Phone::INPUT_TYPE => esc_html__('Phone Number', 'event_espresso'),
-            ]
-        );
-    }
+	/**
+	 * Phone constructor.
+	 */
+	public function __construct()
+	{
+		$this->regex_patterns     = (array) apply_filters(
+			'FHEE__EventEspresso_core_services_form_meta_inputs_Phone__regex_patterns',
+			[
+				'de_DE' => Phone::PATTERN_DE,
+				'fr_FR' => Phone::PATTERN_FR,
+				'en_UK' => Phone::PATTERN_UK,
+				'en_US' => Phone::PATTERN_US,
+			]
+		);
+		$this->valid_type_options = apply_filters(
+			'FHEE__EventEspresso_core_services_form_meta_inputs_Phone__valid_type_options',
+			[
+				Phone::INPUT_TYPE => esc_html__('Phone Number', 'event_espresso'),
+			]
+		);
+	}
 
 
-    /**
-     * @return array
-     */
-    public function regexPatterns()
-    {
-        return $this->regex_patterns;
-    }
+	/**
+	 * @return array
+	 */
+	public function regexPatterns()
+	{
+		return $this->regex_patterns;
+	}
 
 
-    /**
-     * @param bool $constants_only
-     * @return array
-     */
-    public function validTypeOptions($constants_only = false)
-    {
-        return $constants_only
-            ? array_keys($this->valid_type_options)
-            : $this->valid_type_options;
-    }
+	/**
+	 * @param bool $constants_only
+	 * @return array
+	 */
+	public function validTypeOptions($constants_only = false)
+	{
+		return $constants_only
+			? array_keys($this->valid_type_options)
+			: $this->valid_type_options;
+	}
 }

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

Spacing +9 added lines, -9 removed lines

@@ -53,11 +53,11 @@ 
 
     public function translate_js_strings()
     {
-        EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
+        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__(
+        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'
         );
@@ -65,7 +65,7 @@ 
             'Please answer all required questions correctly before proceeding.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
+        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.',
@@ -73,11 +73,11 @@ 
             ),
             '<br/>'
         );
-        EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
+        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__(
+        EE_Registry::$i18n_js_strings['enter_valid_email'] = esc_html__(
             'You must enter a valid email address.',
             'event_espresso'
         );
@@ -322,7 +322,7 @@ 
         if (empty($valid_data)) {
             return $this->inValidDataError();
         }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+        if ( ! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
             return $this->inValidTransactionError();
         }
         // get cached registrations
@@ -334,14 +334,14 @@ 
         /** @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)) {
+        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) {
+        if ( ! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
             return $this->registrationProcessingError($registrations_processed);
         }
         // mark this reg step as completed
@@ -408,7 +408,7 @@ 
                 '(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('espresso_events') . '" >',
+            '<a href="'.get_post_type_archive_link('espresso_events').'" >',
             '</a>',
             '<br />'
         );

Indentation +859 added lines, -859 removed lines

@@ -22,863 +22,863 @@
  */
 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()
-    {
-        return true;
-    }
-
-
-    /**
-     * @return RegForm
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function generate_reg_form()
-    {
-        $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   $VID:$
-     */
-    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   $VID:$
-     */
-    public function registrationQuestionGroupsQueryParameters(
-        $query_params,
-        $registration
-    ) {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
-            $query_params,
-            $registration,
-            $this
-        );
-    }
-
-
-    /**
-     * @param RegFormQuestionGroup $question_group_reg_form
-     * @param EE_Registration      $registration
-     * @param EE_Question_Group    $question_group
-     * @return mixed|void
-     * @since   $VID:$
-     */
-    public function registrationQuestionGroupsRegForm(
-        $question_group_reg_form,
-        $registration,
-        $question_group
-    ) {
-        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   $VID:$
-     */
-    public function registrationRegFormPrintCopyInfo(
-        $print_copy_info,
-        $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   $VID:$
-     */
-    public function registrationRegFormRelatedQuestionsQueryParams(
-        $query_params,
-        $question_group,
-        $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   $VID:$
-     */
-    public function registrationRegFormBeforeQuestionGroupQuestions(
-        $html,
-        $registration,
-        $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   $VID:$
-     */
-    public function registrationRegFormSubsections(
-        $form_subsections,
-        $registration,
-        $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   $VID:$
-     */
-    public function registrationRegFormAfterQuestionGroupQuestions(
-        $html,
-        $registration,
-        $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   $VID:$
-     */
-    public function autoCopyAttendeeInfoTemplateArgs($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   $VID:$
-     */
-    public function generateQuestionInputCountryOptions(
-        $country_options,
-        $registration,
-        $question,
-        $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   $VID:$
-     */
-    public function generateQuestionInputStateOptions(
-        $state_options,
-        $registration,
-        $question,
-        $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   $VID:$
-     */
-    private function _registrations_reg_form()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalAttendeeRegInfoInput()
-     *
-     * @deprecated   $VID:$
-     */
-    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   $VID:$
-     */
-    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   $VID:$
-     */
-    private function _question_group_header()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\CopyAttendeeInfoForm
-     *
-     * @deprecated   $VID:$
-     */
-    private function _copy_attendee_info_form()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\AutoCopyAttendeeInfoForm
-     *
-     * @deprecated   $VID:$
-     */
-    private function _auto_copy_attendee_info()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\CopyAttendeeInfoForm
-     *
-     * @deprecated   $VID:$
-     */
-    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   $VID:$
-     */
-    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   $VID:$
-     */
-    public function reg_form_question($registration, $question)
-    {
-        /** @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   $VID:$
-     */
-    private function _generate_question_input()
-    {
-    }
-
-
-    /**
-     * looking for hooks?
-     * this method has been replaced by:
-     * EventEspresso\core\domain\services\registration\form\v1\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   $VID:$
-     */
-    public function use_cached_countries_for_form_input(
-        $countries_list = null,
-        $question = null,
-        $registration = null,
-        $answer = null
-    ) {
-        /** @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\v1\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   $VID:$
-     */
-    public function use_cached_states_for_form_input(
-        $states_list = null,
-        $question = null,
-        $registration = null,
-        $answer = null
-    ) {
-        /** @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()
-    {
-        $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   $VID:$
-     */
-    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   $VID:$
-     */
-    public function preRegistrationProcess(
-        $bypass,
-        $attendee_count,
-        $registration,
-        $registrations,
-        $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   $VID:$
-     */
-    public function validDataLineItem($reg_form_data, $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   $VID:$
-     */
-    public function saveRegistrationFormInput($save, $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   $VID:$
-     */
-    public function mergeAddressDetailsWithCriticalAttendeeDetails($merge_data)
-    {
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
-            $merge_data
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @since   $VID:$
-     */
-    private function inValidDataError()
-    {
-        EE_Error::add_error(
-            esc_html__('No valid question responses were received.', 'event_espresso'),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-    /**
-     * @return bool
-     * @since   $VID:$
-     */
-    private function inValidTransactionError()
-    {
-        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   $VID:$
-     */
-    private function noRegistrationsError()
-    {
-        // 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('espresso_events') . '" >',
-            '</a>',
-            '<br />'
-        );
-        EE_Error::add_error($error_message, __FILE__, __FUNCTION__, __LINE__);
-        return false;
-    }
-
-
-    /**
-     * @param int $registrations_processed
-     * @return bool
-     * @since   $VID:$
-     */
-    private function registrationProcessingError($registrations_processed)
-    {
-        $registrations_processed = (int) $registrations_processed;
-        // 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()
-    {
-        // 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()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @return RegForm
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function generate_reg_form()
+	{
+		$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   $VID:$
+	 */
+	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   $VID:$
+	 */
+	public function registrationQuestionGroupsQueryParameters(
+		$query_params,
+		$registration
+	) {
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
+			$query_params,
+			$registration,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param RegFormQuestionGroup $question_group_reg_form
+	 * @param EE_Registration      $registration
+	 * @param EE_Question_Group    $question_group
+	 * @return mixed|void
+	 * @since   $VID:$
+	 */
+	public function registrationQuestionGroupsRegForm(
+		$question_group_reg_form,
+		$registration,
+		$question_group
+	) {
+		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   $VID:$
+	 */
+	public function registrationRegFormPrintCopyInfo(
+		$print_copy_info,
+		$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   $VID:$
+	 */
+	public function registrationRegFormRelatedQuestionsQueryParams(
+		$query_params,
+		$question_group,
+		$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   $VID:$
+	 */
+	public function registrationRegFormBeforeQuestionGroupQuestions(
+		$html,
+		$registration,
+		$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   $VID:$
+	 */
+	public function registrationRegFormSubsections(
+		$form_subsections,
+		$registration,
+		$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   $VID:$
+	 */
+	public function registrationRegFormAfterQuestionGroupQuestions(
+		$html,
+		$registration,
+		$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   $VID:$
+	 */
+	public function autoCopyAttendeeInfoTemplateArgs($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   $VID:$
+	 */
+	public function generateQuestionInputCountryOptions(
+		$country_options,
+		$registration,
+		$question,
+		$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   $VID:$
+	 */
+	public function generateQuestionInputStateOptions(
+		$state_options,
+		$registration,
+		$question,
+		$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   $VID:$
+	 */
+	private function _registrations_reg_form()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\RegForm::additionalAttendeeRegInfoInput()
+	 *
+	 * @deprecated   $VID:$
+	 */
+	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   $VID:$
+	 */
+	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   $VID:$
+	 */
+	private function _question_group_header()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\CopyAttendeeInfoForm
+	 *
+	 * @deprecated   $VID:$
+	 */
+	private function _copy_attendee_info_form()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\AutoCopyAttendeeInfoForm
+	 *
+	 * @deprecated   $VID:$
+	 */
+	private function _auto_copy_attendee_info()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\CopyAttendeeInfoForm
+	 *
+	 * @deprecated   $VID:$
+	 */
+	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   $VID:$
+	 */
+	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   $VID:$
+	 */
+	public function reg_form_question($registration, $question)
+	{
+		/** @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   $VID:$
+	 */
+	private function _generate_question_input()
+	{
+	}
+
+
+	/**
+	 * looking for hooks?
+	 * this method has been replaced by:
+	 * EventEspresso\core\domain\services\registration\form\v1\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   $VID:$
+	 */
+	public function use_cached_countries_for_form_input(
+		$countries_list = null,
+		$question = null,
+		$registration = null,
+		$answer = null
+	) {
+		/** @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\v1\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   $VID:$
+	 */
+	public function use_cached_states_for_form_input(
+		$states_list = null,
+		$question = null,
+		$registration = null,
+		$answer = null
+	) {
+		/** @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()
+	{
+		$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   $VID:$
+	 */
+	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   $VID:$
+	 */
+	public function preRegistrationProcess(
+		$bypass,
+		$attendee_count,
+		$registration,
+		$registrations,
+		$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   $VID:$
+	 */
+	public function validDataLineItem($reg_form_data, $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   $VID:$
+	 */
+	public function saveRegistrationFormInput($save, $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   $VID:$
+	 */
+	public function mergeAddressDetailsWithCriticalAttendeeDetails($merge_data)
+	{
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
+			$merge_data
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	private function inValidDataError()
+	{
+		EE_Error::add_error(
+			esc_html__('No valid question responses were received.', 'event_espresso'),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+	/**
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	private function inValidTransactionError()
+	{
+		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   $VID:$
+	 */
+	private function noRegistrationsError()
+	{
+		// 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('espresso_events') . '" >',
+			'</a>',
+			'<br />'
+		);
+		EE_Error::add_error($error_message, __FILE__, __FUNCTION__, __LINE__);
+		return false;
+	}
+
+
+	/**
+	 * @param int $registrations_processed
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	private function registrationProcessingError($registrations_processed)
+	{
+		$registrations_processed = (int) $registrations_processed;
+		// 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()
+	{
+		// 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;
+	}
 }