eventespresso / event-espresso-core

caffeinated/payment_methods/Aim/EEG_Aim.gateway.php

Unused Use Statements -1 removed lines

@@ -1,6 +1,5 @@
 <?php
 
-use EventEspresso\core\services\formatters\AsciiOnly;
 use EventEspresso\core\services\loaders\LoaderFactory;
 
 /**

Spacing +12 added lines, -12 removed lines

@@ -216,7 +216,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(
@@ -254,7 +254,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);
 
@@ -265,7 +265,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);
@@ -311,7 +311,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']);
     }
 
@@ -351,7 +351,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.");
@@ -371,11 +371,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();
@@ -387,7 +387,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);
         }
@@ -399,7 +399,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);
     }
@@ -419,7 +419,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]);
                 }
             }
         }
@@ -560,7 +560,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);
             }
@@ -642,7 +642,7 @@ 
     }
 }
 
-if (! class_exists('AuthorizeNetException')) {
+if ( ! class_exists('AuthorizeNetException')) {
     /**
      * Class AuthorizeNetException
      *

Doc Comments +2 added lines, -2 removed lines

@@ -362,7 +362,7 @@ 
     /**
      * Posts the request to AuthorizeNet & returns response.
      *
-     * @param $payment
+     * @param EEI_Payment $payment
      * @return \EE_AuthorizeNetAIM_Response
      */
     private function _sendRequest($payment)
@@ -451,7 +451,7 @@ 
     /**
      * Removes characters Authorize.net doesn't handle well.
      * @since 4.9.82.p
-     * @param $text
+     * @param string $text
      * @return string
      */
     private function prepareStringForAuthnet($text)

Indentation +620 added lines, -620 removed lines

@@ -26,442 +26,442 @@ 
 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 $_server;
-
-    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
-        );
-    }
-
-
-    /**
-     * TEMPORARY CALLBACK! Do not use
-     * Callback which filters the server url. This is added so site admins can revert to using
-     * the old AIM server in case Akamai service breaks their integration.
-     * Using Akamai will, however, be mandatory on June 30th 2016 Authorize.net
-     * (see http://www.authorize.net/support/akamaifaqs/#firewall?utm_campaign=April%202016%20Technical%20Updates%20for%20Merchants.html&utm_medium=email&utm_source=Eloqua&elqTrackId=46103bdc375c411a979c2f658fc99074&elq=7026706360154fee9b6d588b27d8eb6a&elqaid=506&elqat=1&elqCampaignId=343)
-     * Once that happens, this will be obsolete and WILL BE REMOVED.
-     *
-     * @param string $url
-     * @param EEG_Aim $gateway_object
-     * @return string
-     */
-    public function possibly_use_deprecated_aim_server($url, EEG_Aim $gateway_object)
-    {
-        if ($gateway_object->_server === 'authorize.net' && ! $gateway_object->_debug_mode) {
-            return 'https://secure.authorize.net/gateway/transact.dll';
-        } else {
-            return $url;
-        }
-    }
-
-
-    /**
-     * 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 EEI_Payment $payment
-     * @param array $billing_info {
-     *  @type $credit_card string
-     *  @type $cvv string
-     *  @type $exp_month string
-     *  @type $exp_year string
-     *  @see parent::do_direct_payment
-     * }
-     * @return EEI_Payment updated
-     */
-    public function do_direct_payment($payment, $billing_info = null)
-    {
-        add_filter('FHEE__EEG_Aim___get_server_url', array($this, 'possibly_use_deprecated_aim_server'), 10, 2);
-        // 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(__("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 $_server;
+
+	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
+		);
+	}
+
+
+	/**
+	 * TEMPORARY CALLBACK! Do not use
+	 * Callback which filters the server url. This is added so site admins can revert to using
+	 * the old AIM server in case Akamai service breaks their integration.
+	 * Using Akamai will, however, be mandatory on June 30th 2016 Authorize.net
+	 * (see http://www.authorize.net/support/akamaifaqs/#firewall?utm_campaign=April%202016%20Technical%20Updates%20for%20Merchants.html&utm_medium=email&utm_source=Eloqua&elqTrackId=46103bdc375c411a979c2f658fc99074&elq=7026706360154fee9b6d588b27d8eb6a&elqaid=506&elqat=1&elqCampaignId=343)
+	 * Once that happens, this will be obsolete and WILL BE REMOVED.
+	 *
+	 * @param string $url
+	 * @param EEG_Aim $gateway_object
+	 * @return string
+	 */
+	public function possibly_use_deprecated_aim_server($url, EEG_Aim $gateway_object)
+	{
+		if ($gateway_object->_server === 'authorize.net' && ! $gateway_object->_debug_mode) {
+			return 'https://secure.authorize.net/gateway/transact.dll';
+		} else {
+			return $url;
+		}
+	}
+
+
+	/**
+	 * 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 EEI_Payment $payment
+	 * @param array $billing_info {
+	 *  @type $credit_card string
+	 *  @type $cvv string
+	 *  @type $exp_month string
+	 *  @type $exp_year string
+	 *  @see parent::do_direct_payment
+	 * }
+	 * @return EEI_Payment updated
+	 */
+	public function do_direct_payment($payment, $billing_info = null)
+	{
+		add_filter('FHEE__EEG_Aim___get_server_url', array($this, 'possibly_use_deprecated_aim_server'), 10, 2);
+		// 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(__("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 EEI_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 EEI_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
+		);
+	}
 }
 
 
@@ -477,192 +477,192 @@ 
 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);
+		}
+	}
 }

core/libraries/shortcodes/EE_Event_List_Shortcodes.lib.php

Indentation +135 added lines, -135 removed lines

