eventespresso / event-espresso-core

core/db_classes/EE_Term_Taxonomy.class.php

Indentation +64 added lines, -64 removed lines

@@ -11,80 +11,80 @@
 class EE_Term_Taxonomy extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Term_Taxonomy
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Term_Taxonomy
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Term_Taxonomy
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Term_Taxonomy
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
 
 
-    /**
-     * Gets taxonomy
-     *
-     * @return string
-     */
-    public function taxonomy()
-    {
-        return $this->get('taxonomy');
-    }
+	/**
+	 * Gets taxonomy
+	 *
+	 * @return string
+	 */
+	public function taxonomy()
+	{
+		return $this->get('taxonomy');
+	}
 
 
-    /**
-     * Sets taxonomy
-     *
-     * @param string $taxonomy
-     * @return boolean
-     */
-    public function set_taxonomy($taxonomy)
-    {
-        $this->set('taxonomy', $taxonomy);
-    }
+	/**
+	 * Sets taxonomy
+	 *
+	 * @param string $taxonomy
+	 * @return boolean
+	 */
+	public function set_taxonomy($taxonomy)
+	{
+		$this->set('taxonomy', $taxonomy);
+	}
 
 
-    /**
-     * Gets term_count
-     *
-     * @return int
-     */
-    public function count()
-    {
-        return $this->get('term_count');
-    }
+	/**
+	 * Gets term_count
+	 *
+	 * @return int
+	 */
+	public function count()
+	{
+		return $this->get('term_count');
+	}
 
 
-    /**
-     * Sets term_count
-     *
-     * @param int $term_count
-     * @return boolean
-     */
-    public function set_count($term_count)
-    {
-        $this->set('term_count', $term_count);
-    }
+	/**
+	 * Sets term_count
+	 *
+	 * @param int $term_count
+	 * @return boolean
+	 */
+	public function set_count($term_count)
+	{
+		$this->set('term_count', $term_count);
+	}
 
 
-    /**
-     * Gets the term for this term taxonomy
-     *
-     * @return EE_Term
-     */
-    public function term()
-    {
-        return $this->get_first_related('Term');
-    }
+	/**
+	 * Gets the term for this term taxonomy
+	 *
+	 * @return EE_Term
+	 */
+	public function term()
+	{
+		return $this->get_first_related('Term');
+	}
 }

core/db_classes/EE_Message_Template_Group.class.php

Spacing +8 added lines, -8 removed lines

