eventespresso / event-espresso-core

core/db_models/fields/EE_Datetime_Field.php

Doc Comments +1 added lines, -1 removed lines

@@ -503,7 +503,7 @@
 	 * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
 	 * allowed)
 	 * @param string $datetime_string mysql timestamp in UTC
-	 * @return  mixed null | DateTime
+	 * @return  null|DateTime null | DateTime
 	 */
 	public function prepare_for_set_from_db( $datetime_string ) {
 		//if $datetime_value is empty, and ! $this->_nullable, just use time()

Indentation +8 added lines, -8 removed lines

@@ -2,14 +2,14 @@
 	exit( 'No direct script access allowed' );
 }
 /**
- * EE_Datetime_Field
- *
- * Text_Fields is a base class for any fields which are have integer value. (Exception: foreign and private key fields. Wish PHP had multiple-inheritance for this...)
- *
- * @package 			Event Espresso
- * @subpackage 	/core/db_models/fields/EE_Datetime_Field.php
- * @author 				Darren Ethier
- */
+	 * EE_Datetime_Field
+	 *
+	 * Text_Fields is a base class for any fields which are have integer value. (Exception: foreign and private key fields. Wish PHP had multiple-inheritance for this...)
+	 *
+	 * @package 			Event Espresso
+	 * @subpackage 	/core/db_models/fields/EE_Datetime_Field.php
+	 * @author 				Darren Ethier
+	 */
 class EE_Datetime_Field extends EE_Model_Field_Base {
 
 	/**

Braces +1 added lines, -1 removed lines

@@ -459,7 +459,7 @@
 				//must be explicit because schema could equal true.
 				if( $schema === 'no_html' ){
 					$timezone_string = ' (' . $DateTime->format( 'T' )  . ')';
-				}else{
+				} else{
 					$timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format( 'T' ) . ')</span>';
 				}
 			} else {

Spacing +103 added lines, -103 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');
 }
 /**
  * EE_Datetime_Field
@@ -111,16 +111,16 @@ 
 	 * @param string 	$pretty_date_format
 	 * @param string 	$pretty_time_format
 	 */
-	public function __construct( $table_column, $nice_name, $nullable, $default_value, $timezone_string = '', $date_format = '', $time_format = '', $pretty_date_format = '', $pretty_time_format = '' ){
+	public function __construct($table_column, $nice_name, $nullable, $default_value, $timezone_string = '', $date_format = '', $time_format = '', $pretty_date_format = '', $pretty_time_format = '') {
 
-		$this->_date_format = ! empty( $date_format ) ? $date_format : get_option('date_format');
-		$this->_time_format = ! empty( $time_format ) ? $time_format : get_option('time_format');
-		$this->_pretty_date_format = ! empty( $pretty_date_format ) ? $pretty_date_format : get_option('date_format');
-		$this->_pretty_time_format = ! empty( $pretty_time_format ) ? $pretty_time_format : get_option('time_format');
+		$this->_date_format = ! empty($date_format) ? $date_format : get_option('date_format');
+		$this->_time_format = ! empty($time_format) ? $time_format : get_option('time_format');
+		$this->_pretty_date_format = ! empty($pretty_date_format) ? $pretty_date_format : get_option('date_format');
+		$this->_pretty_time_format = ! empty($pretty_time_format) ? $pretty_time_format : get_option('time_format');
 
-		parent::__construct( $table_column, $nice_name, $nullable, $default_value );
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
 		EE_Registry::instance()->load_helper('DTT_Helper');
-		$this->set_timezone( $timezone_string );
+		$this->set_timezone($timezone_string);
 
 	}
 
@@ -139,7 +139,7 @@ 
 	 * @return DateTimeZone
 	 */
 	public function get_UTC_DateTimeZone() {
-		return $this->_UTC_DateTimeZone instanceof DateTimeZone ? $this->_UTC_DateTimeZone : $this->_create_timezone_object_from_timezone_string( 'UTC' );
+		return $this->_UTC_DateTimeZone instanceof DateTimeZone ? $this->_UTC_DateTimeZone : $this->_create_timezone_object_from_timezone_string('UTC');
 	}
 
 
@@ -148,7 +148,7 @@ 
 	 * @return DateTimeZone
 	 */
 	public function get_blog_DateTimeZone() {
-		return $this->_blog_DateTimeZone instanceof DateTimeZone ? $this->_blog_DateTimeZone : $this->_create_timezone_object_from_timezone_string( '' );
+		return $this->_blog_DateTimeZone instanceof DateTimeZone ? $this->_blog_DateTimeZone : $this->_create_timezone_object_from_timezone_string('');
 	}
 
 
@@ -158,8 +158,8 @@ 
 	 * @param  string|int $value_inputted_for_field_on_model_object could be a string formatted date time or int unix timestamp
 	 * @return DateTime
 	 */
-	public function prepare_for_set( $value_inputted_for_field_on_model_object ) {
-		return $this->_get_date_object( $value_inputted_for_field_on_model_object );
+	public function prepare_for_set($value_inputted_for_field_on_model_object) {
+		return $this->_get_date_object($value_inputted_for_field_on_model_object);
 	}
 
 
@@ -175,9 +175,9 @@ 
 	 * @param bool $pretty If we're returning the pretty formats or standard format string.
 	 * @return string    The final assembled format string.
 	 */
-	protected function _get_date_time_output( $pretty = FALSE ) {
+	protected function _get_date_time_output($pretty = FALSE) {
 
-		switch ( $this->_date_time_output ) {
+		switch ($this->_date_time_output) {
 			case 'time' :
 				return $pretty ? $this->_pretty_time_format : $this->_time_format;
 				break;
@@ -187,7 +187,7 @@ 
 				break;
 
 			default :
-				return $pretty ? $this->_pretty_date_format . ' ' . $this->_pretty_time_format : $this->_date_format . ' ' . $this->_time_format;
+				return $pretty ? $this->_pretty_date_format.' '.$this->_pretty_time_format : $this->_date_format.' '.$this->_time_format;
 		}
 	}
 
@@ -201,7 +201,7 @@ 
 	 * @param string $what acceptable values are 'time' or 'date'.  Any other value will be set but will always result in both 'date' and 'time' being returned.
 	 * @return void
 	 */
-	public function set_date_time_output( $what = NULL ) {
+	public function set_date_time_output($what = NULL) {
 		$this->_date_time_output = $what;
 	}
 
@@ -217,15 +217,15 @@ 
 	 * @param string $timezone_string A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
 	 * @return void
 	 */
-	public function set_timezone( $timezone_string ) {
-		if( empty( $timezone_string ) && $this->_timezone_string != NULL ){
+	public function set_timezone($timezone_string) {
+		if (empty($timezone_string) && $this->_timezone_string != NULL) {
 			// leave the timezone AS-IS if we already have one and
 			// the function arg didn't provide one
 			return;
 		}
-		$timezone_string = EEH_DTT_Helper::get_valid_timezone_string( $timezone_string );
-		$this->_timezone_string = ! empty( $timezone_string ) ? $timezone_string : 'UTC';
-		$this->_DateTimeZone = $this->_create_timezone_object_from_timezone_string( $this->_timezone_string );
+		$timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$this->_timezone_string = ! empty($timezone_string) ? $timezone_string : 'UTC';
+		$this->_DateTimeZone = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
 	}
 
 
@@ -237,8 +237,8 @@ 
 	 * @param string $timezone_string
 	 * @return \DateTimeZone
 	 */
-	protected function _create_timezone_object_from_timezone_string( $timezone_string = '' ) {
-		return new DateTimeZone( EEH_DTT_Helper::get_valid_timezone_string( $timezone_string ) );
+	protected function _create_timezone_object_from_timezone_string($timezone_string = '') {
+		return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
 	}
 
 
@@ -263,8 +263,8 @@ 
 	 * @param bool   $pretty Whether to set pretty format or not.
 	 * @return void
 	 */
-	public function set_date_format( $format, $pretty = false ) {
-		if ( $pretty ) {
+	public function set_date_format($format, $pretty = false) {
+		if ($pretty) {
 			$this->_pretty_date_format = $format;
 		} else {
 			$this->_date_format = $format;
@@ -279,7 +279,7 @@ 
 	 * @param bool   $pretty Whether to get pretty format or not.
 	 * @return string
 	 */
-	public function get_date_format( $pretty = false ) {
+	public function get_date_format($pretty = false) {
 		return $pretty ? $this->_pretty_date_format : $this->_date_format;
 	}
 
@@ -294,8 +294,8 @@ 
 	 * @param bool   $pretty Whether to set pretty format or not.
 	 * @return void
 	 */
-	public function set_time_format( $format, $pretty = false ) {
-		if ( $pretty ) {
+	public function set_time_format($format, $pretty = false) {
+		if ($pretty) {
 			$this->_pretty_time_format = $format;
 		} else {
 			$this->_time_format = $format;
@@ -310,7 +310,7 @@ 
 	 * @param bool   $pretty Whether to get pretty format or not.
 	 * @return string
 	 */
-	public function get_time_format( $pretty = false ) {
+	public function get_time_format($pretty = false) {
 		return $pretty ? $this->_pretty_time_format : $this->_time_format;
 	}
 
@@ -325,7 +325,7 @@ 
 	 * @param string $format a new pretty date format (corresponding to formats accepted by PHP date() function)
 	 * @return void
 	 */
-	public function set_pretty_date_format( $format ) {
+	public function set_pretty_date_format($format) {
 		$this->_pretty_date_format = $format;
 	}
 
@@ -342,7 +342,7 @@ 
 	 * @param string $format a new pretty time format (corresponding to formats accepted by PHP date() function)
 	 * @return void
 	 */
-	public function set_pretty_time_format( $format ) {
+	public function set_pretty_time_format($format) {
 		$this->_pretty_time_format = $format;
 	}
 
@@ -354,9 +354,9 @@ 
 	 * @param DateTime    $current current DateTime object for the datetime field
 	 * @return DateTime
 	 */
-	public function prepare_for_set_with_new_time( $time_to_set_string, DateTime $current ){
+	public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current) {
 		//if $time_to_set_string is datetime object, then let's use it to set the parse array.  Otherwise parse the string.
-		if ( $time_to_set_string instanceof DateTime ) {
+		if ($time_to_set_string instanceof DateTime) {
 			$parsed = array(
 				'hour' => $time_to_set_string->format('H'),
 				'minute' => $time_to_set_string->format('i'),
@@ -364,12 +364,12 @@ 
 				);
 		} else {
 			//parse incoming string
-			$parsed = date_parse_from_format( $this->_time_format, $time_to_set_string );
+			$parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
 		}
 
 		//make sure $current is in the correct timezone.
-		$current->setTimezone( $this->_DateTimeZone );
-		return $current->setTime( $parsed['hour'], $parsed['minute'], $parsed['second'] );
+		$current->setTimezone($this->_DateTimeZone);
+		return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
 	}
 
 
@@ -380,9 +380,9 @@ 
 	 * @param DateTime    $current current DateTime object for the datetime field
 	 * @return DateTime
 	 */
-	public function prepare_for_set_with_new_date( $date_to_set_string, DateTime $current ){
+	public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current) {
 		//if $time_to_set_string is datetime object, then let's use it to set the parse array.  Otherwise parse the string.
-		if ( $date_to_set_string instanceof DateTime ) {
+		if ($date_to_set_string instanceof DateTime) {
 			$parsed = array(
 				'year' => $date_to_set_string->format('Y'),
 				'month' => $date_to_set_string->format('m'),
@@ -390,12 +390,12 @@ 
 				);
 		} else {
 			//parse incoming string
-			$parsed = date_parse_from_format( $this->_date_format, $date_to_set_string );
+			$parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
 		}
 
 		//make sure $current is in the correct timezone
-		$current->setTimezone( $this->_DateTimeZone );
-		return $current->setDate( $parsed['year'], $parsed['month'], $parsed['day'] );
+		$current->setTimezone($this->_DateTimeZone);
+		return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
 	}
 
 
@@ -407,8 +407,8 @@ 
 	 * @param  DateTime $DateTime
 	 * @return string formatted date time for given timezone
 	 */
-	public function prepare_for_get( $DateTime ) {
-		return $this->_prepare_for_display( $DateTime  );
+	public function prepare_for_get($DateTime) {
+		return $this->_prepare_for_display($DateTime);
 	}
 
 
@@ -423,8 +423,8 @@ 
 	 * @param null     $schema
 	 * @return string
 	 */
-	public function prepare_for_pretty_echoing( $DateTime, $schema = null ) {
-		return $this->_prepare_for_display( $DateTime, $schema ? $schema : true );
+	public function prepare_for_pretty_echoing($DateTime, $schema = null) {
+		return $this->_prepare_for_display($DateTime, $schema ? $schema : true);
 	}
 
 
@@ -438,36 +438,36 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	protected function _prepare_for_display( $DateTime, $schema = false ) {
-		if ( ! $DateTime instanceof DateTime  ) {
-			if ( $this->_nullable ) {
+	protected function _prepare_for_display($DateTime, $schema = false) {
+		if ( ! $DateTime instanceof DateTime) {
+			if ($this->_nullable) {
 				return '';
 			} else {
-				if ( WP_DEBUG ) {
-					throw new EE_Error( sprintf( __('EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.', 'event_espresso' ), $this->_nicename ) );
+				if (WP_DEBUG) {
+					throw new EE_Error(sprintf(__('EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.', 'event_espresso'), $this->_nicename));
 				} else {
-					$DateTime = new DateTime( "now" );
-					EE_Error::add_error( sprintf( __('EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.', 'event_espresso' ), $this->_nicename ) );
+					$DateTime = new DateTime("now");
+					EE_Error::add_error(sprintf(__('EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.', 'event_espresso'), $this->_nicename));
 				}
 			}
 		}
-		$format_string = $this->_get_date_time_output( $schema );
+		$format_string = $this->_get_date_time_output($schema);
 		//make sure datetime_value is in the correct timezone (in case that's been updated).
-		$DateTime->setTimezone( $this->_DateTimeZone );
-		if ( $schema ) {
-			if( $this->_display_timezone() ) {
+		$DateTime->setTimezone($this->_DateTimeZone);
+		if ($schema) {
+			if ($this->_display_timezone()) {
 				//must be explicit because schema could equal true.
-				if( $schema === 'no_html' ){
-					$timezone_string = ' (' . $DateTime->format( 'T' )  . ')';
-				}else{
-					$timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format( 'T' ) . ')</span>';
+				if ($schema === 'no_html') {
+					$timezone_string = ' ('.$DateTime->format('T').')';
+				} else {
+					$timezone_string = ' <span class="ee_dtt_timezone_string">('.$DateTime->format('T').')</span>';
 				}
 			} else {
 				$timezone_string = '';
 			}
-			return $DateTime->format( $format_string ) . $timezone_string;
+			return $DateTime->format($format_string).$timezone_string;
 		} else {
-			return $DateTime->format( $format_string );
+			return $DateTime->format($format_string);
 		}
 	}
 
@@ -481,18 +481,18 @@ 
 	 * @return string mysql timestamp in UTC
 	 * @throws \EE_Error
 	 */
-	public function prepare_for_use_in_db( $datetime_value ) {
+	public function prepare_for_use_in_db($datetime_value) {
 		//we allow an empty value or DateTime object, but nothing else.
-		if ( ! empty( $datetime_value ) && ! $datetime_value instanceof DateTime ) {
-			throw new EE_Error( __('The incoming value being prepared for setting in the database must either be empty or a php DateTime object', 'event_espresso' ) );
+		if ( ! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
+			throw new EE_Error(__('The incoming value being prepared for setting in the database must either be empty or a php DateTime object', 'event_espresso'));
 		}
 
-		if ( $datetime_value instanceof DateTime ) {
-			return $datetime_value->setTimezone( $this->get_UTC_DateTimeZone() )->format( EE_Datetime_Field::mysql_timestamp_format );
+		if ($datetime_value instanceof DateTime) {
+			return $datetime_value->setTimezone($this->get_UTC_DateTimeZone())->format(EE_Datetime_Field::mysql_timestamp_format);
 		}
 
 		// if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
-		return ! $this->_nullable && empty( $datetime_value ) ? current_time( 'mysql', true ) : null;
+		return ! $this->_nullable && empty($datetime_value) ? current_time('mysql', true) : null;
 	}
 
 
@@ -505,20 +505,20 @@ 
 	 * @param string $datetime_string mysql timestamp in UTC
 	 * @return  mixed null | DateTime
 	 */
-	public function prepare_for_set_from_db( $datetime_string ) {
+	public function prepare_for_set_from_db($datetime_string) {
 		//if $datetime_value is empty, and ! $this->_nullable, just use time()
-		if ( empty( $datetime_string) && $this->_nullable ) {
+		if (empty($datetime_string) && $this->_nullable) {
 			return null;
 		}
 		// datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
-		$DateTime = empty( $datetime_string ) ? new DateTime( 'now', $this->get_UTC_DateTimeZone() ) : DateTime::createFromFormat( EE_Datetime_Field::mysql_timestamp_format, $datetime_string, $this->get_UTC_DateTimeZone() );
+		$DateTime = empty($datetime_string) ? new DateTime('now', $this->get_UTC_DateTimeZone()) : DateTime::createFromFormat(EE_Datetime_Field::mysql_timestamp_format, $datetime_string, $this->get_UTC_DateTimeZone());
 
-		if ( ! $DateTime instanceof DateTime ) {
+		if ( ! $DateTime instanceof DateTime) {
 			//if still no datetime object, then let's just use now
-			$DateTime = new DateTime( 'now', $this->get_UTC_DateTimeZone() );
+			$DateTime = new DateTime('now', $this->get_UTC_DateTimeZone());
 		}
 		// THEN apply the field's set DateTimeZone
-		$DateTime->setTimezone( $this->_DateTimeZone );
+		$DateTime->setTimezone($this->_DateTimeZone);
 		return $DateTime;
 	}
 
@@ -535,15 +535,15 @@ 
 	protected function _display_timezone() {
 
 		// first let's do a comparison of timezone strings.  If they match then we can get out without any further calculations
-		$blog_string = get_option( 'timezone_string' );
-		if ( $blog_string == $this->_timezone_string ) {
+		$blog_string = get_option('timezone_string');
+		if ($blog_string == $this->_timezone_string) {
 			return FALSE;
 		}
 		// now we need to calc the offset for the timezone string so we can compare with the blog offset.
-		$this_offset = $this->get_timezone_offset( $this->_DateTimeZone );
-		$blog_offset = $this->get_timezone_offset( $this->get_blog_DateTimeZone() );
+		$this_offset = $this->get_timezone_offset($this->_DateTimeZone);
+		$blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
 		// now compare
-		if ( $blog_offset === $this_offset ) {
+		if ($blog_offset === $this_offset) {
 			return FALSE;
 		}
 		return TRUE;
@@ -561,24 +561,24 @@ 
 	 *
 	 * @return DateTime
 	 */
-	protected function _get_date_object( $date_string ) {
+	protected function _get_date_object($date_string) {
 		//first if this is an empty date_string and nullable is allowed, just return null.
-		if ( $this->_nullable && empty( $date_string ) ) {
+		if ($this->_nullable && empty($date_string)) {
 			return null;
 		}
 
 		// if incoming date
-		if ( $date_string instanceof DateTime ) {
-			$date_string->setTimezone( $this->_DateTimeZone );
+		if ($date_string instanceof DateTime) {
+			$date_string->setTimezone($this->_DateTimeZone);
 			return $date_string;
 		}
 		// if empty date_string and made it here.
 		// Return a datetime object for now in the given timezone.
-		if ( empty( $date_string ) ) {
-			return new DateTime( "now", $this->_DateTimeZone );
+		if (empty($date_string)) {
+			return new DateTime("now", $this->_DateTimeZone);
 		}
 		// if $date_string is matches something that looks like a Unix timestamp let's just use it.
-		if ( preg_match( EE_Datetime_Field::unix_timestamp_regex, $date_string ) ) {
+		if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
 			try {
 				/**
 				 * This is operating under the assumption that the incoming Unix timestamp is
@@ -586,29 +586,29 @@ 
 				 * current_time('timestamp');
 				 *
 				 */
-				$DateTime = new DateTime( "now", $this->_DateTimeZone );
-				return $DateTime->setTimestamp( $date_string );
-			 } catch ( Exception $e )  {
+				$DateTime = new DateTime("now", $this->_DateTimeZone);
+				return $DateTime->setTimestamp($date_string);
+			 } catch (Exception $e) {
 			 	// should be rare, but if things got fooled then let's just continue
 			 }
 		}
 		//not a unix timestamp.  So we will use the set format on this object and set timezone to
 		//create the DateTime object.
-		$format = $this->_date_format . ' ' . $this->_time_format;
+		$format = $this->_date_format.' '.$this->_time_format;
 		try {
-			$DateTime = DateTime::createFromFormat( $format, $date_string, $this->_DateTimeZone );
-			if ( ! $DateTime instanceof DateTime ) {
+			$DateTime = DateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
+			if ( ! $DateTime instanceof DateTime) {
 				throw new EE_Error(
 					sprintf(
-						__( '"%1$s" does not represent a valid Date Time in the format "%2$s".', 'event_espresso' ),
+						__('"%1$s" does not represent a valid Date Time in the format "%2$s".', 'event_espresso'),
 						$date_string,
 						$format
 					)
 				);
 			}
-		} catch ( Exception $e ) {
+		} catch (Exception $e) {
 			// if we made it here then likely then something went really wrong.  Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
-			$DateTime = new DateTime( "now", $this->_DateTimeZone );
+			$DateTime = new DateTime("now", $this->_DateTimeZone);
 		}
 		return $DateTime;
 	}
@@ -622,9 +622,9 @@ 
 	 * @param null          $time
 	 * @return mixed
 	 */
-	public function get_timezone_offset( DateTimeZone $DateTimeZone, $time = null ) {
-		$time = preg_match( EE_Datetime_Field::unix_timestamp_regex, $time ) ? $time : time();
-		$transitions = $DateTimeZone->getTransitions( $time );
+	public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null) {
+		$time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
+		$transitions = $DateTimeZone->getTransitions($time);
 		return $transitions[0]['offset'];
 	}
 
@@ -636,10 +636,10 @@ 
 	 * @param  string $timezone_string
 	 * @return string           abbreviation
 	 */
-	public function get_timezone_abbrev( $timezone_string ) {
-		$timezone_string = EEH_DTT_Helper::get_valid_timezone_string( $timezone_string );
-		$dateTime = new DateTime( 'now', new DateTimeZone( $timezone_string ) );
-		return $dateTime->format( 'T' );
+	public function get_timezone_abbrev($timezone_string) {
+		$timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$dateTime = new DateTime('now', new DateTimeZone($timezone_string));
+		return $dateTime->format('T');
 	}
 
 

core/db_models/fields/EE_Field_With_Model_Name.php

Doc Comments +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
 	/**
 	 * Returns the name of the model(s) pointed to
 	 * @deprecated since version 4.6.7
-	 * @return mixed string or array of strings
+	 * @return string string or array of strings
 	 */
 	function get_model_name_pointed_to(){
 		EE_Error::doing_it_wrong( 'get_model_name_pointed_to', __( 'This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array', 'event_espresso' ), '4.6.7' );

Spacing +14 added lines, -14 removed lines

@@ -5,7 +5,7 @@ 
  * with the EE_Foreign_Key_Field to create a relation between any two models)
  * also required basically the exact same functionality, except NOT be a foreign key.
  */
-abstract class EE_Field_With_Model_Name extends EE_Model_Field_Base{
+abstract class EE_Field_With_Model_Name extends EE_Model_Field_Base {
 	/**
 	 * Usually the name of a single model. However, as in the case for custom post types,
 	 * it can actually be an array of models
@@ -20,7 +20,7 @@ 
 	 * @param mixed $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul dbe a string
 	 * @param string $model_name eg 'Event','Answer','Term', etc. Basically its the model class's name without the "EEM_"
 	 */
-	function __construct($table_column, $nicename, $nullable, $default_value,$model_name){
+	function __construct($table_column, $nicename, $nullable, $default_value, $model_name) {
 		$this->_model_name_pointed_to = $model_name;
 		parent::__construct($table_column, $nicename, $nullable, $default_value);
 	}
@@ -29,8 +29,8 @@ 
 	 * @deprecated since version 4.6.7
 	 * @return mixed string or array of strings
 	 */
-	function get_model_name_pointed_to(){
-		EE_Error::doing_it_wrong( 'get_model_name_pointed_to', __( 'This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array', 'event_espresso' ), '4.6.7' );
+	function get_model_name_pointed_to() {
+		EE_Error::doing_it_wrong('get_model_name_pointed_to', __('This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array', 'event_espresso'), '4.6.7');
 		return $this->_model_name_pointed_to;
 	}
 	/**
@@ -39,31 +39,31 @@ 
 	 * @return array of model names pointed to by this field
 	 */
 	function get_model_names_pointed_to() {
-		if( is_array( $this->_model_name_pointed_to ) ) {
+		if (is_array($this->_model_name_pointed_to)) {
 			return $this->_model_name_pointed_to;
-		}else{
-			return array( $this->_model_name_pointed_to );
+		} else {
+			return array($this->_model_name_pointed_to);
 		}
 	}
 	/**
 	 * Returns the model's classname (eg EE_Event instead of just Event)
 	 * @return array
 	 */
-	function get_model_class_names_pointed_to(){
+	function get_model_class_names_pointed_to() {
 		$model_names = array();
-		if(is_array($this->_model_name_pointed_to)){
-			foreach($this->_model_name_pointed_to as $model_name){
+		if (is_array($this->_model_name_pointed_to)) {
+			foreach ($this->_model_name_pointed_to as $model_name) {
 				$model_names[] = "EE_".$model_name;
 			}
-		}else{
+		} else {
 			$model_names = array("EE_".$this->_model_name_pointed_to);
 		}
 		return $model_names;
 	}
 
-	function is_model_obj_of_type_pointed_to($model_obj_or_ID){
-		foreach($this->get_model_class_names_pointed_to() as $model_obj_classname){
-			if($model_obj_or_ID instanceof $model_obj_classname){
+	function is_model_obj_of_type_pointed_to($model_obj_or_ID) {
+		foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
+			if ($model_obj_or_ID instanceof $model_obj_classname) {
 				return true;
 			}
 		}

Braces +2 added lines, -2 removed lines

@@ -42,7 +42,7 @@ 
 				$validation_error_message = $default_validation_strategy->get_validation_error_message();
 			}
 			throw new EE_Validation_Error( $validation_error_message, 'float_only' );
-		}else{
+		} else{
 			return floatval($normalized_value);
 		}
 	}
@@ -55,7 +55,7 @@ 
 	public function unnormalize($normalized_value) {
 		if( empty( $normalized_value ) ){
 			return '0.00';
-		}else{
+		} else{
 			return "$normalized_value";
 		}
 	}

core/db_models/fields/EE_Model_Field_Base.php

Doc Comments +3 added lines, -3 removed lines

@@ -29,9 +29,9 @@ 
 	protected $_model_name;
 
 	/**
-	 * @param      $table_column
+	 * @param      string $table_column
 	 * @param      $nicename
-	 * @param      $nullable
+	 * @param      boolean $nullable
 	 * @param null $default_value
 	 */
 	function __construct($table_column, $nicename, $nullable, $default_value = null){
@@ -117,7 +117,7 @@ 
 	 * the field's type. Eg, we may want ot serialize it, strip tags, etc. By default,
 	 * we simply return it.
 	 * @param mixed $value_of_field_on_model_object
-	 * @return mixed
+	 * @return double
 	 */
 	function prepare_for_get($value_of_field_on_model_object){
 		return $value_of_field_on_model_object;

Indentation +16 added lines, -16 removed lines

@@ -2,22 +2,22 @@
 	exit( 'No direct script access allowed' );
 }
 /**
- *
- * EE_Model_Field_Base class
- *
- * Base class for all EE_*_Field classes. These classes are for providing information and functions specific to each
- * field. They define the field's data type for insertion into the db (eg, if the value should be treated as an int, float, or string),
- * what values for the field are acceptable (eg, if setting EVT_ID to a float is acceptable), and generally any functionality within
- * EEM_Base or EE_Base_Class which depend on the field's type. (ie, you shouldn't need any logic within your model
- * or model object which are dependent on the field's type, ideally). For example, EE_Serialized_Text_Field, specifies that any fields of this type
- * should be serialized before insertion into the db (prepare_for_insertion_into_db()),
- * should be considered a string when inserting, updating, or using in a where clause for any queries (get_wpdb_data_type()),
- * should be unserialized when being retrieved from the db (prepare_for_set_from_db()), and whatever else.
- *
- * @package 			Event Espresso
- * @subpackage    /core/db_models/fields/EE_Model_Field_Base.php
- * @author 				Michael Nelson
- */
+	 *
+	 * EE_Model_Field_Base class
+	 *
+	 * Base class for all EE_*_Field classes. These classes are for providing information and functions specific to each
+	 * field. They define the field's data type for insertion into the db (eg, if the value should be treated as an int, float, or string),
+	 * what values for the field are acceptable (eg, if setting EVT_ID to a float is acceptable), and generally any functionality within
+	 * EEM_Base or EE_Base_Class which depend on the field's type. (ie, you shouldn't need any logic within your model
+	 * or model object which are dependent on the field's type, ideally). For example, EE_Serialized_Text_Field, specifies that any fields of this type
+	 * should be serialized before insertion into the db (prepare_for_insertion_into_db()),
+	 * should be considered a string when inserting, updating, or using in a where clause for any queries (get_wpdb_data_type()),
+	 * should be unserialized when being retrieved from the db (prepare_for_set_from_db()), and whatever else.
+	 *
+	 * @package 			Event Espresso
+	 * @subpackage    /core/db_models/fields/EE_Model_Field_Base.php
+	 * @author 				Michael Nelson
+	 */
 abstract class EE_Model_Field_Base{
 	var $_table_alias;
 	var $_table_column;

Spacing +23 added lines, -23 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');
 }
 /**
  *
@@ -18,7 +18,7 @@ 
  * @subpackage    /core/db_models/fields/EE_Model_Field_Base.php
  * @author 				Michael Nelson
  */
-abstract class EE_Model_Field_Base{
+abstract class EE_Model_Field_Base {
 	var $_table_alias;
 	var $_table_column;
 	var $_name;
@@ -34,7 +34,7 @@ 
 	 * @param      $nullable
 	 * @param null $default_value
 	 */
-	function __construct($table_column, $nicename, $nullable, $default_value = null){
+	function __construct($table_column, $nicename, $nullable, $default_value = null) {
 		$this->_table_column = $table_column;
 		$this->_nicename = $nicename;
 		$this->_nullable = $nullable;
@@ -48,22 +48,22 @@ 
 	 * @param $name
 	 * @param $model_name
 	 */
-	function _construct_finalize($table_alias, $name, $model_name){
+	function _construct_finalize($table_alias, $name, $model_name) {
 		$this->_table_alias = $table_alias;
 		$this->_name = $name;
 		$this->_model_name = $model_name;
 	}
-	function get_table_alias(){
+	function get_table_alias() {
 		return $this->_table_alias;
 	}
-	function get_table_column(){
+	function get_table_column() {
 		return $this->_table_column;
 	}
 	/**
 	 * Returns the name of the model this field is on. Eg 'Event' or 'Ticket_Datetime'
 	 * @return string
 	 */
-	function get_model_name(){
+	function get_model_name() {
 		return $this->_model_name;
 	}
 
@@ -71,17 +71,17 @@ 
 	 * @throws \EE_Error
 	 * @return string
 	 */
-	function get_name(){
-		if($this->_name){
+	function get_name() {
+		if ($this->_name) {
 			return $this->_name;
-		}else{
-			throw new EE_Error(sprintf(__("Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?", "event_espresso"),get_class($this)));
+		} else {
+			throw new EE_Error(sprintf(__("Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?", "event_espresso"), get_class($this)));
 		}
 	}
-	function get_nicename(){
+	function get_nicename() {
 		return $this->_nicename;
 	}
-	function is_nullable(){
+	function is_nullable() {
 		return $this->_nullable;
 	}
 	/**
@@ -89,7 +89,7 @@ 
 	 * on insertion it can be null. However, on updates it must be present.
 	 * @return boolean
 	 */
-	function is_auto_increment(){
+	function is_auto_increment() {
 		return false;
 	}
 	/**
@@ -97,7 +97,7 @@ 
 	 * value domains at the top of EEM_Base
 	 * @return mixed
 	 */
-	function get_default_value(){
+	function get_default_value() {
 		return $this->_default_value;
 	}
 
@@ -108,7 +108,7 @@ 
 	 * in the current query
 	 * @return string
 	 */
-	function get_qualified_column(){
+	function get_qualified_column() {
 		return $this->get_table_alias().".".$this->get_table_column();
 	}
 	/**
@@ -119,7 +119,7 @@ 
 	 * @param mixed $value_of_field_on_model_object
 	 * @return mixed
 	 */
-	function prepare_for_get($value_of_field_on_model_object){
+	function prepare_for_get($value_of_field_on_model_object) {
 		return $value_of_field_on_model_object;
 	}
 	/**
@@ -129,7 +129,7 @@ 
 	 * @param mixed $value_of_field_on_model_object
 	 * @return mixed
 	 */
-	function prepare_for_use_in_db($value_of_field_on_model_object){
+	function prepare_for_use_in_db($value_of_field_on_model_object) {
 		return $value_of_field_on_model_object;
 	}
 
@@ -140,7 +140,7 @@ 
 	 * @param mixed $value_inputted_for_field_on_model_object
 	 * @return mixed
 	 */
-	function prepare_for_set($value_inputted_for_field_on_model_object){
+	function prepare_for_set($value_inputted_for_field_on_model_object) {
 		return $value_inputted_for_field_on_model_object;
 	}
 
@@ -151,7 +151,7 @@ 
 	 * @param mixed $value_found_in_db_for_model_object
 	 * @return mixed
 	 */
-	function prepare_for_set_from_db($value_found_in_db_for_model_object){
+	function prepare_for_set_from_db($value_found_in_db_for_model_object) {
 		return $this->prepare_for_set($value_found_in_db_for_model_object);
 	}
 
@@ -162,7 +162,7 @@ 
 	 * @param mixed $value_on_field_to_be_outputted
 	 * @return mixed
 	 */
-	function prepare_for_pretty_echoing( $value_on_field_to_be_outputted ){
+	function prepare_for_pretty_echoing($value_on_field_to_be_outputted) {
 		return $value_on_field_to_be_outputted;
 	}
 
@@ -177,7 +177,7 @@ 
 	 * By default, all fields aren't db-only.
 	 * @return boolean
 	 */
-	function is_db_only_field(){
+	function is_db_only_field() {
 		return false;
 	}
 }
\ No newline at end of file

Braces +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
 		//so in case teh IPN is arriving later, let's try to process an IPN!
 		if($_SERVER['REQUEST_METHOD'] == 'POST'){
 			return $this->handle_ipn($_POST, $transaction );
-		}else{
+		} else{
 			return parent::finalize_payment_for( $transaction );
 		}
 	}

core/db_models/fields/EE_Primary_Key_Field_Base.php

Doc Comments +1 added lines

@@ -4,6 +4,7 @@
 	 * Overrides parent so it doesn't need to provide so many non-applicable fields
 	 * @param string $table_column
 	 * @param string $nicename
+	 * @param integer|null $default
 	 */
 	public function __construct($table_column, $nicename,$default) {
 		parent::__construct($table_column, $nicename, false, $default, null);

Spacing +3 added lines, -3 removed lines

@@ -1,18 +1,18 @@
 <?php
-abstract class EE_Primary_Key_Field_Base extends EE_Field_With_Model_Name{
+abstract class EE_Primary_Key_Field_Base extends EE_Field_With_Model_Name {
 	/**
 	 * Overrides parent so it doesn't need to provide so many non-applicable fields
 	 * @param string $table_column
 	 * @param string $nicename
 	 */
-	public function __construct($table_column, $nicename,$default) {
+	public function __construct($table_column, $nicename, $default) {
 		parent::__construct($table_column, $nicename, false, $default, null);
 	}
 	/**
 	 * @param $table_alias
 	 * @param $name
 	 */
-	function _construct_finalize($table_alias, $name, $model_name){
+	function _construct_finalize($table_alias, $name, $model_name) {
 		$this->_model_name_pointed_to = $model_name;
 		parent::_construct_finalize($table_alias, $name, $model_name);
 	}

core/db_models/fields/EE_Primary_Key_String_Field.php

Doc Comments +4 added lines

@@ -4,6 +4,10 @@
 	function get_wpdb_data_type(){
 		return '%s';
 	}
+
+	/**
+	 * @param string $table_column
+	 */
 	public function __construct($table_column, $nicename) {
 		parent::__construct($table_column, $nicename, NULL);
 	}

Spacing +3 added lines, -3 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 require_once('EE_Primary_Key_Field_Base.php');
-class EE_Primary_Key_String_Field extends EE_Primary_Key_Field_Base{
-	function get_wpdb_data_type(){
+class EE_Primary_Key_String_Field extends EE_Primary_Key_Field_Base {
+	function get_wpdb_data_type() {
 		return '%s';
 	}
 	public function __construct($table_column, $nicename) {
@@ -13,7 +13,7 @@ 
 	 * @return string
 	 */
 	function prepare_for_set($value_inputted_for_field_on_model_object) {
-	if($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)){
+	if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
 			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
 		}
 		return wp_strip_all_tags($value_inputted_for_field_on_model_object);

core/db_models/fields/EE_WP_Post_Status_Field.php

Doc Comments -1 removed lines

@@ -26,7 +26,6 @@
 	 *   )
 	 * )
 	 * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
-	 * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is set to true, it will be stored as an INT
 	 */
 	function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array()){
 		$this->_register_new_stati( $new_stati );

Spacing +16 added lines, -16 removed lines

@@ -1,6 +1,6 @@ 
 <?php
-require_once( EE_MODELS . 'fields/EE_Enum_Text_Field.php' );
-class EE_WP_Post_Status_Field extends EE_Enum_Text_Field{
+require_once(EE_MODELS.'fields/EE_Enum_Text_Field.php');
+class EE_WP_Post_Status_Field extends EE_Enum_Text_Field {
 
 	protected $_wp_post_stati;
 
@@ -28,8 +28,8 @@ 
 	 * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
 	 * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is set to true, it will be stored as an INT
 	 */
-	function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array()){
-		$this->_register_new_stati( $new_stati );
+	function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array()) {
+		$this->_register_new_stati($new_stati);
 		$this->_set_allowed_enum_values();
 		parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values);
 	}
@@ -46,18 +46,18 @@ 
 	 * @param  array $new_stati statuses
 	 * @return void
 	 */
-	protected function _register_new_stati( $new_stati ) {
+	protected function _register_new_stati($new_stati) {
 
-		foreach ( (array) $new_stati as $status_key => $status_args ) {
+		foreach ((array) $new_stati as $status_key => $status_args) {
 			$args = array(
-				'label' => isset( $status_args['label'] ) ? $status_args['label'] : $status_key,
-				'public' => isset( $status_args['public'] ) && is_bool( $status_args['public'] ) ? $status_args['public'] : TRUE,
-				'exclude_from_search' => isset( $status_args['exclude_from_search'] ) && is_bool($status_args['exclude_from_search'] ) ? $status_args['exclude_from_search'] : FALSE,
-				'show_in_admin_all_list' => isset( $status_args['show_in_admin_all_list'] ) && is_bool( $status_args['show_in_admin_all_list'] ) ? $status_args['show_in_admin_all_list'] : FALSE,
-				'show_in_admin_status_list' =>  isset( $status_args['show_in_admin_status_list'] ) && is_bool( $status_args['show_in_admin_status_list'] ) ? $status_args['show_in_admin_status_list'] : TRUE,
-				'label_count' => isset( $status_args['label_count'] ) ? $status_args['label_count'] : ''
+				'label' => isset($status_args['label']) ? $status_args['label'] : $status_key,
+				'public' => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : TRUE,
+				'exclude_from_search' => isset($status_args['exclude_from_search']) && is_bool($status_args['exclude_from_search']) ? $status_args['exclude_from_search'] : FALSE,
+				'show_in_admin_all_list' => isset($status_args['show_in_admin_all_list']) && is_bool($status_args['show_in_admin_all_list']) ? $status_args['show_in_admin_all_list'] : FALSE,
+				'show_in_admin_status_list' =>  isset($status_args['show_in_admin_status_list']) && is_bool($status_args['show_in_admin_status_list']) ? $status_args['show_in_admin_status_list'] : TRUE,
+				'label_count' => isset($status_args['label_count']) ? $status_args['label_count'] : ''
 				);
-			register_post_status( $status_key, $status_args );
+			register_post_status($status_key, $status_args);
 		}
 
 	}
@@ -78,7 +78,7 @@ 
 		global $wp_post_statuses;
 		$this->_wp_post_stati = $wp_post_statuses;
 
-		foreach( $this->_wp_post_stati  as $post_status => $args_object ) {
+		foreach ($this->_wp_post_stati  as $post_status => $args_object) {
 			$this->_allowed_enum_values[$post_status] = $args_object->label;
 		}
 
@@ -108,7 +108,7 @@ 
 	 * @param  string $status What status object you want
 	 * @return std_object         the status object or FALSE if it doesn't exist.
 	 */
-	public function get_status_object( $status ) {
-		return isset( $this->_wp_post_stati[$status] ) ? $this->_wp_post_stati[$status] : FALSE;
+	public function get_status_object($status) {
+		return isset($this->_wp_post_stati[$status]) ? $this->_wp_post_stati[$status] : FALSE;
 	}
 }
\ No newline at end of file

core/db_models/helpers/EE_Model_Query_Info_Carrier.php

Doc Comments +14 added lines, -1 removed lines

@@ -43,16 +43,30 @@ 
    
    private $_group_by_sql;
    
+   /**
+    * @param string $limit_sql
+    */
    function set_limit_sql($limit_sql){
 	   $this->_limit_sql = $limit_sql;
 	}
 	
+	/**
+	 * @param string $order_by_sql
+	 */
 	function set_order_by_sql($order_by_sql){
 		$this->_order_by_sql = $order_by_sql;
 	}
+
+	/**
+	 * @param string $group_by_sql
+	 */
 	function set_group_by_sql($group_by_sql){
 		$this->_group_by_sql = $group_by_sql;
 	}
+
+	/**
+	 * @param string $having_sql
+	 */
 	function set_having_sql($having_sql){
 		$this->_having_sql = $having_sql;
 	}
@@ -72,7 +86,6 @@ 
     * 
     * @param type $model_included_name
     * @param type $join_sql
-    * @param type $data_types
     */
    public function __construct($model_included_name= array(), $join_sql = ''){
 	   $this->_models_included = $model_included_name;

Indentation +3 added lines, -3 removed lines

@@ -11,8 +11,8 @@ 
 */
 class EE_Model_Query_Info_Carrier extends EE_Base{
    /**
-	* @var string SQL for performing joins (Eg, "INNER JOIN blah ON blah=blah INNER JOIN FOO ON foo=foo...")
-	*/
+    * @var string SQL for performing joins (Eg, "INNER JOIN blah ON blah=blah INNER JOIN FOO ON foo=foo...")
+    */
    private $_join_sql;
    /**
     *
@@ -132,7 +132,7 @@ 
     * @return string
     */
   public function get_main_model_join_sql() {
-    return $this->_main_join_sql;
+	return $this->_main_join_sql;
   }
 
 

Spacing +23 added lines, -23 removed lines

@@ -9,7 +9,7 @@ 
 * We could have returned an array
 * with two keys 'join_sql' and 'data_types', but this better-defines the data being passed around
 */
-class EE_Model_Query_Info_Carrier extends EE_Base{
+class EE_Model_Query_Info_Carrier extends EE_Base {
    /**
 	* @var string SQL for performing joins (Eg, "INNER JOIN blah ON blah=blah INNER JOIN FOO ON foo=foo...")
 	*/
@@ -43,29 +43,29 @@ 
    
    private $_group_by_sql;
    
-   function set_limit_sql($limit_sql){
+   function set_limit_sql($limit_sql) {
 	   $this->_limit_sql = $limit_sql;
 	}
 	
-	function set_order_by_sql($order_by_sql){
+	function set_order_by_sql($order_by_sql) {
 		$this->_order_by_sql = $order_by_sql;
 	}
-	function set_group_by_sql($group_by_sql){
+	function set_group_by_sql($group_by_sql) {
 		$this->_group_by_sql = $group_by_sql;
 	}
-	function set_having_sql($having_sql){
+	function set_having_sql($having_sql) {
 		$this->_having_sql = $having_sql;
 	}
-	function get_limit_sql(){
+	function get_limit_sql() {
 		return $this->_limit_sql;
 	}
-	function get_order_by_sql(){
+	function get_order_by_sql() {
 		return $this->_order_by_sql;
 	}
-	function get_group_by_sql(){
+	function get_group_by_sql() {
 		return $this->_group_by_sql;
 	}
-	function get_having_sql(){
+	function get_having_sql() {
 		return $this->_having_sql;
 	}
    /**
@@ -74,7 +74,7 @@ 
     * @param type $join_sql
     * @param type $data_types
     */
-   public function __construct($model_included_name= array(), $join_sql = ''){
+   public function __construct($model_included_name = array(), $join_sql = '') {
 	   $this->_models_included = $model_included_name;
 	   $this->_join_sql = $join_sql;
    }
@@ -83,10 +83,10 @@ 
     * Merges info from the other EEM_Related_Model_Info_Carrier into this one.
     * @param EE_Model_Query_Info_Carrier $other_model_query_info_carrier
     */
-   public function merge( $other_model_query_info_carrier ){
-	   if( $other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())){
-			$model_included_on_other_join_sql_and_data_types_carrier =  $other_model_query_info_carrier->get_model_names_included();
-			$this->_models_included = array_merge( $this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier );
+   public function merge($other_model_query_info_carrier) {
+	   if ($other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())) {
+			$model_included_on_other_join_sql_and_data_types_carrier = $other_model_query_info_carrier->get_model_names_included();
+			$this->_models_included = array_merge($this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier);
 			$this->_join_sql .= $other_model_query_info_carrier->_join_sql;
 	   }
 	   //otherwise don't merge our data.
@@ -100,9 +100,9 @@ 
     * @param array $model_names just like EE_MOdel_QUery_Info_Carrier::_models_included: keys are model chain paths, values are the model names only
     * @return boolean
     */
-   protected function  _have_already_included_one_of_these_models($model_names){
-	   foreach($this->_models_included as $model_relation_path=>$model_included){
-		   if(array_key_exists($model_relation_path, $model_names)){
+   protected function  _have_already_included_one_of_these_models($model_names) {
+	   foreach ($this->_models_included as $model_relation_path=>$model_included) {
+		   if (array_key_exists($model_relation_path, $model_names)) {
 			   return true;
 		   }
 	   }
@@ -112,17 +112,17 @@ 
     * Array keys are model names, values are "model relation paths". See EE_Model_Query_Info_Carrier::_models_included for details
     * @return array like EE_Model_Query_Info_Carrier::_models_included
     */
-   public function get_model_names_included(){
+   public function get_model_names_included() {
 	   return $this->_models_included;
    }
    /**
     * sets the $where_sql for later use from client code
     * @param string $where_sql
     */
-   public function set_where_sql($where_sql){
+   public function set_where_sql($where_sql) {
 	   $this->_where_sql = $where_sql;
    }
-   public function get_where_sql(){
+   public function get_where_sql() {
 	   return $this->_where_sql;
    }
 
@@ -143,10 +143,10 @@ 
     * after the FROM and before the WHERE.)
     * @param string $join_sql
     */
-   public function set_main_model_join_sql($join_sql){
+   public function set_main_model_join_sql($join_sql) {
 	   $this->_main_join_sql = $join_sql;
    }
-   public function get_full_join_sql(){
-	   return $this->_main_join_sql . $this->_join_sql;
+   public function get_full_join_sql() {
+	   return $this->_main_join_sql.$this->_join_sql;
    }
 }
\ No newline at end of file

core/db_models/helpers/EE_Secondary_Table.php

Doc Comments +2 added lines, -1 removed lines

@@ -49,7 +49,7 @@ 
 	 * creates join statement FROM primary table
 	 * gets SQL like "LEFT JOIN table_name AS table_alias ON other_table_alias.pk = table_alias.fk
 	 *
-	 * @param string $table allows us to set special conditions on the $table_name portion of the join query (i.e. doing a subquery)
+	 * @param string $primary_table_alias_with_model_chain_prefix
 	 * @return string of SQL
 	 */
 	function get_join_sql( $primary_table_alias_with_model_chain_prefix  ){
@@ -72,6 +72,7 @@ 
 	 * " LEFT JOIN secondary_table_table AS Secondary ON ..." like get_join_sql, this function returns
 	 * " LEFT JOIN primary_table AS Primary ON ...".
 	 * This is useful if the secondary table is already included in the SQL, but the primary table is not yet.
+	 * @param string $secondary_table_alias_with_model_chain_prefix
 	 * @return string
 	 */
 	function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix){

Spacing +21 added lines, -21 removed lines

@@ -5,8 +5,8 @@ 
  * table's rows. Ie, it can't have many rows in the secondary table that point to
  * a single row in the primary table
  */
-require_once( EE_MODELS . 'helpers/EE_Table_Base.php');
-class EE_Secondary_Table extends EE_Table_Base{
+require_once(EE_MODELS.'helpers/EE_Table_Base.php');
+class EE_Secondary_Table extends EE_Table_Base {
 	protected $_extra_join_conditions;
 
 	/**
@@ -19,15 +19,15 @@ 
 	 * @param boolean $global whether the table is "global" as in there is only 1 table on an entire multisite install,
 	 *					or whether each site on a multisite install has a copy of this table
 	 */
-	function __construct($table_name, $pk_column,  $fk_column = null, $extra_join_conditions = null, $global = false ){
+	function __construct($table_name, $pk_column, $fk_column = null, $extra_join_conditions = null, $global = false) {
 		$this->_fk_on_table = $fk_column;
 		$this->_extra_join_conditions = $extra_join_conditions;
-		parent::__construct( $table_name, $pk_column, $global );
+		parent::__construct($table_name, $pk_column, $global);
 	}
-	function get_fk_on_table(){
+	function get_fk_on_table() {
 		return $this->_fk_on_table;
 	}
-	function _construct_finalize_set_table_to_join_with(EE_Table_Base $table){
+	function _construct_finalize_set_table_to_join_with(EE_Table_Base $table) {
 		$this->_table_to_join_with = $table;
 	}
 	/**
@@ -35,14 +35,14 @@ 
 	 * @return string of sql like "Event.post_type = 'event'", which gets added to
 	 * the end of the join statement with the primary table
 	 */
-	function get_extra_join_conditions(){
+	function get_extra_join_conditions() {
 		return $this->_extra_join_conditions;
 	}
 	/**
 	 *
 	 * @return EE_Primary_Table
 	 */
-	function get_table_to_join_with(){
+	function get_table_to_join_with() {
 		return $this->_table_to_join_with;
 	}
 	/**
@@ -52,15 +52,15 @@ 
 	 * @param string $table allows us to set special conditions on the $table_name portion of the join query (i.e. doing a subquery)
 	 * @return string of SQL
 	 */
-	function get_join_sql( $primary_table_alias_with_model_chain_prefix  ){
+	function get_join_sql($primary_table_alias_with_model_chain_prefix) {
 
 		$table_name = $this->get_table_name();
-		$secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix) . $this->get_table_alias();
+		$secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix).$this->get_table_alias();
 		$other_table_pk = $this->get_table_to_join_with()->get_pk_column();
 		$fk = $this->get_fk_on_table();
 		$join_sql = " LEFT JOIN $table_name AS $secondary_table_alias ON $primary_table_alias_with_model_chain_prefix.$other_table_pk = $secondary_table_alias.$fk ";
-		if($this->get_extra_join_conditions()){
-			$join_sql.="AND ".$this->get_extra_join_conditions();
+		if ($this->get_extra_join_conditions()) {
+			$join_sql .= "AND ".$this->get_extra_join_conditions();
 		}
 		return $join_sql;
 	}
@@ -74,14 +74,14 @@ 
 	 * This is useful if the secondary table is already included in the SQL, but the primary table is not yet.
 	 * @return string
 	 */
-	function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix){
-		$primary_table_name =$this->get_table_to_join_with()->get_table_name();
-		$primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix) . $this->get_table_to_join_with()->get_table_alias();
-		$primary_table_pk = $this->get_table_to_join_with()->get_pk_column();//$this->get_pk_column();
+	function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix) {
+		$primary_table_name = $this->get_table_to_join_with()->get_table_name();
+		$primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix).$this->get_table_to_join_with()->get_table_alias();
+		$primary_table_pk = $this->get_table_to_join_with()->get_pk_column(); //$this->get_pk_column();
 		$fk = $this->get_fk_on_table();
 		$join_sql = " LEFT JOIN $primary_table_name AS $primary_table_alias ON $primary_table_alias.$primary_table_pk = $secondary_table_alias_with_model_chain_prefix.$fk ";
-		if($this->get_extra_join_conditions()){
-			$join_sql.="AND ".$this->get_extra_join_conditions();
+		if ($this->get_extra_join_conditions()) {
+			$join_sql .= "AND ".$this->get_extra_join_conditions();
 		}
 		return $join_sql;
 	}
@@ -94,7 +94,7 @@ 
 	public function get_select_join_limit_join($limit) {
 		//first get the select
 		$select = $this->get_select_join_limit($limit);
-		$join_sql = $this->get_join_sql( $select );
+		$join_sql = $this->get_join_sql($select);
 		return $join_sql;
 	}
 
@@ -103,12 +103,12 @@ 
 	function get_fully_qualified_fk_column() {
 		$table_alias = $this->get_table_alias();
 		$fk = $this->get_fk_on_table();
-		return $table_alias . '.' . $fk;
+		return $table_alias.'.'.$fk;
 	}
 
 	function get_fully_qualified_pk_on_fk_table() {
 		$table_alias = $this->get_table_to_join_with()->get_table_alias();
 		$pk = $this->get_table_to_join_with()->get_pk_column();
-		return $table_alias . '.' . $pk;
+		return $table_alias.'.'.$pk;
 	}
 }
\ No newline at end of file

core/db_models/relations/EE_HABTM_Relation.php

Doc Comments +2 added lines, -1 removed lines

@@ -17,6 +17,7 @@ 
 	 * get related models across the relation, and add-and-remove the relationships.
 	 * @param boolean $block_deletes for this type of relation, we block by default for now. if there are related models across this relation, block (prevent and add an error) the deletion of this model
 	 * @param type $blocking_delete_error_message a customized error message on blocking deletes instead of the default
+	 * @param string $joining_model_name
 	 */
 	function __construct($joining_model_name,$block_deletes = true, $blocking_delete_error_message =''){
 		$this->_joining_model_name = $joining_model_name;
@@ -24,7 +25,7 @@ 
 	}
 	/**
 	 * Gets the joining model's object
-	 * @return EEM_Base
+	 * @return boolean
 	 */
 	function get_join_model(){
 		return $this->_get_model($this->_joining_model_name);

Spacing +30 added lines, -30 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
-require_once( EE_MODELS . 'relations/EE_Model_Relation_Base.php');
-class EE_HABTM_Relation extends EE_Model_Relation_Base{
+require_once(EE_MODELS.'relations/EE_Model_Relation_Base.php');
+class EE_HABTM_Relation extends EE_Model_Relation_Base {
 	/**
 	 * Model whicih defines the relation between two other models. Eg, the EE_Event_Question_Group model,
 	 * which joins EE_Event and EE_Question_Group
@@ -18,7 +18,7 @@ 
 	 * @param boolean $block_deletes for this type of relation, we block by default for now. if there are related models across this relation, block (prevent and add an error) the deletion of this model
 	 * @param type $blocking_delete_error_message a customized error message on blocking deletes instead of the default
 	 */
-	function __construct($joining_model_name,$block_deletes = true, $blocking_delete_error_message =''){
+	function __construct($joining_model_name, $block_deletes = true, $blocking_delete_error_message = '') {
 		$this->_joining_model_name = $joining_model_name;
 		parent::__construct($block_deletes, $blocking_delete_error_message);
 	}
@@ -26,7 +26,7 @@ 
 	 * Gets the joining model's object
 	 * @return EEM_Base
 	 */
-	function get_join_model(){
+	function get_join_model() {
 		return $this->_get_model($this->_joining_model_name);
 	}
 	/**
@@ -34,21 +34,21 @@ 
 	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
 	 * @return string of SQL
 	 */
-	function get_join_to_intermediate_model_statement($model_relation_chain){
+	function get_join_to_intermediate_model_statement($model_relation_chain) {
 		//create sql like
 		//LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
 		//LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
 		//remember the model relation chain to the JOIN model, because we'll
 		//need it for get_join_statement()
 		$this->_model_relation_chain_to_join_model = $model_relation_chain;
-		$this_table_pk_field = $this->get_this_model()->get_primary_key_field();//get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		$this_table_pk_field = $this->get_this_model()->get_primary_key_field(); //get_foreign_key_to($this->get_other_model()->get_this_model_name());
 		$join_table_fk_field_to_this_table = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-		$this_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();
+		$this_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();
 
-		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias();
+		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_join_model()->get_this_model_name()).$join_table_fk_field_to_this_table->get_table_alias();
 		$join_table = $this->get_join_model()->get_table_for_alias($join_table_alias);
 		//phew! ok, we have all the info we need, now we can create the SQL join string
-		$SQL = $this->_left_join($join_table, $join_table_alias, $join_table_fk_field_to_this_table->get_table_column(), $this_table_alias, $this_table_pk_field->get_table_column()) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
+		$SQL = $this->_left_join($join_table, $join_table_alias, $join_table_fk_field_to_this_table->get_table_column(), $this_table_alias, $this_table_pk_field->get_table_column()).$this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
 
 		return $SQL;
 	}
@@ -60,18 +60,18 @@ 
 	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
 	 * @return string of SQL
 	 */
-	function get_join_statement($model_relation_chain){
-		if( $this->_model_relation_chain_to_join_model === NULL ){
-			throw new EE_Error( sprintf( __( 'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement', 'event_espresso' )));
+	function get_join_statement($model_relation_chain) {
+		if ($this->_model_relation_chain_to_join_model === NULL) {
+			throw new EE_Error(sprintf(__('When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement', 'event_espresso')));
 		}
 		$join_table_fk_field_to_this_table = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($this->_model_relation_chain_to_join_model, $this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias();
+		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($this->_model_relation_chain_to_join_model, $this->get_join_model()->get_this_model_name()).$join_table_fk_field_to_this_table->get_table_alias();
 		$other_table_pk_field = $this->get_other_model()->get_primary_key_field();
 		$join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-		$other_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_pk_field->get_table_alias();
+		$other_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_pk_field->get_table_alias();
 		$other_table = $this->get_other_model()->get_table_for_alias($other_table_alias);
 
-		$SQL = $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(), $join_table_alias, $join_table_fk_field_to_other_table->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+		$SQL = $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(), $join_table_alias, $join_table_fk_field_to_other_table->get_table_column()).$this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
 		return $SQL;
 	}
 
@@ -84,36 +84,36 @@ 
 	 * @param array             $extra_join_model_fields_n_values col=>val pairs that are used as extra conditions for checking existing values and for setting new rows if no exact matches.
 	 * @return EE_Base_Class
 	 */
-	 function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array() ){
+	 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);
 		//check if such a relationship already exists
 		 $join_model_fk_to_this_model = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
 		 $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
 
-		 $cols_n_values =  array(
+		 $cols_n_values = array(
 				 $join_model_fk_to_this_model->get_name() => $this_model_obj->ID(),
 				 $join_model_fk_to_other_model->get_name() => $other_model_obj->ID());
 
 		 //if $where_query exists lets add them to the query_params.
-		 if ( !empty( $extra_join_model_fields_n_values ) ) {
+		 if ( ! empty($extra_join_model_fields_n_values)) {
 		 	//make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
 		 	//make sure we strip THIS models name from the query param
-		 	foreach ( $extra_join_model_fields_n_values as $query_param => $val ) {
-				$query_param = str_replace($this->get_join_model()->get_this_model_name().".","", $query_param);
+		 	foreach ($extra_join_model_fields_n_values as $query_param => $val) {
+				$query_param = str_replace($this->get_join_model()->get_this_model_name().".", "", $query_param);
 				$parsed_query[$query_param] = $val;
 			}
-		 	$cols_n_values = array_merge( $cols_n_values, $parsed_query );
+		 	$cols_n_values = array_merge($cols_n_values, $parsed_query);
 		 }
 
-		 $query_params = array( $cols_n_values );
+		 $query_params = array($cols_n_values);
 
 
 		 $existing_entry_in_join_table = $this->get_join_model()->get_one($query_params);
 		//if there is already an entry in the join table, indicating a relationship, we're done
 		 //again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
 		 //the other tables, use the joining model directly!
-		 if( ! $existing_entry_in_join_table ){
+		 if ( ! $existing_entry_in_join_table) {
 			$this->get_join_model()->insert($cols_n_values);
 		}
 		return $other_model_obj;
@@ -125,29 +125,29 @@ 
 	 * * @param array           $where_query col=>val pairs that are used as extra conditions for checking existing values and for removing existing rows if exact matches exist.
 	 * @return EE_Base_Class
 	 */
-	 function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array() ){
+	 function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = 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);
 		//check if such a relationship already exists
 		 $join_model_fk_to_this_model = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
 		 $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
 
-		 $cols_n_values =  array(
+		 $cols_n_values = array(
 				 $join_model_fk_to_this_model->get_name() => $this_model_obj->ID(),
 				 $join_model_fk_to_other_model->get_name() => $other_model_obj->ID());
 
 		//if $where_query exists lets add them to the query_params.
-		 if ( !empty( $where_query ) ) {
+		 if ( ! empty($where_query)) {
 		 	//make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
 		 	//make sure we strip THIS models name from the query param
-		 	foreach ( $where_query as $query_param => $val ) {
-				$query_param = str_replace($this->get_join_model()->get_this_model_name().".","", $query_param);
+		 	foreach ($where_query as $query_param => $val) {
+				$query_param = str_replace($this->get_join_model()->get_this_model_name().".", "", $query_param);
 				$parsed_query[$query_param] = $val;
 			}
-		 	$cols_n_values = array_merge( $cols_n_values, $parsed_query );
+		 	$cols_n_values = array_merge($cols_n_values, $parsed_query);
 		 }
 
-		 $existing_entry_in_join_table = $this->get_join_model()->delete( array($cols_n_values) );
+		 $existing_entry_in_join_table = $this->get_join_model()->delete(array($cols_n_values));
 		return $other_model_obj;
 	 }
 }