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()

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,15 +111,15 @@ 
 	 * @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 );
-		$this->set_timezone( $timezone_string );
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
+		$this->set_timezone($timezone_string);
 
 	}
 
@@ -138,7 +138,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');
 	}
 
 
@@ -147,7 +147,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('');
 	}
 
 
@@ -157,8 +157,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);
 	}
 
 
@@ -174,9 +174,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;
@@ -186,7 +186,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;
 		}
 	}
 
@@ -200,7 +200,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;
 	}
 
@@ -216,15 +216,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);
 	}
 
 
@@ -236,8 +236,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));
 	}
 
 
@@ -262,8 +262,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;
@@ -278,7 +278,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;
 	}
 
@@ -293,8 +293,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;
@@ -309,7 +309,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;
 	}
 
@@ -324,7 +324,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;
 	}
 
@@ -341,7 +341,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;
 	}
 
@@ -353,9 +353,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'),
@@ -363,12 +363,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']);
 	}
 
 
@@ -379,9 +379,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'),
@@ -389,12 +389,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']);
 	}
 
 
@@ -406,8 +406,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);
 	}
 
 
@@ -422,8 +422,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);
 	}
 
 
@@ -437,36 +437,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);
 		}
 	}
 
@@ -480,18 +480,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;
 	}
 
 
@@ -504,20 +504,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;
 	}
 
@@ -534,15 +534,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;
@@ -560,24 +560,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
@@ -585,29 +585,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;
 	}
@@ -621,9 +621,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'];
 	}
 
@@ -635,10 +635,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_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/EE_Capabilities.core.php

Doc Comments +3 added lines, -3 removed lines

@@ -557,7 +557,7 @@ 
 	 * @since    4.5.0
 	 *
 	 * @param string $meta_cap     What meta capability is this mapping.
