eventespresso / event-espresso-core

core/db_models/relations/EE_Has_Many_Relation.php

Indentation +81 added lines, -81 removed lines

@@ -13,93 +13,93 @@
 class EE_Has_Many_Relation extends EE_Model_Relation_Base
 {
 
-    /**
-     * Object representing the relationship between two models. Has_Many_Relations are where the OTHER model has the
-     * foreign key this model. IE, there can be many other model objects related to one of this model's objects (but
-     * NOT through a JOIN table, which is the case for EE_HABTM_Relations). This knows how to join the models, get
-     * related models across the relation, and add-and-remove the relationships.
-     *
-     * @param boolean $block_deletes                 For this type of r elation, we block by default. If there are
-     *                                               related models across this relation, block (prevent and add an
-     *                                               error) the deletion of this model
-     * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct($block_deletes = true, $blocking_delete_error_message = null)
-    {
-        parent::__construct($block_deletes, $blocking_delete_error_message);
-    }
+	/**
+	 * Object representing the relationship between two models. Has_Many_Relations are where the OTHER model has the
+	 * foreign key this model. IE, there can be many other model objects related to one of this model's objects (but
+	 * NOT through a JOIN table, which is the case for EE_HABTM_Relations). This knows how to join the models, get
+	 * related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param boolean $block_deletes                 For this type of r elation, we block by default. If there are
+	 *                                               related models across this relation, block (prevent and add an
+	 *                                               error) the deletion of this model
+	 * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct($block_deletes = true, $blocking_delete_error_message = null)
+	{
+		parent::__construct($block_deletes, $blocking_delete_error_message);
+	}
 
 
-    /**
-     * Gets the SQL string for performing the join between this model and the other model.
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
-     *                other_model_primary_table.fk" etc
-     * @throws \EE_Error
-     */
-    public function get_join_statement($model_relation_chain)
-    {
-        //create the sql string like
-        // LEFT JOIN other_table AS table_alias ON this_table_alias.pk = other_table_alias.fk extra_join_conditions
-        $this_table_pk_field  = $this->get_this_model()->get_primary_key_field();
-        $other_table_fk_field = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $pk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
-                $this->get_this_model()->get_this_model_name()) . $this_table_pk_field->get_table_alias();
-        $fk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
-                $this->get_other_model()->get_this_model_name()) . $other_table_fk_field->get_table_alias();
-        $fk_table             = $this->get_other_model()->get_table_for_alias($fk_table_alias);
+	/**
+	 * Gets the SQL string for performing the join between this model and the other model.
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
+	 *                other_model_primary_table.fk" etc
+	 * @throws \EE_Error
+	 */
+	public function get_join_statement($model_relation_chain)
+	{
+		//create the sql string like
+		// LEFT JOIN other_table AS table_alias ON this_table_alias.pk = other_table_alias.fk extra_join_conditions
+		$this_table_pk_field  = $this->get_this_model()->get_primary_key_field();
+		$other_table_fk_field = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$pk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
+				$this->get_this_model()->get_this_model_name()) . $this_table_pk_field->get_table_alias();
+		$fk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
+				$this->get_other_model()->get_this_model_name()) . $other_table_fk_field->get_table_alias();
+		$fk_table             = $this->get_other_model()->get_table_for_alias($fk_table_alias);
 
-        return $this->_left_join($fk_table, $fk_table_alias, $other_table_fk_field->get_table_column(), $pk_table_alias,
-                $this_table_pk_field->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
-    }
+		return $this->_left_join($fk_table, $fk_table_alias, $other_table_fk_field->get_table_column(), $pk_table_alias,
+				$this_table_pk_field->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
+	}
 
 
-    /**
-     * Sets the other model object's foreign key to this model object's primary key. Feel free to do this manually if
-     * you like.
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $extra_join_model_fields_n_values
-     * @return \EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array())
-    {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+	/**
+	 * Sets the other model object's foreign key to this model object's primary key. Feel free to do this manually if
+	 * you like.
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $extra_join_model_fields_n_values
+	 * @return \EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array())
+	{
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 
-        //find the field on the other model which is a foreign key to this model
-        $fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        if ($other_model_obj->get($fk_field_on_other_model->get_name()) != $this_model_obj->ID()) {
-            //set that field on the other model to this model's ID
-            $other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
-            $other_model_obj->save();
-        }
-        return $other_model_obj;
-    }
+		//find the field on the other model which is a foreign key to this model
+		$fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		if ($other_model_obj->get($fk_field_on_other_model->get_name()) != $this_model_obj->ID()) {
+			//set that field on the other model to this model's ID
+			$other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
+			$other_model_obj->save();
+		}
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Sets the other model object's foreign key to its default, instead of pointing to this model object.
-     * If $other_obj_or_id doesn't have any other relations, this function is essentially orphaning it
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $where_query
-     * @return \EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array())
-    {
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        //find the field on the other model which is a foreign key to this model
-        $fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        //set that field on the other model to this model's ID
-        $other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
-        $other_model_obj->save();
-        return $other_model_obj;
-    }
+	/**
+	 * Sets the other model object's foreign key to its default, instead of pointing to this model object.
+	 * If $other_obj_or_id doesn't have any other relations, this function is essentially orphaning it
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $where_query
+	 * @return \EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array())
+	{
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		//find the field on the other model which is a foreign key to this model
+		$fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		//set that field on the other model to this model's ID
+		$other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
+		$other_model_obj->save();
+		return $other_model_obj;
+	}
 }

core/db_classes/EE_Datetime.class.php

Doc Comments +4 added lines, -4 removed lines

@@ -253,7 +253,7 @@ 
 	 * increments reserved by amount passed by $qty
 	 *
 	 * @param int $qty
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function increase_reserved( $qty = 1 ) {
 		$reserved = $this->reserved() + absint( $qty );
@@ -266,7 +266,7 @@ 
 	 * decrements (subtracts) reserved by amount passed by $qty
 	 *
 	 * @param int $qty
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function decrease_reserved( $qty = 1 ) {
 		$reserved = $this->reserved() - absint( $qty );
@@ -411,7 +411,7 @@ 
 	 * @param string $dt_frmt     - string representation of date format defaults to WP settings
 	 * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with
 	 *                            the end date ie: Jan 01 "to" Dec 31
-	 * @return mixed        string on success, FALSE on fail
+	 * @return string        string on success, FALSE on fail
 	 * @throws \EE_Error
 	 */
 	public function date_range( $dt_frmt = '', $conjunction = ' - ' ) {
@@ -483,7 +483,7 @@ 
 	 * @param string $tm_format   string representation of time format defaults to 'g:i a'
 	 * @param string $conjunction conjunction junction what's your function ?
 	 *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
-	 * @return mixed              string on success, FALSE on fail
+	 * @return string              string on success, FALSE on fail
 	 * @throws \EE_Error
 	 */
 	public function time_range( $tm_format = '', $conjunction = ' - ' ) {

Indentation +36 added lines, -36 removed lines

@@ -358,13 +358,13 @@ 
 
 
 
-    /**
-     * get event start date.  Provide either the date format, or NULL to re-use the
-     * last-used format, or '' to use the default date format
-     *
-     * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
-     * @return        mixed        string on success, FALSE on fail
-     */
+	/**
+	 * get event start date.  Provide either the date format, or NULL to re-use the
+	 * last-used format, or '' to use the default date format
+	 *
+	 * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
+	 * @return        mixed        string on success, FALSE on fail
+	 */
 	public function start_date( $dt_frmt = '' ) {
 		return $this->_show_datetime( 'D', 'start', $dt_frmt );
 	}
@@ -381,13 +381,13 @@ 
 
 
 
-    /**
-     * get end date. Provide either the date format, or NULL to re-use the
-     * last-used format, or '' to use the default date format
-     *
-     * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
-     * @return        mixed        string on success, FALSE on fail
-     */
+	/**
+	 * get end date. Provide either the date format, or NULL to re-use the
+	 * last-used format, or '' to use the default date format
+	 *
+	 * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
+	 * @return        mixed        string on success, FALSE on fail
+	 */
 	public function end_date( $dt_frmt = '' ) {
 		return $this->_show_datetime( 'D', 'end', $dt_frmt );
 	}
@@ -509,23 +509,23 @@ 
 	/**
 	 * This returns a range representation of the date and times.
 	 * Output is dependent on the difference (or similarity) between DTT_EVT_start and DTT_EVT_end.
-     * Also, the return value is localized.
-     *
-     * @param string $dt_format
+	 * Also, the return value is localized.
+	 *
+	 * @param string $dt_format
 	 * @param string $tm_format
 	 * @param string $conjunction used between two different dates or times.
-     *                            ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm
-     * @param string $separator   used between the date and time formats.
-     *                            ex: Dec 1, 2016{$separator}2pm
+	 *                            ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm
+	 * @param string $separator   used between the date and time formats.
+	 *                            ex: Dec 1, 2016{$separator}2pm
 	 * @return string
 	 * @throws \EE_Error
 	 */
 	public function date_and_time_range(
-	    $dt_format = '',
-        $tm_format = '',
-        $conjunction = ' - ' ,
-        $separator = ' '
-    ) {
+		$dt_format = '',
+		$tm_format = '',
+		$conjunction = ' - ' ,
+		$separator = ' '
+	) {
 		$dt_format = ! empty( $dt_format ) ? $dt_format : $this->_dt_frmt;
 		$tm_format = ! empty( $tm_format ) ? $tm_format : $this->_tm_frmt;
 		$full_format = $dt_format . $separator . $tm_format;
@@ -539,14 +539,14 @@ 
 			//start and end date are the same but times are different
 			case ( $this->start_date() === $this->end_date() ) :
 				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format )
-				          . $conjunction
-				          . $this->get_i18n_datetime( 'DTT_EVT_end', $tm_format );
+						  . $conjunction
+						  . $this->get_i18n_datetime( 'DTT_EVT_end', $tm_format );
 				break;
 			//all other conditions
 			default :
 				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format )
-				          . $conjunction
-				          . $this->get_i18n_datetime( 'DTT_EVT_end', $full_format );
+						  . $conjunction
+						  . $this->get_i18n_datetime( 'DTT_EVT_end', $full_format );
 				break;
 		}
 		return $output;
@@ -630,13 +630,13 @@ 
 
 
 	/**
-     *        get end date and time
-     *
-     * @param string $dt_frmt   - string representation of date format defaults to 'F j, Y'
-     * @param string $tm_format - string representation of time format defaults to 'g:i a'
-     * @return    mixed                string on success, FALSE on fail
-     */
-    public function end_date_and_time($dt_frmt = '', $tm_format = '') {
+	 *        get end date and time
+	 *
+	 * @param string $dt_frmt   - string representation of date format defaults to 'F j, Y'
+	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
+	 * @return    mixed                string on success, FALSE on fail
+	 */
+	public function end_date_and_time($dt_frmt = '', $tm_format = '') {
 		return $this->_show_datetime( '', 'end', $dt_frmt, $tm_format );
 	}
 

Spacing +150 added lines, -150 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -74,9 +74,9 @@ 
 	 *                             		    date_format and the second value is the time format
 	 * @return EE_Datetime
 	 */
-	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 );
+	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);
 	}
 
 
@@ -87,8 +87,8 @@ 
 	 *                          		the website will be used.
 	 * @return EE_Datetime
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -96,8 +96,8 @@ 
 	/**
 	 * @param $name
 	 */
-	public function set_name( $name ) {
-		$this->set( 'DTT_name', $name );
+	public function set_name($name) {
+		$this->set('DTT_name', $name);
 	}
 
 
@@ -105,8 +105,8 @@ 
 	/**
 	 * @param $description
 	 */
-	public function set_description( $description ) {
-		$this->set( 'DTT_description', $description );
+	public function set_description($description) {
+		$this->set('DTT_description', $description);
 	}
 
 
@@ -118,8 +118,8 @@ 
 	 *
 	 * @param        string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
 	 */
-	public function set_start_date( $date ) {
-		$this->_set_date_for( $date, 'DTT_EVT_start' );
+	public function set_start_date($date) {
+		$this->_set_date_for($date, 'DTT_EVT_start');
 	}
 
 
@@ -131,8 +131,8 @@ 
 	 *
 	 * @param        string $time a string representation of the event time ex:  9am  or  7:30 PM
 	 */
-	public function set_start_time( $time ) {
-		$this->_set_time_for( $time, 'DTT_EVT_start' );
+	public function set_start_time($time) {
+		$this->_set_time_for($time, 'DTT_EVT_start');
 	}
 
 
@@ -144,8 +144,8 @@ 
 	 *
 	 * @param        string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
 	 */
-	public function set_end_date( $date ) {
-		$this->_set_date_for( $date, 'DTT_EVT_end' );
+	public function set_end_date($date) {
+		$this->_set_date_for($date, 'DTT_EVT_end');
 	}
 
 
@@ -157,8 +157,8 @@ 
 	 *
 	 * @param        string $time a string representation of the event time ex:  9am  or  7:30 PM
 	 */
-	public function set_end_time( $time ) {
-		$this->_set_time_for( $time, 'DTT_EVT_end' );
+	public function set_end_time($time) {
+		$this->_set_time_for($time, 'DTT_EVT_end');
 	}
 
 
@@ -170,8 +170,8 @@ 
 	 *
 	 * @param        int $reg_limit
 	 */
-	public function set_reg_limit( $reg_limit ) {
-		$this->set( 'DTT_reg_limit', $reg_limit );
+	public function set_reg_limit($reg_limit) {
+		$this->set('DTT_reg_limit', $reg_limit);
 	}
 
 
@@ -183,7 +183,7 @@ 
 	 * @return        mixed        int on success, FALSE on fail
 	 */
 	public function sold() {
-		return $this->get_raw( 'DTT_sold' );
+		return $this->get_raw('DTT_sold');
 	}
 
 
@@ -193,10 +193,10 @@ 
 	 *
 	 * @param        int $sold
 	 */
-	public function set_sold( $sold ) {
+	public function set_sold($sold) {
 		// sold can not go below zero
-		$sold = max( 0, $sold );
-		$this->set( 'DTT_sold', $sold );
+		$sold = max(0, $sold);
+		$this->set('DTT_sold', $sold);
 	}
 
 
@@ -205,11 +205,11 @@ 
 	 * increments sold by amount passed by $qty
 	 * @param int $qty
 	 */
-	public function increase_sold( $qty = 1 ) {
+	public function increase_sold($qty = 1) {
 		$sold = $this->sold() + $qty;
 		// remove ticket reservation
-		$this->decrease_reserved( $qty );
-		$this->set_sold( $sold );
+		$this->decrease_reserved($qty);
+		$this->set_sold($sold);
 	}
 
 
@@ -218,9 +218,9 @@ 
 	 * decrements (subtracts) sold amount passed by $qty
 	 * @param int $qty
 	 */
-	public function decrease_sold( $qty = 1 ) {
+	public function decrease_sold($qty = 1) {
 		$sold = $this->sold() - $qty;
-		$this->set_sold( $sold );
+		$this->set_sold($sold);
 	}
 
 
@@ -231,7 +231,7 @@ 
 	 * @return int
 	 */
 	public function reserved() {
-		return $this->get_raw( 'DTT_reserved' );
+		return $this->get_raw('DTT_reserved');
 	}
 
 
@@ -241,10 +241,10 @@ 
 	 *
 	 * @param int $reserved
 	 */
-	public function set_reserved( $reserved ) {
+	public function set_reserved($reserved) {
 		// reserved can not go below zero
-		$reserved = max( 0, (int) $reserved );
-		$this->set( 'DTT_reserved', $reserved );
+		$reserved = max(0, (int) $reserved);
+		$this->set('DTT_reserved', $reserved);
 	}
 
 
@@ -255,9 +255,9 @@ 
 	 * @param int $qty
 	 * @return boolean
 	 */
-	public function increase_reserved( $qty = 1 ) {
-		$reserved = $this->reserved() + absint( $qty );
-		return $this->set_reserved( $reserved );
+	public function increase_reserved($qty = 1) {
+		$reserved = $this->reserved() + absint($qty);
+		return $this->set_reserved($reserved);
 	}
 
 
@@ -268,9 +268,9 @@ 
 	 * @param int $qty
 	 * @return boolean
 	 */
-	public function decrease_reserved( $qty = 1 ) {
-		$reserved = $this->reserved() - absint( $qty );
-		return $this->set_reserved( $reserved );
+	public function decrease_reserved($qty = 1) {
+		$reserved = $this->reserved() - absint($qty);
+		return $this->set_reserved($reserved);
 	}
 
 
@@ -291,7 +291,7 @@ 
 	 * @return string
 	 */
 	public function name() {
-		return $this->get( 'DTT_name' );
+		return $this->get('DTT_name');
 	}
 
 
@@ -301,7 +301,7 @@ 
 	 * @return string
 	 */
 	public function description() {
-		return $this->get( 'DTT_description' );
+		return $this->get('DTT_description');
 	}
 
 
@@ -311,7 +311,7 @@ 
 	 * @return boolean          TRUE if is primary, FALSE if not.
 	 */
 	public function is_primary() {
-		return $this->get( 'DTT_is_primary' );
+		return $this->get('DTT_is_primary');
 	}
 
 
@@ -321,7 +321,7 @@ 
 	 * @return int         The order of the datetime for this event.
 	 */
 	public function order() {
-		return $this->get( 'DTT_order' );
+		return $this->get('DTT_order');
 	}
 
 
@@ -331,7 +331,7 @@ 
 	 * @return int
 	 */
 	public function parent() {
-		return $this->get( 'DTT_parent' );
+		return $this->get('DTT_parent');
 	}
 
 
@@ -347,10 +347,10 @@ 
 	 * @param    bool   $echo         - whether we echo or return (note echoing uses "pretty" formats, otherwise we use the standard formats)
 	 * @return    string|bool  string on success, FALSE on fail
 	 */
-	private function _show_datetime( $date_or_time = NULL, $start_or_end = 'start', $dt_frmt = '', $tm_frmt = '', $echo = FALSE ) {
+	private function _show_datetime($date_or_time = NULL, $start_or_end = 'start', $dt_frmt = '', $tm_frmt = '', $echo = FALSE) {
 		$field_name = "DTT_EVT_{$start_or_end}";
-		$dtt = $this->_get_datetime( $field_name, $dt_frmt, $tm_frmt, $date_or_time, $echo );
-		if ( ! $echo ) {
+		$dtt = $this->_get_datetime($field_name, $dt_frmt, $tm_frmt, $date_or_time, $echo);
+		if ( ! $echo) {
 			return $dtt;
 		}
 		return '';
@@ -365,8 +365,8 @@ 
      * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
      * @return        mixed        string on success, FALSE on fail
      */
-	public function start_date( $dt_frmt = '' ) {
-		return $this->_show_datetime( 'D', 'start', $dt_frmt );
+	public function start_date($dt_frmt = '') {
+		return $this->_show_datetime('D', 'start', $dt_frmt);
 	}
 
 
@@ -375,8 +375,8 @@ 
 	 * Echoes start_date()
 	 * @param string $dt_frmt
 	 */
-	public function e_start_date( $dt_frmt = '' ) {
-		$this->_show_datetime( 'D', 'start', $dt_frmt, NULL, TRUE );
+	public function e_start_date($dt_frmt = '') {
+		$this->_show_datetime('D', 'start', $dt_frmt, NULL, TRUE);
 	}
 
 
@@ -388,8 +388,8 @@ 
      * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
      * @return        mixed        string on success, FALSE on fail
      */
-	public function end_date( $dt_frmt = '' ) {
-		return $this->_show_datetime( 'D', 'end', $dt_frmt );
+	public function end_date($dt_frmt = '') {
+		return $this->_show_datetime('D', 'end', $dt_frmt);
 	}
 
 
@@ -398,8 +398,8 @@ 
 	 * Echoes the end date. See end_date()
 	 * @param string $dt_frmt
 	 */
-	public function e_end_date( $dt_frmt = '' ) {
-		$this->_show_datetime( 'D', 'end', $dt_frmt, NULL, TRUE );
+	public function e_end_date($dt_frmt = '') {
+		$this->_show_datetime('D', 'end', $dt_frmt, NULL, TRUE);
 	}
 
 
@@ -414,11 +414,11 @@ 
 	 * @return mixed        string on success, FALSE on fail
 	 * @throws \EE_Error
 	 */
-	public function date_range( $dt_frmt = '', $conjunction = ' - ' ) {
-		$dt_frmt = ! empty( $dt_frmt ) ? $dt_frmt : $this->_dt_frmt;
-		$start = str_replace( ' ', '&nbsp;', $this->get_i18n_datetime( 'DTT_EVT_start', $dt_frmt ) );
-		$end = str_replace( ' ', '&nbsp;', $this->get_i18n_datetime( 'DTT_EVT_end', $dt_frmt ) );
-		return $start !== $end ? $start . $conjunction . $end : $start;
+	public function date_range($dt_frmt = '', $conjunction = ' - ') {
+		$dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt;
+		$start = str_replace(' ', '&nbsp;', $this->get_i18n_datetime('DTT_EVT_start', $dt_frmt));
+		$end = str_replace(' ', '&nbsp;', $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt));
+		return $start !== $end ? $start.$conjunction.$end : $start;
 	}
 
 
@@ -428,8 +428,8 @@ 
 	 * @param string $conjunction
 	 * @throws \EE_Error
 	 */
-	public function e_date_range( $dt_frmt = '', $conjunction = ' - ' ) {
-		echo $this->date_range( $dt_frmt, $conjunction );
+	public function e_date_range($dt_frmt = '', $conjunction = ' - ') {
+		echo $this->date_range($dt_frmt, $conjunction);
 	}
 
 
@@ -440,8 +440,8 @@ 
 	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
 	 * @return mixed        string on success, FALSE on fail
 	 */
-	public function start_time( $tm_format = '' ) {
-		return $this->_show_datetime( 'T', 'start', NULL, $tm_format );
+	public function start_time($tm_format = '') {
+		return $this->_show_datetime('T', 'start', NULL, $tm_format);
 	}
 
 
@@ -449,8 +449,8 @@ 
 	/**
 	 * @param string $tm_format
 	 */
-	public function e_start_time( $tm_format = '' ) {
-		$this->_show_datetime( 'T', 'start', NULL, $tm_format, TRUE );
+	public function e_start_time($tm_format = '') {
+		$this->_show_datetime('T', 'start', NULL, $tm_format, TRUE);
 	}
 
 
@@ -461,8 +461,8 @@ 
 	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
 	 * @return mixed        string on success, FALSE on fail
 	 */
-	public function end_time( $tm_format = '' ) {
-		return $this->_show_datetime( 'T', 'end', NULL, $tm_format );
+	public function end_time($tm_format = '') {
+		return $this->_show_datetime('T', 'end', NULL, $tm_format);
 	}
 
 
@@ -470,8 +470,8 @@ 
 	/**
 	 * @param string $tm_format
 	 */
-	public function e_end_time( $tm_format = '' ) {
-		$this->_show_datetime( 'T', 'end', NULL, $tm_format, TRUE );
+	public function e_end_time($tm_format = '') {
+		$this->_show_datetime('T', 'end', NULL, $tm_format, TRUE);
 	}
 
 
@@ -486,11 +486,11 @@ 
 	 * @return mixed              string on success, FALSE on fail
 	 * @throws \EE_Error
 	 */
-	public function time_range( $tm_format = '', $conjunction = ' - ' ) {
-		$tm_format = ! empty( $tm_format ) ? $tm_format : $this->_tm_frmt;
-		$start = str_replace( ' ', '&nbsp;', $this->get_i18n_datetime( 'DTT_EVT_start', $tm_format ) );
-		$end = str_replace( ' ', '&nbsp;', $this->get_i18n_datetime( 'DTT_EVT_end',  $tm_format ) );
-		return $start !== $end ? $start . $conjunction . $end : $start;
+	public function time_range($tm_format = '', $conjunction = ' - ') {
+		$tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
+		$start = str_replace(' ', '&nbsp;', $this->get_i18n_datetime('DTT_EVT_start', $tm_format));
+		$end = str_replace(' ', '&nbsp;', $this->get_i18n_datetime('DTT_EVT_end', $tm_format));
+		return $start !== $end ? $start.$conjunction.$end : $start;
 	}
 
 
@@ -500,8 +500,8 @@ 
 	 * @param string $conjunction
 	 * @throws \EE_Error
 	 */
-	public function e_time_range( $tm_format = '', $conjunction = ' - ' ) {
-		echo $this->time_range( $tm_format, $conjunction );
+	public function e_time_range($tm_format = '', $conjunction = ' - ') {
+		echo $this->time_range($tm_format, $conjunction);
 	}
 
 
@@ -523,30 +523,30 @@ 
 	public function date_and_time_range(
 	    $dt_format = '',
         $tm_format = '',
-        $conjunction = ' - ' ,
+        $conjunction = ' - ',
         $separator = ' '
     ) {
-		$dt_format = ! empty( $dt_format ) ? $dt_format : $this->_dt_frmt;
-		$tm_format = ! empty( $tm_format ) ? $tm_format : $this->_tm_frmt;
-		$full_format = $dt_format . $separator . $tm_format;
+		$dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt;
+		$tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
+		$full_format = $dt_format.$separator.$tm_format;
 
 		//the range output depends on various conditions
-		switch ( true ) {
+		switch (true) {
 			//start date timestamp and end date timestamp are the same.
-			case ( $this->get_raw( 'DTT_EVT_start' ) === $this->get_raw( 'DTT_EVT_end' ) ) :
-				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format );
+			case ($this->get_raw('DTT_EVT_start') === $this->get_raw('DTT_EVT_end')) :
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format);
 				break;
 			//start and end date are the same but times are different
-			case ( $this->start_date() === $this->end_date() ) :
-				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format )
+			case ($this->start_date() === $this->end_date()) :
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
 				          . $conjunction
-				          . $this->get_i18n_datetime( 'DTT_EVT_end', $tm_format );
+				          . $this->get_i18n_datetime('DTT_EVT_end', $tm_format);
 				break;
 			//all other conditions
 			default :
-				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format )
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
 				          . $conjunction
-				          . $this->get_i18n_datetime( 'DTT_EVT_end', $full_format );
+				          . $this->get_i18n_datetime('DTT_EVT_end', $full_format);
 				break;
 		}
 		return $output;
@@ -564,8 +564,8 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function e_date_and_time_range( $dt_format = '', $tm_format = '', $conjunction = ' - ' ) {
-		echo $this->date_and_time_range( $dt_format, $tm_format, $conjunction );
+	public function e_date_and_time_range($dt_format = '', $tm_format = '', $conjunction = ' - ') {
+		echo $this->date_and_time_range($dt_format, $tm_format, $conjunction);
 	}
 
 
@@ -577,8 +577,8 @@ 
 	 * @param 	string 	$tm_format - string representation of time format defaults to 'g:i a'
 	 * @return 	mixed 	string on success, FALSE on fail
 	 */
-	public function start_date_and_time( $dt_format = '', $tm_format = '' ) {
-		return $this->_show_datetime( '', 'start', $dt_format, $tm_format );
+	public function start_date_and_time($dt_format = '', $tm_format = '') {
+		return $this->_show_datetime('', 'start', $dt_format, $tm_format);
 	}
 
 
@@ -587,8 +587,8 @@ 
 	 * @param string $dt_frmt
 	 * @param string $tm_format
 	 */
-	public function e_start_date_and_time( $dt_frmt = '', $tm_format = '' ) {
-		$this->_show_datetime( '', 'start', $dt_frmt, $tm_format, TRUE );
+	public function e_start_date_and_time($dt_frmt = '', $tm_format = '') {
+		$this->_show_datetime('', 'start', $dt_frmt, $tm_format, TRUE);
 	}
 
 
@@ -602,11 +602,11 @@ 
 	 * @param bool   $round_up
 	 * @return float|int|mixed
 	 */
-	public function length( $units = 'seconds', $round_up = FALSE ) {
-		$start = $this->get_raw( 'DTT_EVT_start' );
-		$end = $this->get_raw( 'DTT_EVT_end' );
+	public function length($units = 'seconds', $round_up = FALSE) {
+		$start = $this->get_raw('DTT_EVT_start');
+		$end = $this->get_raw('DTT_EVT_end');
 		$length_in_units = $end - $start;
-		switch ( $units ) {
+		switch ($units) {
 			//NOTE: We purposefully don't use "break;" in order to chain the divisions
 			/** @noinspection PhpMissingBreakStatementInspection */
 			case 'days':
@@ -619,10 +619,10 @@ 
 				$length_in_units /= 60;
 			case 'seconds':
 			default:
-				$length_in_units = ceil( $length_in_units );
+				$length_in_units = ceil($length_in_units);
 		}
-		if ( $round_up ) {
-			$length_in_units = max( $length_in_units, 1 );
+		if ($round_up) {
+			$length_in_units = max($length_in_units, 1);
 		}
 		return $length_in_units;
 	}
@@ -637,7 +637,7 @@ 
      * @return    mixed                string on success, FALSE on fail
      */
     public function end_date_and_time($dt_frmt = '', $tm_format = '') {
-		return $this->_show_datetime( '', 'end', $dt_frmt, $tm_format );
+		return $this->_show_datetime('', 'end', $dt_frmt, $tm_format);
 	}
 
 
@@ -646,8 +646,8 @@ 
 	 * @param string $dt_frmt
 	 * @param string $tm_format
 	 */
-	public function e_end_date_and_time( $dt_frmt = '', $tm_format = '' ) {
-		$this->_show_datetime( '', 'end', $dt_frmt, $tm_format, TRUE );
+	public function e_end_date_and_time($dt_frmt = '', $tm_format = '') {
+		$this->_show_datetime('', 'end', $dt_frmt, $tm_format, TRUE);
 	}
 
 
@@ -658,7 +658,7 @@ 
 	 * @return        int
 	 */
 	public function start() {
-		return $this->get_raw( 'DTT_EVT_start' );
+		return $this->get_raw('DTT_EVT_start');
 	}
 
 
@@ -669,7 +669,7 @@ 
 	 * @return        int
 	 */
 	public function end() {
-		return $this->get_raw( 'DTT_EVT_end' );
+		return $this->get_raw('DTT_EVT_end');
 	}
 
 
@@ -680,7 +680,7 @@ 
 	 * @return        mixed        int on success, FALSE on fail
 	 */
 	public function reg_limit() {
-		return $this->get_raw( 'DTT_reg_limit' );
+		return $this->get_raw('DTT_reg_limit');
 	}
 
 
@@ -708,15 +708,15 @@ 
 	 * 																	the spaces remaining for this particular datetime, hence the flag.
 	 * @return 	int
 	 */
-	public function spaces_remaining( $consider_tickets = FALSE ) {
+	public function spaces_remaining($consider_tickets = FALSE) {
 		// tickets remaining available for purchase
 		//no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF
 		$dtt_remaining = $this->reg_limit() - $this->sold_and_reserved();
-		if ( ! $consider_tickets ) {
+		if ( ! $consider_tickets) {
 			return $dtt_remaining;
 		}
 		$tickets_remaining = $this->tickets_remaining();
-		return min( $dtt_remaining, $tickets_remaining );
+		return min($dtt_remaining, $tickets_remaining);
 	}
 
 
@@ -727,19 +727,19 @@ 
 	 * @param array $query_params like EEM_Base::get_all's
 	 * @return int
 	 */
-	public function tickets_remaining( $query_params = array() ) {
+	public function tickets_remaining($query_params = array()) {
 		$sum = 0;
-		$tickets = $this->tickets( $query_params );
-		if ( ! empty( $tickets ) ) {
-			foreach ( $tickets as $ticket ) {
-				if ( $ticket instanceof EE_Ticket ) {
+		$tickets = $this->tickets($query_params);
+		if ( ! empty($tickets)) {
+			foreach ($tickets as $ticket) {
+				if ($ticket instanceof EE_Ticket) {
 					// get the actual amount of tickets that can be sold
-					$qty = $ticket->qty( 'saleable' );
-					if ( $qty === EE_INF ) {
+					$qty = $ticket->qty('saleable');
+					if ($qty === EE_INF) {
 						return EE_INF;
 					}
 					// no negative ticket quantities plz
-					if ( $qty > 0 ) {
+					if ($qty > 0) {
 						$sum += $qty;
 					}
 				}
@@ -756,8 +756,8 @@ 
 	 * @param array $query_params like EEM_Base::get_all's
 	 * @return int
 	 */
-	public function sum_tickets_initially_available( $query_params = array() ) {
-		return $this->sum_related( 'Ticket', $query_params, 'TKT_qty' );
+	public function sum_tickets_initially_available($query_params = array()) {
+		return $this->sum_related('Ticket', $query_params, 'TKT_qty');
 	}
 
 
@@ -769,7 +769,7 @@ 
 	 * @return int
 	 */
 	public function total_tickets_available_at_this_datetime() {
-		return $this->spaces_remaining( true );
+		return $this->spaces_remaining(true);
 	}
 
 
@@ -780,7 +780,7 @@ 
 	 * @return boolean
 	 */
 	public function is_upcoming() {
-		return ( $this->get_raw( 'DTT_EVT_start' ) > time() );
+		return ($this->get_raw('DTT_EVT_start') > time());
 	}
 
 
@@ -790,7 +790,7 @@ 
 	 * @return boolean
 	 */
 	public function is_active() {
-		return ( $this->get_raw( 'DTT_EVT_start' ) < time() && $this->get_raw( 'DTT_EVT_end' ) > time() );
+		return ($this->get_raw('DTT_EVT_start') < time() && $this->get_raw('DTT_EVT_end') > time());
 	}
 
 
@@ -800,7 +800,7 @@ 
 	 * @return boolean
 	 */
 	public function is_expired() {
-		return ( $this->get_raw( 'DTT_EVT_end' ) < time() );
+		return ($this->get_raw('DTT_EVT_end') < time());
 	}
 
 
@@ -811,16 +811,16 @@ 
 	 */
 	public function get_active_status() {
 		$total_tickets_for_this_dtt = $this->total_tickets_available_at_this_datetime();
-		if ( $total_tickets_for_this_dtt !== FALSE && $total_tickets_for_this_dtt < 1 ) {
+		if ($total_tickets_for_this_dtt !== FALSE && $total_tickets_for_this_dtt < 1) {
 			return EE_Datetime::sold_out;
 		}
-		if ( $this->is_expired() ) {
+		if ($this->is_expired()) {
 			return EE_Datetime::expired;
 		}
-		if ( $this->is_upcoming() ) {
+		if ($this->is_upcoming()) {
 			return EE_Datetime::upcoming;
 		}
-		if ( $this->is_active() ) {
+		if ($this->is_active()) {
 			return EE_Datetime::active;
 		}
 		return NULL;
@@ -834,24 +834,24 @@ 
 	 * @param  boolean $use_dtt_name if TRUE then we'll use DTT->name() if its not empty.
 	 * @return string
 	 */
-	public function get_dtt_display_name( $use_dtt_name = FALSE ) {
-		if ( $use_dtt_name ) {
+	public function get_dtt_display_name($use_dtt_name = FALSE) {
+		if ($use_dtt_name) {
 			$dtt_name = $this->name();
-			if ( !empty( $dtt_name ) ) {
+			if ( ! empty($dtt_name)) {
 				return $dtt_name;
 			}
 		}
 		//first condition is to see if the months are different
-		if ( date( 'm', $this->get_raw( 'DTT_EVT_start' ) ) != date( 'm', $this->get_raw( 'DTT_EVT_end' ) ) ) {
-			$display_date = $this->start_date( 'M j\, Y g:i a' ) . ' - ' . $this->end_date( 'M j\, Y g:i a' );
+		if (date('m', $this->get_raw('DTT_EVT_start')) != date('m', $this->get_raw('DTT_EVT_end'))) {
+			$display_date = $this->start_date('M j\, Y g:i a').' - '.$this->end_date('M j\, Y g:i a');
 			//next condition is if its the same month but different day
 		}
 		else {
-			if ( date( 'm', $this->get_raw( 'DTT_EVT_start' ) ) == date( 'm', $this->get_raw( 'DTT_EVT_end' ) ) && date( 'd', $this->get_raw( 'DTT_EVT_start' ) ) != date( 'd', $this->get_raw( 'DTT_EVT_end' ) ) ) {
-				$display_date = $this->start_date( 'M j\, g:i a' ) . ' - ' . $this->end_date( 'M j\, g:i a Y' );
+			if (date('m', $this->get_raw('DTT_EVT_start')) == date('m', $this->get_raw('DTT_EVT_end')) && date('d', $this->get_raw('DTT_EVT_start')) != date('d', $this->get_raw('DTT_EVT_end'))) {
+				$display_date = $this->start_date('M j\, g:i a').' - '.$this->end_date('M j\, g:i a Y');
 			}
 			else {
-				$display_date = $this->start_date( 'F j\, Y' ) . ' @ ' . $this->start_date( 'g:i a' ) . ' - ' . $this->end_date( 'g:i a' );
+				$display_date = $this->start_date('F j\, Y').' @ '.$this->start_date('g:i a').' - '.$this->end_date('g:i a');
 			}
 		}
 		return $display_date;
@@ -865,8 +865,8 @@ 
 *@param array $query_params see EEM_Base::get_all()
 	 * @return EE_Ticket[]
 	 */
-	public function tickets( $query_params = array() ) {
-		return $this->get_many_related( 'Ticket', $query_params );
+	public function tickets($query_params = array()) {
+		return $this->get_many_related('Ticket', $query_params);
 	}
 
 
@@ -876,21 +876,21 @@ 
 	 * @param array $query_params like EEM_Base::get_all's
 	 * @return EE_Ticket[]
 	 */
-	public function ticket_types_available_for_purchase( $query_params = array() ) {
+	public function ticket_types_available_for_purchase($query_params = array()) {
 		// first check if datetime is valid
-		if ( ! ( $this->is_upcoming() || $this->is_active() ) || $this->sold_out() ) {
+		if ( ! ($this->is_upcoming() || $this->is_active()) || $this->sold_out()) {
 			return array();
 		}
-		if ( empty( $query_params ) ) {
+		if (empty($query_params)) {
 			$query_params = array(
 				array(
-					'TKT_start_date' => array( '<=', EEM_Ticket::instance()->current_time_for_query( 'TKT_start_date' ) ),
-					'TKT_end_date'   => array( '>=', EEM_Ticket::instance()->current_time_for_query( 'TKT_end_date' ) ),
+					'TKT_start_date' => array('<=', EEM_Ticket::instance()->current_time_for_query('TKT_start_date')),
+					'TKT_end_date'   => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
 					'TKT_deleted'    => false
 				)
 			);
 		}
-		return $this->tickets( $query_params );
+		return $this->tickets($query_params);
 	}
 
 
@@ -900,7 +900,7 @@ 
 	 * @return EE_Event
 	 */
 	public function event() {
-		return $this->get_first_related( 'Event' );
+		return $this->get_first_related('Event');
 	}
 
 
@@ -912,13 +912,13 @@ 
 	 */
 	public function update_sold() {
 		$count_regs_for_this_datetime = EEM_Registration::instance()->count(
-			array( array(
+			array(array(
 				'STS_ID' 					=> EEM_Registration::status_id_approved,
 				'REG_deleted' 				=> 0,
 				'Ticket.Datetime.DTT_ID' 	=> $this->ID(),
-			) )
+			))
 		);
-		$this->set( 'DTT_sold', $count_regs_for_this_datetime );
+		$this->set('DTT_sold', $count_regs_for_this_datetime);
 		$this->save();
 		return $count_regs_for_this_datetime;
 	}

core/helpers/EEH_Event_View.helper.php

Doc Comments +4 added lines, -4 removed lines

@@ -38,7 +38,7 @@ 
 	 *
 	 * @access    public
 	 * @param    int $EVT_ID
-	 * @return    object
+	 * @return    null|boolean
 	 */
 	public static function get_event( $EVT_ID = 0 ) {
 		$EVT_ID = $EVT_ID instanceof WP_Post ? $EVT_ID->ID : absint( $EVT_ID );
@@ -116,7 +116,7 @@ 
 	 *
 	 *  @access 	public
 	 * @param    int $EVT_ID
-	 *  @return 	string
+	 *  @return 	boolean
 	 */
 	public static function event_has_content_or_excerpt( $EVT_ID = 0 ) {
 		$event = EEH_Event_View::get_event( $EVT_ID );
@@ -136,7 +136,7 @@ 
 	 *    event_active_status
 	 *
 	 * @access    public
-	 * @param null $num_words
+	 * @param integer $num_words
 	 * @param null $more
 	 * @return    string
 	 */
@@ -428,7 +428,7 @@ 
 	 *
 	 * @access    public
 	 * @param int $EVT_ID
-	 * @param null $include_expired
+	 * @param false|null $include_expired
 	 * @param bool $include_deleted
 	 * @param null $limit
 	 * @return EE_Datetime[]

Indentation +22 added lines, -22 removed lines

@@ -148,11 +148,11 @@ 
 			// admin has chosen "full description" for the "Event Espresso - Events > Templates > Display Description" option
 			the_content();
 		} else if (( is_archive() && has_excerpt( $post->ID ) && espresso_display_excerpt_in_event_list() ) ) {
-            // admin has chosen "excerpt (short desc)" for the "Event Espresso - Events > Templates > Display Description" option
+			// admin has chosen "excerpt (short desc)" for the "Event Espresso - Events > Templates > Display Description" option
 			// AND an excerpt actually exists
 			the_excerpt();
 		} else if (( is_archive() && ! has_excerpt( $post->ID ) && espresso_display_excerpt_in_event_list() )) {
-            // admin has chosen "excerpt (short desc)" for the "Event Espresso - Events > Templates > Display Description" option
+			// admin has chosen "excerpt (short desc)" for the "Event Espresso - Events > Templates > Display Description" option
 			// but NO excerpt actually exists, so we need to create one
 			if ( ! empty( $num_words )) {
 				if ( empty( $more )) {
@@ -161,32 +161,32 @@ 
 					$more .= ' class="more-link"';
 					$more .= \EED_Events_Archive::link_target();
 					$more .= '>' . $more_link_text . '</a>';
-                    $more = apply_filters( 'the_content_more_link', $more, $more_link_text );
+					$more = apply_filters( 'the_content_more_link', $more, $more_link_text );
 				}
 				$content = str_replace( 'NOMORELINK', '', get_the_content( 'NOMORELINK' ));
 
 				$content =  wp_trim_words( $content, $num_words, ' ' ) . $more;
-            } else {
-                $content =  get_the_content();
+			} else {
+				$content =  get_the_content();
 			}
 			global $allowedtags;
 			// make sure links are allowed
-            $allowedtags['a'] = isset($allowedtags['a'])
-                ? $allowedtags['a']
-                : array();
-            // as well as target attribute
-            $allowedtags['a']['target'] = isset($allowedtags['a']['target'])
-                ? $allowedtags['a']['target']
-                : false;
-            // but get previous value so we can reset it
-            $prev_value = $allowedtags['a']['target'];
-            $allowedtags['a']['target'] = true;
+			$allowedtags['a'] = isset($allowedtags['a'])
+				? $allowedtags['a']
+				: array();
+			// as well as target attribute
+			$allowedtags['a']['target'] = isset($allowedtags['a']['target'])
+				? $allowedtags['a']['target']
+				: false;
+			// but get previous value so we can reset it
+			$prev_value = $allowedtags['a']['target'];
+			$allowedtags['a']['target'] = true;
 			$content = wp_kses( $content, $allowedtags );
 			$content = strip_shortcodes( $content );
 			echo apply_filters( 'the_content', $content );
 			$allowedtags['a']['target'] = $prev_value;
-        } else {
-            // admin has chosen "none" for the "Event Espresso - Events > Templates > Display Description" option
+		} else {
+			// admin has chosen "none" for the "Event Espresso - Events > Templates > Display Description" option
 			echo apply_filters( 'the_content', '' );
 		}
 		return ob_get_clean();
@@ -234,11 +234,11 @@ 
 					$url = get_term_link( $term, 'espresso_venue_categories' );
 					if ( ! is_wp_error( $url ) && (( $hide_uncategorized && strtolower( $term->name ) != __( 'uncategorized', 'event_espresso' )) || ! $hide_uncategorized )) {
 						$category_links[] = '<a href="' . esc_url( $url )
-                                            . '" rel="tag"'
-                                            . \EED_Events_Archive::link_target()
-                                            .'>'
-                                            . $term->name
-                                            . '</a>';
+											. '" rel="tag"'
+											. \EED_Events_Archive::link_target()
+											.'>'
+											. $term->name
+											. '</a>';
 					}
 				}
 			}

Spacing +120 added lines, -120 removed lines

@@ -40,27 +40,27 @@ 
 	 * @param    int $EVT_ID
 	 * @return    object
 	 */
-	public static function get_event( $EVT_ID = 0 ) {
-		$EVT_ID = $EVT_ID instanceof WP_Post ? $EVT_ID->ID : absint( $EVT_ID );
+	public static function get_event($EVT_ID = 0) {
+		$EVT_ID = $EVT_ID instanceof WP_Post ? $EVT_ID->ID : absint($EVT_ID);
 		// do we already have the Event  you are looking for?
-		if ( EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID ) {
+		if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
 			return EEH_Event_View::$_event;
 		}
 		EEH_Event_View::$_event = NULL;
 		// international newspaper?
 		global $post;
 		// if this is being called from an EE_Event post, then we can just grab the attached EE_Event object
-		 if ( isset( $post->post_type ) && $post->post_type == 'espresso_events' || $EVT_ID ) {
+		 if (isset($post->post_type) && $post->post_type == 'espresso_events' || $EVT_ID) {
 //			d( $post );
 			// grab the event we're looking for
-			if ( isset( $post->EE_Event ) && ( $EVT_ID == 0 || ( $EVT_ID == $post->ID ))) {
+			if (isset($post->EE_Event) && ($EVT_ID == 0 || ($EVT_ID == $post->ID))) {
 				EEH_Event_View::$_event = $post->EE_Event;
 //				d( EEH_Event_View::$_event );
 			}
 			// now if we STILL do NOT have an EE_Event model object, BUT we have an Event ID...
-			if ( ! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID ) {
+			if ( ! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
 				// sigh... pull it from the db
-				EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID( $EVT_ID );
+				EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
 //				d( EEH_Event_View::$_event );
 			}
 		}
@@ -76,8 +76,8 @@ 
 	 * @param    int $EVT_ID
 	 * @return    boolean
 	 */
-	public static function display_ticket_selector( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
+	public static function display_ticket_selector($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
 		return $event instanceof EE_Event ? $event->display_ticket_selector() : FALSE;
 	}
 
@@ -90,9 +90,9 @@ 
 	 * @param    int $EVT_ID
 	 * @return    string
 	 */
-	public static function event_status( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		return $event instanceof EE_Event ? $event->pretty_active_status( FALSE ) : '';
+	public static function event_status($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		return $event instanceof EE_Event ? $event->pretty_active_status(FALSE) : '';
 	}
 
 
@@ -104,8 +104,8 @@ 
 	 * @param    int $EVT_ID
 	 *  @return 	string
 	 */
-	public static function event_active_status( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
+	public static function event_active_status($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
 		return $event instanceof EE_Event ? $event->pretty_active_status() : 'inactive';
 	}
 
@@ -118,13 +118,13 @@ 
 	 * @param    int $EVT_ID
 	 *  @return 	string
 	 */
-	public static function event_has_content_or_excerpt( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
+	public static function event_has_content_or_excerpt($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
 		$has_content_or_excerpt = FALSE;
-		if ( $event instanceof EE_Event ) {
-			$has_content_or_excerpt = $event->description() != '' || $event->short_description( NULL, NULL, TRUE ) != '' ? TRUE : FALSE;
+		if ($event instanceof EE_Event) {
+			$has_content_or_excerpt = $event->description() != '' || $event->short_description(NULL, NULL, TRUE) != '' ? TRUE : FALSE;
 		}
-		if ( is_archive() && ! ( espresso_display_full_description_in_event_list() || espresso_display_excerpt_in_event_list() )) {
+		if (is_archive() && ! (espresso_display_full_description_in_event_list() || espresso_display_excerpt_in_event_list())) {
 			$has_content_or_excerpt = FALSE;
 		}
 		return $has_content_or_excerpt;
@@ -140,34 +140,34 @@ 
 	 * @param null $more
 	 * @return    string
 	 */
-	public static function event_content_or_excerpt( $num_words = NULL, $more = NULL ) {
+	public static function event_content_or_excerpt($num_words = NULL, $more = NULL) {
 		global $post;
 
 		ob_start();
-		if (( is_single() ) || ( is_archive() && espresso_display_full_description_in_event_list() )) {
+		if ((is_single()) || (is_archive() && espresso_display_full_description_in_event_list())) {
 			// admin has chosen "full description" for the "Event Espresso - Events > Templates > Display Description" option
 			the_content();
-		} else if (( is_archive() && has_excerpt( $post->ID ) && espresso_display_excerpt_in_event_list() ) ) {
+		} else if ((is_archive() && has_excerpt($post->ID) && espresso_display_excerpt_in_event_list())) {
             // admin has chosen "excerpt (short desc)" for the "Event Espresso - Events > Templates > Display Description" option
 			// AND an excerpt actually exists
 			the_excerpt();
-		} else if (( is_archive() && ! has_excerpt( $post->ID ) && espresso_display_excerpt_in_event_list() )) {
+		} else if ((is_archive() && ! has_excerpt($post->ID) && espresso_display_excerpt_in_event_list())) {
             // admin has chosen "excerpt (short desc)" for the "Event Espresso - Events > Templates > Display Description" option
 			// but NO excerpt actually exists, so we need to create one
-			if ( ! empty( $num_words )) {
-				if ( empty( $more )) {
-					$more_link_text = __( '(more…)' );
-					$more = ' <a href="' . get_permalink() . '"';
+			if ( ! empty($num_words)) {
+				if (empty($more)) {
+					$more_link_text = __('(more&hellip;)');
+					$more = ' <a href="'.get_permalink().'"';
 					$more .= ' class="more-link"';
 					$more .= \EED_Events_Archive::link_target();
-					$more .= '>' . $more_link_text . '</a>';
-                    $more = apply_filters( 'the_content_more_link', $more, $more_link_text );
+					$more .= '>'.$more_link_text.'</a>';
+                    $more = apply_filters('the_content_more_link', $more, $more_link_text);
 				}
-				$content = str_replace( 'NOMORELINK', '', get_the_content( 'NOMORELINK' ));
+				$content = str_replace('NOMORELINK', '', get_the_content('NOMORELINK'));
 
-				$content =  wp_trim_words( $content, $num_words, ' ' ) . $more;
+				$content = wp_trim_words($content, $num_words, ' ').$more;
             } else {
-                $content =  get_the_content();
+                $content = get_the_content();
 			}
 			global $allowedtags;
 			// make sure links are allowed
@@ -181,13 +181,13 @@ 
             // but get previous value so we can reset it
             $prev_value = $allowedtags['a']['target'];
             $allowedtags['a']['target'] = true;
-			$content = wp_kses( $content, $allowedtags );
-			$content = strip_shortcodes( $content );
-			echo apply_filters( 'the_content', $content );
+			$content = wp_kses($content, $allowedtags);
+			$content = strip_shortcodes($content);
+			echo apply_filters('the_content', $content);
 			$allowedtags['a']['target'] = $prev_value;
         } else {
             // admin has chosen "none" for the "Event Espresso - Events > Templates > Display Description" option
-			echo apply_filters( 'the_content', '' );
+			echo apply_filters('the_content', '');
 		}
 		return ob_get_clean();
 	}
@@ -201,13 +201,13 @@ 
 	 * @param    int $EVT_ID
 	 *  @return 	EE_Ticket[]
 	 */
-	public static function event_tickets_available( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
+	public static function event_tickets_available($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
 		$tickets_available_for_purchase = array();
-		if( $event instanceof EE_Event ) {
-			$datetimes = EEH_Event_View::get_all_date_obj( $EVT_ID, FALSE );
-			foreach( $datetimes as $datetime ) {
-				$tickets_available_for_purchase = array_merge( $tickets_available_for_purchase, $datetime->ticket_types_available_for_purchase() );
+		if ($event instanceof EE_Event) {
+			$datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, FALSE);
+			foreach ($datetimes as $datetime) {
+				$tickets_available_for_purchase = array_merge($tickets_available_for_purchase, $datetime->ticket_types_available_for_purchase());
 			}
 		}
 		return $tickets_available_for_purchase;
@@ -223,17 +223,17 @@ 
 	 * @param 	  bool   $hide_uncategorized
 	 * @return    string
 	 */
-	public static function event_categories( $EVT_ID = 0, $hide_uncategorized = TRUE ) {
+	public static function event_categories($EVT_ID = 0, $hide_uncategorized = TRUE) {
 		$category_links = array();
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
-			$event_categories = get_the_terms( $event->ID(), 'espresso_event_categories' );
-			if ( $event_categories ) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$event_categories = get_the_terms($event->ID(), 'espresso_event_categories');
+			if ($event_categories) {
 				// loop thru terms and create links
-				foreach ( $event_categories as $term ) {
-					$url = get_term_link( $term, 'espresso_venue_categories' );
-					if ( ! is_wp_error( $url ) && (( $hide_uncategorized && strtolower( $term->name ) != __( 'uncategorized', 'event_espresso' )) || ! $hide_uncategorized )) {
-						$category_links[] = '<a href="' . esc_url( $url )
+				foreach ($event_categories as $term) {
+					$url = get_term_link($term, 'espresso_venue_categories');
+					if ( ! is_wp_error($url) && (($hide_uncategorized && strtolower($term->name) != __('uncategorized', 'event_espresso')) || ! $hide_uncategorized)) {
+						$category_links[] = '<a href="'.esc_url($url)
                                             . '" rel="tag"'
                                             . \EED_Events_Archive::link_target()
                                             .'>'
@@ -243,7 +243,7 @@ 
 				}
 			}
 		}
-		return implode( ', ', $category_links );
+		return implode(', ', $category_links);
 	}
 
 
@@ -257,10 +257,10 @@ 
 	 * @param int    $EVT_ID
 	 * @return    string
 	 */
-	public static function the_event_date( $dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0 ) {
-		$datetime = EEH_Event_View::get_primary_date_obj( $EVT_ID );
-		$format = ! empty( $dt_frmt ) && ! empty( $tm_frmt ) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime( 'DTT_EVT_start', $format ) :  '';
+	public static function the_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0) {
+		$datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
 	}
 
 
@@ -274,10 +274,10 @@ 
 	 * @param int    $EVT_ID
 	 * @return    string
 	 */
-	public static function the_event_end_date( $dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0 ) {
-		$datetime = EEH_Event_View::get_last_date_obj( $EVT_ID );
-		$format = ! empty( $dt_frmt ) && ! empty( $tm_frmt ) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime( 'DTT_EVT_end', $format ) : '';
+	public static function the_event_end_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0) {
+		$datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
 	}
 
 
@@ -291,10 +291,10 @@ 
 	 * @param int    $EVT_ID
 	 * @return    string
 	 */
-	public static function the_earliest_event_date( $dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0 ) {
-		$datetime = EEH_Event_View::get_earliest_date_obj( $EVT_ID );
-		$format = ! empty( $dt_frmt ) && ! empty( $tm_frmt ) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-		return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime( 'DTT_EVT_start', $format ) : '';
+	public static function the_earliest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0) {
+		$datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
 	}
 
 
@@ -308,10 +308,10 @@ 
 	 * @param int    $EVT_ID
 	 * @return    string
 	 */
-	public static function the_latest_event_date( $dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0 ) {
-		$datetime = EEH_Event_View::get_last_date_obj( $EVT_ID );
-		$format = ! empty( $dt_frmt ) && ! empty( $tm_frmt ) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-		return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime( 'DTT_EVT_end', $format ) : '';
+	public static function the_latest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0) {
+		$datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
 	}
 
 
@@ -323,13 +323,13 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function event_date_as_calendar_page( $EVT_ID = 0 ) {
-		$datetime = EEH_Event_View::get_primary_date_obj( $EVT_ID );
-		if ( $datetime instanceof EE_Datetime ) {
+	public static function event_date_as_calendar_page($EVT_ID = 0) {
+		$datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
+		if ($datetime instanceof EE_Datetime) {
 	?>
 		<div class="event-date-calendar-page-dv">
-			<div class="event-date-calendar-page-month-dv"><?php echo $datetime->get_i18n_datetime( 'DTT_EVT_start', 'M' );?></div>
-			<div class="event-date-calendar-page-day-dv"><?php echo $datetime->start_date( 'd' );?></div>
+			<div class="event-date-calendar-page-month-dv"><?php echo $datetime->get_i18n_datetime('DTT_EVT_start', 'M'); ?></div>
+			<div class="event-date-calendar-page-day-dv"><?php echo $datetime->start_date('d'); ?></div>
 		</div>
 	<?php
 		}
@@ -344,17 +344,17 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function get_primary_date_obj( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
+	public static function get_primary_date_obj($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
 			$datetimes = $event->get_many_related(
 				'Datetime',
 				array(
 					'limit' => 1,
-					'order_by' => array( 'DTT_order' => 'ASC' )
+					'order_by' => array('DTT_order' => 'ASC')
 				)
 			);
-			return reset( $datetimes );
+			return reset($datetimes);
 		} else {
 			 return FALSE;
 		}
@@ -369,17 +369,17 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function get_last_date_obj( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
+	public static function get_last_date_obj($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
 			$datetimes = $event->get_many_related(
 				'Datetime',
 				array(
 					'limit' => 1,
-					'order_by' => array( 'DTT_order' => 'DESC' )
+					'order_by' => array('DTT_order' => 'DESC')
 				)
 			);
-			return end( $datetimes );
+			return end($datetimes);
 		} else {
 			return FALSE;
 		}
@@ -394,17 +394,17 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function get_earliest_date_obj( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
+	public static function get_earliest_date_obj($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
 			$datetimes = $event->get_many_related(
 				'Datetime',
 				array(
 					'limit' => 1,
-					'order_by' => array( 'DTT_EVT_start' => 'ASC' )
+					'order_by' => array('DTT_EVT_start' => 'ASC')
 				)
 			);
-			return reset( $datetimes );
+			return reset($datetimes);
 		} else {
 			 return FALSE;
 		}
@@ -419,17 +419,17 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function get_latest_date_obj( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
+	public static function get_latest_date_obj($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
 			$datetimes = $event->get_many_related(
 				'Datetime',
 				array(
 					'limit' => 1,
-					'order_by' => array( 'DTT_EVT_start' => 'DESC' )
+					'order_by' => array('DTT_EVT_start' => 'DESC')
 				)
 			);
-			return end( $datetimes );
+			return end($datetimes);
 		} else {
 			return FALSE;
 		}
@@ -447,17 +447,17 @@ 
 	 * @param null $limit
 	 * @return EE_Datetime[]
 	 */
-	public static function get_all_date_obj( $EVT_ID = 0, $include_expired = null, $include_deleted = false, $limit = NULL ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if($include_expired === null){
-			if($event instanceof EE_Event && $event->is_expired()){
+	public static function get_all_date_obj($EVT_ID = 0, $include_expired = null, $include_deleted = false, $limit = NULL) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($include_expired === null) {
+			if ($event instanceof EE_Event && $event->is_expired()) {
 				$include_expired = true;
-			}else{
+			} else {
 				$include_expired = false;
 			}
 		}
 
-		if ( $event instanceof EE_Event ) {
+		if ($event instanceof EE_Event) {
 			return $event->datetimes_ordered($include_expired, $include_deleted, $limit);
 		} else {
 			 return array();
@@ -473,11 +473,11 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function event_link_url( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
-			$url = $event->external_url() !== NULL && $event->external_url() !== '' ? $event->external_url() : get_permalink( $event->ID() );
-			return preg_match( "~^(?:f|ht)tps?://~i", $url ) ? $url : 'http://' . $url;
+	public static function event_link_url($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$url = $event->external_url() !== NULL && $event->external_url() !== '' ? $event->external_url() : get_permalink($event->ID());
+			return preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'http://'.$url;
 		}
 		return NULL;
 	}
@@ -491,10 +491,10 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function event_phone( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
-			return EEH_Schema::telephone( $event->phone() );
+	public static function event_phone($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			return EEH_Schema::telephone($event->phone());
 		}
 		return NULL;
 	}
@@ -511,26 +511,26 @@ 
 	 * @param string $after
 	 * @return    string
 	 */
-	public static function edit_event_link( $EVT_ID = 0, $link = '', $before = '', $after = '' ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
+	public static function edit_event_link($EVT_ID = 0, $link = '', $before = '', $after = '') {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
 			// can the user edit this post ?
-			if ( current_user_can( 'edit_post', $event->ID() )) {
+			if (current_user_can('edit_post', $event->ID())) {
 				// set link text
-				$link_text = ! empty( $link ) ? $link : __('edit this event');
+				$link_text = ! empty($link) ? $link : __('edit this event');
 				// generate nonce
-				$nonce = wp_create_nonce( 'edit_nonce' );
+				$nonce = wp_create_nonce('edit_nonce');
 				// generate url to event editor for this event
-				$url = add_query_arg( array( 'page' => 'espresso_events', 'action' => 'edit', 'post' => $event->ID(), 'edit_nonce' => $nonce ), admin_url() );
+				$url = add_query_arg(array('page' => 'espresso_events', 'action' => 'edit', 'post' => $event->ID(), 'edit_nonce' => $nonce), admin_url());
 				// get edit CPT text
-				$post_type_obj = get_post_type_object( 'espresso_events' );
+				$post_type_obj = get_post_type_object('espresso_events');
 				// build final link html
-				$link = '<a class="post-edit-link" href="' . $url . '" ';
-				$link .= ' title="' . esc_attr( $post_type_obj->labels->edit_item ) . '"';
+				$link = '<a class="post-edit-link" href="'.$url.'" ';
+				$link .= ' title="'.esc_attr($post_type_obj->labels->edit_item).'"';
 				$link .= \EED_Events_Archive::link_target();
-				$link .='>' . $link_text . '</a>';
+				$link .= '>'.$link_text.'</a>';
 				// put it all together
-				return $before . apply_filters( 'edit_post_link', $link, $event->ID() ) . $after;
+				return $before.apply_filters('edit_post_link', $link, $event->ID()).$after;
 			}
 		}
 		return '';

core/db_classes/EE_Ticket.class.php

Indentation +566 added lines, -566 removed lines

@@ -61,15 +61,15 @@ 
 
 
 
-    /**
-     * @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_Ticket
-     * @throws \EE_Error
-     */
+	/**
+	 * @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_Ticket
+	 * @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 );
@@ -77,36 +77,36 @@ 
 
 
 
-    /**
-     * @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_Ticket
-     * @throws \EE_Error
-     */
+	/**
+	 * @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_Ticket
+	 * @throws \EE_Error
+	 */
 	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
 		return new self( $props_n_values, TRUE, $timezone );
 	}
 
 
 
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
 	public function parent() {
 		return $this->get( 'TKT_parent' );
 	}
 
 
 
-    /**
-     * return if a ticket has quantities available for purchase
-     *
-     * @param  int $DTT_ID the primary key for a particular datetime
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * return if a ticket has quantities available for purchase
+	 *
+	 * @param  int $DTT_ID the primary key for a particular datetime
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function available( $DTT_ID = 0 ) {
 		// are we checking availability for a particular datetime ?
 		if ( $DTT_ID ) {
@@ -123,14 +123,14 @@ 
 
 
 
-    /**
-     * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired
-     *
-     * @param bool        $display   true = we'll return a localized string, otherwise we just return the value of the relevant status const
-     * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save further processing
-     * @return mixed status int if the display string isn't requested
-     * @throws \EE_Error
-     */
+	/**
+	 * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired
+	 *
+	 * @param bool        $display   true = we'll return a localized string, otherwise we just return the value of the relevant status const
+	 * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save further processing
+	 * @return mixed status int if the display string isn't requested
+	 * @throws \EE_Error
+	 */
 	public function ticket_status( $display = FALSE, $remaining = null ) {
 		$remaining = is_bool( $remaining ) ? $remaining : $this->is_remaining();
 		if ( ! $remaining ) {
@@ -153,14 +153,14 @@ 
 
 
 
-    /**
-     * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale considering ALL the factors used for figuring that out.
-     *
-     * @access public
-     * @param  int $DTT_ID if an int above 0 is included here then we get a specific dtt.
-     * @return boolean         true = tickets remaining, false not.
-     * @throws \EE_Error
-     */
+	/**
+	 * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale considering ALL the factors used for figuring that out.
+	 *
+	 * @access public
+	 * @param  int $DTT_ID if an int above 0 is included here then we get a specific dtt.
+	 * @return boolean         true = tickets remaining, false not.
+	 * @throws \EE_Error
+	 */
 	public function is_remaining( $DTT_ID = 0 ) {
 		$num_remaining = $this->remaining( $DTT_ID );
 		if ( $num_remaining === 0 ) {
@@ -174,76 +174,76 @@ 
 
 
 
-    /**
-     * return the total number of tickets available for purchase
-     *
-     * @param  int $DTT_ID the primary key for a particular datetime.
-     *                     set to 0 for all related datetimes
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * return the total number of tickets available for purchase
+	 *
+	 * @param  int $DTT_ID the primary key for a particular datetime.
+	 *                     set to 0 for all related datetimes
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function remaining( $DTT_ID = 0 ) {
 		return $this->real_quantity_on_ticket('saleable', $DTT_ID );
 	}
 
 
 
-    /**
-     * Gets min
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets min
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function min() {
 		return $this->get( 'TKT_min' );
 	}
 
 
 
-    /**
-     * return if a ticket is no longer available cause its available dates have expired.
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * return if a ticket is no longer available cause its available dates have expired.
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function is_expired() {
 		return ( $this->get_raw( 'TKT_end_date' ) < time() );
 	}
 
 
 
-    /**
-     * Return if a ticket is yet to go on sale or not
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Return if a ticket is yet to go on sale or not
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function is_pending() {
 		return ( $this->get_raw( 'TKT_start_date' ) > time() );
 	}
 
 
 
-    /**
-     * Return if a ticket is on sale or not
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Return if a ticket is on sale or not
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function is_on_sale() {
 		return ( $this->get_raw( 'TKT_start_date' ) < time() && $this->get_raw( 'TKT_end_date' ) > time() );
 	}
 
 
 
-    /**
-     * This returns the chronologically last datetime that this ticket is associated with
-     *
-     * @param string $dt_frmt
-     * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with the end date ie: Jan 01 "to" Dec 31
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the chronologically last datetime that this ticket is associated with
+	 *
+	 * @param string $dt_frmt
+	 * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with the end date ie: Jan 01 "to" Dec 31
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function date_range( $dt_frmt = '', $conjunction = ' - ' ) {
 		$first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->start_date( $dt_frmt ) : '';
 		$last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->end_date( $dt_frmt ) : '';
@@ -253,12 +253,12 @@ 
 
 
 
-    /**
-     * This returns the chronologically first datetime that this ticket is associated with
-     *
-     * @return EE_Datetime
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the chronologically first datetime that this ticket is associated with
+	 *
+	 * @return EE_Datetime
+	 * @throws \EE_Error
+	 */
 	public function first_datetime() {
 		$datetimes = $this->datetimes( array( 'limit' => 1 ) );
 		return reset( $datetimes );
@@ -266,14 +266,14 @@ 
 
 
 
-    /**
-     * Gets all the datetimes this ticket can be used for attending.
-     * Unless otherwise specified, orders datetimes by start date.
-     *
-     * @param array $query_params see EEM_Base::get_all()
-     * @return EE_Datetime[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the datetimes this ticket can be used for attending.
+	 * Unless otherwise specified, orders datetimes by start date.
+	 *
+	 * @param array $query_params see EEM_Base::get_all()
+	 * @return EE_Datetime[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function datetimes( $query_params = array() ) {
 		if ( ! isset( $query_params[ 'order_by' ] ) ) {
 			$query_params[ 'order_by' ][ 'DTT_order' ] = 'ASC';
@@ -283,12 +283,12 @@ 
 
 
 
-    /**
-     * This returns the chronologically last datetime that this ticket is associated with
-     *
-     * @return EE_Datetime
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the chronologically last datetime that this ticket is associated with
+	 *
+	 * @return EE_Datetime
+	 * @throws \EE_Error
+	 */
 	public function last_datetime() {
 		$datetimes = $this->datetimes( array( 'limit' => 1, 'order_by' => array( 'DTT_EVT_start' => 'DESC' ) ) );
 		return end( $datetimes );
@@ -296,19 +296,19 @@ 
 
 
 
-    /**
-     * This returns the total tickets sold depending on the given parameters.
-     *
-     * @param  string $what   Can be one of two options: 'ticket', 'datetime'.
-     *                        'ticket' = total ticket sales for all datetimes this ticket is related to
-     *                        'datetime' = total ticket sales for a specified datetime (required $dtt_id)
-     *                        'datetime' = total ticket sales in the datetime_ticket table.
-     *                        If $dtt_id is not given then we return an array of sales indexed by datetime.
-     *                        If $dtt_id IS given then we return the tickets sold for that given datetime.
-     * @param  int    $dtt_id [optional] include the dtt_id with $what = 'datetime'.
-     * @return mixed (array|int)          how many tickets have sold
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the total tickets sold depending on the given parameters.
+	 *
+	 * @param  string $what   Can be one of two options: 'ticket', 'datetime'.
+	 *                        'ticket' = total ticket sales for all datetimes this ticket is related to
+	 *                        'datetime' = total ticket sales for a specified datetime (required $dtt_id)
+	 *                        'datetime' = total ticket sales in the datetime_ticket table.
+	 *                        If $dtt_id is not given then we return an array of sales indexed by datetime.
+	 *                        If $dtt_id IS given then we return the tickets sold for that given datetime.
+	 * @param  int    $dtt_id [optional] include the dtt_id with $what = 'datetime'.
+	 * @return mixed (array|int)          how many tickets have sold
+	 * @throws \EE_Error
+	 */
 	public function tickets_sold( $what = 'ticket', $dtt_id = NULL ) {
 		$total = 0;
 		$tickets_sold = $this->_all_tickets_sold();
@@ -333,12 +333,12 @@ 
 
 
 
-    /**
-     * This returns an array indexed by datetime_id for tickets sold with this ticket.
-     *
-     * @return EE_Ticket[]
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns an array indexed by datetime_id for tickets sold with this ticket.
+	 *
+	 * @return EE_Ticket[]
+	 * @throws \EE_Error
+	 */
 	protected function _all_tickets_sold() {
 		$datetimes = $this->get_many_related( 'Datetime' );
 		$tickets_sold = array();
@@ -354,29 +354,29 @@ 
 
 
 
-    /**
-     * This returns the base price object for the ticket.
-     *
-     * @param  bool $return_array whether to return as an array indexed by price id or just the object.
-     * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the base price object for the ticket.
+	 *
+	 * @param  bool $return_array whether to return as an array indexed by price id or just the object.
+	 * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function base_price( $return_array = FALSE ) {
 		$_where = array( 'Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price );
 		return $return_array
-            ? $this->get_many_related( 'Price', array( $_where ) )
-            : $this->get_first_related( 'Price', array( $_where ) );
+			? $this->get_many_related( 'Price', array( $_where ) )
+			: $this->get_first_related( 'Price', array( $_where ) );
 	}
 
 
 
-    /**
-     * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price)
-     *
-     * @access public
-     * @return EE_Price[]
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price)
+	 *
+	 * @access public
+	 * @return EE_Price[]
+	 * @throws \EE_Error
+	 */
 	public function price_modifiers() {
 		$query_params = array( 0 => array( 'Price_Type.PBT_ID' => array( 'NOT IN', array( EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax ) ) ) );
 		return $this->prices( $query_params );
@@ -384,132 +384,132 @@ 
 
 
 
-    /**
-     * Gets all the prices that combine to form the final price of this ticket
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Price[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the prices that combine to form the final price of this ticket
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Price[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function prices( $query_params = array() ) {
 		return $this->get_many_related( 'Price', $query_params );
 	}
 
 
 
-    /**
-     * Gets all the ticket applicabilities (ie, relations between datetimes and tickets)
-     *
-     * @param array $query_params see EEM_Base::get_all()
-     * @return EE_Datetime_Ticket|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the ticket applicabilities (ie, relations between datetimes and tickets)
+	 *
+	 * @param array $query_params see EEM_Base::get_all()
+	 * @return EE_Datetime_Ticket|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function datetime_tickets( $query_params = array() ) {
 		return $this->get_many_related( 'Datetime_Ticket', $query_params );
 	}
 
 
 
-    /**
-     * Gets all the datetimes from the db ordered by DTT_order
-     *
-     * @param boolean $show_expired
-     * @param boolean $show_deleted
-     * @return EE_Datetime[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the datetimes from the db ordered by DTT_order
+	 *
+	 * @param boolean $show_expired
+	 * @param boolean $show_deleted
+	 * @return EE_Datetime[]
+	 * @throws \EE_Error
+	 */
 	public function datetimes_ordered( $show_expired = TRUE, $show_deleted = FALSE ) {
 		return EEM_Datetime::instance( $this->_timezone )->get_datetimes_for_ticket_ordered_by_DTT_order( $this->ID(), $show_expired, $show_deleted );
 	}
 
 
 
-    /**
-     * Gets ID
-     *
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets ID
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function ID() {
 		return $this->get( 'TKT_ID' );
 	}
 
 
 
-    /**
-     * get the author of the ticket.
-     *
-     * @since 4.5.0
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * get the author of the ticket.
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function wp_user() {
 		return $this->get('TKT_wp_user');
 	}
 
 
 
-    /**
-     * Gets the template for the ticket
-     *
-     * @return EE_Ticket_Template|EE_Base_Class
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets the template for the ticket
+	 *
+	 * @return EE_Ticket_Template|EE_Base_Class
+	 * @throws \EE_Error
+	 */
 	public function template() {
 		return $this->get_first_related( 'Ticket_Template' );
 	}
 
 
 
-    /**
-     * Simply returns an array of EE_Price objects that are taxes.
-     *
-     * @return EE_Price[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Simply returns an array of EE_Price objects that are taxes.
+	 *
+	 * @return EE_Price[]
+	 * @throws \EE_Error
+	 */
 	public function get_ticket_taxes_for_admin() {
 		return EE_Taxes::get_taxes_for_admin();
 	}
 
 
 
-    /**
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function ticket_price() {
 		return $this->get( 'TKT_price' );
 	}
 
 
 
-    /**
-     * @return mixed
-     * @throws \EE_Error
-     */
+	/**
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
 	public function pretty_price() {
 		return $this->get_pretty( 'TKT_price' );
 	}
 
 
 
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
 	public function is_free() {
 		return $this->get_ticket_total_with_taxes() === 0;
 	}
 
 
 
-    /**
-     * get_ticket_total_with_taxes
-     *
-     * @param bool $no_cache
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * get_ticket_total_with_taxes
+	 *
+	 * @param bool $no_cache
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function get_ticket_total_with_taxes( $no_cache = FALSE ) {
 		if ($this->_ticket_total_with_taxes === null || $no_cache ) {
 			$this->_ticket_total_with_taxes = $this->get_ticket_subtotal() + $this->get_ticket_taxes_total_for_admin();
@@ -526,201 +526,201 @@ 
 
 
 
-    /**
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function get_ticket_subtotal() {
 		return EE_Taxes::get_subtotal_for_admin( $this );
 	}
 
 
 
-    /**
-     * Returns the total taxes applied to this ticket
-     *
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * Returns the total taxes applied to this ticket
+	 *
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function get_ticket_taxes_total_for_admin() {
 		return EE_Taxes::get_total_taxes_for_admin( $this );
 	}
 
 
 
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @throws \EE_Error
+	 */
 	public function set_name( $name ) {
 		$this->set( 'TKT_name', $name );
 	}
 
 
 
-    /**
-     * Gets description
-     *
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets description
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function description() {
 		return $this->get( 'TKT_description' );
 	}
 
 
 
-    /**
-     * Sets description
-     *
-     * @param string $description
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets description
+	 *
+	 * @param string $description
+	 * @throws \EE_Error
+	 */
 	public function set_description( $description ) {
 		$this->set( 'TKT_description', $description );
 	}
 
 
 
-    /**
-     * Gets start_date
-     *
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets start_date
+	 *
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function start_date( $dt_frmt = '', $tm_frmt = '' ) {
 		return $this->_get_datetime( 'TKT_start_date', $dt_frmt, $tm_frmt );
 	}
 
 
 
-    /**
-     * Sets start_date
-     *
-     * @param string $start_date
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets start_date
+	 *
+	 * @param string $start_date
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_start_date( $start_date ) {
 		$this->_set_date_time( 'B', $start_date, 'TKT_start_date' );
 	}
 
 
 
-    /**
-     * Gets end_date
-     *
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets end_date
+	 *
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function end_date( $dt_frmt = '', $tm_frmt = '' ) {
 		return $this->_get_datetime( 'TKT_end_date', $dt_frmt, $tm_frmt );
 	}
 
 
 
-    /**
-     * Sets end_date
-     *
-     * @param string $end_date
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets end_date
+	 *
+	 * @param string $end_date
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_end_date( $end_date ) {
 		$this->_set_date_time( 'B', $end_date, 'TKT_end_date' );
 	}
 
 
 
-    /**
-     * Sets sell until time
-     *
-     * @since 4.5.0
-     * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets sell until time
+	 *
+	 * @since 4.5.0
+	 * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
+	 * @throws \EE_Error
+	 */
 	public function set_end_time( $time ) {
 		$this->_set_time_for( $time, 'TKT_end_date' );
 	}
 
 
 
-    /**
-     * Sets min
-     *
-     * @param int $min
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets min
+	 *
+	 * @param int $min
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_min( $min ) {
 		$this->set( 'TKT_min', $min );
 	}
 
 
 
-    /**
-     * Gets max
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets max
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function max() {
 		return $this->get( 'TKT_max' );
 	}
 
 
 
-    /**
-     * Sets max
-     *
-     * @param int $max
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets max
+	 *
+	 * @param int $max
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_max( $max ) {
 		$this->set( 'TKT_max', $max );
 	}
 
 
 
-    /**
-     * Sets price
-     *
-     * @param float $price
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets price
+	 *
+	 * @param float $price
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_price( $price ) {
 		$this->set( 'TKT_price', $price );
 	}
 
 
 
-    /**
-     * Gets sold
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets sold
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function sold() {
 		return $this->get_raw( 'TKT_sold' );
 	}
 
 
 
-    /**
-     * Sets sold
-     *
-     * @param int $sold
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets sold
+	 *
+	 * @param int $sold
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_sold( $sold ) {
 		// sold can not go below zero
 		$sold = max( 0, $sold );
@@ -729,13 +729,13 @@ 
 
 
 
-    /**
-     * increments sold by amount passed by $qty
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * increments sold by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function increase_sold( $qty = 1 ) {
 		$sold = $this->sold() + $qty;
 		// remove ticket reservation, but don't adjust datetime reservations,  because that will happen
@@ -747,13 +747,13 @@ 
 
 
 
-    /**
-     * Increases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	protected function _increase_sold_for_datetimes( $qty = 1 ) {
 		$datetimes = $this->datetimes();
 		if ( is_array( $datetimes ) ) {
@@ -768,13 +768,13 @@ 
 
 
 
-    /**
-     * decrements (subtracts) sold by amount passed by $qty
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * decrements (subtracts) sold by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function decrease_sold( $qty = 1 ) {
 		$sold = $this->sold() - $qty;
 		$this->_decrease_sold_for_datetimes( $qty );
@@ -783,13 +783,13 @@ 
 
 
 
-    /**
-     * Decreases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Decreases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	protected function _decrease_sold_for_datetimes( $qty = 1 ) {
 		$datetimes = $this->datetimes();
 		if ( is_array( $datetimes ) ) {
@@ -804,25 +804,25 @@ 
 
 
 
-    /**
-     * Gets qty of reserved tickets
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets qty of reserved tickets
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function reserved() {
 		return $this->get_raw( 'TKT_reserved' );
 	}
 
 
 
-    /**
-     * Sets reserved
-     *
-     * @param int $reserved
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets reserved
+	 *
+	 * @param int $reserved
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_reserved( $reserved ) {
 		// reserved can not go below zero
 		$reserved = max( 0, (int) $reserved );
@@ -831,13 +831,13 @@ 
 
 
 
-    /**
-     * increments reserved by amount passed by $qty
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * increments reserved by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function increase_reserved( $qty = 1 ) {
 		$qty = absint( $qty );
 		$reserved = $this->reserved() + $qty;
@@ -847,13 +847,13 @@ 
 
 
 
-    /**
-     * Increases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	protected function _increase_reserved_for_datetimes( $qty = 1 ) {
 		$datetimes = $this->datetimes();
 		if ( is_array( $datetimes ) ) {
@@ -868,14 +868,14 @@ 
 
 
 
-    /**
-     * decrements (subtracts) reserved by amount passed by $qty
-     *
-     * @param int  $qty
-     * @param bool $adjust_datetimes
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * decrements (subtracts) reserved by amount passed by $qty
+	 *
+	 * @param int  $qty
+	 * @param bool $adjust_datetimes
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function decrease_reserved( $qty = 1, $adjust_datetimes = true ) {
 		$reserved = $this->reserved() - absint( $qty );
 		if ( $adjust_datetimes ) {
@@ -886,13 +886,13 @@ 
 
 
 
-    /**
-     * Increases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	protected function _decrease_reserved_for_datetimes( $qty = 1 ) {
 		$datetimes = $this->datetimes();
 		if ( is_array( $datetimes ) ) {
@@ -907,18 +907,18 @@ 
 
 
 
-    /**
-     * Gets ticket quantity
-     *
-     * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
-     *                            therefore $context can be one of three values: '', 'reg_limit', or 'saleable'
-     *                            '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects
-     *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
-     *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
-     *                            is therefore the truest measure of tickets that can be purchased at the moment
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets ticket quantity
+	 *
+	 * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
+	 *                            therefore $context can be one of three values: '', 'reg_limit', or 'saleable'
+	 *                            '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects
+	 *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
+	 *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
+	 *                            is therefore the truest measure of tickets that can be purchased at the moment
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function qty( $context = '' ) {
 		switch ( $context ) {
 			case 'reg_limit' :
@@ -932,19 +932,19 @@ 
 
 
 
-    /**
-     * Gets ticket quantity
-     *
-     * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
-     *                            therefore $context can be one of two values: 'reg_limit', or 'saleable'
-     *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
-     *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
-     *                            is therefore the truest measure of tickets that can be purchased at the moment
-     * @param  int   $DTT_ID      the primary key for a particular datetime.
-     *                            set to 0 for all related datetimes
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets ticket quantity
+	 *
+	 * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
+	 *                            therefore $context can be one of two values: 'reg_limit', or 'saleable'
+	 *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
+	 *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
+	 *                            is therefore the truest measure of tickets that can be purchased at the moment
+	 * @param  int   $DTT_ID      the primary key for a particular datetime.
+	 *                            set to 0 for all related datetimes
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function real_quantity_on_ticket( $context = 'reg_limit', $DTT_ID = 0 ) {
 		$raw = $this->get_raw( 'TKT_qty' );
 		// return immediately if it's zero
@@ -1027,212 +1027,212 @@ 
 
 
 
-    /**
-     * Gets uses
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets uses
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function uses() {
 		return $this->get( 'TKT_uses' );
 	}
 
 
 
-    /**
-     * Sets uses
-     *
-     * @param int $uses
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets uses
+	 *
+	 * @param int $uses
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_uses( $uses ) {
 		$this->set( 'TKT_uses', $uses );
 	}
 
 
 
-    /**
-     * returns whether ticket is required or not.
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * returns whether ticket is required or not.
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function required() {
 		return $this->get( 'TKT_required' );
 	}
 
 
 
-    /**
-     * sets the TKT_required property
-     *
-     * @param boolean $required
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * sets the TKT_required property
+	 *
+	 * @param boolean $required
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_required( $required ) {
 		$this->set( 'TKT_required', $required );
 	}
 
 
 
-    /**
-     * Gets taxable
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets taxable
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function taxable() {
 		return $this->get( 'TKT_taxable' );
 	}
 
 
 
-    /**
-     * Sets taxable
-     *
-     * @param boolean $taxable
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets taxable
+	 *
+	 * @param boolean $taxable
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_taxable( $taxable ) {
 		$this->set( 'TKT_taxable', $taxable );
 	}
 
 
 
-    /**
-     * Gets is_default
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets is_default
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function is_default() {
 		return $this->get( 'TKT_is_default' );
 	}
 
 
 
-    /**
-     * Sets is_default
-     *
-     * @param boolean $is_default
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets is_default
+	 *
+	 * @param boolean $is_default
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_is_default( $is_default ) {
 		$this->set( 'TKT_is_default', $is_default );
 	}
 
 
 
-    /**
-     * Gets order
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function order() {
 		return $this->get( 'TKT_order' );
 	}
 
 
 
-    /**
-     * Sets order
-     *
-     * @param int $order
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_order( $order ) {
 		$this->set( 'TKT_order', $order );
 	}
 
 
 
-    /**
-     * Gets row
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets row
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function row() {
 		return $this->get( 'TKT_row' );
 	}
 
 
 
-    /**
-     * Sets row
-     *
-     * @param int $row
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets row
+	 *
+	 * @param int $row
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_row( $row ) {
 		$this->set( 'TKT_row', $row );
 	}
 
 
 
-    /**
-     * Gets deleted
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets deleted
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function deleted() {
 		return $this->get( 'TKT_deleted' );
 	}
 
 
 
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_deleted( $deleted ) {
 		$this->set( 'TKT_deleted', $deleted );
 	}
 
 
 
-    /**
-     * Gets parent
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets parent
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function parent_ID() {
 		return $this->get( 'TKT_parent' );
 	}
 
 
 
-    /**
-     * Sets parent
-     *
-     * @param int $parent
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets parent
+	 *
+	 * @param int $parent
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_parent_ID( $parent ) {
 		$this->set( 'TKT_parent', $parent );
 	}
 
 
 
-    /**
-     * Gets a string which is handy for showing in gateways etc that describes the ticket.
-     *
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets a string which is handy for showing in gateways etc that describes the ticket.
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function name_and_info() {
 		$times = array();
 		foreach ( $this->datetimes() as $datetime ) {
@@ -1243,50 +1243,50 @@ 
 
 
 
-    /**
-     * Gets name
-     *
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function name() {
 		return $this->get( 'TKT_name' );
 	}
 
 
 
-    /**
-     * Gets price
-     *
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets price
+	 *
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function price() {
 		return $this->get( 'TKT_price' );
 	}
 
 
 
-    /**
-     * Gets all the registrations for this ticket
-     *
-     * @param array $query_params like EEM_Base::get_all's
-     * @return EE_Registration[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the registrations for this ticket
+	 *
+	 * @param array $query_params like EEM_Base::get_all's
+	 * @return EE_Registration[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function registrations( $query_params = array() ) {
 		return $this->get_many_related( 'Registration', $query_params );
 	}
 
 
 
-    /**
-     * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket.
-     * into account
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket.
+	 * into account
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function update_tickets_sold() {
 		$count_regs_for_this_ticket = $this->count_registrations( array( array( 'STS_ID' => EEM_Registration::status_id_approved, 'REG_deleted' => 0 ) ) );
 		$this->set_sold( $count_regs_for_this_ticket );
@@ -1318,21 +1318,21 @@ 
 
 
 
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return EE_Event
-     * @throws \EE_Error
-     * @throws UnexpectedEntityException
-     */
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return EE_Event
+	 * @throws \EE_Error
+	 * @throws UnexpectedEntityException
+	 */
 	public function get_related_event() {
 		//get one datetime to use for getting the event
 		$datetime = $this->first_datetime();
 		if ( ! $datetime instanceof \EE_Datetime ) {
 			throw new UnexpectedEntityException(
 				$datetime,
-                'EE_Datetime',
+				'EE_Datetime',
 				sprintf(
 					__( 'The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
 					$datetime->name()
@@ -1343,7 +1343,7 @@ 
 		if ( ! $event instanceof \EE_Event ) {
 			throw new UnexpectedEntityException(
 				$event,
-                'EE_Event',
+				'EE_Event',
 				sprintf(
 					__( 'The ticket (%s) is not associated with a valid event.', 'event_espresso'),
 					$this->name()
@@ -1355,14 +1355,14 @@ 
 
 
 
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return string
-     * @throws UnexpectedEntityException
-     * @throws \EE_Error
-     */
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return string
+	 * @throws UnexpectedEntityException
+	 * @throws \EE_Error
+	 */
 	public function get_event_name() {
 		$event = $this->get_related_event();
 		return $event instanceof EE_Event ? $event->name() : '';
@@ -1370,14 +1370,14 @@ 
 
 
 
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws \EE_Error
-     */
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws \EE_Error
+	 */
 	public function get_event_ID() {
 		$event = $this->get_related_event();
 		return $event instanceof EE_Event ? $event->ID() : 0;

Spacing +205 added lines, -205 removed lines

@@ -1,7 +1,7 @@ 
 <?php use EventEspresso\core\exceptions\UnexpectedEntityException;
 
-if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -70,9 +70,9 @@ 
      * @return EE_Ticket
      * @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 );
+	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);
 	}
 
 
@@ -84,8 +84,8 @@ 
      * @return EE_Ticket
      * @throws \EE_Error
      */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -95,7 +95,7 @@ 
      * @throws \EE_Error
      */
 	public function parent() {
-		return $this->get( 'TKT_parent' );
+		return $this->get('TKT_parent');
 	}
 
 
@@ -107,13 +107,13 @@ 
      * @return boolean
      * @throws \EE_Error
      */
-	public function available( $DTT_ID = 0 ) {
+	public function available($DTT_ID = 0) {
 		// are we checking availability for a particular datetime ?
-		if ( $DTT_ID ) {
+		if ($DTT_ID) {
 			// get that datetime object
-			$datetime = $this->get_first_related( 'Datetime', array( array( 'DTT_ID' => $DTT_ID ) ) );
+			$datetime = $this->get_first_related('Datetime', array(array('DTT_ID' => $DTT_ID)));
 			// if  ticket sales for this datetime have exceeded the reg limit...
-			if ( $datetime instanceof EE_Datetime && $datetime->sold_out() ) {
+			if ($datetime instanceof EE_Datetime && $datetime->sold_out()) {
 				return FALSE;
 			}
 		}
@@ -131,22 +131,22 @@ 
      * @return mixed status int if the display string isn't requested
      * @throws \EE_Error
      */
-	public function ticket_status( $display = FALSE, $remaining = null ) {
-		$remaining = is_bool( $remaining ) ? $remaining : $this->is_remaining();
-		if ( ! $remaining ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::sold_out, FALSE, 'sentence' ) : EE_Ticket::sold_out;
+	public function ticket_status($display = FALSE, $remaining = null) {
+		$remaining = is_bool($remaining) ? $remaining : $this->is_remaining();
+		if ( ! $remaining) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::sold_out, FALSE, 'sentence') : EE_Ticket::sold_out;
 		}
-		if ( $this->get( 'TKT_deleted' ) ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::archived, FALSE, 'sentence' ) : EE_Ticket::archived;
+		if ($this->get('TKT_deleted')) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::archived, FALSE, 'sentence') : EE_Ticket::archived;
 		}
-		if ( $this->is_expired() ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::expired, FALSE, 'sentence' ) : EE_Ticket::expired;
+		if ($this->is_expired()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::expired, FALSE, 'sentence') : EE_Ticket::expired;
 		}
-		if ( $this->is_pending() ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::pending, FALSE, 'sentence' ) : EE_Ticket::pending;
+		if ($this->is_pending()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::pending, FALSE, 'sentence') : EE_Ticket::pending;
 		}
-		if ( $this->is_on_sale() ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::onsale, FALSE, 'sentence' ) : EE_Ticket::onsale;
+		if ($this->is_on_sale()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::onsale, FALSE, 'sentence') : EE_Ticket::onsale;
 		}
 		return '';
 	}
@@ -161,12 +161,12 @@ 
      * @return boolean         true = tickets remaining, false not.
      * @throws \EE_Error
      */
-	public function is_remaining( $DTT_ID = 0 ) {
-		$num_remaining = $this->remaining( $DTT_ID );
-		if ( $num_remaining === 0 ) {
+	public function is_remaining($DTT_ID = 0) {
+		$num_remaining = $this->remaining($DTT_ID);
+		if ($num_remaining === 0) {
 			return FALSE;
 		}
-		if ( $num_remaining > 0 && $num_remaining < $this->min() ) {
+		if ($num_remaining > 0 && $num_remaining < $this->min()) {
 			return FALSE;
 		}
 		return TRUE;
@@ -182,8 +182,8 @@ 
      * @return int
      * @throws \EE_Error
      */
-	public function remaining( $DTT_ID = 0 ) {
-		return $this->real_quantity_on_ticket('saleable', $DTT_ID );
+	public function remaining($DTT_ID = 0) {
+		return $this->real_quantity_on_ticket('saleable', $DTT_ID);
 	}
 
 
@@ -195,7 +195,7 @@ 
      * @throws \EE_Error
      */
 	public function min() {
-		return $this->get( 'TKT_min' );
+		return $this->get('TKT_min');
 	}
 
 
@@ -207,7 +207,7 @@ 
      * @throws \EE_Error
      */
 	public function is_expired() {
-		return ( $this->get_raw( 'TKT_end_date' ) < time() );
+		return ($this->get_raw('TKT_end_date') < time());
 	}
 
 
@@ -219,7 +219,7 @@ 
      * @throws \EE_Error
      */
 	public function is_pending() {
-		return ( $this->get_raw( 'TKT_start_date' ) > time() );
+		return ($this->get_raw('TKT_start_date') > time());
 	}
 
 
@@ -231,7 +231,7 @@ 
      * @throws \EE_Error
      */
 	public function is_on_sale() {
-		return ( $this->get_raw( 'TKT_start_date' ) < time() && $this->get_raw( 'TKT_end_date' ) > time() );
+		return ($this->get_raw('TKT_start_date') < time() && $this->get_raw('TKT_end_date') > time());
 	}
 
 
@@ -244,11 +244,11 @@ 
      * @return string
      * @throws \EE_Error
      */
-	public function date_range( $dt_frmt = '', $conjunction = ' - ' ) {
-		$first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->start_date( $dt_frmt ) : '';
-		$last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->end_date( $dt_frmt ) : '';
+	public function date_range($dt_frmt = '', $conjunction = ' - ') {
+		$first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->start_date($dt_frmt) : '';
+		$last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->end_date($dt_frmt) : '';
 
-		return $first_date && $last_date ? $first_date . $conjunction  . $last_date : '';
+		return $first_date && $last_date ? $first_date.$conjunction.$last_date : '';
 	}
 
 
@@ -260,8 +260,8 @@ 
      * @throws \EE_Error
      */
 	public function first_datetime() {
-		$datetimes = $this->datetimes( array( 'limit' => 1 ) );
-		return reset( $datetimes );
+		$datetimes = $this->datetimes(array('limit' => 1));
+		return reset($datetimes);
 	}
 
 
@@ -274,11 +274,11 @@ 
      * @return EE_Datetime[]|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function datetimes( $query_params = array() ) {
-		if ( ! isset( $query_params[ 'order_by' ] ) ) {
-			$query_params[ 'order_by' ][ 'DTT_order' ] = 'ASC';
+	public function datetimes($query_params = array()) {
+		if ( ! isset($query_params['order_by'])) {
+			$query_params['order_by']['DTT_order'] = 'ASC';
 		}
-		return $this->get_many_related( 'Datetime', $query_params );
+		return $this->get_many_related('Datetime', $query_params);
 	}
 
 
@@ -290,8 +290,8 @@ 
      * @throws \EE_Error
      */
 	public function last_datetime() {
-		$datetimes = $this->datetimes( array( 'limit' => 1, 'order_by' => array( 'DTT_EVT_start' => 'DESC' ) ) );
-		return end( $datetimes );
+		$datetimes = $this->datetimes(array('limit' => 1, 'order_by' => array('DTT_EVT_start' => 'DESC')));
+		return end($datetimes);
 	}
 
 
@@ -309,22 +309,22 @@ 
      * @return mixed (array|int)          how many tickets have sold
      * @throws \EE_Error
      */
-	public function tickets_sold( $what = 'ticket', $dtt_id = NULL ) {
+	public function tickets_sold($what = 'ticket', $dtt_id = NULL) {
 		$total = 0;
 		$tickets_sold = $this->_all_tickets_sold();
-		switch ( $what ) {
+		switch ($what) {
 			case 'ticket' :
-				return $tickets_sold[ 'ticket' ];
+				return $tickets_sold['ticket'];
 				break;
 			case 'datetime' :
-				if ( empty( $tickets_sold[ 'datetime' ] ) ) {
+				if (empty($tickets_sold['datetime'])) {
 					return $total;
 				}
-				if ( ! empty( $dtt_id ) && ! isset( $tickets_sold[ 'datetime' ][ $dtt_id ] ) ) {
-					EE_Error::add_error( __( 'You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+				if ( ! empty($dtt_id) && ! isset($tickets_sold['datetime'][$dtt_id])) {
+					EE_Error::add_error(__('You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 					return $total;
 				}
-				return empty( $dtt_id ) ? $tickets_sold[ 'datetime' ] : $tickets_sold[ 'datetime' ][ $dtt_id ];
+				return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][$dtt_id];
 				break;
 			default:
 				return $total;
@@ -340,15 +340,15 @@ 
      * @throws \EE_Error
      */
 	protected function _all_tickets_sold() {
-		$datetimes = $this->get_many_related( 'Datetime' );
+		$datetimes = $this->get_many_related('Datetime');
 		$tickets_sold = array();
-		if ( ! empty( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				$tickets_sold[ 'datetime' ][ $datetime->ID() ] = $datetime->get( 'DTT_sold' );
+		if ( ! empty($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				$tickets_sold['datetime'][$datetime->ID()] = $datetime->get('DTT_sold');
 			}
 		}
 		//Tickets sold
-		$tickets_sold[ 'ticket' ] = $this->sold();
+		$tickets_sold['ticket'] = $this->sold();
 		return $tickets_sold;
 	}
 
@@ -361,11 +361,11 @@ 
      * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function base_price( $return_array = FALSE ) {
-		$_where = array( 'Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price );
+	public function base_price($return_array = FALSE) {
+		$_where = array('Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price);
 		return $return_array
-            ? $this->get_many_related( 'Price', array( $_where ) )
-            : $this->get_first_related( 'Price', array( $_where ) );
+            ? $this->get_many_related('Price', array($_where))
+            : $this->get_first_related('Price', array($_where));
 	}
 
 
@@ -378,8 +378,8 @@ 
      * @throws \EE_Error
      */
 	public function price_modifiers() {
-		$query_params = array( 0 => array( 'Price_Type.PBT_ID' => array( 'NOT IN', array( EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax ) ) ) );
-		return $this->prices( $query_params );
+		$query_params = array(0 => array('Price_Type.PBT_ID' => array('NOT IN', array(EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax))));
+		return $this->prices($query_params);
 	}
 
 
@@ -391,8 +391,8 @@ 
      * @return EE_Price[]|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function prices( $query_params = array() ) {
-		return $this->get_many_related( 'Price', $query_params );
+	public function prices($query_params = array()) {
+		return $this->get_many_related('Price', $query_params);
 	}
 
 
@@ -404,8 +404,8 @@ 
      * @return EE_Datetime_Ticket|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function datetime_tickets( $query_params = array() ) {
-		return $this->get_many_related( 'Datetime_Ticket', $query_params );
+	public function datetime_tickets($query_params = array()) {
+		return $this->get_many_related('Datetime_Ticket', $query_params);
 	}
 
 
@@ -418,8 +418,8 @@ 
      * @return EE_Datetime[]
      * @throws \EE_Error
      */
-	public function datetimes_ordered( $show_expired = TRUE, $show_deleted = FALSE ) {
-		return EEM_Datetime::instance( $this->_timezone )->get_datetimes_for_ticket_ordered_by_DTT_order( $this->ID(), $show_expired, $show_deleted );
+	public function datetimes_ordered($show_expired = TRUE, $show_deleted = FALSE) {
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_ticket_ordered_by_DTT_order($this->ID(), $show_expired, $show_deleted);
 	}
 
 
@@ -431,7 +431,7 @@ 
      * @throws \EE_Error
      */
 	public function ID() {
-		return $this->get( 'TKT_ID' );
+		return $this->get('TKT_ID');
 	}
 
 
@@ -456,7 +456,7 @@ 
      * @throws \EE_Error
      */
 	public function template() {
-		return $this->get_first_related( 'Ticket_Template' );
+		return $this->get_first_related('Ticket_Template');
 	}
 
 
@@ -478,7 +478,7 @@ 
      * @throws \EE_Error
      */
 	public function ticket_price() {
-		return $this->get( 'TKT_price' );
+		return $this->get('TKT_price');
 	}
 
 
@@ -488,7 +488,7 @@ 
      * @throws \EE_Error
      */
 	public function pretty_price() {
-		return $this->get_pretty( 'TKT_price' );
+		return $this->get_pretty('TKT_price');
 	}
 
 
@@ -510,8 +510,8 @@ 
      * @return float
      * @throws \EE_Error
      */
-	public function get_ticket_total_with_taxes( $no_cache = FALSE ) {
-		if ($this->_ticket_total_with_taxes === null || $no_cache ) {
+	public function get_ticket_total_with_taxes($no_cache = FALSE) {
+		if ($this->_ticket_total_with_taxes === null || $no_cache) {
 			$this->_ticket_total_with_taxes = $this->get_ticket_subtotal() + $this->get_ticket_taxes_total_for_admin();
 		}
 		return (float) $this->_ticket_total_with_taxes;
@@ -520,7 +520,7 @@ 
 
 
 	public function ensure_TKT_Price_correct() {
-		$this->set( 'TKT_price', EE_Taxes::get_subtotal_for_admin( $this ) );
+		$this->set('TKT_price', EE_Taxes::get_subtotal_for_admin($this));
 		$this->save();
 	}
 
@@ -531,7 +531,7 @@ 
      * @throws \EE_Error
      */
 	public function get_ticket_subtotal() {
-		return EE_Taxes::get_subtotal_for_admin( $this );
+		return EE_Taxes::get_subtotal_for_admin($this);
 	}
 
 
@@ -543,7 +543,7 @@ 
      * @throws \EE_Error
      */
 	public function get_ticket_taxes_total_for_admin() {
-		return EE_Taxes::get_total_taxes_for_admin( $this );
+		return EE_Taxes::get_total_taxes_for_admin($this);
 	}
 
 
@@ -554,8 +554,8 @@ 
      * @param string $name
      * @throws \EE_Error
      */
-	public function set_name( $name ) {
-		$this->set( 'TKT_name', $name );
+	public function set_name($name) {
+		$this->set('TKT_name', $name);
 	}
 
 
@@ -567,7 +567,7 @@ 
      * @throws \EE_Error
      */
 	public function description() {
-		return $this->get( 'TKT_description' );
+		return $this->get('TKT_description');
 	}
 
 
@@ -578,8 +578,8 @@ 
      * @param string $description
      * @throws \EE_Error
      */
-	public function set_description( $description ) {
-		$this->set( 'TKT_description', $description );
+	public function set_description($description) {
+		$this->set('TKT_description', $description);
 	}
 
 
@@ -592,8 +592,8 @@ 
      * @return string
      * @throws \EE_Error
      */
-	public function start_date( $dt_frmt = '', $tm_frmt = '' ) {
-		return $this->_get_datetime( 'TKT_start_date', $dt_frmt, $tm_frmt );
+	public function start_date($dt_frmt = '', $tm_frmt = '') {
+		return $this->_get_datetime('TKT_start_date', $dt_frmt, $tm_frmt);
 	}
 
 
@@ -605,8 +605,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_start_date( $start_date ) {
-		$this->_set_date_time( 'B', $start_date, 'TKT_start_date' );
+	public function set_start_date($start_date) {
+		$this->_set_date_time('B', $start_date, 'TKT_start_date');
 	}
 
 
@@ -619,8 +619,8 @@ 
      * @return string
      * @throws \EE_Error
      */
-	public function end_date( $dt_frmt = '', $tm_frmt = '' ) {
-		return $this->_get_datetime( 'TKT_end_date', $dt_frmt, $tm_frmt );
+	public function end_date($dt_frmt = '', $tm_frmt = '') {
+		return $this->_get_datetime('TKT_end_date', $dt_frmt, $tm_frmt);
 	}
 
 
@@ -632,8 +632,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_end_date( $end_date ) {
-		$this->_set_date_time( 'B', $end_date, 'TKT_end_date' );
+	public function set_end_date($end_date) {
+		$this->_set_date_time('B', $end_date, 'TKT_end_date');
 	}
 
 
@@ -645,8 +645,8 @@ 
      * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
      * @throws \EE_Error
      */
-	public function set_end_time( $time ) {
-		$this->_set_time_for( $time, 'TKT_end_date' );
+	public function set_end_time($time) {
+		$this->_set_time_for($time, 'TKT_end_date');
 	}
 
 
@@ -658,8 +658,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_min( $min ) {
-		$this->set( 'TKT_min', $min );
+	public function set_min($min) {
+		$this->set('TKT_min', $min);
 	}
 
 
@@ -671,7 +671,7 @@ 
      * @throws \EE_Error
      */
 	public function max() {
-		return $this->get( 'TKT_max' );
+		return $this->get('TKT_max');
 	}
 
 
@@ -683,8 +683,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_max( $max ) {
-		$this->set( 'TKT_max', $max );
+	public function set_max($max) {
+		$this->set('TKT_max', $max);
 	}
 
 
@@ -696,8 +696,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_price( $price ) {
-		$this->set( 'TKT_price', $price );
+	public function set_price($price) {
+		$this->set('TKT_price', $price);
 	}
 
 
@@ -709,7 +709,7 @@ 
      * @throws \EE_Error
      */
 	public function sold() {
-		return $this->get_raw( 'TKT_sold' );
+		return $this->get_raw('TKT_sold');
 	}
 
 
@@ -721,10 +721,10 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_sold( $sold ) {
+	public function set_sold($sold) {
 		// sold can not go below zero
-		$sold = max( 0, $sold );
-		$this->set( 'TKT_sold', $sold );
+		$sold = max(0, $sold);
+		$this->set('TKT_sold', $sold);
 	}
 
 
@@ -736,13 +736,13 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function increase_sold( $qty = 1 ) {
+	public function increase_sold($qty = 1) {
 		$sold = $this->sold() + $qty;
 		// remove ticket reservation, but don't adjust datetime reservations,  because that will happen
 		// via \EE_Datetime::increase_sold() when \EE_Ticket::_increase_sold_for_datetimes() is called
-		$this->decrease_reserved( $qty, false );
-		$this->_increase_sold_for_datetimes( $qty );
-		$this->set_sold( $sold );
+		$this->decrease_reserved($qty, false);
+		$this->_increase_sold_for_datetimes($qty);
+		$this->set_sold($sold);
 	}
 
 
@@ -754,12 +754,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	protected function _increase_sold_for_datetimes( $qty = 1 ) {
+	protected function _increase_sold_for_datetimes($qty = 1) {
 		$datetimes = $this->datetimes();
-		if ( is_array( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$datetime->increase_sold( $qty );
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->increase_sold($qty);
 					$datetime->save();
 				}
 			}
@@ -775,10 +775,10 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function decrease_sold( $qty = 1 ) {
+	public function decrease_sold($qty = 1) {
 		$sold = $this->sold() - $qty;
-		$this->_decrease_sold_for_datetimes( $qty );
-		$this->set_sold( $sold );
+		$this->_decrease_sold_for_datetimes($qty);
+		$this->set_sold($sold);
 	}
 
 
@@ -790,12 +790,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	protected function _decrease_sold_for_datetimes( $qty = 1 ) {
+	protected function _decrease_sold_for_datetimes($qty = 1) {
 		$datetimes = $this->datetimes();
-		if ( is_array( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$datetime->decrease_sold( $qty );
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->decrease_sold($qty);
 					$datetime->save();
 				}
 			}
@@ -811,7 +811,7 @@ 
      * @throws \EE_Error
      */
 	public function reserved() {
-		return $this->get_raw( 'TKT_reserved' );
+		return $this->get_raw('TKT_reserved');
 	}
 
 
@@ -823,10 +823,10 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_reserved( $reserved ) {
+	public function set_reserved($reserved) {
 		// reserved can not go below zero
-		$reserved = max( 0, (int) $reserved );
-		$this->set( 'TKT_reserved', $reserved );
+		$reserved = max(0, (int) $reserved);
+		$this->set('TKT_reserved', $reserved);
 	}
 
 
@@ -838,11 +838,11 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function increase_reserved( $qty = 1 ) {
-		$qty = absint( $qty );
+	public function increase_reserved($qty = 1) {
+		$qty = absint($qty);
 		$reserved = $this->reserved() + $qty;
-		$this->_increase_reserved_for_datetimes( $qty );
-		$this->set_reserved( $reserved );
+		$this->_increase_reserved_for_datetimes($qty);
+		$this->set_reserved($reserved);
 	}
 
 
@@ -854,12 +854,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	protected function _increase_reserved_for_datetimes( $qty = 1 ) {
+	protected function _increase_reserved_for_datetimes($qty = 1) {
 		$datetimes = $this->datetimes();
-		if ( is_array( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$datetime->increase_reserved( $qty );
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->increase_reserved($qty);
 					$datetime->save();
 				}
 			}
@@ -876,12 +876,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function decrease_reserved( $qty = 1, $adjust_datetimes = true ) {
-		$reserved = $this->reserved() - absint( $qty );
-		if ( $adjust_datetimes ) {
-			$this->_decrease_reserved_for_datetimes( $qty );
+	public function decrease_reserved($qty = 1, $adjust_datetimes = true) {
+		$reserved = $this->reserved() - absint($qty);
+		if ($adjust_datetimes) {
+			$this->_decrease_reserved_for_datetimes($qty);
 		}
-		$this->set_reserved( $reserved );
+		$this->set_reserved($reserved);
 	}
 
 
@@ -893,12 +893,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	protected function _decrease_reserved_for_datetimes( $qty = 1 ) {
+	protected function _decrease_reserved_for_datetimes($qty = 1) {
 		$datetimes = $this->datetimes();
-		if ( is_array( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$datetime->decrease_reserved( $qty );
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->decrease_reserved($qty);
 					$datetime->save();
 				}
 			}
@@ -919,14 +919,14 @@ 
      * @return int
      * @throws \EE_Error
      */
-	public function qty( $context = '' ) {
-		switch ( $context ) {
+	public function qty($context = '') {
+		switch ($context) {
 			case 'reg_limit' :
 				return $this->real_quantity_on_ticket();
 			case 'saleable' :
-				return $this->real_quantity_on_ticket( 'saleable' );
+				return $this->real_quantity_on_ticket('saleable');
 			default:
-				return $this->get_raw( 'TKT_qty' );
+				return $this->get_raw('TKT_qty');
 		}
 	}
 
@@ -945,15 +945,15 @@ 
      * @return int
      * @throws \EE_Error
      */
-	public function real_quantity_on_ticket( $context = 'reg_limit', $DTT_ID = 0 ) {
-		$raw = $this->get_raw( 'TKT_qty' );
+	public function real_quantity_on_ticket($context = 'reg_limit', $DTT_ID = 0) {
+		$raw = $this->get_raw('TKT_qty');
 		// return immediately if it's zero
-		if ( $raw === 0 ) {
+		if ($raw === 0) {
 			return $raw;
 		}
 		//echo "\n\n<br />Ticket: " . $this->name() . '<br />';
 		// ensure qty doesn't exceed raw value for THIS ticket
-		$qty = min( EE_INF, $raw );
+		$qty = min(EE_INF, $raw);
 		//echo "\n . qty: " . $qty . '<br />';
 		// calculate this ticket's total sales and reservations
 		$sold_and_reserved_for_this_ticket = $this->sold() + $this->reserved();
@@ -962,23 +962,23 @@ 
 		//echo "\n . sold_and_reserved_for_this_ticket: " . $sold_and_reserved_for_this_ticket . '<br />';
 		// first we need to calculate the maximum number of tickets available for the datetime
 		// do we want data for one datetime or all of them ?
-		$query_params = $DTT_ID ? array( array( 'DTT_ID' => $DTT_ID ) ) : array();
-		$datetimes = $this->datetimes( $query_params );
-		if ( is_array( $datetimes ) && ! empty( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
+		$query_params = $DTT_ID ? array(array('DTT_ID' => $DTT_ID)) : array();
+		$datetimes = $this->datetimes($query_params);
+		if (is_array($datetimes) && ! empty($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
 					$datetime->refresh_from_db();
 					//echo "\n . . datetime name: " . $datetime->name() . '<br />';
 					//echo "\n . . datetime ID: " . $datetime->ID() . '<br />';
 					// initialize with no restrictions for each datetime
 					// but adjust datetime qty based on datetime reg limit
-					$datetime_qty = min( EE_INF, $datetime->reg_limit() );
+					$datetime_qty = min(EE_INF, $datetime->reg_limit());
 					//echo "\n . . . datetime reg_limit: " . $datetime->reg_limit() . '<br />';
 					//echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
 					// if we want the actual saleable amount, then we need to consider OTHER ticket sales
 					// and reservations for this datetime, that do NOT include sales and reservations
 					// for this ticket (so we add $this->sold() and $this->reserved() back in)
-					if ( $context === 'saleable' ) {
+					if ($context === 'saleable') {
 						$datetime_qty = max(
 							$datetime_qty - $datetime->sold_and_reserved() + $sold_and_reserved_for_this_ticket,
 							0
@@ -990,16 +990,16 @@ 
 						$datetime_qty = ! $datetime->sold_out() ? $datetime_qty : 0;
 						//echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
 					}
-					$qty = min( $datetime_qty, $qty );
+					$qty = min($datetime_qty, $qty);
 					//echo "\n . . qty: " . $qty . '<br />';
 				}
 			}
 		}
 		// NOW that we know the  maximum number of tickets available for the datetime
 		// we can finally factor in the details for this specific ticket
-		if ( $qty > 0 && $context === 'saleable' ) {
+		if ($qty > 0 && $context === 'saleable') {
 			// and subtract the sales for THIS ticket
-			$qty = max( $qty - $sold_and_reserved_for_this_ticket, 0 );
+			$qty = max($qty - $sold_and_reserved_for_this_ticket, 0);
 			//echo "\n . qty: " . $qty . '<br />';
 		}
 		//echo "\nFINAL QTY: " . $qty . "<br /><br />";
@@ -1015,14 +1015,14 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function set_qty( $qty ) {
+	public function set_qty($qty) {
 		$datetimes = $this->datetimes();
-		foreach ( $datetimes as $datetime ) {
-			if ( $datetime instanceof EE_Datetime ) {
-				$qty = min( $qty, $datetime->reg_limit() );
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$qty = min($qty, $datetime->reg_limit());
 			}
 		}
-		$this->set( 'TKT_qty', $qty );
+		$this->set('TKT_qty', $qty);
 	}
 
 
@@ -1034,7 +1034,7 @@ 
      * @throws \EE_Error
      */
 	public function uses() {
-		return $this->get( 'TKT_uses' );
+		return $this->get('TKT_uses');
 	}
 
 
@@ -1046,8 +1046,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_uses( $uses ) {
-		$this->set( 'TKT_uses', $uses );
+	public function set_uses($uses) {
+		$this->set('TKT_uses', $uses);
 	}
 
 
@@ -1059,7 +1059,7 @@ 
      * @throws \EE_Error
      */
 	public function required() {
-		return $this->get( 'TKT_required' );
+		return $this->get('TKT_required');
 	}
 
 
@@ -1071,8 +1071,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_required( $required ) {
-		$this->set( 'TKT_required', $required );
+	public function set_required($required) {
+		$this->set('TKT_required', $required);
 	}
 
 
@@ -1084,7 +1084,7 @@ 
      * @throws \EE_Error
      */
 	public function taxable() {
-		return $this->get( 'TKT_taxable' );
+		return $this->get('TKT_taxable');
 	}
 
 
@@ -1096,8 +1096,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_taxable( $taxable ) {
-		$this->set( 'TKT_taxable', $taxable );
+	public function set_taxable($taxable) {
+		$this->set('TKT_taxable', $taxable);
 	}
 
 
@@ -1109,7 +1109,7 @@ 
      * @throws \EE_Error
      */
 	public function is_default() {
-		return $this->get( 'TKT_is_default' );
+		return $this->get('TKT_is_default');
 	}
 
 
@@ -1121,8 +1121,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_is_default( $is_default ) {
-		$this->set( 'TKT_is_default', $is_default );
+	public function set_is_default($is_default) {
+		$this->set('TKT_is_default', $is_default);
 	}
 
 
@@ -1134,7 +1134,7 @@ 
      * @throws \EE_Error
      */
 	public function order() {
-		return $this->get( 'TKT_order' );
+		return $this->get('TKT_order');
 	}
 
 
@@ -1146,8 +1146,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_order( $order ) {
-		$this->set( 'TKT_order', $order );
+	public function set_order($order) {
+		$this->set('TKT_order', $order);
 	}
 
 
@@ -1159,7 +1159,7 @@ 
      * @throws \EE_Error
      */
 	public function row() {
-		return $this->get( 'TKT_row' );
+		return $this->get('TKT_row');
 	}
 
 
@@ -1171,8 +1171,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_row( $row ) {
-		$this->set( 'TKT_row', $row );
+	public function set_row($row) {
+		$this->set('TKT_row', $row);
 	}
 
 
@@ -1184,7 +1184,7 @@ 
      * @throws \EE_Error
      */
 	public function deleted() {
-		return $this->get( 'TKT_deleted' );
+		return $this->get('TKT_deleted');
 	}
 
 
@@ -1196,8 +1196,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_deleted( $deleted ) {
-		$this->set( 'TKT_deleted', $deleted );
+	public function set_deleted($deleted) {
+		$this->set('TKT_deleted', $deleted);
 	}
 
 
@@ -1209,7 +1209,7 @@ 
      * @throws \EE_Error
      */
 	public function parent_ID() {
-		return $this->get( 'TKT_parent' );
+		return $this->get('TKT_parent');
 	}
 
 
@@ -1221,8 +1221,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_parent_ID( $parent ) {
-		$this->set( 'TKT_parent', $parent );
+	public function set_parent_ID($parent) {
+		$this->set('TKT_parent', $parent);
 	}
 
 
@@ -1235,10 +1235,10 @@ 
      */
 	public function name_and_info() {
 		$times = array();
-		foreach ( $this->datetimes() as $datetime ) {
+		foreach ($this->datetimes() as $datetime) {
 			$times[] = $datetime->start_date_and_time();
 		}
-		return $this->name() . ' @ ' . implode( ', ', $times ) . ' for ' . $this->pretty_price();
+		return $this->name().' @ '.implode(', ', $times).' for '.$this->pretty_price();
 	}
 
 
@@ -1250,7 +1250,7 @@ 
      * @throws \EE_Error
      */
 	public function name() {
-		return $this->get( 'TKT_name' );
+		return $this->get('TKT_name');
 	}
 
 
@@ -1262,7 +1262,7 @@ 
      * @throws \EE_Error
      */
 	public function price() {
-		return $this->get( 'TKT_price' );
+		return $this->get('TKT_price');
 	}
 
 
@@ -1274,8 +1274,8 @@ 
      * @return EE_Registration[]|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function registrations( $query_params = array() ) {
-		return $this->get_many_related( 'Registration', $query_params );
+	public function registrations($query_params = array()) {
+		return $this->get_many_related('Registration', $query_params);
 	}
 
 
@@ -1288,8 +1288,8 @@ 
      * @throws \EE_Error
      */
 	public function update_tickets_sold() {
-		$count_regs_for_this_ticket = $this->count_registrations( array( array( 'STS_ID' => EEM_Registration::status_id_approved, 'REG_deleted' => 0 ) ) );
-		$this->set_sold( $count_regs_for_this_ticket );
+		$count_regs_for_this_ticket = $this->count_registrations(array(array('STS_ID' => EEM_Registration::status_id_approved, 'REG_deleted' => 0)));
+		$this->set_sold($count_regs_for_this_ticket);
 		$this->save();
 		return $count_regs_for_this_ticket;
 	}
@@ -1301,7 +1301,7 @@ 
 	 * @param array $query_params like EEM_Base::get_all's
 	 * @return int
 	 */
-	public function count_registrations( $query_params = array() ) {
+	public function count_registrations($query_params = array()) {
 		return $this->count_related('Registration', $query_params);
 	}
 
@@ -1329,23 +1329,23 @@ 
 	public function get_related_event() {
 		//get one datetime to use for getting the event
 		$datetime = $this->first_datetime();
-		if ( ! $datetime instanceof \EE_Datetime ) {
+		if ( ! $datetime instanceof \EE_Datetime) {
 			throw new UnexpectedEntityException(
 				$datetime,
                 'EE_Datetime',
 				sprintf(
-					__( 'The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
+					__('The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
 					$datetime->name()
 				)
 			);
 		}
 		$event = $datetime->event();
-		if ( ! $event instanceof \EE_Event ) {
+		if ( ! $event instanceof \EE_Event) {
 			throw new UnexpectedEntityException(
 				$event,
                 'EE_Event',
 				sprintf(
-					__( 'The ticket (%s) is not associated with a valid event.', 'event_espresso'),
+					__('The ticket (%s) is not associated with a valid event.', 'event_espresso'),
 					$this->name()
 				)
 			);

Doc Comments +2 added lines, -1 removed lines

@@ -128,7 +128,8 @@
      *
      * @param bool        $display   true = we'll return a localized string, otherwise we just return the value of the relevant status const
      * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save further processing
-     * @return mixed status int if the display string isn't requested
+     * @param boolean $remaining
+     * @return string status int if the display string isn't requested
      * @throws \EE_Error
      */
 	public function ticket_status( $display = FALSE, $remaining = null ) {

core/helpers/EEH_Schema.helper.php

Spacing +28 added lines, -28 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -69,7 +69,7 @@ 
             $VNU_ID
         );
         extract($template_args, EXTR_OVERWRITE);
-        include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
+        include EE_TEMPLATES.'json_linked_data_for_event.template.php';
     }
 
 
@@ -82,8 +82,8 @@ 
 	 * @param string $location
 	 * @return string
 	 */
-	public static function location( $location = null ) {
-		return ! empty( $location ) ? '<div itemprop="location" itemscope itemtype="http://schema.org/Place">'
+	public static function location($location = null) {
+		return ! empty($location) ? '<div itemprop="location" itemscope itemtype="http://schema.org/Place">'
 		                              . $location
 		                              . '</div>' : '';
 	}
@@ -98,8 +98,8 @@ 
 	 * @param string $name
 	 * @return string
 	 */
-	public static function name( $name = null ) {
-		return ! empty( $name ) ? '<span itemprop="name">' . $name . '</span>' : '';
+	public static function name($name = null) {
+		return ! empty($name) ? '<span itemprop="name">'.$name.'</span>' : '';
 	}
 
 
@@ -112,9 +112,9 @@ 
 	 * @param EEI_Address $obj_with_address
 	 * @return string
 	 */
-	public static function streetAddress( EEI_Address $obj_with_address = null ) {
+	public static function streetAddress(EEI_Address $obj_with_address = null) {
 		return $obj_with_address->address() !== null && $obj_with_address->address() !== ''
-			? '<span itemprop="streetAddress">' . $obj_with_address->address() . '</span>' : '';
+			? '<span itemprop="streetAddress">'.$obj_with_address->address().'</span>' : '';
 	}
 
 
@@ -127,14 +127,14 @@ 
 	 * @param EEI_Address $obj_with_address
 	 * @return string
 	 */
-	public static function postOfficeBoxNumber( EEI_Address $obj_with_address = null ) {
+	public static function postOfficeBoxNumber(EEI_Address $obj_with_address = null) {
 		// regex check for some form of PO Box or P.O. Box, etc, etc, etc
-		if ( preg_match(
+		if (preg_match(
 			"/^\s*((P(OST)?.?\s*(O(FF(ICE)?)?)?.?\s+(B(IN|OX))?)|B(IN|OX))/i",
 			$obj_with_address->address2()
-		) ) {
+		)) {
 			return $obj_with_address->address2() !== null && $obj_with_address->address2() !== ''
-				? '<span itemprop="postOfficeBoxNumber">' . $obj_with_address->address2() . '</span>' : '';
+				? '<span itemprop="postOfficeBoxNumber">'.$obj_with_address->address2().'</span>' : '';
 		} else {
 			return $obj_with_address->address2();
 		}
@@ -150,9 +150,9 @@ 
 	 * @param EEI_Address $obj_with_address
 	 * @return string
 	 */
-	public static function addressLocality( EEI_Address $obj_with_address = null ) {
+	public static function addressLocality(EEI_Address $obj_with_address = null) {
 		return $obj_with_address->city() !== null && $obj_with_address->city() !== ''
-			? '<span itemprop="addressLocality">' . $obj_with_address->city() . '</span>' : '';
+			? '<span itemprop="addressLocality">'.$obj_with_address->city().'</span>' : '';
 	}
 
 
@@ -165,10 +165,10 @@ 
 	 * @param EEI_Address $obj_with_address
 	 * @return string
 	 */
-	public static function addressRegion( EEI_Address $obj_with_address = null ) {
+	public static function addressRegion(EEI_Address $obj_with_address = null) {
 		$state = $obj_with_address->state_name();
-		if ( ! empty( $state ) ) {
-			return '<span itemprop="addressRegion">' . $state . '</span>';
+		if ( ! empty($state)) {
+			return '<span itemprop="addressRegion">'.$state.'</span>';
 		} else {
 			return '';
 		}
@@ -184,10 +184,10 @@ 
 	 * @param EEI_Address $obj_with_address
 	 * @return string
 	 */
-	public static function addressCountry( EEI_Address $obj_with_address = null ) {
+	public static function addressCountry(EEI_Address $obj_with_address = null) {
 		$country = $obj_with_address->country_name();
-		if ( ! empty( $country ) ) {
-			return '<span itemprop="addressCountry">' . $country . '</span>';
+		if ( ! empty($country)) {
+			return '<span itemprop="addressCountry">'.$country.'</span>';
 		} else {
 			return '';
 		}
@@ -203,7 +203,7 @@ 
 	 * @param EEI_Address $obj_with_address
 	 * @return string
 	 */
-	public static function postalCode( EEI_Address $obj_with_address = null ) {
+	public static function postalCode(EEI_Address $obj_with_address = null) {
 		return $obj_with_address->zip() !== null && $obj_with_address->zip() !== '' ? '<span itemprop="postalCode">'
 		                                                                              . $obj_with_address->zip()
 		                                                                              . '</span>' : '';
@@ -219,8 +219,8 @@ 
 	 * @param string $phone_nmbr
 	 * @return string
 	 */
-	public static function telephone( $phone_nmbr = null ) {
-		return $phone_nmbr !== null && $phone_nmbr !== '' ? '<span itemprop="telephone">' . $phone_nmbr . '</span>'
+	public static function telephone($phone_nmbr = null) {
+		return $phone_nmbr !== null && $phone_nmbr !== '' ? '<span itemprop="telephone">'.$phone_nmbr.'</span>'
 			: '';
 	}
 
@@ -236,13 +236,13 @@ 
 	 * @param array  $attributes - array of additional link attributes in  attribute_name => value pairs. ie: array( 'title' => 'click here', 'class' => 'link-class' )
 	 * @return string (link)
 	 */
-	public static function url( $url = null, $text = null, $attributes = array() ) {
+	public static function url($url = null, $text = null, $attributes = array()) {
 		$atts = '';
-		foreach ( $attributes as $attribute => $value ) {
-			$atts .= ' ' . $attribute . '="' . $value . '"';
+		foreach ($attributes as $attribute => $value) {
+			$atts .= ' '.$attribute.'="'.$value.'"';
 		}
 		$text = $text !== null && $text !== '' ? $text : $url;
-		return $url !== null && $url !== '' ? '<a itemprop="url" href="' . $url . '"' . $atts . '>' . $text . '</a>'
+		return $url !== null && $url !== '' ? '<a itemprop="url" href="'.$url.'"'.$atts.'>'.$text.'</a>'
 			: '';
 	}
 

Indentation +60 added lines, -60 removed lines

@@ -17,62 +17,62 @@ 
 class EEH_Schema {
 
 
-    /**
-     * generates JSON-based linked data for an event
-     *
-     * @param \EE_Event $event
-     */
-    public static function add_json_linked_data_for_event(\EE_Event $event)
-    {
-        $template_args = array(
-            'event_permalink' => '',
-            'event_name' => '',
-            'event_description' => '',
-            'event_start' => '',
-            'event_end' => '',
-            'currency' => '',
-            'event_tickets' => array(),
-            'venue_name' => '',
-            'venue_url' => '',
-            'venue_locality' => '',
-            'venue_region' => '',
-            'event_image' => '',
-        );
-        $template_args['event_permalink'] = $event->get_permalink();
-        $template_args['event_name'] = $event->name();
-        $template_args['event_description'] = $event->description();
-        $template_args['event_start'] = $event->primary_datetime()->start_date(DateTime::ATOM);
-        $template_args['event_end'] = $event->primary_datetime()->end_date(DateTime::ATOM);
-        $template_args['currency'] = EE_Registry::instance()->CFG->currency->code;
-        foreach ($event->tickets() as $ticket) {
-            $ID = $ticket->ID();
-            $template_args['event_tickets'][$ID]['start_date'] = $ticket->start_date(DateTime::ATOM, null);
-            $template_args['event_tickets'][$ID]['end_date'] = $ticket->end_date(DateTime::ATOM, null);
-            $template_args['event_tickets'][$ID]['price'] = number_format(
-                $ticket->price(),
-                EE_Registry::instance()->CFG->currency->dec_plc,
-                EE_Registry::instance()->CFG->currency->dec_mrk,
-                EE_Registry::instance()->CFG->currency->thsnds
-            );
-        }
-        $VNU_ID = espresso_venue_id();
-        if ( ! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
-            $venue = EEH_Venue_View::get_venue($VNU_ID);
-            $template_args['venue_name'] = get_the_title($VNU_ID);
-            $template_args['venue_url'] = get_permalink($VNU_ID);
-            $template_args['venue_locality'] = $venue->city();
-            $template_args['venue_region'] = $venue->state_name();
-        }
-        $template_args['event_image'] = $event->feature_image_url();
-        $template_args = apply_filters(
-            'FHEE__EEH_Schema__add_json_linked_data_for_event__template_args',
-            $template_args,
-            $event,
-            $VNU_ID
-        );
-        extract($template_args, EXTR_OVERWRITE);
-        include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
-    }
+	/**
+	 * generates JSON-based linked data for an event
+	 *
+	 * @param \EE_Event $event
+	 */
+	public static function add_json_linked_data_for_event(\EE_Event $event)
+	{
+		$template_args = array(
+			'event_permalink' => '',
+			'event_name' => '',
+			'event_description' => '',
+			'event_start' => '',
+			'event_end' => '',
+			'currency' => '',
+			'event_tickets' => array(),
+			'venue_name' => '',
+			'venue_url' => '',
+			'venue_locality' => '',
+			'venue_region' => '',
+			'event_image' => '',
+		);
+		$template_args['event_permalink'] = $event->get_permalink();
+		$template_args['event_name'] = $event->name();
+		$template_args['event_description'] = $event->description();
+		$template_args['event_start'] = $event->primary_datetime()->start_date(DateTime::ATOM);
+		$template_args['event_end'] = $event->primary_datetime()->end_date(DateTime::ATOM);
+		$template_args['currency'] = EE_Registry::instance()->CFG->currency->code;
+		foreach ($event->tickets() as $ticket) {
+			$ID = $ticket->ID();
+			$template_args['event_tickets'][$ID]['start_date'] = $ticket->start_date(DateTime::ATOM, null);
+			$template_args['event_tickets'][$ID]['end_date'] = $ticket->end_date(DateTime::ATOM, null);
+			$template_args['event_tickets'][$ID]['price'] = number_format(
+				$ticket->price(),
+				EE_Registry::instance()->CFG->currency->dec_plc,
+				EE_Registry::instance()->CFG->currency->dec_mrk,
+				EE_Registry::instance()->CFG->currency->thsnds
+			);
+		}
+		$VNU_ID = espresso_venue_id();
+		if ( ! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
+			$venue = EEH_Venue_View::get_venue($VNU_ID);
+			$template_args['venue_name'] = get_the_title($VNU_ID);
+			$template_args['venue_url'] = get_permalink($VNU_ID);
+			$template_args['venue_locality'] = $venue->city();
+			$template_args['venue_region'] = $venue->state_name();
+		}
+		$template_args['event_image'] = $event->feature_image_url();
+		$template_args = apply_filters(
+			'FHEE__EEH_Schema__add_json_linked_data_for_event__template_args',
+			$template_args,
+			$event,
+			$VNU_ID
+		);
+		extract($template_args, EXTR_OVERWRITE);
+		include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
+	}
 
 
 	/**
@@ -86,8 +86,8 @@ 
 	 */
 	public static function location( $location = null ) {
 		return ! empty( $location ) ? '<div itemprop="location" itemscope itemtype="http://schema.org/Place">'
-		                              . $location
-		                              . '</div>' : '';
+									  . $location
+									  . '</div>' : '';
 	}
 
 
@@ -207,8 +207,8 @@ 
 	 */
 	public static function postalCode( EEI_Address $obj_with_address = null ) {
 		return $obj_with_address->zip() !== null && $obj_with_address->zip() !== '' ? '<span itemprop="postalCode">'
-		                                                                              . $obj_with_address->zip()
-		                                                                              . '</span>' : '';
+																					  . $obj_with_address->zip()
+																					  . '</span>' : '';
 	}
 
 

core/EE_Front_Controller.core.php

Indentation +681 added lines, -681 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -22,686 +22,686 @@ 
 final class EE_Front_Controller
 {
 
-    /**
-     *    $_template_path
-     * @var    string $_template_path
-     * @access    public
-     */
-    private $_template_path;
-
-    /**
-     *    $_template
-     * @var    string $_template
-     * @access    public
-     */
-    private $_template;
-
-    /**
-     * @type  EE_Registry $Registry
-     * @access    protected
-     */
-    protected $Registry;
-
-    /**
-     * @type  EE_Request_Handler $Request_Handler
-     * @access    protected
-     */
-    protected $Request_Handler;
-
-    /**
-     * @type  EE_Module_Request_Router $Module_Request_Router
-     * @access    protected
-     */
-    protected $Module_Request_Router;
-
-
-    /**
-     *    class constructor
-     *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
-     *
-     * @access    public
-     * @param \EE_Registry              $Registry
-     * @param \EE_Request_Handler       $Request_Handler
-     * @param \EE_Module_Request_Router $Module_Request_Router
-     */
-    public function __construct(
-        EE_Registry $Registry,
-        EE_Request_Handler $Request_Handler,
-        EE_Module_Request_Router $Module_Request_Router
-    ) {
-        $this->Registry              = $Registry;
-        $this->Request_Handler       = $Request_Handler;
-        $this->Module_Request_Router = $Module_Request_Router;
-        // make sure template tags are loaded immediately so that themes don't break
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'load_espresso_template_tags'), 10);
-        // determine how to integrate WP_Query with the EE models
-        add_action('AHEE__EE_System__initialize', array($this, 'employ_CPT_Strategy'));
-        // load other resources and begin to actually run shortcodes and modules
-        add_action('wp_loaded', array($this, 'wp_loaded'), 5);
-        // analyse the incoming WP request
-        add_action('parse_request', array($this, 'get_request'), 1, 1);
-        // process any content shortcodes
-        add_action('parse_request', array($this, '_initialize_shortcodes'), 5);
-        // process request with module factory
-        add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1);
-        // before headers sent
-        add_action('wp', array($this, 'wp'), 5);
-        // load css and js
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 1);
-        // header
-        add_action('wp_head', array($this, 'header_meta_tag'), 5);
-        add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10);
-        add_filter('template_include', array($this, 'template_include'), 1);
-        // display errors
-        add_action('loop_start', array($this, 'display_errors'), 2);
-        // the content
-        // add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
-        //exclude our private cpt comments
-        add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1);
-        //make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://)
-        add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1);
-        // action hook EE
-        do_action('AHEE__EE_Front_Controller__construct__done', $this);
-        // for checking that browser cookies are enabled
-        if (apply_filters('FHEE__EE_Front_Controller____construct__set_test_cookie', true)) {
-            setcookie('ee_cookie_test', uniqid(), time() + 24 * HOUR_IN_SECONDS, '/');
-        }
-    }
-
-
-    /**
-     * @return EE_Request_Handler
-     */
-    public function Request_Handler()
-    {
-        return $this->Request_Handler;
-    }
-
-
-    /**
-     * @return EE_Module_Request_Router
-     */
-    public function Module_Request_Router()
-    {
-        return $this->Module_Request_Router;
-    }
-
-
-
-
-
-    /***********************************************        INIT ACTION HOOK         ***********************************************/
-
-
-    /**
-     *    load_espresso_template_tags - if current theme is an espresso theme, or uses ee theme template parts, then
-     *    load it's functions.php file ( if not already loaded )
-     *
-     * @return void
-     */
-    public function load_espresso_template_tags()
-    {
-        if (is_readable(EE_PUBLIC . 'template_tags.php')) {
-            require_once(EE_PUBLIC . 'template_tags.php');
-        }
-    }
-
-
-    /**
-     * filter_wp_comments
-     * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
-     * widgets/queries done on frontend
-     *
-     * @param  array $clauses array of comment clauses setup by WP_Comment_Query
-     * @return array array of comment clauses with modifications.
-     */
-    public function filter_wp_comments($clauses)
-    {
-        global $wpdb;
-        if (strpos($clauses['join'], $wpdb->posts) !== false) {
-            $cpts = EE_Register_CPTs::get_private_CPTs();
-            foreach ($cpts as $cpt => $details) {
-                $clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
-            }
-        }
-        return $clauses;
-    }
-
-
-    /**
-     *    employ_CPT_Strategy
-     *
-     * @access    public
-     * @return    void
-     */
-    public function employ_CPT_Strategy()
-    {
-        if (apply_filters('FHEE__EE_Front_Controller__employ_CPT_Strategy', true)) {
-            $this->Registry->load_core('CPT_Strategy');
-        }
-    }
-
-
-    /**
-     * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
-     *
-     * @param  string $url incoming url
-     * @return string         final assembled url
-     */
-    public function maybe_force_admin_ajax_ssl($url)
-    {
-        if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
-            $url = str_replace('http://', 'https://', $url);
-        }
-        return $url;
-    }
-
-
-
-
-
-
-    /***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
-
-
-    /**
-     *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
-     *    default priority init phases have run
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-
-
-
-    /***********************************************        PARSE_REQUEST HOOK         ***********************************************/
-    /**
-     *    _get_request
-     *
-     * @access public
-     * @param WP $WP
-     * @return void
-     */
-    public function get_request(WP $WP)
-    {
-        do_action('AHEE__EE_Front_Controller__get_request__start');
-        $this->Request_Handler->parse_request($WP);
-        do_action('AHEE__EE_Front_Controller__get_request__complete');
-    }
-
-
-    /**
-     *    _initialize_shortcodes - calls init method on shortcodes that have been determined to be in the_content for
-     *    the currently requested page
-     *
-     * @access    public
-     * @param WP $WP
-     * @return    void
-     */
-    public function _initialize_shortcodes(WP $WP)
-    {
-        do_action('AHEE__EE_Front_Controller__initialize_shortcodes__begin', $WP, $this);
-        $this->Request_Handler->set_request_vars($WP);
-        // grab post_name from request
-        $current_post  = apply_filters('FHEE__EE_Front_Controller__initialize_shortcodes__current_post_name',
-            $this->Request_Handler->get('post_name'));
-        $show_on_front = get_option('show_on_front');
-        // if it's not set, then check if frontpage is blog
-        if (empty($current_post)) {
-            // yup.. this is the posts page, prepare to load all shortcode modules
-            $current_post = 'posts';
-            // unless..
-            if ($show_on_front === 'page') {
-                // some other page is set as the homepage
-                $page_on_front = get_option('page_on_front');
-                if ($page_on_front) {
-                    // k now we need to find the post_name for this page
-                    global $wpdb;
-                    $page_on_front = $wpdb->get_var(
-                        $wpdb->prepare(
-                            "SELECT post_name from $wpdb->posts WHERE post_type='page' AND post_status='publish' AND ID=%d",
-                            $page_on_front
-                        )
-                    );
-                    // set the current post slug to what it actually is
-                    $current_post = $page_on_front ? $page_on_front : $current_post;
-                }
-            }
-        }
-        // where are posts being displayed ?
-        $page_for_posts = EE_Config::get_page_for_posts();
-        // in case $current_post is hierarchical like: /parent-page/current-page
-        $current_post = basename($current_post);
-        // are we on a category page?
-        $term_exists = is_array(term_exists($current_post, 'category')) || array_key_exists('category_name',
-                $WP->query_vars);
-        // make sure shortcodes are set
-        if (isset($this->Registry->CFG->core->post_shortcodes)) {
-            if ( ! isset($this->Registry->CFG->core->post_shortcodes[$page_for_posts])) {
-                $this->Registry->CFG->core->post_shortcodes[$page_for_posts] = array();
-            }
-            // cycle thru all posts with shortcodes set
-            foreach ($this->Registry->CFG->core->post_shortcodes as $post_name => $post_shortcodes) {
-                // filter shortcodes so
-                $post_shortcodes = apply_filters('FHEE__Front_Controller__initialize_shortcodes__post_shortcodes',
-                    $post_shortcodes);
-                // now cycle thru shortcodes
-                foreach ($post_shortcodes as $shortcode_class => $post_id) {
-                    // are we on this page, or on the blog page, or an EE CPT category page ?
-                    if ($current_post === $post_name || $term_exists) {
-                        // maybe init the shortcode
-                        $this->initialize_shortcode_if_active_on_page(
-                            $shortcode_class,
-                            $current_post,
-                            $page_for_posts,
-                            $post_id,
-                            $term_exists,
-                            $WP
-                        );
-                        // if this is NOT the "Posts page" and we have a valid entry
-                        // for the "Posts page" in our tracked post_shortcodes array
-                        // but the shortcode is not being tracked for this page
-                    } else if (
-                        $post_name !== $page_for_posts
-                        && isset($this->Registry->CFG->core->post_shortcodes[$page_for_posts])
-                        && ! isset($this->Registry->CFG->core->post_shortcodes[$page_for_posts][$shortcode_class])
-                    ) {
-                        // then remove the "fallback" shortcode processor
-                        remove_shortcode($shortcode_class);
-                    }
-                }
-            }
-        }
-        do_action('AHEE__EE_Front_Controller__initialize_shortcodes__end', $this);
-    }
-
-
-    /**
-     * @param string $shortcode_class
-     * @param string $current_post
-     * @param string $page_for_posts
-     * @param int    $post_id
-     * @param bool   $term_exists
-     * @param WP     $WP
-     */
-    protected function initialize_shortcode_if_active_on_page(
-        $shortcode_class,
-        $current_post,
-        $page_for_posts,
-        $post_id,
-        $term_exists,
-        $WP
-    ) {
-        // verify shortcode is in list of registered shortcodes
-        if ( ! isset($this->Registry->shortcodes->{$shortcode_class})) {
-            if ($current_post !== $page_for_posts && current_user_can('edit_post', $post_id)) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'The [%s] shortcode has not been properly registered or the corresponding addon/module is not active for some reason. Either fix/remove the shortcode from the post, or activate the addon/module the shortcode is associated with.',
-                            'event_espresso'
-                        ),
-                        $shortcode_class
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                add_filter('FHEE_run_EE_the_content', '__return_true');
-            }
-            add_shortcode($shortcode_class, array('EES_Shortcode', 'invalid_shortcode_processor'));
-            return;
-        }
-        // is this : a shortcodes set exclusively for this post, or for the home page, or a category, or a taxonomy ?
-        if (
-            $term_exists
-            || $current_post === $page_for_posts
-            || isset($this->Registry->CFG->core->post_shortcodes[$current_post])
-        ) {
-            // let's pause to reflect on this...
-            $sc_reflector = new ReflectionClass('EES_' . $shortcode_class);
-            // ensure that class is actually a shortcode
-            if (
-                defined('WP_DEBUG')
-                && WP_DEBUG === true
-                && ! $sc_reflector->isSubclassOf('EES_Shortcode')
-            ) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'The requested %s shortcode is not of the class "EES_Shortcode". Please check your files.',
-                            'event_espresso'
-                        ),
-                        $shortcode_class
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                add_filter('FHEE_run_EE_the_content', '__return_true');
-                return;
-            }
-            // and pass the request object to the run method
-            $this->Registry->shortcodes->{$shortcode_class} = $sc_reflector->newInstance();
-            // fire the shortcode class's run method, so that it can activate resources
-            $this->Registry->shortcodes->{$shortcode_class}->run($WP);
-        }
-    }
-
-
-    /**
-     *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
-     *
-     * @access    public
-     * @param   WP_Query $WP_Query
-     * @return    void
-     */
-    public function pre_get_posts($WP_Query)
-    {
-        // only load Module_Request_Router if this is the main query
-        if (
-            $this->Module_Request_Router instanceof EE_Module_Request_Router
-            && $WP_Query->is_main_query()
-        ) {
-            // cycle thru module routes
-            while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
-                // determine module and method for route
-                $module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
-                if ($module instanceof EED_Module) {
-                    // get registered view for route
-                    $this->_template_path = $this->Module_Request_Router->get_view($route);
-                    // grab module name
-                    $module_name = $module->module_name();
-                    // map the module to the module objects
-                    $this->Registry->modules->{$module_name} = $module;
-                }
-            }
-        }
-    }
-
-
-
-
-
-    /***********************************************        WP HOOK         ***********************************************/
-
-
-    /**
-     *    wp - basically last chance to do stuff before headers sent
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp()
-    {
-    }
-
-
-
-    /***********************************************        WP_ENQUEUE_SCRIPTS && WP_HEAD HOOK         ***********************************************/
-
-
-    /**
-     *    wp_enqueue_scripts
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_enqueue_scripts()
-    {
-
-        // css is turned ON by default, but prior to the wp_enqueue_scripts hook, can be turned OFF  via:  add_filter( 'FHEE_load_css', '__return_false' );
-        if (apply_filters('FHEE_load_css', true)) {
-
-            $this->Registry->CFG->template_settings->enable_default_style = true;
-            //Load the ThemeRoller styles if enabled
-            if (isset($this->Registry->CFG->template_settings->enable_default_style) && $this->Registry->CFG->template_settings->enable_default_style) {
-
-                //Load custom style sheet if available
-                if (isset($this->Registry->CFG->template_settings->custom_style_sheet)) {
-                    wp_register_style('espresso_custom_css',
-                        EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->Registry->CFG->template_settings->custom_style_sheet,
-                        EVENT_ESPRESSO_VERSION);
-                    wp_enqueue_style('espresso_custom_css');
-                }
-
-                if (is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')) {
-                    wp_register_style('espresso_default', EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css',
-                        array('dashicons'), EVENT_ESPRESSO_VERSION);
-                } else {
-                    wp_register_style('espresso_default', EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
-                        array('dashicons'), EVENT_ESPRESSO_VERSION);
-                }
-                wp_enqueue_style('espresso_default');
-
-                if (is_readable(get_stylesheet_directory() . EE_Config::get_current_theme() . DS . 'style.css')) {
-                    wp_register_style('espresso_style',
-                        get_stylesheet_directory_uri() . EE_Config::get_current_theme() . DS . 'style.css',
-                        array('dashicons', 'espresso_default'));
-                } else {
-                    wp_register_style('espresso_style',
-                        EE_TEMPLATES_URL . EE_Config::get_current_theme() . DS . 'style.css',
-                        array('dashicons', 'espresso_default'));
-                }
-
-            }
-
-        }
-
-        // js is turned ON by default, but prior to the wp_enqueue_scripts hook, can be turned OFF  via:  add_filter( 'FHEE_load_js', '__return_false' );
-        if (apply_filters('FHEE_load_js', true)) {
-
-            wp_enqueue_script('jquery');
-            //let's make sure that all required scripts have been setup
-            if (function_exists('wp_script_is') && ! wp_script_is('jquery')) {
-                $msg = sprintf(
-                    __('%sJquery is not loaded!%sEvent Espresso is unable to load Jquery due to a conflict with your theme or another plugin.',
-                        'event_espresso'),
-                    '<em><br />',
-                    '</em>'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-            // load core js
-            wp_register_script('espresso_core', EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', array('jquery'),
-                EVENT_ESPRESSO_VERSION, true);
-            wp_enqueue_script('espresso_core');
-            wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings);
-
-        }
-
-        //qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook, can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
-        if (apply_filters('FHEE_load_qtip', false)) {
-            EEH_Qtip_Loader::instance()->register_and_enqueue();
-        }
-
-
-        //accounting.js library
-        // @link http://josscrowcroft.github.io/accounting.js/
-        if (apply_filters('FHEE_load_accounting_js', false)) {
-            $acct_js = EE_THIRD_PARTY_URL . 'accounting/accounting.js';
-            wp_register_script('ee-accounting', EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
-                array('ee-accounting-core'), EVENT_ESPRESSO_VERSION, true);
-            wp_register_script('ee-accounting-core', $acct_js, array('underscore'), '0.3.2', true);
-            wp_enqueue_script('ee-accounting');
-
-            $currency_config = array(
-                'currency' => array(
-                    'symbol'    => $this->Registry->CFG->currency->sign,
-                    'format'    => array(
-                        'pos'  => $this->Registry->CFG->currency->sign_b4 ? '%s%v' : '%v%s',
-                        'neg'  => $this->Registry->CFG->currency->sign_b4 ? '- %s%v' : '- %v%s',
-                        'zero' => $this->Registry->CFG->currency->sign_b4 ? '%s--' : '--%s',
-                    ),
-                    'decimal'   => $this->Registry->CFG->currency->dec_mrk,
-                    'thousand'  => $this->Registry->CFG->currency->thsnds,
-                    'precision' => $this->Registry->CFG->currency->dec_plc,
-                ),
-                'number'   => array(
-                    'precision' => 0,
-                    'thousand'  => $this->Registry->CFG->currency->thsnds,
-                    'decimal'   => $this->Registry->CFG->currency->dec_mrk,
-                ),
-            );
-            wp_localize_script('ee-accounting', 'EE_ACCOUNTING_CFG', $currency_config);
-        }
-
-        if ( ! function_exists('wp_head')) {
-            $msg = sprintf(
-                __('%sMissing wp_head() function.%sThe WordPress function wp_head() seems to be missing in your theme. Please contact the theme developer to make sure this is fixed before using Event Espresso.',
-                    'event_espresso'),
-                '<em><br />',
-                '</em>'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        if ( ! function_exists('wp_footer')) {
-            $msg = sprintf(
-                __('%sMissing wp_footer() function.%sThe WordPress function wp_footer() seems to be missing in your theme. Please contact the theme developer to make sure this is fixed before using Event Espresso.',
-                    'event_espresso'),
-                '<em><br />',
-                '</em>'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-
-    }
-
-
-    /**
-     *    header_meta_tag
-     *
-     * @access    public
-     * @return    void
-     */
-    public function header_meta_tag()
-    {
-        print(
-            apply_filters(
-                'FHEE__EE_Front_Controller__header_meta_tag',
-                '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n")
-        );
-
-        //let's exclude all event type taxonomy term archive pages from search engine indexing
-        //@see https://events.codebasehq.com/projects/event-espresso/tickets/10249
-        if (
-            is_tax('espresso_event_type')
-            && get_option( 'blog_public' ) !== '0'
-        ) {
-            print(
-                apply_filters(
-                    'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
-                    '<meta name="robots" content="noindex,follow" />' . "\n"
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * wp_print_scripts
-     *
-     * @return void
-     */
-    public function wp_print_scripts()
-    {
-        global $post;
-        if (get_post_type() === 'espresso_events' && is_singular()) {
-            \EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
-        }
-    }
-
-
-
-    /***********************************************        THE_CONTENT FILTER HOOK         ***********************************************/
-
-
-
-    /**
-     *    the_content
-     *
-     * @access    public
-     * @param   $the_content
-     * @return    string
-     */
-    // public function the_content( $the_content ) {
-    // 	// nothing gets loaded at this point unless other systems turn this hookpoint on by using:  add_filter( 'FHEE_run_EE_the_content', '__return_true' );
-    // 	if ( apply_filters( 'FHEE_run_EE_the_content', FALSE ) ) {
-    // 	}
-    // 	return $the_content;
-    // }
-
-
-    /***********************************************        WP_FOOTER         ***********************************************/
-
-
-    /**
-     *    display_errors
-     *
-     * @access    public
-     * @return    string
-     */
-    public function display_errors()
-    {
-        static $shown_already = false;
-        do_action('AHEE__EE_Front_Controller__display_errors__begin');
-        if (
-            ! $shown_already
-            && apply_filters('FHEE__EE_Front_Controller__display_errors', true)
-            && is_main_query()
-            && ! is_feed()
-            && in_the_loop()
-            && $this->Request_Handler->is_espresso_page()
-        ) {
-            echo EE_Error::get_notices();
-            $shown_already = true;
-            EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
-        }
-        do_action('AHEE__EE_Front_Controller__display_errors__end');
-    }
-
-
-
-
-
-    /***********************************************        UTILITIES         ***********************************************/
-    /**
-     *    template_include
-     *
-     * @access    public
-     * @param   string $template_include_path
-     * @return    string
-     */
-    public function template_include($template_include_path = null)
-    {
-        if ($this->Request_Handler->is_espresso_page()) {
-            $this->_template_path = ! empty($this->_template_path) ? basename($this->_template_path) : basename($template_include_path);
-            $template_path        = EEH_Template::locate_template($this->_template_path, array(), false);
-            $this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
-            $this->_template      = basename($this->_template_path);
-            return $this->_template_path;
-        }
-        return $template_include_path;
-    }
-
-
-    /**
-     *    get_selected_template
-     *
-     * @access    public
-     * @param bool $with_path
-     * @return    string
-     */
-    public function get_selected_template($with_path = false)
-    {
-        return $with_path ? $this->_template_path : $this->_template;
-    }
+	/**
+	 *    $_template_path
+	 * @var    string $_template_path
+	 * @access    public
+	 */
+	private $_template_path;
+
+	/**
+	 *    $_template
+	 * @var    string $_template
+	 * @access    public
+	 */
+	private $_template;
+
+	/**
+	 * @type  EE_Registry $Registry
+	 * @access    protected
+	 */
+	protected $Registry;
+
+	/**
+	 * @type  EE_Request_Handler $Request_Handler
+	 * @access    protected
+	 */
+	protected $Request_Handler;
+
+	/**
+	 * @type  EE_Module_Request_Router $Module_Request_Router
+	 * @access    protected
+	 */
+	protected $Module_Request_Router;
+
+
+	/**
+	 *    class constructor
+	 *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
+	 *
+	 * @access    public
+	 * @param \EE_Registry              $Registry
+	 * @param \EE_Request_Handler       $Request_Handler
+	 * @param \EE_Module_Request_Router $Module_Request_Router
+	 */
+	public function __construct(
+		EE_Registry $Registry,
+		EE_Request_Handler $Request_Handler,
+		EE_Module_Request_Router $Module_Request_Router
+	) {
+		$this->Registry              = $Registry;
+		$this->Request_Handler       = $Request_Handler;
+		$this->Module_Request_Router = $Module_Request_Router;
+		// make sure template tags are loaded immediately so that themes don't break
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'load_espresso_template_tags'), 10);
+		// determine how to integrate WP_Query with the EE models
+		add_action('AHEE__EE_System__initialize', array($this, 'employ_CPT_Strategy'));
+		// load other resources and begin to actually run shortcodes and modules
+		add_action('wp_loaded', array($this, 'wp_loaded'), 5);
+		// analyse the incoming WP request
+		add_action('parse_request', array($this, 'get_request'), 1, 1);
+		// process any content shortcodes
+		add_action('parse_request', array($this, '_initialize_shortcodes'), 5);
+		// process request with module factory
+		add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1);
+		// before headers sent
+		add_action('wp', array($this, 'wp'), 5);
+		// load css and js
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 1);
+		// header
+		add_action('wp_head', array($this, 'header_meta_tag'), 5);
+		add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10);
+		add_filter('template_include', array($this, 'template_include'), 1);
+		// display errors
+		add_action('loop_start', array($this, 'display_errors'), 2);
+		// the content
+		// add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
+		//exclude our private cpt comments
+		add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1);
+		//make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://)
+		add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1);
+		// action hook EE
+		do_action('AHEE__EE_Front_Controller__construct__done', $this);
+		// for checking that browser cookies are enabled
+		if (apply_filters('FHEE__EE_Front_Controller____construct__set_test_cookie', true)) {
+			setcookie('ee_cookie_test', uniqid(), time() + 24 * HOUR_IN_SECONDS, '/');
+		}
+	}
+
+
+	/**
+	 * @return EE_Request_Handler
+	 */
+	public function Request_Handler()
+	{
+		return $this->Request_Handler;
+	}
+
+
+	/**
+	 * @return EE_Module_Request_Router
+	 */
+	public function Module_Request_Router()
+	{
+		return $this->Module_Request_Router;
+	}
+
+
+
+
+
+	/***********************************************        INIT ACTION HOOK         ***********************************************/
+
+
+	/**
+	 *    load_espresso_template_tags - if current theme is an espresso theme, or uses ee theme template parts, then
+	 *    load it's functions.php file ( if not already loaded )
+	 *
+	 * @return void
+	 */
+	public function load_espresso_template_tags()
+	{
+		if (is_readable(EE_PUBLIC . 'template_tags.php')) {
+			require_once(EE_PUBLIC . 'template_tags.php');
+		}
+	}
+
+
+	/**
+	 * filter_wp_comments
+	 * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
+	 * widgets/queries done on frontend
+	 *
+	 * @param  array $clauses array of comment clauses setup by WP_Comment_Query
+	 * @return array array of comment clauses with modifications.
+	 */
+	public function filter_wp_comments($clauses)
+	{
+		global $wpdb;
+		if (strpos($clauses['join'], $wpdb->posts) !== false) {
+			$cpts = EE_Register_CPTs::get_private_CPTs();
+			foreach ($cpts as $cpt => $details) {
+				$clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
+			}
+		}
+		return $clauses;
+	}
+
+
+	/**
+	 *    employ_CPT_Strategy
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function employ_CPT_Strategy()
+	{
+		if (apply_filters('FHEE__EE_Front_Controller__employ_CPT_Strategy', true)) {
+			$this->Registry->load_core('CPT_Strategy');
+		}
+	}
+
+
+	/**
+	 * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
+	 *
+	 * @param  string $url incoming url
+	 * @return string         final assembled url
+	 */
+	public function maybe_force_admin_ajax_ssl($url)
+	{
+		if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
+			$url = str_replace('http://', 'https://', $url);
+		}
+		return $url;
+	}
+
+
+
+
+
+
+	/***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
+
+
+	/**
+	 *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
+	 *    default priority init phases have run
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+
+
+
+	/***********************************************        PARSE_REQUEST HOOK         ***********************************************/
+	/**
+	 *    _get_request
+	 *
+	 * @access public
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function get_request(WP $WP)
+	{
+		do_action('AHEE__EE_Front_Controller__get_request__start');
+		$this->Request_Handler->parse_request($WP);
+		do_action('AHEE__EE_Front_Controller__get_request__complete');
+	}
+
+
+	/**
+	 *    _initialize_shortcodes - calls init method on shortcodes that have been determined to be in the_content for
+	 *    the currently requested page
+	 *
+	 * @access    public
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function _initialize_shortcodes(WP $WP)
+	{
+		do_action('AHEE__EE_Front_Controller__initialize_shortcodes__begin', $WP, $this);
+		$this->Request_Handler->set_request_vars($WP);
+		// grab post_name from request
+		$current_post  = apply_filters('FHEE__EE_Front_Controller__initialize_shortcodes__current_post_name',
+			$this->Request_Handler->get('post_name'));
+		$show_on_front = get_option('show_on_front');
+		// if it's not set, then check if frontpage is blog
+		if (empty($current_post)) {
+			// yup.. this is the posts page, prepare to load all shortcode modules
+			$current_post = 'posts';
+			// unless..
+			if ($show_on_front === 'page') {
+				// some other page is set as the homepage
+				$page_on_front = get_option('page_on_front');
+				if ($page_on_front) {
+					// k now we need to find the post_name for this page
+					global $wpdb;
+					$page_on_front = $wpdb->get_var(
+						$wpdb->prepare(
+							"SELECT post_name from $wpdb->posts WHERE post_type='page' AND post_status='publish' AND ID=%d",
+							$page_on_front
+						)
+					);
+					// set the current post slug to what it actually is
+					$current_post = $page_on_front ? $page_on_front : $current_post;
+				}
+			}
+		}
+		// where are posts being displayed ?
+		$page_for_posts = EE_Config::get_page_for_posts();
+		// in case $current_post is hierarchical like: /parent-page/current-page
+		$current_post = basename($current_post);
+		// are we on a category page?
+		$term_exists = is_array(term_exists($current_post, 'category')) || array_key_exists('category_name',
+				$WP->query_vars);
+		// make sure shortcodes are set
+		if (isset($this->Registry->CFG->core->post_shortcodes)) {
+			if ( ! isset($this->Registry->CFG->core->post_shortcodes[$page_for_posts])) {
+				$this->Registry->CFG->core->post_shortcodes[$page_for_posts] = array();
+			}
+			// cycle thru all posts with shortcodes set
+			foreach ($this->Registry->CFG->core->post_shortcodes as $post_name => $post_shortcodes) {
+				// filter shortcodes so
+				$post_shortcodes = apply_filters('FHEE__Front_Controller__initialize_shortcodes__post_shortcodes',
+					$post_shortcodes);
+				// now cycle thru shortcodes
+				foreach ($post_shortcodes as $shortcode_class => $post_id) {
+					// are we on this page, or on the blog page, or an EE CPT category page ?
+					if ($current_post === $post_name || $term_exists) {
+						// maybe init the shortcode
+						$this->initialize_shortcode_if_active_on_page(
+							$shortcode_class,
+							$current_post,
+							$page_for_posts,
+							$post_id,
+							$term_exists,
+							$WP
+						);
+						// if this is NOT the "Posts page" and we have a valid entry
+						// for the "Posts page" in our tracked post_shortcodes array
+						// but the shortcode is not being tracked for this page
+					} else if (
+						$post_name !== $page_for_posts
+						&& isset($this->Registry->CFG->core->post_shortcodes[$page_for_posts])
+						&& ! isset($this->Registry->CFG->core->post_shortcodes[$page_for_posts][$shortcode_class])
+					) {
+						// then remove the "fallback" shortcode processor
+						remove_shortcode($shortcode_class);
+					}
+				}
+			}
+		}
+		do_action('AHEE__EE_Front_Controller__initialize_shortcodes__end', $this);
+	}
+
+
+	/**
+	 * @param string $shortcode_class
+	 * @param string $current_post
+	 * @param string $page_for_posts
+	 * @param int    $post_id
+	 * @param bool   $term_exists
+	 * @param WP     $WP
+	 */
+	protected function initialize_shortcode_if_active_on_page(
+		$shortcode_class,
+		$current_post,
+		$page_for_posts,
+		$post_id,
+		$term_exists,
+		$WP
+	) {
+		// verify shortcode is in list of registered shortcodes
+		if ( ! isset($this->Registry->shortcodes->{$shortcode_class})) {
+			if ($current_post !== $page_for_posts && current_user_can('edit_post', $post_id)) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'The [%s] shortcode has not been properly registered or the corresponding addon/module is not active for some reason. Either fix/remove the shortcode from the post, or activate the addon/module the shortcode is associated with.',
+							'event_espresso'
+						),
+						$shortcode_class
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				add_filter('FHEE_run_EE_the_content', '__return_true');
+			}
+			add_shortcode($shortcode_class, array('EES_Shortcode', 'invalid_shortcode_processor'));
+			return;
+		}
+		// is this : a shortcodes set exclusively for this post, or for the home page, or a category, or a taxonomy ?
+		if (
+			$term_exists
+			|| $current_post === $page_for_posts
+			|| isset($this->Registry->CFG->core->post_shortcodes[$current_post])
+		) {
+			// let's pause to reflect on this...
+			$sc_reflector = new ReflectionClass('EES_' . $shortcode_class);
+			// ensure that class is actually a shortcode
+			if (
+				defined('WP_DEBUG')
+				&& WP_DEBUG === true
+				&& ! $sc_reflector->isSubclassOf('EES_Shortcode')
+			) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'The requested %s shortcode is not of the class "EES_Shortcode". Please check your files.',
+							'event_espresso'
+						),
+						$shortcode_class
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				add_filter('FHEE_run_EE_the_content', '__return_true');
+				return;
+			}
+			// and pass the request object to the run method
+			$this->Registry->shortcodes->{$shortcode_class} = $sc_reflector->newInstance();
+			// fire the shortcode class's run method, so that it can activate resources
+			$this->Registry->shortcodes->{$shortcode_class}->run($WP);
+		}
+	}
+
+
+	/**
+	 *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
+	 *
+	 * @access    public
+	 * @param   WP_Query $WP_Query
+	 * @return    void
+	 */
+	public function pre_get_posts($WP_Query)
+	{
+		// only load Module_Request_Router if this is the main query
+		if (
+			$this->Module_Request_Router instanceof EE_Module_Request_Router
+			&& $WP_Query->is_main_query()
+		) {
+			// cycle thru module routes
+			while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
+				// determine module and method for route
+				$module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
+				if ($module instanceof EED_Module) {
+					// get registered view for route
+					$this->_template_path = $this->Module_Request_Router->get_view($route);
+					// grab module name
+					$module_name = $module->module_name();
+					// map the module to the module objects
+					$this->Registry->modules->{$module_name} = $module;
+				}
+			}
+		}
+	}
+
+
+
+
+
+	/***********************************************        WP HOOK         ***********************************************/
+
+
+	/**
+	 *    wp - basically last chance to do stuff before headers sent
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp()
+	{
+	}
+
+
+
+	/***********************************************        WP_ENQUEUE_SCRIPTS && WP_HEAD HOOK         ***********************************************/
+
+
+	/**
+	 *    wp_enqueue_scripts
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_enqueue_scripts()
+	{
+
+		// css is turned ON by default, but prior to the wp_enqueue_scripts hook, can be turned OFF  via:  add_filter( 'FHEE_load_css', '__return_false' );
+		if (apply_filters('FHEE_load_css', true)) {
+
+			$this->Registry->CFG->template_settings->enable_default_style = true;
+			//Load the ThemeRoller styles if enabled
+			if (isset($this->Registry->CFG->template_settings->enable_default_style) && $this->Registry->CFG->template_settings->enable_default_style) {
+
+				//Load custom style sheet if available
+				if (isset($this->Registry->CFG->template_settings->custom_style_sheet)) {
+					wp_register_style('espresso_custom_css',
+						EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->Registry->CFG->template_settings->custom_style_sheet,
+						EVENT_ESPRESSO_VERSION);
+					wp_enqueue_style('espresso_custom_css');
+				}
+
+				if (is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')) {
+					wp_register_style('espresso_default', EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css',
+						array('dashicons'), EVENT_ESPRESSO_VERSION);
+				} else {
+					wp_register_style('espresso_default', EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+						array('dashicons'), EVENT_ESPRESSO_VERSION);
+				}
+				wp_enqueue_style('espresso_default');
+
+				if (is_readable(get_stylesheet_directory() . EE_Config::get_current_theme() . DS . 'style.css')) {
+					wp_register_style('espresso_style',
+						get_stylesheet_directory_uri() . EE_Config::get_current_theme() . DS . 'style.css',
+						array('dashicons', 'espresso_default'));
+				} else {
+					wp_register_style('espresso_style',
+						EE_TEMPLATES_URL . EE_Config::get_current_theme() . DS . 'style.css',
+						array('dashicons', 'espresso_default'));
+				}
+
+			}
+
+		}
+
+		// js is turned ON by default, but prior to the wp_enqueue_scripts hook, can be turned OFF  via:  add_filter( 'FHEE_load_js', '__return_false' );
+		if (apply_filters('FHEE_load_js', true)) {
+
+			wp_enqueue_script('jquery');
+			//let's make sure that all required scripts have been setup
+			if (function_exists('wp_script_is') && ! wp_script_is('jquery')) {
+				$msg = sprintf(
+					__('%sJquery is not loaded!%sEvent Espresso is unable to load Jquery due to a conflict with your theme or another plugin.',
+						'event_espresso'),
+					'<em><br />',
+					'</em>'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+			// load core js
+			wp_register_script('espresso_core', EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', array('jquery'),
+				EVENT_ESPRESSO_VERSION, true);
+			wp_enqueue_script('espresso_core');
+			wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings);
+
+		}
+
+		//qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook, can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
+		if (apply_filters('FHEE_load_qtip', false)) {
+			EEH_Qtip_Loader::instance()->register_and_enqueue();
+		}
+
+
+		//accounting.js library
+		// @link http://josscrowcroft.github.io/accounting.js/
+		if (apply_filters('FHEE_load_accounting_js', false)) {
+			$acct_js = EE_THIRD_PARTY_URL . 'accounting/accounting.js';
+			wp_register_script('ee-accounting', EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
+				array('ee-accounting-core'), EVENT_ESPRESSO_VERSION, true);
+			wp_register_script('ee-accounting-core', $acct_js, array('underscore'), '0.3.2', true);
+			wp_enqueue_script('ee-accounting');
+
+			$currency_config = array(
+				'currency' => array(
+					'symbol'    => $this->Registry->CFG->currency->sign,
+					'format'    => array(
+						'pos'  => $this->Registry->CFG->currency->sign_b4 ? '%s%v' : '%v%s',
+						'neg'  => $this->Registry->CFG->currency->sign_b4 ? '- %s%v' : '- %v%s',
+						'zero' => $this->Registry->CFG->currency->sign_b4 ? '%s--' : '--%s',
+					),
+					'decimal'   => $this->Registry->CFG->currency->dec_mrk,
+					'thousand'  => $this->Registry->CFG->currency->thsnds,
+					'precision' => $this->Registry->CFG->currency->dec_plc,
+				),
+				'number'   => array(
+					'precision' => 0,
+					'thousand'  => $this->Registry->CFG->currency->thsnds,
+					'decimal'   => $this->Registry->CFG->currency->dec_mrk,
+				),
+			);
+			wp_localize_script('ee-accounting', 'EE_ACCOUNTING_CFG', $currency_config);
+		}
+
+		if ( ! function_exists('wp_head')) {
+			$msg = sprintf(
+				__('%sMissing wp_head() function.%sThe WordPress function wp_head() seems to be missing in your theme. Please contact the theme developer to make sure this is fixed before using Event Espresso.',
+					'event_espresso'),
+				'<em><br />',
+				'</em>'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		if ( ! function_exists('wp_footer')) {
+			$msg = sprintf(
+				__('%sMissing wp_footer() function.%sThe WordPress function wp_footer() seems to be missing in your theme. Please contact the theme developer to make sure this is fixed before using Event Espresso.',
+					'event_espresso'),
+				'<em><br />',
+				'</em>'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+
+	}
+
+
+	/**
+	 *    header_meta_tag
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function header_meta_tag()
+	{
+		print(
+			apply_filters(
+				'FHEE__EE_Front_Controller__header_meta_tag',
+				'<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n")
+		);
+
+		//let's exclude all event type taxonomy term archive pages from search engine indexing
+		//@see https://events.codebasehq.com/projects/event-espresso/tickets/10249
+		if (
+			is_tax('espresso_event_type')
+			&& get_option( 'blog_public' ) !== '0'
+		) {
+			print(
+				apply_filters(
+					'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
+					'<meta name="robots" content="noindex,follow" />' . "\n"
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * wp_print_scripts
+	 *
+	 * @return void
+	 */
+	public function wp_print_scripts()
+	{
+		global $post;
+		if (get_post_type() === 'espresso_events' && is_singular()) {
+			\EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
+		}
+	}
+
+
+
+	/***********************************************        THE_CONTENT FILTER HOOK         ***********************************************/
+
+
+
+	/**
+	 *    the_content
+	 *
+	 * @access    public
+	 * @param   $the_content
+	 * @return    string
+	 */
+	// public function the_content( $the_content ) {
+	// 	// nothing gets loaded at this point unless other systems turn this hookpoint on by using:  add_filter( 'FHEE_run_EE_the_content', '__return_true' );
+	// 	if ( apply_filters( 'FHEE_run_EE_the_content', FALSE ) ) {
+	// 	}
+	// 	return $the_content;
+	// }
+
+
+	/***********************************************        WP_FOOTER         ***********************************************/
+
+
+	/**
+	 *    display_errors
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function display_errors()
+	{
+		static $shown_already = false;
+		do_action('AHEE__EE_Front_Controller__display_errors__begin');
+		if (
+			! $shown_already
+			&& apply_filters('FHEE__EE_Front_Controller__display_errors', true)
+			&& is_main_query()
+			&& ! is_feed()
+			&& in_the_loop()
+			&& $this->Request_Handler->is_espresso_page()
+		) {
+			echo EE_Error::get_notices();
+			$shown_already = true;
+			EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
+		}
+		do_action('AHEE__EE_Front_Controller__display_errors__end');
+	}
+
+
+
+
+
+	/***********************************************        UTILITIES         ***********************************************/
+	/**
+	 *    template_include
+	 *
+	 * @access    public
+	 * @param   string $template_include_path
+	 * @return    string
+	 */
+	public function template_include($template_include_path = null)
+	{
+		if ($this->Request_Handler->is_espresso_page()) {
+			$this->_template_path = ! empty($this->_template_path) ? basename($this->_template_path) : basename($template_include_path);
+			$template_path        = EEH_Template::locate_template($this->_template_path, array(), false);
+			$this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
+			$this->_template      = basename($this->_template_path);
+			return $this->_template_path;
+		}
+		return $template_include_path;
+	}
+
+
+	/**
+	 *    get_selected_template
+	 *
+	 * @access    public
+	 * @param bool $with_path
+	 * @return    string
+	 */
+	public function get_selected_template($with_path = false)
+	{
+		return $with_path ? $this->_template_path : $this->_template;
+	}
 
 
 }

core/templates/json_linked_data_for_event.template.php

Indentation +2 added lines, -2 removed lines

@@ -31,8 +31,8 @@
       "price": "<?php echo $ticket['price'] ?>",
       "priceCurrency": "<?php echo $currency ?>"
     }<?php if (is_array($event_tickets) && end($event_tickets) !== $ticket) { echo ','; }
-    }
-    ?>
+	}
+	?>
     ]<?php if ($venue_name) { ?>,
   "location": {
     "@type": "Place",

core/db_classes/EE_Base_Class.class.php

Doc Comments +9 added lines, -8 removed lines

@@ -574,7 +574,7 @@ 
      *
      * @param \EE_Datetime_Field $datetime_field
      * @param bool               $pretty
-     * @param null $date_or_time
+     * @param string|null $date_or_time
      * @return void
      * @throws \EE_Error
      */
@@ -892,7 +892,7 @@ 
      *
      * @param null  $field_to_order_by  What field is being used as the reference point.
      * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+     * @param string  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
      *                                  you can indicate just the columns you want returned
      * @return array|EE_Base_Class
      * @throws \EE_Error
@@ -917,7 +917,7 @@ 
      *
      * @param null  $field_to_order_by  What field is being used as the reference point.
      * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
+     * @param string  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
      *                                  you can indicate just the column you want returned
      * @return array|EE_Base_Class
      * @throws \EE_Error
@@ -990,7 +990,7 @@ 
      * This method simply returns the RAW unprocessed value for the given property in this class
      *
      * @param  string $field_name A valid fieldname
-     * @return mixed              Whatever the raw value stored on the property is.
+     * @return integer|null              Whatever the raw value stored on the property is.
      * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
      */
     public function get_raw($field_name)
@@ -1256,7 +1256,7 @@ 
      * sets the time on a datetime property
      *
      * @access protected
-     * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
+     * @param string $time      a valid time string for php datetime functions (or DateTime object)
      * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
      * @throws \EE_Error
      */
@@ -1271,7 +1271,7 @@ 
      * sets the date on a datetime property
      *
      * @access protected
-     * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
+     * @param string $date      a valid date string for php datetime functions ( or DateTime object)
      * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
      * @throws \EE_Error
      */
@@ -1329,6 +1329,7 @@ 
      * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
      * @param string               $prepend    You can include something to prepend on the timestamp
      * @param string               $append     You can include something to append on the timestamp
+     * @param string $args
      * @throws EE_Error
      * @return string timestamp
      */
@@ -1699,7 +1700,7 @@ 
      *
      * @param  array  $props_n_values   incoming array of properties and their values
      * @param  string $classname        the classname of the child class
-     * @param null    $timezone
+     * @param string|null    $timezone
      * @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 mixed (EE_Base_Class|bool)
@@ -1777,7 +1778,7 @@ 
      * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
      *
      * @param string $model_classname
-     * @param null   $timezone
+     * @param string|null   $timezone
      * @return EEM_Base
      */
     protected static function _get_model_instance_with_name($model_classname, $timezone = null)

Indentation +2647 added lines, -2647 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 do_action('AHEE_log', __FILE__, ' FILE LOADED', '');
 
@@ -25,2652 +25,2652 @@ 
 abstract class EE_Base_Class
 {
 
-    /**
-     * This is an array of the original properties and values provided during construction
-     * of this model object. (keys are model field names, values are their values).
-     * This list is important to remember so that when we are merging data from the db, we know
-     * which values to override and which to not override.
-     *
-     * @var array
-     */
-    protected $_props_n_values_provided_in_constructor;
-
-    /**
-     * Timezone
-     * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
-     * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
-     * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
-     * access to it.
-     *
-     * @var string
-     */
-    protected $_timezone;
-
-
-
-    /**
-     * date format
-     * pattern or format for displaying dates
-     *
-     * @var string $_dt_frmt
-     */
-    protected $_dt_frmt;
-
-
-
-    /**
-     * time format
-     * pattern or format for displaying time
-     *
-     * @var string $_tm_frmt
-     */
-    protected $_tm_frmt;
-
-
-
-    /**
-     * This property is for holding a cached array of object properties indexed by property name as the key.
-     * The purpose of this is for setting a cache on properties that may have calculated values after a
-     * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
-     * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
-     *
-     * @var array
-     */
-    protected $_cached_properties = array();
-
-    /**
-     * An array containing keys of the related model, and values are either an array of related mode objects or a
-     * single
-     * related model object. see the model's _model_relations. The keys should match those specified. And if the
-     * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
-     * all others have an array)
-     *
-     * @var array
-     */
-    protected $_model_relations = array();
-
-    /**
-     * Array where keys are field names (see the model's _fields property) and values are their values. To see what
-     * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
-     *
-     * @var array
-     */
-    protected $_fields = array();
-
-    /**
-     * @var boolean indicating whether or not this model object is intended to ever be saved
-     * For example, we might create model objects intended to only be used for the duration
-     * of this request and to be thrown away, and if they were accidentally saved
-     * it would be a bug.
-     */
-    protected $_allow_persist = true;
-
-
-
-    /**
-     * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children
-     * play nice
-     *
-     * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
-     *                                                         layer of the model's _fields array, (eg, EVT_ID,
-     *                                                         TXN_amount, QST_name, etc) and values are their values
-     * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
-     *                                                         corresponding db model or not.
-     * @param string  $timezone                                indicate what timezone you want any datetime fields to
-     *                                                         be in when instantiating a EE_Base_Class object.
-     * @param array   $date_formats                            An array of date formats to set on construct where first
-     *                                                         value is the date_format and second value is the time
-     *                                                         format.
-     * @throws EE_Error
-     */
-    protected function __construct($fieldValues = array(), $bydb = false, $timezone = '', $date_formats = array())
-    {
-        $className = get_class($this);
-        do_action("AHEE__{$className}__construct", $this, $fieldValues);
-        $model = $this->get_model();
-        $model_fields = $model->field_settings(false);
-        // ensure $fieldValues is an array
-        $fieldValues = is_array($fieldValues) ? $fieldValues : array($fieldValues);
-        // EEH_Debug_Tools::printr( $fieldValues, '$fieldValues  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        // verify client code has not passed any invalid field names
-        foreach ($fieldValues as $field_name => $field_value) {
-            if ( ! isset($model_fields[$field_name])) {
-                throw new EE_Error(sprintf(__("Invalid field (%s) passed to constructor of %s. Allowed fields are :%s",
-                    "event_espresso"), $field_name, get_class($this), implode(", ", array_keys($model_fields))));
-            }
-        }
-        // EEH_Debug_Tools::printr( $model_fields, '$model_fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        if ( ! empty($date_formats) && is_array($date_formats)) {
-            list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
-        } else {
-            //set default formats for date and time
-            $this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
-            $this->_tm_frmt = (string)get_option('time_format', 'g:i a');
-        }
-        //if db model is instantiating
-        if ($bydb) {
-            //client code has indicated these field values are from the database
-            foreach ($model_fields as $fieldName => $field) {
-                $this->set_from_db($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null);
-            }
-        } else {
-            //we're constructing a brand
-            //new instance of the model object. Generally, this means we'll need to do more field validation
-            foreach ($model_fields as $fieldName => $field) {
-                $this->set($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null, true);
-            }
-        }
-        //remember what values were passed to this constructor
-        $this->_props_n_values_provided_in_constructor = $fieldValues;
-        //remember in entity mapper
-        if ( ! $bydb && $model->has_primary_key_field() && $this->ID()) {
-            $model->add_to_entity_map($this);
-        }
-        //setup all the relations
-        foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $this->_model_relations[$relation_name] = null;
-            } else {
-                $this->_model_relations[$relation_name] = array();
-            }
-        }
-        /**
-         * Action done at the end of each model object construction
-         *
-         * @param EE_Base_Class $this the model object just created
-         */
-        do_action('AHEE__EE_Base_Class__construct__finished', $this);
-    }
-
-
-
-    /**
-     * Gets whether or not this model object is allowed to persist/be saved to the database.
-     *
-     * @return boolean
-     */
-    public function allow_persist()
-    {
-        return $this->_allow_persist;
-    }
-
-
-
-    /**
-     * Sets whether or not this model object should be allowed to be saved to the DB.
-     * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
-     * you got new information that somehow made you change your mind.
-     *
-     * @param boolean $allow_persist
-     * @return boolean
-     */
-    public function set_allow_persist($allow_persist)
-    {
-        return $this->_allow_persist = $allow_persist;
-    }
-
-
-
-    /**
-     * Gets the field's original value when this object was constructed during this request.
-     * This can be helpful when determining if a model object has changed or not
-     *
-     * @param string $field_name
-     * @return mixed|null
-     * @throws \EE_Error
-     */
-    public function get_original($field_name)
-    {
-        if (isset($this->_props_n_values_provided_in_constructor[$field_name])
-            && $field_settings = $this->get_model()->field_settings_for($field_name)
-        ) {
-            return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[$field_name]);
-        } else {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * @param EE_Base_Class $obj
-     * @return string
-     */
-    public function get_class($obj)
-    {
-        return get_class($obj);
-    }
-
-
-
-    /**
-     * Overrides parent because parent expects old models.
-     * This also doesn't do any validation, and won't work for serialized arrays
-     *
-     * @param    string $field_name
-     * @param    mixed  $field_value
-     * @param bool      $use_default
-     * @throws \EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        $field_obj = $this->get_model()->field_settings_for($field_name);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            //			if ( method_exists( $field_obj, 'set_timezone' )) {
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $field_obj->set_timezone($this->_timezone);
-                $field_obj->set_date_format($this->_dt_frmt);
-                $field_obj->set_time_format($this->_tm_frmt);
-            }
-            $holder_of_value = $field_obj->prepare_for_set($field_value);
-            //should the value be null?
-            if (($field_value === null || $holder_of_value === null || $holder_of_value === '') && $use_default) {
-                $this->_fields[$field_name] = $field_obj->get_default_value();
-                /**
-                 * To save having to refactor all the models, if a default value is used for a
-                 * EE_Datetime_Field, and that value is not null nor is it a DateTime
-                 * object.  Then let's do a set again to ensure that it becomes a DateTime
-                 * object.
-                 *
-                 * @since 4.6.10+
-                 */
-                if (
-                    $field_obj instanceof EE_Datetime_Field
-                    && $this->_fields[$field_name] !== null
-                    && ! $this->_fields[$field_name] instanceof DateTime
-                ) {
-                    empty($this->_fields[$field_name])
-                        ? $this->set($field_name, time())
-                        : $this->set($field_name, $this->_fields[$field_name]);
-                }
-            } else {
-                $this->_fields[$field_name] = $holder_of_value;
-            }
-            //if we're not in the constructor...
-            //now check if what we set was a primary key
-            if (
-                //note: props_n_values_provided_in_constructor is only set at the END of the constructor
-                $this->_props_n_values_provided_in_constructor
-                && $field_value
-                && $field_name === self::_get_primary_key_name(get_class($this))
-            ) {
-                //if so, we want all this object's fields to be filled either with
-                //what we've explicitly set on this model
-                //or what we have in the db
-                // echo "setting primary key!";
-                $fields_on_model = self::_get_model(get_class($this))->field_settings();
-                $obj_in_db = self::_get_model(get_class($this))->get_one_by_ID($field_value);
-                foreach ($fields_on_model as $field_obj) {
-                    if ( ! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
-                         && $field_obj->get_name() !== $field_name
-                    ) {
-                        $this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
-                    }
-                }
-                //oh this model object has an ID? well make sure its in the entity mapper
-                $this->get_model()->add_to_entity_map($this);
-            }
-            //let's unset any cache for this field_name from the $_cached_properties property.
-            $this->_clear_cached_property($field_name);
-        } else {
-            throw new EE_Error(sprintf(__("A valid EE_Model_Field_Base could not be found for the given field name: %s",
-                "event_espresso"), $field_name));
-        }
-    }
-
-
-
-    /**
-     * This sets the field value on the db column if it exists for the given $column_name or
-     * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
-     *
-     * @see EE_message::get_column_value for related documentation on the necessity of this method.
-     * @param string $field_name  Must be the exact column name.
-     * @param mixed  $field_value The value to set.
-     * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
-     * @throws \EE_Error
-     */
-    public function set_field_or_extra_meta($field_name, $field_value)
-    {
-        if ($this->get_model()->has_field($field_name)) {
-            $this->set($field_name, $field_value);
-            return true;
-        } else {
-            //ensure this object is saved first so that extra meta can be properly related.
-            $this->save();
-            return $this->update_extra_meta($field_name, $field_value);
-        }
-    }
-
-
-
-    /**
-     * This retrieves the value of the db column set on this class or if that's not present
-     * it will attempt to retrieve from extra_meta if found.
-     * Example Usage:
-     * Via EE_Message child class:
-     * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
-     * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
-     * also have additional main fields specific to the messenger.  The system accommodates those extra
-     * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
-     * value for those extra fields dynamically via the EE_message object.
-     *
-     * @param  string $field_name expecting the fully qualified field name.
-     * @return mixed|null  value for the field if found.  null if not found.
-     * @throws \EE_Error
-     */
-    public function get_field_or_extra_meta($field_name)
-    {
-        if ($this->get_model()->has_field($field_name)) {
-            $column_value = $this->get($field_name);
-        } else {
-            //This isn't a column in the main table, let's see if it is in the extra meta.
-            $column_value = $this->get_extra_meta($field_name, true, null);
-        }
-        return $column_value;
-    }
-
-
-
-    /**
-     * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
-     * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
-     * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
-     * available to all child classes that may be using the EE_Datetime_Field for a field data type.
-     *
-     * @access public
-     * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_timezone($timezone = '')
-    {
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        //make sure we clear all cached properties because they won't be relevant now
-        $this->_clear_cached_properties();
-        //make sure we update field settings and the date for all EE_Datetime_Fields
-        $model_fields = $this->get_model()->field_settings(false);
-        foreach ($model_fields as $field_name => $field_obj) {
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $field_obj->set_timezone($this->_timezone);
-                if (isset($this->_fields[$field_name]) && $this->_fields[$field_name] instanceof DateTime) {
-                    $this->_fields[$field_name]->setTimezone(new DateTimeZone($this->_timezone));
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string timezone string
-     */
-    public function get_timezone()
-    {
-        return $this->_timezone;
-    }
-
-
-
-    /**
-     * This sets the internal date format to what is sent in to be used as the new default for the class
-     * internally instead of wp set date format options
-     *
-     * @since 4.6
-     * @param string $format should be a format recognizable by PHP date() functions.
-     */
-    public function set_date_format($format)
-    {
-        $this->_dt_frmt = $format;
-        //clear cached_properties because they won't be relevant now.
-        $this->_clear_cached_properties();
-    }
-
-
-
-    /**
-     * This sets the internal time format string to what is sent in to be used as the new default for the
-     * class internally instead of wp set time format options.
-     *
-     * @since 4.6
-     * @param string $format should be a format recognizable by PHP date() functions.
-     */
-    public function set_time_format($format)
-    {
-        $this->_tm_frmt = $format;
-        //clear cached_properties because they won't be relevant now.
-        $this->_clear_cached_properties();
-    }
-
-
-
-    /**
-     * This returns the current internal set format for the date and time formats.
-     *
-     * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
-     *                             where the first value is the date format and the second value is the time format.
-     * @return mixed string|array
-     */
-    public function get_format($full = true)
-    {
-        return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
-    }
-
-
-
-    /**
-     * cache
-     * stores the passed model object on the current model object.
-     * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
-     *
-     * @param string        $relationName    one of the keys in the _model_relations array on the model. Eg
-     *                                       'Registration' associated with this model object
-     * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
-     *                                       that could be a payment or a registration)
-     * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
-     *                                       items which will be stored in an array on this object
-     * @throws EE_Error
-     * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
-     *                  related thing, no array)
-     */
-    public function cache($relationName = '', $object_to_cache = null, $cache_id = null)
-    {
-        // its entirely possible that there IS no related object yet in which case there is nothing to cache.
-        if ( ! $object_to_cache instanceof EE_Base_Class) {
-            return false;
-        }
-        // also get "how" the object is related, or throw an error
-        if ( ! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
-            throw new EE_Error(sprintf(__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
-                $relationName, get_class($this)));
-        }
-        // how many things are related ?
-        if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            // if it's a "belongs to" relationship, then there's only one related model object  eg, if this is a registration, there's only 1 attendee for it
-            // so for these model objects just set it to be cached
-            $this->_model_relations[$relationName] = $object_to_cache;
-            $return = true;
-        } else {
-            // otherwise, this is the "many" side of a one to many relationship, so we'll add the object to the array of related objects for that type.
-            // eg: if this is an event, there are many registrations for that event, so we cache the registrations in an array
-            if ( ! is_array($this->_model_relations[$relationName])) {
-                // if for some reason, the cached item is a model object, then stick that in the array, otherwise start with an empty array
-                $this->_model_relations[$relationName] = $this->_model_relations[$relationName] instanceof EE_Base_Class
-                    ? array($this->_model_relations[$relationName]) : array();
-            }
-            // first check for a cache_id which is normally empty
-            if ( ! empty($cache_id)) {
-                // if the cache_id exists, then it means we are purposely trying to cache this with a known key that can then be used to retrieve the object later on
-                $this->_model_relations[$relationName][$cache_id] = $object_to_cache;
-                $return = $cache_id;
-            } elseif ($object_to_cache->ID()) {
-                // OR the cached object originally came from the db, so let's just use it's PK for an ID
-                $this->_model_relations[$relationName][$object_to_cache->ID()] = $object_to_cache;
-                $return = $object_to_cache->ID();
-            } else {
-                // OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
-                $this->_model_relations[$relationName][] = $object_to_cache;
-                // move the internal pointer to the end of the array
-                end($this->_model_relations[$relationName]);
-                // and grab the key so that we can return it
-                $return = key($this->_model_relations[$relationName]);
-            }
-        }
-        return $return;
-    }
-
-
-
-    /**
-     * For adding an item to the cached_properties property.
-     *
-     * @access protected
-     * @param string      $fieldname the property item the corresponding value is for.
-     * @param mixed       $value     The value we are caching.
-     * @param string|null $cache_type
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _set_cached_property($fieldname, $value, $cache_type = null)
-    {
-        //first make sure this property exists
-        $this->get_model()->field_settings_for($fieldname);
-        $cache_type = empty($cache_type) ? 'standard' : $cache_type;
-        $this->_cached_properties[$fieldname][$cache_type] = $value;
-    }
-
-
-
-    /**
-     * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
-     * This also SETS the cache if we return the actual property!
-     *
-     * @param string $fieldname        the name of the property we're trying to retrieve
-     * @param bool   $pretty
-     * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
-     *                                 (in cases where the same property may be used for different outputs
-     *                                 - i.e. datetime, money etc.)
-     *                                 It can also accept certain pre-defined "schema" strings
-     *                                 to define how to output the property.
-     *                                 see the field's prepare_for_pretty_echoing for what strings can be used
-     * @return mixed                   whatever the value for the property is we're retrieving
-     * @throws \EE_Error
-     */
-    protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
-    {
-        //verify the field exists
-        $this->get_model()->field_settings_for($fieldname);
-        $cache_type = $pretty ? 'pretty' : 'standard';
-        $cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
-        if (isset($this->_cached_properties[$fieldname][$cache_type])) {
-            return $this->_cached_properties[$fieldname][$cache_type];
-        }
-        $field_obj = $this->get_model()->field_settings_for($fieldname);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            // If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
-            }
-            if ( ! isset($this->_fields[$fieldname])) {
-                $this->_fields[$fieldname] = null;
-            }
-            $value = $pretty
-                ? $field_obj->prepare_for_pretty_echoing($this->_fields[$fieldname], $extra_cache_ref)
-                : $field_obj->prepare_for_get($this->_fields[$fieldname]);
-            $this->_set_cached_property($fieldname, $value, $cache_type);
-            return $value;
-        }
-        return null;
-    }
-
-
-
-    /**
-     * set timezone, formats, and output for EE_Datetime_Field objects
-     *
-     * @param \EE_Datetime_Field $datetime_field
-     * @param bool               $pretty
-     * @param null $date_or_time
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _prepare_datetime_field(
-        EE_Datetime_Field $datetime_field,
-        $pretty = false,
-        $date_or_time = null
-    ) {
-        $datetime_field->set_timezone($this->_timezone);
-        $datetime_field->set_date_format($this->_dt_frmt, $pretty);
-        $datetime_field->set_time_format($this->_tm_frmt, $pretty);
-        //set the output returned
-        switch ($date_or_time) {
-            case 'D' :
-                $datetime_field->set_date_time_output('date');
-                break;
-            case 'T' :
-                $datetime_field->set_date_time_output('time');
-                break;
-            default :
-                $datetime_field->set_date_time_output();
-        }
-    }
-
-
-
-    /**
-     * This just takes care of clearing out the cached_properties
-     *
-     * @return void
-     */
-    protected function _clear_cached_properties()
-    {
-        $this->_cached_properties = array();
-    }
-
-
-
-    /**
-     * This just clears out ONE property if it exists in the cache
-     *
-     * @param  string $property_name the property to remove if it exists (from the _cached_properties array)
-     * @return void
-     */
-    protected function _clear_cached_property($property_name)
-    {
-        if (isset($this->_cached_properties[$property_name])) {
-            unset($this->_cached_properties[$property_name]);
-        }
-    }
-
-
-
-    /**
-     * Ensures that this related thing is a model object.
-     *
-     * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
-     * @param string $model_name   name of the related thing, eg 'Attendee',
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
-    {
-        $other_model_instance = self::_get_model_instance_with_name(
-            self::_get_model_classname($model_name),
-            $this->_timezone
-        );
-        return $other_model_instance->ensure_is_obj($object_or_id);
-    }
-
-
-
-    /**
-     * Forgets the cached model of the given relation Name. So the next time we request it,
-     * we will fetch it again from the database. (Handy if you know it's changed somehow).
-     * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
-     * then only remove that one object from our cached array. Otherwise, clear the entire list
-     *
-     * @param string $relationName                         one of the keys in the _model_relations array on the model.
-     *                                                     Eg 'Registration'
-     * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
-     *                                                     if you intend to use $clear_all = TRUE, or the relation only
-     *                                                     has 1 object anyways (ie, it's a BelongsToRelation)
-     * @param bool   $clear_all                            This flags clearing the entire cache relation property if
-     *                                                     this is HasMany or HABTM.
-     * @throws EE_Error
-     * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a
-     *                       relation from all
-     */
-    public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false)
-    {
-        $relationship_to_model = $this->get_model()->related_settings_for($relationName);
-        $index_in_cache = '';
-        if ( ! $relationship_to_model) {
-            throw new EE_Error(
-                sprintf(
-                    __("There is no relationship to %s on a %s. Cannot clear that cache", 'event_espresso'),
-                    $relationName,
-                    get_class($this)
-                )
-            );
-        }
-        if ($clear_all) {
-            $obj_removed = true;
-            $this->_model_relations[$relationName] = null;
-        } elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            $obj_removed = $this->_model_relations[$relationName];
-            $this->_model_relations[$relationName] = null;
-        } else {
-            if ($object_to_remove_or_index_into_array instanceof EE_Base_Class
-                && $object_to_remove_or_index_into_array->ID()
-            ) {
-                $index_in_cache = $object_to_remove_or_index_into_array->ID();
-                if (is_array($this->_model_relations[$relationName])
-                    && ! isset($this->_model_relations[$relationName][$index_in_cache])
-                ) {
-                    $index_found_at = null;
-                    //find this object in the array even though it has a different key
-                    foreach ($this->_model_relations[$relationName] as $index => $obj) {
-                        if (
-                            $obj instanceof EE_Base_Class
-                            && (
-                                $obj == $object_to_remove_or_index_into_array
-                                || $obj->ID() === $object_to_remove_or_index_into_array->ID()
-                            )
-                        ) {
-                            $index_found_at = $index;
-                            break;
-                        }
-                    }
-                    if ($index_found_at) {
-                        $index_in_cache = $index_found_at;
-                    } else {
-                        //it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
-                        //if it wasn't in it to begin with. So we're done
-                        return $object_to_remove_or_index_into_array;
-                    }
-                }
-            } elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
-                //so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
-                foreach ($this->get_all_from_cache($relationName) as $index => $potentially_obj_we_want) {
-                    if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
-                        $index_in_cache = $index;
-                    }
-                }
-            } else {
-                $index_in_cache = $object_to_remove_or_index_into_array;
-            }
-            //supposedly we've found it. But it could just be that the client code
-            //provided a bad index/object
-            if (
-            isset(
-                $this->_model_relations[$relationName],
-                $this->_model_relations[$relationName][$index_in_cache]
-            )
-            ) {
-                $obj_removed = $this->_model_relations[$relationName][$index_in_cache];
-                unset($this->_model_relations[$relationName][$index_in_cache]);
-            } else {
-                //that thing was never cached anyways.
-                $obj_removed = null;
-            }
-        }
-        return $obj_removed;
-    }
-
-
-
-    /**
-     * update_cache_after_object_save
-     * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
-     * obtained after being saved to the db
-     *
-     * @param string         $relationName       - the type of object that is cached
-     * @param \EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
-     * @param string         $current_cache_id   - the ID that was used when originally caching the object
-     * @return boolean TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function update_cache_after_object_save(
-        $relationName,
-        EE_Base_Class $newly_saved_object,
-        $current_cache_id = ''
-    ) {
-        // verify that incoming object is of the correct type
-        $obj_class = 'EE_' . $relationName;
-        if ($newly_saved_object instanceof $obj_class) {
-            /* @type EE_Base_Class $newly_saved_object */
-            // now get the type of relation
-            $relationship_to_model = $this->get_model()->related_settings_for($relationName);
-            // if this is a 1:1 relationship
-            if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-                // then just replace the cached object with the newly saved object
-                $this->_model_relations[$relationName] = $newly_saved_object;
-                return true;
-                // or if it's some kind of sordid feral polyamorous relationship...
-            } elseif (is_array($this->_model_relations[$relationName])
-                      && isset($this->_model_relations[$relationName][$current_cache_id])
-            ) {
-                // then remove the current cached item
-                unset($this->_model_relations[$relationName][$current_cache_id]);
-                // and cache the newly saved object using it's new ID
-                $this->_model_relations[$relationName][$newly_saved_object->ID()] = $newly_saved_object;
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
-     *
-     * @param string $relationName
-     * @return EE_Base_Class
-     */
-    public function get_one_from_cache($relationName)
-    {
-        $cached_array_or_object = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName]
-            : null;
-        if (is_array($cached_array_or_object)) {
-            return array_shift($cached_array_or_object);
-        } else {
-            return $cached_array_or_object;
-        }
-    }
-
-
-
-    /**
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
-     *
-     * @param string $relationName
-     * @throws \EE_Error
-     * @return EE_Base_Class[] NOT necessarily indexed by primary keys
-     */
-    public function get_all_from_cache($relationName)
-    {
-        $objects = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName] : array();
-        // if the result is not an array, but exists, make it an array
-        $objects = is_array($objects) ? $objects : array($objects);
-        //bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
-        //basically, if this model object was stored in the session, and these cached model objects
-        //already have IDs, let's make sure they're in their model's entity mapper
-        //otherwise we will have duplicates next time we call
-        // EE_Registry::instance()->load_model( $relationName )->get_one_by_ID( $result->ID() );
-        $model = EE_Registry::instance()->load_model($relationName);
-        foreach ($objects as $model_object) {
-            if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
-                //ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
-                if ($model_object->ID()) {
-                    $model->add_to_entity_map($model_object);
-                }
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
-                            'event_espresso'
-                        ),
-                        $relationName,
-                        gettype($model_object)
-                    )
-                );
-            }
-        }
-        return $objects;
-    }
-
-
-
-    /**
-     * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param int   $limit              How many objects to return.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function next_x($field_to_order_by = null, $limit = 1, $query_params = array(), $columns_to_select = null)
-    {
-        $field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
-            ? $this->get_model()->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $this->get_model()->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param int   $limit              How many objects to return.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function previous_x(
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = array(),
-        $columns_to_select = null
-    ) {
-        $field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
-            ? $this->get_model()->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $this->get_model()->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Returns the next EE_Base_Class object in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function next($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
-    {
-        $field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
-            ? $this->get_model()->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $this->get_model()->next($current_value, $field, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Returns the previous EE_Base_Class object in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
-     *                                  you can indicate just the column you want returned
-     * @return array|EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function previous($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
-    {
-        $field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
-            ? $this->get_model()->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $this->get_model()->previous($current_value, $field, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Overrides parent because parent expects old models.
-     * This also doesn't do any validation, and won't work for serialized arrays
-     *
-     * @param string $field_name
-     * @param mixed  $field_value_from_db
-     * @throws \EE_Error
-     */
-    public function set_from_db($field_name, $field_value_from_db)
-    {
-        $field_obj = $this->get_model()->field_settings_for($field_name);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            //you would think the DB has no NULLs for non-null label fields right? wrong!
-            //eg, a CPT model object could have an entry in the posts table, but no
-            //entry in the meta table. Meaning that all its columns in the meta table
-            //are null! yikes! so when we find one like that, use defaults for its meta columns
-            if ($field_value_from_db === null) {
-                if ($field_obj->is_nullable()) {
-                    //if the field allows nulls, then let it be null
-                    $field_value = null;
-                } else {
-                    $field_value = $field_obj->get_default_value();
-                }
-            } else {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
-            }
-            $this->_fields[$field_name] = $field_value;
-            $this->_clear_cached_property($field_name);
-        }
-    }
-
-
-
-    /**
-     * verifies that the specified field is of the correct type
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function get($field_name, $extra_cache_ref = null)
-    {
-        return $this->_get_cached_property($field_name, false, $extra_cache_ref);
-    }
-
-
-
-    /**
-     * This method simply returns the RAW unprocessed value for the given property in this class
-     *
-     * @param  string $field_name A valid fieldname
-     * @return mixed              Whatever the raw value stored on the property is.
-     * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
-     */
-    public function get_raw($field_name)
-    {
-        $field_settings = $this->get_model()->field_settings_for($field_name);
-        return $field_settings instanceof EE_Datetime_Field && $this->_fields[$field_name] instanceof DateTime
-            ? $this->_fields[$field_name]->format('U')
-            : $this->_fields[$field_name];
-    }
-
-
-
-    /**
-     * This is used to return the internal DateTime object used for a field that is a
-     * EE_Datetime_Field.
-     *
-     * @param string $field_name               The field name retrieving the DateTime object.
-     * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
-     * @throws \EE_Error
-     *                                         an error is set and false returned.  If the field IS an
-     *                                         EE_Datetime_Field and but the field value is null, then
-     *                                         just null is returned (because that indicates that likely
-     *                                         this field is nullable).
-     */
-    public function get_DateTime_object($field_name)
-    {
-        $field_settings = $this->get_model()->field_settings_for($field_name);
-        if ( ! $field_settings instanceof EE_Datetime_Field) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
-                        'event_espresso'
-                    ),
-                    $field_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $this->_fields[$field_name];
-    }
-
-
-
-    /**
-     * To be used in template to immediately echo out the value, and format it for output.
-     * Eg, should call stripslashes and whatnot before echoing
-     *
-     * @param string $field_name      the name of the field as it appears in the DB
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return void
-     * @throws \EE_Error
-     */
-    public function e($field_name, $extra_cache_ref = null)
-    {
-        echo $this->get_pretty($field_name, $extra_cache_ref);
-    }
-
-
-
-    /**
-     * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
-     * can be easily used as the value of form input.
-     *
-     * @param string $field_name
-     * @return void
-     * @throws \EE_Error
-     */
-    public function f($field_name)
-    {
-        $this->e($field_name, 'form_input');
-    }
-
-
-
-    /**
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function get_pretty($field_name, $extra_cache_ref = null)
-    {
-        return $this->_get_cached_property($field_name, true, $extra_cache_ref);
-    }
-
-
-
-    /**
-     * This simply returns the datetime for the given field name
-     * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
-     * (and the equivalent e_date, e_time, e_datetime).
-     *
-     * @access   protected
-     * @param string   $field_name   Field on the instantiated EE_Base_Class child object
-     * @param string   $dt_frmt      valid datetime format used for date
-     *                               (if '' then we just use the default on the field,
-     *                               if NULL we use the last-used format)
-     * @param string   $tm_frmt      Same as above except this is for time format
-     * @param string   $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
-     * @param  boolean $echo         Whether the dtt is echoing using pretty echoing or just returned using vanilla get
-     * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
-     *                               if field is not a valid dtt field, or void if echoing
-     * @throws \EE_Error
-     */
-    protected function _get_datetime($field_name, $dt_frmt = '', $tm_frmt = '', $date_or_time = '', $echo = false)
-    {
-        // clear cached property
-        $this->_clear_cached_property($field_name);
-        //reset format properties because they are used in get()
-        $this->_dt_frmt = $dt_frmt !== '' ? $dt_frmt : $this->_dt_frmt;
-        $this->_tm_frmt = $tm_frmt !== '' ? $tm_frmt : $this->_tm_frmt;
-        if ($echo) {
-            $this->e($field_name, $date_or_time);
-            return '';
-        }
-        return $this->get($field_name, $date_or_time);
-    }
-
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $format     format for the date returned (if NULL we use default in dt_frmt property)
-     * @return string            datetime value formatted
-     * @throws \EE_Error
-     */
-    public function get_date($field_name, $format = '')
-    {
-        return $this->_get_datetime($field_name, $format, null, 'D');
-    }
-
-
-
-    /**
-     * @param      $field_name
-     * @param string $format
-     * @throws \EE_Error
-     */
-    public function e_date($field_name, $format = '')
-    {
-        $this->_get_datetime($field_name, $format, null, 'D', true);
-    }
-
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $format     format for the time returned ( if NULL we use default in tm_frmt property)
-     * @return string             datetime value formatted
-     * @throws \EE_Error
-     */
-    public function get_time($field_name, $format = '')
-    {
-        return $this->_get_datetime($field_name, null, $format, 'T');
-    }
-
-
-
-    /**
-     * @param      $field_name
-     * @param string $format
-     * @throws \EE_Error
-     */
-    public function e_time($field_name, $format = '')
-    {
-        $this->_get_datetime($field_name, null, $format, 'T', true);
-    }
-
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
-     * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $dt_frmt    format for the date returned (if NULL we use default in dt_frmt property)
-     * @param  string $tm_frmt    format for the time returned (if NULL we use default in tm_frmt property)
-     * @return string             datetime value formatted
-     * @throws \EE_Error
-     */
-    public function get_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
-    {
-        return $this->_get_datetime($field_name, $dt_frmt, $tm_frmt);
-    }
-
-
-
-    /**
-     * @param string $field_name
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @throws \EE_Error
-     */
-    public function e_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
-    {
-        $this->_get_datetime($field_name, $dt_frmt, $tm_frmt, null, true);
-    }
-
-
-
-    /**
-     * Get the i8ln value for a date using the WordPress @see date_i18n function.
-     *
-     * @param string $field_name The EE_Datetime_Field reference for the date being retrieved.
-     * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
-     *                           on the object will be used.
-     * @return string Date and time string in set locale or false if no field exists for the given
-     * @throws \EE_Error
-     *                           field name.
-     */
-    public function get_i18n_datetime($field_name, $format = '')
-    {
-        $format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
-        return date_i18n(
-            $format,
-            EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
-        );
-    }
-
-
-
-    /**
-     * This method validates whether the given field name is a valid field on the model object as well as it is of a
-     * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
-     * thrown.
-     *
-     * @param  string $field_name The field name being checked
-     * @throws EE_Error
-     * @return EE_Datetime_Field
-     */
-    protected function _get_dtt_field_settings($field_name)
-    {
-        $field = $this->get_model()->field_settings_for($field_name);
-        //check if field is dtt
-        if ($field instanceof EE_Datetime_Field) {
-            return $field;
-        } else {
-            throw new EE_Error(sprintf(__('The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
-                'event_espresso'), $field_name, self::_get_model_classname(get_class($this))));
-        }
-    }
-
-
-
-
-    /**
-     * NOTE ABOUT BELOW:
-     * These convenience date and time setters are for setting date and time independently.  In other words you might
-     * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
-     * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
-     * method and make sure you send the entire datetime value for setting.
-     */
-    /**
-     * sets the time on a datetime property
-     *
-     * @access protected
-     * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
-     * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
-     * @throws \EE_Error
-     */
-    protected function _set_time_for($time, $fieldname)
-    {
-        $this->_set_date_time('T', $time, $fieldname);
-    }
-
-
-
-    /**
-     * sets the date on a datetime property
-     *
-     * @access protected
-     * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
-     * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
-     * @throws \EE_Error
-     */
-    protected function _set_date_for($date, $fieldname)
-    {
-        $this->_set_date_time('D', $date, $fieldname);
-    }
-
-
-
-    /**
-     * This takes care of setting a date or time independently on a given model object property. This method also
-     * verifies that the given fieldname matches a model object property and is for a EE_Datetime_Field field
-     *
-     * @access protected
-     * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
-     * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
-     * @param string          $fieldname      the name of the field the date OR time is being set on (must match a
-     *                                        EE_Datetime_Field property)
-     * @throws \EE_Error
-     */
-    protected function _set_date_time($what = 'T', $datetime_value, $fieldname)
-    {
-        $field = $this->_get_dtt_field_settings($fieldname);
-        $field->set_timezone($this->_timezone);
-        $field->set_date_format($this->_dt_frmt);
-        $field->set_time_format($this->_tm_frmt);
-        switch ($what) {
-            case 'T' :
-                $this->_fields[$fieldname] = $field->prepare_for_set_with_new_time(
-                    $datetime_value,
-                    $this->_fields[$fieldname]
-                );
-                break;
-            case 'D' :
-                $this->_fields[$fieldname] = $field->prepare_for_set_with_new_date(
-                    $datetime_value,
-                    $this->_fields[$fieldname]
-                );
-                break;
-            case 'B' :
-                $this->_fields[$fieldname] = $field->prepare_for_set($datetime_value);
-                break;
-        }
-        $this->_clear_cached_property($fieldname);
-    }
-
-
-
-    /**
-     * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
-     * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
-     * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
-     * that could lead to some unexpected results!
-     *
-     * @access public
-     * @param string               $field_name This is the name of the field on the object that contains the date/time
-     *                                         value being returned.
-     * @param string               $callback   must match a valid method in this class (defaults to get_datetime)
-     * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
-     * @param string               $prepend    You can include something to prepend on the timestamp
-     * @param string               $append     You can include something to append on the timestamp
-     * @throws EE_Error
-     * @return string timestamp
-     */
-    public function display_in_my_timezone(
-        $field_name,
-        $callback = 'get_datetime',
-        $args = null,
-        $prepend = '',
-        $append = ''
-    ) {
-        $timezone = EEH_DTT_Helper::get_timezone();
-        if ($timezone === $this->_timezone) {
-            return '';
-        }
-        $original_timezone = $this->_timezone;
-        $this->set_timezone($timezone);
-        $fn = (array)$field_name;
-        $args = array_merge($fn, (array)$args);
-        if ( ! method_exists($this, $callback)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
-                        'event_espresso'
-                    ),
-                    $callback
-                )
-            );
-        }
-        $args = (array)$args;
-        $return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
-        $this->set_timezone($original_timezone);
-        return $return;
-    }
-
-
-
-    /**
-     * Deletes this model object.
-     * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
-     * override
-     * `EE_Base_Class::_delete` NOT this class.
-     *
-     * @return boolean | int
-     * @throws \EE_Error
-     */
-    public function delete()
-    {
-        /**
-         * Called just before the `EE_Base_Class::_delete` method call.
-         * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
-         * should be aware that `_delete` may not always result in a permanent delete.  For example, `EE_Soft_Delete_Base_Class::_delete`
-         * soft deletes (trash) the object and does not permanently delete it.
-         *
-         * @param EE_Base_Class $model_object about to be 'deleted'
-         */
-        do_action('AHEE__EE_Base_Class__delete__before', $this);
-        $result = $this->_delete();
-        /**
-         * Called just after the `EE_Base_Class::_delete` method call.
-         * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
-         * should be aware that `_delete` may not always result in a permanent delete.  For example `EE_Soft_Base_Class::_delete`
-         * soft deletes (trash) the object and does not permanently delete it.
-         *
-         * @param EE_Base_Class $model_object that was just 'deleted'
-         * @param boolean       $result
-         */
-        do_action('AHEE__EE_Base_Class__delete__end', $this, $result);
-        return $result;
-    }
-
-
-
-    /**
-     * Calls the specific delete method for the instantiated class.
-     * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
-     * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
-     * `EE_Base_Class::delete`
-     *
-     * @return bool|int
-     * @throws \EE_Error
-     */
-    protected function _delete()
-    {
-        return $this->delete_permanently();
-    }
-
-
-
-    /**
-     * Deletes this model object permanently from db (but keep in mind related models my block the delete and return an
-     * error)
-     *
-     * @return bool | int
-     * @throws \EE_Error
-     */
-    public function delete_permanently()
-    {
-        /**
-         * Called just before HARD deleting a model object
-         *
-         * @param EE_Base_Class $model_object about to be 'deleted'
-         */
-        do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
-        $model = $this->get_model();
-        $result = $model->delete_permanently_by_ID($this->ID());
-        $this->refresh_cache_of_related_objects();
-        /**
-         * Called just after HARD deleting a model object
-         *
-         * @param EE_Base_Class $model_object that was just 'deleted'
-         * @param boolean       $result
-         */
-        do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
-        return $result;
-    }
-
-
-
-    /**
-     * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
-     * related model objects
-     *
-     * @throws \EE_Error
-     */
-    public function refresh_cache_of_related_objects()
-    {
-        foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
-            if ( ! empty($this->_model_relations[$relation_name])) {
-                $related_objects = $this->_model_relations[$relation_name];
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                    //this relation only stores a single model object, not an array
-                    //but let's make it consistent
-                    $related_objects = array($related_objects);
-                }
-                foreach ($related_objects as $related_object) {
-                    //only refresh their cache if they're in memory
-                    if ($related_object instanceof EE_Base_Class) {
-                        $related_object->clear_cache($this->get_model()->get_this_model_name(), $this);
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *        Saves this object to the database. An array may be supplied to set some values on this
-     * object just before saving.
-     *
-     * @access public
-     * @param array $set_cols_n_values keys are field names, values are their new values,
-     *                                 if provided during the save() method (often client code will change the fields'
-     *                                 values before calling save)
-     * @throws \EE_Error
-     * @return int , 1 on a successful update, the ID of the new entry on insert; 0 on failure or if the model object
-     *                                 isn't allowed to persist (as determined by EE_Base_Class::allow_persist())
-     */
-    public function save($set_cols_n_values = array())
-    {
-        /**
-         * Filters the fields we're about to save on the model object
-         *
-         * @param array         $set_cols_n_values
-         * @param EE_Base_Class $model_object
-         */
-        $set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
-            $this);
-        //set attributes as provided in $set_cols_n_values
-        foreach ($set_cols_n_values as $column => $value) {
-            $this->set($column, $value);
-        }
-        /**
-         * Saving a model object.
-         * Before we perform a save, this action is fired.
-         *
-         * @param EE_Base_Class $model_object the model object about to be saved.
-         */
-        do_action('AHEE__EE_Base_Class__save__begin', $this);
-        if ( ! $this->allow_persist()) {
-            return 0;
-        }
-        //now get current attribute values
-        $save_cols_n_values = $this->_fields;
-        //if the object already has an ID, update it. Otherwise, insert it
-        //also: change the assumption about values passed to the model NOT being prepare dby the model object. They have been
-        $old_assumption_concerning_value_preparation = $this->get_model()
-                                                            ->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->get_model()->assume_values_already_prepared_by_model_object(true);
-        //does this model have an autoincrement PK?
-        if ($this->get_model()->has_primary_key_field()) {
-            if ($this->get_model()->get_primary_key_field()->is_auto_increment()) {
-                //ok check if it's set, if so: update; if not, insert
-                if ( ! empty($save_cols_n_values[self::_get_primary_key_name(get_class($this))])) {
-                    $results = $this->get_model()->update_by_ID($save_cols_n_values, $this->ID());
-                } else {
-                    unset($save_cols_n_values[self::_get_primary_key_name(get_class($this))]);
-                    $results = $this->get_model()->insert($save_cols_n_values);
-                    if ($results) {
-                        //if successful, set the primary key
-                        //but don't use the normal SET method, because it will check if
-                        //an item with the same ID exists in the mapper & db, then
-                        //will find it in the db (because we just added it) and THAT object
-                        //will get added to the mapper before we can add this one!
-                        //but if we just avoid using the SET method, all that headache can be avoided
-                        $pk_field_name = self::_get_primary_key_name(get_class($this));
-                        $this->_fields[$pk_field_name] = $results;
-                        $this->_clear_cached_property($pk_field_name);
-                        $this->get_model()->add_to_entity_map($this);
-                        $this->_update_cached_related_model_objs_fks();
-                    }
-                }
-            } else {//PK is NOT auto-increment
-                //so check if one like it already exists in the db
-                if ($this->get_model()->exists_by_ID($this->ID())) {
-                    if (WP_DEBUG && ! $this->in_entity_map()) {
-                        throw new EE_Error(
-                            sprintf(
-                                __('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
-                                    'event_espresso'),
-                                get_class($this),
-                                get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                                get_class($this->get_model()) . '::instance()->get_one_by_ID()',
-                                '<br />'
-                            )
-                        );
-                    }
-                    $results = $this->get_model()->update_by_ID($save_cols_n_values, $this->ID());
-                } else {
-                    $results = $this->get_model()->insert($save_cols_n_values);
-                    $this->_update_cached_related_model_objs_fks();
-                }
-            }
-        } else {//there is NO primary key
-            $already_in_db = false;
-            foreach ($this->get_model()->unique_indexes() as $index) {
-                $uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
-                if ($this->get_model()->exists(array($uniqueness_where_params))) {
-                    $already_in_db = true;
-                }
-            }
-            if ($already_in_db) {
-                $combined_pk_fields_n_values = array_intersect_key($save_cols_n_values,
-                    $this->get_model()->get_combined_primary_key_fields());
-                $results = $this->get_model()->update($save_cols_n_values, $combined_pk_fields_n_values);
-            } else {
-                $results = $this->get_model()->insert($save_cols_n_values);
-            }
-        }
-        //restore the old assumption about values being prepared by the model object
-        $this->get_model()
-             ->assume_values_already_prepared_by_model_object($old_assumption_concerning_value_preparation);
-        /**
-         * After saving the model object this action is called
-         *
-         * @param EE_Base_Class $model_object which was just saved
-         * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
-         *                                    the new ID (or 0 if an error occurred and it wasn't updated)
-         */
-        do_action('AHEE__EE_Base_Class__save__end', $this, $results);
-        return $results;
-    }
-
-
-
-    /**
-     * Updates the foreign key on related models objects pointing to this to have this model object's ID
-     * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
-     * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
-     * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
-     * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
-     * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
-     * or not they exist in the DB (if they do, their DB records will be automatically updated)
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _update_cached_related_model_objs_fks()
-    {
-        foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Has_Many_Relation) {
-                foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
-                    $fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
-                        $this->get_model()->get_this_model_name()
-                    );
-                    $related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
-                    if ($related_model_obj_in_cache->ID()) {
-                        $related_model_obj_in_cache->save();
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Saves this model object and its NEW cached relations to the database.
-     * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
-     * In order for that to work, we would need to mark model objects as dirty/clean...
-     * because otherwise, there's a potential for infinite looping of saving
-     * Saves the cached related model objects, and ensures the relation between them
-     * and this object and properly setup
-     *
-     * @return int ID of new model object on save; 0 on failure+
-     * @throws \EE_Error
-     */
-    public function save_new_cached_related_model_objs()
-    {
-        //make sure this has been saved
-        if ( ! $this->ID()) {
-            $id = $this->save();
-        } else {
-            $id = $this->ID();
-        }
-        //now save all the NEW cached model objects  (ie they don't exist in the DB)
-        foreach ($this->get_model()->relation_settings() as $relationName => $relationObj) {
-            if ($this->_model_relations[$relationName]) {
-                //is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
-                //or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
-                if ($relationObj instanceof EE_Belongs_To_Relation) {
-                    //add a relation to that relation type (which saves the appropriate thing in the process)
-                    //but ONLY if it DOES NOT exist in the DB
-                    /* @var $related_model_obj EE_Base_Class */
-                    $related_model_obj = $this->_model_relations[$relationName];
-                    //					if( ! $related_model_obj->ID()){
-                    $this->_add_relation_to($related_model_obj, $relationName);
-                    $related_model_obj->save_new_cached_related_model_objs();
-                    //					}
-                } else {
-                    foreach ($this->_model_relations[$relationName] as $related_model_obj) {
-                        //add a relation to that relation type (which saves the appropriate thing in the process)
-                        //but ONLY if it DOES NOT exist in the DB
-                        //						if( ! $related_model_obj->ID()){
-                        $this->_add_relation_to($related_model_obj, $relationName);
-                        $related_model_obj->save_new_cached_related_model_objs();
-                        //						}
-                    }
-                }
-            }
-        }
-        return $id;
-    }
-
-
-
-    /**
-     * for getting a model while instantiated.
-     *
-     * @return \EEM_Base | \EEM_CPT_Base
-     */
-    public function get_model()
-    {
-        $modelName = self::_get_model_classname(get_class($this));
-        return self::_get_model_instance_with_name($modelName, $this->_timezone);
-    }
-
-
-
-    /**
-     * @param $props_n_values
-     * @param $classname
-     * @return mixed bool|EE_Base_Class|EEM_CPT_Base
-     * @throws \EE_Error
-     */
-    protected static function _get_object_from_entity_mapper($props_n_values, $classname)
-    {
-        //TODO: will not work for Term_Relationships because they have no PK!
-        $primary_id_ref = self::_get_primary_key_name($classname);
-        if (array_key_exists($primary_id_ref, $props_n_values) && ! empty($props_n_values[$primary_id_ref])) {
-            $id = $props_n_values[$primary_id_ref];
-            return self::_get_model($classname)->get_from_entity_map($id);
-        }
-        return false;
-    }
-
-
-
-    /**
-     * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
-     * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
-     * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
-     * we return false.
-     *
-     * @param  array  $props_n_values   incoming array of properties and their values
-     * @param  string $classname        the classname of the child class
-     * @param null    $timezone
-     * @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 mixed (EE_Base_Class|bool)
-     * @throws \EE_Error
-     */
-    protected static function _check_for_object($props_n_values, $classname, $timezone = null, $date_formats = array())
-    {
-        $existing = null;
-        if (self::_get_model($classname)->has_primary_key_field()) {
-            $primary_id_ref = self::_get_primary_key_name($classname);
-            if (array_key_exists($primary_id_ref, $props_n_values)
-                && ! empty($props_n_values[$primary_id_ref])
-            ) {
-                $existing = self::_get_model($classname, $timezone)->get_one_by_ID(
-                    $props_n_values[$primary_id_ref]
-                );
-            }
-        } elseif (self::_get_model($classname, $timezone)->has_all_combined_primary_key_fields($props_n_values)) {
-            //no primary key on this model, but there's still a matching item in the DB
-            $existing = self::_get_model($classname, $timezone)->get_one_by_ID(
-                self::_get_model($classname, $timezone)->get_index_primary_key_string($props_n_values)
-            );
-        }
-        if ($existing) {
-            //set date formats if present before setting values
-            if ( ! empty($date_formats) && is_array($date_formats)) {
-                $existing->set_date_format($date_formats[0]);
-                $existing->set_time_format($date_formats[1]);
-            } else {
-                //set default formats for date and time
-                $existing->set_date_format(get_option('date_format'));
-                $existing->set_time_format(get_option('time_format'));
-            }
-            foreach ($props_n_values as $property => $field_value) {
-                $existing->set($property, $field_value);
-            }
-            return $existing;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Gets the EEM_*_Model for this class
-     *
-     * @access public now, as this is more convenient
-     * @param      $classname
-     * @param null $timezone
-     * @throws EE_Error
-     * @return EEM_Base
-     */
-    protected static function _get_model($classname, $timezone = null)
-    {
-        //find model for this class
-        if ( ! $classname) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "What were you thinking calling _get_model(%s)?? You need to specify the class name",
-                        "event_espresso"
-                    ),
-                    $classname
-                )
-            );
-        }
-        $modelName = self::_get_model_classname($classname);
-        return self::_get_model_instance_with_name($modelName, $timezone);
-    }
-
-
-
-    /**
-     * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
-     *
-     * @param string $model_classname
-     * @param null   $timezone
-     * @return EEM_Base
-     */
-    protected static function _get_model_instance_with_name($model_classname, $timezone = null)
-    {
-        $model_classname = str_replace('EEM_', '', $model_classname);
-        $model = EE_Registry::instance()->load_model($model_classname);
-        $model->set_timezone($timezone);
-        return $model;
-    }
-
-
-
-    /**
-     * If a model name is provided (eg Registration), gets the model classname for that model.
-     * Also works if a model class's classname is provided (eg EE_Registration).
-     *
-     * @param null $model_name
-     * @return string like EEM_Attendee
-     */
-    private static function _get_model_classname($model_name = null)
-    {
-        if (strpos($model_name, "EE_") === 0) {
-            $model_classname = str_replace("EE_", "EEM_", $model_name);
-        } else {
-            $model_classname = "EEM_" . $model_name;
-        }
-        return $model_classname;
-    }
-
-
-
-    /**
-     * returns the name of the primary key attribute
-     *
-     * @param null $classname
-     * @throws EE_Error
-     * @return string
-     */
-    protected static function _get_primary_key_name($classname = null)
-    {
-        if ( ! $classname) {
-            throw new EE_Error(
-                sprintf(
-                    __("What were you thinking calling _get_primary_key_name(%s)", "event_espresso"),
-                    $classname
-                )
-            );
-        }
-        return self::_get_model($classname)->get_primary_key_field()->get_name();
-    }
-
-
-
-    /**
-     * Gets the value of the primary key.
-     * If the object hasn't yet been saved, it should be whatever the model field's default was
-     * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
-     * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
-     *
-     * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
-     * @throws \EE_Error
-     */
-    public function ID()
-    {
-        //now that we know the name of the variable, use a variable variable to get its value and return its
-        if ($this->get_model()->has_primary_key_field()) {
-            return $this->_fields[self::_get_primary_key_name(get_class($this))];
-        } else {
-            return $this->get_model()->get_index_primary_key_string($this->_fields);
-        }
-    }
-
-
-
-    /**
-     * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
-     * model is related to a group of events, the $relationName should be 'Event', and should be a key in the EE
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
-     *
-     * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
-     * @param string $relationName                     eg 'Events','Question',etc.
-     *                                                 an attendee to a group, you also want to specify which role they
-     *                                                 will have in that group. So you would use this parameter to
-     *                                                 specify array('role-column-name'=>'role-id')
-     * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
-     *                                                 allow you to further constrict the relation to being added.
-     *                                                 However, keep in mind that the columns (keys) given must match a
-     *                                                 column on the JOIN table and currently only the HABTM models
-     *                                                 accept these additional conditions.  Also remember that if an
-     *                                                 exact match isn't found for these extra cols/val pairs, then a
-     *                                                 NEW row is created in the join table.
-     * @param null   $cache_id
-     * @throws EE_Error
-     * @return EE_Base_Class the object the relation was added to
-     */
-    public function _add_relation_to(
-        $otherObjectModelObjectOrID,
-        $relationName,
-        $extra_join_model_fields_n_values = array(),
-        $cache_id = null
-    ) {
-        //if this thing exists in the DB, save the relation to the DB
-        if ($this->ID()) {
-            $otherObject = $this->get_model()
-                                ->add_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
-                                    $extra_join_model_fields_n_values);
-            //clear cache so future get_many_related and get_first_related() return new results.
-            $this->clear_cache($relationName, $otherObject, true);
-            if ($otherObject instanceof EE_Base_Class) {
-                $otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
-            }
-        } else {
-            //this thing doesn't exist in the DB,  so just cache it
-            if ( ! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
-                throw new EE_Error(sprintf(
-                    __('Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
-                        'event_espresso'),
-                    $otherObjectModelObjectOrID,
-                    get_class($this)
-                ));
-            } else {
-                $otherObject = $otherObjectModelObjectOrID;
-            }
-            $this->cache($relationName, $otherObjectModelObjectOrID, $cache_id);
-        }
-        if ($otherObject instanceof EE_Base_Class) {
-            //fix the reciprocal relation too
-            if ($otherObject->ID()) {
-                //its saved so assumed relations exist in the DB, so we can just
-                //clear the cache so future queries use the updated info in the DB
-                $otherObject->clear_cache($this->get_model()->get_this_model_name(), null, true);
-            } else {
-                //it's not saved, so it caches relations like this
-                $otherObject->cache($this->get_model()->get_this_model_name(), $this);
-            }
-        }
-        return $otherObject;
-    }
-
-
-
-    /**
-     * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
-     * model is related to a group of events, the $relationName should be 'Events', and should be a key in the EE
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
-     * from the cache
-     *
-     * @param mixed  $otherObjectModelObjectOrID
-     *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
-     *                to the DB yet
-     * @param string $relationName
-     * @param array  $where_query
-     *                You can optionally include an array of key=>value pairs that allow you to further constrict the
-     *                relation to being added. However, keep in mind that the columns (keys) given must match a column
-     *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
-     *                remember that if an exact match isn't found for these extra cols/val pairs, then a NEW row is
-     *                created in the join table.
-     * @return EE_Base_Class the relation was removed from
-     * @throws \EE_Error
-     */
-    public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = array())
-    {
-        if ($this->ID()) {
-            //if this exists in the DB, save the relation change to the DB too
-            $otherObject = $this->get_model()
-                                ->remove_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
-                                    $where_query);
-            $this->clear_cache($relationName, $otherObject);
-        } else {
-            //this doesn't exist in the DB, just remove it from the cache
-            $otherObject = $this->clear_cache($relationName, $otherObjectModelObjectOrID);
-        }
-        if ($otherObject instanceof EE_Base_Class) {
-            $otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
-        }
-        return $otherObject;
-    }
-
-
-
-    /**
-     * Removes ALL the related things for the $relationName.
-     *
-     * @param string $relationName
-     * @param array  $where_query_params like EEM_Base::get_all's $query_params[0] (where conditions)
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function _remove_relations($relationName, $where_query_params = array())
-    {
-        if ($this->ID()) {
-            //if this exists in the DB, save the relation change to the DB too
-            $otherObjects = $this->get_model()->remove_relations($this, $relationName, $where_query_params);
-            $this->clear_cache($relationName, null, true);
-        } else {
-            //this doesn't exist in the DB, just remove it from the cache
-            $otherObjects = $this->clear_cache($relationName, null, true);
-        }
-        if (is_array($otherObjects)) {
-            foreach ($otherObjects as $otherObject) {
-                $otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
-            }
-        }
-        return $otherObjects;
-    }
-
-
-
-    /**
-     * Gets all the related model objects of the specified type. Eg, if the current class if
-     * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
-     * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
-     * because we want to get even deleted items etc.
-     *
-     * @param string $relationName key in the model's _model_relations array
-     * @param array  $query_params like EEM_Base::get_all
-     * @return EE_Base_Class[] Results not necessarily indexed by IDs, because some results might not have primary keys
-     * @throws \EE_Error
-     *                             or might not be saved yet. Consider using EEM_Base::get_IDs() on these results if
-     *                             you want IDs
-     */
-    public function get_many_related($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            //this exists in the DB, so get the related things from either the cache or the DB
-            //if there are query parameters, forget about caching the related model objects.
-            if ($query_params) {
-                $related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
-            } else {
-                //did we already cache the result of this query?
-                $cached_results = $this->get_all_from_cache($relationName);
-                if ( ! $cached_results) {
-                    $related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
-                    //if no query parameters were passed, then we got all the related model objects
-                    //for that relation. We can cache them then.
-                    foreach ($related_model_objects as $related_model_object) {
-                        $this->cache($relationName, $related_model_object);
-                    }
-                } else {
-                    $related_model_objects = $cached_results;
-                }
-            }
-        } else {
-            //this doesn't exist in the DB, so just get the related things from the cache
-            $related_model_objects = $this->get_all_from_cache($relationName);
-        }
-        return $related_model_objects;
-    }
-
-
-
-    /**
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
-     * unless otherwise specified in the $query_params
-     *
-     * @param string $relation_name  model_name like 'Event', or 'Registration'
-     * @param array  $query_params   like EEM_Base::get_all's
-     * @param string $field_to_count name of field to count by. By default, uses primary key
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
-     *                               that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_related($relation_name, $query_params = array(), $field_to_count = null, $distinct = false)
-    {
-        return $this->get_model()->count_related($this, $relation_name, $query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
-     *
-     * @param string $relation_name model_name like 'Event', or 'Registration'
-     * @param array  $query_params  like EEM_Base::get_all's
-     * @param string $field_to_sum  name of field to count by.
-     *                              By default, uses primary key (which doesn't make much sense, so you should probably
-     *                              change it)
-     * @return int
-     */
-    public function sum_related($relation_name, $query_params = array(), $field_to_sum = null)
-    {
-        return $this->get_model()->sum_related($this, $relation_name, $query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Gets the first (ie, one) related model object of the specified type.
-     *
-     * @param string $relationName key in the model's _model_relations array
-     * @param array  $query_params like EEM_Base::get_all
-     * @return EE_Base_Class (not an array, a single object)
-     * @throws \EE_Error
-     */
-    public function get_first_related($relationName, $query_params = array())
-    {
-        if ($this->ID()) {//this exists in the DB, get from the cache OR the DB
-            //if they've provided some query parameters, don't bother trying to cache the result
-            //also make sure we're not caching the result of get_first_related
-            //on a relation which should have an array of objects (because the cache might have an array of objects)
-            if ($query_params
-                || ! $this->get_model()->related_settings_for($relationName)
-                     instanceof
-                     EE_Belongs_To_Relation
-            ) {
-                $related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
-            } else {
-                //first, check if we've already cached the result of this query
-                $cached_result = $this->get_one_from_cache($relationName);
-                if ( ! $cached_result) {
-                    $related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
-                    $this->cache($relationName, $related_model_object);
-                } else {
-                    $related_model_object = $cached_result;
-                }
-            }
-        } else {
-            $related_model_object = null;
-            //this doesn't exist in the Db, but maybe the relation is of type belongs to, and so the related thing might
-            if ($this->get_model()->related_settings_for($relationName) instanceof EE_Belongs_To_Relation) {
-                $related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
-            }
-            //this doesn't exist in the DB and apparently the thing it belongs to doesn't either, just get what's cached on this object
-            if ( ! $related_model_object) {
-                $related_model_object = $this->get_one_from_cache($relationName);
-            }
-        }
-        return $related_model_object;
-    }
-
-
-
-    /**
-     * Does a delete on all related objects of type $relationName and removes
-     * the current model object's relation to them. If they can't be deleted (because
-     * of blocking related model objects) does nothing. If the related model objects are
-     * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
-     * If this model object doesn't exist yet in the DB, just removes its related things
-     *
-     * @param string $relationName
-     * @param array  $query_params like EEM_Base::get_all's
-     * @return int how many deleted
-     * @throws \EE_Error
-     */
-    public function delete_related($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            $count = $this->get_model()->delete_related($this, $relationName, $query_params);
-        } else {
-            $count = count($this->get_all_from_cache($relationName));
-            $this->clear_cache($relationName, null, true);
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * Does a hard delete (ie, removes the DB row) on all related objects of type $relationName and removes
-     * the current model object's relation to them. If they can't be deleted (because
-     * of blocking related model objects) just does a soft delete on it instead, if possible.
-     * If the related thing isn't a soft-deletable model object, this function is identical
-     * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
-     *
-     * @param string $relationName
-     * @param array  $query_params like EEM_Base::get_all's
-     * @return int how many deleted (including those soft deleted)
-     * @throws \EE_Error
-     */
-    public function delete_related_permanently($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            $count = $this->get_model()->delete_related_permanently($this, $relationName, $query_params);
-        } else {
-            $count = count($this->get_all_from_cache($relationName));
-        }
-        $this->clear_cache($relationName, null, true);
-        return $count;
-    }
-
-
-
-    /**
-     * is_set
-     * Just a simple utility function children can use for checking if property exists
-     *
-     * @access  public
-     * @param  string $field_name property to check
-     * @return bool                              TRUE if existing,FALSE if not.
-     */
-    public function is_set($field_name)
-    {
-        return isset($this->_fields[$field_name]);
-    }
-
-
-
-    /**
-     * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
-     * EE_Error exception if they don't
-     *
-     * @param  mixed (string|array) $properties properties to check
-     * @throws EE_Error
-     * @return bool                              TRUE if existing, throw EE_Error if not.
-     */
-    protected function _property_exists($properties)
-    {
-        foreach ((array)$properties as $property_name) {
-            //first make sure this property exists
-            if ( ! $this->_fields[$property_name]) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
-                            'event_espresso'
-                        ),
-                        $property_name
-                    )
-                );
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * This simply returns an array of model fields for this object
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function model_field_array()
-    {
-        $fields = $this->get_model()->field_settings(false);
-        $properties = array();
-        //remove prepended underscore
-        foreach ($fields as $field_name => $settings) {
-            $properties[$field_name] = $this->get($field_name);
-        }
-        return $properties;
-    }
-
-
-
-    /**
-     * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
-     * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
-     * requiring a plugin to extend the EE_Base_Class (which works fine is there's only 1 plugin, but when will that
-     * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
-     * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
-     * was called, and an array of the original arguments passed to the function. Whatever their callback function
-     * returns will be returned by this function. Example: in functions.php (or in a plugin):
-     * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
-     * my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
-     *        return $previousReturnValue.$returnString;
-     * }
-     * require('EE_Answer.class.php');
-     * $answer= EE_Answer::new_instance(array('REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'));
-     * echo $answer->my_callback('monkeys',100);
-     * //will output "you called my_callback! and passed args:monkeys,100"
-     *
-     * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
-     * @param array  $args       array of original arguments passed to the function
-     * @throws EE_Error
-     * @return mixed whatever the plugin which calls add_filter decides
-     */
-    public function __call($methodName, $args)
-    {
-        $className = get_class($this);
-        $tagName = "FHEE__{$className}__{$methodName}";
-        if ( ! has_filter($tagName)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
-                        "event_espresso"
-                    ),
-                    $methodName,
-                    $className,
-                    $tagName
-                )
-            );
-        }
-        return apply_filters($tagName, null, $this, $args);
-    }
-
-
-
-    /**
-     * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
-     * A $previous_value can be specified in case there are many meta rows with the same key
-     *
-     * @param string $meta_key
-     * @param string $meta_value
-     * @param string $previous_value
-     * @return int records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
-     * @throws \EE_Error
-     * NOTE: if the values haven't changed, returns 0
-     */
-    public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
-    {
-        $query_params = array(
-            array(
-                'EXM_key'  => $meta_key,
-                'OBJ_ID'   => $this->ID(),
-                'EXM_type' => $this->get_model()->get_this_model_name(),
-            ),
-        );
-        if ($previous_value !== null) {
-            $query_params[0]['EXM_value'] = $meta_value;
-        }
-        $existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
-        if ( ! $existing_rows_like_that) {
-            return $this->add_extra_meta($meta_key, $meta_value);
-        } else {
-            foreach ($existing_rows_like_that as $existing_row) {
-                $existing_row->save(array('EXM_value' => $meta_value));
-            }
-            return count($existing_rows_like_that);
-        }
-    }
-
-
-
-    /**
-     * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
-     * no other extra meta for this model object have the same key. Returns TRUE if the
-     * extra meta row was entered, false if not
-     *
-     * @param string  $meta_key
-     * @param string  $meta_value
-     * @param boolean $unique
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function add_extra_meta($meta_key, $meta_value, $unique = false)
-    {
-        if ($unique) {
-            $existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
-                array(
-                    array(
-                        'EXM_key'  => $meta_key,
-                        'OBJ_ID'   => $this->ID(),
-                        'EXM_type' => $this->get_model()->get_this_model_name(),
-                    ),
-                )
-            );
-            if ($existing_extra_meta) {
-                return false;
-            }
-        }
-        $new_extra_meta = EE_Extra_Meta::new_instance(
-            array(
-                'EXM_key'   => $meta_key,
-                'EXM_value' => $meta_value,
-                'OBJ_ID'    => $this->ID(),
-                'EXM_type'  => $this->get_model()->get_this_model_name(),
-            )
-        );
-        $new_extra_meta->save();
-        return true;
-    }
-
-
-
-    /**
-     * Deletes all the extra meta rows for this record as specified by key. If $meta_value
-     * is specified, only deletes extra meta records with that value.
-     *
-     * @param string $meta_key
-     * @param string $meta_value
-     * @return int number of extra meta rows deleted
-     * @throws \EE_Error
-     */
-    public function delete_extra_meta($meta_key, $meta_value = null)
-    {
-        $query_params = array(
-            array(
-                'EXM_key'  => $meta_key,
-                'OBJ_ID'   => $this->ID(),
-                'EXM_type' => $this->get_model()->get_this_model_name(),
-            ),
-        );
-        if ($meta_value !== null) {
-            $query_params[0]['EXM_value'] = $meta_value;
-        }
-        return EEM_Extra_Meta::instance()->delete($query_params);
-    }
-
-
-
-    /**
-     * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
-     * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
-     * You can specify $default is case you haven't found the extra meta
-     *
-     * @param string  $meta_key
-     * @param boolean $single
-     * @param mixed   $default if we don't find anything, what should we return?
-     * @return mixed single value if $single; array if ! $single
-     * @throws \EE_Error
-     */
-    public function get_extra_meta($meta_key, $single = false, $default = null)
-    {
-        if ($single) {
-            $result = $this->get_first_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
-            if ($result instanceof EE_Extra_Meta) {
-                return $result->value();
-            } else {
-                return $default;
-            }
-        } else {
-            $results = $this->get_many_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
-            if ($results) {
-                $values = array();
-                foreach ($results as $result) {
-                    if ($result instanceof EE_Extra_Meta) {
-                        $values[$result->ID()] = $result->value();
-                    }
-                }
-                return $values;
-            } else {
-                return $default;
-            }
-        }
-    }
-
-
-
-    /**
-     * Returns a simple array of all the extra meta associated with this model object.
-     * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
-     * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
-     * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
-     * If $one_of_each_key is false, it will return an array with the top-level keys being
-     * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
-     * finally the extra meta's value as each sub-value. (eg
-     * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
-     *
-     * @param boolean $one_of_each_key
-     * @return array
-     * @throws \EE_Error
-     */
-    public function all_extra_meta_array($one_of_each_key = true)
-    {
-        $return_array = array();
-        if ($one_of_each_key) {
-            $extra_meta_objs = $this->get_many_related('Extra_Meta', array('group_by' => 'EXM_key'));
-            foreach ($extra_meta_objs as $extra_meta_obj) {
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    $return_array[$extra_meta_obj->key()] = $extra_meta_obj->value();
-                }
-            }
-        } else {
-            $extra_meta_objs = $this->get_many_related('Extra_Meta');
-            foreach ($extra_meta_objs as $extra_meta_obj) {
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    if ( ! isset($return_array[$extra_meta_obj->key()])) {
-                        $return_array[$extra_meta_obj->key()] = array();
-                    }
-                    $return_array[$extra_meta_obj->key()][$extra_meta_obj->ID()] = $extra_meta_obj->value();
-                }
-            }
-        }
-        return $return_array;
-    }
-
-
-
-    /**
-     * Gets a pretty nice displayable nice for this model object. Often overridden
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function name()
-    {
-        //find a field that's not a text field
-        $field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
-        if ($field_we_can_use) {
-            return $this->get($field_we_can_use->get_name());
-        } else {
-            $first_few_properties = $this->model_field_array();
-            $first_few_properties = array_slice($first_few_properties, 0, 3);
-            $name_parts = array();
-            foreach ($first_few_properties as $name => $value) {
-                $name_parts[] = "$name:$value";
-            }
-            return implode(",", $name_parts);
-        }
-    }
-
-
-
-    /**
-     * in_entity_map
-     * Checks if this model object has been proven to already be in the entity map
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function in_entity_map()
-    {
-        if ($this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this) {
-            //well, if we looked, did we find it in the entity map?
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * refresh_from_db
-     * Makes sure the fields and values on this model object are in-sync with what's in the database.
-     *
-     * @throws EE_Error if this model object isn't in the entity mapper (because then you should
-     * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
-     */
-    public function refresh_from_db()
-    {
-        if ($this->ID() && $this->in_entity_map()) {
-            $this->get_model()->refresh_entity_map_from_db($this->ID());
-        } else {
-            //if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
-            //if it has an ID but it's not in the map, and you're asking me to refresh it
-            //that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
-            //absolutely nothing in it for this ID
-            if (WP_DEBUG) {
-                throw new EE_Error(
-                    sprintf(
-                        __('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
-                            'event_espresso'),
-                        $this->ID(),
-                        get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                        get_class($this->get_model()) . '::instance()->refresh_entity_map()'
-                    )
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
-     * (probably a bad assumption they have made, oh well)
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        try {
-            return sprintf('%s (%s)', $this->name(), $this->ID());
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            return '';
-        }
-    }
-
-
-
-    /**
-     * Clear related model objects if they're already in the DB, because otherwise when we
-     * UN-serialize this model object we'll need to be careful to add them to the entity map.
-     * This means if we have made changes to those related model objects, and want to unserialize
-     * the this model object on a subsequent request, changes to those related model objects will be lost.
-     * Instead, those related model objects should be directly serialized and stored.
-     * Eg, the following won't work:
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
-     * $att = $reg->attendee();
-     * $att->set( 'ATT_fname', 'Dirk' );
-     * update_option( 'my_option', serialize( $reg ) );
-     * //END REQUEST
-     * //START NEXT REQUEST
-     * $reg = get_option( 'my_option' );
-     * $reg->attendee()->save();
-     * And would need to be replace with:
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
-     * $att = $reg->attendee();
-     * $att->set( 'ATT_fname', 'Dirk' );
-     * update_option( 'my_option', serialize( $reg ) );
-     * //END REQUEST
-     * //START NEXT REQUEST
-     * $att = get_option( 'my_option' );
-     * $att->save();
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function __sleep()
-    {
-        foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $classname = 'EE_' . $this->get_model()->get_this_model_name();
-                if (
-                    $this->get_one_from_cache($relation_name) instanceof $classname
-                    && $this->get_one_from_cache($relation_name)->ID()
-                ) {
-                    $this->clear_cache($relation_name, $this->get_one_from_cache($relation_name)->ID());
-                }
-            }
-        }
-        $this->_props_n_values_provided_in_constructor = array();
-        return array_keys(get_object_vars($this));
-    }
-
-
-
-    /**
-     * restore _props_n_values_provided_in_constructor
-     * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
-     * and therefore should NOT be used to determine if state change has occurred since initial construction.
-     * At best, you would only be able to detect if state change has occurred during THIS request.
-     */
-    public function __wakeup()
-    {
-        $this->_props_n_values_provided_in_constructor = $this->_fields;
-    }
+	/**
+	 * This is an array of the original properties and values provided during construction
+	 * of this model object. (keys are model field names, values are their values).
+	 * This list is important to remember so that when we are merging data from the db, we know
+	 * which values to override and which to not override.
+	 *
+	 * @var array
+	 */
+	protected $_props_n_values_provided_in_constructor;
+
+	/**
+	 * Timezone
+	 * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
+	 * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
+	 * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
+	 * access to it.
+	 *
+	 * @var string
+	 */
+	protected $_timezone;
+
+
+
+	/**
+	 * date format
+	 * pattern or format for displaying dates
+	 *
+	 * @var string $_dt_frmt
+	 */
+	protected $_dt_frmt;
+
+
+
+	/**
+	 * time format
+	 * pattern or format for displaying time
+	 *
+	 * @var string $_tm_frmt
+	 */
+	protected $_tm_frmt;
+
+
+
+	/**
+	 * This property is for holding a cached array of object properties indexed by property name as the key.
+	 * The purpose of this is for setting a cache on properties that may have calculated values after a
+	 * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
+	 * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
+	 *
+	 * @var array
+	 */
+	protected $_cached_properties = array();
+
+	/**
+	 * An array containing keys of the related model, and values are either an array of related mode objects or a
+	 * single
+	 * related model object. see the model's _model_relations. The keys should match those specified. And if the
+	 * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
+	 * all others have an array)
+	 *
+	 * @var array
+	 */
+	protected $_model_relations = array();
+
+	/**
+	 * Array where keys are field names (see the model's _fields property) and values are their values. To see what
+	 * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
+	 *
+	 * @var array
+	 */
+	protected $_fields = array();
+
+	/**
+	 * @var boolean indicating whether or not this model object is intended to ever be saved
+	 * For example, we might create model objects intended to only be used for the duration
+	 * of this request and to be thrown away, and if they were accidentally saved
+	 * it would be a bug.
+	 */
+	protected $_allow_persist = true;
+
+
+
+	/**
+	 * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children
+	 * play nice
+	 *
+	 * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
+	 *                                                         layer of the model's _fields array, (eg, EVT_ID,
+	 *                                                         TXN_amount, QST_name, etc) and values are their values
+	 * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
+	 *                                                         corresponding db model or not.
+	 * @param string  $timezone                                indicate what timezone you want any datetime fields to
+	 *                                                         be in when instantiating a EE_Base_Class object.
+	 * @param array   $date_formats                            An array of date formats to set on construct where first
+	 *                                                         value is the date_format and second value is the time
+	 *                                                         format.
+	 * @throws EE_Error
+	 */
+	protected function __construct($fieldValues = array(), $bydb = false, $timezone = '', $date_formats = array())
+	{
+		$className = get_class($this);
+		do_action("AHEE__{$className}__construct", $this, $fieldValues);
+		$model = $this->get_model();
+		$model_fields = $model->field_settings(false);
+		// ensure $fieldValues is an array
+		$fieldValues = is_array($fieldValues) ? $fieldValues : array($fieldValues);
+		// EEH_Debug_Tools::printr( $fieldValues, '$fieldValues  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		// verify client code has not passed any invalid field names
+		foreach ($fieldValues as $field_name => $field_value) {
+			if ( ! isset($model_fields[$field_name])) {
+				throw new EE_Error(sprintf(__("Invalid field (%s) passed to constructor of %s. Allowed fields are :%s",
+					"event_espresso"), $field_name, get_class($this), implode(", ", array_keys($model_fields))));
+			}
+		}
+		// EEH_Debug_Tools::printr( $model_fields, '$model_fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
+		if ( ! empty($date_formats) && is_array($date_formats)) {
+			list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
+		} else {
+			//set default formats for date and time
+			$this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
+			$this->_tm_frmt = (string)get_option('time_format', 'g:i a');
+		}
+		//if db model is instantiating
+		if ($bydb) {
+			//client code has indicated these field values are from the database
+			foreach ($model_fields as $fieldName => $field) {
+				$this->set_from_db($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null);
+			}
+		} else {
+			//we're constructing a brand
+			//new instance of the model object. Generally, this means we'll need to do more field validation
+			foreach ($model_fields as $fieldName => $field) {
+				$this->set($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null, true);
+			}
+		}
+		//remember what values were passed to this constructor
+		$this->_props_n_values_provided_in_constructor = $fieldValues;
+		//remember in entity mapper
+		if ( ! $bydb && $model->has_primary_key_field() && $this->ID()) {
+			$model->add_to_entity_map($this);
+		}
+		//setup all the relations
+		foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$this->_model_relations[$relation_name] = null;
+			} else {
+				$this->_model_relations[$relation_name] = array();
+			}
+		}
+		/**
+		 * Action done at the end of each model object construction
+		 *
+		 * @param EE_Base_Class $this the model object just created
+		 */
+		do_action('AHEE__EE_Base_Class__construct__finished', $this);
+	}
+
+
+
+	/**
+	 * Gets whether or not this model object is allowed to persist/be saved to the database.
+	 *
+	 * @return boolean
+	 */
+	public function allow_persist()
+	{
+		return $this->_allow_persist;
+	}
+
+
+
+	/**
+	 * Sets whether or not this model object should be allowed to be saved to the DB.
+	 * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
+	 * you got new information that somehow made you change your mind.
+	 *
+	 * @param boolean $allow_persist
+	 * @return boolean
+	 */
+	public function set_allow_persist($allow_persist)
+	{
+		return $this->_allow_persist = $allow_persist;
+	}
+
+
+
+	/**
+	 * Gets the field's original value when this object was constructed during this request.
+	 * This can be helpful when determining if a model object has changed or not
+	 *
+	 * @param string $field_name
+	 * @return mixed|null
+	 * @throws \EE_Error
+	 */
+	public function get_original($field_name)
+	{
+		if (isset($this->_props_n_values_provided_in_constructor[$field_name])
+			&& $field_settings = $this->get_model()->field_settings_for($field_name)
+		) {
+			return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[$field_name]);
+		} else {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * @param EE_Base_Class $obj
+	 * @return string
+	 */
+	public function get_class($obj)
+	{
+		return get_class($obj);
+	}
+
+
+
+	/**
+	 * Overrides parent because parent expects old models.
+	 * This also doesn't do any validation, and won't work for serialized arrays
+	 *
+	 * @param    string $field_name
+	 * @param    mixed  $field_value
+	 * @param bool      $use_default
+	 * @throws \EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		$field_obj = $this->get_model()->field_settings_for($field_name);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			//			if ( method_exists( $field_obj, 'set_timezone' )) {
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$field_obj->set_timezone($this->_timezone);
+				$field_obj->set_date_format($this->_dt_frmt);
+				$field_obj->set_time_format($this->_tm_frmt);
+			}
+			$holder_of_value = $field_obj->prepare_for_set($field_value);
+			//should the value be null?
+			if (($field_value === null || $holder_of_value === null || $holder_of_value === '') && $use_default) {
+				$this->_fields[$field_name] = $field_obj->get_default_value();
+				/**
+				 * To save having to refactor all the models, if a default value is used for a
+				 * EE_Datetime_Field, and that value is not null nor is it a DateTime
+				 * object.  Then let's do a set again to ensure that it becomes a DateTime
+				 * object.
+				 *
+				 * @since 4.6.10+
+				 */
+				if (
+					$field_obj instanceof EE_Datetime_Field
+					&& $this->_fields[$field_name] !== null
+					&& ! $this->_fields[$field_name] instanceof DateTime
+				) {
+					empty($this->_fields[$field_name])
+						? $this->set($field_name, time())
+						: $this->set($field_name, $this->_fields[$field_name]);
+				}
+			} else {
+				$this->_fields[$field_name] = $holder_of_value;
+			}
+			//if we're not in the constructor...
+			//now check if what we set was a primary key
+			if (
+				//note: props_n_values_provided_in_constructor is only set at the END of the constructor
+				$this->_props_n_values_provided_in_constructor
+				&& $field_value
+				&& $field_name === self::_get_primary_key_name(get_class($this))
+			) {
+				//if so, we want all this object's fields to be filled either with
+				//what we've explicitly set on this model
+				//or what we have in the db
+				// echo "setting primary key!";
+				$fields_on_model = self::_get_model(get_class($this))->field_settings();
+				$obj_in_db = self::_get_model(get_class($this))->get_one_by_ID($field_value);
+				foreach ($fields_on_model as $field_obj) {
+					if ( ! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
+						 && $field_obj->get_name() !== $field_name
+					) {
+						$this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
+					}
+				}
+				//oh this model object has an ID? well make sure its in the entity mapper
+				$this->get_model()->add_to_entity_map($this);
+			}
+			//let's unset any cache for this field_name from the $_cached_properties property.
+			$this->_clear_cached_property($field_name);
+		} else {
+			throw new EE_Error(sprintf(__("A valid EE_Model_Field_Base could not be found for the given field name: %s",
+				"event_espresso"), $field_name));
+		}
+	}
+
+
+
+	/**
+	 * This sets the field value on the db column if it exists for the given $column_name or
+	 * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
+	 *
+	 * @see EE_message::get_column_value for related documentation on the necessity of this method.
+	 * @param string $field_name  Must be the exact column name.
+	 * @param mixed  $field_value The value to set.
+	 * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
+	 * @throws \EE_Error
+	 */
+	public function set_field_or_extra_meta($field_name, $field_value)
+	{
+		if ($this->get_model()->has_field($field_name)) {
+			$this->set($field_name, $field_value);
+			return true;
+		} else {
+			//ensure this object is saved first so that extra meta can be properly related.
+			$this->save();
+			return $this->update_extra_meta($field_name, $field_value);
+		}
+	}
+
+
+
+	/**
+	 * This retrieves the value of the db column set on this class or if that's not present
+	 * it will attempt to retrieve from extra_meta if found.
+	 * Example Usage:
+	 * Via EE_Message child class:
+	 * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
+	 * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
+	 * also have additional main fields specific to the messenger.  The system accommodates those extra
+	 * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
+	 * value for those extra fields dynamically via the EE_message object.
+	 *
+	 * @param  string $field_name expecting the fully qualified field name.
+	 * @return mixed|null  value for the field if found.  null if not found.
+	 * @throws \EE_Error
+	 */
+	public function get_field_or_extra_meta($field_name)
+	{
+		if ($this->get_model()->has_field($field_name)) {
+			$column_value = $this->get($field_name);
+		} else {
+			//This isn't a column in the main table, let's see if it is in the extra meta.
+			$column_value = $this->get_extra_meta($field_name, true, null);
+		}
+		return $column_value;
+	}
+
+
+
+	/**
+	 * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
+	 * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
+	 * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
+	 * available to all child classes that may be using the EE_Datetime_Field for a field data type.
+	 *
+	 * @access public
+	 * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_timezone($timezone = '')
+	{
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
+		//make sure we clear all cached properties because they won't be relevant now
+		$this->_clear_cached_properties();
+		//make sure we update field settings and the date for all EE_Datetime_Fields
+		$model_fields = $this->get_model()->field_settings(false);
+		foreach ($model_fields as $field_name => $field_obj) {
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$field_obj->set_timezone($this->_timezone);
+				if (isset($this->_fields[$field_name]) && $this->_fields[$field_name] instanceof DateTime) {
+					$this->_fields[$field_name]->setTimezone(new DateTimeZone($this->_timezone));
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string timezone string
+	 */
+	public function get_timezone()
+	{
+		return $this->_timezone;
+	}
+
+
+
+	/**
+	 * This sets the internal date format to what is sent in to be used as the new default for the class
+	 * internally instead of wp set date format options
+	 *
+	 * @since 4.6
+	 * @param string $format should be a format recognizable by PHP date() functions.
+	 */
+	public function set_date_format($format)
+	{
+		$this->_dt_frmt = $format;
+		//clear cached_properties because they won't be relevant now.
+		$this->_clear_cached_properties();
+	}
+
+
+
+	/**
+	 * This sets the internal time format string to what is sent in to be used as the new default for the
+	 * class internally instead of wp set time format options.
+	 *
+	 * @since 4.6
+	 * @param string $format should be a format recognizable by PHP date() functions.
+	 */
+	public function set_time_format($format)
+	{
+		$this->_tm_frmt = $format;
+		//clear cached_properties because they won't be relevant now.
+		$this->_clear_cached_properties();
+	}
+
+
+
+	/**
+	 * This returns the current internal set format for the date and time formats.
+	 *
+	 * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
+	 *                             where the first value is the date format and the second value is the time format.
+	 * @return mixed string|array
+	 */
+	public function get_format($full = true)
+	{
+		return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
+	}
+
+
+
+	/**
+	 * cache
+	 * stores the passed model object on the current model object.
+	 * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
+	 *
+	 * @param string        $relationName    one of the keys in the _model_relations array on the model. Eg
+	 *                                       'Registration' associated with this model object
+	 * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
+	 *                                       that could be a payment or a registration)
+	 * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
+	 *                                       items which will be stored in an array on this object
+	 * @throws EE_Error
+	 * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
+	 *                  related thing, no array)
+	 */
+	public function cache($relationName = '', $object_to_cache = null, $cache_id = null)
+	{
+		// its entirely possible that there IS no related object yet in which case there is nothing to cache.
+		if ( ! $object_to_cache instanceof EE_Base_Class) {
+			return false;
+		}
+		// also get "how" the object is related, or throw an error
+		if ( ! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
+			throw new EE_Error(sprintf(__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
+				$relationName, get_class($this)));
+		}
+		// how many things are related ?
+		if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+			// if it's a "belongs to" relationship, then there's only one related model object  eg, if this is a registration, there's only 1 attendee for it
+			// so for these model objects just set it to be cached
+			$this->_model_relations[$relationName] = $object_to_cache;
+			$return = true;
+		} else {
+			// otherwise, this is the "many" side of a one to many relationship, so we'll add the object to the array of related objects for that type.
+			// eg: if this is an event, there are many registrations for that event, so we cache the registrations in an array
+			if ( ! is_array($this->_model_relations[$relationName])) {
+				// if for some reason, the cached item is a model object, then stick that in the array, otherwise start with an empty array
+				$this->_model_relations[$relationName] = $this->_model_relations[$relationName] instanceof EE_Base_Class
+					? array($this->_model_relations[$relationName]) : array();
+			}
+			// first check for a cache_id which is normally empty
+			if ( ! empty($cache_id)) {
+				// if the cache_id exists, then it means we are purposely trying to cache this with a known key that can then be used to retrieve the object later on
+				$this->_model_relations[$relationName][$cache_id] = $object_to_cache;
+				$return = $cache_id;
+			} elseif ($object_to_cache->ID()) {
+				// OR the cached object originally came from the db, so let's just use it's PK for an ID
+				$this->_model_relations[$relationName][$object_to_cache->ID()] = $object_to_cache;
+				$return = $object_to_cache->ID();
+			} else {
+				// OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
+				$this->_model_relations[$relationName][] = $object_to_cache;
+				// move the internal pointer to the end of the array
+				end($this->_model_relations[$relationName]);
+				// and grab the key so that we can return it
+				$return = key($this->_model_relations[$relationName]);
+			}
+		}
+		return $return;
+	}
+
+
+
+	/**
+	 * For adding an item to the cached_properties property.
+	 *
+	 * @access protected
+	 * @param string      $fieldname the property item the corresponding value is for.
+	 * @param mixed       $value     The value we are caching.
+	 * @param string|null $cache_type
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _set_cached_property($fieldname, $value, $cache_type = null)
+	{
+		//first make sure this property exists
+		$this->get_model()->field_settings_for($fieldname);
+		$cache_type = empty($cache_type) ? 'standard' : $cache_type;
+		$this->_cached_properties[$fieldname][$cache_type] = $value;
+	}
+
+
+
+	/**
+	 * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
+	 * This also SETS the cache if we return the actual property!
+	 *
+	 * @param string $fieldname        the name of the property we're trying to retrieve
+	 * @param bool   $pretty
+	 * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
+	 *                                 (in cases where the same property may be used for different outputs
+	 *                                 - i.e. datetime, money etc.)
+	 *                                 It can also accept certain pre-defined "schema" strings
+	 *                                 to define how to output the property.
+	 *                                 see the field's prepare_for_pretty_echoing for what strings can be used
+	 * @return mixed                   whatever the value for the property is we're retrieving
+	 * @throws \EE_Error
+	 */
+	protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
+	{
+		//verify the field exists
+		$this->get_model()->field_settings_for($fieldname);
+		$cache_type = $pretty ? 'pretty' : 'standard';
+		$cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
+		if (isset($this->_cached_properties[$fieldname][$cache_type])) {
+			return $this->_cached_properties[$fieldname][$cache_type];
+		}
+		$field_obj = $this->get_model()->field_settings_for($fieldname);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			// If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
+			}
+			if ( ! isset($this->_fields[$fieldname])) {
+				$this->_fields[$fieldname] = null;
+			}
+			$value = $pretty
+				? $field_obj->prepare_for_pretty_echoing($this->_fields[$fieldname], $extra_cache_ref)
+				: $field_obj->prepare_for_get($this->_fields[$fieldname]);
+			$this->_set_cached_property($fieldname, $value, $cache_type);
+			return $value;
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * set timezone, formats, and output for EE_Datetime_Field objects
+	 *
+	 * @param \EE_Datetime_Field $datetime_field
+	 * @param bool               $pretty
+	 * @param null $date_or_time
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _prepare_datetime_field(
+		EE_Datetime_Field $datetime_field,
+		$pretty = false,
+		$date_or_time = null
+	) {
+		$datetime_field->set_timezone($this->_timezone);
+		$datetime_field->set_date_format($this->_dt_frmt, $pretty);
+		$datetime_field->set_time_format($this->_tm_frmt, $pretty);
+		//set the output returned
+		switch ($date_or_time) {
+			case 'D' :
+				$datetime_field->set_date_time_output('date');
+				break;
+			case 'T' :
+				$datetime_field->set_date_time_output('time');
+				break;
+			default :
+				$datetime_field->set_date_time_output();
+		}
+	}
+
+
+
+	/**
+	 * This just takes care of clearing out the cached_properties
+	 *
+	 * @return void
+	 */
+	protected function _clear_cached_properties()
+	{
+		$this->_cached_properties = array();
+	}
+
+
+
+	/**
+	 * This just clears out ONE property if it exists in the cache
+	 *
+	 * @param  string $property_name the property to remove if it exists (from the _cached_properties array)
+	 * @return void
+	 */
+	protected function _clear_cached_property($property_name)
+	{
+		if (isset($this->_cached_properties[$property_name])) {
+			unset($this->_cached_properties[$property_name]);
+		}
+	}
+
+
+
+	/**
+	 * Ensures that this related thing is a model object.
+	 *
+	 * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
+	 * @param string $model_name   name of the related thing, eg 'Attendee',
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
+	{
+		$other_model_instance = self::_get_model_instance_with_name(
+			self::_get_model_classname($model_name),
+			$this->_timezone
+		);
+		return $other_model_instance->ensure_is_obj($object_or_id);
+	}
+
+
+
+	/**
+	 * Forgets the cached model of the given relation Name. So the next time we request it,
+	 * we will fetch it again from the database. (Handy if you know it's changed somehow).
+	 * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
+	 * then only remove that one object from our cached array. Otherwise, clear the entire list
+	 *
+	 * @param string $relationName                         one of the keys in the _model_relations array on the model.
+	 *                                                     Eg 'Registration'
+	 * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
+	 *                                                     if you intend to use $clear_all = TRUE, or the relation only
+	 *                                                     has 1 object anyways (ie, it's a BelongsToRelation)
+	 * @param bool   $clear_all                            This flags clearing the entire cache relation property if
+	 *                                                     this is HasMany or HABTM.
+	 * @throws EE_Error
+	 * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a
+	 *                       relation from all
+	 */
+	public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false)
+	{
+		$relationship_to_model = $this->get_model()->related_settings_for($relationName);
+		$index_in_cache = '';
+		if ( ! $relationship_to_model) {
+			throw new EE_Error(
+				sprintf(
+					__("There is no relationship to %s on a %s. Cannot clear that cache", 'event_espresso'),
+					$relationName,
+					get_class($this)
+				)
+			);
+		}
+		if ($clear_all) {
+			$obj_removed = true;
+			$this->_model_relations[$relationName] = null;
+		} elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+			$obj_removed = $this->_model_relations[$relationName];
+			$this->_model_relations[$relationName] = null;
+		} else {
+			if ($object_to_remove_or_index_into_array instanceof EE_Base_Class
+				&& $object_to_remove_or_index_into_array->ID()
+			) {
+				$index_in_cache = $object_to_remove_or_index_into_array->ID();
+				if (is_array($this->_model_relations[$relationName])
+					&& ! isset($this->_model_relations[$relationName][$index_in_cache])
+				) {
+					$index_found_at = null;
+					//find this object in the array even though it has a different key
+					foreach ($this->_model_relations[$relationName] as $index => $obj) {
+						if (
+							$obj instanceof EE_Base_Class
+							&& (
+								$obj == $object_to_remove_or_index_into_array
+								|| $obj->ID() === $object_to_remove_or_index_into_array->ID()
+							)
+						) {
+							$index_found_at = $index;
+							break;
+						}
+					}
+					if ($index_found_at) {
+						$index_in_cache = $index_found_at;
+					} else {
+						//it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
+						//if it wasn't in it to begin with. So we're done
+						return $object_to_remove_or_index_into_array;
+					}
+				}
+			} elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
+				//so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
+				foreach ($this->get_all_from_cache($relationName) as $index => $potentially_obj_we_want) {
+					if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
+						$index_in_cache = $index;
+					}
+				}
+			} else {
+				$index_in_cache = $object_to_remove_or_index_into_array;
+			}
+			//supposedly we've found it. But it could just be that the client code
+			//provided a bad index/object
+			if (
+			isset(
+				$this->_model_relations[$relationName],
+				$this->_model_relations[$relationName][$index_in_cache]
+			)
+			) {
+				$obj_removed = $this->_model_relations[$relationName][$index_in_cache];
+				unset($this->_model_relations[$relationName][$index_in_cache]);
+			} else {
+				//that thing was never cached anyways.
+				$obj_removed = null;
+			}
+		}
+		return $obj_removed;
+	}
+
+
+
+	/**
+	 * update_cache_after_object_save
+	 * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
+	 * obtained after being saved to the db
+	 *
+	 * @param string         $relationName       - the type of object that is cached
+	 * @param \EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
+	 * @param string         $current_cache_id   - the ID that was used when originally caching the object
+	 * @return boolean TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function update_cache_after_object_save(
+		$relationName,
+		EE_Base_Class $newly_saved_object,
+		$current_cache_id = ''
+	) {
+		// verify that incoming object is of the correct type
+		$obj_class = 'EE_' . $relationName;
+		if ($newly_saved_object instanceof $obj_class) {
+			/* @type EE_Base_Class $newly_saved_object */
+			// now get the type of relation
+			$relationship_to_model = $this->get_model()->related_settings_for($relationName);
+			// if this is a 1:1 relationship
+			if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+				// then just replace the cached object with the newly saved object
+				$this->_model_relations[$relationName] = $newly_saved_object;
+				return true;
+				// or if it's some kind of sordid feral polyamorous relationship...
+			} elseif (is_array($this->_model_relations[$relationName])
+					  && isset($this->_model_relations[$relationName][$current_cache_id])
+			) {
+				// then remove the current cached item
+				unset($this->_model_relations[$relationName][$current_cache_id]);
+				// and cache the newly saved object using it's new ID
+				$this->_model_relations[$relationName][$newly_saved_object->ID()] = $newly_saved_object;
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
+	 *
+	 * @param string $relationName
+	 * @return EE_Base_Class
+	 */
+	public function get_one_from_cache($relationName)
+	{
+		$cached_array_or_object = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName]
+			: null;
+		if (is_array($cached_array_or_object)) {
+			return array_shift($cached_array_or_object);
+		} else {
+			return $cached_array_or_object;
+		}
+	}
+
+
+
+	/**
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
+	 *
+	 * @param string $relationName
+	 * @throws \EE_Error
+	 * @return EE_Base_Class[] NOT necessarily indexed by primary keys
+	 */
+	public function get_all_from_cache($relationName)
+	{
+		$objects = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName] : array();
+		// if the result is not an array, but exists, make it an array
+		$objects = is_array($objects) ? $objects : array($objects);
+		//bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
+		//basically, if this model object was stored in the session, and these cached model objects
+		//already have IDs, let's make sure they're in their model's entity mapper
+		//otherwise we will have duplicates next time we call
+		// EE_Registry::instance()->load_model( $relationName )->get_one_by_ID( $result->ID() );
+		$model = EE_Registry::instance()->load_model($relationName);
+		foreach ($objects as $model_object) {
+			if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
+				//ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
+				if ($model_object->ID()) {
+					$model->add_to_entity_map($model_object);
+				}
+			} else {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
+							'event_espresso'
+						),
+						$relationName,
+						gettype($model_object)
+					)
+				);
+			}
+		}
+		return $objects;
+	}
+
+
+
+	/**
+	 * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param int   $limit              How many objects to return.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function next_x($field_to_order_by = null, $limit = 1, $query_params = array(), $columns_to_select = null)
+	{
+		$field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
+			? $this->get_model()->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $this->get_model()->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param int   $limit              How many objects to return.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function previous_x(
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = array(),
+		$columns_to_select = null
+	) {
+		$field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
+			? $this->get_model()->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $this->get_model()->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Returns the next EE_Base_Class object in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function next($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
+	{
+		$field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
+			? $this->get_model()->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $this->get_model()->next($current_value, $field, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Returns the previous EE_Base_Class object in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
+	 *                                  you can indicate just the column you want returned
+	 * @return array|EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function previous($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
+	{
+		$field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
+			? $this->get_model()->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $this->get_model()->previous($current_value, $field, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Overrides parent because parent expects old models.
+	 * This also doesn't do any validation, and won't work for serialized arrays
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value_from_db
+	 * @throws \EE_Error
+	 */
+	public function set_from_db($field_name, $field_value_from_db)
+	{
+		$field_obj = $this->get_model()->field_settings_for($field_name);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			//you would think the DB has no NULLs for non-null label fields right? wrong!
+			//eg, a CPT model object could have an entry in the posts table, but no
+			//entry in the meta table. Meaning that all its columns in the meta table
+			//are null! yikes! so when we find one like that, use defaults for its meta columns
+			if ($field_value_from_db === null) {
+				if ($field_obj->is_nullable()) {
+					//if the field allows nulls, then let it be null
+					$field_value = null;
+				} else {
+					$field_value = $field_obj->get_default_value();
+				}
+			} else {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
+			}
+			$this->_fields[$field_name] = $field_value;
+			$this->_clear_cached_property($field_name);
+		}
+	}
+
+
+
+	/**
+	 * verifies that the specified field is of the correct type
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function get($field_name, $extra_cache_ref = null)
+	{
+		return $this->_get_cached_property($field_name, false, $extra_cache_ref);
+	}
+
+
+
+	/**
+	 * This method simply returns the RAW unprocessed value for the given property in this class
+	 *
+	 * @param  string $field_name A valid fieldname
+	 * @return mixed              Whatever the raw value stored on the property is.
+	 * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
+	 */
+	public function get_raw($field_name)
+	{
+		$field_settings = $this->get_model()->field_settings_for($field_name);
+		return $field_settings instanceof EE_Datetime_Field && $this->_fields[$field_name] instanceof DateTime
+			? $this->_fields[$field_name]->format('U')
+			: $this->_fields[$field_name];
+	}
+
+
+
+	/**
+	 * This is used to return the internal DateTime object used for a field that is a
+	 * EE_Datetime_Field.
+	 *
+	 * @param string $field_name               The field name retrieving the DateTime object.
+	 * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
+	 * @throws \EE_Error
+	 *                                         an error is set and false returned.  If the field IS an
+	 *                                         EE_Datetime_Field and but the field value is null, then
+	 *                                         just null is returned (because that indicates that likely
+	 *                                         this field is nullable).
+	 */
+	public function get_DateTime_object($field_name)
+	{
+		$field_settings = $this->get_model()->field_settings_for($field_name);
+		if ( ! $field_settings instanceof EE_Datetime_Field) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
+						'event_espresso'
+					),
+					$field_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $this->_fields[$field_name];
+	}
+
+
+
+	/**
+	 * To be used in template to immediately echo out the value, and format it for output.
+	 * Eg, should call stripslashes and whatnot before echoing
+	 *
+	 * @param string $field_name      the name of the field as it appears in the DB
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function e($field_name, $extra_cache_ref = null)
+	{
+		echo $this->get_pretty($field_name, $extra_cache_ref);
+	}
+
+
+
+	/**
+	 * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
+	 * can be easily used as the value of form input.
+	 *
+	 * @param string $field_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function f($field_name)
+	{
+		$this->e($field_name, 'form_input');
+	}
+
+
+
+	/**
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($field_name, $extra_cache_ref = null)
+	{
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
+	}
+
+
+
+	/**
+	 * This simply returns the datetime for the given field name
+	 * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
+	 * (and the equivalent e_date, e_time, e_datetime).
+	 *
+	 * @access   protected
+	 * @param string   $field_name   Field on the instantiated EE_Base_Class child object
+	 * @param string   $dt_frmt      valid datetime format used for date
+	 *                               (if '' then we just use the default on the field,
+	 *                               if NULL we use the last-used format)
+	 * @param string   $tm_frmt      Same as above except this is for time format
+	 * @param string   $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
+	 * @param  boolean $echo         Whether the dtt is echoing using pretty echoing or just returned using vanilla get
+	 * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
+	 *                               if field is not a valid dtt field, or void if echoing
+	 * @throws \EE_Error
+	 */
+	protected function _get_datetime($field_name, $dt_frmt = '', $tm_frmt = '', $date_or_time = '', $echo = false)
+	{
+		// clear cached property
+		$this->_clear_cached_property($field_name);
+		//reset format properties because they are used in get()
+		$this->_dt_frmt = $dt_frmt !== '' ? $dt_frmt : $this->_dt_frmt;
+		$this->_tm_frmt = $tm_frmt !== '' ? $tm_frmt : $this->_tm_frmt;
+		if ($echo) {
+			$this->e($field_name, $date_or_time);
+			return '';
+		}
+		return $this->get($field_name, $date_or_time);
+	}
+
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $format     format for the date returned (if NULL we use default in dt_frmt property)
+	 * @return string            datetime value formatted
+	 * @throws \EE_Error
+	 */
+	public function get_date($field_name, $format = '')
+	{
+		return $this->_get_datetime($field_name, $format, null, 'D');
+	}
+
+
+
+	/**
+	 * @param      $field_name
+	 * @param string $format
+	 * @throws \EE_Error
+	 */
+	public function e_date($field_name, $format = '')
+	{
+		$this->_get_datetime($field_name, $format, null, 'D', true);
+	}
+
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $format     format for the time returned ( if NULL we use default in tm_frmt property)
+	 * @return string             datetime value formatted
+	 * @throws \EE_Error
+	 */
+	public function get_time($field_name, $format = '')
+	{
+		return $this->_get_datetime($field_name, null, $format, 'T');
+	}
+
+
+
+	/**
+	 * @param      $field_name
+	 * @param string $format
+	 * @throws \EE_Error
+	 */
+	public function e_time($field_name, $format = '')
+	{
+		$this->_get_datetime($field_name, null, $format, 'T', true);
+	}
+
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
+	 * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $dt_frmt    format for the date returned (if NULL we use default in dt_frmt property)
+	 * @param  string $tm_frmt    format for the time returned (if NULL we use default in tm_frmt property)
+	 * @return string             datetime value formatted
+	 * @throws \EE_Error
+	 */
+	public function get_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
+	{
+		return $this->_get_datetime($field_name, $dt_frmt, $tm_frmt);
+	}
+
+
+
+	/**
+	 * @param string $field_name
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @throws \EE_Error
+	 */
+	public function e_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
+	{
+		$this->_get_datetime($field_name, $dt_frmt, $tm_frmt, null, true);
+	}
+
+
+
+	/**
+	 * Get the i8ln value for a date using the WordPress @see date_i18n function.
+	 *
+	 * @param string $field_name The EE_Datetime_Field reference for the date being retrieved.
+	 * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
+	 *                           on the object will be used.
+	 * @return string Date and time string in set locale or false if no field exists for the given
+	 * @throws \EE_Error
+	 *                           field name.
+	 */
+	public function get_i18n_datetime($field_name, $format = '')
+	{
+		$format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
+		return date_i18n(
+			$format,
+			EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
+		);
+	}
+
+
+
+	/**
+	 * This method validates whether the given field name is a valid field on the model object as well as it is of a
+	 * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
+	 * thrown.
+	 *
+	 * @param  string $field_name The field name being checked
+	 * @throws EE_Error
+	 * @return EE_Datetime_Field
+	 */
+	protected function _get_dtt_field_settings($field_name)
+	{
+		$field = $this->get_model()->field_settings_for($field_name);
+		//check if field is dtt
+		if ($field instanceof EE_Datetime_Field) {
+			return $field;
+		} else {
+			throw new EE_Error(sprintf(__('The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
+				'event_espresso'), $field_name, self::_get_model_classname(get_class($this))));
+		}
+	}
+
+
+
+
+	/**
+	 * NOTE ABOUT BELOW:
+	 * These convenience date and time setters are for setting date and time independently.  In other words you might
+	 * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
+	 * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
+	 * method and make sure you send the entire datetime value for setting.
+	 */
+	/**
+	 * sets the time on a datetime property
+	 *
+	 * @access protected
+	 * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
+	 * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
+	 * @throws \EE_Error
+	 */
+	protected function _set_time_for($time, $fieldname)
+	{
+		$this->_set_date_time('T', $time, $fieldname);
+	}
+
+
+
+	/**
+	 * sets the date on a datetime property
+	 *
+	 * @access protected
+	 * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
+	 * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
+	 * @throws \EE_Error
+	 */
+	protected function _set_date_for($date, $fieldname)
+	{
+		$this->_set_date_time('D', $date, $fieldname);
+	}
+
+
+
+	/**
+	 * This takes care of setting a date or time independently on a given model object property. This method also
+	 * verifies that the given fieldname matches a model object property and is for a EE_Datetime_Field field
+	 *
+	 * @access protected
+	 * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
+	 * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
+	 * @param string          $fieldname      the name of the field the date OR time is being set on (must match a
+	 *                                        EE_Datetime_Field property)
+	 * @throws \EE_Error
+	 */
+	protected function _set_date_time($what = 'T', $datetime_value, $fieldname)
+	{
+		$field = $this->_get_dtt_field_settings($fieldname);
+		$field->set_timezone($this->_timezone);
+		$field->set_date_format($this->_dt_frmt);
+		$field->set_time_format($this->_tm_frmt);
+		switch ($what) {
+			case 'T' :
+				$this->_fields[$fieldname] = $field->prepare_for_set_with_new_time(
+					$datetime_value,
+					$this->_fields[$fieldname]
+				);
+				break;
+			case 'D' :
+				$this->_fields[$fieldname] = $field->prepare_for_set_with_new_date(
+					$datetime_value,
+					$this->_fields[$fieldname]
+				);
+				break;
+			case 'B' :
+				$this->_fields[$fieldname] = $field->prepare_for_set($datetime_value);
+				break;
+		}
+		$this->_clear_cached_property($fieldname);
+	}
+
+
+
+	/**
+	 * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
+	 * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
+	 * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
+	 * that could lead to some unexpected results!
+	 *
+	 * @access public
+	 * @param string               $field_name This is the name of the field on the object that contains the date/time
+	 *                                         value being returned.
+	 * @param string               $callback   must match a valid method in this class (defaults to get_datetime)
+	 * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
+	 * @param string               $prepend    You can include something to prepend on the timestamp
+	 * @param string               $append     You can include something to append on the timestamp
+	 * @throws EE_Error
+	 * @return string timestamp
+	 */
+	public function display_in_my_timezone(
+		$field_name,
+		$callback = 'get_datetime',
+		$args = null,
+		$prepend = '',
+		$append = ''
+	) {
+		$timezone = EEH_DTT_Helper::get_timezone();
+		if ($timezone === $this->_timezone) {
+			return '';
+		}
+		$original_timezone = $this->_timezone;
+		$this->set_timezone($timezone);
+		$fn = (array)$field_name;
+		$args = array_merge($fn, (array)$args);
+		if ( ! method_exists($this, $callback)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
+						'event_espresso'
+					),
+					$callback
+				)
+			);
+		}
+		$args = (array)$args;
+		$return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
+		$this->set_timezone($original_timezone);
+		return $return;
+	}
+
+
+
+	/**
+	 * Deletes this model object.
+	 * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
+	 * override
+	 * `EE_Base_Class::_delete` NOT this class.
+	 *
+	 * @return boolean | int
+	 * @throws \EE_Error
+	 */
+	public function delete()
+	{
+		/**
+		 * Called just before the `EE_Base_Class::_delete` method call.
+		 * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
+		 * should be aware that `_delete` may not always result in a permanent delete.  For example, `EE_Soft_Delete_Base_Class::_delete`
+		 * soft deletes (trash) the object and does not permanently delete it.
+		 *
+		 * @param EE_Base_Class $model_object about to be 'deleted'
+		 */
+		do_action('AHEE__EE_Base_Class__delete__before', $this);
+		$result = $this->_delete();
+		/**
+		 * Called just after the `EE_Base_Class::_delete` method call.
+		 * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
+		 * should be aware that `_delete` may not always result in a permanent delete.  For example `EE_Soft_Base_Class::_delete`
+		 * soft deletes (trash) the object and does not permanently delete it.
+		 *
+		 * @param EE_Base_Class $model_object that was just 'deleted'
+		 * @param boolean       $result
+		 */
+		do_action('AHEE__EE_Base_Class__delete__end', $this, $result);
+		return $result;
+	}
+
+
+
+	/**
+	 * Calls the specific delete method for the instantiated class.
+	 * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
+	 * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
+	 * `EE_Base_Class::delete`
+	 *
+	 * @return bool|int
+	 * @throws \EE_Error
+	 */
+	protected function _delete()
+	{
+		return $this->delete_permanently();
+	}
+
+
+
+	/**
+	 * Deletes this model object permanently from db (but keep in mind related models my block the delete and return an
+	 * error)
+	 *
+	 * @return bool | int
+	 * @throws \EE_Error
+	 */
+	public function delete_permanently()
+	{
+		/**
+		 * Called just before HARD deleting a model object
+		 *
+		 * @param EE_Base_Class $model_object about to be 'deleted'
+		 */
+		do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
+		$model = $this->get_model();
+		$result = $model->delete_permanently_by_ID($this->ID());
+		$this->refresh_cache_of_related_objects();
+		/**
+		 * Called just after HARD deleting a model object
+		 *
+		 * @param EE_Base_Class $model_object that was just 'deleted'
+		 * @param boolean       $result
+		 */
+		do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
+		return $result;
+	}
+
+
+
+	/**
+	 * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
+	 * related model objects
+	 *
+	 * @throws \EE_Error
+	 */
+	public function refresh_cache_of_related_objects()
+	{
+		foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
+			if ( ! empty($this->_model_relations[$relation_name])) {
+				$related_objects = $this->_model_relations[$relation_name];
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
+					//this relation only stores a single model object, not an array
+					//but let's make it consistent
+					$related_objects = array($related_objects);
+				}
+				foreach ($related_objects as $related_object) {
+					//only refresh their cache if they're in memory
+					if ($related_object instanceof EE_Base_Class) {
+						$related_object->clear_cache($this->get_model()->get_this_model_name(), $this);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *        Saves this object to the database. An array may be supplied to set some values on this
+	 * object just before saving.
+	 *
+	 * @access public
+	 * @param array $set_cols_n_values keys are field names, values are their new values,
+	 *                                 if provided during the save() method (often client code will change the fields'
+	 *                                 values before calling save)
+	 * @throws \EE_Error
+	 * @return int , 1 on a successful update, the ID of the new entry on insert; 0 on failure or if the model object
+	 *                                 isn't allowed to persist (as determined by EE_Base_Class::allow_persist())
+	 */
+	public function save($set_cols_n_values = array())
+	{
+		/**
+		 * Filters the fields we're about to save on the model object
+		 *
+		 * @param array         $set_cols_n_values
+		 * @param EE_Base_Class $model_object
+		 */
+		$set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
+			$this);
+		//set attributes as provided in $set_cols_n_values
+		foreach ($set_cols_n_values as $column => $value) {
+			$this->set($column, $value);
+		}
+		/**
+		 * Saving a model object.
+		 * Before we perform a save, this action is fired.
+		 *
+		 * @param EE_Base_Class $model_object the model object about to be saved.
+		 */
+		do_action('AHEE__EE_Base_Class__save__begin', $this);
+		if ( ! $this->allow_persist()) {
+			return 0;
+		}
+		//now get current attribute values
+		$save_cols_n_values = $this->_fields;
+		//if the object already has an ID, update it. Otherwise, insert it
+		//also: change the assumption about values passed to the model NOT being prepare dby the model object. They have been
+		$old_assumption_concerning_value_preparation = $this->get_model()
+															->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->get_model()->assume_values_already_prepared_by_model_object(true);
+		//does this model have an autoincrement PK?
+		if ($this->get_model()->has_primary_key_field()) {
+			if ($this->get_model()->get_primary_key_field()->is_auto_increment()) {
+				//ok check if it's set, if so: update; if not, insert
+				if ( ! empty($save_cols_n_values[self::_get_primary_key_name(get_class($this))])) {
+					$results = $this->get_model()->update_by_ID($save_cols_n_values, $this->ID());
+				} else {
+					unset($save_cols_n_values[self::_get_primary_key_name(get_class($this))]);
+					$results = $this->get_model()->insert($save_cols_n_values);
+					if ($results) {
+						//if successful, set the primary key
+						//but don't use the normal SET method, because it will check if
+						//an item with the same ID exists in the mapper & db, then
+						//will find it in the db (because we just added it) and THAT object
+						//will get added to the mapper before we can add this one!
+						//but if we just avoid using the SET method, all that headache can be avoided
+						$pk_field_name = self::_get_primary_key_name(get_class($this));
+						$this->_fields[$pk_field_name] = $results;
+						$this->_clear_cached_property($pk_field_name);
+						$this->get_model()->add_to_entity_map($this);
+						$this->_update_cached_related_model_objs_fks();
+					}
+				}
+			} else {//PK is NOT auto-increment
+				//so check if one like it already exists in the db
+				if ($this->get_model()->exists_by_ID($this->ID())) {
+					if (WP_DEBUG && ! $this->in_entity_map()) {
+						throw new EE_Error(
+							sprintf(
+								__('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
+									'event_espresso'),
+								get_class($this),
+								get_class($this->get_model()) . '::instance()->add_to_entity_map()',
+								get_class($this->get_model()) . '::instance()->get_one_by_ID()',
+								'<br />'
+							)
+						);
+					}
+					$results = $this->get_model()->update_by_ID($save_cols_n_values, $this->ID());
+				} else {
+					$results = $this->get_model()->insert($save_cols_n_values);
+					$this->_update_cached_related_model_objs_fks();
+				}
+			}
+		} else {//there is NO primary key
+			$already_in_db = false;
+			foreach ($this->get_model()->unique_indexes() as $index) {
+				$uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
+				if ($this->get_model()->exists(array($uniqueness_where_params))) {
+					$already_in_db = true;
+				}
+			}
+			if ($already_in_db) {
+				$combined_pk_fields_n_values = array_intersect_key($save_cols_n_values,
+					$this->get_model()->get_combined_primary_key_fields());
+				$results = $this->get_model()->update($save_cols_n_values, $combined_pk_fields_n_values);
+			} else {
+				$results = $this->get_model()->insert($save_cols_n_values);
+			}
+		}
+		//restore the old assumption about values being prepared by the model object
+		$this->get_model()
+			 ->assume_values_already_prepared_by_model_object($old_assumption_concerning_value_preparation);
+		/**
+		 * After saving the model object this action is called
+		 *
+		 * @param EE_Base_Class $model_object which was just saved
+		 * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
+		 *                                    the new ID (or 0 if an error occurred and it wasn't updated)
+		 */
+		do_action('AHEE__EE_Base_Class__save__end', $this, $results);
+		return $results;
+	}
+
+
+
+	/**
+	 * Updates the foreign key on related models objects pointing to this to have this model object's ID
+	 * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
+	 * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
+	 * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
+	 * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
+	 * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
+	 * or not they exist in the DB (if they do, their DB records will be automatically updated)
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _update_cached_related_model_objs_fks()
+	{
+		foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Has_Many_Relation) {
+				foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
+					$fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
+						$this->get_model()->get_this_model_name()
+					);
+					$related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
+					if ($related_model_obj_in_cache->ID()) {
+						$related_model_obj_in_cache->save();
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Saves this model object and its NEW cached relations to the database.
+	 * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
+	 * In order for that to work, we would need to mark model objects as dirty/clean...
+	 * because otherwise, there's a potential for infinite looping of saving
+	 * Saves the cached related model objects, and ensures the relation between them
+	 * and this object and properly setup
+	 *
+	 * @return int ID of new model object on save; 0 on failure+
+	 * @throws \EE_Error
+	 */
+	public function save_new_cached_related_model_objs()
+	{
+		//make sure this has been saved
+		if ( ! $this->ID()) {
+			$id = $this->save();
+		} else {
+			$id = $this->ID();
+		}
+		//now save all the NEW cached model objects  (ie they don't exist in the DB)
+		foreach ($this->get_model()->relation_settings() as $relationName => $relationObj) {
+			if ($this->_model_relations[$relationName]) {
+				//is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
+				//or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
+				if ($relationObj instanceof EE_Belongs_To_Relation) {
+					//add a relation to that relation type (which saves the appropriate thing in the process)
+					//but ONLY if it DOES NOT exist in the DB
+					/* @var $related_model_obj EE_Base_Class */
+					$related_model_obj = $this->_model_relations[$relationName];
+					//					if( ! $related_model_obj->ID()){
+					$this->_add_relation_to($related_model_obj, $relationName);
+					$related_model_obj->save_new_cached_related_model_objs();
+					//					}
+				} else {
+					foreach ($this->_model_relations[$relationName] as $related_model_obj) {
+						//add a relation to that relation type (which saves the appropriate thing in the process)
+						//but ONLY if it DOES NOT exist in the DB
+						//						if( ! $related_model_obj->ID()){
+						$this->_add_relation_to($related_model_obj, $relationName);
+						$related_model_obj->save_new_cached_related_model_objs();
+						//						}
+					}
+				}
+			}
+		}
+		return $id;
+	}
+
+
+
+	/**
+	 * for getting a model while instantiated.
+	 *
+	 * @return \EEM_Base | \EEM_CPT_Base
+	 */
+	public function get_model()
+	{
+		$modelName = self::_get_model_classname(get_class($this));
+		return self::_get_model_instance_with_name($modelName, $this->_timezone);
+	}
+
+
+
+	/**
+	 * @param $props_n_values
+	 * @param $classname
+	 * @return mixed bool|EE_Base_Class|EEM_CPT_Base
+	 * @throws \EE_Error
+	 */
+	protected static function _get_object_from_entity_mapper($props_n_values, $classname)
+	{
+		//TODO: will not work for Term_Relationships because they have no PK!
+		$primary_id_ref = self::_get_primary_key_name($classname);
+		if (array_key_exists($primary_id_ref, $props_n_values) && ! empty($props_n_values[$primary_id_ref])) {
+			$id = $props_n_values[$primary_id_ref];
+			return self::_get_model($classname)->get_from_entity_map($id);
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
+	 * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
+	 * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
+	 * we return false.
+	 *
+	 * @param  array  $props_n_values   incoming array of properties and their values
+	 * @param  string $classname        the classname of the child class
+	 * @param null    $timezone
+	 * @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 mixed (EE_Base_Class|bool)
+	 * @throws \EE_Error
+	 */
+	protected static function _check_for_object($props_n_values, $classname, $timezone = null, $date_formats = array())
+	{
+		$existing = null;
+		if (self::_get_model($classname)->has_primary_key_field()) {
+			$primary_id_ref = self::_get_primary_key_name($classname);
+			if (array_key_exists($primary_id_ref, $props_n_values)
+				&& ! empty($props_n_values[$primary_id_ref])
+			) {
+				$existing = self::_get_model($classname, $timezone)->get_one_by_ID(
+					$props_n_values[$primary_id_ref]
+				);
+			}
+		} elseif (self::_get_model($classname, $timezone)->has_all_combined_primary_key_fields($props_n_values)) {
+			//no primary key on this model, but there's still a matching item in the DB
+			$existing = self::_get_model($classname, $timezone)->get_one_by_ID(
+				self::_get_model($classname, $timezone)->get_index_primary_key_string($props_n_values)
+			);
+		}
+		if ($existing) {
+			//set date formats if present before setting values
+			if ( ! empty($date_formats) && is_array($date_formats)) {
+				$existing->set_date_format($date_formats[0]);
+				$existing->set_time_format($date_formats[1]);
+			} else {
+				//set default formats for date and time
+				$existing->set_date_format(get_option('date_format'));
+				$existing->set_time_format(get_option('time_format'));
+			}
+			foreach ($props_n_values as $property => $field_value) {
+				$existing->set($property, $field_value);
+			}
+			return $existing;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Gets the EEM_*_Model for this class
+	 *
+	 * @access public now, as this is more convenient
+	 * @param      $classname
+	 * @param null $timezone
+	 * @throws EE_Error
+	 * @return EEM_Base
+	 */
+	protected static function _get_model($classname, $timezone = null)
+	{
+		//find model for this class
+		if ( ! $classname) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"What were you thinking calling _get_model(%s)?? You need to specify the class name",
+						"event_espresso"
+					),
+					$classname
+				)
+			);
+		}
+		$modelName = self::_get_model_classname($classname);
+		return self::_get_model_instance_with_name($modelName, $timezone);
+	}
+
+
+
+	/**
+	 * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
+	 *
+	 * @param string $model_classname
+	 * @param null   $timezone
+	 * @return EEM_Base
+	 */
+	protected static function _get_model_instance_with_name($model_classname, $timezone = null)
+	{
+		$model_classname = str_replace('EEM_', '', $model_classname);
+		$model = EE_Registry::instance()->load_model($model_classname);
+		$model->set_timezone($timezone);
+		return $model;
+	}
+
+
+
+	/**
+	 * If a model name is provided (eg Registration), gets the model classname for that model.
+	 * Also works if a model class's classname is provided (eg EE_Registration).
+	 *
+	 * @param null $model_name
+	 * @return string like EEM_Attendee
+	 */
+	private static function _get_model_classname($model_name = null)
+	{
+		if (strpos($model_name, "EE_") === 0) {
+			$model_classname = str_replace("EE_", "EEM_", $model_name);
+		} else {
+			$model_classname = "EEM_" . $model_name;
+		}
+		return $model_classname;
+	}
+
+
+
+	/**
+	 * returns the name of the primary key attribute
+	 *
+	 * @param null $classname
+	 * @throws EE_Error
+	 * @return string
+	 */
+	protected static function _get_primary_key_name($classname = null)
+	{
+		if ( ! $classname) {
+			throw new EE_Error(
+				sprintf(
+					__("What were you thinking calling _get_primary_key_name(%s)", "event_espresso"),
+					$classname
+				)
+			);
+		}
+		return self::_get_model($classname)->get_primary_key_field()->get_name();
+	}
+
+
+
+	/**
+	 * Gets the value of the primary key.
+	 * If the object hasn't yet been saved, it should be whatever the model field's default was
+	 * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
+	 * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
+	 *
+	 * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
+	 * @throws \EE_Error
+	 */
+	public function ID()
+	{
+		//now that we know the name of the variable, use a variable variable to get its value and return its
+		if ($this->get_model()->has_primary_key_field()) {
+			return $this->_fields[self::_get_primary_key_name(get_class($this))];
+		} else {
+			return $this->get_model()->get_index_primary_key_string($this->_fields);
+		}
+	}
+
+
+
+	/**
+	 * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
+	 * model is related to a group of events, the $relationName should be 'Event', and should be a key in the EE
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
+	 *
+	 * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
+	 * @param string $relationName                     eg 'Events','Question',etc.
+	 *                                                 an attendee to a group, you also want to specify which role they
+	 *                                                 will have in that group. So you would use this parameter to
+	 *                                                 specify array('role-column-name'=>'role-id')
+	 * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
+	 *                                                 allow you to further constrict the relation to being added.
+	 *                                                 However, keep in mind that the columns (keys) given must match a
+	 *                                                 column on the JOIN table and currently only the HABTM models
+	 *                                                 accept these additional conditions.  Also remember that if an
+	 *                                                 exact match isn't found for these extra cols/val pairs, then a
+	 *                                                 NEW row is created in the join table.
+	 * @param null   $cache_id
+	 * @throws EE_Error
+	 * @return EE_Base_Class the object the relation was added to
+	 */
+	public function _add_relation_to(
+		$otherObjectModelObjectOrID,
+		$relationName,
+		$extra_join_model_fields_n_values = array(),
+		$cache_id = null
+	) {
+		//if this thing exists in the DB, save the relation to the DB
+		if ($this->ID()) {
+			$otherObject = $this->get_model()
+								->add_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
+									$extra_join_model_fields_n_values);
+			//clear cache so future get_many_related and get_first_related() return new results.
+			$this->clear_cache($relationName, $otherObject, true);
+			if ($otherObject instanceof EE_Base_Class) {
+				$otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
+			}
+		} else {
+			//this thing doesn't exist in the DB,  so just cache it
+			if ( ! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
+				throw new EE_Error(sprintf(
+					__('Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
+						'event_espresso'),
+					$otherObjectModelObjectOrID,
+					get_class($this)
+				));
+			} else {
+				$otherObject = $otherObjectModelObjectOrID;
+			}
+			$this->cache($relationName, $otherObjectModelObjectOrID, $cache_id);
+		}
+		if ($otherObject instanceof EE_Base_Class) {
+			//fix the reciprocal relation too
+			if ($otherObject->ID()) {
+				//its saved so assumed relations exist in the DB, so we can just
+				//clear the cache so future queries use the updated info in the DB
+				$otherObject->clear_cache($this->get_model()->get_this_model_name(), null, true);
+			} else {
+				//it's not saved, so it caches relations like this
+				$otherObject->cache($this->get_model()->get_this_model_name(), $this);
+			}
+		}
+		return $otherObject;
+	}
+
+
+
+	/**
+	 * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
+	 * model is related to a group of events, the $relationName should be 'Events', and should be a key in the EE
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
+	 * from the cache
+	 *
+	 * @param mixed  $otherObjectModelObjectOrID
+	 *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
+	 *                to the DB yet
+	 * @param string $relationName
+	 * @param array  $where_query
+	 *                You can optionally include an array of key=>value pairs that allow you to further constrict the
+	 *                relation to being added. However, keep in mind that the columns (keys) given must match a column
+	 *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
+	 *                remember that if an exact match isn't found for these extra cols/val pairs, then a NEW row is
+	 *                created in the join table.
+	 * @return EE_Base_Class the relation was removed from
+	 * @throws \EE_Error
+	 */
+	public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = array())
+	{
+		if ($this->ID()) {
+			//if this exists in the DB, save the relation change to the DB too
+			$otherObject = $this->get_model()
+								->remove_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
+									$where_query);
+			$this->clear_cache($relationName, $otherObject);
+		} else {
+			//this doesn't exist in the DB, just remove it from the cache
+			$otherObject = $this->clear_cache($relationName, $otherObjectModelObjectOrID);
+		}
+		if ($otherObject instanceof EE_Base_Class) {
+			$otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
+		}
+		return $otherObject;
+	}
+
+
+
+	/**
+	 * Removes ALL the related things for the $relationName.
+	 *
+	 * @param string $relationName
+	 * @param array  $where_query_params like EEM_Base::get_all's $query_params[0] (where conditions)
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function _remove_relations($relationName, $where_query_params = array())
+	{
+		if ($this->ID()) {
+			//if this exists in the DB, save the relation change to the DB too
+			$otherObjects = $this->get_model()->remove_relations($this, $relationName, $where_query_params);
+			$this->clear_cache($relationName, null, true);
+		} else {
+			//this doesn't exist in the DB, just remove it from the cache
+			$otherObjects = $this->clear_cache($relationName, null, true);
+		}
+		if (is_array($otherObjects)) {
+			foreach ($otherObjects as $otherObject) {
+				$otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
+			}
+		}
+		return $otherObjects;
+	}
+
+
+
+	/**
+	 * Gets all the related model objects of the specified type. Eg, if the current class if
+	 * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
+	 * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
+	 * because we want to get even deleted items etc.
+	 *
+	 * @param string $relationName key in the model's _model_relations array
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @return EE_Base_Class[] Results not necessarily indexed by IDs, because some results might not have primary keys
+	 * @throws \EE_Error
+	 *                             or might not be saved yet. Consider using EEM_Base::get_IDs() on these results if
+	 *                             you want IDs
+	 */
+	public function get_many_related($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			//this exists in the DB, so get the related things from either the cache or the DB
+			//if there are query parameters, forget about caching the related model objects.
+			if ($query_params) {
+				$related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
+			} else {
+				//did we already cache the result of this query?
+				$cached_results = $this->get_all_from_cache($relationName);
+				if ( ! $cached_results) {
+					$related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
+					//if no query parameters were passed, then we got all the related model objects
+					//for that relation. We can cache them then.
+					foreach ($related_model_objects as $related_model_object) {
+						$this->cache($relationName, $related_model_object);
+					}
+				} else {
+					$related_model_objects = $cached_results;
+				}
+			}
+		} else {
+			//this doesn't exist in the DB, so just get the related things from the cache
+			$related_model_objects = $this->get_all_from_cache($relationName);
+		}
+		return $related_model_objects;
+	}
+
+
+
+	/**
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
+	 * unless otherwise specified in the $query_params
+	 *
+	 * @param string $relation_name  model_name like 'Event', or 'Registration'
+	 * @param array  $query_params   like EEM_Base::get_all's
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
+	 *                               that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_related($relation_name, $query_params = array(), $field_to_count = null, $distinct = false)
+	{
+		return $this->get_model()->count_related($this, $relation_name, $query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
+	 *
+	 * @param string $relation_name model_name like 'Event', or 'Registration'
+	 * @param array  $query_params  like EEM_Base::get_all's
+	 * @param string $field_to_sum  name of field to count by.
+	 *                              By default, uses primary key (which doesn't make much sense, so you should probably
+	 *                              change it)
+	 * @return int
+	 */
+	public function sum_related($relation_name, $query_params = array(), $field_to_sum = null)
+	{
+		return $this->get_model()->sum_related($this, $relation_name, $query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Gets the first (ie, one) related model object of the specified type.
+	 *
+	 * @param string $relationName key in the model's _model_relations array
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @return EE_Base_Class (not an array, a single object)
+	 * @throws \EE_Error
+	 */
+	public function get_first_related($relationName, $query_params = array())
+	{
+		if ($this->ID()) {//this exists in the DB, get from the cache OR the DB
+			//if they've provided some query parameters, don't bother trying to cache the result
+			//also make sure we're not caching the result of get_first_related
+			//on a relation which should have an array of objects (because the cache might have an array of objects)
+			if ($query_params
+				|| ! $this->get_model()->related_settings_for($relationName)
+					 instanceof
+					 EE_Belongs_To_Relation
+			) {
+				$related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
+			} else {
+				//first, check if we've already cached the result of this query
+				$cached_result = $this->get_one_from_cache($relationName);
+				if ( ! $cached_result) {
+					$related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
+					$this->cache($relationName, $related_model_object);
+				} else {
+					$related_model_object = $cached_result;
+				}
+			}
+		} else {
+			$related_model_object = null;
+			//this doesn't exist in the Db, but maybe the relation is of type belongs to, and so the related thing might
+			if ($this->get_model()->related_settings_for($relationName) instanceof EE_Belongs_To_Relation) {
+				$related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
+			}
+			//this doesn't exist in the DB and apparently the thing it belongs to doesn't either, just get what's cached on this object
+			if ( ! $related_model_object) {
+				$related_model_object = $this->get_one_from_cache($relationName);
+			}
+		}
+		return $related_model_object;
+	}
+
+
+
+	/**
+	 * Does a delete on all related objects of type $relationName and removes
+	 * the current model object's relation to them. If they can't be deleted (because
+	 * of blocking related model objects) does nothing. If the related model objects are
+	 * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
+	 * If this model object doesn't exist yet in the DB, just removes its related things
+	 *
+	 * @param string $relationName
+	 * @param array  $query_params like EEM_Base::get_all's
+	 * @return int how many deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_related($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			$count = $this->get_model()->delete_related($this, $relationName, $query_params);
+		} else {
+			$count = count($this->get_all_from_cache($relationName));
+			$this->clear_cache($relationName, null, true);
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * Does a hard delete (ie, removes the DB row) on all related objects of type $relationName and removes
+	 * the current model object's relation to them. If they can't be deleted (because
+	 * of blocking related model objects) just does a soft delete on it instead, if possible.
+	 * If the related thing isn't a soft-deletable model object, this function is identical
+	 * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
+	 *
+	 * @param string $relationName
+	 * @param array  $query_params like EEM_Base::get_all's
+	 * @return int how many deleted (including those soft deleted)
+	 * @throws \EE_Error
+	 */
+	public function delete_related_permanently($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			$count = $this->get_model()->delete_related_permanently($this, $relationName, $query_params);
+		} else {
+			$count = count($this->get_all_from_cache($relationName));
+		}
+		$this->clear_cache($relationName, null, true);
+		return $count;
+	}
+
+
+
+	/**
+	 * is_set
+	 * Just a simple utility function children can use for checking if property exists
+	 *
+	 * @access  public
+	 * @param  string $field_name property to check
+	 * @return bool                              TRUE if existing,FALSE if not.
+	 */
+	public function is_set($field_name)
+	{
+		return isset($this->_fields[$field_name]);
+	}
+
+
+
+	/**
+	 * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
+	 * EE_Error exception if they don't
+	 *
+	 * @param  mixed (string|array) $properties properties to check
+	 * @throws EE_Error
+	 * @return bool                              TRUE if existing, throw EE_Error if not.
+	 */
+	protected function _property_exists($properties)
+	{
+		foreach ((array)$properties as $property_name) {
+			//first make sure this property exists
+			if ( ! $this->_fields[$property_name]) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
+							'event_espresso'
+						),
+						$property_name
+					)
+				);
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * This simply returns an array of model fields for this object
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function model_field_array()
+	{
+		$fields = $this->get_model()->field_settings(false);
+		$properties = array();
+		//remove prepended underscore
+		foreach ($fields as $field_name => $settings) {
+			$properties[$field_name] = $this->get($field_name);
+		}
+		return $properties;
+	}
+
+
+
+	/**
+	 * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
+	 * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
+	 * requiring a plugin to extend the EE_Base_Class (which works fine is there's only 1 plugin, but when will that
+	 * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
+	 * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
+	 * was called, and an array of the original arguments passed to the function. Whatever their callback function
+	 * returns will be returned by this function. Example: in functions.php (or in a plugin):
+	 * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
+	 * my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
+	 *        return $previousReturnValue.$returnString;
+	 * }
+	 * require('EE_Answer.class.php');
+	 * $answer= EE_Answer::new_instance(array('REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'));
+	 * echo $answer->my_callback('monkeys',100);
+	 * //will output "you called my_callback! and passed args:monkeys,100"
+	 *
+	 * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
+	 * @param array  $args       array of original arguments passed to the function
+	 * @throws EE_Error
+	 * @return mixed whatever the plugin which calls add_filter decides
+	 */
+	public function __call($methodName, $args)
+	{
+		$className = get_class($this);
+		$tagName = "FHEE__{$className}__{$methodName}";
+		if ( ! has_filter($tagName)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
+						"event_espresso"
+					),
+					$methodName,
+					$className,
+					$tagName
+				)
+			);
+		}
+		return apply_filters($tagName, null, $this, $args);
+	}
+
+
+
+	/**
+	 * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
+	 * A $previous_value can be specified in case there are many meta rows with the same key
+	 *
+	 * @param string $meta_key
+	 * @param string $meta_value
+	 * @param string $previous_value
+	 * @return int records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
+	 * @throws \EE_Error
+	 * NOTE: if the values haven't changed, returns 0
+	 */
+	public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
+	{
+		$query_params = array(
+			array(
+				'EXM_key'  => $meta_key,
+				'OBJ_ID'   => $this->ID(),
+				'EXM_type' => $this->get_model()->get_this_model_name(),
+			),
+		);
+		if ($previous_value !== null) {
+			$query_params[0]['EXM_value'] = $meta_value;
+		}
+		$existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
+		if ( ! $existing_rows_like_that) {
+			return $this->add_extra_meta($meta_key, $meta_value);
+		} else {
+			foreach ($existing_rows_like_that as $existing_row) {
+				$existing_row->save(array('EXM_value' => $meta_value));
+			}
+			return count($existing_rows_like_that);
+		}
+	}
+
+
+
+	/**
+	 * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
+	 * no other extra meta for this model object have the same key. Returns TRUE if the
+	 * extra meta row was entered, false if not
+	 *
+	 * @param string  $meta_key
+	 * @param string  $meta_value
+	 * @param boolean $unique
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function add_extra_meta($meta_key, $meta_value, $unique = false)
+	{
+		if ($unique) {
+			$existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
+				array(
+					array(
+						'EXM_key'  => $meta_key,
+						'OBJ_ID'   => $this->ID(),
+						'EXM_type' => $this->get_model()->get_this_model_name(),
+					),
+				)
+			);
+			if ($existing_extra_meta) {
+				return false;
+			}
+		}
+		$new_extra_meta = EE_Extra_Meta::new_instance(
+			array(
+				'EXM_key'   => $meta_key,
+				'EXM_value' => $meta_value,
+				'OBJ_ID'    => $this->ID(),
+				'EXM_type'  => $this->get_model()->get_this_model_name(),
+			)
+		);
+		$new_extra_meta->save();
+		return true;
+	}
+
+
+
+	/**
+	 * Deletes all the extra meta rows for this record as specified by key. If $meta_value
+	 * is specified, only deletes extra meta records with that value.
+	 *
+	 * @param string $meta_key
+	 * @param string $meta_value
+	 * @return int number of extra meta rows deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_extra_meta($meta_key, $meta_value = null)
+	{
+		$query_params = array(
+			array(
+				'EXM_key'  => $meta_key,
+				'OBJ_ID'   => $this->ID(),
+				'EXM_type' => $this->get_model()->get_this_model_name(),
+			),
+		);
+		if ($meta_value !== null) {
+			$query_params[0]['EXM_value'] = $meta_value;
+		}
+		return EEM_Extra_Meta::instance()->delete($query_params);
+	}
+
+
+
+	/**
+	 * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
+	 * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
+	 * You can specify $default is case you haven't found the extra meta
+	 *
+	 * @param string  $meta_key
+	 * @param boolean $single
+	 * @param mixed   $default if we don't find anything, what should we return?
+	 * @return mixed single value if $single; array if ! $single
+	 * @throws \EE_Error
+	 */
+	public function get_extra_meta($meta_key, $single = false, $default = null)
+	{
+		if ($single) {
+			$result = $this->get_first_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
+			if ($result instanceof EE_Extra_Meta) {
+				return $result->value();
+			} else {
+				return $default;
+			}
+		} else {
+			$results = $this->get_many_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
+			if ($results) {
+				$values = array();
+				foreach ($results as $result) {
+					if ($result instanceof EE_Extra_Meta) {
+						$values[$result->ID()] = $result->value();
+					}
+				}
+				return $values;
+			} else {
+				return $default;
+			}
+		}
+	}
+
+
+
+	/**
+	 * Returns a simple array of all the extra meta associated with this model object.
+	 * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
+	 * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
+	 * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
+	 * If $one_of_each_key is false, it will return an array with the top-level keys being
+	 * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
+	 * finally the extra meta's value as each sub-value. (eg
+	 * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
+	 *
+	 * @param boolean $one_of_each_key
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function all_extra_meta_array($one_of_each_key = true)
+	{
+		$return_array = array();
+		if ($one_of_each_key) {
+			$extra_meta_objs = $this->get_many_related('Extra_Meta', array('group_by' => 'EXM_key'));
+			foreach ($extra_meta_objs as $extra_meta_obj) {
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
+					$return_array[$extra_meta_obj->key()] = $extra_meta_obj->value();
+				}
+			}
+		} else {
+			$extra_meta_objs = $this->get_many_related('Extra_Meta');
+			foreach ($extra_meta_objs as $extra_meta_obj) {
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
+					if ( ! isset($return_array[$extra_meta_obj->key()])) {
+						$return_array[$extra_meta_obj->key()] = array();
+					}
+					$return_array[$extra_meta_obj->key()][$extra_meta_obj->ID()] = $extra_meta_obj->value();
+				}
+			}
+		}
+		return $return_array;
+	}
+
+
+
+	/**
+	 * Gets a pretty nice displayable nice for this model object. Often overridden
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function name()
+	{
+		//find a field that's not a text field
+		$field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
+		if ($field_we_can_use) {
+			return $this->get($field_we_can_use->get_name());
+		} else {
+			$first_few_properties = $this->model_field_array();
+			$first_few_properties = array_slice($first_few_properties, 0, 3);
+			$name_parts = array();
+			foreach ($first_few_properties as $name => $value) {
+				$name_parts[] = "$name:$value";
+			}
+			return implode(",", $name_parts);
+		}
+	}
+
+
+
+	/**
+	 * in_entity_map
+	 * Checks if this model object has been proven to already be in the entity map
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function in_entity_map()
+	{
+		if ($this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this) {
+			//well, if we looked, did we find it in the entity map?
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * refresh_from_db
+	 * Makes sure the fields and values on this model object are in-sync with what's in the database.
+	 *
+	 * @throws EE_Error if this model object isn't in the entity mapper (because then you should
+	 * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
+	 */
+	public function refresh_from_db()
+	{
+		if ($this->ID() && $this->in_entity_map()) {
+			$this->get_model()->refresh_entity_map_from_db($this->ID());
+		} else {
+			//if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
+			//if it has an ID but it's not in the map, and you're asking me to refresh it
+			//that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
+			//absolutely nothing in it for this ID
+			if (WP_DEBUG) {
+				throw new EE_Error(
+					sprintf(
+						__('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
+							'event_espresso'),
+						$this->ID(),
+						get_class($this->get_model()) . '::instance()->add_to_entity_map()',
+						get_class($this->get_model()) . '::instance()->refresh_entity_map()'
+					)
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
+	 * (probably a bad assumption they have made, oh well)
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		try {
+			return sprintf('%s (%s)', $this->name(), $this->ID());
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			return '';
+		}
+	}
+
+
+
+	/**
+	 * Clear related model objects if they're already in the DB, because otherwise when we
+	 * UN-serialize this model object we'll need to be careful to add them to the entity map.
+	 * This means if we have made changes to those related model objects, and want to unserialize
+	 * the this model object on a subsequent request, changes to those related model objects will be lost.
+	 * Instead, those related model objects should be directly serialized and stored.
+	 * Eg, the following won't work:
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
+	 * $att = $reg->attendee();
+	 * $att->set( 'ATT_fname', 'Dirk' );
+	 * update_option( 'my_option', serialize( $reg ) );
+	 * //END REQUEST
+	 * //START NEXT REQUEST
+	 * $reg = get_option( 'my_option' );
+	 * $reg->attendee()->save();
+	 * And would need to be replace with:
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
+	 * $att = $reg->attendee();
+	 * $att->set( 'ATT_fname', 'Dirk' );
+	 * update_option( 'my_option', serialize( $reg ) );
+	 * //END REQUEST
+	 * //START NEXT REQUEST
+	 * $att = get_option( 'my_option' );
+	 * $att->save();
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function __sleep()
+	{
+		foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$classname = 'EE_' . $this->get_model()->get_this_model_name();
+				if (
+					$this->get_one_from_cache($relation_name) instanceof $classname
+					&& $this->get_one_from_cache($relation_name)->ID()
+				) {
+					$this->clear_cache($relation_name, $this->get_one_from_cache($relation_name)->ID());
+				}
+			}
+		}
+		$this->_props_n_values_provided_in_constructor = array();
+		return array_keys(get_object_vars($this));
+	}
+
+
+
+	/**
+	 * restore _props_n_values_provided_in_constructor
+	 * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
+	 * and therefore should NOT be used to determine if state change has occurred since initial construction.
+	 * At best, you would only be able to detect if state change has occurred during THIS request.
+	 */
+	public function __wakeup()
+	{
+		$this->_props_n_values_provided_in_constructor = $this->_fields;
+	}
 
 
 

core/libraries/plugin_api/EE_Register_Addon.lib.php

Spacing +119 added lines, -119 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -61,23 +61,23 @@ 
 	 * @param string $min_core_version
 	 * @return string always like '4.3.0.rc.000'
 	 */
-	protected static function _effective_version( $min_core_version ) {
+	protected static function _effective_version($min_core_version) {
 		// versions: 4 . 3 . 1 . p . 123
 		// offsets:    0 . 1 . 2 . 3 . 4
-		$version_parts = explode( '.', $min_core_version );
+		$version_parts = explode('.', $min_core_version);
 		//check they specified the micro version (after 2nd period)
-		if ( ! isset( $version_parts[2] ) ) {
+		if ( ! isset($version_parts[2])) {
 			$version_parts[2] = '0';
 		}
 		//if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
 		//soon we can assume that's 'rc', but this current version is 'alpha'
-		if ( ! isset( $version_parts[3] ) ) {
+		if ( ! isset($version_parts[3])) {
 			$version_parts[3] = 'dev';
 		}
-		if ( ! isset( $version_parts[4] ) ) {
+		if ( ! isset($version_parts[4])) {
 			$version_parts[4] = '000';
 		}
-		return implode( '.', $version_parts );
+		return implode('.', $version_parts);
 	}
 
 
@@ -94,8 +94,8 @@ 
 		$actual_core_version = EVENT_ESPRESSO_VERSION
 	) {
 		return version_compare(
-			self::_effective_version( $actual_core_version ),
-			self::_effective_version( $min_core_version ),
+			self::_effective_version($actual_core_version),
+			self::_effective_version($min_core_version),
 			'>='
 		);
 	}
@@ -217,7 +217,7 @@ 
 	 * @throws EE_Error
 	 * @return void
 	 */
-	public static function register( $addon_name = '', $setup_args = array() ) {
+	public static function register($addon_name = '', $setup_args = array()) {
 		// required fields MUST be present, so let's make sure they are.
         \EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
         // get class name for addon
@@ -227,13 +227,13 @@ 
         // setup PUE
         \EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
         // does this addon work with this version of core or WordPress ?
-        if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings) ) {
+        if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
             return;
 		}
 		// register namespaces
         \EE_Register_Addon::_setup_namespaces($addon_settings);
         // check if this is an activation request
-        if ( \EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
+        if (\EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
             // dont bother setting up the rest of the addon atm
             return;
         }
@@ -326,7 +326,7 @@ 
         } else {
             $class_name = $setup_args['class_name'];
         }
-        return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name;
+        return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_'.$class_name;
     }
 
 
@@ -344,105 +344,105 @@ 
             'class_name'            => $class_name,
             // the addon slug for use in URLs, etc
             'plugin_slug'           => isset($setup_args['plugin_slug'])
-                ? (string)$setup_args['plugin_slug']
+                ? (string) $setup_args['plugin_slug']
                 : '',
             // page slug to be used when generating the "Settings" link on the WP plugin page
             'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
-                ? (string)$setup_args['plugin_action_slug']
+                ? (string) $setup_args['plugin_action_slug']
                 : '',
             // the "software" version for the addon
             'version'               => isset($setup_args['version'])
-                ? (string)$setup_args['version']
+                ? (string) $setup_args['version']
                 : '',
             // the minimum version of EE Core that the addon will work with
             'min_core_version'      => isset($setup_args['min_core_version'])
-                ? (string)$setup_args['min_core_version']
+                ? (string) $setup_args['min_core_version']
                 : '',
             // the minimum version of WordPress that the addon will work with
             'min_wp_version'        => isset($setup_args['min_wp_version'])
-                ? (string)$setup_args['min_wp_version']
+                ? (string) $setup_args['min_wp_version']
                 : EE_MIN_WP_VER_REQUIRED,
             // full server path to main file (file loaded directly by WP)
             'main_file_path'        => isset($setup_args['main_file_path'])
-                ? (string)$setup_args['main_file_path']
+                ? (string) $setup_args['main_file_path']
                 : '',
             // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
             'admin_path'            => isset($setup_args['admin_path'])
-                ? (string)$setup_args['admin_path'] : '',
+                ? (string) $setup_args['admin_path'] : '',
             // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
             'admin_callback'        => isset($setup_args['admin_callback'])
-                ? (string)$setup_args['admin_callback']
+                ? (string) $setup_args['admin_callback']
                 : '',
             // the section name for this addon's configuration settings section (defaults to "addons")
             'config_section'        => isset($setup_args['config_section'])
-                ? (string)$setup_args['config_section']
+                ? (string) $setup_args['config_section']
                 : 'addons',
             // the class name for this addon's configuration settings object
             'config_class'          => isset($setup_args['config_class'])
-                ? (string)$setup_args['config_class'] : '',
+                ? (string) $setup_args['config_class'] : '',
             //the name given to the config for this addons' configuration settings object (optional)
             'config_name'           => isset($setup_args['config_name'])
-                ? (string)$setup_args['config_name'] : '',
+                ? (string) $setup_args['config_name'] : '',
             // an array of "class names" => "full server paths" for any classes that might be invoked by the addon
             'autoloader_paths'      => isset($setup_args['autoloader_paths'])
-                ? (array)$setup_args['autoloader_paths']
+                ? (array) $setup_args['autoloader_paths']
                 : array(),
             // an array of  "full server paths" for any folders containing classes that might be invoked by the addon
             'autoloader_folders'    => isset($setup_args['autoloader_folders'])
-                ? (array)$setup_args['autoloader_folders']
+                ? (array) $setup_args['autoloader_folders']
                 : array(),
             // array of full server paths to any EE_DMS data migration scripts used by the addon
             'dms_paths'             => isset($setup_args['dms_paths'])
-                ? (array)$setup_args['dms_paths']
+                ? (array) $setup_args['dms_paths']
                 : array(),
             // array of full server paths to any EED_Modules used by the addon
             'module_paths'          => isset($setup_args['module_paths'])
-                ? (array)$setup_args['module_paths']
+                ? (array) $setup_args['module_paths']
                 : array(),
             // array of full server paths to any EES_Shortcodes used by the addon
             'shortcode_paths'       => isset($setup_args['shortcode_paths'])
-                ? (array)$setup_args['shortcode_paths']
+                ? (array) $setup_args['shortcode_paths']
                 : array(),
             // array of full server paths to any WP_Widgets used by the addon
             'widget_paths'          => isset($setup_args['widget_paths'])
-                ? (array)$setup_args['widget_paths']
+                ? (array) $setup_args['widget_paths']
                 : array(),
             // array of PUE options used by the addon
             'pue_options'           => isset($setup_args['pue_options'])
-                ? (array)$setup_args['pue_options']
+                ? (array) $setup_args['pue_options']
                 : array(),
             'message_types'         => isset($setup_args['message_types'])
-                ? (array)$setup_args['message_types']
+                ? (array) $setup_args['message_types']
                 : array(),
             'capabilities'          => isset($setup_args['capabilities'])
-                ? (array)$setup_args['capabilities']
+                ? (array) $setup_args['capabilities']
                 : array(),
             'capability_maps'       => isset($setup_args['capability_maps'])
-                ? (array)$setup_args['capability_maps']
+                ? (array) $setup_args['capability_maps']
                 : array(),
             'model_paths'           => isset($setup_args['model_paths'])
-                ? (array)$setup_args['model_paths']
+                ? (array) $setup_args['model_paths']
                 : array(),
             'class_paths'           => isset($setup_args['class_paths'])
-                ? (array)$setup_args['class_paths']
+                ? (array) $setup_args['class_paths']
                 : array(),
             'model_extension_paths' => isset($setup_args['model_extension_paths'])
-                ? (array)$setup_args['model_extension_paths']
+                ? (array) $setup_args['model_extension_paths']
                 : array(),
             'class_extension_paths' => isset($setup_args['class_extension_paths'])
-                ? (array)$setup_args['class_extension_paths']
+                ? (array) $setup_args['class_extension_paths']
                 : array(),
             'custom_post_types'     => isset($setup_args['custom_post_types'])
-                ? (array)$setup_args['custom_post_types']
+                ? (array) $setup_args['custom_post_types']
                 : array(),
             'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
-                ? (array)$setup_args['custom_taxonomies']
+                ? (array) $setup_args['custom_taxonomies']
                 : array(),
             'payment_method_paths'  => isset($setup_args['payment_method_paths'])
-                ? (array)$setup_args['payment_method_paths']
+                ? (array) $setup_args['payment_method_paths']
                 : array(),
             'default_terms'         => isset($setup_args['default_terms'])
-                ? (array)$setup_args['default_terms']
+                ? (array) $setup_args['default_terms']
                 : array(),
             // if not empty, inserts a new table row after this plugin's row on the WP Plugins page
             // that can be used for adding upgrading/marketing info
@@ -454,7 +454,7 @@ 
                 $setup_args['namespace']['FQNS'],
                 $setup_args['namespace']['DIR']
             )
-                ? (array)$setup_args['namespace']
+                ? (array) $setup_args['namespace']
                 : array(),
         );
         // if plugin_action_slug is NOT set, but an admin page path IS set,
@@ -475,7 +475,7 @@ 
      * @param array  $addon_settings
      * @return boolean
      */
-	private static function _addon_is_compatible( $addon_name, array $addon_settings ) {
+	private static function _addon_is_compatible($addon_name, array $addon_settings) {
         global $wp_version;
         $incompatibility_message = '';
         //check whether this addon version is compatible with EE core
@@ -551,20 +551,20 @@ 
      * @param array  $setup_args
      * @return void
      */
-	private static function _parse_pue_options( $addon_name, $class_name, array $setup_args ) {
+	private static function _parse_pue_options($addon_name, $class_name, array $setup_args) {
         if ( ! empty($setup_args['pue_options'])) {
             self::$_settings[$addon_name]['pue_options'] = array(
                 'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
-                    ? (string)$setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
+                    ? (string) $setup_args['pue_options']['pue_plugin_slug']
+                    : 'espresso_'.strtolower($class_name),
                 'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
-                    ? (string)$setup_args['pue_options']['plugin_basename']
+                    ? (string) $setup_args['pue_options']['plugin_basename']
                     : plugin_basename($setup_args['main_file_path']),
                 'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
-                    ? (string)$setup_args['pue_options']['checkPeriod']
+                    ? (string) $setup_args['pue_options']['checkPeriod']
                     : '24',
                 'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
-                    ? (string)$setup_args['pue_options']['use_wp_update']
+                    ? (string) $setup_args['pue_options']['use_wp_update']
                     : false,
             );
             add_action(
@@ -606,7 +606,7 @@ 
      * @param array  $addon_settings
      * @return bool
      */
-	private static function _addon_activation( $addon_name, array $addon_settings ) {
+	private static function _addon_activation($addon_name, array $addon_settings) {
         // this is an activation request
         if (did_action('activate_plugin')) {
             //to find if THIS is the addon that was activated,
@@ -663,7 +663,7 @@ 
         }
         // setup autoloaders for folders
         if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
-            foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
+            foreach ((array) self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
                 EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
             }
         }
@@ -678,7 +678,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_models_and_extensions( $addon_name ) {
+	private static function _register_models_and_extensions($addon_name) {
         // register new models
         if (
             ! empty(self::$_settings[$addon_name]['model_paths'])
@@ -714,7 +714,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_data_migration_scripts( $addon_name ) {
+	private static function _register_data_migration_scripts($addon_name) {
         // setup DMS
         if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
             EE_Register_Data_Migration_Scripts::register(
@@ -730,7 +730,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_config( $addon_name ) {
+	private static function _register_config($addon_name) {
         // if config_class is present let's register config.
         if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
             EE_Register_Config::register(
@@ -749,7 +749,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_admin_pages( $addon_name ) {
+	private static function _register_admin_pages($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
             EE_Register_Admin_Page::register(
                 $addon_name,
@@ -764,7 +764,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_modules( $addon_name ) {
+	private static function _register_modules($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
             EE_Register_Module::register(
                 $addon_name,
@@ -779,7 +779,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_shortcodes( $addon_name ) {
+	private static function _register_shortcodes($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
             EE_Register_Shortcode::register(
                 $addon_name,
@@ -794,7 +794,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_widgets( $addon_name ) {
+	private static function _register_widgets($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
             EE_Register_Widget::register(
                 $addon_name,
@@ -809,7 +809,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_capabilities( $addon_name ) {
+	private static function _register_capabilities($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['capabilities'])) {
             EE_Register_Capabilities::register(
                 $addon_name,
@@ -827,7 +827,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_message_types( $addon_name ) {
+	private static function _register_message_types($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
             add_action(
                 'EE_Brewing_Regular___messages_caf',
@@ -842,7 +842,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_custom_post_types( $addon_name ) {
+	private static function _register_custom_post_types($addon_name) {
         if (
             ! empty(self::$_settings[$addon_name]['custom_post_types'])
             || ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
@@ -864,7 +864,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_payment_methods( $addon_name ) {
+	private static function _register_payment_methods($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
             EE_Register_Payment_Method::register(
                 $addon_name,
@@ -881,25 +881,25 @@ 
 	 * @param string $addon_name
 	 * @return EE_Addon
 	 */
-	private static function _load_and_init_addon_class( $addon_name ) {
+	private static function _load_and_init_addon_class($addon_name) {
 		$addon = EE_Registry::instance()->load_addon(
-			dirname( self::$_settings[ $addon_name ]['main_file_path'] ),
-			self::$_settings[ $addon_name ]['class_name']
+			dirname(self::$_settings[$addon_name]['main_file_path']),
+			self::$_settings[$addon_name]['class_name']
 		);
-		$addon->set_name( $addon_name );
-		$addon->set_plugin_slug( self::$_settings[ $addon_name ]['plugin_slug'] );
-		$addon->set_plugin_basename( self::$_settings[ $addon_name ]['plugin_basename'] );
-		$addon->set_main_plugin_file( self::$_settings[ $addon_name ]['main_file_path'] );
-		$addon->set_plugin_action_slug( self::$_settings[ $addon_name ]['plugin_action_slug'] );
-		$addon->set_plugins_page_row( self::$_settings[ $addon_name ]['plugins_page_row'] );
-		$addon->set_version( self::$_settings[ $addon_name ]['version'] );
-		$addon->set_min_core_version( self::_effective_version( self::$_settings[ $addon_name ]['min_core_version'] ) );
-		$addon->set_config_section( self::$_settings[ $addon_name ]['config_section'] );
-		$addon->set_config_class( self::$_settings[ $addon_name ]['config_class'] );
-		$addon->set_config_name( self::$_settings[ $addon_name ]['config_name'] );
+		$addon->set_name($addon_name);
+		$addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']);
+		$addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']);
+		$addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']);
+		$addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']);
+		$addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']);
+		$addon->set_version(self::$_settings[$addon_name]['version']);
+		$addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version']));
+		$addon->set_config_section(self::$_settings[$addon_name]['config_section']);
+		$addon->set_config_class(self::$_settings[$addon_name]['config_class']);
+		$addon->set_config_name(self::$_settings[$addon_name]['config_name']);
 		//unfortunately this can't be hooked in upon construction, because we don't have
 		//the plugin mainfile's path upon construction.
-		register_deactivation_hook( $addon->get_main_plugin_file(), array( $addon, 'deactivation' ) );
+		register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
         // call any additional admin_callback functions during load_admin_controller hook
         if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
             add_action(
@@ -919,18 +919,18 @@ 
 	 */
 	public static function load_pue_update() {
 		// load PUE client
-		require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
+		require_once EE_THIRD_PARTY.'pue'.DS.'pue-client.php';
 		// cycle thru settings
-		foreach ( self::$_settings as $settings ) {
-			if ( ! empty( $settings['pue_options'] ) ) {
+		foreach (self::$_settings as $settings) {
+			if ( ! empty($settings['pue_options'])) {
                 // initiate the class and start the plugin update engine!
 				new PluginUpdateEngineChecker(
 				// host file URL
 					'https://eventespresso.com',
 					// plugin slug(s)
 					array(
-						'premium'    => array( 'p' => $settings['pue_options']['pue_plugin_slug'] ),
-						'prerelease' => array( 'beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr' ),
+						'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
+						'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'].'-pr'),
 					),
 					// options
 					array(
@@ -958,9 +958,9 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function register_message_types() {
-		foreach ( self::$_settings as $addon_name => $settings ) {
+		foreach (self::$_settings as $addon_name => $settings) {
 		    if ( ! empty($settings['message_types'])) {
-                foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) {
+                foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
                     EE_Register_Message_Type::register($message_type, $message_type_settings);
                 }
             }
@@ -977,73 +977,73 @@ 
 	 * @throws EE_Error
 	 * @return void
 	 */
-	public static function deregister( $addon_name = null ) {
-		if ( isset( self::$_settings[ $addon_name ] ) ) {
-			$class_name = self::$_settings[ $addon_name ]['class_name'];
-			if ( ! empty( self::$_settings[ $addon_name ]['dms_paths'] ) ) {
+	public static function deregister($addon_name = null) {
+		if (isset(self::$_settings[$addon_name])) {
+			$class_name = self::$_settings[$addon_name]['class_name'];
+			if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
 				// setup DMS
-				EE_Register_Data_Migration_Scripts::deregister( $addon_name );
+				EE_Register_Data_Migration_Scripts::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['admin_path'] ) ) {
+			if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
 				// register admin page
-				EE_Register_Admin_Page::deregister( $addon_name );
+				EE_Register_Admin_Page::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['module_paths'] ) ) {
+			if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
 				// add to list of modules to be registered
-				EE_Register_Module::deregister( $addon_name );
+				EE_Register_Module::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['shortcode_paths'] ) ) {
+			if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
 				// add to list of shortcodes to be registered
-				EE_Register_Shortcode::deregister( $addon_name );
+				EE_Register_Shortcode::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['config_class'] ) ) {
+			if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
 				// if config_class present let's register config.
-				EE_Register_Config::deregister( self::$_settings[ $addon_name ]['config_class'] );
+				EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['widget_paths'] ) ) {
+			if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
 				// add to list of widgets to be registered
-				EE_Register_Widget::deregister( $addon_name );
+				EE_Register_Widget::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['model_paths'] )
+			if ( ! empty(self::$_settings[$addon_name]['model_paths'])
 			     ||
-			     ! empty( self::$_settings[ $addon_name ]['class_paths'] )
+			     ! empty(self::$_settings[$addon_name]['class_paths'])
 			) {
 				// add to list of shortcodes to be registered
-				EE_Register_Model::deregister( $addon_name );
+				EE_Register_Model::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['model_extension_paths'] )
+			if ( ! empty(self::$_settings[$addon_name]['model_extension_paths'])
 			     ||
-			     ! empty( self::$_settings[ $addon_name ]['class_extension_paths'] )
+			     ! empty(self::$_settings[$addon_name]['class_extension_paths'])
 			) {
 				// add to list of shortcodes to be registered
-				EE_Register_Model_Extensions::deregister( $addon_name );
+				EE_Register_Model_Extensions::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['message_types'] ) ) {
-				foreach ((array)self::$_settings[ $addon_name ]['message_types'] as $message_type => $message_type_settings )
+			if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
+				foreach ((array) self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings)
 				{
-					EE_Register_Message_Type::deregister( $message_type );
+					EE_Register_Message_Type::deregister($message_type);
 				}
 			}
 			//deregister capabilities for addon
 			if (
-				! empty( self::$_settings[ $addon_name ]['capabilities'] )
-				|| ! empty( self::$_settings[ $addon_name ]['capability_maps'] )
+				! empty(self::$_settings[$addon_name]['capabilities'])
+				|| ! empty(self::$_settings[$addon_name]['capability_maps'])
 			) {
-				EE_Register_Capabilities::deregister( $addon_name );
+				EE_Register_Capabilities::deregister($addon_name);
 			}
 			//deregister custom_post_types for addon
-			if ( ! empty( self::$_settings[ $addon_name ]['custom_post_types'] ) ) {
-				EE_Register_CPT::deregister( $addon_name );
+			if ( ! empty(self::$_settings[$addon_name]['custom_post_types'])) {
+				EE_Register_CPT::deregister($addon_name);
 			}
 			remove_action(
-				'deactivate_' . EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(),
-				array( EE_Registry::instance()->addons->{$class_name}, 'deactivation' )
+				'deactivate_'.EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(),
+				array(EE_Registry::instance()->addons->{$class_name}, 'deactivation')
 			);
 			remove_action(
 				'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-				array( EE_Registry::instance()->addons->{$class_name}, 'initialize_db_if_no_migrations_required' )
+				array(EE_Registry::instance()->addons->{$class_name}, 'initialize_db_if_no_migrations_required')
 			);
-			unset( EE_Registry::instance()->addons->{$class_name}, self::$_settings[ $addon_name ] );
+			unset(EE_Registry::instance()->addons->{$class_name}, self::$_settings[$addon_name]);
 		}
 	}
 

Indentation +637 added lines, -637 removed lines

@@ -48,7 +48,7 @@ 
 	protected static $_incompatible_addons = array(
 		'Multi_Event_Registration' => '2.0.11.rc.002',
 		'Promotions' => '1.0.0.rc.084',
-    );
+	);
 
 
 
@@ -219,660 +219,660 @@ 
 	 */
 	public static function register( $addon_name = '', $setup_args = array() ) {
 		// required fields MUST be present, so let's make sure they are.
-        \EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
-        // get class name for addon
+		\EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
+		// get class name for addon
 		$class_name = \EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
 		//setup $_settings array from incoming values.
-        $addon_settings = \EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
-        // setup PUE
-        \EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
-        // does this addon work with this version of core or WordPress ?
-        if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings) ) {
-            return;
+		$addon_settings = \EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
+		// setup PUE
+		\EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
+		// does this addon work with this version of core or WordPress ?
+		if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings) ) {
+			return;
 		}
 		// register namespaces
-        \EE_Register_Addon::_setup_namespaces($addon_settings);
-        // check if this is an activation request
-        if ( \EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
-            // dont bother setting up the rest of the addon atm
-            return;
-        }
-        // we need cars
-        \EE_Register_Addon::_setup_autoloaders($addon_name);
-        // register new models and extensions
-        \EE_Register_Addon::_register_models_and_extensions($addon_name);
-        // setup DMS
-        \EE_Register_Addon::_register_data_migration_scripts($addon_name);
-        // if config_class is present let's register config.
-        \EE_Register_Addon::_register_config($addon_name);
-        // register admin pages
-        \EE_Register_Addon::_register_admin_pages($addon_name);
-        // add to list of modules to be registered
-        \EE_Register_Addon::_register_modules($addon_name);
-        // add to list of shortcodes to be registered
-        \EE_Register_Addon::_register_shortcodes($addon_name);
-        // add to list of widgets to be registered
-        \EE_Register_Addon::_register_widgets($addon_name);
-        // register capability related stuff.
-        \EE_Register_Addon::_register_capabilities($addon_name);
-        // any message type to register?
-        \EE_Register_Addon::_register_message_types($addon_name);
+		\EE_Register_Addon::_setup_namespaces($addon_settings);
+		// check if this is an activation request
+		if ( \EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
+			// dont bother setting up the rest of the addon atm
+			return;
+		}
+		// we need cars
+		\EE_Register_Addon::_setup_autoloaders($addon_name);
+		// register new models and extensions
+		\EE_Register_Addon::_register_models_and_extensions($addon_name);
+		// setup DMS
+		\EE_Register_Addon::_register_data_migration_scripts($addon_name);
+		// if config_class is present let's register config.
+		\EE_Register_Addon::_register_config($addon_name);
+		// register admin pages
+		\EE_Register_Addon::_register_admin_pages($addon_name);
+		// add to list of modules to be registered
+		\EE_Register_Addon::_register_modules($addon_name);
+		// add to list of shortcodes to be registered
+		\EE_Register_Addon::_register_shortcodes($addon_name);
+		// add to list of widgets to be registered
+		\EE_Register_Addon::_register_widgets($addon_name);
+		// register capability related stuff.
+		\EE_Register_Addon::_register_capabilities($addon_name);
+		// any message type to register?
+		\EE_Register_Addon::_register_message_types($addon_name);
 		// any custom post type/ custom capabilities or default terms to register
-        \EE_Register_Addon::_register_custom_post_types($addon_name);
-        // and any payment methods
-        \EE_Register_Addon::_register_payment_methods($addon_name);
+		\EE_Register_Addon::_register_custom_post_types($addon_name);
+		// and any payment methods
+		\EE_Register_Addon::_register_payment_methods($addon_name);
 		// load and instantiate main addon class
-        $addon = \EE_Register_Addon::_load_and_init_addon_class($addon_name);
-        $addon->after_registration();
-    }
-
-
-
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _verify_parameters($addon_name, array $setup_args)
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args)) {
-            throw new EE_Error(
-                __(
-                    'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
-                    'event_espresso'
-                )
-            );
-        }
-        if ( ! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
-                        'event_espresso'
-                    ),
-                    implode(',', array_keys($setup_args))
-                )
-            );
-        }
-        // check that addon has not already been registered with that name
-        if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                )
-            );
-        }
+		$addon = \EE_Register_Addon::_load_and_init_addon_class($addon_name);
+		$addon->after_registration();
+	}
+
+
+
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _verify_parameters($addon_name, array $setup_args)
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args)) {
+			throw new EE_Error(
+				__(
+					'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
+					'event_espresso'
+				)
+			);
+		}
+		if ( ! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
+						'event_espresso'
+					),
+					implode(',', array_keys($setup_args))
+				)
+			);
+		}
+		// check that addon has not already been registered with that name
+		if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
+						'event_espresso'
+					),
+					$addon_name
+				)
+			);
+		}
 	}
 
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return string
-     */
-    private static function _parse_class_name($addon_name, array $setup_args)
-    {
-        if (empty($setup_args['class_name'])) {
-            // generate one by first separating name with spaces
-            $class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
-            //capitalize, then replace spaces with underscores
-            $class_name = str_replace(' ', '_', ucwords($class_name));
-        } else {
-            $class_name = $setup_args['class_name'];
-        }
-        return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name;
-    }
-
-
-
-    /**
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return array
-     */
-    private static function _get_addon_settings($class_name, array $setup_args)
-    {
-        //setup $_settings array from incoming values.
-        $addon_settings = array(
-            // generated from the addon name, changes something like "calendar" to "EE_Calendar"
-            'class_name'            => $class_name,
-            // the addon slug for use in URLs, etc
-            'plugin_slug'           => isset($setup_args['plugin_slug'])
-                ? (string)$setup_args['plugin_slug']
-                : '',
-            // page slug to be used when generating the "Settings" link on the WP plugin page
-            'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
-                ? (string)$setup_args['plugin_action_slug']
-                : '',
-            // the "software" version for the addon
-            'version'               => isset($setup_args['version'])
-                ? (string)$setup_args['version']
-                : '',
-            // the minimum version of EE Core that the addon will work with
-            'min_core_version'      => isset($setup_args['min_core_version'])
-                ? (string)$setup_args['min_core_version']
-                : '',
-            // the minimum version of WordPress that the addon will work with
-            'min_wp_version'        => isset($setup_args['min_wp_version'])
-                ? (string)$setup_args['min_wp_version']
-                : EE_MIN_WP_VER_REQUIRED,
-            // full server path to main file (file loaded directly by WP)
-            'main_file_path'        => isset($setup_args['main_file_path'])
-                ? (string)$setup_args['main_file_path']
-                : '',
-            // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
-            'admin_path'            => isset($setup_args['admin_path'])
-                ? (string)$setup_args['admin_path'] : '',
-            // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
-            'admin_callback'        => isset($setup_args['admin_callback'])
-                ? (string)$setup_args['admin_callback']
-                : '',
-            // the section name for this addon's configuration settings section (defaults to "addons")
-            'config_section'        => isset($setup_args['config_section'])
-                ? (string)$setup_args['config_section']
-                : 'addons',
-            // the class name for this addon's configuration settings object
-            'config_class'          => isset($setup_args['config_class'])
-                ? (string)$setup_args['config_class'] : '',
-            //the name given to the config for this addons' configuration settings object (optional)
-            'config_name'           => isset($setup_args['config_name'])
-                ? (string)$setup_args['config_name'] : '',
-            // an array of "class names" => "full server paths" for any classes that might be invoked by the addon
-            'autoloader_paths'      => isset($setup_args['autoloader_paths'])
-                ? (array)$setup_args['autoloader_paths']
-                : array(),
-            // an array of  "full server paths" for any folders containing classes that might be invoked by the addon
-            'autoloader_folders'    => isset($setup_args['autoloader_folders'])
-                ? (array)$setup_args['autoloader_folders']
-                : array(),
-            // array of full server paths to any EE_DMS data migration scripts used by the addon
-            'dms_paths'             => isset($setup_args['dms_paths'])
-                ? (array)$setup_args['dms_paths']
-                : array(),
-            // array of full server paths to any EED_Modules used by the addon
-            'module_paths'          => isset($setup_args['module_paths'])
-                ? (array)$setup_args['module_paths']
-                : array(),
-            // array of full server paths to any EES_Shortcodes used by the addon
-            'shortcode_paths'       => isset($setup_args['shortcode_paths'])
-                ? (array)$setup_args['shortcode_paths']
-                : array(),
-            // array of full server paths to any WP_Widgets used by the addon
-            'widget_paths'          => isset($setup_args['widget_paths'])
-                ? (array)$setup_args['widget_paths']
-                : array(),
-            // array of PUE options used by the addon
-            'pue_options'           => isset($setup_args['pue_options'])
-                ? (array)$setup_args['pue_options']
-                : array(),
-            'message_types'         => isset($setup_args['message_types'])
-                ? (array)$setup_args['message_types']
-                : array(),
-            'capabilities'          => isset($setup_args['capabilities'])
-                ? (array)$setup_args['capabilities']
-                : array(),
-            'capability_maps'       => isset($setup_args['capability_maps'])
-                ? (array)$setup_args['capability_maps']
-                : array(),
-            'model_paths'           => isset($setup_args['model_paths'])
-                ? (array)$setup_args['model_paths']
-                : array(),
-            'class_paths'           => isset($setup_args['class_paths'])
-                ? (array)$setup_args['class_paths']
-                : array(),
-            'model_extension_paths' => isset($setup_args['model_extension_paths'])
-                ? (array)$setup_args['model_extension_paths']
-                : array(),
-            'class_extension_paths' => isset($setup_args['class_extension_paths'])
-                ? (array)$setup_args['class_extension_paths']
-                : array(),
-            'custom_post_types'     => isset($setup_args['custom_post_types'])
-                ? (array)$setup_args['custom_post_types']
-                : array(),
-            'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
-                ? (array)$setup_args['custom_taxonomies']
-                : array(),
-            'payment_method_paths'  => isset($setup_args['payment_method_paths'])
-                ? (array)$setup_args['payment_method_paths']
-                : array(),
-            'default_terms'         => isset($setup_args['default_terms'])
-                ? (array)$setup_args['default_terms']
-                : array(),
-            // if not empty, inserts a new table row after this plugin's row on the WP Plugins page
-            // that can be used for adding upgrading/marketing info
-            'plugins_page_row'      => isset($setup_args['plugins_page_row'])
-                ? $setup_args['plugins_page_row']
-                : '',
-            'namespace'             => isset(
-                $setup_args['namespace'],
-                $setup_args['namespace']['FQNS'],
-                $setup_args['namespace']['DIR']
-            )
-                ? (array)$setup_args['namespace']
-                : array(),
-        );
-        // if plugin_action_slug is NOT set, but an admin page path IS set,
-        // then let's just use the plugin_slug since that will be used for linking to the admin page
-        $addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
-                                                && ! empty($addon_settings['admin_path'])
-            ? $addon_settings['plugin_slug']
-            : $addon_settings['plugin_action_slug'];
-        // full server path to main file (file loaded directly by WP)
-        $addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
-        return $addon_settings;
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return string
+	 */
+	private static function _parse_class_name($addon_name, array $setup_args)
+	{
+		if (empty($setup_args['class_name'])) {
+			// generate one by first separating name with spaces
+			$class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
+			//capitalize, then replace spaces with underscores
+			$class_name = str_replace(' ', '_', ucwords($class_name));
+		} else {
+			$class_name = $setup_args['class_name'];
+		}
+		return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name;
 	}
 
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return boolean
-     */
+	/**
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return array
+	 */
+	private static function _get_addon_settings($class_name, array $setup_args)
+	{
+		//setup $_settings array from incoming values.
+		$addon_settings = array(
+			// generated from the addon name, changes something like "calendar" to "EE_Calendar"
+			'class_name'            => $class_name,
+			// the addon slug for use in URLs, etc
+			'plugin_slug'           => isset($setup_args['plugin_slug'])
+				? (string)$setup_args['plugin_slug']
+				: '',
+			// page slug to be used when generating the "Settings" link on the WP plugin page
+			'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
+				? (string)$setup_args['plugin_action_slug']
+				: '',
+			// the "software" version for the addon
+			'version'               => isset($setup_args['version'])
+				? (string)$setup_args['version']
+				: '',
+			// the minimum version of EE Core that the addon will work with
+			'min_core_version'      => isset($setup_args['min_core_version'])
+				? (string)$setup_args['min_core_version']
+				: '',
+			// the minimum version of WordPress that the addon will work with
+			'min_wp_version'        => isset($setup_args['min_wp_version'])
+				? (string)$setup_args['min_wp_version']
+				: EE_MIN_WP_VER_REQUIRED,
+			// full server path to main file (file loaded directly by WP)
+			'main_file_path'        => isset($setup_args['main_file_path'])
+				? (string)$setup_args['main_file_path']
+				: '',
+			// path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
+			'admin_path'            => isset($setup_args['admin_path'])
+				? (string)$setup_args['admin_path'] : '',
+			// a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
+			'admin_callback'        => isset($setup_args['admin_callback'])
+				? (string)$setup_args['admin_callback']
+				: '',
+			// the section name for this addon's configuration settings section (defaults to "addons")
+			'config_section'        => isset($setup_args['config_section'])
+				? (string)$setup_args['config_section']
+				: 'addons',
+			// the class name for this addon's configuration settings object
+			'config_class'          => isset($setup_args['config_class'])
+				? (string)$setup_args['config_class'] : '',
+			//the name given to the config for this addons' configuration settings object (optional)
+			'config_name'           => isset($setup_args['config_name'])
+				? (string)$setup_args['config_name'] : '',
+			// an array of "class names" => "full server paths" for any classes that might be invoked by the addon
+			'autoloader_paths'      => isset($setup_args['autoloader_paths'])
+				? (array)$setup_args['autoloader_paths']
+				: array(),
+			// an array of  "full server paths" for any folders containing classes that might be invoked by the addon
+			'autoloader_folders'    => isset($setup_args['autoloader_folders'])
+				? (array)$setup_args['autoloader_folders']
+				: array(),
+			// array of full server paths to any EE_DMS data migration scripts used by the addon
+			'dms_paths'             => isset($setup_args['dms_paths'])
+				? (array)$setup_args['dms_paths']
+				: array(),
+			// array of full server paths to any EED_Modules used by the addon
+			'module_paths'          => isset($setup_args['module_paths'])
+				? (array)$setup_args['module_paths']
+				: array(),
+			// array of full server paths to any EES_Shortcodes used by the addon
+			'shortcode_paths'       => isset($setup_args['shortcode_paths'])
+				? (array)$setup_args['shortcode_paths']
+				: array(),
+			// array of full server paths to any WP_Widgets used by the addon
+			'widget_paths'          => isset($setup_args['widget_paths'])
+				? (array)$setup_args['widget_paths']
+				: array(),
+			// array of PUE options used by the addon
+			'pue_options'           => isset($setup_args['pue_options'])
+				? (array)$setup_args['pue_options']
+				: array(),
+			'message_types'         => isset($setup_args['message_types'])
+				? (array)$setup_args['message_types']
+				: array(),
+			'capabilities'          => isset($setup_args['capabilities'])
+				? (array)$setup_args['capabilities']
+				: array(),
+			'capability_maps'       => isset($setup_args['capability_maps'])
+				? (array)$setup_args['capability_maps']
+				: array(),
+			'model_paths'           => isset($setup_args['model_paths'])
+				? (array)$setup_args['model_paths']
+				: array(),
+			'class_paths'           => isset($setup_args['class_paths'])
+				? (array)$setup_args['class_paths']
+				: array(),
+			'model_extension_paths' => isset($setup_args['model_extension_paths'])
+				? (array)$setup_args['model_extension_paths']
+				: array(),
+			'class_extension_paths' => isset($setup_args['class_extension_paths'])
+				? (array)$setup_args['class_extension_paths']
+				: array(),
+			'custom_post_types'     => isset($setup_args['custom_post_types'])
+				? (array)$setup_args['custom_post_types']
+				: array(),
+			'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
+				? (array)$setup_args['custom_taxonomies']
+				: array(),
+			'payment_method_paths'  => isset($setup_args['payment_method_paths'])
+				? (array)$setup_args['payment_method_paths']
+				: array(),
+			'default_terms'         => isset($setup_args['default_terms'])
+				? (array)$setup_args['default_terms']
+				: array(),
+			// if not empty, inserts a new table row after this plugin's row on the WP Plugins page
+			// that can be used for adding upgrading/marketing info
+			'plugins_page_row'      => isset($setup_args['plugins_page_row'])
+				? $setup_args['plugins_page_row']
+				: '',
+			'namespace'             => isset(
+				$setup_args['namespace'],
+				$setup_args['namespace']['FQNS'],
+				$setup_args['namespace']['DIR']
+			)
+				? (array)$setup_args['namespace']
+				: array(),
+		);
+		// if plugin_action_slug is NOT set, but an admin page path IS set,
+		// then let's just use the plugin_slug since that will be used for linking to the admin page
+		$addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
+												&& ! empty($addon_settings['admin_path'])
+			? $addon_settings['plugin_slug']
+			: $addon_settings['plugin_action_slug'];
+		// full server path to main file (file loaded directly by WP)
+		$addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
+		return $addon_settings;
+	}
+
+
+
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return boolean
+	 */
 	private static function _addon_is_compatible( $addon_name, array $addon_settings ) {
-        global $wp_version;
-        $incompatibility_message = '';
-        //check whether this addon version is compatible with EE core
-        if (
-            isset(EE_Register_Addon::$_incompatible_addons[$addon_name])
-            && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[$addon_name],
-                $addon_settings['version']
-            )
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.'
-                ),
-                $addon_name,
-                '<br />',
-                EE_Register_Addon::$_incompatible_addons[$addon_name],
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } else if (
-            ! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
-                    'event_espresso'
-                ),
-                $addon_name,
-                self::_effective_version($addon_settings['min_core_version']),
-                self::_effective_version(espresso_version()),
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } else if (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                $addon_settings['min_wp_version'],
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        }
-        if ( ! empty($incompatibility_message)) {
-            // remove 'activate' from the REQUEST
-            // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
-            unset($_GET['activate'], $_REQUEST['activate']);
-            if (current_user_can('activate_plugins')) {
-                // show an error message indicating the plugin didn't activate properly
-                EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
-            }
-            // BAIL FROM THE ADDON REGISTRATION PROCESS
-            return false;
-        }
-        // addon IS compatible
-        return true;
+		global $wp_version;
+		$incompatibility_message = '';
+		//check whether this addon version is compatible with EE core
+		if (
+			isset(EE_Register_Addon::$_incompatible_addons[$addon_name])
+			&& ! self::_meets_min_core_version_requirement(
+				EE_Register_Addon::$_incompatible_addons[$addon_name],
+				$addon_settings['version']
+			)
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.'
+				),
+				$addon_name,
+				'<br />',
+				EE_Register_Addon::$_incompatible_addons[$addon_name],
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} else if (
+			! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
+					'event_espresso'
+				),
+				$addon_name,
+				self::_effective_version($addon_settings['min_core_version']),
+				self::_effective_version(espresso_version()),
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} else if (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
+					'event_espresso'
+				),
+				$addon_name,
+				$addon_settings['min_wp_version'],
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		}
+		if ( ! empty($incompatibility_message)) {
+			// remove 'activate' from the REQUEST
+			// so WP doesn't erroneously tell the user the plugin activated fine when it didn't
+			unset($_GET['activate'], $_REQUEST['activate']);
+			if (current_user_can('activate_plugins')) {
+				// show an error message indicating the plugin didn't activate properly
+				EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
+			}
+			// BAIL FROM THE ADDON REGISTRATION PROCESS
+			return false;
+		}
+		// addon IS compatible
+		return true;
 	}
 
 
 
-    /**
-     * if plugin update engine is being used for auto-updates,
-     * then let's set that up now before going any further so that ALL addons can be updated
-     * (not needed if PUE is not being used)
-     *
-     * @param string $addon_name
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return void
-     */
+	/**
+	 * if plugin update engine is being used for auto-updates,
+	 * then let's set that up now before going any further so that ALL addons can be updated
+	 * (not needed if PUE is not being used)
+	 *
+	 * @param string $addon_name
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return void
+	 */
 	private static function _parse_pue_options( $addon_name, $class_name, array $setup_args ) {
-        if ( ! empty($setup_args['pue_options'])) {
-            self::$_settings[$addon_name]['pue_options'] = array(
-                'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
-                    ? (string)$setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
-                'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
-                    ? (string)$setup_args['pue_options']['plugin_basename']
-                    : plugin_basename($setup_args['main_file_path']),
-                'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
-                    ? (string)$setup_args['pue_options']['checkPeriod']
-                    : '24',
-                'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
-                    ? (string)$setup_args['pue_options']['use_wp_update']
-                    : false,
-            );
-            add_action(
-                'AHEE__EE_System__brew_espresso__after_pue_init',
-                array('EE_Register_Addon', 'load_pue_update')
-            );
-        }
+		if ( ! empty($setup_args['pue_options'])) {
+			self::$_settings[$addon_name]['pue_options'] = array(
+				'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
+					? (string)$setup_args['pue_options']['pue_plugin_slug']
+					: 'espresso_' . strtolower($class_name),
+				'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
+					? (string)$setup_args['pue_options']['plugin_basename']
+					: plugin_basename($setup_args['main_file_path']),
+				'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
+					? (string)$setup_args['pue_options']['checkPeriod']
+					: '24',
+				'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
+					? (string)$setup_args['pue_options']['use_wp_update']
+					: false,
+			);
+			add_action(
+				'AHEE__EE_System__brew_espresso__after_pue_init',
+				array('EE_Register_Addon', 'load_pue_update')
+			);
+		}
 	}
 
 
 
-    /**
-     * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
-     *
-     * @param array $addon_settings
-     * @return void
-     */
-    private static function _setup_namespaces(array $addon_settings)
-    {
-        //
-        if (
-        isset(
-            $addon_settings['namespace'],
-            $addon_settings['namespace']['FQNS'],
-            $addon_settings['namespace']['DIR']
-        )
-        ) {
-            EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
-                $addon_settings['namespace']['FQNS'],
-                $addon_settings['namespace']['DIR']
-            );
-        }
-    }
-
-
-
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return bool
-     */
+	/**
+	 * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
+	 *
+	 * @param array $addon_settings
+	 * @return void
+	 */
+	private static function _setup_namespaces(array $addon_settings)
+	{
+		//
+		if (
+		isset(
+			$addon_settings['namespace'],
+			$addon_settings['namespace']['FQNS'],
+			$addon_settings['namespace']['DIR']
+		)
+		) {
+			EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
+				$addon_settings['namespace']['FQNS'],
+				$addon_settings['namespace']['DIR']
+			);
+		}
+	}
+
+
+
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return bool
+	 */
 	private static function _addon_activation( $addon_name, array $addon_settings ) {
-        // this is an activation request
-        if (did_action('activate_plugin')) {
-            //to find if THIS is the addon that was activated,
-            //just check if we have already registered it or not
-            //(as the newly-activated addon wasn't around the first time addons were registered)
-            if ( ! isset(self::$_settings[$addon_name])) {
-                self::$_settings[$addon_name] = $addon_settings;
-                $addon = self::_load_and_init_addon_class($addon_name);
-                $addon->set_activation_indicator_option();
-                // dont bother setting up the rest of the addon.
-                // we know it was just activated and the request will end soon
-            }
-            return true;
-        } else {
-            // make sure this was called in the right place!
-            if (
-                ! did_action('AHEE__EE_System__load_espresso_addons')
-                || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
-            ) {
-                EE_Error::doing_it_wrong(
-                    __METHOD__,
-                    sprintf(
-                        __(
-                            'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
-                            'event_espresso'
-                        ),
-                        $addon_name
-                    ),
-                    '4.3.0'
-                );
-            }
-            // make sure addon settings are set correctly without overwriting anything existing
-            if (isset(self::$_settings[$addon_name])) {
-                self::$_settings[$addon_name] += $addon_settings;
-            } else {
-                self::$_settings[$addon_name] = $addon_settings;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _setup_autoloaders($addon_name)
-    {
-        if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
-            // setup autoloader for single file
-            EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
-        }
-        // setup autoloaders for folders
-        if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
-            foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
-            }
-        }
-    }
-
-
-
-    /**
-     * register new models and extensions
-     *
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		// this is an activation request
+		if (did_action('activate_plugin')) {
+			//to find if THIS is the addon that was activated,
+			//just check if we have already registered it or not
+			//(as the newly-activated addon wasn't around the first time addons were registered)
+			if ( ! isset(self::$_settings[$addon_name])) {
+				self::$_settings[$addon_name] = $addon_settings;
+				$addon = self::_load_and_init_addon_class($addon_name);
+				$addon->set_activation_indicator_option();
+				// dont bother setting up the rest of the addon.
+				// we know it was just activated and the request will end soon
+			}
+			return true;
+		} else {
+			// make sure this was called in the right place!
+			if (
+				! did_action('AHEE__EE_System__load_espresso_addons')
+				|| did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
+			) {
+				EE_Error::doing_it_wrong(
+					__METHOD__,
+					sprintf(
+						__(
+							'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
+							'event_espresso'
+						),
+						$addon_name
+					),
+					'4.3.0'
+				);
+			}
+			// make sure addon settings are set correctly without overwriting anything existing
+			if (isset(self::$_settings[$addon_name])) {
+				self::$_settings[$addon_name] += $addon_settings;
+			} else {
+				self::$_settings[$addon_name] = $addon_settings;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _setup_autoloaders($addon_name)
+	{
+		if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
+			// setup autoloader for single file
+			EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
+		}
+		// setup autoloaders for folders
+		if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
+			foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
+			}
+		}
+	}
+
+
+
+	/**
+	 * register new models and extensions
+	 *
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_models_and_extensions( $addon_name ) {
-        // register new models
-        if (
-            ! empty(self::$_settings[$addon_name]['model_paths'])
-            || ! empty(self::$_settings[$addon_name]['class_paths'])
-        ) {
-            EE_Register_Model::register(
-                $addon_name,
-                array(
-                    'model_paths' => self::$_settings[$addon_name]['model_paths'],
-                    'class_paths' => self::$_settings[$addon_name]['class_paths'],
-                )
-            );
-        }
-        // register model extensions
-        if (
-            ! empty(self::$_settings[$addon_name]['model_extension_paths'])
-            || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
-        ) {
-            EE_Register_Model_Extensions::register(
-                $addon_name,
-                array(
-                    'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'],
-                    'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'],
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		// register new models
+		if (
+			! empty(self::$_settings[$addon_name]['model_paths'])
+			|| ! empty(self::$_settings[$addon_name]['class_paths'])
+		) {
+			EE_Register_Model::register(
+				$addon_name,
+				array(
+					'model_paths' => self::$_settings[$addon_name]['model_paths'],
+					'class_paths' => self::$_settings[$addon_name]['class_paths'],
+				)
+			);
+		}
+		// register model extensions
+		if (
+			! empty(self::$_settings[$addon_name]['model_extension_paths'])
+			|| ! empty(self::$_settings[$addon_name]['class_extension_paths'])
+		) {
+			EE_Register_Model_Extensions::register(
+				$addon_name,
+				array(
+					'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'],
+					'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'],
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_data_migration_scripts( $addon_name ) {
-        // setup DMS
-        if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
-            EE_Register_Data_Migration_Scripts::register(
-                $addon_name,
-                array('dms_paths' => self::$_settings[$addon_name]['dms_paths'])
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		// setup DMS
+		if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
+			EE_Register_Data_Migration_Scripts::register(
+				$addon_name,
+				array('dms_paths' => self::$_settings[$addon_name]['dms_paths'])
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_config( $addon_name ) {
-        // if config_class is present let's register config.
-        if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
-            EE_Register_Config::register(
-                self::$_settings[$addon_name]['config_class'],
-                array(
-                    'config_section' => self::$_settings[$addon_name]['config_section'],
-                    'config_name'    => self::$_settings[$addon_name]['config_name'],
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		// if config_class is present let's register config.
+		if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
+			EE_Register_Config::register(
+				self::$_settings[$addon_name]['config_class'],
+				array(
+					'config_section' => self::$_settings[$addon_name]['config_section'],
+					'config_name'    => self::$_settings[$addon_name]['config_name'],
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_admin_pages( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
-            EE_Register_Admin_Page::register(
-                $addon_name,
-                array('page_path' => self::$_settings[$addon_name]['admin_path'])
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
+			EE_Register_Admin_Page::register(
+				$addon_name,
+				array('page_path' => self::$_settings[$addon_name]['admin_path'])
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_modules( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
-            EE_Register_Module::register(
-                $addon_name,
-                array('module_paths' => self::$_settings[$addon_name]['module_paths'])
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
+			EE_Register_Module::register(
+				$addon_name,
+				array('module_paths' => self::$_settings[$addon_name]['module_paths'])
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_shortcodes( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
-            EE_Register_Shortcode::register(
-                $addon_name,
-                array('shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths'])
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
+			EE_Register_Shortcode::register(
+				$addon_name,
+				array('shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths'])
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_widgets( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
-            EE_Register_Widget::register(
-                $addon_name,
-                array('widget_paths' => self::$_settings[$addon_name]['widget_paths'])
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
+			EE_Register_Widget::register(
+				$addon_name,
+				array('widget_paths' => self::$_settings[$addon_name]['widget_paths'])
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_capabilities( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['capabilities'])) {
-            EE_Register_Capabilities::register(
-                $addon_name,
-                array(
-                    'capabilities'    => self::$_settings[$addon_name]['capabilities'],
-                    'capability_maps' => self::$_settings[$addon_name]['capability_maps'],
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if ( ! empty(self::$_settings[$addon_name]['capabilities'])) {
+			EE_Register_Capabilities::register(
+				$addon_name,
+				array(
+					'capabilities'    => self::$_settings[$addon_name]['capabilities'],
+					'capability_maps' => self::$_settings[$addon_name]['capability_maps'],
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_message_types( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
-            add_action(
-                'EE_Brewing_Regular___messages_caf',
-                array('EE_Register_Addon', 'register_message_types')
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
+			add_action(
+				'EE_Brewing_Regular___messages_caf',
+				array('EE_Register_Addon', 'register_message_types')
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_custom_post_types( $addon_name ) {
-        if (
-            ! empty(self::$_settings[$addon_name]['custom_post_types'])
-            || ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
-        ) {
-            EE_Register_CPT::register(
-                $addon_name,
-                array(
-                    'cpts'          => self::$_settings[$addon_name]['custom_post_types'],
-                    'cts'           => self::$_settings[$addon_name]['custom_taxonomies'],
-                    'default_terms' => self::$_settings[$addon_name]['default_terms'],
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if (
+			! empty(self::$_settings[$addon_name]['custom_post_types'])
+			|| ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
+		) {
+			EE_Register_CPT::register(
+				$addon_name,
+				array(
+					'cpts'          => self::$_settings[$addon_name]['custom_post_types'],
+					'cts'           => self::$_settings[$addon_name]['custom_taxonomies'],
+					'default_terms' => self::$_settings[$addon_name]['default_terms'],
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_payment_methods( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
-            EE_Register_Payment_Method::register(
-                $addon_name,
-                array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths'])
-            );
-        }
-    }
+		if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
+			EE_Register_Payment_Method::register(
+				$addon_name,
+				array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths'])
+			);
+		}
+	}
 
 
 
@@ -901,14 +901,14 @@ 
 		//unfortunately this can't be hooked in upon construction, because we don't have
 		//the plugin mainfile's path upon construction.
 		register_deactivation_hook( $addon->get_main_plugin_file(), array( $addon, 'deactivation' ) );
-        // call any additional admin_callback functions during load_admin_controller hook
-        if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
-            add_action(
-                'AHEE__EE_System__load_controllers__load_admin_controllers',
-                array($addon, self::$_settings[$addon_name]['admin_callback'])
-            );
-        }
-        return $addon;
+		// call any additional admin_callback functions during load_admin_controller hook
+		if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
+			add_action(
+				'AHEE__EE_System__load_controllers__load_admin_controllers',
+				array($addon, self::$_settings[$addon_name]['admin_callback'])
+			);
+		}
+		return $addon;
 	}
 
 
@@ -924,7 +924,7 @@ 
 		// cycle thru settings
 		foreach ( self::$_settings as $settings ) {
 			if ( ! empty( $settings['pue_options'] ) ) {
-                // initiate the class and start the plugin update engine!
+				// initiate the class and start the plugin update engine!
 				new PluginUpdateEngineChecker(
 				// host file URL
 					'https://eventespresso.com',
@@ -960,11 +960,11 @@ 
 	 */
 	public static function register_message_types() {
 		foreach ( self::$_settings as $addon_name => $settings ) {
-		    if ( ! empty($settings['message_types'])) {
-                foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) {
-                    EE_Register_Message_Type::register($message_type, $message_type_settings);
-                }
-            }
+			if ( ! empty($settings['message_types'])) {
+				foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) {
+					EE_Register_Message_Type::register($message_type, $message_type_settings);
+				}
+			}
 		}
 	}
 
@@ -1006,15 +1006,15 @@ 
 				EE_Register_Widget::deregister( $addon_name );
 			}
 			if ( ! empty( self::$_settings[ $addon_name ]['model_paths'] )
-			     ||
-			     ! empty( self::$_settings[ $addon_name ]['class_paths'] )
+				 ||
+				 ! empty( self::$_settings[ $addon_name ]['class_paths'] )
 			) {
 				// add to list of shortcodes to be registered
 				EE_Register_Model::deregister( $addon_name );
 			}
 			if ( ! empty( self::$_settings[ $addon_name ]['model_extension_paths'] )
-			     ||
-			     ! empty( self::$_settings[ $addon_name ]['class_extension_paths'] )
+				 ||
+				 ! empty( self::$_settings[ $addon_name ]['class_extension_paths'] )
 			) {
 				// add to list of shortcodes to be registered
 				EE_Register_Model_Extensions::deregister( $addon_name );