@@ -21,139 +21,139 @@
 class EE_Event_List_Shortcodes extends EE_Shortcodes
 {
 
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    protected function _init_props()
-    {
-        $this->label = __('Event List Shortcodes', 'event_espresso');
-        $this->description = __('All shortcodes specific to event lists', 'event_espresso');
-        $this->_shortcodes = array(
-            '[EVENT_LIST]' => __('Will output a list of events', 'event_espresso'),
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[EVENT_LIST]':
-                return $this->_get_event_list();
-                break;
-        }
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value.
-     *
-     * @return string
-     */
-    private function _get_event_list()
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_event_list_for_main();
-        } elseif ($this->_data['data'] instanceof EE_Registration) {
-            return $this->_get_event_list_for_registration();
-        } // prevent recursive loop
-        else {
-            return '';
-        }
-    }
-
-
-    /**
-     * This returns the parsed event list for main template
-     *
-     * @return string
-     */
-    private function _get_event_list_for_main()
-    {
-
-        $valid_shortcodes = array(
-            'event',
-            'attendee_list',
-            'ticket_list',
-            'datetime_list',
-            'venue',
-            'attendee',
-            'recipient_list',
-            'recipient_details',
-            'primary_registration_list',
-            'primary_registration_details',
-            'event_author',
-            'organization',
-        );
-        $template = $this->_data['template'];
-        $data = $this->_data['data'];
-        $events = '';
-
-        // now we need to loop through the events array in EE_Messages_Addressee and send data to the EE_Parser helper.
-        foreach ($data->events as $event) {
-            $events .= $this->_shortcode_helper->parse_event_list_template(
-                $template,
-                $event['event'],
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-        return $events;
-    }
-
-
-    /**
-     * This returns the parsed event list for an attendee
-     *
-     * @return string
-     */
-    private function _get_event_list_for_registration()
-    {
-        $valid_shortcodes = array(
-            'event',
-            'ticket_list',
-            'datetime_list',
-            'attendee',
-            'event_author',
-            'recipient_details',
-            'recipient_list',
-            'venue',
-            'organization',
-        );
-        $template = is_array($this->_data['template']) && isset($this->_data['template']['event_list'])
-            ? $this->_data['template']['event_list'] : $this->_extra_data['template']['event_list'];
-        $registration = $this->_data['data'];
-
-        // let's remove any existing [ATTENDEE_LIST] shortcode from the event list template so that we don't get recursion.
-        $template = str_replace('[ATTENDEE_LIST]', '', $template);
-
-        // here we're setting up the events for the event_list template for THIS registration.
-        $evt_result = '';
-        $all_events = $this->_get_events_from_registration($registration);
-
-        // we're NOT going to prepare a list of attendees this time around
-        $events = '';
-
-        foreach ((array) $all_events as $event) {
-            $events .= $this->_shortcode_helper->parse_event_list_template(
-                $template,
-                $event,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $events;
-    }
-
-
-    private function _get_events_from_registration(EE_Registration $registration)
-    {
-        return isset($this->_extra_data['data']->registrations)
-            ? array($this->_extra_data['data']->registrations[ $registration->ID() ]['evt_obj']) : array();
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	protected function _init_props()
+	{
+		$this->label = __('Event List Shortcodes', 'event_espresso');
+		$this->description = __('All shortcodes specific to event lists', 'event_espresso');
+		$this->_shortcodes = array(
+			'[EVENT_LIST]' => __('Will output a list of events', 'event_espresso'),
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[EVENT_LIST]':
+				return $this->_get_event_list();
+				break;
+		}
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value.
+	 *
+	 * @return string
+	 */
+	private function _get_event_list()
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_event_list_for_main();
+		} elseif ($this->_data['data'] instanceof EE_Registration) {
+			return $this->_get_event_list_for_registration();
+		} // prevent recursive loop
+		else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * This returns the parsed event list for main template
+	 *
+	 * @return string
+	 */
+	private function _get_event_list_for_main()
+	{
+
+		$valid_shortcodes = array(
+			'event',
+			'attendee_list',
+			'ticket_list',
+			'datetime_list',
+			'venue',
+			'attendee',
+			'recipient_list',
+			'recipient_details',
+			'primary_registration_list',
+			'primary_registration_details',
+			'event_author',
+			'organization',
+		);
+		$template = $this->_data['template'];
+		$data = $this->_data['data'];
+		$events = '';
+
+		// now we need to loop through the events array in EE_Messages_Addressee and send data to the EE_Parser helper.
+		foreach ($data->events as $event) {
+			$events .= $this->_shortcode_helper->parse_event_list_template(
+				$template,
+				$event['event'],
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+		return $events;
+	}
+
+
+	/**
+	 * This returns the parsed event list for an attendee
+	 *
+	 * @return string
+	 */
+	private function _get_event_list_for_registration()
+	{
+		$valid_shortcodes = array(
+			'event',
+			'ticket_list',
+			'datetime_list',
+			'attendee',
+			'event_author',
+			'recipient_details',
+			'recipient_list',
+			'venue',
+			'organization',
+		);
+		$template = is_array($this->_data['template']) && isset($this->_data['template']['event_list'])
+			? $this->_data['template']['event_list'] : $this->_extra_data['template']['event_list'];
+		$registration = $this->_data['data'];
+
+		// let's remove any existing [ATTENDEE_LIST] shortcode from the event list template so that we don't get recursion.
+		$template = str_replace('[ATTENDEE_LIST]', '', $template);
+
+		// here we're setting up the events for the event_list template for THIS registration.
+		$evt_result = '';
+		$all_events = $this->_get_events_from_registration($registration);
+
+		// we're NOT going to prepare a list of attendees this time around
+		$events = '';
+
+		foreach ((array) $all_events as $event) {
+			$events .= $this->_shortcode_helper->parse_event_list_template(
+				$template,
+				$event,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $events;
+	}
+
+
+	private function _get_events_from_registration(EE_Registration $registration)
+	{
+		return isset($this->_extra_data['data']->registrations)
+			? array($this->_extra_data['data']->registrations[ $registration->ID() ]['evt_obj']) : array();
+	}
 }

core/domain/services/contexts/RequestTypeContextDetector.php

Indentation +177 added lines, -177 removed lines

@@ -18,181 +18,181 @@
 class RequestTypeContextDetector
 {
 
-    /**
-     * @var RequestTypeContextFactoryInterface $factory
-     */
-    private $factory;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * @var array $globalRouteConditions
-     */
-    private $globalRouteConditions;
-
-
-    /**
-     * RequestTypeContextDetector constructor.
-     *
-     * @param RequestInterface                   $request
-     * @param RequestTypeContextFactoryInterface $factory
-     * @param array                              $globalRouteConditions an array for injecting values that would
-     *                                                                  otherwise be defined as global constants
-     *                                                                  or other global variables for the current
-     *                                                                  request route such as DOING_AJAX
-     */
-    public function __construct(
-        RequestInterface $request,
-        RequestTypeContextFactoryInterface $factory,
-        array $globalRouteConditions = array()
-    ) {
-        $this->request = $request;
-        $this->factory = $factory;
-        $this->globalRouteConditions = $globalRouteConditions;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    private function getGlobalRouteCondition($globalRouteCondition, $default)
-    {
-        return isset($this->globalRouteConditions[ $globalRouteCondition ])
-            ? $this->globalRouteConditions[ $globalRouteCondition ]
-            : $default;
-    }
-
-
-    /**
-     * @return RequestTypeContext
-     * @throws InvalidArgumentException
-     */
-    public function detectRequestTypeContext()
-    {
-        // Detect error scrapes
-        if ($this->request->getRequestParam('wp_scrape_key') !== null
-            && $this->request->getRequestParam('wp_scrape_nonce') !== null
-        ) {
-            return $this->factory->create(RequestTypeContext::WP_SCRAPE);
-        }
-        // Detect EE REST API
-        if ($this->isEspressoRestApiRequest()) {
-            return $this->factory->create(RequestTypeContext::API);
-        }
-        // Detect WP REST API
-        if ($this->isWordPressRestApiRequest()) {
-            return $this->factory->create(RequestTypeContext::WP_API);
-        }
-        // Detect AJAX
-        if ($this->getGlobalRouteCondition('DOING_AJAX', false)) {
-            if (filter_var($this->request->getRequestParam('ee_front_ajax'), FILTER_VALIDATE_BOOLEAN)) {
-                return $this->factory->create(RequestTypeContext::AJAX_FRONT);
-            }
-            if (filter_var($this->request->getRequestParam('ee_admin_ajax'), FILTER_VALIDATE_BOOLEAN)) {
-                return $this->factory->create(RequestTypeContext::AJAX_ADMIN);
-            }
-            if ($this->request->getRequestParam('action') === 'heartbeat') {
-                return $this->factory->create(RequestTypeContext::AJAX_HEARTBEAT);
-            }
-            return $this->factory->create(RequestTypeContext::AJAX_OTHER);
-        }
-        // Detect WP_Cron
-        if ($this->isCronRequest()) {
-            return $this->factory->create(RequestTypeContext::CRON);
-        }
-        // Detect command line requests
-        if ($this->getGlobalRouteCondition('WP_CLI', false)) {
-            return $this->factory->create(RequestTypeContext::CLI);
-        }
-        // detect WordPress admin (ie: "Dashboard")
-        if ($this->getGlobalRouteCondition('is_admin', false)) {
-            return $this->factory->create(RequestTypeContext::ADMIN);
-        }
-        // Detect iFrames
-        if ($this->isIframeRoute()) {
-            return $this->factory->create(RequestTypeContext::IFRAME);
-        }
-        // Detect Feeds
-        if ($this->isFeedRequest()) {
-            return $this->factory->create(RequestTypeContext::FEED);
-        }
-        // and by process of elimination...
-        return $this->factory->create(RequestTypeContext::FRONTEND);
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isEspressoRestApiRequest()
-    {
-        // Check for URLs like http://mysite.com/?rest_route=/ee... and http://mysite.com/wp-json/ee/...
-        return strpos(
-            $this->request->getRequestParam('rest_route', false),
-            '/' . Domain::API_NAMESPACE
-        ) === 0
-            || $this->uriPathMatches(trim(rest_get_url_prefix(), '/') . '/' . Domain::API_NAMESPACE);
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    private function isWordPressRestApiRequest()
-    {
-        // Check for URLs like http://mysite.com/?rest_route=/.. and http://mysite.com/wp-json/...
-        return $this->request->getRequestParam('rest_route', false)
-            || $this->uriPathMatches(trim(rest_get_url_prefix(), '/'));
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isCronRequest()
-    {
-        return $this->uriPathMatches('wp-cron.php');
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isFeedRequest()
-    {
-        return $this->uriPathMatches('feed');
-    }
-
-
-    /**
-     * @param string $component
-     * @return bool
-     */
-    private function uriPathMatches($component)
-    {
-        $request_uri = $this->request->requestUri(true);
-        $parts = explode('?', $request_uri);
-        $path = trim(reset($parts), '/');
-        return strpos($path, $component) === 0;
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isIframeRoute()
-    {
-        $is_iframe_route = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_contexts_RequestTypeContextDetector__isIframeRoute',
-            $this->request->getRequestParam('event_list', '') === 'iframe'
-            || $this->request->getRequestParam('ticket_selector', '') === 'iframe'
-            || $this->request->getRequestParam('calendar', '') === 'iframe',
-            $this
-        );
-        return filter_var($is_iframe_route, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @var RequestTypeContextFactoryInterface $factory
+	 */
+	private $factory;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * @var array $globalRouteConditions
+	 */
+	private $globalRouteConditions;
+
+
+	/**
+	 * RequestTypeContextDetector constructor.
+	 *
+	 * @param RequestInterface                   $request
+	 * @param RequestTypeContextFactoryInterface $factory
+	 * @param array                              $globalRouteConditions an array for injecting values that would
+	 *                                                                  otherwise be defined as global constants
+	 *                                                                  or other global variables for the current
+	 *                                                                  request route such as DOING_AJAX
+	 */
+	public function __construct(
+		RequestInterface $request,
+		RequestTypeContextFactoryInterface $factory,
+		array $globalRouteConditions = array()
+	) {
+		$this->request = $request;
+		$this->factory = $factory;
+		$this->globalRouteConditions = $globalRouteConditions;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	private function getGlobalRouteCondition($globalRouteCondition, $default)
+	{
+		return isset($this->globalRouteConditions[ $globalRouteCondition ])
+			? $this->globalRouteConditions[ $globalRouteCondition ]
+			: $default;
+	}
+
+
+	/**
+	 * @return RequestTypeContext
+	 * @throws InvalidArgumentException
+	 */
+	public function detectRequestTypeContext()
+	{
+		// Detect error scrapes
+		if ($this->request->getRequestParam('wp_scrape_key') !== null
+			&& $this->request->getRequestParam('wp_scrape_nonce') !== null
+		) {
+			return $this->factory->create(RequestTypeContext::WP_SCRAPE);
+		}
+		// Detect EE REST API
+		if ($this->isEspressoRestApiRequest()) {
+			return $this->factory->create(RequestTypeContext::API);
+		}
+		// Detect WP REST API
+		if ($this->isWordPressRestApiRequest()) {
+			return $this->factory->create(RequestTypeContext::WP_API);
+		}
+		// Detect AJAX
+		if ($this->getGlobalRouteCondition('DOING_AJAX', false)) {
+			if (filter_var($this->request->getRequestParam('ee_front_ajax'), FILTER_VALIDATE_BOOLEAN)) {
+				return $this->factory->create(RequestTypeContext::AJAX_FRONT);
+			}
+			if (filter_var($this->request->getRequestParam('ee_admin_ajax'), FILTER_VALIDATE_BOOLEAN)) {
+				return $this->factory->create(RequestTypeContext::AJAX_ADMIN);
+			}
+			if ($this->request->getRequestParam('action') === 'heartbeat') {
+				return $this->factory->create(RequestTypeContext::AJAX_HEARTBEAT);
+			}
+			return $this->factory->create(RequestTypeContext::AJAX_OTHER);
+		}
+		// Detect WP_Cron
+		if ($this->isCronRequest()) {
+			return $this->factory->create(RequestTypeContext::CRON);
+		}
+		// Detect command line requests
+		if ($this->getGlobalRouteCondition('WP_CLI', false)) {
+			return $this->factory->create(RequestTypeContext::CLI);
+		}
+		// detect WordPress admin (ie: "Dashboard")
+		if ($this->getGlobalRouteCondition('is_admin', false)) {
+			return $this->factory->create(RequestTypeContext::ADMIN);
+		}
+		// Detect iFrames
+		if ($this->isIframeRoute()) {
+			return $this->factory->create(RequestTypeContext::IFRAME);
+		}
+		// Detect Feeds
+		if ($this->isFeedRequest()) {
+			return $this->factory->create(RequestTypeContext::FEED);
+		}
+		// and by process of elimination...
+		return $this->factory->create(RequestTypeContext::FRONTEND);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isEspressoRestApiRequest()
+	{
+		// Check for URLs like http://mysite.com/?rest_route=/ee... and http://mysite.com/wp-json/ee/...
+		return strpos(
+			$this->request->getRequestParam('rest_route', false),
+			'/' . Domain::API_NAMESPACE
+		) === 0
+			|| $this->uriPathMatches(trim(rest_get_url_prefix(), '/') . '/' . Domain::API_NAMESPACE);
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	private function isWordPressRestApiRequest()
+	{
+		// Check for URLs like http://mysite.com/?rest_route=/.. and http://mysite.com/wp-json/...
+		return $this->request->getRequestParam('rest_route', false)
+			|| $this->uriPathMatches(trim(rest_get_url_prefix(), '/'));
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isCronRequest()
+	{
+		return $this->uriPathMatches('wp-cron.php');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isFeedRequest()
+	{
+		return $this->uriPathMatches('feed');
+	}
+
+
+	/**
+	 * @param string $component
+	 * @return bool
+	 */
+	private function uriPathMatches($component)
+	{
+		$request_uri = $this->request->requestUri(true);
+		$parts = explode('?', $request_uri);
+		$path = trim(reset($parts), '/');
+		return strpos($path, $component) === 0;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isIframeRoute()
+	{
+		$is_iframe_route = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_contexts_RequestTypeContextDetector__isIframeRoute',
+			$this->request->getRequestParam('event_list', '') === 'iframe'
+			|| $this->request->getRequestParam('ticket_selector', '') === 'iframe'
+			|| $this->request->getRequestParam('calendar', '') === 'iframe',
+			$this
+		);
+		return filter_var($is_iframe_route, FILTER_VALIDATE_BOOLEAN);
+	}
 }

core/services/request/Request.php

Indentation +636 added lines, -636 removed lines

@@ -17,640 +17,640 @@
 class Request implements InterminableInterface, RequestInterface, ReservedInstanceInterface
 {
 
-    /**
-     * $_GET parameters
-     *
-     * @var array $get
-     */
-    private $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array $post
-     */
-    private $post;
-
-    /**
-     * $_COOKIE parameters
-     *
-     * @var array $cookie
-     */
-    private $cookie;
-
-    /**
-     * $_SERVER parameters
-     *
-     * @var array $server
-     */
-    private $server;
-
-    /**
-     * $_FILES parameters
-     *
-     * @var array $files
-     */
-    private $files;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array $request
-     */
-    private $request;
-
-    /**
-     * @var RequestTypeContextCheckerInterface
-     */
-    private $request_type;
-
-    /**
-     * IP address for request
-     *
-     * @var string $ip_address
-     */
-    private $ip_address;
-
-    /**
-     * @var string $user_agent
-     */
-    private $user_agent;
-
-    /**
-     * true if current user appears to be some kind of bot
-     *
-     * @var bool $is_bot
-     */
-    private $is_bot;
-
-
-    /**
-     * @param array $get
-     * @param array $post
-     * @param array $cookie
-     * @param array $server
-     * @param array $files
-     */
-    public function __construct(array $get, array $post, array $cookie, array $server, array $files = array())
-    {
-        // grab request vars
-        $this->get = $get;
-        $this->post = $post;
-        $this->cookie = $cookie;
-        $this->server = $server;
-        $this->files = $files;
-        $this->request = array_merge($this->get, $this->post);
-        $this->ip_address = $this->visitorIp();
-    }
-
-
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
-    {
-        $this->request_type = $type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams()
-    {
-        return $this->cookie;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function serverParams()
-    {
-        return $this->server;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function filesParams()
-    {
-        return $this->files;
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if ($key !== 'ee'
-            || ($key === 'ee' && empty($this->request['ee']))
-            || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
-        ) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param       $key
-     * @param null  $default
-     * @return mixed
-     */
-    public function getRequestParam($key, $default = null)
-    {
-        return $this->requestParameterDrillDown($key, $default, 'get');
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param       $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return $this->requestParameterDrillDown($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param null|mixed $default
-     * @return mixed
-     */
-    public function getMatch($pattern, $default = null)
-    {
-        return $this->requestParameterDrillDown($pattern, $default, 'match');
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return bool
-     */
-    public function matches($pattern)
-    {
-        return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
-     *                                      and used to search through the current request's parameter keys
-     * @param array  $request_params        The array of request parameters to search through
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
-     *                                      Default is null
-     * @param string $return                [optional] Controls what kind of value is returned.
-     *                                      Options are:
-     *                                      'bool' will return true or false if match is found or not
-     *                                      'key' will return the first key found that matches the supplied pattern
-     *                                      'value' will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                      Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = 'value')
-    {
-        $return = in_array($return, array('bool', 'key', 'value'), true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            array("\*", "\?"),
-            array('.*', '.'),
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === 'value') {
-                    return $request_params[ $key ];
-                }
-                // or actual key or true just to indicate it was found
-                return $return === 'key' ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === 'value' ? $default : false;
-    }
-
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param array  $request_params
-     * @return bool|mixed|null
-     */
-    private function requestParameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        array $request_params = array()
-    ) {
-        $callback = in_array($callback, array('is_set', 'get', 'match'), true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->request;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, 'key');
-                $key = $real_key ? $real_key : $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->requestParameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default);
-        }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
-            : $default;
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        unset($this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_REQUEST[ $key ]);
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->ip_address;
-    }
-
-
-    /**
-     * attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @access public
-     * @return string
-     */
-    private function visitorIp()
-    {
-        $visitor_ip = '0.0.0.0';
-        $server_keys = array(
-            'HTTP_CLIENT_IP',
-            'HTTP_X_FORWARDED_FOR',
-            'HTTP_X_FORWARDED',
-            'HTTP_X_CLUSTER_CLIENT_IP',
-            'HTTP_FORWARDED_FOR',
-            'HTTP_FORWARDED',
-            'REMOTE_ADDR',
-        );
-        foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return $visitor_ip;
-    }
-
-
-    /**
-     * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
-     * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
-     *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
-     *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false)
-    {
-        $request_uri = filter_input(
-            INPUT_SERVER,
-            'REQUEST_URI',
-            FILTER_SANITIZE_URL,
-            FILTER_NULL_ON_FAILURE
-        );
-        if (empty($request_uri)) {
-            // fallback sanitization if the above fails
-            $request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
-        }
-        if ($relativeToWpRoot) {
-            $home_path = untrailingslashit(
-                parse_url(
-                    home_url(),
-                    PHP_URL_PATH
-                )
-            );
-            $request_uri = str_replace(
-                $home_path,
-                '',
-                $request_uri
-            );
-        }
-        return $request_uri;
-    }
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        return $this->user_agent;
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        if ($user_agent === '' || ! is_string($user_agent)) {
-            $user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
-        }
-        $this->user_agent = $user_agent;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isBot()
-    {
-        return $this->is_bot;
-    }
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot)
-    {
-        $this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->request_type->isActivation();
-    }
-
-
-    /**
-     * @param $is_activation
-     * @return bool
-     */
-    public function setIsActivation($is_activation)
-    {
-        return $this->request_type->setIsActivation($is_activation);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdmin()
-    {
-        return $this->request_type->isAdmin();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdminAjax()
-    {
-        return $this->request_type->isAdminAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAjax()
-    {
-        return $this->request_type->isAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isEeAjax()
-    {
-        return $this->request_type->isEeAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isOtherAjax()
-    {
-        return $this->request_type->isOtherAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isApi()
-    {
-        return $this->request_type->isApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCli()
-    {
-        return $this->request_type->isCli();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCron()
-    {
-        return $this->request_type->isCron();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFeed()
-    {
-        return $this->request_type->isFeed();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontend()
-    {
-        return $this->request_type->isFrontend();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontAjax()
-    {
-        return $this->request_type->isFrontAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isIframe()
-    {
-        return $this->request_type->isIframe();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressApi()
-    {
-        return $this->request_type->isWordPressApi();
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressHeartbeat()
-    {
-        return $this->request_type->isWordPressHeartbeat();
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressScrape()
-    {
-        return $this->request_type->isWordPressScrape();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->request_type->slug();
-    }
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array $get
+	 */
+	private $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array $post
+	 */
+	private $post;
+
+	/**
+	 * $_COOKIE parameters
+	 *
+	 * @var array $cookie
+	 */
+	private $cookie;
+
+	/**
+	 * $_SERVER parameters
+	 *
+	 * @var array $server
+	 */
+	private $server;
+
+	/**
+	 * $_FILES parameters
+	 *
+	 * @var array $files
+	 */
+	private $files;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array $request
+	 */
+	private $request;
+
+	/**
+	 * @var RequestTypeContextCheckerInterface
+	 */
+	private $request_type;
+
+	/**
+	 * IP address for request
+	 *
+	 * @var string $ip_address
+	 */
+	private $ip_address;
+
+	/**
+	 * @var string $user_agent
+	 */
+	private $user_agent;
+
+	/**
+	 * true if current user appears to be some kind of bot
+	 *
+	 * @var bool $is_bot
+	 */
+	private $is_bot;
+
+
+	/**
+	 * @param array $get
+	 * @param array $post
+	 * @param array $cookie
+	 * @param array $server
+	 * @param array $files
+	 */
+	public function __construct(array $get, array $post, array $cookie, array $server, array $files = array())
+	{
+		// grab request vars
+		$this->get = $get;
+		$this->post = $post;
+		$this->cookie = $cookie;
+		$this->server = $server;
+		$this->files = $files;
+		$this->request = array_merge($this->get, $this->post);
+		$this->ip_address = $this->visitorIp();
+	}
+
+
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
+	{
+		$this->request_type = $type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams()
+	{
+		return $this->cookie;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams()
+	{
+		return $this->server;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function filesParams()
+	{
+		return $this->files;
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if ($key !== 'ee'
+			|| ($key === 'ee' && empty($this->request['ee']))
+			|| ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
+		) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param       $key
+	 * @param null  $default
+	 * @return mixed
+	 */
+	public function getRequestParam($key, $default = null)
+	{
+		return $this->requestParameterDrillDown($key, $default, 'get');
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param       $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return $this->requestParameterDrillDown($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param null|mixed $default
+	 * @return mixed
+	 */
+	public function getMatch($pattern, $default = null)
+	{
+		return $this->requestParameterDrillDown($pattern, $default, 'match');
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return bool
+	 */
+	public function matches($pattern)
+	{
+		return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
+	 *                                      and used to search through the current request's parameter keys
+	 * @param array  $request_params        The array of request parameters to search through
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
+	 *                                      Default is null
+	 * @param string $return                [optional] Controls what kind of value is returned.
+	 *                                      Options are:
+	 *                                      'bool' will return true or false if match is found or not
+	 *                                      'key' will return the first key found that matches the supplied pattern
+	 *                                      'value' will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                      Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = 'value')
+	{
+		$return = in_array($return, array('bool', 'key', 'value'), true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			array("\*", "\?"),
+			array('.*', '.'),
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === 'value') {
+					return $request_params[ $key ];
+				}
+				// or actual key or true just to indicate it was found
+				return $return === 'key' ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === 'value' ? $default : false;
+	}
+
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param array  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function requestParameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		array $request_params = array()
+	) {
+		$callback = in_array($callback, array('is_set', 'get', 'match'), true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->request;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, 'key');
+				$key = $real_key ? $real_key : $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->requestParameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default);
+		}
+		return isset($request_params[ $key ])
+			? $request_params[ $key ]
+			: $default;
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		unset($this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_REQUEST[ $key ]);
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->ip_address;
+	}
+
+
+	/**
+	 * attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @access public
+	 * @return string
+	 */
+	private function visitorIp()
+	{
+		$visitor_ip = '0.0.0.0';
+		$server_keys = array(
+			'HTTP_CLIENT_IP',
+			'HTTP_X_FORWARDED_FOR',
+			'HTTP_X_FORWARDED',
+			'HTTP_X_CLUSTER_CLIENT_IP',
+			'HTTP_FORWARDED_FOR',
+			'HTTP_FORWARDED',
+			'REMOTE_ADDR',
+		);
+		foreach ($server_keys as $key) {
+			if (isset($this->server[ $key ])) {
+				foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return $visitor_ip;
+	}
+
+
+	/**
+	 * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
+	 * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
+	 *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
+	 *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false)
+	{
+		$request_uri = filter_input(
+			INPUT_SERVER,
+			'REQUEST_URI',
+			FILTER_SANITIZE_URL,
+			FILTER_NULL_ON_FAILURE
+		);
+		if (empty($request_uri)) {
+			// fallback sanitization if the above fails
+			$request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
+		}
+		if ($relativeToWpRoot) {
+			$home_path = untrailingslashit(
+				parse_url(
+					home_url(),
+					PHP_URL_PATH
+				)
+			);
+			$request_uri = str_replace(
+				$home_path,
+				'',
+				$request_uri
+			);
+		}
+		return $request_uri;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		return $this->user_agent;
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		if ($user_agent === '' || ! is_string($user_agent)) {
+			$user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
+		}
+		$this->user_agent = $user_agent;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot()
+	{
+		return $this->is_bot;
+	}
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot)
+	{
+		$this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->request_type->isActivation();
+	}
+
+
+	/**
+	 * @param $is_activation
+	 * @return bool
+	 */
+	public function setIsActivation($is_activation)
+	{
+		return $this->request_type->setIsActivation($is_activation);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdmin()
+	{
+		return $this->request_type->isAdmin();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdminAjax()
+	{
+		return $this->request_type->isAdminAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAjax()
+	{
+		return $this->request_type->isAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isEeAjax()
+	{
+		return $this->request_type->isEeAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isOtherAjax()
+	{
+		return $this->request_type->isOtherAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isApi()
+	{
+		return $this->request_type->isApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCli()
+	{
+		return $this->request_type->isCli();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCron()
+	{
+		return $this->request_type->isCron();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFeed()
+	{
+		return $this->request_type->isFeed();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontend()
+	{
+		return $this->request_type->isFrontend();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontAjax()
+	{
+		return $this->request_type->isFrontAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isIframe()
+	{
+		return $this->request_type->isIframe();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressApi()
+	{
+		return $this->request_type->isWordPressApi();
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressHeartbeat()
+	{
+		return $this->request_type->isWordPressHeartbeat();
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressScrape()
+	{
+		return $this->request_type->isWordPressScrape();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->request_type->slug();
+	}
 }

core/services/request/RequestInterface.php

Indentation +123 added lines, -123 removed lines

@@ -16,146 +16,146 @@
 interface RequestInterface extends RequestTypeContextCheckerInterface
 {
 
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
-
-    /**
-     * @return array
-     */
-    public function getParams();
-
-
-    /**
-     * @return array
-     */
-    public function postParams();
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams();
-
-
-    /**
-     * @return array
-     */
-    public function serverParams();
-
-
-    /**
-     * @return array
-     */
-    public function filesParams();
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
+
+	/**
+	 * @return array
+	 */
+	public function getParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function filesParams();
 
 
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams();
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams();
 
 
-    /**
-     * @param string $key
-     * @param string $value
-     * @param bool   $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false);
+	/**
+	 * @param string $key
+	 * @param string $value
+	 * @param bool   $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false);
 
 
-    /**
-     * returns the value for a request param if the given key exists
-     *
-     * @param string $key
-     * @param null   $default
-     * @return mixed
-     */
-    public function getRequestParam($key, $default = null);
+	/**
+	 * returns the value for a request param if the given key exists
+	 *
+	 * @param string $key
+	 * @param null   $default
+	 * @return mixed
+	 */
+	public function getRequestParam($key, $default = null);
 
 
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key);
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key);
 
 
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param null|mixed $default
-     * @return false|int
-     */
-    public function getMatch($pattern, $default = null);
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param null|mixed $default
+	 * @return false|int
+	 */
+	public function getMatch($pattern, $default = null);
 
 
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return false|int
-     */
-    public function matches($pattern);
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return false|int
+	 */
+	public function matches($pattern);
 
 
-    /**
-     * remove param
-     *
-     * @param string $key
-     * @param bool   $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false);
+	/**
+	 * remove param
+	 *
+	 * @param string $key
+	 * @param bool   $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false);
 
 
-    /**
-     * @return string
-     */
-    public function ipAddress();
+	/**
+	 * @return string
+	 */
+	public function ipAddress();
 
 
-    /**
-     * @param boolean $relativeToWpRoot whether to return the uri relative to WordPress' home URL, or not.
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false);
-
+	/**
+	 * @param boolean $relativeToWpRoot whether to return the uri relative to WordPress' home URL, or not.
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false);
+
 
-    /**
-     * @return string
-     */
-    public function userAgent();
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '');
-
-
-    /**
-     * @return bool
-     */
-    public function isBot();
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot);
+	/**
+	 * @return string
+	 */
+	public function userAgent();
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '');
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot();
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot);
 }

core/db_classes/EE_Event.class.php

Indentation +1353 added lines, -1353 removed lines

@@ -13,1357 +13,1357 @@
 class EE_Event extends EE_CPT_Base implements EEI_Line_Item_Object, EEI_Admin_Links, EEI_Has_Icon, EEI_Event
 {
 
-    /**
-     * cached value for the the logical active status for the event
-     *
-     * @see get_active_status()
-     * @var string
-     */
-    protected $_active_status = '';
-
-    /**
-     * This is just used for caching the Primary Datetime for the Event on initial retrieval
-     *
-     * @var EE_Datetime
-     */
-    protected $_Primary_Datetime;
-
-    /**
-     * @var EventSpacesCalculator $available_spaces_calculator
-     */
-    protected $available_spaces_calculator;
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Event
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Event
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @return EventSpacesCalculator
-     * @throws \EE_Error
-     */
-    public function getAvailableSpacesCalculator()
-    {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
-            $this->available_spaces_calculator = new EventSpacesCalculator($this);
-        }
-        return $this->available_spaces_calculator;
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'status':
-                $this->set_status($field_value, $use_default);
-                break;
-            default:
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     *    set_status
-     * Checks if event status is being changed to SOLD OUT
-     * and updates event meta data with previous event status
-     * so that we can revert things if/when the event is no longer sold out
-     *
-     * @access public
-     * @param string $new_status
-     * @param bool   $use_default
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_status($new_status = null, $use_default = false)
-    {
-        // if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
-        if (empty($new_status) && ! $use_default) {
-            return;
-        }
-        // get current Event status
-        $old_status = $this->status();
-        // if status has changed
-        if ($old_status !== $new_status) {
-            // TO sold_out
-            if ($new_status === EEM_Event::sold_out) {
-                // save the previous event status so that we can revert if the event is no longer sold out
-                $this->add_post_meta('_previous_event_status', $old_status);
-                do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status);
-                // OR FROM  sold_out
-            } elseif ($old_status === EEM_Event::sold_out) {
-                $this->delete_post_meta('_previous_event_status');
-                do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status);
-            }
-            // clear out the active status so that it gets reset the next time it is requested
-            $this->_active_status = null;
-            // update status
-            parent::set('status', $new_status, $use_default);
-            do_action('AHEE__EE_Event__set_status__after_update', $this);
-            return;
-        }
-        // even though the old value matches the new value, it's still good to
-        // allow the parent set method to have a say
-        parent::set('status', $new_status, $use_default);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes($query_params = array())
-    {
-        return $this->get_many_related('Datetime', $query_params);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
-     *
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes_in_chronological_order()
-    {
-        return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC')));
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
-     * @darren, we should probably UNSET timezone on the EEM_Datetime model
-     * after running our query, so that this timezone isn't set for EVERY query
-     * on EEM_Datetime for the rest of the request, no?
-     *
-     * @param boolean $show_expired whether or not to include expired events
-     * @param boolean $show_deleted whether or not to include deleted events
-     * @param null    $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
-    {
-        return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
-            $this->ID(),
-            $show_expired,
-            $show_deleted,
-            $limit
-        );
-    }
-
-
-    /**
-     * Returns one related datetime. Mostly only used by some legacy code.
-     *
-     * @return EE_Base_Class|EE_Datetime
-     * @throws EE_Error
-     */
-    public function first_datetime()
-    {
-        return $this->get_first_related('Datetime');
-    }
-
-
-    /**
-     * Returns the 'primary' datetime for the event
-     *
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
-    {
-        if (! empty($this->_Primary_Datetime)) {
-            return $this->_Primary_Datetime;
-        }
-        $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
-            $this->ID(),
-            $try_to_exclude_expired,
-            $try_to_exclude_deleted
-        );
-        return $this->_Primary_Datetime;
-    }
-
-
-    /**
-     * Gets all the tickets available for purchase of this event
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function tickets($query_params = array())
-    {
-        // first get all datetimes
-        $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
-            return array();
-        }
-        $datetime_ids = array();
-        foreach ($datetimes as $datetime) {
-            $datetime_ids[] = $datetime->ID();
-        }
-        $where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids));
-        // if incoming $query_params has where conditions let's merge but not override existing.
-        if (is_array($query_params) && isset($query_params[0])) {
-            $where_params = array_merge($query_params[0], $where_params);
-            unset($query_params[0]);
-        }
-        // now add $where_params to $query_params
-        $query_params[0] = $where_params;
-        return EEM_Ticket::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * get all unexpired untrashed tickets
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function active_tickets()
-    {
-        return $this->tickets(
-            array(
-                array(
-                    'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
-                    'TKT_deleted'  => false,
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function additional_limit()
-    {
-        return $this->get('EVT_additional_limit');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function allow_overflow()
-    {
-        return $this->get('EVT_allow_overflow');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function created()
-    {
-        return $this->get('EVT_created');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function description()
-    {
-        return $this->get('EVT_desc');
-    }
-
-
-    /**
-     * Runs do_shortcode and wpautop on the description
-     *
-     * @return string of html
-     * @throws EE_Error
-     */
-    public function description_filtered()
-    {
-        return $this->get_pretty('EVT_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_description()
-    {
-        return $this->get('EVT_display_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_ticket_selector()
-    {
-        return (bool) $this->get('EVT_display_ticket_selector');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function external_url()
-    {
-        return $this->get('EVT_external_URL');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function member_only()
-    {
-        return $this->get('EVT_member_only');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function phone()
-    {
-        return $this->get('EVT_phone');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function modified()
-    {
-        return $this->get('EVT_modified');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        return $this->get('EVT_name');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function order()
-    {
-        return $this->get('EVT_order');
-    }
-
-
-    /**
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function default_registration_status()
-    {
-        $event_default_registration_status = $this->get('EVT_default_registration_status');
-        return ! empty($event_default_registration_status)
-            ? $event_default_registration_status
-            : EE_Registry::instance()->CFG->registration->default_STS_ID;
-    }
-
-
-    /**
-     * @param int  $num_words
-     * @param null $more
-     * @param bool $not_full_desc
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function short_description($num_words = 55, $more = null, $not_full_desc = false)
-    {
-        $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
-            return $short_desc;
-        }
-        $full_desc = $this->get('EVT_desc');
-        return wp_trim_words($full_desc, $num_words, $more);
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function slug()
-    {
-        return $this->get('EVT_slug');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function timezone_string()
-    {
-        return $this->get('EVT_timezone_string');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function visible_on()
-    {
-        return $this->get('EVT_visible_on');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('EVT_wp_user');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function donations()
-    {
-        return $this->get('EVT_donations');
-    }
-
-
-    /**
-     * @param $limit
-     * @throws EE_Error
-     */
-    public function set_additional_limit($limit)
-    {
-        $this->set('EVT_additional_limit', $limit);
-    }
-
-
-    /**
-     * @param $created
-     * @throws EE_Error
-     */
-    public function set_created($created)
-    {
-        $this->set('EVT_created', $created);
-    }
-
-
-    /**
-     * @param $desc
-     * @throws EE_Error
-     */
-    public function set_description($desc)
-    {
-        $this->set('EVT_desc', $desc);
-    }
-
-
-    /**
-     * @param $display_desc
-     * @throws EE_Error
-     */
-    public function set_display_description($display_desc)
-    {
-        $this->set('EVT_display_desc', $display_desc);
-    }
-
-
-    /**
-     * @param $display_ticket_selector
-     * @throws EE_Error
-     */
-    public function set_display_ticket_selector($display_ticket_selector)
-    {
-        $this->set('EVT_display_ticket_selector', $display_ticket_selector);
-    }
-
-
-    /**
-     * @param $external_url
-     * @throws EE_Error
-     */
-    public function set_external_url($external_url)
-    {
-        $this->set('EVT_external_URL', $external_url);
-    }
-
-
-    /**
-     * @param $member_only
-     * @throws EE_Error
-     */
-    public function set_member_only($member_only)
-    {
-        $this->set('EVT_member_only', $member_only);
-    }
-
-
-    /**
-     * @param $event_phone
-     * @throws EE_Error
-     */
-    public function set_event_phone($event_phone)
-    {
-        $this->set('EVT_phone', $event_phone);
-    }
-
-
-    /**
-     * @param $modified
-     * @throws EE_Error
-     */
-    public function set_modified($modified)
-    {
-        $this->set('EVT_modified', $modified);
-    }
-
-
-    /**
-     * @param $name
-     * @throws EE_Error
-     */
-    public function set_name($name)
-    {
-        $this->set('EVT_name', $name);
-    }
-
-
-    /**
-     * @param $order
-     * @throws EE_Error
-     */
-    public function set_order($order)
-    {
-        $this->set('EVT_order', $order);
-    }
-
-
-    /**
-     * @param $short_desc
-     * @throws EE_Error
-     */
-    public function set_short_description($short_desc)
-    {
-        $this->set('EVT_short_desc', $short_desc);
-    }
-
-
-    /**
-     * @param $slug
-     * @throws EE_Error
-     */
-    public function set_slug($slug)
-    {
-        $this->set('EVT_slug', $slug);
-    }
-
-
-    /**
-     * @param $timezone_string
-     * @throws EE_Error
-     */
-    public function set_timezone_string($timezone_string)
-    {
-        $this->set('EVT_timezone_string', $timezone_string);
-    }
-
-
-    /**
-     * @param $visible_on
-     * @throws EE_Error
-     */
-    public function set_visible_on($visible_on)
-    {
-        $this->set('EVT_visible_on', $visible_on);
-    }
-
-
-    /**
-     * @param $wp_user
-     * @throws EE_Error
-     */
-    public function set_wp_user($wp_user)
-    {
-        $this->set('EVT_wp_user', $wp_user);
-    }
-
-
-    /**
-     * @param $default_registration_status
-     * @throws EE_Error
-     */
-    public function set_default_registration_status($default_registration_status)
-    {
-        $this->set('EVT_default_registration_status', $default_registration_status);
-    }
-
-
-    /**
-     * @param $donations
-     * @throws EE_Error
-     */
-    public function set_donations($donations)
-    {
-        $this->set('EVT_donations', $donations);
-    }
-
-
-    /**
-     * Adds a venue to this event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     */
-    public function add_venue($venue_id_or_obj)
-    {
-        return $this->_add_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Removes a venue from the event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     */
-    public function remove_venue($venue_id_or_obj)
-    {
-        return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Gets all the venues related ot the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Venue[]
-     * @throws EE_Error
-     */
-    public function venues($query_params = array())
-    {
-        return $this->get_many_related('Venue', $query_params);
-    }
-
-
-    /**
-     * check if event id is present and if event is published
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     */
-    private function _has_ID_and_is_published()
-    {
-        // first check if event id is present and not NULL,
-        // then check if this event is published (or any of the equivalent "published" statuses)
-        return
-            $this->ID() && $this->ID() !== null
-            && (
-                $this->status() === 'publish'
-                || $this->status() === EEM_Event::sold_out
-                || $this->status() === EEM_Event::postponed
-                || $this->status() === EEM_Event::cancelled
-            );
-    }
-
-
-    /**
-     * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     */
-    public function is_upcoming()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $upcoming = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is active then we return false.
-                if ($datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check upcoming status
-                $upcoming = $datetime->is_upcoming();
-            }
-        }
-        return $upcoming;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_active()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $active = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be active.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is upcoming then we return false.
-                if ($datetime->is_upcoming()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $active = $datetime->is_active();
-            }
-        }
-        return $active;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_expired()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $expired = false;
-        // first let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is upcoming or active then we return false.
-                if ($datetime->is_upcoming() || $datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $expired = $datetime->is_expired();
-            }
-        }
-        return $expired;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_inactive()
-    {
-        // check if event id is present and if this event is published
-        if ($this->_has_ID_and_is_published()) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * calculate spaces remaining based on "saleable" tickets
-     *
-     * @param array $tickets
-     * @param bool  $filtered
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining($tickets = array(), $filtered = true)
-    {
-        $this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
-        $spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
-        return $filtered
-            ? apply_filters(
-                'FHEE_EE_Event__spaces_remaining',
-                $spaces_remaining,
-                $this,
-                $tickets
-            )
-            : $spaces_remaining;
-    }
-
-
-    /**
-     *    perform_sold_out_status_check
-     *    checks all of this events's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
-     *    available... if NOT, then the event status will get toggled to 'sold_out'
-     *
-     * @return bool    return the ACTUAL sold out state.
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function perform_sold_out_status_check()
-    {
-        // get all tickets
-        $tickets = $this->tickets(
-            array(
-                'default_where_conditions' => 'none',
-                'order_by' => array('TKT_qty' => 'ASC'),
-            )
-        );
-        $all_expired = true;
-        foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
-                $all_expired = false;
-                break;
-            }
-        }
-        // if all the tickets are just expired, then don't update the event status to sold out
-        if ($all_expired) {
-            return true;
-        }
-        $spaces_remaining = $this->spaces_remaining($tickets);
-        if ($spaces_remaining < 1) {
-            if ($this->status() !== EEM_Event::post_status_private) {
-                $this->set_status(EEM_Event::sold_out);
-                $this->save();
-            }
-            $sold_out = true;
-        } else {
-            $sold_out = false;
-            // was event previously marked as sold out ?
-            if ($this->status() === EEM_Event::sold_out) {
-                // revert status to previous value, if it was set
-                $previous_event_status = $this->get_post_meta('_previous_event_status', true);
-                if ($previous_event_status) {
-                    $this->set_status($previous_event_status);
-                    $this->save();
-                }
-            }
-        }
-        do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
-        return $sold_out;
-    }
-
-
-    /**
-     * This returns the total remaining spaces for sale on this event.
-     *
-     * @uses EE_Event::total_available_spaces()
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining_for_sale()
-    {
-        return $this->total_available_spaces(true);
-    }
-
-
-    /**
-     * This returns the total spaces available for an event
-     * while considering all the qtys on the tickets and the reg limits
-     * on the datetimes attached to this event.
-     *
-     * @param   bool $consider_sold Whether to consider any tickets that have already sold in our calculation.
-     *                              If this is false, then we return the most tickets that could ever be sold
-     *                              for this event with the datetime and tickets setup on the event under optimal
-     *                              selling conditions.  Otherwise we return a live calculation of spaces available
-     *                              based on tickets sold.  Depending on setup and stage of sales, this
-     *                              may appear to equal remaining tickets.  However, the more tickets are
-     *                              sold out, the more accurate the "live" total is.
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function total_available_spaces($consider_sold = false)
-    {
-        $spaces_available = $consider_sold
-            ? $this->getAvailableSpacesCalculator()->spacesRemaining()
-            : $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
-        return apply_filters(
-            'FHEE_EE_Event__total_available_spaces__spaces_available',
-            $spaces_available,
-            $this,
-            $this->getAvailableSpacesCalculator()->getDatetimes(),
-            $this->getAvailableSpacesCalculator()->getActiveTickets()
-        );
-    }
-
-
-    /**
-     * Checks if the event is set to sold out
-     *
-     * @param  bool $actual whether or not to perform calculations to not only figure the
-     *                      actual status but also to flip the status if necessary to sold
-     *                      out If false, we just check the existing status of the event
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_sold_out($actual = false)
-    {
-        if (! $actual) {
-            return $this->status() === EEM_Event::sold_out;
-        }
-        return $this->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * Checks if the event is marked as postponed
-     *
-     * @return boolean
-     */
-    public function is_postponed()
-    {
-        return $this->status() === EEM_Event::postponed;
-    }
-
-
-    /**
-     * Checks if the event is marked as cancelled
-     *
-     * @return boolean
-     */
-    public function is_cancelled()
-    {
-        return $this->status() === EEM_Event::cancelled;
-    }
-
-
-    /**
-     * Get the logical active status in a hierarchical order for all the datetimes.  Note
-     * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
-     * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
-     * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
-     * the event is considered expired.
-     * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
-     * status set on the EVENT when it is not published and thus is done
-     *
-     * @param bool $reset
-     * @return bool | string - based on EE_Datetime active constants or FALSE if error.
-     * @throws EE_Error
-     */
-    public function get_active_status($reset = false)
-    {
-        // if the active status has already been set, then just use that value (unless we are resetting it)
-        if (! empty($this->_active_status) && ! $reset) {
-            return $this->_active_status;
-        }
-        // first check if event id is present on this object
-        if (! $this->ID()) {
-            return false;
-        }
-        $where_params_for_event = array(array('EVT_ID' => $this->ID()));
-        // if event is published:
-        if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
-            // active?
-            if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                EE_Datetime::active,
-                $where_params_for_event
-            ) > 0) {
-                $this->_active_status = EE_Datetime::active;
-            } else {
-                // upcoming?
-                if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                    EE_Datetime::upcoming,
-                    $where_params_for_event
-                ) > 0) {
-                    $this->_active_status = EE_Datetime::upcoming;
-                } else {
-                    // expired?
-                    if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                        EE_Datetime::expired,
-                        $where_params_for_event
-                    ) > 0
-                    ) {
-                        $this->_active_status = EE_Datetime::expired;
-                    } else {
-                        // it would be odd if things make it this far because it basically means there are no datetime's
-                        // attached to the event.  So in this case it will just be considered inactive.
-                        $this->_active_status = EE_Datetime::inactive;
-                    }
-                }
-            }
-        } else {
-            // the event is not published, so let's just set it's active status according to its' post status
-            switch ($this->status()) {
-                case EEM_Event::sold_out:
-                    $this->_active_status = EE_Datetime::sold_out;
-                    break;
-                case EEM_Event::cancelled:
-                    $this->_active_status = EE_Datetime::cancelled;
-                    break;
-                case EEM_Event::postponed:
-                    $this->_active_status = EE_Datetime::postponed;
-                    break;
-                default:
-                    $this->_active_status = EE_Datetime::inactive;
-            }
-        }
-        return $this->_active_status;
-    }
-
-
-    /**
-     *    pretty_active_status
-     *
-     * @access public
-     * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
-     * @return mixed void|string
-     * @throws EE_Error
-     */
-    public function pretty_active_status($echo = true)
-    {
-        $active_status = $this->get_active_status();
-        $status = '<span class="ee-status event-active-status-'
-                  . $active_status
-                  . '">'
-                  . EEH_Template::pretty_status($active_status, false, 'sentence')
-                  . '</span>';
-        if ($echo) {
-            echo $status;
-            return '';
-        }
-        return $status;
-    }
-
-
-    /**
-     * @return bool|int
-     * @throws EE_Error
-     */
-    public function get_number_of_tickets_sold()
-    {
-        $tkt_sold = 0;
-        if (! $this->ID()) {
-            return 0;
-        }
-        $datetimes = $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $tkt_sold += $datetime->sold();
-            }
-        }
-        return $tkt_sold;
-    }
-
-
-    /**
-     * This just returns a count of all the registrations for this event
-     *
-     * @access  public
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_count_of_all_registrations()
-    {
-        return EEM_Event::instance()->count_related($this, 'Registration');
-    }
-
-
-    /**
-     * This returns the ticket with the earliest start time that is
-     * available for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     */
-    public function get_ticket_with_earliest_start_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC'));
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the ticket with the latest end time that is available
-     * for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     */
-    public function get_ticket_with_latest_end_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC'));
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the number of different ticket types currently on sale for this event.
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function countTicketsOnSale()
-    {
-        $where = array(
-            'Datetime.EVT_ID' => $this->ID(),
-            'TKT_start_date'  => array('<', time()),
-            'TKT_end_date'    => array('>', time()),
-        );
-        return EEM_Ticket::instance()->count(array($where));
-    }
-
-
-    /**
-     * This returns whether there are any tickets on sale for this event.
-     *
-     * @return bool true = YES tickets on sale.
-     * @throws EE_Error
-     */
-    public function tickets_on_sale()
-    {
-        return $this->countTicketsOnSale() > 0;
-    }
-
-
-    /**
-     * Gets the URL for viewing this event on the front-end. Overrides parent
-     * to check for an external URL first
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_permalink()
-    {
-        if ($this->external_url()) {
-            return $this->external_url();
-        }
-        return parent::get_permalink();
-    }
-
-
-    /**
-     * Gets the first term for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class|EE_Term|null
-     * @throws EE_Error
-     */
-    public function first_event_category($query_params = array())
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_one($query_params);
-    }
-
-
-    /**
-     * Gets all terms for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Term[]
-     * @throws EE_Error
-     */
-    public function get_all_event_categories($query_params = array())
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Adds a question group to this event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool                  $for_primary if true, the question group will be added for the primary
-     *                                           registrant, if false will be added for others. default: false
-     * @return EE_Base_Class|EE_Question_Group
-     * @throws EE_Error
-     */
-    public function add_question_group($question_group_id_or_obj, $for_primary = false)
-    {
-        $extra = $for_primary
-            ? array('EQG_primary' => 1)
-            : array();
-        return $this->_add_relation_to($question_group_id_or_obj, 'Question_Group', $extra);
-    }
-
-
-    /**
-     * Removes a question group from the event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool                  $for_primary if true, the question group will be removed from the primary
-     *                                           registrant, if false will be removed from others. default: false
-     * @return EE_Base_Class|EE_Question_Group
-     * @throws EE_Error
-     */
-    public function remove_question_group($question_group_id_or_obj, $for_primary = false)
-    {
-        $where = $for_primary
-            ? array('EQG_primary' => 1)
-            : array();
-        return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group', $where);
-    }
-
-
-    /**
-     * Gets all the question groups, ordering them by QSG_order ascending
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Question_Group[]
-     * @throws EE_Error
-     */
-    public function question_groups($query_params = array())
-    {
-        $query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
-        return $this->get_many_related('Question_Group', $query_params);
-    }
-
-
-    /**
-     * Implementation for EEI_Has_Icon interface method.
-     *
-     * @see EEI_Visual_Representation for comments
-     * @return string
-     */
-    public function get_icon()
-    {
-        return '<span class="dashicons dashicons-flag"></span>';
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_edit_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'edit',
-                'post'   => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'default_event_settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'default',
-            ),
-            admin_url('admin.php')
-        );
-    }
+	/**
+	 * cached value for the the logical active status for the event
+	 *
+	 * @see get_active_status()
+	 * @var string
+	 */
+	protected $_active_status = '';
+
+	/**
+	 * This is just used for caching the Primary Datetime for the Event on initial retrieval
+	 *
+	 * @var EE_Datetime
+	 */
+	protected $_Primary_Datetime;
+
+	/**
+	 * @var EventSpacesCalculator $available_spaces_calculator
+	 */
+	protected $available_spaces_calculator;
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Event
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Event
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @return EventSpacesCalculator
+	 * @throws \EE_Error
+	 */
+	public function getAvailableSpacesCalculator()
+	{
+		if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+			$this->available_spaces_calculator = new EventSpacesCalculator($this);
+		}
+		return $this->available_spaces_calculator;
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'status':
+				$this->set_status($field_value, $use_default);
+				break;
+			default:
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 *    set_status
+	 * Checks if event status is being changed to SOLD OUT
+	 * and updates event meta data with previous event status
+	 * so that we can revert things if/when the event is no longer sold out
+	 *
+	 * @access public
+	 * @param string $new_status
+	 * @param bool   $use_default
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_status($new_status = null, $use_default = false)
+	{
+		// if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
+		if (empty($new_status) && ! $use_default) {
+			return;
+		}
+		// get current Event status
+		$old_status = $this->status();
+		// if status has changed
+		if ($old_status !== $new_status) {
+			// TO sold_out
+			if ($new_status === EEM_Event::sold_out) {
+				// save the previous event status so that we can revert if the event is no longer sold out
+				$this->add_post_meta('_previous_event_status', $old_status);
+				do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status);
+				// OR FROM  sold_out
+			} elseif ($old_status === EEM_Event::sold_out) {
+				$this->delete_post_meta('_previous_event_status');
+				do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status);
+			}
+			// clear out the active status so that it gets reset the next time it is requested
+			$this->_active_status = null;
+			// update status
+			parent::set('status', $new_status, $use_default);
+			do_action('AHEE__EE_Event__set_status__after_update', $this);
+			return;
+		}
+		// even though the old value matches the new value, it's still good to
+		// allow the parent set method to have a say
+		parent::set('status', $new_status, $use_default);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes($query_params = array())
+	{
+		return $this->get_many_related('Datetime', $query_params);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
+	 *
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes_in_chronological_order()
+	{
+		return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC')));
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
+	 * @darren, we should probably UNSET timezone on the EEM_Datetime model
+	 * after running our query, so that this timezone isn't set for EVERY query
+	 * on EEM_Datetime for the rest of the request, no?
+	 *
+	 * @param boolean $show_expired whether or not to include expired events
+	 * @param boolean $show_deleted whether or not to include deleted events
+	 * @param null    $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
+	{
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
+			$this->ID(),
+			$show_expired,
+			$show_deleted,
+			$limit
+		);
+	}
+
+
+	/**
+	 * Returns one related datetime. Mostly only used by some legacy code.
+	 *
+	 * @return EE_Base_Class|EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function first_datetime()
+	{
+		return $this->get_first_related('Datetime');
+	}
+
+
+	/**
+	 * Returns the 'primary' datetime for the event
+	 *
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
+	{
+		if (! empty($this->_Primary_Datetime)) {
+			return $this->_Primary_Datetime;
+		}
+		$this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
+			$this->ID(),
+			$try_to_exclude_expired,
+			$try_to_exclude_deleted
+		);
+		return $this->_Primary_Datetime;
+	}
+
+
+	/**
+	 * Gets all the tickets available for purchase of this event
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function tickets($query_params = array())
+	{
+		// first get all datetimes
+		$datetimes = $this->datetimes_ordered();
+		if (! $datetimes) {
+			return array();
+		}
+		$datetime_ids = array();
+		foreach ($datetimes as $datetime) {
+			$datetime_ids[] = $datetime->ID();
+		}
+		$where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids));
+		// if incoming $query_params has where conditions let's merge but not override existing.
+		if (is_array($query_params) && isset($query_params[0])) {
+			$where_params = array_merge($query_params[0], $where_params);
+			unset($query_params[0]);
+		}
+		// now add $where_params to $query_params
+		$query_params[0] = $where_params;
+		return EEM_Ticket::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * get all unexpired untrashed tickets
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function active_tickets()
+	{
+		return $this->tickets(
+			array(
+				array(
+					'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
+					'TKT_deleted'  => false,
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function additional_limit()
+	{
+		return $this->get('EVT_additional_limit');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function allow_overflow()
+	{
+		return $this->get('EVT_allow_overflow');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function created()
+	{
+		return $this->get('EVT_created');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function description()
+	{
+		return $this->get('EVT_desc');
+	}
+
+
+	/**
+	 * Runs do_shortcode and wpautop on the description
+	 *
+	 * @return string of html
+	 * @throws EE_Error
+	 */
+	public function description_filtered()
+	{
+		return $this->get_pretty('EVT_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_description()
+	{
+		return $this->get('EVT_display_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_ticket_selector()
+	{
+		return (bool) $this->get('EVT_display_ticket_selector');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function external_url()
+	{
+		return $this->get('EVT_external_URL');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function member_only()
+	{
+		return $this->get('EVT_member_only');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function phone()
+	{
+		return $this->get('EVT_phone');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function modified()
+	{
+		return $this->get('EVT_modified');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('EVT_name');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function order()
+	{
+		return $this->get('EVT_order');
+	}
+
+
+	/**
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function default_registration_status()
+	{
+		$event_default_registration_status = $this->get('EVT_default_registration_status');
+		return ! empty($event_default_registration_status)
+			? $event_default_registration_status
+			: EE_Registry::instance()->CFG->registration->default_STS_ID;
+	}
+
+
+	/**
+	 * @param int  $num_words
+	 * @param null $more
+	 * @param bool $not_full_desc
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function short_description($num_words = 55, $more = null, $not_full_desc = false)
+	{
+		$short_desc = $this->get('EVT_short_desc');
+		if (! empty($short_desc) || $not_full_desc) {
+			return $short_desc;
+		}
+		$full_desc = $this->get('EVT_desc');
+		return wp_trim_words($full_desc, $num_words, $more);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function slug()
+	{
+		return $this->get('EVT_slug');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function timezone_string()
+	{
+		return $this->get('EVT_timezone_string');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function visible_on()
+	{
+		return $this->get('EVT_visible_on');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('EVT_wp_user');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function donations()
+	{
+		return $this->get('EVT_donations');
+	}
+
+
+	/**
+	 * @param $limit
+	 * @throws EE_Error
+	 */
+	public function set_additional_limit($limit)
+	{
+		$this->set('EVT_additional_limit', $limit);
+	}
+
+
+	/**
+	 * @param $created
+	 * @throws EE_Error
+	 */
+	public function set_created($created)
+	{
+		$this->set('EVT_created', $created);
+	}
+
+
+	/**
+	 * @param $desc
+	 * @throws EE_Error
+	 */
+	public function set_description($desc)
+	{
+		$this->set('EVT_desc', $desc);
+	}
+
+
+	/**
+	 * @param $display_desc
+	 * @throws EE_Error
+	 */
+	public function set_display_description($display_desc)
+	{
+		$this->set('EVT_display_desc', $display_desc);
+	}
+
+
+	/**
+	 * @param $display_ticket_selector
+	 * @throws EE_Error
+	 */
+	public function set_display_ticket_selector($display_ticket_selector)
+	{
+		$this->set('EVT_display_ticket_selector', $display_ticket_selector);
+	}
+
+
+	/**
+	 * @param $external_url
+	 * @throws EE_Error
+	 */
+	public function set_external_url($external_url)
+	{
+		$this->set('EVT_external_URL', $external_url);
+	}
+
+
+	/**
+	 * @param $member_only
+	 * @throws EE_Error
+	 */
+	public function set_member_only($member_only)
+	{
+		$this->set('EVT_member_only', $member_only);
+	}
+
+
+	/**
+	 * @param $event_phone
+	 * @throws EE_Error
+	 */
+	public function set_event_phone($event_phone)
+	{
+		$this->set('EVT_phone', $event_phone);
+	}
+
+
+	/**
+	 * @param $modified
+	 * @throws EE_Error
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('EVT_modified', $modified);
+	}
+
+
+	/**
+	 * @param $name
+	 * @throws EE_Error
+	 */
+	public function set_name($name)
+	{
+		$this->set('EVT_name', $name);
+	}
+
+
+	/**
+	 * @param $order
+	 * @throws EE_Error
+	 */
+	public function set_order($order)
+	{
+		$this->set('EVT_order', $order);
+	}
+
+
+	/**
+	 * @param $short_desc
+	 * @throws EE_Error
+	 */
+	public function set_short_description($short_desc)
+	{
+		$this->set('EVT_short_desc', $short_desc);
+	}
+
+
+	/**
+	 * @param $slug
+	 * @throws EE_Error
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('EVT_slug', $slug);
+	}
+
+
+	/**
+	 * @param $timezone_string
+	 * @throws EE_Error
+	 */
+	public function set_timezone_string($timezone_string)
+	{
+		$this->set('EVT_timezone_string', $timezone_string);
+	}
+
+
+	/**
+	 * @param $visible_on
+	 * @throws EE_Error
+	 */
+	public function set_visible_on($visible_on)
+	{
+		$this->set('EVT_visible_on', $visible_on);
+	}
+
+
+	/**
+	 * @param $wp_user
+	 * @throws EE_Error
+	 */
+	public function set_wp_user($wp_user)
+	{
+		$this->set('EVT_wp_user', $wp_user);
+	}
+
+
+	/**
+	 * @param $default_registration_status
+	 * @throws EE_Error
+	 */
+	public function set_default_registration_status($default_registration_status)
+	{
+		$this->set('EVT_default_registration_status', $default_registration_status);
+	}
+
+
+	/**
+	 * @param $donations
+	 * @throws EE_Error
+	 */
+	public function set_donations($donations)
+	{
+		$this->set('EVT_donations', $donations);
+	}
+
+
+	/**
+	 * Adds a venue to this event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 */
+	public function add_venue($venue_id_or_obj)
+	{
+		return $this->_add_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Removes a venue from the event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 */
+	public function remove_venue($venue_id_or_obj)
+	{
+		return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Gets all the venues related ot the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Venue[]
+	 * @throws EE_Error
+	 */
+	public function venues($query_params = array())
+	{
+		return $this->get_many_related('Venue', $query_params);
+	}
+
+
+	/**
+	 * check if event id is present and if event is published
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 */
+	private function _has_ID_and_is_published()
+	{
+		// first check if event id is present and not NULL,
+		// then check if this event is published (or any of the equivalent "published" statuses)
+		return
+			$this->ID() && $this->ID() !== null
+			&& (
+				$this->status() === 'publish'
+				|| $this->status() === EEM_Event::sold_out
+				|| $this->status() === EEM_Event::postponed
+				|| $this->status() === EEM_Event::cancelled
+			);
+	}
+
+
+	/**
+	 * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 */
+	public function is_upcoming()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$upcoming = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is active then we return false.
+				if ($datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check upcoming status
+				$upcoming = $datetime->is_upcoming();
+			}
+		}
+		return $upcoming;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_active()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$active = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be active.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is upcoming then we return false.
+				if ($datetime->is_upcoming()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$active = $datetime->is_active();
+			}
+		}
+		return $active;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_expired()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$expired = false;
+		// first let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is upcoming or active then we return false.
+				if ($datetime->is_upcoming() || $datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$expired = $datetime->is_expired();
+			}
+		}
+		return $expired;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_inactive()
+	{
+		// check if event id is present and if this event is published
+		if ($this->_has_ID_and_is_published()) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * calculate spaces remaining based on "saleable" tickets
+	 *
+	 * @param array $tickets
+	 * @param bool  $filtered
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining($tickets = array(), $filtered = true)
+	{
+		$this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
+		$spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
+		return $filtered
+			? apply_filters(
+				'FHEE_EE_Event__spaces_remaining',
+				$spaces_remaining,
+				$this,
+				$tickets
+			)
+			: $spaces_remaining;
+	}
+
+
+	/**
+	 *    perform_sold_out_status_check
+	 *    checks all of this events's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
+	 *    available... if NOT, then the event status will get toggled to 'sold_out'
+	 *
+	 * @return bool    return the ACTUAL sold out state.
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function perform_sold_out_status_check()
+	{
+		// get all tickets
+		$tickets = $this->tickets(
+			array(
+				'default_where_conditions' => 'none',
+				'order_by' => array('TKT_qty' => 'ASC'),
+			)
+		);
+		$all_expired = true;
+		foreach ($tickets as $ticket) {
+			if (! $ticket->is_expired()) {
+				$all_expired = false;
+				break;
+			}
+		}
+		// if all the tickets are just expired, then don't update the event status to sold out
+		if ($all_expired) {
+			return true;
+		}
+		$spaces_remaining = $this->spaces_remaining($tickets);
+		if ($spaces_remaining < 1) {
+			if ($this->status() !== EEM_Event::post_status_private) {
+				$this->set_status(EEM_Event::sold_out);
+				$this->save();
+			}
+			$sold_out = true;
+		} else {
+			$sold_out = false;
+			// was event previously marked as sold out ?
+			if ($this->status() === EEM_Event::sold_out) {
+				// revert status to previous value, if it was set
+				$previous_event_status = $this->get_post_meta('_previous_event_status', true);
+				if ($previous_event_status) {
+					$this->set_status($previous_event_status);
+					$this->save();
+				}
+			}
+		}
+		do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
+		return $sold_out;
+	}
+
+
+	/**
+	 * This returns the total remaining spaces for sale on this event.
+	 *
+	 * @uses EE_Event::total_available_spaces()
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining_for_sale()
+	{
+		return $this->total_available_spaces(true);
+	}
+
+
+	/**
+	 * This returns the total spaces available for an event
+	 * while considering all the qtys on the tickets and the reg limits
+	 * on the datetimes attached to this event.
+	 *
+	 * @param   bool $consider_sold Whether to consider any tickets that have already sold in our calculation.
+	 *                              If this is false, then we return the most tickets that could ever be sold
+	 *                              for this event with the datetime and tickets setup on the event under optimal
+	 *                              selling conditions.  Otherwise we return a live calculation of spaces available
+	 *                              based on tickets sold.  Depending on setup and stage of sales, this
+	 *                              may appear to equal remaining tickets.  However, the more tickets are
+	 *                              sold out, the more accurate the "live" total is.
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function total_available_spaces($consider_sold = false)
+	{
+		$spaces_available = $consider_sold
+			? $this->getAvailableSpacesCalculator()->spacesRemaining()
+			: $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
+		return apply_filters(
+			'FHEE_EE_Event__total_available_spaces__spaces_available',
+			$spaces_available,
+			$this,
+			$this->getAvailableSpacesCalculator()->getDatetimes(),
+			$this->getAvailableSpacesCalculator()->getActiveTickets()
+		);
+	}
+
+
+	/**
+	 * Checks if the event is set to sold out
+	 *
+	 * @param  bool $actual whether or not to perform calculations to not only figure the
+	 *                      actual status but also to flip the status if necessary to sold
+	 *                      out If false, we just check the existing status of the event
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_sold_out($actual = false)
+	{
+		if (! $actual) {
+			return $this->status() === EEM_Event::sold_out;
+		}
+		return $this->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * Checks if the event is marked as postponed
+	 *
+	 * @return boolean
+	 */
+	public function is_postponed()
+	{
+		return $this->status() === EEM_Event::postponed;
+	}
+
+
+	/**
+	 * Checks if the event is marked as cancelled
+	 *
+	 * @return boolean
+	 */
+	public function is_cancelled()
+	{
+		return $this->status() === EEM_Event::cancelled;
+	}
+
+
+	/**
+	 * Get the logical active status in a hierarchical order for all the datetimes.  Note
+	 * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
+	 * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
+	 * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
+	 * the event is considered expired.
+	 * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
+	 * status set on the EVENT when it is not published and thus is done
+	 *
+	 * @param bool $reset
+	 * @return bool | string - based on EE_Datetime active constants or FALSE if error.
+	 * @throws EE_Error
+	 */
+	public function get_active_status($reset = false)
+	{
+		// if the active status has already been set, then just use that value (unless we are resetting it)
+		if (! empty($this->_active_status) && ! $reset) {
+			return $this->_active_status;
+		}
+		// first check if event id is present on this object
+		if (! $this->ID()) {
+			return false;
+		}
+		$where_params_for_event = array(array('EVT_ID' => $this->ID()));
+		// if event is published:
+		if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
+			// active?
+			if (EEM_Datetime::instance()->get_datetime_count_for_status(
+				EE_Datetime::active,
+				$where_params_for_event
+			) > 0) {
+				$this->_active_status = EE_Datetime::active;
+			} else {
+				// upcoming?
+				if (EEM_Datetime::instance()->get_datetime_count_for_status(
+					EE_Datetime::upcoming,
+					$where_params_for_event
+				) > 0) {
+					$this->_active_status = EE_Datetime::upcoming;
+				} else {
+					// expired?
+					if (EEM_Datetime::instance()->get_datetime_count_for_status(
+						EE_Datetime::expired,
+						$where_params_for_event
+					) > 0
+					) {
+						$this->_active_status = EE_Datetime::expired;
+					} else {
+						// it would be odd if things make it this far because it basically means there are no datetime's
+						// attached to the event.  So in this case it will just be considered inactive.
+						$this->_active_status = EE_Datetime::inactive;
+					}
+				}
+			}
+		} else {
+			// the event is not published, so let's just set it's active status according to its' post status
+			switch ($this->status()) {
+				case EEM_Event::sold_out:
+					$this->_active_status = EE_Datetime::sold_out;
+					break;
+				case EEM_Event::cancelled:
+					$this->_active_status = EE_Datetime::cancelled;
+					break;
+				case EEM_Event::postponed:
+					$this->_active_status = EE_Datetime::postponed;
+					break;
+				default:
+					$this->_active_status = EE_Datetime::inactive;
+			}
+		}
+		return $this->_active_status;
+	}
+
+
+	/**
+	 *    pretty_active_status
+	 *
+	 * @access public
+	 * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
+	 * @return mixed void|string
+	 * @throws EE_Error
+	 */
+	public function pretty_active_status($echo = true)
+	{
+		$active_status = $this->get_active_status();
+		$status = '<span class="ee-status event-active-status-'
+				  . $active_status
+				  . '">'
+				  . EEH_Template::pretty_status($active_status, false, 'sentence')
+				  . '</span>';
+		if ($echo) {
+			echo $status;
+			return '';
+		}
+		return $status;
+	}
+
+
+	/**
+	 * @return bool|int
+	 * @throws EE_Error
+	 */
+	public function get_number_of_tickets_sold()
+	{
+		$tkt_sold = 0;
+		if (! $this->ID()) {
+			return 0;
+		}
+		$datetimes = $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$tkt_sold += $datetime->sold();
+			}
+		}
+		return $tkt_sold;
+	}
+
+
+	/**
+	 * This just returns a count of all the registrations for this event
+	 *
+	 * @access  public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_count_of_all_registrations()
+	{
+		return EEM_Event::instance()->count_related($this, 'Registration');
+	}
+
+
+	/**
+	 * This returns the ticket with the earliest start time that is
+	 * available for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 */
+	public function get_ticket_with_earliest_start_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC'));
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the ticket with the latest end time that is available
+	 * for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 */
+	public function get_ticket_with_latest_end_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC'));
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the number of different ticket types currently on sale for this event.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function countTicketsOnSale()
+	{
+		$where = array(
+			'Datetime.EVT_ID' => $this->ID(),
+			'TKT_start_date'  => array('<', time()),
+			'TKT_end_date'    => array('>', time()),
+		);
+		return EEM_Ticket::instance()->count(array($where));
+	}
+
+
+	/**
+	 * This returns whether there are any tickets on sale for this event.
+	 *
+	 * @return bool true = YES tickets on sale.
+	 * @throws EE_Error
+	 */
+	public function tickets_on_sale()
+	{
+		return $this->countTicketsOnSale() > 0;
+	}
+
+
+	/**
+	 * Gets the URL for viewing this event on the front-end. Overrides parent
+	 * to check for an external URL first
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_permalink()
+	{
+		if ($this->external_url()) {
+			return $this->external_url();
+		}
+		return parent::get_permalink();
+	}
+
+
+	/**
+	 * Gets the first term for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class|EE_Term|null
+	 * @throws EE_Error
+	 */
+	public function first_event_category($query_params = array())
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_one($query_params);
+	}
+
+
+	/**
+	 * Gets all terms for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Term[]
+	 * @throws EE_Error
+	 */
+	public function get_all_event_categories($query_params = array())
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Adds a question group to this event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool                  $for_primary if true, the question group will be added for the primary
+	 *                                           registrant, if false will be added for others. default: false
+	 * @return EE_Base_Class|EE_Question_Group
+	 * @throws EE_Error
+	 */
+	public function add_question_group($question_group_id_or_obj, $for_primary = false)
+	{
+		$extra = $for_primary
+			? array('EQG_primary' => 1)
+			: array();
+		return $this->_add_relation_to($question_group_id_or_obj, 'Question_Group', $extra);
+	}
+
+
+	/**
+	 * Removes a question group from the event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool                  $for_primary if true, the question group will be removed from the primary
+	 *                                           registrant, if false will be removed from others. default: false
+	 * @return EE_Base_Class|EE_Question_Group
+	 * @throws EE_Error
+	 */
+	public function remove_question_group($question_group_id_or_obj, $for_primary = false)
+	{
+		$where = $for_primary
+			? array('EQG_primary' => 1)
+			: array();
+		return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group', $where);
+	}
+
+
+	/**
+	 * Gets all the question groups, ordering them by QSG_order ascending
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Question_Group[]
+	 * @throws EE_Error
+	 */
+	public function question_groups($query_params = array())
+	{
+		$query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
+		return $this->get_many_related('Question_Group', $query_params);
+	}
+
+
+	/**
+	 * Implementation for EEI_Has_Icon interface method.
+	 *
+	 * @see EEI_Visual_Representation for comments
+	 * @return string
+	 */
+	public function get_icon()
+	{
+		return '<span class="dashicons dashicons-flag"></span>';
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_edit_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'edit',
+				'post'   => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'default_event_settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'default',
+			),
+			admin_url('admin.php')
+		);
+	}
 }

core/libraries/shortcodes/EE_Organization_Shortcodes.lib.php

Indentation +135 added lines, -135 removed lines

@@ -19,139 +19,139 @@
 {
 
 
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Organization Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to organization related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[COMPANY]'          => esc_html__('Event organization name', 'event_espresso'),
-            '[CO_ADD1]'          => esc_html__('Address 1 value for the organization', 'event_espresso'),
-            '[CO_ADD2]'          => esc_html__('Address 2 value for the organization', 'event_espresso'),
-            '[CO_CITY]'          => esc_html__('City the organization is in', 'event_espresso'),
-            '[CO_STATE]'         => esc_html__('State the organization is located in', 'event_espresso'),
-            '[CO_ZIP]'           => esc_html__('The zip code for the organization', 'event_espresso'),
-            '[CO_LOGO]'          => esc_html__('The logo image for the organization', 'event_espresso'),
-            '[CO_EMAIL]'         => esc_html__('The primary email address for the organization', 'event_espresso'),
-            '[CO_PHONE]'         => esc_html__('The phone number for the organization', 'event_espresso'),
-            '[CO_LOGO_URL]'      => esc_html__(
-                'Just the link to the image used as the logo for the organization',
-                'event_espresso'
-            ),
-            '[CO_FACEBOOK_URL]'  => esc_html__('Link to organization Facebook page', 'event_espresso'),
-            '[CO_TWITTER_URL]'   => esc_html__('Link to organization Twitter page', 'event_espresso'),
-            '[CO_PINTEREST_URL]' => esc_html__('Link to organization Pinterest page', 'event_espresso'),
-            '[CO_GOOGLE_URL]'    => esc_html__('Link to organization Google page', 'event_espresso'),
-            '[CO_LINKEDIN_URL]'  => esc_html__('Link to organization LinkedIn page', 'event_espresso'),
-            '[CO_INSTAGRAM_URL]' => esc_html__('Link to organization Instagram page', 'event_espresso'),
-            '[CO_TAX_NUMBER_*]'  => sprintf(
-                esc_html__(
-                    'This is the shortcode used for displaying any tax number for the company.  %1$sNote: This is a special dynamic shortcode.%2$s You can use the "prefix" parameter to indicate what the prefix for this tax number is.  It defaults to "VAT/Tax Number:".  To change this prefix you do the following format for this shortcode:  [CO_TAX_NUMBER_* prefix="GST: "] and that will output: GST: 12345t56.  Also take note that if you have NO number in your settings, the prefix is not output either.',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>'
-            ),
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-
-        switch ($shortcode) {
-            case '[COMPANY]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('name');
-                break;
-
-            case '[CO_ADD1]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('address_1');
-                break;
-
-            case '[CO_ADD2]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('address_2');
-                break;
-
-            case '[CO_CITY]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('city');
-                break;
-
-            case '[CO_STATE]':
-                $state = EE_Registry::instance()->load_model('State')->get_one_by_ID(
-                    EE_Registry::instance()->CFG->organization->STA_ID
-                );
-                return $state instanceof EE_State ? $state->name() : '';
-                break;
-
-            case '[CO_ZIP]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('zip');
-                break;
-
-            case '[CO_EMAIL]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('email');
-                break;
-
-            case '[CO_PHONE]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('phone');
-                break;
-
-            case '[CO_LOGO]':
-                return '<img src="'
-                       . EE_Registry::instance()->CFG->organization->get_pretty(
-                           'logo_url'
-                       ) . '" id="headerImage" />';
-                break;
-
-            case '[CO_LOGO_URL]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('logo_url');
-                break;
-
-            case '[CO_FACEBOOK_URL]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('facebook');
-                break;
-
-            case '[CO_TWITTER_URL]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('twitter');
-                break;
-
-            case '[CO_PINTEREST_URL]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('pinterest');
-                break;
-
-            case '[CO_LINKEDIN_URL]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('linkedin');
-                break;
-
-            case '[CO_GOOGLE_URL]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('google');
-                break;
-
-            case '[CO_INSTAGRAM_URL]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('instagram');
-                break;
-        }
-
-        // also allow for parameter shortcode
-        if (strpos($shortcode, '[CO_TAX_NUMBER_*') !== false) {
-            // first see if there is any company tax number set and bail early if not
-            $tax_number = EE_Registry::instance()->CFG->organization->vat;
-            if (empty($tax_number)) {
-                return '';
-            }
-
-            // see if there are any attributes.
-            $attrs = $this->_get_shortcode_attrs($shortcode);
-
-            // set custom attrs if present (or default)
-            $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
-            return $prefix . $tax_number;
-        }
-
-        return '';
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Organization Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to organization related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[COMPANY]'          => esc_html__('Event organization name', 'event_espresso'),
+			'[CO_ADD1]'          => esc_html__('Address 1 value for the organization', 'event_espresso'),
+			'[CO_ADD2]'          => esc_html__('Address 2 value for the organization', 'event_espresso'),
+			'[CO_CITY]'          => esc_html__('City the organization is in', 'event_espresso'),
+			'[CO_STATE]'         => esc_html__('State the organization is located in', 'event_espresso'),
+			'[CO_ZIP]'           => esc_html__('The zip code for the organization', 'event_espresso'),
+			'[CO_LOGO]'          => esc_html__('The logo image for the organization', 'event_espresso'),
+			'[CO_EMAIL]'         => esc_html__('The primary email address for the organization', 'event_espresso'),
+			'[CO_PHONE]'         => esc_html__('The phone number for the organization', 'event_espresso'),
+			'[CO_LOGO_URL]'      => esc_html__(
+				'Just the link to the image used as the logo for the organization',
+				'event_espresso'
+			),
+			'[CO_FACEBOOK_URL]'  => esc_html__('Link to organization Facebook page', 'event_espresso'),
+			'[CO_TWITTER_URL]'   => esc_html__('Link to organization Twitter page', 'event_espresso'),
+			'[CO_PINTEREST_URL]' => esc_html__('Link to organization Pinterest page', 'event_espresso'),
+			'[CO_GOOGLE_URL]'    => esc_html__('Link to organization Google page', 'event_espresso'),
+			'[CO_LINKEDIN_URL]'  => esc_html__('Link to organization LinkedIn page', 'event_espresso'),
+			'[CO_INSTAGRAM_URL]' => esc_html__('Link to organization Instagram page', 'event_espresso'),
+			'[CO_TAX_NUMBER_*]'  => sprintf(
+				esc_html__(
+					'This is the shortcode used for displaying any tax number for the company.  %1$sNote: This is a special dynamic shortcode.%2$s You can use the "prefix" parameter to indicate what the prefix for this tax number is.  It defaults to "VAT/Tax Number:".  To change this prefix you do the following format for this shortcode:  [CO_TAX_NUMBER_* prefix="GST: "] and that will output: GST: 12345t56.  Also take note that if you have NO number in your settings, the prefix is not output either.',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>'
+			),
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+
+		switch ($shortcode) {
+			case '[COMPANY]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('name');
+				break;
+
+			case '[CO_ADD1]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('address_1');
+				break;
+
+			case '[CO_ADD2]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('address_2');
+				break;
+
+			case '[CO_CITY]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('city');
+				break;
+
+			case '[CO_STATE]':
+				$state = EE_Registry::instance()->load_model('State')->get_one_by_ID(
+					EE_Registry::instance()->CFG->organization->STA_ID
+				);
+				return $state instanceof EE_State ? $state->name() : '';
+				break;
+
+			case '[CO_ZIP]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('zip');
+				break;
+
+			case '[CO_EMAIL]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('email');
+				break;
+
+			case '[CO_PHONE]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('phone');
+				break;
+
+			case '[CO_LOGO]':
+				return '<img src="'
+					   . EE_Registry::instance()->CFG->organization->get_pretty(
+						   'logo_url'
+					   ) . '" id="headerImage" />';
+				break;
+
+			case '[CO_LOGO_URL]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('logo_url');
+				break;
+
+			case '[CO_FACEBOOK_URL]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('facebook');
+				break;
+
+			case '[CO_TWITTER_URL]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('twitter');
+				break;
+
+			case '[CO_PINTEREST_URL]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('pinterest');
+				break;
+
+			case '[CO_LINKEDIN_URL]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('linkedin');
+				break;
+
+			case '[CO_GOOGLE_URL]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('google');
+				break;
+
+			case '[CO_INSTAGRAM_URL]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('instagram');
+				break;
+		}
+
+		// also allow for parameter shortcode
+		if (strpos($shortcode, '[CO_TAX_NUMBER_*') !== false) {
+			// first see if there is any company tax number set and bail early if not
+			$tax_number = EE_Registry::instance()->CFG->organization->vat;
+			if (empty($tax_number)) {
+				return '';
+			}
+
+			// see if there are any attributes.
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+
+			// set custom attrs if present (or default)
+			$prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
+			return $prefix . $tax_number;
+		}
+
+		return '';
+	}
 }

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.83.rc.000');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.83.rc.000');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/services/assets/Registry.php

Indentation +731 added lines, -731 removed lines

@@ -27,742 +27,742 @@
 class Registry
 {
 
-    const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
-
-    /**
-     * @var AssetCollection $assets
-     */
-    protected $assets;
-
-    /**
-     * @var I18nRegistry
-     */
-    private $i18n_registry;
-
-    /**
-     * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
-     *
-     * @var array
-     */
-    protected $jsdata = array();
-
-    /**
-     * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
-     * page source.
-     *
-     * @var array
-     */
-    private $script_handles_with_data = array();
-
-
-    /**
-     * Holds the manifest data obtained from registered manifest files.
-     * Manifests are maps of asset chunk name to actual built asset file names.
-     * Shape of this array is:
-     * array(
-     *  'some_namespace_slug' => array(
-     *      'some_chunk_name' => array(
-     *          'js' => 'filename.js'
-     *          'css' => 'filename.js'
-     *      ),
-     *      'url_base' => 'https://baseurl.com/to/assets
-     *  )
-     * )
-     *
-     * @var array
-     */
-    private $manifest_data = array();
-
-
-    /**
-     * Holds any dependency data obtained from registered dependency map json.
-     * Dependency map json is generated via the @wordpress/dependency-extraction-webpack-plugin via the webpack config.
-     * @see https://github.com/WordPress/gutenberg/tree/master/packages/dependency-extraction-webpack-plugin
-     *
-     * @var array
-     */
-    private $dependencies_data = [];
-
-
-    /**
-     * This is a known array of possible wp css handles that correspond to what may be exposed as dependencies in our
-     * build process.  Currently the dependency export process in webpack does not consider css imports, so we derive
-     * them via the js dependencies (WP uses the same handle for both js and css). This is a list of known handles that
-     * are used for both js and css.
-     * @var array
-     */
-    private $wp_css_handle_dependencies = [
-        'wp-components',
-        'wp-block-editor',
-        'wp-block-library',
-        'wp-edit-post',
-        'wp-edit-widgets',
-        'wp-editor',
-        'wp-format-library',
-        'wp-list-reusable-blocks',
-        'wp-nux',
-    ];
-
-
-    /**
-     * Registry constructor.
-     * Hooking into WP actions for script registry.
-     *
-     * @param AssetCollection      $assets
-     * @param I18nRegistry         $i18n_registry
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
-    {
-        $this->assets = $assets;
-        $this->i18n_registry = $i18n_registry;
-        add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
-        add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
-        add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
-        add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
-        add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
-        add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
-        add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
-        add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
-    }
-
-
-    /**
-     * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
-     * translation handling.
-     *
-     * @return I18nRegistry
-     */
-    public function getI18nRegistry()
-    {
-        return $this->i18n_registry;
-    }
-
-
-    /**
-     * Callback for the wp_enqueue_scripts actions used to register assets.
-     *
-     * @since 4.9.62.p
-     * @throws Exception
-     */
-    public function registerScriptsAndStyles()
-    {
-        try {
-            $this->registerScripts($this->assets->getJavascriptAssets());
-            $this->registerStyles($this->assets->getStylesheetAssets());
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * Registers JS assets with WP core
-     *
-     * @since 4.9.62.p
-     * @param JavascriptAsset[] $scripts
-     * @throws AssetRegistrationException
-     * @throws InvalidDataTypeException
-     */
-    public function registerScripts(array $scripts)
-    {
-        foreach ($scripts as $script) {
-            // skip to next script if this has already been done
-            if ($script->isRegistered()) {
-                continue;
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
-                $script
-            );
-            $registered = wp_register_script(
-                $script->handle(),
-                $script->source(),
-                $script->dependencies(),
-                $script->version(),
-                $script->loadInFooter()
-            );
-            if (! $registered && $this->debug()) {
-                throw new AssetRegistrationException($script->handle());
-            }
-            $script->setRegistered($registered);
-            if ($script->requiresTranslation()) {
-                $this->registerTranslation($script->handle());
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
-                $script
-            );
-        }
-    }
-
-
-    /**
-     * Registers CSS assets with WP core
-     *
-     * @since 4.9.62.p
-     * @param StylesheetAsset[] $styles
-     * @throws InvalidDataTypeException
-     */
-    public function registerStyles(array $styles)
-    {
-        foreach ($styles as $style) {
-            // skip to next style if this has already been done
-            if ($style->isRegistered()) {
-                continue;
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
-                $style
-            );
-            wp_register_style(
-                $style->handle(),
-                $style->source(),
-                $style->dependencies(),
-                $style->version(),
-                $style->media()
-            );
-            $style->setRegistered();
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
-                $style
-            );
-        }
-    }
-
-
-    /**
-     * Call back for the script print in frontend and backend.
-     * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
-     *
-     * @since 4.9.31.rc.015
-     */
-    public function enqueueData()
-    {
-        $this->removeAlreadyRegisteredDataForScriptHandles();
-        wp_add_inline_script(
-            'eejs-core',
-            'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
-            'before'
-        );
-        $scripts = $this->assets->getJavascriptAssetsWithData();
-        foreach ($scripts as $script) {
-            $this->addRegisteredScriptHandlesWithData($script->handle());
-            if ($script->hasInlineDataCallback()) {
-                $localize = $script->inlineDataCallback();
-                $localize();
-            }
-        }
-    }
-
-
-    /**
-     * Used to add data to eejs.data object.
-     * Note:  Overriding existing data is not allowed.
-     * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
-     * If the data you add is something like this:
-     *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
-     * It will be exposed in the page source as:
-     *  eejs.data.my_plugin_data.foo == gar
-     *
-     * @param string       $key   Key used to access your data
-     * @param string|array $value Value to attach to key
-     * @throws InvalidArgumentException
-     */
-    public function addData($key, $value)
-    {
-        if ($this->verifyDataNotExisting($key)) {
-            $this->jsdata[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * Similar to addData except this allows for users to push values to an existing key where the values on key are
-     * elements in an array.
-     *
-     * When you use this method, the value you include will be merged with the array on $key.
-     * So if the $key was 'test' and you added a value of ['my_data'] then it would be represented in the javascript
-     * object like this, eejs.data.test = [ my_data,
-     * ]
-     * If there has already been a scalar value attached to the data object given key (via addData for instance), then
-     * this will throw an exception.
-     *
-     * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
-     * key potentially overriding the existing data on merge (specifically with associative arrays).
-     *
-     * @param string       $key   Key to attach data to.
-     * @param string|array $value Value being registered.
-     * @throws InvalidArgumentException
-     */
-    public function pushData($key, $value)
-    {
-        if (isset($this->jsdata[ $key ])
-            && ! is_array($this->jsdata[ $key ])
-        ) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    __(
-                        'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
+	const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
+
+	/**
+	 * @var AssetCollection $assets
+	 */
+	protected $assets;
+
+	/**
+	 * @var I18nRegistry
+	 */
+	private $i18n_registry;
+
+	/**
+	 * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
+	 *
+	 * @var array
+	 */
+	protected $jsdata = array();
+
+	/**
+	 * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
+	 * page source.
+	 *
+	 * @var array
+	 */
+	private $script_handles_with_data = array();
+
+
+	/**
+	 * Holds the manifest data obtained from registered manifest files.
+	 * Manifests are maps of asset chunk name to actual built asset file names.
+	 * Shape of this array is:
+	 * array(
+	 *  'some_namespace_slug' => array(
+	 *      'some_chunk_name' => array(
+	 *          'js' => 'filename.js'
+	 *          'css' => 'filename.js'
+	 *      ),
+	 *      'url_base' => 'https://baseurl.com/to/assets
+	 *  )
+	 * )
+	 *
+	 * @var array
+	 */
+	private $manifest_data = array();
+
+
+	/**
+	 * Holds any dependency data obtained from registered dependency map json.
+	 * Dependency map json is generated via the @wordpress/dependency-extraction-webpack-plugin via the webpack config.
+	 * @see https://github.com/WordPress/gutenberg/tree/master/packages/dependency-extraction-webpack-plugin
+	 *
+	 * @var array
+	 */
+	private $dependencies_data = [];
+
+
+	/**
+	 * This is a known array of possible wp css handles that correspond to what may be exposed as dependencies in our
+	 * build process.  Currently the dependency export process in webpack does not consider css imports, so we derive
+	 * them via the js dependencies (WP uses the same handle for both js and css). This is a list of known handles that
+	 * are used for both js and css.
+	 * @var array
+	 */
+	private $wp_css_handle_dependencies = [
+		'wp-components',
+		'wp-block-editor',
+		'wp-block-library',
+		'wp-edit-post',
+		'wp-edit-widgets',
+		'wp-editor',
+		'wp-format-library',
+		'wp-list-reusable-blocks',
+		'wp-nux',
+	];
+
+
+	/**
+	 * Registry constructor.
+	 * Hooking into WP actions for script registry.
+	 *
+	 * @param AssetCollection      $assets
+	 * @param I18nRegistry         $i18n_registry
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
+	{
+		$this->assets = $assets;
+		$this->i18n_registry = $i18n_registry;
+		add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
+		add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
+		add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
+		add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
+		add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
+		add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
+		add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
+		add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
+	}
+
+
+	/**
+	 * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
+	 * translation handling.
+	 *
+	 * @return I18nRegistry
+	 */
+	public function getI18nRegistry()
+	{
+		return $this->i18n_registry;
+	}
+
+
+	/**
+	 * Callback for the wp_enqueue_scripts actions used to register assets.
+	 *
+	 * @since 4.9.62.p
+	 * @throws Exception
+	 */
+	public function registerScriptsAndStyles()
+	{
+		try {
+			$this->registerScripts($this->assets->getJavascriptAssets());
+			$this->registerStyles($this->assets->getStylesheetAssets());
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * Registers JS assets with WP core
+	 *
+	 * @since 4.9.62.p
+	 * @param JavascriptAsset[] $scripts
+	 * @throws AssetRegistrationException
+	 * @throws InvalidDataTypeException
+	 */
+	public function registerScripts(array $scripts)
+	{
+		foreach ($scripts as $script) {
+			// skip to next script if this has already been done
+			if ($script->isRegistered()) {
+				continue;
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
+				$script
+			);
+			$registered = wp_register_script(
+				$script->handle(),
+				$script->source(),
+				$script->dependencies(),
+				$script->version(),
+				$script->loadInFooter()
+			);
+			if (! $registered && $this->debug()) {
+				throw new AssetRegistrationException($script->handle());
+			}
+			$script->setRegistered($registered);
+			if ($script->requiresTranslation()) {
+				$this->registerTranslation($script->handle());
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
+				$script
+			);
+		}
+	}
+
+
+	/**
+	 * Registers CSS assets with WP core
+	 *
+	 * @since 4.9.62.p
+	 * @param StylesheetAsset[] $styles
+	 * @throws InvalidDataTypeException
+	 */
+	public function registerStyles(array $styles)
+	{
+		foreach ($styles as $style) {
+			// skip to next style if this has already been done
+			if ($style->isRegistered()) {
+				continue;
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
+				$style
+			);
+			wp_register_style(
+				$style->handle(),
+				$style->source(),
+				$style->dependencies(),
+				$style->version(),
+				$style->media()
+			);
+			$style->setRegistered();
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
+				$style
+			);
+		}
+	}
+
+
+	/**
+	 * Call back for the script print in frontend and backend.
+	 * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
+	 *
+	 * @since 4.9.31.rc.015
+	 */
+	public function enqueueData()
+	{
+		$this->removeAlreadyRegisteredDataForScriptHandles();
+		wp_add_inline_script(
+			'eejs-core',
+			'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
+			'before'
+		);
+		$scripts = $this->assets->getJavascriptAssetsWithData();
+		foreach ($scripts as $script) {
+			$this->addRegisteredScriptHandlesWithData($script->handle());
+			if ($script->hasInlineDataCallback()) {
+				$localize = $script->inlineDataCallback();
+				$localize();
+			}
+		}
+	}
+
+
+	/**
+	 * Used to add data to eejs.data object.
+	 * Note:  Overriding existing data is not allowed.
+	 * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
+	 * If the data you add is something like this:
+	 *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
+	 * It will be exposed in the page source as:
+	 *  eejs.data.my_plugin_data.foo == gar
+	 *
+	 * @param string       $key   Key used to access your data
+	 * @param string|array $value Value to attach to key
+	 * @throws InvalidArgumentException
+	 */
+	public function addData($key, $value)
+	{
+		if ($this->verifyDataNotExisting($key)) {
+			$this->jsdata[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * Similar to addData except this allows for users to push values to an existing key where the values on key are
+	 * elements in an array.
+	 *
+	 * When you use this method, the value you include will be merged with the array on $key.
+	 * So if the $key was 'test' and you added a value of ['my_data'] then it would be represented in the javascript
+	 * object like this, eejs.data.test = [ my_data,
+	 * ]
+	 * If there has already been a scalar value attached to the data object given key (via addData for instance), then
+	 * this will throw an exception.
+	 *
+	 * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
+	 * key potentially overriding the existing data on merge (specifically with associative arrays).
+	 *
+	 * @param string       $key   Key to attach data to.
+	 * @param string|array $value Value being registered.
+	 * @throws InvalidArgumentException
+	 */
+	public function pushData($key, $value)
+	{
+		if (isset($this->jsdata[ $key ])
+			&& ! is_array($this->jsdata[ $key ])
+		) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
                          push values to this data element when it is an array.',
-                        'event_espresso'
-                    ),
-                    $key,
-                    __METHOD__
-                )
-            );
-        }
-        if ( ! isset( $this->jsdata[ $key ] ) ) {
-            $this->jsdata[ $key ] = is_array($value) ? $value : [$value];
-        } else {
-            $this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $value);
-        }
-    }
-
-
-    /**
-     * Used to set content used by javascript for a template.
-     * Note: Overrides of existing registered templates are not allowed.
-     *
-     * @param string $template_reference
-     * @param string $template_content
-     * @throws InvalidArgumentException
-     */
-    public function addTemplate($template_reference, $template_content)
-    {
-        if (! isset($this->jsdata['templates'])) {
-            $this->jsdata['templates'] = array();
-        }
-        //no overrides allowed.
-        if (isset($this->jsdata['templates'][ $template_reference ])) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    __(
-                        'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
-                        'event_espresso'
-                    ),
-                    $template_reference
-                )
-            );
-        }
-        $this->jsdata['templates'][ $template_reference ] = $template_content;
-    }
-
-
-    /**
-     * Retrieve the template content already registered for the given reference.
-     *
-     * @param string $template_reference
-     * @return string
-     */
-    public function getTemplate($template_reference)
-    {
-        return isset($this->jsdata['templates'][ $template_reference ])
-            ? $this->jsdata['templates'][ $template_reference ]
-            : '';
-    }
-
-
-    /**
-     * Retrieve registered data.
-     *
-     * @param string $key Name of key to attach data to.
-     * @return mixed                If there is no for the given key, then false is returned.
-     */
-    public function getData($key)
-    {
-        return isset($this->jsdata[ $key ])
-            ? $this->jsdata[ $key ]
-            : false;
-    }
-
-
-    /**
-     * Verifies whether the given data exists already on the jsdata array.
-     * Overriding data is not allowed.
-     *
-     * @param string $key Index for data.
-     * @return bool        If valid then return true.
-     * @throws InvalidArgumentException if data already exists.
-     */
-    protected function verifyDataNotExisting($key)
-    {
-        if (isset($this->jsdata[ $key ])) {
-            if (! $this->debug()) {
-                return false;
-            }
-            if (is_array($this->jsdata[ $key ])) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        __(
-                            'The value for %1$s already exists in the Registry::eejs object.
+						'event_espresso'
+					),
+					$key,
+					__METHOD__
+				)
+			);
+		}
+		if ( ! isset( $this->jsdata[ $key ] ) ) {
+			$this->jsdata[ $key ] = is_array($value) ? $value : [$value];
+		} else {
+			$this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $value);
+		}
+	}
+
+
+	/**
+	 * Used to set content used by javascript for a template.
+	 * Note: Overrides of existing registered templates are not allowed.
+	 *
+	 * @param string $template_reference
+	 * @param string $template_content
+	 * @throws InvalidArgumentException
+	 */
+	public function addTemplate($template_reference, $template_content)
+	{
+		if (! isset($this->jsdata['templates'])) {
+			$this->jsdata['templates'] = array();
+		}
+		//no overrides allowed.
+		if (isset($this->jsdata['templates'][ $template_reference ])) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
+						'event_espresso'
+					),
+					$template_reference
+				)
+			);
+		}
+		$this->jsdata['templates'][ $template_reference ] = $template_content;
+	}
+
+
+	/**
+	 * Retrieve the template content already registered for the given reference.
+	 *
+	 * @param string $template_reference
+	 * @return string
+	 */
+	public function getTemplate($template_reference)
+	{
+		return isset($this->jsdata['templates'][ $template_reference ])
+			? $this->jsdata['templates'][ $template_reference ]
+			: '';
+	}
+
+
+	/**
+	 * Retrieve registered data.
+	 *
+	 * @param string $key Name of key to attach data to.
+	 * @return mixed                If there is no for the given key, then false is returned.
+	 */
+	public function getData($key)
+	{
+		return isset($this->jsdata[ $key ])
+			? $this->jsdata[ $key ]
+			: false;
+	}
+
+
+	/**
+	 * Verifies whether the given data exists already on the jsdata array.
+	 * Overriding data is not allowed.
+	 *
+	 * @param string $key Index for data.
+	 * @return bool        If valid then return true.
+	 * @throws InvalidArgumentException if data already exists.
+	 */
+	protected function verifyDataNotExisting($key)
+	{
+		if (isset($this->jsdata[ $key ])) {
+			if (! $this->debug()) {
+				return false;
+			}
+			if (is_array($this->jsdata[ $key ])) {
+				throw new InvalidArgumentException(
+					sprintf(
+						__(
+							'The value for %1$s already exists in the Registry::eejs object.
                             Overrides are not allowed. Since the value of this data is an array, you may want to use the
                             %2$s method to push your value to the array.',
-                            'event_espresso'
-                        ),
-                        $key,
-                        'pushData()'
-                    )
-                );
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    __(
-                        'The value for %1$s already exists in the Registry::eejs object. Overrides are not
+							'event_espresso'
+						),
+						$key,
+						'pushData()'
+					)
+				);
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'The value for %1$s already exists in the Registry::eejs object. Overrides are not
                         allowed.  Consider attaching your value to a different key',
-                        'event_espresso'
-                    ),
-                    $key
-                )
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * Get the actual asset path for asset manifests.
-     * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
-     *
-     * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
-     *                           asset file location.
-     * @param string $chunk_name
-     * @param string $asset_type
-     * @return string
-     * @since 4.9.59.p
-     */
-    public function getAssetUrl($namespace, $chunk_name, $asset_type)
-    {
-        $url = isset(
-            $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
-            $this->manifest_data[ $namespace ]['url_base']
-        )
-            ? $this->manifest_data[ $namespace ]['url_base']
-              . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
-            : $chunk_name;
-
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
-            $url,
-            $namespace,
-            $chunk_name,
-            $asset_type
-        );
-    }
-
-
-
-    /**
-     * Return the url to a js file for the given namespace and chunk name.
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return string
-     */
-    public function getJsUrl($namespace, $chunk_name)
-    {
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS);
-    }
-
-
-    /**
-     * Return the url to a css file for the given namespace and chunk name.
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return string
-     */
-    public function getCssUrl($namespace, $chunk_name)
-    {
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * Return the dependencies for a given asset $chunk_name
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @param string $asset_type
-     * @return array
-     * @since 4.9.82.p
-     */
-    private function getDependenciesForAsset($namespace, $chunk_name, $asset_type)
-    {
-        $asset_index = $chunk_name . '.' . $asset_type;
-        if (! isset( $this->dependencies_data[ $namespace ][ $asset_index ])) {
-            $path = isset($this->manifest_data[ $namespace ]['path'])
-                ? $this->manifest_data[ $namespace ]['path']
-                : '';
-            $dependencies_index = $chunk_name . '.' . Asset::TYPE_JSON;
-            $file_path = isset($this->manifest_data[ $namespace ][ $dependencies_index ])
-                ? $path . $this->manifest_data[ $namespace ][ $dependencies_index ]
-                :
-                '';
-            $this->dependencies_data[ $namespace ][ $asset_index ] = $file_path !== '' && file_exists($file_path)
-                ? $this->getDependenciesForAssetType($namespace, $asset_type, $file_path, $chunk_name)
-                : [];
-        }
-        return $this->dependencies_data[ $namespace ][ $asset_index ];
-    }
-
-
-    /**
-     * Return dependencies according to asset type.
-     *
-     * For css assets, this filters the auto generated dependencies by css type.
-     *
-     * @param string $namespace
-     * @param string $asset_type
-     * @param string $file_path
-     * @param string $chunk_name
-     * @return array
-     * @since 4.9.82.p
-     */
-    private function getDependenciesForAssetType($namespace, $asset_type, $file_path, $chunk_name)
-    {
-        $asset_dependencies = json_decode(file_get_contents($file_path), true);
-        if ($asset_type === Asset::TYPE_JS) {
-            return $chunk_name === 'eejs-core' ? $asset_dependencies : array_merge(
-                $asset_dependencies,
-                [ CoreAssetManager::JS_HANDLE_JS_CORE ]
-            );
-        }
-        // for css we need to make sure there is actually a css file related to this chunk.
-        if (isset($this->manifest_data[ $namespace ])) {
-            // array of css chunk files for ee.
-            $css_chunks = array_map(
-                function ($value) {
-                    return str_replace('.css', '', $value);
-                },
-                array_filter(
-                    array_keys($this->manifest_data[ $namespace ]),
-                    function ($value) {
-                        return strpos($value, '.css') !== false;
-                    }
-                )
-            );
-            // add known wp chunks with css
-            $css_chunks = array_merge( $css_chunks, $this->wp_css_handle_dependencies);
-            // flip for easier search
-            $css_chunks = array_flip($css_chunks);
-            // now let's filter the dependencies for the incoming chunk to actual chunks that have styles
-            return array_filter(
-                $asset_dependencies,
-                function ($chunk_name) use ($css_chunks) {
-                    return isset($css_chunks[ $chunk_name ]);
-                }
-            );
-        }
-        return [];
-    }
-
-
-    /**
-     * Get the dependencies array for the given js asset chunk name
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @since 4.9.82.p
-     */
-    public function getJsDependencies($namespace, $chunk_name)
-    {
-        return $this->getDependenciesForAsset($namespace, $chunk_name, Asset::TYPE_JS);
-    }
-
-
-    /**
-     * Get the dependencies array for the given css asset chunk name
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @since 4.9.82.p
-     */
-    public function getCssDependencies($namespace, $chunk_name)
-    {
-        return $this->getDependenciesForAsset($namespace, $chunk_name, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * @since 4.9.62.p
-     * @throws InvalidArgumentException
-     * @throws InvalidFilePathException
-     */
-    public function registerManifestFiles()
-    {
-        $manifest_files = $this->assets->getManifestFiles();
-        foreach ($manifest_files as $manifest_file) {
-            $this->registerManifestFile(
-                $manifest_file->assetNamespace(),
-                $manifest_file->urlBase(),
-                $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST,
-                $manifest_file->filepath()
-            );
-        }
-    }
-
-
-    /**
-     * Used to register a js/css manifest file with the registered_manifest_files property.
-     *
-     * @param string $namespace     Provided to associate the manifest file with a specific namespace.
-     * @param string $url_base      The url base for the manifest file location.
-     * @param string $manifest_file The absolute path to the manifest file.
-     * @param string $manifest_file_path  The path to the folder containing the manifest file. If not provided will be
-     *                                    default to `plugin_root/assets/dist`.
-     * @throws InvalidArgumentException
-     * @throws InvalidFilePathException
-     * @since 4.9.59.p
-     */
-    public function registerManifestFile($namespace, $url_base, $manifest_file, $manifest_file_path = '')
-    {
-        if (isset($this->manifest_data[ $namespace ])) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The namespace for this manifest file has already been registered, choose a namespace other than %s',
-                        'event_espresso'
-                    ),
-                    $namespace
-                )
-            );
-        }
-        if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
-            if (is_admin()) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
-                            'event_espresso'
-                        ),
-                        'Event Espresso',
-                        $url_base,
-                        'plugins_url',
-                        'WP_PLUGIN_URL'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return;
-        }
-        $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
-        if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
-            $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
-        }
-        if (! isset($this->manifest_data[ $namespace ]['path'])) {
-            $this->manifest_data[ $namespace ]['path'] = $manifest_file_path;
-        }
-    }
-
-
-    /**
-     * Decodes json from the provided manifest file.
-     *
-     * @since 4.9.59.p
-     * @param string $manifest_file Path to manifest file.
-     * @return array
-     * @throws InvalidFilePathException
-     */
-    private function decodeManifestFile($manifest_file)
-    {
-        if (! file_exists($manifest_file)) {
-            throw new InvalidFilePathException($manifest_file);
-        }
-        return json_decode(file_get_contents($manifest_file), true);
-    }
-
-
-    /**
-     * This is used to set registered script handles that have data.
-     *
-     * @param string $script_handle
-     */
-    private function addRegisteredScriptHandlesWithData($script_handle)
-    {
-        $this->script_handles_with_data[ $script_handle ] = $script_handle;
-    }
-
-
-    /**i
+						'event_espresso'
+					),
+					$key
+				)
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Get the actual asset path for asset manifests.
+	 * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
+	 *
+	 * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
+	 *                           asset file location.
+	 * @param string $chunk_name
+	 * @param string $asset_type
+	 * @return string
+	 * @since 4.9.59.p
+	 */
+	public function getAssetUrl($namespace, $chunk_name, $asset_type)
+	{
+		$url = isset(
+			$this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
+			$this->manifest_data[ $namespace ]['url_base']
+		)
+			? $this->manifest_data[ $namespace ]['url_base']
+			  . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
+			: $chunk_name;
+
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
+			$url,
+			$namespace,
+			$chunk_name,
+			$asset_type
+		);
+	}
+
+
+
+	/**
+	 * Return the url to a js file for the given namespace and chunk name.
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return string
+	 */
+	public function getJsUrl($namespace, $chunk_name)
+	{
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS);
+	}
+
+
+	/**
+	 * Return the url to a css file for the given namespace and chunk name.
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return string
+	 */
+	public function getCssUrl($namespace, $chunk_name)
+	{
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * Return the dependencies for a given asset $chunk_name
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @param string $asset_type
+	 * @return array
+	 * @since 4.9.82.p
+	 */
+	private function getDependenciesForAsset($namespace, $chunk_name, $asset_type)
+	{
+		$asset_index = $chunk_name . '.' . $asset_type;
+		if (! isset( $this->dependencies_data[ $namespace ][ $asset_index ])) {
+			$path = isset($this->manifest_data[ $namespace ]['path'])
+				? $this->manifest_data[ $namespace ]['path']
+				: '';
+			$dependencies_index = $chunk_name . '.' . Asset::TYPE_JSON;
+			$file_path = isset($this->manifest_data[ $namespace ][ $dependencies_index ])
+				? $path . $this->manifest_data[ $namespace ][ $dependencies_index ]
+				:
+				'';
+			$this->dependencies_data[ $namespace ][ $asset_index ] = $file_path !== '' && file_exists($file_path)
+				? $this->getDependenciesForAssetType($namespace, $asset_type, $file_path, $chunk_name)
+				: [];
+		}
+		return $this->dependencies_data[ $namespace ][ $asset_index ];
+	}
+
+
+	/**
+	 * Return dependencies according to asset type.
+	 *
+	 * For css assets, this filters the auto generated dependencies by css type.
+	 *
+	 * @param string $namespace
+	 * @param string $asset_type
+	 * @param string $file_path
+	 * @param string $chunk_name
+	 * @return array
+	 * @since 4.9.82.p
+	 */
+	private function getDependenciesForAssetType($namespace, $asset_type, $file_path, $chunk_name)
+	{
+		$asset_dependencies = json_decode(file_get_contents($file_path), true);
+		if ($asset_type === Asset::TYPE_JS) {
+			return $chunk_name === 'eejs-core' ? $asset_dependencies : array_merge(
+				$asset_dependencies,
+				[ CoreAssetManager::JS_HANDLE_JS_CORE ]
+			);
+		}
+		// for css we need to make sure there is actually a css file related to this chunk.
+		if (isset($this->manifest_data[ $namespace ])) {
+			// array of css chunk files for ee.
+			$css_chunks = array_map(
+				function ($value) {
+					return str_replace('.css', '', $value);
+				},
+				array_filter(
+					array_keys($this->manifest_data[ $namespace ]),
+					function ($value) {
+						return strpos($value, '.css') !== false;
+					}
+				)
+			);
+			// add known wp chunks with css
+			$css_chunks = array_merge( $css_chunks, $this->wp_css_handle_dependencies);
+			// flip for easier search
+			$css_chunks = array_flip($css_chunks);
+			// now let's filter the dependencies for the incoming chunk to actual chunks that have styles
+			return array_filter(
+				$asset_dependencies,
+				function ($chunk_name) use ($css_chunks) {
+					return isset($css_chunks[ $chunk_name ]);
+				}
+			);
+		}
+		return [];
+	}
+
+
+	/**
+	 * Get the dependencies array for the given js asset chunk name
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @since 4.9.82.p
+	 */
+	public function getJsDependencies($namespace, $chunk_name)
+	{
+		return $this->getDependenciesForAsset($namespace, $chunk_name, Asset::TYPE_JS);
+	}
+
+
+	/**
+	 * Get the dependencies array for the given css asset chunk name
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @since 4.9.82.p
+	 */
+	public function getCssDependencies($namespace, $chunk_name)
+	{
+		return $this->getDependenciesForAsset($namespace, $chunk_name, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * @since 4.9.62.p
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFilePathException
+	 */
+	public function registerManifestFiles()
+	{
+		$manifest_files = $this->assets->getManifestFiles();
+		foreach ($manifest_files as $manifest_file) {
+			$this->registerManifestFile(
+				$manifest_file->assetNamespace(),
+				$manifest_file->urlBase(),
+				$manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST,
+				$manifest_file->filepath()
+			);
+		}
+	}
+
+
+	/**
+	 * Used to register a js/css manifest file with the registered_manifest_files property.
+	 *
+	 * @param string $namespace     Provided to associate the manifest file with a specific namespace.
+	 * @param string $url_base      The url base for the manifest file location.
+	 * @param string $manifest_file The absolute path to the manifest file.
+	 * @param string $manifest_file_path  The path to the folder containing the manifest file. If not provided will be
+	 *                                    default to `plugin_root/assets/dist`.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFilePathException
+	 * @since 4.9.59.p
+	 */
+	public function registerManifestFile($namespace, $url_base, $manifest_file, $manifest_file_path = '')
+	{
+		if (isset($this->manifest_data[ $namespace ])) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The namespace for this manifest file has already been registered, choose a namespace other than %s',
+						'event_espresso'
+					),
+					$namespace
+				)
+			);
+		}
+		if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
+			if (is_admin()) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
+							'event_espresso'
+						),
+						'Event Espresso',
+						$url_base,
+						'plugins_url',
+						'WP_PLUGIN_URL'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return;
+		}
+		$this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
+		if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
+			$this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
+		}
+		if (! isset($this->manifest_data[ $namespace ]['path'])) {
+			$this->manifest_data[ $namespace ]['path'] = $manifest_file_path;
+		}
+	}
+
+
+	/**
+	 * Decodes json from the provided manifest file.
+	 *
+	 * @since 4.9.59.p
+	 * @param string $manifest_file Path to manifest file.
+	 * @return array
+	 * @throws InvalidFilePathException
+	 */
+	private function decodeManifestFile($manifest_file)
+	{
+		if (! file_exists($manifest_file)) {
+			throw new InvalidFilePathException($manifest_file);
+		}
+		return json_decode(file_get_contents($manifest_file), true);
+	}
+
+
+	/**
+	 * This is used to set registered script handles that have data.
+	 *
+	 * @param string $script_handle
+	 */
+	private function addRegisteredScriptHandlesWithData($script_handle)
+	{
+		$this->script_handles_with_data[ $script_handle ] = $script_handle;
+	}
+
+
+	/**i
      * Checks WP_Scripts for all of each script handle registered internally as having data and unsets from the
      * Dependency stored in WP_Scripts if its set.
      */
-    private function removeAlreadyRegisteredDataForScriptHandles()
-    {
-        if (empty($this->script_handles_with_data)) {
-            return;
-        }
-        foreach ($this->script_handles_with_data as $script_handle) {
-            $this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
-        }
-    }
-
-
-    /**
-     * Removes any data dependency registered in WP_Scripts if its set.
-     *
-     * @param string $script_handle
-     */
-    private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
-    {
-        if (isset($this->script_handles_with_data[ $script_handle ])) {
-            global $wp_scripts;
-            $unset_handle = false;
-            if ($wp_scripts->get_data($script_handle, 'data')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['data']);
-                $unset_handle = true;
-            }
-            //deal with inline_scripts
-            if ($wp_scripts->get_data($script_handle, 'before')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['before']);
-                $unset_handle = true;
-            }
-            if ($wp_scripts->get_data($script_handle, 'after')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['after']);
-            }
-            if ($unset_handle) {
-                unset($this->script_handles_with_data[ $script_handle ]);
-            }
-        }
-    }
-
-
-    /**
-     * register translations for a registered script
-     *
-     * @param string $handle
-     */
-    public function registerTranslation($handle)
-    {
-        $this->i18n_registry->registerScriptI18n($handle);
-    }
-
-
-    /**
-     * @since 4.9.63.p
-     * @return bool
-     */
-    private function debug()
-    {
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__debug',
-            defined('EE_DEBUG') && EE_DEBUG
-        );
-    }
+	private function removeAlreadyRegisteredDataForScriptHandles()
+	{
+		if (empty($this->script_handles_with_data)) {
+			return;
+		}
+		foreach ($this->script_handles_with_data as $script_handle) {
+			$this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
+		}
+	}
+
+
+	/**
+	 * Removes any data dependency registered in WP_Scripts if its set.
+	 *
+	 * @param string $script_handle
+	 */
+	private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
+	{
+		if (isset($this->script_handles_with_data[ $script_handle ])) {
+			global $wp_scripts;
+			$unset_handle = false;
+			if ($wp_scripts->get_data($script_handle, 'data')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['data']);
+				$unset_handle = true;
+			}
+			//deal with inline_scripts
+			if ($wp_scripts->get_data($script_handle, 'before')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['before']);
+				$unset_handle = true;
+			}
+			if ($wp_scripts->get_data($script_handle, 'after')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['after']);
+			}
+			if ($unset_handle) {
+				unset($this->script_handles_with_data[ $script_handle ]);
+			}
+		}
+	}
+
+
+	/**
+	 * register translations for a registered script
+	 *
+	 * @param string $handle
+	 */
+	public function registerTranslation($handle)
+	{
+		$this->i18n_registry->registerScriptI18n($handle);
+	}
+
+
+	/**
+	 * @since 4.9.63.p
+	 * @return bool
+	 */
+	private function debug()
+	{
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__debug',
+			defined('EE_DEBUG') && EE_DEBUG
+		);
+	}
 }