@@ -48,7 +48,7 @@ 
      */
     public function set_message_type($message_type = false)
     {
-        if (! $message_type) {
+        if ( ! $message_type) {
             throw new EE_Error(esc_html__('Missing required value for the message_type parameter', 'event_espresso'));
         }
         $this->set('MTP_message_type', $message_type);
@@ -61,7 +61,7 @@ 
      */
     public function set_messenger($messenger = false)
     {
-        if (! $messenger) {
+        if ( ! $messenger) {
             throw new EE_Error(esc_html__('Missing required value for the messenger parameter', 'event_espresso'));
         }
         $this->set('MTP_messenger', $messenger);
@@ -74,7 +74,7 @@ 
      */
     public function set_group_template_id($GRP_ID = false)
     {
-        if (! $GRP_ID) {
+        if ( ! $GRP_ID) {
             throw new EE_Error(
                 esc_html__(
                     'Missing required value for the message template group id',
@@ -290,7 +290,7 @@ 
         }
         // note contexts could have CHECKBOX fields per context. So we return the objects indexed by context AND field.
         foreach ($mtps as $mtp) {
-            $mtps_arr[ $mtp->get('MTP_context') ][ $mtp->get('MTP_template_field') ] = $mtp;
+            $mtps_arr[$mtp->get('MTP_context')][$mtp->get('MTP_template_field')] = $mtp;
         }
         return $mtps_arr;
     }
@@ -430,7 +430,7 @@ 
     public function deactivate_context($context)
     {
         $this->validate_context($context);
-        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, false);
+        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX.$context, false);
     }
 
 
@@ -445,7 +445,7 @@ 
     public function activate_context($context)
     {
         $this->validate_context($context);
-        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true);
+        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX.$context, true);
     }
 
 
@@ -465,7 +465,7 @@ 
     {
         $this->validate_context($context);
         return filter_var(
-            $this->get_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true, true),
+            $this->get_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX.$context, true, true),
             FILTER_VALIDATE_BOOLEAN
         );
     }
@@ -481,7 +481,7 @@ 
     public function validate_context($context)
     {
         $contexts = $this->contexts_config();
-        if (! isset($contexts[ $context ])) {
+        if ( ! isset($contexts[$context])) {
             throw new InvalidIdentifierException(
                 '',
                 '',

Indentation +483 added lines, -483 removed lines

@@ -13,487 +13,487 @@
 class EE_Message_Template_Group extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     * Extra Meta key prefix for whether a given context for this message tmeplate group is active or not.
-     */
-    const ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX = 'active_context_';
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template_Group|mixed
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '')
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template_Group
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @param bool $message_type
-     * @throws EE_Error
-     */
-    public function set_message_type($message_type = false)
-    {
-        if (! $message_type) {
-            throw new EE_Error(esc_html__('Missing required value for the message_type parameter', 'event_espresso'));
-        }
-        $this->set('MTP_message_type', $message_type);
-    }
-
-
-    /**
-     * @param bool $messenger
-     * @throws EE_Error
-     */
-    public function set_messenger($messenger = false)
-    {
-        if (! $messenger) {
-            throw new EE_Error(esc_html__('Missing required value for the messenger parameter', 'event_espresso'));
-        }
-        $this->set('MTP_messenger', $messenger);
-    }
-
-
-    /**
-     * @param bool $GRP_ID
-     * @throws EE_Error
-     */
-    public function set_group_template_id($GRP_ID = false)
-    {
-        if (! $GRP_ID) {
-            throw new EE_Error(
-                esc_html__(
-                    'Missing required value for the message template group id',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * get Group ID
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * get User ID
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function user()
-    {
-        $user_id = $this->get('MTP_user_id');
-        return empty($user_id) ? get_current_user_id() : $user_id;
-    }
-
-
-    /**
-     * Wrapper for the user function() (preserve backward compat)
-     *
-     * @since  4.5.0
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->user();
-    }
-
-
-    /**
-     * This simply returns a count of all related events to this message template group
-     *
-     * @return int
-     */
-    public function count_events()
-    {
-        return $this->count_related('Event');
-    }
-
-
-    /**
-     * returns the name saved in the db for this template
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        return $this->get('MTP_name');
-    }
-
-
-    /**
-     * Returns the description saved in the db for this template group
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function description()
-    {
-        return $this->get('MTP_description');
-    }
-
-
-    /**
-     * returns all related EE_Message_Template objects
-     *
-     * @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[]
-     * @throws EE_Error
-     */
-    public function message_templates($query_params = array())
-    {
-        return $this->get_many_related('Message_Template', $query_params);
-    }
-
-
-    /**
-     * get Message Messenger
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     */
-    public function messenger()
-    {
-        return $this->get('MTP_messenger');
-    }
-
-
-    /**
-     * get Message Messenger OBJECT
-     * If an attempt to get the corresponding messenger object fails, then we set this message
-     * template group to inactive, and save to db.  Then return null so client code can handle
-     * appropriately.
-     *
-     * @return EE_messenger
-     * @throws EE_Error
-     */
-    public function messenger_obj()
-    {
-        $messenger = $this->messenger();
-        try {
-            $messenger = EEH_MSG_Template::messenger_obj($messenger);
-        } catch (EE_Error $e) {
-            // if an exception was thrown then let's deactivate this message template group because it means there is no
-            // class for this messenger in this group.
-            $this->set('MTP_is_active', false);
-            $this->save();
-            return null;
-        }
-        return $messenger;
-    }
-
-
-    /**
-     * get Message Type
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     */
-    public function message_type()
-    {
-        return $this->get('MTP_message_type');
-    }
-
-
-    /**
-     * get Message type OBJECT
-     * If an attempt to get the corresponding message type object fails, then we set this message
-     * template group to inactive, and save to db.  Then return null so client code can handle
-     * appropriately.
-     *
-     * @throws EE_Error
-     * @return EE_message_type|false if exception thrown.
-     */
-    public function message_type_obj()
-    {
-        $message_type = $this->message_type();
-        try {
-            $message_type = EEH_MSG_Template::message_type_obj($message_type);
-        } catch (EE_Error $e) {
-            // if an exception was thrown then let's deactivate this message template group because it means there is no
-            // class for the message type in this group.
-            $this->set('MTP_is_active', false);
-            $this->save();
-            return null;
-        }
-        return $message_type;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     */
-    public function contexts_config()
-    {
-        return $this->message_type_obj()->get_contexts();
-    }
-
-
-    /**
-     * This returns the context_label for contexts as set in the message type object
-     * Note this is an array with singular and plural keys
-     *
-     * @access public
-     * @return array labels for "context"
-     * @throws EE_Error
-     */
-    public function context_label()
-    {
-        $obj = $this->message_type_obj();
-        return $obj->get_context_label();
-    }
-
-
-    /**
-     * This returns an array of EE_Message_Template objects indexed by context and field.
-     *
-     * @return array ()
-     * @throws EE_Error
-     */
-    public function context_templates()
-    {
-        $mtps_arr = array();
-        $mtps = $this->get_many_related('Message_Template');
-        if (empty($mtps)) {
-            return array();
-        }
-        // note contexts could have CHECKBOX fields per context. So we return the objects indexed by context AND field.
-        foreach ($mtps as $mtp) {
-            $mtps_arr[ $mtp->get('MTP_context') ][ $mtp->get('MTP_template_field') ] = $mtp;
-        }
-        return $mtps_arr;
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is global
-     *
-     * @return bool true if it is, false if it isn't
-     * @throws EE_Error
-     */
-    public function is_global()
-    {
-        return $this->get('MTP_is_global');
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
-     *
-     * @return bool true if it is, false if it isn't
-     * @throws EE_Error
-     */
-    public function is_active()
-    {
-        return $this->get('MTP_is_active');
-    }
-
-
-    /**
-     * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
-     * this template.
-     *
-     * @since 4.3.0
-     * @uses  EEH_MSG_Template::get_shortcodes()
-     * @param string $context what context we're going to return shortcodes for
-     * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
-     *                        to be returned.
-     * @param bool   $merged  If TRUE then we don't return shortcodes indexed by field but instead an array of the
-     *                        unique shortcodes for all the given (or all) fields.
-     * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
-     *                        shortcodes found.
-     * @throws EE_Error
-     */
-    public function get_shortcodes($context, $fields = array(), $merged = false)
-    {
-        $messenger = $this->messenger();
-        $message_type = $this->message_type();
-        return EEH_MSG_Template::get_shortcodes($message_type, $messenger, $fields, $context, $merged);
-    }
-
-
-    /**
-     * This just gets the template pack name assigned to this message template group.  If it's not set, then we just
-     * use the default template pack.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_template_pack_name()
-    {
-        return $this->get_extra_meta('MTP_template_pack', true, 'default');
-    }
-
-
-    /**
-     * This returns the specific template pack object referenced by the template pack name attached to this message
-     * template group.  If no template pack is assigned then the default template pack is retrieved.
-     *
-     * @since 4.5.0
-     * @return EE_Messages_Template_Pack
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function get_template_pack()
-    {
-        $pack_name = $this->get_template_pack_name();
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::get_template_pack($pack_name);
-    }
-
-
-    /**
-     * This retrieves the template variation assigned to this message template group.  If it's not set, then we just
-     * use the default template variation.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_template_pack_variation()
-    {
-        return $this->get_extra_meta('MTP_variation', true, 'default');
-    }
-
-
-    /**
-     * This just sets the template pack name attached to this message template group.
-     *
-     * @since 4.5.0
-     * @param string $template_pack_name What message template pack is assigned.
-     * @return int
-     * @throws EE_Error
-     */
-    public function set_template_pack_name($template_pack_name)
-    {
-        return $this->update_extra_meta('MTP_template_pack', $template_pack_name);
-    }
-
-
-    /**
-     * This just sets the template pack variation attached to this message template group.
-     *
-     * @since 4.5.0
-     * @param string $variation What variation is being set on the message template group.
-     * @return int
-     * @throws EE_Error
-     */
-    public function set_template_pack_variation($variation)
-    {
-        return $this->update_extra_meta('MTP_variation', $variation);
-    }
-
-
-    /**
-     * Deactivates the given context.
-     *
-     * @param $context
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    public function deactivate_context($context)
-    {
-        $this->validate_context($context);
-        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, false);
-    }
-
-
-    /**
-     * Activates the given context.
-     *
-     * @param $context
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    public function activate_context($context)
-    {
-        $this->validate_context($context);
-        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true);
-    }
-
-
-    /**
-     * Returns whether the context is active or not.
-     * Note, this will default to true if the extra meta record doesn't exist.
-     * Also, this does NOT account for whether the "To" field is empty or not. Some messengers may allow the "To" field
-     * to be empty (@see EE_Messenger::allow_empty_to_field()) so an empty "To" field is not always an indicator of
-     * whether a context is "active" or not.
-     *
-     * @param $context
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    public function is_context_active($context)
-    {
-        $this->validate_context($context);
-        return filter_var(
-            $this->get_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true, true),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * Validates the incoming context to verify it matches a registered context for the related message type.
-     *
-     * @param string $context
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    public function validate_context($context)
-    {
-        $contexts = $this->contexts_config();
-        if (! isset($contexts[ $context ])) {
-            throw new InvalidIdentifierException(
-                '',
-                '',
-                sprintf(
-                    esc_html__(
-                        'An invalid string identifying a context was provided.  "%1$s" was received, and one of "%2$s" was expected.',
-                        'event_espresso'
-                    ),
-                    $context,
-                    implode(',', array_keys($contexts))
-                )
-            );
-        }
-    }
+	/**
+	 * Extra Meta key prefix for whether a given context for this message tmeplate group is active or not.
+	 */
+	const ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX = 'active_context_';
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template_Group|mixed
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '')
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template_Group
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @param bool $message_type
+	 * @throws EE_Error
+	 */
+	public function set_message_type($message_type = false)
+	{
+		if (! $message_type) {
+			throw new EE_Error(esc_html__('Missing required value for the message_type parameter', 'event_espresso'));
+		}
+		$this->set('MTP_message_type', $message_type);
+	}
+
+
+	/**
+	 * @param bool $messenger
+	 * @throws EE_Error
+	 */
+	public function set_messenger($messenger = false)
+	{
+		if (! $messenger) {
+			throw new EE_Error(esc_html__('Missing required value for the messenger parameter', 'event_espresso'));
+		}
+		$this->set('MTP_messenger', $messenger);
+	}
+
+
+	/**
+	 * @param bool $GRP_ID
+	 * @throws EE_Error
+	 */
+	public function set_group_template_id($GRP_ID = false)
+	{
+		if (! $GRP_ID) {
+			throw new EE_Error(
+				esc_html__(
+					'Missing required value for the message template group id',
+					'event_espresso'
+				)
+			);
+		}
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * get Group ID
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * get User ID
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function user()
+	{
+		$user_id = $this->get('MTP_user_id');
+		return empty($user_id) ? get_current_user_id() : $user_id;
+	}
+
+
+	/**
+	 * Wrapper for the user function() (preserve backward compat)
+	 *
+	 * @since  4.5.0
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->user();
+	}
+
+
+	/**
+	 * This simply returns a count of all related events to this message template group
+	 *
+	 * @return int
+	 */
+	public function count_events()
+	{
+		return $this->count_related('Event');
+	}
+
+
+	/**
+	 * returns the name saved in the db for this template
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('MTP_name');
+	}
+
+
+	/**
+	 * Returns the description saved in the db for this template group
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function description()
+	{
+		return $this->get('MTP_description');
+	}
+
+
+	/**
+	 * returns all related EE_Message_Template objects
+	 *
+	 * @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[]
+	 * @throws EE_Error
+	 */
+	public function message_templates($query_params = array())
+	{
+		return $this->get_many_related('Message_Template', $query_params);
+	}
+
+
+	/**
+	 * get Message Messenger
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function messenger()
+	{
+		return $this->get('MTP_messenger');
+	}
+
+
+	/**
+	 * get Message Messenger OBJECT
+	 * If an attempt to get the corresponding messenger object fails, then we set this message
+	 * template group to inactive, and save to db.  Then return null so client code can handle
+	 * appropriately.
+	 *
+	 * @return EE_messenger
+	 * @throws EE_Error
+	 */
+	public function messenger_obj()
+	{
+		$messenger = $this->messenger();
+		try {
+			$messenger = EEH_MSG_Template::messenger_obj($messenger);
+		} catch (EE_Error $e) {
+			// if an exception was thrown then let's deactivate this message template group because it means there is no
+			// class for this messenger in this group.
+			$this->set('MTP_is_active', false);
+			$this->save();
+			return null;
+		}
+		return $messenger;
+	}
+
+
+	/**
+	 * get Message Type
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function message_type()
+	{
+		return $this->get('MTP_message_type');
+	}
+
+
+	/**
+	 * get Message type OBJECT
+	 * If an attempt to get the corresponding message type object fails, then we set this message
+	 * template group to inactive, and save to db.  Then return null so client code can handle
+	 * appropriately.
+	 *
+	 * @throws EE_Error
+	 * @return EE_message_type|false if exception thrown.
+	 */
+	public function message_type_obj()
+	{
+		$message_type = $this->message_type();
+		try {
+			$message_type = EEH_MSG_Template::message_type_obj($message_type);
+		} catch (EE_Error $e) {
+			// if an exception was thrown then let's deactivate this message template group because it means there is no
+			// class for the message type in this group.
+			$this->set('MTP_is_active', false);
+			$this->save();
+			return null;
+		}
+		return $message_type;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function contexts_config()
+	{
+		return $this->message_type_obj()->get_contexts();
+	}
+
+
+	/**
+	 * This returns the context_label for contexts as set in the message type object
+	 * Note this is an array with singular and plural keys
+	 *
+	 * @access public
+	 * @return array labels for "context"
+	 * @throws EE_Error
+	 */
+	public function context_label()
+	{
+		$obj = $this->message_type_obj();
+		return $obj->get_context_label();
+	}
+
+
+	/**
+	 * This returns an array of EE_Message_Template objects indexed by context and field.
+	 *
+	 * @return array ()
+	 * @throws EE_Error
+	 */
+	public function context_templates()
+	{
+		$mtps_arr = array();
+		$mtps = $this->get_many_related('Message_Template');
+		if (empty($mtps)) {
+			return array();
+		}
+		// note contexts could have CHECKBOX fields per context. So we return the objects indexed by context AND field.
+		foreach ($mtps as $mtp) {
+			$mtps_arr[ $mtp->get('MTP_context') ][ $mtp->get('MTP_template_field') ] = $mtp;
+		}
+		return $mtps_arr;
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is global
+	 *
+	 * @return bool true if it is, false if it isn't
+	 * @throws EE_Error
+	 */
+	public function is_global()
+	{
+		return $this->get('MTP_is_global');
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
+	 *
+	 * @return bool true if it is, false if it isn't
+	 * @throws EE_Error
+	 */
+	public function is_active()
+	{
+		return $this->get('MTP_is_active');
+	}
+
+
+	/**
+	 * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
+	 * this template.
+	 *
+	 * @since 4.3.0
+	 * @uses  EEH_MSG_Template::get_shortcodes()
+	 * @param string $context what context we're going to return shortcodes for
+	 * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
+	 *                        to be returned.
+	 * @param bool   $merged  If TRUE then we don't return shortcodes indexed by field but instead an array of the
+	 *                        unique shortcodes for all the given (or all) fields.
+	 * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
+	 *                        shortcodes found.
+	 * @throws EE_Error
+	 */
+	public function get_shortcodes($context, $fields = array(), $merged = false)
+	{
+		$messenger = $this->messenger();
+		$message_type = $this->message_type();
+		return EEH_MSG_Template::get_shortcodes($message_type, $messenger, $fields, $context, $merged);
+	}
+
+
+	/**
+	 * This just gets the template pack name assigned to this message template group.  If it's not set, then we just
+	 * use the default template pack.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_template_pack_name()
+	{
+		return $this->get_extra_meta('MTP_template_pack', true, 'default');
+	}
+
+
+	/**
+	 * This returns the specific template pack object referenced by the template pack name attached to this message
+	 * template group.  If no template pack is assigned then the default template pack is retrieved.
+	 *
+	 * @since 4.5.0
+	 * @return EE_Messages_Template_Pack
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function get_template_pack()
+	{
+		$pack_name = $this->get_template_pack_name();
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_template_pack($pack_name);
+	}
+
+
+	/**
+	 * This retrieves the template variation assigned to this message template group.  If it's not set, then we just
+	 * use the default template variation.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_template_pack_variation()
+	{
+		return $this->get_extra_meta('MTP_variation', true, 'default');
+	}
+
+
+	/**
+	 * This just sets the template pack name attached to this message template group.
+	 *
+	 * @since 4.5.0
+	 * @param string $template_pack_name What message template pack is assigned.
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function set_template_pack_name($template_pack_name)
+	{
+		return $this->update_extra_meta('MTP_template_pack', $template_pack_name);
+	}
+
+
+	/**
+	 * This just sets the template pack variation attached to this message template group.
+	 *
+	 * @since 4.5.0
+	 * @param string $variation What variation is being set on the message template group.
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function set_template_pack_variation($variation)
+	{
+		return $this->update_extra_meta('MTP_variation', $variation);
+	}
+
+
+	/**
+	 * Deactivates the given context.
+	 *
+	 * @param $context
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	public function deactivate_context($context)
+	{
+		$this->validate_context($context);
+		return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, false);
+	}
+
+
+	/**
+	 * Activates the given context.
+	 *
+	 * @param $context
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	public function activate_context($context)
+	{
+		$this->validate_context($context);
+		return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true);
+	}
+
+
+	/**
+	 * Returns whether the context is active or not.
+	 * Note, this will default to true if the extra meta record doesn't exist.
+	 * Also, this does NOT account for whether the "To" field is empty or not. Some messengers may allow the "To" field
+	 * to be empty (@see EE_Messenger::allow_empty_to_field()) so an empty "To" field is not always an indicator of
+	 * whether a context is "active" or not.
+	 *
+	 * @param $context
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	public function is_context_active($context)
+	{
+		$this->validate_context($context);
+		return filter_var(
+			$this->get_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true, true),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * Validates the incoming context to verify it matches a registered context for the related message type.
+	 *
+	 * @param string $context
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	public function validate_context($context)
+	{
+		$contexts = $this->contexts_config();
+		if (! isset($contexts[ $context ])) {
+			throw new InvalidIdentifierException(
+				'',
+				'',
+				sprintf(
+					esc_html__(
+						'An invalid string identifying a context was provided.  "%1$s" was received, and one of "%2$s" was expected.',
+						'event_espresso'
+					),
+					$context,
+					implode(',', array_keys($contexts))
+				)
+			);
+		}
+	}
 }

core/db_classes/EE_Message_Template.class.php

Indentation +169 added lines, -169 removed lines

@@ -13,173 +13,173 @@
 class EE_Message_Template extends EE_Base_Class
 {
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '')
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @param bool $GRP_ID
-     * @throws EE_Error
-     */
-    public function set_group_template_id($GRP_ID = false)
-    {
-        if (! $GRP_ID) {
-            throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
-        }
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * get Group ID
-     *
-     * @access public
-     * @return int
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * get User ID
-     *
-     * @access public
-     * @return int
-     */
-    public function user()
-    {
-        return $this->get_first_related('Message_Template_Group')->get('MTP_user_id');
-    }
-
-
-    /**
-     * get Message Messenger
-     *
-     * @access public
-     * @return string
-     */
-    public function messenger()
-    {
-        return $this->get_first_related('Message_Template_Group')->messenger();
-    }
-
-
-    /**
-     * get Message Messenger OBJECT
-     *
-     * @access public
-     * @return object Messenger Object for the given messenger
-     */
-    public function messenger_obj()
-    {
-        return $this->get_first_related('Message_Template_Group')->messenger_obj();
-    }
-
-
-    /**
-     * get Message Type
-     *
-     * @access public
-     * @return string
-     */
-    public function message_type()
-    {
-        return $this->get_first_related('Message_Template_Group')->message_type();
-    }
-
-
-    /**
-     * get Message type OBJECT
-     *
-     * @access public
-     * @return object  Message Type object for the given message type
-     */
-    public function message_type_obj()
-    {
-        return $this->get_first_related('Message_Template_Group')->message_type_obj();
-    }
-
-
-    /**
-     * This returns the set context array configured in the message type object
-     *
-     * @access public
-     * @return array array of contexts and their configuration.
-     */
-    public function contexts_config()
-    {
-        return $this->get_first_related('Message_Template_Group')->contexts_config();
-    }
-
-
-    /**
-     * This returns the context_label for contexts as set in the message type object
-     *
-     * @access public
-     * @return string label for "context"
-     */
-    public function context_label()
-    {
-        return $this->get_first_related('Message_Template_Group')->context_label();
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is global
-     *
-     * @return boolean true if it is, false if it isn't
-     */
-    public function is_global()
-    {
-        return $this->get_first_related('Message_Template_Group')->is_global();
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
-     *
-     * @return boolean true if it is, false if it isn't
-     */
-    public function is_active()
-    {
-        return $this->get_first_related('Message_Template_Group')->is_active();
-    }
-
-
-    /**
-     * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
-     * this template.
-     *
-     * @access public
-     * @param string $context what context we're going to return shortcodes for
-     * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
-     *                        to be merged and returned.
-     * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
-     *               shortcodes found.
-     */
-    public function get_shortcodes($context, $fields = array())
-    {
-        return $this->get_first_related('Message_Template_Group')->get_shortcodes($context, $fields);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '')
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @param bool $GRP_ID
+	 * @throws EE_Error
+	 */
+	public function set_group_template_id($GRP_ID = false)
+	{
+		if (! $GRP_ID) {
+			throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
+		}
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * get Group ID
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * get User ID
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function user()
+	{
+		return $this->get_first_related('Message_Template_Group')->get('MTP_user_id');
+	}
+
+
+	/**
+	 * get Message Messenger
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function messenger()
+	{
+		return $this->get_first_related('Message_Template_Group')->messenger();
+	}
+
+
+	/**
+	 * get Message Messenger OBJECT
+	 *
+	 * @access public
+	 * @return object Messenger Object for the given messenger
+	 */
+	public function messenger_obj()
+	{
+		return $this->get_first_related('Message_Template_Group')->messenger_obj();
+	}
+
+
+	/**
+	 * get Message Type
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function message_type()
+	{
+		return $this->get_first_related('Message_Template_Group')->message_type();
+	}
+
+
+	/**
+	 * get Message type OBJECT
+	 *
+	 * @access public
+	 * @return object  Message Type object for the given message type
+	 */
+	public function message_type_obj()
+	{
+		return $this->get_first_related('Message_Template_Group')->message_type_obj();
+	}
+
+
+	/**
+	 * This returns the set context array configured in the message type object
+	 *
+	 * @access public
+	 * @return array array of contexts and their configuration.
+	 */
+	public function contexts_config()
+	{
+		return $this->get_first_related('Message_Template_Group')->contexts_config();
+	}
+
+
+	/**
+	 * This returns the context_label for contexts as set in the message type object
+	 *
+	 * @access public
+	 * @return string label for "context"
+	 */
+	public function context_label()
+	{
+		return $this->get_first_related('Message_Template_Group')->context_label();
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is global
+	 *
+	 * @return boolean true if it is, false if it isn't
+	 */
+	public function is_global()
+	{
+		return $this->get_first_related('Message_Template_Group')->is_global();
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
+	 *
+	 * @return boolean true if it is, false if it isn't
+	 */
+	public function is_active()
+	{
+		return $this->get_first_related('Message_Template_Group')->is_active();
+	}
+
+
+	/**
+	 * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
+	 * this template.
+	 *
+	 * @access public
+	 * @param string $context what context we're going to return shortcodes for
+	 * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
+	 *                        to be merged and returned.
+	 * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
+	 *               shortcodes found.
+	 */
+	public function get_shortcodes($context, $fields = array())
+	{
+		return $this->get_first_related('Message_Template_Group')->get_shortcodes($context, $fields);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
      */
     public function set_group_template_id($GRP_ID = false)
     {
-        if (! $GRP_ID) {
+        if ( ! $GRP_ID) {
             throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
         }
         $this->set('GRP_ID', $GRP_ID);

core/db_classes/EE_CPT_Base.class.php

Indentation +425 added lines, -425 removed lines

@@ -14,429 +14,429 @@
 abstract class EE_CPT_Base extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     * This is a property for holding cached feature images on CPT objects.  Cache's are set on the first
-     * "feature_image()" method call.  Each key in the array corresponds to the requested size.
-     *
-     * @var array
-     */
-    protected $_feature_image = array();
-
-    /**
-     * @var WP_Post the WP_Post that corresponds with this CPT model object
-     */
-    protected $_wp_post;
-
-
-    abstract public function wp_user();
-
-
-    /**
-     * Returns the WP post associated with this CPT model object. If this CPT is saved, fetches it
-     * from the DB. Otherwise, create an unsaved WP_POst object. Caches the post internally.
-     *
-     * @return WP_Post
-     */
-    public function wp_post()
-    {
-        global $wpdb;
-        if (! $this->_wp_post instanceof WP_Post) {
-            if ($this->ID()) {
-                $this->_wp_post = get_post($this->ID());
-            } else {
-                $simulated_db_result = new stdClass();
-                foreach ($this->get_model()->field_settings(true) as $field_name => $field_obj) {
-                    if ($this->get_model()->get_table_obj_by_alias($field_obj->get_table_alias())->get_table_name()
-                        === $wpdb->posts
-                    ) {
-                        $column = $field_obj->get_table_column();
-
-                        if ($field_obj instanceof EE_Datetime_Field) {
-                            $value_on_model_obj = $this->get_DateTime_object($field_name);
-                        } elseif ($field_obj->is_db_only_field()) {
-                            $value_on_model_obj = $field_obj->get_default_value();
-                        } else {
-                            $value_on_model_obj = $this->get_raw($field_name);
-                        }
-                        $simulated_db_result->{$column} = $field_obj->prepare_for_use_in_db($value_on_model_obj);
-                    }
-                }
-                $this->_wp_post = new WP_Post($simulated_db_result);
-            }
-            // and let's make retrieving the EE CPT object easy too
-            $classname = get_class($this);
-            if (! isset($this->_wp_post->{$classname})) {
-                $this->_wp_post->{$classname} = $this;
-            }
-        }
-        return $this->_wp_post;
-    }
-
-    /**
-     * When fetching a new value for a post field that uses the global $post for rendering,
-     * set the global $post temporarily to be this model object; and afterwards restore it
-     *
-     * @param string $fieldname
-     * @param bool   $pretty
-     * @param string $extra_cache_ref
-     * @return mixed
-     */
-    protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
-    {
-        global $post;
-
-        if ($pretty
-            && (
-                ! (
-                    $post instanceof WP_Post
-                    && $post->ID
-                )
-                || (int) $post->ID !== $this->ID()
-            )
-            && $this->get_model()->field_settings_for($fieldname) instanceof EE_Post_Content_Field) {
-            $old_post = $post;
-            $post = $this->wp_post();
-            $return_value = parent::_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
-            $post = $old_post;
-        } else {
-            $return_value = parent::_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
-        }
-        return $return_value;
-    }
-
-    /**
-     * Adds to the specified event category. If it category doesn't exist, creates it.
-     *
-     * @param string $category_name
-     * @param string $category_description    optional
-     * @param int    $parent_term_taxonomy_id optional
-     * @return EE_Term_Taxonomy
-     */
-    public function add_event_category($category_name, $category_description = null, $parent_term_taxonomy_id = null)
-    {
-        return $this->get_model()->add_event_category(
-            $this,
-            $category_name,
-            $category_description,
-            $parent_term_taxonomy_id
-        );
-    }
-
-
-    /**
-     * Removes the event category by specified name from being related ot this event
-     *
-     * @param string $category_name
-     * @return bool
-     */
-    public function remove_event_category($category_name)
-    {
-        return $this->get_model()->remove_event_category($this, $category_name);
-    }
-
-
-    /**
-     * Removes the relation to the specified term taxonomy, and maintains the
-     * data integrity of the term taxonomy provided
-     *
-     * @param EE_Term_Taxonomy $term_taxonomy
-     * @return EE_Base_Class the relation was removed from
-     */
-    public function remove_relation_to_term_taxonomy($term_taxonomy)
-    {
-        if (! $term_taxonomy) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        "No Term_Taxonomy provided which to remove from model object of type %s and id %d",
-                        "event_espresso"
-                    ),
-                    get_class($this),
-                    $this->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $term_taxonomy->set_count($term_taxonomy->count() - 1);
-        $term_taxonomy->save();
-        return $this->_remove_relation_to($term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * The main purpose of this method is to return the post type for the model object
-     *
-     * @access public
-     * @return string
-     */
-    public function post_type()
-    {
-        return $this->get_model()->post_type();
-    }
-
-
-    /**
-     * The main purpose of this method is to return the parent for the model object
-     *
-     * @access public
-     * @return int
-     */
-    public function parent()
-    {
-        return $this->get('parent');
-    }
-
-
-    /**
-     * return the _status property
-     *
-     * @return string
-     */
-    public function status()
-    {
-        return $this->get('status');
-    }
-
-
-    /**
-     * @param string $status
-     */
-    public function set_status($status)
-    {
-        $this->set('status', $status);
-    }
-
-
-    /**
-     * This calls the equivalent model method for retrieving the feature image which in turn is a wrapper for
-     * WordPress' get_the_post_thumbnail() function.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
-     * @access protected
-     * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
-     *                           representing width and height in pixels (i.e. array(32,32) ).
-     * @param string|array $attr Optional. Query string or array of attributes.
-     * @return string HTML image element
-     */
-    protected function _get_feature_image($size, $attr)
-    {
-        // first let's see if we already have the _feature_image property set AND if it has a cached element on it FOR the given size
-        $attr_key = is_array($attr) ? implode('_', $attr) : $attr;
-        $cache_key = is_array($size) ? implode('_', $size) . $attr_key : $size . $attr_key;
-        $this->_feature_image[ $cache_key ] = isset($this->_feature_image[ $cache_key ])
-            ? $this->_feature_image[ $cache_key ] : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
-        return $this->_feature_image[ $cache_key ];
-    }
-
-
-    /**
-     * See _get_feature_image. Returns the HTML to display a featured image
-     *
-     * @param string       $size
-     * @param string|array $attr
-     * @return string of html
-     */
-    public function feature_image($size = 'thumbnail', $attr = '')
-    {
-        return $this->_get_feature_image($size, $attr);
-    }
-
-
-    /**
-     * This uses the wp "wp_get_attachment_image_src()" function to return the feature image for the current class
-     * using the given size params.
-     *
-     * @param  string|array $size can either be a string: 'thumbnail', 'medium', 'large', 'full' OR 2-item array
-     *                            representing width and height in pixels eg. array(32,32).
-     * @return string|boolean          the url of the image or false if not found
-     */
-    public function feature_image_url($size = 'thumbnail')
-    {
-        $attachment = wp_get_attachment_image_src(get_post_thumbnail_id($this->ID()), $size);
-        return ! empty($attachment) ? $attachment[0] : false;
-    }
-
-
-    /**
-     * This is a method for restoring this_obj using details from the given $revision_id
-     *
-     * @param int   $revision_id       ID of the revision we're getting data from
-     * @param array $related_obj_names if included this will be used to restore for related obj
-     *                                 if not included then we just do restore on the meta.
-     *                                 We will accept an array of related_obj_names for restoration here.
-     * @param array $where_query       You can optionally include an array of key=>value pairs
-     *                                 that allow you to further constrict the relation to being added.
-     *                                 However, keep in mind that the columns (keys) given
-     *                                 must match a column on the JOIN table and currently
-     *                                 only the HABTM models accept these additional conditions.
-     *                                 Also remember that if an exact match isn't found for these extra cols/val pairs,
-     *                                 then a NEW row is created in the join table.
-     *                                 This array is INDEXED by RELATED OBJ NAME (so it corresponds with the obj_names
-     *                                 sent);
-     * @return void
-     */
-    public function restore_revision($revision_id, $related_obj_names = array(), $where_query = array())
-    {
-        // get revision object
-        $revision_obj = $this->get_model()->get_one_by_ID($revision_id);
-        if ($revision_obj instanceof EE_CPT_Base) {
-            // no related_obj_name so we assume we're saving a revision on this object.
-            if (empty($related_obj_names)) {
-                $fields = $this->get_model()->get_meta_table_fields();
-                foreach ($fields as $field) {
-                    $this->set($field, $revision_obj->get($field));
-                }
-                $this->save();
-            }
-            $related_obj_names = (array) $related_obj_names;
-            foreach ($related_obj_names as $related_name) {
-                // related_obj_name so we're saving a revision on an object related to this object
-                // do we have $where_query params for this related object?  If we do then we include that.
-                $cols_n_values = isset($where_query[ $related_name ]) ? $where_query[ $related_name ] : array();
-                $where_params = ! empty($cols_n_values) ? array($cols_n_values) : array();
-                $related_objs = $this->get_many_related($related_name, $where_params);
-                $revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
-                // load helper
-                // remove related objs from this object that are not in revision
-                // array_diff *should* work cause I think objects are indexed by ID?
-                $related_to_remove = EEH_Array::object_array_diff($related_objs, $revision_related_objs);
-                foreach ($related_to_remove as $rr) {
-                    $this->_remove_relation_to($rr, $related_name, $cols_n_values);
-                }
-                // add all related objs attached to revision to this object
-                foreach ($revision_related_objs as $r_obj) {
-                    $this->_add_relation_to($r_obj, $related_name, $cols_n_values);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Wrapper for get_post_meta, http://codex.wordpress.org/Function_Reference/get_post_meta
-     *
-     * @param string  $meta_key
-     * @param boolean $single
-     * @return mixed <ul><li>If only $id is set it will return all meta values in an associative array.</li>
-     * <li>If $single is set to false, or left blank, the function returns an array containing all values of the
-     * specified key.</li>
-     * <li>If $single is set to true, the function returns the first value of the specified key (not in an
-     * array</li></ul>
-     */
-    public function get_post_meta($meta_key = null, $single = false)
-    {
-        return get_post_meta($this->ID(), $meta_key, $single);
-    }
-
-
-    /**
-     * Wrapper for update_post_meta, http://codex.wordpress.org/Function_Reference/update_post_meta
-     *
-     * @param string $meta_key
-     * @param mixed  $meta_value
-     * @param mixed  $prev_value
-     * @return mixed Returns meta_id if the meta doesn't exist, otherwise returns true on success and false on failure.
-     *               NOTE: If the meta_value passed to this function is the same as the value that is already in the
-     *               database, this function returns false.
-     */
-    public function update_post_meta($meta_key, $meta_value, $prev_value = null)
-    {
-        if (! $this->ID()) {
-            $this->save();
-        }
-        return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
-    }
-
-
-    /**
-     * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
-     *
-     * @param mixed $meta_key
-     * @param mixed $meta_value
-     * @param bool  $unique . If postmeta for this $meta_key already exists, whether to add an additional item or not
-     * @return boolean Boolean true, except if the $unique argument was set to true and a custom field with the given
-     *                 key already exists, in which case false is returned.
-     */
-    public function add_post_meta($meta_key, $meta_value, $unique = false)
-    {
-        if ($this->ID()) {
-            $this->save();
-        }
-        return add_post_meta($this->ID(), $meta_key, $meta_value, $unique);
-    }
-
-
-    /**
-     * Wrapper for delete_post_meta, http://codex.wordpress.org/Function_Reference/delete_post_meta
-     *
-     * @param mixed $meta_key
-     * @param mixed $meta_value
-     * @return boolean False for failure. True for success.
-     */
-    public function delete_post_meta($meta_key, $meta_value = '')
-    {
-        if (! $this->ID()) {
-            // there are obviously no postmetas for this if it's not saved
-            // so let's just report this as a success
-            return true;
-        }
-        return delete_post_meta($this->ID(), $meta_key, $meta_value);
-    }
-
-
-    /**
-     * Gets the URL for viewing this event on the front-end
-     *
-     * @return string
-     */
-    public function get_permalink()
-    {
-        return get_permalink($this->ID());
-    }
-
-
-    /**
-     * Gets all the term-taxonomies for this CPT
-     *
-     * @param array $query_params
-     * @return EE_Term_Taxonomy
-     */
-    public function term_taxonomies($query_params = array())
-    {
-        return $this->get_many_related('Term_Taxonomy', $query_params);
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function get_custom_post_statuses()
-    {
-        return $this->get_model()->get_custom_post_statuses();
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function get_all_post_statuses()
-    {
-        return $this->get_model()->get_status_array();
-    }
-
-
-    /**
-     * Don't serialize the WP Post. That's just duplicate data and we want to avoid recursion
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties_to_serialize = parent::__sleep();
-        $properties_to_serialize = array_diff($properties_to_serialize, array('_wp_post'));
-        return $properties_to_serialize;
-    }
+	/**
+	 * This is a property for holding cached feature images on CPT objects.  Cache's are set on the first
+	 * "feature_image()" method call.  Each key in the array corresponds to the requested size.
+	 *
+	 * @var array
+	 */
+	protected $_feature_image = array();
+
+	/**
+	 * @var WP_Post the WP_Post that corresponds with this CPT model object
+	 */
+	protected $_wp_post;
+
+
+	abstract public function wp_user();
+
+
+	/**
+	 * Returns the WP post associated with this CPT model object. If this CPT is saved, fetches it
+	 * from the DB. Otherwise, create an unsaved WP_POst object. Caches the post internally.
+	 *
+	 * @return WP_Post
+	 */
+	public function wp_post()
+	{
+		global $wpdb;
+		if (! $this->_wp_post instanceof WP_Post) {
+			if ($this->ID()) {
+				$this->_wp_post = get_post($this->ID());
+			} else {
+				$simulated_db_result = new stdClass();
+				foreach ($this->get_model()->field_settings(true) as $field_name => $field_obj) {
+					if ($this->get_model()->get_table_obj_by_alias($field_obj->get_table_alias())->get_table_name()
+						=== $wpdb->posts
+					) {
+						$column = $field_obj->get_table_column();
+
+						if ($field_obj instanceof EE_Datetime_Field) {
+							$value_on_model_obj = $this->get_DateTime_object($field_name);
+						} elseif ($field_obj->is_db_only_field()) {
+							$value_on_model_obj = $field_obj->get_default_value();
+						} else {
+							$value_on_model_obj = $this->get_raw($field_name);
+						}
+						$simulated_db_result->{$column} = $field_obj->prepare_for_use_in_db($value_on_model_obj);
+					}
+				}
+				$this->_wp_post = new WP_Post($simulated_db_result);
+			}
+			// and let's make retrieving the EE CPT object easy too
+			$classname = get_class($this);
+			if (! isset($this->_wp_post->{$classname})) {
+				$this->_wp_post->{$classname} = $this;
+			}
+		}
+		return $this->_wp_post;
+	}
+
+	/**
+	 * When fetching a new value for a post field that uses the global $post for rendering,
+	 * set the global $post temporarily to be this model object; and afterwards restore it
+	 *
+	 * @param string $fieldname
+	 * @param bool   $pretty
+	 * @param string $extra_cache_ref
+	 * @return mixed
+	 */
+	protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
+	{
+		global $post;
+
+		if ($pretty
+			&& (
+				! (
+					$post instanceof WP_Post
+					&& $post->ID
+				)
+				|| (int) $post->ID !== $this->ID()
+			)
+			&& $this->get_model()->field_settings_for($fieldname) instanceof EE_Post_Content_Field) {
+			$old_post = $post;
+			$post = $this->wp_post();
+			$return_value = parent::_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
+			$post = $old_post;
+		} else {
+			$return_value = parent::_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
+		}
+		return $return_value;
+	}
+
+	/**
+	 * Adds to the specified event category. If it category doesn't exist, creates it.
+	 *
+	 * @param string $category_name
+	 * @param string $category_description    optional
+	 * @param int    $parent_term_taxonomy_id optional
+	 * @return EE_Term_Taxonomy
+	 */
+	public function add_event_category($category_name, $category_description = null, $parent_term_taxonomy_id = null)
+	{
+		return $this->get_model()->add_event_category(
+			$this,
+			$category_name,
+			$category_description,
+			$parent_term_taxonomy_id
+		);
+	}
+
+
+	/**
+	 * Removes the event category by specified name from being related ot this event
+	 *
+	 * @param string $category_name
+	 * @return bool
+	 */
+	public function remove_event_category($category_name)
+	{
+		return $this->get_model()->remove_event_category($this, $category_name);
+	}
+
+
+	/**
+	 * Removes the relation to the specified term taxonomy, and maintains the
+	 * data integrity of the term taxonomy provided
+	 *
+	 * @param EE_Term_Taxonomy $term_taxonomy
+	 * @return EE_Base_Class the relation was removed from
+	 */
+	public function remove_relation_to_term_taxonomy($term_taxonomy)
+	{
+		if (! $term_taxonomy) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						"No Term_Taxonomy provided which to remove from model object of type %s and id %d",
+						"event_espresso"
+					),
+					get_class($this),
+					$this->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$term_taxonomy->set_count($term_taxonomy->count() - 1);
+		$term_taxonomy->save();
+		return $this->_remove_relation_to($term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * The main purpose of this method is to return the post type for the model object
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function post_type()
+	{
+		return $this->get_model()->post_type();
+	}
+
+
+	/**
+	 * The main purpose of this method is to return the parent for the model object
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function parent()
+	{
+		return $this->get('parent');
+	}
+
+
+	/**
+	 * return the _status property
+	 *
+	 * @return string
+	 */
+	public function status()
+	{
+		return $this->get('status');
+	}
+
+
+	/**
+	 * @param string $status
+	 */
+	public function set_status($status)
+	{
+		$this->set('status', $status);
+	}
+
+
+	/**
+	 * This calls the equivalent model method for retrieving the feature image which in turn is a wrapper for
+	 * WordPress' get_the_post_thumbnail() function.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
+	 * @access protected
+	 * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
+	 *                           representing width and height in pixels (i.e. array(32,32) ).
+	 * @param string|array $attr Optional. Query string or array of attributes.
+	 * @return string HTML image element
+	 */
+	protected function _get_feature_image($size, $attr)
+	{
+		// first let's see if we already have the _feature_image property set AND if it has a cached element on it FOR the given size
+		$attr_key = is_array($attr) ? implode('_', $attr) : $attr;
+		$cache_key = is_array($size) ? implode('_', $size) . $attr_key : $size . $attr_key;
+		$this->_feature_image[ $cache_key ] = isset($this->_feature_image[ $cache_key ])
+			? $this->_feature_image[ $cache_key ] : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
+		return $this->_feature_image[ $cache_key ];
+	}
+
+
+	/**
+	 * See _get_feature_image. Returns the HTML to display a featured image
+	 *
+	 * @param string       $size
+	 * @param string|array $attr
+	 * @return string of html
+	 */
+	public function feature_image($size = 'thumbnail', $attr = '')
+	{
+		return $this->_get_feature_image($size, $attr);
+	}
+
+
+	/**
+	 * This uses the wp "wp_get_attachment_image_src()" function to return the feature image for the current class
+	 * using the given size params.
+	 *
+	 * @param  string|array $size can either be a string: 'thumbnail', 'medium', 'large', 'full' OR 2-item array
+	 *                            representing width and height in pixels eg. array(32,32).
+	 * @return string|boolean          the url of the image or false if not found
+	 */
+	public function feature_image_url($size = 'thumbnail')
+	{
+		$attachment = wp_get_attachment_image_src(get_post_thumbnail_id($this->ID()), $size);
+		return ! empty($attachment) ? $attachment[0] : false;
+	}
+
+
+	/**
+	 * This is a method for restoring this_obj using details from the given $revision_id
+	 *
+	 * @param int   $revision_id       ID of the revision we're getting data from
+	 * @param array $related_obj_names if included this will be used to restore for related obj
+	 *                                 if not included then we just do restore on the meta.
+	 *                                 We will accept an array of related_obj_names for restoration here.
+	 * @param array $where_query       You can optionally include an array of key=>value pairs
+	 *                                 that allow you to further constrict the relation to being added.
+	 *                                 However, keep in mind that the columns (keys) given
+	 *                                 must match a column on the JOIN table and currently
+	 *                                 only the HABTM models accept these additional conditions.
+	 *                                 Also remember that if an exact match isn't found for these extra cols/val pairs,
+	 *                                 then a NEW row is created in the join table.
+	 *                                 This array is INDEXED by RELATED OBJ NAME (so it corresponds with the obj_names
+	 *                                 sent);
+	 * @return void
+	 */
+	public function restore_revision($revision_id, $related_obj_names = array(), $where_query = array())
+	{
+		// get revision object
+		$revision_obj = $this->get_model()->get_one_by_ID($revision_id);
+		if ($revision_obj instanceof EE_CPT_Base) {
+			// no related_obj_name so we assume we're saving a revision on this object.
+			if (empty($related_obj_names)) {
+				$fields = $this->get_model()->get_meta_table_fields();
+				foreach ($fields as $field) {
+					$this->set($field, $revision_obj->get($field));
+				}
+				$this->save();
+			}
+			$related_obj_names = (array) $related_obj_names;
+			foreach ($related_obj_names as $related_name) {
+				// related_obj_name so we're saving a revision on an object related to this object
+				// do we have $where_query params for this related object?  If we do then we include that.
+				$cols_n_values = isset($where_query[ $related_name ]) ? $where_query[ $related_name ] : array();
+				$where_params = ! empty($cols_n_values) ? array($cols_n_values) : array();
+				$related_objs = $this->get_many_related($related_name, $where_params);
+				$revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
+				// load helper
+				// remove related objs from this object that are not in revision
+				// array_diff *should* work cause I think objects are indexed by ID?
+				$related_to_remove = EEH_Array::object_array_diff($related_objs, $revision_related_objs);
+				foreach ($related_to_remove as $rr) {
+					$this->_remove_relation_to($rr, $related_name, $cols_n_values);
+				}
+				// add all related objs attached to revision to this object
+				foreach ($revision_related_objs as $r_obj) {
+					$this->_add_relation_to($r_obj, $related_name, $cols_n_values);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Wrapper for get_post_meta, http://codex.wordpress.org/Function_Reference/get_post_meta
+	 *
+	 * @param string  $meta_key
+	 * @param boolean $single
+	 * @return mixed <ul><li>If only $id is set it will return all meta values in an associative array.</li>
+	 * <li>If $single is set to false, or left blank, the function returns an array containing all values of the
+	 * specified key.</li>
+	 * <li>If $single is set to true, the function returns the first value of the specified key (not in an
+	 * array</li></ul>
+	 */
+	public function get_post_meta($meta_key = null, $single = false)
+	{
+		return get_post_meta($this->ID(), $meta_key, $single);
+	}
+
+
+	/**
+	 * Wrapper for update_post_meta, http://codex.wordpress.org/Function_Reference/update_post_meta
+	 *
+	 * @param string $meta_key
+	 * @param mixed  $meta_value
+	 * @param mixed  $prev_value
+	 * @return mixed Returns meta_id if the meta doesn't exist, otherwise returns true on success and false on failure.
+	 *               NOTE: If the meta_value passed to this function is the same as the value that is already in the
+	 *               database, this function returns false.
+	 */
+	public function update_post_meta($meta_key, $meta_value, $prev_value = null)
+	{
+		if (! $this->ID()) {
+			$this->save();
+		}
+		return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
+	}
+
+
+	/**
+	 * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
+	 *
+	 * @param mixed $meta_key
+	 * @param mixed $meta_value
+	 * @param bool  $unique . If postmeta for this $meta_key already exists, whether to add an additional item or not
+	 * @return boolean Boolean true, except if the $unique argument was set to true and a custom field with the given
+	 *                 key already exists, in which case false is returned.
+	 */
+	public function add_post_meta($meta_key, $meta_value, $unique = false)
+	{
+		if ($this->ID()) {
+			$this->save();
+		}
+		return add_post_meta($this->ID(), $meta_key, $meta_value, $unique);
+	}
+
+
+	/**
+	 * Wrapper for delete_post_meta, http://codex.wordpress.org/Function_Reference/delete_post_meta
+	 *
+	 * @param mixed $meta_key
+	 * @param mixed $meta_value
+	 * @return boolean False for failure. True for success.
+	 */
+	public function delete_post_meta($meta_key, $meta_value = '')
+	{
+		if (! $this->ID()) {
+			// there are obviously no postmetas for this if it's not saved
+			// so let's just report this as a success
+			return true;
+		}
+		return delete_post_meta($this->ID(), $meta_key, $meta_value);
+	}
+
+
+	/**
+	 * Gets the URL for viewing this event on the front-end
+	 *
+	 * @return string
+	 */
+	public function get_permalink()
+	{
+		return get_permalink($this->ID());
+	}
+
+
+	/**
+	 * Gets all the term-taxonomies for this CPT
+	 *
+	 * @param array $query_params
+	 * @return EE_Term_Taxonomy
+	 */
+	public function term_taxonomies($query_params = array())
+	{
+		return $this->get_many_related('Term_Taxonomy', $query_params);
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function get_custom_post_statuses()
+	{
+		return $this->get_model()->get_custom_post_statuses();
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function get_all_post_statuses()
+	{
+		return $this->get_model()->get_status_array();
+	}
+
+
+	/**
+	 * Don't serialize the WP Post. That's just duplicate data and we want to avoid recursion
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties_to_serialize = parent::__sleep();
+		$properties_to_serialize = array_diff($properties_to_serialize, array('_wp_post'));
+		return $properties_to_serialize;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -40,7 +40,7 @@ 
     public function wp_post()
     {
         global $wpdb;
-        if (! $this->_wp_post instanceof WP_Post) {
+        if ( ! $this->_wp_post instanceof WP_Post) {
             if ($this->ID()) {
                 $this->_wp_post = get_post($this->ID());
             } else {
@@ -65,7 +65,7 @@ 
             }
             // and let's make retrieving the EE CPT object easy too
             $classname = get_class($this);
-            if (! isset($this->_wp_post->{$classname})) {
+            if ( ! isset($this->_wp_post->{$classname})) {
                 $this->_wp_post->{$classname} = $this;
             }
         }
@@ -144,7 +144,7 @@ 
      */
     public function remove_relation_to_term_taxonomy($term_taxonomy)
     {
-        if (! $term_taxonomy) {
+        if ( ! $term_taxonomy) {
             EE_Error::add_error(
                 sprintf(
                     __(
@@ -225,10 +225,10 @@ 
     {
         // first let's see if we already have the _feature_image property set AND if it has a cached element on it FOR the given size
         $attr_key = is_array($attr) ? implode('_', $attr) : $attr;
-        $cache_key = is_array($size) ? implode('_', $size) . $attr_key : $size . $attr_key;
-        $this->_feature_image[ $cache_key ] = isset($this->_feature_image[ $cache_key ])
-            ? $this->_feature_image[ $cache_key ] : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
-        return $this->_feature_image[ $cache_key ];
+        $cache_key = is_array($size) ? implode('_', $size).$attr_key : $size.$attr_key;
+        $this->_feature_image[$cache_key] = isset($this->_feature_image[$cache_key])
+            ? $this->_feature_image[$cache_key] : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
+        return $this->_feature_image[$cache_key];
     }
 
 
@@ -295,7 +295,7 @@ 
             foreach ($related_obj_names as $related_name) {
                 // related_obj_name so we're saving a revision on an object related to this object
                 // do we have $where_query params for this related object?  If we do then we include that.
-                $cols_n_values = isset($where_query[ $related_name ]) ? $where_query[ $related_name ] : array();
+                $cols_n_values = isset($where_query[$related_name]) ? $where_query[$related_name] : array();
                 $where_params = ! empty($cols_n_values) ? array($cols_n_values) : array();
                 $related_objs = $this->get_many_related($related_name, $where_params);
                 $revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
@@ -344,7 +344,7 @@ 
      */
     public function update_post_meta($meta_key, $meta_value, $prev_value = null)
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             $this->save();
         }
         return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
@@ -378,7 +378,7 @@ 
      */
     public function delete_post_meta($meta_key, $meta_value = '')
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             // there are obviously no postmetas for this if it's not saved
             // so let's just report this as a success
             return true;

core/db_classes/EE_Ticket_Price.class.php

Indentation +19 added lines, -19 removed lines

@@ -11,25 +11,25 @@
 class EE_Ticket_Price extends EE_Base_Class
 {
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Ticket_Price|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '', $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Ticket_Price|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '', $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
 
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Ticket_Price
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Ticket_Price
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
 }

core/db_classes/EE_Ticket_Template.class.php

Indentation +19 added lines, -19 removed lines

@@ -12,25 +12,25 @@
 class EE_Ticket_Template extends EE_Base_Class
 {
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Ticket_Template|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '')
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Ticket_Template|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '')
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone);
+	}
 
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Ticket_Template
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Ticket_Template
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
 }

core/db_classes/EE_Extra_Meta.class.php

Indentation +111 added lines, -111 removed lines

@@ -10,115 +10,115 @@
 class EE_Extra_Meta extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Extra_Meta|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Extra_Meta
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Gets FK_ID
-     *
-     * @return int
-     */
-    public function FK_ID()
-    {
-        return $this->get('FK_ID');
-    }
-
-
-    /**
-     * Sets FK_ID
-     *
-     * @param int $FK_ID
-     * @return boolean
-     */
-    public function set_FK_ID($FK_ID)
-    {
-        $this->set('FK_ID', $FK_ID);
-    }
-
-
-    /**
-     * Gets model
-     *
-     * @return string
-     */
-    public function model()
-    {
-        return $this->get('EXM_model');
-    }
-
-
-    /**
-     * Sets model
-     *
-     * @param string $model
-     * @return boolean
-     */
-    public function set_model($model)
-    {
-        $this->set('EXM_model', $model);
-    }
-
-
-    /**
-     * Gets key
-     *
-     * @return string
-     */
-    public function key()
-    {
-        return $this->get('EXM_key');
-    }
-
-
-    /**
-     * Sets key
-     *
-     * @param string $key
-     * @return boolean
-     */
-    public function set_key($key)
-    {
-        $this->set('EXM_key', $key);
-    }
-
-
-    /**
-     * Gets value
-     *
-     * @return string
-     */
-    public function value()
-    {
-        return $this->get('EXM_value');
-    }
-
-
-    /**
-     * Sets value
-     *
-     * @param string $value
-     * @return boolean
-     */
-    public function set_value($value)
-    {
-        $this->set('EXM_value', $value);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Extra_Meta|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Extra_Meta
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Gets FK_ID
+	 *
+	 * @return int
+	 */
+	public function FK_ID()
+	{
+		return $this->get('FK_ID');
+	}
+
+
+	/**
+	 * Sets FK_ID
+	 *
+	 * @param int $FK_ID
+	 * @return boolean
+	 */
+	public function set_FK_ID($FK_ID)
+	{
+		$this->set('FK_ID', $FK_ID);
+	}
+
+
+	/**
+	 * Gets model
+	 *
+	 * @return string
+	 */
+	public function model()
+	{
+		return $this->get('EXM_model');
+	}
+
+
+	/**
+	 * Sets model
+	 *
+	 * @param string $model
+	 * @return boolean
+	 */
+	public function set_model($model)
+	{
+		$this->set('EXM_model', $model);
+	}
+
+
+	/**
+	 * Gets key
+	 *
+	 * @return string
+	 */
+	public function key()
+	{
+		return $this->get('EXM_key');
+	}
+
+
+	/**
+	 * Sets key
+	 *
+	 * @param string $key
+	 * @return boolean
+	 */
+	public function set_key($key)
+	{
+		$this->set('EXM_key', $key);
+	}
+
+
+	/**
+	 * Gets value
+	 *
+	 * @return string
+	 */
+	public function value()
+	{
+		return $this->get('EXM_value');
+	}
+
+
+	/**
+	 * Sets value
+	 *
+	 * @param string $value
+	 * @return boolean
+	 */
+	public function set_value($value)
+	{
+		$this->set('EXM_value', $value);
+	}
 }

core/db_classes/EE_Post_Meta.class.php

Indentation +108 added lines, -108 removed lines

@@ -10,112 +10,112 @@
 class EE_Post_Meta extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Post_Meta|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Post_Meta
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Gets meta_id
-     *
-     * @return int
-     */
-    public function meta_id()
-    {
-        return $this->get('meta_id');
-    }
-
-
-    /**
-     * Sets meta_id
-     *
-     * @param int $meta_id
-     * @return boolean
-     */
-    public function set_meta_id($meta_id)
-    {
-        return $this->set('meta_id', $meta_id);
-    }
-
-    /**
-     * Gets post_id
-     *
-     * @return int
-     */
-    public function post_id()
-    {
-        return $this->get('post_id');
-    }
-
-
-    /**
-     * Sets post_id
-     *
-     * @param int $post_id
-     * @return boolean
-     */
-    public function set_post_id($post_id)
-    {
-        return $this->set('post_id', $post_id);
-    }
-
-    /**
-     * Gets meta_key
-     *
-     * @return string
-     */
-    public function meta_key()
-    {
-        return $this->get('meta_key');
-    }
-
-
-    /**
-     * Sets meta_key
-     *
-     * @param string $meta_key
-     * @return boolean
-     */
-    public function set_meta_key($meta_key)
-    {
-        return $this->set('meta_key', $meta_key);
-    }
-
-    /**
-     * Gets meta_value
-     *
-     * @return mixed
-     */
-    public function meta_value()
-    {
-        return $this->get('meta_value');
-    }
-
-
-    /**
-     * Sets meta_value
-     *
-     * @param mixed $meta_value
-     * @return boolean
-     */
-    public function set_meta_value($meta_value)
-    {
-        return $this->set('meta_value', $meta_value);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Post_Meta|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Post_Meta
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Gets meta_id
+	 *
+	 * @return int
+	 */
+	public function meta_id()
+	{
+		return $this->get('meta_id');
+	}
+
+
+	/**
+	 * Sets meta_id
+	 *
+	 * @param int $meta_id
+	 * @return boolean
+	 */
+	public function set_meta_id($meta_id)
+	{
+		return $this->set('meta_id', $meta_id);
+	}
+
+	/**
+	 * Gets post_id
+	 *
+	 * @return int
+	 */
+	public function post_id()
+	{
+		return $this->get('post_id');
+	}
+
+
+	/**
+	 * Sets post_id
+	 *
+	 * @param int $post_id
+	 * @return boolean
+	 */
+	public function set_post_id($post_id)
+	{
+		return $this->set('post_id', $post_id);
+	}
+
+	/**
+	 * Gets meta_key
+	 *
+	 * @return string
+	 */
+	public function meta_key()
+	{
+		return $this->get('meta_key');
+	}
+
+
+	/**
+	 * Sets meta_key
+	 *
+	 * @param string $meta_key
+	 * @return boolean
+	 */
+	public function set_meta_key($meta_key)
+	{
+		return $this->set('meta_key', $meta_key);
+	}
+
+	/**
+	 * Gets meta_value
+	 *
+	 * @return mixed
+	 */
+	public function meta_value()
+	{
+		return $this->get('meta_value');
+	}
+
+
+	/**
+	 * Sets meta_value
+	 *
+	 * @param mixed $meta_value
+	 * @return boolean
+	 */
+	public function set_meta_value($meta_value)
+	{
+		return $this->set('meta_value', $meta_value);
+	}
 }

core/db_classes/EE_Question.class.php

Spacing +3 added lines, -3 removed lines

@@ -335,7 +335,7 @@ 
      */
     public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return array();
         }
         $query_params = array();
@@ -509,7 +509,7 @@ 
             ),
             $input_constructor_args
         );
-        if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
+        if ( ! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
             $answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID());
         }
         // has this question been answered ?
@@ -647,7 +647,7 @@ 
                     $this,
                     $input_constructor_args
                 );
-                if (! $default_input) {
+                if ( ! $default_input) {
                     $default_input = new EE_Text_Input($input_constructor_args);
                 }
                 $result = $default_input;

Indentation +657 added lines, -657 removed lines

@@ -14,661 +14,661 @@
 class EE_Question extends EE_Soft_Delete_Base_Class implements EEI_Duplicatable
 {
 
-    /**
-     *
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Question
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Question
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set    Question display text
-     *
-     * @access        public
-     * @param string $QST_display_text
-     */
-    public function set_display_text($QST_display_text = '')
-    {
-        $this->set('QST_display_text', $QST_display_text);
-    }
-
-
-    /**
-     *        Set    Question admin text
-     *
-     * @access        public
-     * @param        string $QST_admin_label
-     */
-    public function set_admin_label($QST_admin_label = '')
-    {
-        $this->set('QST_admin_label', $QST_admin_label);
-    }
-
-
-    /**
-     *        Set    system name
-     *
-     * @access        public
-     * @param        mixed $QST_system
-     */
-    public function set_system_ID($QST_system = '')
-    {
-        $this->set('QST_system', $QST_system);
-    }
-
-
-    /**
-     *        Set    question's type
-     *
-     * @access        public
-     * @param        string $QST_type
-     */
-    public function set_question_type($QST_type = '')
-    {
-        $this->set('QST_type', $QST_type);
-    }
-
-
-    /**
-     *        Sets whether this question must be answered when presented in a form
-     *
-     * @access        public
-     * @param        bool $QST_required
-     */
-    public function set_required($QST_required = false)
-    {
-        $this->set('QST_required', $QST_required);
-    }
-
-
-    /**
-     *        Set    Question display text
-     *
-     * @access        public
-     * @param        string $QST_required_text
-     */
-    public function set_required_text($QST_required_text = '')
-    {
-        $this->set('QST_required_text', $QST_required_text);
-    }
-
-
-    /**
-     *        Sets the order of this question when placed in a sequence of questions
-     *
-     * @access        public
-     * @param        int $QST_order
-     */
-    public function set_order($QST_order = 0)
-    {
-        $this->set('QST_order', $QST_order);
-    }
-
-
-    /**
-     *        Sets whether the question is admin-only
-     *
-     * @access        public
-     * @param        bool $QST_admin_only
-     */
-    public function set_admin_only($QST_admin_only = false)
-    {
-        $this->set('QST_admin_only', $QST_admin_only);
-    }
-
-
-    /**
-     *        Sets the wordpress user ID on the question
-     *
-     * @access        public
-     * @param        int $QST_wp_user
-     */
-    public function set_wp_user($QST_wp_user = 1)
-    {
-        $this->set('QST_wp_user', $QST_wp_user);
-    }
-
-
-    /**
-     *        Sets whether the question has been deleted
-     *        (we use this boolean instead of actually
-     *        deleting it because when users delete this question
-     *        they really want to remove the question from future
-     *        forms, BUT keep their old answers which depend
-     *        on this record actually existing.
-     *
-     * @access        public
-     * @param    bool $QST_deleted
-     */
-    public function set_deleted($QST_deleted = false)
-    {
-        $this->set('QST_deleted', $QST_deleted);
-    }
-
-
-    /**
-     * returns the text for displaying the question to users
-     *
-     * @access public
-     * @return string
-     */
-    public function display_text()
-    {
-        return $this->get('QST_display_text');
-    }
-
-
-    /**
-     * returns the text for the administrative label
-     *
-     * @access public
-     * @return string
-     */
-    public function admin_label()
-    {
-        return $this->get('QST_admin_label');
-    }
-
-
-    /**
-     * returns the attendee column name for this question
-     *
-     * @access public
-     * @return string
-     */
-    public function system_ID()
-    {
-        return $this->get('QST_system');
-    }
-
-
-    /**
-     * returns either a string of 'text', 'textfield', etc.
-     *
-     * @access public
-     * @return boolean
-     */
-    public function required()
-    {
-        return $this->get('QST_required');
-    }
-
-
-    /**
-     * returns the text which should be displayed when a user
-     * doesn't answer this question in a form
-     *
-     * @access public
-     * @return string
-     */
-    public function required_text()
-    {
-        return $this->get('QST_required_text');
-    }
-
-
-    /**
-     * returns the type of this question
-     *
-     * @access public
-     * @return string
-     */
-    public function type()
-    {
-        return $this->get('QST_type');
-    }
-
-
-    /**
-     * returns an integer showing where this question should
-     * be placed in a sequence of questions
-     *
-     * @access public
-     * @return int
-     */
-    public function order()
-    {
-        return $this->get('QST_order');
-    }
-
-
-    /**
-     * returns whether this question should only appears to admins,
-     * or to everyone
-     *
-     * @access public
-     * @return boolean
-     */
-    public function admin_only()
-    {
-        return $this->get('QST_admin_only');
-    }
-
-
-    /**
-     * returns the id the wordpress user who created this question
-     *
-     * @access public
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('QST_wp_user');
-    }
-
-
-    /**
-     * returns whether this question has been marked as 'deleted'
-     *
-     * @access public
-     * @return boolean
-     */
-    public function deleted()
-    {
-        return $this->get('QST_deleted');
-    }
-
-
-    /**
-     * Gets an array of related EE_Answer  to this EE_Question
-     *
-     * @return EE_Answer[]
-     */
-    public function answers()
-    {
-        return $this->get_many_related('Answer');
-    }
-
-
-    /**
-     * Boolean check for if there are answers on this question in th db
-     *
-     * @return boolean true = has answers, false = no answers.
-     */
-    public function has_answers()
-    {
-        return $this->count_related('Answer') > 0 ? true : false;
-    }
-
-
-    /**
-     * gets an array of EE_Question_Group which relate to this question
-     *
-     * @return EE_Question_Group[]
-     */
-    public function question_groups()
-    {
-        return $this->get_many_related('Question_Group');
-    }
-
-
-    /**
-     * Returns all the options for this question. By default, it returns only the not-yet-deleted ones.
-     *
-     * @param boolean      $notDeletedOptionsOnly            1
-     *                                                       whether to return ALL options, or only the ones which have
-     *                                                       not yet been deleleted
-     * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question,
-     *                                                       we want to usually only show non-deleted options AND the
-     *                                                       value that was selected for the answer, whether it was
-     *                                                       trashed or not.
-     * @return EE_Question_Option[]
-     */
-    public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
-    {
-        if (! $this->ID()) {
-            return array();
-        }
-        $query_params = array();
-        if ($selected_value_to_always_include) {
-            if (is_array($selected_value_to_always_include)) {
-                $query_params[0]['OR*options-query']['QSO_value'] = array('IN', $selected_value_to_always_include);
-            } else {
-                $query_params[0]['OR*options-query']['QSO_value'] = $selected_value_to_always_include;
-            }
-        }
-        if ($notDeletedOptionsOnly) {
-            $query_params[0]['OR*options-query']['QSO_deleted'] = false;
-        }
-        // order by QSO_order
-        $query_params['order_by'] = array('QSO_order' => 'ASC');
-        return $this->get_many_related('Question_Option', $query_params);
-    }
-
-
-    /**
-     * returns an array of EE_Question_Options which relate to this question
-     *
-     * @return \EE_Question_Option[]
-     */
-    public function temp_options()
-    {
-        return $this->_model_relations['Question_Option'];
-    }
-
-
-    /**
-     * Adds an option for this question. Note: if the option were previously associated with a different
-     * Question, that relationship will be overwritten.
-     *
-     * @param EE_Question_Option $option
-     * @return boolean success
-     */
-    public function add_option(EE_Question_Option $option)
-    {
-        return $this->_add_relation_to($option, 'Question_Option');
-    }
-
-
-    /**
-     * Adds an option directly to this question without saving to the db
-     *
-     * @param EE_Question_Option $option
-     * @return boolean success
-     */
-    public function add_temp_option(EE_Question_Option $option)
-    {
-        $this->_model_relations['Question_Option'][] = $option;
-        return true;
-    }
-
-
-    /**
-     * Marks the option as deleted.
-     *
-     * @param EE_Question_Option $option
-     * @return boolean success
-     */
-    public function remove_option(EE_Question_Option $option)
-    {
-        return $this->_remove_relation_to($option, 'Question_Option');
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function is_system_question()
-    {
-        $system_ID = $this->get('QST_system');
-        return ! empty($system_ID) ? true : false;
-    }
-
-
-    /**
-     * The purpose of this method is set the question order this question order to be the max out of all questions
-     *
-     * @access public
-     * @return void
-     */
-    public function set_order_to_latest()
-    {
-        $latest_order = $this->get_model()->get_latest_question_order();
-        $latest_order++;
-        $this->set('QST_order', $latest_order);
-    }
-
-
-    /**
-     * Retrieves the list of allowed question types from the model.
-     *
-     * @return string[]
-     */
-    private function _allowed_question_types()
-    {
-        $questionModel = $this->get_model();
-        /* @var $questionModel EEM_Question */
-        return $questionModel->allowed_question_types();
-    }
-
-    /**
-     * Duplicates this question and its question options
-     *
-     * @return \EE_Question
-     */
-    public function duplicate($options = array())
-    {
-        $new_question = clone $this;
-        $new_question->set('QST_ID', null);
-        $new_question->set_display_text(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->display_text()));
-        $new_question->set_admin_label(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->admin_label()));
-        $new_question->set_system_ID(null);
-        $new_question->set_wp_user(get_current_user_id());
-        // if we're duplicating a trashed question, assume we don't want the new one to be trashed
-        $new_question->set_deleted(false);
-        $success = $new_question->save();
-        if ($success) {
-            // we don't totally want to duplicate the question options, because we want them to be for the NEW question
-            foreach ($this->options() as $question_option) {
-                $question_option->duplicate(array('QST_ID' => $new_question->ID()));
-            }
-            return $new_question;
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Returns the question's maximum allowed response size
-     *
-     * @return int|float
-     */
-    public function max()
-    {
-        return $this->get('QST_max');
-    }
-
-    /**
-     * Sets the question's maximum allowed response size
-     *
-     * @param int|float $new_max
-     * @return void
-     */
-    public function set_max($new_max)
-    {
-        $this->set('QST_max', $new_max);
-    }
-
-
-    /**
-     * Creates a form input from this question which can be used in HTML forms
-     *
-     * @param EE_Registration $registration
-     * @param EE_Answer       $answer
-     * @param array           $input_constructor_args
-     * @return EE_Form_Input_Base
-     */
-    public function generate_form_input($registration = null, $answer = null, $input_constructor_args = array())
-    {
-        $identifier = $this->is_system_question() ? $this->system_ID() : $this->ID();
-
-        $input_constructor_args = array_merge(
-            array(
-                'required'                          => $this->required() ? true : false,
-                'html_label_text'                   => $this->display_text(),
-                'required_validation_error_message' => $this->required_text(),
-            ),
-            $input_constructor_args
-        );
-        if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
-            $answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID());
-        }
-        // has this question been answered ?
-        if ($answer instanceof EE_Answer
-            && $answer->value() !== ''
-        ) {
-            // answer gets htmlspecialchars called on it, undo that please
-            // because the form input's display strategy may call esc_attr too
-            // which also does html special characters
-            $values_with_html_special_chars = $answer->value();
-            if (is_array($values_with_html_special_chars)) {
-                $default_value = array_map('htmlspecialchars_decode', $values_with_html_special_chars);
-            } else {
-                $default_value = htmlspecialchars_decode($values_with_html_special_chars);
-            }
-            $input_constructor_args['default'] = $default_value;
-        }
-        $max_max_for_question = EEM_Question::instance()->absolute_max_for_system_question($this->system_ID());
-        if (in_array(
-            $this->type(),
-            EEM_Question::instance()->questionTypesWithMaxLength(),
-            true
-        )) {
-            $input_constructor_args['validation_strategies'][] = new EE_Max_Length_Validation_Strategy(
-                null,
-                min($max_max_for_question, $this->max())
-            );
-        }
-        $input_constructor_args = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__input_constructor_args',
-            $input_constructor_args,
-            $registration,
-            $this,
-            $answer
-        );
-
-        $result = null;
-        switch ($this->type()) {
-            // Text
-            case EEM_Question::QST_type_text:
-                $result = new EE_Text_Input($input_constructor_args);
-                break;
-            // Textarea
-            case EEM_Question::QST_type_textarea:
-                $result = new EE_Text_Area_Input($input_constructor_args);
-                break;
-            // Radio Buttons
-            case EEM_Question::QST_type_radio:
-                $result = new EE_Radio_Button_Input($this->options(), $input_constructor_args);
-                break;
-            // Dropdown
-            case EEM_Question::QST_type_dropdown:
-                $result = new EE_Select_Input($this->options(), $input_constructor_args);
-                break;
-            // State Dropdown
-            case EEM_Question::QST_type_state:
-                $state_options = apply_filters(
-                    'FHEE__EE_Question__generate_form_input__state_options',
-                    null,
-                    $this,
-                    $registration,
-                    $answer
-                );
-                $result = new EE_State_Select_Input($state_options, $input_constructor_args);
-                break;
-            // Country Dropdown
-            case EEM_Question::QST_type_country:
-                $country_options = apply_filters(
-                    'FHEE__EE_Question__generate_form_input__country_options',
-                    null,
-                    $this,
-                    $registration,
-                    $answer
-                );
-                $result = new EE_Country_Select_Input($country_options, $input_constructor_args);
-                break;
-            // Checkboxes
-            case EEM_Question::QST_type_checkbox:
-                $result = new EE_Checkbox_Multi_Input($this->options(), $input_constructor_args);
-                break;
-            // Date
-            case EEM_Question::QST_type_date:
-                $result = new EE_Datepicker_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_html_textarea:
-                $input_constructor_args['validation_strategies'][] = new EE_Simple_HTML_Validation_Strategy();
-                $result = new EE_Text_Area_Input($input_constructor_args);
-                $result->remove_validation_strategy('EE_Plaintext_Validation_Strategy');
-                break;
-            case EEM_Question::QST_type_email:
-                $result = new EE_Email_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_us_phone:
-                $result = new EE_Phone_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_int:
-                $result = new EE_Integer_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_decimal:
-                $result = new EE_Float_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_url:
-                $input_constructor_args['validation_strategies'][] = LoaderFactory::getLoader()->getNew('EE_URL_Validation_Strategy');
-                $result = new EE_Text_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_year:
-                $result = new EE_Year_Input(
-                    $input_constructor_args,
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__four_digit',
-                        true,
-                        $this
-                    ),
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__early_range',
-                        100,
-                        $this
-                    ),
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__end_range',
-                        100,
-                        $this
-                    )
-                );
-                break;
-            case EEM_Question::QST_type_multi_select:
-                $result = new EE_Select_Multiple_Input($this->options(), $input_constructor_args);
-                break;
-            // fallback
-            default:
-                $default_input = apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__default',
-                    null,
-                    $this->type(),
-                    $this,
-                    $input_constructor_args
-                );
-                if (! $default_input) {
-                    $default_input = new EE_Text_Input($input_constructor_args);
-                }
-                $result = $default_input;
-        }
-        return apply_filters('FHEE__EE_Question__generate_form_input__return', $result, $registration, $this, $answer);
-    }
-
-
-    /**
-     * Returns whether or not this question type should have question option entries
-     *
-     * @return bool
-     */
-    public function should_have_question_options()
-    {
-        return in_array(
-            $this->type(),
-            $this->_model->question_types_with_options(),
-            true
-        );
-    }
+	/**
+	 *
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Question
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Question
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set    Question display text
+	 *
+	 * @access        public
+	 * @param string $QST_display_text
+	 */
+	public function set_display_text($QST_display_text = '')
+	{
+		$this->set('QST_display_text', $QST_display_text);
+	}
+
+
+	/**
+	 *        Set    Question admin text
+	 *
+	 * @access        public
+	 * @param        string $QST_admin_label
+	 */
+	public function set_admin_label($QST_admin_label = '')
+	{
+		$this->set('QST_admin_label', $QST_admin_label);
+	}
+
+
+	/**
+	 *        Set    system name
+	 *
+	 * @access        public
+	 * @param        mixed $QST_system
+	 */
+	public function set_system_ID($QST_system = '')
+	{
+		$this->set('QST_system', $QST_system);
+	}
+
+
+	/**
+	 *        Set    question's type
+	 *
+	 * @access        public
+	 * @param        string $QST_type
+	 */
+	public function set_question_type($QST_type = '')
+	{
+		$this->set('QST_type', $QST_type);
+	}
+
+
+	/**
+	 *        Sets whether this question must be answered when presented in a form
+	 *
+	 * @access        public
+	 * @param        bool $QST_required
+	 */
+	public function set_required($QST_required = false)
+	{
+		$this->set('QST_required', $QST_required);
+	}
+
+
+	/**
+	 *        Set    Question display text
+	 *
+	 * @access        public
+	 * @param        string $QST_required_text
+	 */
+	public function set_required_text($QST_required_text = '')
+	{
+		$this->set('QST_required_text', $QST_required_text);
+	}
+
+
+	/**
+	 *        Sets the order of this question when placed in a sequence of questions
+	 *
+	 * @access        public
+	 * @param        int $QST_order
+	 */
+	public function set_order($QST_order = 0)
+	{
+		$this->set('QST_order', $QST_order);
+	}
+
+
+	/**
+	 *        Sets whether the question is admin-only
+	 *
+	 * @access        public
+	 * @param        bool $QST_admin_only
+	 */
+	public function set_admin_only($QST_admin_only = false)
+	{
+		$this->set('QST_admin_only', $QST_admin_only);
+	}
+
+
+	/**
+	 *        Sets the wordpress user ID on the question
+	 *
+	 * @access        public
+	 * @param        int $QST_wp_user
+	 */
+	public function set_wp_user($QST_wp_user = 1)
+	{
+		$this->set('QST_wp_user', $QST_wp_user);
+	}
+
+
+	/**
+	 *        Sets whether the question has been deleted
+	 *        (we use this boolean instead of actually
+	 *        deleting it because when users delete this question
+	 *        they really want to remove the question from future
+	 *        forms, BUT keep their old answers which depend
+	 *        on this record actually existing.
+	 *
+	 * @access        public
+	 * @param    bool $QST_deleted
+	 */
+	public function set_deleted($QST_deleted = false)
+	{
+		$this->set('QST_deleted', $QST_deleted);
+	}
+
+
+	/**
+	 * returns the text for displaying the question to users
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function display_text()
+	{
+		return $this->get('QST_display_text');
+	}
+
+
+	/**
+	 * returns the text for the administrative label
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function admin_label()
+	{
+		return $this->get('QST_admin_label');
+	}
+
+
+	/**
+	 * returns the attendee column name for this question
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function system_ID()
+	{
+		return $this->get('QST_system');
+	}
+
+
+	/**
+	 * returns either a string of 'text', 'textfield', etc.
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function required()
+	{
+		return $this->get('QST_required');
+	}
+
+
+	/**
+	 * returns the text which should be displayed when a user
+	 * doesn't answer this question in a form
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function required_text()
+	{
+		return $this->get('QST_required_text');
+	}
+
+
+	/**
+	 * returns the type of this question
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->get('QST_type');
+	}
+
+
+	/**
+	 * returns an integer showing where this question should
+	 * be placed in a sequence of questions
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->get('QST_order');
+	}
+
+
+	/**
+	 * returns whether this question should only appears to admins,
+	 * or to everyone
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function admin_only()
+	{
+		return $this->get('QST_admin_only');
+	}
+
+
+	/**
+	 * returns the id the wordpress user who created this question
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('QST_wp_user');
+	}
+
+
+	/**
+	 * returns whether this question has been marked as 'deleted'
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function deleted()
+	{
+		return $this->get('QST_deleted');
+	}
+
+
+	/**
+	 * Gets an array of related EE_Answer  to this EE_Question
+	 *
+	 * @return EE_Answer[]
+	 */
+	public function answers()
+	{
+		return $this->get_many_related('Answer');
+	}
+
+
+	/**
+	 * Boolean check for if there are answers on this question in th db
+	 *
+	 * @return boolean true = has answers, false = no answers.
+	 */
+	public function has_answers()
+	{
+		return $this->count_related('Answer') > 0 ? true : false;
+	}
+
+
+	/**
+	 * gets an array of EE_Question_Group which relate to this question
+	 *
+	 * @return EE_Question_Group[]
+	 */
+	public function question_groups()
+	{
+		return $this->get_many_related('Question_Group');
+	}
+
+
+	/**
+	 * Returns all the options for this question. By default, it returns only the not-yet-deleted ones.
+	 *
+	 * @param boolean      $notDeletedOptionsOnly            1
+	 *                                                       whether to return ALL options, or only the ones which have
+	 *                                                       not yet been deleleted
+	 * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question,
+	 *                                                       we want to usually only show non-deleted options AND the
+	 *                                                       value that was selected for the answer, whether it was
+	 *                                                       trashed or not.
+	 * @return EE_Question_Option[]
+	 */
+	public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
+	{
+		if (! $this->ID()) {
+			return array();
+		}
+		$query_params = array();
+		if ($selected_value_to_always_include) {
+			if (is_array($selected_value_to_always_include)) {
+				$query_params[0]['OR*options-query']['QSO_value'] = array('IN', $selected_value_to_always_include);
+			} else {
+				$query_params[0]['OR*options-query']['QSO_value'] = $selected_value_to_always_include;
+			}
+		}
+		if ($notDeletedOptionsOnly) {
+			$query_params[0]['OR*options-query']['QSO_deleted'] = false;
+		}
+		// order by QSO_order
+		$query_params['order_by'] = array('QSO_order' => 'ASC');
+		return $this->get_many_related('Question_Option', $query_params);
+	}
+
+
+	/**
+	 * returns an array of EE_Question_Options which relate to this question
+	 *
+	 * @return \EE_Question_Option[]
+	 */
+	public function temp_options()
+	{
+		return $this->_model_relations['Question_Option'];
+	}
+
+
+	/**
+	 * Adds an option for this question. Note: if the option were previously associated with a different
+	 * Question, that relationship will be overwritten.
+	 *
+	 * @param EE_Question_Option $option
+	 * @return boolean success
+	 */
+	public function add_option(EE_Question_Option $option)
+	{
+		return $this->_add_relation_to($option, 'Question_Option');
+	}
+
+
+	/**
+	 * Adds an option directly to this question without saving to the db
+	 *
+	 * @param EE_Question_Option $option
+	 * @return boolean success
+	 */
+	public function add_temp_option(EE_Question_Option $option)
+	{
+		$this->_model_relations['Question_Option'][] = $option;
+		return true;
+	}
+
+
+	/**
+	 * Marks the option as deleted.
+	 *
+	 * @param EE_Question_Option $option
+	 * @return boolean success
+	 */
+	public function remove_option(EE_Question_Option $option)
+	{
+		return $this->_remove_relation_to($option, 'Question_Option');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function is_system_question()
+	{
+		$system_ID = $this->get('QST_system');
+		return ! empty($system_ID) ? true : false;
+	}
+
+
+	/**
+	 * The purpose of this method is set the question order this question order to be the max out of all questions
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_order_to_latest()
+	{
+		$latest_order = $this->get_model()->get_latest_question_order();
+		$latest_order++;
+		$this->set('QST_order', $latest_order);
+	}
+
+
+	/**
+	 * Retrieves the list of allowed question types from the model.
+	 *
+	 * @return string[]
+	 */
+	private function _allowed_question_types()
+	{
+		$questionModel = $this->get_model();
+		/* @var $questionModel EEM_Question */
+		return $questionModel->allowed_question_types();
+	}
+
+	/**
+	 * Duplicates this question and its question options
+	 *
+	 * @return \EE_Question
+	 */
+	public function duplicate($options = array())
+	{
+		$new_question = clone $this;
+		$new_question->set('QST_ID', null);
+		$new_question->set_display_text(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->display_text()));
+		$new_question->set_admin_label(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->admin_label()));
+		$new_question->set_system_ID(null);
+		$new_question->set_wp_user(get_current_user_id());
+		// if we're duplicating a trashed question, assume we don't want the new one to be trashed
+		$new_question->set_deleted(false);
+		$success = $new_question->save();
+		if ($success) {
+			// we don't totally want to duplicate the question options, because we want them to be for the NEW question
+			foreach ($this->options() as $question_option) {
+				$question_option->duplicate(array('QST_ID' => $new_question->ID()));
+			}
+			return $new_question;
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * Returns the question's maximum allowed response size
+	 *
+	 * @return int|float
+	 */
+	public function max()
+	{
+		return $this->get('QST_max');
+	}
+
+	/**
+	 * Sets the question's maximum allowed response size
+	 *
+	 * @param int|float $new_max
+	 * @return void
+	 */
+	public function set_max($new_max)
+	{
+		$this->set('QST_max', $new_max);
+	}
+
+
+	/**
+	 * Creates a form input from this question which can be used in HTML forms
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Answer       $answer
+	 * @param array           $input_constructor_args
+	 * @return EE_Form_Input_Base
+	 */
+	public function generate_form_input($registration = null, $answer = null, $input_constructor_args = array())
+	{
+		$identifier = $this->is_system_question() ? $this->system_ID() : $this->ID();
+
+		$input_constructor_args = array_merge(
+			array(
+				'required'                          => $this->required() ? true : false,
+				'html_label_text'                   => $this->display_text(),
+				'required_validation_error_message' => $this->required_text(),
+			),
+			$input_constructor_args
+		);
+		if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
+			$answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID());
+		}
+		// has this question been answered ?
+		if ($answer instanceof EE_Answer
+			&& $answer->value() !== ''
+		) {
+			// answer gets htmlspecialchars called on it, undo that please
+			// because the form input's display strategy may call esc_attr too
+			// which also does html special characters
+			$values_with_html_special_chars = $answer->value();
+			if (is_array($values_with_html_special_chars)) {
+				$default_value = array_map('htmlspecialchars_decode', $values_with_html_special_chars);
+			} else {
+				$default_value = htmlspecialchars_decode($values_with_html_special_chars);
+			}
+			$input_constructor_args['default'] = $default_value;
+		}
+		$max_max_for_question = EEM_Question::instance()->absolute_max_for_system_question($this->system_ID());
+		if (in_array(
+			$this->type(),
+			EEM_Question::instance()->questionTypesWithMaxLength(),
+			true
+		)) {
+			$input_constructor_args['validation_strategies'][] = new EE_Max_Length_Validation_Strategy(
+				null,
+				min($max_max_for_question, $this->max())
+			);
+		}
+		$input_constructor_args = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__input_constructor_args',
+			$input_constructor_args,
+			$registration,
+			$this,
+			$answer
+		);
+
+		$result = null;
+		switch ($this->type()) {
+			// Text
+			case EEM_Question::QST_type_text:
+				$result = new EE_Text_Input($input_constructor_args);
+				break;
+			// Textarea
+			case EEM_Question::QST_type_textarea:
+				$result = new EE_Text_Area_Input($input_constructor_args);
+				break;
+			// Radio Buttons
+			case EEM_Question::QST_type_radio:
+				$result = new EE_Radio_Button_Input($this->options(), $input_constructor_args);
+				break;
+			// Dropdown
+			case EEM_Question::QST_type_dropdown:
+				$result = new EE_Select_Input($this->options(), $input_constructor_args);
+				break;
+			// State Dropdown
+			case EEM_Question::QST_type_state:
+				$state_options = apply_filters(
+					'FHEE__EE_Question__generate_form_input__state_options',
+					null,
+					$this,
+					$registration,
+					$answer
+				);
+				$result = new EE_State_Select_Input($state_options, $input_constructor_args);
+				break;
+			// Country Dropdown
+			case EEM_Question::QST_type_country:
+				$country_options = apply_filters(
+					'FHEE__EE_Question__generate_form_input__country_options',
+					null,
+					$this,
+					$registration,
+					$answer
+				);
+				$result = new EE_Country_Select_Input($country_options, $input_constructor_args);
+				break;
+			// Checkboxes
+			case EEM_Question::QST_type_checkbox:
+				$result = new EE_Checkbox_Multi_Input($this->options(), $input_constructor_args);
+				break;
+			// Date
+			case EEM_Question::QST_type_date:
+				$result = new EE_Datepicker_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_html_textarea:
+				$input_constructor_args['validation_strategies'][] = new EE_Simple_HTML_Validation_Strategy();
+				$result = new EE_Text_Area_Input($input_constructor_args);
+				$result->remove_validation_strategy('EE_Plaintext_Validation_Strategy');
+				break;
+			case EEM_Question::QST_type_email:
+				$result = new EE_Email_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_us_phone:
+				$result = new EE_Phone_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_int:
+				$result = new EE_Integer_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_decimal:
+				$result = new EE_Float_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_url:
+				$input_constructor_args['validation_strategies'][] = LoaderFactory::getLoader()->getNew('EE_URL_Validation_Strategy');
+				$result = new EE_Text_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_year:
+				$result = new EE_Year_Input(
+					$input_constructor_args,
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__four_digit',
+						true,
+						$this
+					),
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__early_range',
+						100,
+						$this
+					),
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__end_range',
+						100,
+						$this
+					)
+				);
+				break;
+			case EEM_Question::QST_type_multi_select:
+				$result = new EE_Select_Multiple_Input($this->options(), $input_constructor_args);
+				break;
+			// fallback
+			default:
+				$default_input = apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__default',
+					null,
+					$this->type(),
+					$this,
+					$input_constructor_args
+				);
+				if (! $default_input) {
+					$default_input = new EE_Text_Input($input_constructor_args);
+				}
+				$result = $default_input;
+		}
+		return apply_filters('FHEE__EE_Question__generate_form_input__return', $result, $registration, $this, $answer);
+	}
+
+
+	/**
+	 * Returns whether or not this question type should have question option entries
+	 *
+	 * @return bool
+	 */
+	public function should_have_question_options()
+	{
+		return in_array(
+			$this->type(),
+			$this->_model->question_types_with_options(),
+			true
+		);
+	}
 }