eventespresso / event-espresso-core

caffeinated/payment_methods/Paypal_Pro/templates/paypal_pro_intro.template.php

Indentation +6 added lines, -6 removed lines

@@ -1,10 +1,10 @@
 <?php
 
 printf(
-    esc_html__(
-        'PayPal Pro (Website Payments Pro) is an on-site payment method for accepting credit and debit cards and is available to event organizers in the United States, United Kingdom, and Canada. An account with PayPal is required to accept payments. Need a PayPal Pro account? Call 1-855-456-1338 or %1$sclick here to sign up for a merchant account%2$s.',
-        'event_espresso'
-    ),
-    '<a href="https://eventespresso.com/go/paypalpro/" target="_blank">',
-    '</a>'
+	esc_html__(
+		'PayPal Pro (Website Payments Pro) is an on-site payment method for accepting credit and debit cards and is available to event organizers in the United States, United Kingdom, and Canada. An account with PayPal is required to accept payments. Need a PayPal Pro account? Call 1-855-456-1338 or %1$sclick here to sign up for a merchant account%2$s.',
+		'event_espresso'
+	),
+	'<a href="https://eventespresso.com/go/paypalpro/" target="_blank">',
+	'</a>'
 );

caffeinated/payment_methods/Aim/EEG_Aim.gateway.php

Spacing +13 added lines, -13 removed lines

@@ -191,7 +191,7 @@ 
                     $line_item->unit_price(),
                     'N'
                 );
-                $order_description .= $this->prepareStringForAuthnet($line_item->desc()) . ', ';
+                $order_description .= $this->prepareStringForAuthnet($line_item->desc()).', ';
             }
             foreach ($total_line_item->tax_descendants() as $tax_line_item) {
                 $this->addLineItem(
@@ -216,7 +216,7 @@ 
         $this->setField('last_name', $billing_info['last_name']);
         $this->setField('email', $billing_info['email']);
         $this->setField('company', $billing_info['company']);
-        $this->setField('address', $billing_info['address'] . ' ' . $billing_info['address2']);
+        $this->setField('address', $billing_info['address'].' '.$billing_info['address2']);
         $this->setField('city', $billing_info['city']);
         $this->setField('state', $billing_info['state']);
         $this->setField('country', $billing_info['country']);
@@ -229,7 +229,7 @@ 
         // invoice_num would be nice to have it be unique per SPCO page-load, that way if users
         // press back, they don't submit a duplicate. However, we may be keeping the user on teh same spco page
         // in which case, we need to generate teh invoice num per request right here...
-        $this->setField('invoice_num', wp_generate_password(12, false));// $billing_info['_reg-page-billing-invoice-'.$this->_gateway_name]['value']);
+        $this->setField('invoice_num', wp_generate_password(12, false)); // $billing_info['_reg-page-billing-invoice-'.$this->_gateway_name]['value']);
         // tell AIM that any duplicates sent in the next 5 minutes are to be ignored
         $this->setField('duplicate_window', 5 * MINUTE_IN_SECONDS);
 
@@ -240,7 +240,7 @@ 
         // Capture response
         $this->type = "AUTH_CAPTURE";
         $response = $this->_sendRequest($payment);
-        if (! empty($response)) {
+        if ( ! empty($response)) {
             if ($response->error_message) {
                 $payment->set_status($this->_pay_model->failed_status());
                 $payment->set_gateway_response($response->error_message);
@@ -286,7 +286,7 @@ 
     protected function _set_sensitive_billing_data($billing_info)
     {
         $this->setField('card_num', $billing_info['credit_card']);
-        $this->setField('exp_date', $billing_info['exp_month'] . $billing_info['exp_year']);
+        $this->setField('exp_date', $billing_info['exp_month'].$billing_info['exp_year']);
         $this->setField('card_code', $billing_info['cvv']);
     }
 
@@ -326,7 +326,7 @@ 
     protected function setField($name, $value)
     {
         if (in_array($name, $this->_all_aim_fields)) {
-            $this->_x_post_fields[ $name ] = $value;
+            $this->_x_post_fields[$name] = $value;
         } else {
             throw new AuthorizeNetException("Error: no field $name exists in the AIM API.
             To set a custom field use setCustomField('field','value') instead.");
@@ -346,11 +346,11 @@ 
         $this->_x_post_fields['tran_key'] = $this->_transaction_key;
         $x_keys = array();
         foreach ($this->_x_post_fields as $key => $value) {
-            $x_keys[] = "x_$key=" . urlencode($this->_get_unsupported_character_remover()->format($value));
+            $x_keys[] = "x_$key=".urlencode($this->_get_unsupported_character_remover()->format($value));
         }
         // Add line items
         foreach ($this->_additional_line_items as $key => $value) {
-            $x_keys[] =  "x_line_item=" . urlencode($this->_get_unsupported_character_remover()->format($value));
+            $x_keys[] = "x_line_item=".urlencode($this->_get_unsupported_character_remover()->format($value));
         }
         $this->_log_clean_request($x_keys, $payment);
         $post_url = $this->_get_server_url();
@@ -362,7 +362,7 @@ 
         curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);
         curl_setopt($curl_request, CURLOPT_SSL_VERIFYHOST, 2);
         if ($this->VERIFY_PEER) {
-            curl_setopt($curl_request, CURLOPT_CAINFO, dirname(__DIR__) . '/ssl/cert.pem');
+            curl_setopt($curl_request, CURLOPT_CAINFO, dirname(__DIR__).'/ssl/cert.pem');
         } else {
             curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, false);
         }
@@ -374,7 +374,7 @@ 
         $response = curl_exec($curl_request);
 
         curl_close($curl_request);
-        $response_obj =  new EE_AuthorizeNetAIM_Response($response);
+        $response_obj = new EE_AuthorizeNetAIM_Response($response);
 
         return $this->_log_and_clean_response($response_obj, $payment);
     }
@@ -394,7 +394,7 @@ 
                 if (strpos($keyvaltogether, $key) === 0) {
                     // found it at the first character
                     // so its one of them
-                    unset($request_array[ $index ]);
+                    unset($request_array[$index]);
                 }
             }
         }
@@ -535,7 +535,7 @@ 
             // Split Array
             $this->response = $response;
             if ($encap_char) {
-                $this->_response_array = explode($encap_char . $delimiter . $encap_char, substr($response, 1, -1));
+                $this->_response_array = explode($encap_char.$delimiter.$encap_char, substr($response, 1, -1));
             } else {
                 $this->_response_array = explode($delimiter, $response);
             }
@@ -617,7 +617,7 @@ 
     }
 }
 
-if (! class_exists('AuthorizeNetException')) {
+if ( ! class_exists('AuthorizeNetException')) {
     /**
      * Class AuthorizeNetException
      *

Indentation +590 added lines, -590 removed lines

@@ -25,413 +25,413 @@ 
  */
 class EEG_Aim extends EE_Onsite_Gateway
 {
-    const LIVE_URL    = 'https://secure2.authorize.net/gateway/transact.dll'; // Authnet URL
-
-    const SANDBOX_URL = 'https://test.authorize.net/gateway/transact.dll';
-
-    protected $_login_id;
-
-    protected $_transaction_key;
-
-    protected $_currencies_supported = array(
-        'AUD',
-        'USD',
-        'CAD',
-        'EUR',
-        'GBP',
-        'NZD',
-    );
-
-    /**
-     * Whether to send test transactions (even to live site)
-     *
-     * @var boolean
-     */
-    protected $_test_transactions;
-
-    private $VERIFY_PEER = false;
-
-    private $_x_post_fields = array(
-        "version"        => "3.1",
-        "delim_char"     => ",",
-        "delim_data"     => "TRUE",
-        "relay_response" => "FALSE",
-        "encap_char"     => "|",
-    );
-
-    private $_additional_line_items = array();
-
-    /**
-     * A list of all fields in the AIM API.
-     * Used to warn user if they try to set a field not offered in the API.
-     */
-    private $_all_aim_fields = array(
-        "address",
-        "allow_partial_auth",
-        "amount",
-        "auth_code",
-        "authentication_indicator",
-        "bank_aba_code",
-        "bank_acct_name",
-        "bank_acct_num",
-        "bank_acct_type",
-        "bank_check_number",
-        "bank_name",
-        "card_code",
-        "card_num",
-        "cardholder_authentication_value",
-        "city",
-        "company",
-        "country",
-        "cust_id",
-        "customer_ip",
-        "delim_char",
-        "delim_data",
-        "description",
-        "duplicate_window",
-        "duty",
-        "echeck_type",
-        "email",
-        "email_customer",
-        "encap_char",
-        "exp_date",
-        "fax",
-        "first_name",
-        "footer_email_receipt",
-        "freight",
-        "header_email_receipt",
-        "invoice_num",
-        "last_name",
-        "line_item",
-        "login",
-        "method",
-        "phone",
-        "po_num",
-        "recurring_billing",
-        "relay_response",
-        "ship_to_address",
-        "ship_to_city",
-        "ship_to_company",
-        "ship_to_country",
-        "ship_to_first_name",
-        "ship_to_last_name",
-        "ship_to_state",
-        "ship_to_zip",
-        "split_tender_id",
-        "state",
-        "tax",
-        "tax_exempt",
-        "test_request",
-        "tran_key",
-        "trans_id",
-        "type",
-        "version",
-        "zip",
-        "solution_id",
-        "currency_code"
-    );
-
-
-    /**
-     * Gets the URL where the request should go. This is filterable
-     *
-     * @return string
-     */
-    protected function _get_server_url()
-    {
-        return apply_filters(
-            'FHEE__EEG_Aim___get_server_url',
-            $this->_debug_mode ? self::SANDBOX_URL : self::LIVE_URL,
-            $this
-        );
-    }
-
-
-    /**
-     * Asks the gateway to do whatever it does to process the payment. Onsite gateways will
-     * usually send a request directly to the payment provider and update the payment's status based on that;
-     * whereas offsite gateways will usually just update the payment with the URL and query parameters to use
-     * for sending the request via http_remote_request()
-     *
-     * @param EE_Payment|null $payment
-     * @param array|null $billing_info
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function do_direct_payment($payment, $billing_info = null)
-    {
-        // Enable test mode if needed
-        // 4007000000027  <-- test successful visa
-        // 4222222222222  <-- test failure card number
-
-        $item_num = 1;
-        $transaction = $payment->transaction();
-        $gateway_formatter = $this->_get_gateway_formatter();
-        $order_description = $this->prepareStringForAuthnet($gateway_formatter->formatOrderDescription($payment));
-        $primary_registrant = $transaction->primary_registration();
-        // if we're are charging for the full amount, show the normal line items
-        // and the itemized total adds up properly
-        if ($this->_can_easily_itemize_transaction_for($payment)) {
-            $total_line_item = $transaction->total_line_item();
-            foreach ($total_line_item->get_items() as $line_item) {
-                if ($line_item->quantity() == 0) {
-                    continue;
-                }
-                $this->addLineItem(
-                    $item_num++,
-                    $gateway_formatter->formatLineItemName($line_item, $payment),
-                    $gateway_formatter->formatLineItemDesc($line_item, $payment),
-                    $line_item->quantity(),
-                    $line_item->unit_price(),
-                    'N'
-                );
-                $order_description .= $this->prepareStringForAuthnet($line_item->desc()) . ', ';
-            }
-            foreach ($total_line_item->tax_descendants() as $tax_line_item) {
-                $this->addLineItem(
-                    $item_num++,
-                    $tax_line_item->name(),
-                    $tax_line_item->desc(),
-                    1,
-                    $tax_line_item->total(),
-                    'N'
-                );
-            }
-        }
-
-        // start transaction
-        // if in debug mode, use authorize.net's sandbox id; otherwise use the Event Espresso partner id
-        $partner_id = $this->_debug_mode ? 'AAA100302' : 'AAA105363';
-        $this->setField('solution_id', $partner_id);
-        $this->setField('amount', $gateway_formatter->formatCurrency($payment->amount()));
-        $this->setField('description', substr(rtrim($order_description, ', '), 0, 255));
-        $this->_set_sensitive_billing_data($billing_info);
-        $this->setField('first_name', $billing_info['first_name']);
-        $this->setField('last_name', $billing_info['last_name']);
-        $this->setField('email', $billing_info['email']);
-        $this->setField('company', $billing_info['company']);
-        $this->setField('address', $billing_info['address'] . ' ' . $billing_info['address2']);
-        $this->setField('city', $billing_info['city']);
-        $this->setField('state', $billing_info['state']);
-        $this->setField('country', $billing_info['country']);
-        $this->setField('zip', $billing_info['zip']);
-        $this->setField('fax', $billing_info['fax']);
-        $this->setField('cust_id', $primary_registrant->ID());
-        $this->setField('phone', $billing_info['phone']);
-        $currency_config = LoaderFactory::getLoader()->load('EE_Currency_Config');
-        $this->setField('currency_code', $currency_config->code);
-        // invoice_num would be nice to have it be unique per SPCO page-load, that way if users
-        // press back, they don't submit a duplicate. However, we may be keeping the user on teh same spco page
-        // in which case, we need to generate teh invoice num per request right here...
-        $this->setField('invoice_num', wp_generate_password(12, false));// $billing_info['_reg-page-billing-invoice-'.$this->_gateway_name]['value']);
-        // tell AIM that any duplicates sent in the next 5 minutes are to be ignored
-        $this->setField('duplicate_window', 5 * MINUTE_IN_SECONDS);
-
-        if ($this->_test_transactions) {
-            $this->test_request = "true";
-        }
-
-        // Capture response
-        $this->type = "AUTH_CAPTURE";
-        $response = $this->_sendRequest($payment);
-        if (! empty($response)) {
-            if ($response->error_message) {
-                $payment->set_status($this->_pay_model->failed_status());
-                $payment->set_gateway_response($response->error_message);
-            } else {
-                $payment_status = $response->approved
-                    ? $this->_pay_model->approved_status()
-                    : $this->_pay_model->declined_status();
-                $payment->set_status($payment_status);
-                // make sure we interpret the AMT as a float, not an international string (where periods are thousand separators)
-                $payment->set_amount((float) $response->amount);
-                $payment->set_gateway_response(
-                    sprintf(
-                        esc_html__('%1$s (Reason Code: %2$s)', 'event_espresso'),
-                        $response->response_reason_text,
-                        $response->response_reason_code
-                    )
-                );
-                if ($this->_debug_mode) {
-                    $txn_id = $response->invoice_number;
-                } else {
-                    $txn_id = $response->transaction_id;
-                }
-                $payment->set_txn_id_chq_nmbr($txn_id);
-            }
-            $payment->set_extra_accntng($primary_registrant->reg_code());
-            $payment->set_details(print_r($response, true));
-        } else {
-            $payment->set_status($this->_pay_model->failed_status());
-            $payment->set_gateway_response(esc_html__("There was no response from Authorize.net", 'event_espresso'));
-            $payment->set_details(print_r($response, true));
-        }
-        return $payment;
-    }
-
-
-    /**
-     * Sets billing data for the upcoming request to AIM that is considered sensitive;
-     * also this method can be overridden by children classes to easily change
-     * what billing data gets sent
-     *
-     * @param array $billing_info
-     */
-    protected function _set_sensitive_billing_data($billing_info)
-    {
-        $this->setField('card_num', $billing_info['credit_card']);
-        $this->setField('exp_date', $billing_info['exp_month'] . $billing_info['exp_year']);
-        $this->setField('card_code', $billing_info['cvv']);
-    }
-
-
-    /**
-     * Add a line item.
-     *
-     * @param string $item_id
-     * @param string $item_name
-     * @param string $item_description
-     * @param string $item_quantity
-     * @param string $item_unit_price
-     * @param string $item_taxable
-     */
-    public function addLineItem($item_id, $item_name, $item_description, $item_quantity, $item_unit_price, $item_taxable)
-    {
-        $args = array(
-            substr($item_id, 0, 31),
-            substr($this->prepareStringForAuthnet($item_name), 0, 31),
-            substr($this->prepareStringForAuthnet($item_description), 0, 255),
-            number_format(abs($item_quantity), 2, '.', ''),
-            number_format(abs($item_unit_price), 2, '.', ''),
-            $item_taxable === 'N' ? 'N' : 'Y'
-        );
-        $this->_additional_line_items[] = implode('<|>', $args);
-    }
-
-
-    /**
-     * Set an individual name/value pair. This will append x_ to the name
-     * before posting.
-     *
-     * @param string $name
-     * @param string $value
-     * @throws AuthorizeNetException
-     */
-    protected function setField($name, $value)
-    {
-        if (in_array($name, $this->_all_aim_fields)) {
-            $this->_x_post_fields[ $name ] = $value;
-        } else {
-            throw new AuthorizeNetException("Error: no field $name exists in the AIM API.
+	const LIVE_URL    = 'https://secure2.authorize.net/gateway/transact.dll'; // Authnet URL
+
+	const SANDBOX_URL = 'https://test.authorize.net/gateway/transact.dll';
+
+	protected $_login_id;
+
+	protected $_transaction_key;
+
+	protected $_currencies_supported = array(
+		'AUD',
+		'USD',
+		'CAD',
+		'EUR',
+		'GBP',
+		'NZD',
+	);
+
+	/**
+	 * Whether to send test transactions (even to live site)
+	 *
+	 * @var boolean
+	 */
+	protected $_test_transactions;
+
+	private $VERIFY_PEER = false;
+
+	private $_x_post_fields = array(
+		"version"        => "3.1",
+		"delim_char"     => ",",
+		"delim_data"     => "TRUE",
+		"relay_response" => "FALSE",
+		"encap_char"     => "|",
+	);
+
+	private $_additional_line_items = array();
+
+	/**
+	 * A list of all fields in the AIM API.
+	 * Used to warn user if they try to set a field not offered in the API.
+	 */
+	private $_all_aim_fields = array(
+		"address",
+		"allow_partial_auth",
+		"amount",
+		"auth_code",
+		"authentication_indicator",
+		"bank_aba_code",
+		"bank_acct_name",
+		"bank_acct_num",
+		"bank_acct_type",
+		"bank_check_number",
+		"bank_name",
+		"card_code",
+		"card_num",
+		"cardholder_authentication_value",
+		"city",
+		"company",
+		"country",
+		"cust_id",
+		"customer_ip",
+		"delim_char",
+		"delim_data",
+		"description",
+		"duplicate_window",
+		"duty",
+		"echeck_type",
+		"email",
+		"email_customer",
+		"encap_char",
+		"exp_date",
+		"fax",
+		"first_name",
+		"footer_email_receipt",
+		"freight",
+		"header_email_receipt",
+		"invoice_num",
+		"last_name",
+		"line_item",
+		"login",
+		"method",
+		"phone",
+		"po_num",
+		"recurring_billing",
+		"relay_response",
+		"ship_to_address",
+		"ship_to_city",
+		"ship_to_company",
+		"ship_to_country",
+		"ship_to_first_name",
+		"ship_to_last_name",
+		"ship_to_state",
+		"ship_to_zip",
+		"split_tender_id",
+		"state",
+		"tax",
+		"tax_exempt",
+		"test_request",
+		"tran_key",
+		"trans_id",
+		"type",
+		"version",
+		"zip",
+		"solution_id",
+		"currency_code"
+	);
+
+
+	/**
+	 * Gets the URL where the request should go. This is filterable
+	 *
+	 * @return string
+	 */
+	protected function _get_server_url()
+	{
+		return apply_filters(
+			'FHEE__EEG_Aim___get_server_url',
+			$this->_debug_mode ? self::SANDBOX_URL : self::LIVE_URL,
+			$this
+		);
+	}
+
+
+	/**
+	 * Asks the gateway to do whatever it does to process the payment. Onsite gateways will
+	 * usually send a request directly to the payment provider and update the payment's status based on that;
+	 * whereas offsite gateways will usually just update the payment with the URL and query parameters to use
+	 * for sending the request via http_remote_request()
+	 *
+	 * @param EE_Payment|null $payment
+	 * @param array|null $billing_info
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function do_direct_payment($payment, $billing_info = null)
+	{
+		// Enable test mode if needed
+		// 4007000000027  <-- test successful visa
+		// 4222222222222  <-- test failure card number
+
+		$item_num = 1;
+		$transaction = $payment->transaction();
+		$gateway_formatter = $this->_get_gateway_formatter();
+		$order_description = $this->prepareStringForAuthnet($gateway_formatter->formatOrderDescription($payment));
+		$primary_registrant = $transaction->primary_registration();
+		// if we're are charging for the full amount, show the normal line items
+		// and the itemized total adds up properly
+		if ($this->_can_easily_itemize_transaction_for($payment)) {
+			$total_line_item = $transaction->total_line_item();
+			foreach ($total_line_item->get_items() as $line_item) {
+				if ($line_item->quantity() == 0) {
+					continue;
+				}
+				$this->addLineItem(
+					$item_num++,
+					$gateway_formatter->formatLineItemName($line_item, $payment),
+					$gateway_formatter->formatLineItemDesc($line_item, $payment),
+					$line_item->quantity(),
+					$line_item->unit_price(),
+					'N'
+				);
+				$order_description .= $this->prepareStringForAuthnet($line_item->desc()) . ', ';
+			}
+			foreach ($total_line_item->tax_descendants() as $tax_line_item) {
+				$this->addLineItem(
+					$item_num++,
+					$tax_line_item->name(),
+					$tax_line_item->desc(),
+					1,
+					$tax_line_item->total(),
+					'N'
+				);
+			}
+		}
+
+		// start transaction
+		// if in debug mode, use authorize.net's sandbox id; otherwise use the Event Espresso partner id
+		$partner_id = $this->_debug_mode ? 'AAA100302' : 'AAA105363';
+		$this->setField('solution_id', $partner_id);
+		$this->setField('amount', $gateway_formatter->formatCurrency($payment->amount()));
+		$this->setField('description', substr(rtrim($order_description, ', '), 0, 255));
+		$this->_set_sensitive_billing_data($billing_info);
+		$this->setField('first_name', $billing_info['first_name']);
+		$this->setField('last_name', $billing_info['last_name']);
+		$this->setField('email', $billing_info['email']);
+		$this->setField('company', $billing_info['company']);
+		$this->setField('address', $billing_info['address'] . ' ' . $billing_info['address2']);
+		$this->setField('city', $billing_info['city']);
+		$this->setField('state', $billing_info['state']);
+		$this->setField('country', $billing_info['country']);
+		$this->setField('zip', $billing_info['zip']);
+		$this->setField('fax', $billing_info['fax']);
+		$this->setField('cust_id', $primary_registrant->ID());
+		$this->setField('phone', $billing_info['phone']);
+		$currency_config = LoaderFactory::getLoader()->load('EE_Currency_Config');
+		$this->setField('currency_code', $currency_config->code);
+		// invoice_num would be nice to have it be unique per SPCO page-load, that way if users
+		// press back, they don't submit a duplicate. However, we may be keeping the user on teh same spco page
+		// in which case, we need to generate teh invoice num per request right here...
+		$this->setField('invoice_num', wp_generate_password(12, false));// $billing_info['_reg-page-billing-invoice-'.$this->_gateway_name]['value']);
+		// tell AIM that any duplicates sent in the next 5 minutes are to be ignored
+		$this->setField('duplicate_window', 5 * MINUTE_IN_SECONDS);
+
+		if ($this->_test_transactions) {
+			$this->test_request = "true";
+		}
+
+		// Capture response
+		$this->type = "AUTH_CAPTURE";
+		$response = $this->_sendRequest($payment);
+		if (! empty($response)) {
+			if ($response->error_message) {
+				$payment->set_status($this->_pay_model->failed_status());
+				$payment->set_gateway_response($response->error_message);
+			} else {
+				$payment_status = $response->approved
+					? $this->_pay_model->approved_status()
+					: $this->_pay_model->declined_status();
+				$payment->set_status($payment_status);
+				// make sure we interpret the AMT as a float, not an international string (where periods are thousand separators)
+				$payment->set_amount((float) $response->amount);
+				$payment->set_gateway_response(
+					sprintf(
+						esc_html__('%1$s (Reason Code: %2$s)', 'event_espresso'),
+						$response->response_reason_text,
+						$response->response_reason_code
+					)
+				);
+				if ($this->_debug_mode) {
+					$txn_id = $response->invoice_number;
+				} else {
+					$txn_id = $response->transaction_id;
+				}
+				$payment->set_txn_id_chq_nmbr($txn_id);
+			}
+			$payment->set_extra_accntng($primary_registrant->reg_code());
+			$payment->set_details(print_r($response, true));
+		} else {
+			$payment->set_status($this->_pay_model->failed_status());
+			$payment->set_gateway_response(esc_html__("There was no response from Authorize.net", 'event_espresso'));
+			$payment->set_details(print_r($response, true));
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * Sets billing data for the upcoming request to AIM that is considered sensitive;
+	 * also this method can be overridden by children classes to easily change
+	 * what billing data gets sent
+	 *
+	 * @param array $billing_info
+	 */
+	protected function _set_sensitive_billing_data($billing_info)
+	{
+		$this->setField('card_num', $billing_info['credit_card']);
+		$this->setField('exp_date', $billing_info['exp_month'] . $billing_info['exp_year']);
+		$this->setField('card_code', $billing_info['cvv']);
+	}
+
+
+	/**
+	 * Add a line item.
+	 *
+	 * @param string $item_id
+	 * @param string $item_name
+	 * @param string $item_description
+	 * @param string $item_quantity
+	 * @param string $item_unit_price
+	 * @param string $item_taxable
+	 */
+	public function addLineItem($item_id, $item_name, $item_description, $item_quantity, $item_unit_price, $item_taxable)
+	{
+		$args = array(
+			substr($item_id, 0, 31),
+			substr($this->prepareStringForAuthnet($item_name), 0, 31),
+			substr($this->prepareStringForAuthnet($item_description), 0, 255),
+			number_format(abs($item_quantity), 2, '.', ''),
+			number_format(abs($item_unit_price), 2, '.', ''),
+			$item_taxable === 'N' ? 'N' : 'Y'
+		);
+		$this->_additional_line_items[] = implode('<|>', $args);
+	}
+
+
+	/**
+	 * Set an individual name/value pair. This will append x_ to the name
+	 * before posting.
+	 *
+	 * @param string $name
+	 * @param string $value
+	 * @throws AuthorizeNetException
+	 */
+	protected function setField($name, $value)
+	{
+		if (in_array($name, $this->_all_aim_fields)) {
+			$this->_x_post_fields[ $name ] = $value;
+		} else {
+			throw new AuthorizeNetException("Error: no field $name exists in the AIM API.
             To set a custom field use setCustomField('field','value') instead.");
-        }
-    }
-
-
-    /**
-     * Posts the request to AuthorizeNet & returns response.
-     *
-     * @param $payment
-     * @return EE_AuthorizeNetAIM_Response
-     */
-    private function _sendRequest($payment)
-    {
-        $this->_x_post_fields['login'] = $this->_login_id;
-        $this->_x_post_fields['tran_key'] = $this->_transaction_key;
-        $x_keys = array();
-        foreach ($this->_x_post_fields as $key => $value) {
-            $x_keys[] = "x_$key=" . urlencode($this->_get_unsupported_character_remover()->format($value));
-        }
-        // Add line items
-        foreach ($this->_additional_line_items as $key => $value) {
-            $x_keys[] =  "x_line_item=" . urlencode($this->_get_unsupported_character_remover()->format($value));
-        }
-        $this->_log_clean_request($x_keys, $payment);
-        $post_url = $this->_get_server_url();
-        $curl_request = curl_init($post_url);
-        $post_body = implode("&", $x_keys);
-        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post_body);
-        curl_setopt($curl_request, CURLOPT_HEADER, 0);
-        curl_setopt($curl_request, CURLOPT_TIMEOUT, 45);
-        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);
-        curl_setopt($curl_request, CURLOPT_SSL_VERIFYHOST, 2);
-        if ($this->VERIFY_PEER) {
-            curl_setopt($curl_request, CURLOPT_CAINFO, dirname(__DIR__) . '/ssl/cert.pem');
-        } else {
-            curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, false);
-        }
-
-        if (preg_match('/xml/', $post_url)) {
-            curl_setopt($curl_request, CURLOPT_HTTPHEADER, array("Content-Type: text/xml"));
-        }
-
-        $response = curl_exec($curl_request);
-
-        curl_close($curl_request);
-        $response_obj =  new EE_AuthorizeNetAIM_Response($response);
-
-        return $this->_log_and_clean_response($response_obj, $payment);
-    }
-
-
-    /**
-     * Logs the clean data only
-     *
-     * @param array $request_array
-     * @param EE_Payment $payment
-     */
-    protected function _log_clean_request($request_array, $payment)
-    {
-        $keys_to_filter_out = array('x_card_num', 'x_card_code', 'x_exp_date');
-        foreach ($request_array as $index => $keyvaltogether) {
-            foreach ($keys_to_filter_out as $key) {
-                if (strpos($keyvaltogether, $key) === 0) {
-                    // found it at the first character
-                    // so its one of them
-                    unset($request_array[ $index ]);
-                }
-            }
-        }
-        $this->log(
-            array(
-                'AIM Request sent:' => $request_array,
-                'Server URL'        => $this->_get_server_url()
-            ),
-            $payment
-        );
-    }
-
-
-
-    /**
-     * Logs the response and cleans it
-     *
-     * @param EE_AuthorizeNetAIM_Response $response_obj
-     * @param EE_Payment                  $payment
-     * @return EE_AuthorizeNetAIM_Response
-     */
-    private function _log_and_clean_response($response_obj, $payment)
-    {
-        $response_obj->account_number = '';
-        $this->log(array('AIM Response received:' => (array) $response_obj), $payment);
-        return $response_obj;
-    }
-
-    /**
-     * Removes characters Authorize.net doesn't handle well.
-     * @since 4.9.82.p
-     * @param $text
-     * @return string
-     */
-    private function prepareStringForAuthnet($text)
-    {
-        return str_replace(
-            '\'',
-            '',
-            $text
-        );
-    }
+		}
+	}
+
+
+	/**
+	 * Posts the request to AuthorizeNet & returns response.
+	 *
+	 * @param $payment
+	 * @return EE_AuthorizeNetAIM_Response
+	 */
+	private function _sendRequest($payment)
+	{
+		$this->_x_post_fields['login'] = $this->_login_id;
+		$this->_x_post_fields['tran_key'] = $this->_transaction_key;
+		$x_keys = array();
+		foreach ($this->_x_post_fields as $key => $value) {
+			$x_keys[] = "x_$key=" . urlencode($this->_get_unsupported_character_remover()->format($value));
+		}
+		// Add line items
+		foreach ($this->_additional_line_items as $key => $value) {
+			$x_keys[] =  "x_line_item=" . urlencode($this->_get_unsupported_character_remover()->format($value));
+		}
+		$this->_log_clean_request($x_keys, $payment);
+		$post_url = $this->_get_server_url();
+		$curl_request = curl_init($post_url);
+		$post_body = implode("&", $x_keys);
+		curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post_body);
+		curl_setopt($curl_request, CURLOPT_HEADER, 0);
+		curl_setopt($curl_request, CURLOPT_TIMEOUT, 45);
+		curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);
+		curl_setopt($curl_request, CURLOPT_SSL_VERIFYHOST, 2);
+		if ($this->VERIFY_PEER) {
+			curl_setopt($curl_request, CURLOPT_CAINFO, dirname(__DIR__) . '/ssl/cert.pem');
+		} else {
+			curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, false);
+		}
+
+		if (preg_match('/xml/', $post_url)) {
+			curl_setopt($curl_request, CURLOPT_HTTPHEADER, array("Content-Type: text/xml"));
+		}
+
+		$response = curl_exec($curl_request);
+
+		curl_close($curl_request);
+		$response_obj =  new EE_AuthorizeNetAIM_Response($response);
+
+		return $this->_log_and_clean_response($response_obj, $payment);
+	}
+
+
+	/**
+	 * Logs the clean data only
+	 *
+	 * @param array $request_array
+	 * @param EE_Payment $payment
+	 */
+	protected function _log_clean_request($request_array, $payment)
+	{
+		$keys_to_filter_out = array('x_card_num', 'x_card_code', 'x_exp_date');
+		foreach ($request_array as $index => $keyvaltogether) {
+			foreach ($keys_to_filter_out as $key) {
+				if (strpos($keyvaltogether, $key) === 0) {
+					// found it at the first character
+					// so its one of them
+					unset($request_array[ $index ]);
+				}
+			}
+		}
+		$this->log(
+			array(
+				'AIM Request sent:' => $request_array,
+				'Server URL'        => $this->_get_server_url()
+			),
+			$payment
+		);
+	}
+
+
+
+	/**
+	 * Logs the response and cleans it
+	 *
+	 * @param EE_AuthorizeNetAIM_Response $response_obj
+	 * @param EE_Payment                  $payment
+	 * @return EE_AuthorizeNetAIM_Response
+	 */
+	private function _log_and_clean_response($response_obj, $payment)
+	{
+		$response_obj->account_number = '';
+		$this->log(array('AIM Response received:' => (array) $response_obj), $payment);
+		return $response_obj;
+	}
+
+	/**
+	 * Removes characters Authorize.net doesn't handle well.
+	 * @since 4.9.82.p
+	 * @param $text
+	 * @return string
+	 */
+	private function prepareStringForAuthnet($text)
+	{
+		return str_replace(
+			'\'',
+			'',
+			$text
+		);
+	}
 }
 
 
