eventespresso / event-espresso-core

core/db_classes/EE_Taxes.class.php

Spacing +3 added lines, -3 removed lines

@@ -39,7 +39,7 @@ 
         $tax = 0;
         $total_tax = 0;
         // This first checks to see if the given ticket is taxable.
-        if (! $ticket->get('TKT_taxable')) {
+        if ( ! $ticket->get('TKT_taxable')) {
             return $tax;
         }
         // get subtotal (notice we're only retrieving a subtotal if there isn't one given)
@@ -80,8 +80,8 @@ 
     public static function get_subtotal_for_admin(EE_Ticket $ticket)
     {
         $TKT_ID = $ticket->ID();
-        return isset(self::$_subtotal[ $TKT_ID ])
-            ? self::$_subtotal[ $TKT_ID ]
+        return isset(self::$_subtotal[$TKT_ID])
+            ? self::$_subtotal[$TKT_ID]
             : self::_get_subtotal_for_admin($ticket);
     }
 

Indentation +123 added lines, -123 removed lines

@@ -9,138 +9,138 @@
  */
 class EE_Taxes extends EE_Base
 {
-    /**
-     * This is used for when EE_Taxes is used statically by the admin
-     *
-     * @var array
-     */
-    private static $_subtotal = array();
+	/**
+	 * This is used for when EE_Taxes is used statically by the admin
+	 *
+	 * @var array
+	 */
+	private static $_subtotal = array();
 
-    /**
-     * This holds an array of EE_Price objects that are of PRT_ID == 4 (tax price types)
-     *
-     * @var EE_Price[]
-     */
-    private static $_default_taxes = array();
+	/**
+	 * This holds an array of EE_Price objects that are of PRT_ID == 4 (tax price types)
+	 *
+	 * @var EE_Price[]
+	 */
+	private static $_default_taxes = array();
 
 
-    /**
-     * This method simply calculates the total taxes for a given ticket (by pulling the prices attached to the ticket
-     * and applying default taxes to it). Note: this is just an intermediary helper method added to facilitate quick
-     * calc of taxes for tickets listed in the event editor.
-     *
-     * @param  EE_Ticket $ticket incoming EE_Ticket
-     * @return float             total taxes to apply to ticket.
-     * @throws \EE_Error
-     */
-    public static function get_total_taxes_for_admin(EE_Ticket $ticket)
-    {
-        $tax = 0;
-        $total_tax = 0;
-        // This first checks to see if the given ticket is taxable.
-        if (! $ticket->get('TKT_taxable')) {
-            return $tax;
-        }
-        // get subtotal (notice we're only retrieving a subtotal if there isn't one given)
-        $subtotal = self::get_subtotal_for_admin($ticket);
-        // get taxes
-        $taxes = self::get_taxes_for_admin();
-        // apply taxes to subtotal
-        foreach ($taxes as $tax) {
-            // assuming taxes are not cumulative
-            $total_tax += $subtotal * $tax->get('PRC_amount') / 100;
-        }
-        return $total_tax;
-    }
+	/**
+	 * This method simply calculates the total taxes for a given ticket (by pulling the prices attached to the ticket
+	 * and applying default taxes to it). Note: this is just an intermediary helper method added to facilitate quick
+	 * calc of taxes for tickets listed in the event editor.
+	 *
+	 * @param  EE_Ticket $ticket incoming EE_Ticket
+	 * @return float             total taxes to apply to ticket.
+	 * @throws \EE_Error
+	 */
+	public static function get_total_taxes_for_admin(EE_Ticket $ticket)
+	{
+		$tax = 0;
+		$total_tax = 0;
+		// This first checks to see if the given ticket is taxable.
+		if (! $ticket->get('TKT_taxable')) {
+			return $tax;
+		}
+		// get subtotal (notice we're only retrieving a subtotal if there isn't one given)
+		$subtotal = self::get_subtotal_for_admin($ticket);
+		// get taxes
+		$taxes = self::get_taxes_for_admin();
+		// apply taxes to subtotal
+		foreach ($taxes as $tax) {
+			// assuming taxes are not cumulative
+			$total_tax += $subtotal * $tax->get('PRC_amount') / 100;
+		}
+		return $total_tax;
+	}
 
 
-    /**
-     * Gets the total percentage of tax that should be applied to taxable line items
-     *
-     * @return float the percentage of tax that should be added to taxable items
-     * @throws \EE_Error
-     * eg 20 for %20 tax (NOT 0.20, which
-     */
-    public static function get_total_taxes_percentage()
-    {
-        $total_tax_percent = 0;
-        foreach (self::get_taxes_for_admin() as $tax_price) {
-            $total_tax_percent += $tax_price->get('PRC_amount');
-        }
-        return $total_tax_percent;
-    }
+	/**
+	 * Gets the total percentage of tax that should be applied to taxable line items
+	 *
+	 * @return float the percentage of tax that should be added to taxable items
+	 * @throws \EE_Error
+	 * eg 20 for %20 tax (NOT 0.20, which
+	 */
+	public static function get_total_taxes_percentage()
+	{
+		$total_tax_percent = 0;
+		foreach (self::get_taxes_for_admin() as $tax_price) {
+			$total_tax_percent += $tax_price->get('PRC_amount');
+		}
+		return $total_tax_percent;
+	}
 
 
-    /**
-     * @param EE_Ticket $ticket
-     * @return float
-     * @throws \EE_Error
-     */
-    public static function get_subtotal_for_admin(EE_Ticket $ticket)
-    {
-        $TKT_ID = $ticket->ID();
-        return isset(self::$_subtotal[ $TKT_ID ])
-            ? self::$_subtotal[ $TKT_ID ]
-            : self::_get_subtotal_for_admin($ticket);
-    }
+	/**
+	 * @param EE_Ticket $ticket
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public static function get_subtotal_for_admin(EE_Ticket $ticket)
+	{
+		$TKT_ID = $ticket->ID();
+		return isset(self::$_subtotal[ $TKT_ID ])
+			? self::$_subtotal[ $TKT_ID ]
+			: self::_get_subtotal_for_admin($ticket);
+	}
 
 
-    /**
-     * simply take an incoming ticket and calculate the subtotal for the ticket
-     *
-     * @param  EE_Ticket $ticket
-     * @return float     subtotal calculated from all EE_Price[] on Ticket.
-     * @throws \EE_Error
-     */
-    private static function _get_subtotal_for_admin(EE_Ticket $ticket)
-    {
-        $subtotal = 0;
-        // get all prices
-        $prices = $ticket->get_many_related(
-            'Price',
-            array(
-                'default_where_conditions' => 'none',
-                'order_by'                 => array('PRC_order' => 'ASC'),
-            )
-        );
-        // let's loop through them (base price is always the first item)
-        foreach ($prices as $price) {
-            if ($price instanceof EE_Price) {
-                $price_type = $price->type_obj();
-                if ($price_type instanceof EE_Price_Type) {
-                    switch ($price->type_obj()->base_type()) {
-                        case 1: // base price
-                        case 3: // surcharges
-                            $subtotal += $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
-                                : $price->get('PRC_amount');
-                            break;
-                        case 2: // discounts
-                            $subtotal -= $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
-                                : $price->get('PRC_amount');
-                            break;
-                    }
-                }
-            }
-        }
-        $TKT_ID = $ticket->ID();
-        self::$_subtotal = array($TKT_ID => $subtotal);
-        return $subtotal;
-    }
+	/**
+	 * simply take an incoming ticket and calculate the subtotal for the ticket
+	 *
+	 * @param  EE_Ticket $ticket
+	 * @return float     subtotal calculated from all EE_Price[] on Ticket.
+	 * @throws \EE_Error
+	 */
+	private static function _get_subtotal_for_admin(EE_Ticket $ticket)
+	{
+		$subtotal = 0;
+		// get all prices
+		$prices = $ticket->get_many_related(
+			'Price',
+			array(
+				'default_where_conditions' => 'none',
+				'order_by'                 => array('PRC_order' => 'ASC'),
+			)
+		);
+		// let's loop through them (base price is always the first item)
+		foreach ($prices as $price) {
+			if ($price instanceof EE_Price) {
+				$price_type = $price->type_obj();
+				if ($price_type instanceof EE_Price_Type) {
+					switch ($price->type_obj()->base_type()) {
+						case 1: // base price
+						case 3: // surcharges
+							$subtotal += $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
+								: $price->get('PRC_amount');
+							break;
+						case 2: // discounts
+							$subtotal -= $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
+								: $price->get('PRC_amount');
+							break;
+					}
+				}
+			}
+		}
+		$TKT_ID = $ticket->ID();
+		self::$_subtotal = array($TKT_ID => $subtotal);
+		return $subtotal;
+	}
 
 
-    /**
-     * get all default prices that are a Tax price type (PRT_ID = 4) and return
-     *
-     * @return EE_Price[] EE_Price objects that have PRT_ID == 4
-     * @throws \EE_Error
-     */
-    public static function get_taxes_for_admin()
-    {
-        if (empty(self::$_default_taxes)) {
-            self::$_default_taxes = EE_Registry::instance()->load_model('Price')->get_all(
-                array(array('Price_Type.PBT_ID' => 4))
-            );
-        }
-        return self::$_default_taxes;
-    }
+	/**
+	 * get all default prices that are a Tax price type (PRT_ID = 4) and return
+	 *
+	 * @return EE_Price[] EE_Price objects that have PRT_ID == 4
+	 * @throws \EE_Error
+	 */
+	public static function get_taxes_for_admin()
+	{
+		if (empty(self::$_default_taxes)) {
+			self::$_default_taxes = EE_Registry::instance()->load_model('Price')->get_all(
+				array(array('Price_Type.PBT_ID' => 4))
+			);
+		}
+		return self::$_default_taxes;
+	}
 }

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

@@ -12,487 +12,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_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 +664 added lines, -664 removed lines

@@ -13,668 +13,668 @@
  */
 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(esc_html__('%s **Duplicate**', 'event_espresso'), $this->display_text()));
