eventespresso / event-espresso-core

core/libraries/messages/EE_Message_Factory.lib.php

Indentation +171 added lines, -171 removed lines

@@ -15,175 +15,175 @@
 {
 
 
-    /**
-     * @type EE_Message_Factory $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
-
-
-
-    /**
-     * EE_Message_Factory constructor.
-     *
-     * @access protected
-     * @param \EE_Message_Resource_Manager $Message_Resource_Manager
-     */
-    protected function __construct(
-        EE_Message_Resource_Manager $Message_Resource_Manager
-    ) {
-        $this->_message_resource_manager = $Message_Resource_Manager;
-    }
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param \EE_Message_Resource_Manager $Message_Resource_Manager
-     * @return \EE_Message_Factory instance
-     */
-    public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager)
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Message_Factory) {
-            self::$_instance = new EE_Message_Factory($Message_Resource_Manager);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * @access public
-     * @param  array $props_n_values
-     * @return EE_Message
-     */
-    public static function create($props_n_values = array())
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_create($props_n_values);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    public static function set_messenger_and_message_type(EE_Message $message)
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_set_messenger_and_message_type($message);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    public static function set_messenger(EE_Message $message)
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_set_messenger($message);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    public static function set_message_type(EE_Message $message)
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_set_message_type($message);
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  array $props_n_values
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _create($props_n_values = array())
-    {
-        $new_instance = false;
-        if (! empty($props_n_values['MSG_ID'])) {
-            $message = EE_Message::new_instance_from_db($props_n_values);
-        } else {
-            $message = EE_Message::new_instance($props_n_values);
-            $new_instance = true;
-        }
-        return $this->_set_messenger_and_message_type($message, $new_instance);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _set_messenger_and_message_type(EE_Message $message, $new_instance = false)
-    {
-        $message = $this->_set_messenger($message);
-        $message = $this->_set_message_type($message, $new_instance);
-        return $message;
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _set_messenger(EE_Message $message)
-    {
-        $messenger = $this->_message_resource_manager->get_messenger($message->messenger());
-        if ($messenger instanceof EE_messenger) {
-            $message->set_messenger_object($messenger);
-        }
-        return $message;
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  \EE_Message $message
-     * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _set_message_type(EE_Message $message, $new_instance = false)
-    {
-        $message_type = $this->_message_resource_manager->get_message_type($message->message_type());
-        if ($message_type instanceof EE_message_type) {
-            $message->set_message_type_object($message_type, $new_instance);
-        }
-        return $message;
-    }
+	/**
+	 * @type EE_Message_Factory $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
+
+
+
+	/**
+	 * EE_Message_Factory constructor.
+	 *
+	 * @access protected
+	 * @param \EE_Message_Resource_Manager $Message_Resource_Manager
+	 */
+	protected function __construct(
+		EE_Message_Resource_Manager $Message_Resource_Manager
+	) {
+		$this->_message_resource_manager = $Message_Resource_Manager;
+	}
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param \EE_Message_Resource_Manager $Message_Resource_Manager
+	 * @return \EE_Message_Factory instance
+	 */
+	public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager)
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Message_Factory) {
+			self::$_instance = new EE_Message_Factory($Message_Resource_Manager);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  array $props_n_values
+	 * @return EE_Message
+	 */
+	public static function create($props_n_values = array())
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_create($props_n_values);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	public static function set_messenger_and_message_type(EE_Message $message)
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_messenger_and_message_type($message);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	public static function set_messenger(EE_Message $message)
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_messenger($message);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	public static function set_message_type(EE_Message $message)
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_message_type($message);
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  array $props_n_values
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _create($props_n_values = array())
+	{
+		$new_instance = false;
+		if (! empty($props_n_values['MSG_ID'])) {
+			$message = EE_Message::new_instance_from_db($props_n_values);
+		} else {
+			$message = EE_Message::new_instance($props_n_values);
+			$new_instance = true;
+		}
+		return $this->_set_messenger_and_message_type($message, $new_instance);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _set_messenger_and_message_type(EE_Message $message, $new_instance = false)
+	{
+		$message = $this->_set_messenger($message);
+		$message = $this->_set_message_type($message, $new_instance);
+		return $message;
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _set_messenger(EE_Message $message)
+	{
+		$messenger = $this->_message_resource_manager->get_messenger($message->messenger());
+		if ($messenger instanceof EE_messenger) {
+			$message->set_messenger_object($messenger);
+		}
+		return $message;
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  \EE_Message $message
+	 * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _set_message_type(EE_Message $message, $new_instance = false)
+	{
+		$message_type = $this->_message_resource_manager->get_message_type($message->message_type());
+		if ($message_type instanceof EE_message_type) {
+			$message->set_message_type_object($message_type, $new_instance);
+		}
+		return $message;
+	}
 }

core/db_models/EEM_Price_Type.model.php

Indentation +199 added lines, -199 removed lines

@@ -10,203 +10,203 @@
 class EEM_Price_Type extends EEM_Soft_Delete_Base
 {
 
-    /**
-     * @var EEM_Price_Type
-     */
-    protected static $_instance;
-
-    // An array of the price type objects
-
-    /**
-     * @var string
-     */
-    public $type;
-
-    /**
-     * Price Base types
-     * Keys are INTs which are used in the database,
-     * values are text-representations of the base type.
-     *
-     * @var string[]
-     */
-    public $base_types;
-
-
-    /**
-     * return an array of Base types.
-     *
-     * @return string[]
-     */
-    public function get_base_types(): array
-    {
-        return $this->base_types;
-    }
-
-
-    /**
-     * Gets the name of the base
-     *
-     * @param int $base_type_int
-     * @return string
-     */
-    public function get_base_type_name(int $base_type_int): string
-    {
-        return $this->base_types[ $base_type_int ];
-    }
-
-
-    /**
-     * constants for price base types. In the DB, we decided to store the price base type
-     * as an integer. So, to avoid just having magic numbers everywhere (eg, querying for
-     * all price types with PBT_ID = 2), we define these constants, to make code more understandable.
-     * So, as an example, to query for all price types that are a tax, we'd do
-     * EEM_PRice_Type::instance()->get_all(array(array('PBT_ID'=>EEM_Price_Type::base_type_tax)))
-     * instead of
-     * EEM_Price_Type::instance()->get_all(array(array('PBT_ID'=>2)))
-     * Although the 2nd is shorter, it's much less obvious what it's doing. Also, should these magic IDs ever
-     * change, we can continue to use the constant, by simply change its value.
-     */
-    const base_type_base_price = 1;
-
-    const base_type_discount   = 2;
-
-    const base_type_surcharge  = 3;
-
-    const base_type_tax        = 4;
-
-
-    /**
-     * EEM_Price_Type constructor.
-     *
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->base_types    = [
-            EEM_Price_Type::base_type_base_price => esc_html__('Price', 'event_espresso'),
-            EEM_Price_Type::base_type_discount   => esc_html__('Discount', 'event_espresso'),
-            EEM_Price_Type::base_type_surcharge  => esc_html__('Surcharge', 'event_espresso'),
-            EEM_Price_Type::base_type_tax        => esc_html__('Tax', 'event_espresso'),
-        ];
-        $this->singular_item = esc_html__('Price Type', 'event_espresso');
-        $this->plural_item   = esc_html__('Price Types', 'event_espresso');
-
-        $this->_tables          = [
-            'Price_Type' => new EE_Primary_Table('esp_price_type', 'PRT_ID'),
-        ];
-        $this->_fields          = [
-            'Price_Type' => [
-                'PRT_ID'         => new EE_Primary_Key_Int_Field(
-                    'PRT_ID',
-                    esc_html__('Price Type ID', 'event_espresso')
-                ),
-                'PRT_name'       => new EE_Plain_Text_Field(
-                    'PRT_name',
-                    esc_html__('Price Type Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'PBT_ID'         => new EE_Enum_Integer_Field(
-                    'PBT_ID',
-                    esc_html__(
-                        'Price Base type ID, 1 = Price , 2 = Discount , 3 = Surcharge , 4 = Tax',
-                        'event_espresso'
-                    ),
-                    false,
-                    EEM_Price_Type::base_type_base_price,
-                    $this->base_types
-                ),
-                'PRT_is_percent' => new EE_Boolean_Field(
-                    'PRT_is_percent',
-                    esc_html__('Flag indicating price is a percentage', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PRT_order'      => new EE_Integer_Field(
-                    'PRT_order',
-                    esc_html__('Order in which price should be applied. ', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'PRT_deleted'    => new EE_Trashed_Flag_Field(
-                    'PRT_deleted',
-                    esc_html__('Flag indicating price type has been trashed', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PRT_wp_user'    => new EE_WP_User_Field(
-                    'PRT_wp_user',
-                    esc_html__('Price Type Creator ID', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Price'   => new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        // all price types are "default" in terms of capability names
-        $this->_caps_slug = 'default_price_types';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * instantiate a new price type object with blank/empty properties
-     *
-     * @return EE_Price_Type
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_new_price_type(): EE_Price_Type
-    {
-        return EE_Price_Type::new_instance();
-    }
-
-
-    /**
-     *
-     * @param array   $query_params
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted
-     *                                if there is no related model info that blocks it
-     *                                (ie, there' sno other data that depends on this data);
-     *                                if false, deletes regardless of other objects which may depend on it.
-     *                                Its generally advisable to always leave this as TRUE,
-     *                                otherwise you could easily corrupt your DB
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_permanently($query_params = [], $allow_blocking = true): bool
-    {
-
-        $would_be_deleted_price_types    = $this->get_all_deleted_and_undeleted($query_params);
-        $would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
-
-        $ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
-
-        // check if any prices use this price type
-        $prc_query_params = [['PRT_ID' => ['IN', $would_be_deleted_price_type_ids]]];
-        if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
-            $prices_names_and_ids = [];
-            foreach ($prices as $price) {
-                /* @var $price EE_Price */
-                $prices_names_and_ids[] = $price->name() . "(" . $price->ID() . ")";
-            }
-            $msg = sprintf(
-                    esc_html__(
-                        'The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s',
-                        'event_espresso'
-                    ),
-                    implode(",", $prices_names_and_ids)
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        return parent::delete_permanently($query_params);
-    }
+	/**
+	 * @var EEM_Price_Type
+	 */
+	protected static $_instance;
+
+	// An array of the price type objects
+
+	/**
+	 * @var string
+	 */
+	public $type;
+
+	/**
+	 * Price Base types
+	 * Keys are INTs which are used in the database,
+	 * values are text-representations of the base type.
+	 *
+	 * @var string[]
+	 */
+	public $base_types;
+
+
+	/**
+	 * return an array of Base types.
+	 *
+	 * @return string[]
+	 */
+	public function get_base_types(): array
+	{
+		return $this->base_types;
+	}
+
+
+	/**
+	 * Gets the name of the base
+	 *
+	 * @param int $base_type_int
+	 * @return string
+	 */
+	public function get_base_type_name(int $base_type_int): string
+	{
+		return $this->base_types[ $base_type_int ];
+	}
+
+
+	/**
+	 * constants for price base types. In the DB, we decided to store the price base type
+	 * as an integer. So, to avoid just having magic numbers everywhere (eg, querying for
+	 * all price types with PBT_ID = 2), we define these constants, to make code more understandable.
+	 * So, as an example, to query for all price types that are a tax, we'd do
+	 * EEM_PRice_Type::instance()->get_all(array(array('PBT_ID'=>EEM_Price_Type::base_type_tax)))
+	 * instead of
+	 * EEM_Price_Type::instance()->get_all(array(array('PBT_ID'=>2)))
+	 * Although the 2nd is shorter, it's much less obvious what it's doing. Also, should these magic IDs ever
+	 * change, we can continue to use the constant, by simply change its value.
+	 */
+	const base_type_base_price = 1;
+
+	const base_type_discount   = 2;
+
+	const base_type_surcharge  = 3;
+
+	const base_type_tax        = 4;
+
+
+	/**
+	 * EEM_Price_Type constructor.
+	 *
+	 * @param string $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->base_types    = [
+			EEM_Price_Type::base_type_base_price => esc_html__('Price', 'event_espresso'),
+			EEM_Price_Type::base_type_discount   => esc_html__('Discount', 'event_espresso'),
+			EEM_Price_Type::base_type_surcharge  => esc_html__('Surcharge', 'event_espresso'),
+			EEM_Price_Type::base_type_tax        => esc_html__('Tax', 'event_espresso'),
+		];
+		$this->singular_item = esc_html__('Price Type', 'event_espresso');
+		$this->plural_item   = esc_html__('Price Types', 'event_espresso');
+
+		$this->_tables          = [
+			'Price_Type' => new EE_Primary_Table('esp_price_type', 'PRT_ID'),
+		];
+		$this->_fields          = [
+			'Price_Type' => [
+				'PRT_ID'         => new EE_Primary_Key_Int_Field(
+					'PRT_ID',
+					esc_html__('Price Type ID', 'event_espresso')
+				),
+				'PRT_name'       => new EE_Plain_Text_Field(
+					'PRT_name',
+					esc_html__('Price Type Name', 'event_espresso'),
+					false,
+					''
+				),
+				'PBT_ID'         => new EE_Enum_Integer_Field(
+					'PBT_ID',
+					esc_html__(
+						'Price Base type ID, 1 = Price , 2 = Discount , 3 = Surcharge , 4 = Tax',
+						'event_espresso'
+					),
+					false,
+					EEM_Price_Type::base_type_base_price,
+					$this->base_types
+				),
+				'PRT_is_percent' => new EE_Boolean_Field(
+					'PRT_is_percent',
+					esc_html__('Flag indicating price is a percentage', 'event_espresso'),
+					false,
+					false
+				),
+				'PRT_order'      => new EE_Integer_Field(
+					'PRT_order',
+					esc_html__('Order in which price should be applied. ', 'event_espresso'),
+					false,
+					0
+				),
+				'PRT_deleted'    => new EE_Trashed_Flag_Field(
+					'PRT_deleted',
+					esc_html__('Flag indicating price type has been trashed', 'event_espresso'),
+					false,
+					false
+				),
+				'PRT_wp_user'    => new EE_WP_User_Field(
+					'PRT_wp_user',
+					esc_html__('Price Type Creator ID', 'event_espresso'),
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Price'   => new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		// all price types are "default" in terms of capability names
+		$this->_caps_slug = 'default_price_types';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * instantiate a new price type object with blank/empty properties
+	 *
+	 * @return EE_Price_Type
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_new_price_type(): EE_Price_Type
+	{
+		return EE_Price_Type::new_instance();
+	}
+
+
+	/**
+	 *
+	 * @param array   $query_params
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted
+	 *                                if there is no related model info that blocks it
+	 *                                (ie, there' sno other data that depends on this data);
+	 *                                if false, deletes regardless of other objects which may depend on it.
+	 *                                Its generally advisable to always leave this as TRUE,
+	 *                                otherwise you could easily corrupt your DB
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_permanently($query_params = [], $allow_blocking = true): bool
+	{
+
+		$would_be_deleted_price_types    = $this->get_all_deleted_and_undeleted($query_params);
+		$would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
+
+		$ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
+
+		// check if any prices use this price type
+		$prc_query_params = [['PRT_ID' => ['IN', $would_be_deleted_price_type_ids]]];
+		if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
+			$prices_names_and_ids = [];
+			foreach ($prices as $price) {
+				/* @var $price EE_Price */
+				$prices_names_and_ids[] = $price->name() . "(" . $price->ID() . ")";
+			}
+			$msg = sprintf(
+					esc_html__(
+						'The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s',
+						'event_espresso'
+					),
+					implode(",", $prices_names_and_ids)
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		return parent::delete_permanently($query_params);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -51,7 +51,7 @@ 
      */
     public function get_base_type_name(int $base_type_int): string
     {
-        return $this->base_types[ $base_type_int ];
+        return $this->base_types[$base_type_int];
     }
 
 
@@ -83,7 +83,7 @@ 
      */
     protected function __construct(string $timezone = '')
     {
-        $this->base_types    = [
+        $this->base_types = [
             EEM_Price_Type::base_type_base_price => esc_html__('Price', 'event_espresso'),
             EEM_Price_Type::base_type_discount   => esc_html__('Discount', 'event_espresso'),
             EEM_Price_Type::base_type_surcharge  => esc_html__('Surcharge', 'event_espresso'),
@@ -147,7 +147,7 @@ 
             'WP_User' => new EE_Belongs_To_Relation(),
         ];
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         // all price types are "default" in terms of capability names
         $this->_caps_slug = 'default_price_types';
         parent::__construct($timezone);
@@ -186,7 +186,7 @@ 
         $would_be_deleted_price_types    = $this->get_all_deleted_and_undeleted($query_params);
         $would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
 
-        $ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
+        $ID = $query_params[0][$this->get_primary_key_field()->get_name()];
 
         // check if any prices use this price type
         $prc_query_params = [['PRT_ID' => ['IN', $would_be_deleted_price_type_ids]]];
@@ -194,7 +194,7 @@ 
             $prices_names_and_ids = [];
             foreach ($prices as $price) {
                 /* @var $price EE_Price */
-                $prices_names_and_ids[] = $price->name() . "(" . $price->ID() . ")";
+                $prices_names_and_ids[] = $price->name()."(".$price->ID().")";
             }
             $msg = sprintf(
                     esc_html__(

core/db_models/EEM_Term_Taxonomy.model.php

Indentation +134 added lines, -134 removed lines

@@ -10,144 +10,144 @@
 class EEM_Term_Taxonomy extends EEM_Base
 {
 
-    /**
-     * @var EEM_Term_Taxonomy
-     */
-    protected static $_instance;
+	/**
+	 * @var EEM_Term_Taxonomy
+	 */
+	protected static $_instance;
 
 
-    /**
-     * EEM_Term_Taxonomy constructor.
-     *
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Term Taxonomy', 'event_espresso');
-        $this->plural_item      = esc_html__('Term Taxonomy', 'event_espresso');
-        $this->_tables          = [
-            'Term_Taxonomy' => new EE_Primary_Table('term_taxonomy', 'term_taxonomy_id'),
-        ];
-        $this->_fields          = [
-            'Term_Taxonomy' => [
-                'term_taxonomy_id' => new EE_Primary_Key_Int_Field(
-                    'term_taxonomy_id',
-                    esc_html__('Term-Taxonomy ID', 'event_espresso')
-                ),
-                'term_id'          => new EE_Foreign_Key_Int_Field(
-                    'term_id',
-                    esc_html__("Term Id", "event_espresso"),
-                    false,
-                    0,
-                    'Term'
-                ),
-                'taxonomy'         => new EE_Plain_Text_Field(
-                    'taxonomy',
-                    esc_html__('Taxonomy Name', 'event_espresso'),
-                    false,
-                    'category'
-                ),
-                'description'      => new EE_Post_Content_Field(
-                    'description',
-                    esc_html__("Description of Term", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'parent'           => new EE_Integer_Field(
-                    'parent',
-                    esc_html__("Parent Term ID", "event_espresso"),
-                    false,
-                    0
-                ),
-                'term_count'       => new EE_Integer_Field(
-                    'count',
-                    esc_html__("Count of Objects attached", 'event_espresso'),
-                    false,
-                    0
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Term_Relationship' => new EE_Has_Many_Relation(),
-            'Term'              => new EE_Belongs_To_Relation(),
-        ];
-        $cpt_models             = array_keys(EE_Registry::instance()->cpt_models());
-        foreach ($cpt_models as $model_name) {
-            $this->_model_relations[ $model_name ] = new EE_HABTM_Relation('Term_Relationship');
-        }
-        $this->_wp_core_model                                       = true;
-        $this->_indexes                                             = [
-            'term_id_taxonomy' => new EE_Unique_Index(['term_id', 'taxonomy']),
-        ];
-        $path_to_tax_model                                          = '';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]   = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
-                                                                    = new EE_Restriction_Generator_Taxonomy_Protected(
-            $path_to_tax_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = false;
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = false;
-        // add cap restrictions for editing relating to the "ee_edit_*"
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
-            ]
-        );
-        // add cap restrictions for deleting relating to the "ee_deleting_*"
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
-            ]
-        );
-        parent::__construct($timezone);
-        add_filter('FHEE__Read__create_model_query_params', ['EEM_Term_Taxonomy', 'rest_api_query_params'], 10, 3);
-    }
+	/**
+	 * EEM_Term_Taxonomy constructor.
+	 *
+	 * @param string $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Term Taxonomy', 'event_espresso');
+		$this->plural_item      = esc_html__('Term Taxonomy', 'event_espresso');
+		$this->_tables          = [
+			'Term_Taxonomy' => new EE_Primary_Table('term_taxonomy', 'term_taxonomy_id'),
+		];
+		$this->_fields          = [
+			'Term_Taxonomy' => [
+				'term_taxonomy_id' => new EE_Primary_Key_Int_Field(
+					'term_taxonomy_id',
+					esc_html__('Term-Taxonomy ID', 'event_espresso')
+				),
+				'term_id'          => new EE_Foreign_Key_Int_Field(
+					'term_id',
+					esc_html__("Term Id", "event_espresso"),
+					false,
+					0,
+					'Term'
+				),
+				'taxonomy'         => new EE_Plain_Text_Field(
+					'taxonomy',
+					esc_html__('Taxonomy Name', 'event_espresso'),
+					false,
+					'category'
+				),
+				'description'      => new EE_Post_Content_Field(
+					'description',
+					esc_html__("Description of Term", "event_espresso"),
+					false,
+					''
+				),
+				'parent'           => new EE_Integer_Field(
+					'parent',
+					esc_html__("Parent Term ID", "event_espresso"),
+					false,
+					0
+				),
+				'term_count'       => new EE_Integer_Field(
+					'count',
+					esc_html__("Count of Objects attached", 'event_espresso'),
+					false,
+					0
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Term_Relationship' => new EE_Has_Many_Relation(),
+			'Term'              => new EE_Belongs_To_Relation(),
+		];
+		$cpt_models             = array_keys(EE_Registry::instance()->cpt_models());
+		foreach ($cpt_models as $model_name) {
+			$this->_model_relations[ $model_name ] = new EE_HABTM_Relation('Term_Relationship');
+		}
+		$this->_wp_core_model                                       = true;
+		$this->_indexes                                             = [
+			'term_id_taxonomy' => new EE_Unique_Index(['term_id', 'taxonomy']),
+		];
+		$path_to_tax_model                                          = '';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]   = new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+																	= new EE_Restriction_Generator_Taxonomy_Protected(
+			$path_to_tax_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = false;
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = false;
+		// add cap restrictions for editing relating to the "ee_edit_*"
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
+			]
+		);
+		// add cap restrictions for deleting relating to the "ee_deleting_*"
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
+			]
+		);
+		parent::__construct($timezone);
+		add_filter('FHEE__Read__create_model_query_params', ['EEM_Term_Taxonomy', 'rest_api_query_params'], 10, 3);
+	}
 
 
-    /**
-     * Makes sure that during REST API queries, we only return term-taxonomies
-     * for term taxonomies which should be shown in the rest api
-     *
-     * @param array    $model_query_params
-     * @param array    $querystring_query_params
-     * @param EEM_Base $model
-     * @return array
-     * @throws EE_Error
-     */
-    public static function rest_api_query_params(
-        array $model_query_params,
-        array $querystring_query_params,
-        EEM_Base $model
-    ): array {
-        if ($model === EEM_Term_Taxonomy::instance()) {
-            $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
-                $model_query_params[0]['taxonomy'] = ['IN', $taxonomies];
-            }
-        }
-        return $model_query_params;
-    }
+	/**
+	 * Makes sure that during REST API queries, we only return term-taxonomies
+	 * for term taxonomies which should be shown in the rest api
+	 *
+	 * @param array    $model_query_params
+	 * @param array    $querystring_query_params
+	 * @param EEM_Base $model
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function rest_api_query_params(
+		array $model_query_params,
+		array $querystring_query_params,
+		EEM_Base $model
+	): array {
+		if ($model === EEM_Term_Taxonomy::instance()) {
+			$taxonomies = get_taxonomies(['show_in_rest' => true]);
+			if (! empty($taxonomies)) {
+				$model_query_params[0]['taxonomy'] = ['IN', $taxonomies];
+			}
+		}
+		return $model_query_params;
+	}
 }
 // End of file EEM_Term_Taxonomy.model.php
 // Location: /includes/models/EEM_Term_Taxonomy.model.php

Spacing +19 added lines, -19 removed lines

@@ -72,52 +72,52 @@ 
             'Term_Relationship' => new EE_Has_Many_Relation(),
             'Term'              => new EE_Belongs_To_Relation(),
         ];
-        $cpt_models             = array_keys(EE_Registry::instance()->cpt_models());
+        $cpt_models = array_keys(EE_Registry::instance()->cpt_models());
         foreach ($cpt_models as $model_name) {
-            $this->_model_relations[ $model_name ] = new EE_HABTM_Relation('Term_Relationship');
+            $this->_model_relations[$model_name] = new EE_HABTM_Relation('Term_Relationship');
         }
         $this->_wp_core_model                                       = true;
         $this->_indexes                                             = [
             'term_id_taxonomy' => new EE_Unique_Index(['term_id', 'taxonomy']),
         ];
         $path_to_tax_model                                          = '';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]   = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+        $this->_cap_restriction_generators[EEM_Base::caps_read]   = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin]
                                                                     = new EE_Restriction_Generator_Taxonomy_Protected(
             $path_to_tax_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = false;
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = false;
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]   = false;
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = false;
         // add cap restrictions for editing relating to the "ee_edit_*"
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
+                $path_to_tax_model.'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
+                $path_to_tax_model.'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_event_type'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
+                $path_to_tax_model.'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
             ]
         );
         // add cap restrictions for deleting relating to the "ee_deleting_*"
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
+                $path_to_tax_model.'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
+                $path_to_tax_model.'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_event_type'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
+                $path_to_tax_model.'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
             ]
         );
         parent::__construct($timezone);
@@ -142,7 +142,7 @@ 
     ): array {
         if ($model === EEM_Term_Taxonomy::instance()) {
             $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
+            if ( ! empty($taxonomies)) {
                 $model_query_params[0]['taxonomy'] = ['IN', $taxonomies];
             }
         }

core/db_models/strategies/EE_Soft_Delete_Where_Conditions.strategy.php

Indentation +39 added lines, -39 removed lines

@@ -16,45 +16,45 @@
 class EE_Soft_Delete_Where_Conditions extends EE_Default_Where_Conditions
 {
 
-    /**
-     * Gets the where default where conditions for a custom post type model
-     *
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    protected function _get_default_where_conditions(): array
-    {
-        $trashed_field_name = $this->deleted_field_name();
-        return [
-            $trashed_field_name => false,
-        ];
-    }
+	/**
+	 * Gets the where default where conditions for a custom post type model
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	protected function _get_default_where_conditions(): array
+	{
+		$trashed_field_name = $this->deleted_field_name();
+		return [
+			$trashed_field_name => false,
+		];
+	}
 
 
-    /**
-     * Searches for field on the model of type 'deleted_flag'. if it is found,
-     * returns it's name.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    private function deleted_field_name(): string
-    {
-        $field = $this->_model->get_a_field_of_type('EE_Trashed_Flag_Field');
-        if ($field) {
-            return $field->get_name();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * Searches for field on the model of type 'deleted_flag'. if it is found,
+	 * returns it's name.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function deleted_field_name(): string
+	{
+		$field = $this->_model->get_a_field_of_type('EE_Trashed_Flag_Field');
+		if ($field) {
+			return $field->get_name();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
+						'event_espresso'
+					),
+					get_class($this),
+					get_class($this)
+				)
+			);
+		}
+	}
 }

core/db_models/EEM_Country.model.php

Indentation +200 added lines, -200 removed lines

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

Spacing +7 added lines, -7 removed lines

@@ -51,7 +51,7 @@ 
             'Country' => new EE_Primary_Table('esp_country', 'CNT_ISO'),
         ];
 
-        $this->_fields          = [
+        $this->_fields = [
             'Country' => [
                 'CNT_active'      => new EE_Boolean_Field(
                     'CNT_active',
@@ -149,7 +149,7 @@ 
             'Venue'    => new EE_Has_Many_Relation(),
         ];
         // only anyone to view, but only those with the default role can do anything
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
 
         parent::__construct($timezone);
     }
@@ -162,7 +162,7 @@ 
      */
     public function get_all_countries()
     {
-        if (! self::$_all_countries) {
+        if ( ! self::$_all_countries) {
             self::$_all_countries = $this->get_all(['order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
         }
         return self::$_all_countries;
@@ -180,7 +180,7 @@ 
      */
     public function get_all_active_countries()
     {
-        if (! self::$_active_countries) {
+        if ( ! self::$_active_countries) {
             self::$_active_countries =
                 $this->get_all([['CNT_active' => true], 'order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
         }
@@ -199,10 +199,10 @@ 
     public function get_country_name_by_ISO($country_ISO)
     {
         if (
-            isset(self::$_all_countries[ $country_ISO ])
-            && self::$_all_countries[ $country_ISO ] instanceof EE_Country
+            isset(self::$_all_countries[$country_ISO])
+            && self::$_all_countries[$country_ISO] instanceof EE_Country
         ) {
-            return self::$_all_countries[ $country_ISO ]->name();
+            return self::$_all_countries[$country_ISO]->name();
         }
         $names = $this->get_col([['CNT_ISO' => $country_ISO], 'limit' => 1], 'CNT_name');
         if (is_array($names) && ! empty($names)) {

core/db_models/EEM_Term.model.php

Indentation +270 added lines, -270 removed lines

@@ -13,290 +13,290 @@
 class EEM_Term extends EEM_Base
 {
 
-    /**
-     * @var EEM_Term
-     */
-    protected static $_instance;
+	/**
+	 * @var EEM_Term
+	 */
+	protected static $_instance;
 
 
-    /**
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item                                        = esc_html__('Term', 'event_espresso');
-        $this->plural_item                                          = esc_html__('Terms', 'event_espresso');
-        $this->_tables                                              = [
-            'Term' => new EE_Primary_Table('terms', 'term_id'),
-        ];
-        $this->_fields                                              = [
-            'Term' => [
-                'term_id'    => new EE_Primary_Key_Int_Field(
-                    'term_id',
-                    esc_html__('Term ID', 'event_espresso')
-                ),
-                'name'       => new EE_Plain_Text_Field(
-                    'name',
-                    esc_html__('Term Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'slug'       => new EE_Slug_Field(
-                    'slug',
-                    esc_html__('Term Slug', 'event_espresso'),
-                    false
-                ),
-                'term_group' => new EE_Integer_Field(
-                    'term_group',
-                    esc_html__("Term Group", "event_espresso"),
-                    false,
-                    0
-                ),
-            ],
-        ];
-        $this->_model_relations                                     = [
-            'Term_Taxonomy' => new EE_Has_Many_Relation(),
-        ];
-        $this->_wp_core_model                                       = true;
-        $path_to_tax_model                                          = 'Term_Taxonomy';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]   = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
-                                                                    = new EE_Restriction_Generator_Taxonomy_Protected(
-            $path_to_tax_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = false;
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = false;
-        $path_to_tax_model                                          = $path_to_tax_model . '.';
-        // add cap restrictions for editing relating to the "ee_edit_*"
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
-            ]
-        );
-        // add cap restrictions for deleting relating to the "ee_deleting_*"
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
-            ]
-        );
-        parent::__construct($timezone);
-        add_filter('FHEE__Read__create_model_query_params', ['EEM_Term', 'rest_api_query_params'], 10, 3);
-    }
+	/**
+	 * @param string $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item                                        = esc_html__('Term', 'event_espresso');
+		$this->plural_item                                          = esc_html__('Terms', 'event_espresso');
+		$this->_tables                                              = [
+			'Term' => new EE_Primary_Table('terms', 'term_id'),
+		];
+		$this->_fields                                              = [
+			'Term' => [
+				'term_id'    => new EE_Primary_Key_Int_Field(
+					'term_id',
+					esc_html__('Term ID', 'event_espresso')
+				),
+				'name'       => new EE_Plain_Text_Field(
+					'name',
+					esc_html__('Term Name', 'event_espresso'),
+					false,
+					''
+				),
+				'slug'       => new EE_Slug_Field(
+					'slug',
+					esc_html__('Term Slug', 'event_espresso'),
+					false
+				),
+				'term_group' => new EE_Integer_Field(
+					'term_group',
+					esc_html__("Term Group", "event_espresso"),
+					false,
+					0
+				),
+			],
+		];
+		$this->_model_relations                                     = [
+			'Term_Taxonomy' => new EE_Has_Many_Relation(),
+		];
+		$this->_wp_core_model                                       = true;
+		$path_to_tax_model                                          = 'Term_Taxonomy';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]   = new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+																	= new EE_Restriction_Generator_Taxonomy_Protected(
+			$path_to_tax_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = false;
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = false;
+		$path_to_tax_model                                          = $path_to_tax_model . '.';
+		// add cap restrictions for editing relating to the "ee_edit_*"
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
+			]
+		);
+		// add cap restrictions for deleting relating to the "ee_deleting_*"
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
+			]
+		);
+		parent::__construct($timezone);
+		add_filter('FHEE__Read__create_model_query_params', ['EEM_Term', 'rest_api_query_params'], 10, 3);
+	}
 
 
-    /**
-     * retrieves a list of all EE event categories
-     *
-     * @access public
-     * @param bool $show_uncategorized
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_ee_categories(bool $show_uncategorized = false): array
-    {
-        $where_params = [
-            'Term_Taxonomy.taxonomy' => 'espresso_event_categories',
-            'NOT'                    => ['name' => esc_html__('Uncategorized', 'event_espresso')],
-        ];
-        if ($show_uncategorized) {
-            unset($where_params['NOT']);
-        }
-        return EEM_Term::instance()->get_all(
-            [
-                $where_params,
-                'order_by' => ['name' => 'ASC'],
-            ]
-        );
-    }
+	/**
+	 * retrieves a list of all EE event categories
+	 *
+	 * @access public
+	 * @param bool $show_uncategorized
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_ee_categories(bool $show_uncategorized = false): array
+	{
+		$where_params = [
+			'Term_Taxonomy.taxonomy' => 'espresso_event_categories',
+			'NOT'                    => ['name' => esc_html__('Uncategorized', 'event_espresso')],
+		];
+		if ($show_uncategorized) {
+			unset($where_params['NOT']);
+		}
+		return EEM_Term::instance()->get_all(
+			[
+				$where_params,
+				'order_by' => ['name' => 'ASC'],
+			]
+		);
+	}
 
 
-    /**
-     * retrieves a list of all post_tags associated with an EE CPT
-     *
-     * @access public
-     * @param string $post_type
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_CPT_post_tags(string $post_type = ''): array
-    {
-        switch ($post_type) {
-            case 'espresso_events':
-                return $this->get_all_event_post_tags();
-            case 'espresso_venues':
-                return $this->get_all_venue_post_tags();
-            default:
-                $event_tags = $this->get_all_event_post_tags();
-                $venue_tags = $this->get_all_venue_post_tags();
-                return array_merge($event_tags, $venue_tags);
-        }
-    }
+	/**
+	 * retrieves a list of all post_tags associated with an EE CPT
+	 *
+	 * @access public
+	 * @param string $post_type
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_CPT_post_tags(string $post_type = ''): array
+	{
+		switch ($post_type) {
+			case 'espresso_events':
+				return $this->get_all_event_post_tags();
+			case 'espresso_venues':
+				return $this->get_all_venue_post_tags();
+			default:
+				$event_tags = $this->get_all_event_post_tags();
+				$venue_tags = $this->get_all_venue_post_tags();
+				return array_merge($event_tags, $venue_tags);
+		}
+	}
 
 
-    /**
-     * returns an EE_Term object for the given tag
-     * if it has been utilized by any EE_Events or EE_Venues
-     *
-     * @param string $tag
-     * @return EE_Term|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_post_tag_for_event_or_venue(string $tag): ?EE_Term
-    {
-        $post_tag_results = $this->get_all_wpdb_results(
-            [
-                [
-                    'slug'                   => $tag,
-                    'Term_Taxonomy.taxonomy' => 'post_tag',
-                    'OR'                     => [
-                        'Term_Taxonomy.Venue.post_type' => 'espresso_venues',
-                        'Term_Taxonomy.Event.post_type' => 'espresso_events',
-                    ],
-                ],
-                'default_where_conditions' => 'none',
-                'extra_selects'            => [
-                    'event_post_type' => ['Term_Taxonomy___Event_CPT.post_type', '%s'],
-                    'venue_post_type' => ['Term_Taxonomy___Venue_CPT.post_type', '%s'],
-                ],
-                'group_by'                 => [
-                    'event_post_type',
-                    'venue_post_type',
-                ],
-                'limit'                    => 2,
-            ]
-        );
+	/**
+	 * returns an EE_Term object for the given tag
+	 * if it has been utilized by any EE_Events or EE_Venues
+	 *
+	 * @param string $tag
+	 * @return EE_Term|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_post_tag_for_event_or_venue(string $tag): ?EE_Term
+	{
+		$post_tag_results = $this->get_all_wpdb_results(
+			[
+				[
+					'slug'                   => $tag,
+					'Term_Taxonomy.taxonomy' => 'post_tag',
+					'OR'                     => [
+						'Term_Taxonomy.Venue.post_type' => 'espresso_venues',
+						'Term_Taxonomy.Event.post_type' => 'espresso_events',
+					],
+				],
+				'default_where_conditions' => 'none',
+				'extra_selects'            => [
+					'event_post_type' => ['Term_Taxonomy___Event_CPT.post_type', '%s'],
+					'venue_post_type' => ['Term_Taxonomy___Venue_CPT.post_type', '%s'],
+				],
+				'group_by'                 => [
+					'event_post_type',
+					'venue_post_type',
+				],
+				'limit'                    => 2,
+			]
+		);
 
-        $post_types = [];
-        foreach ((array) $post_tag_results as $row) {
-            if ($row['event_post_type'] === 'espresso_events') {
-                $post_types[] = EEM_Event::instance()->post_type();
-            } elseif ($row['venue_post_type'] === 'espresso_venues') {
-                $post_types[] = EEM_Venue::instance()->post_type();
-            }
-        }
-        $post_tag_row = reset($post_tag_results);
-        $post_tag     = $this->instantiate_class_from_array_or_object($post_tag_row);
-        if (! $post_tag instanceof EE_Term) {
-            return null;
-        }
+		$post_types = [];
+		foreach ((array) $post_tag_results as $row) {
+			if ($row['event_post_type'] === 'espresso_events') {
+				$post_types[] = EEM_Event::instance()->post_type();
+			} elseif ($row['venue_post_type'] === 'espresso_venues') {
+				$post_types[] = EEM_Venue::instance()->post_type();
+			}
+		}
+		$post_tag_row = reset($post_tag_results);
+		$post_tag     = $this->instantiate_class_from_array_or_object($post_tag_row);
+		if (! $post_tag instanceof EE_Term) {
+			return null;
+		}
 
-        if ($post_tag->post_type === null) {
-            $post_tag->post_type = [];
-        }
-        $post_tag->post_type = array_merge($post_tag->post_type, array_unique($post_types));
-        return $post_tag;
-    }
+		if ($post_tag->post_type === null) {
+			$post_tag->post_type = [];
+		}
+		$post_tag->post_type = array_merge($post_tag->post_type, array_unique($post_types));
+		return $post_tag;
+	}
 
 
-    /**
-     * get_all_event_post_tags
-     *
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_event_post_tags(): array
-    {
-        $post_tags = EEM_Term::instance()->get_all(
-            [
-                [
-                    'Term_Taxonomy.taxonomy'        => 'post_tag',
-                    'Term_Taxonomy.Event.post_type' => 'espresso_events',
-                ],
-                'order_by'   => ['name' => 'ASC'],
-                'force_join' => ['Term_Taxonomy.Event'],
-            ]
-        );
-        foreach ($post_tags as $key => $post_tag) {
-            if (! isset($post_tag->post_type)) {
-                $post_tag->post_type = [];
-            }
-            $post_tag->post_type[] = 'espresso_events';
-            $post_tags[ $key ]     = $post_tag;
-        }
-        return $post_tags;
-    }
+	/**
+	 * get_all_event_post_tags
+	 *
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_event_post_tags(): array
+	{
+		$post_tags = EEM_Term::instance()->get_all(
+			[
+				[
+					'Term_Taxonomy.taxonomy'        => 'post_tag',
+					'Term_Taxonomy.Event.post_type' => 'espresso_events',
+				],
+				'order_by'   => ['name' => 'ASC'],
+				'force_join' => ['Term_Taxonomy.Event'],
+			]
+		);
+		foreach ($post_tags as $key => $post_tag) {
+			if (! isset($post_tag->post_type)) {
+				$post_tag->post_type = [];
+			}
+			$post_tag->post_type[] = 'espresso_events';
+			$post_tags[ $key ]     = $post_tag;
+		}
+		return $post_tags;
+	}
 
 
-    /**
-     * get_all_venue_post_tags
-     *
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_venue_post_tags(): array
-    {
-        $post_tags = EEM_Term::instance()->get_all(
-            [
-                [
-                    'Term_Taxonomy.taxonomy'        => 'post_tag',
-                    'Term_Taxonomy.Venue.post_type' => 'espresso_venues',
-                ],
-                'order_by'   => ['name' => 'ASC'],
-                'force_join' => ['Term_Taxonomy'],
-            ]
-        );
-        foreach ($post_tags as $key => $post_tag) {
-            if (! isset($post_tag->post_type)) {
-                $post_tag->post_type = [];
-            }
-            $post_tag->post_type[] = 'espresso_venues';
-            $post_tags[ $key ]     = $post_tag;
-        }
-        return $post_tags;
-    }
+	/**
+	 * get_all_venue_post_tags
+	 *
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_venue_post_tags(): array
+	{
+		$post_tags = EEM_Term::instance()->get_all(
+			[
+				[
+					'Term_Taxonomy.taxonomy'        => 'post_tag',
+					'Term_Taxonomy.Venue.post_type' => 'espresso_venues',
+				],
+				'order_by'   => ['name' => 'ASC'],
+				'force_join' => ['Term_Taxonomy'],
+			]
+		);
+		foreach ($post_tags as $key => $post_tag) {
+			if (! isset($post_tag->post_type)) {
+				$post_tag->post_type = [];
+			}
+			$post_tag->post_type[] = 'espresso_venues';
+			$post_tags[ $key ]     = $post_tag;
+		}
+		return $post_tags;
+	}
 
 
-    /**
-     * Makes sure that during REST API queries, we only return terms
-     * for term taxonomies which should be shown in the rest api
-     *
-     * @param array    $model_query_params
-     * @param array    $querystring_query_params
-     * @param EEM_Base $model
-     * @return array
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public static function rest_api_query_params(
-        array $model_query_params,
-        array $querystring_query_params,
-        EEM_Base $model
-    ): array {
-        if ($model === EEM_Term::instance()) {
-            $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
-                $model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
-            }
-        }
-        return $model_query_params;
-    }
+	/**
+	 * Makes sure that during REST API queries, we only return terms
+	 * for term taxonomies which should be shown in the rest api
+	 *
+	 * @param array    $model_query_params
+	 * @param array    $querystring_query_params
+	 * @param EEM_Base $model
+	 * @return array
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public static function rest_api_query_params(
+		array $model_query_params,
+		array $querystring_query_params,
+		EEM_Base $model
+	): array {
+		if ($model === EEM_Term::instance()) {
+			$taxonomies = get_taxonomies(['show_in_rest' => true]);
+			if (! empty($taxonomies)) {
+				$model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
+			}
+		}
+		return $model_query_params;
+	}
 }

Spacing +23 added lines, -23 removed lines

@@ -60,44 +60,44 @@ 
         ];
         $this->_wp_core_model                                       = true;
         $path_to_tax_model                                          = 'Term_Taxonomy';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]   = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+        $this->_cap_restriction_generators[EEM_Base::caps_read]   = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin]
                                                                     = new EE_Restriction_Generator_Taxonomy_Protected(
             $path_to_tax_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = false;
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = false;
-        $path_to_tax_model                                          = $path_to_tax_model . '.';
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]   = false;
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = false;
+        $path_to_tax_model                                          = $path_to_tax_model.'.';
         // add cap restrictions for editing relating to the "ee_edit_*"
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
+                $path_to_tax_model.'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
+                $path_to_tax_model.'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_event_type'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
+                $path_to_tax_model.'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
             ]
         );
         // add cap restrictions for deleting relating to the "ee_deleting_*"
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
+                $path_to_tax_model.'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
+                $path_to_tax_model.'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_event_type'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
+                $path_to_tax_model.'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
             ]
         );
         parent::__construct($timezone);
@@ -203,7 +203,7 @@ 
         }
         $post_tag_row = reset($post_tag_results);
         $post_tag     = $this->instantiate_class_from_array_or_object($post_tag_row);
-        if (! $post_tag instanceof EE_Term) {
+        if ( ! $post_tag instanceof EE_Term) {
             return null;
         }
 
@@ -235,11 +235,11 @@ 
             ]
         );
         foreach ($post_tags as $key => $post_tag) {
-            if (! isset($post_tag->post_type)) {
+            if ( ! isset($post_tag->post_type)) {
                 $post_tag->post_type = [];
             }
             $post_tag->post_type[] = 'espresso_events';
-            $post_tags[ $key ]     = $post_tag;
+            $post_tags[$key]     = $post_tag;
         }
         return $post_tags;
     }
@@ -265,11 +265,11 @@ 
             ]
         );
         foreach ($post_tags as $key => $post_tag) {
-            if (! isset($post_tag->post_type)) {
+            if ( ! isset($post_tag->post_type)) {
                 $post_tag->post_type = [];
             }
             $post_tag->post_type[] = 'espresso_venues';
-            $post_tags[ $key ]     = $post_tag;
+            $post_tags[$key]     = $post_tag;
         }
         return $post_tags;
     }
@@ -293,7 +293,7 @@ 
     ): array {
         if ($model === EEM_Term::instance()) {
             $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
+            if ( ! empty($taxonomies)) {
                 $model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
             }
         }

core/db_models/EEM_Payment_Method.model.php

Indentation +461 added lines, -461 removed lines

@@ -17,465 +17,465 @@
 class EEM_Payment_Method extends EEM_Base
 {
 
-    const scope_cart  = 'CART';
-
-    const scope_admin = 'ADMIN';
-
-    const scope_api   = 'API';
-
-    /**
-     * @type EEM_Payment_Method
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Payment Method', 'event_espresso');
-        $this->plural_item      = esc_html__('Payment Methods', 'event_espresso');
-        $this->_tables          = [
-            'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'),
-        ];
-        $this->_fields          = [
-            'Payment_Method' => [
-                'PMD_ID'              => new EE_Primary_Key_Int_Field(
-                    'PMD_ID',
-                    esc_html__('ID', 'event_espresso')
-                ),
-                'PMD_type'            => new EE_Plain_Text_Field(
-                    'PMD_type',
-                    esc_html__('Payment Method Type', 'event_espresso'),
-                    false,
-                    'Admin_Only'
-                ),
-                'PMD_name'            => new EE_Plain_Text_Field(
-                    'PMD_name',
-                    esc_html__('Name', 'event_espresso'),
-                    false
-                ),
-                'PMD_desc'            => new EE_Post_Content_Field(
-                    'PMD_desc',
-                    esc_html__('Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'PMD_admin_name'      => new EE_Plain_Text_Field(
-                    'PMD_admin_name',
-                    esc_html__('Admin-Only Name', 'event_espresso'),
-                    true
-                ),
-                'PMD_admin_desc'      => new EE_Post_Content_Field(
-                    'PMD_admin_desc',
-                    esc_html__('Admin-Only Description', 'event_espresso'),
-                    true
-                ),
-                'PMD_slug'            => new EE_Slug_Field(
-                    'PMD_slug',
-                    esc_html__('Slug', 'event_espresso'),
-                    false
-                ),
-                'PMD_order'           => new EE_Integer_Field(
-                    'PMD_order',
-                    esc_html__('Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'PMD_debug_mode'      => new EE_Boolean_Field(
-                    'PMD_debug_mode',
-                    esc_html__('Debug Mode On?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PMD_wp_user'         => new EE_WP_User_Field(
-                    'PMD_wp_user',
-                    esc_html__('Payment Method Creator ID', 'event_espresso'),
-                    false
-                ),
-                'PMD_open_by_default' => new EE_Boolean_Field(
-                    'PMD_open_by_default',
-                    esc_html__('Open by Default?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PMD_button_url'      => new EE_Plain_Text_Field(
-                    'PMD_button_url',
-                    esc_html__('Button URL', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'PMD_scope'           => new EE_Serialized_Text_Field(
-                    'PMD_scope',
-                    esc_html__('Usable From?', 'event_espresso'),
-                    false,
-                    []// possible values currently are 'CART','ADMIN','API'
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Payment'     => new EE_Has_Many_Relation(),
-            'Currency'    => new EE_HABTM_Relation('Currency_Payment_Method'),
-            'Transaction' => new EE_Has_Many_Relation(),
-            'WP_User'     => new EE_Belongs_To_Relation(),
-        ];
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets one by the slug provided
-     *
-     * @param string $slug
-     * @return EE_Payment_Method|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one_by_slug(string $slug): ?EE_Payment_Method
-    {
-        return $this->get_one([['PMD_slug' => $slug]]);
-    }
-
-
-    /**
-     * Gets all the acceptable scopes for payment methods.
-     * Keys are their names as store din the DB, and values are nice names for displaying them
-     *
-     * @return array
-     */
-    public function scopes(): array
-    {
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__scopes',
-            [
-                EEM_Payment_Method::scope_cart  => esc_html__('Front-end Registration Page', 'event_espresso'),
-                EEM_Payment_Method::scope_admin => esc_html__(
-                    'Admin Registration Page (no online processing)',
-                    'event_espresso'
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * Determines if this is an valid scope
-     *
-     * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
-     * @return boolean
-     */
-    public function is_valid_scope(string $scope): bool
-    {
-        $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets all active payment methods
-     *
-     * @param string $scope one of
-     * @param array  $query_params
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_active(string $scope = '', array $query_params = []): array
-    {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
-        }
-        return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Counts all active gateways in the specified scope
-     *
-     * @param string $scope one of EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function count_active(string $scope = '', array $query_params = []): int
-    {
-        return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     *
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _get_query_params_for_all_active(string $scope = '', array $query_params = []): array
-    {
-        if (! empty($scope)) {
-            if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive([['PMD_scope' => ['LIKE', "%$scope%"]]], $query_params);
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("'%s' is not a valid scope for a payment method", 'event_espresso'),
-                    $scope
-                )
-            );
-        }
-        $acceptable_scopes = [];
-        $count             = 0;
-        foreach ($this->scopes() as $scope_name => $desc) {
-            $count++;
-            $acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
-        }
-        return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
-    }
-
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     *
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_query_params_for_all_active(string $scope = '', array $query_params = []): array
-    {
-        return $this->_get_query_params_for_all_active($scope, $query_params);
-    }
-
-
-    /**
-     * Gets one active payment method. see @get_all_active for documentation
-     *
-     * @param string $scope
-     * @param array  $query_params
-     * @return EE_Payment_Method|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one_active(string $scope = '', array $query_params = []): ?EE_Payment_Method
-    {
-        return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Gets one payment method of that type, regardless of whether its active or not
-     *
-     * @param string $type
-     * @return EE_Payment_Method|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one_of_type(string $type): ?EE_Payment_Method
-    {
-        return $this->get_one([['PMD_type' => $type]]);
-    }
-
-
-    /**
-     * Overrides parent to also check by the slug
-     *
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
-     * @param boolean                      $ensure_is_in_db
-     * @return EE_Payment_Method|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see EEM_Base::ensure_is_obj()
-     */
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false): ?EE_Payment_Method
-    {
-        // first: check if it's a slug
-        if (is_string($base_class_obj_or_id)) {
-            $obj = $this->get_one_by_slug($base_class_obj_or_id);
-            if ($obj) {
-                return $obj;
-            }
-        }
-        // ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
-        try {
-            return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
-        } catch (EE_Error $e) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("'%s' is neither a Payment Method ID, slug, nor object: %s", 'event_espresso'),
-                    $base_class_obj_or_id,
-                    $e->getMessage()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Gets the ID of this object, or if its a string finds the object's id
-     * associated with that slug
-     *
-     * @param int|string $base_obj_or_id_or_slug
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ensure_is_ID($base_obj_or_id_or_slug): int
-    {
-        if (is_string($base_obj_or_id_or_slug)) {
-            // assume it's a slug
-            $base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
-        }
-        return parent::ensure_is_ID($base_obj_or_id_or_slug);
-    }
-
-
-    /**
-     * Verifies the button urls on all the passed payment methods have a valid button url.
-     * If not, resets them to their default.
-     *
-     * @param EE_Payment_Method[]|null $payment_methods if NULL, defaults to all payment methods active in the cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function verify_button_urls(array $payment_methods = [])
-    {
-        $payment_methods = ! empty($payment_methods) && is_array($payment_methods)
-            ? $payment_methods
-            : $this->get_all_active(EEM_Payment_Method::scope_cart);
-        foreach ($payment_methods as $payment_method) {
-            try {
-                // If there is really no button URL at all, or if the button URLs still point to decaf folder even
-                // though this is a caffeinated install, reset it to the default.
-                $current_button_url = $payment_method->button_url();
-                if (
-                    empty($current_button_url)
-                    || (
-                        strpos($current_button_url, 'decaf') !== false
-                        && strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
-                    )
-                ) {
-                    $payment_method->save(
-                        [
-                            'PMD_button_url' => $payment_method->type_obj()->default_button_url(),
-                        ]
-                    );
-                }
-            } catch (EE_Error $e) {
-                $payment_method->deactivate();
-            }
-        }
-    }
-
-
-    /**
-     * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
-     * but also verifies the payment method type of each is a usable object. If not,
-     * deactivate it, sets a notification, and deactivates it
-     *
-     * @param array $rows
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    protected function _create_objects($rows = []): array
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_methods = parent::_create_objects($rows);
-        /* @var $payment_methods EE_Payment_Method[] */
-        $usable_payment_methods = [];
-        foreach ($payment_methods as $key => $payment_method) {
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
-                // some payment methods enqueue their scripts in EE_PMT_*::__construct
-                // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
-                // its scripts). but for backwards-compat we should continue to do that
-                $payment_method->type_obj();
-            } elseif ($payment_method->active()) {
-                // only deactivate and notify the admin if the payment is active somewhere
-                $payment_method->deactivate();
-                $payment_method->save();
-                do_action(
-                    'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
-                    $payment_method
-                );
-                new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
-                    sprintf(
-                        esc_html__(
-                            'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
-                            'event_espresso'
-                        ),
-                        $payment_method->admin_name(),
-                        '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
-                        '</a>'
-                    ),
-                    true
-                );
-            }
-        }
-        return $usable_payment_methods;
-    }
-
-
-    /**
-     * Gets all the payment methods which can be used for transaction
-     * (according to the relations between payment methods and events, and
-     * the currencies used for the transaction and their relation to payment methods)
-     *
-     * @param EE_Transaction $transaction
-     * @param string         $scope @see EEM_Payment_Method::get_all_for_events
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_for_transaction(EE_Transaction $transaction, string $scope): array
-    {
-        // give addons a chance to override what payment methods are chosen based on the transaction
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, ['group_by' => 'PMD_type']),
-            $transaction,
-            $scope
-        );
-    }
-
-
-    /**
-     * Returns the payment method used for the last payment made for a registration.
-     * Note: if an offline payment method was selected on the related transaction then this will have no payment
-     * methods returned. It will ONLY return a payment method for a PAYMENT recorded against the registration.
-     *
-     * @param EE_Registration|int $registration_or_reg_id Either the EE_Registration object or the id for the
-     *                                                    registration.
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_last_used_for_registration($registration_or_reg_id): ?EE_Payment
-    {
-        $registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
-
-        $query_params = [
-            0          => [
-                'Payment.Registration.REG_ID' => $registration_id,
-            ],
-            'order_by' => ['Payment.PAY_ID' => 'DESC'],
-        ];
-        return $this->get_one($query_params);
-    }
+	const scope_cart  = 'CART';
+
+	const scope_admin = 'ADMIN';
+
+	const scope_api   = 'API';
+
+	/**
+	 * @type EEM_Payment_Method
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Payment Method', 'event_espresso');
+		$this->plural_item      = esc_html__('Payment Methods', 'event_espresso');
+		$this->_tables          = [
+			'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'),
+		];
+		$this->_fields          = [
+			'Payment_Method' => [
+				'PMD_ID'              => new EE_Primary_Key_Int_Field(
+					'PMD_ID',
+					esc_html__('ID', 'event_espresso')
+				),
+				'PMD_type'            => new EE_Plain_Text_Field(
+					'PMD_type',
+					esc_html__('Payment Method Type', 'event_espresso'),
+					false,
+					'Admin_Only'
+				),
+				'PMD_name'            => new EE_Plain_Text_Field(
+					'PMD_name',
+					esc_html__('Name', 'event_espresso'),
+					false
+				),
+				'PMD_desc'            => new EE_Post_Content_Field(
+					'PMD_desc',
+					esc_html__('Description', 'event_espresso'),
+					false,
+					''
+				),
+				'PMD_admin_name'      => new EE_Plain_Text_Field(
+					'PMD_admin_name',
+					esc_html__('Admin-Only Name', 'event_espresso'),
+					true
+				),
+				'PMD_admin_desc'      => new EE_Post_Content_Field(
+					'PMD_admin_desc',
+					esc_html__('Admin-Only Description', 'event_espresso'),
+					true
+				),
+				'PMD_slug'            => new EE_Slug_Field(
+					'PMD_slug',
+					esc_html__('Slug', 'event_espresso'),
+					false
+				),
+				'PMD_order'           => new EE_Integer_Field(
+					'PMD_order',
+					esc_html__('Order', 'event_espresso'),
+					false,
+					0
+				),
+				'PMD_debug_mode'      => new EE_Boolean_Field(
+					'PMD_debug_mode',
+					esc_html__('Debug Mode On?', 'event_espresso'),
+					false,
+					false
+				),
+				'PMD_wp_user'         => new EE_WP_User_Field(
+					'PMD_wp_user',
+					esc_html__('Payment Method Creator ID', 'event_espresso'),
+					false
+				),
+				'PMD_open_by_default' => new EE_Boolean_Field(
+					'PMD_open_by_default',
+					esc_html__('Open by Default?', 'event_espresso'),
+					false,
+					false
+				),
+				'PMD_button_url'      => new EE_Plain_Text_Field(
+					'PMD_button_url',
+					esc_html__('Button URL', 'event_espresso'),
+					true,
+					''
+				),
+				'PMD_scope'           => new EE_Serialized_Text_Field(
+					'PMD_scope',
+					esc_html__('Usable From?', 'event_espresso'),
+					false,
+					[]// possible values currently are 'CART','ADMIN','API'
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Payment'     => new EE_Has_Many_Relation(),
+			'Currency'    => new EE_HABTM_Relation('Currency_Payment_Method'),
+			'Transaction' => new EE_Has_Many_Relation(),
+			'WP_User'     => new EE_Belongs_To_Relation(),
+		];
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets one by the slug provided
+	 *
+	 * @param string $slug
+	 * @return EE_Payment_Method|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one_by_slug(string $slug): ?EE_Payment_Method
+	{
+		return $this->get_one([['PMD_slug' => $slug]]);
+	}
+
+
+	/**
+	 * Gets all the acceptable scopes for payment methods.
+	 * Keys are their names as store din the DB, and values are nice names for displaying them
+	 *
+	 * @return array
+	 */
+	public function scopes(): array
+	{
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__scopes',
+			[
+				EEM_Payment_Method::scope_cart  => esc_html__('Front-end Registration Page', 'event_espresso'),
+				EEM_Payment_Method::scope_admin => esc_html__(
+					'Admin Registration Page (no online processing)',
+					'event_espresso'
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * Determines if this is an valid scope
+	 *
+	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
+	 * @return boolean
+	 */
+	public function is_valid_scope(string $scope): bool
+	{
+		$scopes = $this->scopes();
+		if (isset($scopes[ $scope ])) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets all active payment methods
+	 *
+	 * @param string $scope one of
+	 * @param array  $query_params
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_active(string $scope = '', array $query_params = []): array
+	{
+		if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
+		}
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Counts all active gateways in the specified scope
+	 *
+	 * @param string $scope one of EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function count_active(string $scope = '', array $query_params = []): int
+	{
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 *
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _get_query_params_for_all_active(string $scope = '', array $query_params = []): array
+	{
+		if (! empty($scope)) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive([['PMD_scope' => ['LIKE', "%$scope%"]]], $query_params);
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__("'%s' is not a valid scope for a payment method", 'event_espresso'),
+					$scope
+				)
+			);
+		}
+		$acceptable_scopes = [];
+		$count             = 0;
+		foreach ($this->scopes() as $scope_name => $desc) {
+			$count++;
+			$acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
+		}
+		return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
+	}
+
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 *
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_query_params_for_all_active(string $scope = '', array $query_params = []): array
+	{
+		return $this->_get_query_params_for_all_active($scope, $query_params);
+	}
+
+
+	/**
+	 * Gets one active payment method. see @get_all_active for documentation
+	 *
+	 * @param string $scope
+	 * @param array  $query_params
+	 * @return EE_Payment_Method|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one_active(string $scope = '', array $query_params = []): ?EE_Payment_Method
+	{
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Gets one payment method of that type, regardless of whether its active or not
+	 *
+	 * @param string $type
+	 * @return EE_Payment_Method|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one_of_type(string $type): ?EE_Payment_Method
+	{
+		return $this->get_one([['PMD_type' => $type]]);
+	}
+
+
+	/**
+	 * Overrides parent to also check by the slug
+	 *
+	 * @param string|int|EE_Payment_Method $base_class_obj_or_id
+	 * @param boolean                      $ensure_is_in_db
+	 * @return EE_Payment_Method|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see EEM_Base::ensure_is_obj()
+	 */
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false): ?EE_Payment_Method
+	{
+		// first: check if it's a slug
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
+				return $obj;
+			}
+		}
+		// ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
+		try {
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
+		} catch (EE_Error $e) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("'%s' is neither a Payment Method ID, slug, nor object: %s", 'event_espresso'),
+					$base_class_obj_or_id,
+					$e->getMessage()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Gets the ID of this object, or if its a string finds the object's id
+	 * associated with that slug
+	 *
+	 * @param int|string $base_obj_or_id_or_slug
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ensure_is_ID($base_obj_or_id_or_slug): int
+	{
+		if (is_string($base_obj_or_id_or_slug)) {
+			// assume it's a slug
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
+		}
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
+	}
+
+
+	/**
+	 * Verifies the button urls on all the passed payment methods have a valid button url.
+	 * If not, resets them to their default.
+	 *
+	 * @param EE_Payment_Method[]|null $payment_methods if NULL, defaults to all payment methods active in the cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function verify_button_urls(array $payment_methods = [])
+	{
+		$payment_methods = ! empty($payment_methods) && is_array($payment_methods)
+			? $payment_methods
+			: $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
+			try {
+				// If there is really no button URL at all, or if the button URLs still point to decaf folder even
+				// though this is a caffeinated install, reset it to the default.
+				$current_button_url = $payment_method->button_url();
+				if (
+					empty($current_button_url)
+					|| (
+						strpos($current_button_url, 'decaf') !== false
+						&& strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
+					)
+				) {
+					$payment_method->save(
+						[
+							'PMD_button_url' => $payment_method->type_obj()->default_button_url(),
+						]
+					);
+				}
+			} catch (EE_Error $e) {
+				$payment_method->deactivate();
+			}
+		}
+	}
+
+
+	/**
+	 * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
+	 * but also verifies the payment method type of each is a usable object. If not,
+	 * deactivate it, sets a notification, and deactivates it
+	 *
+	 * @param array $rows
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	protected function _create_objects($rows = []): array
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_methods = parent::_create_objects($rows);
+		/* @var $payment_methods EE_Payment_Method[] */
+		$usable_payment_methods = [];
+		foreach ($payment_methods as $key => $payment_method) {
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
+				$usable_payment_methods[ $key ] = $payment_method;
+				// some payment methods enqueue their scripts in EE_PMT_*::__construct
+				// which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
+				// its scripts). but for backwards-compat we should continue to do that
+				$payment_method->type_obj();
+			} elseif ($payment_method->active()) {
+				// only deactivate and notify the admin if the payment is active somewhere
+				$payment_method->deactivate();
+				$payment_method->save();
+				do_action(
+					'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
+					$payment_method
+				);
+				new PersistentAdminNotice(
+					'auto-deactivated-' . $payment_method->type(),
+					sprintf(
+						esc_html__(
+							'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
+							'event_espresso'
+						),
+						$payment_method->admin_name(),
+						'<br />',
+						'<a href="' . admin_url('plugins.php') . '">',
+						'</a>'
+					),
+					true
+				);
+			}
+		}
+		return $usable_payment_methods;
+	}
+
+
+	/**
+	 * Gets all the payment methods which can be used for transaction
+	 * (according to the relations between payment methods and events, and
+	 * the currencies used for the transaction and their relation to payment methods)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param string         $scope @see EEM_Payment_Method::get_all_for_events
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_for_transaction(EE_Transaction $transaction, string $scope): array
+	{
+		// give addons a chance to override what payment methods are chosen based on the transaction
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+			$this->get_all_active($scope, ['group_by' => 'PMD_type']),
+			$transaction,
+			$scope
+		);
+	}
+
+
+	/**
+	 * Returns the payment method used for the last payment made for a registration.
+	 * Note: if an offline payment method was selected on the related transaction then this will have no payment
+	 * methods returned. It will ONLY return a payment method for a PAYMENT recorded against the registration.
+	 *
+	 * @param EE_Registration|int $registration_or_reg_id Either the EE_Registration object or the id for the
+	 *                                                    registration.
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_last_used_for_registration($registration_or_reg_id): ?EE_Payment
+	{
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
+
+		$query_params = [
+			0          => [
+				'Payment.Registration.REG_ID' => $registration_id,
+			],
+			'order_by' => ['Payment.PAY_ID' => 'DESC'],
+		];
+		return $this->get_one($query_params);
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -171,7 +171,7 @@ 
     public function is_valid_scope(string $scope): bool
     {
         $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
+        if (isset($scopes[$scope])) {
             return true;
         }
         return false;
@@ -189,7 +189,7 @@ 
      */
     public function get_all_active(string $scope = '', array $query_params = []): array
     {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+        if ( ! isset($query_params['order_by']) && ! isset($query_params['order'])) {
             $query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
         }
         return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
@@ -223,7 +223,7 @@ 
      */
     protected function _get_query_params_for_all_active(string $scope = '', array $query_params = []): array
     {
-        if (! empty($scope)) {
+        if ( ! empty($scope)) {
             if ($this->is_valid_scope($scope)) {
                 return array_replace_recursive([['PMD_scope' => ['LIKE', "%$scope%"]]], $query_params);
             }
@@ -238,7 +238,7 @@ 
         $count             = 0;
         foreach ($this->scopes() as $scope_name => $desc) {
             $count++;
-            $acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
+            $acceptable_scopes['PMD_scope*'.$count] = ['LIKE', '%'.$scope_name.'%'];
         }
         return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
     }
@@ -399,7 +399,7 @@ 
         $usable_payment_methods = [];
         foreach ($payment_methods as $key => $payment_method) {
             if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
+                $usable_payment_methods[$key] = $payment_method;
                 // some payment methods enqueue their scripts in EE_PMT_*::__construct
                 // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
                 // its scripts). but for backwards-compat we should continue to do that
@@ -413,7 +413,7 @@ 
                     $payment_method
                 );
                 new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
+                    'auto-deactivated-'.$payment_method->type(),
                     sprintf(
                         esc_html__(
                             'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
@@ -421,7 +421,7 @@ 
                         ),
                         $payment_method->admin_name(),
                         '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
+                        '<a href="'.admin_url('plugins.php').'">',
                         '</a>'
                     ),
                     true

core/db_models/EEM_System_Status.model.php

Indentation +388 added lines, -388 removed lines

@@ -6,392 +6,392 @@
 class EEM_System_Status
 {
 
-    /**
-     * @var EEM_System_Status
-     */
-    protected static $_instance;
-
-
-    /**
-     * This function is a singleton method used to instantiate the EEM_Attendee object
-     *
-     * @return EEM_System_Status
-     */
-    public static function instance(): EEM_System_Status
-    {
-
-        // check if instance of EEM_System_Status already exists
-        if (self::$_instance === null) {
-            // instantiate EEM_System_Status
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    private function __construct()
-    {
-    }
-
-
-    /**
-     * @return array where each key is a function name on this class, and each value is SOMETHING--
-     * it might be a value, an array, or an object
-     */
-    public function get_system_stati(): array
-    {
-        return apply_filters(
-            'FHEE__EEM_System_Status__get_system_stati',
-            [
-                'ee_version'            => $this->get_ee_version(),
-                'ee_activation_history' => $this->get_ee_activation_history(),
-                'ee_config'             => $this->get_ee_config(),
-                'ee_migration_history'  => $this->get_ee_migration_history(),
-                'active_plugins'        => $this->get_active_plugins(),
-                'wp_settings'           => $this->get_wp_settings(),
-                'wp_maintenance_mode'   => $this->get_wp_maintenance_mode(),
-                'https_enabled'         => $this->get_https_enabled(),
-                'logging_enabled'       => $this->get_logging_enabled(),
-                'remote_posting'        => $this->get_remote_posting(),
-                'php_version'           => $this->php_version(),
-                'php.ini_settings'      => $this->get_php_ini_all(),
-                'php_info'              => $this->get_php_info(),
-            ],
-            $this
-        );
-    }
-
-
-    /**
-     *
-     * @return string
-     */
-    public function get_ee_version(): string
-    {
-        return espresso_version();
-    }
-
-
-    /**
-     *
-     * @return string
-     */
-    public function php_version(): string
-    {
-        return phpversion();
-    }
-
-
-    /**
-     *
-     * @return array, where each key is a plugin name (lower-cased), values are sub-arrays.
-     * Sub-arrays like described in wp function get_plugin_data. Ie,     *
-     *  'Name' => 'Plugin Name',
-     * 'PluginURI' => 'Plugin URI',
-     * 'Version' => 'Version',
-     * 'Description' => 'Description',
-     * 'Author' => 'Author',
-     * 'AuthorURI' => 'Author URI',
-     * 'TextDomain' => 'Text Domain',
-     * 'DomainPath' => 'Domain Path',
-     * 'Network' => 'Network',
-     */
-    public function get_active_plugins(): array
-    {
-        $active_plugins = (array) get_option('active_plugins', []);
-        if (is_multisite()) {
-            $active_plugins = array_merge($active_plugins, get_site_option('active_sitewide_plugins', []));
-        }
-        $active_plugins = array_map('strtolower', $active_plugins);
-        $plugin_info    = [];
-        foreach ($active_plugins as $plugin) {
-            $plugin_data = @get_plugin_data(WP_PLUGIN_DIR . '/' . $plugin);
-
-            $plugin_info[ $plugin ] = $plugin_data;
-        }
-        return $plugin_info;
-    }
-
-
-    /**
-     *
-     * @return array with keys 'home_url' and 'site_url'
-     */
-    public function get_wp_settings(): array
-    {
-        $wp_memory_int = $this->let_to_num(WP_MEMORY_LIMIT);
-        if ($wp_memory_int < 67108864) {
-            $wp_memory_to_display = '<mark class="error">'
-                                    . sprintf(
-                                        esc_html__(
-                                            '%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s',
-                                            'event_espresso'
-                                        ),
-                                        WP_MEMORY_LIMIT,
-                                        '<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">',
-                                        '</a>"'
-                                    )
-                                    . '</mark>';
-        } else {
-            $wp_memory_to_display = '<mark class="yes">' . size_format($wp_memory_int) . '</mark>';
-        }
-        return [
-            'name'                => get_bloginfo('name', 'display'),
-            'is_multisite'        => is_multisite(),
-            'version'             => get_bloginfo('version', 'display'),
-            'home_url'            => home_url(),
-            'site_url'            => site_url(),
-            'WP_DEBUG'            => WP_DEBUG,
-            'permalink_structure' => get_option('permalink_structure'),
-            'theme'               => wp_get_theme(),
-            'gmt_offset'          => get_option('gmt_offset'),
-            'timezone_string'     => get_option('timezone_string'),
-            'admin_email'         => get_bloginfo('admin_email', 'display'),
-            'language'            => get_bloginfo('language', 'display'),
-            'wp_max_upload_size'  => size_format(wp_max_upload_size()),
-            'wp_memory'           => $wp_memory_to_display,
-        ];
-    }
-
-
-    /**
-     * Gets an array of information about the history of ee versions installed
-     *
-     * @return array
-     */
-    public function get_ee_activation_history(): array
-    {
-        return get_option('espresso_db_update');
-    }
-
-
-    /**
-     * Gets an array where keys are ee versions, and their values are arrays indicating all the different times that
-     * version was installed
-     *
-     * @return EE_Data_Migration_Script_Base[]
-     */
-    public function get_ee_migration_history(): array
-    {
-        $presentable_migration_scripts = [];
-        $options                       = EE_Data_Migration_Manager::instance()->get_all_migration_script_options();
-        foreach ($options as $option_array) {
-            $key                                   = str_replace(
-                EE_Data_Migration_Manager::data_migration_script_option_prefix,
-                '',
-                $option_array['option_name']
-            );
-            $presentable_migration_scripts[ $key ] = maybe_unserialize($option_array['option_value']);
-        }
-        return $presentable_migration_scripts;
-    }
-
-
-    /**
-     *
-     * @return EE_Config
-     */
-    public function get_ee_config(): EE_Config
-    {
-        return EE_Config::instance();
-    }
-
-
-    /**
-     * Gets an array of php setup info, pilfered from http://www.php.net/manual/en/function.phpinfo.php#87463
-     *
-     * @return array like the output of phpinfo(), but in an array
-     */
-    public function get_php_info(): array
-    {
-        ob_start();
-        phpinfo(-1);
-
-        $pi = preg_replace(
-            [
-                '#^.*<body>(.*)</body>.*$#ms',
-                '#<h2>PHP License</h2>.*$#ms',
-                '#<h1>Configuration</h1>#',
-                "#\r?\n#",
-                "#</(h1|h2|h3|tr)>#",
-                '# +<#',
-                "#[ \t]+#",
-                '#&nbsp;#',
-                '#  +#',
-                '# class=".*?"#',
-                '%&#039;%',
-                '#<tr>(?:.*?)" src="(?:.*?)=(.*?)" alt="PHP Logo" /></a>'
-                . '<h1>PHP Version (.*?)</h1>(?:\n+?)</td></tr>#',
-                '#<h1><a href="(?:.*?)\?=(.*?)">PHP Credits</a></h1>#',
-                '#<tr>(?:.*?)" src="(?:.*?)=(.*?)"(?:.*?)Zend Engine (.*?),(?:.*?)</tr>#',
-                "# +#",
-                '#<tr>#',
-                '#</tr>#',
-            ],
-            [
-                '$1',
-                '',
-                '',
-                '',
-                '</$1>' . "\n",
-                '<',
-                ' ',
-                ' ',
-                ' ',
-                '',
-                ' ',
-                '<h2>PHP Configuration</h2>' . "\n" . '<tr><td>PHP Version</td><td>$2</td></tr>' .
-                "\n" . '<tr><td>PHP Egg</td><td>$1</td></tr>',
-                '<tr><td>PHP Credits Egg</td><td>$1</td></tr>',
-                '<tr><td>Zend Engine</td><td>$2</td></tr>' . "\n" .
-                '<tr><td>Zend Egg</td><td>$1</td></tr>',
-                ' ',
-                '%S%',
-                '%E%',
-            ],
-            ob_get_clean()
-        );
-
-        $sections = explode('<h2>', strip_tags($pi, '<h2><th><td>'));
-        unset($sections[0]);
-
-        $pi = [];
-        foreach ($sections as $section) {
-            $n = substr($section, 0, strpos($section, '</h2>'));
-            preg_match_all(
-                '#%S%(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?%E%#',
-                $section,
-                $ask_apache,
-                PREG_SET_ORDER
-            );
-            foreach ($ask_apache as $m) {
-                $m2 = $m[2] ?? null;
-            }
-            $pi[ $n ][ $m[1] ] = (! isset($m[3]) || $m2 == $m[3])
-                ? $m2
-                : array_slice($m, 2);
-        }
-
-        return $pi;
-    }
-
-
-    /**
-     * Checks if site responds ot HTTPS
-     *
-     * @return string
-     */
-    public function get_https_enabled(): string
-    {
-        $home     = str_replace("http://", "https://", home_url());
-        $response = wp_remote_get($home);
-        if ($response instanceof WP_Error) {
-            $error_string = '';
-            foreach ($response->errors as $short_name => $description_array) {
-                $error_string .= "<b>$short_name</b>: " . implode(", ", $description_array);
-            }
-            return $error_string;
-        }
-        return "ok!";
-    }
-
-
-    /**
-     * Whether or not a .maintenance file is detected
-     *
-     * @return string wp_maintenance_mode status
-     */
-    public function get_wp_maintenance_mode(): string
-    {
-        $opened = file_exists(ABSPATH . '.maintenance');
-        return $opened
-            ? sprintf(
-                esc_html__(
-                    '%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>'
-            )
-            : esc_html__('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso');
-    }
-
-
-    /**
-     * Whether or not logging is enabled
-     *
-     * @return string logging's status
-     */
-    public function get_logging_enabled(): string
-    {
-        $opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a');
-        return $opened
-            ? esc_html__('Log Directory is writable', 'event_espresso')
-            : sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>');
-    }
-
-
-    /**
-     *  Whether curl ro fsock works
-     *
-     * @return string describing posting's status
-     */
-    public function get_remote_posting(): string
-    {
-        $fsock_works = function_exists('fsockopen');
-        $curl_works  = function_exists('curl_init');
-        if ($fsock_works && $curl_works) {
-            $status = esc_html__('Your server has fsockopen and cURL enabled.', 'event_espresso');
-        } elseif ($fsock_works) {
-            $status = esc_html__('Your server has fsockopen enabled, cURL is disabled.', 'event_espresso');
-        } elseif ($curl_works) {
-            $status = esc_html__('Your server has cURL enabled, fsockopen is disabled.', 'event_espresso');
-        } else {
-            $status = esc_html__(
-                          'Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.',
-                          'event_espresso'
-                      ) . '</mark>';
-        }
-        return $status;
-    }
-
-
-    /**
-     * Gets all the php.ini settings
-     *
-     * @return array
-     */
-    public function get_php_ini_all(): array
-    {
-        return ini_get_all();
-    }
-
-
-    /**
-     * Transforms the php.ini notation for numbers (like '2M') to an integer.
-     *
-     * @param string $size
-     * @return int
-     * @noinspection PhpMissingBreakStatementInspection
-     */
-    public function let_to_num(string $size): int
-    {
-        $l   = substr($size, -1);
-        $ret = substr($size, 0, -1);
-        // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
-        switch (strtoupper($l)) {
-            case 'P':
-                $ret *= 1024;
-            case 'T':
-                $ret *= 1024;
-            case 'G':
-                $ret *= 1024;
-            case 'M':
-                $ret *= 1024;
-            case 'K':
-                $ret *= 1024;
-        }
-        // phpcs:enable
-        return $ret;
-    }
+	/**
+	 * @var EEM_System_Status
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * This function is a singleton method used to instantiate the EEM_Attendee object
+	 *
+	 * @return EEM_System_Status
+	 */
+	public static function instance(): EEM_System_Status
+	{
+
+		// check if instance of EEM_System_Status already exists
+		if (self::$_instance === null) {
+			// instantiate EEM_System_Status
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	private function __construct()
+	{
+	}
+
+
+	/**
+	 * @return array where each key is a function name on this class, and each value is SOMETHING--
+	 * it might be a value, an array, or an object
+	 */
+	public function get_system_stati(): array
+	{
+		return apply_filters(
+			'FHEE__EEM_System_Status__get_system_stati',
+			[
+				'ee_version'            => $this->get_ee_version(),
+				'ee_activation_history' => $this->get_ee_activation_history(),
+				'ee_config'             => $this->get_ee_config(),
+				'ee_migration_history'  => $this->get_ee_migration_history(),
+				'active_plugins'        => $this->get_active_plugins(),
+				'wp_settings'           => $this->get_wp_settings(),
+				'wp_maintenance_mode'   => $this->get_wp_maintenance_mode(),
+				'https_enabled'         => $this->get_https_enabled(),
+				'logging_enabled'       => $this->get_logging_enabled(),
+				'remote_posting'        => $this->get_remote_posting(),
+				'php_version'           => $this->php_version(),
+				'php.ini_settings'      => $this->get_php_ini_all(),
+				'php_info'              => $this->get_php_info(),
+			],
+			$this
+		);
+	}
+
+
+	/**
+	 *
+	 * @return string
+	 */
+	public function get_ee_version(): string
+	{
+		return espresso_version();
+	}
+
+
+	/**
+	 *
+	 * @return string
+	 */
+	public function php_version(): string
+	{
+		return phpversion();
+	}
+
+
+	/**
+	 *
+	 * @return array, where each key is a plugin name (lower-cased), values are sub-arrays.
+	 * Sub-arrays like described in wp function get_plugin_data. Ie,     *
+	 *  'Name' => 'Plugin Name',
+	 * 'PluginURI' => 'Plugin URI',
+	 * 'Version' => 'Version',
+	 * 'Description' => 'Description',
+	 * 'Author' => 'Author',
+	 * 'AuthorURI' => 'Author URI',
+	 * 'TextDomain' => 'Text Domain',
+	 * 'DomainPath' => 'Domain Path',
+	 * 'Network' => 'Network',
+	 */
+	public function get_active_plugins(): array
+	{
+		$active_plugins = (array) get_option('active_plugins', []);
+		if (is_multisite()) {
+			$active_plugins = array_merge($active_plugins, get_site_option('active_sitewide_plugins', []));
+		}
+		$active_plugins = array_map('strtolower', $active_plugins);
+		$plugin_info    = [];
+		foreach ($active_plugins as $plugin) {
+			$plugin_data = @get_plugin_data(WP_PLUGIN_DIR . '/' . $plugin);
+
+			$plugin_info[ $plugin ] = $plugin_data;
+		}
+		return $plugin_info;
+	}
+
+
+	/**
+	 *
+	 * @return array with keys 'home_url' and 'site_url'
+	 */
+	public function get_wp_settings(): array
+	{
+		$wp_memory_int = $this->let_to_num(WP_MEMORY_LIMIT);
+		if ($wp_memory_int < 67108864) {
+			$wp_memory_to_display = '<mark class="error">'
+									. sprintf(
+										esc_html__(
+											'%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s',
+											'event_espresso'
+										),
+										WP_MEMORY_LIMIT,
+										'<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">',
+										'</a>"'
+									)
+									. '</mark>';
+		} else {
+			$wp_memory_to_display = '<mark class="yes">' . size_format($wp_memory_int) . '</mark>';
+		}
+		return [
+			'name'                => get_bloginfo('name', 'display'),
+			'is_multisite'        => is_multisite(),
+			'version'             => get_bloginfo('version', 'display'),
+			'home_url'            => home_url(),
+			'site_url'            => site_url(),
+			'WP_DEBUG'            => WP_DEBUG,
+			'permalink_structure' => get_option('permalink_structure'),
+			'theme'               => wp_get_theme(),
+			'gmt_offset'          => get_option('gmt_offset'),
+			'timezone_string'     => get_option('timezone_string'),
+			'admin_email'         => get_bloginfo('admin_email', 'display'),
+			'language'            => get_bloginfo('language', 'display'),
+			'wp_max_upload_size'  => size_format(wp_max_upload_size()),
+			'wp_memory'           => $wp_memory_to_display,
+		];
+	}
+
+
+	/**
+	 * Gets an array of information about the history of ee versions installed
+	 *
+	 * @return array
+	 */
+	public function get_ee_activation_history(): array
+	{
+		return get_option('espresso_db_update');
+	}
+
+
+	/**
+	 * Gets an array where keys are ee versions, and their values are arrays indicating all the different times that
+	 * version was installed
+	 *
+	 * @return EE_Data_Migration_Script_Base[]
+	 */
+	public function get_ee_migration_history(): array
+	{
+		$presentable_migration_scripts = [];
+		$options                       = EE_Data_Migration_Manager::instance()->get_all_migration_script_options();
+		foreach ($options as $option_array) {
+			$key                                   = str_replace(
+				EE_Data_Migration_Manager::data_migration_script_option_prefix,
+				'',
+				$option_array['option_name']
+			);
+			$presentable_migration_scripts[ $key ] = maybe_unserialize($option_array['option_value']);
+		}
+		return $presentable_migration_scripts;
+	}
+
+
+	/**
+	 *
+	 * @return EE_Config
+	 */
+	public function get_ee_config(): EE_Config
+	{
+		return EE_Config::instance();
+	}
+
+
+	/**
+	 * Gets an array of php setup info, pilfered from http://www.php.net/manual/en/function.phpinfo.php#87463
+	 *
+	 * @return array like the output of phpinfo(), but in an array
+	 */
+	public function get_php_info(): array
+	{
+		ob_start();
+		phpinfo(-1);
+
+		$pi = preg_replace(
+			[
+				'#^.*<body>(.*)</body>.*$#ms',
+				'#<h2>PHP License</h2>.*$#ms',
+				'#<h1>Configuration</h1>#',
+				"#\r?\n#",
+				"#</(h1|h2|h3|tr)>#",
+				'# +<#',
+				"#[ \t]+#",
+				'#&nbsp;#',
+				'#  +#',
+				'# class=".*?"#',
+				'%&#039;%',
+				'#<tr>(?:.*?)" src="(?:.*?)=(.*?)" alt="PHP Logo" /></a>'
+				. '<h1>PHP Version (.*?)</h1>(?:\n+?)</td></tr>#',
+				'#<h1><a href="(?:.*?)\?=(.*?)">PHP Credits</a></h1>#',
+				'#<tr>(?:.*?)" src="(?:.*?)=(.*?)"(?:.*?)Zend Engine (.*?),(?:.*?)</tr>#',
+				"# +#",
+				'#<tr>#',
+				'#</tr>#',
+			],
+			[
+				'$1',
+				'',
+				'',
+				'',
+				'</$1>' . "\n",
+				'<',
+				' ',
+				' ',
+				' ',
+				'',
+				' ',
+				'<h2>PHP Configuration</h2>' . "\n" . '<tr><td>PHP Version</td><td>$2</td></tr>' .
+				"\n" . '<tr><td>PHP Egg</td><td>$1</td></tr>',
+				'<tr><td>PHP Credits Egg</td><td>$1</td></tr>',
+				'<tr><td>Zend Engine</td><td>$2</td></tr>' . "\n" .
+				'<tr><td>Zend Egg</td><td>$1</td></tr>',
+				' ',
+				'%S%',
+				'%E%',
+			],
+			ob_get_clean()
+		);
+
+		$sections = explode('<h2>', strip_tags($pi, '<h2><th><td>'));
+		unset($sections[0]);
+
+		$pi = [];
+		foreach ($sections as $section) {
+			$n = substr($section, 0, strpos($section, '</h2>'));
+			preg_match_all(
+				'#%S%(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?%E%#',
+				$section,
+				$ask_apache,
+				PREG_SET_ORDER
+			);
+			foreach ($ask_apache as $m) {
+				$m2 = $m[2] ?? null;
+			}
+			$pi[ $n ][ $m[1] ] = (! isset($m[3]) || $m2 == $m[3])
+				? $m2
+				: array_slice($m, 2);
+		}
+
+		return $pi;
+	}
+
+
+	/**
+	 * Checks if site responds ot HTTPS
+	 *
+	 * @return string
+	 */
+	public function get_https_enabled(): string
+	{
+		$home     = str_replace("http://", "https://", home_url());
+		$response = wp_remote_get($home);
+		if ($response instanceof WP_Error) {
+			$error_string = '';
+			foreach ($response->errors as $short_name => $description_array) {
+				$error_string .= "<b>$short_name</b>: " . implode(", ", $description_array);
+			}
+			return $error_string;
+		}
+		return "ok!";
+	}
+
+
+	/**
+	 * Whether or not a .maintenance file is detected
+	 *
+	 * @return string wp_maintenance_mode status
+	 */
+	public function get_wp_maintenance_mode(): string
+	{
+		$opened = file_exists(ABSPATH . '.maintenance');
+		return $opened
+			? sprintf(
+				esc_html__(
+					'%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>'
+			)
+			: esc_html__('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso');
+	}
+
+
+	/**
+	 * Whether or not logging is enabled
+	 *
+	 * @return string logging's status
+	 */
+	public function get_logging_enabled(): string
+	{
+		$opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a');
+		return $opened
+			? esc_html__('Log Directory is writable', 'event_espresso')
+			: sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>');
+	}
+
+
+	/**
+	 *  Whether curl ro fsock works
+	 *
+	 * @return string describing posting's status
+	 */
+	public function get_remote_posting(): string
+	{
+		$fsock_works = function_exists('fsockopen');
+		$curl_works  = function_exists('curl_init');
+		if ($fsock_works && $curl_works) {
+			$status = esc_html__('Your server has fsockopen and cURL enabled.', 'event_espresso');
+		} elseif ($fsock_works) {
+			$status = esc_html__('Your server has fsockopen enabled, cURL is disabled.', 'event_espresso');
+		} elseif ($curl_works) {
+			$status = esc_html__('Your server has cURL enabled, fsockopen is disabled.', 'event_espresso');
+		} else {
+			$status = esc_html__(
+						  'Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.',
+						  'event_espresso'
+					  ) . '</mark>';
+		}
+		return $status;
+	}
+
+
+	/**
+	 * Gets all the php.ini settings
+	 *
+	 * @return array
+	 */
+	public function get_php_ini_all(): array
+	{
+		return ini_get_all();
+	}
+
+
+	/**
+	 * Transforms the php.ini notation for numbers (like '2M') to an integer.
+	 *
+	 * @param string $size
+	 * @return int
+	 * @noinspection PhpMissingBreakStatementInspection
+	 */
+	public function let_to_num(string $size): int
+	{
+		$l   = substr($size, -1);
+		$ret = substr($size, 0, -1);
+		// phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
+		switch (strtoupper($l)) {
+			case 'P':
+				$ret *= 1024;
+			case 'T':
+				$ret *= 1024;
+			case 'G':
+				$ret *= 1024;
+			case 'M':
+				$ret *= 1024;
+			case 'K':
+				$ret *= 1024;
+		}
+		// phpcs:enable
+		return $ret;
+	}
 }

Spacing +14 added lines, -14 removed lines

@@ -105,9 +105,9 @@ 
         $active_plugins = array_map('strtolower', $active_plugins);
         $plugin_info    = [];
         foreach ($active_plugins as $plugin) {
-            $plugin_data = @get_plugin_data(WP_PLUGIN_DIR . '/' . $plugin);
+            $plugin_data = @get_plugin_data(WP_PLUGIN_DIR.'/'.$plugin);
 
-            $plugin_info[ $plugin ] = $plugin_data;
+            $plugin_info[$plugin] = $plugin_data;
         }
         return $plugin_info;
     }
@@ -133,7 +133,7 @@ 
                                     )
                                     . '</mark>';
         } else {
-            $wp_memory_to_display = '<mark class="yes">' . size_format($wp_memory_int) . '</mark>';
+            $wp_memory_to_display = '<mark class="yes">'.size_format($wp_memory_int).'</mark>';
         }
         return [
             'name'                => get_bloginfo('name', 'display'),
@@ -176,12 +176,12 @@ 
         $presentable_migration_scripts = [];
         $options                       = EE_Data_Migration_Manager::instance()->get_all_migration_script_options();
         foreach ($options as $option_array) {
-            $key                                   = str_replace(
+            $key = str_replace(
                 EE_Data_Migration_Manager::data_migration_script_option_prefix,
                 '',
                 $option_array['option_name']
             );
-            $presentable_migration_scripts[ $key ] = maybe_unserialize($option_array['option_value']);
+            $presentable_migration_scripts[$key] = maybe_unserialize($option_array['option_value']);
         }
         return $presentable_migration_scripts;
     }
@@ -233,17 +233,17 @@ 
                 '',
                 '',
                 '',
-                '</$1>' . "\n",
+                '</$1>'."\n",
                 '<',
                 ' ',
                 ' ',
                 ' ',
                 '',
                 ' ',
-                '<h2>PHP Configuration</h2>' . "\n" . '<tr><td>PHP Version</td><td>$2</td></tr>' .
-                "\n" . '<tr><td>PHP Egg</td><td>$1</td></tr>',
+                '<h2>PHP Configuration</h2>'."\n".'<tr><td>PHP Version</td><td>$2</td></tr>'.
+                "\n".'<tr><td>PHP Egg</td><td>$1</td></tr>',
                 '<tr><td>PHP Credits Egg</td><td>$1</td></tr>',
-                '<tr><td>Zend Engine</td><td>$2</td></tr>' . "\n" .
+                '<tr><td>Zend Engine</td><td>$2</td></tr>'."\n".
                 '<tr><td>Zend Egg</td><td>$1</td></tr>',
                 ' ',
                 '%S%',
@@ -267,7 +267,7 @@ 
             foreach ($ask_apache as $m) {
                 $m2 = $m[2] ?? null;
             }
-            $pi[ $n ][ $m[1] ] = (! isset($m[3]) || $m2 == $m[3])
+            $pi[$n][$m[1]] = ( ! isset($m[3]) || $m2 == $m[3])
                 ? $m2
                 : array_slice($m, 2);
         }
@@ -288,7 +288,7 @@ 
         if ($response instanceof WP_Error) {
             $error_string = '';
             foreach ($response->errors as $short_name => $description_array) {
-                $error_string .= "<b>$short_name</b>: " . implode(", ", $description_array);
+                $error_string .= "<b>$short_name</b>: ".implode(", ", $description_array);
             }
             return $error_string;
         }
@@ -303,7 +303,7 @@ 
      */
     public function get_wp_maintenance_mode(): string
     {
-        $opened = file_exists(ABSPATH . '.maintenance');
+        $opened = file_exists(ABSPATH.'.maintenance');
         return $opened
             ? sprintf(
                 esc_html__(
@@ -324,7 +324,7 @@ 
      */
     public function get_logging_enabled(): string
     {
-        $opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a');
+        $opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR.'/logs/espresso_log.txt', 'a');
         return $opened
             ? esc_html__('Log Directory is writable', 'event_espresso')
             : sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>');
@@ -350,7 +350,7 @@ 
             $status = esc_html__(
                           'Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.',
                           'event_espresso'
-                      ) . '</mark>';
+                      ).'</mark>';
         }
         return $status;
     }

core/db_models/EEM_Message_Template_Group.model.php

Indentation +478 added lines, -478 removed lines

@@ -12,482 +12,482 @@
 class EEM_Message_Template_Group extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the EEM_Message_Template_Group object
-    protected static $_instance;
-
-
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Message Template Group', 'event_espresso');
-        $this->plural_item      = esc_html__('Message Template Groups', 'event_espresso');
-        $this->_tables          = [
-            'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID'),
-        ];
-        $this->_fields          = [
-            'Message_Template_Group' => [
-                'GRP_ID'           => new EE_Primary_Key_Int_Field(
-                    'GRP_ID', esc_html__('Message Template Group ID', 'event_espresso')
-                ),
-                'MTP_name'         => new EE_Plain_Text_Field(
-                    'MTP_name', esc_html__('The name of the template group', 'event_espresso'), false, ''
-                ),
-                'MTP_description'  => new EE_Simple_HTML_Field(
-                    'MTP_description',
-                    esc_html__('A brief description about this template.', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'MTP_user_id'      => new EE_WP_User_Field(
-                    'MTP_user_id',
-                    esc_html__('Template Creator ID', 'event_espresso'),
-                    false
-                ),
-                'MTP_messenger'    => new EE_Plain_Text_Field(
-                    'MTP_messenger',
-                    esc_html__('Messenger Used for Template', 'event_espresso'),
-                    false,
-                    'email'
-                ),
-                'MTP_message_type' => new EE_Plain_Text_Field(
-                    'MTP_message_type',
-                    esc_html__('Message Type', 'event_espresso'),
-                    false,
-                    'registration'
-                ),
-                'MTP_is_global'    => new EE_Boolean_Field(
-                    'MTP_is_global',
-                    esc_html__('Flag indicating if Template Group is Global', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'MTP_is_override'  => new EE_Boolean_Field(
-                    'MTP_is_override',
-                    esc_html__('Flag indicating if Template Group overrides any other Templates for the messenger/message type combination',
-                               'event_espresso'),
-                    false,
-                    false
-                ),
-                'MTP_deleted'      => new EE_Trashed_Flag_Field(
-                    'MTP_deleted',
-                    esc_html__('Flag indicating whether this has been trashed', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'MTP_is_active'    => new EE_Boolean_Field(
-                    'MTP_is_active',
-                    esc_html__('Flag indicating whether template group is active', 'event_espresso'),
-                    false,
-                    true
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Message_Template' => new EE_Has_Many_Relation(),
-            'Message'          => new EE_Has_Many_Relation(),
-            'Event'            => new EE_HABTM_Relation('Event_Message_Template'),
-            'WP_User'          => new EE_Belongs_To_Relation(),
-        ];
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
-        }
-        $this->_caps_slug = 'messages';
-
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * get_all_trashed_message_templates_by_event
-     *
-     * @param int      $EVT_ID specific event id
-     * @param string   $orderby
-     * @param string   $order
-     * @param int|null $limit
-     * @param bool     $count
-     * @return EE_Message_Template_Group[]|int message template objects that are attached to a specific event.
-     */
-    public function get_all_trashed_message_templates_by_event(
-        int $EVT_ID,
-        string $orderby = 'GRP_ID',
-        string $order = 'ASC',
-        int $limit = null,
-        bool $count = false
-    ) {
-        $query_params = [['Event.EVT_ID' => $EVT_ID], 'order_by' => [$orderby => $order], 'limit' => $limit];
-        return $count
-            ? $this->count_deleted($query_params, 'GRP_ID', true)
-            : $this->get_all_deleted($query_params);
-    }
-
-
-    /**
-     * get_all_message_templates_by_messenger
-     *
-     * @param string $messenger
-     * @param string $orderby
-     * @param string $order
-     * @return EE_Message_Template_Group[] all (including trashed or inactive) message template group objects for the
-     * given messenger
-     */
-    public function get_all_message_templates_by_messenger(string $messenger,
-                                                           string $orderby = 'GRP_ID',
-                                                           string $order = 'ASC'): array
-    {
-        return $this->get_all_deleted_and_undeleted(
-            [['MTP_messenger' => $messenger], 'order_by' => [$orderby => $order]]
-        );
-    }
-
-
-    /**
-     * This simply adds on any messenger/message type filters that may be present in the $_POST global
-     *
-     * @param array $_where any existing where conditions to append these to.
-     * @return EE_Message_Template_Group[] original where conditions or original with additional filters.
-     */
-    protected function _maybe_mtp_filters(array $_where = []): array
-    {
-        // account for messenger or message type filters
-        if (
-            isset($_REQUEST['ee_messenger_filter_by'])
-            && $_REQUEST['ee_messenger_filter_by'] != 'none_selected'
-            && $_REQUEST['ee_messenger_filter_by'] != 'all'
-        ) {
-            $_where['MTP_messenger'] = $_REQUEST['ee_messenger_filter_by'];
-        }
-
-        if (
-            isset($_REQUEST['ee_message_type_filter_by'])
-            && $_REQUEST['ee_message_type_filter_by'] != 'none_selected'
-        ) {
-            $_where['MTP_message_type'] = $_REQUEST['ee_message_type_filter_by'];
-        }
-
-        return $_where;
-    }
-
-
-    /**
-     * get_all_active_message_templates groups
-     *
-     * @param string   $orderby
-     * @param string   $order
-     * @param int|null $limit
-     * @param bool     $count
-     * @param bool     $global
-     * @param bool     $user_check
-     * @return EE_Message_Template_Group[]|int all active (non_trashed, active) message template objects
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_active_message_templates(
-        string $orderby = 'GRP_ID',
-        string $order = 'ASC',
-        int $limit = null,
-        bool $count = false,
-        bool $global = true,
-        bool $user_check = false
-    ): array {
-        $_where                  = $global ? ['MTP_is_global' => true] : ['MTP_is_global' => false];
-        $_where['MTP_is_active'] = true;
-        $_where                  = $this->_maybe_mtp_filters($_where);
-
-        if (
-            $user_check
-            && ! $global
-            && ! EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_others_messages',
-                'get_all_active_message_templates'
-            )
-        ) {
-            $_where['MTP_user_id'] = get_current_user_id();
-        }
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-    /**
-     *    retrieve ALL message_template groups from db regardless of wht
-     *
-     * @access    public
-     * @param string   $orderby
-     * @param string   $order
-     * @param int|null $limit
-     * @param bool     $count
-     * @return EE_Message_Template_Group[]
-     */
-    public function get_all_message_templates(
-        string $orderby = 'GRP_ID',
-        string $order = 'ASC',
-        int $limit = null,
-        bool $count = false
-    ): array {
-        $_where = $this->_maybe_mtp_filters();
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count
-            ? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
-            : $this->get_all_deleted_and_undeleted($query_params);
-    }
-
-
-    /**
-     * This gets all the custom templates attached to a specific event
-     *
-     * @param int   $EVT_ID       event id
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return  EE_Message_Template_Group[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_custom_templates_by_event(int $EVT_ID, array $query_params = []): array
-    {
-        $where = array_merge($query_params, ['Event.EVT_ID' => $EVT_ID]);
-        return $this->get_all([$where]);
-    }
-
-
-    /**
-     * get_all_trashed_grouped_message_templates
-     * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
-     *
-     * @param string   $orderby
-     * @param string   $order
-     * @param int|null $limit
-     * @param bool     $count
-     * @param bool     $global
-     * @return EE_Message_Template_Group[]|int message template groups.
-     */
-    public function get_all_trashed_grouped_message_templates(
-        string $orderby = 'GRP_ID',
-        string $order = 'ASC',
-        int $limit = null,
-        bool $count = false,
-        bool $global = true
-    ) {
-        $_where                  = $global ? ['MTP_is_global' => true] : ['MTP_is_global' => false];
-        $_where['MTP_is_active'] = true;
-        $_where                  = $this->_maybe_mtp_filters($_where);
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count
-            ? $this->count_deleted($query_params, 'GRP_ID', true)
-            : $this->get_all_deleted($query_params);
-    }
-
-
-    /**
-     * this returns the message template group(s) for a given event, messenger, and message template
-     *
-     * @param string   $messenger
-     * @param string   $message_type
-     * @param int      $evt_id
-     * @param string   $orderby pointless at this point but still included
-     * @param string   $order
-     * @param int|null $limit
-     * @param bool     $count   true = just return count, false = objects
-     * @param bool     $active  ignore "active" or not. (default only return active)
-     * @return EE_Message_Template_Group[]|int depending on $count.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_event_message_templates_by_m_and_mt_and_evt(
-        string $messenger,
-        string $message_type,
-        int $evt_id,
-        string $orderby = 'GRP_ID',
-        string $order = 'ASC',
-        int $limit = null,
-        bool $count = false,
-        bool $active = true
-    ) {
-        $_where = [
-            'MTP_messenger'    => $messenger,
-            'MTP_message_type' => $message_type,
-            'Event.EVT_ID'     => $evt_id,
-            'MTP_is_global'    => true,
-            'MTP_is_active'    => $active,
-        ];
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count
-            ? $this->count($query_params, 'GRP_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-    /**
-     * get all GLOBAL message template groups for the given messenger and message type
-     *
-     * @param string   $messenger    slug for messenger
-     * @param string   $message_type slug for message type
-     * @param string   $orderby      what column to orderby
-     * @param string   $order        ASC or DESC
-     * @param int|null $limit
-     * @param bool     $count        true = just return count, false = objects
-     * @param bool     $active       ignore "active" or not. (default only return active) -
-     *                               'all' means return both inactive AND inactive.
-     * @return EE_Message_Template_Group[]|int               message template objects that are global (i.e. non-event)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_global_message_template_by_m_and_mt(
-        string $messenger,
-        string $message_type,
-        string $orderby = 'GRP_ID',
-        string $order = 'ASC',
-        int $limit = null,
-        bool $count = false,
-        bool $active = true
-    ) {
-        $_where = [
-            'MTP_messenger'    => $messenger,
-            'MTP_message_type' => $message_type,
-            'MTP_is_global'    => true,
-        ];
-
-        if ($active != 'all') {
-            $_where['MTP_is_active'] = $active;
-        }
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count
-            ? $this->count($query_params, 'GRP_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-    /**
-     * get all custom message template groups for the given messenger and message type
-     *
-     * @param string $messenger
-     * @param string $message_type
-     * @param array  $query_params same as EEM_Base->get_all()
-     * @return EE_Message_Template_Group[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_custom_message_template_by_m_and_mt(string $messenger, string $message_type, array $query_params = []): array
-    {
-        return $this->get_all(
-            array_merge(
-                $query_params,
-                [
-                    [
-                        'MTP_is_global'    => false,
-                        'MTP_messenger'    => $messenger,
-                        'MTP_message_type' => $message_type,
-                    ],
-                ]
-            )
-        );
-    }
-
-
-    /**
-     * This sends things to the validator for the given messenger and message type.
-     *
-     * @param array  $fields       the incoming fields to check.
-     *                             Note this array is in the formatted fields from the form fields setup.
-     *                             So we need to reformat this into an array of expected field refs by the validator.
-     *                             Note also that this is not only the fields for the Message Template Group
-     *                             but ALSO for Message Template.
-     * @param string $context      The context the fields were obtained from.
-     * @param string $messenger    The messenger we are validating
-     * @param string $message_type The message type we are validating.
-     * @return mixed If the fields all check out then we return true otherwise error messages are returned
-     *                             (indexed by field name);
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function validate(array $fields, string $context, string $messenger, string $message_type)
-    {
-
-        $assembled_fields = [];
-
-        // let's loop through all the fields and set them up in the right format
-        foreach ($fields as $value) {
-            // first let's figure out if the value['content'] in the current index is an array.
-            //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
-            if (is_array($value['content'])) {
-                $assembled_fields[ $value['name'] ] = $value['content']['main'];
-                // loop through the content and get the other fields.
-                foreach ($value['content'] as $name => $val) {
-                    if ($name == 'main') {
-                        continue;
-                    }
-                    $assembled_fields[ $name ] = $val;
-                }
-                continue;
-            }
-
-            // okay if we're here then this is just a straight field=>$value arrangement
-            $assembled_fields[ $value['name'] ] = $value['content'];
-        }
-
-        // now we've got the assembled_fields.
-        // We need to setup the string for the appropriate validator class and call that.
-        $m_ref  = ucwords(str_replace('_', ' ', $messenger));
-        $m_ref  = str_replace(' ', '_', $m_ref);
-        $mt_ref = ucwords(str_replace('_', ' ', $message_type));
-        $mt_ref = str_replace(' ', '_', $mt_ref);
-
-        $classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
-
-        if (! class_exists($classname)) {
-            $msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
-            $msg[] = sprintf(
-                esc_html__(
-                    'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
-                    'event_espresso'
-                ),
-                $classname
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-
-        $a      = new ReflectionClass($classname);
-        $_VLD   = $a->newInstance($assembled_fields, $context);
-        return $_VLD->validate();
-    }
-
-
-    /**
-     * Updates all message template groups matching the incoming arguments to inactive status.
-     *
-     * @param array $messenger_names    The messenger slugs.
-     *                                  If empty then all templates matching the message types are marked inactive.
-     *                                  Otherwise only templates matching the messengers and message types.
-     * @param array $message_type_names The message type slugs.
-     *                                  If empty then all templates matching the messengers are marked inactive.
-     *                                  Otherwise only templates matching the messengers and message types.
-     *
-     * @return int  count of updated records.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function deactivate_message_template_groups_for(
-        array $messenger_names = [],
-        array $message_type_names = []
-    ): int {
-        $query_args = [];
-        if (empty($messenger_names) && empty($message_type_names)) {
-            return 0;
-        }
-        if (! empty($messenger_names)) {
-            $query_args[0]['MTP_messenger'] = ['IN', $messenger_names];
-        }
-        if (! empty($message_type_names)) {
-            $query_args[0]['MTP_message_type'] = ['IN', $message_type_names];
-        }
-        return $this->update(['MTP_is_active' => false], $query_args);
-    }
+	// private instance of the EEM_Message_Template_Group object
+	protected static $_instance;
+
+
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Message Template Group', 'event_espresso');
+		$this->plural_item      = esc_html__('Message Template Groups', 'event_espresso');
+		$this->_tables          = [
+			'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID'),
+		];
+		$this->_fields          = [
+			'Message_Template_Group' => [
+				'GRP_ID'           => new EE_Primary_Key_Int_Field(
+					'GRP_ID', esc_html__('Message Template Group ID', 'event_espresso')
+				),
+				'MTP_name'         => new EE_Plain_Text_Field(
+					'MTP_name', esc_html__('The name of the template group', 'event_espresso'), false, ''
+				),
+				'MTP_description'  => new EE_Simple_HTML_Field(
+					'MTP_description',
+					esc_html__('A brief description about this template.', 'event_espresso'),
+					false,
+					''
+				),
+				'MTP_user_id'      => new EE_WP_User_Field(
+					'MTP_user_id',
+					esc_html__('Template Creator ID', 'event_espresso'),
+					false
+				),
+				'MTP_messenger'    => new EE_Plain_Text_Field(
+					'MTP_messenger',
+					esc_html__('Messenger Used for Template', 'event_espresso'),
+					false,
+					'email'
+				),
+				'MTP_message_type' => new EE_Plain_Text_Field(
+					'MTP_message_type',
+					esc_html__('Message Type', 'event_espresso'),
+					false,
+					'registration'
+				),
+				'MTP_is_global'    => new EE_Boolean_Field(
+					'MTP_is_global',
+					esc_html__('Flag indicating if Template Group is Global', 'event_espresso'),
+					false,
+					true
+				),
+				'MTP_is_override'  => new EE_Boolean_Field(
+					'MTP_is_override',
+					esc_html__('Flag indicating if Template Group overrides any other Templates for the messenger/message type combination',
+							   'event_espresso'),
+					false,
+					false
+				),
+				'MTP_deleted'      => new EE_Trashed_Flag_Field(
+					'MTP_deleted',
+					esc_html__('Flag indicating whether this has been trashed', 'event_espresso'),
+					false,
+					false
+				),
+				'MTP_is_active'    => new EE_Boolean_Field(
+					'MTP_is_active',
+					esc_html__('Flag indicating whether template group is active', 'event_espresso'),
+					false,
+					true
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Message_Template' => new EE_Has_Many_Relation(),
+			'Message'          => new EE_Has_Many_Relation(),
+			'Event'            => new EE_HABTM_Relation('Event_Message_Template'),
+			'WP_User'          => new EE_Belongs_To_Relation(),
+		];
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+		}
+		$this->_caps_slug = 'messages';
+
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * get_all_trashed_message_templates_by_event
+	 *
+	 * @param int      $EVT_ID specific event id
+	 * @param string   $orderby
+	 * @param string   $order
+	 * @param int|null $limit
+	 * @param bool     $count
+	 * @return EE_Message_Template_Group[]|int message template objects that are attached to a specific event.
+	 */
+	public function get_all_trashed_message_templates_by_event(
+		int $EVT_ID,
+		string $orderby = 'GRP_ID',
+		string $order = 'ASC',
+		int $limit = null,
+		bool $count = false
+	) {
+		$query_params = [['Event.EVT_ID' => $EVT_ID], 'order_by' => [$orderby => $order], 'limit' => $limit];
+		return $count
+			? $this->count_deleted($query_params, 'GRP_ID', true)
+			: $this->get_all_deleted($query_params);
+	}
+
+
+	/**
+	 * get_all_message_templates_by_messenger
+	 *
+	 * @param string $messenger
+	 * @param string $orderby
+	 * @param string $order
+	 * @return EE_Message_Template_Group[] all (including trashed or inactive) message template group objects for the
+	 * given messenger
+	 */
+	public function get_all_message_templates_by_messenger(string $messenger,
+														   string $orderby = 'GRP_ID',
+														   string $order = 'ASC'): array
+	{
+		return $this->get_all_deleted_and_undeleted(
+			[['MTP_messenger' => $messenger], 'order_by' => [$orderby => $order]]
+		);
+	}
+
+
+	/**
+	 * This simply adds on any messenger/message type filters that may be present in the $_POST global
+	 *
+	 * @param array $_where any existing where conditions to append these to.
+	 * @return EE_Message_Template_Group[] original where conditions or original with additional filters.
+	 */
+	protected function _maybe_mtp_filters(array $_where = []): array
+	{
+		// account for messenger or message type filters
+		if (
+			isset($_REQUEST['ee_messenger_filter_by'])
+			&& $_REQUEST['ee_messenger_filter_by'] != 'none_selected'
+			&& $_REQUEST['ee_messenger_filter_by'] != 'all'
+		) {
+			$_where['MTP_messenger'] = $_REQUEST['ee_messenger_filter_by'];
+		}
+
+		if (
+			isset($_REQUEST['ee_message_type_filter_by'])
+			&& $_REQUEST['ee_message_type_filter_by'] != 'none_selected'
+		) {
+			$_where['MTP_message_type'] = $_REQUEST['ee_message_type_filter_by'];
+		}
+
+		return $_where;
+	}
+
+
+	/**
+	 * get_all_active_message_templates groups
+	 *
+	 * @param string   $orderby
+	 * @param string   $order
+	 * @param int|null $limit
+	 * @param bool     $count
+	 * @param bool     $global
+	 * @param bool     $user_check
+	 * @return EE_Message_Template_Group[]|int all active (non_trashed, active) message template objects
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_active_message_templates(
+		string $orderby = 'GRP_ID',
+		string $order = 'ASC',
+		int $limit = null,
+		bool $count = false,
+		bool $global = true,
+		bool $user_check = false
+	): array {
+		$_where                  = $global ? ['MTP_is_global' => true] : ['MTP_is_global' => false];
+		$_where['MTP_is_active'] = true;
+		$_where                  = $this->_maybe_mtp_filters($_where);
+
+		if (
+			$user_check
+			&& ! $global
+			&& ! EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_others_messages',
+				'get_all_active_message_templates'
+			)
+		) {
+			$_where['MTP_user_id'] = get_current_user_id();
+		}
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+	/**
+	 *    retrieve ALL message_template groups from db regardless of wht
+	 *
+	 * @access    public
+	 * @param string   $orderby
+	 * @param string   $order
+	 * @param int|null $limit
+	 * @param bool     $count
+	 * @return EE_Message_Template_Group[]
+	 */
+	public function get_all_message_templates(
+		string $orderby = 'GRP_ID',
+		string $order = 'ASC',
+		int $limit = null,
+		bool $count = false
+	): array {
+		$_where = $this->_maybe_mtp_filters();
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count
+			? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
+			: $this->get_all_deleted_and_undeleted($query_params);
+	}
+
+
+	/**
+	 * This gets all the custom templates attached to a specific event
+	 *
+	 * @param int   $EVT_ID       event id
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return  EE_Message_Template_Group[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_custom_templates_by_event(int $EVT_ID, array $query_params = []): array
+	{
+		$where = array_merge($query_params, ['Event.EVT_ID' => $EVT_ID]);
+		return $this->get_all([$where]);
+	}
+
+
+	/**
+	 * get_all_trashed_grouped_message_templates
+	 * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
+	 *
+	 * @param string   $orderby
+	 * @param string   $order
+	 * @param int|null $limit
+	 * @param bool     $count
+	 * @param bool     $global
+	 * @return EE_Message_Template_Group[]|int message template groups.
+	 */
+	public function get_all_trashed_grouped_message_templates(
+		string $orderby = 'GRP_ID',
+		string $order = 'ASC',
+		int $limit = null,
+		bool $count = false,
+		bool $global = true
+	) {
+		$_where                  = $global ? ['MTP_is_global' => true] : ['MTP_is_global' => false];
+		$_where['MTP_is_active'] = true;
+		$_where                  = $this->_maybe_mtp_filters($_where);
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count
+			? $this->count_deleted($query_params, 'GRP_ID', true)
+			: $this->get_all_deleted($query_params);
+	}
+
+
+	/**
+	 * this returns the message template group(s) for a given event, messenger, and message template
+	 *
+	 * @param string   $messenger
+	 * @param string   $message_type
+	 * @param int      $evt_id
+	 * @param string   $orderby pointless at this point but still included
+	 * @param string   $order
+	 * @param int|null $limit
+	 * @param bool     $count   true = just return count, false = objects
+	 * @param bool     $active  ignore "active" or not. (default only return active)
+	 * @return EE_Message_Template_Group[]|int depending on $count.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_event_message_templates_by_m_and_mt_and_evt(
+		string $messenger,
+		string $message_type,
+		int $evt_id,
+		string $orderby = 'GRP_ID',
+		string $order = 'ASC',
+		int $limit = null,
+		bool $count = false,
+		bool $active = true
+	) {
+		$_where = [
+			'MTP_messenger'    => $messenger,
+			'MTP_message_type' => $message_type,
+			'Event.EVT_ID'     => $evt_id,
+			'MTP_is_global'    => true,
+			'MTP_is_active'    => $active,
+		];
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count
+			? $this->count($query_params, 'GRP_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+	/**
+	 * get all GLOBAL message template groups for the given messenger and message type
+	 *
+	 * @param string   $messenger    slug for messenger
+	 * @param string   $message_type slug for message type
+	 * @param string   $orderby      what column to orderby
+	 * @param string   $order        ASC or DESC
+	 * @param int|null $limit
+	 * @param bool     $count        true = just return count, false = objects
+	 * @param bool     $active       ignore "active" or not. (default only return active) -
+	 *                               'all' means return both inactive AND inactive.
+	 * @return EE_Message_Template_Group[]|int               message template objects that are global (i.e. non-event)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_global_message_template_by_m_and_mt(
+		string $messenger,
+		string $message_type,
+		string $orderby = 'GRP_ID',
+		string $order = 'ASC',
+		int $limit = null,
+		bool $count = false,
+		bool $active = true
+	) {
+		$_where = [
+			'MTP_messenger'    => $messenger,
+			'MTP_message_type' => $message_type,
+			'MTP_is_global'    => true,
+		];
+
+		if ($active != 'all') {
+			$_where['MTP_is_active'] = $active;
+		}
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count
+			? $this->count($query_params, 'GRP_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+	/**
+	 * get all custom message template groups for the given messenger and message type
+	 *
+	 * @param string $messenger
+	 * @param string $message_type
+	 * @param array  $query_params same as EEM_Base->get_all()
+	 * @return EE_Message_Template_Group[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_custom_message_template_by_m_and_mt(string $messenger, string $message_type, array $query_params = []): array
+	{
+		return $this->get_all(
+			array_merge(
+				$query_params,
+				[
+					[
+						'MTP_is_global'    => false,
+						'MTP_messenger'    => $messenger,
+						'MTP_message_type' => $message_type,
+					],
+				]
+			)
+		);
+	}
+
+
+	/**
+	 * This sends things to the validator for the given messenger and message type.
+	 *
+	 * @param array  $fields       the incoming fields to check.
+	 *                             Note this array is in the formatted fields from the form fields setup.
+	 *                             So we need to reformat this into an array of expected field refs by the validator.
+	 *                             Note also that this is not only the fields for the Message Template Group
+	 *                             but ALSO for Message Template.
+	 * @param string $context      The context the fields were obtained from.
+	 * @param string $messenger    The messenger we are validating
+	 * @param string $message_type The message type we are validating.
+	 * @return mixed If the fields all check out then we return true otherwise error messages are returned
+	 *                             (indexed by field name);
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function validate(array $fields, string $context, string $messenger, string $message_type)
+	{
+
+		$assembled_fields = [];
+
+		// let's loop through all the fields and set them up in the right format
+		foreach ($fields as $value) {
+			// first let's figure out if the value['content'] in the current index is an array.
+			//  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
+			if (is_array($value['content'])) {
+				$assembled_fields[ $value['name'] ] = $value['content']['main'];
+				// loop through the content and get the other fields.
+				foreach ($value['content'] as $name => $val) {
+					if ($name == 'main') {
+						continue;
+					}
+					$assembled_fields[ $name ] = $val;
+				}
+				continue;
+			}
+
+			// okay if we're here then this is just a straight field=>$value arrangement
+			$assembled_fields[ $value['name'] ] = $value['content'];
+		}
+
+		// now we've got the assembled_fields.
+		// We need to setup the string for the appropriate validator class and call that.
+		$m_ref  = ucwords(str_replace('_', ' ', $messenger));
+		$m_ref  = str_replace(' ', '_', $m_ref);
+		$mt_ref = ucwords(str_replace('_', ' ', $message_type));
+		$mt_ref = str_replace(' ', '_', $mt_ref);
+
+		$classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
+
+		if (! class_exists($classname)) {
+			$msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
+			$msg[] = sprintf(
+				esc_html__(
+					'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
+					'event_espresso'
+				),
+				$classname
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+
+		$a      = new ReflectionClass($classname);
+		$_VLD   = $a->newInstance($assembled_fields, $context);
+		return $_VLD->validate();
+	}
+
+
+	/**
+	 * Updates all message template groups matching the incoming arguments to inactive status.
+	 *
+	 * @param array $messenger_names    The messenger slugs.
+	 *                                  If empty then all templates matching the message types are marked inactive.
+	 *                                  Otherwise only templates matching the messengers and message types.
+	 * @param array $message_type_names The message type slugs.
+	 *                                  If empty then all templates matching the messengers are marked inactive.
+	 *                                  Otherwise only templates matching the messengers and message types.
+	 *
+	 * @return int  count of updated records.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function deactivate_message_template_groups_for(
+		array $messenger_names = [],
+		array $message_type_names = []
+	): int {
+		$query_args = [];
+		if (empty($messenger_names) && empty($message_type_names)) {
+			return 0;
+		}
+		if (! empty($messenger_names)) {
+			$query_args[0]['MTP_messenger'] = ['IN', $messenger_names];
+		}
+		if (! empty($message_type_names)) {
+			$query_args[0]['MTP_message_type'] = ['IN', $message_type_names];
+		}
+		return $this->update(['MTP_is_active' => false], $query_args);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -88,7 +88,7 @@ 
             'WP_User'          => new EE_Belongs_To_Relation(),
         ];
         foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+            $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_Global('MTP_is_global');
         }
         $this->_caps_slug = 'messages';
 
@@ -418,19 +418,19 @@ 
             // first let's figure out if the value['content'] in the current index is an array.
             //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
             if (is_array($value['content'])) {
-                $assembled_fields[ $value['name'] ] = $value['content']['main'];
+                $assembled_fields[$value['name']] = $value['content']['main'];
                 // loop through the content and get the other fields.
                 foreach ($value['content'] as $name => $val) {
                     if ($name == 'main') {
                         continue;
                     }
-                    $assembled_fields[ $name ] = $val;
+                    $assembled_fields[$name] = $val;
                 }
                 continue;
             }
 
             // okay if we're here then this is just a straight field=>$value arrangement
-            $assembled_fields[ $value['name'] ] = $value['content'];
+            $assembled_fields[$value['name']] = $value['content'];
         }
 
         // now we've got the assembled_fields.
@@ -440,9 +440,9 @@ 
         $mt_ref = ucwords(str_replace('_', ' ', $message_type));
         $mt_ref = str_replace(' ', '_', $mt_ref);
 
-        $classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
+        $classname = 'EE_Messages_'.$m_ref.'_'.$mt_ref.'_Validator';
 
-        if (! class_exists($classname)) {
+        if ( ! class_exists($classname)) {
             $msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
             $msg[] = sprintf(
                 esc_html__(
@@ -482,10 +482,10 @@ 
         if (empty($messenger_names) && empty($message_type_names)) {
             return 0;
         }
-        if (! empty($messenger_names)) {
+        if ( ! empty($messenger_names)) {
             $query_args[0]['MTP_messenger'] = ['IN', $messenger_names];
         }
-        if (! empty($message_type_names)) {
+        if ( ! empty($message_type_names)) {
             $query_args[0]['MTP_message_type'] = ['IN', $message_type_names];
         }
         return $this->update(['MTP_is_active' => false], $query_args);