@@ -446,191 +446,191 @@ 
  */
 class EE_AuthorizeNetAIM_Response
 {
-    const APPROVED = '1';
-    const DECLINED = '2';
-    const ERROR = '3';
-    const HELD = '4';
-
-    protected $_x_post_fields = array(
-        "version"        => "3.1",
-        "delim_char"     => ",",
-        "delim_data"     => "TRUE",
-        "relay_response" => "FALSE",
-        "encap_char"     => "|",
-    );
-    public $approved;
-    public $declined;
-    public $error;
-    public $held;
-    public $response_code;
-    public $response_subcode;
-    public $response_reason_code;
-    public $response_reason_text;
-    public $authorization_code;
-    public $avs_response;
-    public $transaction_id;
-    public $invoice_number;
-    public $description;
-    public $amount;
-    public $method;
-    public $transaction_type;
-    public $customer_id;
-    public $first_name;
-    public $last_name;
-    public $company;
-    public $address;
-    public $city;
-    public $state;
-    public $zip_code;
-    public $country;
-    public $phone;
-    public $fax;
-    public $email_address;
-    public $ship_to_first_name;
-    public $ship_to_last_name;
-    public $ship_to_company;
-    public $ship_to_address;
-    public $ship_to_city;
-    public $ship_to_state;
-    public $ship_to_zip_code;
-    public $ship_to_country;
-    public $tax;
-    public $duty;
-    public $freight;
-    public $tax_exempt;
-    public $purchase_order_number;
-    public $md5_hash;
-    public $card_code_response;
-    public $cavv_response; // cardholder_authentication_verification_response
-    public $account_number;
-    public $card_type;
-    public $split_tender_id;
-    public $requested_amount;
-    public $balance_on_card;
-    public $response; // The response string from AuthorizeNet.
-    public $error_message;
-    private $_response_array = array(); // An array with the split response.
-
-
-    /**
-     * Constructor. Parses the AuthorizeNet response string
-     *
-     * @param string $response The response from the AuthNet server.
-     * @var string   $delimiter The delimiter used (default is ",")
-     * @var string   $encap_char The encap_char used (default is "|")
-     * @var array    $custom_fields Any custom fields set in the request.
-     */
-
-    public function __construct($response)
-    {
-        $encap_char = $this->_x_post_fields['encap_char'];
-        $delimiter = $this->_x_post_fields['delim_char'];
-        if ($response) {
-            // Split Array
-            $this->response = $response;
-            if ($encap_char) {
-                $this->_response_array = explode($encap_char . $delimiter . $encap_char, substr($response, 1, -1));
-            } else {
-                $this->_response_array = explode($delimiter, $response);
-            }
-
-            /**
-             * If AuthorizeNet doesn't return a delimited response.
-             */
-            if (count($this->_response_array) < 10) {
-                $this->approved = false;
-                $this->error = true;
-                $this->error_message = sprintf(
-                    esc_html__('Unrecognized response from Authorize.net: %1$s', 'event_espresso'),
-                    esc_html($response)
-                );
-                return;
-            }
-
-
-
-            // Set all fields
-            $this->response_code = $this->_response_array[0];
-            $this->response_subcode = $this->_response_array[1];
-            $this->response_reason_code = $this->_response_array[2];
-            $this->response_reason_text = $this->_response_array[3];
-            $this->authorization_code = $this->_response_array[4];
-            $this->avs_response = $this->_response_array[5];
-            $this->transaction_id = $this->_response_array[6];
-            $this->invoice_number = $this->_response_array[7];
-            $this->description = $this->_response_array[8];
-            $this->amount = $this->_response_array[9];
-            $this->method = $this->_response_array[10];
-            $this->transaction_type = $this->_response_array[11];
-            $this->customer_id = $this->_response_array[12];
-            $this->first_name = $this->_response_array[13];
-            $this->last_name = $this->_response_array[14];
-            $this->company = $this->_response_array[15];
-            $this->address = $this->_response_array[16];
-            $this->city = $this->_response_array[17];
-            $this->state = $this->_response_array[18];
-            $this->zip_code = $this->_response_array[19];
-            $this->country = $this->_response_array[20];
-            $this->phone = $this->_response_array[21];
-            $this->fax = $this->_response_array[22];
-            $this->email_address = $this->_response_array[23];
-            $this->ship_to_first_name = $this->_response_array[24];
-            $this->ship_to_last_name = $this->_response_array[25];
-            $this->ship_to_company = $this->_response_array[26];
-            $this->ship_to_address = $this->_response_array[27];
-            $this->ship_to_city = $this->_response_array[28];
-            $this->ship_to_state = $this->_response_array[29];
-            $this->ship_to_zip_code = $this->_response_array[30];
-            $this->ship_to_country = $this->_response_array[31];
-            $this->tax = $this->_response_array[32];
-            $this->duty = $this->_response_array[33];
-            $this->freight = $this->_response_array[34];
-            $this->tax_exempt = $this->_response_array[35];
-            $this->purchase_order_number = $this->_response_array[36];
-            $this->md5_hash = $this->_response_array[37];
-            $this->card_code_response = $this->_response_array[38];
-            $this->cavv_response = $this->_response_array[39];
-            $this->account_number = $this->_response_array[50];
-            $this->card_type = $this->_response_array[51];
-            $this->split_tender_id = $this->_response_array[52];
-            $this->requested_amount = $this->_response_array[53];
-            $this->balance_on_card = $this->_response_array[54];
-
-            $this->approved = ($this->response_code === self::APPROVED);
-            $this->declined = ($this->response_code === self::DECLINED);
-            $this->error = ($this->response_code === self::ERROR);
-            $this->held = ($this->response_code === self::HELD);
-        } else {
-            $this->approved = false;
-            $this->error = true;
-            $this->error_message = esc_html__(
-                'Error connecting to Authorize.net',
-                'event_espresso'
-            );
-        }
-    }
+	const APPROVED = '1';
+	const DECLINED = '2';
+	const ERROR = '3';
+	const HELD = '4';
+
+	protected $_x_post_fields = array(
+		"version"        => "3.1",
+		"delim_char"     => ",",
+		"delim_data"     => "TRUE",
+		"relay_response" => "FALSE",
+		"encap_char"     => "|",
+	);
+	public $approved;
+	public $declined;
+	public $error;
+	public $held;
+	public $response_code;
+	public $response_subcode;
+	public $response_reason_code;
+	public $response_reason_text;
+	public $authorization_code;
+	public $avs_response;
+	public $transaction_id;
+	public $invoice_number;
+	public $description;
+	public $amount;
+	public $method;
+	public $transaction_type;
+	public $customer_id;
+	public $first_name;
+	public $last_name;
+	public $company;
+	public $address;
+	public $city;
+	public $state;
+	public $zip_code;
+	public $country;
+	public $phone;
+	public $fax;
+	public $email_address;
+	public $ship_to_first_name;
+	public $ship_to_last_name;
+	public $ship_to_company;
+	public $ship_to_address;
+	public $ship_to_city;
+	public $ship_to_state;
+	public $ship_to_zip_code;
+	public $ship_to_country;
+	public $tax;
+	public $duty;
+	public $freight;
+	public $tax_exempt;
+	public $purchase_order_number;
+	public $md5_hash;
+	public $card_code_response;
+	public $cavv_response; // cardholder_authentication_verification_response
+	public $account_number;
+	public $card_type;
+	public $split_tender_id;
+	public $requested_amount;
+	public $balance_on_card;
+	public $response; // The response string from AuthorizeNet.
+	public $error_message;
+	private $_response_array = array(); // An array with the split response.
+
+
+	/**
+	 * Constructor. Parses the AuthorizeNet response string
+	 *
+	 * @param string $response The response from the AuthNet server.
+	 * @var string   $delimiter The delimiter used (default is ",")
+	 * @var string   $encap_char The encap_char used (default is "|")
+	 * @var array    $custom_fields Any custom fields set in the request.
+	 */
+
+	public function __construct($response)
+	{
+		$encap_char = $this->_x_post_fields['encap_char'];
+		$delimiter = $this->_x_post_fields['delim_char'];
+		if ($response) {
+			// Split Array
+			$this->response = $response;
+			if ($encap_char) {
+				$this->_response_array = explode($encap_char . $delimiter . $encap_char, substr($response, 1, -1));
+			} else {
+				$this->_response_array = explode($delimiter, $response);
+			}
+
+			/**
+			 * If AuthorizeNet doesn't return a delimited response.
+			 */
+			if (count($this->_response_array) < 10) {
+				$this->approved = false;
+				$this->error = true;
+				$this->error_message = sprintf(
+					esc_html__('Unrecognized response from Authorize.net: %1$s', 'event_espresso'),
+					esc_html($response)
+				);
+				return;
+			}
+
+
+
+			// Set all fields
+			$this->response_code = $this->_response_array[0];
+			$this->response_subcode = $this->_response_array[1];
+			$this->response_reason_code = $this->_response_array[2];
+			$this->response_reason_text = $this->_response_array[3];
+			$this->authorization_code = $this->_response_array[4];
+			$this->avs_response = $this->_response_array[5];
+			$this->transaction_id = $this->_response_array[6];
+			$this->invoice_number = $this->_response_array[7];
+			$this->description = $this->_response_array[8];
+			$this->amount = $this->_response_array[9];
+			$this->method = $this->_response_array[10];
+			$this->transaction_type = $this->_response_array[11];
+			$this->customer_id = $this->_response_array[12];
+			$this->first_name = $this->_response_array[13];
+			$this->last_name = $this->_response_array[14];
+			$this->company = $this->_response_array[15];
+			$this->address = $this->_response_array[16];
+			$this->city = $this->_response_array[17];
+			$this->state = $this->_response_array[18];
+			$this->zip_code = $this->_response_array[19];
+			$this->country = $this->_response_array[20];
+			$this->phone = $this->_response_array[21];
+			$this->fax = $this->_response_array[22];
+			$this->email_address = $this->_response_array[23];
+			$this->ship_to_first_name = $this->_response_array[24];
+			$this->ship_to_last_name = $this->_response_array[25];
+			$this->ship_to_company = $this->_response_array[26];
+			$this->ship_to_address = $this->_response_array[27];
+			$this->ship_to_city = $this->_response_array[28];
+			$this->ship_to_state = $this->_response_array[29];
+			$this->ship_to_zip_code = $this->_response_array[30];
+			$this->ship_to_country = $this->_response_array[31];
+			$this->tax = $this->_response_array[32];
+			$this->duty = $this->_response_array[33];
+			$this->freight = $this->_response_array[34];
+			$this->tax_exempt = $this->_response_array[35];
+			$this->purchase_order_number = $this->_response_array[36];
+			$this->md5_hash = $this->_response_array[37];
+			$this->card_code_response = $this->_response_array[38];
+			$this->cavv_response = $this->_response_array[39];
+			$this->account_number = $this->_response_array[50];
+			$this->card_type = $this->_response_array[51];
+			$this->split_tender_id = $this->_response_array[52];
+			$this->requested_amount = $this->_response_array[53];
+			$this->balance_on_card = $this->_response_array[54];
+
+			$this->approved = ($this->response_code === self::APPROVED);
+			$this->declined = ($this->response_code === self::DECLINED);
+			$this->error = ($this->response_code === self::ERROR);
+			$this->held = ($this->response_code === self::HELD);
+		} else {
+			$this->approved = false;
+			$this->error = true;
+			$this->error_message = esc_html__(
+				'Error connecting to Authorize.net',
+				'event_espresso'
+			);
+		}
+	}
 }
 
 if (! class_exists('AuthorizeNetException')) {
-    /**
-     * Class AuthorizeNetException
-     *
-     * @package    AuthorizeNet
-     */
-    class AuthorizeNetException extends Exception
-    {
-        /**
-         * Construct the exception. Note: The message is NOT binary safe.
-         *
-         * @link http://php.net/manual/en/exception.construct.php
-         * @param string $message [optional] The Exception message to throw.
-         * @param int $code [optional] The Exception code.
-         * @param Exception $previous [optional] The previous exception used for the exception chaining. Since 5.3.0
-         * @since 5.1.0
-         */
-        public function __construct($message = "", $code = 0, Exception $previous = null)
-        {
-            parent::__construct($message, $code, $previous);
-        }
-    }
+	/**
+	 * Class AuthorizeNetException
+	 *
+	 * @package    AuthorizeNet
+	 */
+	class AuthorizeNetException extends Exception
+	{
+		/**
+		 * Construct the exception. Note: The message is NOT binary safe.
+		 *
+		 * @link http://php.net/manual/en/exception.construct.php
+		 * @param string $message [optional] The Exception message to throw.
+		 * @param int $code [optional] The Exception code.
+		 * @param Exception $previous [optional] The previous exception used for the exception chaining. Since 5.3.0
+		 * @since 5.1.0
+		 */
+		public function __construct($message = "", $code = 0, Exception $previous = null)
+		{
+			parent::__construct($message, $code, $previous);
+		}
+	}
 }

