eventespresso / event-espresso-core

core/db_classes/EE_Message_Template_Group.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -224,7 +224,7 @@
 	 * appropriately.
 	 *
 	 * @throws EE_Error
-	 * @return EE_message_type|false if exception thrown.
+	 * @return null|EE_message_type if exception thrown.
 	 */
 	public function message_type_obj() {
 		$message_type = $this->message_type();

Spacing +51 added lines, -51 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_Message_Template_Group class
@@ -18,9 +18,9 @@ 
 	 * @param string $timezone
 	 * @return EE_Message_Template_Group|mixed
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = '' ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone );
-		return $has_object ? $has_object : new self( $props_n_values, FALSE, $timezone );
+	public static function new_instance($props_n_values = array(), $timezone = '') {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, FALSE, $timezone);
 	}
 
 
@@ -30,8 +30,8 @@ 
 	 * @param string $timezone
 	 * @return EE_Message_Template_Group
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = '' ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '') {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -40,11 +40,11 @@ 
 	 * @param bool $message_type
 	 * @throws EE_Error
 	 */
-	public function set_message_type( $message_type = FALSE ) {
-		if ( ! $message_type ) {
-			throw new EE_Error( __( 'Missing required value for the message_type parameter', 'event_espresso' ) );
+	public function set_message_type($message_type = FALSE) {
+		if ( ! $message_type) {
+			throw new EE_Error(__('Missing required value for the message_type parameter', 'event_espresso'));
 		}
-		$this->set( 'MTP_message_type', $message_type );
+		$this->set('MTP_message_type', $message_type);
 	}
 
 
@@ -53,11 +53,11 @@ 
 	 * @param bool $messenger
 	 * @throws EE_Error
 	 */
-	public function set_messenger( $messenger = FALSE ) {
-		if ( ! $messenger ) {
-			throw new EE_Error( __( 'Missing required value for the messenger parameter', 'event_espresso' ) );
+	public function set_messenger($messenger = FALSE) {
+		if ( ! $messenger) {
+			throw new EE_Error(__('Missing required value for the messenger parameter', 'event_espresso'));
 		}
-		$this->set( 'MTP_messenger', $messenger );
+		$this->set('MTP_messenger', $messenger);
 	}
 
 
@@ -66,11 +66,11 @@ 
 	 * @param bool $GRP_ID
 	 * @throws EE_Error
 	 */
-	public function set_group_template_id( $GRP_ID = FALSE ) {
-		if ( ! $GRP_ID ) {
-			throw new EE_Error( __( 'Missing required value for the message template group id', 'event_espresso' ) );
+	public function set_group_template_id($GRP_ID = FALSE) {
+		if ( ! $GRP_ID) {
+			throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
 		}
-		$this->set( 'GRP_ID', $GRP_ID );
+		$this->set('GRP_ID', $GRP_ID);
 	}
 
 
@@ -81,7 +81,7 @@ 
 	 * @return int
 	 */
 	public function GRP_ID() {
-		return $this->get( 'GRP_ID' );
+		return $this->get('GRP_ID');
 	}
 
 
@@ -92,8 +92,8 @@ 
 	 * @return int
 	 */
 	public function user() {
-		$user_id = $this->get( 'MTP_user_id' );
-		return empty( $user_id ) ? get_current_user_id() : $user_id;
+		$user_id = $this->get('MTP_user_id');
+		return empty($user_id) ? get_current_user_id() : $user_id;
 	}
 
 
@@ -116,7 +116,7 @@ 
 	 * @return int
 	 */
 	public function count_events() {
-		return $this->count_related( 'Event' );
+		return $this->count_related('Event');
 	}
 
 
@@ -126,7 +126,7 @@ 
 	 * @return string
 	 */
 	public function name() {
-		return $this->get( 'MTP_name' );
+		return $this->get('MTP_name');
 	}
 
 
@@ -136,7 +136,7 @@ 
 	 * @return string
 	 */
 	public function description() {
-		return $this->get( 'MTP_description' );
+		return $this->get('MTP_description');
 	}
 
 
@@ -146,8 +146,8 @@ 
 	 * @param  array $query_params like EEM_Base::get_all()
 	 * @return EE_Message_Template[]
 	 */
-	public function message_templates( $query_params = array() ) {
-		return $this->get_many_related( 'Message_Template', $query_params );
+	public function message_templates($query_params = array()) {
+		return $this->get_many_related('Message_Template', $query_params);
 	}
 
 
@@ -158,7 +158,7 @@ 
 	 * @return string
 	 */
 	public function messenger() {
-		return $this->get( 'MTP_messenger' );
+		return $this->get('MTP_messenger');
 	}
 
 
@@ -175,10 +175,10 @@ 
 	public function messenger_obj() {
 		$messenger = $this->messenger();
 		try {
-			$messenger = EEH_MSG_Template::messenger_obj( $messenger );
-		} catch( EE_Error $e ) {
+			$messenger = EEH_MSG_Template::messenger_obj($messenger);
+		} catch (EE_Error $e) {
 			//if an exception was thrown then let's deactivate this message template group because it means there is no class for this messenger in this group.
-			$this->set( 'MTP_is_active', false );
+			$this->set('MTP_is_active', false);
 			$this->save();
 			return null;
 		}
@@ -194,7 +194,7 @@ 
 	 * @return string
 	 */
 	public function message_type() {
-		return $this->get( 'MTP_message_type' );
+		return $this->get('MTP_message_type');
 	}
 
 
@@ -212,10 +212,10 @@ 
 	public function message_type_obj() {
 		$message_type = $this->message_type();
 		try {
-			$message_type = EEH_MSG_Template::message_type_obj( $message_type );
-		} catch(EE_Error $e) {
+			$message_type = EEH_MSG_Template::message_type_obj($message_type);
+		} catch (EE_Error $e) {
 			//if an exception was thrown then let's deactivate this message template group because it means there is no class for the message type in this group.
-			$this->set( 'MTP_is_active', false );
+			$this->set('MTP_is_active', false);
 			$this->save();
 			return null;
 		}
@@ -252,13 +252,13 @@ 
 	 */
 	public function context_templates() {
 		$mtps_arr = array();
-		$mtps = $this->get_many_related( 'Message_Template' );
-		if ( empty( $mtps ) ) {
+		$mtps = $this->get_many_related('Message_Template');
+		if (empty($mtps)) {
 			return array();
 		}
 		//note contexts could have CHECKBOX fields per context. So we return the objects indexed by context AND field.
-		foreach ( $mtps as $mtp ) {
-			$mtps_arr[ $mtp->get( 'MTP_context' ) ][ $mtp->get( 'MTP_template_field' ) ] = $mtp;
+		foreach ($mtps as $mtp) {
+			$mtps_arr[$mtp->get('MTP_context')][$mtp->get('MTP_template_field')] = $mtp;
 		}
 		return $mtps_arr;
 	}
@@ -270,7 +270,7 @@ 
 	 * @return boolean true if it is, false if it isn't
 	 */
 	public function is_global() {
-		return $this->get( 'MTP_is_global' );
+		return $this->get('MTP_is_global');
 	}
 
 
@@ -280,7 +280,7 @@ 
 	 * @return boolean true if it is, false if it isn't
 	 */
 	public function is_active() {
-		return $this->get( 'MTP_is_active' );
+		return $this->get('MTP_is_active');
 	}
 
 
@@ -296,10 +296,10 @@ 
 	 * @param bool   $merged  If TRUE then we don't return shortcodes indexed by field but instead an array of the unique shortcodes for all the given (or all) fields.
 	 * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no shortcodes found.
 	 */
-	public function get_shortcodes( $context, $fields = array(), $merged = FALSE ) {
+	public function get_shortcodes($context, $fields = array(), $merged = FALSE) {
 		$messenger = $this->messenger();
 		$message_type = $this->message_type();
-		return EEH_MSG_Template::get_shortcodes( $message_type, $messenger, $fields, $context, $merged );
+		return EEH_MSG_Template::get_shortcodes($message_type, $messenger, $fields, $context, $merged);
 	}
 
 
@@ -340,7 +340,7 @@ 
 	 * @return string
 	 */
 	public function get_template_pack_name() {
-		return $this->get_extra_meta( 'MTP_template_pack', true, 'default' );
+		return $this->get_extra_meta('MTP_template_pack', true, 'default');
 	}
 
 
@@ -355,8 +355,8 @@ 
 	 */
 	public function get_template_pack() {
 		$pack_name = $this->get_template_pack_name();
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
-		return EEH_MSG_Template::get_template_pack( $pack_name );
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_template_pack($pack_name);
 	}
 
 
@@ -369,7 +369,7 @@ 
 	 * @return string
 	 */
 	public function get_template_pack_variation() {
-		return $this->get_extra_meta( 'MTP_variation', TRUE, 'default' );
+		return $this->get_extra_meta('MTP_variation', TRUE, 'default');
 	}
 
 
@@ -381,8 +381,8 @@ 
 	 * @param string $template_pack_name What message template pack is assigned.
 	 * @return int
 	 */
-	public function set_template_pack_name( $template_pack_name ) {
-		return $this->update_extra_meta( 'MTP_template_pack', $template_pack_name );
+	public function set_template_pack_name($template_pack_name) {
+		return $this->update_extra_meta('MTP_template_pack', $template_pack_name);
 	}
 
 
@@ -394,8 +394,8 @@ 
 	 * @param string $variation What variation is being set on the message template group.
 	 * @return int
 	 */
-	public function set_template_pack_variation( $variation ) {
-		return $this->update_extra_meta( 'MTP_variation', $variation );
+	public function set_template_pack_variation($variation) {
+		return $this->update_extra_meta('MTP_variation', $variation);
 	}
 }
 //end EE_Message_Template_Group class

core/db_classes/EE_Payment.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -15,7 +15,7 @@ 
 	 * @param array  $props_n_values          incoming values
 	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
 	 *                                        used.)
-	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 * @param string[]  $date_formats            incoming date_formats in an array where the first value is the
 	 *                                        date_format and the second value is the time format
 	 * @return EE_Payment
 	 * @throws \EE_Error
@@ -590,7 +590,7 @@ 
 	 * Gets all the extra meta info on this payment
 	 *
 	 * @param array $query_params like EEM_Base::get_all
-	 * @return EE_Extra_Meta
+	 * @return EE_Base_Class[]
 	 * @throws \EE_Error
 	 */
 	public function extra_meta( $query_params = array() ) {

Indentation +10 added lines, -10 removed lines

@@ -662,11 +662,11 @@ 
 				$redirect_url = str_replace( '?' . $querystring, '', $redirect_url );
 			}
 			$form = EEH_HTML::nl( 1 )
-			        . '<form method="'
-			        . $method
-			        . '" name="gateway_form" action="'
-			        . $redirect_url
-			        . '">';
+					. '<form method="'
+					. $method
+					. '" name="gateway_form" action="'
+					. $redirect_url
+					. '">';
 			$form .= EEH_HTML::nl( 1 ) . $this->redirect_args_as_inputs();
 			$form .= $inside_form_html;
 			$form .= EEH_HTML::nl( -1 ) . '</form>' . EEH_HTML::nl( -1 );
@@ -704,11 +704,11 @@ 
 			EE_Registry::instance()->load_helper( 'HTML' );
 			foreach ( $args as $name => $value ) {
 				$html .= EEH_HTML::nl( 0 )
-				         . '<input type="hidden" name="'
-				         . $name
-				         . '" value="'
-				         . esc_attr( $value )
-				         . '"/>';
+						 . '<input type="hidden" name="'
+						 . $name
+						 . '" value="'
+						 . esc_attr( $value )
+						 . '"/>';
 			}
 		}
 		return $html;

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');
 }
 
 /**
@@ -20,9 +20,9 @@ 
 	 * @return EE_Payment
 	 * @throws \EE_Error
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -34,8 +34,8 @@ 
 	 * @return EE_Payment
 	 * @throws \EE_Error
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, true, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, true, $timezone);
 	}
 
 
@@ -47,8 +47,8 @@ 
 	 * @param int $TXN_ID
 	 * @throws \EE_Error
 	 */
-	public function set_transaction_id( $TXN_ID = 0 ) {
-		$this->set( 'TXN_ID', $TXN_ID );
+	public function set_transaction_id($TXN_ID = 0) {
+		$this->set('TXN_ID', $TXN_ID);
 	}
 
 
@@ -60,7 +60,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function transaction() {
-		return $this->get_first_related( 'Transaction' );
+		return $this->get_first_related('Transaction');
 	}
 
 
@@ -72,8 +72,8 @@ 
 	 * @param string $STS_ID
 	 * @throws \EE_Error
 	 */
-	public function set_status( $STS_ID = '' ) {
-		$this->set( 'STS_ID', $STS_ID );
+	public function set_status($STS_ID = '') {
+		$this->set('STS_ID', $STS_ID);
 	}
 
 
@@ -85,8 +85,8 @@ 
 	 * @param int $timestamp
 	 * @throws \EE_Error
 	 */
-	public function set_timestamp( $timestamp = 0 ) {
-		$this->set( 'PAY_timestamp', $timestamp );
+	public function set_timestamp($timestamp = 0) {
+		$this->set('PAY_timestamp', $timestamp);
 	}
 
 
@@ -98,8 +98,8 @@ 
 	 * @param string $PAY_source
 	 * @throws \EE_Error
 	 */
-	public function set_source( $PAY_source = '' ) {
-		$this->set( 'PAY_source', $PAY_source );
+	public function set_source($PAY_source = '') {
+		$this->set('PAY_source', $PAY_source);
 	}
 
 
@@ -111,8 +111,8 @@ 
 	 * @param float $amount
 	 * @throws \EE_Error
 	 */
-	public function set_amount( $amount = 0.00 ) {
-		$this->set( 'PAY_amount', (float)$amount );
+	public function set_amount($amount = 0.00) {
+		$this->set('PAY_amount', (float) $amount);
 	}
 
 
@@ -124,8 +124,8 @@ 
 	 * @param string $gateway_response
 	 * @throws \EE_Error
 	 */
-	public function set_gateway_response( $gateway_response = '' ) {
-		$this->set( 'PAY_gateway_response', $gateway_response );
+	public function set_gateway_response($gateway_response = '') {
+		$this->set('PAY_gateway_response', $gateway_response);
 	}
 
 
@@ -148,7 +148,7 @@ 
 			),
 			'4.6.0'
 		);
-		return $this->payment_method() ? $this->payment_method()->name() : __( 'Unknown', 'event_espresso' );
+		return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
 	}
 
 
@@ -160,8 +160,8 @@ 
 	 * @param string $txn_id_chq_nmbr
 	 * @throws \EE_Error
 	 */
-	public function set_txn_id_chq_nmbr( $txn_id_chq_nmbr = '' ) {
-		$this->set( 'PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr );
+	public function set_txn_id_chq_nmbr($txn_id_chq_nmbr = '') {
+		$this->set('PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr);
 	}
 
 
@@ -173,8 +173,8 @@ 
 	 * @param string $po_number
 	 * @throws \EE_Error
 	 */
-	public function set_po_number( $po_number = '' ) {
-		$this->set( 'PAY_po_number', $po_number );
+	public function set_po_number($po_number = '') {
+		$this->set('PAY_po_number', $po_number);
 	}
 
 
@@ -186,8 +186,8 @@ 
 	 * @param string $extra_accntng
 	 * @throws \EE_Error
 	 */
-	public function set_extra_accntng( $extra_accntng = '' ) {
-		$this->set( 'PAY_extra_accntng', $extra_accntng );
+	public function set_extra_accntng($extra_accntng = '') {
+		$this->set('PAY_extra_accntng', $extra_accntng);
 	}
 
 
@@ -199,11 +199,11 @@ 
 	 * @param bool $via_admin
 	 * @throws \EE_Error
 	 */
-	public function set_payment_made_via_admin( $via_admin = false ) {
-		if ( $via_admin ) {
-			$this->set( 'PAY_source', EEM_Payment_Method::scope_admin );
+	public function set_payment_made_via_admin($via_admin = false) {
+		if ($via_admin) {
+			$this->set('PAY_source', EEM_Payment_Method::scope_admin);
 		} else {
-			$this->set( 'PAY_source', EEM_Payment_Method::scope_cart );
+			$this->set('PAY_source', EEM_Payment_Method::scope_cart);
 		}
 	}
 
@@ -216,13 +216,13 @@ 
 	 * @param string|array $details
 	 * @throws \EE_Error
 	 */
-	public function set_details( $details = '' ) {
-		if ( is_array( $details ) ) {
-			array_walk_recursive( $details, array( $this, '_strip_all_tags_within_array' ) );
+	public function set_details($details = '') {
+		if (is_array($details)) {
+			array_walk_recursive($details, array($this, '_strip_all_tags_within_array'));
 		} else {
-			$details = wp_strip_all_tags( $details );
+			$details = wp_strip_all_tags($details);
 		}
-		$this->set( 'PAY_details', $details );
+		$this->set('PAY_details', $details);
 	}
 
 
@@ -233,8 +233,8 @@ 
 	 * @param string $redirect_url
 	 * @throws \EE_Error
 	 */
-	public function set_redirect_url( $redirect_url ) {
-		$this->set( 'PAY_redirect_url', $redirect_url );
+	public function set_redirect_url($redirect_url) {
+		$this->set('PAY_redirect_url', $redirect_url);
 	}
 
 
@@ -245,8 +245,8 @@ 
 	 * @param array $redirect_args
 	 * @throws \EE_Error
 	 */
-	public function set_redirect_args( $redirect_args ) {
-		$this->set( 'PAY_redirect_args', $redirect_args );
+	public function set_redirect_args($redirect_args) {
+		$this->set('PAY_redirect_args', $redirect_args);
 	}
 
 
@@ -258,7 +258,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function TXN_ID() {
-		return $this->get( 'TXN_ID' );
+		return $this->get('TXN_ID');
 	}
 
 
@@ -270,7 +270,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function status() {
-		return $this->get( 'STS_ID' );
+		return $this->get('STS_ID');
 	}
 
 
@@ -282,7 +282,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function STS_ID() {
-		return $this->get( 'STS_ID' );
+		return $this->get('STS_ID');
 	}
 
 
@@ -296,8 +296,8 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public function timestamp( $dt_frmt = '', $tm_frmt = '' ) {
-		return $this->get_i18n_datetime( 'PAY_timestamp', trim( $dt_frmt . ' ' . $tm_frmt) );
+	public function timestamp($dt_frmt = '', $tm_frmt = '') {
+		return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt.' '.$tm_frmt));
 	}
 
 
@@ -309,7 +309,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function source() {
-		return $this->get( 'PAY_source' );
+		return $this->get('PAY_source');
 	}
 
 
@@ -322,7 +322,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function amount() {
-		return (float)$this->get( 'PAY_amount' );
+		return (float) $this->get('PAY_amount');
 	}
 
 
@@ -332,7 +332,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function amount_no_code() {
-		return $this->get_pretty( 'PAY_amount', 'no_currency_code' );
+		return $this->get_pretty('PAY_amount', 'no_currency_code');
 	}
 
 
@@ -344,7 +344,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function gateway_response() {
-		return $this->get( 'PAY_gateway_response' );
+		return $this->get('PAY_gateway_response');
 	}
 
 
@@ -356,7 +356,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function txn_id_chq_nmbr() {
-		return $this->get( 'PAY_txn_id_chq_nmbr' );
+		return $this->get('PAY_txn_id_chq_nmbr');
 	}
 
 
@@ -368,7 +368,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function po_number() {
-		return $this->get( 'PAY_po_number' );
+		return $this->get('PAY_po_number');
 	}
 
 
@@ -380,7 +380,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function extra_accntng() {
-		return $this->get( 'PAY_extra_accntng' );
+		return $this->get('PAY_extra_accntng');
 	}
 
 
@@ -392,7 +392,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function payment_made_via_admin() {
-		return ( $this->get( 'PAY_source' ) === EEM_Payment_Method::scope_admin );
+		return ($this->get('PAY_source') === EEM_Payment_Method::scope_admin);
 	}
 
 
@@ -404,7 +404,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function details() {
-		return $this->get( 'PAY_details' );
+		return $this->get('PAY_details');
 	}
 
 
@@ -416,7 +416,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function redirect_url() {
-		return $this->get( 'PAY_redirect_url' );
+		return $this->get('PAY_redirect_url');
 	}
 
 
@@ -428,7 +428,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function redirect_args() {
-		return $this->get( 'PAY_redirect_args' );
+		return $this->get('PAY_redirect_args');
 	}
 
 
@@ -440,8 +440,8 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function e_pretty_status( $show_icons = false ) {
-		echo $this->pretty_status( $show_icons );
+	public function e_pretty_status($show_icons = false) {
+		echo $this->pretty_status($show_icons);
 	}
 
 
@@ -453,14 +453,14 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public function pretty_status( $show_icons = false ) {
+	public function pretty_status($show_icons = false) {
 		$status = EEM_Status::instance()->localized_status(
-			array( $this->STS_ID() => __( 'unknown', 'event_espresso' ) ),
+			array($this->STS_ID() => __('unknown', 'event_espresso')),
 			false,
 			'sentence'
 		);
 		$icon = '';
-		switch ( $this->STS_ID() ) {
+		switch ($this->STS_ID()) {
 			case EEM_Payment::status_id_approved:
 				$icon = $show_icons
 					? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
@@ -482,7 +482,7 @@ 
 					: '';
 				break;
 		}
-		return $icon . $status[ $this->STS_ID() ];
+		return $icon.$status[$this->STS_ID()];
 	}
 
 
@@ -494,7 +494,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_approved() {
-		return $this->status_is( EEM_Payment::status_id_approved );
+		return $this->status_is(EEM_Payment::status_id_approved);
 	}
 
 
@@ -508,7 +508,7 @@ 
 	 * @return boolean whether the status of this payment equals the status id
 	 * @throws \EE_Error
 	 */
-	protected function status_is( $STS_ID ) {
+	protected function status_is($STS_ID) {
 		return $STS_ID === $this->STS_ID() ? true : false;
 	}
 
@@ -521,7 +521,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_pending() {
-		return $this->status_is( EEM_Payment::status_id_pending );
+		return $this->status_is(EEM_Payment::status_id_pending);
 	}
 
 
@@ -533,7 +533,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_cancelled() {
-		return $this->status_is( EEM_Payment::status_id_cancelled );
+		return $this->status_is(EEM_Payment::status_id_cancelled);
 	}
 
 
@@ -545,7 +545,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_declined() {
-		return $this->status_is( EEM_Payment::status_id_declined );
+		return $this->status_is(EEM_Payment::status_id_declined);
 	}
 
 
@@ -557,7 +557,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_failed() {
-		return $this->status_is( EEM_Payment::status_id_failed );
+		return $this->status_is(EEM_Payment::status_id_failed);
 	}
 
 
@@ -581,7 +581,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function status_obj() {
-		return $this->get_first_related( 'Status' );
+		return $this->get_first_related('Status');
 	}
 
 
@@ -593,8 +593,8 @@ 
 	 * @return EE_Extra_Meta
 	 * @throws \EE_Error
 	 */
-	public function extra_meta( $query_params = array() ) {
-		return $this->get_many_related( 'Extra_Meta', $query_params );
+	public function extra_meta($query_params = array()) {
+		return $this->get_many_related('Extra_Meta', $query_params);
 	}
 
 
@@ -608,7 +608,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function payment_method() {
-		return $this->get_first_related( 'Payment_Method' );
+		return $this->get_first_related('Payment_Method');
 	}
 
 
@@ -626,18 +626,18 @@ 
 	 * @return string html
 	 * @throws \EE_Error
 	 */
-	public function redirect_form( $inside_form_html = null ) {
+	public function redirect_form($inside_form_html = null) {
 		$redirect_url = $this->redirect_url();
-		if ( ! empty( $redirect_url ) ) {
+		if ( ! empty($redirect_url)) {
 			// what ? no inner form content?
-			if ( $inside_form_html === null ) {
+			if ($inside_form_html === null) {
 				$inside_form_html = EEH_HTML::p(
 					sprintf(
 						__(
 							'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
 							'event_espresso'
 						),
-						EEH_HTML::br( 2 ),
+						EEH_HTML::br(2),
 						'<input type="submit" value="',
 						'">'
 					),
@@ -653,22 +653,22 @@ 
 			);
 			//if it's a GET request, we need to remove all the GET params in the querystring
 			//and put them into the form instead
-			if ( $method === 'GET' ) {
-				$querystring = parse_url( $redirect_url, PHP_URL_QUERY );
+			if ($method === 'GET') {
+				$querystring = parse_url($redirect_url, PHP_URL_QUERY);
 				$get_params = null;
-				parse_str( $querystring, $get_params );
-				$inside_form_html .= $this->_args_as_inputs( $get_params );
-				$redirect_url = str_replace( '?' . $querystring, '', $redirect_url );
+				parse_str($querystring, $get_params);
+				$inside_form_html .= $this->_args_as_inputs($get_params);
+				$redirect_url = str_replace('?'.$querystring, '', $redirect_url);
 			}
-			$form = EEH_HTML::nl( 1 )
+			$form = EEH_HTML::nl(1)
 			        . '<form method="'
 			        . $method
 			        . '" name="gateway_form" action="'
 			        . $redirect_url
 			        . '">';
-			$form .= EEH_HTML::nl( 1 ) . $this->redirect_args_as_inputs();
+			$form .= EEH_HTML::nl(1).$this->redirect_args_as_inputs();
 			$form .= $inside_form_html;
-			$form .= EEH_HTML::nl( -1 ) . '</form>' . EEH_HTML::nl( -1 );
+			$form .= EEH_HTML::nl( -1 ).'</form>'.EEH_HTML::nl( -1 );
 			return $form;
 		} else {
 			return null;
@@ -685,7 +685,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function redirect_args_as_inputs() {
-		return $this->_args_as_inputs( $this->redirect_args() );
+		return $this->_args_as_inputs($this->redirect_args());
 	}
 
 
@@ -697,15 +697,15 @@ 
 	 * @param array $args key-value pairs
 	 * @return string
 	 */
-	protected function _args_as_inputs( $args ) {
+	protected function _args_as_inputs($args) {
 		$html = '';
-		if ( $args !== null && is_array( $args ) ) {
-			foreach ( $args as $name => $value ) {
-				$html .= EEH_HTML::nl( 0 )
+		if ($args !== null && is_array($args)) {
+			foreach ($args as $name => $value) {
+				$html .= EEH_HTML::nl(0)
 				         . '<input type="hidden" name="'
 				         . $name
 				         . '" value="'
-				         . esc_attr( $value )
+				         . esc_attr($value)
 				         . '"/>';
 			}
 		}
@@ -734,14 +734,14 @@ 
 	 * @access private
 	 * @param mixed $item
 	 */
-	private function _strip_all_tags_within_array( &$item ) {
-		if ( is_object( $item ) ) {
-			$item = (array)$item;
+	private function _strip_all_tags_within_array(&$item) {
+		if (is_object($item)) {
+			$item = (array) $item;
 		}
-		if ( is_array( $item ) ) {
-			array_walk_recursive( $item, array( $this, '_strip_all_tags_within_array' ) );
+		if (is_array($item)) {
+			array_walk_recursive($item, array($this, '_strip_all_tags_within_array'));
 		} else {
-			$item = wp_strip_all_tags( $item );
+			$item = wp_strip_all_tags($item);
 		}
 	}
 
@@ -758,7 +758,7 @@ 
 		$original_status = EEH_Array::is_set(
 			$this->_props_n_values_provided_in_constructor,
 			'STS_ID',
-			$this->get_model()->field_settings_for( 'STS_ID' )->get_default_value()
+			$this->get_model()->field_settings_for('STS_ID')->get_default_value()
 		);
 		$current_status = $this->status();
 		if (
@@ -784,11 +784,11 @@ 
 	 * @return mixed
 	 * @throws \EE_Error
 	 */
-	public function get_pretty( $field_name, $extra_cache_ref = null ) {
-		if ( $field_name === 'PAY_gateway' ) {
-			return $this->payment_method() ? $this->payment_method()->name() : __( 'Unknown', 'event_espresso' );
+	public function get_pretty($field_name, $extra_cache_ref = null) {
+		if ($field_name === 'PAY_gateway') {
+			return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
 		}
-		return $this->_get_cached_property( $field_name, true, $extra_cache_ref );
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
 	}
 
 
@@ -800,8 +800,8 @@ 
 	 * @return EE_Registration_Payment[]
 	 * @throws \EE_Error
 	 */
-	public function registration_payments( $query_params = array() ) {
-		return $this->get_many_related( 'Registration_Payment', $query_params );
+	public function registration_payments($query_params = array()) {
+		return $this->get_many_related('Registration_Payment', $query_params);
 	}
 
 

core/db_classes/EE_Venue.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
 	 * @param array $props_n_values  incoming values from the database
 	 * @param string $timezone  incoming timezone as set by the model.  If not set the timezone for
 	 *                          		the website will be used.
-	 * @return EE_Attendee
+	 * @return EE_Venue
 	 */
 	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
 		return new self( $props_n_values, TRUE, $timezone );

Spacing +81 added lines, -81 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -37,9 +37,9 @@ 
 	 *                             		    date_format and the second value is the time format
 	 * @return EE_Attendee
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -50,8 +50,8 @@ 
 	 *                          		the website will be used.
 	 * @return EE_Attendee
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -61,7 +61,7 @@ 
 	 * @return string
 	 */
 	function name() {
-		return $this->get( 'VNU_name' );
+		return $this->get('VNU_name');
 	}
 
 
@@ -70,7 +70,7 @@ 
 	 * @return string
 	 */
 	function phone() {
-		return $this->get( 'VNU_phone' );
+		return $this->get('VNU_phone');
 	}
 
 
@@ -80,7 +80,7 @@ 
 	 * @return string
 	 */
 	function venue_url() {
-		return $this->get( 'VNU_url' );
+		return $this->get('VNU_url');
 	}
 
 
@@ -89,7 +89,7 @@ 
 	 * @return string
 	 */
 	function description() {
-		return $this->get( 'VNU_desc' );
+		return $this->get('VNU_desc');
 	}
 
 
@@ -99,7 +99,7 @@ 
 	 * @return string
 	 */
 	function excerpt() {
-		return $this->get( 'VNU_short_desc' );
+		return $this->get('VNU_short_desc');
 	}
 
 
@@ -109,7 +109,7 @@ 
 	 * @return string
 	 */
 	function identifier() {
-		return $this->get( 'VNU_identifier' );
+		return $this->get('VNU_identifier');
 	}
 
 
@@ -119,7 +119,7 @@ 
 	 * @return string
 	 */
 	function address() {
-		return $this->get( 'VNU_address' );
+		return $this->get('VNU_address');
 	}
 
 
@@ -129,7 +129,7 @@ 
 	 * @return string
 	 */
 	function address2() {
-		return $this->get( 'VNU_address2' );
+		return $this->get('VNU_address2');
 	}
 
 
@@ -140,7 +140,7 @@ 
 	 * @return string
 	 */
 	function city() {
-		return $this->get( 'VNU_city' );
+		return $this->get('VNU_city');
 	}
 
 	/**
@@ -148,7 +148,7 @@ 
 	 * @return int
 	 */
 	function state_ID() {
-		return $this->get( 'STA_ID' );
+		return $this->get('STA_ID');
 	}
 
 
@@ -166,7 +166,7 @@ 
 	 * @return string
 	 */
 	public function state_name() {
-		return $this->state_obj() instanceof EE_State ? $this->state_obj()->name() :  '';
+		return $this->state_obj() instanceof EE_State ? $this->state_obj()->name() : '';
 	}
 
 
@@ -176,7 +176,7 @@ 
 	 * @return EE_State
 	 */
 	function state_obj() {
-		return $this->get_first_related( 'State' );
+		return $this->get_first_related('State');
 	}
 
 
@@ -188,7 +188,7 @@ 
 	 * @return string
 	 */
 	public function state() {
-		if ( apply_filters( 'FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj() ) ) {
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
 			return $this->state_abbrev();
 		} else {
 			return $this->state_name();
@@ -202,7 +202,7 @@ 
 	 * @return string
 	 */
 	function country_ID() {
-		return $this->get( 'CNT_ISO' );
+		return $this->get('CNT_ISO');
 	}
 
 
@@ -211,7 +211,7 @@ 
 	 * @return string
 	 */
 	public function country_name() {
-		return $this->country_obj() instanceof EE_Country ? $this->country_obj()->name() :  '';
+		return $this->country_obj() instanceof EE_Country ? $this->country_obj()->name() : '';
 	}
 
 
@@ -221,7 +221,7 @@ 
 	 * @return EE_Country
 	 */
 	function country_obj() {
-		return $this->get_first_related( 'Country' );
+		return $this->get_first_related('Country');
 	}
 
 
@@ -233,7 +233,7 @@ 
 	 * @return string
 	 */
 	public function country() {
-		if ( apply_filters( 'FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj() ) ) {
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
 			return $this->country_ID();
 		} else {
 			return $this->country_name();
@@ -247,7 +247,7 @@ 
 	 * @return string
 	 */
 	function zip() {
-		return $this->get( 'VNU_zip' );
+		return $this->get('VNU_zip');
 	}
 
 
@@ -257,7 +257,7 @@ 
 	 * @return int
 	 */
 	function capacity() {
-		return $this->get_pretty( 'VNU_capacity', 'symbol' );
+		return $this->get_pretty('VNU_capacity', 'symbol');
 	}
 
 
@@ -267,7 +267,7 @@ 
 	 * @return string
 	 */
 	function created() {
-		return $this->get( 'VNU_created' );
+		return $this->get('VNU_created');
 	}
 
 
@@ -277,7 +277,7 @@ 
 	 * @return string
 	 */
 	function modified() {
-		return $this->get( 'VNU_modified' );
+		return $this->get('VNU_modified');
 	}
 
 
@@ -287,7 +287,7 @@ 
 	 * @return int
 	 */
 	function order() {
-		return $this->get( 'VNU_order' );
+		return $this->get('VNU_order');
 	}
 
 
@@ -297,7 +297,7 @@ 
 	 * @return int
 	 */
 	function wp_user() {
-		return $this->get( 'VNU_wp_user' );
+		return $this->get('VNU_wp_user');
 	}
 
 
@@ -306,7 +306,7 @@ 
 	 * @return string
 	 */
 	function virtual_phone() {
-		return $this->get( 'VNU_virtual_phone' );
+		return $this->get('VNU_virtual_phone');
 	}
 
 
@@ -315,7 +315,7 @@ 
 	 * @return string
 	 */
 	function virtual_url() {
-		return $this->get( 'VNU_virtual_url' );
+		return $this->get('VNU_virtual_url');
 	}
 
 
@@ -324,7 +324,7 @@ 
 	 * @return bool
 	 */
 	function enable_for_gmap() {
-		return $this->get( 'VNU_enable_for_gmap' );
+		return $this->get('VNU_enable_for_gmap');
 	}
 
 
@@ -333,7 +333,7 @@ 
 	 * @return string
 	 */
 	function google_map_link() {
-		return $this->get( 'VNU_google_map_link' );
+		return $this->get('VNU_google_map_link');
 	}
 
 
@@ -345,16 +345,16 @@ 
 	 * @param bool  $upcoming
 	 * @return EE_Event[]
 	 */
-	function events( $query_params = array(), $upcoming = FALSE ) {
-		if ( $upcoming ) {
+	function events($query_params = array(), $upcoming = FALSE) {
+		if ($upcoming) {
 			$query_params = array(
 				array(
 					'status' => 'publish',
-					'Datetime.DTT_EVT_start' => array( '>',  EEM_Datetime::instance()->current_time_for_query( 'DTT_EVT_start' ) )
+					'Datetime.DTT_EVT_start' => array('>', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'))
 				)
 			);
 		}
-		return $this->get_many_related( 'Event', $query_params );
+		return $this->get_many_related('Event', $query_params);
 	}
 
 
@@ -372,8 +372,8 @@ 
 	/**
 	 * Sets address
 	 */
-	function set_address( $address = '' ) {
-		$this->set( 'VNU_address', $address );
+	function set_address($address = '') {
+		$this->set('VNU_address', $address);
 	}
 
 
@@ -381,8 +381,8 @@ 
 	/**
 	 * @param string $address2
 	 */
-	function set_address2( $address2 = '' ) {
-		$this->set( 'VNU_address2', $address2 );
+	function set_address2($address2 = '') {
+		$this->set('VNU_address2', $address2);
 	}
 
 
@@ -390,8 +390,8 @@ 
 	/**
 	 * @param string $city
 	 */
-	function set_city( $city = '' ) {
-		$this->set( 'VNU_city', $city );
+	function set_city($city = '') {
+		$this->set('VNU_city', $city);
 	}
 
 
@@ -399,8 +399,8 @@ 
 	/**
 	 * @param int $state
 	 */
-	function set_state_ID( $state = 0 ) {
-		$this->set( 'STA_ID', $state );
+	function set_state_ID($state = 0) {
+		$this->set('STA_ID', $state);
 	}
 
 
@@ -411,8 +411,8 @@ 
 	 * @param EE_State /int $state_id_or_obj
 	 * @return EE_State
 	 */
-	function set_state_obj( $state_id_or_obj ) {
-		return $this->_add_relation_to( $state_id_or_obj, 'State' );
+	function set_state_obj($state_id_or_obj) {
+		return $this->_add_relation_to($state_id_or_obj, 'State');
 	}
 
 
@@ -420,8 +420,8 @@ 
 	/**
 	 * @param int $country_ID
 	 */
-	function set_country_ID( $country_ID = 0 ) {
-		$this->set( 'CNT_ISO', $country_ID );
+	function set_country_ID($country_ID = 0) {
+		$this->set('CNT_ISO', $country_ID);
 	}
 
 
@@ -430,7 +430,7 @@ 
 	 * @param EE_Country /string $country_id_or_obj
 	 * @return EE_Country
 	 */
-	function set_country_obj( $country_id_or_obj ) {
+	function set_country_obj($country_id_or_obj) {
 		return $this->_add_relation_to($country_id_or_obj, 'Country');
 	}
 
@@ -439,8 +439,8 @@ 
 	/**
 	 * @param string $zip
 	 */
-	function set_zip( $zip = '' ) {
-		$this->set( 'VNU_zip', $zip );
+	function set_zip($zip = '') {
+		$this->set('VNU_zip', $zip);
 	}
 
 
@@ -448,8 +448,8 @@ 
 	/**
 	 * @param int $capacity
 	 */
-	function set_capacity( $capacity = 0 ) {
-		$this->set( 'VNU_capacity', $capacity );
+	function set_capacity($capacity = 0) {
+		$this->set('VNU_capacity', $capacity);
 	}
 
 
@@ -457,8 +457,8 @@ 
 	/**
 	 * @param string $created
 	 */
-	function set_created( $created = '' ) {
-		$this->set( 'VNU_created', $created );
+	function set_created($created = '') {
+		$this->set('VNU_created', $created);
 	}
 
 
@@ -466,8 +466,8 @@ 
 	/**
 	 * @param string $desc
 	 */
-	function set_description( $desc = '' ) {
-		$this->set( 'VNU_desc', $desc );
+	function set_description($desc = '') {
+		$this->set('VNU_desc', $desc);
 	}
 
 
@@ -475,8 +475,8 @@ 
 	/**
 	 * @param string $identifier
 	 */
-	function set_identifier( $identifier = '' ) {
-		$this->set( 'VNU_identifier', $identifier );
+	function set_identifier($identifier = '') {
+		$this->set('VNU_identifier', $identifier);
 	}
 
 
@@ -484,8 +484,8 @@ 
 	/**
 	 * @param string $modified
 	 */
-	function set_modified( $modified = '' ) {
-		$this->set( 'VNU_modified', $modified );
+	function set_modified($modified = '') {
+		$this->set('VNU_modified', $modified);
 	}
 
 
@@ -493,8 +493,8 @@ 
 	/**
 	 * @param string $name
 	 */
-	function set_name( $name = '' ) {
-		$this->set( 'VNU_name', $name );
+	function set_name($name = '') {
+		$this->set('VNU_name', $name);
 	}
 
 
@@ -502,8 +502,8 @@ 
 	/**
 	 * @param int $order
 	 */
-	function set_order( $order = 0 ) {
-		$this->set( 'VNU_order', $order );
+	function set_order($order = 0) {
+		$this->set('VNU_order', $order);
 	}
 
 
@@ -511,8 +511,8 @@ 
 	/**
 	 * @param string $phone
 	 */
-	function set_phone( $phone = '' ) {
-		$this->set( 'VNU_phone', $phone );
+	function set_phone($phone = '') {
+		$this->set('VNU_phone', $phone);
 	}
 
 
@@ -520,8 +520,8 @@ 
 	/**
 	 * @param int $wp_user
 	 */
-	function set_wp_user( $wp_user = 1 ) {
-		$this->set( 'VNU_wp_user', $wp_user );
+	function set_wp_user($wp_user = 1) {
+		$this->set('VNU_wp_user', $wp_user);
 	}
 
 
@@ -529,8 +529,8 @@ 
 	/**
 	 * @param string $url
 	 */
-	function set_venue_url( $url = '' ) {
-		$this->set( 'VNU_url', $url );
+	function set_venue_url($url = '') {
+		$this->set('VNU_url', $url);
 	}
 
 
@@ -538,8 +538,8 @@ 
 	/**
 	 * @param string $phone
 	 */
-	function set_virtual_phone( $phone = '' ) {
-		$this->set( 'VNU_virtual_phone', $phone );
+	function set_virtual_phone($phone = '') {
+		$this->set('VNU_virtual_phone', $phone);
 	}
 
 
@@ -547,8 +547,8 @@ 
 	/**
 	 * @param string $url
 	 */
-	function set_virtual_url( $url = '' ) {
-		$this->set( 'VNU_virtual_url', $url );
+	function set_virtual_url($url = '') {
+		$this->set('VNU_virtual_url', $url);
 	}
 
 
@@ -556,8 +556,8 @@ 
 	/**
 	 * @param string $enable
 	 */
-	function set_enable_for_gmap( $enable = '' ) {
-		$this->set( 'VNU_enable_for_gmap', $enable );
+	function set_enable_for_gmap($enable = '') {
+		$this->set('VNU_enable_for_gmap', $enable);
 	}
 
 
@@ -565,8 +565,8 @@ 
 	/**
 	 * @param string $google_map_link
 	 */
-	function set_google_map_link( $google_map_link = '' ) {
-		$this->set( 'VNU_google_map_link', $google_map_link );
+	function set_google_map_link($google_map_link = '') {
+		$this->set('VNU_google_map_link', $google_map_link);
 	}
 
 

core/interfaces/EEI_Interfaces.php

Indentation +22 added lines, -22 removed lines

@@ -310,23 +310,23 @@ 
 	 * @param float $amount
 	 * @param string $name
 	 * @param string $description
-         * @param string $code
-         * @param boolean $add_to_existing_line_item if true and a duplicate line item with
-         *  the same code is found, $amount will be added onto it; otherwise will simply
-         *  set the taxes to match $amount
+	 * @param string $code
+	 * @param boolean $add_to_existing_line_item if true and a duplicate line item with
+	 *  the same code is found, $amount will be added onto it; otherwise will simply
+	 *  set the taxes to match $amount
 	 * @return EE_Line_Item the new tax created
 	 */
 	public function set_total_tax_to( EE_Line_Item $total_line_item, $amount, $name  = NULL, $description = NULL, $code = NULL, $add_to_existing_line_item = false );
 
-         /**
-         * Makes all the line items which are children of $line_item taxable (or not).
-         * Does NOT save the line items
-         * @param EE_Line_Item $line_item
-         * @param boolean $taxable
-         * @param string $code_substring_for_whitelist if this string is part of the line item's code
-         *  it will be whitelisted (ie, except from becoming taxable)
-         */
-        public static function set_line_items_taxable( EE_Line_Item $line_item, $taxable = true, $code_substring_for_whitelist = null );
+		 /**
+		  * Makes all the line items which are children of $line_item taxable (or not).
+		  * Does NOT save the line items
+		  * @param EE_Line_Item $line_item
+		  * @param boolean $taxable
+		  * @param string $code_substring_for_whitelist if this string is part of the line item's code
+		  *  it will be whitelisted (ie, except from becoming taxable)
+		  */
+		public static function set_line_items_taxable( EE_Line_Item $line_item, $taxable = true, $code_substring_for_whitelist = null );
 
 	/**
 	 * Adds a simple item ( unrelated to any other model object) to the total line item,
@@ -356,15 +356,15 @@ 
  */
 interface EEHI_Money{
 		/**
-	 * For comparing floats. Default operator is '=', but see the $operator below for all options.
-	 * This should be used to compare floats instead of normal '==' because floats
-	 * are inherently imprecise, and so you can sometimes have two floats that appear to be identical
-	 * but actually differ by 0.00000001.
-	 * @param float $float1
-	 * @param float $float2
-	 * @param string $operator  The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
-	 * @return boolean whether the equation is true or false
-	 */
+		 * For comparing floats. Default operator is '=', but see the $operator below for all options.
+		 * This should be used to compare floats instead of normal '==' because floats
+		 * are inherently imprecise, and so you can sometimes have two floats that appear to be identical
+		 * but actually differ by 0.00000001.
+		 * @param float $float1
+		 * @param float $float2
+		 * @param string $operator  The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
+		 * @return boolean whether the equation is true or false
+		 */
 	public function compare_floats( $float1, $float2, $operator='=' );
 }
 

Spacing +21 added lines, -21 removed lines

@@ -5,7 +5,7 @@ 
 /**
  * Interface EEI_Base
  */
-interface EEI_Base{
+interface EEI_Base {
 	/**
 	 * gets the unique ID of the model object. If it hasn't been saved yet
 	 * to the database, this should be 0 or NULL
@@ -32,7 +32,7 @@ 
 	 * @return int records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
 	 * NOTE: if the values haven't changed, returns 0
 	 */
-	public function update_extra_meta($meta_key,$meta_value,$previous_value = NULL);
+	public function update_extra_meta($meta_key, $meta_value, $previous_value = NULL);
 
 	/**
 	 * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
@@ -43,7 +43,7 @@ 
 	 * @param boolean $unique
 	 * @return boolean
 	 */
-	public function add_extra_meta($meta_key,$meta_value,$unique = false);
+	public function add_extra_meta($meta_key, $meta_value, $unique = false);
 
 	/**
 	 * Deletes all the extra meta rows for this record as specified by key. If $meta_value
@@ -52,7 +52,7 @@ 
 	 * @param string $meta_value
 	 * @return int number of extra meta rows deleted
 	 */
-	public function delete_extra_meta($meta_key,$meta_value = NULL);
+	public function delete_extra_meta($meta_key, $meta_value = NULL);
 
 	/**
 	 * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
@@ -63,7 +63,7 @@ 
 	 * @param mixed $default if we don't find anything, what should we return?
 	 * @return mixed single value if $single; array if ! $single
 	 */
-	public function get_extra_meta($meta_key,$single = FALSE,$default = NULL);
+	public function get_extra_meta($meta_key, $single = FALSE, $default = NULL);
 }
 
 
@@ -90,7 +90,7 @@ 
 	 * @param 	EE_Response $response
 	 * @return 	EE_Response
 	 */
-	public function handle_request( EE_Request $request, EE_Response $response );
+	public function handle_request(EE_Request $request, EE_Response $response);
 }
 
 
@@ -106,7 +106,7 @@ 
 	 * @param EE_Request $request
 	 * @param EE_Response $response
 	 */
-	public function handle_response( EE_Request $request, EE_Response $response );
+	public function handle_response(EE_Request $request, EE_Response $response);
 }
 
 
@@ -286,7 +286,7 @@ 
 	 * @param string $country
 	 * @param string $CNT_ISO
 	 */
-	public function format( $address, $address2, $city, $state, $zip, $country, $CNT_ISO );
+	public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO);
 }
 
 
@@ -296,13 +296,13 @@ 
 /**
  * Interface EEHI_Line_Item
  */
-interface EEHI_Line_Item{
+interface EEHI_Line_Item {
 	/**
 	 * Adds an item to the purchase in the right spot
 	 * @param EE_Line_Item $total_line_item
 	 * @param EE_Line_Item $line_item
 	 */
-	public function add_item( EE_Line_Item $total_line_item, EE_Line_Item $line_item );
+	public function add_item(EE_Line_Item $total_line_item, EE_Line_Item $line_item);
 	/**
 	 * Overwrites the previous tax by clearing out the old taxes, and creates a new
 	 * tax and updates the total line item accordingly
@@ -316,7 +316,7 @@ 
          *  set the taxes to match $amount
 	 * @return EE_Line_Item the new tax created
 	 */
-	public function set_total_tax_to( EE_Line_Item $total_line_item, $amount, $name  = NULL, $description = NULL, $code = NULL, $add_to_existing_line_item = false );
+	public function set_total_tax_to(EE_Line_Item $total_line_item, $amount, $name = NULL, $description = NULL, $code = NULL, $add_to_existing_line_item = false);
 
          /**
          * Makes all the line items which are children of $line_item taxable (or not).
@@ -326,7 +326,7 @@ 
          * @param string $code_substring_for_whitelist if this string is part of the line item's code
          *  it will be whitelisted (ie, except from becoming taxable)
          */
-        public static function set_line_items_taxable( EE_Line_Item $line_item, $taxable = true, $code_substring_for_whitelist = null );
+        public static function set_line_items_taxable(EE_Line_Item $line_item, $taxable = true, $code_substring_for_whitelist = null);
 
 	/**
 	 * Adds a simple item ( unrelated to any other model object) to the total line item,
@@ -340,21 +340,21 @@ 
 	 * @param boolean $code if set to a value, ensures there is only one line item with that code
 	 * @return boolean success
 	 */
-	public function add_unrelated_item( EE_Line_Item $total_line_item, $name, $unit_price, $description = '', $quantity = 1, $taxable = FALSE, $code = null );
+	public function add_unrelated_item(EE_Line_Item $total_line_item, $name, $unit_price, $description = '', $quantity = 1, $taxable = FALSE, $code = null);
 
 	/**
 	 * Gets the line item for the taxes subtotal
 	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
 	 * @return \EE_Line_Item
 	 */
-	public static function get_taxes_subtotal( EE_Line_Item $total_line_item );
+	public static function get_taxes_subtotal(EE_Line_Item $total_line_item);
 }
 
 
 /**
  * Money-related helper
  */
-interface EEHI_Money{
+interface EEHI_Money {
 		/**
 	 * For comparing floats. Default operator is '=', but see the $operator below for all options.
 	 * This should be used to compare floats instead of normal '==' because floats
@@ -365,13 +365,13 @@ 
 	 * @param string $operator  The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
 	 * @return boolean whether the equation is true or false
 	 */
-	public function compare_floats( $float1, $float2, $operator='=' );
+	public function compare_floats($float1, $float2, $operator = '=');
 }
 
 /**
  * Interface EEHI_Template
  */
-interface EEHI_Template{
+interface EEHI_Template {
 
 	/**
 	 * EEH_Template::format_currency
@@ -384,7 +384,7 @@ 
 	 * @param string   $cur_code_span_class
 	 * @return string the html output for the formatted money value
 	 */
-	public static function format_currency( $amount = NULL, $return_raw = FALSE, $display_code = TRUE, $CNT_ISO = '', $cur_code_span_class = 'currency-code' );
+	public static function format_currency($amount = NULL, $return_raw = FALSE, $display_code = TRUE, $CNT_ISO = '', $cur_code_span_class = 'currency-code');
 }
 
 
@@ -399,7 +399,7 @@ 
 	 * @param array $options
 	 * @return mixed
 	 */
-	public function display_line_item( EE_Line_Item $line_item, $options = array() );
+	public function display_line_item(EE_Line_Item $line_item, $options = array());
 
 }
 
@@ -416,7 +416,7 @@ 
 	 * @throws EE_Error
 	 * @return bool
 	 */
-	public static function ensure_file_exists_and_is_writable( $full_file_path = '' );
+	public static function ensure_file_exists_and_is_writable($full_file_path = '');
 
 	/**
 	 * ensure_folder_exists_and_is_writable
@@ -425,7 +425,7 @@ 
 	 * @throws EE_Error
 	 * @return bool
 	 */
-	public static function ensure_folder_exists_and_is_writable( $folder = '' );
+	public static function ensure_folder_exists_and_is_writable($folder = '');
 }
 
 // End of file EEI_Interfaces.php

core/db_models/relations/EE_Model_Relation_Base.php

Indentation +2 added lines, -2 removed lines

@@ -151,8 +151,8 @@
 		}
 		$query_params = $this->_disable_default_where_conditions_on_query_param($query_params);
 		$query_param_where_this_model_pk = $this->get_this_model()->get_this_model_name()
-		                                   . "."
-		                                   . $this->get_this_model()->get_primary_key_field()->get_name();
+										   . "."
+										   . $this->get_this_model()->get_primary_key_field()->get_name();
 		$model_object_id = $this->_get_model_object_id( $model_object_or_id );
 		$query_params[0][$query_param_where_this_model_pk] = $model_object_id;
 		return $this->get_other_model()->get_all($query_params);

Spacing +45 added lines, -45 removed lines

@@ -13,7 +13,7 @@ 
  * @subpackage    core
  * @author        Michael Nelson
  */
-abstract class EE_Model_Relation_Base{
+abstract class EE_Model_Relation_Base {
 	/**
 	 * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
 	 * @var string eg Event, Question_Group, Registration
@@ -48,9 +48,9 @@ 
 	 * @param boolean $block_deletes if there are related models across this relation, block (prevent and add an error) the deletion of this model
 	 * @param string $blocking_delete_error_message a customized error message on blocking deletes instead of the default
 	 */
-	public function __construct($block_deletes, $blocking_delete_error_message){
+	public function __construct($block_deletes, $blocking_delete_error_message) {
 		$this->_blocking_delete = $block_deletes;
-		$this->_blocking_delete_error_message=$blocking_delete_error_message;
+		$this->_blocking_delete_error_message = $blocking_delete_error_message;
 	}
 
 
@@ -60,12 +60,12 @@ 
 	 * @param $other_model_name
 	 * @throws EE_Error
 	 */
-	public function _construct_finalize_set_models($this_model_name, $other_model_name){
+	public function _construct_finalize_set_models($this_model_name, $other_model_name) {
 		$this->_this_model_name = $this_model_name;
 		$this->_other_model_name = $other_model_name;
-		if(is_string($this->_blocking_delete)){
+		if (is_string($this->_blocking_delete)) {
 			throw new EE_Error(sprintf(__("When instantiating the relation of type %s from %s to %s, the \$block_deletes argument should be a boolean, not a string (%s)", "event_espresso"),
-						get_class($this),$this_model_name,$other_model_name,$this->_blocking_delete));
+						get_class($this), $this_model_name, $other_model_name, $this->_blocking_delete));
 		}
 	}
 
@@ -75,7 +75,7 @@ 
 	 * Gets the model where this relation is defined.
 	 * @return EEM_Base
 	 */
-	public function get_this_model(){
+	public function get_this_model() {
 		return $this->_get_model($this->_this_model_name);
 	}
 
@@ -86,7 +86,7 @@ 
 	 * this relation object was defined on get_this_model(), get_other_model() is the other one)
 	 * @return EEM_Base
 	 */
-	public function get_other_model(){
+	public function get_other_model() {
 		return $this->_get_model($this->_other_model_name);
 	}
 
@@ -97,9 +97,9 @@ 
 	 * @param string $model_name like Event, Question_Group, etc. omit the EEM_
 	 * @return EEM_Base
 	 */
-	protected function _get_model($model_name){
-		$modelInstance = EE_Registry::instance()->load_model( $model_name );
-		$modelInstance->set_timezone( $this->_timezone );
+	protected function _get_model($model_name) {
+		$modelInstance = EE_Registry::instance()->load_model($model_name);
+		$modelInstance->set_timezone($this->_timezone);
 		return $modelInstance;
 	}
 
@@ -109,8 +109,8 @@ 
 	 * entirely possible that relations may be called from a model and we need to make sure those relations have their timezone set correctly.
 	 * @param string $timezone timezone to set.
 	 */
-	public function set_timezone( $timezone ) {
-		if($timezone !== NULL){
+	public function set_timezone($timezone) {
+		if ($timezone !== NULL) {
 			$this->_timezone = $timezone;
 		}
 	}
@@ -126,8 +126,8 @@ 
 	 * @param string $extra_join_sql
 	 * @return string
 	 */
-	protected function _left_join($other_table,$other_table_alias,$other_table_column,$this_table_alias,$this_table_join_column, $extra_join_sql = ''){
-		return " LEFT JOIN ".$other_table." AS ".$other_table_alias. " ON ".$other_table_alias.".".$other_table_column."=".$this_table_alias.".".$this_table_join_column. ($extra_join_sql ? " AND $extra_join_sql" : '');
+	protected function _left_join($other_table, $other_table_alias, $other_table_column, $this_table_alias, $this_table_join_column, $extra_join_sql = '') {
+		return " LEFT JOIN ".$other_table." AS ".$other_table_alias." ON ".$other_table_alias.".".$other_table_column."=".$this_table_alias.".".$this_table_join_column.($extra_join_sql ? " AND $extra_join_sql" : '');
 	}
 
 
@@ -145,15 +145,15 @@ 
 	 * @return EE_Base_Class[]
 	 * @throws \EE_Error
 	 */
-	public function get_all_related($model_object_or_id, $query_params = array(), $values_already_prepared_by_model_object = false ){
-		if( $values_already_prepared_by_model_object !== false ) {
-			EE_Error::doing_it_wrong( 'EE_Model_Relation_Base::get_all_related', __( 'The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso' ), '4.8.1' );
+	public function get_all_related($model_object_or_id, $query_params = array(), $values_already_prepared_by_model_object = false) {
+		if ($values_already_prepared_by_model_object !== false) {
+			EE_Error::doing_it_wrong('EE_Model_Relation_Base::get_all_related', __('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'), '4.8.1');
 		}
 		$query_params = $this->_disable_default_where_conditions_on_query_param($query_params);
 		$query_param_where_this_model_pk = $this->get_this_model()->get_this_model_name()
 		                                   . "."
 		                                   . $this->get_this_model()->get_primary_key_field()->get_name();
-		$model_object_id = $this->_get_model_object_id( $model_object_or_id );
+		$model_object_id = $this->_get_model_object_id($model_object_or_id);
 		$query_params[0][$query_param_where_this_model_pk] = $model_object_id;
 		return $this->get_other_model()->get_all($query_params);
 	}
@@ -165,9 +165,9 @@ 
 	 * @param string $query_params
 	 * @return array
 	 */
-	protected function _disable_default_where_conditions_on_query_param($query_params){
-		if( ! isset($query_params['default_where_conditions'])){
-			$query_params['default_where_conditions']='none';
+	protected function _disable_default_where_conditions_on_query_param($query_params) {
+		if ( ! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'none';
 		}
 		return $query_params;
 	}
@@ -185,15 +185,15 @@ 
 	 * @return int of how many related models got deleted
 	 * @throws \EE_Error
 	 */
-	public function delete_all_related($model_object_or_id,$query_params = array()){
+	public function delete_all_related($model_object_or_id, $query_params = array()) {
 		//for each thing we would delete,
-		$related_model_objects = $this->get_all_related($model_object_or_id,$query_params);
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
 		//determine if it's blocked by anything else before it can be deleted
 		$deleted_count = 0;
-		foreach($related_model_objects as $related_model_object){
+		foreach ($related_model_objects as $related_model_object) {
 			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models($related_model_object, $model_object_or_id);
 			/* @var $model_object_or_id EE_Base_Class */
-			if( ! $delete_is_blocked ){
+			if ( ! $delete_is_blocked) {
 				$this->remove_relation_to($model_object_or_id, $related_model_object);
 				$related_model_object->delete();
 				$deleted_count++;
@@ -215,27 +215,27 @@ 
 	 * @return int of how many related models got deleted
 	 * @throws \EE_Error
 	 */
-	public function delete_related_permanently($model_object_or_id,$query_params = array()){
+	public function delete_related_permanently($model_object_or_id, $query_params = array()) {
 		//for each thing we would delete,
-		$related_model_objects = $this->get_all_related($model_object_or_id,$query_params);
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
 		//determine if it's blocked by anything else before it can be deleted
 		$deleted_count = 0;
-		foreach($related_model_objects as $related_model_object){
+		foreach ($related_model_objects as $related_model_object) {
 			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models($related_model_object, $model_object_or_id);
 			/* @var $model_object_or_id EE_Base_Class */
-			if( $related_model_object instanceof EE_Soft_Delete_Base_Class ){
+			if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
 				$this->remove_relation_to($model_object_or_id, $related_model_object);
 				$deleted_count++;
-				if( ! $delete_is_blocked ){
+				if ( ! $delete_is_blocked) {
 					$related_model_object->delete_permanently();
-				}else{
+				} else {
 					//delete is blocked
 					//brent and darren, in this case, wanted to just soft delete it then
 					$related_model_object->delete();
 				}
-			}else{
+			} else {
 				//its not a soft-deletable thing anyways. do the normal logic.
-				if( ! $delete_is_blocked ){
+				if ( ! $delete_is_blocked) {
 					$this->remove_relation_to($model_object_or_id, $related_model_object);
 					$related_model_object->delete();
 					$deleted_count++;
@@ -255,11 +255,11 @@ 
 	 */
 	protected function _get_model_object_id($model_object_or_id) {
 		$model_object_id = $model_object_or_id;
-		if($model_object_or_id instanceof EE_Base_Class){
+		if ($model_object_or_id instanceof EE_Base_Class) {
 			$model_object_id = $model_object_or_id->ID();
 		}
-		if( ! $model_object_id){
-			throw new EE_Error(sprintf(__("Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects", "event_espresso"),$this->get_other_model()->get_this_model_name(),$this->get_this_model()->get_this_model_name()));
+		if ( ! $model_object_id) {
+			throw new EE_Error(sprintf(__("Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects", "event_espresso"), $this->get_other_model()->get_this_model_name(), $this->get_this_model()->get_this_model_name()));
 		}
 		return $model_object_id;
 	}
@@ -313,10 +313,10 @@ 
 	 * @return EE_Base_Class[]
 	 * @throws \EE_Error
 	 */
-	public function remove_relations($this_obj_or_id,$where_query_param = array()){
-		$related_things = $this->get_all_related($this_obj_or_id,array($where_query_param));
+	public function remove_relations($this_obj_or_id, $where_query_param = array()) {
+		$related_things = $this->get_all_related($this_obj_or_id, array($where_query_param));
 		$objs_removed = array();
-		foreach($related_things as $related_thing){
+		foreach ($related_things as $related_thing) {
 			$objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
 		}
 		return $objs_removed;
@@ -329,7 +329,7 @@ 
 	 * related objects exist, returns false.
 	 * @return boolean
 	 */
-	public function block_delete_if_related_models_exist(){
+	public function block_delete_if_related_models_exist() {
 		return $this->_blocking_delete;
 	}
 
@@ -338,13 +338,13 @@ 
 	 * Gets the error message to show
 	 * @return string
 	 */
-	public function get_deletion_error_message(){
-		if($this->_blocking_delete_error_message){
+	public function get_deletion_error_message() {
+		if ($this->_blocking_delete_error_message) {
 			return $this->_blocking_delete_error_message;
-		}else{
+		} else {
 //			return sprintf(__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2));
 			return sprintf(
-				__( 'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.', "event_espresso"),
+				__('This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.', "event_espresso"),
 				$this->get_this_model()->item_name(1),
 				$this->get_other_model()->item_name(1),
 				$this->get_other_model()->item_name(2)

Braces +3 added lines, -3 removed lines

@@ -228,12 +228,12 @@ 
 				$deleted_count++;
 				if( ! $delete_is_blocked ){
 					$related_model_object->delete_permanently();
-				}else{
+				} else{
 					//delete is blocked
 					//brent and darren, in this case, wanted to just soft delete it then
 					$related_model_object->delete();
 				}
-			}else{
+			} else{
 				//its not a soft-deletable thing anyways. do the normal logic.
 				if( ! $delete_is_blocked ){
 					$this->remove_relation_to($model_object_or_id, $related_model_object);
@@ -341,7 +341,7 @@ 
 	public function get_deletion_error_message(){
 		if($this->_blocking_delete_error_message){
 			return $this->_blocking_delete_error_message;
-		}else{
+		} else{
 //			return sprintf(__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2));
 			return sprintf(
 				__( 'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.', "event_espresso"),

Doc Comments +5 added lines, -5 removed lines

@@ -119,9 +119,9 @@ 
 
 	/**
 	 * @param        $other_table
-	 * @param        $other_table_alias
+	 * @param        string $other_table_alias
 	 * @param        $other_table_column
-	 * @param        $this_table_alias
+	 * @param        string $this_table_alias
 	 * @param        $this_table_join_column
 	 * @param string $extra_join_sql
 	 * @return string
@@ -163,7 +163,7 @@ 
 	/**
 	 * Alters the $query_params to disable default where conditions, unless otherwise specified
 	 * @param string $query_params
-	 * @return array
+	 * @return string
 	 */
 	protected function _disable_default_where_conditions_on_query_param($query_params){
 		if( ! isset($query_params['default_where_conditions'])){
@@ -180,7 +180,7 @@ 
 	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
 	 * model objects will only be soft-deleted.
 	 *
-	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param EE_Base_Class|null $model_object_or_id
 	 * @param array                    $query_params
 	 * @return int of how many related models got deleted
 	 * @throws \EE_Error
@@ -210,7 +210,7 @@ 
 	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
 	 * model objects will only be soft-deleted.
 	 *
-	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param EE_Base_Class|null $model_object_or_id
 	 * @param array                    $query_params
 	 * @return int of how many related models got deleted
 	 * @throws \EE_Error

core/db_models/relations/EE_HABTM_Relation.php

Spacing +30 added lines, -30 removed lines

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

core/db_models/relations/EE_HABTM_Any_Relation.php

Spacing +35 added lines, -35 removed lines

@@ -8,7 +8,7 @@ 
  * @subpackage    core
  * @author        Michael Nelson
  */
-class EE_HABTM_Any_Relation extends EE_HABTM_Relation{
+class EE_HABTM_Any_Relation extends EE_HABTM_Relation {
 	/**
 	 *
 	 * @var string
@@ -22,8 +22,8 @@ 
 	 * @param boolean $block_deletes for this type of relation, we block by default for now. if there are related models across this relation, block (prevent and add an error) the deletion of this model
 	 * @param string $blocking_delete_error_message a customized error message on blocking deletes instead of the default
 	 */
-	public function __construct( $block_deletes = true, $blocking_delete_error_message =''){
-		parent::__construct( 'Extra_Join', $block_deletes, $blocking_delete_error_message);
+	public function __construct($block_deletes = true, $blocking_delete_error_message = '') {
+		parent::__construct('Extra_Join', $block_deletes, $blocking_delete_error_message);
 	}
 
 
@@ -33,13 +33,13 @@ 
 	 * @param $other_model_name
 	 * @throws EE_Error
 	 */
-	public function _construct_finalize_set_models( $this_model_name, $other_model_name){
-		if( $this_model_name < $other_model_name ) {
+	public function _construct_finalize_set_models($this_model_name, $other_model_name) {
+		if ($this_model_name < $other_model_name) {
 			$this->_alphabetically_first_model_name = $this_model_name;
-		} else{
+		} else {
 			$this->_alphabetically_first_model_name = $other_model_name;
 		}
-		parent::_construct_finalize_set_models( $this_model_name, $other_model_name );
+		parent::_construct_finalize_set_models($this_model_name, $other_model_name);
 	}
 
 
@@ -50,14 +50,14 @@ 
 	 * @return EE_Model_Field_Base
 	 * @throws \EE_Error
 	 */
-	public function get_join_table_fk_field_to( $model_name, $id_or_name_field ) {
+	public function get_join_table_fk_field_to($model_name, $id_or_name_field) {
 		$order = null;
-		if( $model_name === $this->_alphabetically_first_model_name ) {
+		if ($model_name === $this->_alphabetically_first_model_name) {
 			$order = 'first';
 		} else {
 			$order = 'second';
 		}
-		return $this->get_join_model()->field_settings_for( 'EXJ_' . $order . '_model_' . $id_or_name_field );
+		return $this->get_join_model()->field_settings_for('EXJ_'.$order.'_model_'.$id_or_name_field);
 	}
 
 
@@ -69,7 +69,7 @@ 
 	 * @return string of SQL
 	 * @throws \EE_Error
 	 */
-	public function get_join_to_intermediate_model_statement($model_relation_chain){
+	public function get_join_to_intermediate_model_statement($model_relation_chain) {
 		//create sql like
 		//LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
 		//LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
@@ -83,8 +83,8 @@ 
 		$field_with_model_name = $this->get_join_table_fk_field_to(
 				$this->get_this_model()->get_this_model_name(),
 				'name' );
-		$this_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_this_model()->get_this_model_name()) . $this_table_pk_field->get_table_alias();
-		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias();
+		$this_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_this_model()->get_this_model_name()).$this_table_pk_field->get_table_alias();
+		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_join_model()->get_this_model_name()).$join_table_fk_field_to_this_table->get_table_alias();
 		$join_table = $this->get_join_model()->get_table_for_alias($join_table_alias);
 		//phew! ok, we have all the info we need, now we can create the SQL join string
 		$SQL = $this->_left_join(
@@ -93,7 +93,7 @@ 
 					$join_table_fk_field_to_this_table->get_table_column(),
 					$this_table_alias,
 					$this_table_pk_field->get_table_column(),
-					$field_with_model_name->get_qualified_column()."='".$this->get_this_model()->get_this_model_name()."'" ) .
+					$field_with_model_name->get_qualified_column()."='".$this->get_this_model()->get_this_model_name()."'" ).
 				$this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
 
 		return $SQL;
@@ -111,9 +111,9 @@ 
 	 * @return string of SQL
 	 * @throws \EE_Error
 	 */
-	public function get_join_statement($model_relation_chain){
-		if( $this->_model_relation_chain_to_join_model === NULL ){
-			throw new EE_Error( sprintf( __( 'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement', 'event_espresso' )));
+	public function get_join_statement($model_relation_chain) {
+		if ($this->_model_relation_chain_to_join_model === NULL) {
+			throw new EE_Error(sprintf(__('When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement', 'event_espresso')));
 		}
 		$join_table_fk_field_to_this_table = $this->get_join_table_fk_field_to(
 				$this->get_this_model()->get_this_model_name(),
@@ -125,10 +125,10 @@ 
 				$this->get_other_model()->get_this_model_name(),
 				'name' );
 
-		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($this->_model_relation_chain_to_join_model, $this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias();
+		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($this->_model_relation_chain_to_join_model, $this->get_join_model()->get_this_model_name()).$join_table_fk_field_to_this_table->get_table_alias();
 
 		$other_table_pk_field = $this->get_other_model()->get_primary_key_field();
-		$other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_other_model()->get_this_model_name()) . $other_table_pk_field->get_table_alias();
+		$other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_other_model()->get_this_model_name()).$other_table_pk_field->get_table_alias();
 		$other_table = $this->get_other_model()->get_table_for_alias($other_table_alias);
 
 		$SQL = $this->_left_join(
@@ -138,7 +138,7 @@ 
 					$join_table_alias,
 					$join_table_fk_field_to_other_table->get_table_column(),
 					$field_with_other_model_name->get_qualified_column()."='".$this->get_other_model()->get_this_model_name()."'"
-				) .
+				).
 				$this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
 		return $SQL;
 	}
@@ -154,7 +154,7 @@ 
 	 * @return EE_Base_Class
 	 * @throws \EE_Error
 	 */
-	public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array() ){
+	public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array()) {
 		 $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
 		 $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 		//check if such a relationship already exists
@@ -171,32 +171,32 @@ 
 				$this->get_other_model()->get_this_model_name(),
 				'name' );
 
-		$cols_n_values =  array(
+		$cols_n_values = array(
 				$join_model_fk_to_this_model->get_name() => $this_model_obj->ID(),
 				$join_model_name_field_to_this_model->get_name() => $this_model_obj->get_model()->get_this_model_name(),
 				$join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
 				$join_model_name_field_to_other_model->get_name() => $other_model_obj->get_model()->get_this_model_name() );
 
 		//if $where_query exists lets add them to the query_params.
-		if ( !empty( $extra_join_model_fields_n_values ) ) {
+		if ( ! empty($extra_join_model_fields_n_values)) {
 		   //make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
 		   //make sure we strip THIS models name from the query param
 			$parsed_query = array();
-		   foreach ( $extra_join_model_fields_n_values as $query_param => $val ) {
-			   $query_param = str_replace($this->get_join_model()->get_this_model_name().".","", $query_param);
+		   foreach ($extra_join_model_fields_n_values as $query_param => $val) {
+			   $query_param = str_replace($this->get_join_model()->get_this_model_name().".", "", $query_param);
 			   $parsed_query[$query_param] = $val;
 		   }
-		   $cols_n_values = array_merge( $cols_n_values, $parsed_query );
+		   $cols_n_values = array_merge($cols_n_values, $parsed_query);
 		}
 
-		$query_params = array( $cols_n_values );
+		$query_params = array($cols_n_values);
 
 
 		$existing_entry_in_join_table = $this->get_join_model()->get_one($query_params);
 		//if there is already an entry in the join table, indicating a relationship, we're done
 		 //again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
 		 //the other tables, use the joining model directly!
-		if( ! $existing_entry_in_join_table ){
+		if ( ! $existing_entry_in_join_table) {
 			$this->get_join_model()->insert($cols_n_values);
 		}
 		return $other_model_obj;
@@ -214,7 +214,7 @@ 
 	 * @return EE_Base_Class
 	 * @throws \EE_Error
 	 */
-	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array() ){
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array()) {
 		 $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
 		 $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 		//check if such a relationship already exists
@@ -231,25 +231,25 @@ 
 				$this->get_other_model()->get_this_model_name(),
 				'name' );
 
-		$cols_n_values =  array(
+		$cols_n_values = array(
 				$join_model_fk_to_this_model->get_name() => $this_model_obj->ID(),
 				$join_model_name_field_to_this_model->get_name() => $this_model_obj->get_model()->get_this_model_name(),
 				$join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
 				$join_model_name_field_to_other_model->get_name() => $other_model_obj->get_model()->get_this_model_name() );
 
 		//if $where_query exists lets add them to the query_params.
-		if ( !empty( $where_query ) ) {
+		if ( ! empty($where_query)) {
 		 	//make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
 		 	//make sure we strip THIS models name from the query param
 			$parsed_query = array();
-			foreach ( $where_query as $query_param => $val ) {
-				$query_param = str_replace($this->get_join_model()->get_this_model_name().".","", $query_param);
+			foreach ($where_query as $query_param => $val) {
+				$query_param = str_replace($this->get_join_model()->get_this_model_name().".", "", $query_param);
 				$parsed_query[$query_param] = $val;
 			}
-		 	$cols_n_values = array_merge( $cols_n_values, $parsed_query );
+		 	$cols_n_values = array_merge($cols_n_values, $parsed_query);
 		}
 
-		$this->get_join_model()->delete( array($cols_n_values) );
+		$this->get_join_model()->delete(array($cols_n_values));
 		return $other_model_obj;
 	 }
 }

core/db_models/relations/EE_Has_Many_Relation.php

Spacing +10 added lines, -10 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-require_once( EE_MODELS . 'relations/EE_Model_Relation_Base.php');
+require_once(EE_MODELS.'relations/EE_Model_Relation_Base.php');
 
 
 
@@ -11,7 +11,7 @@ 
  * @subpackage    core
  * @author        Michael Nelson
  */
-class EE_Has_Many_Relation extends EE_Model_Relation_Base{
+class EE_Has_Many_Relation extends EE_Model_Relation_Base {
 
 	/**
 	 * Object representing the relationship between two models. Has_Many_Relations are where the OTHER model has the foreign key
@@ -21,7 +21,7 @@ 
 	 * @param boolean $block_deletes For this type of relation, we block by default. If there are related models across this relation, block (prevent and add an error) the deletion of this model
 	 * @param string $blocking_delete_error_message a customized error message on blocking deletes instead of the default
 	 */
-	public function __construct($block_deletes = true, $blocking_delete_error_message = null){
+	public function __construct($block_deletes = true, $blocking_delete_error_message = null) {
 		parent::__construct($block_deletes, $blocking_delete_error_message);
 	}
 
@@ -34,13 +34,13 @@ 
 	 * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk = other_model_primary_table.fk" etc
 	 * @throws \EE_Error
 	 */
-	public function get_join_statement( $model_relation_chain){
+	public function get_join_statement($model_relation_chain) {
 		//create the sql string like
 		// LEFT JOIN other_table AS table_alias ON this_table_alias.pk = other_table_alias.fk extra_join_conditions
 		$this_table_pk_field = $this->get_this_model()->get_primary_key_field();
 		$other_table_fk_field = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-		$pk_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_this_model()->get_this_model_name()) . $this_table_pk_field->get_table_alias();
-		$fk_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_other_model()->get_this_model_name()) . $other_table_fk_field->get_table_alias();
+		$pk_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_this_model()->get_this_model_name()).$this_table_pk_field->get_table_alias();
+		$fk_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_other_model()->get_this_model_name()).$other_table_fk_field->get_table_alias();
 		$fk_table = $this->get_other_model()->get_table_for_alias($fk_table_alias);
 
 		return $this->_left_join($fk_table, $fk_table_alias, $other_table_fk_field->get_table_column(), $pk_table_alias, $this_table_pk_field->get_table_column()).$this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
@@ -57,13 +57,13 @@ 
 	 * @return \EE_Base_Class
 	 * @throws \EE_Error
 	 */
-	public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array() ){
+	public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array()) {
 		 $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
 		 $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 
 		 //find the field on the other model which is a foreign key to this model
 		 $fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-		 if($other_model_obj->get($fk_field_on_other_model->get_name()) != $this_model_obj->ID()){
+		 if ($other_model_obj->get($fk_field_on_other_model->get_name()) != $this_model_obj->ID()) {
 			//set that field on the other model to this model's ID
 			$other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
 			$other_model_obj->save();
@@ -83,12 +83,12 @@ 
 	 * @return \EE_Base_Class
 	 * @throws \EE_Error
 	 */
-	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array()){
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array()) {
 		 $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 		 //find the field on the other model which is a foreign key to this model
 		 $fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
 		 //set that field on the other model to this model's ID
-		 $other_model_obj->set($fk_field_on_other_model->get_name(),null, true);
+		 $other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
 		 $other_model_obj->save();
 		 return $other_model_obj;
 	 }

core/db_models/relations/EE_Has_Many_Revision_Relation.php

Spacing +48 added lines, -48 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-require_once( EE_MODELS . 'relations/EE_Has_Many_Relation.php');
+require_once(EE_MODELS.'relations/EE_Has_Many_Relation.php');
 
 
 
@@ -11,7 +11,7 @@ 
  * @subpackage    core
  * @author        Michael Nelson
  */
-class EE_Has_Many_Revision_Relation extends EE_Has_Many_Relation{
+class EE_Has_Many_Revision_Relation extends EE_Has_Many_Relation {
 
 
 	/**
@@ -44,7 +44,7 @@ 
 	 * @param boolean $block_deletes For this type of relation, we block by default. If there are related models across this relation, block (prevent and add an error) the deletion of this model
 	 * @param string $blocking_delete_error_message a customized error message on blocking deletes instead of the default
 	 */
-	public function __construct($primary_cpt_field, $parent_pk_relation_field, $block_deletes = true, $blocking_delete_error_message = null){
+	public function __construct($primary_cpt_field, $parent_pk_relation_field, $block_deletes = true, $blocking_delete_error_message = null) {
 		$this->_primary_cpt_field = $primary_cpt_field;
 		$this->_parent_pk_relation_field = $parent_pk_relation_field;
 		parent::__construct($block_deletes, $blocking_delete_error_message);
@@ -61,7 +61,7 @@ 
 	 * @return \EE_Base_Class
 	 * @throws \EE_Error
 	 */
-	public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array() ){
+	public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array()) {
 		 $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
 		 $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id);
 
@@ -69,7 +69,7 @@ 
 		 $other_model_obj = $this->_check_for_revision($this_model_obj, $other_model_obj);
 
 		 //if is array, then we've already done the add_relation so let's get out
-		if ( is_array( $other_model_obj ) ){
+		if (is_array($other_model_obj)) {
 			return $other_model_obj[0];
 		}
 		 //find the field on the other model which is a foreign key to this model
@@ -91,15 +91,15 @@ 
 	 * @return \EE_Base_Class
 	 * @throws \EE_Error
 	 */
-	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array()){
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array()) {
 	 	$this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id);
 		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id);
 		//handle possible revisions
-		$other_model_obj = $this->_check_for_revision( $this_model_obj, $other_model_obj, TRUE );
+		$other_model_obj = $this->_check_for_revision($this_model_obj, $other_model_obj, TRUE);
 
 
 		//if is array, then we've already done the add_relation so let's get out
-		if ( is_array( $other_model_obj ) ){
+		if (is_array($other_model_obj)) {
 			return $other_model_obj[0];
 		}
 
@@ -108,12 +108,12 @@ 
 
 
 		 //set that field on the other model to this model's ID
-		 if ( $this->_blocking_delete ) {
-		 	$other_model_obj->set($fk_field_on_other_model->get_name(),null,true);
+		 if ($this->_blocking_delete) {
+		 	$other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
 		 	$other_model_obj->save();
 		 } else {
 		 	$other_model_obj->delete();
-		 	$other_model_obj->set($fk_field_on_other_model->get_name(),null,true);
+		 	$other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
 		 	return $other_model_obj;
 		 }
 		 return $other_model_obj;
@@ -130,17 +130,17 @@ 
 	 * @return EE_Base_Class[]
 	 * @throws \EE_Error
 	 */
-	 public function get_all_related( $model_object_or_id, $query_params = array(), $values_already_prepared_by_model_object = false ) {
-		if( $values_already_prepared_by_model_object !== false ) {
-			EE_Error::doing_it_wrong( 'EE_Model_Relation_Base::get_all_related', __( 'The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso' ), '4.8.1' );
+	 public function get_all_related($model_object_or_id, $query_params = array(), $values_already_prepared_by_model_object = false) {
+		if ($values_already_prepared_by_model_object !== false) {
+			EE_Error::doing_it_wrong('EE_Model_Relation_Base::get_all_related', __('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'), '4.8.1');
 		}
 
 	 	//if this is an autosave then we're going to get things differently
-	 	if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE ) {
-	 		return $this->_do_autosave_get_all($model_object_or_id, $query_params );
+	 	if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
+	 		return $this->_do_autosave_get_all($model_object_or_id, $query_params);
 	 	}
 
-	 	return parent::get_all_related( $model_object_or_id, $query_params );
+	 	return parent::get_all_related($model_object_or_id, $query_params);
 	 }
 
 
@@ -156,22 +156,22 @@ 
 	 * @return \EE_Base_Class[]
 	 * @throws \EE_Error
 	 */
-	 protected function _do_autosave_get_all( $model_object_or_id, $query_params, $deprecated = false ) {
+	 protected function _do_autosave_get_all($model_object_or_id, $query_params, $deprecated = false) {
 
 	 	//first we check if the post_id for the incoming query is for an autosave.  If it isn't that's what we want!
-	 	$model_object_id = $this->_get_model_object_id( $model_object_or_id );
+	 	$model_object_id = $this->_get_model_object_id($model_object_or_id);
 
-	 	$autosave = wp_get_post_autosave( $model_object_id );
+	 	$autosave = wp_get_post_autosave($model_object_id);
 	 	$id_to_use = $autosave ? $autosave->ID : $model_object_id;
 
-	 	$autosave_relations =  parent::get_all_related( $id_to_use, $query_params );
+	 	$autosave_relations = parent::get_all_related($id_to_use, $query_params);
 	 	$parent_ids = $parents = array();
 	 	$return_objs = array();
 
 		//k this is where things differ because NOW what we're going to do is get the PARENTS for the get all related (and we'll also start setting up the return_objs array containing related that DON'T have parent ids, for those that DON'T have parents to merge with our returned objects);
-		foreach ( $autosave_relations as $a_r ) {
+		foreach ($autosave_relations as $a_r) {
 			$pid = $a_r->parent();
-			if ( !empty( $pid ) ) {
+			if ( ! empty($pid)) {
 				$parent_ids[] = $pid;
 			} else {
 				$return_objs[] = $a_r;
@@ -179,17 +179,17 @@ 
 		}
 
 		//we have to make sure we also include the ORIGINAL values
-		$originals = parent::get_all_related($model_object_or_id, $query_params );
+		$originals = parent::get_all_related($model_object_or_id, $query_params);
 
 		//merge $originals with $return_objs
-		if ( $originals ) {
+		if ($originals) {
 			$return_objs = array_merge($originals, $return_objs);
 		}
 
 		//now we setup the query to get all the parents
-		if ( !empty( $parent_ids ) ) {
+		if ( ! empty($parent_ids)) {
 			$query_param_where_this_model_pk = $this->get_this_model()->get_this_model_name().".".$this->get_this_model()->get_primary_key_field()->get_name();
-			$query_param[0][$query_param_where_this_model_pk] = array('IN', $parent_ids );
+			$query_param[0][$query_param_where_this_model_pk] = array('IN', $parent_ids);
 			$parents = $this->get_other_model()->get_all($query_params);
 		}
 
@@ -197,7 +197,7 @@ 
 
 
 		//now merge parents with our current $return_objs and send back
-		return array_merge( $parents, $return_objs );
+		return array_merge($parents, $return_objs);
 	 }
 
 
@@ -211,42 +211,42 @@ 
 	 * @return EE_Base_Class. ($other_obj);
 	 * @throws \EE_Error
 	 */
-	protected function _check_for_revision( $this_obj, $other_obj, $remove_relation = FALSE ) {
+	protected function _check_for_revision($this_obj, $other_obj, $remove_relation = FALSE) {
 		$pk_on_related_model = $this->get_other_model()->get_primary_key_field()->get_name();
 		//now we need to determine if we're in a WP revision save cause if we are we need to do some special handling
-		if (  $this_obj->post_type() === 'revision' ) {
+		if ($this_obj->post_type() === 'revision') {
 			//first if $other_obj fk = this_obj pk then we know that this is a pk object, let's make sure there is a matching set for the autosave if there is then we save over it, if there isn't then we need to create a new one.
 			$parent_evt_id = $this_obj->parent();
 			/*var_dump($parent_evt_id);
 			var_dump($this_obj);
 			var_dump($other_obj);/**/
 
-			if ( !empty($parent_evt_id) && $parent_evt_id == $other_obj->get($this->_primary_cpt_field) ) {
+			if ( ! empty($parent_evt_id) && $parent_evt_id == $other_obj->get($this->_primary_cpt_field)) {
 				//let's do query on this objects model to see if the incoming pk value on the obj matches any parents in this objects table.
-				$has_parent_obj = $this->get_other_model()->get_one( array( array( $this->_parent_pk_relation_field => $other_obj->ID(), $this->_primary_cpt_field => $this_obj->ID() ) ) );
+				$has_parent_obj = $this->get_other_model()->get_one(array(array($this->_parent_pk_relation_field => $other_obj->ID(), $this->_primary_cpt_field => $this_obj->ID())));
 
-				if ( $has_parent_obj ) {
+				if ($has_parent_obj) {
 					//this makes sure the update on the current obj happens to the revision's row NOT the parent row.
 
-					$other_obj->set( $this->_parent_pk_relation_field, $other_obj->ID());
-					$other_obj->set($pk_on_related_model, $has_parent_obj->ID() );
+					$other_obj->set($this->_parent_pk_relation_field, $other_obj->ID());
+					$other_obj->set($pk_on_related_model, $has_parent_obj->ID());
 					$other_obj->set($this->_primary_cpt_field, $this_obj->ID());
 
-					if ( !$remove_relation ) {
+					if ( ! $remove_relation) {
 						$other_obj->save();
-						return array( $other_obj );
-					} elseif ( $remove_relation && !$this->_blocking_delete) {
+						return array($other_obj);
+					} elseif ($remove_relation && ! $this->_blocking_delete) {
 						$other_obj->delete();
 						$other_obj->set($this->_parent_pk_relation_field, NULL, true);
 						return array($other_obj);
 					}
 
 				} else {
-					$other_obj->set( $this->_parent_pk_relation_field, $other_obj->ID() );
-					$other_obj->set( $this->_primary_cpt_field, $this_obj->ID() );
+					$other_obj->set($this->_parent_pk_relation_field, $other_obj->ID());
+					$other_obj->set($this->_primary_cpt_field, $this_obj->ID());
 					$other_obj->set($pk_on_related_model, NULL, true); //ensure we create a new row for the autosave with parent id the same as the incoming ID.
 					$other_obj->save(); //make sure we insert.
-					return array( $other_obj );
+					return array($other_obj);
 				}
 			}
 
@@ -259,24 +259,24 @@ 
 		} else {
 
 			//we only need to do the below IF this is not a remove relation
-			if ( !$remove_relation ) {
+			if ( ! $remove_relation) {
 				//okay this is is a normal update/save/remove so, let's make sure the other object is not a revision of the current object.
 				//the other object will likely NOT have the correct fk on it (which is the primary_cpt_field_mame) so we must retrieve from the db to get that first.
 				$existing_other_obj = $this->get_other_model()->get_one_by_ID($other_obj->ID());
 				$potential_revision_id = is_object($existing_other_obj) ? $existing_other_obj->get($this->_primary_cpt_field) : NULL;
 
-				if ( $parent_this_obj_id = wp_is_post_revision($potential_revision_id) ) {
+				if ($parent_this_obj_id = wp_is_post_revision($potential_revision_id)) {
 					//yes the OTHER object is linked to the revision of the parent, not the parent itself. That means we need to make the other_object an attachment of this_obj and then duplicate other_obj for the revision.
-					$other_obj->set($this->_primary_cpt_field, $this_obj->ID() );
+					$other_obj->set($this->_primary_cpt_field, $this_obj->ID());
 					$other_obj->save();
 
 					//now create a new other_obj and fill with details from existing object
 					$new_obj = $other_obj;
-					$new_obj->set( $this->_primary_cpt_field, $potential_revision_id );
-					$new_obj->set( $this->_parent_pk_relation_field, $other_obj->ID() );
-					$new_obj->set( $pk_on_related_model, NULL );
+					$new_obj->set($this->_primary_cpt_field, $potential_revision_id);
+					$new_obj->set($this->_parent_pk_relation_field, $other_obj->ID());
+					$new_obj->set($pk_on_related_model, NULL);
 					$new_obj->save();
-					return array( $new_obj );
+					return array($new_obj);
 				}
 
 			}