eventespresso / event-espresso-core

core/db_models/EEM_Change_Log.model.php

Spacing +7 added lines, -7 removed lines

@@ -113,17 +113,17 @@ 
                 ),
             ),
         );
-        $this->_model_relations    = array();
+        $this->_model_relations = array();
         foreach ($models_this_can_attach_to as $model) {
             if ($model != 'Change_Log') {
-                $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
+                $this->_model_relations[$model] = new EE_Belongs_To_Any_Relation();
             }
         }
         // use completely custom caps for this
         $this->_cap_restriction_generators = false;
         // caps-wise this is all-or-nothing: if you have the default role you can access anything, otherwise nothing
         foreach ($this->_cap_contexts_to_cap_action_map as $cap_context => $action) {
-            $this->_cap_restrictions[ $cap_context ][ EE_Restriction_Generator_Base::get_default_restrictions_cap() ]
+            $this->_cap_restrictions[$cap_context][EE_Restriction_Generator_Base::get_default_restrictions_cap()]
                 = new EE_Return_None_Where_Conditions();
         }
         parent::__construct($timezone);
@@ -168,7 +168,7 @@ 
      */
     public function gateway_log($message, $related_obj_id, $related_obj_type)
     {
-        if (! EE_Registry::instance()->is_model_name($related_obj_type)) {
+        if ( ! EE_Registry::instance()->is_model_name($related_obj_type)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -217,7 +217,7 @@ 
         global $wpdb;
         return $wpdb->query(
             $wpdb->prepare(
-                'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s',
+                'DELETE FROM '.$this->table().' WHERE LOG_type = %s AND LOG_time < %s',
                 EEM_Change_Log::type_gateway,
                 $datetime->format(EE_Datetime_Field::mysql_timestamp_format)
             )
@@ -256,8 +256,8 @@ 
     {
         $type_identifier_map = self::get_pretty_label_map_for_registered_types();
         // we fallback to the incoming type identifier if there is no localized label for it.
-        return isset($type_identifier_map[ $type_identifier ])
-            ? $type_identifier_map[ $type_identifier ]
+        return isset($type_identifier_map[$type_identifier])
+            ? $type_identifier_map[$type_identifier]
             : $type_identifier;
     }
 }

Indentation +227 added lines, -227 removed lines

@@ -11,93 +11,93 @@ 
 class EEM_Change_Log extends EEM_Base
 {
 
-    /**
-     * the related object was created log type
-     */
-    const type_create = 'create';
-    /**
-     * the related object was updated (changed, or soft-deleted)
-     */
-    const type_update = 'update';
-    /**
-     * the related object was deleted permanently
-     */
-    const type_delete = 'delete';
-    /**
-     * the related item had something worth noting happen on it, but
-     * only for the purposes of debugging problems
-     */
-    const type_debug = 'debug';
-    /**
-     * the related item had an error occur on it
-     */
-    const type_error = 'error';
-    /**
-     * the related item is regarding some gateway interaction, like an IPN
-     * or request to process a payment
-     */
-    const type_gateway = 'gateway';
+	/**
+	 * the related object was created log type
+	 */
+	const type_create = 'create';
+	/**
+	 * the related object was updated (changed, or soft-deleted)
+	 */
+	const type_update = 'update';
+	/**
+	 * the related object was deleted permanently
+	 */
+	const type_delete = 'delete';
+	/**
+	 * the related item had something worth noting happen on it, but
+	 * only for the purposes of debugging problems
+	 */
+	const type_debug = 'debug';
+	/**
+	 * the related item had an error occur on it
+	 */
+	const type_error = 'error';
+	/**
+	 * the related item is regarding some gateway interaction, like an IPN
+	 * or request to process a payment
+	 */
+	const type_gateway = 'gateway';
 
-    /**
-     * private instance of the EEM_Change_Log object
-     *
-     * @access private
-     * @var EEM_Change_Log $_instance
-     */
-    protected static $_instance = null;
+	/**
+	 * private instance of the EEM_Change_Log object
+	 *
+	 * @access private
+	 * @var EEM_Change_Log $_instance
+	 */
+	protected static $_instance = null;
 
 
-    /**
-     * constructor
-     *
-     * @access protected
-     * @param null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        global $current_user;
-        $this->singular_item       = esc_html__('Log', 'event_espresso');
-        $this->plural_item         = esc_html__('Logs', 'event_espresso');
-        $this->_tables             = array(
-            'Log' => new EE_Primary_Table('esp_log', 'LOG_ID'),
-        );
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
-        $this->_fields             = array(
-            'Log' => array(
-                'LOG_ID'      => new EE_Primary_Key_Int_Field('LOG_ID', esc_html__('Log ID', 'event_espresso')),
-                'LOG_time'    => new EE_Datetime_Field(
-                    'LOG_time',
-                    esc_html__("Log Time", 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'OBJ_ID'      => new EE_Foreign_Key_String_Field(
-                    'OBJ_ID',
-                    esc_html__("Object ID (int or string)", 'event_espresso'),
-                    true,
-                    null,
-                    $models_this_can_attach_to
-                ),
-                'OBJ_type'    => new EE_Any_Foreign_Model_Name_Field(
-                    'OBJ_type',
-                    esc_html__("Object Type", 'event_espresso'),
-                    true,
-                    null,
-                    $models_this_can_attach_to
-                ),
-                'LOG_type'    => new EE_Plain_Text_Field(
-                    'LOG_type',
-                    esc_html__("Type of log entry", "event_espresso"),
-                    false,
-                    self::type_debug
-                ),
-                'LOG_message' => new EE_Maybe_Serialized_Text_Field(
-                    'LOG_message',
-                    esc_html__("Log Message (body)", 'event_espresso'),
-                    true
-                ),
-                /*
+	/**
+	 * constructor
+	 *
+	 * @access protected
+	 * @param null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		global $current_user;
+		$this->singular_item       = esc_html__('Log', 'event_espresso');
+		$this->plural_item         = esc_html__('Logs', 'event_espresso');
+		$this->_tables             = array(
+			'Log' => new EE_Primary_Table('esp_log', 'LOG_ID'),
+		);
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
+		$this->_fields             = array(
+			'Log' => array(
+				'LOG_ID'      => new EE_Primary_Key_Int_Field('LOG_ID', esc_html__('Log ID', 'event_espresso')),
+				'LOG_time'    => new EE_Datetime_Field(
+					'LOG_time',
+					esc_html__("Log Time", 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'OBJ_ID'      => new EE_Foreign_Key_String_Field(
+					'OBJ_ID',
+					esc_html__("Object ID (int or string)", 'event_espresso'),
+					true,
+					null,
+					$models_this_can_attach_to
+				),
+				'OBJ_type'    => new EE_Any_Foreign_Model_Name_Field(
+					'OBJ_type',
+					esc_html__("Object Type", 'event_espresso'),
+					true,
+					null,
+					$models_this_can_attach_to
+				),
+				'LOG_type'    => new EE_Plain_Text_Field(
+					'LOG_type',
+					esc_html__("Type of log entry", "event_espresso"),
+					false,
+					self::type_debug
+				),
+				'LOG_message' => new EE_Maybe_Serialized_Text_Field(
+					'LOG_message',
+					esc_html__("Log Message (body)", 'event_espresso'),
+					true
+				),
+				/*
                  * Note: when querying for a change log's user, the OBJ_ID and OBJ_type fields are used,
                  * not the LOG_wp_user field. E.g.,
                  * `EEM_Change_Log::instance()->get_all(array(array('WP_User.ID'=>1)))` will actually return
@@ -106,158 +106,158 @@ 
                  *  If you want the latter, you can't use the model's magic joining. E.g, you would need to do
                  * `EEM_Change_Log::instance()->get_all(array(array('LOG_wp_user' => 1)))`.
                  */
-                'LOG_wp_user' => new EE_WP_User_Field(
-                    'LOG_wp_user',
-                    esc_html__("User who was logged in while this occurred", 'event_espresso'),
-                    true
-                ),
-            ),
-        );
-        $this->_model_relations    = array();
-        foreach ($models_this_can_attach_to as $model) {
-            if ($model != 'Change_Log') {
-                $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
-            }
-        }
-        // use completely custom caps for this
-        $this->_cap_restriction_generators = false;
-        // caps-wise this is all-or-nothing: if you have the default role you can access anything, otherwise nothing
-        foreach ($this->_cap_contexts_to_cap_action_map as $cap_context => $action) {
-            $this->_cap_restrictions[ $cap_context ][ EE_Restriction_Generator_Base::get_default_restrictions_cap() ]
-                = new EE_Return_None_Where_Conditions();
-        }
-        parent::__construct($timezone);
-    }
+				'LOG_wp_user' => new EE_WP_User_Field(
+					'LOG_wp_user',
+					esc_html__("User who was logged in while this occurred", 'event_espresso'),
+					true
+				),
+			),
+		);
+		$this->_model_relations    = array();
+		foreach ($models_this_can_attach_to as $model) {
+			if ($model != 'Change_Log') {
+				$this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
+			}
+		}
+		// use completely custom caps for this
+		$this->_cap_restriction_generators = false;
+		// caps-wise this is all-or-nothing: if you have the default role you can access anything, otherwise nothing
+		foreach ($this->_cap_contexts_to_cap_action_map as $cap_context => $action) {
+			$this->_cap_restrictions[ $cap_context ][ EE_Restriction_Generator_Base::get_default_restrictions_cap() ]
+				= new EE_Return_None_Where_Conditions();
+		}
+		parent::__construct($timezone);
+	}
 