caffeinated/payment_methods/Aim/templates/aim_intro.template.php

Indentation +6 added lines, -6 removed lines

@@ -1,10 +1,10 @@
 <?php
 
 printf(
-    esc_html__(
-        'Authorize.Net AIM is an on-site payment method for accepting credit and debit card payments and is available to event organizers in the United States, Canada, United Kingdom, and Australia. An account with Authorize.Net is required to accept payments. Need an Authorize.Net account? %1$sClick here to sign up for a merchant account%2$s.',
-        'event_espresso'
-    ),
-    '<a href="https://eventespresso.com/go/authorizenetaim/" target="_blank">',
-    '</a>'
+	esc_html__(
+		'Authorize.Net AIM is an on-site payment method for accepting credit and debit card payments and is available to event organizers in the United States, Canada, United Kingdom, and Australia. An account with Authorize.Net is required to accept payments. Need an Authorize.Net account? %1$sClick here to sign up for a merchant account%2$s.',
+		'event_espresso'
+	),
+	'<a href="https://eventespresso.com/go/authorizenetaim/" target="_blank">',
+	'</a>'
 );

caffeinated/modules/recaptcha/autoload.php

Indentation +16 added lines, -16 removed lines

@@ -7,33 +7,33 @@
  */
 
 spl_autoload_register(function ($class) {
-    if (substr($class, 0, 10) !== 'ReCaptcha\\') {
-        /* If the class does not lie under the "ReCaptcha" namespace,
+	if (substr($class, 0, 10) !== 'ReCaptcha\\') {
+		/* If the class does not lie under the "ReCaptcha" namespace,
          * then we can exit immediately.
          */
-        return;
-    }
+		return;
+	}
 
-    /* All of the classes have names like "ReCaptcha\Foo", so we need
+	/* All of the classes have names like "ReCaptcha\Foo", so we need
      * to replace the backslashes with frontslashes if we want the
      * name to map directly to a location in the filesystem.
      */
-    $class = str_replace('\\', '/', $class);
+	$class = str_replace('\\', '/', $class);
 
-    /* First, check under the current directory. It is important that
+	/* First, check under the current directory. It is important that
      * we look here first, so that we don't waste time searching for
      * test classes in the common case.
      */
-    $path = dirname(__FILE__) . '/' . $class . '.php';
-    if (is_readable($path)) {
-        require_once $path;
-    }
+	$path = dirname(__FILE__) . '/' . $class . '.php';
+	if (is_readable($path)) {
+		require_once $path;
+	}
 
-    /* If we didn't find what we're looking for already, maybe it's
+	/* If we didn't find what we're looking for already, maybe it's
      * a test class?
      */
-    $path = dirname(__FILE__) . '/../tests/' . $class . '.php';
-    if (is_readable($path)) {
-        require_once $path;
-    }
+	$path = dirname(__FILE__) . '/../tests/' . $class . '.php';
+	if (is_readable($path)) {
+		require_once $path;
+	}
 });

Spacing +3 added lines, -3 removed lines

@@ -6,7 +6,7 @@ 
  * classes.
  */
 
