eventespresso / event-espresso-core

caffeinated/payment_methods/Paypal_Pro/EEG_Paypal_Pro.gateway.php

Doc Comments +1 added lines, -1 removed lines

@@ -392,7 +392,7 @@
 
 
 	/**
-	 * @param $Request
+	 * @param string $Request
 	 * @return mixed
 	 */
 	private function _CURLRequest($Request) {

Braces +42 added lines, -31 removed lines

@@ -1,7 +1,8 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if (!defined('EVENT_ESPRESSO_VERSION')) {
 	exit('No direct script access allowed');
+}
 
 /**
  * Event Espresso
@@ -123,7 +124,7 @@ 
 			}
 			$item_amount = $total_line_item->get_items_total();
 			$tax_amount = $total_line_item->get_total_tax();
-		}else{
+		} else{
 			$order_items = array();
 			$item_amount = $payment->amount();
 			$single_item_desc = sprintf(__("Partial payment of %s for %s", "event_espresso"),$payment->amount(),$primary_registrant->reg_code());
@@ -248,10 +249,10 @@ 
 				$payment->set_status( $this->_pay_model->failed_status() ) ;
 				$payment->set_gateway_response( __( 'No response received from Paypal Pro', 'event_espresso' ) );
 				$payment->set_details($PayPalResult);
-			}else{
+			} else{
 				if($this->_APICallSuccessful($PayPalResult)){
 					$payment->set_status($this->_pay_model->approved_status());
-				}else{
+				} else{
 					$payment->set_status($this->_pay_model->declined_status());
 				}
 				//make sure we interpret the AMT as a float, not an international string (where periods are thousand separators)
@@ -263,7 +264,7 @@ 
 				$payment->set_extra_accntng($primary_registration_code);
 				$payment->set_details($PayPalResult);
 			}
-		}catch(Exception $e){
+		} catch(Exception $e){
 			$payment->set_status($this->_pay_model->failed_status());
 			$payment->set_gateway_response($e->getMessage());
 		}
@@ -325,53 +326,62 @@ 
 
 		// DP Fields
 		$DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array();
-		foreach ($DPFields as $DPFieldsVar => $DPFieldsVal)
-			$DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
+		foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) {
+					$DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
+		}
 
 		// CC Details Fields
 		$CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array();
-		foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal)
-			$CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
+		foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) {
+					$CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
+		}
 
 		// PayerInfo Type Fields
 		$PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array();
-		foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal)
-			$PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
+		foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) {
+					$PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
+		}
 
 		// Payer Name Fields
 		$PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array();
-		foreach ($PayerName as $PayerNameVar => $PayerNameVal)
-			$PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
+		foreach ($PayerName as $PayerNameVar => $PayerNameVal) {
+					$PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
+		}
 
 		// Address Fields (Billing)
 		$BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array();
-		foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal)
-			$BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
+		foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) {
+					$BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
+		}
 
 		// Payment Details Type Fields
 		$PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array();
-		foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal)
-			$PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
+		foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) {
+					$PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
+		}
 
 		// Payment Details Item Type Fields
 		$OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array();
 		$n = 0;
 		foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) {
 			$CurrentItem = $OrderItems[$OrderItemsVar];
-			foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal)
-				$OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
+			foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) {
+							$OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
+			}
 			$n++;
 		}
 
 		// Ship To Address Fields
 		$ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array();
-		foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal)
-			$ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
+		foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) {
+					$ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
+		}
 
 		// 3D Secure Fields
 		$Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array();
-		foreach ($Secure3D as $Secure3DVar => $Secure3DVal)
-			$Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
+		foreach ($Secure3D as $Secure3DVar => $Secure3DVal) {
+					$Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
+		}
 
 		// Now that we have each chunk we need to go ahead and append them all together for our entire NVP string
 		$NVPRequest = 'USER=' . $this->_username . '&PWD=' . $this->_password . '&VERSION=64.0' . '&SIGNATURE=' . $this->_signature . $DPFieldsNVP . $CCDetailsNVP . $PayerInfoNVP . $PayerNameNVP . $BillingAddressNVP . $PaymentDetailsNVP . $OrderItemsNVP . $ShippingAddressNVP . $Secure3DNVP;
@@ -500,14 +510,15 @@ 
 			$CurrentError = $Errors[$ErrorVar];
 			foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) {
 				$CurrentVarName = '';
-				if ($CurrentErrorVar == 'L_ERRORCODE')
-					$CurrentVarName = 'Error Code';
-				elseif ($CurrentErrorVar == 'L_SHORTMESSAGE')
-					$CurrentVarName = 'Short Message';
-				elseif ($CurrentErrorVar == 'L_LONGMESSAGE')
-					$CurrentVarName = 'Long Message';
-				elseif ($CurrentErrorVar == 'L_SEVERITYCODE')
-					$CurrentVarName = 'Severity Code';
+				if ($CurrentErrorVar == 'L_ERRORCODE') {
+									$CurrentVarName = 'Error Code';
+				} elseif ($CurrentErrorVar == 'L_SHORTMESSAGE') {
+									$CurrentVarName = 'Short Message';
+				} elseif ($CurrentErrorVar == 'L_LONGMESSAGE') {
+									$CurrentVarName = 'Long Message';
+				} elseif ($CurrentErrorVar == 'L_SEVERITYCODE') {
+									$CurrentVarName = 'Severity Code';
+				}
 
 				$error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal;
 			}

Spacing +51 added lines, -51 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('No direct script access allowed');
 
 /**
@@ -25,7 +25,7 @@ 
  *
  * ------------------------------------------------------------------------
  */
-class EEG_Paypal_Pro extends EE_Onsite_Gateway{
+class EEG_Paypal_Pro extends EE_Onsite_Gateway {
 	/**
 	 *
 	 * @var $_paypal_api_username string
@@ -88,21 +88,21 @@ 
 	 * } @see parent::do_direct_payment for more info
 	 * @return \EE_Payment|\EEI_Payment
 	 */
-	public function do_direct_payment($payment,$billing_info = null){
+	public function do_direct_payment($payment, $billing_info = null) {
 		$transaction = $payment->transaction();
 		$primary_registrant = $transaction->primary_registration();
-		$order_description  = sprintf(__("Event Registrations from %s", "event_espresso"),get_bloginfo('name'));
+		$order_description  = sprintf(__("Event Registrations from %s", "event_espresso"), get_bloginfo('name'));
 		//charge for the full amount. Show itemized list
-		if( $this->_can_easily_itemize_transaction_for( $payment ) ){
+		if ($this->_can_easily_itemize_transaction_for($payment)) {
 			$item_num = 1;
 			$total_line_item = $transaction->total_line_item();
 			$order_items = array();
 			foreach ($total_line_item->get_items() as $line_item) {
 				$item = array(
 						// Item Name.  127 char max.
-						'l_name' => substr($line_item->name(),0,127),
+						'l_name' => substr($line_item->name(), 0, 127),
 						// Item description.  127 char max.
-						'l_desc' => substr($line_item->desc(),0,127),
+						'l_desc' => substr($line_item->desc(), 0, 127),
 						// Cost of individual item.
 						'l_amt' => $line_item->unit_price(),
 						// Item Number.  127 char max.
@@ -123,14 +123,14 @@ 
 			}
 			$item_amount = $total_line_item->get_items_total();
 			$tax_amount = $total_line_item->get_total_tax();
-		}else{
+		} else {
 			$order_items = array();
 			$item_amount = $payment->amount();
-			$single_item_desc = sprintf(__("Partial payment of %s for %s", "event_espresso"),$payment->amount(),$primary_registrant->reg_code());
+			$single_item_desc = sprintf(__("Partial payment of %s for %s", "event_espresso"), $payment->amount(), $primary_registrant->reg_code());
 			$tax_amount = 0;
-			array_push($order_items,array(
+			array_push($order_items, array(
 				// Item Name.  127 char max.
-				'l_name' => sprintf(__("Partial payment for registration: %s", 'event_espresso'),$primary_registrant->reg_code()),
+				'l_name' => sprintf(__("Partial payment for registration: %s", 'event_espresso'), $primary_registrant->reg_code()),
 				// Item description.  127 char max.
 				'l_desc' => $single_item_desc,
 				// Cost of individual item.
@@ -177,11 +177,11 @@ 
 			// Payer's salutation.  20 char max.
 			'salutation' => '',
 			// Payer's first name.  25 char max.
-			'firstname' => substr($billing_info['first_name'],0,25),
+			'firstname' => substr($billing_info['first_name'], 0, 25),
 			// Payer's middle name.  25 char max.
 			'middlename' => '',
 			// Payer's last name.  25 char max.
-			'lastname' => substr($billing_info['last_name'],0,25),
+			'lastname' => substr($billing_info['last_name'], 0, 25),
 			// Payer's suffix.  12 char max.
 			'suffix' => ''
 		);
@@ -194,13 +194,13 @@ 
 			// Required.  Name of City.
 			'city' => $billing_info['city'],
 			// Required. Name of State or Province.
-			'state' => substr( $billing_info['state'], 0, 40 ),
+			'state' => substr($billing_info['state'], 0, 40),
 			// Required.  Country code.
 			'countrycode' => $billing_info['country'],
 			// Required.  Postal code of payer.
 			'zip' => $billing_info['zip'],
 			// Phone Number of payer.  20 char max.
-			'shiptophonenum' => substr($billing_info['phone'],0,20)
+			'shiptophonenum' => substr($billing_info['phone'], 0, 20)
 		);
 
 
@@ -210,7 +210,7 @@ 
 			// Required.  Three-letter currency code.  Default is USD.
 			'currencycode' => $payment->currency_code(),
 			// Required if you include itemized cart details. (L_AMTn, etc.)  Subtotal of items not including S&H, or tax.
-			'itemamt' => $this->format_currency($item_amount),//
+			'itemamt' => $this->format_currency($item_amount), //
 			// Total shipping costs for the order.  If you specify shippingamt, you must also specify itemamt.
 			'shippingamt' => '',
 			// Total handling costs for the order.  If you specify handlingamt, you must also specify itemamt.
@@ -222,10 +222,10 @@ 
 			// Free-form field for your own use.  256 char max.
 			'custom' => $primary_registrant ? $primary_registrant->ID() : '',
 			// Your own invoice or tracking number
-			'invnum' => wp_generate_password(12,false),//$transaction->ID(),
+			'invnum' => wp_generate_password(12, false), //$transaction->ID(),
 			// URL for receiving Instant Payment Notifications.  This overrides what your profile is set to use.
 			'notifyurl' => '',
-			'buttonsource' => 'EventEspresso_SP',//EE will blow up if you change this
+			'buttonsource' => 'EventEspresso_SP', //EE will blow up if you change this
 		);
 		// Wrap all data arrays into a single, "master" array which will be passed into the class function.
 		$PayPalRequestData = array(
@@ -238,32 +238,32 @@ 
 				'OrderItems' => $order_items,
 		);
 		$this->_log_clean_request($PayPalRequestData, $payment);
-		try{
+		try {
 			$PayPalResult = $this->prep_and_curl_request($PayPalRequestData);
 			//remove PCI-sensitive data so it doesn't get stored
-			$PayPalResult = $this->_log_clean_response($PayPalResult,$payment);
+			$PayPalResult = $this->_log_clean_response($PayPalResult, $payment);
 
 			$message = isset($PayPalResult['L_LONGMESSAGE0']) ? $PayPalResult['L_LONGMESSAGE0'] : $PayPalResult['ACK'];
-			if( empty($PayPalResult[ 'RAWRESPONSE' ] ) ) {
-				$payment->set_status( $this->_pay_model->failed_status() ) ;
-				$payment->set_gateway_response( __( 'No response received from Paypal Pro', 'event_espresso' ) );
+			if (empty($PayPalResult['RAWRESPONSE'])) {
+				$payment->set_status($this->_pay_model->failed_status());
+				$payment->set_gateway_response(__('No response received from Paypal Pro', 'event_espresso'));
 				$payment->set_details($PayPalResult);
-			}else{
-				if($this->_APICallSuccessful($PayPalResult)){
+			} else {
+				if ($this->_APICallSuccessful($PayPalResult)) {
 					$payment->set_status($this->_pay_model->approved_status());
-				}else{
+				} else {
 					$payment->set_status($this->_pay_model->declined_status());
 				}
 				//make sure we interpret the AMT as a float, not an international string (where periods are thousand separators)
-				$payment->set_amount(isset($PayPalResult['AMT']) ? floatval( $PayPalResult['AMT'] ) : 0);
+				$payment->set_amount(isset($PayPalResult['AMT']) ? floatval($PayPalResult['AMT']) : 0);
 				$payment->set_gateway_response($message);
-				$payment->set_txn_id_chq_nmbr(isset( $PayPalResult['TRANSACTIONID'] )? $PayPalResult['TRANSACTIONID'] : null);
+				$payment->set_txn_id_chq_nmbr(isset($PayPalResult['TRANSACTIONID']) ? $PayPalResult['TRANSACTIONID'] : null);
 
 				$primary_registration_code = $primary_registrant instanceof EE_Registration ? $primary_registrant->reg_code() : '';
 				$payment->set_extra_accntng($primary_registration_code);
 				$payment->set_details($PayPalResult);
 			}
-		}catch(Exception $e){
+		} catch (Exception $e) {
 			$payment->set_status($this->_pay_model->failed_status());
 			$payment->set_gateway_response($e->getMessage());
 		}
@@ -280,7 +280,7 @@ 
 	 * @param EEI_Payment $payment
 	 * @return array
 	 */
-	private function _log_clean_request($request,$payment){
+	private function _log_clean_request($request, $payment) {
 		$cleaned_request_data = $request;
 		unset($cleaned_request_data['CCDetails']['acct']);
 		unset($cleaned_request_data['CCDetails']['cvv2']);
@@ -296,13 +296,13 @@ 
 	 * @param EEI_Payment $payment
 	 * @return array cleaned
 	 */
-	private function _log_clean_response($response,$payment){
+	private function _log_clean_response($response, $payment) {
 		unset($response['REQUESTDATA']['CREDITCARDTYPE']);
 		unset($response['REQUESTDATA']['ACCT']);
 		unset($response['REQUESTDATA']['EXPDATE']);
 		unset($response['REQUESTDATA']['CVV2']);
 		unset($response['RAWREQUEST']);
-		$this->log(array('Paypal Response'=>$response),$payment);
+		$this->log(array('Paypal Response'=>$response), $payment);
 		return $response;
 	}
 
@@ -327,32 +327,32 @@ 
 		// DP Fields
 		$DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array();
 		foreach ($DPFields as $DPFieldsVar => $DPFieldsVal)
-			$DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
+			$DPFieldsNVP .= '&'.strtoupper($DPFieldsVar).'='.urlencode($DPFieldsVal);
 
 		// CC Details Fields
 		$CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array();
 		foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal)
-			$CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
+			$CCDetailsNVP .= '&'.strtoupper($CCDetailsVar).'='.urlencode($CCDetailsVal);
 
 		// PayerInfo Type Fields
 		$PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array();
 		foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal)
-			$PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
+			$PayerInfoNVP .= '&'.strtoupper($PayerInfoVar).'='.urlencode($PayerInfoVal);
 
 		// Payer Name Fields
 		$PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array();
 		foreach ($PayerName as $PayerNameVar => $PayerNameVal)
-			$PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
+			$PayerNameNVP .= '&'.strtoupper($PayerNameVar).'='.urlencode($PayerNameVal);
 
 		// Address Fields (Billing)
 		$BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array();
 		foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal)
-			$BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
+			$BillingAddressNVP .= '&'.strtoupper($BillingAddressVar).'='.urlencode($BillingAddressVal);
 
 		// Payment Details Type Fields
 		$PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array();
 		foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal)
-			$PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
+			$PaymentDetailsNVP .= '&'.strtoupper($PaymentDetailsVar).'='.urlencode($PaymentDetailsVal);
 
 		// Payment Details Item Type Fields
 		$OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array();
@@ -360,22 +360,22 @@ 
 		foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) {
 			$CurrentItem = $OrderItems[$OrderItemsVar];
 			foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal)
-				$OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
+				$OrderItemsNVP .= '&'.strtoupper($CurrentItemVar).$n.'='.urlencode($CurrentItemVal);
 			$n++;
 		}
 
 		// Ship To Address Fields
 		$ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array();
 		foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal)
-			$ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
+			$ShippingAddressNVP .= '&'.strtoupper($ShippingAddressVar).'='.urlencode($ShippingAddressVal);
 
 		// 3D Secure Fields
 		$Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array();
 		foreach ($Secure3D as $Secure3DVar => $Secure3DVal)
-			$Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
+			$Secure3DNVP .= '&'.strtoupper($Secure3DVar).'='.urlencode($Secure3DVal);
 
 		// Now that we have each chunk we need to go ahead and append them all together for our entire NVP string
-		$NVPRequest = 'USER=' . $this->_username . '&PWD=' . $this->_password . '&VERSION=64.0' . '&SIGNATURE=' . $this->_signature . $DPFieldsNVP . $CCDetailsNVP . $PayerInfoNVP . $PayerNameNVP . $BillingAddressNVP . $PaymentDetailsNVP . $OrderItemsNVP . $ShippingAddressNVP . $Secure3DNVP;
+		$NVPRequest = 'USER='.$this->_username.'&PWD='.$this->_password.'&VERSION=64.0'.'&SIGNATURE='.$this->_signature.$DPFieldsNVP.$CCDetailsNVP.$PayerInfoNVP.$PayerNameNVP.$BillingAddressNVP.$PaymentDetailsNVP.$OrderItemsNVP.$ShippingAddressNVP.$Secure3DNVP;
 		$NVPResponse = $this->_CURLRequest($NVPRequest);
 		$NVPRequestArray = $this->_NVPToArray($NVPRequest);
 		$NVPResponseArray = $this->_NVPToArray($NVPResponse);
@@ -399,7 +399,7 @@ 
 	private function _CURLRequest($Request) {
 		$EndPointURL = $this->_debug_mode ? 'https://api-3t.sandbox.paypal.com/nvp' : 'https://api-3t.paypal.com/nvp';
 		$curl = curl_init();
-		curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', TRUE ) );
+		curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', TRUE));
 		curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, FALSE);
 		curl_setopt($curl, CURLOPT_TIMEOUT, 60);
 		curl_setopt($curl, CURLOPT_URL, $EndPointURL);
@@ -449,9 +449,9 @@ 
 	private function _APICallSuccessful($PayPalResult) {
 		$approved = false;
 		// check main response message from PayPal
-		if (isset($PayPalResult['ACK']) && !empty($PayPalResult['ACK'])) {
+		if (isset($PayPalResult['ACK']) && ! empty($PayPalResult['ACK'])) {
 			$ack = strtoupper($PayPalResult['ACK']);
-			$approved = ( $ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS' ) ? true : false;
+			$approved = ($ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS') ? true : false;
 		}
 
 		return $approved;
@@ -467,11 +467,11 @@ 
 
 		$Errors = array();
 		$n = 0;
-		while (isset($DataArray['L_ERRORCODE' . $n . ''])) {
-			$LErrorCode = isset($DataArray['L_ERRORCODE' . $n . '']) ? $DataArray['L_ERRORCODE' . $n . ''] : '';
-			$LShortMessage = isset($DataArray['L_SHORTMESSAGE' . $n . '']) ? $DataArray['L_SHORTMESSAGE' . $n . ''] : '';
-			$LLongMessage = isset($DataArray['L_LONGMESSAGE' . $n . '']) ? $DataArray['L_LONGMESSAGE' . $n . ''] : '';
-			$LSeverityCode = isset($DataArray['L_SEVERITYCODE' . $n . '']) ? $DataArray['L_SEVERITYCODE' . $n . ''] : '';
+		while (isset($DataArray['L_ERRORCODE'.$n.''])) {
+			$LErrorCode = isset($DataArray['L_ERRORCODE'.$n.'']) ? $DataArray['L_ERRORCODE'.$n.''] : '';
+			$LShortMessage = isset($DataArray['L_SHORTMESSAGE'.$n.'']) ? $DataArray['L_SHORTMESSAGE'.$n.''] : '';
+			$LLongMessage = isset($DataArray['L_LONGMESSAGE'.$n.'']) ? $DataArray['L_LONGMESSAGE'.$n.''] : '';
+			$LSeverityCode = isset($DataArray['L_SEVERITYCODE'.$n.'']) ? $DataArray['L_SEVERITYCODE'.$n.''] : '';
 
 			$CurrentItem = array(
 					'L_ERRORCODE' => $LErrorCode,
@@ -511,7 +511,7 @@ 
 				elseif ($CurrentErrorVar == 'L_SEVERITYCODE')
 					$CurrentVarName = 'Severity Code';
 
-				$error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal;
+				$error .= '<br />'.$CurrentVarName.': '.$CurrentErrorVal;
 			}
 		}
 		return $error;

core/admin/EE_Admin_Hooks.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -207,7 +207,7 @@
 
 	/**
 	 * constructor
-	 * @param EE_Admin_Page $admin_page the calling admin_page_object
+	 * @param EE_Admin_Page $adminpage the calling admin_page_object
 	 */
 	public function __construct( EE_Admin_Page $adminpage ) {
 

Braces +59 added lines, -35 removed lines

@@ -1,6 +1,7 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if (!defined('EVENT_ESPRESSO_VERSION') ) {
 	exit('NO direct script access allowed');
+}
 
 /**
  * Event Espresso
@@ -217,12 +218,15 @@ 
 		$this->_set_hooks_properties();
 
 		//first let's verify we're on the right page
-		if ( !isset( $this->_req_data['page'] ) || ( isset( $this->_req_data['page'] ) && $this->_adminpage_obj->page_slug != $this->_req_data['page'] ) )
-			return; //get out nothing more to be done here.
+		if ( !isset( $this->_req_data['page'] ) || ( isset( $this->_req_data['page'] ) && $this->_adminpage_obj->page_slug != $this->_req_data['page'] ) ) {
+					return;
+		}
+		//get out nothing more to be done here.
 
 		//allow for extends to modify properties
-		if ( method_exists( $this, '_extend_properties' ) )
-			$this->_extend_properties();
+		if ( method_exists( $this, '_extend_properties' ) ) {
+					$this->_extend_properties();
+		}
 
 		$this->_set_page_object();
 		$this->_init_hooks();
@@ -305,8 +309,10 @@ 
 			}
 
 			//k now lets do the enqueues
-			if( !isset( $this->_scripts_styles['enqueues'] ) )
-				return;  //not sure if we should throw an error here or not.
+			if( !isset( $this->_scripts_styles['enqueues'] ) ) {
+							return;
+			}
+			//not sure if we should throw an error here or not.
 			foreach( $this->_scripts_styles['enqueues'] as $ref => $routes ) {
 				//make sure $routes is an array
 				$routes = (array) $routes;
@@ -323,8 +329,9 @@ 
 			}
 
 			//let's do the deregisters
-			if ( !isset( $this->_scripts_styles['deregisters'] ) )
-				return;
+			if ( !isset( $this->_scripts_styles['deregisters'] ) ) {
+							return;
+			}
 			foreach ( $this->_scripts_styles['deregisters'] as $ref => $details ) {
 				$defaults = array(
 					'type' => 'js'
@@ -376,8 +383,9 @@ 
 
 		//first default file (if exists)
 		$decaf_file = EE_ADMIN_PAGES . $this->_name . DS . $ref . '.core.php';
-		if ( is_readable( $decaf_file ) )
-		require_once( $decaf_file );
+		if ( is_readable( $decaf_file ) ) {
+				require_once( $decaf_file );
+		}
 
 		//now we have to do require for extended file (if needed)
 		if ( $this->_extend ) {
@@ -486,12 +494,14 @@ 
 
 		foreach ( $hook_filter_array as $hook => $args ) {
 			if ( method_exists( $this, $this->_current_route . '_' . $hook ) ) {
-				if ( isset( $this->_wp_action_filters_priority[$hook] ) )
-					$args['priority'] = $this->_wp_action_filters_priority[$hook];
-				if ( $args['type'] == 'action' )
-					add_action( $hook, array( $this, $this->_current_route . '_' . $hook ), $args['priority'], $args['argnum'] );
-				else
-					add_filter( $hook, array( $this, $this->_current_route . '_' . $hook ), $args['priority'], $args['argnum'] );
+				if ( isset( $this->_wp_action_filters_priority[$hook] ) ) {
+									$args['priority'] = $this->_wp_action_filters_priority[$hook];
+				}
+				if ( $args['type'] == 'action' ) {
+									add_action( $hook, array( $this, $this->_current_route . '_' . $hook ), $args['priority'], $args['argnum'] );
+				} else {
+									add_filter( $hook, array( $this, $this->_current_route . '_' . $hook ), $args['priority'], $args['argnum'] );
+				}
 			}
 		}
 
@@ -504,8 +514,10 @@ 
 	 */
 	private function _ajax_hooks() {
 
-		if ( empty( $this->_ajax_func) )
-			return; //get out there's nothing to take care of.
+		if ( empty( $this->_ajax_func) ) {
+					return;
+		}
+		//get out there's nothing to take care of.
 
 		foreach ( $this->_ajax_func as $action => $method ) {
 			//make sure method exists
@@ -528,8 +540,10 @@ 
 	 * @return void
 	 */
 	protected function _init_hooks() {
-		if ( empty( $this->_init_func) )
-			return; //get out there's nothing to take care of.
+		if ( empty( $this->_init_func) ) {
+					return;
+		}
+		//get out there's nothing to take care of.
 
 		//We need to determine what page_route we are on!
 		$current_route = isset ( $_REQUEST['action'] ) ? $_REQUEST['action'] : 'default';
@@ -541,8 +555,9 @@ 
 				$msg[] = sprintf( __('The method name given in the array is %s, check the spelling and make sure it exists in the %s class', 'event_espresso' ), $method, $this->caller );
 				throw new EE_Error( implode('||', $msg ) );
 			}
-			if ( $route == $this->_current_route )
-				add_action('admin_init', array( $this, $method ) );
+			if ( $route == $this->_current_route ) {
+							add_action('admin_init', array( $this, $method ) );
+			}
 		}
 
 	}
@@ -557,8 +572,10 @@ 
 	 * @return void
 	 */
 	public function add_metaboxes() {
-		if ( empty( $this->_metaboxes ) )
-			return; //get out we don't have any metaboxes to set for this connection
+		if ( empty( $this->_metaboxes ) ) {
+					return;
+		}
+		//get out we don't have any metaboxes to set for this connection
 
 		$this->_handle_metabox_array( $this->_metaboxes );
 
@@ -569,19 +586,24 @@ 
 	private function _handle_metabox_array( $boxes, $add = TRUE ) {
 
 		foreach ( $boxes as $box ) {
-			if ( !isset($box['page_route']) )
-				continue; //we dont' have a valid array
+			if ( !isset($box['page_route']) ) {
+							continue;
+			}
+			//we dont' have a valid array
 
 			//let's make sure $box['page_route'] is an array so the "foreach" will work.
 			$box['page_route'] = (array) $box['page_route'];
 
 			foreach ( $box['page_route'] as $route ) {
-				if ( $route != $this->_current_route )
-					continue; //get out we only add metaboxes for set route.
-				if ( $add )
-					$this->_add_metabox($box);
-				else
-					$this->_remove_metabox($box);
+				if ( $route != $this->_current_route ) {
+									continue;
+				}
+				//get out we only add metaboxes for set route.
+				if ( $add ) {
+									$this->_add_metabox($box);
+				} else {
+									$this->_remove_metabox($box);
+				}
 			}
 		}
 	}
@@ -596,8 +618,10 @@ 
 	 */
 	public function remove_metaboxes() {
 
-		if ( empty( $this->_remove_metaboxes ) )
-			return; //get out there are no metaboxes to remove
+		if ( empty( $this->_remove_metaboxes ) ) {
+					return;
+		}
+		//get out there are no metaboxes to remove
 
 		$this->_handle_metabox_array( $this->_remove_metaboxes, FALSE );
 	}

Spacing +105 added lines, -105 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -209,7 +209,7 @@ 
 	 * constructor
 	 * @param EE_Admin_Page $admin_page the calling admin_page_object
 	 */
-	public function __construct( EE_Admin_Page $adminpage ) {
+	public function __construct(EE_Admin_Page $adminpage) {
 
 		$this->_adminpage_obj = $adminpage;
 		$this->_req_data = array_merge($_GET, $_POST);
@@ -217,11 +217,11 @@ 
 		$this->_set_hooks_properties();
 
 		//first let's verify we're on the right page
-		if ( !isset( $this->_req_data['page'] ) || ( isset( $this->_req_data['page'] ) && $this->_adminpage_obj->page_slug != $this->_req_data['page'] ) )
+		if ( ! isset($this->_req_data['page']) || (isset($this->_req_data['page']) && $this->_adminpage_obj->page_slug != $this->_req_data['page']))
 			return; //get out nothing more to be done here.
 
 		//allow for extends to modify properties
-		if ( method_exists( $this, '_extend_properties' ) )
+		if (method_exists($this, '_extend_properties'))
 			$this->_extend_properties();
 
 		$this->_set_page_object();
@@ -229,9 +229,9 @@ 
 		$this->_load_custom_methods();
 		$this->_load_routed_hooks();
 
-		add_action( 'admin_enqueue_scripts', array($this, 'enqueue_scripts_styles' ) );
-		add_action( 'admin_enqueue_scripts', array($this, 'add_metaboxes'), 20 );
-		add_action( 'admin_enqueue_scripts', array($this, 'remove_metaboxes'), 15 );
+		add_action('admin_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
+		add_action('admin_enqueue_scripts', array($this, 'add_metaboxes'), 20);
+		add_action('admin_enqueue_scripts', array($this, 'remove_metaboxes'), 15);
 
 		$this->_ajax_hooks();
 
@@ -272,15 +272,15 @@ 
 	 */
 	public function enqueue_scripts_styles() {
 
-		if ( !empty( $this->_scripts_styles ) ) {
+		if ( ! empty($this->_scripts_styles)) {
 			//first let's do all the registrations
-			if ( !isset($this->_scripts_styles['registers'] ) ) {
+			if ( ! isset($this->_scripts_styles['registers'])) {
 				$msg[] = __('There is no "registers" index in the <code>$this->_scripts_styles</code> property.', 'event_espresso');
-				$msg[] = sprintf ( __('Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child', 'event_espresso'), '<strong>' . $this->caller . '</strong>' );
-				throw new EE_Error( implode( '||', $msg ) );
+				$msg[] = sprintf(__('Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child', 'event_espresso'), '<strong>'.$this->caller.'</strong>');
+				throw new EE_Error(implode('||', $msg));
 			}
 
-			foreach( $this->_scripts_styles['registers'] as $ref => $details ) {
+			foreach ($this->_scripts_styles['registers'] as $ref => $details) {
 				$defaults = array(
 					'type' => 'js',
 					'url' => '',
@@ -289,48 +289,48 @@ 
 					'footer' => TRUE
 					);
 				$details = wp_parse_args($details, $defaults);
-				extract( $details );
+				extract($details);
 
 				//let's make sure that we set the 'registers' type if it's not set! We need it later to determine whhich enqueu we do
 				$this->_scripts_styles['registers'][$ref]['type'] = $type;
 
 				//let's make sure we're not missing any REQUIRED parameters
-				if ( empty($url) ) {
-					$msg[] = sprintf( __('Missing the url for the requested %s', 'event_espresso'), $type == 'js' ? 'script' : 'stylesheet' );
-					$msg[] = sprintf( __('Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref', 'event_espresso'), '<strong>' . $this->caller . '</strong>', $ref );
-					throw new EE_Error( implode( '||', $msg ) );
+				if (empty($url)) {
+					$msg[] = sprintf(__('Missing the url for the requested %s', 'event_espresso'), $type == 'js' ? 'script' : 'stylesheet');
+					$msg[] = sprintf(__('Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref', 'event_espresso'), '<strong>'.$this->caller.'</strong>', $ref);
+					throw new EE_Error(implode('||', $msg));
 				}
 				//made it here so let's do the appropriate registration
-				$type == 'js' ? wp_register_script( $ref, $url, $depends, $version, $footer ) : wp_register_style( $ref, $url, $depends, $version );
+				$type == 'js' ? wp_register_script($ref, $url, $depends, $version, $footer) : wp_register_style($ref, $url, $depends, $version);
 			}
 
 			//k now lets do the enqueues
-			if( !isset( $this->_scripts_styles['enqueues'] ) )
-				return;  //not sure if we should throw an error here or not.
-			foreach( $this->_scripts_styles['enqueues'] as $ref => $routes ) {
+			if ( ! isset($this->_scripts_styles['enqueues']))
+				return; //not sure if we should throw an error here or not.
+			foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
 				//make sure $routes is an array
 				$routes = (array) $routes;
 
-				if ( in_array($this->_current_route, $routes ) ) {
+				if (in_array($this->_current_route, $routes)) {
 					$this->_scripts_styles['registers'][$ref]['type'] == 'js' ? wp_enqueue_script($ref) : wp_enqueue_style($ref);
 					//if we have a localization for the script let's do that too.
-					if ( isset( $this->_scripts_styles['localize'][$ref] ) ) {
-						foreach ( $this->_scripts_styles['localize'][$ref] as $object_name => $indexes ) {
-							wp_localize_script($ref, $object_name , $this->_scripts_styles['localize'][$ref][$object_name] );
+					if (isset($this->_scripts_styles['localize'][$ref])) {
+						foreach ($this->_scripts_styles['localize'][$ref] as $object_name => $indexes) {
+							wp_localize_script($ref, $object_name, $this->_scripts_styles['localize'][$ref][$object_name]);
 						}
 					}
 				}
 			}
 
 			//let's do the deregisters
-			if ( !isset( $this->_scripts_styles['deregisters'] ) )
+			if ( ! isset($this->_scripts_styles['deregisters']))
 				return;
-			foreach ( $this->_scripts_styles['deregisters'] as $ref => $details ) {
+			foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
 				$defaults = array(
 					'type' => 'js'
 					);
-				$details = wp_parse_args( $details, $defaults );
-				extract( $details );
+				$details = wp_parse_args($details, $defaults);
+				extract($details);
 
 				$type == 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
 
@@ -349,7 +349,7 @@ 
 	 */
 	private function _set_defaults() {
 		$this->_ajax_func = $this->_init_func = $this->_metaboxes = $this->_scripts = $this->_styles = $this->_wp_action_filters_priority = array();
-		$this->_current_route = isset( $_REQUEST['action'] ) ? $_REQUEST['action'] : 'default';
+		$this->_current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
 		$this->caller = get_class($this);
 		$this->_extend = stripos($this->caller, 'Extend') ? TRUE : FALSE;
 	}
@@ -364,34 +364,34 @@ 
 	 */
 	protected function _set_page_object() {
 		//first make sure $this->_name is set
-		if ( empty( $this->_name ) ) {
+		if (empty($this->_name)) {
 			$msg[] = __('We can\'t load the page object', 'event_espresso');
-			$msg[] = sprintf( __("This is because the %s child class has not set the '_name' property", 'event_espresso'), $this->caller );
-			throw new EE_Error( implode( '||', $msg ) );
+			$msg[] = sprintf(__("This is because the %s child class has not set the '_name' property", 'event_espresso'), $this->caller);
+			throw new EE_Error(implode('||', $msg));
 		}
 
-		$ref = str_replace('_' , ' ', $this->_name); //take the_message -> the message
-		$ref = str_replace(' ', '_', ucwords($ref) ) . '_Admin_Page'; //take the message -> The_Message
+		$ref = str_replace('_', ' ', $this->_name); //take the_message -> the message
+		$ref = str_replace(' ', '_', ucwords($ref)).'_Admin_Page'; //take the message -> The_Message
 
 		//first default file (if exists)
-		$decaf_file = EE_ADMIN_PAGES . $this->_name . DS . $ref . '.core.php';
-		if ( is_readable( $decaf_file ) )
-		require_once( $decaf_file );
+		$decaf_file = EE_ADMIN_PAGES.$this->_name.DS.$ref.'.core.php';
+		if (is_readable($decaf_file))
+		require_once($decaf_file);
 
 		//now we have to do require for extended file (if needed)
-		if ( $this->_extend ) {
-			require_once( EE_CORE_CAF_ADMIN_EXTEND . $this->_name . DS . 'Extend_' . $ref . '.core.php' );
+		if ($this->_extend) {
+			require_once(EE_CORE_CAF_ADMIN_EXTEND.$this->_name.DS.'Extend_'.$ref.'.core.php');
 		}
 
 
 		//if we've got an extended class we use that!
-		$ref = $this->_extend ? 'Extend_' . $ref : $ref;
+		$ref = $this->_extend ? 'Extend_'.$ref : $ref;
 
 		//let's make sure the class exists
-		if ( !class_exists( $ref ) ) {
+		if ( ! class_exists($ref)) {
 			$msg[] = __('We can\'t load the page object', 'event_espresso');
-			$msg[] = sprintf( __('The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class', 'event_espresso'), $ref );
-			throw new EE_Error( implode( '||', $msg ) );
+			$msg[] = sprintf(__('The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class', 'event_espresso'), $ref);
+			throw new EE_Error(implode('||', $msg));
 		}
 
 		$a = new ReflectionClass($ref);
@@ -416,27 +416,27 @@ 
 		$method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
 
 		//these run before the Admin_Page route executes.
-		if ( method_exists( $this, $method_callback ) ) {
-			call_user_func( array( $this, $method_callback) );
+		if (method_exists($this, $method_callback)) {
+			call_user_func(array($this, $method_callback));
 		}
 
 
 		//these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the seond fires right before the actual redirect happens.
 		//first the actions
 		//note that these action hooks will have the $query_args value available.
-		$admin_class_name = get_class( $this->_adminpage_obj );
+		$admin_class_name = get_class($this->_adminpage_obj);
 
-		if ( method_exists( $this, '_redirect_action_early_' . $this->_current_route ) ) {
-			add_action( 'AHEE__' . $admin_class_name . '___redirect_after_action__before_redirect_modification_' . $this->_current_route, array( $this, '_redirect_action_early_' . $this->_current_route ), 10 );
+		if (method_exists($this, '_redirect_action_early_'.$this->_current_route)) {
+			add_action('AHEE__'.$admin_class_name.'___redirect_after_action__before_redirect_modification_'.$this->_current_route, array($this, '_redirect_action_early_'.$this->_current_route), 10);
 		}
 
-		if ( method_exists( $this, '_redirect_action_' . $this->_current_route ) ) {
-			add_action( 'AHEE_redirect_' . $admin_class_name . $this->_current_route, array( $this, '_redirect_action_' . $this->_current_route ), 10 );
+		if (method_exists($this, '_redirect_action_'.$this->_current_route)) {
+			add_action('AHEE_redirect_'.$admin_class_name.$this->_current_route, array($this, '_redirect_action_'.$this->_current_route), 10);
 		}
 
 		//let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-		if ( method_exists( $this, '_redirect_filter_' . $this->_current_route ) ) {
-			add_filter( 'FHEE_redirect_' . $admin_class_name . $this->_current_route, array( $this, '_redirect_filter_' . $this->_current_route ), 10, 2 );
+		if (method_exists($this, '_redirect_filter_'.$this->_current_route)) {
+			add_filter('FHEE_redirect_'.$admin_class_name.$this->_current_route, array($this, '_redirect_filter_'.$this->_current_route), 10, 2);
 		}
 
 	}
@@ -459,12 +459,12 @@ 
 				'argnum' => 1,
 				'priority' => 10
 				),
-			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => array(
+			'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug.'_'.$this->_current_route => array(
 				'type' => 'filter',
 				'argnum' => 1,
 				'priority' => 10
 				),
-			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug => array(
+			'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug => array(
 				'type' => 'filter',
 				'argnum' => 1,
 				'priority' => 10
@@ -483,14 +483,14 @@ 
 
 
 
-		foreach ( $hook_filter_array as $hook => $args ) {
-			if ( method_exists( $this, $this->_current_route . '_' . $hook ) ) {
-				if ( isset( $this->_wp_action_filters_priority[$hook] ) )
+		foreach ($hook_filter_array as $hook => $args) {
+			if (method_exists($this, $this->_current_route.'_'.$hook)) {
+				if (isset($this->_wp_action_filters_priority[$hook]))
 					$args['priority'] = $this->_wp_action_filters_priority[$hook];
-				if ( $args['type'] == 'action' )
-					add_action( $hook, array( $this, $this->_current_route . '_' . $hook ), $args['priority'], $args['argnum'] );
+				if ($args['type'] == 'action')
+					add_action($hook, array($this, $this->_current_route.'_'.$hook), $args['priority'], $args['argnum']);
 				else
-					add_filter( $hook, array( $this, $this->_current_route . '_' . $hook ), $args['priority'], $args['argnum'] );
+					add_filter($hook, array($this, $this->_current_route.'_'.$hook), $args['priority'], $args['argnum']);
 			}
 		}
 
@@ -503,18 +503,18 @@ 
 	 */
 	private function _ajax_hooks() {
 
-		if ( empty( $this->_ajax_func) )
+		if (empty($this->_ajax_func))
 			return; //get out there's nothing to take care of.
 
-		foreach ( $this->_ajax_func as $action => $method ) {
+		foreach ($this->_ajax_func as $action => $method) {
 			//make sure method exists
-			if ( !method_exists($this, $method) ) {
-				$msg[] = __('There is no corresponding method for the hook labeled in the _ajax_func array', 'event_espresso') . '<br />';
-				$msg[] = sprintf( __('The method name given in the array is %s, check the spelling and make sure it exists in the %s class', 'event_espresso' ), $method, $this->caller );
-				throw new EE_Error( implode('||', $msg ) );
+			if ( ! method_exists($this, $method)) {
+				$msg[] = __('There is no corresponding method for the hook labeled in the _ajax_func array', 'event_espresso').'<br />';
+				$msg[] = sprintf(__('The method name given in the array is %s, check the spelling and make sure it exists in the %s class', 'event_espresso'), $method, $this->caller);
+				throw new EE_Error(implode('||', $msg));
 			}
 
-			add_action('wp_ajax_' . $action, array( $this, $method ) );
+			add_action('wp_ajax_'.$action, array($this, $method));
 		}
 
 	}
@@ -527,21 +527,21 @@ 
 	 * @return void
 	 */
 	protected function _init_hooks() {
-		if ( empty( $this->_init_func) )
+		if (empty($this->_init_func))
 			return; //get out there's nothing to take care of.
 
 		//We need to determine what page_route we are on!
-		$current_route = isset ( $_REQUEST['action'] ) ? $_REQUEST['action'] : 'default';
+		$current_route = isset ($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
 
-		foreach ( $this->_init_func as $route => $method ) {
+		foreach ($this->_init_func as $route => $method) {
 			//make sure method exists
-			if ( !method_exists($this, $method) ) {
-				$msg[] = __('There is no corresponding method for the hook labeled in the _init_func array', 'event_espresso') . '<br />';
-				$msg[] = sprintf( __('The method name given in the array is %s, check the spelling and make sure it exists in the %s class', 'event_espresso' ), $method, $this->caller );
-				throw new EE_Error( implode('||', $msg ) );
+			if ( ! method_exists($this, $method)) {
+				$msg[] = __('There is no corresponding method for the hook labeled in the _init_func array', 'event_espresso').'<br />';
+				$msg[] = sprintf(__('The method name given in the array is %s, check the spelling and make sure it exists in the %s class', 'event_espresso'), $method, $this->caller);
+				throw new EE_Error(implode('||', $msg));
 			}
-			if ( $route == $this->_current_route )
-				add_action('admin_init', array( $this, $method ) );
+			if ($route == $this->_current_route)
+				add_action('admin_init', array($this, $method));
 		}
 
 	}
@@ -556,28 +556,28 @@ 
 	 * @return void
 	 */
 	public function add_metaboxes() {
-		if ( empty( $this->_metaboxes ) )
+		if (empty($this->_metaboxes))
 			return; //get out we don't have any metaboxes to set for this connection
 
-		$this->_handle_metabox_array( $this->_metaboxes );
+		$this->_handle_metabox_array($this->_metaboxes);
 
 	}
 
 
 
-	private function _handle_metabox_array( $boxes, $add = TRUE ) {
+	private function _handle_metabox_array($boxes, $add = TRUE) {
 
-		foreach ( $boxes as $box ) {
-			if ( !isset($box['page_route']) )
+		foreach ($boxes as $box) {
+			if ( ! isset($box['page_route']))
 				continue; //we dont' have a valid array
 
 			//let's make sure $box['page_route'] is an array so the "foreach" will work.
 			$box['page_route'] = (array) $box['page_route'];
 
-			foreach ( $box['page_route'] as $route ) {
-				if ( $route != $this->_current_route )
+			foreach ($box['page_route'] as $route) {
+				if ($route != $this->_current_route)
 					continue; //get out we only add metaboxes for set route.
-				if ( $add )
+				if ($add)
 					$this->_add_metabox($box);
 				else
 					$this->_remove_metabox($box);
@@ -595,10 +595,10 @@ 
 	 */
 	public function remove_metaboxes() {
 
-		if ( empty( $this->_remove_metaboxes ) )
+		if (empty($this->_remove_metaboxes))
 			return; //get out there are no metaboxes to remove
 
-		$this->_handle_metabox_array( $this->_remove_metaboxes, FALSE );
+		$this->_handle_metabox_array($this->_remove_metaboxes, FALSE);
 	}
 
 
@@ -608,53 +608,53 @@ 
 	 * @access private
 	 * @param array $args an array of args that have been set for this metabox by the child class
 	 */
-	private function _add_metabox( $args ) {
+	private function _add_metabox($args) {
 		$current_screen = get_current_screen();
-		$screen_id = is_object( $current_screen ) ? $current_screen->id : NULL;
-		$func = isset( $args['func'] ) ? $args['func'] : 'some_invalid_callback';
+		$screen_id = is_object($current_screen) ? $current_screen->id : NULL;
+		$func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
 
 		//set defaults
 		$defaults = array(
 			'func' => $func,
-			'id' => $this->caller . '_' . $func . '_metabox',
+			'id' => $this->caller.'_'.$func.'_metabox',
 			'priority' => 'default',
 			'label' => $this->caller,
 			'context' => 'advanced',
 			'callback_args' => array(),
-			'page' => isset( $args['page'] ) ? $args['page'] : $screen_id
+			'page' => isset($args['page']) ? $args['page'] : $screen_id
 			);
 
-		$args = wp_parse_args( $args, $defaults );
+		$args = wp_parse_args($args, $defaults);
 		extract($args);
 
 
 		//make sure method exists
-		if ( !method_exists($this, $func) ) {
-			$msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso') . '<br />';
-			$msg[] = sprintf( __('The method name given in the array is %s, check the spelling and make sure it exists in the %s class', 'event_espresso' ), $func, $this->caller );
-			throw new EE_Error( implode('||', $msg ) );
+		if ( ! method_exists($this, $func)) {
+			$msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso').'<br />';
+			$msg[] = sprintf(__('The method name given in the array is %s, check the spelling and make sure it exists in the %s class', 'event_espresso'), $func, $this->caller);
+			throw new EE_Error(implode('||', $msg));
 		}
 
 		//everything checks out so lets add the metabox
-		add_meta_box( $id, $label, array( $this, $func ), $page, $context, $priority, $callback_args);
+		add_meta_box($id, $label, array($this, $func), $page, $context, $priority, $callback_args);
 	}
 
 
 
-	private function _remove_metabox( $args ) {
+	private function _remove_metabox($args) {
 		$current_screen = get_current_screen();
-		$screen_id = is_object( $current_screen ) ? $current_screen->id : NULL;
-		$func = isset( $args['func'] ) ? $args['func'] : 'some_invalid_callback';
+		$screen_id = is_object($current_screen) ? $current_screen->id : NULL;
+		$func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
 
 		//set defaults
 		$defaults = array(
-			'id' => isset( $args['id'] ) ? $args['id'] : $this->_current_route . '_' . $this->caller . '_' . $func . '_metabox',
+			'id' => isset($args['id']) ? $args['id'] : $this->_current_route.'_'.$this->caller.'_'.$func.'_metabox',
 			'context' => 'default',
-			'screen' => isset( $args['screen'] ) ? $args['screen'] : $screen_id
+			'screen' => isset($args['screen']) ? $args['screen'] : $screen_id
 		);
 
-		$args = wp_parse_args( $args, $defaults );
-		extract( $args );
+		$args = wp_parse_args($args, $defaults);
+		extract($args);
 
 		//everything checks out so lets remove the box!
 		remove_meta_box($id, $screen, $context);

core/admin/EE_Admin_List_Table.core.php

Doc Comments +2 added lines, -2 removed lines

@@ -304,7 +304,7 @@ 
 	/**
 	 * _get_hidden_fields
 	 * returns a html string of hidden fields so if any table filters are used the current view will be respected.
-	 * @return html string
+	 * @return string string
 	 */
 	protected function _get_hidden_fields() {
 		$action = isset( $this->_req_data['route'] ) ? $this->_req_data['route'] : '';
@@ -512,7 +512,7 @@ 
 	 * @since 4.1
 	 * @access public
 	 *
-	 * @param object $item The current item
+	 * @param EE_Message_Template_Group $item The current item
 	 */
 	public function single_row( $item ) {
 		$row_class = $this->_get_row_class( $item );

Indentation +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
  */
 
 if ( ! class_exists( 'WP_List_Table' )) {
-    require_once( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' );
+	require_once( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' );
 }
 
 abstract class EE_Admin_List_Table extends WP_List_Table {

Braces +14 added lines, -12 removed lines

@@ -1,6 +1,7 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if (!defined('EVENT_ESPRESSO_VERSION') ) {
 	exit('NO direct script access allowed');
+}
 
 
 /**
@@ -362,8 +363,9 @@ 
 
 		$sortable = array();
 		foreach ( $_sortable as $id => $data ) {
-			if ( empty( $data ) )
-				continue;
+			if ( empty( $data ) ) {
+							continue;
+			}
 
 			//fix for offset errors with WP_List_Table default get_columninfo()
 			if ( is_array($data) ) {
@@ -375,8 +377,9 @@ 
 
 			$data = (array) $data;
 
-			if ( !isset( $data[1] ) )
-				$_data[1] = false;
+			if ( !isset( $data[1] ) ) {
+							$_data[1] = false;
+			}
 
 
 			$sortable[$id] = $_data;
@@ -399,11 +402,12 @@ 
 		$actions = array();
 		//the _views property should have the bulk_actions, so let's go through and extract them into a properly formatted array for the wp_list_table();
 		foreach ( $this->_views as $view => $args) {
-			if ( isset( $args['bulk_action']) && is_array($args['bulk_action']) && $this->_view == $view )
-				//each bulk action will correspond with a admin page route, so we can check whatever the capability is for that page route and skip adding the bulk action if no access for the current logged in user.
+			if ( isset( $args['bulk_action']) && is_array($args['bulk_action']) && $this->_view == $view ) {
+							//each bulk action will correspond with a admin page route, so we can check whatever the capability is for that page route and skip adding the bulk action if no access for the current logged in user.
 				foreach ( $args['bulk_action'] as $route =>$label ) {
 					if ( $this->_admin_page->check_user_access( $route, true ) ) {
 						$actions[$route] = $label;
+			}
 					}
 				}
 		}
@@ -633,14 +637,12 @@ 
 				echo '<th scope="row" class="check-column">';
 				echo apply_filters( 'FHEE__EE_Admin_List_Table__single_row_columns__column_cb_content', $this->column_cb( $item ), $item, $this );
 				echo '</th>';
-			}
-			elseif ( method_exists( $this, 'column_' . $column_name ) ) {
+			} elseif ( method_exists( $this, 'column_' . $column_name ) ) {
 				echo "<td $attributes>";
 				echo apply_filters( 'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content', call_user_func( array( $this, 'column_' . $column_name ), $item ), $item, $this );
 				echo $this->handle_row_actions( $item, $column_name, $primary );
 				echo "</td>";
-			}
-			else {
+			} else {
 				echo "<td $attributes>";
 				echo apply_filters( 'FHEE__EE_Admin_List_Table__single_row_columns__column_default__column_content', $this->column_default( $item, $column_name ), $item, $column_name, $this );
 				echo $this->handle_row_actions( $item, $column_name, $primary );
@@ -656,7 +658,7 @@ 
 			$this->_filters();
 			echo $this->_get_hidden_fields();
 			echo '<br class="clear">';
-		}else{
+		} else{
 			echo '<div class="list-table-bottom-buttons alignleft actions">';
 			foreach($this->_bottom_buttons as $type => $action){
 				$route = isset( $action['route'] ) ? $action['route'] : '';

Spacing +92 added lines, -92 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 
@@ -31,8 +31,8 @@ 
  * ------------------------------------------------------------------------
  */
 
-if ( ! class_exists( 'WP_List_Table' )) {
-    require_once( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' );
+if ( ! class_exists('WP_List_Table')) {
+    require_once(ABSPATH.'wp-admin/includes/class-wp-list-table.php');
 }
 
 abstract class EE_Admin_List_Table extends WP_List_Table {
@@ -234,16 +234,16 @@ 
 	 * constructor
 	 * @param EE_Admin_Page object $admin_page we use this for obtaining everything we need in the list table.
 	 */
-	public function __construct( EE_Admin_Page $admin_page ) {
+	public function __construct(EE_Admin_Page $admin_page) {
 		$this->_admin_page = $admin_page;
 		$this->_req_data = $this->_admin_page->get_request_data();
 		$this->_view = $this->_admin_page->get_view();
-		$this->_views = empty( $this->_views ) ? $this->_admin_page->get_list_table_view_RLs() : $this->_views;
+		$this->_views = empty($this->_views) ? $this->_admin_page->get_list_table_view_RLs() : $this->_views;
 		$this->_current_page = $this->get_pagenum();
-		$this->_screen = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
-		$this->_yes_no = array(  __('No', 'event_espresso'), __('Yes', 'event_espresso'));
+		$this->_screen = $this->_admin_page->get_current_page().'_'.$this->_admin_page->get_current_view();
+		$this->_yes_no = array(__('No', 'event_espresso'), __('Yes', 'event_espresso'));
 
-		$this->_per_page = $this->get_items_per_page( $this->_screen . '_per_page', 10 );
+		$this->_per_page = $this->get_items_per_page($this->_screen.'_per_page', 10);
 
 		$this->_setup_data();
 		$this->_add_view_counts();
@@ -253,7 +253,7 @@ 
 		$this->_set_properties();
 
 		//set primary column
-		add_filter( 'list_table_primary_column', array( $this, 'set_primary_column' ) );
+		add_filter('list_table_primary_column', array($this, 'set_primary_column'));
 
 		//set parent defaults
 		parent::__construct($this->_wp_list_args);
@@ -329,17 +329,17 @@ 
 	 * @return html string
 	 */
 	protected function _get_hidden_fields() {
-		$action = isset( $this->_req_data['route'] ) ? $this->_req_data['route'] : '';
-		$action = empty( $action ) && isset( $this->_req_data['action'] ) ? $this->_req_data['action'] : $action;
+		$action = isset($this->_req_data['route']) ? $this->_req_data['route'] : '';
+		$action = empty($action) && isset($this->_req_data['action']) ? $this->_req_data['action'] : $action;
 		//if action is STILL empty, then we set it to default
-		$action = empty( $action ) ? 'default' : $action;
-		$field = '<input type="hidden" name="page" value="' . $this->_req_data['page'] . '" />' . "\n";
-		$field .= '<input type="hidden" name="route" value="'. $action .'" />' . "\n";/**/
-		$field .= '<input type="hidden" name="perpage" value="' . $this->_per_page . '" />' . "\n";
+		$action = empty($action) ? 'default' : $action;
+		$field = '<input type="hidden" name="page" value="'.$this->_req_data['page'].'" />'."\n";
+		$field .= '<input type="hidden" name="route" value="'.$action.'" />'."\n"; /**/
+		$field .= '<input type="hidden" name="perpage" value="'.$this->_per_page.'" />'."\n";
 
 		$bulk_actions = $this->_get_bulk_actions();
-		foreach ( $bulk_actions as $bulk_action => $label ) {
-			$field .= '<input type="hidden" name="' . $bulk_action . '_nonce" value="' . wp_create_nonce  ( $bulk_action . '_nonce' ) . '" />' . "\n";
+		foreach ($bulk_actions as $bulk_action => $label) {
+			$field .= '<input type="hidden" name="'.$bulk_action.'_nonce" value="'.wp_create_nonce($bulk_action.'_nonce').'" />'."\n";
 		}
 
 		return $field;
@@ -369,15 +369,15 @@ 
 		 *
 		 * @var array
 		 */
-		$_sortable = apply_filters( "FHEE_manage_{$this->screen->id}_sortable_columns", $_sortable, $this->_screen );
+		$_sortable = apply_filters("FHEE_manage_{$this->screen->id}_sortable_columns", $_sortable, $this->_screen);
 
 		$sortable = array();
-		foreach ( $_sortable as $id => $data ) {
-			if ( empty( $data ) )
+		foreach ($_sortable as $id => $data) {
+			if (empty($data))
 				continue;
 
 			//fix for offset errors with WP_List_Table default get_columninfo()
-			if ( is_array($data) ) {
+			if (is_array($data)) {
 				$_data[0] = key($data);
 				$_data[1] = isset($data[1]) ? $data[1] : false;
 			} else {
@@ -386,14 +386,14 @@ 
 
 			$data = (array) $data;
 
-			if ( !isset( $data[1] ) )
+			if ( ! isset($data[1]))
 				$_data[1] = false;
 
 
 			$sortable[$id] = $_data;
 		}
 		$primary = $this->get_primary_column_name();
-		$this->_column_headers = array( $columns, $hidden, $sortable, $primary );
+		$this->_column_headers = array($columns, $hidden, $sortable, $primary);
 	}
 
 
@@ -402,8 +402,8 @@ 
 	 * @return string
 	 */
 	protected function get_primary_column_name() {
-		foreach( class_parents( $this ) as $parent ) {
-			if ( method_exists( $parent, 'get_primary_column_name' ) && $parent == 'WP_List_Table' ) {
+		foreach (class_parents($this) as $parent) {
+			if (method_exists($parent, 'get_primary_column_name') && $parent == 'WP_List_Table') {
 				return parent::get_primary_column_name();
 			}
 		}
@@ -415,10 +415,10 @@ 
 	 * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
 	 * @return string
 	 */
-	protected function handle_row_actions( $item, $column_name, $primary ) {
-		foreach( class_parents( $this ) as $parent ) {
-			if ( method_exists( $parent, 'handle_row_actions' ) && $parent == 'WP_List_Table' ) {
-				return parent::handle_row_actions( $item, $column_name, $primary );
+	protected function handle_row_actions($item, $column_name, $primary) {
+		foreach (class_parents($this) as $parent) {
+			if (method_exists($parent, 'handle_row_actions') && $parent == 'WP_List_Table') {
+				return parent::handle_row_actions($item, $column_name, $primary);
 			}
 		}
 		'';
@@ -436,11 +436,11 @@ 
 	protected function _get_bulk_actions() {
 		$actions = array();
 		//the _views property should have the bulk_actions, so let's go through and extract them into a properly formatted array for the wp_list_table();
-		foreach ( $this->_views as $view => $args) {
-			if ( isset( $args['bulk_action']) && is_array($args['bulk_action']) && $this->_view == $view )
+		foreach ($this->_views as $view => $args) {
+			if (isset($args['bulk_action']) && is_array($args['bulk_action']) && $this->_view == $view)
 				//each bulk action will correspond with a admin page route, so we can check whatever the capability is for that page route and skip adding the bulk action if no access for the current logged in user.
-				foreach ( $args['bulk_action'] as $route =>$label ) {
-					if ( $this->_admin_page->check_user_access( $route, true ) ) {
+				foreach ($args['bulk_action'] as $route =>$label) {
+					if ($this->_admin_page->check_user_access($route, true)) {
 						$actions[$route] = $label;
 					}
 				}
@@ -458,18 +458,18 @@ 
 	 */
 	private function _filters() {
 		$classname = get_class($this);
-		$filters = apply_filters( "FHEE__{$classname}__filters", (array) $this->_get_table_filters(), $this, $this->_screen );
+		$filters = apply_filters("FHEE__{$classname}__filters", (array) $this->_get_table_filters(), $this, $this->_screen);
 
-		if ( empty( $filters )) {
+		if (empty($filters)) {
 			return;
 		}
-		foreach ( $filters as $filter ) {
+		foreach ($filters as $filter) {
 			echo $filter;
 		}
 		//add filter button at end
-		echo '<input type="submit" class="button-secondary" value="' . __('Filter', 'event_espresso') . '" id="post-query-submit" />';
+		echo '<input type="submit" class="button-secondary" value="'.__('Filter', 'event_espresso').'" id="post-query-submit" />';
 		//add reset filters button at end
-		echo '<a class="button button-secondary"  href="' . $this->_admin_page->get_current_page_view_url() . '" style="display:inline-block">' . __('Reset Filters', 'event_espresso') . '</a>';
+		echo '<a class="button button-secondary"  href="'.$this->_admin_page->get_current_page_view_url().'" style="display:inline-block">'.__('Reset Filters', 'event_espresso').'</a>';
 	}
 
 
@@ -483,8 +483,8 @@ 
 	 * @param string $column_name
 	 * @return string
 	 */
-	public function set_primary_column( $column_name ) {
-		return ! empty( $this->_primary_column ) ? $this->_primary_column : $column_name;
+	public function set_primary_column($column_name) {
+		return ! empty($this->_primary_column) ? $this->_primary_column : $column_name;
 	}
 
 
@@ -503,7 +503,7 @@ 
 			array(
 				'total_items' => $total_items,
 				'per_page' => $this->_per_page,
-				'total_pages' => ceil($total_items / $this->_per_page )
+				'total_pages' => ceil($total_items / $this->_per_page)
 			)
 		);
 	}
@@ -519,7 +519,7 @@ 
 	 *
 	 * @return string html content for the column
 	 */
-	public function column_default( $item, $column_name ) {
+	public function column_default($item, $column_name) {
 		/**
 		 * Dynamic hook allowing for adding additional column content in this list table.
 		 * Note that $this->screen->id is in the format
@@ -529,7 +529,7 @@ 
 		 * hook prefix ("event-espresso") will be different.
 		 *
 		 */
-		do_action( 'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id, $item, $this->_screen );
+		do_action('AHEE__EE_Admin_List_Table__column_'.$column_name.'__'.$this->screen->id, $item, $this->_screen);
 	}
 
 
@@ -545,7 +545,7 @@ 
 		 *
 		 * @var array
 		 */
-		$columns = apply_filters( 'FHEE_manage_'.$this->screen->id.'_columns', $this->_columns, $this->_screen );
+		$columns = apply_filters('FHEE_manage_'.$this->screen->id.'_columns', $this->_columns, $this->_screen);
 		return $columns;
 	}
 
@@ -557,18 +557,18 @@ 
 		$views = $this->get_views();
 		$assembled_views = '';
 
-		if ( empty( $views )) {
+		if (empty($views)) {
 			return;
 		}
 		echo "<ul class='subsubsub'>\n";
-		foreach ( $views as $view ) {
-			$count = isset($view['count'] ) && !empty($view['count']) ? absint( $view['count'] )  : 0;
-			if ( isset( $view['slug'] ) && isset( $view['class'] ) && isset( $view['url'] ) && isset( $view['label']) ) {
-				$assembled_views[ $view['slug'] ] = "\t<li class='" . $view['class'] . "'>" . '<a href="' . $view['url'] . '">' . $view['label'] . '</a> <span class="count">(' . $count . ')</span>';
+		foreach ($views as $view) {
+			$count = isset($view['count']) && ! empty($view['count']) ? absint($view['count']) : 0;
+			if (isset($view['slug']) && isset($view['class']) && isset($view['url']) && isset($view['label'])) {
+				$assembled_views[$view['slug']] = "\t<li class='".$view['class']."'>".'<a href="'.$view['url'].'">'.$view['label'].'</a> <span class="count">('.$count.')</span>';
 			}
 		}
 
-		echo is_array( $assembled_views) && ! empty( $assembled_views ) ? implode( " |</li>\n", $assembled_views ) . "</li>\n" : '';
+		echo is_array($assembled_views) && ! empty($assembled_views) ? implode(" |</li>\n", $assembled_views)."</li>\n" : '';
 		echo "</ul>";
 	}
 
@@ -581,10 +581,10 @@ 
 	 *
 	 * @param object $item The current item
 	 */
-	public function single_row( $item ) {
-		$row_class = $this->_get_row_class( $item );
-		echo '<tr class="' . esc_attr( $row_class ) . '">';
-		$this->single_row_columns( $item );
+	public function single_row($item) {
+		$row_class = $this->_get_row_class($item);
+		echo '<tr class="'.esc_attr($row_class).'">';
+		$this->single_row_columns($item);
 		echo '</tr>';
 	}
 
@@ -595,13 +595,13 @@ 
 	 * @param  object $item the current item
 	 * @return string
 	 */
-	protected function _get_row_class( $item ) {
+	protected function _get_row_class($item) {
 		static $row_class = '';
-		$row_class = ( $row_class == '' ? 'alternate' : '' );
+		$row_class = ($row_class == '' ? 'alternate' : '');
 
 		$new_row_class = $row_class;
 
-		if ( !empty($this->_ajax_sorting_callback) ) {
+		if ( ! empty($this->_ajax_sorting_callback)) {
 			$new_row_class .= ' rowsortable';
 		}
 
@@ -620,13 +620,13 @@ 
 
 	public function get_hidden_columns() {
 		$user_id = get_current_user_id();
-		$has_default = get_user_option('default'. $this->screen->id . 'columnshidden', $user_id);
-		if ( empty( $has_default ) && !empty($this->_hidden_columns ) ) {
-			update_user_option($user_id, 'default'.$this->screen->id . 'columnshidden', TRUE);
-			update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, TRUE );
+		$has_default = get_user_option('default'.$this->screen->id.'columnshidden', $user_id);
+		if (empty($has_default) && ! empty($this->_hidden_columns)) {
+			update_user_option($user_id, 'default'.$this->screen->id.'columnshidden', TRUE);
+			update_user_option($user_id, 'manage'.$this->screen->id.'columnshidden', $this->_hidden_columns, TRUE);
 		}
-		$ref = 'manage' . $this->screen->id . 'columnshidden';
-		$saved_columns = (array) get_user_option( $ref, $user_id );
+		$ref = 'manage'.$this->screen->id.'columnshidden';
+		$saved_columns = (array) get_user_option($ref, $user_id);
 		return $saved_columns;
 	}
 
@@ -641,47 +641,47 @@ 
 	 *
 	 * @param object $item The current item
 	 */
-	public function single_row_columns( $item ) {
-		list( $columns, $hidden, $sortable, $primary ) = $this->get_column_info();
+	public function single_row_columns($item) {
+		list($columns, $hidden, $sortable, $primary) = $this->get_column_info();
 
 		global $wp_version;
-		$use_hidden_class = version_compare( $wp_version, '4.3-RC', '>=' );
+		$use_hidden_class = version_compare($wp_version, '4.3-RC', '>=');
 
-		foreach ( $columns as $column_name => $column_display_name ) {
+		foreach ($columns as $column_name => $column_display_name) {
 
 			/**
 			 * With WordPress version 4.3.RC+ WordPress started using the hidden css class to control whether columns are
 			 * hidden or not instead of using "display:none;".  This bit of code provides backward compat.
 			 */
-			$hidden_class = $use_hidden_class && in_array( $column_name, $hidden ) ? ' hidden' : '';
-			$style = ! $use_hidden_class && in_array( $column_name, $hidden ) ? ' style="display:none;"' : '';
+			$hidden_class = $use_hidden_class && in_array($column_name, $hidden) ? ' hidden' : '';
+			$style = ! $use_hidden_class && in_array($column_name, $hidden) ? ' style="display:none;"' : '';
 
-			$classes = $column_name . ' column-' . $column_name.$hidden_class;
-			if ( $primary == $column_name ) {
+			$classes = $column_name.' column-'.$column_name.$hidden_class;
+			if ($primary == $column_name) {
 				$classes .= ' has-row-actions column-primary';
 			}
 
-			$data = ' data-colname="' . wp_strip_all_tags( $column_display_name ) . '"';
+			$data = ' data-colname="'.wp_strip_all_tags($column_display_name).'"';
 
 			$class = "class='$classes'";
 
 			$attributes = "$class$style$data";
 
-			if ( 'cb' === $column_name ) {
+			if ('cb' === $column_name) {
 				echo '<th scope="row" class="check-column">';
-				echo apply_filters( 'FHEE__EE_Admin_List_Table__single_row_columns__column_cb_content', $this->column_cb( $item ), $item, $this );
+				echo apply_filters('FHEE__EE_Admin_List_Table__single_row_columns__column_cb_content', $this->column_cb($item), $item, $this);
 				echo '</th>';
 			}
-			elseif ( method_exists( $this, 'column_' . $column_name ) ) {
+			elseif (method_exists($this, 'column_'.$column_name)) {
 				echo "<td $attributes>";
-				echo apply_filters( 'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content', call_user_func( array( $this, 'column_' . $column_name ), $item ), $item, $this );
-				echo $this->handle_row_actions( $item, $column_name, $primary );
+				echo apply_filters('FHEE__EE_Admin_List_Table__single_row_columns__column_'.$column_name.'__column_content', call_user_func(array($this, 'column_'.$column_name), $item), $item, $this);
+				echo $this->handle_row_actions($item, $column_name, $primary);
 				echo "</td>";
 			}
 			else {
 				echo "<td $attributes>";
-				echo apply_filters( 'FHEE__EE_Admin_List_Table__single_row_columns__column_default__column_content', $this->column_default( $item, $column_name ), $item, $column_name, $this );
-				echo $this->handle_row_actions( $item, $column_name, $primary );
+				echo apply_filters('FHEE__EE_Admin_List_Table__single_row_columns__column_default__column_content', $this->column_default($item, $column_name), $item, $column_name, $this);
+				echo $this->handle_row_actions($item, $column_name, $primary);
 				echo "</td>";
 			}
 		}
@@ -689,19 +689,19 @@ 
 
 
 
-	public function extra_tablenav( $which ) {
-		if ( $which == 'top' ) {
+	public function extra_tablenav($which) {
+		if ($which == 'top') {
 			$this->_filters();
 			echo $this->_get_hidden_fields();
 			echo '<br class="clear">';
-		}else{
+		} else {
 			echo '<div class="list-table-bottom-buttons alignleft actions">';
-			foreach($this->_bottom_buttons as $type => $action){
-				$route = isset( $action['route'] ) ? $action['route'] : '';
-				$extra_request = isset( $action['extra_request'] ) ? $action['extra_request'] : '';
+			foreach ($this->_bottom_buttons as $type => $action) {
+				$route = isset($action['route']) ? $action['route'] : '';
+				$extra_request = isset($action['extra_request']) ? $action['extra_request'] : '';
 				echo $this->_admin_page->get_action_link_or_button($route, $type, $extra_request);
 			}
-			do_action( 'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', $this, $this->_screen );
+			do_action('AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', $this, $this->_screen);
 			echo '</div>';
 		}
 		//echo $this->_entries_per_page_dropdown;
@@ -751,13 +751,13 @@ 
 	 *
 	 * @return string The assembled action elements container.
 	 */
-	protected function _action_string( $action_items, $item, $action_container = 'ul', $action_class = '', $action_id = '' ) {
+	protected function _action_string($action_items, $item, $action_container = 'ul', $action_class = '', $action_id = '') {
 		$content = '';
-		$action_class = ! empty( $action_class ) ? ' class="' . $action_class . '"' : '';
-		$action_id = ! empty( $action_id ) ? ' id="' . $action_id . '"' : '';
-		$content .= ! empty( $action_container ) ? '<' . $action_container . $action_class . $action_id . '>' : '';
-		$content .= apply_filters( 'FHEE__EE_Admin_List_Table___action_string__action_items', $action_items, $item, $this );
-		$content .= ! empty( $container ) ? '</' . $container . '>' : '';
+		$action_class = ! empty($action_class) ? ' class="'.$action_class.'"' : '';
+		$action_id = ! empty($action_id) ? ' id="'.$action_id.'"' : '';
+		$content .= ! empty($action_container) ? '<'.$action_container.$action_class.$action_id.'>' : '';
+		$content .= apply_filters('FHEE__EE_Admin_List_Table___action_string__action_items', $action_items, $item, $this);
+		$content .= ! empty($container) ? '</'.$container.'>' : '';
 		return $content;
 	}
 }

core/admin/EE_Admin_Page_Init.core.php

Doc Comments +4 added lines, -2 removed lines

@@ -214,7 +214,6 @@ 
 	 *
 	 * @access  public
 	 * @uses   _initialize_admin_page()
-	 * @param  string $dir_name directory name for specific admin_page being loaded.
 	 * @return void
 	 */
 	public function initialize_admin_page() {
@@ -231,6 +230,9 @@ 
 
 
 
+	/**
+	 * @param string $wp_page_slug
+	 */
 	public function set_page_dependencies($wp_page_slug) {
 		if ( !$this->_load_page ) return;
 
@@ -428,7 +430,7 @@ 
 	/**
 	 * _check_user_access
 	 * verifies user access for this admin page.  If no user access is available then let's gracefully exit with a WordPress die message.
-	 * @return bool|die true if pass (or admin) wp_die if fail
+	 * @return boolean true if pass (or admin) wp_die if fail
 	 */
 	private function _check_user_access() {
 		if ( ! EE_Registry::instance()->CAP->current_user_can( $this->_menu_map->capability, $this->_menu_map->menu_slug ) ) {

Spacing +56 added lines, -56 removed lines

@@ -88,16 +88,16 @@ 
 		$this->_set_init_properties();
 
 		//global styles/scripts across all wp admin pages
-		add_action('admin_enqueue_scripts', array($this, 'load_wp_global_scripts_styles'), 5 );
+		add_action('admin_enqueue_scripts', array($this, 'load_wp_global_scripts_styles'), 5);
 
 		//load initial stuff.
 		$this->_set_file_and_folder_name();
 
 		$this->_set_menu_map();
 
-		if ( empty( $this->_menu_map ) || is_array( $this->_menu_map ) )
+		if (empty($this->_menu_map) || is_array($this->_menu_map))
 			 {
-			 	EE_Error::doing_it_wrong( get_class( $this ) . '::$_menu_map', sprintf( __('The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.', 'event_espresso' ), get_class( $this ) ), '4.4.0' );
+			 	EE_Error::doing_it_wrong(get_class($this).'::$_menu_map', sprintf(__('The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.', 'event_espresso'), get_class($this)), '4.4.0');
 			 	return;
 			 }
 
@@ -159,7 +159,7 @@ 
 	public function load_wp_global_scripts_styles() {
 		/** STYLES **/
 		//register
-		wp_register_style('espresso_menu', EE_ADMIN_URL . 'assets/admin-menu-styles.css');
+		wp_register_style('espresso_menu', EE_ADMIN_URL.'assets/admin-menu-styles.css');
 
 
 
@@ -201,8 +201,8 @@ 
 
 
 	protected function _set_capability() {
-		$capability = empty($this->capability) ?  $this->_menu_map->capability : $this->capability;
-		$this->capability = apply_filters( 'FHEE_' . $this->_menu_map->menu_slug . '_capability', $capability );
+		$capability = empty($this->capability) ? $this->_menu_map->capability : $this->capability;
+		$this->capability = apply_filters('FHEE_'.$this->_menu_map->menu_slug.'_capability', $capability);
 	}
 
 
@@ -220,7 +220,7 @@ 
 	public function initialize_admin_page() {
 		//let's check user access first
 		$this->_check_user_access();
-		if ( !is_object( $this->_loaded_page_object) ) return;
+		if ( ! is_object($this->_loaded_page_object)) return;
 		$this->_loaded_page_object->route_admin_request();
 		return;
 	}
@@ -232,25 +232,25 @@ 
 
 
 	public function set_page_dependencies($wp_page_slug) {
-		if ( !$this->_load_page ) return;
+		if ( ! $this->_load_page) return;
 
-		if ( !is_object($this->_loaded_page_object) ) {
+		if ( ! is_object($this->_loaded_page_object)) {
 			$msg[] = __('We can\'t load the page because we\'re missing a valid page object that tells us what to load', 'event_espresso');
-			$msg[] = $msg[0] . "\r\n" . sprintf(
+			$msg[] = $msg[0]."\r\n".sprintf(
 				__('The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory', 'event_espresso'),
 				 $this->_file_name,
 				 $this->_file_name,
-				 $this->_folder_path . $this->_file_name,
+				 $this->_folder_path.$this->_file_name,
 				 $this->_menu_map->menu_slug
 			);
-			throw new EE_Error( implode( '||', $msg) );
+			throw new EE_Error(implode('||', $msg));
 		}
 
 		$this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
-		$page_hook = 'load-' . $wp_page_slug;
+		$page_hook = 'load-'.$wp_page_slug;
 		//hook into page load hook so all page specific stuff get's loaded.
-		if ( !empty($wp_page_slug) )
-			add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies') );
+		if ( ! empty($wp_page_slug))
+			add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies'));
 	}
 
 
@@ -261,7 +261,7 @@ 
 	 */
 	public function do_initial_loads() {
 		//no loading or initializing if menu map is setup incorrectly.
-		if ( empty( $this->_menu_map ) || is_array( $this->_menu_map ) ) {
+		if (empty($this->_menu_map) || is_array($this->_menu_map)) {
 			return;
 		}
 		$this->_initialize_admin_page();
@@ -278,19 +278,19 @@ 
 		$bt = debug_backtrace();
 		//for more reliable determination of folder name
 		//we're using this to get the actual folder name of the CALLING class (i.e. the child class that extends this).  Why?  Because $this->menu_slug may be different than the folder name (to avoid conflicts with other plugins)
-		$class = get_class( $this );
-		foreach ( $bt as $index => $values ) {
-			if ( isset( $values['class'] ) && $values['class'] == $class ) {
+		$class = get_class($this);
+		foreach ($bt as $index => $values) {
+			if (isset($values['class']) && $values['class'] == $class) {
 				$file_index = $index - 1;
-				$this->_folder_name = basename(dirname($bt[$file_index]['file']) );
-				if ( !empty( $this->_folder_name ) ) break;
+				$this->_folder_name = basename(dirname($bt[$file_index]['file']));
+				if ( ! empty($this->_folder_name)) break;
 			}
 		}
 
-		$this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . DS;
+		$this->_folder_path = EE_ADMIN_PAGES.$this->_folder_name.DS;
 
-		$this->_file_name = preg_replace( '/^ee/' , 'EE', $this->_folder_name );
-		$this->_file_name = ucwords( str_replace('_', ' ', $this->_file_name) );
+		$this->_file_name = preg_replace('/^ee/', 'EE', $this->_folder_name);
+		$this->_file_name = ucwords(str_replace('_', ' ', $this->_file_name));
 		$this->_file_name = str_replace(' ', '_', $this->_file_name);
 	}
 
@@ -302,19 +302,19 @@ 
 	 * @param bool $extend This indicates whether we're checking the extend directory for any register_hooks files/classes
 	 * @return array
 	 */
-	public function register_hooks( $extend = FALSE ) {
+	public function register_hooks($extend = FALSE) {
 
 		//get a list of files in the directory that have the "Hook" in their name an
 
 		//if this is an extended check (i.e. caf is active) then we will scan the caffeinated/extend directory first and any hook files that are found will be have their reference added to the $_files_hook array property.  Then, we make sure that when we loop through the core decaf directories to find hook files that we skip over any hooks files that have already been set by caf.
-		if ( $extend ) {
-			$hook_files_glob_path = apply_filters( 'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend', EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . DS . '*' . $this->_file_name . '_Hooks_Extend.class.php' );
-			$this->_hook_paths = $this->_register_hook_files( $hook_files_glob_path, $extend );
+		if ($extend) {
+			$hook_files_glob_path = apply_filters('FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend', EE_CORE_CAF_ADMIN_EXTEND.$this->_folder_name.DS.'*'.$this->_file_name.'_Hooks_Extend.class.php');
+			$this->_hook_paths = $this->_register_hook_files($hook_files_glob_path, $extend);
 		}
 
 		//loop through decaf folders
-		$hook_files_glob_path = apply_filters( 'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path', $this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php' );
-		$this->_hook_paths = array_merge( $this->_register_hook_files( $hook_files_glob_path ), $this->_hook_paths );  //making sure any extended hook paths are later in the array than the core hook paths!
+		$hook_files_glob_path = apply_filters('FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path', $this->_folder_path.'*'.$this->_file_name.'_Hooks.class.php');
+		$this->_hook_paths = array_merge($this->_register_hook_files($hook_files_glob_path), $this->_hook_paths); //making sure any extended hook paths are later in the array than the core hook paths!
 
 		return $this->_hook_paths;
 
@@ -322,27 +322,27 @@ 
 
 
 
-	protected function _register_hook_files( $hook_files_glob_path, $extend = FALSE ) {
+	protected function _register_hook_files($hook_files_glob_path, $extend = FALSE) {
 		$hook_paths = array();
-		if ( $hook_files = glob( $hook_files_glob_path ) ) {
-			if ( empty( $hook_files ) ) {
+		if ($hook_files = glob($hook_files_glob_path)) {
+			if (empty($hook_files)) {
 				return array();
 			}
-			foreach ( $hook_files as $file ) {
+			foreach ($hook_files as $file) {
 				//lets get the linked admin.
-				$hook_file = $extend ? str_replace( EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . DS, '', $file ) : str_replace($this->_folder_path, '', $file );
-				$replace = $extend ? '_' . $this->_file_name . '_Hooks_Extend.class.php' : '_' . $this->_file_name . '_Hooks.class.php';
-				$rel_admin = str_replace( $replace, '', $hook_file);
+				$hook_file = $extend ? str_replace(EE_CORE_CAF_ADMIN_EXTEND.$this->_folder_name.DS, '', $file) : str_replace($this->_folder_path, '', $file);
+				$replace = $extend ? '_'.$this->_file_name.'_Hooks_Extend.class.php' : '_'.$this->_file_name.'_Hooks.class.php';
+				$rel_admin = str_replace($replace, '', $hook_file);
 				$rel_admin = strtolower($rel_admin);
 				$hook_paths[] = $file;
 
 				//make sure we haven't already got a hook setup for this page path
-				if ( in_array( $rel_admin, $this->_files_hooked ) )
+				if (in_array($rel_admin, $this->_files_hooked))
 					continue;
 
 				$this->hook_file = $hook_file;
-				$rel_admin_hook = 'FHEE_do_other_page_hooks_' . $rel_admin;
-				$filter = add_filter( $rel_admin_hook, array($this, 'load_admin_hook') );
+				$rel_admin_hook = 'FHEE_do_other_page_hooks_'.$rel_admin;
+				$filter = add_filter($rel_admin_hook, array($this, 'load_admin_hook'));
 				$this->_files_hooked[] = $rel_admin;
 			}
 		}
@@ -367,7 +367,7 @@ 
 	protected function _initialize_admin_page() {
 
 		//JUST CHECK WE'RE ON RIGHT PAGE.
-		if ( (!isset( $_REQUEST['page'] ) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing )
+		if (( ! isset($_REQUEST['page']) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing)
 			return; //not on the right page so let's get out.
 		$this->_load_page = TRUE;
 
@@ -375,30 +375,30 @@ 
 //		spl_autoload_register(array( $this, 'set_autoloaders') );
 
 		//we don't need to do a page_request check here because it's only called via WP menu system.
-		$admin_page = $this->_file_name . '_Admin_Page';
-		$hook_suffix = $this->_menu_map->menu_slug . '_' . $admin_page;
+		$admin_page = $this->_file_name.'_Admin_Page';
+		$hook_suffix = $this->_menu_map->menu_slug.'_'.$admin_page;
 		$admin_page = apply_filters("FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$hook_suffix}", $admin_page);
 
 		// define requested admin page class name then load the file and instantiate
-		$path_to_file = str_replace( array( '\\', '/' ), DS, $this->_folder_path . $admin_page . '.core.php' );
-		$path_to_file=apply_filters("FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}",$path_to_file );//so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
+		$path_to_file = str_replace(array('\\', '/'), DS, $this->_folder_path.$admin_page.'.core.php');
+		$path_to_file = apply_filters("FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}", $path_to_file); //so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
 
-		if ( is_readable( $path_to_file )) {
+		if (is_readable($path_to_file)) {
 			// This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
-			do_action( 'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization' );
-			do_action( 'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_' . $this->_menu_map->menu_slug );
-			require_once( $path_to_file );
-			$a = new ReflectionClass( $admin_page );
-			$this->_loaded_page_object = $a->newInstance( $this->_routing );
+			do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
+			do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_'.$this->_menu_map->menu_slug);
+			require_once($path_to_file);
+			$a = new ReflectionClass($admin_page);
+			$this->_loaded_page_object = $a->newInstance($this->_routing);
 		}
-		do_action( 'AHEE__EE_Admin_Page___initialize_admin_page__after_initialization' );
-		do_action( 'AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_' . $this->_menu_map->menu_slug );
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_'.$this->_menu_map->menu_slug);
 	}
 
 
 
 	public function get_admin_page_name() {
-		return $this->_file_name . '_Admin_Page';
+		return $this->_file_name.'_Admin_Page';
 	}
 
 
@@ -431,8 +431,8 @@ 
 	 * @return bool|die true if pass (or admin) wp_die if fail
 	 */
 	private function _check_user_access() {
-		if ( ! EE_Registry::instance()->CAP->current_user_can( $this->_menu_map->capability, $this->_menu_map->menu_slug ) ) {
-			wp_die( __('You don\'t have access to this page.'), '', array( 'back_link' => true ) );
+		if ( ! EE_Registry::instance()->CAP->current_user_can($this->_menu_map->capability, $this->_menu_map->menu_slug)) {
+			wp_die(__('You don\'t have access to this page.'), '', array('back_link' => true));
 		}
 		return true;
 	}

Braces +22 added lines, -10 removed lines

@@ -1,4 +1,6 @@ 
-<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
+}
 /**
  * Event Espresso
  *
@@ -220,7 +222,9 @@ 
 	public function initialize_admin_page() {
 		//let's check user access first
 		$this->_check_user_access();
-		if ( !is_object( $this->_loaded_page_object) ) return;
+		if ( !is_object( $this->_loaded_page_object) ) {
+			return;
+		}
 		$this->_loaded_page_object->route_admin_request();
 		return;
 	}
@@ -232,7 +236,9 @@ 
 
 
 	public function set_page_dependencies($wp_page_slug) {
-		if ( !$this->_load_page ) return;
+		if ( !$this->_load_page ) {
+			return;
+		}
 
 		if ( !is_object($this->_loaded_page_object) ) {
 			$msg[] = __('We can\'t load the page because we\'re missing a valid page object that tells us what to load', 'event_espresso');
@@ -249,8 +255,9 @@ 
 		$this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
 		$page_hook = 'load-' . $wp_page_slug;
 		//hook into page load hook so all page specific stuff get's loaded.
-		if ( !empty($wp_page_slug) )
-			add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies') );
+		if ( !empty($wp_page_slug) ) {
+					add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies') );
+		}
 	}
 
 
@@ -283,7 +290,9 @@ 
 			if ( isset( $values['class'] ) && $values['class'] == $class ) {
 				$file_index = $index - 1;
 				$this->_folder_name = basename(dirname($bt[$file_index]['file']) );
-				if ( !empty( $this->_folder_name ) ) break;
+				if ( !empty( $this->_folder_name ) ) {
+					break;
+				}
 			}
 		}
 
@@ -337,8 +346,9 @@ 
 				$hook_paths[] = $file;
 
 				//make sure we haven't already got a hook setup for this page path
-				if ( in_array( $rel_admin, $this->_files_hooked ) )
-					continue;
+				if ( in_array( $rel_admin, $this->_files_hooked ) ) {
+									continue;
+				}
 
 				$this->hook_file = $hook_file;
 				$rel_admin_hook = 'FHEE_do_other_page_hooks_' . $rel_admin;
@@ -367,8 +377,10 @@ 
 	protected function _initialize_admin_page() {
 
 		//JUST CHECK WE'RE ON RIGHT PAGE.
-		if ( (!isset( $_REQUEST['page'] ) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing )
-			return; //not on the right page so let's get out.
+		if ( (!isset( $_REQUEST['page'] ) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing ) {
+					return;
+		}
+		//not on the right page so let's get out.
 		$this->_load_page = TRUE;
 
 		//let's set page specific autoloaders.  Note that this just sets autoloaders for THIS set of admin pages.

core/admin/EE_Admin_Page_Menu_Map.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -150,7 +150,7 @@
 	 *
 	 * @param  array $menu_args  An array of arguments used to setup the menu
 	 *                           		properties on construct.
-	 * @param  array $required   	An array of keys that should be in the $menu_args, this
+	 * @param  string[] $required   	An array of keys that should be in the $menu_args, this
 	 *                            		is used to validate that the items that should be defined
 	 *                            		are present.
 	 * @return void

Spacing +39 added lines, -39 removed lines

@@ -15,7 +15,7 @@ 
  * @package 		Event Espresso
  * @subpackage 	admin
  */
-abstract class EE_Admin_Page_Menu_Map  {
+abstract class EE_Admin_Page_Menu_Map {
 
 
 	/**
@@ -155,28 +155,28 @@ 
 	 *                            		are present.
 	 * @return void
 	 */
-	public function __construct( $menu_args, $required ) {
+	public function __construct($menu_args, $required) {
 		//filter all args before processing so plugins can manipulate various settings for menus.
-		$menu_args = apply_filters( 'FHEE__EE_Admin_Page_Menu_Map__construct__menu_args', $menu_args, $required, get_class( $this ) );
+		$menu_args = apply_filters('FHEE__EE_Admin_Page_Menu_Map__construct__menu_args', $menu_args, $required, get_class($this));
 
 
 		//verify that required keys are present in the incoming array.
-		$missing = array_diff( (array) $required, array_keys( (array) $menu_args ) );
+		$missing = array_diff((array) $required, array_keys((array) $menu_args));
 
-		if ( !empty( $missing ) ) {
-			throw new EE_Error( sprintf( __('%s is missing some expected keys in the argument array.  The following keys are missing: %s', 'event_espresso'), get_class( $this ), implode(', ', $missing ) ) );
+		if ( ! empty($missing)) {
+			throw new EE_Error(sprintf(__('%s is missing some expected keys in the argument array.  The following keys are missing: %s', 'event_espresso'), get_class($this), implode(', ', $missing)));
 		}
 
 		//made it here okay, so let's set the properties!
-		foreach ( $menu_args as $prop => $value ) {
+		foreach ($menu_args as $prop => $value) {
 
-			switch ( $prop ) {
+			switch ($prop) {
 				case 'show_on_menu' :
 					$value = (int) $value;
 					break;
 				case 'admin_init_page' :
-					if ( in_array( 'admin_init_page', $required ) && ! $value instanceof EE_Admin_Page_Init ) {
-						throw new EE_Error( sprintf( __('The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.', 'event_espresso'), print_r($value, TRUE) ) );
+					if (in_array('admin_init_page', $required) && ! $value instanceof EE_Admin_Page_Init) {
+						throw new EE_Error(sprintf(__('The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.', 'event_espresso'), print_r($value, TRUE)));
 					}
 					break;
 				case 'menu_callback' :
@@ -187,24 +187,24 @@ 
 					break;
 
 			}
-			if ( ! EEH_Class_Tools::has_property( $this, $prop ) )
-				throw new EE_Error( sprintf( __('The $menu_args coming into %s has a index key (%s) representing a property that is not defined by the class.  Perhaps there is a typo?', 'event_espresso'), get_class( $this ), $prop ) );
+			if ( ! EEH_Class_Tools::has_property($this, $prop))
+				throw new EE_Error(sprintf(__('The $menu_args coming into %s has a index key (%s) representing a property that is not defined by the class.  Perhaps there is a typo?', 'event_espresso'), get_class($this), $prop));
 			$this->{$prop} = $value;
 
 		}
 
 		//filter capabilities (both static and dynamic)
-		$this->capability = apply_filters( 'FHEE_management_capability', $this->capability, NULL );
-		$this->capability = apply_filters( 'FHEE_' . $this->menu_slug . '_capability', $this->capability, NULL );
+		$this->capability = apply_filters('FHEE_management_capability', $this->capability, NULL);
+		$this->capability = apply_filters('FHEE_'.$this->menu_slug.'_capability', $this->capability, NULL);
 
 		//Might need to change parent slug depending on maintenance mode.
-		if ( ! empty( $this->maintenance_mode_parent ) && EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance )  {
+		if ( ! empty($this->maintenance_mode_parent) && EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance) {
 			$this->parent_slug = $this->maintenance_mode_parent;
 		}
 
 		//if empty menu_callback let's set default (but only if we have admin page init object)
-		if ( empty( $this->menu_callback ) && $this->admin_init_page instanceof EE_Admin_Page_Init )
-			$this->menu_callback = array( $this->admin_init_page, 'initialize_admin_page' );
+		if (empty($this->menu_callback) && $this->admin_init_page instanceof EE_Admin_Page_Init)
+			$this->menu_callback = array($this->admin_init_page, 'initialize_admin_page');
 
 	}
 
@@ -226,21 +226,21 @@ 
 	 * @param boolean $network_admin whether this is being added to the network admin page or not
 	 * @since  4.4.0
 	 */
-	public function add_menu_page( $network_admin = FALSE ) {
+	public function add_menu_page($network_admin = FALSE) {
 
 		$show_on_menu_int = (int) $this->show_on_menu;
-		if( ( $network_admin && in_array( $show_on_menu_int, array( self::BLOG_AND_NETWORK_ADMIN, self::NETWORK_ADMIN_ONLY ), TRUE ) )
+		if (($network_admin && in_array($show_on_menu_int, array(self::BLOG_AND_NETWORK_ADMIN, self::NETWORK_ADMIN_ONLY), TRUE))
 				||
-			( ! $network_admin && in_array( $show_on_menu_int, array( self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY ), TRUE )) ){
+			( ! $network_admin && in_array($show_on_menu_int, array(self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY), TRUE))) {
 			$wp_page_slug = $this->_add_menu_page();
-		}else{
+		} else {
 			$wp_page_slug = '';
 		}
 
-		if ( !empty( $wp_page_slug ) && $this->admin_init_page instanceof EE_Admin_Page_Init ) {
+		if ( ! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
 			try {
-				$this->admin_init_page->set_page_dependencies( $wp_page_slug );
-			} catch( EE_Error $e ) {
+				$this->admin_init_page->set_page_dependencies($wp_page_slug);
+			} catch (EE_Error $e) {
 				$e->get_error();
 			}
 		}
@@ -293,12 +293,12 @@ 
 	public $position;
 
 
-	public function __construct( $menu_args ) {
-		$required = array( 'menu_label', 'parent_slug', 'menu_slug', 'menu_group', 'menu_order', 'admin_init_page');
+	public function __construct($menu_args) {
+		$required = array('menu_label', 'parent_slug', 'menu_slug', 'menu_group', 'menu_order', 'admin_init_page');
 
-		parent::__construct( $menu_args, $required );
+		parent::__construct($menu_args, $required);
 
-		$this->position = ! empty( $this->position ) ? (int) $this->position : $this->position;
+		$this->position = ! empty($this->position) ? (int) $this->position : $this->position;
 	}
 
 
@@ -306,9 +306,9 @@ 
 	 * Uses the proper WP utility for registering a menu page for the main WP pages.
 	 */
 	protected function _add_menu_page() {
-		$main =  add_menu_page( $this->title, $this->menu_label, $this->capability, $this->parent_slug, $this->menu_callback, $this->icon_url, $this->position );
-		if ( ! empty( $this->subtitle ) ) {
-			add_submenu_page( $this->parent_slug, $this->subtitle, $this->subtitle, $this->capability, $this->menu_slug, $this->menu_callback );
+		$main = add_menu_page($this->title, $this->menu_label, $this->capability, $this->parent_slug, $this->menu_callback, $this->icon_url, $this->position);
+		if ( ! empty($this->subtitle)) {
+			add_submenu_page($this->parent_slug, $this->subtitle, $this->subtitle, $this->capability, $this->menu_slug, $this->menu_callback);
 		}
 		return $main;
 	}
@@ -325,13 +325,13 @@ 
  */
 class EE_Admin_Page_Sub_Menu extends EE_Admin_Page_Main_Menu {
 
-	public function __construct( $menu_args ) {
-		parent::__construct( $menu_args );
+	public function __construct($menu_args) {
+		parent::__construct($menu_args);
 	}
 
 
 	protected function _add_menu_page() {
-		return add_submenu_page( $this->parent_slug, $this->title, $this->menu_label, $this->capability, $this->menu_slug, $this->menu_callback );
+		return add_submenu_page($this->parent_slug, $this->title, $this->menu_label, $this->capability, $this->menu_slug, $this->menu_callback);
 	}
 
 } //end class EE_Admin_Page_Menu_Map
@@ -352,18 +352,18 @@ 
 
 
 
-	public function __construct( $menu_args = array() ) {
-		$required = array( 'menu_label', 'menu_slug', 'menu_order', 'parent_slug' );
-		parent::__construct( $menu_args, $required );
+	public function __construct($menu_args = array()) {
+		$required = array('menu_label', 'menu_slug', 'menu_order', 'parent_slug');
+		parent::__construct($menu_args, $required);
 	}
 
 
 	protected function _add_menu_page() {
-		return add_submenu_page( $this->parent_slug, $this->menu_label, $this->_group_link(), $this->capability, $this->menu_slug, '__return_false' );
+		return add_submenu_page($this->parent_slug, $this->menu_label, $this->_group_link(), $this->capability, $this->menu_slug, '__return_false');
 	}
 
 
 	private function _group_link() {
-		return '<span class="ee_menu_group"  onclick="return false;">' . $this->menu_label . '</span>';
+		return '<span class="ee_menu_group"  onclick="return false;">'.$this->menu_label.'</span>';
 	}
 } //end EE_Admin_Page_Menu_Group

Braces +7 added lines, -5 removed lines

@@ -187,8 +187,9 @@ 
 					break;
 
 			}
-			if ( ! EEH_Class_Tools::has_property( $this, $prop ) )
-				throw new EE_Error( sprintf( __('The $menu_args coming into %s has a index key (%s) representing a property that is not defined by the class.  Perhaps there is a typo?', 'event_espresso'), get_class( $this ), $prop ) );
+			if ( ! EEH_Class_Tools::has_property( $this, $prop ) ) {
+							throw new EE_Error( sprintf( __('The $menu_args coming into %s has a index key (%s) representing a property that is not defined by the class.  Perhaps there is a typo?', 'event_espresso'), get_class( $this ), $prop ) );
+			}
 			$this->{$prop} = $value;
 
 		}
@@ -203,8 +204,9 @@ 
 		}
 
 		//if empty menu_callback let's set default (but only if we have admin page init object)
-		if ( empty( $this->menu_callback ) && $this->admin_init_page instanceof EE_Admin_Page_Init )
-			$this->menu_callback = array( $this->admin_init_page, 'initialize_admin_page' );
+		if ( empty( $this->menu_callback ) && $this->admin_init_page instanceof EE_Admin_Page_Init ) {
+					$this->menu_callback = array( $this->admin_init_page, 'initialize_admin_page' );
+		}
 
 	}
 
@@ -233,7 +235,7 @@ 
 				||
 			( ! $network_admin && in_array( $show_on_menu_int, array( self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY ), TRUE )) ){
 			$wp_page_slug = $this->_add_menu_page();
-		}else{
+		} else{
 			$wp_page_slug = '';
 		}
 

core/admin/EE_Help_Tour.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -111,7 +111,7 @@
 	 *
 	 * @access public
 	 * @param boolean $caf used to indicate if this tour is happening on caf install or not.
-	 * @return void
+	 * @return EE_Help_Tour
 	 */
 	public function __construct($caf = FALSE) {
 		$this->_is_caf = $caf;

Spacing +35 added lines, -35 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -115,7 +115,7 @@ 
 	 */
 	public function __construct($caf = FALSE) {
 		$this->_is_caf = $caf;
-		$this->_req_data = array_merge( $_GET, $_POST );
+		$this->_req_data = array_merge($_GET, $_POST);
 		$this->_set_tour_properties();
 		$this->_set_tour_stops();
 		$this->_set_tour_options();
@@ -158,36 +158,36 @@ 
 	 * @access protected
 	 * @return void
 	 */
-	protected function _set_tour_options( $options = array() ) {
+	protected function _set_tour_options($options = array()) {
 		$defaults = array(
-			'tipLocation' => 'bottom',         // 'top', 'bottom', 'right', 'left' in relation to parent
-		  	'nubPosition' => 'auto',           // override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
-		  	'tipAdjustmentY' => 0, 			//allow for adjustment of tip
-		  	'tipAdjustmentX' => 0,			//allow for adjustment of tip
+			'tipLocation' => 'bottom', // 'top', 'bottom', 'right', 'left' in relation to parent
+		  	'nubPosition' => 'auto', // override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
+		  	'tipAdjustmentY' => 0, //allow for adjustment of tip
+		  	'tipAdjustmentX' => 0, //allow for adjustment of tip
 		  	'scroll' => true, //whether to scrollTo the next step or not
-		  	'scrollSpeed' => 300,              // Page scrolling speed in ms
-		  	'timer' => 0,	                // 0 = off, all other numbers = time(ms)
-		  	'autoStart' => true,			// true or false - false tour starts when restart called
-		  	'startTimerOnClick' => true,       // true/false to start timer on first click
-		  	'nextButton' => true,              // true/false for next button visibility
+		  	'scrollSpeed' => 300, // Page scrolling speed in ms
+		  	'timer' => 0, // 0 = off, all other numbers = time(ms)
+		  	'autoStart' => true, // true or false - false tour starts when restart called
+		  	'startTimerOnClick' => true, // true/false to start timer on first click
+		  	'nextButton' => true, // true/false for next button visibility
 		  	'button_text' => __('Next', 'event_espresso'),
-		  	'tipAnimation' => 'fade',           // 'pop' or 'fade' in each tip
-		  	'pauseAfter' => array(),                // array of indexes where to pause the tour after
-		  	'tipAnimationFadeSpeed' => 300,    // if 'fade'- speed in ms of transition
-		  	'cookieMonster' => true,           // true/false for whether cookies are used
-		  	'cookieName' => $this->get_slug(),         // choose your own cookie name (setup will add the prefix for the specific page joyride)
-	  		'cookieDomain' => false,           // set to false or yoursite.com
+		  	'tipAnimation' => 'fade', // 'pop' or 'fade' in each tip
+		  	'pauseAfter' => array(), // array of indexes where to pause the tour after
+		  	'tipAnimationFadeSpeed' => 300, // if 'fade'- speed in ms of transition
+		  	'cookieMonster' => true, // true/false for whether cookies are used
+		  	'cookieName' => $this->get_slug(), // choose your own cookie name (setup will add the prefix for the specific page joyride)
+	  		'cookieDomain' => false, // set to false or yoursite.com
 		  	//'tipContainer' => 'body',            // Where the tip be attached if not inline
-		  	'modal' => false, 					// Whether to cover page with modal during the tour
-		  	'expose' => false,					// Whether to expose the elements at each step in the tour (requires modal:true),
-		  	'postExposeCallback' => 'EEHelpTour.postExposeCallback',    // A method to call after an element has been exposed
-		  	'preRideCallback' => 'EEHelpTour_preRideCallback',    // A method to call before the tour starts (passed index, tip, and cloned exposed element)
-		  	'postRideCallback' => 'EEHelpTour_postRideCallback',       // a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
-		  	'preStepCallback' => 'EEHelpTour_preStepCallback',    // A method to call before each step
-		  	'postStepCallback' => 'EEHelpTour_postStepCallback',        // A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
+		  	'modal' => false, // Whether to cover page with modal during the tour
+		  	'expose' => false, // Whether to expose the elements at each step in the tour (requires modal:true),
+		  	'postExposeCallback' => 'EEHelpTour.postExposeCallback', // A method to call after an element has been exposed
+		  	'preRideCallback' => 'EEHelpTour_preRideCallback', // A method to call before the tour starts (passed index, tip, and cloned exposed element)
+		  	'postRideCallback' => 'EEHelpTour_postRideCallback', // a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
+		  	'preStepCallback' => 'EEHelpTour_preStepCallback', // A method to call before each step
+		  	'postStepCallback' => 'EEHelpTour_postStepCallback', // A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
 			);
 
-		$options = !empty( $options ) && is_array($options)  ? array_merge( $defaults, $options ) : $defaults;
+		$options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
 		$this->_options = $options;
 	}
 
@@ -202,8 +202,8 @@ 
 	 * @return string slug for the tour
 	 */
 	public function get_slug() {
-		if ( empty( $this->_slug ) )
-			throw new EE_Error( sprintf(__('There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor', 'event_espresso'), get_class($this) ) );
+		if (empty($this->_slug))
+			throw new EE_Error(sprintf(__('There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor', 'event_espresso'), get_class($this)));
 		return $this->_slug;
 	}
 
@@ -215,8 +215,8 @@ 
 	 * @return string
 	 */
 	public function get_label() {
-		if ( empty( $this->_label ) )
-			throw new EE_Error( sprintf( __('There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor', 'event_espresso'), get_class($this) ) );
+		if (empty($this->_label))
+			throw new EE_Error(sprintf(__('There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor', 'event_espresso'), get_class($this)));
 		return $this->_label;
 	}
 
@@ -227,8 +227,8 @@ 
 	 * @return array
 	 */
 	public function get_stops() {
-		foreach( $this->_stops as $ind => $stop ) {
-			if ( ! isset( $stop['button_text'] ) ) {
+		foreach ($this->_stops as $ind => $stop) {
+			if ( ! isset($stop['button_text'])) {
 				$this->_stops[$ind]['button_text'] = $this->_options['button_text'];
 			}
 		}
@@ -243,12 +243,12 @@ 
 	 */
 	public function get_options() {
 		//let's make sure there are not pauses set
-		foreach ( $this->_stops as $ind => $stop ) {
-			if ( isset( $stop['pause_after'] ) && $stop['pause_after'] ) {
+		foreach ($this->_stops as $ind => $stop) {
+			if (isset($stop['pause_after']) && $stop['pause_after']) {
 				$this->_options['pauseAfter'][] = $ind;
 			}
 		}
-		return apply_filters( 'FHEE__' . get_class($this) . '__get_options', $this->_options, $this );
+		return apply_filters('FHEE__'.get_class($this).'__get_options', $this->_options, $this);
 	}
 
 }

Braces +8 added lines, -5 removed lines

@@ -1,6 +1,7 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if (!defined('EVENT_ESPRESSO_VERSION')) {
 	exit('NO direct script access allowed');
+}
 
 /**
  * Event Espresso
@@ -202,8 +203,9 @@ 
 	 * @return string slug for the tour
 	 */
 	public function get_slug() {
-		if ( empty( $this->_slug ) )
-			throw new EE_Error( sprintf(__('There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor', 'event_espresso'), get_class($this) ) );
+		if ( empty( $this->_slug ) ) {
+					throw new EE_Error( sprintf(__('There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor', 'event_espresso'), get_class($this) ) );
+		}
 		return $this->_slug;
 	}
 
@@ -215,8 +217,9 @@ 
 	 * @return string
 	 */
 	public function get_label() {
-		if ( empty( $this->_label ) )
-			throw new EE_Error( sprintf( __('There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor', 'event_espresso'), get_class($this) ) );
+		if ( empty( $this->_label ) ) {
+					throw new EE_Error( sprintf( __('There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor', 'event_espresso'), get_class($this) ) );
+		}
 		return $this->_label;
 	}
 

core/business/EE_Registration_Processor.class.php

Doc Comments +1 added lines

@@ -161,6 +161,7 @@
 	 *
 	 * @param int           $att_nmbr
 	 * @param EE_Line_Item | string $item
+	 * @param EE_Line_Item $item
 	 * @return string
 	 */
 	public function generate_reg_url_link( $att_nmbr, $item ) {

Spacing +106 added lines, -106 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
-EE_Registry::instance()->load_class( 'Processor_Base' );
+EE_Registry::instance()->load_class('Processor_Base');
 
 /**
  * Class EE_Registration_Processor
@@ -60,7 +60,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated
-		if ( ! self::$_instance instanceof EE_Registration_Processor ) {
+		if ( ! self::$_instance instanceof EE_Registration_Processor) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -96,37 +96,37 @@ 
 	 * @return \EE_Registration | null
 	 * @throws \EE_Error
 	 */
-	public function generate_ONE_registration_from_line_item( EE_Line_Item $line_item, EE_Transaction $transaction, $att_nmbr = 1, $total_ticket_count = 1 ) {
+	public function generate_ONE_registration_from_line_item(EE_Line_Item $line_item, EE_Transaction $transaction, $att_nmbr = 1, $total_ticket_count = 1) {
 		// grab the related ticket object for this line_item
 		$ticket = $line_item->ticket();
-		if ( ! $ticket instanceof EE_Ticket ) {
-			EE_Error::add_error( sprintf( __( "Line item %s did not contain a valid ticket", "event_espresso" ), $line_item->ID() ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $ticket instanceof EE_Ticket) {
+			EE_Error::add_error(sprintf(__("Line item %s did not contain a valid ticket", "event_espresso"), $line_item->ID()), __FILE__, __FUNCTION__, __LINE__);
 			return null;
 		}
-		$first_datetime = $ticket->get_first_related( 'Datetime' );
-		if ( ! $first_datetime instanceof EE_Datetime ) {
-			EE_Error::add_error( sprintf( __( "The ticket (%s) is not associated with any valid datetimes.", "event_espresso" ), $ticket->name() ), __FILE__, __FUNCTION__, __LINE__ );
+		$first_datetime = $ticket->get_first_related('Datetime');
+		if ( ! $first_datetime instanceof EE_Datetime) {
+			EE_Error::add_error(sprintf(__("The ticket (%s) is not associated with any valid datetimes.", "event_espresso"), $ticket->name()), __FILE__, __FUNCTION__, __LINE__);
 			return null;
 		}
-		$event = $first_datetime->get_first_related( 'Event' );
-		if ( ! $event instanceof EE_Event ) {
-			EE_Error::add_error( sprintf( __( "The ticket (%s) is not associated with a valid event.", "event_espresso" ), $ticket->name() ), __FILE__, __FUNCTION__, __LINE__ );
+		$event = $first_datetime->get_first_related('Event');
+		if ( ! $event instanceof EE_Event) {
+			EE_Error::add_error(sprintf(__("The ticket (%s) is not associated with a valid event.", "event_espresso"), $ticket->name()), __FILE__, __FUNCTION__, __LINE__);
 			return null;
 		}
-		$reg_url_link = $this->generate_reg_url_link( $att_nmbr, $line_item );
+		$reg_url_link = $this->generate_reg_url_link($att_nmbr, $line_item);
 
-		if( $this->_reg_final_price_per_tkt_line_item === null ) {
-			$this->_reg_final_price_per_tkt_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item( $transaction->total_line_item() );
+		if ($this->_reg_final_price_per_tkt_line_item === null) {
+			$this->_reg_final_price_per_tkt_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item($transaction->total_line_item());
 		}
 		//ok now find this new registration's final price
-		if( isset( $this->_reg_final_price_per_tkt_line_item[ $line_item->ID() ] ) ) {
-			$final_price = $this->_reg_final_price_per_tkt_line_item[ $line_item->ID() ] ;
-		}else{
-			$message = sprintf( __( 'The ticket line item (ID:%1$d) had no entry in the reg_final_price_per_tkt_line_item array.', 'event_espresso' ), $line_item->ID() );
-			if( WP_DEBUG ){
-				throw new EE_Error( $message );
-			}else{
-				EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message );
+		if (isset($this->_reg_final_price_per_tkt_line_item[$line_item->ID()])) {
+			$final_price = $this->_reg_final_price_per_tkt_line_item[$line_item->ID()];
+		} else {
+			$message = sprintf(__('The ticket line item (ID:%1$d) had no entry in the reg_final_price_per_tkt_line_item array.', 'event_espresso'), $line_item->ID());
+			if (WP_DEBUG) {
+				throw new EE_Error($message);
+			} else {
+				EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message);
 			}
 			$final_price = $ticket->get_ticket_total_with_taxes();
 
@@ -146,11 +146,11 @@ 
 				'REG_url_link'    => $reg_url_link
 			)
 		);
-		$registration->set_reg_code( $this->generate_reg_code( $registration ) );
+		$registration->set_reg_code($this->generate_reg_code($registration));
 		$registration->save();
-		$registration->_add_relation_to( $event, 'Event', array(), $event->ID() );
-		$registration->_add_relation_to( $line_item->ticket(), 'Ticket', array(), $line_item->ticket()->ID() );
-		$transaction->_add_relation_to( $registration, 'Registration' );
+		$registration->_add_relation_to($event, 'Event', array(), $event->ID());
+		$registration->_add_relation_to($line_item->ticket(), 'Ticket', array(), $line_item->ticket()->ID());
+		$transaction->_add_relation_to($registration, 'Registration');
 		return $registration;
 	}
 
@@ -163,9 +163,9 @@ 
 	 * @param EE_Line_Item | string $item
 	 * @return string
 	 */
-	public function generate_reg_url_link( $att_nmbr, $item ) {
+	public function generate_reg_url_link($att_nmbr, $item) {
 		$reg_url_link = $item instanceof EE_Line_Item ? $item->code() : $item;
-		$reg_url_link = $att_nmbr . '-' . md5( $reg_url_link . microtime() );
+		$reg_url_link = $att_nmbr.'-'.md5($reg_url_link.microtime());
 		return $reg_url_link;
 	}
 
@@ -177,18 +177,18 @@ 
 	 * @param \EE_Registration $registration
 	 * @return string
 	 */
-	public function generate_reg_code( EE_Registration $registration ) {
+	public function generate_reg_code(EE_Registration $registration) {
 	// figure out where to start parsing the reg code
-		$chars = strpos( $registration->reg_url_link(), '-' ) + 5;
+		$chars = strpos($registration->reg_url_link(), '-') + 5;
 		// TXN_ID + TKT_ID + first 3 and last 3 chars of reg_url_link
 		$new_reg_code = array(
 			$registration->transaction_ID(),
 			$registration->ticket_ID(),
-			substr( $registration->reg_url_link(), 0, $chars )
+			substr($registration->reg_url_link(), 0, $chars)
 		);
 		// now put it all together
-		$new_reg_code = implode( '-', $new_reg_code );
-		return apply_filters( 'FHEE__EE_Registration_Processor___generate_reg_code__new_reg_code', $new_reg_code, $registration );
+		$new_reg_code = implode('-', $new_reg_code);
+		return apply_filters('FHEE__EE_Registration_Processor___generate_reg_code__new_reg_code', $new_reg_code, $registration);
 	}
 
 
@@ -197,8 +197,8 @@ 
 	 * @param int $REG_ID
 	 * @return string
 	 */
-	public function old_reg_status( $REG_ID ) {
-		return isset( $this->_old_reg_status[ $REG_ID ] ) ? $this->_old_reg_status[ $REG_ID ] : null;
+	public function old_reg_status($REG_ID) {
+		return isset($this->_old_reg_status[$REG_ID]) ? $this->_old_reg_status[$REG_ID] : null;
 	}
 
 
@@ -207,10 +207,10 @@ 
 	 * @param int $REG_ID
 	 * @param string $old_reg_status
 	 */
-	public function set_old_reg_status( $REG_ID, $old_reg_status ) {
+	public function set_old_reg_status($REG_ID, $old_reg_status) {
 		// only set the first time
-		if ( ! isset( $this->_old_reg_status[ $REG_ID ] ) ) {
-			$this->_old_reg_status[ $REG_ID ] = $old_reg_status;
+		if ( ! isset($this->_old_reg_status[$REG_ID])) {
+			$this->_old_reg_status[$REG_ID] = $old_reg_status;
 		}
 	}
 
@@ -220,8 +220,8 @@ 
 	 * @param int $REG_ID
 	 * @return string
 	 */
-	public function new_reg_status( $REG_ID ) {
-		return isset( $this->_new_reg_status[ $REG_ID ] ) ? $this->_new_reg_status[ $REG_ID ] : null;
+	public function new_reg_status($REG_ID) {
+		return isset($this->_new_reg_status[$REG_ID]) ? $this->_new_reg_status[$REG_ID] : null;
 	}
 
 
@@ -230,8 +230,8 @@ 
 	 * @param int $REG_ID
 	 * @param string $new_reg_status
 	 */
-	public function set_new_reg_status( $REG_ID, $new_reg_status ) {
-		$this->_new_reg_status[ $REG_ID ] = $new_reg_status;
+	public function set_new_reg_status($REG_ID, $new_reg_status) {
+		$this->_new_reg_status[$REG_ID] = $new_reg_status;
 	}
 
 
@@ -242,8 +242,8 @@ 
 	 * @param int $REG_ID
 	 * @return bool
 	 */
-	public function reg_status_updated( $REG_ID ) {
-		return $this->new_reg_status( $REG_ID ) !== $this->old_reg_status( $REG_ID ) ? true : false;
+	public function reg_status_updated($REG_ID) {
+		return $this->new_reg_status($REG_ID) !== $this->old_reg_status($REG_ID) ? true : false;
 	}
 
 
@@ -257,19 +257,19 @@ 
 	 * @param bool 	$save TRUE will save the registration if the status is updated, FALSE will leave that up to client code
 	 * 	@return boolean
 	 */
-	public function manually_update_registration_status( EE_Registration $registration, $new_reg_status = '', $save = true ) {
+	public function manually_update_registration_status(EE_Registration $registration, $new_reg_status = '', $save = true) {
 		// set initial REG_Status
-		$this->set_old_reg_status( $registration->ID(), $registration->status_ID() );
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
 		// set incoming REG_Status
-		$this->set_new_reg_status( $registration->ID(), $new_reg_status );
+		$this->set_new_reg_status($registration->ID(), $new_reg_status);
 		// toggle reg status but only if it has changed and the user can do so
 		if (
-			$this->reg_status_updated( $registration->ID() ) &&
-			EE_Registry::instance()->CAP->current_user_can( 'ee_edit_registration', 'toggle_registration_status', $registration->ID() )
+			$this->reg_status_updated($registration->ID()) &&
+			EE_Registry::instance()->CAP->current_user_can('ee_edit_registration', 'toggle_registration_status', $registration->ID())
 		) {
 			// change status to new value
-			if ( $registration->set_status( $this->new_reg_status( $registration->ID() ) )) {
-				if ( $save ) {
+			if ($registration->set_status($this->new_reg_status($registration->ID()))) {
+				if ($save) {
 					$registration->save();
 				}
 			}
@@ -290,27 +290,27 @@ 
 	 * @param bool 	$save TRUE will save the registration if the status is updated, FALSE will leave that up to client code
 	 * @return void
 	 */
-	public function toggle_incomplete_registration_status_to_default( EE_Registration $registration, $save = TRUE ) {
+	public function toggle_incomplete_registration_status_to_default(EE_Registration $registration, $save = TRUE) {
 		// set initial REG_Status
-		$this->set_old_reg_status( $registration->ID(), $registration->status_ID() );
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
 		// is the registration currently incomplete ?
-		if ( $registration->status_ID() === EEM_Registration::status_id_incomplete ) {
+		if ($registration->status_ID() === EEM_Registration::status_id_incomplete) {
 			// grab default reg status for the event, if set
 			$event_default_registration_status = $registration->event()->default_registration_status();
 			// if no default reg status is set for the event, then use the global value
-			$STS_ID = ! empty( $event_default_registration_status ) ? $event_default_registration_status : EE_Registry::instance()->CFG->registration->default_STS_ID;
+			$STS_ID = ! empty($event_default_registration_status) ? $event_default_registration_status : EE_Registry::instance()->CFG->registration->default_STS_ID;
 			// if the event default reg status is approved, then downgrade temporarily to payment pending to ensure that payments are triggered
 			$STS_ID = $STS_ID === EEM_Registration::status_id_approved ? EEM_Registration::status_id_pending_payment : $STS_ID;
 			// set incoming REG_Status
-			$this->set_new_reg_status( $registration->ID(), $STS_ID );
-			$registration->set_status( $STS_ID );
-			if ( $save ) {
+			$this->set_new_reg_status($registration->ID(), $STS_ID);
+			$registration->set_status($STS_ID);
+			if ($save) {
 				$registration->save();
 			}
 			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-			if ( ! EE_Processor_Base::$IPN ) {
+			if ( ! EE_Processor_Base::$IPN) {
 				// otherwise, send out notifications
-				add_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10 );
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
 			}
 			// DEBUG LOG
 			//$this->log(
@@ -334,25 +334,25 @@ 
 	 * @param bool 	$save TRUE will save the registration if the status is updated, FALSE will leave that up to client code
 	 * @return boolean
 	 */
-	public function toggle_registration_status_for_default_approved_events( EE_Registration $registration, $save = TRUE ) {
+	public function toggle_registration_status_for_default_approved_events(EE_Registration $registration, $save = TRUE) {
 		// set initial REG_Status
-		$this->set_old_reg_status( $registration->ID(), $registration->status_ID() );
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
 		// if not already, toggle reg status to approved IF the event default reg status is approved
 		if (
 			$registration->status_ID() !== EEM_Registration::status_id_approved &&
 			$registration->event()->default_registration_status() == EEM_Registration::status_id_approved
 		) {
 			// set incoming REG_Status
-			$this->set_new_reg_status( $registration->ID(), EEM_Registration::status_id_approved );
+			$this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
 			// toggle status to approved
-			$registration->set_status( EEM_Registration::status_id_approved );
-			if ( $save ) {
+			$registration->set_status(EEM_Registration::status_id_approved);
+			if ($save) {
 				$registration->save();
 			}
 			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-			if ( ! EE_Processor_Base::$IPN ) {
+			if ( ! EE_Processor_Base::$IPN) {
 				// otherwise, send out notifications
-				add_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10 );
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
 			}
 			// DEBUG LOG
 			//$this->log(
@@ -380,19 +380,19 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	public function toggle_registration_status_if_no_monies_owing( EE_Registration $registration, $save = TRUE, $additional_details = array() ) {
+	public function toggle_registration_status_if_no_monies_owing(EE_Registration $registration, $save = TRUE, $additional_details = array()) {
 		// set initial REG_Status
-		$this->set_old_reg_status( $registration->ID(), $registration->status_ID() );
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
 		//EEH_Debug_Tools::printr( $additional_details, '$additional_details', __FILE__, __LINE__ );
 		// was a payment just made ?
 		if (
-			isset( $additional_details[ 'payment_updates' ], $additional_details[ 'last_payment' ] ) &&
-			$additional_details[ 'payment_updates' ] &&
-			$additional_details[ 'last_payment' ] instanceof EE_Payment
+			isset($additional_details['payment_updates'], $additional_details['last_payment']) &&
+			$additional_details['payment_updates'] &&
+			$additional_details['last_payment'] instanceof EE_Payment
 		) {
-			$payment = $additional_details[ 'last_payment' ];
+			$payment = $additional_details['last_payment'];
 			$total_paid = 0;
-			foreach ( self::$_amount_paid as $reg => $amount_paid ) {
+			foreach (self::$_amount_paid as $reg => $amount_paid) {
 				$total_paid += $amount_paid;
 			}
 		} else {
@@ -416,30 +416,30 @@ 
 					$registration->transaction()->is_completed() ||
 					$registration->transaction()->is_overpaid() ||
 					$registration->transaction()->is_free() ||
-					apply_filters( 'FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing', false, $registration )
+					apply_filters('FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing', false, $registration)
 				) || (
 					$payment instanceof EE_Payment &&
 					$payment->is_approved() &&
 					// this specific registration has not yet been paid for
-					! isset( self::$_amount_paid[ $registration->ID() ] ) &&
+					! isset(self::$_amount_paid[$registration->ID()]) &&
 					// payment amount, less what we have already attributed to other registrations, is greater than this reg's final price
 					$payment->amount() - $total_paid >= $registration->final_price()
 				)
 			)
 		) {
 			// mark as paid
-			self::$_amount_paid[ $registration->ID() ] = $registration->final_price();
+			self::$_amount_paid[$registration->ID()] = $registration->final_price();
 			// track new REG_Status
-			$this->set_new_reg_status( $registration->ID(), EEM_Registration::status_id_approved );
+			$this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
 			// toggle status to approved
-			$registration->set_status( EEM_Registration::status_id_approved );
-			if ( $save ) {
+			$registration->set_status(EEM_Registration::status_id_approved);
+			if ($save) {
 				$registration->save();
 			}
 			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-			if ( ! EE_Processor_Base::$IPN ) {
+			if ( ! EE_Processor_Base::$IPN) {
 				// otherwise, send out notifications
-				add_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10 );
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
 			}
 			// DEBUG LOG
 			//$this->log(
@@ -465,20 +465,20 @@ 
 	 * @param array 	$additional_details
 	 * @return void
 	 */
-	public function trigger_registration_update_notifications( $registration, $additional_details = array() ) {
+	public function trigger_registration_update_notifications($registration, $additional_details = array()) {
 		try {
-			if ( ! $registration instanceof EE_Registration ) {
-				throw new EE_Error( __( 'An invalid registration was received.', 'event_espresso' ) );
+			if ( ! $registration instanceof EE_Registration) {
+				throw new EE_Error(__('An invalid registration was received.', 'event_espresso'));
 			}
-			EE_Registry::instance()->load_helper( 'Debug_Tools' );
-			EEH_Debug_Tools::log( __CLASS__, __FUNCTION__, __LINE__, array( $registration->transaction(), $additional_details ), false, 'EE_Transaction: ' . $registration->transaction()->ID() );
+			EE_Registry::instance()->load_helper('Debug_Tools');
+			EEH_Debug_Tools::log(__CLASS__, __FUNCTION__, __LINE__, array($registration->transaction(), $additional_details), false, 'EE_Transaction: '.$registration->transaction()->ID());
 			do_action(
 				'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
 				$registration,
 				$additional_details
 			);
-		} catch( Exception $e ) {
-			EE_Error::add_error( $e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine() );
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine());
 		}
 	}
 
@@ -491,18 +491,18 @@ 
 	 * @param array 	$additional_details
 	 * @return bool
 	 */
-	public function update_registration_after_checkout_or_payment(  EE_Registration $registration, $additional_details = array() ) {
+	public function update_registration_after_checkout_or_payment(EE_Registration $registration, $additional_details = array()) {
 		// set initial REG_Status
-		$this->set_old_reg_status( $registration->ID(), $registration->status_ID() );
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
 
 		// if the registration status gets updated, then save the registration
-		if ( $this->toggle_registration_status_for_default_approved_events( $registration, false ) || $this->toggle_registration_status_if_no_monies_owing( $registration, false, $additional_details )) {
+		if ($this->toggle_registration_status_for_default_approved_events($registration, false) || $this->toggle_registration_status_if_no_monies_owing($registration, false, $additional_details)) {
 			$registration->save();
 		}
 
 		// set new  REG_Status
-		$this->set_new_reg_status( $registration->ID(), $registration->status_ID() );
-		return $this->reg_status_updated( $registration->ID() ) && $this->new_reg_status( $registration->ID() ) == EEM_Registration::status_id_approved ? true : false;
+		$this->set_new_reg_status($registration->ID(), $registration->status_ID());
+		return $this->reg_status_updated($registration->ID()) && $this->new_reg_status($registration->ID()) == EEM_Registration::status_id_approved ? true : false;
 	}
 
 	/**
@@ -512,19 +512,19 @@ 
 	 * @param boolean $save_regs whether to immediately save registrations in this function or not
 	 * @return void
 	 */
-	public function update_registration_final_prices( $transaction, $save_regs = true ) {
-		$reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item( $transaction->total_line_item() );
-		foreach( $transaction->registrations() as $registration ) {
-			$line_item = EEM_Line_Item::instance()->get_line_item_for_registration( $registration );
-			if( isset( $reg_final_price_per_ticket_line_item[ $line_item->ID() ] ) ) {
-				$registration->set_final_price( $reg_final_price_per_ticket_line_item[ $line_item->ID() ] );
-				if( $save_regs ) {
+	public function update_registration_final_prices($transaction, $save_regs = true) {
+		$reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item($transaction->total_line_item());
+		foreach ($transaction->registrations() as $registration) {
+			$line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration);
+			if (isset($reg_final_price_per_ticket_line_item[$line_item->ID()])) {
+				$registration->set_final_price($reg_final_price_per_ticket_line_item[$line_item->ID()]);
+				if ($save_regs) {
 					$registration->save();
 				}
 			}
 		}
 		//and make sure there's no rounding problem
-		$this->fix_reg_final_price_rounding_issue( $transaction );
+		$this->fix_reg_final_price_rounding_issue($transaction);
 	}
 
 	/**
@@ -540,7 +540,7 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean success verifying that there is NO difference after this method is done
 	 */
-	public function fix_reg_final_price_rounding_issue( $transaction ) {
+	public function fix_reg_final_price_rounding_issue($transaction) {
 		$reg_final_price_sum = EEM_Registration::instance()->sum(
 			array(
 				array(
@@ -549,9 +549,9 @@ 
 			),
 			'REG_final_price'
 		);
-		$diff =  $transaction->total() - floatval( $reg_final_price_sum );
+		$diff = $transaction->total() - floatval($reg_final_price_sum);
 		//ok then, just grab one of the registrations
-		if( $diff != 0 ) {
+		if ($diff != 0) {
 			$a_reg = EEM_Registration::instance()->get_one(
 					array(
 						array(
@@ -560,7 +560,7 @@ 
 					));
 			$success = $a_reg instanceof EE_Registration ? $a_reg->save(
 				array(
-					'REG_final_price' => ( $a_reg->final_price() + $diff )
+					'REG_final_price' => ($a_reg->final_price() + $diff)
 				)
 			) : false;
 			return $success ? true : false;

Braces +2 added lines, -2 removed lines

@@ -742,11 +742,11 @@
 		$pm = $this->get_first_related('Payment_Method');
 		if( $pm instanceof EE_Payment_Method ){
 			return $pm;
-		}else{
+		} else{
 			$last_payment = $this->last_payment();
 			if( $last_payment instanceof EE_Payment && $last_payment->payment_method() ){
 				return $last_payment->payment_method();
-			}else{
+			} else{
 				return NULL;
 			}
 		}

core/business/EE_Transaction_Payments.class.php

Doc Comments +1 added lines, -2 removed lines

@@ -120,7 +120,6 @@ 
 	 * then client code needs to take responsibility for saving the TXN
 	 * regardless of what happens within EE_Transaction_Payments;
 	 *
-	 * @param EE_Transaction/int $transaction_obj_or_id EE_Transaction or its ID
 	 * @param 	boolean $update_txn  	whether to save the TXN
 	 * @return 	boolean 	 	whether the TXN was saved
 	 */
@@ -158,7 +157,7 @@ 
 	 * 		@access		public
 	 * 		@param EE_Transaction $transaction
 	 *		@param	string $payment_status, one of EEM_Payment's statuses, like 'PAP' (Approved). By default, searches for approved payments
-	 *		@return 		mixed		float on success, false on fail
+	 *		@return 		double		float on success, false on fail
 	 */
 	public function recalculate_total_payments_for_transaction( EE_Transaction $transaction, $payment_status = EEM_Payment::status_id_approved ) {
 		// verify transaction

Spacing +56 added lines, -56 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
-EE_Registry::instance()->load_class( 'Processor_Base' );
+EE_Registry::instance()->load_class('Processor_Base');
 
 /**
  * Class EE_Transaction_Payments
@@ -44,7 +44,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated
-		if ( ! self::$_instance instanceof EE_Transaction_Payments ) {
+		if ( ! self::$_instance instanceof EE_Transaction_Payments) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -72,9 +72,9 @@ 
 	/**
 	 * @param string $old_txn_status
 	 */
-	public function set_old_txn_status( $old_txn_status ) {
+	public function set_old_txn_status($old_txn_status) {
 		// only set the first time
-		if ( $this->_old_txn_status === null ) {
+		if ($this->_old_txn_status === null) {
 			$this->_old_txn_status = $old_txn_status;
 		}
 	}
@@ -93,7 +93,7 @@ 
 	/**
 	 * @param string $new_txn_status
 	 */
-	public function set_new_txn_status( $new_txn_status ) {
+	public function set_new_txn_status($new_txn_status) {
 		$this->_new_txn_status = $new_txn_status;
 	}
 
@@ -105,7 +105,7 @@ 
 	 * @return bool
 	 */
 	public function txn_status_updated() {
-		return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null  ? true : false;
+		return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
 	}
 
 
@@ -124,22 +124,22 @@ 
 	 * @param 	boolean $update_txn  	whether to save the TXN
 	 * @return 	boolean 	 	whether the TXN was saved
 	 */
-	public function calculate_total_payments_and_update_status( EE_Transaction $transaction, $update_txn = true ){
+	public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true) {
 		// verify transaction
-		if ( ! $transaction instanceof EE_Transaction ) {
-			EE_Error::add_error( __( 'Please provide a valid EE_Transaction object.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(__('Please provide a valid EE_Transaction object.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		// set incoming TXN_Status
-		$this->set_old_txn_status( $transaction->status_ID() );
+		$this->set_old_txn_status($transaction->status_ID());
 		// calculate total paid
-		$total_paid = $this->recalculate_total_payments_for_transaction( $transaction );
+		$total_paid = $this->recalculate_total_payments_for_transaction($transaction);
 		// if total paid has changed
-		if ( $total_paid != $transaction->paid() ) {
-			$transaction->set_paid( $total_paid );
+		if ($total_paid != $transaction->paid()) {
+			$transaction->set_paid($total_paid);
 			// maybe update status, and make sure to save transaction if not done already
-			if ( ! $this->update_transaction_status_based_on_total_paid( $transaction, $update_txn )) {
-				if ( $update_txn ) {
+			if ( ! $this->update_transaction_status_based_on_total_paid($transaction, $update_txn)) {
+				if ($update_txn) {
 					return $transaction->save() ? true : false;
 				}
 			} else {
@@ -160,18 +160,18 @@ 
 	 *		@param	string $payment_status, one of EEM_Payment's statuses, like 'PAP' (Approved). By default, searches for approved payments
 	 *		@return 		mixed		float on success, false on fail
 	 */
-	public function recalculate_total_payments_for_transaction( EE_Transaction $transaction, $payment_status = EEM_Payment::status_id_approved ) {
+	public function recalculate_total_payments_for_transaction(EE_Transaction $transaction, $payment_status = EEM_Payment::status_id_approved) {
 		// verify transaction
-		if ( ! $transaction instanceof EE_Transaction ) {
-			EE_Error::add_error( __( 'Please provide a valid EE_Transaction object.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(__('Please provide a valid EE_Transaction object.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		// ensure Payment model is loaded
-		EE_Registry::instance()->load_model( 'Payment' );
+		EE_Registry::instance()->load_model('Payment');
 		// calls EEM_Base::sum()
 		return EEM_Payment::instance()->sum(
 			// query params
-			array( array( 'TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status )),
+			array(array('TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status)),
 			// field to sum
 			'PAY_amount'
 		);
@@ -187,37 +187,37 @@ 
 	 * @return 	boolean 	 	whether the TXN was saved
 	 * @throws \EE_Error
 	 */
-	public function update_transaction_status_based_on_total_paid( EE_Transaction $transaction, $update_txn = TRUE ) {
+	public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = TRUE) {
 		// verify transaction
-		if ( ! $transaction instanceof EE_Transaction ) {
+		if ( ! $transaction instanceof EE_Transaction) {
 			EE_Error::add_error(
-				__( 'Please provide a valid EE_Transaction object.', 'event_espresso' ),
+				__('Please provide a valid EE_Transaction object.', 'event_espresso'),
 				__FILE__, __FUNCTION__, __LINE__
 			);
 			return FALSE;
 		}
-		EE_Registry::instance()->load_helper( 'Money' );
+		EE_Registry::instance()->load_helper('Money');
 		// set incoming TXN_Status
-		$this->set_old_txn_status( $transaction->status_ID() );
+		$this->set_old_txn_status($transaction->status_ID());
 		// set transaction status based on comparison of TXN_paid vs TXN_total
-		if ( EEH_Money::compare_floats( $transaction->paid(), $transaction->total(), '>' ) ){
+		if (EEH_Money::compare_floats($transaction->paid(), $transaction->total(), '>')) {
 			$new_txn_status = EEM_Transaction::overpaid_status_code;
-		} else if ( EEH_Money::compare_floats( $transaction->paid(), $transaction->total() ) ) {
+		} else if (EEH_Money::compare_floats($transaction->paid(), $transaction->total())) {
 			$new_txn_status = EEM_Transaction::complete_status_code;
-		} else if ( EEH_Money::compare_floats( $transaction->paid(), $transaction->total(), '<' ) ) {
+		} else if (EEH_Money::compare_floats($transaction->paid(), $transaction->total(), '<')) {
 			$new_txn_status = EEM_Transaction::incomplete_status_code;
 		} else {
 			EE_Error::add_error(
-				__( 'The total paid calculation for this transaction is inaccurate.', 'event_espresso' ),
+				__('The total paid calculation for this transaction is inaccurate.', 'event_espresso'),
 				__FILE__, __FUNCTION__, __LINE__
 			);
 			return FALSE;
 		}
-		if ( $new_txn_status !== $transaction->status_ID() ) {
+		if ($new_txn_status !== $transaction->status_ID()) {
 			// set incoming TXN_Status
-			$this->set_new_txn_status( $new_txn_status );
-			$transaction->set_status( $new_txn_status );
-			if ( $update_txn ) {
+			$this->set_new_txn_status($new_txn_status);
+			$transaction->set_status($new_txn_status);
+			if ($update_txn) {
 				return $transaction->save() ? TRUE : FALSE;
 			}
 		}
@@ -236,17 +236,17 @@ 
 	 * @param EE_Payment $payment
 	 * @return boolean
 	 */
-	public function delete_payment_and_update_transaction( EE_Payment $payment ) {
+	public function delete_payment_and_update_transaction(EE_Payment $payment) {
 		// verify payment
-		if ( ! $payment instanceof EE_Payment ) {
-			EE_Error::add_error( __( 'A valid Payment object was not received.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $payment instanceof EE_Payment) {
+			EE_Error::add_error(__('A valid Payment object was not received.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
-		if ( ! $this->delete_registration_payments_and_update_registrations( $payment ) ) {
+		if ( ! $this->delete_registration_payments_and_update_registrations($payment)) {
 			return false;
 		}
-		if ( ! $payment->delete() ) {
-			EE_Error::add_error( __( 'The payment could not be deleted.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $payment->delete()) {
+			EE_Error::add_error(__('The payment could not be deleted.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 
@@ -257,14 +257,14 @@ 
 			|| $transaction->status_ID() === EEM_Transaction::failed_status_code
 			|| $payment->amount() === 0
 		) {
-			EE_Error::add_success( __( 'The Payment was successfully deleted.', 'event_espresso' ) );
+			EE_Error::add_success(__('The Payment was successfully deleted.', 'event_espresso'));
 			return true;
 		}
 
 
 		//if this fails, that just means that the transaction didn't get its status changed and/or updated.
 		//however the payment was still deleted.
-		if ( ! $this->calculate_total_payments_and_update_status( $transaction ) ) {
+		if ( ! $this->calculate_total_payments_and_update_status($transaction)) {
 
 			EE_Error::add_attention(
 				__(
@@ -298,28 +298,28 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	public function delete_registration_payments_and_update_registrations( EE_Payment $payment, $reg_payment_query_params = array() ) {
+	public function delete_registration_payments_and_update_registrations(EE_Payment $payment, $reg_payment_query_params = array()) {
 		$save_payment = false;
-		$reg_payment_query_params = ! empty( $reg_payment_query_params ) ? $reg_payment_query_params : array( array( 'PAY_ID' => $payment->ID() ) );
-		$registration_payments = EEM_Registration_Payment::instance()->get_all( $reg_payment_query_params );
-		if ( ! empty( $registration_payments )) {
-			foreach ( $registration_payments as $registration_payment ) {
-				if ( $registration_payment instanceof EE_Registration_Payment ) {
+		$reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params : array(array('PAY_ID' => $payment->ID()));
+		$registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
+		if ( ! empty($registration_payments)) {
+			foreach ($registration_payments as $registration_payment) {
+				if ($registration_payment instanceof EE_Registration_Payment) {
 					$amount_paid = $registration_payment->amount();
 					$registration = $registration_payment->registration();
-					if ( $registration instanceof EE_Registration ) {
-						$registration->set_paid( $registration->paid() - $amount_paid );
-						if ( $registration->save() ) {
-							if ( $registration_payment->delete() ) {
-								$registration->_remove_relation_to( $payment, 'Payment' );
-								$payment->_remove_relation_to( $registration, 'Registration' );
+					if ($registration instanceof EE_Registration) {
+						$registration->set_paid($registration->paid() - $amount_paid);
+						if ($registration->save()) {
+							if ($registration_payment->delete()) {
+								$registration->_remove_relation_to($payment, 'Payment');
+								$payment->_remove_relation_to($registration, 'Registration');
 							}
 							$save_payment = true;
 						}
 					} else {
 						EE_Error::add_error(
 							sprintf(
-								__( 'An invalid Registration object was associated with Registration Payment ID# %1$d.', 'event_espresso' ),
+								__('An invalid Registration object was associated with Registration Payment ID# %1$d.', 'event_espresso'),
 								$registration_payment->ID()
 							),
 							__FILE__, __FUNCTION__, __LINE__
@@ -329,7 +329,7 @@ 
 				} else {
 					EE_Error::add_error(
 						sprintf(
-							__( 'An invalid Registration Payment object was associated with payment ID# %1$d.', 'event_espresso' ),
+							__('An invalid Registration Payment object was associated with payment ID# %1$d.', 'event_espresso'),
 							$payment->ID()
 						),
 						__FILE__, __FUNCTION__, __LINE__
@@ -338,7 +338,7 @@ 
 				}
 			}
 		}
-		if ( $save_payment ) {
+		if ($save_payment) {
 			$payment->save();
 		}
 		return true;

core/business/EE_Transaction_Processor.class.php

Doc Comments +1 added lines

@@ -503,6 +503,7 @@
 	 * @param EE_Transaction $transaction
 	 * @param \EE_Payment | NULL    $payment
 	 * @param array          $registration_query_params - array of query WHERE params to use when retrieving cached registrations from a transaction
+	 * @param EE_Payment $payment
 	 * @throws \EE_Error
 	 * @return array
 	 */

Spacing +106 added lines, -106 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
-EE_Registry::instance()->load_class( 'Processor_Base' );
+EE_Registry::instance()->load_class('Processor_Base');
 
 /**
  * Class EE_Transaction_Processor
@@ -50,10 +50,10 @@ 
 	 * @param array $registration_query_params
 	 *@return EE_Transaction_Processor instance
 	 */
-	public static function instance( $registration_query_params = array() ) {
+	public static function instance($registration_query_params = array()) {
 		// check if class object is instantiated
-		if ( ! self::$_instance instanceof EE_Transaction_Processor ) {
-			self::$_instance = new self( $registration_query_params );
+		if ( ! self::$_instance instanceof EE_Transaction_Processor) {
+			self::$_instance = new self($registration_query_params);
 		}
 		return self::$_instance;
 	}
@@ -64,9 +64,9 @@ 
 	 * @param array $registration_query_params
 	 * @return EE_Transaction_Processor
 	 */
-	private function __construct( $registration_query_params = array() ) {
+	private function __construct($registration_query_params = array()) {
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 	}
 
 
@@ -75,8 +75,8 @@ 
 	 * @access private
 	 * @param array $registration_query_params
 	 */
-	private function _set_registration_query_params( $registration_query_params ) {
-		$this->_registration_query_params = ! empty( $registration_query_params ) ? $registration_query_params : array( 'order_by' => array( 'REG_count' => 'ASC' ));
+	private function _set_registration_query_params($registration_query_params) {
+		$this->_registration_query_params = ! empty($registration_query_params) ? $registration_query_params : array('order_by' => array('REG_count' => 'ASC'));
 	}
 
 
@@ -93,9 +93,9 @@ 
 	/**
 	 * @param string $old_txn_status
 	 */
-	public function set_old_txn_status( $old_txn_status ) {
+	public function set_old_txn_status($old_txn_status) {
 		// only set the first time
-		if ( $this->_old_txn_status === null ) {
+		if ($this->_old_txn_status === null) {
 			$this->_old_txn_status = $old_txn_status;
 		}
 	}
@@ -114,7 +114,7 @@ 
 	/**
 	 * @param string $new_txn_status
 	 */
-	public function set_new_txn_status( $new_txn_status ) {
+	public function set_new_txn_status($new_txn_status) {
 		$this->_new_txn_status = $new_txn_status;
 	}
 
@@ -145,17 +145,17 @@ 
 	 * @param bool   $check_all
 	 * @return boolean | int
 	 */
-	private function _reg_steps_completed( EE_Transaction $transaction, $reg_step_slug = '', $check_all = TRUE ) {
+	private function _reg_steps_completed(EE_Transaction $transaction, $reg_step_slug = '', $check_all = TRUE) {
 		$reg_steps = $transaction->reg_steps();
-		if ( ! is_array( $reg_steps ) || empty( $reg_steps )) {
+		if ( ! is_array($reg_steps) || empty($reg_steps)) {
 			return false;
 		}
 		// loop thru reg steps array)
-		foreach ( $reg_steps as $slug => $reg_step_completed ) {
+		foreach ($reg_steps as $slug => $reg_step_completed) {
 			// if NOT checking ALL steps (only checking one step)
-			if ( ! $check_all ) {
+			if ( ! $check_all) {
 				// and this is the one
-				if ( $slug == $reg_step_slug ) {
+				if ($slug == $reg_step_slug) {
 					return $reg_step_completed;
 				} else {
 					// skip to next reg step in loop
@@ -163,9 +163,9 @@ 
 				}
 			}
 			// if any reg step is NOT completed (ignoring any specific steps), then just leave
-			if ( $reg_step_completed !== true && $slug != $reg_step_slug ) {
+			if ($reg_step_completed !== true && $slug != $reg_step_slug) {
 				return false;
-			} else if ( $slug == $reg_step_slug ) {
+			} else if ($slug == $reg_step_slug) {
 				// if we reach this point, then we are testing either:
 				// all_reg_steps_completed_except() or
 				// all_reg_steps_completed_except_final_step(),
@@ -190,8 +190,8 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean
 	 */
-	public function all_reg_steps_completed( EE_Transaction $transaction ) {
-		return $this->_reg_steps_completed( $transaction );
+	public function all_reg_steps_completed(EE_Transaction $transaction) {
+		return $this->_reg_steps_completed($transaction);
 	}
 
 
@@ -208,8 +208,8 @@ 
 	 * @param string $exception
 	 * @return boolean
 	 */
-	public function all_reg_steps_completed_except( EE_Transaction $transaction, $exception = '' ) {
-		return $this->_reg_steps_completed( $transaction, $exception );
+	public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '') {
+		return $this->_reg_steps_completed($transaction, $exception);
 	}
 
 
@@ -225,8 +225,8 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean
 	 */
-	public function all_reg_steps_completed_except_final_step( EE_Transaction $transaction ) {
-		return $this->_reg_steps_completed( $transaction, 'finalize_registration' );
+	public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction) {
+		return $this->_reg_steps_completed($transaction, 'finalize_registration');
 	}
 
 
@@ -243,8 +243,8 @@ 
 	 * @param string $reg_step_slug
 	 * @return boolean | int
 	 */
-	public function reg_step_completed( EE_Transaction $transaction, $reg_step_slug ) {
-		return $this->_reg_steps_completed( $transaction, $reg_step_slug, FALSE );
+	public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug) {
+		return $this->_reg_steps_completed($transaction, $reg_step_slug, FALSE);
 	}
 
 
@@ -260,8 +260,8 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean | int
 	 */
-	public function final_reg_step_completed( EE_Transaction $transaction ) {
-		return $this->_reg_steps_completed( $transaction, 'finalize_registration', FALSE );
+	public function final_reg_step_completed(EE_Transaction $transaction) {
+		return $this->_reg_steps_completed($transaction, 'finalize_registration', FALSE);
 	}
 
 
@@ -275,9 +275,9 @@ 
 	 * @param string          $reg_step_slug
 	 * @return boolean
 	 */
-	public function set_reg_step_initiated( EE_Transaction $transaction, $reg_step_slug ) {
+	public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug) {
 		$current_time = time();
-		return $this->_set_reg_step_completed_status( $transaction, $reg_step_slug, $current_time );
+		return $this->_set_reg_step_completed_status($transaction, $reg_step_slug, $current_time);
 	}
 
 
@@ -291,8 +291,8 @@ 
 	 * @param string          $reg_step_slug
 	 * @return boolean
 	 */
-	public function set_reg_step_completed( EE_Transaction $transaction, $reg_step_slug ) {
-		return $this->_set_reg_step_completed_status( $transaction, $reg_step_slug, TRUE );
+	public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug) {
+		return $this->_set_reg_step_completed_status($transaction, $reg_step_slug, TRUE);
 	}
 
 
@@ -306,8 +306,8 @@ 
 	 * @param string          $reg_step_slug
 	 * @return boolean
 	 */
-	public function set_reg_step_not_completed( EE_Transaction $transaction, $reg_step_slug ) {
-		return $this->_set_reg_step_completed_status( $transaction, $reg_step_slug, FALSE );
+	public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug) {
+		return $this->_set_reg_step_completed_status($transaction, $reg_step_slug, FALSE);
 	}
 
 
@@ -323,36 +323,36 @@ 
 	 * @param boolean | int $status
 	 * @return boolean
 	 */
-	private function _set_reg_step_completed_status( EE_Transaction $transaction, $reg_step_slug, $status ) {
+	private function _set_reg_step_completed_status(EE_Transaction $transaction, $reg_step_slug, $status) {
 		// validate status
-		$status = is_bool( $status ) || is_numeric( $status ) ? $status : false;
+		$status = is_bool($status) || is_numeric($status) ? $status : false;
 		// get reg steps array
 		$txn_reg_steps = $transaction->reg_steps();
 		// if reg step does NOT exist
-		if ( ! isset( $txn_reg_steps[ $reg_step_slug ] )) {
+		if ( ! isset($txn_reg_steps[$reg_step_slug])) {
 			return false;
 		}
 		// if  we're trying to complete a step that is already completed
-		if ( $txn_reg_steps[ $reg_step_slug ] === true ) {
+		if ($txn_reg_steps[$reg_step_slug] === true) {
 			return true;
 		}
 		// if  we're trying to complete a step that hasn't even started
-		if ( $status === true && $txn_reg_steps[ $reg_step_slug ] === false ) {
+		if ($status === true && $txn_reg_steps[$reg_step_slug] === false) {
 			return false;
 		}
 		// if current status value matches the incoming value (no change)
-		if ( $txn_reg_steps[ $reg_step_slug ] === $status ) {
+		if ($txn_reg_steps[$reg_step_slug] === $status) {
 			// this will happen in cases where multiple AJAX requests occur during the same step
 			return true;
 		}
 		// if we're trying to set a start time
-		if ( is_numeric( $status ) && is_numeric( $txn_reg_steps[ $reg_step_slug ] )) {
+		if (is_numeric($status) && is_numeric($txn_reg_steps[$reg_step_slug])) {
 			// skip the update below, but don't return FALSE so that errors won't be displayed
 			return true;
 		}
 		// update completed status
-		$txn_reg_steps[ $reg_step_slug ] = $status;
-		$transaction->set_reg_steps( $txn_reg_steps );
+		$txn_reg_steps[$reg_step_slug] = $status;
+		$transaction->set_reg_steps($txn_reg_steps);
 		$transaction->save();
 		// DEBUG LOG
 		//$this->log(
@@ -378,11 +378,11 @@ 
 	 * @param string $reg_step_slug
 	 * @return void
 	 */
-	public function remove_reg_step( EE_Transaction $transaction, $reg_step_slug ) {
+	public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug) {
 		// get reg steps array
 		$txn_reg_steps = $transaction->reg_steps();
-		unset( $txn_reg_steps[ $reg_step_slug ] );
-		$transaction->set_reg_steps( $txn_reg_steps );
+		unset($txn_reg_steps[$reg_step_slug]);
+		$transaction->set_reg_steps($txn_reg_steps);
 	}
 
 
@@ -396,14 +396,14 @@ 
 	 * @param EE_Transaction $transaction
 	 * 	@return 	boolean
 	 */
-	public function toggle_failed_transaction_status( EE_Transaction $transaction ) {
+	public function toggle_failed_transaction_status(EE_Transaction $transaction) {
 		// set incoming TXN_Status
-		$this->set_old_txn_status( $transaction->status_ID() );
+		$this->set_old_txn_status($transaction->status_ID());
 		// if TXN status is still set as "failed"...
-		if ( $transaction->status_ID() == EEM_Transaction::failed_status_code ) {
+		if ($transaction->status_ID() == EEM_Transaction::failed_status_code) {
 			// set incoming TXN_Status
-			$this->set_new_txn_status( EEM_Transaction::abandoned_status_code );
-			$transaction->set_status( EEM_Transaction::abandoned_status_code );
+			$this->set_new_txn_status(EEM_Transaction::abandoned_status_code);
+			$transaction->set_status(EEM_Transaction::abandoned_status_code);
 			return TRUE;
 		}
 		return FALSE;
@@ -419,20 +419,20 @@ 
 	 * @param EE_Transaction $transaction
 	 * 	@return 	boolean
 	 */
-	public function toggle_abandoned_transaction_status( EE_Transaction $transaction ) {
+	public function toggle_abandoned_transaction_status(EE_Transaction $transaction) {
 		// set incoming TXN_Status
-		$this->set_old_txn_status( $transaction->status_ID() );
+		$this->set_old_txn_status($transaction->status_ID());
 		// if TXN status has not been updated already due to a payment, and is still set as "failed" or "abandoned"...
-		if ( $transaction->status_ID() == EEM_Transaction::failed_status_code || $transaction->status_ID() == EEM_Transaction::abandoned_status_code ) {
-			$this->set_new_txn_status( EEM_Transaction::incomplete_status_code );
+		if ($transaction->status_ID() == EEM_Transaction::failed_status_code || $transaction->status_ID() == EEM_Transaction::abandoned_status_code) {
+			$this->set_new_txn_status(EEM_Transaction::incomplete_status_code);
 			// if a contact record for the primary registrant has been created
-			if ( $transaction->primary_registration() instanceof EE_Registration && $transaction->primary_registration()->attendee() instanceof EE_Attendee ) {
-				$transaction->set_status( EEM_Transaction::incomplete_status_code );
-				$this->set_new_txn_status( EEM_Transaction::incomplete_status_code );
+			if ($transaction->primary_registration() instanceof EE_Registration && $transaction->primary_registration()->attendee() instanceof EE_Attendee) {
+				$transaction->set_status(EEM_Transaction::incomplete_status_code);
+				$this->set_new_txn_status(EEM_Transaction::incomplete_status_code);
 			} else {
 				// no contact record? yer abandoned!
-				$transaction->set_status( EEM_Transaction::abandoned_status_code );
-				$this->set_new_txn_status( EEM_Transaction::abandoned_status_code );
+				$transaction->set_status(EEM_Transaction::abandoned_status_code);
+				$this->set_new_txn_status(EEM_Transaction::abandoned_status_code);
 			}
 			return TRUE;
 		}
@@ -450,16 +450,16 @@ 
 	 * @param array 	$registration_query_params - array of query WHERE params to use when retrieving cached registrations from a transaction
 	 * 	@return 	boolean
 	 */
-	public function manually_update_registration_statuses( EE_Transaction $transaction, $new_reg_status = '', $registration_query_params = array() ) {
-		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor( 'manually_update_registration_status', $transaction, $registration_query_params, $new_reg_status );
+	public function manually_update_registration_statuses(EE_Transaction $transaction, $new_reg_status = '', $registration_query_params = array()) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor('manually_update_registration_status', $transaction, $registration_query_params, $new_reg_status);
 		// send messages
 		/** @type EE_Registration_Processor $registration_processor */
-		$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 		$registration_processor->trigger_registration_update_notifications(
 			$transaction->primary_registration(),
-			array( 'manually_updated' 	=> true )
+			array('manually_updated' 	=> true)
 		);
-		do_action( 'AHEE__EE_Transaction_Processor__manually_update_registration_statuses', $transaction, $status_updates );
+		do_action('AHEE__EE_Transaction_Processor__manually_update_registration_statuses', $transaction, $status_updates);
 		return $status_updates;
 	}
 
@@ -473,9 +473,9 @@ 
 	 * @param array 	$registration_query_params - array of query WHERE params to use when retrieving cached registrations from a transaction
 	 * 	@return 	boolean
 	 */
-	public function toggle_registration_statuses_for_default_approved_events( EE_Transaction $transaction, $registration_query_params = array() ) {
-		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor( 'toggle_registration_status_for_default_approved_events', $transaction, $registration_query_params );
-		do_action( 'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events', $transaction, $status_updates );
+	public function toggle_registration_statuses_for_default_approved_events(EE_Transaction $transaction, $registration_query_params = array()) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor('toggle_registration_status_for_default_approved_events', $transaction, $registration_query_params);
+		do_action('AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events', $transaction, $status_updates);
 		return $status_updates;
 	}
 
@@ -489,9 +489,9 @@ 
 	 * @param array 	$registration_query_params - array of query WHERE params to use when retrieving cached registrations from a transaction
 	 * 	@return 	boolean
 	 */
-	public function toggle_registration_statuses_if_no_monies_owing( EE_Transaction $transaction, $registration_query_params = array() ) {
-		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor( 'toggle_registration_status_if_no_monies_owing', $transaction, $registration_query_params );
-		do_action( 'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing', $transaction, $status_updates );
+	public function toggle_registration_statuses_if_no_monies_owing(EE_Transaction $transaction, $registration_query_params = array()) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor('toggle_registration_status_if_no_monies_owing', $transaction, $registration_query_params);
+		do_action('AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing', $transaction, $status_updates);
 		return $status_updates;
 	}
 
@@ -507,17 +507,17 @@ 
 	 * @throws \EE_Error
 	 * @return array
 	 */
-	public function update_transaction_and_registrations_after_checkout_or_payment( EE_Transaction $transaction, $payment = NULL, $registration_query_params = array() ) {
+	public function update_transaction_and_registrations_after_checkout_or_payment(EE_Transaction $transaction, $payment = NULL, $registration_query_params = array()) {
 		// set incoming TXN_Status, and consider it new since old status should have been set
-		$this->set_new_txn_status( $transaction->status_ID() );
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, $transaction->status_ID(), '$transaction->status_ID()' );
+		$this->set_new_txn_status($transaction->status_ID());
+		do_action('AHEE_log', __FILE__, __FUNCTION__, $transaction->status_ID(), '$transaction->status_ID()');
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 		// get final reg step status
-		$finalized = $this->final_reg_step_completed( $transaction );
+		$finalized = $this->final_reg_step_completed($transaction);
 		// if the 'finalize_registration' step has been initiated (has a timestamp) but has not yet been fully completed (TRUE)
-		if ( is_numeric( $finalized ) && $finalized !== true ) {
-			$this->set_reg_step_completed( $transaction, 'finalize_registration' );
+		if (is_numeric($finalized) && $finalized !== true) {
+			$this->set_reg_step_completed($transaction, 'finalize_registration');
 			$finalized = true;
 		}
 		$transaction->save();
@@ -540,13 +540,13 @@ 
 
 		// send messages
 		/** @type EE_Registration_Processor $registration_processor */
-		$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 		$registration_processor->trigger_registration_update_notifications(
 			$transaction->primary_registration(),
 			$update_params
 		);
 
-		do_action( 'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment', $transaction, $update_params );
+		do_action('AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment', $transaction, $update_params);
 		return $update_params;
 	}
 
@@ -564,23 +564,23 @@ 
 	 * @throws \EE_Error
 	 * @return boolean
 	 */
-	private function _call_method_on_registrations_via_Registration_Processor( $method_name,  EE_Transaction $transaction, $registration_query_params = array(), $additional_param = NULL ) {
+	private function _call_method_on_registrations_via_Registration_Processor($method_name, EE_Transaction $transaction, $registration_query_params = array(), $additional_param = NULL) {
 		$response = FALSE;
 		/** @type EE_Registration_Processor $registration_processor */
-		$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 		// check that method exists
-		if ( ! method_exists( $registration_processor, $method_name )) {
-			throw new EE_Error( __( 'Method does not exist.', 'event_espresso' ));
+		if ( ! method_exists($registration_processor, $method_name)) {
+			throw new EE_Error(__('Method does not exist.', 'event_espresso'));
 		}
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 		// loop through cached registrations
-		foreach ( $transaction->registrations( $this->_registration_query_params ) as $registration ) {
-			if ( $registration instanceof EE_Registration ) {
-				if ( $additional_param ) {
-					$response = $registration_processor->{$method_name}( $registration, $additional_param ) ? TRUE : $response;
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
+			if ($registration instanceof EE_Registration) {
+				if ($additional_param) {
+					$response = $registration_processor->{$method_name}($registration, $additional_param) ? TRUE : $response;
 				} else {
-					$response = $registration_processor->{$method_name}( $registration ) ? TRUE : $response;
+					$response = $registration_processor->{$method_name}($registration) ? TRUE : $response;
 				}
 			}
 		}
@@ -605,46 +605,46 @@ 
 	public function set_transaction_payment_method_based_on_registration_statuses(
 		EE_Registration $edited_registration
 	) {
-		if ( $edited_registration instanceof EE_Registration ) {
+		if ($edited_registration instanceof EE_Registration) {
 			$transaction = $edited_registration->transaction();
-			if ( $transaction instanceof EE_Transaction ) {
+			if ($transaction instanceof EE_Transaction) {
 				$all_not_approved = true;
-				foreach ( $transaction->registrations() as $registration ) {
-					if ( $registration instanceof EE_Registration ) {
+				foreach ($transaction->registrations() as $registration) {
+					if ($registration instanceof EE_Registration) {
 						// if any REG != "Not Approved" then toggle to false
 						$all_not_approved = $registration->is_not_approved() ? $all_not_approved : false;
 					}
 				}
 				// if ALL Registrations are "Not Approved"
-				if ( $all_not_approved ) {
-					$transaction->set_payment_method_ID( null );
+				if ($all_not_approved) {
+					$transaction->set_payment_method_ID(null);
 					$transaction->save();
 				} else {
-					$available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction( $transaction, EEM_Payment_Method::scope_cart );
-					if ( ! empty( $available_payment_methods ) ) {
+					$available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction($transaction, EEM_Payment_Method::scope_cart);
+					if ( ! empty($available_payment_methods)) {
 						$PMD_ID = 0;
-						foreach ( $available_payment_methods as $available_payment_method ) {
-							if ( $available_payment_method instanceof EE_Payment_Method && $available_payment_method->open_by_default() ) {
+						foreach ($available_payment_methods as $available_payment_method) {
+							if ($available_payment_method instanceof EE_Payment_Method && $available_payment_method->open_by_default()) {
 								$PMD_ID = $available_payment_method->ID();
 								break;
 							}
 						}
-						if ( ! $PMD_ID ) {
-							$first_payment_method = reset( $available_payment_methods );
-							if ( $first_payment_method instanceof EE_Payment_Method ) {
+						if ( ! $PMD_ID) {
+							$first_payment_method = reset($available_payment_methods);
+							if ($first_payment_method instanceof EE_Payment_Method) {
 								$PMD_ID = $first_payment_method->ID();
 							} else {
 								EE_Error::add_error(
-									__( 'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.', 'event_espresso' ),
+									__('A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.', 'event_espresso'),
 									__FILE__, __LINE__, __FUNCTION__
 								);
 							}
 						}
-						$transaction->set_payment_method_ID( $PMD_ID );
+						$transaction->set_payment_method_ID($PMD_ID);
 						$transaction->save();
 					} else {
 						EE_Error::add_error(
-							__( 'Please activate at least one Payment Method in order for things to operate correctly.', 'event_espresso' ),
+							__('Please activate at least one Payment Method in order for things to operate correctly.', 'event_espresso'),
 							__FILE__, __LINE__, __FUNCTION__
 						);
 					}