eventespresso / event-espresso-core

core/db_models/strategies/EE_Default_Where_Conditions.strategy.php

Spacing +7 added lines, -7 removed lines

@@ -112,26 +112,26 @@ 
     public function prepare_where_conditions_for_querying($where_conditions, $model_relation_chain)
     {
         $where_conditions_with_model_relation_chain_prefixes = array();
-        if (! is_array($where_conditions)) {
+        if ( ! is_array($where_conditions)) {
             $where_conditions = array();
         }
         foreach ($where_conditions as $key => $value) {
             if (
-                in_array($key, array( 'OR', 'AND', 'NOT' ))
+                in_array($key, array('OR', 'AND', 'NOT'))
                 || strpos($key, 'OR*') !== false
                 || strpos($key, 'AND*') !== false
                 || strpos($key, 'NOT*') !== false
             ) {
-                $where_conditions_with_model_relation_chain_prefixes[ $key ] = $this->prepare_where_conditions_for_querying(
+                $where_conditions_with_model_relation_chain_prefixes[$key] = $this->prepare_where_conditions_for_querying(
                     $value,
                     $model_relation_chain
                 );
             } else {
                 if (
                     $model_relation_chain != ''
-                    && $model_relation_chain[ strlen($model_relation_chain) - 1 ] != '.'
+                    && $model_relation_chain[strlen($model_relation_chain) - 1] != '.'
                 ) {
-                    $model_relation_chain = $model_relation_chain . ".";
+                    $model_relation_chain = $model_relation_chain.".";
                 }
                 // check for the current user id place holder, and if present change it
                 if ($value === self::current_user_placeholder) {
@@ -139,7 +139,7 @@ 
                 }
                 // check for user field placeholder
                 if ($key == self::user_field_name_placeholder) {
-                    if (! $this->_model->wp_user_field_name()) {
+                    if ( ! $this->_model->wp_user_field_name()) {
                         throw new EE_Error(
                             sprintf(
                                 esc_html__(
@@ -152,7 +152,7 @@ 
                     }
                     $key = $this->_model->wp_user_field_name();
                 }
-                $where_conditions_with_model_relation_chain_prefixes[ $model_relation_chain . $key ] = $value;
+                $where_conditions_with_model_relation_chain_prefixes[$model_relation_chain.$key] = $value;
             }
         }
         return $where_conditions_with_model_relation_chain_prefixes;

Indentation +142 added lines, -142 removed lines

@@ -3,7 +3,7 @@ 
 /**
  *
  * Class EE_Default_Where_Conditions
-  *
+ *
  * Strategy to be used for getting default where conditions for EEM_Base children.
  * Should be initialized and set on construction of model
  *
@@ -15,145 +15,145 @@ 
  */
 class EE_Default_Where_Conditions
 {
-    /**
-     * This const can be used in EE_Default_Where_Conditions values, and at the time of querying it will be
-     * replaced with the current user's ID (because we don't want to use the current user's ID at time of
-     * initializing the models because it's too early)
-     */
-    const current_user_placeholder = '%$current_user_placeholder_should_be_replaced_automatically$%';
-
-    /**
-     * This const can be used in EE_Default_Where_Conditions where parameters as the name
-     * of the user field. When we are actually generating the where conditions it will be
-     * replaced with the model's wp user fieldname
-     */
-    const user_field_name_placeholder = '%$user_field_name_placeholder$%';
-
-    /**
-     * Model for which this strategy find default where conditions
-     * @var EEM_Base
-     */
-    protected $_model;
-
-    /**
-     * Where conditions specified on construction
-     * @var array
-     */
-    protected $_where_conditions_provided = array();
-
-    /**
-     * Custom where conditions. Model relation chains will be automatically added
-     * onto any field names
-     * @param array $custom_where_conditions
-     */
-    public function __construct($custom_where_conditions = array())
-    {
-        $this->_where_conditions_provided = $custom_where_conditions;
-    }
-
-
-
-    /**
-     * finalizes construction of the strategy for use in getting default where conditions
-     * for querying of the model.
-     * @param EEM_Base $model
-     */
-    public function _finalize_construct(EEM_Base $model)
-    {
-        $this->_model = $model;
-    }
-
-
-
-    /**
-     * Returns the where conditions explicitly passed in the constructor
-     * @return array
-     */
-    public function get_where_conditions_provided()
-    {
-        return $this->_where_conditions_provided;
-    }
-
-
-
-    /**
-     * Gets the where conditions to be added onto the query
-     * @param string $model_relation_chain
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    public function get_default_where_conditions($model_relation_chain = '')
-    {
-        return $this->prepare_where_conditions_for_querying(array_merge($this->_get_default_where_conditions(), $this->get_where_conditions_provided()), $model_relation_chain);
-    }
-
-
-
-    /**
-     * Gets the default where conditions that are specific to this child of EE_Default_Where_Conditions.
-     * Adding model relation chains is handled by the public method get_default_where_conditions
-     * @return array
-     */
-    protected function _get_default_where_conditions()
-    {
-        return array();
-    }
-
-
-
-    /**
-     * Takes the default query parameters, and traverses them, adding the model relation chain
-     * onto them (intelligently doesn't do that to logic query params like NOT, OR, and AND)
-     * @param array $where_conditions
-     * @param string $model_relation_chain
-     * @return array
-     * @throws \EE_Error
-     */
-    public function prepare_where_conditions_for_querying($where_conditions, $model_relation_chain)
-    {
-        $where_conditions_with_model_relation_chain_prefixes = array();
-        if (! is_array($where_conditions)) {
-            $where_conditions = array();
-        }
-        foreach ($where_conditions as $key => $value) {
-            if (
-                in_array($key, array( 'OR', 'AND', 'NOT' ))
-                || strpos($key, 'OR*') !== false
-                || strpos($key, 'AND*') !== false
-                || strpos($key, 'NOT*') !== false
-            ) {
-                $where_conditions_with_model_relation_chain_prefixes[ $key ] = $this->prepare_where_conditions_for_querying(
-                    $value,
-                    $model_relation_chain
-                );
-            } else {
-                if (
-                    $model_relation_chain != ''
-                    && $model_relation_chain[ strlen($model_relation_chain) - 1 ] != '.'
-                ) {
-                    $model_relation_chain = $model_relation_chain . ".";
-                }
-                // check for the current user id place holder, and if present change it
-                if ($value === self::current_user_placeholder) {
-                    $value = get_current_user_id();
-                }
-                // check for user field placeholder
-                if ($key == self::user_field_name_placeholder) {
-                    if (! $this->_model->wp_user_field_name()) {
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__(
-                                    'There is no foreign key to the WP_User model on model %s. Please either modify your default where conditions, add a _model_chain_to_wp_user onto the model, or a proper EE_WP_User_Field onto the model',
-                                    'event_espresso'
-                                ),
-                                $this->_model->get_this_model_name()
-                            )
-                        );
-                    }
-                    $key = $this->_model->wp_user_field_name();
-                }
-                $where_conditions_with_model_relation_chain_prefixes[ $model_relation_chain . $key ] = $value;
-            }
-        }
-        return $where_conditions_with_model_relation_chain_prefixes;
-    }
+	/**
+	 * This const can be used in EE_Default_Where_Conditions values, and at the time of querying it will be
+	 * replaced with the current user's ID (because we don't want to use the current user's ID at time of
+	 * initializing the models because it's too early)
+	 */
+	const current_user_placeholder = '%$current_user_placeholder_should_be_replaced_automatically$%';
+
+	/**
+	 * This const can be used in EE_Default_Where_Conditions where parameters as the name
+	 * of the user field. When we are actually generating the where conditions it will be
+	 * replaced with the model's wp user fieldname
+	 */
+	const user_field_name_placeholder = '%$user_field_name_placeholder$%';
+
+	/**
+	 * Model for which this strategy find default where conditions
+	 * @var EEM_Base
+	 */
+	protected $_model;
+
+	/**
+	 * Where conditions specified on construction
+	 * @var array
+	 */
+	protected $_where_conditions_provided = array();
+
+	/**
+	 * Custom where conditions. Model relation chains will be automatically added
+	 * onto any field names
+	 * @param array $custom_where_conditions
+	 */
+	public function __construct($custom_where_conditions = array())
+	{
+		$this->_where_conditions_provided = $custom_where_conditions;
+	}
+
+
+
+	/**
+	 * finalizes construction of the strategy for use in getting default where conditions
+	 * for querying of the model.
+	 * @param EEM_Base $model
+	 */
+	public function _finalize_construct(EEM_Base $model)
+	{
+		$this->_model = $model;
+	}
+
+
+
+	/**
+	 * Returns the where conditions explicitly passed in the constructor
+	 * @return array
+	 */
+	public function get_where_conditions_provided()
+	{
+		return $this->_where_conditions_provided;
+	}
+
+
+
+	/**
+	 * Gets the where conditions to be added onto the query
+	 * @param string $model_relation_chain
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	public function get_default_where_conditions($model_relation_chain = '')
+	{
+		return $this->prepare_where_conditions_for_querying(array_merge($this->_get_default_where_conditions(), $this->get_where_conditions_provided()), $model_relation_chain);
+	}
+
+
+
+	/**
+	 * Gets the default where conditions that are specific to this child of EE_Default_Where_Conditions.
+	 * Adding model relation chains is handled by the public method get_default_where_conditions
+	 * @return array
+	 */
+	protected function _get_default_where_conditions()
+	{
+		return array();
+	}
+
+
+
+	/**
+	 * Takes the default query parameters, and traverses them, adding the model relation chain
+	 * onto them (intelligently doesn't do that to logic query params like NOT, OR, and AND)
+	 * @param array $where_conditions
+	 * @param string $model_relation_chain
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function prepare_where_conditions_for_querying($where_conditions, $model_relation_chain)
+	{
+		$where_conditions_with_model_relation_chain_prefixes = array();
+		if (! is_array($where_conditions)) {
+			$where_conditions = array();
+		}
+		foreach ($where_conditions as $key => $value) {
+			if (
+				in_array($key, array( 'OR', 'AND', 'NOT' ))
+				|| strpos($key, 'OR*') !== false
+				|| strpos($key, 'AND*') !== false
+				|| strpos($key, 'NOT*') !== false
+			) {
+				$where_conditions_with_model_relation_chain_prefixes[ $key ] = $this->prepare_where_conditions_for_querying(
+					$value,
+					$model_relation_chain
+				);
+			} else {
+				if (
+					$model_relation_chain != ''
+					&& $model_relation_chain[ strlen($model_relation_chain) - 1 ] != '.'
+				) {
+					$model_relation_chain = $model_relation_chain . ".";
+				}
+				// check for the current user id place holder, and if present change it
+				if ($value === self::current_user_placeholder) {
+					$value = get_current_user_id();
+				}
+				// check for user field placeholder
+				if ($key == self::user_field_name_placeholder) {
+					if (! $this->_model->wp_user_field_name()) {
+						throw new EE_Error(
+							sprintf(
+								esc_html__(
+									'There is no foreign key to the WP_User model on model %s. Please either modify your default where conditions, add a _model_chain_to_wp_user onto the model, or a proper EE_WP_User_Field onto the model',
+									'event_espresso'
+								),
+								$this->_model->get_this_model_name()
+							)
+						);
+					}
+					$key = $this->_model->wp_user_field_name();
+				}
+				$where_conditions_with_model_relation_chain_prefixes[ $model_relation_chain . $key ] = $value;
+			}
+		}
+		return $where_conditions_with_model_relation_chain_prefixes;
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Base.strategy.php

Spacing +9 added lines, -9 removed lines

@@ -65,7 +65,7 @@ 
      */
     public function model()
     {
-        if (! $this->_model instanceof EEM_Base) {
+        if ( ! $this->_model instanceof EEM_Base) {
             throw new EE_Error(sprintf(esc_html__('Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called', 'event_espresso'), get_class($this)));
         }
         return $this->_model;
@@ -80,7 +80,7 @@ 
      */
     public function action()
     {
-        if (! $this->_action) {
+        if ( ! $this->_action) {
             throw new EE_Error(sprintf(esc_html__('Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called', 'event_espresso'), get_class($this)));
         }
         return $this->_action;
@@ -92,7 +92,7 @@ 
      */
     public function construction_finalized()
     {
-        if ($this->_model instanceof EEM_Base  && $this->_action) {
+        if ($this->_model instanceof EEM_Base && $this->_action) {
             return true;
         } else {
             return false;
@@ -145,7 +145,7 @@ 
      */
     public static function get_cap_name($model, $action)
     {
-        return apply_filters('FHEE__EE_Restriction_Generator__get_cap_name', ( $model->is_wp_core_model() ? '' : 'ee_' ) . $action . '_' . $model->cap_slug(), $model, $action);
+        return apply_filters('FHEE__EE_Restriction_Generator__get_cap_name', ($model->is_wp_core_model() ? '' : 'ee_').$action.'_'.$model->cap_slug(), $model, $action);
     }
 
     /**
@@ -189,19 +189,19 @@ 
         if ($check_if_published) {
             $published_value = 'publish';
         } else {
-            $published_value = array('!=','private');
+            $published_value = array('!=', 'private');
         }
         // only add a check for the previous event status if the model is the event or it's related to the event model
         if ($this->model() instanceof EEM_Event || strpos($path_to_event_model, 'Event') !== false) {
             $where_conditions['OR*status'] = array(
-                $path_to_event_model . 'status' => $published_value,
+                $path_to_event_model.'status' => $published_value,
                 'AND' => array(
-                    $path_to_event_model . 'Post_Meta.meta_key'   => '_previous_event_status',
-                    $path_to_event_model . 'Post_Meta.meta_value' => $published_value
+                    $path_to_event_model.'Post_Meta.meta_key'   => '_previous_event_status',
+                    $path_to_event_model.'Post_Meta.meta_value' => $published_value
                 )
             );
         } else {
-            $where_conditions[ $path_to_event_model . 'status' ] = $published_value;
+            $where_conditions[$path_to_event_model.'status'] = $published_value;
         }
         return $where_conditions;
     }

Indentation +165 added lines, -165 removed lines

@@ -26,182 +26,182 @@
  */
 abstract class EE_Restriction_Generator_Base
 {
-    /**
-     * The restrictions generated by this object. FALSE before any are made.
-     * @var EE_Default_Where_Conditions[]
-     */
-    protected $_cap_restrictions_generated = false;
+	/**
+	 * The restrictions generated by this object. FALSE before any are made.
+	 * @var EE_Default_Where_Conditions[]
+	 */
+	protected $_cap_restrictions_generated = false;
 
-    /**
-     * Model for which restrictions are generated
-     * @var EEM_Base
-     */
-    protected $_model;
+	/**
+	 * Model for which restrictions are generated
+	 * @var EEM_Base
+	 */
+	protected $_model;
 
-    /**
-     * One of EEM_Base::valid_cap_contexts()
-     * @var string
-     */
-    protected $_action;
-    /**
-     * Puts the last necessary info onto the restriction generator class. This is usually
-     * called by EEM_Base during its constructor, so child classes don't have to
-     * always provide this info.
-     * @param EEM_Base $model
-     * @param string $action
-     */
-    public function _construct_finalize(EEM_Base $model, $action)
-    {
-        $this->_model = $model;
-        $this->_action = $action;
-    }
+	/**
+	 * One of EEM_Base::valid_cap_contexts()
+	 * @var string
+	 */
+	protected $_action;
+	/**
+	 * Puts the last necessary info onto the restriction generator class. This is usually
+	 * called by EEM_Base during its constructor, so child classes don't have to
+	 * always provide this info.
+	 * @param EEM_Base $model
+	 * @param string $action
+	 */
+	public function _construct_finalize(EEM_Base $model, $action)
+	{
+		$this->_model = $model;
+		$this->_action = $action;
+	}
 
-    /**
-     * Returns the model set for this restriction generator
-     *
-     * @throws EE_Error
-     * @return EEM_Base | EEM_Soft_Delete_Base
-     */
-    public function model()
-    {
-        if (! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(sprintf(esc_html__('Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called', 'event_espresso'), get_class($this)));
-        }
-        return $this->_model;
-    }
+	/**
+	 * Returns the model set for this restriction generator
+	 *
+	 * @throws EE_Error
+	 * @return EEM_Base | EEM_Soft_Delete_Base
+	 */
+	public function model()
+	{
+		if (! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(sprintf(esc_html__('Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called', 'event_espresso'), get_class($this)));
+		}
+		return $this->_model;
+	}
 
-    /**
-     * Returns the action this restriction generator will generate restrictions for.
-     * It should be one of EEM_Base::valid_cap_contexts()
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function action()
-    {
-        if (! $this->_action) {
-            throw new EE_Error(sprintf(esc_html__('Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called', 'event_espresso'), get_class($this)));
-        }
-        return $this->_action;
-    }
+	/**
+	 * Returns the action this restriction generator will generate restrictions for.
+	 * It should be one of EEM_Base::valid_cap_contexts()
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function action()
+	{
+		if (! $this->_action) {
+			throw new EE_Error(sprintf(esc_html__('Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called', 'event_espresso'), get_class($this)));
+		}
+		return $this->_action;
+	}
 
-    /**
-     * Returns whether or not _construct_finalize() has been called on this restriction generator object
-     * @return boolean
-     */
-    public function construction_finalized()
-    {
-        if ($this->_model instanceof EEM_Base  && $this->_action) {
-            return true;
-        } else {
-            return false;
-        }
-    }
+	/**
+	 * Returns whether or not _construct_finalize() has been called on this restriction generator object
+	 * @return boolean
+	 */
+	public function construction_finalized()
+	{
+		if ($this->_model instanceof EEM_Base  && $this->_action) {
+			return true;
+		} else {
+			return false;
+		}
+	}
 
-    /**
-     * Gets the capability restrictions generated by this object. Caches them in
-     * case they are required for subsequent requests
-     * @return array @see EEM_Base::_cap_restrictions
-     */
-    public function generate_restrictions()
-    {
-        if ($this->_cap_restrictions_generated === false) {
-            $this->_cap_restrictions_generated = apply_filters('FHEE__EE_Restriction_Generator_Base__generate_restrictions__first_time', $this->_generate_restrictions(), $this);
-        }
-        return apply_filters('FHEE__EE_Restriction_Generator_Base__generate_restrictions__every_time', $this->_cap_restrictions_generated, $this);
-    }
+	/**
+	 * Gets the capability restrictions generated by this object. Caches them in
+	 * case they are required for subsequent requests
+	 * @return array @see EEM_Base::_cap_restrictions
+	 */
+	public function generate_restrictions()
+	{
+		if ($this->_cap_restrictions_generated === false) {
+			$this->_cap_restrictions_generated = apply_filters('FHEE__EE_Restriction_Generator_Base__generate_restrictions__first_time', $this->_generate_restrictions(), $this);
+		}
+		return apply_filters('FHEE__EE_Restriction_Generator_Base__generate_restrictions__every_time', $this->_cap_restrictions_generated, $this);
+	}
 
-    /**
-     * Provided with the model, and using global knowledge about what capabilities exist,
-     * generates an array for use in one of the sub-arrays in EEM_Base::_cap_restrictions,
-     * where keys are capability names, and values are children of EE_Default_Where_Conditions
-     * @return array @see EEM_Base::_cap_restrictions
-     */
-    abstract protected function _generate_restrictions();
+	/**
+	 * Provided with the model, and using global knowledge about what capabilities exist,
+	 * generates an array for use in one of the sub-arrays in EEM_Base::_cap_restrictions,
+	 * where keys are capability names, and values are children of EE_Default_Where_Conditions
+	 * @return array @see EEM_Base::_cap_restrictions
+	 */
+	abstract protected function _generate_restrictions();
 
-    /**
-     * Whether or not this restriction generator has already done its job of
-     * making restrictions and caching them on itself in case its asked later
-     * @return boolean
-     */
-    public function has_generated_cap_restrictions()
-    {
-        if ($this->_cap_restrictions_generated === false) {
-            return false;
-        } else {
-            return true;
-        }
-    }
+	/**
+	 * Whether or not this restriction generator has already done its job of
+	 * making restrictions and caching them on itself in case its asked later
+	 * @return boolean
+	 */
+	public function has_generated_cap_restrictions()
+	{
+		if ($this->_cap_restrictions_generated === false) {
+			return false;
+		} else {
+			return true;
+		}
+	}
 
-    /**
-     * Given an action like 'edit' generates the cap name based off
-     * the EEM_Base::_cap_slug, which for events would be 'events', to generate the
-     * cap name like 'ee_edit_events'.
-     * If a $qualifier is passed,
-     * @param EEM_Base $model
-     * @param string $action
-     * @return string
-     */
-    public static function get_cap_name($model, $action)
-    {
-        return apply_filters('FHEE__EE_Restriction_Generator__get_cap_name', ( $model->is_wp_core_model() ? '' : 'ee_' ) . $action . '_' . $model->cap_slug(), $model, $action);
-    }
+	/**
+	 * Given an action like 'edit' generates the cap name based off
+	 * the EEM_Base::_cap_slug, which for events would be 'events', to generate the
+	 * cap name like 'ee_edit_events'.
+	 * If a $qualifier is passed,
+	 * @param EEM_Base $model
+	 * @param string $action
+	 * @return string
+	 */
+	public static function get_cap_name($model, $action)
+	{
+		return apply_filters('FHEE__EE_Restriction_Generator__get_cap_name', ( $model->is_wp_core_model() ? '' : 'ee_' ) . $action . '_' . $model->cap_slug(), $model, $action);
+	}
 
-    /**
-     * Checks if there is a cap for this model and this action
-     * @param EEM_Base $model
-     * @param string $action
-     * @return boolean
-     */
-    public static function is_cap($model, $action)
-    {
-        $caps_for_admin = EE_Registry::instance()->CAP->get_ee_capabilities('administrator');
-        if (in_array(self::get_cap_name($model, $action), $caps_for_admin)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
+	/**
+	 * Checks if there is a cap for this model and this action
+	 * @param EEM_Base $model
+	 * @param string $action
+	 * @return boolean
+	 */
+	public static function is_cap($model, $action)
+	{
+		$caps_for_admin = EE_Registry::instance()->CAP->get_ee_capabilities('administrator');
+		if (in_array(self::get_cap_name($model, $action), $caps_for_admin)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
 
-    /**
-     * Returns the default capability used to determine if the current user can
-     * access something.
-     * @return string
-     */
-    public static function get_default_restrictions_cap()
-    {
-        return apply_filters('FHEE__EE_Restriction_Generator_Base__default_restrictions_cap', 'manage_options');
-    }
+	/**
+	 * Returns the default capability used to determine if the current user can
+	 * access something.
+	 * @return string
+	 */
+	public static function get_default_restrictions_cap()
+	{
+		return apply_filters('FHEE__EE_Restriction_Generator_Base__default_restrictions_cap', 'manage_options');
+	}
 
 
-    /**
-     * Gets WHERE conditions for the query that show the posty-y model is published,
-     * or that it's sold out and it was previously published
-     * @param array $where_conditions
-     * @param boolean $check_if_published if true, will add conditions like status=publish. If false, will add conditions
-     *                                    like status!=private
-     * @param string $path_to_event_model including the period at the end
-     * @return array
-     */
-    protected function addPublishedPostConditions($where_conditions = array(), $check_if_published = true, $path_to_event_model = '')
-    {
-        if ($check_if_published) {
-            $published_value = 'publish';
-        } else {
-            $published_value = array('!=','private');
-        }
-        // only add a check for the previous event status if the model is the event or it's related to the event model
-        if ($this->model() instanceof EEM_Event || strpos($path_to_event_model, 'Event') !== false) {
-            $where_conditions['OR*status'] = array(
-                $path_to_event_model . 'status' => $published_value,
-                'AND' => array(
-                    $path_to_event_model . 'Post_Meta.meta_key'   => '_previous_event_status',
-                    $path_to_event_model . 'Post_Meta.meta_value' => $published_value
-                )
-            );
-        } else {
-            $where_conditions[ $path_to_event_model . 'status' ] = $published_value;
-        }
-        return $where_conditions;
-    }
+	/**
+	 * Gets WHERE conditions for the query that show the posty-y model is published,
+	 * or that it's sold out and it was previously published
+	 * @param array $where_conditions
+	 * @param boolean $check_if_published if true, will add conditions like status=publish. If false, will add conditions
+	 *                                    like status!=private
+	 * @param string $path_to_event_model including the period at the end
+	 * @return array
+	 */
+	protected function addPublishedPostConditions($where_conditions = array(), $check_if_published = true, $path_to_event_model = '')
+	{
+		if ($check_if_published) {
+			$published_value = 'publish';
+		} else {
+			$published_value = array('!=','private');
+		}
+		// only add a check for the previous event status if the model is the event or it's related to the event model
+		if ($this->model() instanceof EEM_Event || strpos($path_to_event_model, 'Event') !== false) {
+			$where_conditions['OR*status'] = array(
+				$path_to_event_model . 'status' => $published_value,
+				'AND' => array(
+					$path_to_event_model . 'Post_Meta.meta_key'   => '_previous_event_status',
+					$path_to_event_model . 'Post_Meta.meta_value' => $published_value
+				)
+			);
+		} else {
+			$where_conditions[ $path_to_event_model . 'status' ] = $published_value;
+		}
+		return $where_conditions;
+	}
 }

core/db_models/strategies/EE_Soft_Delete_Where_Conditions.strategy.php

Indentation +37 added lines, -37 removed lines

@@ -13,41 +13,41 @@
  */
 class EE_Soft_Delete_Where_Conditions extends EE_Default_Where_Conditions
 {
-    /**
-     * Strategy for setting default soft delete where conditions. This strategy will find
-     * the field of type 'EE_Trashed_Flag_Field', and add a condition that it be FALSE on all queries involving
-     * the model.
-     * If you want to override these default where conditions, you may explicitly in the query you send to the model.
-     * Eg,
-     *
-     */
-    public function __construct()
-    {
-    }
-    /**
-     * Gets the where default where conditions for a custom post type model
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    protected function _get_default_where_conditions()
-    {
-        $trashed_field_name = $this->deleted_field_name();
-        return array(
-            $trashed_field_name => false
-        );
-    }
-    /**
-     * Searches for field on the model of type 'deleted_flag'. if it is found,
-     * returns it's name.
-     * @return string
-     * @throws EE_Error
-     */
-    private function deleted_field_name()
-    {
-        $field = $this->_model->get_a_field_of_type('EE_Trashed_Flag_Field');
-        if ($field) {
-            return $field->get_name();
-        } else {
-            throw new EE_Error(sprintf(esc_html__('We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?', 'event_espresso'), get_class($this), get_class($this)));
-        }
-    }
+	/**
+	 * Strategy for setting default soft delete where conditions. This strategy will find
+	 * the field of type 'EE_Trashed_Flag_Field', and add a condition that it be FALSE on all queries involving
+	 * the model.
+	 * If you want to override these default where conditions, you may explicitly in the query you send to the model.
+	 * Eg,
+	 *
+	 */
+	public function __construct()
+	{
+	}
+	/**
+	 * Gets the where default where conditions for a custom post type model
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	protected function _get_default_where_conditions()
+	{
+		$trashed_field_name = $this->deleted_field_name();
+		return array(
+			$trashed_field_name => false
+		);
+	}
+	/**
+	 * Searches for field on the model of type 'deleted_flag'. if it is found,
+	 * returns it's name.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function deleted_field_name()
+	{
+		$field = $this->_model->get_a_field_of_type('EE_Trashed_Flag_Field');
+		if ($field) {
+			return $field->get_name();
+		} else {
+			throw new EE_Error(sprintf(esc_html__('We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?', 'event_espresso'), get_class($this), get_class($this)));
+		}
+	}
 }

core/db_models/EEM_Price_Type.model.php

Spacing +5 added lines, -5 removed lines

@@ -42,7 +42,7 @@ 
      */
     public function get_base_type_name($base_type_int)
     {
-        return $this->base_types[ $base_type_int ];
+        return $this->base_types[$base_type_int];
     }
 
     /**
@@ -95,7 +95,7 @@ 
             'WP_User' => new EE_Belongs_To_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         // all price types are "default" in terms of capability names
         $this->_caps_slug = 'default_price_types';
         parent::__construct($timezone);
@@ -142,15 +142,15 @@ 
         $would_be_deleted_price_types = $this->get_all_deleted_and_undeleted($query_params);
         $would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
 
-        $ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
+        $ID = $query_params[0][$this->get_primary_key_field()->get_name()];
 
         // check if any prices use this price type
-        $prc_query_params = array(array('PRT_ID' => array('IN',$would_be_deleted_price_type_ids)));
+        $prc_query_params = array(array('PRT_ID' => array('IN', $would_be_deleted_price_type_ids)));
         if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
             $prices_names_and_ids = array();
             foreach ($prices as $price) {
                 /* @var $price EE_Price */
-                $prices_names_and_ids[] = $price->name() . "(" . $price->ID() . ")";
+                $prices_names_and_ids[] = $price->name()."(".$price->ID().")";
             }
             $msg = sprintf(esc_html__('The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s', 'event_espresso'), implode(",", $prices_names_and_ids));
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);

Indentation +124 added lines, -124 removed lines

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

core/db_models/EEM_Status.model.php

Spacing +9 added lines, -9 removed lines

@@ -35,7 +35,7 @@ 
                     false,
                     'event',
                     array(
-                        'event'        => esc_html__("Event", "event_espresso"),// deprecated
+                        'event'        => esc_html__("Event", "event_espresso"), // deprecated
                         'registration' => esc_html__("Registration", "event_espresso"),
                         'transaction'  => esc_html__("Transaction", "event_espresso"),
                         'payment'      => esc_html__("Payment", "event_espresso"),
@@ -54,7 +54,7 @@ 
             'Payment'      => new EE_Has_Many_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
 
         parent::__construct($timezone);
     }
@@ -267,7 +267,7 @@ 
 
         $translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
 
-        if (! is_array($statuses)) {
+        if ( ! is_array($statuses)) {
             throw new EE_Error(esc_html__(
                 'The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
                 'event_espresso'
@@ -277,22 +277,22 @@ 
         $translation = array();
 
         foreach ($statuses as $id => $code) {
-            if (isset($translation_array[ $id ])) {
-                $translation[ $id ] = $plural ? $translation_array[ $id ][1] : $translation_array[ $id ][0];
+            if (isset($translation_array[$id])) {
+                $translation[$id] = $plural ? $translation_array[$id][1] : $translation_array[$id][0];
             } else {
-                $translation[ $id ] = $code;
+                $translation[$id] = $code;
             }
 
             // schema
             switch ($schema) {
                 case 'lower':
-                    $translation[ $id ] = strtolower($translation[ $id ]); // even though these start in lower case, this will catch any statuses added via filter.
+                    $translation[$id] = strtolower($translation[$id]); // even though these start in lower case, this will catch any statuses added via filter.
                     break;
                 case 'sentence':
-                    $translation[ $id ] = ucwords($translation[ $id ]);
+                    $translation[$id] = ucwords($translation[$id]);
                     break;
                 case 'upper':
-                    $translation[ $id ] = strtoupper($translation[ $id ]);
+                    $translation[$id] = strtoupper($translation[$id]);
                     break;
             }
         }

Indentation +277 added lines, -277 removed lines

@@ -10,292 +10,292 @@
  */
 class EEM_Status extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @return EEM_Status
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item    = esc_html__('Status', 'event_espresso');
-        $this->plural_item      = esc_html__('Stati', 'event_espresso');
-        $this->_tables          = array(
-            'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
-        );
-        $this->_fields          = array(
-            'StatusTable' => array(
-                'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', esc_html__('Status ID', 'event_espresso')),
-                'STS_code'     => new EE_Plain_Text_Field('STS_code', esc_html__('Status Code', 'event_espresso'), false, ''),
-                'STS_type'     => new EE_Enum_Text_Field(
-                    'STS_type',
-                    esc_html__("Type", "event_espresso"),
-                    false,
-                    'event',
-                    array(
-                        'event'        => esc_html__("Event", "event_espresso"),// deprecated
-                        'registration' => esc_html__("Registration", "event_espresso"),
-                        'transaction'  => esc_html__("Transaction", "event_espresso"),
-                        'payment'      => esc_html__("Payment", "event_espresso"),
-                        'email'        => esc_html__("Email", "event_espresso"),
-                        'message'      => esc_html__("Message", "event_espresso"),
-                    )
-                ),
-                'STS_can_edit' => new EE_Boolean_Field('STS_can_edit', esc_html__('Editable?', 'event_espresso'), false, false),
-                'STS_desc'     => new EE_Simple_HTML_Field('STS_desc', esc_html__("Description", "event_espresso"), false, ''),
-                'STS_open'     => new EE_Boolean_Field('STS_open', esc_html__("Open?", "event_espresso"), false, false),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration' => new EE_Has_Many_Relation(),
-            'Transaction'  => new EE_Has_Many_Relation(),
-            'Payment'      => new EE_Has_Many_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+	/**
+	 * @return EEM_Status
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item    = esc_html__('Status', 'event_espresso');
+		$this->plural_item      = esc_html__('Stati', 'event_espresso');
+		$this->_tables          = array(
+			'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
+		);
+		$this->_fields          = array(
+			'StatusTable' => array(
+				'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', esc_html__('Status ID', 'event_espresso')),
+				'STS_code'     => new EE_Plain_Text_Field('STS_code', esc_html__('Status Code', 'event_espresso'), false, ''),
+				'STS_type'     => new EE_Enum_Text_Field(
+					'STS_type',
+					esc_html__("Type", "event_espresso"),
+					false,
+					'event',
+					array(
+						'event'        => esc_html__("Event", "event_espresso"),// deprecated
+						'registration' => esc_html__("Registration", "event_espresso"),
+						'transaction'  => esc_html__("Transaction", "event_espresso"),
+						'payment'      => esc_html__("Payment", "event_espresso"),
+						'email'        => esc_html__("Email", "event_espresso"),
+						'message'      => esc_html__("Message", "event_espresso"),
+					)
+				),
+				'STS_can_edit' => new EE_Boolean_Field('STS_can_edit', esc_html__('Editable?', 'event_espresso'), false, false),
+				'STS_desc'     => new EE_Simple_HTML_Field('STS_desc', esc_html__("Description", "event_espresso"), false, ''),
+				'STS_open'     => new EE_Boolean_Field('STS_open', esc_html__("Open?", "event_espresso"), false, false),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration' => new EE_Has_Many_Relation(),
+			'Transaction'  => new EE_Has_Many_Relation(),
+			'Payment'      => new EE_Has_Many_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * This method provides the localized singular or plural string for a given status id
-     *
-     * @param  array   $statuses This should be an array of statuses in the format array( $status_id, $status_code ).
-     *                           That way if there isn't a translation in the index we'll return the default code.
-     * @param  boolean $plural   Whether to return plural string or not. Note, nearly all of the plural strings are the
-     *                           same as the singular (in English), however, this may NOT be the case with other
-     *                           languages
-     * @param  string  $schema   This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
-     *                           the status string returned ( UPPER, lower, Sentence)
-     * @throws EE_Error
-     * @return array             an array of translated strings for the incoming status id.
-     */
-    public function localized_status($statuses, $plural = false, $schema = 'upper')
-    {
-        // note these are all in lower case because ucwords() on upper case will NOT convert.
-        $translation_array = array(
-            EEM_Registration::status_id_pending_payment => array(
-                esc_html__('pending payment', 'event_espresso'), // singular
-                esc_html__('pending payments', 'event_espresso') // plural
-            ),
-            EEM_Registration::status_id_approved        => array(
-                esc_html__('approved', 'event_espresso'), // singular
-                esc_html__('approved', 'event_espresso') // plural
-            ),
-            EEM_Registration::status_id_not_approved    => array(
-                esc_html__('not approved', 'event_espresso'),
-                esc_html__('not approved', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_cancelled       => array(
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_incomplete      => array(
-                esc_html__('incomplete', 'event_espresso'),
-                esc_html__('incomplete', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_declined        => array(
-                esc_html__('declined', 'event_espresso'),
-                esc_html__('declined', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_wait_list       => array(
-                esc_html__('wait list', 'event_espresso'),
-                esc_html__('wait list', 'event_espresso'),
-            ),
-            EEM_Transaction::overpaid_status_code       => array(
-                esc_html__('overpaid', 'event_espresso'),
-                esc_html__('overpaid', 'event_espresso'),
-            ),
-            EEM_Transaction::complete_status_code       => array(
-                esc_html__('complete', 'event_espresso'),
-                esc_html__('complete', 'event_espresso'),
-            ),
-            EEM_Transaction::incomplete_status_code     => array(
-                esc_html__('incomplete', 'event_espresso'),
-                esc_html__('incomplete', 'event_espresso'),
-            ),
-            EEM_Transaction::failed_status_code         => array(
-                esc_html__('failed', 'event_espresso'),
-                esc_html__('failed', 'event_espresso'),
-            ),
-            EEM_Transaction::abandoned_status_code      => array(
-                esc_html__('abandoned', 'event_espresso'),
-                esc_html__('abandoned', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_approved             => array(
-                esc_html__('accepted', 'event_espresso'),
-                esc_html__('accepted', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_pending              => array(
-                esc_html__('pending', 'event_espresso'),
-                esc_html__('pending', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_cancelled            => array(
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_declined             => array(
-                esc_html__('declined', 'event_espresso'),
-                esc_html__('declined', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_failed               => array(
-                esc_html__('failed', 'event_espresso'),
-                esc_html__('failed', 'event_espresso'),
-            ),
-            // following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
-            EEM_Event::sold_out                         => array(
-                esc_html__('sold out', 'event_espresso'),
-                esc_html__('sold out', 'event_espresso'),
-            ),
-            EEM_Event::postponed                        => array(
-                esc_html__('postponed', 'event_espresso'),
-                esc_html__('Postponed', 'event_espresso'),
-            ),
-            EEM_Event::cancelled                        => array(
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ),
-            EE_Ticket::archived                         => array(
-                esc_html__('archived', 'event_espresso'),
-                esc_html__('archived', 'event_espresso'),
-            ),
-            EE_Ticket::expired                          => array(
-                esc_html__('expired', 'event_espresso'),
-                esc_html__('expired', 'event_espresso'),
-            ),
-            EE_Ticket::sold_out                         => array(
-                esc_html__('sold out', 'event_espresso'),
-                esc_html__('sold out', 'event_espresso'),
-            ),
-            EE_Ticket::pending                          => array(
-                esc_html__('upcoming', 'event_espresso'),
-                esc_html__('upcoming', 'event_espresso'),
-            ),
-            EE_Ticket::onsale                           => array(
-                esc_html__('on sale', 'event_espresso'),
-                esc_html__('on sale', 'event_espresso'),
-            ),
-            EE_Datetime::cancelled                      => array(
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ),
-            EE_Datetime::sold_out                       => array(
-                esc_html__('sold out', 'event_espresso'),
-                esc_html__('sold out', 'event_espresso'),
-            ),
-            EE_Datetime::expired                        => array(
-                esc_html__('expired', 'event_espresso'),
-                esc_html__('expired', 'event_espresso'),
-            ),
-            EE_Datetime::inactive                       => array(
-                esc_html__('inactive', 'event_espresso'),
-                esc_html__('inactive', 'event_espresso'),
-            ),
-            EE_Datetime::upcoming                       => array(
-                esc_html__('upcoming', 'event_espresso'),
-                esc_html__('upcoming', 'event_espresso'),
-            ),
-            EE_Datetime::active                         => array(
-                esc_html__('active', 'event_espresso'),
-                esc_html__('active', 'event_espresso'),
-            ),
-            EE_Datetime::postponed                      => array(
-                esc_html__('postponed', 'event_espresso'),
-                esc_html__('postponed', 'event_espresso'),
-            ),
-            // messages related
-            EEM_Message::status_sent                    => array(
-                esc_html__('sent', 'event_espresso'),
-                esc_html__('sent', 'event_espresso'),
-            ),
-            EEM_Message::status_idle                    => array(
-                esc_html__('queued for sending', 'event_espresso'),
-                esc_html__('queued for sending', 'event_espresso'),
-            ),
-            EEM_Message::status_failed                  => array(
-                esc_html__('failed', 'event_espresso'),
-                esc_html__('failed', 'event_espresso'),
-            ),
-            EEM_Message::status_debug_only              => array(
-                esc_html__('debug only', 'event_espresso'),
-                esc_html__('debug only', 'event_espresso'),
-            ),
-            EEM_Message::status_messenger_executing     => array(
-                esc_html__('messenger is executing', 'event_espresso'),
-                esc_html__('messenger is executing', 'event_espresso'),
-            ),
-            EEM_Message::status_resend                  => array(
-                esc_html__('queued for resending', 'event_espresso'),
-                esc_html__('queued for resending', 'event_espresso'),
-            ),
-            EEM_Message::status_incomplete              => array(
-                esc_html__('queued for generating', 'event_espresso'),
-                esc_html__('queued for generating', 'event_espresso'),
-            ),
-            EEM_Message::status_retry                   => array(
-                esc_html__('failed sending, can be retried', 'event_espresso'),
-                esc_html__('failed sending, can be retried', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_publish           => array(
-                esc_html__('published', 'event_espresso'),
-                esc_html__('published', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_future            => array(
-                esc_html__('scheduled', 'event_espresso'),
-                esc_html__('scheduled', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_draft             => array(
-                esc_html__('draft', 'event_espresso'),
-                esc_html__('draft', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_pending           => array(
-                esc_html__('pending', 'event_espresso'),
-                esc_html__('pending', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_private           => array(
-                esc_html__('private', 'event_espresso'),
-                esc_html__('private', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_trashed           => array(
-                esc_html__('trashed', 'event_espresso'),
-                esc_html__('trashed', 'event_espresso'),
-            ),
-        );
+	/**
+	 * This method provides the localized singular or plural string for a given status id
+	 *
+	 * @param  array   $statuses This should be an array of statuses in the format array( $status_id, $status_code ).
+	 *                           That way if there isn't a translation in the index we'll return the default code.
+	 * @param  boolean $plural   Whether to return plural string or not. Note, nearly all of the plural strings are the
+	 *                           same as the singular (in English), however, this may NOT be the case with other
+	 *                           languages
+	 * @param  string  $schema   This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
+	 *                           the status string returned ( UPPER, lower, Sentence)
+	 * @throws EE_Error
+	 * @return array             an array of translated strings for the incoming status id.
+	 */
+	public function localized_status($statuses, $plural = false, $schema = 'upper')
+	{
+		// note these are all in lower case because ucwords() on upper case will NOT convert.
+		$translation_array = array(
+			EEM_Registration::status_id_pending_payment => array(
+				esc_html__('pending payment', 'event_espresso'), // singular
+				esc_html__('pending payments', 'event_espresso') // plural
+			),
+			EEM_Registration::status_id_approved        => array(
+				esc_html__('approved', 'event_espresso'), // singular
+				esc_html__('approved', 'event_espresso') // plural
+			),
+			EEM_Registration::status_id_not_approved    => array(
+				esc_html__('not approved', 'event_espresso'),
+				esc_html__('not approved', 'event_espresso'),
+			),
+			EEM_Registration::status_id_cancelled       => array(
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			),
+			EEM_Registration::status_id_incomplete      => array(
+				esc_html__('incomplete', 'event_espresso'),
+				esc_html__('incomplete', 'event_espresso'),
+			),
+			EEM_Registration::status_id_declined        => array(
+				esc_html__('declined', 'event_espresso'),
+				esc_html__('declined', 'event_espresso'),
+			),
+			EEM_Registration::status_id_wait_list       => array(
+				esc_html__('wait list', 'event_espresso'),
+				esc_html__('wait list', 'event_espresso'),
+			),
+			EEM_Transaction::overpaid_status_code       => array(
+				esc_html__('overpaid', 'event_espresso'),
+				esc_html__('overpaid', 'event_espresso'),
+			),
+			EEM_Transaction::complete_status_code       => array(
+				esc_html__('complete', 'event_espresso'),
+				esc_html__('complete', 'event_espresso'),
+			),
+			EEM_Transaction::incomplete_status_code     => array(
+				esc_html__('incomplete', 'event_espresso'),
+				esc_html__('incomplete', 'event_espresso'),
+			),
+			EEM_Transaction::failed_status_code         => array(
+				esc_html__('failed', 'event_espresso'),
+				esc_html__('failed', 'event_espresso'),
+			),
+			EEM_Transaction::abandoned_status_code      => array(
+				esc_html__('abandoned', 'event_espresso'),
+				esc_html__('abandoned', 'event_espresso'),
+			),
+			EEM_Payment::status_id_approved             => array(
+				esc_html__('accepted', 'event_espresso'),
+				esc_html__('accepted', 'event_espresso'),
+			),
+			EEM_Payment::status_id_pending              => array(
+				esc_html__('pending', 'event_espresso'),
+				esc_html__('pending', 'event_espresso'),
+			),
+			EEM_Payment::status_id_cancelled            => array(
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			),
+			EEM_Payment::status_id_declined             => array(
+				esc_html__('declined', 'event_espresso'),
+				esc_html__('declined', 'event_espresso'),
+			),
+			EEM_Payment::status_id_failed               => array(
+				esc_html__('failed', 'event_espresso'),
+				esc_html__('failed', 'event_espresso'),
+			),
+			// following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
+			EEM_Event::sold_out                         => array(
+				esc_html__('sold out', 'event_espresso'),
+				esc_html__('sold out', 'event_espresso'),
+			),
+			EEM_Event::postponed                        => array(
+				esc_html__('postponed', 'event_espresso'),
+				esc_html__('Postponed', 'event_espresso'),
+			),
+			EEM_Event::cancelled                        => array(
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			),
+			EE_Ticket::archived                         => array(
+				esc_html__('archived', 'event_espresso'),
+				esc_html__('archived', 'event_espresso'),
+			),
+			EE_Ticket::expired                          => array(
+				esc_html__('expired', 'event_espresso'),
+				esc_html__('expired', 'event_espresso'),
+			),
+			EE_Ticket::sold_out                         => array(
+				esc_html__('sold out', 'event_espresso'),
+				esc_html__('sold out', 'event_espresso'),
+			),
+			EE_Ticket::pending                          => array(
+				esc_html__('upcoming', 'event_espresso'),
+				esc_html__('upcoming', 'event_espresso'),
+			),
+			EE_Ticket::onsale                           => array(
+				esc_html__('on sale', 'event_espresso'),
+				esc_html__('on sale', 'event_espresso'),
+			),
+			EE_Datetime::cancelled                      => array(
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			),
+			EE_Datetime::sold_out                       => array(
+				esc_html__('sold out', 'event_espresso'),
+				esc_html__('sold out', 'event_espresso'),
+			),
+			EE_Datetime::expired                        => array(
+				esc_html__('expired', 'event_espresso'),
+				esc_html__('expired', 'event_espresso'),
+			),
+			EE_Datetime::inactive                       => array(
+				esc_html__('inactive', 'event_espresso'),
+				esc_html__('inactive', 'event_espresso'),
+			),
+			EE_Datetime::upcoming                       => array(
+				esc_html__('upcoming', 'event_espresso'),
+				esc_html__('upcoming', 'event_espresso'),
+			),
+			EE_Datetime::active                         => array(
+				esc_html__('active', 'event_espresso'),
+				esc_html__('active', 'event_espresso'),
+			),
+			EE_Datetime::postponed                      => array(
+				esc_html__('postponed', 'event_espresso'),
+				esc_html__('postponed', 'event_espresso'),
+			),
+			// messages related
+			EEM_Message::status_sent                    => array(
+				esc_html__('sent', 'event_espresso'),
+				esc_html__('sent', 'event_espresso'),
+			),
+			EEM_Message::status_idle                    => array(
+				esc_html__('queued for sending', 'event_espresso'),
+				esc_html__('queued for sending', 'event_espresso'),
+			),
+			EEM_Message::status_failed                  => array(
+				esc_html__('failed', 'event_espresso'),
+				esc_html__('failed', 'event_espresso'),
+			),
+			EEM_Message::status_debug_only              => array(
+				esc_html__('debug only', 'event_espresso'),
+				esc_html__('debug only', 'event_espresso'),
+			),
+			EEM_Message::status_messenger_executing     => array(
+				esc_html__('messenger is executing', 'event_espresso'),
+				esc_html__('messenger is executing', 'event_espresso'),
+			),
+			EEM_Message::status_resend                  => array(
+				esc_html__('queued for resending', 'event_espresso'),
+				esc_html__('queued for resending', 'event_espresso'),
+			),
+			EEM_Message::status_incomplete              => array(
+				esc_html__('queued for generating', 'event_espresso'),
+				esc_html__('queued for generating', 'event_espresso'),
+			),
+			EEM_Message::status_retry                   => array(
+				esc_html__('failed sending, can be retried', 'event_espresso'),
+				esc_html__('failed sending, can be retried', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_publish           => array(
+				esc_html__('published', 'event_espresso'),
+				esc_html__('published', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_future            => array(
+				esc_html__('scheduled', 'event_espresso'),
+				esc_html__('scheduled', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_draft             => array(
+				esc_html__('draft', 'event_espresso'),
+				esc_html__('draft', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_pending           => array(
+				esc_html__('pending', 'event_espresso'),
+				esc_html__('pending', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_private           => array(
+				esc_html__('private', 'event_espresso'),
+				esc_html__('private', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_trashed           => array(
+				esc_html__('trashed', 'event_espresso'),
+				esc_html__('trashed', 'event_espresso'),
+			),
+		);
 
-        $translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
+		$translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
 
-        if (! is_array($statuses)) {
-            throw new EE_Error(esc_html__(
-                'The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
-                'event_espresso'
-            ));
-        }
+		if (! is_array($statuses)) {
+			throw new EE_Error(esc_html__(
+				'The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
+				'event_espresso'
+			));
+		}
 
-        $translation = array();
+		$translation = array();
 
-        foreach ($statuses as $id => $code) {
-            if (isset($translation_array[ $id ])) {
-                $translation[ $id ] = $plural ? $translation_array[ $id ][1] : $translation_array[ $id ][0];
-            } else {
-                $translation[ $id ] = $code;
-            }
+		foreach ($statuses as $id => $code) {
+			if (isset($translation_array[ $id ])) {
+				$translation[ $id ] = $plural ? $translation_array[ $id ][1] : $translation_array[ $id ][0];
+			} else {
+				$translation[ $id ] = $code;
+			}
 
-            // schema
-            switch ($schema) {
-                case 'lower':
-                    $translation[ $id ] = strtolower($translation[ $id ]); // even though these start in lower case, this will catch any statuses added via filter.
-                    break;
-                case 'sentence':
-                    $translation[ $id ] = ucwords($translation[ $id ]);
-                    break;
-                case 'upper':
-                    $translation[ $id ] = strtoupper($translation[ $id ]);
-                    break;
-            }
-        }
+			// schema
+			switch ($schema) {
+				case 'lower':
+					$translation[ $id ] = strtolower($translation[ $id ]); // even though these start in lower case, this will catch any statuses added via filter.
+					break;
+				case 'sentence':
+					$translation[ $id ] = ucwords($translation[ $id ]);
+					break;
+				case 'upper':
+					$translation[ $id ] = strtoupper($translation[ $id ]);
+					break;
+			}
+		}
 
-        return $translation;
-    }
+		return $translation;
+	}
 }

core/db_models/EEM_Message_Template_Group.model.php

Spacing +22 added lines, -22 removed lines

@@ -48,7 +48,7 @@ 
             'WP_User' => new EE_Belongs_To_Relation()
         );
         foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+            $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_Global('MTP_is_global');
         }
         $this->_caps_slug = 'messages';
 
@@ -75,7 +75,7 @@ 
         $limit = null,
         $count = false
     ) {
-        $query_params = array( array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit);
         return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
     }
 
@@ -93,7 +93,7 @@ 
     public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
     {
         return $this->get_all_deleted_and_undeleted(
-            array( array( 'MTP_messenger' => $messenger ), 'order_by' => array( $orderby => $order ) )
+            array(array('MTP_messenger' => $messenger), 'order_by' => array($orderby => $order))
         );
     }
 
@@ -145,7 +145,7 @@ 
         $global = true,
         $user_check = false
     ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+        $_where = $global ? array('MTP_is_global' => true) : array('MTP_is_global' => false);
         $_where['MTP_is_active'] = true;
         $_where = $this->_maybe_mtp_filters($_where);
 
@@ -160,7 +160,7 @@ 
             $_where['MTP_user_id'] = get_current_user_id();
         }
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -181,7 +181,7 @@ 
     {
         $_where = $this->_maybe_mtp_filters();
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         $r_templates = $count
             ? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
@@ -201,9 +201,9 @@ 
      */
     public function get_all_custom_templates_by_event($EVT_ID, $query_params = array())
     {
-        $where = array_merge($query_params, array( 'Event.EVT_ID' => $EVT_ID ));
+        $where = array_merge($query_params, array('Event.EVT_ID' => $EVT_ID));
         return $this->get_all(
-            array( $where )
+            array($where)
         );
     }
 
@@ -228,11 +228,11 @@ 
         $count = false,
         $global = true
     ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+        $_where = $global ? array('MTP_is_global' => true) : array('MTP_is_global' => false);
         $_where['MTP_is_active'] = true;
         $_where = $this->_maybe_mtp_filters($_where);
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
     }
@@ -270,7 +270,7 @@ 
             'MTP_is_active' => $active
         );
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -310,7 +310,7 @@ 
             $_where['MTP_is_active'] = $active;
         }
 
-        $query_params = array( $_where, 'order_by' => array( $orderby => $order ), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -368,19 +368,19 @@ 
             // first let's figure out if the value['content'] in the current index is an array.
             //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
             if (is_array($value['content'])) {
-                $assembled_fields[ $value['name'] ] = $value['content']['main'];
+                $assembled_fields[$value['name']] = $value['content']['main'];
                 // loop through the content and get the other fields.
                 foreach ($value['content'] as $name => $val) {
                     if ($name == 'main') {
                         continue;
                     }
-                    $assembled_fields[ $name ] = $val;
+                    $assembled_fields[$name] = $val;
                 }
                 continue;
             }
 
             // okay if we're here then this is just a straight field=>$value arrangement
-            $assembled_fields[ $value['name'] ] = $value['content'];
+            $assembled_fields[$value['name']] = $value['content'];
         }
 
         // now we've got the assembled_fields.
@@ -390,9 +390,9 @@ 
         $mt_ref = ucwords(str_replace('_', ' ', $message_type));
         $mt_ref = str_replace(' ', '_', $mt_ref);
 
-        $classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
+        $classname = 'EE_Messages_'.$m_ref.'_'.$mt_ref.'_Validator';
 
-        if (!class_exists($classname)) {
+        if ( ! class_exists($classname)) {
             $msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
             $msg[] = sprintf(
                 esc_html__(
@@ -430,12 +430,12 @@ 
         if (empty($messenger_names) && empty($message_type_names)) {
             return 0;
         }
-        if (! empty($messenger_names)) {
-            $query_args[0]['MTP_messenger'] = array( 'IN', (array) $messenger_names );
+        if ( ! empty($messenger_names)) {
+            $query_args[0]['MTP_messenger'] = array('IN', (array) $messenger_names);
         }
-        if (! empty($message_type_names)) {
-            $query_args[0]['MTP_message_type'] = array( 'IN', (array) $message_type_names );
+        if ( ! empty($message_type_names)) {
+            $query_args[0]['MTP_message_type'] = array('IN', (array) $message_type_names);
         }
-        return $this->update(array( 'MTP_is_active' => false ), $query_args);
+        return $this->update(array('MTP_is_active' => false), $query_args);
     }
 }

Indentation +423 added lines, -423 removed lines

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

core/db_models/fields/EE_Datetime_Field.php

Spacing +11 added lines, -11 removed lines

@@ -213,8 +213,8 @@ 
 
             default:
                 return $pretty
-                    ? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
-                    : $this->_date_format . ' ' . $this->_time_format;
+                    ? $this->_pretty_date_format.' '.$this->_pretty_time_format
+                    : $this->_date_format.' '.$this->_time_format;
         }
     }
 
@@ -468,7 +468,7 @@ 
      */
     protected function _prepare_for_display($DateTime, $schema = false)
     {
-        if (! $DateTime instanceof DateTime) {
+        if ( ! $DateTime instanceof DateTime) {
             if ($this->_nullable) {
                 return '';
             } else {
@@ -502,15 +502,15 @@ 
             if ($this->_display_timezone()) {
                 // must be explicit because schema could equal true.
                 if ($schema === 'no_html') {
-                    $timezone_string = ' (' . $DateTime->format('T') . ')';
+                    $timezone_string = ' ('.$DateTime->format('T').')';
                 } else {
-                    $timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
+                    $timezone_string = ' <span class="ee_dtt_timezone_string">('.$DateTime->format('T').')</span>';
                 }
             } else {
                 $timezone_string = '';
             }
 
-            return $DateTime->format($format_string) . $timezone_string;
+            return $DateTime->format($format_string).$timezone_string;
         }
         return $DateTime->format($format_string);
     }
@@ -527,7 +527,7 @@ 
     public function prepare_for_use_in_db($datetime_value)
     {
         // we allow an empty value or DateTime object, but nothing else.
-        if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
+        if ( ! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -542,7 +542,7 @@ 
         }
 
         if ($datetime_value instanceof DateTime) {
-            if (! $datetime_value instanceof DbSafeDateTime) {
+            if ( ! $datetime_value instanceof DbSafeDateTime) {
                 $datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
             }
             EEH_DTT_Helper::setTimezone($datetime_value, $this->get_UTC_DateTimeZone());
@@ -581,7 +581,7 @@ 
             );
         }
 
-        if (! $DateTime instanceof DbSafeDateTime) {
+        if ( ! $DateTime instanceof DbSafeDateTime) {
             // if still no datetime object, then let's just use now
             $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
         }
@@ -658,10 +658,10 @@ 
         }
         // not a unix timestamp.  So we will use the set format on this object and set timezone to
         // create the DateTime object.
-        $format = $this->_date_format . ' ' . $this->_time_format;
+        $format = $this->_date_format.' '.$this->_time_format;
         try {
             $DateTime = DbSafeDateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
-            if (! $DateTime instanceof DbSafeDateTime) {
+            if ( ! $DateTime instanceof DbSafeDateTime) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__('"%1$s" does not represent a valid Date Time in the format "%2$s".', 'event_espresso'),

Indentation +752 added lines, -752 removed lines

@@ -15,757 +15,757 @@
  */
 class EE_Datetime_Field extends EE_Model_Field_Base
 {
-    /**
-     * The pattern we're looking for is if only the characters 0-9 are found and there are only
-     * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
-     *
-     * @type string unix_timestamp_regex
-     */
-    const unix_timestamp_regex = '/[0-9]{10,}/';
-
-    /**
-     * @type string mysql_timestamp_format
-     */
-    const mysql_timestamp_format = 'Y-m-d H:i:s';
-
-    /**
-     * @type string mysql_date_format
-     */
-    const mysql_date_format = 'Y-m-d';
-
-    /**
-     * @type string mysql_time_format
-     */
-    const mysql_time_format = 'H:i:s';
-
-    /**
-     * Const for using in the default value. If the field's default is set to this,
-     * then we will return the time of calling `get_default_value()`, not
-     * just the current time at construction
-     */
-    const now = 'now';
-
-    /**
-     * The following properties hold the default formats for date and time.
-     * Defaults are set via the constructor and can be overridden on class instantiation.
-     * However they can also be overridden later by the set_format() method
-     * (and corresponding set_date_format, set_time_format methods);
-     */
-    /**
-     * @type string $_date_format
-     */
-    protected $_date_format = '';
-
-    /**
-     * @type string $_time_format
-     */
-    protected $_time_format = '';
-
-    /**
-     * @type string $_pretty_date_format
-     */
-    protected $_pretty_date_format = '';
-
-    /**
-     * @type string $_pretty_time_format
-     */
-    protected $_pretty_time_format = '';
-
-    /**
-     * @type DateTimeZone $_DateTimeZone
-     */
-    protected $_DateTimeZone;
-
-    /**
-     * @type DateTimeZone $_UTC_DateTimeZone
-     */
-    protected $_UTC_DateTimeZone;
-
-    /**
-     * @type DateTimeZone $_blog_DateTimeZone
-     */
-    protected $_blog_DateTimeZone;
-
-
-    /**
-     * This property holds how we want the output returned when getting a datetime string.  It is set for the
-     * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
-     * and time returned via getters.
-     *
-     * @var mixed (null|string)
-     */
-    protected $_date_time_output;
-
-
-    /**
-     * timezone string
-     * This gets set by the constructor and can be changed by the "set_timezone()" method so that we know what timezone
-     * incoming strings|timestamps are in.  This can also be used before a get to set what timezone you want strings
-     * coming out of the object to be in.  Default timezone is the current WP timezone option setting
-     *
-     * @var string
-     */
-    protected $_timezone_string;
-
-
-    /**
-     * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
-     * offsets for comparison purposes).
-     *
-     * @var int
-     */
-    protected $_blog_offset;
-
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param string $default_value
-     * @param string $timezone_string
-     * @param string $date_format
-     * @param string $time_format
-     * @param string $pretty_date_format
-     * @param string $pretty_time_format
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $table_column,
-        $nice_name,
-        $nullable,
-        $default_value,
-        $timezone_string = '',
-        $date_format = '',
-        $time_format = '',
-        $pretty_date_format = '',
-        $pretty_time_format = ''
-    ) {
-
-        $this->_date_format        = ! empty($date_format) ? $date_format : get_option('date_format');
-        $this->_time_format        = ! empty($time_format) ? $time_format : get_option('time_format');
-        $this->_pretty_date_format = ! empty($pretty_date_format) ? $pretty_date_format : get_option('date_format');
-        $this->_pretty_time_format = ! empty($pretty_time_format) ? $pretty_time_format : get_option('time_format');
-
-        parent::__construct($table_column, $nice_name, $nullable, $default_value);
-        $this->set_timezone($timezone_string);
-        $this->setSchemaFormat('date-time');
-    }
-
-
-    /**
-     * @return DateTimeZone
-     * @throws \EE_Error
-     */
-    public function get_UTC_DateTimeZone()
-    {
-        return $this->_UTC_DateTimeZone instanceof DateTimeZone
-            ? $this->_UTC_DateTimeZone
-            : $this->_create_timezone_object_from_timezone_string('UTC');
-    }
-
-
-    /**
-     * @return DateTimeZone
-     * @throws \EE_Error
-     */
-    public function get_blog_DateTimeZone()
-    {
-        return $this->_blog_DateTimeZone instanceof DateTimeZone
-            ? $this->_blog_DateTimeZone
-            : $this->_create_timezone_object_from_timezone_string('');
-    }
-
-
-    /**
-     * this prepares any incoming date data and make sure its converted to a utc unix timestamp
-     *
-     * @param  string|int $value_inputted_for_field_on_model_object could be a string formatted date time or int unix
-     *                                                              timestamp
-     * @return DateTime
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $this->_get_date_object($value_inputted_for_field_on_model_object);
-    }
-
-
-    /**
-     * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
-     * getters need to know whether we're just returning the date or the time or both.  By default we return both.
-     *
-     * @param bool $pretty If we're returning the pretty formats or standard format string.
-     * @return string    The final assembled format string.
-     */
-    protected function _get_date_time_output($pretty = false)
-    {
-
-        switch ($this->_date_time_output) {
-            case 'time':
-                return $pretty ? $this->_pretty_time_format : $this->_time_format;
-                break;
-
-            case 'date':
-                return $pretty ? $this->_pretty_date_format : $this->_date_format;
-                break;
-
-            default:
-                return $pretty
-                    ? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
-                    : $this->_date_format . ' ' . $this->_time_format;
-        }
-    }
-
-
-    /**
-     * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
-     * returned (using the format properties)
-     *
-     * @param string $what acceptable values are 'time' or 'date'.
-     *                     Any other value will be set but will always result
-     *                     in both 'date' and 'time' being returned.
-     * @return void
-     */
-    public function set_date_time_output($what = null)
-    {
-        $this->_date_time_output = $what;
-    }
-
-
-    /**
-     * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
-     * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
-     * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp).
-     * We also set some other properties in this method.
-     *
-     * @param string $timezone_string A valid timezone string as described by @link
-     *                                http://www.php.net/manual/en/timezones.php
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function set_timezone($timezone_string)
-    {
-        if (empty($timezone_string) && $this->_timezone_string !== null) {
-            // leave the timezone AS-IS if we already have one and
-            // the function arg didn't provide one
-            return;
-        }
-        $timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
-        $this->_timezone_string = ! empty($timezone_string) ? $timezone_string : 'UTC';
-        $this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
-    }
-
-
-    /**
-     * _create_timezone_object_from_timezone_name
-     *
-     * @access protected
-     * @param string $timezone_string
-     * @return \DateTimeZone
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _create_timezone_object_from_timezone_string($timezone_string = '')
-    {
-        return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
-    }
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string timezone string
-     */
-    public function get_timezone()
-    {
-        return $this->_timezone_string;
-    }
-
-
-    /**
-     * set the $_date_format property
-     *
-     * @access public
-     * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
-     * @param bool   $pretty Whether to set pretty format or not.
-     * @return void
-     */
-    public function set_date_format($format, $pretty = false)
-    {
-        if ($pretty) {
-            $this->_pretty_date_format = $format;
-        } else {
-            $this->_date_format = $format;
-        }
-    }
-
-
-    /**
-     * return the $_date_format property value.
-     *
-     * @param bool $pretty Whether to get pretty format or not.
-     * @return string
-     */
-    public function get_date_format($pretty = false)
-    {
-        return $pretty ? $this->_pretty_date_format : $this->_date_format;
-    }
-
-
-    /**
-     * set the $_time_format property
-     *
-     * @access public
-     * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
-     * @param bool   $pretty Whether to set pretty format or not.
-     * @return void
-     */
-    public function set_time_format($format, $pretty = false)
-    {
-        if ($pretty) {
-            $this->_pretty_time_format = $format;
-        } else {
-            $this->_time_format = $format;
-        }
-    }
-
-
-    /**
-     * return the $_time_format property value.
-     *
-     * @param bool $pretty Whether to get pretty format or not.
-     * @return string
-     */
-    public function get_time_format($pretty = false)
-    {
-        return $pretty ? $this->_pretty_time_format : $this->_time_format;
-    }
-
-
-    /**
-     * set the $_pretty_date_format property
-     *
-     * @access public
-     * @param string $format a new pretty date format (corresponding to formats accepted by PHP date() function)
-     * @return void
-     */
-    public function set_pretty_date_format($format)
-    {
-        $this->_pretty_date_format = $format;
-    }
-
-
-    /**
-     * set the $_pretty_time_format property
-     *
-     * @access public
-     * @param string $format a new pretty time format (corresponding to formats accepted by PHP date() function)
-     * @return void
-     */
-    public function set_pretty_time_format($format)
-    {
-        $this->_pretty_time_format = $format;
-    }
-
-
-    /**
-     * Only sets the time portion of the datetime.
-     *
-     * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
-     * @param DateTime        $current            current DateTime object for the datetime field
-     * @return DateTime
-     */
-    public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current)
-    {
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
-        // Otherwise parse the string.
-        if ($time_to_set_string instanceof DateTime) {
-            $parsed = array(
-                'hour'   => $time_to_set_string->format('H'),
-                'minute' => $time_to_set_string->format('i'),
-                'second' => $time_to_set_string->format('s'),
-            );
-        } else {
-            // parse incoming string
-            $parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
-        }
-        EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
-        return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
-    }
-
-
-    /**
-     * Only sets the date portion of the datetime.
-     *
-     * @param string|DateTime $date_to_set_string like Friday, January 8th or a DateTime object.
-     * @param DateTime        $current            current DateTime object for the datetime field
-     * @return DateTime
-     */
-    public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current)
-    {
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
-        // Otherwise parse the string.
-        if ($date_to_set_string instanceof DateTime) {
-            $parsed = array(
-                'year'  => $date_to_set_string->format('Y'),
-                'month' => $date_to_set_string->format('m'),
-                'day'   => $date_to_set_string->format('d'),
-            );
-        } else {
-            // parse incoming string
-            $parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
-        }
-        EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
-        return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).  When the
-     * datetime gets to this stage it should ALREADY be in UTC time
-     *
-     * @param  DateTime $DateTime
-     * @return string formatted date time for given timezone
-     * @throws \EE_Error
-     */
-    public function prepare_for_get($DateTime)
-    {
-        return $this->_prepare_for_display($DateTime);
-    }
-
-
-    /**
-     * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
-     * from the set wp timezone.  If so, then it returns the datetime string formatted via
-     * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
-     * abbreviation to the date_string.
-     *
-     * @param mixed $DateTime
-     * @param null  $schema
-     * @return string
-     * @throws \EE_Error
-     */
-    public function prepare_for_pretty_echoing($DateTime, $schema = null)
-    {
-        return $this->_prepare_for_display($DateTime, $schema ? $schema : true);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
-     * timezone).
-     *
-     * @param DateTime    $DateTime
-     * @param bool|string $schema
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _prepare_for_display($DateTime, $schema = false)
-    {
-        if (! $DateTime instanceof DateTime) {
-            if ($this->_nullable) {
-                return '';
-            } else {
-                if (WP_DEBUG) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
-                                'event_espresso'
-                            ),
-                            $this->_nicename
-                        )
-                    );
-                } else {
-                    $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now);
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
-                                'event_espresso'
-                            ),
-                            $this->_nicename
-                        )
-                    );
-                }
-            }
-        }
-        $format_string = $this->_get_date_time_output($schema);
-        EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
-        if ($schema) {
-            if ($this->_display_timezone()) {
-                // must be explicit because schema could equal true.
-                if ($schema === 'no_html') {
-                    $timezone_string = ' (' . $DateTime->format('T') . ')';
-                } else {
-                    $timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
-                }
-            } else {
-                $timezone_string = '';
-            }
-
-            return $DateTime->format($format_string) . $timezone_string;
-        }
-        return $DateTime->format($format_string);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
-     * timezone).
-     *
-     * @param  mixed $datetime_value u
-     * @return string mysql timestamp in UTC
-     * @throws \EE_Error
-     */
-    public function prepare_for_use_in_db($datetime_value)
-    {
-        // we allow an empty value or DateTime object, but nothing else.
-        if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The incoming value being prepared for setting in the database must either be empty or a php 
+	/**
+	 * The pattern we're looking for is if only the characters 0-9 are found and there are only
+	 * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
+	 *
+	 * @type string unix_timestamp_regex
+	 */
+	const unix_timestamp_regex = '/[0-9]{10,}/';
+
+	/**
+	 * @type string mysql_timestamp_format
+	 */
+	const mysql_timestamp_format = 'Y-m-d H:i:s';
+
+	/**
+	 * @type string mysql_date_format
+	 */
+	const mysql_date_format = 'Y-m-d';
+
+	/**
+	 * @type string mysql_time_format
+	 */
+	const mysql_time_format = 'H:i:s';
+
+	/**
+	 * Const for using in the default value. If the field's default is set to this,
+	 * then we will return the time of calling `get_default_value()`, not
+	 * just the current time at construction
+	 */
+	const now = 'now';
+
+	/**
+	 * The following properties hold the default formats for date and time.
+	 * Defaults are set via the constructor and can be overridden on class instantiation.
+	 * However they can also be overridden later by the set_format() method
+	 * (and corresponding set_date_format, set_time_format methods);
+	 */
+	/**
+	 * @type string $_date_format
+	 */
+	protected $_date_format = '';
+
+	/**
+	 * @type string $_time_format
+	 */
+	protected $_time_format = '';
+
+	/**
+	 * @type string $_pretty_date_format
+	 */
+	protected $_pretty_date_format = '';
+
+	/**
+	 * @type string $_pretty_time_format
+	 */
+	protected $_pretty_time_format = '';
+
+	/**
+	 * @type DateTimeZone $_DateTimeZone
+	 */
+	protected $_DateTimeZone;
+
+	/**
+	 * @type DateTimeZone $_UTC_DateTimeZone
+	 */
+	protected $_UTC_DateTimeZone;
+
+	/**
+	 * @type DateTimeZone $_blog_DateTimeZone
+	 */
+	protected $_blog_DateTimeZone;
+
+
+	/**
+	 * This property holds how we want the output returned when getting a datetime string.  It is set for the
+	 * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
+	 * and time returned via getters.
+	 *
+	 * @var mixed (null|string)
+	 */
+	protected $_date_time_output;
+
+
+	/**
+	 * timezone string
+	 * This gets set by the constructor and can be changed by the "set_timezone()" method so that we know what timezone
+	 * incoming strings|timestamps are in.  This can also be used before a get to set what timezone you want strings
+	 * coming out of the object to be in.  Default timezone is the current WP timezone option setting
+	 *
+	 * @var string
+	 */
+	protected $_timezone_string;
+
+
+	/**
+	 * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
+	 * offsets for comparison purposes).
+	 *
+	 * @var int
+	 */
+	protected $_blog_offset;
+
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param string $default_value
+	 * @param string $timezone_string
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @param string $pretty_date_format
+	 * @param string $pretty_time_format
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$table_column,
+		$nice_name,
+		$nullable,
+		$default_value,
+		$timezone_string = '',
+		$date_format = '',
+		$time_format = '',
+		$pretty_date_format = '',
+		$pretty_time_format = ''
+	) {
+
+		$this->_date_format        = ! empty($date_format) ? $date_format : get_option('date_format');
+		$this->_time_format        = ! empty($time_format) ? $time_format : get_option('time_format');
+		$this->_pretty_date_format = ! empty($pretty_date_format) ? $pretty_date_format : get_option('date_format');
+		$this->_pretty_time_format = ! empty($pretty_time_format) ? $pretty_time_format : get_option('time_format');
+
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
+		$this->set_timezone($timezone_string);
+		$this->setSchemaFormat('date-time');
+	}
+
+
+	/**
+	 * @return DateTimeZone
+	 * @throws \EE_Error
+	 */
+	public function get_UTC_DateTimeZone()
+	{
+		return $this->_UTC_DateTimeZone instanceof DateTimeZone
+			? $this->_UTC_DateTimeZone
+			: $this->_create_timezone_object_from_timezone_string('UTC');
+	}
+
+
+	/**
+	 * @return DateTimeZone
+	 * @throws \EE_Error
+	 */
+	public function get_blog_DateTimeZone()
+	{
+		return $this->_blog_DateTimeZone instanceof DateTimeZone
+			? $this->_blog_DateTimeZone
+			: $this->_create_timezone_object_from_timezone_string('');
+	}
+
+
+	/**
+	 * this prepares any incoming date data and make sure its converted to a utc unix timestamp
+	 *
+	 * @param  string|int $value_inputted_for_field_on_model_object could be a string formatted date time or int unix
+	 *                                                              timestamp
+	 * @return DateTime
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $this->_get_date_object($value_inputted_for_field_on_model_object);
+	}
+
+
+	/**
+	 * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
+	 * getters need to know whether we're just returning the date or the time or both.  By default we return both.
+	 *
+	 * @param bool $pretty If we're returning the pretty formats or standard format string.
+	 * @return string    The final assembled format string.
+	 */
+	protected function _get_date_time_output($pretty = false)
+	{
+
+		switch ($this->_date_time_output) {
+			case 'time':
+				return $pretty ? $this->_pretty_time_format : $this->_time_format;
+				break;
+
+			case 'date':
+				return $pretty ? $this->_pretty_date_format : $this->_date_format;
+				break;
+
+			default:
+				return $pretty
+					? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
+					: $this->_date_format . ' ' . $this->_time_format;
+		}
+	}
+
+
+	/**
+	 * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
+	 * returned (using the format properties)
+	 *
+	 * @param string $what acceptable values are 'time' or 'date'.
+	 *                     Any other value will be set but will always result
+	 *                     in both 'date' and 'time' being returned.
+	 * @return void
+	 */
+	public function set_date_time_output($what = null)
+	{
+		$this->_date_time_output = $what;
+	}
+
+
+	/**
+	 * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
+	 * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
+	 * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp).
+	 * We also set some other properties in this method.
+	 *
+	 * @param string $timezone_string A valid timezone string as described by @link
+	 *                                http://www.php.net/manual/en/timezones.php
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function set_timezone($timezone_string)
+	{
+		if (empty($timezone_string) && $this->_timezone_string !== null) {
+			// leave the timezone AS-IS if we already have one and
+			// the function arg didn't provide one
+			return;
+		}
+		$timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$this->_timezone_string = ! empty($timezone_string) ? $timezone_string : 'UTC';
+		$this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
+	}
+
+
+	/**
+	 * _create_timezone_object_from_timezone_name
+	 *
+	 * @access protected
+	 * @param string $timezone_string
+	 * @return \DateTimeZone
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _create_timezone_object_from_timezone_string($timezone_string = '')
+	{
+		return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
+	}
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string timezone string
+	 */
+	public function get_timezone()
+	{
+		return $this->_timezone_string;
+	}
+
+
+	/**
+	 * set the $_date_format property
+	 *
+	 * @access public
+	 * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
+	 * @param bool   $pretty Whether to set pretty format or not.
+	 * @return void
+	 */
+	public function set_date_format($format, $pretty = false)
+	{
+		if ($pretty) {
+			$this->_pretty_date_format = $format;
+		} else {
+			$this->_date_format = $format;
+		}
+	}
+
+
+	/**
+	 * return the $_date_format property value.
+	 *
+	 * @param bool $pretty Whether to get pretty format or not.
+	 * @return string
+	 */
+	public function get_date_format($pretty = false)
+	{
+		return $pretty ? $this->_pretty_date_format : $this->_date_format;
+	}
+
+
+	/**
+	 * set the $_time_format property
+	 *
+	 * @access public
+	 * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
+	 * @param bool   $pretty Whether to set pretty format or not.
+	 * @return void
+	 */
+	public function set_time_format($format, $pretty = false)
+	{
+		if ($pretty) {
+			$this->_pretty_time_format = $format;
+		} else {
+			$this->_time_format = $format;
+		}
+	}
+
+
+	/**
+	 * return the $_time_format property value.
+	 *
+	 * @param bool $pretty Whether to get pretty format or not.
+	 * @return string
+	 */
+	public function get_time_format($pretty = false)
+	{
+		return $pretty ? $this->_pretty_time_format : $this->_time_format;
+	}
+
+
+	/**
+	 * set the $_pretty_date_format property
+	 *
+	 * @access public
+	 * @param string $format a new pretty date format (corresponding to formats accepted by PHP date() function)
+	 * @return void
+	 */
+	public function set_pretty_date_format($format)
+	{
+		$this->_pretty_date_format = $format;
+	}
+
+
+	/**
+	 * set the $_pretty_time_format property
+	 *
+	 * @access public
+	 * @param string $format a new pretty time format (corresponding to formats accepted by PHP date() function)
+	 * @return void
+	 */
+	public function set_pretty_time_format($format)
+	{
+		$this->_pretty_time_format = $format;
+	}
+
+
+	/**
+	 * Only sets the time portion of the datetime.
+	 *
+	 * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
+	 * @param DateTime        $current            current DateTime object for the datetime field
+	 * @return DateTime
+	 */
+	public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current)
+	{
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
+		// Otherwise parse the string.
+		if ($time_to_set_string instanceof DateTime) {
+			$parsed = array(
+				'hour'   => $time_to_set_string->format('H'),
+				'minute' => $time_to_set_string->format('i'),
+				'second' => $time_to_set_string->format('s'),
+			);
+		} else {
+			// parse incoming string
+			$parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
+		}
+		EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
+		return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
+	}
+
+
+	/**
+	 * Only sets the date portion of the datetime.
+	 *
+	 * @param string|DateTime $date_to_set_string like Friday, January 8th or a DateTime object.
+	 * @param DateTime        $current            current DateTime object for the datetime field
+	 * @return DateTime
+	 */
+	public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current)
+	{
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
+		// Otherwise parse the string.
+		if ($date_to_set_string instanceof DateTime) {
+			$parsed = array(
+				'year'  => $date_to_set_string->format('Y'),
+				'month' => $date_to_set_string->format('m'),
+				'day'   => $date_to_set_string->format('d'),
+			);
+		} else {
+			// parse incoming string
+			$parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
+		}
+		EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
+		return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).  When the
+	 * datetime gets to this stage it should ALREADY be in UTC time
+	 *
+	 * @param  DateTime $DateTime
+	 * @return string formatted date time for given timezone
+	 * @throws \EE_Error
+	 */
+	public function prepare_for_get($DateTime)
+	{
+		return $this->_prepare_for_display($DateTime);
+	}
+
+
+	/**
+	 * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
+	 * from the set wp timezone.  If so, then it returns the datetime string formatted via
+	 * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
+	 * abbreviation to the date_string.
+	 *
+	 * @param mixed $DateTime
+	 * @param null  $schema
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function prepare_for_pretty_echoing($DateTime, $schema = null)
+	{
+		return $this->_prepare_for_display($DateTime, $schema ? $schema : true);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
+	 * timezone).
+	 *
+	 * @param DateTime    $DateTime
+	 * @param bool|string $schema
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _prepare_for_display($DateTime, $schema = false)
+	{
+		if (! $DateTime instanceof DateTime) {
+			if ($this->_nullable) {
+				return '';
+			} else {
+				if (WP_DEBUG) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
+								'event_espresso'
+							),
+							$this->_nicename
+						)
+					);
+				} else {
+					$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now);
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
+								'event_espresso'
+							),
+							$this->_nicename
+						)
+					);
+				}
+			}
+		}
+		$format_string = $this->_get_date_time_output($schema);
+		EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
+		if ($schema) {
+			if ($this->_display_timezone()) {
+				// must be explicit because schema could equal true.
+				if ($schema === 'no_html') {
+					$timezone_string = ' (' . $DateTime->format('T') . ')';
+				} else {
+					$timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
+				}
+			} else {
+				$timezone_string = '';
+			}
+
+			return $DateTime->format($format_string) . $timezone_string;
+		}
+		return $DateTime->format($format_string);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
+	 * timezone).
+	 *
+	 * @param  mixed $datetime_value u
+	 * @return string mysql timestamp in UTC
+	 * @throws \EE_Error
+	 */
+	public function prepare_for_use_in_db($datetime_value)
+	{
+		// we allow an empty value or DateTime object, but nothing else.
+		if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The incoming value being prepared for setting in the database must either be empty or a php 
             		    DateTime object, instead of: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    print_r($datetime_value, true)
-                )
-            );
-        }
-
-        if ($datetime_value instanceof DateTime) {
-            if (! $datetime_value instanceof DbSafeDateTime) {
-                $datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
-            }
-            EEH_DTT_Helper::setTimezone($datetime_value, $this->get_UTC_DateTimeZone());
-            return $datetime_value->format(
-                EE_Datetime_Field::mysql_timestamp_format
-            );
-        }
-
-        // if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
-        return ! $this->_nullable && empty($datetime_value) ? current_time('mysql', true) : null;
-    }
-
-
-    /**
-     * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
-     * allowed)
-     *
-     * @param string $datetime_string mysql timestamp in UTC
-     * @return  mixed null | DateTime
-     * @throws \EE_Error
-     */
-    public function prepare_for_set_from_db($datetime_string)
-    {
-        // if $datetime_value is empty, and ! $this->_nullable, just use time()
-        if (empty($datetime_string) && $this->_nullable) {
-            return null;
-        }
-        // datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
-        if (empty($datetime_string)) {
-            $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
-        } else {
-            $DateTime = DbSafeDateTime::createFromFormat(
-                EE_Datetime_Field::mysql_timestamp_format,
-                $datetime_string,
-                $this->get_UTC_DateTimeZone()
-            );
-        }
-
-        if (! $DateTime instanceof DbSafeDateTime) {
-            // if still no datetime object, then let's just use now
-            $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
-        }
-        // THEN apply the field's set DateTimeZone
-        EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
-        return $DateTime;
-    }
-
-
-    /**
-     * All this method does is determine if we're going to display the timezone string or not on any output.
-     * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
-     * If so, then true.
-     *
-     * @return bool true for yes false for no
-     * @throws \EE_Error
-     */
-    protected function _display_timezone()
-    {
-
-        // first let's do a comparison of timezone strings.
-        // If they match then we can get out without any further calculations
-        $blog_string = get_option('timezone_string');
-        if ($blog_string === $this->_timezone_string) {
-            return false;
-        }
-        // now we need to calc the offset for the timezone string so we can compare with the blog offset.
-        $this_offset = $this->get_timezone_offset($this->_DateTimeZone);
-        $blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
-        // now compare
-        return $blog_offset !== $this_offset;
-    }
-
-
-    /**
-     * This method returns a php DateTime object for setting on the EE_Base_Class model.
-     * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
-     * with.
-     *
-     * @param int|string|DateTime $date_string            This should be the incoming date string.  It's assumed to be
-     *                                                    in the format that is set on the date_field (or DateTime
-     *                                                    object)!
-     * @return DateTime
-     */
-    protected function _get_date_object($date_string)
-    {
-        // first if this is an empty date_string and nullable is allowed, just return null.
-        if ($this->_nullable && empty($date_string)) {
-            return null;
-        }
-
-        // if incoming date
-        if ($date_string instanceof DateTime) {
-            EEH_DTT_Helper::setTimezone($date_string, $this->_DateTimeZone);
-            return $date_string;
-        }
-        // if empty date_string and made it here.
-        // Return a datetime object for now in the given timezone.
-        if (empty($date_string)) {
-            return new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
-        }
-        // if $date_string is matches something that looks like a Unix timestamp let's just use it.
-        if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
-            try {
-                // This is operating under the assumption that the incoming Unix timestamp
-                // is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
-                $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
-                $DateTime->setTimestamp($date_string);
-
-                return $DateTime;
-            } catch (Exception $e) {
-                // should be rare, but if things got fooled then let's just continue
-            }
-        }
-        // not a unix timestamp.  So we will use the set format on this object and set timezone to
-        // create the DateTime object.
-        $format = $this->_date_format . ' ' . $this->_time_format;
-        try {
-            $DateTime = DbSafeDateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
-            if (! $DateTime instanceof DbSafeDateTime) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__('"%1$s" does not represent a valid Date Time in the format "%2$s".', 'event_espresso'),
-                        $date_string,
-                        $format
-                    )
-                );
-            }
-        } catch (Exception $e) {
-            // if we made it here then likely then something went really wrong.
-            // Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
-            $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
-        }
-
-        return $DateTime;
-    }
-
-
-
-    /**
-     * get_timezone_transitions
-     *
-     * @param \DateTimeZone $DateTimeZone
-     * @param int           $time
-     * @param bool          $first_only
-     * @return mixed
-     */
-    public function get_timezone_transitions(DateTimeZone $DateTimeZone, $time = null, $first_only = true)
-    {
-        return EEH_DTT_Helper::get_timezone_transitions($DateTimeZone, $time, $first_only);
-    }
-
-
-
-    /**
-     * get_timezone_offset
-     *
-     * @param \DateTimeZone $DateTimeZone
-     * @param int           $time
-     * @return mixed
-     * @throws \DomainException
-     */
-    public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
-    {
-        return EEH_DTT_Helper::get_timezone_offset($DateTimeZone, $time);
-    }
-
-
-    /**
-     * This will take an incoming timezone string and return the abbreviation for that timezone
-     *
-     * @param  string $timezone_string
-     * @return string           abbreviation
-     * @throws \EE_Error
-     */
-    public function get_timezone_abbrev($timezone_string)
-    {
-        $timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
-        $dateTime        = new DateTime(\EE_Datetime_Field::now, new DateTimeZone($timezone_string));
-
-        return $dateTime->format('T');
-    }
-
-    /**
-     * Overrides the parent to allow for having a dynamic "now" value
-     *
-     * @return mixed
-     */
-    public function get_default_value()
-    {
-        if ($this->_default_value === EE_Datetime_Field::now) {
-            return time();
-        } else {
-            return parent::get_default_value();
-        }
-    }
-
-    /**
-     * Gets the default datetime object from the field's default time
-     * @since 4.9.66.p
-     * @return DbSafeDateTime|null
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getDefaultDateTimeObj()
-    {
-        $default_raw = $this->get_default_value();
-        if ($default_raw instanceof DateTime) {
-            return $default_raw;
-        } elseif (is_null($default_raw)) {
-            return $default_raw;
-        } else {
-            return new DbSafeDateTime(
-                $this->get_default_value(),
-                EEH_DTT_Helper::get_valid_timezone_string($this->get_timezone())
-            );
-        }
-    }
-
-    public function getSchemaDescription()
-    {
-        return sprintf(
-            esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
-            $this->get_nicename()
-        );
-    }
+						'event_espresso'
+					),
+					'<br />',
+					print_r($datetime_value, true)
+				)
+			);
+		}
+
+		if ($datetime_value instanceof DateTime) {
+			if (! $datetime_value instanceof DbSafeDateTime) {
+				$datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
+			}
+			EEH_DTT_Helper::setTimezone($datetime_value, $this->get_UTC_DateTimeZone());
+			return $datetime_value->format(
+				EE_Datetime_Field::mysql_timestamp_format
+			);
+		}
+
+		// if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
+		return ! $this->_nullable && empty($datetime_value) ? current_time('mysql', true) : null;
+	}
+
+
+	/**
+	 * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
+	 * allowed)
+	 *
+	 * @param string $datetime_string mysql timestamp in UTC
+	 * @return  mixed null | DateTime
+	 * @throws \EE_Error
+	 */
+	public function prepare_for_set_from_db($datetime_string)
+	{
+		// if $datetime_value is empty, and ! $this->_nullable, just use time()
+		if (empty($datetime_string) && $this->_nullable) {
+			return null;
+		}
+		// datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
+		if (empty($datetime_string)) {
+			$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
+		} else {
+			$DateTime = DbSafeDateTime::createFromFormat(
+				EE_Datetime_Field::mysql_timestamp_format,
+				$datetime_string,
+				$this->get_UTC_DateTimeZone()
+			);
+		}
+
+		if (! $DateTime instanceof DbSafeDateTime) {
+			// if still no datetime object, then let's just use now
+			$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
+		}
+		// THEN apply the field's set DateTimeZone
+		EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
+		return $DateTime;
+	}
+
+
+	/**
+	 * All this method does is determine if we're going to display the timezone string or not on any output.
+	 * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
+	 * If so, then true.
+	 *
+	 * @return bool true for yes false for no
+	 * @throws \EE_Error
+	 */
+	protected function _display_timezone()
+	{
+
+		// first let's do a comparison of timezone strings.
+		// If they match then we can get out without any further calculations
+		$blog_string = get_option('timezone_string');
+		if ($blog_string === $this->_timezone_string) {
+			return false;
+		}
+		// now we need to calc the offset for the timezone string so we can compare with the blog offset.
+		$this_offset = $this->get_timezone_offset($this->_DateTimeZone);
+		$blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
+		// now compare
+		return $blog_offset !== $this_offset;
+	}
+
+
+	/**
+	 * This method returns a php DateTime object for setting on the EE_Base_Class model.
+	 * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
+	 * with.
+	 *
+	 * @param int|string|DateTime $date_string            This should be the incoming date string.  It's assumed to be
+	 *                                                    in the format that is set on the date_field (or DateTime
+	 *                                                    object)!
+	 * @return DateTime
+	 */
+	protected function _get_date_object($date_string)
+	{
+		// first if this is an empty date_string and nullable is allowed, just return null.
+		if ($this->_nullable && empty($date_string)) {
+			return null;
+		}
+
+		// if incoming date
+		if ($date_string instanceof DateTime) {
+			EEH_DTT_Helper::setTimezone($date_string, $this->_DateTimeZone);
+			return $date_string;
+		}
+		// if empty date_string and made it here.
+		// Return a datetime object for now in the given timezone.
+		if (empty($date_string)) {
+			return new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
+		}
+		// if $date_string is matches something that looks like a Unix timestamp let's just use it.
+		if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
+			try {
+				// This is operating under the assumption that the incoming Unix timestamp
+				// is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
+				$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
+				$DateTime->setTimestamp($date_string);
+
+				return $DateTime;
+			} catch (Exception $e) {
+				// should be rare, but if things got fooled then let's just continue
+			}
+		}
+		// not a unix timestamp.  So we will use the set format on this object and set timezone to
+		// create the DateTime object.
+		$format = $this->_date_format . ' ' . $this->_time_format;
+		try {
+			$DateTime = DbSafeDateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
+			if (! $DateTime instanceof DbSafeDateTime) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__('"%1$s" does not represent a valid Date Time in the format "%2$s".', 'event_espresso'),
+						$date_string,
+						$format
+					)
+				);
+			}
+		} catch (Exception $e) {
+			// if we made it here then likely then something went really wrong.
+			// Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
+			$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
+		}
+
+		return $DateTime;
+	}
+
+
+
+	/**
+	 * get_timezone_transitions
+	 *
+	 * @param \DateTimeZone $DateTimeZone
+	 * @param int           $time
+	 * @param bool          $first_only
+	 * @return mixed
+	 */
+	public function get_timezone_transitions(DateTimeZone $DateTimeZone, $time = null, $first_only = true)
+	{
+		return EEH_DTT_Helper::get_timezone_transitions($DateTimeZone, $time, $first_only);
+	}
+
+
+
+	/**
+	 * get_timezone_offset
+	 *
+	 * @param \DateTimeZone $DateTimeZone
+	 * @param int           $time
+	 * @return mixed
+	 * @throws \DomainException
+	 */
+	public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
+	{
+		return EEH_DTT_Helper::get_timezone_offset($DateTimeZone, $time);
+	}
+
+
+	/**
+	 * This will take an incoming timezone string and return the abbreviation for that timezone
+	 *
+	 * @param  string $timezone_string
+	 * @return string           abbreviation
+	 * @throws \EE_Error
+	 */
+	public function get_timezone_abbrev($timezone_string)
+	{
+		$timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$dateTime        = new DateTime(\EE_Datetime_Field::now, new DateTimeZone($timezone_string));
+
+		return $dateTime->format('T');
+	}
+
+	/**
+	 * Overrides the parent to allow for having a dynamic "now" value
+	 *
+	 * @return mixed
+	 */
+	public function get_default_value()
+	{
+		if ($this->_default_value === EE_Datetime_Field::now) {
+			return time();
+		} else {
+			return parent::get_default_value();
+		}
+	}
+
+	/**
+	 * Gets the default datetime object from the field's default time
+	 * @since 4.9.66.p
+	 * @return DbSafeDateTime|null
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getDefaultDateTimeObj()
+	{
+		$default_raw = $this->get_default_value();
+		if ($default_raw instanceof DateTime) {
+			return $default_raw;
+		} elseif (is_null($default_raw)) {
+			return $default_raw;
+		} else {
+			return new DbSafeDateTime(
+				$this->get_default_value(),
+				EEH_DTT_Helper::get_valid_timezone_string($this->get_timezone())
+			);
+		}
+	}
+
+	public function getSchemaDescription()
+	{
+		return sprintf(
+			esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
+			$this->get_nicename()
+		);
+	}
 }

core/db_models/fields/EE_Foreign_Key_Int_Field.php

Indentation +29 added lines, -29 removed lines

@@ -3,36 +3,36 @@
 class EE_Foreign_Key_Int_Field extends EE_Foreign_Key_Field_Base
 {
 
-    /**
-     * @param string  $table_column  name fo column for field
-     * @param string  $nicename      should eb internationalized with esc_html__('blah','event_espresso')
-     * @param boolean $nullable
-     * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
-     *                               dbe a string
-     * @param string|string[]  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
-     *                               "EEM_"
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
-        $this->setSchemaType('integer');
-    }
+	/**
+	 * @param string  $table_column  name fo column for field
+	 * @param string  $nicename      should eb internationalized with esc_html__('blah','event_espresso')
+	 * @param boolean $nullable
+	 * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
+	 *                               dbe a string
+	 * @param string|string[]  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
+	 *                               "EEM_"
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
+		$this->setSchemaType('integer');
+	}
 
 
-    /**
-     * @param int|EE_Base_Class $value_inputted_for_field_on_model_object
-     * @return int
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return absint($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * @param int|EE_Base_Class $value_inputted_for_field_on_model_object
+	 * @return int
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return absint($value_inputted_for_field_on_model_object);
+	}
 
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return intval($value_found_in_db_for_model_object);
-    }
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return intval($value_found_in_db_for_model_object);
+	}
 }

core/db_models/fields/EE_Boolean_Field.php

Indentation +58 added lines, -58 removed lines

@@ -2,66 +2,66 @@
 
 class EE_Boolean_Field extends EE_Integer_Field
 {
-    /**
-     * @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('boolean');
-    }
+	/**
+	 * @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('boolean');
+	}
 
-    /**
-     * Double-checks the value being returned is an boolean.
-     * @since 4.9.74.p
-     * @param mixed $value_of_field_on_model_object
-     * @return boolean
-     */
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        return (bool) parent::prepare_for_get($value_of_field_on_model_object);
-    }
+	/**
+	 * Double-checks the value being returned is an boolean.
+	 * @since 4.9.74.p
+	 * @param mixed $value_of_field_on_model_object
+	 * @return boolean
+	 */
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		return (bool) parent::prepare_for_get($value_of_field_on_model_object);
+	}
 
-    /**
-     * @since 4.9.74.p
-     * @param $value_inputted_for_field_on_model_object
-     * @return boolean
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($value_inputted_for_field_on_model_object) {
-            return true;
-        } else {
-            return false;
-        }
-    }
+	/**
+	 * @since 4.9.74.p
+	 * @param $value_inputted_for_field_on_model_object
+	 * @return boolean
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($value_inputted_for_field_on_model_object) {
+			return true;
+		} else {
+			return false;
+		}
+	}
 
-    /**
-     * Make sure we're returning booleans
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return boolean
-     */
-    public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
-    {
-        return intval($value_inputted_for_field_on_model_object) ? true : false;
-    }
+	/**
+	 * Make sure we're returning booleans
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return boolean
+	 */
+	public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
+	{
+		return intval($value_inputted_for_field_on_model_object) ? true : false;
+	}
 
-    /**
-     * Gets a nice Yes/No value for this field
-     *
-     * @param boolean $value_on_field_to_be_outputted
-     * @return string Yes or No
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
-    {
-        return apply_filters(
-            'FHEE__EE_Boolean_Field__prepare_for_pretty_echoing__return',
-            $value_on_field_to_be_outputted ? esc_html__('Yes', 'event_espresso') : esc_html__('No', 'event_espresso'),
-            $value_on_field_to_be_outputted
-        );
-    }
+	/**
+	 * Gets a nice Yes/No value for this field
+	 *
+	 * @param boolean $value_on_field_to_be_outputted
+	 * @return string Yes or No
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
+	{
+		return apply_filters(
+			'FHEE__EE_Boolean_Field__prepare_for_pretty_echoing__return',
+			$value_on_field_to_be_outputted ? esc_html__('Yes', 'event_espresso') : esc_html__('No', 'event_espresso'),
+			$value_on_field_to_be_outputted
+		);
+	}
 }