-spl_autoload_register(function ($class) {
+spl_autoload_register(function($class) {
     if (substr($class, 0, 10) !== 'ReCaptcha\\') {
         /* If the class does not lie under the "ReCaptcha" namespace,
          * then we can exit immediately.
@@ -24,7 +24,7 @@ 
      * we look here first, so that we don't waste time searching for
      * test classes in the common case.
      */
-    $path = dirname(__FILE__) . '/' . $class . '.php';
+    $path = dirname(__FILE__).'/'.$class.'.php';
     if (is_readable($path)) {
         require_once $path;
     }
@@ -32,7 +32,7 @@ 
     /* If we didn't find what we're looking for already, maybe it's
      * a test class?
      */
-    $path = dirname(__FILE__) . '/../tests/' . $class . '.php';
+    $path = dirname(__FILE__).'/../tests/'.$class.'.php';
     if (is_readable($path)) {
         require_once $path;
     }

core/libraries/rest_api/Capabilities.php

Spacing +11 added lines, -11 removed lines

@@ -99,7 +99,7 @@ 
     ) {
         $has_password = $model->hasPassword();
         if ($has_password) {
-            $entity[ $model->getPasswordField()->get_name() ] = ModelDataTranslator::prepareFieldValueForJson(
+            $entity[$model->getPasswordField()->get_name()] = ModelDataTranslator::prepareFieldValueForJson(
                 $model->getPasswordField(),
                 $model->getPasswordField()->get_default_value(),
                 $model_version_info->requestedVersion()
@@ -109,7 +109,7 @@ 
             if (
                 $has_password
                 && $model->getPasswordField()->fieldIsProtected($field_name)
-                && $entity[ $field_name ]
+                && $entity[$field_name]
             ) {
                 $replacement_value = ModelDataTranslator::prepareFieldValueForJson(
                     $field_obj,
@@ -117,10 +117,10 @@ 
                     $model_version_info->requestedVersion()
                 );
                 if ($model_version_info->fieldHasRenderedFormat($field_obj)) {
-                    $entity[ $field_name ]['rendered'] = $replacement_value;
+                    $entity[$field_name]['rendered'] = $replacement_value;
                 } elseif ($model_version_info->fieldHasPrettyFormat($field_obj)) {
-                    $entity[ $field_name ]['raw'] = $replacement_value;
-                    $entity[ $field_name ]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
+                    $entity[$field_name]['raw'] = $replacement_value;
+                    $entity[$field_name]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
                         $field_obj,
                         $field_obj->prepare_for_pretty_echoing($field_obj->get_default_value()),
                         $model_version_info->requestedVersion()
@@ -131,7 +131,7 @@ 
                     // so just remove it (or rather, set its default)
                     // API clients will just need to look to fields with rendered formats to know if these have
                     // been redacted. Sorry.
-                    $entity[ $field_name ] = $replacement_value;
+                    $entity[$field_name] = $replacement_value;
                 }
             }
         }
@@ -160,11 +160,11 @@ 
         foreach ($model->field_settings() as $field_name => $field_obj) {
             if (
                 $model_version_info->fieldHasRenderedFormat($field_obj)
-                && isset($entity[ $field_name ])
-                && is_array($entity[ $field_name ])
-                && isset($entity[ $field_name ]['raw'])
+                && isset($entity[$field_name])
+                && is_array($entity[$field_name])
+                && isset($entity[$field_name]['raw'])
             ) {
-                unset($entity[ $field_name ]['raw']);
+                unset($entity[$field_name]['raw']);
             }
         }
         // theoretically we may want to filter out specific fields for specific models
@@ -190,7 +190,7 @@ 
      */
     public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
     {
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
             $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),

Indentation +177 added lines, -177 removed lines

@@ -18,190 +18,190 @@
  */
 class Capabilities
 {
-    /**
-     * The current user can see at least SOME of these entities.
-     *
-     * @param EEM_Base $model
-     * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
-     * @return boolean
-     */
-    public static function currentUserHasPartialAccessTo($model, $model_context = EEM_Base::caps_read)
-    {
-        if (
-            apply_filters(
-                'FHEE__Capabilities__current_user_has_partial_access_to__override_begin',
-                false,
-                $model,
-                $model
-            )
-        ) {
-            return true;
-        }
-        foreach ($model->caps_missing($model_context) as $capability_name => $restriction_obj) {
-            if ($restriction_obj instanceof EE_Return_None_Where_Conditions) {
-                return false;
-            }
-        }
-        if (
-            apply_filters(
-                'FHEE__Capabilities__current_user_has_partial_access_to__override_end',
-                false,
-                $model,
-                $model
-            )
-        ) {
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * The current user can see at least SOME of these entities.
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
+	 * @return boolean
+	 */
+	public static function currentUserHasPartialAccessTo($model, $model_context = EEM_Base::caps_read)
+	{
+		if (
+			apply_filters(
+				'FHEE__Capabilities__current_user_has_partial_access_to__override_begin',
+				false,
+				$model,
+				$model
+			)
+		) {
+			return true;
+		}
+		foreach ($model->caps_missing($model_context) as $capability_name => $restriction_obj) {
+			if ($restriction_obj instanceof EE_Return_None_Where_Conditions) {
+				return false;
+			}
+		}
+		if (
+			apply_filters(
+				'FHEE__Capabilities__current_user_has_partial_access_to__override_end',
+				false,
+				$model,
+				$model
+			)
+		) {
+			return false;
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets an array of all the capabilities the current user is missing that affected
-     * the query
-     *
-     * @param EEM_Base $model
-     * @param string   $request_type one of the constants on WP_JSON_Server
-     * @return array
-     */
-    public static function getMissingPermissions($model, $request_type = EEM_Base::caps_read)
-    {
-        return $model->caps_missing($request_type);
-    }
+	/**
+	 * Gets an array of all the capabilities the current user is missing that affected
+	 * the query
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $request_type one of the constants on WP_JSON_Server
+	 * @return array
+	 */
+	public static function getMissingPermissions($model, $request_type = EEM_Base::caps_read)
+	{
+		return $model->caps_missing($request_type);
+	}
 
 
-    /**
-     * Gets a string of all the capabilities the current user is missing that affected
-     * the query
-     *
-     * @param EEM_Base $model
-     * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
-     * @return string
-     */
-    public static function getMissingPermissionsString($model, $model_context = EEM_Base::caps_read)
-    {
-        return implode(',', array_keys(self::getMissingPermissions($model, $model_context)));
-    }
+	/**
+	 * Gets a string of all the capabilities the current user is missing that affected
+	 * the query
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
+	 * @return string
+	 */
+	public static function getMissingPermissionsString($model, $model_context = EEM_Base::caps_read)
+	{
+		return implode(',', array_keys(self::getMissingPermissions($model, $model_context)));
+	}
 
-    /**
-     * "Removes" password-protected fields. Currently that means setting their values to their default.
-     * @since 4.9.74.p
-     * @param array $entity
-     * @param EEM_Base $model
-     * @param ModelVersionInfo $model_version_info
-     * @return array
-     * @throws EE_Error
-     */
-    public static function filterOutPasswordProtectedFields(
-        $entity,
-        $model,
-        $model_version_info
-    ) {
-        $has_password = $model->hasPassword();
-        if ($has_password) {
-            $entity[ $model->getPasswordField()->get_name() ] = ModelDataTranslator::prepareFieldValueForJson(
-                $model->getPasswordField(),
-                $model->getPasswordField()->get_default_value(),
-                $model_version_info->requestedVersion()
-            );
-        }
-        foreach ($model->field_settings() as $field_name => $field_obj) {
-            if (
-                $has_password
-                && $model->getPasswordField()->fieldIsProtected($field_name)
-                && $entity[ $field_name ]
-            ) {
-                $replacement_value = ModelDataTranslator::prepareFieldValueForJson(
-                    $field_obj,
-                    $field_obj->get_default_value(),
-                    $model_version_info->requestedVersion()
-                );
-                if ($model_version_info->fieldHasRenderedFormat($field_obj)) {
-                    $entity[ $field_name ]['rendered'] = $replacement_value;
-                } elseif ($model_version_info->fieldHasPrettyFormat($field_obj)) {
-                    $entity[ $field_name ]['raw'] = $replacement_value;
-                    $entity[ $field_name ]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
-                        $field_obj,
-                        $field_obj->prepare_for_pretty_echoing($field_obj->get_default_value()),
-                        $model_version_info->requestedVersion()
-                    );
-                } else {
-                    // this is most likely an excerpt field. (These should have also had "rendered" and "raw"
-                    // versions, but we missed that, and can't change it without breaking backward compatibility)
-                    // so just remove it (or rather, set its default)
-                    // API clients will just need to look to fields with rendered formats to know if these have
-                    // been redacted. Sorry.
-                    $entity[ $field_name ] = $replacement_value;
-                }
-            }
-        }
-        return $entity;
-    }
+	/**
+	 * "Removes" password-protected fields. Currently that means setting their values to their default.
+	 * @since 4.9.74.p
+	 * @param array $entity
+	 * @param EEM_Base $model
+	 * @param ModelVersionInfo $model_version_info
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function filterOutPasswordProtectedFields(
+		$entity,
+		$model,
+		$model_version_info
+	) {
+		$has_password = $model->hasPassword();
+		if ($has_password) {
+			$entity[ $model->getPasswordField()->get_name() ] = ModelDataTranslator::prepareFieldValueForJson(
+				$model->getPasswordField(),
+				$model->getPasswordField()->get_default_value(),
+				$model_version_info->requestedVersion()
+			);
+		}
+		foreach ($model->field_settings() as $field_name => $field_obj) {
+			if (
+				$has_password
+				&& $model->getPasswordField()->fieldIsProtected($field_name)
+				&& $entity[ $field_name ]
+			) {
+				$replacement_value = ModelDataTranslator::prepareFieldValueForJson(
+					$field_obj,
+					$field_obj->get_default_value(),
+					$model_version_info->requestedVersion()
+				);
+				if ($model_version_info->fieldHasRenderedFormat($field_obj)) {
+					$entity[ $field_name ]['rendered'] = $replacement_value;
+				} elseif ($model_version_info->fieldHasPrettyFormat($field_obj)) {
+					$entity[ $field_name ]['raw'] = $replacement_value;
+					$entity[ $field_name ]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
+						$field_obj,
+						$field_obj->prepare_for_pretty_echoing($field_obj->get_default_value()),
+						$model_version_info->requestedVersion()
+					);
+				} else {
+					// this is most likely an excerpt field. (These should have also had "rendered" and "raw"
+					// versions, but we missed that, and can't change it without breaking backward compatibility)
+					// so just remove it (or rather, set its default)
+					// API clients will just need to look to fields with rendered formats to know if these have
+					// been redacted. Sorry.
+					$entity[ $field_name ] = $replacement_value;
+				}
+			}
+		}
+		return $entity;
+	}
 
 
-    /**
-     * Takes a entity that's ready to be returned and removes fields which the user shouldn't be able to access.
-     *
-     * @param array $entity
-     * @param EEM_Base $model
-     * @param string $request_type one of the return values from EEM_Base::valid_cap_contexts()
-     * @param ModelVersionInfo $model_version_info
-     * @param string $primary_key_string result of EEM_Base::get_index_primary_key_string(), so that we can
-     *                                               use this with models that have no primary key
-     * @return array ready for converting into json
-     */
-    public static function filterOutInaccessibleEntityFields(
-        $entity,
-        $model,
-        $request_type,
-        $model_version_info,
-        $primary_key_string = null
-    ) {
-        foreach ($model->field_settings() as $field_name => $field_obj) {
-            if (
-                $model_version_info->fieldHasRenderedFormat($field_obj)
-                && isset($entity[ $field_name ])
-                && is_array($entity[ $field_name ])
-                && isset($entity[ $field_name ]['raw'])
-            ) {
-                unset($entity[ $field_name ]['raw']);
-            }
-        }
-        // theoretically we may want to filter out specific fields for specific models
-        return apply_filters(
-            'FHEE__Capabilities__filter_out_inaccessible_entity_fields',
-            $entity,
-            $model,
-            $request_type
-        );
-    }
+	/**
+	 * Takes a entity that's ready to be returned and removes fields which the user shouldn't be able to access.
+	 *
+	 * @param array $entity
+	 * @param EEM_Base $model
+	 * @param string $request_type one of the return values from EEM_Base::valid_cap_contexts()
+	 * @param ModelVersionInfo $model_version_info
+	 * @param string $primary_key_string result of EEM_Base::get_index_primary_key_string(), so that we can
+	 *                                               use this with models that have no primary key
+	 * @return array ready for converting into json
+	 */
+	public static function filterOutInaccessibleEntityFields(
+		$entity,
+		$model,
+		$request_type,
+		$model_version_info,
+		$primary_key_string = null
+	) {
+		foreach ($model->field_settings() as $field_name => $field_obj) {
+			if (
+				$model_version_info->fieldHasRenderedFormat($field_obj)
+				&& isset($entity[ $field_name ])
+				&& is_array($entity[ $field_name ])
+				&& isset($entity[ $field_name ]['raw'])
+			) {
+				unset($entity[ $field_name ]['raw']);
+			}
+		}
+		// theoretically we may want to filter out specific fields for specific models
+		return apply_filters(
+			'FHEE__Capabilities__filter_out_inaccessible_entity_fields',
+			$entity,
+			$model,
+			$request_type
+		);
+	}
 
 
-    /**
-     * Verifies the current user has at least partial access to do this action on this model.
-     * If not, throws an exception (so we can define the code that sets up this error object
-     * once)
-     *
-     * @param EEM_Base $model
-     * @param string   $model_action_context
-     * @param string   $action_name
-     * @return void
-     * @throws RestException
-     */
-    public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
-    {
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
-            $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),
-                sprintf(
-                    esc_html__('Sorry, you are not allowed to %1$s %2$s. Missing permissions: %3$s', 'event_espresso'),
-                    $action_name,
-                    $model_name_plural,
-                    Capabilities::getMissingPermissionsString($model, $model_action_context)
-                ),
-                array('status' => 403)
-            );
-        }
-    }
+	/**
+	 * Verifies the current user has at least partial access to do this action on this model.
+	 * If not, throws an exception (so we can define the code that sets up this error object
+	 * once)
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_action_context
+	 * @param string   $action_name
+	 * @return void
+	 * @throws RestException
+	 */
+	public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
+	{
+		if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
+			$model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),
+				sprintf(
+					esc_html__('Sorry, you are not allowed to %1$s %2$s. Missing permissions: %3$s', 'event_espresso'),
+					$action_name,
+					$model_name_plural,
+					Capabilities::getMissingPermissionsString($model, $model_action_context)
+				),
+				array('status' => 403)
+			);
+		}
+	}
 }

core/libraries/rest_api/RestIncomingQueryParamMetadata.php

Indentation +701 added lines, -701 removed lines

@@ -28,707 +28,707 @@
  */
 class RestIncomingQueryParamMetadata
 {
-    private $query_param_key;
-    private $query_param_value;
-    /**
-     * @var RestIncomingQueryParamContext
-     */
-    private $context;
-
-    /**
-     * @var EE_Model_Field_Base|null
-     */
-    private $field;
-
-    /**
-     * @var string same as $query_param_key but has the * and anything after it removed
-     */
-    private $query_param_key_sans_stars;
-
-    /**
-     * @var string for timezone or timezone offset
-     */
-    private $timezone;
-
-    /**
-     * @var boolean if the field in $query_param_key is for a GMT field (eg `EVT_modified_gmt`)
-     */
-    private $is_gmt_field = false;
-
-    /**
-     * RestIncomingQueryParamMetadata constructor.
-     * You probably want to call
-     * @param string $query_param_key
-     * @param string $query_param_value
-     * @param RestIncomingQueryParamContext $context
-     */
-    public function __construct($query_param_key, $query_param_value, RestIncomingQueryParamContext $context)
-    {
-        $this->query_param_key = $query_param_key;
-        $this->query_param_value = $query_param_value;
-        $this->context = $context;
-        $this->determineFieldAndTimezone();
-    }
-
-    /**
-     * Gets the query parameter key. This may have been modified (see setQueryParamValue())
-     * @return string
-     */
-    public function getQueryParamKey()
-    {
-        return $this->query_param_key;
-    }
-
-    /**
-     * Modifies the query parameter key passed in (Eg this is done when rewriting the simplified specified operator REST
-     * query parameters into the legacy structure)
-     * @param string|array|int|float $query_param_value
-     */
-    private function setQueryParamValue($query_param_value)
-    {
-        $this->query_param_value = $query_param_value;
-    }
-
-    /**
-     * Gets the original query parameter value passed in.
-     * @return string
-     */
-    public function getQueryParamValue()
-    {
-        return $this->query_param_value;
-    }
-
-    /**
-     * Gets the context object.
-     * @return RestIncomingQueryParamContext
-     */
-    public function getContext()
-    {
-        return $this->context;
-    }
-
-    /**
-     * Sets the query parameter key. This may be used to rewrite a key into its non-GMT alternative.
-     * @param string $query_param_key
-     */
-    private function setQueryParamKey($query_param_key)
-    {
-        $this->query_param_key = $query_param_key;
-    }
-
-    /**
-     * Gets the field the query parameter key indicated. This may be null (in cases where the query parameter key
-     * did not indicate a field, eg if it were `OR`).
-     * @return EE_Model_Field_Base|null
-     */
-    public function getField()
-    {
-        return $this->field;
-    }
-
-    /**
-     * Gets the query parameter key (with the star and everything afterwards removed).
-     * @return string
-     */
-    public function getQueryParamKeySansStars()
-    {
-        return $this->query_param_key_sans_stars;
-    }
-
-    /**
-     * Gets the timezone associated with this model (the site timezone, except for GMT datetime fields).
-     * @return string
-     */
-    public function getTimezone()
-    {
-        return $this->timezone;
-    }
-
-    /**
-     * Returns whether or not this is a GMT field
-     * @return boolean
-     */
-    public function isGmtField()
-    {
-        return $this->is_gmt_field;
-    }
-
-    /**
-     * Sets the field indicated by the query parameter key (might be null).
-     * @param EE_Model_Field_Base|null $field
-     */
-    private function setField(EE_Model_Field_Base $field = null)
-    {
-        $this->field = $field;
-    }
-
-    /**
-     * Sets the query parameter key-with-stars-removed.
-     * @param string $query_param_key_sans_stars
-     */
-    private function setQueryParamKeySansStars($query_param_key_sans_stars)
-    {
-        $this->query_param_key_sans_stars = $query_param_key_sans_stars;
-    }
-
-    /**
-     * Sets the timezone (this could be a timezeon offset string).
-     * @param string $timezone
-     */
-    private function setTimezone($timezone)
-    {
-        $this->timezone = $timezone;
-    }
-
-    /**
-     * @param mixed $is_gmt_field
-     */
-    private function setIsGmtField($is_gmt_field)
-    {
-        $this->is_gmt_field = $is_gmt_field;
-    }
-
-    /**
-     * Determines what field, query param name, and query param name without stars, and timezone to use.
-     * @since 4.9.72.p
-     * @type EE_Model_Field_Base $field
-     * @return void {
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function determineFieldAndTimezone()
-    {
-        $this->setQueryParamKeySansStars(ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
-            $this->getQueryParamKey()
-        ));
-        $this->setField(ModelDataTranslator::deduceFieldFromQueryParam(
-            $this->getQueryParamKeySansStars(),
-            $this->getContext()->getModel()
-        ));
-        // double-check is it a *_gmt field?
-        if (
-            !$this->getField() instanceof EE_Model_Field_Base
-            && ModelDataTranslator::isGmtDateFieldName($this->getQueryParamKeySansStars())
-        ) {
-            // yep, take off '_gmt', and find the field
-            $this->setQueryParamKey(ModelDataTranslator::removeGmtFromFieldName($this->getQueryParamKeySansStars()));
-            $this->setField(ModelDataTranslator::deduceFieldFromQueryParam(
-                $this->getQueryParamKey(),
-                $this->context->getModel()
-            ));
-            $this->setTimezone('UTC');
-            $this->setIsGmtField(true);
-        } elseif ($this->getField() instanceof EE_Datetime_Field) {
-            // so it's not a GMT field. Set the timezone on the model to the default
-            $this->setTimezone(EEH_DTT_Helper::get_valid_timezone_string());
-        } else {
-            // just keep using what's already set for the timezone
-            $this->setTimezone($this->context->getModel()->get_timezone());
-        }
-        $this->assertOnlyAdminCanReadPasswordFields();
-    }
-
-    /**
-     * Throws an exception if a non-admin is trying to query by password.
-     * @since 4.9.74.p
-     * @throws RestException
-     */
-    private function assertOnlyAdminCanReadPasswordFields()
-    {
-        if (
-            $this->getField() instanceof EE_Password_Field
-            && ! current_user_can(EE_Restriction_Generator_Base::get_default_restrictions_cap())
-        ) {
-            // only full admins can query by password. sorry bub!
-            throw new RestException(
-                'only_admins_can_query_by_password',
-                // @codingStandardsIgnoreStart
-                esc_html__('You attempted to filter by a password field without the needed privileges. Only a full admin is allowed to do that.', 'event_espresso'),
-                // @codingStandardsIgnoreEnd
-                array(
-                    'status' => 403
-                )
-            );
-        }
-    }
-
-    /**
-     * Given a ton of input, determines the value to use for the models.
-     * @since 4.9.72.p
-     * @return array|null
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws RestException
-     * @throws DomainException
-     */
-    public function determineConditionsQueryParameterValue()
-    {
-        if ($this->valueIsArrayDuringRead()) {
-            return $this->determineModelValueGivenRestInputArray();
-        }
-        return ModelDataTranslator::prepareFieldValueFromJson(
-            $this->getField(),
-            $this->getQueryParamValue(),
-            $this->getContext()->getRequestedVersion(),
-            $this->getTimezone()
-        );
-    }
-
-    /**
-     * Given that the array value provided was itself an array, handles finding the correct value to pass to the model.
-     * @since 4.9.72.p
-     * @return array|null
-     * @throws RestException
-     */
-    private function determineModelValueGivenRestInputArray()
-    {
-        $this->transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax();
-        // did they specify an operator?
-        if ($this->valueIsLegacySpecifiedOperator()) {
-            $query_param_value = $this->getQueryParamValue();
-            $sub_array_key = $query_param_value[0];
-            $translated_value = array($sub_array_key);
-            if ($this->operatorIsNAry($sub_array_key)) {
-                $translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
-            } elseif ($this->operatorIsTernary($sub_array_key)) {
-                $translated_value[] = array(
-                    $this->prepareValuesFromJson($query_param_value[1][0]),
-                    $this->prepareValuesFromJson($query_param_value[1][1])
-                );
-            } elseif ($this->operatorIsLike($sub_array_key)) {
-                // we want to leave this value mostly-as-is (eg don't force it to be a float
-                // or a boolean or an enum value. Leave it as-is with wildcards etc)
-                // but do verify it at least doesn't have any serialized data
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
-                $translated_value[] = $query_param_value[1];
-            } elseif ($this->operatorIsUnary($sub_array_key)) {
-                // no arguments should have been provided, so don't look for any
-            } elseif ($this->operatorisBinary($sub_array_key)) {
-                // it's a valid operator, but none of the exceptions. Treat it normally.
-                $translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
-            } else {
-                // so they provided a valid operator, but wrong number of arguments
-                $this->throwWrongNumberOfArgsExceptionIfDebugging($sub_array_key);
-                $translated_value = null;
-            }
-        } else {
-            // so they didn't provide a valid operator
-            // if we aren't in debug mode, then just try our best to fulfill the user's request
-            $this->throwInvalidOperatorExceptionIfDebugging();
-            $translated_value = null;
-        }
-        return $translated_value;
-    }
-
-    /**
-     * Returns if this request is a "read" request and the value provided was an array.
-     * This will indicate is such things as `array('<', 123)` and `array('IN', array(1,2,3))` are acceptable or not.
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function valueIsArrayDuringRead()
-    {
-        return !$this->getContext()->isWriting() && is_array($this->getQueryParamValue());
-    }
-
-    /**
-     * Returns if the value provided was an associative array (we should have already verified it's an array of some
-     * sort). If the value is an associative array, it had better be in the simplified specified operator structure.
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function valueIsAssociativeArray()
-    {
-        return !EEH_Array::is_array_numerically_and_sequentially_indexed($this->getQueryParamValue());
-    }
-
-    /**
-     * Checks if the array value is itself an array that fits into the simplified specified operator structure
-     * (eg `array('!=' => 123)`).
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function valueIsSimplifiedSpecifiedOperator()
-    {
-        return count($this->getQueryParamValue()) === 1
-            && array_key_exists(
-                key($this->getQueryParamValue()),
-                $this->getContext()->getModel()->valid_operators()
-            );
-    }
-
-    /**
-     * Throws an exception if the sub-value is an array (eg `array('!=' => array())`). It needs to just be a string,
-     * of either comma-separated-values, or a JSON array.
-     * @since 4.9.72.p
-     * @param $sub_array_key
-     * @param $sub_array_value
-     * @throws RestException
-     */
-    private function assertSubValueIsntArray($sub_array_key, $sub_array_value)
-    {
-        if (is_array($sub_array_value) && EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'csv_or_json_string_only',
-                sprintf(
-                    /* translators: 1: variable name*/
-                    esc_html__(
-                        'The value provided for the operator "%1$s" should be comma-separated value string or a JSON array.',
-                        'event_espresso'
-                    ),
-                    $sub_array_key
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-    }
-
-    /**
-     * Determines if the sub-array key is an operator taking 3 or more operators.
-     * @since 4.9.72.p
-     * @param $sub_array_key
-     * @return boolean
-     */
-    private function subArrayKeyIsNonBinaryOperator($sub_array_key)
-    {
-        return array_key_exists(
-            $sub_array_key,
-            array_merge(
-                $this->getContext()->getModel()->valid_in_style_operators(),
-                $this->getContext()->getModel()->valid_between_style_operators()
-            )
-        );
-    }
-
-    /**
-     * Given that the $sub_array_key is a string, checks if it's an operator taking only 1 argument.
-     * @since 4.9.72.p
-     * @param string $sub_array_key
-     * @return boolean
-     */
-    private function subArrayKeyIsUnaryOperator($sub_array_key)
-    {
-        return array_key_exists(
-            $sub_array_key,
-            $this->getContext()->getModel()->valid_null_style_operators()
-        );
-    }
-
-    /**
-     * Parses the $sub_array_value string into an array (given it could either be a comma-separated-list or a JSON
-     * array). eg `"1,2,3"` or `"[1,2,3]"` into `array(1,2,3)`.
-     * @since 4.9.72.p
-     * @param $sub_array_value
-     * @return array|mixed|object
-     */
-    private function extractQuickStyleSpecifiedOperatorValue($sub_array_value)
-    {
-        // the value should be JSON or CSV
-        $values = json_decode($sub_array_value);
-        if (!is_array($values)) {
-            $values = array_filter(
-                array_map(
-                    'trim',
-                    explode(
-                        ',',
-                        $sub_array_value
-                    )
-                )
-            );
-        }
-        return $values;
-    }
-
-    /**
-     * Throws an exception if the value isn't a simplified specified operator (only called when we expect that).
-     * @since 4.9.72.p
-     * @throws RestException
-     */
-    private function assertSimplifiedSpecifiedOperator()
-    {
-        if (!$this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'numerically_indexed_array_of_values_only',
-                sprintf(
-                    /* translators: 1: variable name*/
-                    esc_html__(
-                        'The array provided for the parameter "%1$s" should be numerically indexed.',
-                        'event_espresso'
-                    ),
-                    $this->getQueryParamKey()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-    }
-
-    /**
-     * If query_param_value were in the simplified specific operator structure, change it into the legacy structure.
-     * @since 4.9.72.p
-     * @throws RestException
-     */
-    private function transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax()
-    {
-        if ($this->valueIsAssociativeArray()) {
-            $this->assertSimplifiedSpecifiedOperator();
-            $query_param_value = $this->getQueryParamValue();
-            $sub_array_value = reset($query_param_value);
-            $sub_array_key = key($query_param_value);
-            $this->assertSubValueIsntArray($sub_array_key, $sub_array_value);
-            // they're doing something like "&where[EVT_ID][IN]=1,2,3" or "&where[EVT_ID][>]=5"
-            if ($this->subArrayKeyIsNonBinaryOperator($sub_array_key)) {
-                $this->setQueryParamValue(array(
-                    $sub_array_key,
-                    $this->extractQuickStyleSpecifiedOperatorValue($sub_array_value)
-                ));
-            } elseif ($this->subArrayKeyIsUnaryOperator($sub_array_key)) {
-                $this->setQueryParamValue(array($sub_array_key));
-            } else {
-                $this->setQueryParamValue(array($sub_array_key, $sub_array_value));
-            }
-        }
-    }
-
-    /**
-     * Returns true is the value is an array using the legacy structure to specify the operator. Eg `array('!=',123)`.
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function valueIsLegacySpecifiedOperator()
-    {
-        $valid_operators = $this->getContext()->getModel()->valid_operators();
-        $query_param_value = $this->getQueryParamValue();
-        return isset($query_param_value[0])
-            && isset($valid_operators[ $query_param_value[0] ]);
-    }
-
-    /**
-     * Returns true if the value specified operator accepts arbitrary number of arguments, like "IN".
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorIsNAry($operator)
-    {
-        $valueArray = $this->getQueryParamValue();
-        return array_key_exists(
-            $operator,
-            $this->getContext()->getModel()->valid_in_style_operators()
-        )
-            && isset($valueArray[1])
-            && is_array($valueArray[1])
-            && !isset($valueArray[2]);
-    }
-
-    /**
-     * Returns true if the operator accepts 3 arguments (eg "BETWEEN").
-     * So we're looking for a value that looks like
-     * `array('BETWEEN', array('2015-01-01T00:00:00', '2016-01-01T00:00:00'))`.
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorIsTernary($operator)
-    {
-        $query_param_value = $this->getQueryParamValue();
-        return array_key_exists($operator, $this->getContext()->getModel()->valid_between_style_operators())
-            && isset($query_param_value[1])
-            && is_array($query_param_value[1])
-            && isset($query_param_value[1][0], $query_param_value[1][1])
-            && !isset($query_param_value[1][2])
-            && !isset($query_param_value[2]);
-    }
-
-    /**
-     * Returns true if the operator is a similar to LIKE, indicating the value may have wildcards we should leave alone.
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorIsLike($operator)
-    {
-        $query_param_value = $this->getQueryParamValue();
-        return array_key_exists($operator, $this->getContext()->getModel()->valid_like_style_operators())
-            && isset($query_param_value[1])
-            && !isset($query_param_value[2]);
-    }
-
-    /**
-     * Returns true if the operator only takes one argument (eg it's like `IS NULL`).
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorIsUnary($operator)
-    {
-        $query_param_value = $this->getQueryParamValue();
-        return array_key_exists($operator, $this->getContext()->getModel()->valid_null_style_operators())
-            && !isset($query_param_value[1]);
-    }
-
-    /**
-     * Returns true if the operator specified is a binary opeator (eg `=`, `!=`)
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorisBinary($operator)
-    {
-        $query_param_value = $this->getQueryParamValue();
-        $model = $this->getContext()->getModel();
-        return isset($query_param_value[1])
-            && !isset($query_param_value[2])
-            && !array_key_exists(
-                $operator,
-                array_merge(
-                    $model->valid_in_style_operators(),
-                    $model->valid_null_style_operators(),
-                    $model->valid_like_style_operators(),
-                    $model->valid_between_style_operators()
-                )
-            );
-    }
-
-    /**
-     * If we're debugging, throws an exception saying that the wrong number of arguments was provided.
-     * @since 4.9.72.p
-     * @param $operator
-     * @throws RestException
-     */
-    private function throwWrongNumberOfArgsExceptionIfDebugging($operator)
-    {
-        if (EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'wrong_number_of_arguments',
-                sprintf(
-                    esc_html__(
-                        'The operator you provided, "%1$s" had the wrong number of arguments',
-                        'event_espresso'
-                    ),
-                    $operator
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-    }
-
-    /**
-     * Wrapper for ModelDataTranslator::prepareFieldValuesFromJson(), just a tad more DRY.
-     * @since 4.9.72.p
-     * @param $value
-     * @return mixed
-     * @throws RestException
-     */
-    private function prepareValuesFromJson($value)
-    {
-        return ModelDataTranslator::prepareFieldValuesFromJson(
-            $this->getField(),
-            $value,
-            $this->getContext()->getRequestedVersion(),
-            $this->getTimezone()
-        );
-    }
-
-    /**
-     * Throws an exception if an invalid operator was specified and we're debugging.
-     * @since 4.9.72.p
-     * @throws RestException
-     */
-    private function throwInvalidOperatorExceptionIfDebugging()
-    {
-        // so they didn't provide a valid operator
-        if (EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'invalid_operator',
-                sprintf(
-                    esc_html__(
-                        'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
-                        'event_espresso'
-                    ),
-                    $this->getQueryParamKey(),
-                    $this->getQueryParamValue()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-    }
-
-    /**
-     * Returns true if the query_param_key was a logic query parameter, eg `OR`, `AND`, `NOT`, `OR*`, etc.
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function isLogicQueryParam()
-    {
-        return in_array($this->getQueryParamKeySansStars(), $this->getContext()->getModel()->logic_query_param_keys());
-    }
-
-
-    /**
-     * If the query param isn't for a field, it must be a nested query parameter which requires different logic.
-     * @since 4.9.72.p
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws RestException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function determineNestedConditionQueryParameters()
-    {
-
-        // so this param doesn't correspond to a field eh?
-        if ($this->getContext()->isWriting()) {
-            // always tell API clients about invalid parameters when they're creating data. Otherwise,
-            // they are probably going to create invalid data
-            throw new RestException(
-                'invalid_field',
-                sprintf(
-                    /* translators: 1: variable name */
-                    esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
-                    $this->getQueryParamKey()
-                )
-            );
-        }
-        // so it's not for a field, is it a logic query param key?
-        if ($this->isLogicQueryParam()) {
-            return ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $this->getQueryParamValue(),
-                $this->getContext()->getModel(),
-                $this->getContext()->getRequestedVersion()
-            );
-        }
-        if (EED_Core_Rest_Api::debugMode()) {
-            // only tell API clients they got it wrong if we're in debug mode
-            // otherwise try our best ot fulfill their request by ignoring this invalid data
-            throw new RestException(
-                'invalid_parameter',
-                sprintf(
-                    /* translators: 1: variable name */
-                    esc_html__(
-                        'You provided an invalid parameter, with key "%1$s"',
-                        'event_espresso'
-                    ),
-                    $this->getQueryParamKey()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-        return null;
-    }
+	private $query_param_key;
+	private $query_param_value;
+	/**
+	 * @var RestIncomingQueryParamContext
+	 */
+	private $context;
+
+	/**
+	 * @var EE_Model_Field_Base|null
+	 */
+	private $field;
+
+	/**
+	 * @var string same as $query_param_key but has the * and anything after it removed
+	 */
+	private $query_param_key_sans_stars;
+
+	/**
+	 * @var string for timezone or timezone offset
+	 */
+	private $timezone;
+
+	/**
+	 * @var boolean if the field in $query_param_key is for a GMT field (eg `EVT_modified_gmt`)
+	 */
+	private $is_gmt_field = false;
+
+	/**
+	 * RestIncomingQueryParamMetadata constructor.
+	 * You probably want to call
+	 * @param string $query_param_key
+	 * @param string $query_param_value
+	 * @param RestIncomingQueryParamContext $context
+	 */
+	public function __construct($query_param_key, $query_param_value, RestIncomingQueryParamContext $context)
+	{
+		$this->query_param_key = $query_param_key;
+		$this->query_param_value = $query_param_value;
+		$this->context = $context;
+		$this->determineFieldAndTimezone();
+	}
+
+	/**
+	 * Gets the query parameter key. This may have been modified (see setQueryParamValue())
+	 * @return string
+	 */
+	public function getQueryParamKey()
+	{
+		return $this->query_param_key;
+	}
+
+	/**
+	 * Modifies the query parameter key passed in (Eg this is done when rewriting the simplified specified operator REST
+	 * query parameters into the legacy structure)
+	 * @param string|array|int|float $query_param_value
+	 */
+	private function setQueryParamValue($query_param_value)
+	{
+		$this->query_param_value = $query_param_value;
+	}
+
+	/**
+	 * Gets the original query parameter value passed in.
+	 * @return string
+	 */
+	public function getQueryParamValue()
+	{
+		return $this->query_param_value;
+	}
+
+	/**
+	 * Gets the context object.
+	 * @return RestIncomingQueryParamContext
+	 */
+	public function getContext()
+	{
+		return $this->context;
+	}
+
+	/**
+	 * Sets the query parameter key. This may be used to rewrite a key into its non-GMT alternative.
+	 * @param string $query_param_key
+	 */
+	private function setQueryParamKey($query_param_key)
+	{
+		$this->query_param_key = $query_param_key;
+	}
+
+	/**
+	 * Gets the field the query parameter key indicated. This may be null (in cases where the query parameter key
+	 * did not indicate a field, eg if it were `OR`).
+	 * @return EE_Model_Field_Base|null
+	 */
+	public function getField()
+	{
+		return $this->field;
+	}
+
+	/**
+	 * Gets the query parameter key (with the star and everything afterwards removed).
+	 * @return string
+	 */
+	public function getQueryParamKeySansStars()
+	{
+		return $this->query_param_key_sans_stars;
+	}
+
+	/**
+	 * Gets the timezone associated with this model (the site timezone, except for GMT datetime fields).
+	 * @return string
+	 */
+	public function getTimezone()
+	{
+		return $this->timezone;
+	}
+
+	/**
+	 * Returns whether or not this is a GMT field
+	 * @return boolean
+	 */
+	public function isGmtField()
+	{
+		return $this->is_gmt_field;
+	}
+
+	/**
+	 * Sets the field indicated by the query parameter key (might be null).
+	 * @param EE_Model_Field_Base|null $field
+	 */
+	private function setField(EE_Model_Field_Base $field = null)
+	{
+		$this->field = $field;
+	}
+
+	/**
+	 * Sets the query parameter key-with-stars-removed.
+	 * @param string $query_param_key_sans_stars
+	 */
+	private function setQueryParamKeySansStars($query_param_key_sans_stars)
+	{
+		$this->query_param_key_sans_stars = $query_param_key_sans_stars;
+	}
+
+	/**
+	 * Sets the timezone (this could be a timezeon offset string).
+	 * @param string $timezone
+	 */
+	private function setTimezone($timezone)
+	{
+		$this->timezone = $timezone;
+	}
+
+	/**
+	 * @param mixed $is_gmt_field
+	 */
+	private function setIsGmtField($is_gmt_field)
+	{
+		$this->is_gmt_field = $is_gmt_field;
+	}
+
+	/**
+	 * Determines what field, query param name, and query param name without stars, and timezone to use.
+	 * @since 4.9.72.p
+	 * @type EE_Model_Field_Base $field
+	 * @return void {
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function determineFieldAndTimezone()
+	{
+		$this->setQueryParamKeySansStars(ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
+			$this->getQueryParamKey()
+		));
+		$this->setField(ModelDataTranslator::deduceFieldFromQueryParam(
+			$this->getQueryParamKeySansStars(),
+			$this->getContext()->getModel()
+		));
+		// double-check is it a *_gmt field?
+		if (
+			!$this->getField() instanceof EE_Model_Field_Base
+			&& ModelDataTranslator::isGmtDateFieldName($this->getQueryParamKeySansStars())
+		) {
+			// yep, take off '_gmt', and find the field
+			$this->setQueryParamKey(ModelDataTranslator::removeGmtFromFieldName($this->getQueryParamKeySansStars()));
+			$this->setField(ModelDataTranslator::deduceFieldFromQueryParam(
+				$this->getQueryParamKey(),
+				$this->context->getModel()
+			));
+			$this->setTimezone('UTC');
+			$this->setIsGmtField(true);
+		} elseif ($this->getField() instanceof EE_Datetime_Field) {
+			// so it's not a GMT field. Set the timezone on the model to the default
+			$this->setTimezone(EEH_DTT_Helper::get_valid_timezone_string());
+		} else {
+			// just keep using what's already set for the timezone
+			$this->setTimezone($this->context->getModel()->get_timezone());
+		}
+		$this->assertOnlyAdminCanReadPasswordFields();
+	}
+
+	/**
+	 * Throws an exception if a non-admin is trying to query by password.
+	 * @since 4.9.74.p
+	 * @throws RestException
+	 */
+	private function assertOnlyAdminCanReadPasswordFields()
+	{
+		if (
+			$this->getField() instanceof EE_Password_Field
+			&& ! current_user_can(EE_Restriction_Generator_Base::get_default_restrictions_cap())
+		) {
+			// only full admins can query by password. sorry bub!
+			throw new RestException(
+				'only_admins_can_query_by_password',
+				// @codingStandardsIgnoreStart
+				esc_html__('You attempted to filter by a password field without the needed privileges. Only a full admin is allowed to do that.', 'event_espresso'),
+				// @codingStandardsIgnoreEnd
+				array(
+					'status' => 403
+				)
+			);
+		}
+	}
+
+	/**
+	 * Given a ton of input, determines the value to use for the models.
+	 * @since 4.9.72.p
+	 * @return array|null
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws RestException
+	 * @throws DomainException
+	 */
+	public function determineConditionsQueryParameterValue()
+	{
+		if ($this->valueIsArrayDuringRead()) {
+			return $this->determineModelValueGivenRestInputArray();
+		}
+		return ModelDataTranslator::prepareFieldValueFromJson(
+			$this->getField(),
+			$this->getQueryParamValue(),
+			$this->getContext()->getRequestedVersion(),
+			$this->getTimezone()
+		);
+	}
+
+	/**
+	 * Given that the array value provided was itself an array, handles finding the correct value to pass to the model.
+	 * @since 4.9.72.p
+	 * @return array|null
+	 * @throws RestException
+	 */
+	private function determineModelValueGivenRestInputArray()
+	{
+		$this->transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax();
+		// did they specify an operator?
+		if ($this->valueIsLegacySpecifiedOperator()) {
+			$query_param_value = $this->getQueryParamValue();
+			$sub_array_key = $query_param_value[0];
+			$translated_value = array($sub_array_key);
+			if ($this->operatorIsNAry($sub_array_key)) {
+				$translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
+			} elseif ($this->operatorIsTernary($sub_array_key)) {
+				$translated_value[] = array(
+					$this->prepareValuesFromJson($query_param_value[1][0]),
+					$this->prepareValuesFromJson($query_param_value[1][1])
+				);
+			} elseif ($this->operatorIsLike($sub_array_key)) {
+				// we want to leave this value mostly-as-is (eg don't force it to be a float
+				// or a boolean or an enum value. Leave it as-is with wildcards etc)
+				// but do verify it at least doesn't have any serialized data
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
+				$translated_value[] = $query_param_value[1];
+			} elseif ($this->operatorIsUnary($sub_array_key)) {
+				// no arguments should have been provided, so don't look for any
+			} elseif ($this->operatorisBinary($sub_array_key)) {
+				// it's a valid operator, but none of the exceptions. Treat it normally.
+				$translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
+			} else {
+				// so they provided a valid operator, but wrong number of arguments
+				$this->throwWrongNumberOfArgsExceptionIfDebugging($sub_array_key);
+				$translated_value = null;
+			}
+		} else {
+			// so they didn't provide a valid operator
+			// if we aren't in debug mode, then just try our best to fulfill the user's request
+			$this->throwInvalidOperatorExceptionIfDebugging();
+			$translated_value = null;
+		}
+		return $translated_value;
+	}
+
+	/**
+	 * Returns if this request is a "read" request and the value provided was an array.
+	 * This will indicate is such things as `array('<', 123)` and `array('IN', array(1,2,3))` are acceptable or not.
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function valueIsArrayDuringRead()
+	{
+		return !$this->getContext()->isWriting() && is_array($this->getQueryParamValue());
+	}
+
+	/**
+	 * Returns if the value provided was an associative array (we should have already verified it's an array of some
+	 * sort). If the value is an associative array, it had better be in the simplified specified operator structure.
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function valueIsAssociativeArray()
+	{
+		return !EEH_Array::is_array_numerically_and_sequentially_indexed($this->getQueryParamValue());
+	}
+
+	/**
+	 * Checks if the array value is itself an array that fits into the simplified specified operator structure
+	 * (eg `array('!=' => 123)`).
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function valueIsSimplifiedSpecifiedOperator()
+	{
+		return count($this->getQueryParamValue()) === 1
+			&& array_key_exists(
+				key($this->getQueryParamValue()),
+				$this->getContext()->getModel()->valid_operators()
+			);
+	}
+
+	/**
+	 * Throws an exception if the sub-value is an array (eg `array('!=' => array())`). It needs to just be a string,
+	 * of either comma-separated-values, or a JSON array.
+	 * @since 4.9.72.p
+	 * @param $sub_array_key
+	 * @param $sub_array_value
+	 * @throws RestException
+	 */
+	private function assertSubValueIsntArray($sub_array_key, $sub_array_value)
+	{
+		if (is_array($sub_array_value) && EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'csv_or_json_string_only',
+				sprintf(
+					/* translators: 1: variable name*/
+					esc_html__(
+						'The value provided for the operator "%1$s" should be comma-separated value string or a JSON array.',
+						'event_espresso'
+					),
+					$sub_array_key
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+	}
+
+	/**
+	 * Determines if the sub-array key is an operator taking 3 or more operators.
+	 * @since 4.9.72.p
+	 * @param $sub_array_key
+	 * @return boolean
+	 */
+	private function subArrayKeyIsNonBinaryOperator($sub_array_key)
+	{
+		return array_key_exists(
+			$sub_array_key,
+			array_merge(
+				$this->getContext()->getModel()->valid_in_style_operators(),
+				$this->getContext()->getModel()->valid_between_style_operators()
+			)
+		);
+	}
+
+	/**
+	 * Given that the $sub_array_key is a string, checks if it's an operator taking only 1 argument.
+	 * @since 4.9.72.p
+	 * @param string $sub_array_key
+	 * @return boolean
+	 */
+	private function subArrayKeyIsUnaryOperator($sub_array_key)
+	{
+		return array_key_exists(
+			$sub_array_key,
+			$this->getContext()->getModel()->valid_null_style_operators()
+		);
+	}
+
+	/**
+	 * Parses the $sub_array_value string into an array (given it could either be a comma-separated-list or a JSON
+	 * array). eg `"1,2,3"` or `"[1,2,3]"` into `array(1,2,3)`.
+	 * @since 4.9.72.p
+	 * @param $sub_array_value
+	 * @return array|mixed|object
+	 */
+	private function extractQuickStyleSpecifiedOperatorValue($sub_array_value)
+	{
+		// the value should be JSON or CSV
+		$values = json_decode($sub_array_value);
+		if (!is_array($values)) {
+			$values = array_filter(
+				array_map(
+					'trim',
+					explode(
+						',',
+						$sub_array_value
+					)
+				)
+			);
+		}
+		return $values;
+	}
+
+	/**
+	 * Throws an exception if the value isn't a simplified specified operator (only called when we expect that).
+	 * @since 4.9.72.p
+	 * @throws RestException
+	 */
+	private function assertSimplifiedSpecifiedOperator()
+	{
+		if (!$this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'numerically_indexed_array_of_values_only',
+				sprintf(
+					/* translators: 1: variable name*/
+					esc_html__(
+						'The array provided for the parameter "%1$s" should be numerically indexed.',
+						'event_espresso'
+					),
+					$this->getQueryParamKey()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+	}
+
+	/**
+	 * If query_param_value were in the simplified specific operator structure, change it into the legacy structure.
+	 * @since 4.9.72.p
+	 * @throws RestException
+	 */
+	private function transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax()
+	{
+		if ($this->valueIsAssociativeArray()) {
+			$this->assertSimplifiedSpecifiedOperator();
+			$query_param_value = $this->getQueryParamValue();
+			$sub_array_value = reset($query_param_value);
+			$sub_array_key = key($query_param_value);
+			$this->assertSubValueIsntArray($sub_array_key, $sub_array_value);
+			// they're doing something like "&where[EVT_ID][IN]=1,2,3" or "&where[EVT_ID][>]=5"
+			if ($this->subArrayKeyIsNonBinaryOperator($sub_array_key)) {
+				$this->setQueryParamValue(array(
+					$sub_array_key,
+					$this->extractQuickStyleSpecifiedOperatorValue($sub_array_value)
+				));
+			} elseif ($this->subArrayKeyIsUnaryOperator($sub_array_key)) {
+				$this->setQueryParamValue(array($sub_array_key));
+			} else {
+				$this->setQueryParamValue(array($sub_array_key, $sub_array_value));
+			}
+		}
+	}
+
+	/**
+	 * Returns true is the value is an array using the legacy structure to specify the operator. Eg `array('!=',123)`.
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function valueIsLegacySpecifiedOperator()
+	{
+		$valid_operators = $this->getContext()->getModel()->valid_operators();
+		$query_param_value = $this->getQueryParamValue();
+		return isset($query_param_value[0])
+			&& isset($valid_operators[ $query_param_value[0] ]);
+	}
+
+	/**
+	 * Returns true if the value specified operator accepts arbitrary number of arguments, like "IN".
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorIsNAry($operator)
+	{
+		$valueArray = $this->getQueryParamValue();
+		return array_key_exists(
+			$operator,
+			$this->getContext()->getModel()->valid_in_style_operators()
+		)
+			&& isset($valueArray[1])
+			&& is_array($valueArray[1])
+			&& !isset($valueArray[2]);
+	}
+
+	/**
+	 * Returns true if the operator accepts 3 arguments (eg "BETWEEN").
+	 * So we're looking for a value that looks like
+	 * `array('BETWEEN', array('2015-01-01T00:00:00', '2016-01-01T00:00:00'))`.
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorIsTernary($operator)
+	{
+		$query_param_value = $this->getQueryParamValue();
+		return array_key_exists($operator, $this->getContext()->getModel()->valid_between_style_operators())
+			&& isset($query_param_value[1])
+			&& is_array($query_param_value[1])
+			&& isset($query_param_value[1][0], $query_param_value[1][1])
+			&& !isset($query_param_value[1][2])
+			&& !isset($query_param_value[2]);
+	}
+
+	/**
+	 * Returns true if the operator is a similar to LIKE, indicating the value may have wildcards we should leave alone.
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorIsLike($operator)
+	{
+		$query_param_value = $this->getQueryParamValue();
+		return array_key_exists($operator, $this->getContext()->getModel()->valid_like_style_operators())
+			&& isset($query_param_value[1])
+			&& !isset($query_param_value[2]);
+	}
+
+	/**
+	 * Returns true if the operator only takes one argument (eg it's like `IS NULL`).
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorIsUnary($operator)
+	{
+		$query_param_value = $this->getQueryParamValue();
+		return array_key_exists($operator, $this->getContext()->getModel()->valid_null_style_operators())
+			&& !isset($query_param_value[1]);
+	}
+
+	/**
+	 * Returns true if the operator specified is a binary opeator (eg `=`, `!=`)
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorisBinary($operator)
+	{
+		$query_param_value = $this->getQueryParamValue();
+		$model = $this->getContext()->getModel();
+		return isset($query_param_value[1])
+			&& !isset($query_param_value[2])
+			&& !array_key_exists(
+				$operator,
+				array_merge(
+					$model->valid_in_style_operators(),
+					$model->valid_null_style_operators(),
+					$model->valid_like_style_operators(),
+					$model->valid_between_style_operators()
+				)
+			);
+	}
+
+	/**
+	 * If we're debugging, throws an exception saying that the wrong number of arguments was provided.
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @throws RestException
+	 */
+	private function throwWrongNumberOfArgsExceptionIfDebugging($operator)
+	{
+		if (EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'wrong_number_of_arguments',
+				sprintf(
+					esc_html__(
+						'The operator you provided, "%1$s" had the wrong number of arguments',
+						'event_espresso'
+					),
+					$operator
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+	}
+
+	/**
+	 * Wrapper for ModelDataTranslator::prepareFieldValuesFromJson(), just a tad more DRY.
+	 * @since 4.9.72.p
+	 * @param $value
+	 * @return mixed
+	 * @throws RestException
+	 */
+	private function prepareValuesFromJson($value)
+	{
+		return ModelDataTranslator::prepareFieldValuesFromJson(
+			$this->getField(),
+			$value,
+			$this->getContext()->getRequestedVersion(),
+			$this->getTimezone()
+		);
+	}
+
+	/**
+	 * Throws an exception if an invalid operator was specified and we're debugging.
+	 * @since 4.9.72.p
+	 * @throws RestException
+	 */
+	private function throwInvalidOperatorExceptionIfDebugging()
+	{
+		// so they didn't provide a valid operator
+		if (EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'invalid_operator',
+				sprintf(
+					esc_html__(
+						'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
+						'event_espresso'
+					),
+					$this->getQueryParamKey(),
+					$this->getQueryParamValue()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+	}
+
+	/**
+	 * Returns true if the query_param_key was a logic query parameter, eg `OR`, `AND`, `NOT`, `OR*`, etc.
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function isLogicQueryParam()
+	{
+		return in_array($this->getQueryParamKeySansStars(), $this->getContext()->getModel()->logic_query_param_keys());
+	}
+
+
+	/**
+	 * If the query param isn't for a field, it must be a nested query parameter which requires different logic.
+	 * @since 4.9.72.p
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws RestException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function determineNestedConditionQueryParameters()
+	{
+
+		// so this param doesn't correspond to a field eh?
+		if ($this->getContext()->isWriting()) {
+			// always tell API clients about invalid parameters when they're creating data. Otherwise,
+			// they are probably going to create invalid data
+			throw new RestException(
+				'invalid_field',
+				sprintf(
+					/* translators: 1: variable name */
+					esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
+					$this->getQueryParamKey()
+				)
+			);
+		}
+		// so it's not for a field, is it a logic query param key?
+		if ($this->isLogicQueryParam()) {
+			return ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$this->getQueryParamValue(),
+				$this->getContext()->getModel(),
+				$this->getContext()->getRequestedVersion()
+			);
+		}
+		if (EED_Core_Rest_Api::debugMode()) {
+			// only tell API clients they got it wrong if we're in debug mode
+			// otherwise try our best ot fulfill their request by ignoring this invalid data
+			throw new RestException(
+				'invalid_parameter',
+				sprintf(
+					/* translators: 1: variable name */
+					esc_html__(
+						'You provided an invalid parameter, with key "%1$s"',
+						'event_espresso'
+					),
+					$this->getQueryParamKey()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+		return null;
+	}
 }
 // End of file RestQueryParamMetadata.php
 // Location: EventEspresso\core\libraries\rest_api/RestQueryParamMetadata.php

Spacing +13 added lines, -13 removed lines

@@ -209,7 +209,7 @@ 
         ));
         // double-check is it a *_gmt field?
         if (
-            !$this->getField() instanceof EE_Model_Field_Base
+            ! $this->getField() instanceof EE_Model_Field_Base
             && ModelDataTranslator::isGmtDateFieldName($this->getQueryParamKeySansStars())
         ) {
             // yep, take off '_gmt', and find the field
@@ -330,7 +330,7 @@ 
      */
     private function valueIsArrayDuringRead()
     {
-        return !$this->getContext()->isWriting() && is_array($this->getQueryParamValue());
+        return ! $this->getContext()->isWriting() && is_array($this->getQueryParamValue());
     }
 
     /**
@@ -341,7 +341,7 @@ 
      */
     private function valueIsAssociativeArray()
     {
-        return !EEH_Array::is_array_numerically_and_sequentially_indexed($this->getQueryParamValue());
+        return ! EEH_Array::is_array_numerically_and_sequentially_indexed($this->getQueryParamValue());
     }
 
     /**
@@ -429,7 +429,7 @@ 
     {
         // the value should be JSON or CSV
         $values = json_decode($sub_array_value);
-        if (!is_array($values)) {
+        if ( ! is_array($values)) {
             $values = array_filter(
                 array_map(
                     'trim',
@@ -450,7 +450,7 @@ 
      */
     private function assertSimplifiedSpecifiedOperator()
     {
-        if (!$this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
+        if ( ! $this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
             throw new RestException(
                 'numerically_indexed_array_of_values_only',
                 sprintf(
@@ -505,7 +505,7 @@ 
         $valid_operators = $this->getContext()->getModel()->valid_operators();
         $query_param_value = $this->getQueryParamValue();
         return isset($query_param_value[0])
-            && isset($valid_operators[ $query_param_value[0] ]);
+            && isset($valid_operators[$query_param_value[0]]);
     }
 
     /**
@@ -523,7 +523,7 @@ 
         )
             && isset($valueArray[1])
             && is_array($valueArray[1])
-            && !isset($valueArray[2]);
+            && ! isset($valueArray[2]);
     }
 
     /**
@@ -541,8 +541,8 @@ 
             && isset($query_param_value[1])
             && is_array($query_param_value[1])
             && isset($query_param_value[1][0], $query_param_value[1][1])
-            && !isset($query_param_value[1][2])
-            && !isset($query_param_value[2]);
+            && ! isset($query_param_value[1][2])
+            && ! isset($query_param_value[2]);
     }
 
     /**
@@ -556,7 +556,7 @@ 
         $query_param_value = $this->getQueryParamValue();
         return array_key_exists($operator, $this->getContext()->getModel()->valid_like_style_operators())
             && isset($query_param_value[1])
-            && !isset($query_param_value[2]);
+            && ! isset($query_param_value[2]);
     }
 
     /**
@@ -569,7 +569,7 @@ 
     {
         $query_param_value = $this->getQueryParamValue();
         return array_key_exists($operator, $this->getContext()->getModel()->valid_null_style_operators())
-            && !isset($query_param_value[1]);
+            && ! isset($query_param_value[1]);
     }
 
     /**
@@ -583,8 +583,8 @@ 
         $query_param_value = $this->getQueryParamValue();
         $model = $this->getContext()->getModel();
         return isset($query_param_value[1])
-            && !isset($query_param_value[2])
-            && !array_key_exists(
+            && ! isset($query_param_value[2])
+            && ! array_key_exists(
                 $operator,
                 array_merge(
                     $model->valid_in_style_operators(),

core/libraries/rest_api/changes/ChangesIn40834.php

Indentation +33 added lines, -33 removed lines

@@ -12,39 +12,39 @@
 class ChangesIn40834 extends ChangesInBase
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function setHooks()
-    {
-        // set a hook to remove the checkout/checkout endpoints if the request
-        // is for lower than 4.8.33
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            array($this, 'removeResponseHeaders'),
-            10,
-            3
-        );
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function setHooks()
+	{
+		// set a hook to remove the checkout/checkout endpoints if the request
+		// is for lower than 4.8.33
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			array($this, 'removeResponseHeaders'),
+			10,
+			3
+		);
+	}
 
 
-    /**
-     * Removes the checkin and checkout endpoints from the index for requests
-     * to api versions lowers than 4.8.33
-     *
-     * @param array  $response_headers
-     * @param Base   $controller
-     * @param string $requested_version
-     * @return array like $routes_on_this_version
-     */
-    public function removeResponseHeaders($response_headers, $controller, $requested_version)
-    {
-        if (
-            $controller instanceof Base
-            && $this->appliesToVersion($requested_version)
-        ) {
-            return array();
-        }
-        return $response_headers;
-    }
+	/**
+	 * Removes the checkin and checkout endpoints from the index for requests
+	 * to api versions lowers than 4.8.33
+	 *
+	 * @param array  $response_headers
+	 * @param Base   $controller
+	 * @param string $requested_version
+	 * @return array like $routes_on_this_version
+	 */
+	public function removeResponseHeaders($response_headers, $controller, $requested_version)
+	{
+		if (
+			$controller instanceof Base
+			&& $this->appliesToVersion($requested_version)
+		) {
+			return array();
+		}
+		return $response_headers;
+	}
 }

core/libraries/rest_api/ModelVersionInfo.php

Spacing +12 added lines, -12 removed lines

@@ -114,10 +114,10 @@ 
         foreach ($this->resource_changes as $version => $model_classnames) {
             foreach ($model_classnames as $model_classname => $extra_fields) {
                 foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
+                    $this->resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
                     foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ])) {
-                            $this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ] = $default_value;
+                        if ( ! isset($this->resource_changes[$model_classname][$fieldname][$attribute])) {
+                            $this->resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
                         }
                     }
                 }
@@ -139,7 +139,7 @@ 
             $model_changes = array();
             foreach ($this->modelChanges() as $version => $models_changed_in_version) {
                 if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $model_changes[ $version ] = $models_changed_in_version;
+                    $model_changes[$version] = $models_changed_in_version;
                 }
             }
             $this->cached_model_changes_between_requested_version_and_current = $model_changes;
@@ -161,7 +161,7 @@ 
             $resource_changes = array();
             foreach ($this->resourceChanges() as $version => $model_classnames) {
                 if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $resource_changes[ $version ] = $model_classnames;
+                    $resource_changes[$version] = $model_classnames;
                 }
             }
             $this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
@@ -212,7 +212,7 @@ 
             foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
                 foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
                     if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
-                        unset($all_models_in_current_version[ $model_name ]);
+                        unset($all_models_in_current_version[$model_name]);
                     }
                 }
             }
@@ -237,7 +237,7 @@ 
     public function isModelNameInThisVersion($model_name)
     {
         $model_names = $this->modelsForRequestedVersion();
-        if (isset($model_names[ $model_name ])) {
+        if (isset($model_names[$model_name])) {
             return true;
         } else {
             return false;
@@ -280,7 +280,7 @@ 
      */
     public function fieldsOnModelInThisVersion($model)
     {
-        if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
+        if ( ! isset($this->cached_fields_on_models[$model->get_this_model_name()])) {
             // get all model changes between the requested version and current core version
             $changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
             // fetch all fields currently on this model
@@ -288,12 +288,12 @@ 
             // remove all fields that have been added since
             foreach ($changes as $version => $changes_in_version) {
                 if (
-                    isset($changes_in_version[ $model->get_this_model_name() ])
-                    && $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::MODEL_ADDED
+                    isset($changes_in_version[$model->get_this_model_name()])
+                    && $changes_in_version[$model->get_this_model_name()] !== ModelVersionInfo::MODEL_ADDED
                 ) {
                     $current_fields = array_diff_key(
                         $current_fields,
-                        array_flip($changes_in_version[ $model->get_this_model_name() ])
+                        array_flip($changes_in_version[$model->get_this_model_name()])
                     );
                 }
             }
@@ -448,7 +448,7 @@ 
         $relations = array();
         foreach ($model->relation_settings() as $relation_name => $relation_obj) {
             if ($this->isModelNameInThisVersion($relation_name)) {
-                $relations[ $relation_name ] = $relation_obj;
+                $relations[$relation_name] = $relation_obj;
             }
         }
         // filter the results, but use the old filter name

Indentation +437 added lines, -437 removed lines

@@ -24,441 +24,441 @@
  */
 class ModelVersionInfo
 {
-    /**
-     * Constant used in the $_model_changes array to indicate that a model
-     * was completely new in this version
-     */
-    const MODEL_ADDED = 'model_added_in_this_version';
-
-    /**
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
-     * or it's an array where the values are model field names,
-     * or API resource properties (ie, non-model fields that appear in REST API results)
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @var array
-     */
-    protected $model_changes = array();
-
-    /**
-     * top-level keys are version numbers,
-     * next-level keys are model CLASSNAMES (even parent classnames),
-     * and next-level keys are extra resource properties to attach to those models' resources,
-     * and next-level key-value pairs, where the keys are:
-     * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
-     *
-     * @var array
-     */
-    protected $resource_changes = array();
-
-    /**
-     * @var string indicating what version of the API was requested
-     * (eg although core might be at version 4.8.11, they may have sent a request
-     * for 4.6)
-     */
-    protected $requested_version = null;
-
-    /**
-     * Keys are model names, values are their classnames.
-     * We cache this so we only need to calculate this once per request
-     *
-     * @var array
-     */
-    protected $cached_models_for_requested_version = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_model_changes_between_requested_version_and_current = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_resource_changes_between_requested_version_and_current = null;
-
-    /**
-     * 2d array where top-level keys are model names, 2nd-level keys are field names
-     * and values are the actual field objects
-     *
-     * @var array
-     */
-    protected $cached_fields_on_models = array();
-
-
-    /**
-     * Model_Version_Info constructor.
-     *
-     * @param string $requested_version
-     */
-    public function __construct($requested_version)
-    {
-        $this->requested_version = (string) $requested_version;
-        $this->model_changes = array(
-            '4.8.29' => array(
-                // first version where the REST API is in EE core, so no need
-                // to specify how its different from the previous
-            ),
-        );
-        // setup data for "extra" fields added onto resources which don't actually exist on models
-        $this->resource_changes = apply_filters(
-            'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
-            array()
-        );
-        $defaults = array(
-            'raw'              => false,
-            'type'             => 'N/A',
-            'nullable'         => true,
-            'table_alias'      => 'N/A',
-            'table_column'     => 'N/A',
-            'always_available' => true,
-        );
-        foreach ($this->resource_changes as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $extra_fields) {
-                foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
-                    foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ])) {
-                            $this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ] = $default_value;
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function modelChangesBetweenRequestedVersionAndCurrent()
-    {
-        if ($this->cached_model_changes_between_requested_version_and_current === null) {
-            $model_changes = array();
-            foreach ($this->modelChanges() as $version => $models_changed_in_version) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $model_changes[ $version ] = $models_changed_in_version;
-                }
-            }
-            $this->cached_model_changes_between_requested_version_and_current = $model_changes;
-        }
-        return $this->cached_model_changes_between_requested_version_and_current;
-    }
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function resourceChangesBetweenRequestedVersionAndCurrent()
-    {
-        if ($this->cached_resource_changes_between_requested_version_and_current === null) {
-            $resource_changes = array();
-            foreach ($this->resourceChanges() as $version => $model_classnames) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $resource_changes[ $version ] = $model_classnames;
-                }
-            }
-            $this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
-        }
-        return $this->cached_resource_changes_between_requested_version_and_current;
-    }
-
-
-    /**
-     * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
-     *
-     * @return string like '4.6'
-     */
-    public function requestedVersion()
-    {
-        return $this->requested_version;
-    }
-
-
-    /**
-     * Returns an array describing how the models have changed in each version of core
-     * that supports the API (starting at 4.6)
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either NULL (indicating the model is completely NEW in this version),
-     * or it's an array where fields are value names.
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @return array
-     */
-    public function modelChanges()
-    {
-        return $this->model_changes;
-    }
-
-
-    /**
-     * Takes into account the requested version, and the current version, and
-     * what changed between the two, and tries to return.
-     * Analogous to EE_Registry::instance()->non_abstract_db_models
-     *
-     * @return array keys are model names, values are their classname
-     */
-    public function modelsForRequestedVersion()
-    {
-        if ($this->cached_models_for_requested_version === null) {
-            $all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
-            foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
-                foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
-                    if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
-                        unset($all_models_in_current_version[ $model_name ]);
-                    }
-                }
-            }
-            $this->cached_models_for_requested_version = apply_filters(
-                'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
-                $all_models_in_current_version,
-                $this
-            );
-        }
-        return $this->cached_models_for_requested_version;
-    }
-
-
-    /**
-     * Determines if this is a valid model name in the requested version.
-     * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name eg 'Event'
-     * @return boolean
-     */
-    public function isModelNameInThisVersion($model_name)
-    {
-        $model_names = $this->modelsForRequestedVersion();
-        if (isset($model_names[ $model_name ])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name
-     * @return EEM_Base
-     * @throws EE_Error
-     */
-    public function loadModel($model_name)
-    {
-        if ($this->isModelNameInThisVersion($model_name)) {
-            return EE_Registry::instance()->load_model($model_name);
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
-                        'event_espresso'
-                    ),
-                    $model_name,
-                    $this->requestedVersion()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Gets all the fields that should exist on this model right now
-     *
-     * @param EEM_Base $model
-     * @return array|EE_Model_Field_Base[]
-     */
-    public function fieldsOnModelInThisVersion($model)
-    {
-        if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
-            // get all model changes between the requested version and current core version
-            $changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
-            // fetch all fields currently on this model
-            $current_fields = $model->field_settings();
-            // remove all fields that have been added since
-            foreach ($changes as $version => $changes_in_version) {
-                if (
-                    isset($changes_in_version[ $model->get_this_model_name() ])
-                    && $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::MODEL_ADDED
-                ) {
-                    $current_fields = array_diff_key(
-                        $current_fields,
-                        array_flip($changes_in_version[ $model->get_this_model_name() ])
-                    );
-                }
-            }
-            $this->cached_fields_on_models = $current_fields;
-        }
-        return $this->cached_fields_on_models;
-    }
-
-
-    /**
-     * Determines if $object is of one of the classes of $classes. Similar to
-     * in_array(), except this checks if $object is a subclass of the classnames provided
-     * in $classnames
-     *
-     * @param object $object
-     * @param array  $classnames
-     * @return boolean
-     */
-    public function isSubclassOfOne($object, $classnames)
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the list of model field classes that that the API basically ignores
-     *
-     * @return array
-     */
-    public function fieldsIgnored()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read_fields_ignored',
-            array()
-        );
-    }
-
-
-    /**
-     * If this field one that should be ignored by the API?
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldIsIgnored($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
-    }
-
-
-    /**
-     * Returns the list of model field classes that have a "raw" and non-raw formats.
-     * Normally the "raw" versions are only accessible to those who can edit them.
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fieldsThatHaveRenderedFormat()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_raw',
-            array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that has a raw format
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasRenderedFormat($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
-    }
-
-
-    /**
-     * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
-     * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
-     * to view
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fieldsThatHavePrettyFormat()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_pretty',
-            array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that has a pretty equivalent
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasPrettyFormat($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
-    }
-
-
-    /**
-     * Returns an array describing what extra API resource properties have been added through the versions
-     *
-     * @return array @see $this->_extra_resource_properties_for_models
-     */
-    public function resourceChanges()
-    {
-        return $this->resource_changes;
-    }
-
-
-    /**
-     * Returns an array where keys are extra resource properties in this version of the API,
-     * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
-     *
-     * @param EEM_Base $model
-     * @return array
-     */
-    public function extraResourcePropertiesForModel($model)
-    {
-        $extra_properties = array();
-        foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
-                if (is_subclass_of($model, $model_classname)) {
-                    $extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
-                }
-            }
-        }
-        return $extra_properties;
-    }
-
-
-    /**
-     * Gets all the related models for the specified model. It's good to use this
-     * in case this model didn't exist for this version or something
-     *
-     * @param EEM_Base $model
-     * @return EE_Model_Relation_Base[]
-     */
-    public function relationSettings($model)
-    {
-        $relations = array();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($this->isModelNameInThisVersion($relation_name)) {
-                $relations[ $relation_name ] = $relation_obj;
-            }
-        }
-        // filter the results, but use the old filter name
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
-            $relations,
-            $model
-        );
-    }
+	/**
+	 * Constant used in the $_model_changes array to indicate that a model
+	 * was completely new in this version
+	 */
+	const MODEL_ADDED = 'model_added_in_this_version';
+
+	/**
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
+	 * or it's an array where the values are model field names,
+	 * or API resource properties (ie, non-model fields that appear in REST API results)
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @var array
+	 */
+	protected $model_changes = array();
+
+	/**
+	 * top-level keys are version numbers,
+	 * next-level keys are model CLASSNAMES (even parent classnames),
+	 * and next-level keys are extra resource properties to attach to those models' resources,
+	 * and next-level key-value pairs, where the keys are:
+	 * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
+	 *
+	 * @var array
+	 */
+	protected $resource_changes = array();
+
+	/**
+	 * @var string indicating what version of the API was requested
+	 * (eg although core might be at version 4.8.11, they may have sent a request
+	 * for 4.6)
+	 */
+	protected $requested_version = null;
+
+	/**
+	 * Keys are model names, values are their classnames.
+	 * We cache this so we only need to calculate this once per request
+	 *
+	 * @var array
+	 */
+	protected $cached_models_for_requested_version = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_model_changes_between_requested_version_and_current = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_resource_changes_between_requested_version_and_current = null;
+
+	/**
+	 * 2d array where top-level keys are model names, 2nd-level keys are field names
+	 * and values are the actual field objects
+	 *
+	 * @var array
+	 */
+	protected $cached_fields_on_models = array();
+
+
+	/**
+	 * Model_Version_Info constructor.
+	 *
+	 * @param string $requested_version
+	 */
+	public function __construct($requested_version)
+	{
+		$this->requested_version = (string) $requested_version;
+		$this->model_changes = array(
+			'4.8.29' => array(
+				// first version where the REST API is in EE core, so no need
+				// to specify how its different from the previous
+			),
+		);
+		// setup data for "extra" fields added onto resources which don't actually exist on models
+		$this->resource_changes = apply_filters(
+			'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
+			array()
+		);
+		$defaults = array(
+			'raw'              => false,
+			'type'             => 'N/A',
+			'nullable'         => true,
+			'table_alias'      => 'N/A',
+			'table_column'     => 'N/A',
+			'always_available' => true,
+		);
+		foreach ($this->resource_changes as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $extra_fields) {
+				foreach ($extra_fields as $fieldname => $field_data) {
+					$this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
+					foreach ($defaults as $attribute => $default_value) {
+						if (! isset($this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ])) {
+							$this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ] = $default_value;
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function modelChangesBetweenRequestedVersionAndCurrent()
+	{
+		if ($this->cached_model_changes_between_requested_version_and_current === null) {
+			$model_changes = array();
+			foreach ($this->modelChanges() as $version => $models_changed_in_version) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$model_changes[ $version ] = $models_changed_in_version;
+				}
+			}
+			$this->cached_model_changes_between_requested_version_and_current = $model_changes;
+		}
+		return $this->cached_model_changes_between_requested_version_and_current;
+	}
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function resourceChangesBetweenRequestedVersionAndCurrent()
+	{
+		if ($this->cached_resource_changes_between_requested_version_and_current === null) {
+			$resource_changes = array();
+			foreach ($this->resourceChanges() as $version => $model_classnames) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$resource_changes[ $version ] = $model_classnames;
+				}
+			}
+			$this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
+		}
+		return $this->cached_resource_changes_between_requested_version_and_current;
+	}
+
+
+	/**
+	 * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
+	 *
+	 * @return string like '4.6'
+	 */
+	public function requestedVersion()
+	{
+		return $this->requested_version;
+	}
+
+
+	/**
+	 * Returns an array describing how the models have changed in each version of core
+	 * that supports the API (starting at 4.6)
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either NULL (indicating the model is completely NEW in this version),
+	 * or it's an array where fields are value names.
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @return array
+	 */
+	public function modelChanges()
+	{
+		return $this->model_changes;
+	}
+
+
+	/**
+	 * Takes into account the requested version, and the current version, and
+	 * what changed between the two, and tries to return.
+	 * Analogous to EE_Registry::instance()->non_abstract_db_models
+	 *
+	 * @return array keys are model names, values are their classname
+	 */
+	public function modelsForRequestedVersion()
+	{
+		if ($this->cached_models_for_requested_version === null) {
+			$all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
+			foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
+				foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
+					if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
+						unset($all_models_in_current_version[ $model_name ]);
+					}
+				}
+			}
+			$this->cached_models_for_requested_version = apply_filters(
+				'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
+				$all_models_in_current_version,
+				$this
+			);
+		}
+		return $this->cached_models_for_requested_version;
+	}
+
+
+	/**
+	 * Determines if this is a valid model name in the requested version.
+	 * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name eg 'Event'
+	 * @return boolean
+	 */
+	public function isModelNameInThisVersion($model_name)
+	{
+		$model_names = $this->modelsForRequestedVersion();
+		if (isset($model_names[ $model_name ])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name
+	 * @return EEM_Base
+	 * @throws EE_Error
+	 */
+	public function loadModel($model_name)
+	{
+		if ($this->isModelNameInThisVersion($model_name)) {
+			return EE_Registry::instance()->load_model($model_name);
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
+						'event_espresso'
+					),
+					$model_name,
+					$this->requestedVersion()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Gets all the fields that should exist on this model right now
+	 *
+	 * @param EEM_Base $model
+	 * @return array|EE_Model_Field_Base[]
+	 */
+	public function fieldsOnModelInThisVersion($model)
+	{
+		if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
+			// get all model changes between the requested version and current core version
+			$changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
+			// fetch all fields currently on this model
+			$current_fields = $model->field_settings();
+			// remove all fields that have been added since
+			foreach ($changes as $version => $changes_in_version) {
+				if (
+					isset($changes_in_version[ $model->get_this_model_name() ])
+					&& $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::MODEL_ADDED
+				) {
+					$current_fields = array_diff_key(
+						$current_fields,
+						array_flip($changes_in_version[ $model->get_this_model_name() ])
+					);
+				}
+			}
+			$this->cached_fields_on_models = $current_fields;
+		}
+		return $this->cached_fields_on_models;
+	}
+
+
+	/**
+	 * Determines if $object is of one of the classes of $classes. Similar to
+	 * in_array(), except this checks if $object is a subclass of the classnames provided
+	 * in $classnames
+	 *
+	 * @param object $object
+	 * @param array  $classnames
+	 * @return boolean
+	 */
+	public function isSubclassOfOne($object, $classnames)
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the list of model field classes that that the API basically ignores
+	 *
+	 * @return array
+	 */
+	public function fieldsIgnored()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read_fields_ignored',
+			array()
+		);
+	}
+
+
+	/**
+	 * If this field one that should be ignored by the API?
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldIsIgnored($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
+	}
+
+
+	/**
+	 * Returns the list of model field classes that have a "raw" and non-raw formats.
+	 * Normally the "raw" versions are only accessible to those who can edit them.
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fieldsThatHaveRenderedFormat()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_raw',
+			array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that has a raw format
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasRenderedFormat($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
+	}
+
+
+	/**
+	 * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
+	 * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
+	 * to view
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fieldsThatHavePrettyFormat()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_pretty',
+			array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that has a pretty equivalent
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasPrettyFormat($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
+	}
+
+
+	/**
+	 * Returns an array describing what extra API resource properties have been added through the versions
+	 *
+	 * @return array @see $this->_extra_resource_properties_for_models
+	 */
+	public function resourceChanges()
+	{
+		return $this->resource_changes;
+	}
+
+
+	/**
+	 * Returns an array where keys are extra resource properties in this version of the API,
+	 * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
+	 *
+	 * @param EEM_Base $model
+	 * @return array
+	 */
+	public function extraResourcePropertiesForModel($model)
+	{
+		$extra_properties = array();
+		foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
+				if (is_subclass_of($model, $model_classname)) {
+					$extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
+				}
+			}
+		}
+		return $extra_properties;
+	}
+
+
+	/**
+	 * Gets all the related models for the specified model. It's good to use this
+	 * in case this model didn't exist for this version or something
+	 *
+	 * @param EEM_Base $model
+	 * @return EE_Model_Relation_Base[]
+	 */
+	public function relationSettings($model)
+	{
+		$relations = array();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($this->isModelNameInThisVersion($relation_name)) {
+				$relations[ $relation_name ] = $relation_obj;
+			}
+		}
+		// filter the results, but use the old filter name
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
+			$relations,
+			$model
+		);
+	}
 }