-    /**
-     * @param string        $log_type !see the acceptable values of LOG_type in EEM__Change_Log::__construct
-     * @param mixed         $message  array|string of the message you want to record
-     * @param EE_Base_Class $related_model_obj
-     * @return EE_Change_Log
-     * @throws EE_Error
-     */
-    public function log($log_type, $message, $related_model_obj)
-    {
-        if ($related_model_obj instanceof EE_Base_Class) {
-            $obj_id   = $related_model_obj->ID();
-            $obj_type = $related_model_obj->get_model()->get_this_model_name();
-        } else {
-            $obj_id   = null;
-            $obj_type = null;
-        }
-        /** @var EE_Change_Log $log */
-        $log = EE_Change_Log::new_instance(array(
-            'LOG_type'    => $log_type,
-            'LOG_message' => $message,
-            'OBJ_ID'      => $obj_id,
-            'OBJ_type'    => $obj_type,
-        ));
-        $log->save();
-        return $log;
-    }
+	/**
+	 * @param string        $log_type !see the acceptable values of LOG_type in EEM__Change_Log::__construct
+	 * @param mixed         $message  array|string of the message you want to record
+	 * @param EE_Base_Class $related_model_obj
+	 * @return EE_Change_Log
+	 * @throws EE_Error
+	 */
+	public function log($log_type, $message, $related_model_obj)
+	{
+		if ($related_model_obj instanceof EE_Base_Class) {
+			$obj_id   = $related_model_obj->ID();
+			$obj_type = $related_model_obj->get_model()->get_this_model_name();
+		} else {
+			$obj_id   = null;
+			$obj_type = null;
+		}
+		/** @var EE_Change_Log $log */
+		$log = EE_Change_Log::new_instance(array(
+			'LOG_type'    => $log_type,
+			'LOG_message' => $message,
+			'OBJ_ID'      => $obj_id,
+			'OBJ_type'    => $obj_type,
+		));
+		$log->save();
+		return $log;
+	}
 
 
-    /**
-     * Adds a gateway log for the specified object, given its ID and type
-     *
-     * @param string $message
-     * @param mixed  $related_obj_id
-     * @param string $related_obj_type
-     * @throws EE_Error
-     * @return EE_Change_Log
-     */
-    public function gateway_log($message, $related_obj_id, $related_obj_type)
-    {
-        if (! EE_Registry::instance()->is_model_name($related_obj_type)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "'%s' is not a model name. A model name must be provided when making a gateway log. Eg, 'Payment', 'Payment_Method', etc",
-                        "event_espresso"
-                    ),
-                    $related_obj_type
-                )
-            );
-        }
-        /** @var EE_Change_Log $log */
-        $log = EE_Change_Log::new_instance(array(
-            'LOG_type'    => EEM_Change_Log::type_gateway,
-            'LOG_message' => $message,
-            'OBJ_ID'      => $related_obj_id,
-            'OBJ_type'    => $related_obj_type,
-        ));
-        $log->save();
-        return $log;
-    }
+	/**
+	 * Adds a gateway log for the specified object, given its ID and type
+	 *
+	 * @param string $message
+	 * @param mixed  $related_obj_id
+	 * @param string $related_obj_type
+	 * @throws EE_Error
+	 * @return EE_Change_Log
+	 */
+	public function gateway_log($message, $related_obj_id, $related_obj_type)
+	{
+		if (! EE_Registry::instance()->is_model_name($related_obj_type)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"'%s' is not a model name. A model name must be provided when making a gateway log. Eg, 'Payment', 'Payment_Method', etc",
+						"event_espresso"
+					),
+					$related_obj_type
+				)
+			);
+		}
+		/** @var EE_Change_Log $log */
+		$log = EE_Change_Log::new_instance(array(
+			'LOG_type'    => EEM_Change_Log::type_gateway,
+			'LOG_message' => $message,
+			'OBJ_ID'      => $related_obj_id,
+			'OBJ_type'    => $related_obj_type,
+		));
+		$log->save();
+		return $log;
+	}
 
 
-    /**
-     * Just gets the bare-bones wpdb results as an array in cases where efficiency is essential
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array of arrays
-     * @throws EE_Error
-     */
-    public function get_all_efficiently($query_params)
-    {
-        return $this->_get_all_wpdb_results($query_params);
-    }
+	/**
+	 * Just gets the bare-bones wpdb results as an array in cases where efficiency is essential
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array of arrays
+	 * @throws EE_Error
+	 */
+	public function get_all_efficiently($query_params)
+	{
+		return $this->_get_all_wpdb_results($query_params);
+	}
 
 
-    /**
-     * Executes a database query to delete gateway logs. Does not affect model objects, so if you attempt to use
-     * models after this, they may be out-of-sync with the database
-     *
-     * @param DateTime $datetime
-     * @return false|int
-     * @throws EE_Error
-     */
-    public function delete_gateway_logs_older_than(DateTime $datetime)
-    {
-        global $wpdb;
-        return $wpdb->query(
-            $wpdb->prepare(
-                'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s',
-                EEM_Change_Log::type_gateway,
-                $datetime->format(EE_Datetime_Field::mysql_timestamp_format)
-            )
-        );
-    }
+	/**
+	 * Executes a database query to delete gateway logs. Does not affect model objects, so if you attempt to use
+	 * models after this, they may be out-of-sync with the database
+	 *
+	 * @param DateTime $datetime
+	 * @return false|int
+	 * @throws EE_Error
+	 */
+	public function delete_gateway_logs_older_than(DateTime $datetime)
+	{
+		global $wpdb;
+		return $wpdb->query(
+			$wpdb->prepare(
+				'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s',
+				EEM_Change_Log::type_gateway,
+				$datetime->format(EE_Datetime_Field::mysql_timestamp_format)
+			)
+		);
+	}
 
 
-    /**
-     * Returns the map of type to pretty label for identifiers used for `LOG_type`.  Client code can register their own
-     * map vai the given filter.
-     *
-     * @return array
-     */
-    public static function get_pretty_label_map_for_registered_types()
-    {
-        return apply_filters(
-            'FHEE__EEM_Change_Log__get_pretty_label_map_for_registered_types',
-            array(
-                self::type_create =>  esc_html__("Create", "event_espresso"),
-                self::type_update =>  esc_html__("Update", "event_espresso"),
-                self::type_delete => esc_html__("Delete", "event_espresso"),
-                self::type_debug =>  esc_html__("Debug", "event_espresso"),
-                self::type_error =>  esc_html__("Error", "event_espresso"),
-                self::type_gateway => esc_html__("Gateway Interaction (IPN or Direct Payment)", 'event_espresso')
-            )
-        );
-    }
+	/**
+	 * Returns the map of type to pretty label for identifiers used for `LOG_type`.  Client code can register their own
+	 * map vai the given filter.
+	 *
+	 * @return array
+	 */
+	public static function get_pretty_label_map_for_registered_types()
+	{
+		return apply_filters(
+			'FHEE__EEM_Change_Log__get_pretty_label_map_for_registered_types',
+			array(
+				self::type_create =>  esc_html__("Create", "event_espresso"),
+				self::type_update =>  esc_html__("Update", "event_espresso"),
+				self::type_delete => esc_html__("Delete", "event_espresso"),
+				self::type_debug =>  esc_html__("Debug", "event_espresso"),
+				self::type_error =>  esc_html__("Error", "event_espresso"),
+				self::type_gateway => esc_html__("Gateway Interaction (IPN or Direct Payment)", 'event_espresso')
+			)
+		);
+	}
 
 
-    /**
-     * Return the pretty (localized) label for the given log type identifier.
-     * @param string $type_identifier
-     * @return string
-     */
-    public static function get_pretty_label_for_type($type_identifier)
-    {
-        $type_identifier_map = self::get_pretty_label_map_for_registered_types();
-        // we fallback to the incoming type identifier if there is no localized label for it.
-        return isset($type_identifier_map[ $type_identifier ])
-            ? $type_identifier_map[ $type_identifier ]
-            : $type_identifier;
-    }
+	/**
+	 * Return the pretty (localized) label for the given log type identifier.
+	 * @param string $type_identifier
+	 * @return string
+	 */
+	public static function get_pretty_label_for_type($type_identifier)
+	{
+		$type_identifier_map = self::get_pretty_label_map_for_registered_types();
+		// we fallback to the incoming type identifier if there is no localized label for it.
+		return isset($type_identifier_map[ $type_identifier ])
+			? $type_identifier_map[ $type_identifier ]
+			: $type_identifier;
+	}
 }