-	 * @param array  $map_values   array {
+	 * @param string[]  $map_values   array {
 	 * 		//array of values that MUST match a count of 4.  It's okay to send an empty string for capabilities that don't get mapped to.
 	 * 		@type $map_values[0] string A string representing the model name. Required.  String's
 	 * 		      	    	       should always be used when Menu Maps are registered via the
@@ -625,8 +625,8 @@ 
 	 * @see EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
 	 * @since 4.6.x
 	 * @param $caps
-	 * @param $cap
-	 * @param $user_id
+	 * @param string $cap
+	 * @param integer $user_id
 	 * @param $args
 	 *
 	 * @return array

Indentation +1 added lines, -2 removed lines

@@ -111,7 +111,6 @@ 
 
 	/**
 	 * This sets the meta caps property.
-
 	 * @since 4.5.0
 	 *
 	 * @return void
@@ -209,7 +208,7 @@ 
 			 * capability mapping which will be used for accessing payment methods owned by
 			 * other users.  This is not fully implemented yet in the payment method ui.
 			 * Currently only the "plural" caps are in active use. (Specific payment method caps are in use as well).
-			**/
+			 **/
 				'ee_manage_gateways',
 				'ee_read_payment_method',
 				'ee_read_payment_methods',

Spacing +127 added lines, -127 removed lines

@@ -7,8 +7,8 @@ 
  * @package Event Espresso
  * @subpackage core, capabilities
  */
-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 @@ 
 	 */
 	public static function instance() {
 		//check if instantiated, and if not do so.
-		if ( ! self::$_instance instanceof EE_Capabilities ) {
+		if ( ! self::$_instance instanceof EE_Capabilities) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -98,10 +98,10 @@ 
 	 * @since 4.5.0
 	 * @return void
 	 */
-	public function init_caps( $reset = false ) {
-		if ( EE_Maintenance_Mode::instance()->models_can_query() ){
+	public function init_caps($reset = false) {
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
 			$this->_caps_map = $this->_init_caps_map();
-			$this->init_role_caps( $reset );
+			$this->init_role_caps($reset);
 			$this->_set_meta_caps();
 		}
 	}
@@ -120,11 +120,11 @@ 
 		//make sure we're only ever initializing the default _meta_caps array once if it's empty.
 		$this->_meta_caps = $this->_get_default_meta_caps_array();
 
-		$this->_meta_caps = apply_filters( 'FHEE__EE_Capabilities___set_meta_caps__meta_caps', $this->_meta_caps );
+		$this->_meta_caps = apply_filters('FHEE__EE_Capabilities___set_meta_caps__meta_caps', $this->_meta_caps);
 
 		//add filter for map_meta_caps but only if models can query.
-		if ( EE_Maintenance_Mode::instance()->models_can_query() && ! has_filter( 'map_meta_cap', array( $this, 'map_meta_caps' ) ) ) {
-			add_filter( 'map_meta_cap', array( $this, 'map_meta_caps' ), 10, 4 );
+		if (EE_Maintenance_Mode::instance()->models_can_query() && ! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
+			add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
 		}
 	}
 
@@ -137,37 +137,37 @@ 
 	 */
 	private function _get_default_meta_caps_array() {
 		static $default_meta_caps = array();
-		if ( empty( $default_meta_caps ) ) {
+		if (empty($default_meta_caps)) {
 			$default_meta_caps = array(
 				//edits
-				new EE_Meta_Capability_Map_Edit( 'ee_edit_event', array( 'Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events' ) ),
-				new EE_Meta_Capability_Map_Edit( 'ee_edit_venue', array( 'Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues' ) ),
-				new EE_Meta_Capability_Map_Edit( 'ee_edit_registration', array( 'Registration', '', 'ee_edit_others_registrations', '' ) ),
-				new EE_Meta_Capability_Map_Edit( 'ee_edit_checkin', array( 'Registration', '', 'ee_edit_others_checkins', '' ) ),
-				new EE_Meta_Capability_Map_Messages_Cap( 'ee_edit_message', array( 'Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages' ) ),
-				new EE_Meta_Capability_Map_Edit( 'ee_edit_default_ticket', array( 'Ticket', '', 'ee_edit_others_default_tickets', '' ) ),
-				new EE_Meta_Capability_Map_Registration_Form_Cap( 'ee_edit_question', array( 'Question', '', '', 'ee_edit_system_questions' ) ),
-				new EE_Meta_Capability_Map_Registration_Form_Cap( 'ee_edit_question_group', array( 'Question_Group', '', '', 'ee_edit_system_question_groups' ) ),
-				new EE_Meta_Capability_Map_Edit( 'ee_edit_payment_method', array( 'Payment_Method', '', 'ee_edit_others_payment_methods', '' ) ),
+				new EE_Meta_Capability_Map_Edit('ee_edit_event', array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')),
+				new EE_Meta_Capability_Map_Edit('ee_edit_venue', array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')),
+				new EE_Meta_Capability_Map_Edit('ee_edit_registration', array('Registration', '', 'ee_edit_others_registrations', '')),
+				new EE_Meta_Capability_Map_Edit('ee_edit_checkin', array('Registration', '', 'ee_edit_others_checkins', '')),
+				new EE_Meta_Capability_Map_Messages_Cap('ee_edit_message', array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')),
+				new EE_Meta_Capability_Map_Edit('ee_edit_default_ticket', array('Ticket', '', 'ee_edit_others_default_tickets', '')),
+				new EE_Meta_Capability_Map_Registration_Form_Cap('ee_edit_question', array('Question', '', '', 'ee_edit_system_questions')),
+				new EE_Meta_Capability_Map_Registration_Form_Cap('ee_edit_question_group', array('Question_Group', '', '', 'ee_edit_system_question_groups')),
+				new EE_Meta_Capability_Map_Edit('ee_edit_payment_method', array('Payment_Method', '', 'ee_edit_others_payment_methods', '')),
 				//reads
-				new EE_Meta_Capability_Map_Read( 'ee_read_event', array( 'Event', '', 'ee_read_others_events', 'ee_read_private_events' ) ),
-				new EE_Meta_Capability_Map_Read( 'ee_read_venue', array( 'Venue', '', 'ee_read_others_venues', 'ee_read_private_venues' ) ),
-				new EE_Meta_Capability_Map_Read( 'ee_read_registration', array( 'Registration', '', '', 'ee_edit_others_registrations' ) ),
-				new EE_Meta_Capability_Map_Read( 'ee_read_checkin', array( 'Registration', '', '', 'ee_read_others_checkins' ) ),
-				new EE_Meta_Capability_Map_Messages_Cap( 'ee_read_message', array( 'Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages' ) ),
-				new EE_Meta_Capability_Map_Read( 'ee_read_default_ticket', array( 'Ticket', '', '', 'ee_read_others_default_tickets' ) ),
-				new EE_Meta_Capability_Map_Read( 'ee_read_payment_method', array( 'Payment_Method', '', '', 'ee_read_others_payment_methods' ) ),
+				new EE_Meta_Capability_Map_Read('ee_read_event', array('Event', '', 'ee_read_others_events', 'ee_read_private_events')),
+				new EE_Meta_Capability_Map_Read('ee_read_venue', array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')),
+				new EE_Meta_Capability_Map_Read('ee_read_registration', array('Registration', '', '', 'ee_edit_others_registrations')),
+				new EE_Meta_Capability_Map_Read('ee_read_checkin', array('Registration', '', '', 'ee_read_others_checkins')),
+				new EE_Meta_Capability_Map_Messages_Cap('ee_read_message', array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')),
+				new EE_Meta_Capability_Map_Read('ee_read_default_ticket', array('Ticket', '', '', 'ee_read_others_default_tickets')),
+				new EE_Meta_Capability_Map_Read('ee_read_payment_method', array('Payment_Method', '', '', 'ee_read_others_payment_methods')),
 
 				//deletes
-				new EE_Meta_Capability_Map_Delete( 'ee_delete_event', array( 'Event', 'ee_delete_published_events', 'ee_delete_others_events', 'ee_delete_private_events' ) ),
-				new EE_Meta_Capability_Map_Delete( 'ee_delete_venue', array( 'Venue', 'ee_delete_published_venues', 'ee_delete_others_venues', 'ee_delete_private_venues' ) ),
-				new EE_Meta_Capability_Map_Delete( 'ee_delete_registration', array( 'Registration', '', 'ee_delete_others_registrations', '' ) ),
-				new EE_Meta_Capability_Map_Delete( 'ee_delete_checkin', array( 'Registration', '', 'ee_delete_others_checkins', '' ) ),
-				new EE_Meta_Capability_Map_Messages_Cap( 'ee_delete_message', array( 'Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages' ) ),
-				new EE_Meta_Capability_Map_Delete( 'ee_delete_default_ticket', array( 'Ticket', '', 'ee_delete_others_default_tickets', '' ) ),
-				new EE_Meta_Capability_Map_Registration_Form_Cap( 'ee_delete_question', array( 'Question', '', '', 'delete_system_questions' ) ),
-				new EE_Meta_Capability_Map_Registration_Form_Cap( 'ee_delete_question_group', array( 'Question_Group', '', '', 'delete_system_question_groups' ) ),
-				new EE_Meta_Capability_Map_Delete( 'ee_delete_payment_method', array( 'Payment_Method', '', 'ee_delete_others_payment_methods', '' ) ),
+				new EE_Meta_Capability_Map_Delete('ee_delete_event', array('Event', 'ee_delete_published_events', 'ee_delete_others_events', 'ee_delete_private_events')),
+				new EE_Meta_Capability_Map_Delete('ee_delete_venue', array('Venue', 'ee_delete_published_venues', 'ee_delete_others_venues', 'ee_delete_private_venues')),
+				new EE_Meta_Capability_Map_Delete('ee_delete_registration', array('Registration', '', 'ee_delete_others_registrations', '')),
+				new EE_Meta_Capability_Map_Delete('ee_delete_checkin', array('Registration', '', 'ee_delete_others_checkins', '')),
+				new EE_Meta_Capability_Map_Messages_Cap('ee_delete_message', array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')),
+				new EE_Meta_Capability_Map_Delete('ee_delete_default_ticket', array('Ticket', '', 'ee_delete_others_default_tickets', '')),
+				new EE_Meta_Capability_Map_Registration_Form_Cap('ee_delete_question', array('Question', '', '', 'delete_system_questions')),
+				new EE_Meta_Capability_Map_Registration_Form_Cap('ee_delete_question_group', array('Question_Group', '', '', 'delete_system_question_groups')),
+				new EE_Meta_Capability_Map_Delete('ee_delete_payment_method', array('Payment_Method', '', 'ee_delete_others_payment_methods', '')),
 			);
 		}
 		return $default_meta_caps;
@@ -191,15 +191,15 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	public function map_meta_caps( $caps, $cap, $user_id, $args ) {
+	public function map_meta_caps($caps, $cap, $user_id, $args) {
 		//loop through our _meta_caps array
-		foreach ( $this->_meta_caps as $meta_map ) {
-			if ( ! $meta_map instanceof EE_Meta_Capability_Map ) {
+		foreach ($this->_meta_caps as $meta_map) {
+			if ( ! $meta_map instanceof EE_Meta_Capability_Map) {
 				continue;
 			}
 			$meta_map->ensure_is_model();
 
-			$caps = $meta_map->map_meta_caps( $caps, $cap, $user_id, $args );
+			$caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
 		}
 		return $caps;
 	}
@@ -364,7 +364,7 @@ 
 				)
 			);
 
-		$caps = apply_filters( 'FHEE__EE_Capabilities__init_caps_map__caps', $caps );
+		$caps = apply_filters('FHEE__EE_Capabilities__init_caps_map__caps', $caps);
 		return $caps;
 	}
 
@@ -381,26 +381,26 @@ 
 	 *
 	 * @return void
 	 */
-	public function init_role_caps( $reset = false, $custom_map = array() ) {
+	public function init_role_caps($reset = false, $custom_map = array()) {
 
-		$caps_map = empty( $custom_map ) ? $this->_caps_map : $custom_map;
+		$caps_map = empty($custom_map) ? $this->_caps_map : $custom_map;
 
 		//first let's determine if these caps have already been set.
-		$caps_set_before = get_option( self::option_name, array() );
+		$caps_set_before = get_option(self::option_name, array());
 		//if not reset, see what caps are new for each role. if they're new, add them.
-		foreach ( $caps_map as $role => $caps_for_role ) {
-			foreach ( $caps_for_role as $cap ) {
+		foreach ($caps_map as $role => $caps_for_role) {
+			foreach ($caps_for_role as $cap) {
 				//first check we haven't already added this cap before, or it's a reset
-				if ( $reset || ! isset( $caps_set_before[ $role ] ) || ! in_array( $cap, $caps_set_before[ $role ] ) ) {
-					$this->add_cap_to_role( $role, $cap );
-					$caps_set_before[ $role ][] = $cap;
+				if ($reset || ! isset($caps_set_before[$role]) || ! in_array($cap, $caps_set_before[$role])) {
+					$this->add_cap_to_role($role, $cap);
+					$caps_set_before[$role][] = $cap;
 				}
 			}
 		}
 
 		//now let's just save the cap that has been set.
-		update_option( self::option_name, $caps_set_before );
-		do_action( 'AHEE__EE_Capabilities__init_role_caps__complete', $caps_set_before );
+		update_option(self::option_name, $caps_set_before);
+		do_action('AHEE__EE_Capabilities__init_role_caps__complete', $caps_set_before);
 	}
 
 
@@ -419,10 +419,10 @@ 
 	 * @param bool $grant  Whether to grant access to this cap on this role.
 	 * @return void
 	 */
-	public function add_cap_to_role( $role, $cap, $grant = true ) {
-		$role = get_role( $role );
-		if ( $role instanceof WP_Role ) {
-			$role->add_cap( $cap, $grant );
+	public function add_cap_to_role($role, $cap, $grant = true) {
+		$role = get_role($role);
+		if ($role instanceof WP_Role) {
+			$role->add_cap($cap, $grant);
 		}
 	}
 
@@ -442,10 +442,10 @@ 
 	 *
 	 * @return void
 	 */
-	public function remove_cap_from_role( $role, $cap ) {
-		$role = get_role( $role );
-		if ( $role instanceof WP_Role ) {
-			$role->remove_cap( $cap );
+	public function remove_cap_from_role($role, $cap) {
+		$role = get_role($role);
+		if ($role instanceof WP_Role) {
+			$role->remove_cap($cap);
 		}
 	}
 
@@ -466,11 +466,11 @@ 
 	 *
 	 * @return bool  Whether user can or not.
 	 */
-	public function current_user_can( $cap, $context, $id = 0 ) {
+	public function current_user_can($cap, $context, $id = 0) {
 		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-		$filtered_cap = apply_filters( 'FHEE__EE_Capabilities__current_user_can__cap__' . $context,  $cap, $id );
-		$filtered_cap = apply_filters( 'FHEE__EE_Capabilities__current_user_can__cap', $filtered_cap, $context, $cap, $id );
-		return ! empty( $id ) ? current_user_can( $filtered_cap, $id ) : current_user_can( $filtered_cap );
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__'.$context, $cap, $id);
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap', $filtered_cap, $context, $cap, $id);
+		return ! empty($id) ? current_user_can($filtered_cap, $id) : current_user_can($filtered_cap);
 	}
 
 
@@ -487,11 +487,11 @@ 
 	 *
 	 * @return bool Whether user can or not.
 	 */
-	public function user_can( $user, $cap, $context, $id = 0 ) {
+	public function user_can($user, $cap, $context, $id = 0) {
 		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-		$filtered_cap = apply_filters( 'FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id );
-		$filtered_cap = apply_filters( 'FHEE__EE_Capabilities__user_can__cap', $filtered_cap, $context, $cap, $user,  $id );
-		return ! empty( $id ) ? user_can( $user, $filtered_cap, $id ) : user_can( $user, $filtered_cap );
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__'.$context, $cap, $user, $id);
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap', $filtered_cap, $context, $cap, $user, $id);
+		return ! empty($id) ? user_can($user, $filtered_cap, $id) : user_can($user, $filtered_cap);
 	}
 
 
@@ -511,12 +511,12 @@ 
 	 *
 	 * @return bool  Whether user can or not.
 	 */
-	public function current_user_can_for_blog( $blog_id, $cap, $context, $id = 0 ) {
-		$user_can = ! empty( $id ) ? current_user_can_for_blog( $blog_id, $cap, $id ) : current_user_can( $blog_id, $cap );
+	public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0) {
+		$user_can = ! empty($id) ? current_user_can_for_blog($blog_id, $cap, $id) : current_user_can($blog_id, $cap);
 
 		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-		$user_can = apply_filters( 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context, $user_can, $blog_id, $cap, $id );
-		$user_can = apply_filters( 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can', $user_can, $context, $blog_id, $cap, $id );
+		$user_can = apply_filters('FHEE__EE_Capabilities__current_user_can_for_blog__user_can__'.$context, $user_can, $blog_id, $cap, $id);
+		$user_can = apply_filters('FHEE__EE_Capabilities__current_user_can_for_blog__user_can', $user_can, $context, $blog_id, $cap, $id);
 		return $user_can;
 	}
 
@@ -532,12 +532,12 @@ 
 	 *
 	 * @return array
 	 */
-	public function get_ee_capabilities( $role = 'administrator' ) {
+	public function get_ee_capabilities($role = 'administrator') {
 		$capabilities = $this->_init_caps_map();
-		if ( empty( $role ) ) {
+		if (empty($role)) {
 			return $capabilities;
 		}
-		return isset( $capabilities[ $role ] ) ? $capabilities[ $role ] : array();
+		return isset($capabilities[$role]) ? $capabilities[$role] : array();
 	}
 }
 
@@ -585,11 +585,11 @@ 
 	 * 	}
 	 * @throws EE_Error
 	 */
-	public function __construct( $meta_cap, $map_values ) {
+	public function __construct($meta_cap, $map_values) {
 		$this->meta_cap = $meta_cap;
 		//verify there are four args in the $map_values array;
-		if ( count( $map_values ) !== 4 ) {
-			throw new EE_Error( sprintf( __( 'Incoming $map_values array should have a count of four values in it.  This is what was given: %s', 'event_espresso' ), '<br>' . print_r( $map_values, true ) ) );
+		if (count($map_values) !== 4) {
+			throw new EE_Error(sprintf(__('Incoming $map_values array should have a count of four values in it.  This is what was given: %s', 'event_espresso'), '<br>'.print_r($map_values, true)));
 		}
 
 		//set properties
@@ -603,8 +603,8 @@ 
 	/**
 	 * Makes it so this object stops filtering caps
 	 */
-	public function remove_filters(){
-		remove_filter( 'map_meta_cap', array( $this, 'map_meta_caps' ), 10 );
+	public function remove_filters() {
+		remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
 	}
 
 
@@ -619,19 +619,19 @@ 
 	 */
 	public function ensure_is_model() {
 		//is it already instantiated?
-		if ( $this->_model instanceof EEM_Base ) {
+		if ($this->_model instanceof EEM_Base) {
 			return;
 		}
 
 		//ensure model name is string
 		$this->_model_name = (string) $this->_model_name;
 		//error proof if the name has EEM in it
-		$this->_model_name = str_replace( 'EEM', '', $this->_model_name );
+		$this->_model_name = str_replace('EEM', '', $this->_model_name);
 
-		$this->_model = EE_Registry::instance()->load_model( $this->_model_name );
+		$this->_model = EE_Registry::instance()->load_model($this->_model_name);
 
-		if ( ! $this->_model instanceof EEM_Base ) {
-			throw new EE_Error( sprintf( __( 'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s', 'event_espresso' ), get_class( $this ), $this->_model ) );
+		if ( ! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(sprintf(__('This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s', 'event_espresso'), get_class($this), $this->_model));
 		}
 	}
 
@@ -647,8 +647,8 @@ 
 	 *
 	 * @return array
 	 */
-	public function map_meta_caps( $caps, $cap, $user_id, $args ) {
-		return $this->_map_meta_caps( $caps, $cap, $user_id, $args );
+	public function map_meta_caps($caps, $cap, $user_id, $args) {
+		return $this->_map_meta_caps($caps, $cap, $user_id, $args);
 	}
 
 
@@ -666,7 +666,7 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	abstract protected function _map_meta_caps( $caps, $cap, $user_id, $args );
+	abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
 }
 
 
@@ -698,28 +698,28 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	protected function _map_meta_caps( $caps, $cap, $user_id, $args ) {
+	protected function _map_meta_caps($caps, $cap, $user_id, $args) {
 		//only process if we're checking our mapped_cap
-		if ( $cap !== $this->meta_cap ) {
+		if ($cap !== $this->meta_cap) {
 			return $caps;
 		}
 
-		$obj = ! empty( $args[0] ) ? $this->_model->get_one_by_ID( $args[0] ) : null;
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
 
 		//if no obj then let's just do cap
-		if ( ! $obj instanceof EE_Base_Class ) {
+		if ( ! $obj instanceof EE_Base_Class) {
 			$caps[] = $cap;
 			return $caps;
 		}
 
-		if ( $obj instanceof EE_CPT_Base ) {
+		if ($obj instanceof EE_CPT_Base) {
 			//if the item author is set and the user is the author...
-			if ( $obj->wp_user() && $user_id == $obj->wp_user() ) {
-				if ( empty( $this->published_cap ) ) {
+			if ($obj->wp_user() && $user_id == $obj->wp_user()) {
+				if (empty($this->published_cap)) {
 					$caps[] = $cap;
 				} else {
 					//if obj is published...
-					if ( $obj->status() == 'publish' ) {
+					if ($obj->status() == 'publish') {
 						$caps[] = $this->published_cap;
 					} else {
 						$caps[] = $cap;
@@ -727,21 +727,21 @@ 
 				}
 			} else {
 				//the user is trying to edit someone else's obj
-				if ( ! empty( $this->others_cap ) ) {
+				if ( ! empty($this->others_cap)) {
 					$caps[] = $this->others_cap;
 				}
-				if ( ! empty( $this->published_cap ) && $obj->status() == 'publish' ) {
+				if ( ! empty($this->published_cap) && $obj->status() == 'publish') {
 					$caps[] = $this->published_cap;
-				} elseif ( ! empty( $this->private_cap ) && $obj->status() == 'private' ) {
+				} elseif ( ! empty($this->private_cap) && $obj->status() == 'private') {
 					$caps[] = $this->private_cap;
 				}
 			}
 		} else {
 			//not a cpt object so handled differently
-			if ( method_exists( $obj, 'wp_user' ) && $obj->wp_user() && $user_id == $obj->wp_user() ) {
+			if (method_exists($obj, 'wp_user') && $obj->wp_user() && $user_id == $obj->wp_user()) {
 				$caps[] = $cap;
 			} else {
-				if ( ! empty( $this->others_cap ) ) {
+				if ( ! empty($this->others_cap)) {
 					$caps[] = $this->others_cap;
 				}
 			}
@@ -778,8 +778,8 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	protected function _map_meta_caps( $caps, $cap, $user_id, $args ) {
-		return parent::_map_meta_caps( $caps, $cap, $user_id, $args );
+	protected function _map_meta_caps($caps, $cap, $user_id, $args) {
+		return parent::_map_meta_caps($caps, $cap, $user_id, $args);
 	}
 }
 
@@ -811,45 +811,45 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	protected function _map_meta_caps( $caps, $cap, $user_id, $args ) {
+	protected function _map_meta_caps($caps, $cap, $user_id, $args) {
 		//only process if we're checking our mapped cap;
-		if ( $cap !== $this->meta_cap ) {
+		if ($cap !== $this->meta_cap) {
 			return $caps;
 		}
 
-		$obj = ! empty( $args[0] ) ? $this->_model->get_one_by_ID( $args[0] ) : null;
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
 
 		//if no obj then let's just do cap
-		if ( ! $obj instanceof EE_Base_Class ) {
+		if ( ! $obj instanceof EE_Base_Class) {
 			$caps[] = $cap;
 			return $caps;
 		}
 
-		if ( $obj instanceof EE_CPT_Base ) {
-			$status_obj = get_post_status_object( $obj->status() );
-			if ( $status_obj->public ) {
+		if ($obj instanceof EE_CPT_Base) {
+			$status_obj = get_post_status_object($obj->status());
+			if ($status_obj->public) {
 				$caps[] = $cap;
 				return $caps;
 			}
 
 			//if the item author is set and the user is the author...
-			if ( $obj->wp_user() && $user_id == $obj->wp_user() ) {
+			if ($obj->wp_user() && $user_id == $obj->wp_user()) {
 				$caps[] = $cap;
-			} elseif ( $status_obj->private && ! empty( $this->private_cap ) ) {
+			} elseif ($status_obj->private && ! empty($this->private_cap)) {
 				//the user is trying to view someone else's obj
 				$caps[] = $this->private_cap;
-			} elseif ( ! empty( $this->others_cap ) ) {
+			} elseif ( ! empty($this->others_cap)) {
 				$caps[] = $this->others_cap;
 			} else {
 				$caps[] = $cap;
 			}
 		} else {
 			//not a cpt object so handled differently
-			if ( method_exists( $obj, 'wp_user' ) && $obj->wp_user() && $user_id == $obj->wp_user() ) {
+			if (method_exists($obj, 'wp_user') && $obj->wp_user() && $user_id == $obj->wp_user()) {
 				$caps[] = $cap;
-			} elseif ( ! empty( $this->private_cap ) ) {
+			} elseif ( ! empty($this->private_cap)) {
 				$caps[] = $this->private_cap;
-			} elseif ( ! empty( $this->others_cap ) ) {
+			} elseif ( ! empty($this->others_cap)) {
 				$caps[] = $this->others_cap;
 			} else {
 				$caps[] = $cap;
@@ -886,30 +886,30 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	protected function _map_meta_caps( $caps, $cap, $user_id, $args ) {
+	protected function _map_meta_caps($caps, $cap, $user_id, $args) {
 		//only process if we're checking our mapped_cap
-		if ( $cap !== $this->meta_cap ) {
+		if ($cap !== $this->meta_cap) {
 			return $caps;
 		}
 
-		$obj = ! empty( $args[0] ) ? $this->_model->get_one_by_ID( $args[0] ) : null;
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
 
 		//if no obj then let's just do cap
-		if ( ! $obj instanceof EE_Message_Template_Group ) {
+		if ( ! $obj instanceof EE_Message_Template_Group) {
 			$caps[] = $cap;
 			return $caps;
 		}
 
 		$is_global = $obj->is_global();
 
-		if ( $obj->wp_user() && $user_id == $obj->wp_user() ) {
-			if ( $is_global ) {
-				$caps[]  = $this->private_cap;
+		if ($obj->wp_user() && $user_id == $obj->wp_user()) {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
 			} else {
 				$caps[] = $cap;
 			}
 		} else {
-			if ( $is_global ) {
+			if ($is_global) {
 				$caps[] = $this->private_cap;
 			} else {
 				$caps[] = $this->others_cap;
@@ -947,16 +947,16 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	protected function _map_meta_caps( $caps, $cap, $user_id, $args ) {
+	protected function _map_meta_caps($caps, $cap, $user_id, $args) {
 		//only process if we're checking our mapped_cap
-		if ( $cap !== $this->meta_cap ) {
+		if ($cap !== $this->meta_cap) {
 			return $caps;
 		}
 
-		$obj = ! empty( $args[0] ) ? $this->_model->get_one_by_ID( $args[0] ) : null;
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
 
 		//if no obj then let's just do cap
-		if ( ! $obj instanceof EE_Base_Class ) {
+		if ( ! $obj instanceof EE_Base_Class) {
 			$caps[] = $cap;
 			return $caps;
 		}
@@ -964,7 +964,7 @@ 
 		$is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
 		$is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
 
-		if ( $is_system ) {
+		if ($is_system) {
 			$caps[] = $this->private_cap;
 		} else {
 			$caps[] = $cap;

core/EE_Maintenance_Mode.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -184,7 +184,7 @@
 	 *   returns TRUE if M-Mode is engaged and the current request is not for the admin
 	 *
 	 * @access    public
-	 * @return    string
+	 * @return    boolean
 	 */
 	public static function disable_frontend_for_maintenance() {
 		return ! is_admin() && EE_Maintenance_Mode::instance()->level() ? TRUE : FALSE;

Indentation +4 added lines, -4 removed lines

@@ -48,10 +48,10 @@
 	 */
 	const option_name_maintenance_mode = 'ee_maintenance_mode';
    /**
-     * 	EE_Maintenance_Mode Object
-     * 	@var EE_Maintenance_Mode $_instance
-	 * 	@access 	private
-     */
+    * 	EE_Maintenance_Mode Object
+    * 	@var EE_Maintenance_Mode $_instance
+    * 	@access 	private
+    */
 	private static $_instance = NULL;
 
 	/**

Braces +3 added lines, -3 removed lines

@@ -141,7 +141,7 @@ 
 			current_user_can('administrator') && //when the user is an admin
 			$real_maintenance_mode_level == EE_Maintenance_Mode::level_1_frontend_only_maintenance){//and we're in level 1
 			$maintenance_mode_level = EE_Maintenance_Mode::level_0_not_in_maintenance;
-		}else{
+		} else{
 			$maintenance_mode_level = $real_maintenance_mode_level;
 		}
 		return $maintenance_mode_level;
@@ -156,12 +156,12 @@ 
 		if( EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()){
 			update_option(self::option_name_maintenance_mode, self::level_2_complete_maintenance);
 			return true;
-		}elseif( $this->level() == self::level_2_complete_maintenance ){
+		} elseif( $this->level() == self::level_2_complete_maintenance ){
 			//we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run
 			//then we shouldn't be in mm2. (Maybe an addon got deactivated?)
 			update_option( self::option_name_maintenance_mode, self::level_0_not_in_maintenance );
 			return false;
-		}else{
+		} else{
 			return false;
 		}
 	}

Spacing +35 added lines, -35 removed lines

@@ -73,7 +73,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated
-		if ( self::$_instance === NULL  or ! is_object( self::$_instance ) or ! ( self::$_instance instanceof EE_Maintenance_Mode )) {
+		if (self::$_instance === NULL or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Maintenance_Mode)) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -83,7 +83,7 @@ 
 	 * Resets maintenance mode (mostly just re-checks whether or not we should be in maintenance mode)
 	 * @return EE_Maintenance_Mode
 	 */
-	public static function reset(){
+	public static function reset() {
 		self::instance()->set_maintenance_mode_if_db_old();
 		return self::instance();
 	}
@@ -98,11 +98,11 @@ 
 	 */
 	private function __construct() {
 		// if M-Mode level 2 is engaged, we still need basic assets loaded
-		add_action( 'wp_enqueue_scripts', array( $this, 'load_assets_required_for_m_mode' ));
+		add_action('wp_enqueue_scripts', array($this, 'load_assets_required_for_m_mode'));
 		// shut 'er down down for maintenance ?
-		add_filter( 'the_content', array( $this, 'the_content' ), 2 );
+		add_filter('the_content', array($this, 'the_content'), 2);
 		// add powered by EE msg
-		add_action( 'shutdown', array( $this, 'display_maintenance_mode_notice' ), 10 );
+		add_action('shutdown', array($this, 'display_maintenance_mode_notice'), 10);
 	}
 
 
@@ -112,8 +112,8 @@ 
 	 * retrieves the maintenance mode option value from the db
 	 * @return int
 	 */
-	public function real_level(){
-		return get_option( self::option_name_maintenance_mode, EE_Maintenance_Mode::level_0_not_in_maintenance );
+	public function real_level() {
+		return get_option(self::option_name_maintenance_mode, EE_Maintenance_Mode::level_0_not_in_maintenance);
 	}
 
 	/**
@@ -121,7 +121,7 @@ 
 	 * thinks their tables are present and up-to-date).
 	 * @return boolean
 	 */
-	public function models_can_query(){
+	public function models_can_query() {
 		return $this->real_level() != EE_Maintenance_Mode::level_2_complete_maintenance;
 	}
 
@@ -134,14 +134,14 @@ 
 	 * EE_Maintenance_Mode::level_2_complete_maintenance => frontend and backend maintenance mode
 	 * @return int
 	 */
-	public function level(){
+	public function level() {
 		$real_maintenance_mode_level = $this->real_level();
 		//if this is an admin request, we'll be honest... except if it's ajax, because that might be from the frontend
-		if( ( ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX)) && //only on frontend or ajax requests
+		if (( ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX)) && //only on frontend or ajax requests
 			current_user_can('administrator') && //when the user is an admin
-			$real_maintenance_mode_level == EE_Maintenance_Mode::level_1_frontend_only_maintenance){//and we're in level 1
+			$real_maintenance_mode_level == EE_Maintenance_Mode::level_1_frontend_only_maintenance) {//and we're in level 1
 			$maintenance_mode_level = EE_Maintenance_Mode::level_0_not_in_maintenance;
-		}else{
+		} else {
 			$maintenance_mode_level = $real_maintenance_mode_level;
 		}
 		return $maintenance_mode_level;
@@ -151,17 +151,17 @@ 
 	 * Determines if we need to put EE in maintenance mode because the database needs updating
 	 * @return boolean true if DB is old and maintenance mode was triggered; false otherwise
 	 */
-	public function set_maintenance_mode_if_db_old(){
-		EE_Registry::instance()->load_core( 'Data_Migration_Manager' );
-		if( EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()){
+	public function set_maintenance_mode_if_db_old() {
+		EE_Registry::instance()->load_core('Data_Migration_Manager');
+		if (EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
 			update_option(self::option_name_maintenance_mode, self::level_2_complete_maintenance);
 			return true;
-		}elseif( $this->level() == self::level_2_complete_maintenance ){
+		}elseif ($this->level() == self::level_2_complete_maintenance) {
 			//we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run
 			//then we shouldn't be in mm2. (Maybe an addon got deactivated?)
-			update_option( self::option_name_maintenance_mode, self::level_0_not_in_maintenance );
+			update_option(self::option_name_maintenance_mode, self::level_0_not_in_maintenance);
 			return false;
-		}else{
+		} else {
 			return false;
 		}
 	}
@@ -171,8 +171,8 @@ 
 	 * @param int $level
 	 * @return void
 	 */
-	public function set_maintenance_level($level){
-		do_action( 'AHEE__EE_Maintenance_Mode__set_maintenance_level', $level );
+	public function set_maintenance_level($level) {
+		do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $level);
 		update_option(self::option_name_maintenance_mode, intval($level));
 	}
 
@@ -199,11 +199,11 @@ 
 	 *  @return 	string
 	 */
 	public function load_assets_required_for_m_mode() {
-		if ( $this->real_level() == EE_Maintenance_Mode::level_2_complete_maintenance && ! wp_script_is( 'espresso_core', 'enqueued' )) {
-			wp_register_style( 'espresso_default', EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css', array( 'dashicons' ), EVENT_ESPRESSO_VERSION );
+		if ($this->real_level() == EE_Maintenance_Mode::level_2_complete_maintenance && ! wp_script_is('espresso_core', 'enqueued')) {
+			wp_register_style('espresso_default', EE_GLOBAL_ASSETS_URL.'css/espresso_default.css', array('dashicons'), EVENT_ESPRESSO_VERSION);
 			wp_enqueue_style('espresso_default');
-			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_register_script('espresso_core', EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE);
+			wp_enqueue_script('espresso_core');
 		}
 	}
 
@@ -221,7 +221,7 @@ 
 	 */
 	public static function template_include() {
 		// shut 'er down down for maintenance ? then don't use any of our templates for our endpoints
-		return get_template_directory() . '/index.php';
+		return get_template_directory().'/index.php';
 	}
 
 
@@ -235,12 +235,12 @@ 
 	 * @param    string $the_content
 	 * @return    string
 	 */
-	public function the_content( $the_content ) {
+	public function the_content($the_content) {
 		// check if M-mode is engaged and for EE shortcode
-		if ( $this->level() && strpos( $the_content, '[ESPRESSO_' ) !== false ) {
+		if ($this->level() && strpos($the_content, '[ESPRESSO_') !== false) {
 			// this can eventually be moved to a template, or edited via admin. But for now...
 			$the_content = sprintf(
-				__( '%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s', 'event_espresso' ),
+				__('%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s', 'event_espresso'),
 				'<h3>',
 				'</h3><p>',
 				'</p>'
@@ -264,16 +264,16 @@ 
 		// check if M-mode is engaged and for EE shortcode
 		if (
 			$this->real_level() &&
-			current_user_can( 'administrator' ) &&
+			current_user_can('administrator') &&
 			! is_admin() &&
-			! ( defined( 'DOING_AJAX' ) && DOING_AJAX )
+			! (defined('DOING_AJAX') && DOING_AJAX)
 			&& EE_Registry::instance()->REQ->is_espresso_page()
 		) {
 			printf(
-				__( '%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s', 'event_espresso' ),
+				__('%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s', 'event_espresso'),
 				'<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
 				'">&times;</a><p>',
-				' &raquo; <a href="' . add_query_arg( array( 'page' => 'espresso_maintenance_settings' ), admin_url( 'admin.php' )) . '">',
+				' &raquo; <a href="'.add_query_arg(array('page' => 'espresso_maintenance_settings'), admin_url('admin.php')).'">',
 				'</a></p></div>'
 			);
 		}
@@ -291,9 +291,9 @@ 
 	 *		@ return void
 	 */
 	final function __destruct() {}
-	final function __call($a,$b) {}
+	final function __call($a, $b) {}
 	final function __get($a) {}
-	final function __set($a,$b) {}
+	final function __set($a, $b) {}
 	final function __isset($a) {}
 	final function __unset($a) {}
 	final function __sleep() {
@@ -304,7 +304,7 @@ 
 	final function __invoke() {}
 	final function __set_state() {}
 	final function __clone() {}
-	final static function __callStatic($a,$b) {}
+	final static function __callStatic($a, $b) {}
 
 }
 // End of file EE_Maintenance_Mode.core.php