core/libraries/messages/EE_Messages_Base.lib.php

Spacing +9 added lines, -9 removed lines

@@ -196,11 +196,11 @@ 
             ! empty($messenger)
             && $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
         ) {
-            $settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
+            $settings_to_use = $active_messengers[$messenger]['settings'][$messenger.'-message_types'];
         }
 
-        $this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
-            ? $settings_to_use[ $this->name ]['settings']
+        $this->_existing_admin_settings = isset($settings_to_use[$this->name]['settings'])
+            ? $settings_to_use[$this->name]['settings']
             : null;
     }
 
@@ -240,7 +240,7 @@ 
     public function get_valid_shortcodes()
     {
         $valid_shortcodes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_valid_shortcodes',
+            'FHEE__'.get_class($this).'__get_valid_shortcodes',
             $this->_valid_shortcodes,
             $this
         );
@@ -283,19 +283,19 @@ 
     protected function _get_admin_page_content($page, $action, $extra, $actives)
     {
         // we can also further refine the context by action (if present).
-        if (!empty($action)) {
-            $page = $page . '_' . $action;
+        if ( ! empty($action)) {
+            $page = $page.'_'.$action;
         }
 
-        if (!isset($this->admin_registered_pages[ $page ])) {
+        if ( ! isset($this->admin_registered_pages[$page])) {
             // todo: a place to throw an exception?
             // We need to indicate there is no registered page so this function is not being called correctly.
             return false;
         }
         // k made it here so let's call the method
         $content = call_user_func_array(
-            array( $this, '_get_admin_content_' . $page ),
-            array( $actives, $extra )
+            array($this, '_get_admin_content_'.$page),
+            array($actives, $extra)
         );
         if ($content === false) {
             // todo this needs to be an exception once we've got exceptions in place.

Indentation +265 added lines, -265 removed lines

@@ -13,44 +13,44 @@ 
  */
 abstract class EE_Messages_Base extends EE_Base
 {
-    /** DETAILS PROPERTIES **/
-    /**
-     * The following are used to hold details on the type for reference (i.e. on admin screens)
-     * and also used by the EE_message_type object to figure out where to get template data.
-     */
-    public $name;
-    public $description;
-    protected $_messages_item_type; // messenger OR message_type?
-
-
-    /**
-     * This is an array describing the ui facing labels
-     * that will be used whenever the messenger is referenced in the ui
-     *
-     * array(
-     *  'singular' => esc_html__('something'),
-     *  'plural' => esc_html__('somethings')
-     * )
-     *
-     * @var array
-     */
-    public $label;
-
-
-
-
-    /**
-     * This property when set will hold the slugs of all EE admin pages that we will need to retrieve fields for
-     * (and used to determine which callback method to call from the child class)
-     *
-     * structure should be
-     * array(
-     * 'page_action' => true
-     * )
-     *
+	/** DETAILS PROPERTIES **/
+	/**
+	 * The following are used to hold details on the type for reference (i.e. on admin screens)
+	 * and also used by the EE_message_type object to figure out where to get template data.
+	 */
+	public $name;
+	public $description;
+	protected $_messages_item_type; // messenger OR message_type?
+
+
+	/**
+	 * This is an array describing the ui facing labels
+	 * that will be used whenever the messenger is referenced in the ui
+	 *
+	 * array(
+	 *  'singular' => esc_html__('something'),
+	 *  'plural' => esc_html__('somethings')
+	 * )
+	 *
+	 * @var array
+	 */
+	public $label;
+
+
+
+
+	/**
+	 * This property when set will hold the slugs of all EE admin pages that we will need to retrieve fields for
+	 * (and used to determine which callback method to call from the child class)
+	 *
+	 * structure should be
+	 * array(
+	 * 'page_action' => true
+	 * )
+	 *
 *@var array
-     */
-    public $admin_registered_pages = array();
+	 */
+	public $admin_registered_pages = array();
 
 
 
@@ -59,265 +59,265 @@ 
 
 
 
-    /**
-     * this property holds any specific fields for holding any settings related to a messenger (if any needed)
-     * @var array
-     */
-    protected $_admin_settings_fields = array();
+	/**
+	 * this property holds any specific fields for holding any settings related to a messenger (if any needed)
+	 * @var array
+	 */
+	protected $_admin_settings_fields = array();
 
 
 
 
 
-    /**
-     * this property will hold any existing settings that may have been set in the admin.
-     * @var array
-     */
-    protected $_existing_admin_settings = array();
+	/**
+	 * this property will hold any existing settings that may have been set in the admin.
+	 * @var array
+	 */
+	protected $_existing_admin_settings = array();
 
 
 
 
 
-    /**
-     * this property will hold an array of valid shortcodes for this message type and messengers.
-     * #For Message Types:
-     * This is an array of strings that correspond to defined EE_Shortcode libraries and per context.
-     * For example:
-     * array( 'admin' => array('transaction', 'event', 'attendee') )
-     * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
-     * for the admin context;
-     *
-     *
-     * #For Messengers:
-     * For example:
-     * array('subject' => array('transaction', 'event', 'attendee'))
-     * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
-     * for the 'subject' field;
-     * NOTE:  by default, with messengers, if the valid shortcodes for a field is left blank,
-     * that field will inherit whatever are set as valid shortcodes by message_type.
-     * This is so messenger can set specific valid codes for fields and leave other
-     * valid shortcodes up to the message type matched with the messenger.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_valid_shortcodes = array();
+	/**
+	 * this property will hold an array of valid shortcodes for this message type and messengers.
+	 * #For Message Types:
+	 * This is an array of strings that correspond to defined EE_Shortcode libraries and per context.
+	 * For example:
+	 * array( 'admin' => array('transaction', 'event', 'attendee') )
+	 * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
+	 * for the admin context;
+	 *
+	 *
+	 * #For Messengers:
+	 * For example:
+	 * array('subject' => array('transaction', 'event', 'attendee'))
+	 * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
+	 * for the 'subject' field;
+	 * NOTE:  by default, with messengers, if the valid shortcodes for a field is left blank,
+	 * that field will inherit whatever are set as valid shortcodes by message_type.
+	 * This is so messenger can set specific valid codes for fields and leave other
+	 * valid shortcodes up to the message type matched with the messenger.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_valid_shortcodes = array();
 
 
 
 
 
-    public function __construct()
-    {
-        $this->_set_admin_settings_fields();
-        $this->_set_valid_shortcodes();
-        $this->_set_admin_pages();
-    }
+	public function __construct()
+	{
+		$this->_set_admin_settings_fields();
+		$this->_set_valid_shortcodes();
+		$this->_set_admin_pages();
+	}
 
 
 
 
 
-    /**
-     * sets the _admin_settings_fields property which needs to be defined by child classes.
-     * You will want to set the _admin_settings_fields properties as a multi-dimensional array with the following format
-     * array(
-     *      {field_name - also used for setting index} => array(
-     *          'field_type' => {type of field: 'text', 'textarea', 'checkbox'},
-     *          'value_type' => {type of value: 'string', 'int', 'array', 'bool'},
-     *          'required' => {bool, required or not},
-     *          'validation' => {bool, true if we want validation, false if not},
-     *          'format' => {%d, or %s},
-     *          'label' => {label for the field, make sure it's localized},
-     *          'default' => {default value for the setting}
-     *      ),
-     * );
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_admin_settings_fields();
+	/**
+	 * sets the _admin_settings_fields property which needs to be defined by child classes.
+	 * You will want to set the _admin_settings_fields properties as a multi-dimensional array with the following format
+	 * array(
+	 *      {field_name - also used for setting index} => array(
+	 *          'field_type' => {type of field: 'text', 'textarea', 'checkbox'},
+	 *          'value_type' => {type of value: 'string', 'int', 'array', 'bool'},
+	 *          'required' => {bool, required or not},
+	 *          'validation' => {bool, true if we want validation, false if not},
+	 *          'format' => {%d, or %s},
+	 *          'label' => {label for the field, make sure it's localized},
+	 *          'default' => {default value for the setting}
+	 *      ),
+	 * );
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_admin_settings_fields();
 
 
 
 
 
-    /**
-     * sets any properties on whether a message type or messenger interface shows up on a ee administration page.
-     * Child classes have to define this method but don't necessarily have to set the flags
-     * as they will be set to false by default.
-     *
-     * Child classes use this method to set the `_admin_registered_page` property.
-     * That property is to indicate what EE admin pages we have a corresponding callback for in the child class
-     * so Message Type/messenger fields/content is included on that admin page.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_admin_pages();
+	/**
+	 * sets any properties on whether a message type or messenger interface shows up on a ee administration page.
+	 * Child classes have to define this method but don't necessarily have to set the flags
+	 * as they will be set to false by default.
+	 *
+	 * Child classes use this method to set the `_admin_registered_page` property.
+	 * That property is to indicate what EE admin pages we have a corresponding callback for in the child class
+	 * so Message Type/messenger fields/content is included on that admin page.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_admin_pages();
 
 
 
 
 
-    /**
-     * Child classes must declare the $_valid_shortcodes property using this method.
-     * See comments for $_valid_shortcodes property for details on what it is used for.
-     *
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_valid_shortcodes();
+	/**
+	 * Child classes must declare the $_valid_shortcodes property using this method.
+	 * See comments for $_valid_shortcodes property for details on what it is used for.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_valid_shortcodes();
 
 
 
-    /**
-     * sets the _existing_admin_settings property can be overridden by child classes.
-     * We do this so we only do database calls if needed.
-     *
-     * @access protected
-     * @param string $messenger
-     */
-    protected function _set_existing_admin_settings($messenger = '')
-    {
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_messengers = $Message_Resource_Manager->get_active_messengers_option();
-        $settings_to_use = $active_messengers;
-
-        /**
-         * This determines what will be used for the getting the settings.
-         */
-        if (
-            ! empty($messenger)
-            && $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
-        ) {
-            $settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
-        }
-
-        $this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
-            ? $settings_to_use[ $this->name ]['settings']
-            : null;
-    }
-
-
-
-
-
-
-    /**
-     * get_existing_admin_settings
-     * (if needed) sets and returns the _existing_admin_settings property.
-     *
-     * @access public
-     * @param string $messenger
-     * @return array          settings
-     */
-    public function get_existing_admin_settings($messenger = '')
-    {
-        // if admin_settings property empty lets try setting it.
-        if (method_exists($this, '_set_existing_admin_settings') && empty($this->_existing_admin_settings)) {
-            $this->_set_existing_admin_settings($messenger);
-        }
-        return property_exists($this, '_existing_admin_settings')
-            ? $this->_existing_admin_settings
-            : null;
-    }
-
-
-
-
-
-
-    /**
-     * This returns the array of valid shortcodes for a message type or messenger as set by the child in the $_valid_shortcode property.
-     * @return array   an array of valid shortcodes.
-     */
-    public function get_valid_shortcodes()
-    {
-        $valid_shortcodes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_valid_shortcodes',
-            $this->_valid_shortcodes,
-            $this
-        );
-        // The below filter applies to ALL messengers and message types so use with care!
-        $valid_shortcodes = apply_filters('FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this);
-        return $valid_shortcodes;
-    }
-
-
-
-
-    /**
-     * getter that returns the protected admin_settings_fields property
-     *
-     * @access public
-     * @return array admin settings fields
-     */
-    public function get_admin_settings_fields()
-    {
-        return $this->_admin_settings_fields;
-    }
-
-
-
-
-
-    /**
-     * this public method accepts a page slug (for an EE_admin page)
-     * and will return the response from the child class callback function
-     * if that page is registered via the `_admin_registered_page` property set by the child class.
-     *
-     * @param string $page the slug of the EE admin page
-     * @param array $actives an array of active message type (or messenger) objects.
-     * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
-     * @param array $extra This is just an extra argument that can be used
-     *                     to pass additional data for setting up page content.
-     * @access protected
-     * @return string $content for page.
-     */
-    protected function _get_admin_page_content($page, $action, $extra, $actives)
-    {
-        // we can also further refine the context by action (if present).
-        if (!empty($action)) {
-            $page = $page . '_' . $action;
-        }
-
-        if (!isset($this->admin_registered_pages[ $page ])) {
-            // todo: a place to throw an exception?
-            // We need to indicate there is no registered page so this function is not being called correctly.
-            return false;
-        }
-        // k made it here so let's call the method
-        $content = call_user_func_array(
-            array( $this, '_get_admin_content_' . $page ),
-            array( $actives, $extra )
-        );
-        if ($content === false) {
-            // todo this needs to be an exception once we've got exceptions in place.
-            return false;
-        }
-        return $content;
-    }
-
-
-    /**
-     * Allows a message type to specifically exclude template fields for the provided messenger.
-     * Filtered so this can be programmatically altered as well.
-     * @param string $messenger_name name of messenger
-     * @return array
-     */
-    public function excludedFieldsForMessenger($messenger_name)
-    {
-        return apply_filters(
-            'FHEE__EE_Messages_Base__excludedFieldForMessenger',
-            array(),
-            $messenger_name,
-            $this->name,
-            $this
-        );
-    }
+	/**
+	 * sets the _existing_admin_settings property can be overridden by child classes.
+	 * We do this so we only do database calls if needed.
+	 *
+	 * @access protected
+	 * @param string $messenger
+	 */
+	protected function _set_existing_admin_settings($messenger = '')
+	{
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messengers = $Message_Resource_Manager->get_active_messengers_option();
+		$settings_to_use = $active_messengers;
+
+		/**
+		 * This determines what will be used for the getting the settings.
+		 */
+		if (
+			! empty($messenger)
+			&& $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
+		) {
+			$settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
+		}
+
+		$this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
+			? $settings_to_use[ $this->name ]['settings']
+			: null;
+	}
+
+
+
+
+
+
+	/**
+	 * get_existing_admin_settings
+	 * (if needed) sets and returns the _existing_admin_settings property.
+	 *
+	 * @access public
+	 * @param string $messenger
+	 * @return array          settings
+	 */
+	public function get_existing_admin_settings($messenger = '')
+	{
+		// if admin_settings property empty lets try setting it.
+		if (method_exists($this, '_set_existing_admin_settings') && empty($this->_existing_admin_settings)) {
+			$this->_set_existing_admin_settings($messenger);
+		}
+		return property_exists($this, '_existing_admin_settings')
+			? $this->_existing_admin_settings
+			: null;
+	}
+
+
+
+
+
+
+	/**
+	 * This returns the array of valid shortcodes for a message type or messenger as set by the child in the $_valid_shortcode property.
+	 * @return array   an array of valid shortcodes.
+	 */
+	public function get_valid_shortcodes()
+	{
+		$valid_shortcodes = apply_filters(
+			'FHEE__' . get_class($this) . '__get_valid_shortcodes',
+			$this->_valid_shortcodes,
+			$this
+		);
+		// The below filter applies to ALL messengers and message types so use with care!
+		$valid_shortcodes = apply_filters('FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this);
+		return $valid_shortcodes;
+	}
+
+
+
+
+	/**
+	 * getter that returns the protected admin_settings_fields property
+	 *
+	 * @access public
+	 * @return array admin settings fields
+	 */
+	public function get_admin_settings_fields()
+	{
+		return $this->_admin_settings_fields;
+	}
+
+
+
+
+
+	/**
+	 * this public method accepts a page slug (for an EE_admin page)
+	 * and will return the response from the child class callback function
+	 * if that page is registered via the `_admin_registered_page` property set by the child class.
+	 *
+	 * @param string $page the slug of the EE admin page
+	 * @param array $actives an array of active message type (or messenger) objects.
+	 * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
+	 * @param array $extra This is just an extra argument that can be used
+	 *                     to pass additional data for setting up page content.
+	 * @access protected
+	 * @return string $content for page.
+	 */
+	protected function _get_admin_page_content($page, $action, $extra, $actives)
+	{
+		// we can also further refine the context by action (if present).
+		if (!empty($action)) {
+			$page = $page . '_' . $action;
+		}
+
+		if (!isset($this->admin_registered_pages[ $page ])) {
+			// todo: a place to throw an exception?
+			// We need to indicate there is no registered page so this function is not being called correctly.
+			return false;
+		}
+		// k made it here so let's call the method
+		$content = call_user_func_array(
+			array( $this, '_get_admin_content_' . $page ),
+			array( $actives, $extra )
+		);
+		if ($content === false) {
+			// todo this needs to be an exception once we've got exceptions in place.
+			return false;
+		}
+		return $content;
+	}
+
+
+	/**
+	 * Allows a message type to specifically exclude template fields for the provided messenger.
+	 * Filtered so this can be programmatically altered as well.
+	 * @param string $messenger_name name of messenger
+	 * @return array
+	 */
+	public function excludedFieldsForMessenger($messenger_name)
+	{
+		return apply_filters(
+			'FHEE__EE_Messages_Base__excludedFieldForMessenger',
+			array(),
+			$messenger_name,
+			$this->name,
+			$this
+		);
+	}
 }