core/db_models/EEM_Extra_Meta.model.php

Spacing +2 added lines, -2 removed lines

@@ -38,10 +38,10 @@
             ));
         $this->_model_relations = array();
         foreach ($models_this_can_attach_to as $model) {
-            $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
+            $this->_model_relations[$model] = new EE_Belongs_To_Any_Relation();
         }
         foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-            $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value');
+            $this->_cap_restriction_generators[$cap_context] = new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value');
         }
         parent::__construct($timezone);
     }

Indentation +27 added lines, -27 removed lines

@@ -17,33 +17,33 @@
 class EEM_Extra_Meta extends EEM_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Extra Meta', 'event_espresso');
-        $this->plural_item = __('Extra Metas', 'event_espresso');
-        $this->_tables = array(
-            'Extra_Meta' => new EE_Primary_Table('esp_extra_meta', 'EXM_ID')
-        );
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
-        $this->_fields = array(
-            'Extra_Meta' => array(
-                'EXM_ID' => new EE_Primary_Key_Int_Field('EXM_ID', __("Extra Meta ID", "event_espresso")),
-                'OBJ_ID' => new EE_Foreign_Key_Int_Field('OBJ_ID', __("Primary Key of Attached Thing", "event_espresso"), false, 0, $models_this_can_attach_to),
-                'EXM_type' => new EE_Any_Foreign_Model_Name_Field('EXM_type', __("Model of Attached Thing", "event_espresso"), false, 'Transaction', $models_this_can_attach_to),
-                'EXM_key' => new EE_Plain_Text_Field('EXM_key', __("Meta Key", "event_espresso"), false, ''),
-                'EXM_value' => new EE_Maybe_Serialized_Text_Field('EXM_value', __("Meta Value", "event_espresso"), true)
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Extra Meta', 'event_espresso');
+		$this->plural_item = __('Extra Metas', 'event_espresso');
+		$this->_tables = array(
+			'Extra_Meta' => new EE_Primary_Table('esp_extra_meta', 'EXM_ID')
+		);
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
+		$this->_fields = array(
+			'Extra_Meta' => array(
+				'EXM_ID' => new EE_Primary_Key_Int_Field('EXM_ID', __("Extra Meta ID", "event_espresso")),
+				'OBJ_ID' => new EE_Foreign_Key_Int_Field('OBJ_ID', __("Primary Key of Attached Thing", "event_espresso"), false, 0, $models_this_can_attach_to),
+				'EXM_type' => new EE_Any_Foreign_Model_Name_Field('EXM_type', __("Model of Attached Thing", "event_espresso"), false, 'Transaction', $models_this_can_attach_to),
+				'EXM_key' => new EE_Plain_Text_Field('EXM_key', __("Meta Key", "event_espresso"), false, ''),
+				'EXM_value' => new EE_Maybe_Serialized_Text_Field('EXM_value', __("Meta Value", "event_espresso"), true)
 
-            ));
-        $this->_model_relations = array();
-        foreach ($models_this_can_attach_to as $model) {
-            $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
-        }
-        foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-            $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value');
-        }
-        parent::__construct($timezone);
-    }
+			));
+		$this->_model_relations = array();
+		foreach ($models_this_can_attach_to as $model) {
+			$this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
+		}
+		foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
+			$this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value');
+		}
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Attendee.model.php

Spacing +3 added lines, -3 removed lines

@@ -284,8 +284,8 @@ 
      */
     public function get_attendee_field_for_system_question($system_question_string)
     {
-        return isset($this->_system_question_to_attendee_field_name[ $system_question_string ])
-            ? $this->_system_question_to_attendee_field_name[ $system_question_string ]
+        return isset($this->_system_question_to_attendee_field_name[$system_question_string])
+            ? $this->_system_question_to_attendee_field_name[$system_question_string]
             : null;
     }
 
@@ -353,7 +353,7 @@ 
             return false;
         }
         $attendee = $this->get_all(array($where_cols_n_values));