-        $new_question->set_admin_label(sprintf(esc_html__('%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;
-            // Email confirm
-            case EEM_Question::QST_type_email_confirm:
-                $result = new EE_Email_Confirm_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(esc_html__('%s **Duplicate**', 'event_espresso'), $this->display_text()));
+		$new_question->set_admin_label(sprintf(esc_html__('%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;
+			// Email confirm
+			case EEM_Question::QST_type_email_confirm:
+				$result = new EE_Email_Confirm_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
+		);
+	}
 }

core/db_classes/EE_Price.class.php

Spacing +1 added lines, -1 removed lines

@@ -285,7 +285,7 @@
      */
     public function pretty_price()
     {
-        return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount') . '%';
+        return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount').'%';
     }
 
 

Indentation +285 added lines, -285 removed lines

@@ -9,289 +9,289 @@
  */
 class EE_Price extends EE_Soft_Delete_Base_Class
 {
-    /**
-     * @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_Price
-     */
-    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_Price
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Price type ID
-     *
-     * @access        public
-     * @param        int $PRT_ID
-     */
-    public function set_type($PRT_ID = 0)
-    {
-        $this->set('PRT_ID', $PRT_ID);
-    }
-
-
-    /**
-     *        Set Price Amount
-     *
-     * @access        public
-     * @param        float $PRC_amount
-     */
-    public function set_amount($PRC_amount = 0.00)
-    {
-        $this->set('PRC_amount', $PRC_amount);
-    }
-
-
-    /**
-     *        Set Price Name
-     *
-     * @access        public
-     * @param        string $PRC_name
-     */
-    public function set_name($PRC_name = '')
-    {
-        $this->set('PRC_name', $PRC_name);
-    }
-
-
-    /**
-     *        Set Price Description
-     *
-     * @access        public
-     * @param        string $PRC_desc
-     */
-    public function set_description($PRC_desc = '')
-    {
-        $this->Set('PRC_desc', $PRC_desc);
-    }
-
-
-    /**
-     *        set is_default
-     *
-     * @access        public
-     * @param        bool $PRC_is_default
-     */
-    public function set_is_default($PRC_is_default = false)
-    {
-        $this->set('PRC_is_default', $PRC_is_default);
-    }
-
-
-    /**
-     *        set deleted
-     *
-     * @access        public
-     * @param        bool $PRC_deleted
-     */
-    public function set_deleted($PRC_deleted = null)
-    {
-        $this->set('PRC_deleted', $PRC_deleted);
-    }
-
-
-    /**
-     *    get Price type
-     *
-     * @access        public
-     * @return        int
-     */
-    public function type()
-    {
-        return $this->get('PRT_ID');
-    }
-
-
-    /**
-     *    get Price Amount
-     *
-     * @access        public
-     * @return        float
-     */
-    public function amount()
-    {
-        return $this->get('PRC_amount');
-    }
-
-
-    /**
-     *    get Price Name
-     *
-     * @access        public
-     * @return        string
-     */
-    public function name()
-    {
-        return $this->get('PRC_name');
-    }
-
-
-    /**
-     *    get Price description
-     *
-     * @access        public
-     * @return        string
-     */
-    public function desc()
-    {
-        return $this->get('PRC_desc');
-    }
-
-
-    /**
-     *    get overrides
-     *
-     * @access        public
-     * @return        int
-     */
-    public function overrides()
-    {
-        return $this->get('PRC_overrides');
-    }
-
-
-    /**
-     *    get order
-     *
-     * @access        public
-     * @return        int
-     */
-    public function order()
-    {
-        return $this->get('PRC_order');
-    }
-
-
-    /**
-     * get the author of the price
-     *
-     * @since 4.5.0
-     *
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('PRC_wp_user');
-    }
-
-
-    /**
-     *    get is_default
-     *
-     * @access        public
-     * @return        bool
-     */
-    public function is_default()
-    {
-        return $this->get('PRC_is_default');
-    }
-
-
-    /**
-     *    get deleted
-     *
-     * @access        public
-     * @return        bool
-     */
-    public function deleted()
-    {
-        return $this->get('PRC_deleted');
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function parent()
-    {
-        return $this->get('PRC_parent');
-    }
-
-
-    // some helper methods for getting info on the price_type for this price
-
-    /**
-     * return whether the price is a base price or not
-     *
-     * @return boolean
-     */
-    public function is_base_price()
-    {
-        $price_type = $this->type_obj();
-        return $price_type->base_type() === 1;
-    }
-
-
-    /**
-     *
-     * @return EE_Price_Type
-     */
-    public function type_obj()
-    {
-        return $this->get_first_related('Price_Type');
-    }
-
-
-    /**
-     * Simply indicates whether this price increases or decreases the total
-     *
-     * @return boolean true = discount, otherwise adds to the total
-     */
-    public function is_discount()
-    {
-        $price_type = $this->type_obj();
-        return $price_type->is_discount();
-    }
-
-
-    /**
-     * whether the price is a percentage or not
-     *
-     * @return boolean
-     */
-    public function is_percent()
-    {
-        $price_type = $this->type_obj();
-        return $price_type->get('PRT_is_percent');
-    }
-
-
-    /**
-     * return pretty price dependant on whether its a dollar or percent.
-     *
-     * @since 4.4.0
-     *
-     * @return string
-     */
-    public function pretty_price()
-    {
-        return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount') . '%';
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function get_price_without_currency_symbol()
-    {
-        return str_replace(EE_Registry::instance()->CFG->currency->sign, '', $this->get_pretty('PRC_amount'));
-    }
+	/**
+	 * @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_Price
+	 */
+	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_Price
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Price type ID
+	 *
+	 * @access        public
+	 * @param        int $PRT_ID
+	 */
+	public function set_type($PRT_ID = 0)
+	{
+		$this->set('PRT_ID', $PRT_ID);
+	}
+
+
+	/**
+	 *        Set Price Amount
+	 *
+	 * @access        public
+	 * @param        float $PRC_amount
+	 */
+	public function set_amount($PRC_amount = 0.00)
+	{
+		$this->set('PRC_amount', $PRC_amount);
+	}
+
+
+	/**
+	 *        Set Price Name
+	 *
+	 * @access        public
+	 * @param        string $PRC_name
+	 */
+	public function set_name($PRC_name = '')
+	{
+		$this->set('PRC_name', $PRC_name);
+	}
+
+
+	/**
+	 *        Set Price Description
+	 *
+	 * @access        public
+	 * @param        string $PRC_desc
+	 */
+	public function set_description($PRC_desc = '')
+	{
+		$this->Set('PRC_desc', $PRC_desc);
+	}
+
+
+	/**
+	 *        set is_default
+	 *
+	 * @access        public
+	 * @param        bool $PRC_is_default
+	 */
+	public function set_is_default($PRC_is_default = false)
+	{
+		$this->set('PRC_is_default', $PRC_is_default);
+	}
+
+
+	/**
+	 *        set deleted
+	 *
+	 * @access        public
+	 * @param        bool $PRC_deleted
+	 */
+	public function set_deleted($PRC_deleted = null)
+	{
+		$this->set('PRC_deleted', $PRC_deleted);
+	}
+
+
+	/**
+	 *    get Price type
+	 *
+	 * @access        public
+	 * @return        int
+	 */
+	public function type()
+	{
+		return $this->get('PRT_ID');
+	}
+
+
+	/**
+	 *    get Price Amount
+	 *
+	 * @access        public
+	 * @return        float
+	 */
+	public function amount()
+	{
+		return $this->get('PRC_amount');
+	}
+
+
+	/**
+	 *    get Price Name
+	 *
+	 * @access        public
+	 * @return        string
+	 */
+	public function name()
+	{
+		return $this->get('PRC_name');
+	}
+
+
+	/**
+	 *    get Price description
+	 *
+	 * @access        public
+	 * @return        string
+	 */
+	public function desc()
+	{
+		return $this->get('PRC_desc');
+	}
+
+
+	/**
+	 *    get overrides
+	 *
+	 * @access        public
+	 * @return        int
+	 */
+	public function overrides()
+	{
+		return $this->get('PRC_overrides');
+	}
+
+
+	/**
+	 *    get order
+	 *
+	 * @access        public
+	 * @return        int
+	 */
+	public function order()
+	{
+		return $this->get('PRC_order');
+	}
+
+
+	/**
+	 * get the author of the price
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('PRC_wp_user');
+	}
+
+
+	/**
+	 *    get is_default
+	 *
+	 * @access        public
+	 * @return        bool
+	 */
+	public function is_default()
+	{
+		return $this->get('PRC_is_default');
+	}
+
+
+	/**
+	 *    get deleted
+	 *
+	 * @access        public
+	 * @return        bool
+	 */
+	public function deleted()
+	{
+		return $this->get('PRC_deleted');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function parent()
+	{
+		return $this->get('PRC_parent');
+	}
+
+
+	// some helper methods for getting info on the price_type for this price
+
+	/**
+	 * return whether the price is a base price or not
+	 *
+	 * @return boolean
+	 */
+	public function is_base_price()
+	{
+		$price_type = $this->type_obj();
+		return $price_type->base_type() === 1;
+	}
+
+
+	/**
+	 *
+	 * @return EE_Price_Type
+	 */
+	public function type_obj()
+	{
+		return $this->get_first_related('Price_Type');
+	}
+
+
+	/**
+	 * Simply indicates whether this price increases or decreases the total
+	 *
+	 * @return boolean true = discount, otherwise adds to the total
+	 */
+	public function is_discount()
+	{
+		$price_type = $this->type_obj();
+		return $price_type->is_discount();
+	}
+
+
+	/**
+	 * whether the price is a percentage or not
+	 *
+	 * @return boolean
+	 */
+	public function is_percent()
+	{
+		$price_type = $this->type_obj();
+		return $price_type->get('PRT_is_percent');
+	}
+
+
+	/**
+	 * return pretty price dependant on whether its a dollar or percent.
+	 *
+	 * @since 4.4.0
+	 *
+	 * @return string
+	 */
+	public function pretty_price()
+	{
+		return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount') . '%';
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function get_price_without_currency_symbol()
+	{
+		return str_replace(EE_Registry::instance()->CFG->currency->sign, '', $this->get_pretty('PRC_amount'));
+	}
 }

core/db_classes/EE_Status.class.php

Spacing +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
     {
         $id = $this->get('STS_ID');
         $code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema);
-        return $code[ $id ];
+        return $code[$id];
     }
 
 

Indentation +138 added lines, -138 removed lines

@@ -11,142 +11,142 @@
  */
 class EE_Status extends EE_Base_Class
 {
-    /**
-     * @param array $props_n_values
-     * @return EE_Status
-     */
-    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_Status
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Gets code
-     *
-     * @param bool   $plural
-     * @param string $schema
-     * @return string
-     */
-    public function code($plural = false, $schema = 'upper')
-    {
-        $id = $this->get('STS_ID');
-        $code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema);
-        return $code[ $id ];
-    }
-
-
-    /**
-     * Sets code
-     *
-     * @param string $code
-     * @return boolean
-     */
-    public function set_code($code)
-    {
-        $this->set('STS_code', $code);
-    }
-
-
-    /**
-     * Gets desc
-     *
-     * @return string
-     */
-    public function desc()
-    {
-        return $this->get('STS_desc');
-    }
-
-
-    /**
-     * Sets desc
-     *
-     * @param string $desc
-     * @return boolean
-     */
-    public function set_desc($desc)
-    {
-        $this->set('STS_desc', $desc);
-    }
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     */
-    public function type()
-    {
-        return $this->get('STS_type');
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     * @return boolean
-     */
-    public function set_type($type)
-    {
-        $this->set('STS_type', $type);
-    }
-
-
-    /**
-     * Gets can_edit
-     *
-     * @return boolean
-     */
-    public function can_edit()
-    {
-        return $this->get('STS_can_edit');
-    }
-
-
-    /**
-     * Sets can_edit
-     *
-     * @param boolean $can_edit
-     * @return boolean
-     */
-    public function set_can_edit($can_edit)
-    {
-        $this->set('STS_can_edit', $can_edit);
-    }
-
-
-    /**
-     * Gets open
-     *
-     * @return boolean
-     */
-    public function open()
-    {
-        return $this->get('STS_open');
-    }
-
-
-    /**
-     * Sets open
-     *
-     * @param boolean $open
-     * @return boolean
-     */
-    public function set_open($open)
-    {
-        $this->set('STS_open', $open);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Status
+	 */
+	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_Status
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Gets code
+	 *
+	 * @param bool   $plural
+	 * @param string $schema
+	 * @return string
+	 */
+	public function code($plural = false, $schema = 'upper')
+	{
+		$id = $this->get('STS_ID');
+		$code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema);
+		return $code[ $id ];
+	}
+
+
+	/**
+	 * Sets code
+	 *
+	 * @param string $code
+	 * @return boolean
+	 */
+	public function set_code($code)
+	{
+		$this->set('STS_code', $code);
+	}
+
+
+	/**
+	 * Gets desc
+	 *
+	 * @return string
+	 */
+	public function desc()
+	{
+		return $this->get('STS_desc');
+	}
+
+
+	/**
+	 * Sets desc
+	 *
+	 * @param string $desc
+	 * @return boolean
+	 */
+	public function set_desc($desc)
+	{
+		$this->set('STS_desc', $desc);
+	}
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->get('STS_type');
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 * @return boolean
+	 */
+	public function set_type($type)
+	{
+		$this->set('STS_type', $type);
+	}
+
+
+	/**
+	 * Gets can_edit
+	 *
+	 * @return boolean
+	 */
+	public function can_edit()
+	{
+		return $this->get('STS_can_edit');
+	}
+
+
+	/**
+	 * Sets can_edit
+	 *
+	 * @param boolean $can_edit
+	 * @return boolean
+	 */
+	public function set_can_edit($can_edit)
+	{
+		$this->set('STS_can_edit', $can_edit);
+	}
+
+
+	/**
+	 * Gets open
+	 *
+	 * @return boolean
+	 */
+	public function open()
+	{
+		return $this->get('STS_open');
+	}
+
+
+	/**
+	 * Sets open
+	 *
+	 * @param boolean $open
+	 * @return boolean
+	 */
+	public function set_open($open)
+	{
+		$this->set('STS_open', $open);
+	}
 }

core/db_classes/EE_Term.class.php

Spacing +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
      */
     protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
     {
-        if (! isset($fieldValues['slug'])) {
+        if ( ! isset($fieldValues['slug'])) {
             $fieldValues['slug'] = $fieldValues['name'];
         }
         parent::__construct($fieldValues, $bydb, $timezone);

Indentation +70 added lines, -70 removed lines

@@ -11,87 +11,87 @@
  */
 class EE_Term extends EE_Base_Class
 {
-    public $post_type;
+	public $post_type;
 
-    /**
-     * Sets some dynamic defaults
-     *
-     * @param array  $fieldValues
-     * @param bool   $bydb
-     * @param string $timezone
-     */
-    protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
-    {
-        if (! isset($fieldValues['slug'])) {
-            $fieldValues['slug'] = $fieldValues['name'];
-        }
-        parent::__construct($fieldValues, $bydb, $timezone);
-    }
+	/**
+	 * Sets some dynamic defaults
+	 *
+	 * @param array  $fieldValues
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 */
+	protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
+	{
+		if (! isset($fieldValues['slug'])) {
+			$fieldValues['slug'] = $fieldValues['name'];
+		}
+		parent::__construct($fieldValues, $bydb, $timezone);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Term|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_Term|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_Term
-     */
-    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
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
 
 
-    /**
-     * Gets name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->get('name');
-    }
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->get('name');
+	}
 
 
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @return boolean
-     */
-    public function set_name($name)
-    {
-        $this->set('name', $name);
-    }
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @return boolean
+	 */
+	public function set_name($name)
+	{
+		$this->set('name', $name);
+	}
 
 
-    /**
-     * Gets slug
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->get('slug');
-    }
+	/**
+	 * Gets slug
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->get('slug');
+	}
 
 
-    /**
-     * Sets slug
-     *
-     * @param string $slug
-     * @return boolean
-     */
-    public function set_slug($slug)
-    {
-        $this->set('slug', $slug);
-    }
+	/**
+	 * Sets slug
+	 *
+	 * @param string $slug
+	 * @return boolean
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('slug', $slug);
+	}
 }

core/db_classes/EE_Change_Log.class.php

Spacing +1 added lines, -1 removed lines

@@ -192,7 +192,7 @@
     {
         $model_name_of_related_obj = $this->OBJ_type();
         $is_model_name = EE_Registry::instance()->is_model_name($model_name_of_related_obj);
-        if (! $is_model_name) {
+        if ( ! $is_model_name) {
             return null;
         } else {
             return $this->get_first_related($model_name_of_related_obj);

Indentation +213 added lines, -213 removed lines

@@ -10,217 +10,217 @@
  */
 class EE_Change_Log extends EE_Base_Class
 {
-    /**
-     * @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_Change_Log
-     * @throws EE_Error
-     */
-    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_Change_Log
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-    /**
-     * Gets message
-     *
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function message()
-    {
-        return $this->get('LOG_message');
-    }
-
-    /**
-     * Sets message
-     *
-     * @param mixed $message
-     * @throws EE_Error
-     */
-    public function set_message($message)
-    {
-        $this->set('LOG_message', $message);
-    }
-
-    /**
-     * Gets time
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function time()
-    {
-        return $this->get('LOG_time');
-    }
-
-    /**
-     * Sets time
-     *
-     * @param string $time
-     * @throws EE_Error
-     */
-    public function set_time($time)
-    {
-        $this->set('LOG_time', $time);
-    }
-
-    /**
-     * Gets log_type
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function log_type()
-    {
-        return $this->get('LOG_type');
-    }
-
-
-    /**
-     * Return the localized log type label.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function log_type_label()
-    {
-        return EEM_Change_Log::get_pretty_label_for_type($this->log_type());
-    }
-
-    /**
-     * Sets log_type
-     *
-     * @param string $log_type
-     * @throws EE_Error
-     */
-    public function set_log_type($log_type)
-    {
-        $this->set('LOG_type', $log_type);
-    }
-
-    /**
-     * Gets type of the model object related to this log
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function OBJ_type()
-    {
-        return $this->get('OBJ_type');
-    }
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     * @throws EE_Error
-     */
-    public function set_OBJ_type($type)
-    {
-        $this->set('OBJ_type', $type);
-    }
-
-    /**
-     * Gets OBJ_ID (the ID of the item related to this log)
-     *
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function OBJ_ID()
-    {
-        return $this->get('OBJ_ID');
-    }
-
-    /**
-     * Sets OBJ_ID
-     *
-     * @param mixed $OBJ_ID
-     * @throws EE_Error
-     */
-    public function set_OBJ_ID($OBJ_ID)
-    {
-        $this->set('OBJ_ID', $OBJ_ID);
-    }
-
-    /**
-     * Gets wp_user
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('LOG_wp_user');
-    }
-
-    /**
-     * Sets wp_user
-     *
-     * @param int $wp_user_id
-     * @throws EE_Error
-     */
-    public function set_wp_user($wp_user_id)
-    {
-        $this->set('LOG_wp_user', $wp_user_id);
-    }
-
-    /**
-     * Gets the model object attached to this log
-     *
-     * @return EE_Base_Class
-     * @throws EE_Error
-     */
-    public function object()
-    {
-        $model_name_of_related_obj = $this->OBJ_type();
-        $is_model_name = EE_Registry::instance()->is_model_name($model_name_of_related_obj);
-        if (! $is_model_name) {
-            return null;
-        } else {
-            return $this->get_first_related($model_name_of_related_obj);
-        }
-    }
-
-    /**
-     * Shorthand for setting the OBJ_ID and OBJ_type. Slightly handier than using
-     * _add_relation_to because you don't have to specify what type of model you're
-     * associating it with
-     *
-     * @param EE_Base_Class $object
-     * @param boolean       $save
-     * @return bool if $save=true, NULL is $save=false
-     * @throws EE_Error
-     */
-    public function set_object($object, $save = true)
-    {
-        if ($object instanceof EE_Base_Class) {
-            $this->set_OBJ_type($object->get_model()->get_this_model_name());
-            $this->set_OBJ_ID($object->ID());
-        } else {
-            $this->set_OBJ_type(null);
-            $this->set_OBJ_ID(null);
-        }
-        if ($save) {
-            return $this->save();
-        } else {
-            return null;
-        }
-    }
+	/**
+	 * @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_Change_Log
+	 * @throws EE_Error
+	 */
+	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_Change_Log
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+	/**
+	 * Gets message
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function message()
+	{
+		return $this->get('LOG_message');
+	}
+
+	/**
+	 * Sets message
+	 *
+	 * @param mixed $message
+	 * @throws EE_Error
+	 */
+	public function set_message($message)
+	{
+		$this->set('LOG_message', $message);
+	}
+
+	/**
+	 * Gets time
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function time()
+	{
+		return $this->get('LOG_time');
+	}
+
+	/**
+	 * Sets time
+	 *
+	 * @param string $time
+	 * @throws EE_Error
+	 */
+	public function set_time($time)
+	{
+		$this->set('LOG_time', $time);
+	}
+
+	/**
+	 * Gets log_type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function log_type()
+	{
+		return $this->get('LOG_type');
+	}
+
+
+	/**
+	 * Return the localized log type label.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function log_type_label()
+	{
+		return EEM_Change_Log::get_pretty_label_for_type($this->log_type());
+	}
+
+	/**
+	 * Sets log_type
+	 *
+	 * @param string $log_type
+	 * @throws EE_Error
+	 */
+	public function set_log_type($log_type)
+	{
+		$this->set('LOG_type', $log_type);
+	}
+
+	/**
+	 * Gets type of the model object related to this log
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function OBJ_type()
+	{
+		return $this->get('OBJ_type');
+	}
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 * @throws EE_Error
+	 */
+	public function set_OBJ_type($type)
+	{
+		$this->set('OBJ_type', $type);
+	}
+
+	/**
+	 * Gets OBJ_ID (the ID of the item related to this log)
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function OBJ_ID()
+	{
+		return $this->get('OBJ_ID');
+	}
+
+	/**
+	 * Sets OBJ_ID
+	 *
+	 * @param mixed $OBJ_ID
+	 * @throws EE_Error
+	 */
+	public function set_OBJ_ID($OBJ_ID)
+	{
+		$this->set('OBJ_ID', $OBJ_ID);
+	}
+
+	/**
+	 * Gets wp_user
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('LOG_wp_user');
+	}
+
+	/**
+	 * Sets wp_user
+	 *
+	 * @param int $wp_user_id
+	 * @throws EE_Error
+	 */
+	public function set_wp_user($wp_user_id)
+	{
+		$this->set('LOG_wp_user', $wp_user_id);
+	}
+
+	/**
+	 * Gets the model object attached to this log
+	 *
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 */
+	public function object()
+	{
+		$model_name_of_related_obj = $this->OBJ_type();
+		$is_model_name = EE_Registry::instance()->is_model_name($model_name_of_related_obj);
+		if (! $is_model_name) {
+			return null;
+		} else {
+			return $this->get_first_related($model_name_of_related_obj);
+		}
+	}
+
+	/**
+	 * Shorthand for setting the OBJ_ID and OBJ_type. Slightly handier than using
+	 * _add_relation_to because you don't have to specify what type of model you're
+	 * associating it with
+	 *
+	 * @param EE_Base_Class $object
+	 * @param boolean       $save
+	 * @return bool if $save=true, NULL is $save=false
+	 * @throws EE_Error
+	 */
+	public function set_object($object, $save = true)
+	{
+		if ($object instanceof EE_Base_Class) {
+			$this->set_OBJ_type($object->get_model()->get_this_model_name());
+			$this->set_OBJ_ID($object->ID());
+		} else {
+			$this->set_OBJ_type(null);
+			$this->set_OBJ_ID(null);
+		}
+		if ($save) {
+			return $this->save();
+		} else {
+			return null;
+		}
+	}
 }

core/libraries/line_item_filters/EE_Non_Zero_Line_Item_Filter.class.php

Spacing +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
     public function process(EEI_Line_Item $line_item)
     {
         $non_zero_line_item = $this->_filter_zero_line_item($line_item);
-        if (! $non_zero_line_item instanceof EEI_Line_Item) {
+        if ( ! $non_zero_line_item instanceof EEI_Line_Item) {
             return null;
         }
         // if this is an event subtotal, we want to only include it if it
@@ -42,7 +42,7 @@ 
             foreach ($line_item->children() as $child_line_item) {
                 $code = $child_line_item->code();
                 $child_line_item = $this->process($child_line_item);
-                if (! $child_line_item instanceof EEI_Line_Item) {
+                if ( ! $child_line_item instanceof EEI_Line_Item) {
                     $line_item->delete_child_line_item($code);
                     continue;
                 }

Indentation +89 added lines, -89 removed lines

@@ -13,99 +13,99 @@
  */
 class EE_Non_Zero_Line_Item_Filter extends EE_Line_Item_Filter_Base
 {
-    /**
-     * EE_Non_Zero_Line_Item_Filter constructor.
-     */
-    public function __construct()
-    {
-    }
+	/**
+	 * EE_Non_Zero_Line_Item_Filter constructor.
+	 */
+	public function __construct()
+	{
+	}
 
 
-    /**
-     * Creates a duplicate of the line item tree, except only includes billable items
-     * and the portion of line items attributed to billable things
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     */
-    public function process(EEI_Line_Item $line_item)
-    {
-        $non_zero_line_item = $this->_filter_zero_line_item($line_item);
-        if (! $non_zero_line_item instanceof EEI_Line_Item) {
-            return null;
-        }
-        // if this is an event subtotal, we want to only include it if it
-        // has a non-zero total and at least one ticket line item child
-        if ($line_item->children()) {
-            $ticket_or_subtotals_with_tkt_children_count = 0;
-            foreach ($line_item->children() as $child_line_item) {
-                $code = $child_line_item->code();
-                $child_line_item = $this->process($child_line_item);
-                if (! $child_line_item instanceof EEI_Line_Item) {
-                    $line_item->delete_child_line_item($code);
-                    continue;
-                }
-                if (
-                    (
-                        $child_line_item instanceof EEI_Line_Item
-                        && $child_line_item->type() === EEM_Line_Item::type_sub_total
-                    )
-                    || (
-                        $child_line_item instanceof EEI_Line_Item
-                        && $child_line_item->type() === EEM_Line_Item::type_line_item
-                        && $child_line_item->OBJ_type() === 'Ticket'
-                    )
-                ) {
-                    $ticket_or_subtotals_with_tkt_children_count++;
-                }
-            }
-            // if this is an event subtotal with NO ticket children
-            // we basically want to ignore it
-            return $this->_filter_zero_subtotal_line_item(
-                $non_zero_line_item,
-                $ticket_or_subtotals_with_tkt_children_count
-            );
-        }
-        return $non_zero_line_item;
-    }
+	/**
+	 * Creates a duplicate of the line item tree, except only includes billable items
+	 * and the portion of line items attributed to billable things
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 */
+	public function process(EEI_Line_Item $line_item)
+	{
+		$non_zero_line_item = $this->_filter_zero_line_item($line_item);
+		if (! $non_zero_line_item instanceof EEI_Line_Item) {
+			return null;
+		}
+		// if this is an event subtotal, we want to only include it if it
+		// has a non-zero total and at least one ticket line item child
+		if ($line_item->children()) {
+			$ticket_or_subtotals_with_tkt_children_count = 0;
+			foreach ($line_item->children() as $child_line_item) {
+				$code = $child_line_item->code();
+				$child_line_item = $this->process($child_line_item);
+				if (! $child_line_item instanceof EEI_Line_Item) {
+					$line_item->delete_child_line_item($code);
+					continue;
+				}
+				if (
+					(
+						$child_line_item instanceof EEI_Line_Item
+						&& $child_line_item->type() === EEM_Line_Item::type_sub_total
+					)
+					|| (
+						$child_line_item instanceof EEI_Line_Item
+						&& $child_line_item->type() === EEM_Line_Item::type_line_item
+						&& $child_line_item->OBJ_type() === 'Ticket'
+					)
+				) {
+					$ticket_or_subtotals_with_tkt_children_count++;
+				}
+			}
+			// if this is an event subtotal with NO ticket children
+			// we basically want to ignore it
+			return $this->_filter_zero_subtotal_line_item(
+				$non_zero_line_item,
+				$ticket_or_subtotals_with_tkt_children_count
+			);
+		}
+		return $non_zero_line_item;
+	}
 
 
-    /**
-     * Creates a new, unsaved line item, but if it's a ticket line item
-     * with a total of 0, or a subtotal of 0, returns null instead
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     */
-    protected function _filter_zero_line_item(EEI_Line_Item $line_item)
-    {
-        if (
-            $line_item->type() === EEM_Line_Item::type_line_item
-            && $line_item->OBJ_type() === 'Ticket'
-            && (int) $line_item->quantity() === 0
-        ) {
-            return null;
-        }
-        return $line_item;
-    }
+	/**
+	 * Creates a new, unsaved line item, but if it's a ticket line item
+	 * with a total of 0, or a subtotal of 0, returns null instead
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 */
+	protected function _filter_zero_line_item(EEI_Line_Item $line_item)
+	{
+		if (
+			$line_item->type() === EEM_Line_Item::type_line_item
+			&& $line_item->OBJ_type() === 'Ticket'
+			&& (int) $line_item->quantity() === 0
+		) {
+			return null;
+		}
+		return $line_item;
+	}
 
 
-    /**
-     * Creates a new, unsaved line item, but if it's a ticket line item
-     * with a total of 0, or a subtotal of 0, returns null instead
-     *
-     * @param EEI_Line_Item $line_item
-     * @param int           $ticket_children
-     * @return EEI_Line_Item
-     */
-    protected function _filter_zero_subtotal_line_item(EEI_Line_Item $line_item, $ticket_children = 0)
-    {
-        if (
-            (int) $ticket_children === 0
-            && $line_item->type() === EEM_Line_Item::type_sub_total
-        ) {
-            return null;
-        }
-        return $line_item;
-    }
+	/**
+	 * Creates a new, unsaved line item, but if it's a ticket line item
+	 * with a total of 0, or a subtotal of 0, returns null instead
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @param int           $ticket_children
+	 * @return EEI_Line_Item
+	 */
+	protected function _filter_zero_subtotal_line_item(EEI_Line_Item $line_item, $ticket_children = 0)
+	{
+		if (
+			(int) $ticket_children === 0
+			&& $line_item->type() === EEM_Line_Item::type_sub_total
+		) {
+			return null;
+		}
+		return $line_item;
+	}
 }

core/libraries/template_parts/EE_Template_Part_Manager.class.php

Spacing +6 added lines, -6 removed lines

@@ -69,13 +69,13 @@ 
         // SplPriorityQueue doesn't play nice with multiple items having the same priority
         // so if the incoming priority is already occupied, then let's increment it by one,
         // and then pass everything back into this method and try again with the new priority
-        if (isset($this->priorities[ $priority ])) {
+        if (isset($this->priorities[$priority])) {
             $priority++;
             $this->add_template_part($name, $label, $template, $priority);
             return;
         }
         // kk now we can mark this priority as being occupied
-        $this->priorities[ $priority ] = true;
+        $this->priorities[$priority] = true;
         // create the template part and add to the queue
         $this->template_parts->insert(
             new EE_Template_Part($name, $label, $template, $priority),
@@ -110,7 +110,7 @@ 
             $this->template_parts->next();
         }
         // now simply add our three strings of content together
-        return $this->before_event_content . $this->event_content . $this->after_event_content;
+        return $this->before_event_content.$this->event_content.$this->after_event_content;
     }
 
 
@@ -169,10 +169,10 @@ 
         // loop through template parts and add template content
         while ($this->template_parts->valid()) {
             $event_archive_display_order .= EEH_HTML::li(
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') .
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') .
+                EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2').
+                EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2').
                 $this->template_parts->current()->label(),
-                $list_item_css_id_prefix . $this->template_parts->current()->name(),
+                $list_item_css_id_prefix.$this->template_parts->current()->name(),
                 $list_item_css_class
             );
             $this->template_parts->next();

Indentation +191 added lines, -191 removed lines

@@ -13,195 +13,195 @@
  */
 class EE_Template_Part_Manager
 {
-    /**
-     * @param EE_Template_Part_PriorityQueue $template_parts
-     */
-    protected $template_parts;
-
-    /**
-     * @param array $priorities
-     */
-    protected $priorities = array();
-
-    /**
-     * @param int $event_desc_priority
-     */
-    protected $event_desc_priority;
-
-    /**
-     * @param string $before_event_content
-     */
-    protected $before_event_content;
-
-    /**
-     * @param string $event_content
-     */
-    protected $event_content;
-
-    /**
-     * @param string $after_event_content
-     */
-    protected $after_event_content;
-
-
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->template_parts = new EE_Template_Part_PriorityQueue();
-    }
-
-
-    /**
-     *    add_template_part
-     *
-     *    used for setting the details about a particular template part
-     *
-     * @param string $name     - just a simple string identifier - do NOT use 'event'
-     * @param string $label    - template part label displayed in admin
-     * @param string $template - name or path of template to be used by EEH_Template::locate_template()
-     * @param int    $priority - order in which template parts should be applied
-     */
-    public function add_template_part($name, $label, $template, $priority)
-    {
-        // SplPriorityQueue doesn't play nice with multiple items having the same priority
-        // so if the incoming priority is already occupied, then let's increment it by one,
-        // and then pass everything back into this method and try again with the new priority
-        if (isset($this->priorities[ $priority ])) {
-            $priority++;
-            $this->add_template_part($name, $label, $template, $priority);
-            return;
-        }
-        // kk now we can mark this priority as being occupied
-        $this->priorities[ $priority ] = true;
-        // create the template part and add to the queue
-        $this->template_parts->insert(
-            new EE_Template_Part($name, $label, $template, $priority),
-            $priority
-        );
-        if ($name === 'event') {
-            $this->event_desc_priority = $priority;
-        }
-    }
-
-
-    /**
-     *    apply_template_part_filters
-     *
-     *    adds template parts to the supplied content
-     *    according to the details set when the template parts were added
-     *
-     * @access public
-     * @param string $content
-     * @return string
-     */
-    public function apply_template_part_filters($content = '')
-    {
-        $this->template_parts->rewind();
-        // loop through template parts and position content
-        while ($this->template_parts->valid()) {
-            $this->_position_template_part(
-                $content,
-                $this->template_parts->current()->template(),
-                $this->template_parts->current()->priority()
-            );
-            $this->template_parts->next();
-        }
-        // now simply add our three strings of content together
-        return $this->before_event_content . $this->event_content . $this->after_event_content;
-    }
-
-
-    /**
-     *    position_template_part
-     *
-     * based on the priority of the incoming template part
-     * relative to the known event description template part priority,
-     * this method will assign template parts to one of the following:
-     *        $this->before_event_content
-     *        $this->event_content
-     *        $this->after_event_content
-     *
-     * @access protected
-     * @param string $content
-     * @param string $template
-     * @param int    $priority
-     * @return void
-     */
-    protected function _position_template_part($content, $template, $priority)
-    {
-        // Event Description content is the actual incoming content itself
-        if ($priority === $this->event_desc_priority) {
-            $this->event_content = $content;
-        } elseif ($priority < $this->event_desc_priority) {
-            // everything BEFORE the Event Description
-            $this->before_event_content .= EEH_Template::locate_template($template);
-        } elseif ($priority > $this->event_desc_priority) {
-            // everything AFTER the Event Description
-            $this->after_event_content .= EEH_Template::locate_template($template);
-        }
-    }
-
-
-    /**
-     *    generate_sortable_list_of_template_parts
-     *
-     *    creates an HTML list (<ul>) with list items (<li>) for each template part,
-     *    in a format that can be used as a sortable list in the admin
-     *
-     * @access public
-     * @param string $list_css_id
-     * @param string $list_css_class
-     * @param string $list_item_css_class
-     * @param string $list_item_css_id_prefix
-     * @return string
-     */
-    public function generate_sortable_list_of_template_parts(
-        $list_css_id = '',
-        $list_css_class = '',
-        $list_item_css_class = '',
-        $list_item_css_id_prefix = ''
-    ) {
-        $event_archive_display_order = EEH_HTML::ul($list_css_id, $list_css_class);
-        $this->template_parts->rewind();
-        // loop through template parts and add template content
-        while ($this->template_parts->valid()) {
-            $event_archive_display_order .= EEH_HTML::li(
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') .
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') .
-                $this->template_parts->current()->label(),
-                $list_item_css_id_prefix . $this->template_parts->current()->name(),
-                $list_item_css_class
-            );
-            $this->template_parts->next();
-        }
-        $event_archive_display_order .= EEH_HTML::ulx();
-        return $event_archive_display_order;
-    }
-
-
-    /**
-     *    display_template_parts
-     *
-     * just for debugging purposes
-     *
-     * @access    public
-     * @return void
-     */
-    public function display_template_parts()
-    {
-        if (WP_DEBUG) {
-            $this->template_parts->rewind();
-            while ($this->template_parts->valid()) {
-                EEH_Debug_Tools::printr(
-                    $this->template_parts->current(),
-                    'template_part',
-                    __FILE__,
-                    __LINE__
-                );
-                $this->template_parts->next();
-            }
-        }
-    }
+	/**
+	 * @param EE_Template_Part_PriorityQueue $template_parts
+	 */
+	protected $template_parts;
+
+	/**
+	 * @param array $priorities
+	 */
+	protected $priorities = array();
+
+	/**
+	 * @param int $event_desc_priority
+	 */
+	protected $event_desc_priority;
+
+	/**
+	 * @param string $before_event_content
+	 */
+	protected $before_event_content;
+
+	/**
+	 * @param string $event_content
+	 */
+	protected $event_content;
+
+	/**
+	 * @param string $after_event_content
+	 */
+	protected $after_event_content;
+
+
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->template_parts = new EE_Template_Part_PriorityQueue();
+	}
+
+
+	/**
+	 *    add_template_part
+	 *
+	 *    used for setting the details about a particular template part
+	 *
+	 * @param string $name     - just a simple string identifier - do NOT use 'event'
+	 * @param string $label    - template part label displayed in admin
+	 * @param string $template - name or path of template to be used by EEH_Template::locate_template()
+	 * @param int    $priority - order in which template parts should be applied
+	 */
+	public function add_template_part($name, $label, $template, $priority)
+	{
+		// SplPriorityQueue doesn't play nice with multiple items having the same priority
+		// so if the incoming priority is already occupied, then let's increment it by one,
+		// and then pass everything back into this method and try again with the new priority
+		if (isset($this->priorities[ $priority ])) {
+			$priority++;
+			$this->add_template_part($name, $label, $template, $priority);
+			return;
+		}
+		// kk now we can mark this priority as being occupied
+		$this->priorities[ $priority ] = true;
+		// create the template part and add to the queue
+		$this->template_parts->insert(
+			new EE_Template_Part($name, $label, $template, $priority),
+			$priority
+		);
+		if ($name === 'event') {
+			$this->event_desc_priority = $priority;
+		}
+	}
+
+
+	/**
+	 *    apply_template_part_filters
+	 *
+	 *    adds template parts to the supplied content
+	 *    according to the details set when the template parts were added
+	 *
+	 * @access public
+	 * @param string $content
+	 * @return string
+	 */
+	public function apply_template_part_filters($content = '')
+	{
+		$this->template_parts->rewind();
+		// loop through template parts and position content
+		while ($this->template_parts->valid()) {
+			$this->_position_template_part(
+				$content,
+				$this->template_parts->current()->template(),
+				$this->template_parts->current()->priority()
+			);
+			$this->template_parts->next();
+		}
+		// now simply add our three strings of content together
+		return $this->before_event_content . $this->event_content . $this->after_event_content;
+	}
+
+
+	/**
+	 *    position_template_part
+	 *
+	 * based on the priority of the incoming template part
+	 * relative to the known event description template part priority,
+	 * this method will assign template parts to one of the following:
+	 *        $this->before_event_content
+	 *        $this->event_content
+	 *        $this->after_event_content
+	 *
+	 * @access protected
+	 * @param string $content
+	 * @param string $template
+	 * @param int    $priority
+	 * @return void
+	 */
+	protected function _position_template_part($content, $template, $priority)
+	{
+		// Event Description content is the actual incoming content itself
+		if ($priority === $this->event_desc_priority) {
+			$this->event_content = $content;
+		} elseif ($priority < $this->event_desc_priority) {
+			// everything BEFORE the Event Description
+			$this->before_event_content .= EEH_Template::locate_template($template);
+		} elseif ($priority > $this->event_desc_priority) {
+			// everything AFTER the Event Description
+			$this->after_event_content .= EEH_Template::locate_template($template);
+		}
+	}
+
+
+	/**
+	 *    generate_sortable_list_of_template_parts
+	 *
+	 *    creates an HTML list (<ul>) with list items (<li>) for each template part,
+	 *    in a format that can be used as a sortable list in the admin
+	 *
+	 * @access public
+	 * @param string $list_css_id
+	 * @param string $list_css_class
+	 * @param string $list_item_css_class
+	 * @param string $list_item_css_id_prefix
+	 * @return string
+	 */
+	public function generate_sortable_list_of_template_parts(
+		$list_css_id = '',
+		$list_css_class = '',
+		$list_item_css_class = '',
+		$list_item_css_id_prefix = ''
+	) {
+		$event_archive_display_order = EEH_HTML::ul($list_css_id, $list_css_class);
+		$this->template_parts->rewind();
+		// loop through template parts and add template content
+		while ($this->template_parts->valid()) {
+			$event_archive_display_order .= EEH_HTML::li(
+				EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') .
+				EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') .
+				$this->template_parts->current()->label(),
+				$list_item_css_id_prefix . $this->template_parts->current()->name(),
+				$list_item_css_class
+			);
+			$this->template_parts->next();
+		}
+		$event_archive_display_order .= EEH_HTML::ulx();
+		return $event_archive_display_order;
+	}
+
+
+	/**
+	 *    display_template_parts
+	 *
+	 * just for debugging purposes
+	 *
+	 * @access    public
+	 * @return void
+	 */
+	public function display_template_parts()
+	{
+		if (WP_DEBUG) {
+			$this->template_parts->rewind();
+			while ($this->template_parts->valid()) {
+				EEH_Debug_Tools::printr(
+					$this->template_parts->current(),
+					'template_part',
+					__FILE__,
+					__LINE__
+				);
+				$this->template_parts->next();
+			}
+		}
+	}
 }