eventespresso / event-espresso-core

core/db_models/EEM_Soft_Delete_Base.model.php

Doc Comments +5 added lines, -5 removed lines

@@ -182,7 +182,7 @@ 
 	 * Sums all NON-SOFT-DELETED objects that meet the criteria in $query_params.
 	 * @param array $query_params like EEM_Base::get_all's $query_params
 	 * @param string $field_to_sum name of field
-	 * @return int count
+	 * @return double count
 	 */
 	public function sum($query_params =null,$field_to_sum= null){
 		//just calls parent, but changes PHP doc
@@ -194,7 +194,7 @@ 
 	 * Sum all the deleted items.
 	 * @param array $query_params like EEM_Base::get_all
 	 * @param string $field_to_sum
-	 * @return int
+	 * @return double
 	 */
 	public function sum_deleted($query_params = null, $field_to_sum = null){
 		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
@@ -243,7 +243,7 @@ 
 	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
 	 * that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
 	 * which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
-	 * @return boolean success
+	 * @return integer success
 	 */
 	public function delete_permanently($query_params = array(), $allow_blocking = true){
 		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
@@ -258,7 +258,7 @@ 
 	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
 	 * that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
 	 * which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
-	 * @return boolean success
+	 * @return integer success
 	 */
 	public function delete_permanently_by_ID($ID=FALSE, $allow_blocking = true){
 		$query_params = array();
@@ -352,7 +352,7 @@ 
 	/**
 	 * Updates all the items of this model which match the $query params, regardless of whether
 	 * they've been soft-deleted or not
-	 * @param array $field_n_values like EEM_Base::update's $fields_n_value
+	 * @param array $fields_n_values like EEM_Base::update's $fields_n_value
 	 * @param array $query_params like EEM_base::get_all's $query_params
 	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
 	 * in this model's entity map according to $fields_n_values that match $query_params. This

Spacing +48 added lines, -48 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
-require_once( EE_MODELS . 'EEM_Base.model.php');
+require_once(EE_MODELS.'EEM_Base.model.php');
 /**
  * EEM_Soft_Delete_Base
  *
@@ -25,14 +25,14 @@ 
  * @subpackage		includes/models/
  * @author				Michael Nelson
  */
-abstract class EEM_Soft_Delete_Base extends EEM_Base{
+abstract class EEM_Soft_Delete_Base extends EEM_Base {
 
 	/**
 	 * @param null $timezone
 	 */
 	protected function __construct($timezone = NULL) {
-		require_once( EE_MODELS . 'strategies/EE_Soft_Delete_Where_Conditions.strategy.php');
-		if( ! $this->_default_where_conditions_strategy){
+		require_once(EE_MODELS.'strategies/EE_Soft_Delete_Where_Conditions.strategy.php');
+		if ( ! $this->_default_where_conditions_strategy) {
 			$this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
 		}
 		parent::__construct($timezone);
@@ -43,12 +43,12 @@ 
 	 * @return string
 	 * @throws EE_Error
 	 */
-	public function deleted_field_name(){
+	public function deleted_field_name() {
 		$field = $this->get_a_field_of_type('EE_Trashed_Flag_Field');
-		if($field){
+		if ($field) {
 			return $field->get_name();
-		}else{
-			throw new EE_Error(sprintf(__('We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?','event_espresso'),get_class($this),get_class($this)));
+		} else {
+			throw new EE_Error(sprintf(__('We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?', 'event_espresso'), get_class($this), get_class($this)));
 		}
 	}
 
@@ -59,7 +59,7 @@ 
 	 * @param array $query_params like EEM_Base::get_all
 	 * @return EE_Soft_Delete_Base_Class[]
 	 */
-	public function get_all($query_params = array()){
+	public function get_all($query_params = array()) {
 		return parent::get_all($query_params);
 	}
 
@@ -69,7 +69,7 @@ 
 	 * @param array $query_params like EEM_Base::get_all's $query_params
 	 * @return EE_Soft_Delete_Base_Class
 	 */
-	public function get_one($query_params = array()){
+	public function get_one($query_params = array()) {
 		return parent::get_one($query_params);
 	}
 	/**
@@ -77,7 +77,7 @@ 
 	 * @param array $query_params like EEM_Base::get_all's $query_params
 	 * @return EE_Soft_Delete_Base_Class
 	 */
-	public function get_one_deleted($query_params = array()){
+	public function get_one_deleted($query_params = array()) {
 		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
 		return parent::get_one($query_params);
 	}
@@ -87,7 +87,7 @@ 
 	 * @param array $query_params like EEM_base::get_all's $query_params
 	 * @return EE_Soft_Delete_Base_Class
 	 */
-	public function get_one_deleted_or_undeleted($query_params = array()){
+	public function get_one_deleted_or_undeleted($query_params = array()) {
 		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
 		return parent::get_one($query_params);
 	}
@@ -108,7 +108,7 @@ 
 	 * @param int|string $id
 	 * @return EE_Soft_Delete_Base_Class
 	 */
-	public function get_one_by_ID_but_ignore_deleted($id){
+	public function get_one_by_ID_but_ignore_deleted($id) {
 		return parent::get_one_by_ID($id);
 	}
 	/**
@@ -119,7 +119,7 @@ 
 	 * @param boolean $distinct
 	 * @return int count
 	 */
-	public function count($query_params = array(), $field_to_count = null, $distinct = false){
+	public function count($query_params = array(), $field_to_count = null, $distinct = false) {
 		//just calls parent, but changes PHP docs for this function
 		return parent::count($query_params, $field_to_count, $distinct);
 	}
@@ -131,7 +131,7 @@ 
 	 * @param bool 	 $distinct if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
 	 * @return int
 	 */
-	public function count_deleted($query_params = null, $field_to_count = null, $distinct = FALSE){
+	public function count_deleted($query_params = null, $field_to_count = null, $distinct = FALSE) {
 		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
 		return parent::count($query_params, $field_to_count, $distinct);
 	}
@@ -141,9 +141,9 @@ 
 	 * @param array $query_params like EEM_Base::get_all's $query_params
 	 * @return array like EEM_Base::get_all's $query_params
 	 */
-	protected function _alter_query_params_so_only_trashed_items_included($query_params){
-		$deletedFlagFieldName=$this->deleted_field_name();
-		$query_params[0][$deletedFlagFieldName]=true;
+	protected function _alter_query_params_so_only_trashed_items_included($query_params) {
+		$deletedFlagFieldName = $this->deleted_field_name();
+		$query_params[0][$deletedFlagFieldName] = true;
 		return $query_params;
 	}
 
@@ -152,7 +152,7 @@ 
 	 * @param array $query_params
 	 * @return array
 	 */
-	public function alter_query_params_so_deleted_and_undeleted_items_included( $query_params = array() ){
+	public function alter_query_params_so_deleted_and_undeleted_items_included($query_params = array()) {
 		return $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
 	}
 
@@ -161,7 +161,7 @@ 
 	 * @param array $query_params
 	 * @return array
 	 */
-	protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params){
+	protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params) {
 		$query_params['default_where_conditions'] = 'other_models_only';
 		return $query_params;
 	}
@@ -173,9 +173,9 @@ 
 	 * @param bool 	 $distinct if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
 	 * @return int
 	 */
-	public function count_deleted_and_undeleted($query_params = null, $field_to_count = null, $distinct = FALSE){
+	public function count_deleted_and_undeleted($query_params = null, $field_to_count = null, $distinct = FALSE) {
 		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-		return parent::count($query_params,$field_to_count, $distinct);
+		return parent::count($query_params, $field_to_count, $distinct);
 	}
 
 	/**
@@ -184,9 +184,9 @@ 
 	 * @param string $field_to_sum name of field
 	 * @return int count
 	 */
-	public function sum($query_params =null,$field_to_sum= null){
+	public function sum($query_params = null, $field_to_sum = null) {
 		//just calls parent, but changes PHP doc
-		return parent::sum($query_params,$field_to_sum);
+		return parent::sum($query_params, $field_to_sum);
 	}
 
 
@@ -196,7 +196,7 @@ 
 	 * @param string $field_to_sum
 	 * @return int
 	 */
-	public function sum_deleted($query_params = null, $field_to_sum = null){
+	public function sum_deleted($query_params = null, $field_to_sum = null) {
 		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
 		return parent::sum($query_params, $field_to_sum);
 	}
@@ -207,7 +207,7 @@ 
 	 * @param string $field_to_sum
 	 * @reutrn int
 	 */
-	public function sum_deleted_and_undeleted($query_params = null, $field_to_sum = null){
+	public function sum_deleted_and_undeleted($query_params = null, $field_to_sum = null) {
 		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
 		parent::sum($query_params, $field_to_sum);
 	}
@@ -217,7 +217,7 @@ 
 	 * @param array $query_params like EEM_Base::get_all
 	 * @return EE_Soft_Delete_Base_Class[]
 	 */
-	public function get_all_deleted_and_undeleted($query_params = array()){
+	public function get_all_deleted_and_undeleted($query_params = array()) {
 		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
 		return parent::get_all($query_params);
 	}
@@ -227,7 +227,7 @@ 
 	 * @param array $query_params like EEM_Base::get_all
 	 * @return EE_Soft_Delete_Base_Class[]
 	 */
-	public function get_all_deleted($query_params = array()){
+	public function get_all_deleted($query_params = array()) {
 		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
 		return parent::get_all($query_params);
 	}
@@ -245,7 +245,7 @@ 
 	 * which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
 	 * @return boolean success
 	 */
-	public function delete_permanently($query_params = array(), $allow_blocking = true){
+	public function delete_permanently($query_params = array(), $allow_blocking = true) {
 		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
 		return parent::delete($query_params, $allow_blocking);
 	}
@@ -260,7 +260,7 @@ 
 	 * which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
 	 * @return boolean success
 	 */
-	public function delete_permanently_by_ID($ID=FALSE, $allow_blocking = true){
+	public function delete_permanently_by_ID($ID = FALSE, $allow_blocking = true) {
 		$query_params = array();
 		$query_params[0] = array($this->get_primary_key_field()->get_name() => $ID);
 		$query_params['limit'] = 1;
@@ -274,8 +274,8 @@ 
 	 * @param mixed $ID value of the primary_key or primary_text_key
 	 * @return boolean success
 	 */
-	public function delete_by_ID($ID){
-		return $this->delete_or_restore_by_ID(true,$ID);
+	public function delete_by_ID($ID) {
+		return $this->delete_or_restore_by_ID(true, $ID);
 	}
 	/**
 	 * Restores a particular item by its ID (primary key). Ignores the fact whether the item
@@ -283,8 +283,8 @@ 
 	 * @param mixed $ID int if primary key is an int, string otherwise
 	 * @return boolean success
 	 */
-	public function restore_by_ID($ID=FALSE){
-		return $this->delete_or_restore_by_ID(false,$ID);
+	public function restore_by_ID($ID = FALSE) {
+		return $this->delete_or_restore_by_ID(false, $ID);
 	}
 	/**
 	 * For deleting or restoring a particular item. Note that this model is a SOFT-DELETABLE model! However,
@@ -293,15 +293,15 @@ 
 	 * @param mixed $ID int if primary key is an int, string otherwise
 	 * @return boolean
 	 */
-	public function delete_or_restore_by_ID($delete=true,$ID=FALSE){
-		if ( ! $ID ) {
+	public function delete_or_restore_by_ID($delete = true, $ID = FALSE) {
+		if ( ! $ID) {
 			return FALSE;
 		}
-		$primaryKeyName=$this->primary_key_name();
+		$primaryKeyName = $this->primary_key_name();
 		// retrieve a particular transaction
 		$query_params = array();
-		$query_params[0] = array( $primaryKeyName => $ID );
-		if ( $this->delete_or_restore ($delete, $query_params )) {
+		$query_params[0] = array($primaryKeyName => $ID);
+		if ($this->delete_or_restore($delete, $query_params)) {
 			return TRUE;
 		} else {
 			return FALSE;
@@ -319,7 +319,7 @@ 
 	 * @param bool  $block_deletes
 	 * @return boolean
 	 */
-	public function delete($query_params = array(), $block_deletes = false){
+	public function delete($query_params = array(), $block_deletes = false) {
 		//no matter what, we WON'T block soft deletes.
 		return $this->delete_or_restore(true, $query_params);
 	}
@@ -330,7 +330,7 @@ 
 	 * @param array $query_params like EEM_Base::get_all
 	 * @return boolean
 	 */
-	public function restore($query_params = array()){
+	public function restore($query_params = array()) {
 		return $this->delete_or_restore(false, $query_params);
 	}
 	/**
@@ -339,10 +339,10 @@ 
 	 * @param array $query_params like EEM_Base::get_all
 	 * @return boolean
 	 */
-	function delete_or_restore($delete=true,$query_params = array()){
-		$deletedFlagFieldName=$this->deleted_field_name();
+	function delete_or_restore($delete = true, $query_params = array()) {
+		$deletedFlagFieldName = $this->deleted_field_name();
 		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-		if ( $this->update (array($deletedFlagFieldName=>$delete), $query_params )) {
+		if ($this->update(array($deletedFlagFieldName=>$delete), $query_params)) {
 			return TRUE;
 		} else {
 			return FALSE;
@@ -360,9 +360,9 @@ 
 	 * be aware that model objects being used could get out-of-sync with the database
 	 * @return int number of items updated
 	 */
-	public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = TRUE ){
+	public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = TRUE) {
 		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-		return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync );
+		return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync);
 	}
 
 	/**
@@ -377,8 +377,8 @@ 
 	 * be aware that model objects being used could get out-of-sync with the database
 	 * @return int how many items were updated
 	 */
-	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = TRUE ){
-		return parent::update($fields_n_values,$query_params, $keep_model_objs_in_sync );
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = TRUE) {
+		return parent::update($fields_n_values, $query_params, $keep_model_objs_in_sync);
 	}
 
 

Braces +4 added lines, -2 removed lines

@@ -1,4 +1,6 @@ 
-<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
+}
 /**
  * EEH_URL helper
  * Helper class for URL-related PHP functions
@@ -62,7 +64,7 @@ 
 				isset($results['response']['code']) &&
 				$results['response']['code'] == '200'){
 			return true;
-		}else{
+		} else{
 			return false;
 		}
 	}

core/db_models/EEM_State.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -165,7 +165,7 @@
 	*
 	* 		@access		public
 	* 		@param		$STA_ID
-	*		@return 		mixed		array on success, FALSE on fail
+	*		@return 		boolean		array on success, FALSE on fail
 	*/
 	public function delete_by_ID( $STA_ID = FALSE ) {
 

Indentation +16 added lines, -16 removed lines

@@ -64,11 +64,11 @@ 
 
 
 	/**
-	*	reset_cached_states
-	*
-	* 	@access		private
-	*	@return 		void
-	*/
+	 *	reset_cached_states
+	 *
+	 * 	@access		private
+	 *	@return 		void
+	 */
 	public function reset_cached_states() {
 		EEM_State::$_active_states = array();
 		EEM_State::$_all_states = array();
@@ -78,11 +78,11 @@ 
 
 
 	/**
-	*		_get_states
-	*
-	* 		@access		private
-	*		@return 		array
-	*/
+	 *		_get_states
+	 *
+	 * 		@access		private
+	 *		@return 		array
+	 */
 	public function get_all_states() {
 		if ( ! self::$_all_states ) {
 			self::$_all_states = $this->get_all( array( 'order_by'=>array( 'STA_name'=>'ASC' ), 'limit'=> array( 0, 99999 )));
@@ -161,12 +161,12 @@ 
 
 
 	/**
-	*		delete  a single state from db via their ID
-	*
-	* 		@access		public
-	* 		@param		$STA_ID
-	*		@return 		mixed		array on success, FALSE on fail
-	*/
+	 *		delete  a single state from db via their ID
+	 *
+	 * 		@access		public
+	 * 		@param		$STA_ID
+	 *		@return 		mixed		array on success, FALSE on fail
+	 */
 	public function delete_by_ID( $STA_ID = FALSE ) {
 
 		if ( ! $STA_ID ) {

Spacing +41 added lines, -41 removed lines

@@ -21,8 +21,8 @@ 
  *
  * ------------------------------------------------------------------------
  */
-require_once ( EE_MODELS . 'EEM_Base.model.php' );
-require_once ( EE_CLASSES . 'EE_State.class.php' );
+require_once (EE_MODELS.'EEM_Base.model.php');
+require_once (EE_CLASSES.'EE_State.class.php');
 
 class EEM_State extends EEM_Base {
 
@@ -33,9 +33,9 @@ 
   	// array of all active states
 	private static $_active_states = FALSE;
 
-	protected function __construct( $timezone = NULL ) {
-		$this->singular_item = __('State/Province','event_espresso');
-		$this->plural_item = __('States/Provinces','event_espresso');
+	protected function __construct($timezone = NULL) {
+		$this->singular_item = __('State/Province', 'event_espresso');
+		$this->plural_item = __('States/Provinces', 'event_espresso');
 
 		$this->_tables = array(
 			'State'=> new EE_Primary_Table('esp_state', 'STA_ID')
@@ -43,10 +43,10 @@ 
 
 		$this->_fields = array(
 			'State'=>array(
-				'STA_ID'=> new EE_Primary_Key_Int_Field('STA_ID', __('State ID','event_espresso')),
-				'CNT_ISO'=> new EE_Foreign_Key_String_Field('CNT_ISO', __('Country ISO Code','event_espresso'), false, NULL, 'Country'),
-				'STA_abbrev' => new EE_Plain_Text_Field('STA_abbrev', __('State Abbreviation','event_espresso'), false, ''),
-				'STA_name' => new EE_Plain_Text_Field('STA_name', __('State Name','event_espresso'), false, ''),
+				'STA_ID'=> new EE_Primary_Key_Int_Field('STA_ID', __('State ID', 'event_espresso')),
+				'CNT_ISO'=> new EE_Foreign_Key_String_Field('CNT_ISO', __('Country ISO Code', 'event_espresso'), false, NULL, 'Country'),
+				'STA_abbrev' => new EE_Plain_Text_Field('STA_abbrev', __('State Abbreviation', 'event_espresso'), false, ''),
+				'STA_name' => new EE_Plain_Text_Field('STA_name', __('State Name', 'event_espresso'), false, ''),
 				'STA_active'=> new EE_Boolean_Field('STA_active', __('State Active Flag', 'event_espresso'), false, false)
 				));
 		$this->_model_relations = array(
@@ -55,9 +55,9 @@ 
 			'Venue'=>new EE_Has_Many_Relation(),
 		);
 		//this model is generally available for reading
-		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
 		//@todo: only show STA_active 
-		parent::__construct( $timezone );
+		parent::__construct($timezone);
 	}
 
 
@@ -84,8 +84,8 @@ 
 	*		@return 		array
 	*/
 	public function get_all_states() {
-		if ( ! self::$_all_states ) {
-			self::$_all_states = $this->get_all( array( 'order_by'=>array( 'STA_name'=>'ASC' ), 'limit'=> array( 0, 99999 )));
+		if ( ! self::$_all_states) {
+			self::$_all_states = $this->get_all(array('order_by'=>array('STA_name'=>'ASC'), 'limit'=> array(0, 99999)));
 		}
 		return self::$_all_states;
 	}
@@ -100,14 +100,14 @@ 
 	 * @param bool  $flush_cache
 	 * @return        array
 	 */
-	public function get_all_active_states( $countries = array(), $flush_cache = FALSE ) {
-		if ( ! self::$_active_states || $flush_cache ) {
-			$countries = is_array( $countries ) && ! empty( $countries ) ? $countries : EEM_Country::instance()->get_all_active_countries();
-			self::$_active_states =  $this->get_all( array(
-				array( 'STA_active' => TRUE, 'CNT_ISO' => array( 'IN', array_keys( $countries ))),
-				'order_by' => array( 'STA_name'=>'ASC' ),
-				'limit' => array( 0, 99999 ),
-				'force_join' => array( 'Country' )
+	public function get_all_active_states($countries = array(), $flush_cache = FALSE) {
+		if ( ! self::$_active_states || $flush_cache) {
+			$countries = is_array($countries) && ! empty($countries) ? $countries : EEM_Country::instance()->get_all_active_countries();
+			self::$_active_states = $this->get_all(array(
+				array('STA_active' => TRUE, 'CNT_ISO' => array('IN', array_keys($countries))),
+				'order_by' => array('STA_name'=>'ASC'),
+				'limit' => array(0, 99999),
+				'force_join' => array('Country')
 			));
 		}
 		return self::$_active_states;
@@ -119,8 +119,8 @@ 
 	 * 	get_all_states_of_active_countries
 	 * @return array
 	 */
-	public function get_all_states_of_active_countries(){
-		if ( $states = $this->get_all( array( array( 'Country.CNT_active' => TRUE, 'STA_active' => TRUE ),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
+	public function get_all_states_of_active_countries() {
+		if ($states = $this->get_all(array(array('Country.CNT_active' => TRUE, 'STA_active' => TRUE), 'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')))) {
 			return $states;
 		}
 		return FALSE;
@@ -132,11 +132,11 @@ 
 	 * 	get_all_states_of_active_countries
 	 * @return array
 	 */
-	public function get_all_active_states_for_these_countries( $countries ){
-		if ( ! $countries ) {
+	public function get_all_active_states_for_these_countries($countries) {
+		if ( ! $countries) {
 			return FALSE;
 		}
-		if ( $states = $this->get_all( array(  array( 'Country.CNT_ISO' => array( 'IN', array_keys( $countries )), 'STA_active' => TRUE ),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
+		if ($states = $this->get_all(array(array('Country.CNT_ISO' => array('IN', array_keys($countries)), 'STA_active' => TRUE), 'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')))) {
 			return $states;
 		}
 		return FALSE;
@@ -148,11 +148,11 @@ 
 	 * 	get_all_states_of_active_countries
 	 * @return array
 	 */
-	public function get_all_states_for_these_countries( $countries ){
-		if ( ! $countries ) {
+	public function get_all_states_for_these_countries($countries) {
+		if ( ! $countries) {
 			return FALSE;
 		}
-		if ( $states = $this->get_all( array( array( 'Country.CNT_ISO' => array( 'IN', array_keys( $countries ))),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
+		if ($states = $this->get_all(array(array('Country.CNT_ISO' => array('IN', array_keys($countries))), 'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')))) {
 			return $states;
 		}
 		return FALSE;
@@ -167,15 +167,15 @@ 
 	* 		@param		$STA_ID
 	*		@return 		mixed		array on success, FALSE on fail
 	*/
-	public function delete_by_ID( $STA_ID = FALSE ) {
+	public function delete_by_ID($STA_ID = FALSE) {
 
-		if ( ! $STA_ID ) {
+		if ( ! $STA_ID) {
 			return FALSE;
 		}
 
 		// retrieve a particular transaction
-		$where_cols_n_values = array( array( 'STA_ID' => $STA_ID ));
-		if ( $answer = $this->delete ( $where_cols_n_values )) {
+		$where_cols_n_values = array(array('STA_ID' => $STA_ID));
+		if ($answer = $this->delete($where_cols_n_values)) {
 			return TRUE;
 		} else {
 			return FALSE;
@@ -188,15 +188,15 @@ 
 	 * @param string $state_ID
 	 * @return string
 	 */
-	public function get_state_name_by_ID( $state_ID ){
-		if( isset( self::$_all_states[ $state_ID ] ) &&
-				self::$_all_states[ $state_ID ] instanceof EE_State ){
-			return self::$_all_states[ $state_ID ]->name();
+	public function get_state_name_by_ID($state_ID) {
+		if (isset(self::$_all_states[$state_ID]) &&
+				self::$_all_states[$state_ID] instanceof EE_State) {
+			return self::$_all_states[$state_ID]->name();
 		}
-		$names = $this->get_col( array( array( 'STA_ID' => $state_ID ), 'limit' => 1), 'STA_name' );
-		if( is_array( $names ) && ! empty( $names ) ){
-			return reset( $names );
-		}else{
+		$names = $this->get_col(array(array('STA_ID' => $state_ID), 'limit' => 1), 'STA_name');
+		if (is_array($names) && ! empty($names)) {
+			return reset($names);
+		} else {
 			return '';
 		}
 	}

Braces +4 added lines, -2 removed lines

@@ -1,4 +1,6 @@ 
-<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
+}
 /**
  * EEH_URL helper
  * Helper class for URL-related PHP functions
@@ -62,7 +64,7 @@ 
 				isset($results['response']['code']) &&
 				$results['response']['code'] == '200'){
 			return true;
-		}else{
+		} else{
 			return false;
 		}
 	}

core/db_models/EEM_System_Status.model.php

Doc Comments +2 added lines, -4 removed lines

@@ -14,8 +14,6 @@ 
 	 * 		This function is a singleton method used to instantiate the EEM_Attendee object
 	 *
 	 * 		@access public
-	 * 		@param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-	 * 		@return EEM_System_Status
 	 */
 	public static function instance() {
 
@@ -147,7 +145,7 @@ 
 
 	/**
 	 *
-	 * @return array like EE_Config class
+	 * @return EE_Config like EE_Config class
 	 */
 	function get_ee_config(){
 		return EE_Config::instance();
@@ -197,7 +195,7 @@ 
 
 	/**
 	 * Checks if site responds ot HTTPS
-	 * @return boolean
+	 * @return string
 	 */
 	function get_https_enabled(){
 		$home = str_replace("http://", "https://", home_url());

Braces +7 added lines, -5 removed lines

@@ -81,8 +81,9 @@ 
 	 */
 	function get_active_plugins(){
 		$active_plugins = (array) get_option( 'active_plugins', array() );
-		if ( is_multisite() )
-			$active_plugins = array_merge( $active_plugins, get_site_option( 'active_sitewide_plugins', array() ) );
+		if ( is_multisite() ) {
+					$active_plugins = array_merge( $active_plugins, get_site_option( 'active_sitewide_plugins', array() ) );
+		}
 		$active_plugins = array_map( 'strtolower', $active_plugins );
 		$plugin_info = array();
 		foreach ( $active_plugins as $plugin ) {
@@ -187,8 +188,9 @@ 
 		  preg_match_all(
 		  '#%S%(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?%E%#',
 			$section, $askapache, PREG_SET_ORDER);
-		  foreach($askapache as $m)
-			  $m2 = isset($m[2]) ? $m[2] : null;
+		  foreach($askapache as $m) {
+		  			  $m2 = isset($m[2]) ? $m[2] : null;
+		  }
 			  $pi[$n][$m[1]]=(!isset($m[3])||$m2==$m[3]) ? $m2 : array_slice($m,2);
 		}
 
@@ -232,7 +234,7 @@ 
 			$status = __('Your server has fsockopen enabled, cURL is disabled.', 'event_espresso');
 		} elseif( $curl_works ) {
 			$status = __('Your server has cURL enabled, fsockopen is disabled.', 'event_espresso');
-		}else{
+		} else{
 			$status = __('Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.', 'event_espresso'). '</mark>';
 		}
 		return $status;

Indentation +6 added lines, -6 removed lines

@@ -215,17 +215,17 @@
 	 * Whether or not a .maintenance file is detected
 	 * @return string descripting wp_maintenance_mode status
 	 */
-    function get_wp_maintenance_mode() {
-        $opened = file_exists( ABSPATH . '.maintenance' );
-        return $opened ? sprintf( __('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>','</strong>' ) : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso')  ;
-    }
+	function get_wp_maintenance_mode() {
+		$opened = file_exists( ABSPATH . '.maintenance' );
+		return $opened ? sprintf( __('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>','</strong>' ) : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso')  ;
+	}
 	/**
 	 * Whether or not logging is enabled
 	 * @return string descripting logging's status
 	 */
 	function get_logging_enabled(){
-            $opened = @fopen( EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a' );
-            return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf( __('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"','</mark>' ) ;
+			$opened = @fopen( EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a' );
+			return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf( __('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"','</mark>' ) ;
 	}
 	/**
 	 *  Whether curl ro fsock works

Spacing +56 added lines, -56 removed lines

@@ -3,7 +3,7 @@ 
 /**
  * Model for retrieving Information about the Event Espresso status.
  */
-class EEM_System_Status{
+class EEM_System_Status {
 
 	// private instance of the EEM_System_Status object
 	protected static $_instance = NULL;
@@ -26,7 +26,7 @@ 
 		}
 		return self::$_instance;
 	}
-	private function __construct(){
+	private function __construct() {
 
 	}
 	/**
@@ -34,7 +34,7 @@ 
 	 * @return array where each key is a function name on this class, and each value is SOMETHING--
 	 * it might be a value, an array, or an object
 	 */
-	function get_system_stati(){
+	function get_system_stati() {
 		return array(
 				'ee_version'=>$this->get_ee_version(),
 				'ee_activation_history'=>$this->get_ee_activation_history(),
@@ -55,14 +55,14 @@ 
 	 *
 	 * @return string
 	 */
-	function get_ee_version(){
+	function get_ee_version() {
 		return espresso_version();
 	}
 	/**
 	 *
 	 * @return string
 	 */
-	function php_version(){
+	function php_version() {
 		return phpversion();
 	}
 	/**
@@ -79,16 +79,16 @@ 
 		'DomainPath' => 'Domain Path',
 		'Network' => 'Network',
 	 */
-	function get_active_plugins(){
-		$active_plugins = (array) get_option( 'active_plugins', array() );
-		if ( is_multisite() )
-			$active_plugins = array_merge( $active_plugins, get_site_option( 'active_sitewide_plugins', array() ) );
-		$active_plugins = array_map( 'strtolower', $active_plugins );
+	function get_active_plugins() {
+		$active_plugins = (array) get_option('active_plugins', array());
+		if (is_multisite())
+			$active_plugins = array_merge($active_plugins, get_site_option('active_sitewide_plugins', array()));
+		$active_plugins = array_map('strtolower', $active_plugins);
 		$plugin_info = array();
-		foreach ( $active_plugins as $plugin ) {
-				$plugin_data = @get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin );
+		foreach ($active_plugins as $plugin) {
+				$plugin_data = @get_plugin_data(WP_PLUGIN_DIR.'/'.$plugin);
 
-				$plugin_info[ $plugin ] = $plugin_data;
+				$plugin_info[$plugin] = $plugin_data;
 		}
 		return $plugin_info;
 	}
@@ -97,17 +97,17 @@ 
 	 *
 	 * @return array with keys 'home_url' and 'site_url'
 	 */
-	function get_wp_settings(){
-		$wp_memory_int = $this->let_to_num( WP_MEMORY_LIMIT );
-		if ( $wp_memory_int < 67108864 ) {
-			$wp_memory_to_display = '<mark class="error">' . sprintf( __('%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s', 'event_espresso'), WP_MEMORY_LIMIT, '<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">', '</a>"' ) . '</mark>';
+	function get_wp_settings() {
+		$wp_memory_int = $this->let_to_num(WP_MEMORY_LIMIT);
+		if ($wp_memory_int < 67108864) {
+			$wp_memory_to_display = '<mark class="error">'.sprintf(__('%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s', 'event_espresso'), WP_MEMORY_LIMIT, '<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">', '</a>"').'</mark>';
 		} else {
-			$wp_memory_to_display = '<mark class="yes">' . size_format( $wp_memory_int ) . '</mark>';
+			$wp_memory_to_display = '<mark class="yes">'.size_format($wp_memory_int).'</mark>';
 		}
 		return array(
-			'name'=>get_bloginfo('name','display'),
+			'name'=>get_bloginfo('name', 'display'),
 			'is_multisite'=>is_multisite(),
-			'version'=>  get_bloginfo( 'version', 'display' ),
+			'version'=>  get_bloginfo('version', 'display'),
 			'home_url'=>home_url(),
 			'site_url'=>site_url(),
 			'WP_DEBUG'=>WP_DEBUG,
@@ -116,8 +116,8 @@ 
 			'gmt_offset'=>get_option('gmt_offset'),
 			'timezone_string'=>get_option('timezone_string'),
 			'admin_email'=>  get_bloginfo('admin_email', 'display'),
-			'language'=>get_bloginfo('language','display'),
-			'wp_max_upload_size' => size_format( wp_max_upload_size() ),
+			'language'=>get_bloginfo('language', 'display'),
+			'wp_max_upload_size' => size_format(wp_max_upload_size()),
 			'wp_memory' => $wp_memory_to_display
 			);
 	}
@@ -126,7 +126,7 @@ 
 	 * Gets an array of information about the history of ee versions installed
 	 * @return array
 	 */
-	function get_ee_activation_history(){
+	function get_ee_activation_history() {
 		return get_option('espresso_db_update');
 	}
 
@@ -135,11 +135,11 @@ 
 	 * Gets an array where keys are ee versions, and their values are arrays indicating all the different times that version was installed
 	 * @return EE_Data_Migration_Script_Base[]
 	 */
-	function get_ee_migration_history(){
+	function get_ee_migration_history() {
 		$options = EE_Data_Migration_Manager::instance()->get_all_migration_script_options();
 		$presentable_migration_scripts = array();
-		foreach($options as $option_array){
-			$presentable_migration_scripts[str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix,"",$option_array['option_name'])] = maybe_unserialize($option_array['option_value']);
+		foreach ($options as $option_array) {
+			$presentable_migration_scripts[str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix, "", $option_array['option_name'])] = maybe_unserialize($option_array['option_value']);
 		}
 		return $presentable_migration_scripts;
 //		return get_option(EE_Data_Migration_Manager::data_migrations_option_name);//EE_Data_Migration_Manager::instance()->get_data_migrations_ran();
@@ -149,7 +149,7 @@ 
 	 *
 	 * @return array like EE_Config class
 	 */
-	function get_ee_config(){
+	function get_ee_config() {
 		return EE_Config::instance();
 	}
 
@@ -157,24 +157,24 @@ 
 	 * Gets an array of php setup info, pilfered from http://www.php.net/manual/en/function.phpinfo.php#87463
 	 * @return array like the output of phpinfo(), but in an array
 	 */
-	function get_php_info(){
+	function get_php_info() {
 		ob_start();
 		phpinfo(-1);
 
 		$pi = preg_replace(
 		array('#^.*<body>(.*)</body>.*$#ms', '#<h2>PHP License</h2>.*$#ms',
-		'#<h1>Configuration</h1>#',  "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
+		'#<h1>Configuration</h1>#', "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
 		"#[ \t]+#", '#&nbsp;#', '#  +#', '# class=".*?"#', '%&#039;%',
 		 '#<tr>(?:.*?)" src="(?:.*?)=(.*?)" alt="PHP Logo" /></a>'
 		 .'<h1>PHP Version (.*?)</h1>(?:\n+?)</td></tr>#',
 		 '#<h1><a href="(?:.*?)\?=(.*?)">PHP Credits</a></h1>#',
 		 '#<tr>(?:.*?)" src="(?:.*?)=(.*?)"(?:.*?)Zend Engine (.*?),(?:.*?)</tr>#',
 		 "# +#", '#<tr>#', '#</tr>#'),
-		array('$1', '', '', '', '</$1>' . "\n", '<', ' ', ' ', ' ', '', ' ',
+		array('$1', '', '', '', '</$1>'."\n", '<', ' ', ' ', ' ', '', ' ',
 		 '<h2>PHP Configuration</h2>'."\n".'<tr><td>PHP Version</td><td>$2</td></tr>'.
 		 "\n".'<tr><td>PHP Egg</td><td>$1</td></tr>',
 		 '<tr><td>PHP Credits Egg</td><td>$1</td></tr>',
-		 '<tr><td>Zend Engine</td><td>$2</td></tr>' . "\n" .
+		 '<tr><td>Zend Engine</td><td>$2</td></tr>'."\n".
 		 '<tr><td>Zend Egg</td><td>$1</td></tr>', ' ', '%S%', '%E%'),
 		ob_get_clean());
 
@@ -182,14 +182,14 @@ 
 		unset($sections[0]);
 
 		$pi = array();
-		foreach($sections as $section){
+		foreach ($sections as $section) {
 		  $n = substr($section, 0, strpos($section, '</h2>'));
 		  preg_match_all(
 		  '#%S%(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?%E%#',
 			$section, $askapache, PREG_SET_ORDER);
-		  foreach($askapache as $m)
+		  foreach ($askapache as $m)
 			  $m2 = isset($m[2]) ? $m[2] : null;
-			  $pi[$n][$m[1]]=(!isset($m[3])||$m2==$m[3]) ? $m2 : array_slice($m,2);
+			  $pi[$n][$m[1]] = ( ! isset($m[3]) || $m2 == $m[3]) ? $m2 : array_slice($m, 2);
 		}
 
 		return $pi;
@@ -199,13 +199,13 @@ 
 	 * Checks if site responds ot HTTPS
 	 * @return boolean
 	 */
-	function get_https_enabled(){
+	function get_https_enabled() {
 		$home = str_replace("http://", "https://", home_url());
 		$response = wp_remote_get($home);
-		if($response instanceof WP_Error){
+		if ($response instanceof WP_Error) {
 			$error_string = '';
-			foreach($response->errors as $short_name => $description_array){
-				$error_string .= "<b>$short_name</b>: ".implode(", ",$description_array);
+			foreach ($response->errors as $short_name => $description_array) {
+				$error_string .= "<b>$short_name</b>: ".implode(", ", $description_array);
 			}
 			return $error_string;
 		}
@@ -216,32 +216,32 @@ 
 	 * @return string descripting wp_maintenance_mode status
 	 */
     function get_wp_maintenance_mode() {
-        $opened = file_exists( ABSPATH . '.maintenance' );
-        return $opened ? sprintf( __('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>','</strong>' ) : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso')  ;
+        $opened = file_exists(ABSPATH.'.maintenance');
+        return $opened ? sprintf(__('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>', '</strong>') : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso');
     }
 	/**
 	 * Whether or not logging is enabled
 	 * @return string descripting logging's status
 	 */
-	function get_logging_enabled(){
-            $opened = @fopen( EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a' );
-            return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf( __('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"','</mark>' ) ;
+	function get_logging_enabled() {
+            $opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR.'/logs/espresso_log.txt', 'a');
+            return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>');
 	}
 	/**
 	 *  Whether curl ro fsock works
 	 * @return string describing posting's status
 	 */
-	function get_remote_posting(){
-		$fsock_works = function_exists( 'fsockopen' );
-		$curl_works = function_exists( 'curl_init' );
-		if ( $fsock_works && $curl_works ) {
+	function get_remote_posting() {
+		$fsock_works = function_exists('fsockopen');
+		$curl_works = function_exists('curl_init');
+		if ($fsock_works && $curl_works) {
 			$status = __('Your server has fsockopen and cURL enabled.', 'event_espresso');
-		} elseif ( $fsock_works ) {
+		} elseif ($fsock_works) {
 			$status = __('Your server has fsockopen enabled, cURL is disabled.', 'event_espresso');
-		} elseif( $curl_works ) {
+		} elseif ($curl_works) {
 			$status = __('Your server has cURL enabled, fsockopen is disabled.', 'event_espresso');
-		}else{
-			$status = __('Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.', 'event_espresso'). '</mark>';
+		} else {
+			$status = __('Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.', 'event_espresso').'</mark>';
 		}
 		return $status;
 
@@ -250,7 +250,7 @@ 
 	 * Gets all the php.ini settings
 	 * @return array
 	 */
-	function get_php_ini_all(){
+	function get_php_ini_all() {
 		return ini_get_all();
 	}
 	/**
@@ -259,10 +259,10 @@ 
 	 * @param type $size
 	 * @return int
 	 */
-	function let_to_num( $size ) {
-		$l 		= substr( $size, -1 );
-		$ret 	= substr( $size, 0, -1 );
-		switch( strtoupper( $l ) ) {
+	function let_to_num($size) {
+		$l = substr($size, -1);
+		$ret = substr($size, 0, -1);
+		switch (strtoupper($l)) {
 			case 'P':
 				$ret *= 1024;
 			case 'T':

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,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;

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