-        if (! empty($attendee)) {
+        if ( ! empty($attendee)) {
             return array_shift($attendee);
         }
         return false;

Indentation +419 added lines, -419 removed lines

@@ -12,432 +12,432 @@
 class EEM_Attendee extends EEM_CPT_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
-    /**
-     * QST_system for questions are strings not integers now,
-     * so these constants are deprecated.
-     * Please instead use the EEM_Attendee::system_question_* constants
-     *
-     * @deprecated
-     */
-    const fname_question_id = 1;
+	/**
+	 * QST_system for questions are strings not integers now,
+	 * so these constants are deprecated.
+	 * Please instead use the EEM_Attendee::system_question_* constants
+	 *
+	 * @deprecated
+	 */
+	const fname_question_id = 1;
 
-    /**
-     * @deprecated
-     */
-    const lname_question_id = 2;
+	/**
+	 * @deprecated
+	 */
+	const lname_question_id = 2;
 
 
-    /**
-     * @deprecated
-     */
-    const email_question_id = 3;
+	/**
+	 * @deprecated
+	 */
+	const email_question_id = 3;
 
 
-    /**
-     * @deprecated
-     */
-    const address_question_id = 4;
+	/**
+	 * @deprecated
+	 */
+	const address_question_id = 4;
 
 
-    /**
-     * @deprecated
-     */
-    const address2_question_id = 5;
+	/**
+	 * @deprecated
+	 */
+	const address2_question_id = 5;
 
-
-    /**
-     * @deprecated
-     */
-    const city_question_id = 6;
-
-
-    /**
-     * @deprecated
-     */
-    const state_question_id = 7;
-
-
-    /**
-     * @deprecated
-     */
-    const country_question_id = 8;
-
-
-    /**
-     * @deprecated
-     */
-    const zip_question_id = 9;
-
-
-    /**
-     * @deprecated
-     */
-    const phone_question_id = 10;
-
-    /**
-     * When looking for questions that correspond to attendee fields,
-     * look for the question with this QST_system value.
-     * These replace the old constants like EEM_Attendee::*_question_id
-     */
-    const system_question_fname = 'fname';
-
-    const system_question_lname = 'lname';
-
-    const system_question_email = 'email';
-
-    const system_question_email_confirm = 'email_confirm';
-
-    const system_question_address = 'address';
-
-    const system_question_address2 = 'address2';
-
-    const system_question_city = 'city';
-
-    const system_question_state = 'state';
-
-    const system_question_country = 'country';
-
-    const system_question_zip = 'zip';
-
-    const system_question_phone = 'phone';
-
-    /**
-     * Keys are all the EEM_Attendee::system_question_* constants, which are
-     * also all the values of QST_system in the questions table, and values
-     * are their corresponding Attendee field names
-     *
-     * @var array
-     */
-    protected $_system_question_to_attendee_field_name = array(
-        EEM_Attendee::system_question_fname    => 'ATT_fname',
-        EEM_Attendee::system_question_lname    => 'ATT_lname',
-        EEM_Attendee::system_question_email    => 'ATT_email',
-        EEM_Attendee::system_question_address  => 'ATT_address',
-        EEM_Attendee::system_question_address2 => 'ATT_address2',
-        EEM_Attendee::system_question_city     => 'ATT_city',
-        EEM_Attendee::system_question_state    => 'STA_ID',
-        EEM_Attendee::system_question_country  => 'CNT_ISO',
-        EEM_Attendee::system_question_zip      => 'ATT_zip',
-        EEM_Attendee::system_question_phone    => 'ATT_phone',
-    );
-
-
-
-    /**
-     * EEM_Attendee constructor.
-     *
-     * @param null              $timezone
-     * @param ModelFieldFactory $model_field_factory
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
-    {
-        $this->singular_item = esc_html__('Attendee', 'event_espresso');
-        $this->plural_item = esc_html__('Attendees', 'event_espresso');
-        $this->_tables = array(
-            'Attendee_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Attendee_Meta' => new EE_Secondary_Table(
-                'esp_attendee_meta',
-                'ATTM_ID',
-                'ATT_ID'
-            ),
-        );
-        $this->_fields = array(
-            'Attendee_CPT'  => array(
-                'ATT_ID'        => $model_field_factory->createPrimaryKeyIntField(
-                    'ID',
-                    esc_html__('Attendee ID', 'event_espresso')
-                ),
-                'ATT_full_name' => $model_field_factory->createPlainTextField(
-                    'post_title',
-                    esc_html__('Attendee Full Name', 'event_espresso'),
-                    false,
-                    esc_html__('Unknown', 'event_espresso')
-                ),
-                'ATT_bio'       => $model_field_factory->createPostContentField(
-                    'post_content',
-                    esc_html__('Attendee Biography', 'event_espresso'),
-                    false,
-                    esc_html__('No Biography Provided', 'event_espresso')
-                ),
-                'ATT_slug'      => $model_field_factory->createSlugField(
-                    'post_name',
-                    esc_html__('Attendee URL Slug', 'event_espresso')
-                ),
-                'ATT_created'   => $model_field_factory->createDatetimeField(
-                    'post_date',
-                    esc_html__('Time Attendee Created', 'event_espresso')
-                ),
-                'ATT_short_bio' => $model_field_factory->createSimpleHtmlField(
-                    'post_excerpt',
-                    esc_html__('Attendee Short Biography', 'event_espresso'),
-                    true,
-                    esc_html__('No Biography Provided', 'event_espresso')
-                ),
-                'ATT_modified'  => $model_field_factory->createDatetimeField(
-                    'post_modified',
-                    esc_html__('Time Attendee Last Modified', 'event_espresso')
-                ),
-                'ATT_author'    => $model_field_factory->createWpUserField(
-                    'post_author',
-                    esc_html__('Creator ID of the first Event attended', 'event_espresso'),
-                    false
-                ),
-                'ATT_parent'    => $model_field_factory->createDbOnlyIntField(
-                    'post_parent',
-                    esc_html__('Parent Attendee (unused)', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'post_type'     => $model_field_factory->createWpPostTypeField('espresso_attendees'),
-                'status'        => $model_field_factory->createWpPostStatusField(
-                    'post_status',
-                    esc_html__('Attendee Status', 'event_espresso'),
-                    false,
-                    'publish'
-                ),
-                'password' => new EE_Password_Field(
-                    'post_password',
-                    __('Password', 'event_espresso'),
-                    false,
-                    '',
-                    array(
-                        'ATT_bio',
-                        'ATT_short_bio',
-                        'ATT_address',
-                        'ATT_address2',
-                        'ATT_city',
-                        'STA_ID',
-                        'CNT_ISO',
-                        'ATT_zip',
-                        'ATT_email',
-                        'ATT_phone'
-                    )
-                )
-            ),
-            'Attendee_Meta' => array(
-                'ATTM_ID'      => $model_field_factory->createDbOnlyIntField(
-                    'ATTM_ID',
-                    esc_html__('Attendee Meta Row ID', 'event_espresso'),
-                    false
-                ),
-                'ATT_ID_fk'    => $model_field_factory->createDbOnlyIntField(
-                    'ATT_ID',
-                    esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'),
-                    false
-                ),
-                'ATT_fname'    => $model_field_factory->createPlainTextField(
-                    'ATT_fname',
-                    esc_html__('First Name', 'event_espresso')
-                ),
-                'ATT_lname'    => $model_field_factory->createPlainTextField(
-                    'ATT_lname',
-                    esc_html__('Last Name', 'event_espresso')
-                ),
-                'ATT_address'  => $model_field_factory->createPlainTextField(
-                    'ATT_address',
-                    esc_html__('Address Part 1', 'event_espresso')
-                ),
-                'ATT_address2' => $model_field_factory->createPlainTextField(
-                    'ATT_address2',
-                    esc_html__('Address Part 2', 'event_espresso')
-                ),
-                'ATT_city'     => $model_field_factory->createPlainTextField(
-                    'ATT_city',
-                    esc_html__('City', 'event_espresso')
-                ),
-                'STA_ID'       => $model_field_factory->createForeignKeyIntField(
-                    'STA_ID',
-                    esc_html__('State', 'event_espresso'),
-                    true,
-                    0,
-                    'State'
-                ),
-                'CNT_ISO'      => $model_field_factory->createForeignKeyStringField(
-                    'CNT_ISO',
-                    esc_html__('Country', 'event_espresso'),
-                    true,
-                    '',
-                    'Country'
-                ),
-                'ATT_zip'      => $model_field_factory->createPlainTextField(
-                    'ATT_zip',
-                    esc_html__('ZIP/Postal Code', 'event_espresso')
-                ),
-                'ATT_email'    => $model_field_factory->createEmailField(
-                    'ATT_email',
-                    esc_html__('Email Address', 'event_espresso')
-                ),
-                'ATT_phone'    => $model_field_factory->createPlainTextField(
-                    'ATT_phone',
-                    esc_html__('Phone', 'event_espresso')
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration'      => new EE_Has_Many_Relation(),
-            'State'             => new EE_Belongs_To_Relation(),
-            'Country'           => new EE_Belongs_To_Relation(),
-            'Event'             => new EE_HABTM_Relation('Registration', false),
-            'WP_User'           => new EE_Belongs_To_Relation(),
-            'Message'           => new EE_Has_Many_Any_Relation(false),
-            // allow deletion of attendees even if they have messages in the queue for them.
-            'Term_Relationship' => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
-        );
-        $this->_caps_slug = 'contacts';
-        $this->model_chain_to_password = '';
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Gets the name of the field on the attendee model corresponding to the system question string
-     * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name
-     *
-     * @param string $system_question_string
-     * @return string|null if not found
-     */
-    public function get_attendee_field_for_system_question($system_question_string)
-    {
-        return isset($this->_system_question_to_attendee_field_name[ $system_question_string ])
-            ? $this->_system_question_to_attendee_field_name[ $system_question_string ]
-            : null;
-    }
-
-
-
-    /**
-     * Gets mapping from esp_question.QST_system values to their corresponding attendee field names
-     *
-     * @return array
-     */
-    public function system_question_to_attendee_field_mapping()
-    {
-        return $this->_system_question_to_attendee_field_name;
-    }
-
-
-
-    /**
-     * Gets all the attendees for a transaction (by using the esp_registration as a join table)
-     *
-     * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID
-     * @return EE_Attendee[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_attendees_for_transaction($transaction_id_or_obj)
-    {
-        return $this->get_all(
-            array(
-                array(
-                    'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction
-                        ? $transaction_id_or_obj->ID()
-                        : $transaction_id_or_obj,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * retrieve  a single attendee from db via their ID
-     *
-     * @param $ATT_ID
-     * @return mixed array on success, FALSE on fail
-     * @deprecated
-     */
-    public function get_attendee_by_ID($ATT_ID = false)
-    {
-        // retrieve a particular EE_Attendee
-        return $this->get_one_by_ID($ATT_ID);
-    }
-
-
-
-    /**
-     * retrieve  a single attendee from db via their ID
-     *
-     * @param array $where_cols_n_values
-     * @return mixed array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function get_attendee($where_cols_n_values = array())
-    {
-        if (empty($where_cols_n_values)) {
-            return false;
-        }
-        $attendee = $this->get_all(array($where_cols_n_values));
-        if (! empty($attendee)) {
-            return array_shift($attendee);
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Search for an existing Attendee record in the DB
-     *
-     * @param array $where_cols_n_values
-     * @return bool|mixed
-     * @throws EE_Error
-     */
-    public function find_existing_attendee($where_cols_n_values = null)
-    {
-        // search by combo of first and last names plus the email address
-        $attendee_data_keys = array(
-            'ATT_fname' => $this->_ATT_fname,
-            'ATT_lname' => $this->_ATT_lname,
-            'ATT_email' => $this->_ATT_email,
-        );
-        // no search params means attendee object already exists.
-        $where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values)
-            ? $where_cols_n_values
-            : $attendee_data_keys;
-        $valid_data = true;
-        // check for required values
-        $valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname'])
-            ? $valid_data
-            : false;
-        $valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname'])
-            ? $valid_data
-            : false;
-        $valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email'])
-            ? $valid_data
-            : false;
-        if ($valid_data) {
-            $attendee = $this->get_attendee($where_cols_n_values);
-            if ($attendee instanceof EE_Attendee) {
-                return $attendee;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Takes an incoming array of EE_Registration ids
-     * and sends back a list of corresponding non duplicate EE_Attendee objects.
-     *
-     * @since  4.3.0
-     * @param  array $ids array of EE_Registration ids
-     * @return EE_Attendee[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_array_of_contacts_from_reg_ids($ids)
-    {
-        $ids = (array) $ids;
-        $_where = array(
-            'Registration.REG_ID' => array('in', $ids),
-        );
-        return $this->get_all(array($_where));
-    }
+
+	/**
+	 * @deprecated
+	 */
+	const city_question_id = 6;
+
+
+	/**
+	 * @deprecated
+	 */
+	const state_question_id = 7;
+
+
+	/**
+	 * @deprecated
+	 */
+	const country_question_id = 8;
+
+
+	/**
+	 * @deprecated
+	 */
+	const zip_question_id = 9;
+
+
+	/**
+	 * @deprecated
+	 */
+	const phone_question_id = 10;
+
+	/**
+	 * When looking for questions that correspond to attendee fields,
+	 * look for the question with this QST_system value.
+	 * These replace the old constants like EEM_Attendee::*_question_id
+	 */
+	const system_question_fname = 'fname';
+
+	const system_question_lname = 'lname';
+
+	const system_question_email = 'email';
+
+	const system_question_email_confirm = 'email_confirm';
+
+	const system_question_address = 'address';
+
+	const system_question_address2 = 'address2';
+
+	const system_question_city = 'city';
+
+	const system_question_state = 'state';
+
+	const system_question_country = 'country';
+
+	const system_question_zip = 'zip';
+
+	const system_question_phone = 'phone';
+
+	/**
+	 * Keys are all the EEM_Attendee::system_question_* constants, which are
+	 * also all the values of QST_system in the questions table, and values
+	 * are their corresponding Attendee field names
+	 *
+	 * @var array
+	 */
+	protected $_system_question_to_attendee_field_name = array(
+		EEM_Attendee::system_question_fname    => 'ATT_fname',
+		EEM_Attendee::system_question_lname    => 'ATT_lname',
+		EEM_Attendee::system_question_email    => 'ATT_email',
+		EEM_Attendee::system_question_address  => 'ATT_address',
+		EEM_Attendee::system_question_address2 => 'ATT_address2',
+		EEM_Attendee::system_question_city     => 'ATT_city',
+		EEM_Attendee::system_question_state    => 'STA_ID',
+		EEM_Attendee::system_question_country  => 'CNT_ISO',
+		EEM_Attendee::system_question_zip      => 'ATT_zip',
+		EEM_Attendee::system_question_phone    => 'ATT_phone',
+	);
+
+
+
+	/**
+	 * EEM_Attendee constructor.
+	 *
+	 * @param null              $timezone
+	 * @param ModelFieldFactory $model_field_factory
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
+	{
+		$this->singular_item = esc_html__('Attendee', 'event_espresso');
+		$this->plural_item = esc_html__('Attendees', 'event_espresso');
+		$this->_tables = array(
+			'Attendee_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Attendee_Meta' => new EE_Secondary_Table(
+				'esp_attendee_meta',
+				'ATTM_ID',
+				'ATT_ID'
+			),
+		);
+		$this->_fields = array(
+			'Attendee_CPT'  => array(
+				'ATT_ID'        => $model_field_factory->createPrimaryKeyIntField(
+					'ID',
+					esc_html__('Attendee ID', 'event_espresso')
+				),
+				'ATT_full_name' => $model_field_factory->createPlainTextField(
+					'post_title',
+					esc_html__('Attendee Full Name', 'event_espresso'),
+					false,
+					esc_html__('Unknown', 'event_espresso')
+				),
+				'ATT_bio'       => $model_field_factory->createPostContentField(
+					'post_content',
+					esc_html__('Attendee Biography', 'event_espresso'),
+					false,
+					esc_html__('No Biography Provided', 'event_espresso')
+				),
+				'ATT_slug'      => $model_field_factory->createSlugField(
+					'post_name',
+					esc_html__('Attendee URL Slug', 'event_espresso')
+				),
+				'ATT_created'   => $model_field_factory->createDatetimeField(
+					'post_date',
+					esc_html__('Time Attendee Created', 'event_espresso')
+				),
+				'ATT_short_bio' => $model_field_factory->createSimpleHtmlField(
+					'post_excerpt',
+					esc_html__('Attendee Short Biography', 'event_espresso'),
+					true,
+					esc_html__('No Biography Provided', 'event_espresso')
+				),
+				'ATT_modified'  => $model_field_factory->createDatetimeField(
+					'post_modified',
+					esc_html__('Time Attendee Last Modified', 'event_espresso')
+				),
+				'ATT_author'    => $model_field_factory->createWpUserField(
+					'post_author',
+					esc_html__('Creator ID of the first Event attended', 'event_espresso'),
+					false
+				),
+				'ATT_parent'    => $model_field_factory->createDbOnlyIntField(
+					'post_parent',
+					esc_html__('Parent Attendee (unused)', 'event_espresso'),
+					false,
+					0
+				),
+				'post_type'     => $model_field_factory->createWpPostTypeField('espresso_attendees'),
+				'status'        => $model_field_factory->createWpPostStatusField(
+					'post_status',
+					esc_html__('Attendee Status', 'event_espresso'),
+					false,
+					'publish'
+				),
+				'password' => new EE_Password_Field(
+					'post_password',
+					__('Password', 'event_espresso'),
+					false,
+					'',
+					array(
+						'ATT_bio',
+						'ATT_short_bio',
+						'ATT_address',
+						'ATT_address2',
+						'ATT_city',
+						'STA_ID',
+						'CNT_ISO',
+						'ATT_zip',
+						'ATT_email',
+						'ATT_phone'
+					)
+				)
+			),
+			'Attendee_Meta' => array(
+				'ATTM_ID'      => $model_field_factory->createDbOnlyIntField(
+					'ATTM_ID',
+					esc_html__('Attendee Meta Row ID', 'event_espresso'),
+					false
+				),
+				'ATT_ID_fk'    => $model_field_factory->createDbOnlyIntField(
+					'ATT_ID',
+					esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'),
+					false
+				),
+				'ATT_fname'    => $model_field_factory->createPlainTextField(
+					'ATT_fname',
+					esc_html__('First Name', 'event_espresso')
+				),
+				'ATT_lname'    => $model_field_factory->createPlainTextField(
+					'ATT_lname',
+					esc_html__('Last Name', 'event_espresso')
+				),
+				'ATT_address'  => $model_field_factory->createPlainTextField(
+					'ATT_address',
+					esc_html__('Address Part 1', 'event_espresso')
+				),
+				'ATT_address2' => $model_field_factory->createPlainTextField(
+					'ATT_address2',
+					esc_html__('Address Part 2', 'event_espresso')
+				),
+				'ATT_city'     => $model_field_factory->createPlainTextField(
+					'ATT_city',
+					esc_html__('City', 'event_espresso')
+				),
+				'STA_ID'       => $model_field_factory->createForeignKeyIntField(
+					'STA_ID',
+					esc_html__('State', 'event_espresso'),
+					true,
+					0,
+					'State'
+				),
+				'CNT_ISO'      => $model_field_factory->createForeignKeyStringField(
+					'CNT_ISO',
+					esc_html__('Country', 'event_espresso'),
+					true,
+					'',
+					'Country'
+				),
+				'ATT_zip'      => $model_field_factory->createPlainTextField(
+					'ATT_zip',
+					esc_html__('ZIP/Postal Code', 'event_espresso')
+				),
+				'ATT_email'    => $model_field_factory->createEmailField(
+					'ATT_email',
+					esc_html__('Email Address', 'event_espresso')
+				),
+				'ATT_phone'    => $model_field_factory->createPlainTextField(
+					'ATT_phone',
+					esc_html__('Phone', 'event_espresso')
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration'      => new EE_Has_Many_Relation(),
+			'State'             => new EE_Belongs_To_Relation(),
+			'Country'           => new EE_Belongs_To_Relation(),
+			'Event'             => new EE_HABTM_Relation('Registration', false),
+			'WP_User'           => new EE_Belongs_To_Relation(),
+			'Message'           => new EE_Has_Many_Any_Relation(false),
+			// allow deletion of attendees even if they have messages in the queue for them.
+			'Term_Relationship' => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
+		);
+		$this->_caps_slug = 'contacts';
+		$this->model_chain_to_password = '';
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Gets the name of the field on the attendee model corresponding to the system question string
+	 * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name
+	 *
+	 * @param string $system_question_string
+	 * @return string|null if not found
+	 */
+	public function get_attendee_field_for_system_question($system_question_string)
+	{
+		return isset($this->_system_question_to_attendee_field_name[ $system_question_string ])
+			? $this->_system_question_to_attendee_field_name[ $system_question_string ]
+			: null;
+	}
+
+
+
+	/**
+	 * Gets mapping from esp_question.QST_system values to their corresponding attendee field names
+	 *
+	 * @return array
+	 */
+	public function system_question_to_attendee_field_mapping()
+	{
+		return $this->_system_question_to_attendee_field_name;
+	}
+
+
+
+	/**
+	 * Gets all the attendees for a transaction (by using the esp_registration as a join table)
+	 *
+	 * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID
+	 * @return EE_Attendee[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_attendees_for_transaction($transaction_id_or_obj)
+	{
+		return $this->get_all(
+			array(
+				array(
+					'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction
+						? $transaction_id_or_obj->ID()
+						: $transaction_id_or_obj,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * retrieve  a single attendee from db via their ID
+	 *
+	 * @param $ATT_ID
+	 * @return mixed array on success, FALSE on fail
+	 * @deprecated
+	 */
+	public function get_attendee_by_ID($ATT_ID = false)
+	{
+		// retrieve a particular EE_Attendee
+		return $this->get_one_by_ID($ATT_ID);
+	}
+
+
+
+	/**
+	 * retrieve  a single attendee from db via their ID
+	 *
+	 * @param array $where_cols_n_values
+	 * @return mixed array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function get_attendee($where_cols_n_values = array())
+	{
+		if (empty($where_cols_n_values)) {
+			return false;
+		}
+		$attendee = $this->get_all(array($where_cols_n_values));
+		if (! empty($attendee)) {
+			return array_shift($attendee);
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Search for an existing Attendee record in the DB
+	 *
+	 * @param array $where_cols_n_values
+	 * @return bool|mixed
+	 * @throws EE_Error
+	 */
+	public function find_existing_attendee($where_cols_n_values = null)
+	{
+		// search by combo of first and last names plus the email address
+		$attendee_data_keys = array(
+			'ATT_fname' => $this->_ATT_fname,
+			'ATT_lname' => $this->_ATT_lname,
+			'ATT_email' => $this->_ATT_email,
+		);
+		// no search params means attendee object already exists.
+		$where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values)
+			? $where_cols_n_values
+			: $attendee_data_keys;
+		$valid_data = true;
+		// check for required values
+		$valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname'])
+			? $valid_data
+			: false;
+		$valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname'])
+			? $valid_data
+			: false;
+		$valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email'])
+			? $valid_data
+			: false;
+		if ($valid_data) {
+			$attendee = $this->get_attendee($where_cols_n_values);
+			if ($attendee instanceof EE_Attendee) {
+				return $attendee;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Takes an incoming array of EE_Registration ids
+	 * and sends back a list of corresponding non duplicate EE_Attendee objects.
+	 *
+	 * @since  4.3.0
+	 * @param  array $ids array of EE_Registration ids
+	 * @return EE_Attendee[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_array_of_contacts_from_reg_ids($ids)
+	{
+		$ids = (array) $ids;
+		$_where = array(
+			'Registration.REG_ID' => array('in', $ids),
+		);
+		return $this->get_all(array($_where));
+	}
 }

core/db_models/EEM_Extra_Join.model.php

Indentation +26 added lines, -26 removed lines

@@ -23,32 +23,32 @@
  */
 class EEM_Extra_Join extends EEM_Base
 {
-    // private instance of the Extra Join object
-    protected static $_instance = null;
+	// private instance of the Extra Join object
+	protected static $_instance = null;
     
-    public function __construct($timezone = null)
-    {
-        $models_this_can_join = array_keys(EE_Registry::instance()->non_abstract_db_models);
-        $this->_tables = array(
-            'Extra_Join' => new EE_Primary_Table('esp_extra_join', 'EXJ_ID'),
-        );
-        $this->_fields = array(
-            'Extra_Join' => array(
-                'EXJ_ID' => new EE_Primary_Key_Int_Field('EXJ_ID', __('Extra Join ID', 'event_espresso')),
-                'EXJ_first_model_ID' => new EE_Foreign_Key_String_Field('EXJ_first_model_ID', __('First Model ID', 'event_espresso'), true, 0, $models_this_can_join),
-                'EXJ_first_model_name' => new EE_Any_Foreign_Model_Name_Field('EXJ_first_model_name', __('First Model Name', 'event_espresso'), true, '', $models_this_can_join),
-                'EXJ_second_model_ID' => new EE_Foreign_Key_String_Field('EXJ_second_model_ID', __('Second Model ID', 'event_espresso'), true, 0, $models_this_can_join),
-                'EXJ_second_model_name' => new EE_Any_Foreign_Model_Name_Field('EXJ_second_model_name', __('Second Model Name', 'event_espresso'), true, '', $models_this_can_join),
+	public function __construct($timezone = null)
+	{
+		$models_this_can_join = array_keys(EE_Registry::instance()->non_abstract_db_models);
+		$this->_tables = array(
+			'Extra_Join' => new EE_Primary_Table('esp_extra_join', 'EXJ_ID'),
+		);
+		$this->_fields = array(
+			'Extra_Join' => array(
+				'EXJ_ID' => new EE_Primary_Key_Int_Field('EXJ_ID', __('Extra Join ID', 'event_espresso')),
+				'EXJ_first_model_ID' => new EE_Foreign_Key_String_Field('EXJ_first_model_ID', __('First Model ID', 'event_espresso'), true, 0, $models_this_can_join),
+				'EXJ_first_model_name' => new EE_Any_Foreign_Model_Name_Field('EXJ_first_model_name', __('First Model Name', 'event_espresso'), true, '', $models_this_can_join),
+				'EXJ_second_model_ID' => new EE_Foreign_Key_String_Field('EXJ_second_model_ID', __('Second Model ID', 'event_espresso'), true, 0, $models_this_can_join),
+				'EXJ_second_model_name' => new EE_Any_Foreign_Model_Name_Field('EXJ_second_model_name', __('Second Model Name', 'event_espresso'), true, '', $models_this_can_join),
                 
-            )
-        );
-        // this model is weird in that it has two foreign key columns which can point to any model/table.
-        // eg a foreign key to event will be in "EXJ_first_model_ID", provided the other
-        // model linked to is alphabetically greater than event (eg venue).
-        // but if the model linked to is alphabetically lower (eg attendee),
-        // the foreign key to the event will be in "EXJ_second_model_ID"
-        // so normal usage of foreign keys is weird. So don't define any
-        // relations to other models because they won't work properly with this model
-        parent::__construct($timezone);
-    }
+			)
+		);
+		// this model is weird in that it has two foreign key columns which can point to any model/table.
+		// eg a foreign key to event will be in "EXJ_first_model_ID", provided the other
+		// model linked to is alphabetically greater than event (eg venue).
+		// but if the model linked to is alphabetically lower (eg attendee),
+		// the foreign key to the event will be in "EXJ_second_model_ID"
+		// so normal usage of foreign keys is weird. So don't define any
+		// relations to other models because they won't work properly with this model
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Message.model.php

Spacing +8 added lines, -8 removed lines

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

Indentation +617 added lines, -617 removed lines

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

core/db_models/EEM_Post_Meta.model.php

Indentation +49 added lines, -49 removed lines

@@ -18,56 +18,56 @@
 class EEM_Post_Meta extends EEM_Base
 {
 
-    // private instance of the EE_Post_Meta object
-    protected static $_instance = null;
+	// private instance of the EE_Post_Meta object
+	protected static $_instance = null;
 
 
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Post Meta', 'event_espresso');
-        $this->plural_item = __('Post Metas', 'event_espresso');
-        $this->_tables = array(
-            'Post_Meta' => new EE_Primary_Table('postmeta', 'meta_id'),
-        );
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
-        $this->_fields = array(
-            'Post_Meta' => array(
-                'meta_id'    => new EE_Primary_Key_Int_Field(
-                    'meta_id',
-                    __("Meta ID", "event_espresso")
-                ),
-                'post_id'    => new EE_Foreign_Key_Int_Field(
-                    'post_id',
-                    __("Primary Key of Post", "event_espresso"),
-                    false,
-                    0,
-                    $models_this_can_attach_to
-                ),
-                'meta_key'   => new EE_Plain_Text_Field(
-                    'meta_key',
-                    __("Meta Key", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'meta_value' => new EE_Maybe_Serialized_Text_Field(
-                    'meta_value',
-                    __("Meta Value", "event_espresso"),
-                    true
-                ),
-            ),
-        );
-        $this->_model_relations = array();
-        foreach ($models_this_can_attach_to as $model) {
-            $this->_model_relations[ $model ] = new EE_Belongs_To_Relation();
-        }
-        $this->_wp_core_model = true;
-        foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-            $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta(
-                'meta_key',
-                'meta_value'
-            );
-        }
-        parent::__construct($timezone);
-    }
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Post Meta', 'event_espresso');
+		$this->plural_item = __('Post Metas', 'event_espresso');
+		$this->_tables = array(
+			'Post_Meta' => new EE_Primary_Table('postmeta', 'meta_id'),
+		);
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
+		$this->_fields = array(
+			'Post_Meta' => array(
+				'meta_id'    => new EE_Primary_Key_Int_Field(
+					'meta_id',
+					__("Meta ID", "event_espresso")
+				),
+				'post_id'    => new EE_Foreign_Key_Int_Field(
+					'post_id',
+					__("Primary Key of Post", "event_espresso"),
+					false,
+					0,
+					$models_this_can_attach_to
+				),
+				'meta_key'   => new EE_Plain_Text_Field(
+					'meta_key',
+					__("Meta Key", "event_espresso"),
+					false,
+					''
+				),
+				'meta_value' => new EE_Maybe_Serialized_Text_Field(
+					'meta_value',
+					__("Meta Value", "event_espresso"),
+					true
+				),
+			),
+		);
+		$this->_model_relations = array();
+		foreach ($models_this_can_attach_to as $model) {
+			$this->_model_relations[ $model ] = new EE_Belongs_To_Relation();
+		}
+		$this->_wp_core_model = true;
+		foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
+			$this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta(
+				'meta_key',
+				'meta_value'
+			);
+		}
+		parent::__construct($timezone);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -59,11 +59,11 @@
         );
         $this->_model_relations = array();
         foreach ($models_this_can_attach_to as $model) {
-            $this->_model_relations[ $model ] = new EE_Belongs_To_Relation();
+            $this->_model_relations[$model] = new EE_Belongs_To_Relation();
         }
         $this->_wp_core_model = true;
         foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-            $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta(
+            $this->_cap_restriction_generators[$cap_context] = new EE_Restriction_Generator_Meta(
                 'meta_key',
                 'meta_value'
             );

core/db_models/fields/EE_Float_Field.php

Indentation +62 added lines, -62 removed lines

@@ -7,77 +7,77 @@
 class EE_Float_Field extends EE_Model_Field_Base
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('number');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('number');
+	}
 
 
-    /**
-     * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
-     * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
-     * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
-     * Returns a float
-     *
-     * @param type $value_inputted_for_field_on_model_object
-     * @return float
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
+	/**
+	 * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
+	 * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
+	 * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
+	 * Returns a float
+	 *
+	 * @param type $value_inputted_for_field_on_model_object
+	 * @return float
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
 //      echo __LINE__."$value_inputted_for_field_on_model_object<br>";
-        // remove whitespaces and thousands separators
-        if (is_string($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = str_replace(
-                array(" ", EE_Config::instance()->currency->thsnds),
-                "",
-                $value_inputted_for_field_on_model_object
-            );
+		// remove whitespaces and thousands separators
+		if (is_string($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = str_replace(
+				array(" ", EE_Config::instance()->currency->thsnds),
+				"",
+				$value_inputted_for_field_on_model_object
+			);
 // echo __LINE__."$value_inputted_for_field_on_model_object<br>";
 // normalize it so periods are decimal marks (we don't care where you're from: we're talking PHP now)
-            $value_inputted_for_field_on_model_object = str_replace(
-                EE_Config::instance()->currency->dec_mrk,
-                ".",
-                $value_inputted_for_field_on_model_object
-            );
+			$value_inputted_for_field_on_model_object = str_replace(
+				EE_Config::instance()->currency->dec_mrk,
+				".",
+				$value_inputted_for_field_on_model_object
+			);
 // echo __LINE__."$value_inputted_for_field_on_model_object<br>";
 // double-check there's absolutely nothing left on this string besides numbers
-            $value_inputted_for_field_on_model_object = preg_replace(
-                "/[^0-9,.]/",
-                "",
-                $value_inputted_for_field_on_model_object
-            );
-        }
+			$value_inputted_for_field_on_model_object = preg_replace(
+				"/[^0-9,.]/",
+				"",
+				$value_inputted_for_field_on_model_object
+			);
+		}
 //      echo __LINE__."$value_inputted_for_field_on_model_object<br>";
-        return floatval($value_inputted_for_field_on_model_object);
-    }
+		return floatval($value_inputted_for_field_on_model_object);
+	}
 
-    /**
-     * Returns the number formatted according to local custom (set by the country of the blog).
-     *
-     * @param float $value_on_field_to_be_outputted
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        $EE = EE_Registry::instance();
-        return number_format(
-            $value_on_field_to_be_outputted,
-            $EE->CFG->currency->dec_plc,
-            $EE->CFG->currency->dec_mrk,
-            $EE->CFG->currency->thsnds
-        );
-    }
+	/**
+	 * Returns the number formatted according to local custom (set by the country of the blog).
+	 *
+	 * @param float $value_on_field_to_be_outputted
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		$EE = EE_Registry::instance();
+		return number_format(
+			$value_on_field_to_be_outputted,
+			$EE->CFG->currency->dec_plc,
+			$EE->CFG->currency->dec_mrk,
+			$EE->CFG->currency->thsnds
+		);
+	}
 
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
 //      echo "prepare for set from db of ";d($value_found_in_db_for_model_object);
-        return floatval($value_found_in_db_for_model_object);
-    }
+		return floatval($value_found_in_db_for_model_object);
+	}
 }

core/db_models/fields/EE_All_Caps_Text_Field.php

Indentation +10 added lines, -10 removed lines

@@ -6,14 +6,14 @@
  */
 class EE_All_Caps_Text_Field extends EE_Text_Field_Base
 {
-    /**
-     * makes it all upper case, and key-like
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return strtoupper(sanitize_key($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * makes it all upper case, and key-like
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return strtoupper(sanitize_key($value_inputted_for_field_on_model_object));
+	}
 }

core/db_models/fields/EE_Text_Field_Base.php

Indentation +43 added lines, -43 removed lines

@@ -7,49 +7,49 @@
 abstract class EE_Text_Field_Base extends EE_Model_Field_Base
 {
 
-    /**
-     * Gets the value in the format expected when being set.
-     * For display on the front-end, usually you would use prepare_for_pretty_echoing() instead.
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed|string
-     */
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
+	/**
+	 * Gets the value in the format expected when being set.
+	 * For display on the front-end, usually you would use prepare_for_pretty_echoing() instead.
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed|string
+	 */
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
 
-    /**
-     * Accepts schema of 'form_input' which formats the string for echoing in form input's value.
-     *
-     * @param string $value_on_field_to_be_outputted
-     * @param string $schema
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        if ($schema === 'form_input') {
-            $value_on_field_to_be_outputted = (string) htmlentities(
-                $value_on_field_to_be_outputted,
-                ENT_QUOTES,
-                'UTF-8'
-            );
-        }
-        return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
-    }
+	/**
+	 * Accepts schema of 'form_input' which formats the string for echoing in form input's value.
+	 *
+	 * @param string $value_on_field_to_be_outputted
+	 * @param string $schema
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		if ($schema === 'form_input') {
+			$value_on_field_to_be_outputted = (string) htmlentities(
+				$value_on_field_to_be_outputted,
+				ENT_QUOTES,
+				'UTF-8'
+			);
+		}
+		return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
+	}
 
-    /**
-     * Data received from the user should be exactly as they hope to save it in the DB, with the exception that
-     * quotes need to have slashes added to it. This method takes care of removing the slashes added by WP
-     * in magic-quotes fashion. We used to call html_entity_decode on the value here,
-     * because we called htmlentities when in EE_Text_Field_Base::prepare_for_pretty_echoing, but that's not necessary
-     * because web browsers always decode HTML entities in element attributes, like a form element's value attribute.
-     * So if we do it again here, we'll be removing HTML entities the user intended to have.)
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return stripslashes(parent::prepare_for_set($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * Data received from the user should be exactly as they hope to save it in the DB, with the exception that
+	 * quotes need to have slashes added to it. This method takes care of removing the slashes added by WP
+	 * in magic-quotes fashion. We used to call html_entity_decode on the value here,
+	 * because we called htmlentities when in EE_Text_Field_Base::prepare_for_pretty_echoing, but that's not necessary
+	 * because web browsers always decode HTML entities in element attributes, like a form element's value attribute.
+	 * So if we do it again here, we'll be removing HTML entities the user intended to have.)
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return stripslashes(parent::prepare_for_set($value_inputted_for_field_on_model_object));
+	}
 }