eventespresso / event-espresso-core

admin_pages/transactions/EE_Admin_Transactions_List_Table.class.php

Spacing +31 added lines, -31 removed lines

@@ -96,7 +96,7 @@ 
     {
         $class = parent::_get_row_class($transaction);
         // add status class
-        $class .= ' ee-status-strip txn-status-' . $transaction->status_ID();
+        $class .= ' ee-status-strip txn-status-'.$transaction->status_ID();
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
         }
@@ -170,13 +170,13 @@ 
             ),
             TXN_ADMIN_URL
         );
-        $content = '<a href="' . $view_lnk_url . '"'
-                   . ' title="' . esc_attr__('Go to Transaction Details', 'event_espresso') . '">'
+        $content = '<a href="'.$view_lnk_url.'"'
+                   . ' title="'.esc_attr__('Go to Transaction Details', 'event_espresso').'">'
                    . $transaction->ID()
                    . '</a>';
 
         // txn timestamp
-        $content .= '  <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($transaction) . '</span>';
+        $content .= '  <span class="show-on-mobile-view-only">'.$this->_get_txn_timestamp($transaction).'</span>';
         return $content;
     }
 
@@ -236,9 +236,9 @@ 
             ),
             TXN_ADMIN_URL
         );
-        $txn_date = '<a href="' . $view_lnk_url . '"'
+        $txn_date = '<a href="'.$view_lnk_url.'"'
                     . ' title="'
-                    . esc_attr__('View Transaction Details for TXN #', 'event_espresso') . $transaction->ID() . '">'
+                    . esc_attr__('View Transaction Details for TXN #', 'event_espresso').$transaction->ID().'">'
                     . $this->_get_txn_timestamp($transaction)
                     . '</a>';
         // status
@@ -271,7 +271,7 @@ 
                    )
                    . '</span>';
         } else {
-            return '<span class="txn-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>';
+            return '<span class="txn-overview-free-event-spn">'.esc_html__('free', 'event_espresso').'</span>';
         }
     }
 
@@ -308,7 +308,7 @@ 
             ? $payment_method->admin_name()
             : esc_html__('Unknown', 'event_espresso');
 
-        $content = '<span class="' . $span_class . ' txn-pad-rght">'
+        $content = '<span class="'.$span_class.' txn-pad-rght">'
                    . $transaction->get_pretty('TXN_paid')
                    . '</span>';
         if ($transaction_paid > 0) {
@@ -350,12 +350,12 @@ 
                 'espresso_registrations_view_registration',
                 $primary_reg->ID()
             )
-                ? '<a href="' . $edit_lnk_url . '"'
-                  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
+                ? '<a href="'.$edit_lnk_url.'"'
+                  . ' title="'.esc_attr__('View Registration Details', 'event_espresso').'">'
                   . $attendee->full_name()
                   . '</a>'
                 : $attendee->full_name();
-            $content .= '<br>' . $attendee->email();
+            $content .= '<br>'.$attendee->email();
             return $content;
         }
         return $transaction->failed() || $transaction->is_abandoned()
@@ -377,8 +377,8 @@ 
     public function column_ATT_email(EE_Transaction $transaction)
     {
         $attendee = $transaction->primary_registration()->get_first_related('Attendee');
-        if (! empty($attendee)) {
-            return '<a href="mailto:' . $attendee->get('ATT_email') . '">'
+        if ( ! empty($attendee)) {
+            return '<a href="mailto:'.$attendee->get('ATT_email').'">'
                    . $attendee->get('ATT_email')
                    . '</a>';
         } else {
@@ -406,7 +406,7 @@ 
     {
         $actions = array();
         $event = $transaction->primary_registration()->get_first_related('Event');
-        if (! empty($event)) {
+        if ( ! empty($event)) {
             $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
                 array('action' => 'edit', 'post' => $event->ID()),
                 EVENTS_ADMIN_URL
@@ -427,11 +427,11 @@ 
                     $event->ID()
                 )
             ) {
-                $actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '"'
-                                              . ' title="' . esc_attr__(
+                $actions['filter_by_event'] = '<a href="'.$txn_by_event_lnk.'"'
+                                              . ' title="'.esc_attr__(
                                                   'Filter transactions by this event',
                                                   'event_espresso'
-                                              ) . '">'
+                                              ).'">'
                                               . esc_html__('View Transactions for this event', 'event_espresso')
                                               . '</a>';
             }
@@ -443,7 +443,7 @@ 
                     'espresso_events_edit',
                     $event->ID()
                 )
-                    ? '<a href="' . $edit_event_url . '"'
+                    ? '<a href="'.$edit_event_url.'"'
                       . ' title="'
                       . sprintf(
                           esc_attr__('Edit Event: %s', 'event_espresso'),
@@ -510,8 +510,8 @@ 
         );
         return '
 			<li>
-				<a href="' . $url . '"'
-               . ' title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text">
+				<a href="' . $url.'"'
+               . ' title="'.esc_attr__('View Transaction Details', 'event_espresso').'" class="tiny-text">
 					<span class="dashicons dashicons-cart"></span>
 				</a>
 			</li>';
@@ -536,8 +536,8 @@ 
             ) {
                 return '
                 <li>
-                    <a title="' . esc_attr__('View Transaction Invoice', 'event_espresso') . '"'
-                       . ' target="_blank" href="' . $url . '" class="tiny-text">
+                    <a title="' . esc_attr__('View Transaction Invoice', 'event_espresso').'"'
+                       . ' target="_blank" href="'.$url.'" class="tiny-text">
                         <span class="dashicons dashicons-media-spreadsheet ee-icon-size-18"></span>
                     </a>
                 </li>';
@@ -564,8 +564,8 @@ 
                 && EEH_MSG_Template::is_mt_active('receipt')) {
                 return '
 			<li>
-				<a title="' . esc_attr__('View Transaction Receipt', 'event_espresso') . '"'
-                       . ' target="_blank" href="' . $url . '" class="tiny-text">
+				<a title="' . esc_attr__('View Transaction Receipt', 'event_espresso').'"'
+                       . ' target="_blank" href="'.$url.'" class="tiny-text">
 					<span class="dashicons dashicons-media-default ee-icon-size-18"></span>
 				</a>
 			</li>';
@@ -603,8 +603,8 @@ 
             )
                 ? '
 				<li>
-					<a href="' . $url . '"'
-                  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text">
+					<a href="' . $url.'"'
+                  . ' title="'.esc_attr__('View Registration Details', 'event_espresso').'" class="tiny-text">
 						<span class="dashicons dashicons-clipboard"></span>
 					</a>
 				</li>'
@@ -649,8 +649,8 @@ 
             );
             return '
             <li>
-                <a href="' . $url . '"'
-                   . ' title="' . esc_attr__('Send Payment Reminder', 'event_espresso') . '" class="tiny-text">
+                <a href="' . $url.'"'
+                   . ' title="'.esc_attr__('Send Payment Reminder', 'event_espresso').'" class="tiny-text">
                     <span class="dashicons dashicons-email-alt"></span>
                 </a>
             </li>';
@@ -680,7 +680,7 @@ 
             'ee_read_global_messages',
             'view_filtered_messages'
         )
-            ? '<li>' . $url . '</li>'
+            ? '<li>'.$url.'</li>'
             : '';
     }
 
@@ -701,8 +701,8 @@ 
         ) {
             return '
             <li>
-                <a title="' . esc_attr__('Make Payment from the Frontend.', 'event_espresso') . '"'
-                   . ' target="_blank" href="' . $registration->payment_overview_url(true) . '"'
+                <a title="' . esc_attr__('Make Payment from the Frontend.', 'event_espresso').'"'
+                   . ' target="_blank" href="'.$registration->payment_overview_url(true).'"'
                    . ' class="tiny-text">
                     <span class="dashicons dashicons-money ee-icon-size-18"></span>
                 </a>

Indentation +658 added lines, -658 removed lines

@@ -15,121 +15,121 @@ 
 class EE_Admin_Transactions_List_Table extends EE_Admin_List_Table
 {
 
-    /**
-     * @var SessionLifespan $session_lifespan
-     */
-    private $session_lifespan;
-
-    private $_status;
-
-
-    /**
-     * @param \Transactions_Admin_Page $admin_page
-     * @param SessionLifespan          $lifespan
-     */
-    public function __construct(\Transactions_Admin_Page $admin_page, SessionLifespan $lifespan)
-    {
-        parent::__construct($admin_page);
-        $this->session_lifespan = $lifespan;
-        $this->_status = $this->_admin_page->get_transaction_status_array();
-    }
-
-
-    /**
-     *_setup_data
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->_admin_page->get_transactions($this->_per_page);
-        $status = ! empty($this->_req_data['status']) ? $this->_req_data['status'] : 'all';
-        $this->_all_data_count = $this->_admin_page->get_transactions($this->_per_page, true, $status);
-    }
-
-
-    /**
-     *_set_properties
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => __('transaction', 'event_espresso'),
-            'plural'   => __('transactions', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-        $ID_column_name = __('ID', 'event_espresso');
-        $ID_column_name .= ' : <span class="show-on-mobile-view-only" style="float:none">';
-        $ID_column_name .= __('Transaction Date', 'event_espresso');
-        $ID_column_name .= '</span> ';
-        $this->_columns = array(
-            'TXN_ID'        => $ID_column_name,
-            'TXN_timestamp' => __('Transaction Date', 'event_espresso'),
-            'TXN_total'     => __('Total', 'event_espresso'),
-            'TXN_paid'      => __('Paid', 'event_espresso'),
-            'ATT_fname'     => __('Primary Registrant', 'event_espresso'),
-            'event_name'    => __('Event', 'event_espresso'),
-            'actions'       => __('Actions', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            'TXN_ID'        => array('TXN_ID' => false),
-            'event_name'    => array('event_name' => false),
-            'ATT_fname'     => array('ATT_fname' => false),
-            'TXN_timestamp' => array('TXN_timestamp' => true) // true means its already sorted
-        );
-
-        $this->_primary_column = 'TXN_ID';
-
-        $this->_hidden_columns = array();
-    }
-
-
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param  EE_Transaction $transaction the current item
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_row_class($transaction)
-    {
-        $class = parent::_get_row_class($transaction);
-        // add status class
-        $class .= ' ee-status-strip txn-status-' . $transaction->status_ID();
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * _get_table_filters
-     * We use this to assemble and return any filters that are associated with this table that help further refine what
-     * get's shown in the table.
-     *
-     * @abstract
-     * @access protected
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        $filters = array();
-        $start_date = isset($this->_req_data['txn-filter-start-date'])
-            ? wp_strip_all_tags($this->_req_data['txn-filter-start-date'])
-            : date(
-                'm/d/Y',
-                strtotime('-10 year')
-            );
-        $end_date = isset($this->_req_data['txn-filter-end-date'])
-            ? wp_strip_all_tags($this->_req_data['txn-filter-end-date'])
-            : date(
-                'm/d/Y',
-                current_time('timestamp')
-            );
-        ob_start();
-        ?>
+	/**
+	 * @var SessionLifespan $session_lifespan
+	 */
+	private $session_lifespan;
+
+	private $_status;
+
+
+	/**
+	 * @param \Transactions_Admin_Page $admin_page
+	 * @param SessionLifespan          $lifespan
+	 */
+	public function __construct(\Transactions_Admin_Page $admin_page, SessionLifespan $lifespan)
+	{
+		parent::__construct($admin_page);
+		$this->session_lifespan = $lifespan;
+		$this->_status = $this->_admin_page->get_transaction_status_array();
+	}
+
+
+	/**
+	 *_setup_data
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->_admin_page->get_transactions($this->_per_page);
+		$status = ! empty($this->_req_data['status']) ? $this->_req_data['status'] : 'all';
+		$this->_all_data_count = $this->_admin_page->get_transactions($this->_per_page, true, $status);
+	}
+
+
+	/**
+	 *_set_properties
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => __('transaction', 'event_espresso'),
+			'plural'   => __('transactions', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+		$ID_column_name = __('ID', 'event_espresso');
+		$ID_column_name .= ' : <span class="show-on-mobile-view-only" style="float:none">';
+		$ID_column_name .= __('Transaction Date', 'event_espresso');
+		$ID_column_name .= '</span> ';
+		$this->_columns = array(
+			'TXN_ID'        => $ID_column_name,
+			'TXN_timestamp' => __('Transaction Date', 'event_espresso'),
+			'TXN_total'     => __('Total', 'event_espresso'),
+			'TXN_paid'      => __('Paid', 'event_espresso'),
+			'ATT_fname'     => __('Primary Registrant', 'event_espresso'),
+			'event_name'    => __('Event', 'event_espresso'),
+			'actions'       => __('Actions', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			'TXN_ID'        => array('TXN_ID' => false),
+			'event_name'    => array('event_name' => false),
+			'ATT_fname'     => array('ATT_fname' => false),
+			'TXN_timestamp' => array('TXN_timestamp' => true) // true means its already sorted
+		);
+
+		$this->_primary_column = 'TXN_ID';
+
+		$this->_hidden_columns = array();
+	}
+
+
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param  EE_Transaction $transaction the current item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_row_class($transaction)
+	{
+		$class = parent::_get_row_class($transaction);
+		// add status class
+		$class .= ' ee-status-strip txn-status-' . $transaction->status_ID();
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * _get_table_filters
+	 * We use this to assemble and return any filters that are associated with this table that help further refine what
+	 * get's shown in the table.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = array();
+		$start_date = isset($this->_req_data['txn-filter-start-date'])
+			? wp_strip_all_tags($this->_req_data['txn-filter-start-date'])
+			: date(
+				'm/d/Y',
+				strtotime('-10 year')
+			);
+		$end_date = isset($this->_req_data['txn-filter-end-date'])
+			? wp_strip_all_tags($this->_req_data['txn-filter-end-date'])
+			: date(
+				'm/d/Y',
+				current_time('timestamp')
+			);
+		ob_start();
+		?>
         <label for="txn-filter-start-date">Display Transactions from </label>
         <input id="txn-filter-start-date" class="datepicker" type="text" value="<?php echo $start_date; ?>"
                name="txn-filter-start-date" size="15"/>
@@ -137,578 +137,578 @@ 
         <input id="txn-filter-end-date" class="datepicker" type="text" value="<?php echo $end_date; ?>"
                name="txn-filter-end-date" size="15"/>
         <?php
-        $filters[] = ob_get_contents();
-        ob_end_clean();
-        return $filters;
-    }
-
-
-    /**
-     *_add_view_counts
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_admin_page->get_transactions($this->_per_page, true, 'all');
-        $this->_views['abandoned']['count'] = $this->_admin_page->get_transactions($this->_per_page, true, 'abandoned');
-        $this->_views['failed']['count'] = $this->_admin_page->get_transactions($this->_per_page, true, 'failed');
-    }
-
-
-    /**
-     *    column TXN_ID
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_ID(EE_Transaction $transaction)
-    {
-        $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'view_transaction',
-                'TXN_ID' => $transaction->ID(),
-            ),
-            TXN_ADMIN_URL
-        );
-        $content = '<a href="' . $view_lnk_url . '"'
-                   . ' title="' . esc_attr__('Go to Transaction Details', 'event_espresso') . '">'
-                   . $transaction->ID()
-                   . '</a>';
-
-        // txn timestamp
-        $content .= '  <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($transaction) . '</span>';
-        return $content;
-    }
-
-
-    /**
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_txn_timestamp(EE_Transaction $transaction)
-    {
-        // is TXN less than 2 hours old ?
-        if (($transaction->failed() || $transaction->is_abandoned())
-            && $this->session_lifespan->expiration() < $transaction->datetime(false, true)
-        ) {
-            $timestamp = esc_html__('TXN in progress...', 'event_espresso');
-        } else {
-            $timestamp = $transaction->get_i18n_datetime('TXN_timestamp');
-        }
-        return $timestamp;
-    }
-
-
-    /**
-     *    column_cb
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_cb($transaction)
-    {
-        return sprintf(
-            '<input type="checkbox" name="%1$s[]" value="%2$s" />',
-            $this->_wp_list_args['singular'],
-            $transaction->ID()
-        );
-    }
-
-
-    /**
-     *    column_TXN_timestamp
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_timestamp(EE_Transaction $transaction)
-    {
-        $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'view_transaction',
-                'TXN_ID' => $transaction->ID(),
-            ),
-            TXN_ADMIN_URL
-        );
-        $txn_date = '<a href="' . $view_lnk_url . '"'
-                    . ' title="'
-                    . esc_attr__('View Transaction Details for TXN #', 'event_espresso') . $transaction->ID() . '">'
-                    . $this->_get_txn_timestamp($transaction)
-                    . '</a>';
-        // status
-        $txn_date .= '<br><span class="ee-status-text-small">'
-                    . EEH_Template::pretty_status(
-                        $transaction->status_ID(),
-                        false,
-                        'sentence'
-                    )
-                     . '</span>';
-        return $txn_date;
-    }
-
-
-    /**
-     *    column_TXN_total
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_total(EE_Transaction $transaction)
-    {
-        if ($transaction->get('TXN_total') > 0) {
-            return '<span class="txn-pad-rght">'
-                   . apply_filters(
-                       'FHEE__EE_Admin_Transactions_List_Table__column_TXN_total__TXN_total',
-                       $transaction->get_pretty('TXN_total'),
-                       $transaction
-                   )
-                   . '</span>';
-        } else {
-            return '<span class="txn-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>';
-        }
-    }
-
-
-    /**
-     *    column_TXN_paid
-     *
-     * @param \EE_Transaction $transaction
-     * @return mixed|string
-     * @throws \EE_Error
-     */
-    public function column_TXN_paid(EE_Transaction $transaction)
-    {
-        $transaction_total = $transaction->get('TXN_total');
-        $transaction_paid = $transaction->get('TXN_paid');
-
-        if (\EEH_Money::compare_floats($transaction_total, 0, '>')) {
-            // monies owing
-            $span_class = 'txn-overview-part-payment-spn';
-            if (\EEH_Money::compare_floats($transaction_paid, $transaction_total, '>=')) {
-                // paid in full
-                $span_class = 'txn-overview-full-payment-spn';
-            } elseif (\EEH_Money::compare_floats($transaction_paid, 0, '==')) {
-                // no payments made
-                $span_class = 'txn-overview-no-payment-spn';
-            }
-        } else {
-            // transaction_total == 0 so this is a free event
-            $span_class = 'txn-overview-free-event-spn';
-        }
-
-        $payment_method = $transaction->payment_method();
-        $payment_method_name = $payment_method instanceof EE_Payment_Method
-            ? $payment_method->admin_name()
-            : esc_html__('Unknown', 'event_espresso');
-
-        $content = '<span class="' . $span_class . ' txn-pad-rght">'
-                   . $transaction->get_pretty('TXN_paid')
-                   . '</span>';
-        if ($transaction_paid > 0) {
-            $content .= '<br><span class="ee-status-text-small">'
-                        . sprintf(
-                            esc_html__('...via %s', 'event_espresso'),
-                            $payment_method_name
-                        )
-                        . '</span>';
-        }
-        return $content;
-    }
-
-
-    /**
-     *    column_ATT_fname
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_ATT_fname(EE_Transaction $transaction)
-    {
-        $primary_reg = $transaction->primary_registration();
-        $attendee = $primary_reg->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'  => 'view_registration',
-                    '_REG_ID' => $primary_reg->ID(),
-                ),
-                REG_ADMIN_URL
-            );
-            $content = EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registration',
-                'espresso_registrations_view_registration',
-                $primary_reg->ID()
-            )
-                ? '<a href="' . $edit_lnk_url . '"'
-                  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
-                  . $attendee->full_name()
-                  . '</a>'
-                : $attendee->full_name();
-            $content .= '<br>' . $attendee->email();
-            return $content;
-        }
-        return $transaction->failed() || $transaction->is_abandoned()
-            ? esc_html__('no contact record.', 'event_espresso')
-            : esc_html__(
-                'No contact record, because the transaction was abandoned or the registration process failed.',
-                'event_espresso'
-            );
-    }
-
-
-    /**
-     *    column_ATT_email
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_ATT_email(EE_Transaction $transaction)
-    {
-        $attendee = $transaction->primary_registration()->get_first_related('Attendee');
-        if (! empty($attendee)) {
-            return '<a href="mailto:' . $attendee->get('ATT_email') . '">'
-                   . $attendee->get('ATT_email')
-                   . '</a>';
-        } else {
-            return $transaction->failed() || $transaction->is_abandoned()
-                ? esc_html__('no contact record.', 'event_espresso')
-                : esc_html__(
-                    'No contact record, because the transaction was abandoned or the registration process failed.',
-                    'event_espresso'
-                );
-        }
-    }
-
-
-    /**
-     *    column_event_name
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_event_name(EE_Transaction $transaction)
-    {
-        $actions = array();
-        $event = $transaction->primary_registration()->get_first_related('Event');
-        if (! empty($event)) {
-            $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'edit', 'post' => $event->ID()),
-                EVENTS_ADMIN_URL
-            );
-            $event_name = $event->get('EVT_name');
-
-            // filter this view by transactions for this event
-            $txn_by_event_lnk = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'default',
-                    'EVT_ID' => $event->ID(),
-                )
-            );
-            if (empty($this->_req_data['EVT_ID'])
-                && EE_Registry::instance()->CAP->current_user_can(
-                    'ee_edit_event',
-                    'espresso_events_edit',
-                    $event->ID()
-                )
-            ) {
-                $actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '"'
-                                              . ' title="' . esc_attr__(
-                                                  'Filter transactions by this event',
-                                                  'event_espresso'
-                                              ) . '">'
-                                              . esc_html__('View Transactions for this event', 'event_espresso')
-                                              . '</a>';
-            }
-
-            return sprintf(
-                '%1$s %2$s',
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_edit_event',
-                    'espresso_events_edit',
-                    $event->ID()
-                )
-                    ? '<a href="' . $edit_event_url . '"'
-                      . ' title="'
-                      . sprintf(
-                          esc_attr__('Edit Event: %s', 'event_espresso'),
-                          $event->get('EVT_name')
-                      )
-                      . '">'
-                      . wp_trim_words(
-                          $event_name,
-                          30,
-                          '...'
-                      )
-                      . '</a>'
-                    : wp_trim_words($event_name, 30, '...'),
-                $this->row_actions($actions)
-            );
-        } else {
-            return esc_html__(
-                'The event associated with this transaction via the primary registration cannot be retrieved.',
-                'event_espresso'
-            );
-        }
-    }
-
-
-    /**
-     *    column_actions
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_actions(EE_Transaction $transaction)
-    {
-        return $this->_action_string(
-            $this->get_transaction_details_link($transaction)
-            . $this->get_invoice_link($transaction)
-            . $this->get_receipt_link($transaction)
-            . $this->get_primary_registration_details_link($transaction)
-            . $this->get_send_payment_reminder_trigger_link($transaction)
-            . $this->get_payment_overview_link($transaction)
-            . $this->get_related_messages_link($transaction),
-            $transaction,
-            'ul',
-            'txn-overview-actions-ul'
-        );
-    }
-
-
-    /**
-     * Get the transaction details link.
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_transaction_details_link(EE_Transaction $transaction)
-    {
-        $url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'view_transaction',
-                'TXN_ID' => $transaction->ID(),
-            ),
-            TXN_ADMIN_URL
-        );
-        return '
+		$filters[] = ob_get_contents();
+		ob_end_clean();
+		return $filters;
+	}
+
+
+	/**
+	 *_add_view_counts
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_admin_page->get_transactions($this->_per_page, true, 'all');
+		$this->_views['abandoned']['count'] = $this->_admin_page->get_transactions($this->_per_page, true, 'abandoned');
+		$this->_views['failed']['count'] = $this->_admin_page->get_transactions($this->_per_page, true, 'failed');
+	}
+
+
+	/**
+	 *    column TXN_ID
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_ID(EE_Transaction $transaction)
+	{
+		$view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'view_transaction',
+				'TXN_ID' => $transaction->ID(),
+			),
+			TXN_ADMIN_URL
+		);
+		$content = '<a href="' . $view_lnk_url . '"'
+				   . ' title="' . esc_attr__('Go to Transaction Details', 'event_espresso') . '">'
+				   . $transaction->ID()
+				   . '</a>';
+
+		// txn timestamp
+		$content .= '  <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($transaction) . '</span>';
+		return $content;
+	}
+
+
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_txn_timestamp(EE_Transaction $transaction)
+	{
+		// is TXN less than 2 hours old ?
+		if (($transaction->failed() || $transaction->is_abandoned())
+			&& $this->session_lifespan->expiration() < $transaction->datetime(false, true)
+		) {
+			$timestamp = esc_html__('TXN in progress...', 'event_espresso');
+		} else {
+			$timestamp = $transaction->get_i18n_datetime('TXN_timestamp');
+		}
+		return $timestamp;
+	}
+
+
+	/**
+	 *    column_cb
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_cb($transaction)
+	{
+		return sprintf(
+			'<input type="checkbox" name="%1$s[]" value="%2$s" />',
+			$this->_wp_list_args['singular'],
+			$transaction->ID()
+		);
+	}
+
+
+	/**
+	 *    column_TXN_timestamp
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_timestamp(EE_Transaction $transaction)
+	{
+		$view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'view_transaction',
+				'TXN_ID' => $transaction->ID(),
+			),
+			TXN_ADMIN_URL
+		);
+		$txn_date = '<a href="' . $view_lnk_url . '"'
+					. ' title="'
+					. esc_attr__('View Transaction Details for TXN #', 'event_espresso') . $transaction->ID() . '">'
+					. $this->_get_txn_timestamp($transaction)
+					. '</a>';
+		// status
+		$txn_date .= '<br><span class="ee-status-text-small">'
+					. EEH_Template::pretty_status(
+						$transaction->status_ID(),
+						false,
+						'sentence'
+					)
+					 . '</span>';
+		return $txn_date;
+	}
+
+
+	/**
+	 *    column_TXN_total
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_total(EE_Transaction $transaction)
+	{
+		if ($transaction->get('TXN_total') > 0) {
+			return '<span class="txn-pad-rght">'
+				   . apply_filters(
+					   'FHEE__EE_Admin_Transactions_List_Table__column_TXN_total__TXN_total',
+					   $transaction->get_pretty('TXN_total'),
+					   $transaction
+				   )
+				   . '</span>';
+		} else {
+			return '<span class="txn-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>';
+		}
+	}
+
+
+	/**
+	 *    column_TXN_paid
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return mixed|string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_paid(EE_Transaction $transaction)
+	{
+		$transaction_total = $transaction->get('TXN_total');
+		$transaction_paid = $transaction->get('TXN_paid');
+
+		if (\EEH_Money::compare_floats($transaction_total, 0, '>')) {
+			// monies owing
+			$span_class = 'txn-overview-part-payment-spn';
+			if (\EEH_Money::compare_floats($transaction_paid, $transaction_total, '>=')) {
+				// paid in full
+				$span_class = 'txn-overview-full-payment-spn';
+			} elseif (\EEH_Money::compare_floats($transaction_paid, 0, '==')) {
+				// no payments made
+				$span_class = 'txn-overview-no-payment-spn';
+			}
+		} else {
+			// transaction_total == 0 so this is a free event
+			$span_class = 'txn-overview-free-event-spn';
+		}
+
+		$payment_method = $transaction->payment_method();
+		$payment_method_name = $payment_method instanceof EE_Payment_Method
+			? $payment_method->admin_name()
+			: esc_html__('Unknown', 'event_espresso');
+
+		$content = '<span class="' . $span_class . ' txn-pad-rght">'
+				   . $transaction->get_pretty('TXN_paid')
+				   . '</span>';
+		if ($transaction_paid > 0) {
+			$content .= '<br><span class="ee-status-text-small">'
+						. sprintf(
+							esc_html__('...via %s', 'event_espresso'),
+							$payment_method_name
+						)
+						. '</span>';
+		}
+		return $content;
+	}
+
+
+	/**
+	 *    column_ATT_fname
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_ATT_fname(EE_Transaction $transaction)
+	{
+		$primary_reg = $transaction->primary_registration();
+		$attendee = $primary_reg->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'  => 'view_registration',
+					'_REG_ID' => $primary_reg->ID(),
+				),
+				REG_ADMIN_URL
+			);
+			$content = EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registration',
+				'espresso_registrations_view_registration',
+				$primary_reg->ID()
+			)
+				? '<a href="' . $edit_lnk_url . '"'
+				  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
+				  . $attendee->full_name()
+				  . '</a>'
+				: $attendee->full_name();
+			$content .= '<br>' . $attendee->email();
+			return $content;
+		}
+		return $transaction->failed() || $transaction->is_abandoned()
+			? esc_html__('no contact record.', 'event_espresso')
+			: esc_html__(
+				'No contact record, because the transaction was abandoned or the registration process failed.',
+				'event_espresso'
+			);
+	}
+
+
+	/**
+	 *    column_ATT_email
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_ATT_email(EE_Transaction $transaction)
+	{
+		$attendee = $transaction->primary_registration()->get_first_related('Attendee');
+		if (! empty($attendee)) {
+			return '<a href="mailto:' . $attendee->get('ATT_email') . '">'
+				   . $attendee->get('ATT_email')
+				   . '</a>';
+		} else {
+			return $transaction->failed() || $transaction->is_abandoned()
+				? esc_html__('no contact record.', 'event_espresso')
+				: esc_html__(
+					'No contact record, because the transaction was abandoned or the registration process failed.',
+					'event_espresso'
+				);
+		}
+	}
+
+
+	/**
+	 *    column_event_name
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_event_name(EE_Transaction $transaction)
+	{
+		$actions = array();
+		$event = $transaction->primary_registration()->get_first_related('Event');
+		if (! empty($event)) {
+			$edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'edit', 'post' => $event->ID()),
+				EVENTS_ADMIN_URL
+			);
+			$event_name = $event->get('EVT_name');
+
+			// filter this view by transactions for this event
+			$txn_by_event_lnk = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'default',
+					'EVT_ID' => $event->ID(),
+				)
+			);
+			if (empty($this->_req_data['EVT_ID'])
+				&& EE_Registry::instance()->CAP->current_user_can(
+					'ee_edit_event',
+					'espresso_events_edit',
+					$event->ID()
+				)
+			) {
+				$actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '"'
+											  . ' title="' . esc_attr__(
+												  'Filter transactions by this event',
+												  'event_espresso'
+											  ) . '">'
+											  . esc_html__('View Transactions for this event', 'event_espresso')
+											  . '</a>';
+			}
+
+			return sprintf(
+				'%1$s %2$s',
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_edit_event',
+					'espresso_events_edit',
+					$event->ID()
+				)
+					? '<a href="' . $edit_event_url . '"'
+					  . ' title="'
+					  . sprintf(
+						  esc_attr__('Edit Event: %s', 'event_espresso'),
+						  $event->get('EVT_name')
+					  )
+					  . '">'
+					  . wp_trim_words(
+						  $event_name,
+						  30,
+						  '...'
+					  )
+					  . '</a>'
+					: wp_trim_words($event_name, 30, '...'),
+				$this->row_actions($actions)
+			);
+		} else {
+			return esc_html__(
+				'The event associated with this transaction via the primary registration cannot be retrieved.',
+				'event_espresso'
+			);
+		}
+	}
+
+
+	/**
+	 *    column_actions
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_actions(EE_Transaction $transaction)
+	{
+		return $this->_action_string(
+			$this->get_transaction_details_link($transaction)
+			. $this->get_invoice_link($transaction)
+			. $this->get_receipt_link($transaction)
+			. $this->get_primary_registration_details_link($transaction)
+			. $this->get_send_payment_reminder_trigger_link($transaction)
+			. $this->get_payment_overview_link($transaction)
+			. $this->get_related_messages_link($transaction),
+			$transaction,
+			'ul',
+			'txn-overview-actions-ul'
+		);
+	}
+
+
+	/**
+	 * Get the transaction details link.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_transaction_details_link(EE_Transaction $transaction)
+	{
+		$url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'view_transaction',
+				'TXN_ID' => $transaction->ID(),
+			),
+			TXN_ADMIN_URL
+		);
+		return '
 			<li>
 				<a href="' . $url . '"'
-               . ' title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text">
+			   . ' title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text">
 					<span class="dashicons dashicons-cart"></span>
 				</a>
 			</li>';
-    }
-
-
-    /**
-     * Get the invoice link for the given registration.
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_invoice_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if ($registration instanceof EE_Registration) {
-            $url = $registration->invoice_url();
-            // only show invoice link if message type is active.
-            if ($registration->attendee() instanceof EE_Attendee
-                && EEH_MSG_Template::is_mt_active('invoice')
-            ) {
-                return '
+	}
+
+
+	/**
+	 * Get the invoice link for the given registration.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_invoice_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if ($registration instanceof EE_Registration) {
+			$url = $registration->invoice_url();
+			// only show invoice link if message type is active.
+			if ($registration->attendee() instanceof EE_Attendee
+				&& EEH_MSG_Template::is_mt_active('invoice')
+			) {
+				return '
                 <li>
                     <a title="' . esc_attr__('View Transaction Invoice', 'event_espresso') . '"'
-                       . ' target="_blank" href="' . $url . '" class="tiny-text">
+					   . ' target="_blank" href="' . $url . '" class="tiny-text">
                         <span class="dashicons dashicons-media-spreadsheet ee-icon-size-18"></span>
                     </a>
                 </li>';
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * Get the receipt link for the transaction.
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_receipt_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if ($registration instanceof EE_Registration) {
-            $url = $registration->receipt_url();
-            // only show receipt link if message type is active.
-            if ($registration->attendee() instanceof EE_Attendee
-                && EEH_MSG_Template::is_mt_active('receipt')) {
-                return '
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * Get the receipt link for the transaction.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_receipt_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if ($registration instanceof EE_Registration) {
+			$url = $registration->receipt_url();
+			// only show receipt link if message type is active.
+			if ($registration->attendee() instanceof EE_Attendee
+				&& EEH_MSG_Template::is_mt_active('receipt')) {
+				return '
 			<li>
 				<a title="' . esc_attr__('View Transaction Receipt', 'event_espresso') . '"'
-                       . ' target="_blank" href="' . $url . '" class="tiny-text">
+					   . ' target="_blank" href="' . $url . '" class="tiny-text">
 					<span class="dashicons dashicons-media-default ee-icon-size-18"></span>
 				</a>
 			</li>';
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * Get the link to view the details for the primary registration.
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function get_primary_registration_details_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if ($registration instanceof EE_Registration) {
-            $url = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'  => 'view_registration',
-                    '_REG_ID' => $registration->ID(),
-                ),
-                REG_ADMIN_URL
-            );
-            return EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registration',
-                'espresso_registrations_view_registration',
-                $registration->ID()
-            )
-                ? '
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * Get the link to view the details for the primary registration.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function get_primary_registration_details_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if ($registration instanceof EE_Registration) {
+			$url = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'  => 'view_registration',
+					'_REG_ID' => $registration->ID(),
+				),
+				REG_ADMIN_URL
+			);
+			return EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registration',
+				'espresso_registrations_view_registration',
+				$registration->ID()
+			)
+				? '
 				<li>
 					<a href="' . $url . '"'
-                  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text">
+				  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text">
 						<span class="dashicons dashicons-clipboard"></span>
 					</a>
 				</li>'
-                : '';
-        }
-        return '';
-    }
-
-
-    /**
-     * Get send payment reminder trigger link
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function get_send_payment_reminder_trigger_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if ($registration instanceof EE_Registration
-            && $registration->attendee() instanceof EE_Attendee
-            && EEH_MSG_Template::is_mt_active('payment_reminder')
-            && ! in_array(
-                $transaction->status_ID(),
-                array(EEM_Transaction::complete_status_code, EEM_Transaction::overpaid_status_code),
-                true
-            )
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_transactions_send_payment_reminder'
-            )
-        ) {
-            $url = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'send_payment_reminder',
-                    'TXN_ID' => $transaction->ID(),
-                ),
-                TXN_ADMIN_URL
-            );
-            return '
+				: '';
+		}
+		return '';
+	}
+
+
+	/**
+	 * Get send payment reminder trigger link
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function get_send_payment_reminder_trigger_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if ($registration instanceof EE_Registration
+			&& $registration->attendee() instanceof EE_Attendee
+			&& EEH_MSG_Template::is_mt_active('payment_reminder')
+			&& ! in_array(
+				$transaction->status_ID(),
+				array(EEM_Transaction::complete_status_code, EEM_Transaction::overpaid_status_code),
+				true
+			)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_transactions_send_payment_reminder'
+			)
+		) {
+			$url = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'send_payment_reminder',
+					'TXN_ID' => $transaction->ID(),
+				),
+				TXN_ADMIN_URL
+			);
+			return '
             <li>
                 <a href="' . $url . '"'
-                   . ' title="' . esc_attr__('Send Payment Reminder', 'event_espresso') . '" class="tiny-text">
+				   . ' title="' . esc_attr__('Send Payment Reminder', 'event_espresso') . '" class="tiny-text">
                     <span class="dashicons dashicons-email-alt"></span>
                 </a>
             </li>';
-        }
-        return '';
-    }
-
-
-    /**
-     * Get link to filtered view in the message activity list table of messages for this transaction.
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function get_related_messages_link(EE_Transaction $transaction)
-    {
-        $url = EEH_MSG_Template::get_message_action_link(
-            'see_notifications_for',
-            null,
-            array('TXN_ID' => $transaction->ID())
-        );
-        return EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_global_messages',
-            'view_filtered_messages'
-        )
-            ? '<li>' . $url . '</li>'
-            : '';
-    }
-
-
-    /**
-     * Return the link to make a payment on the frontend
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_payment_overview_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if ($registration instanceof EE_Registration
-            && $transaction->status_ID() !== EEM_Transaction::complete_status_code
-            && $registration->owes_monies_and_can_pay()
-        ) {
-            return '
+		}
+		return '';
+	}
+
+
+	/**
+	 * Get link to filtered view in the message activity list table of messages for this transaction.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function get_related_messages_link(EE_Transaction $transaction)
+	{
+		$url = EEH_MSG_Template::get_message_action_link(
+			'see_notifications_for',
+			null,
+			array('TXN_ID' => $transaction->ID())
+		);
+		return EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_global_messages',
+			'view_filtered_messages'
+		)
+			? '<li>' . $url . '</li>'
+			: '';
+	}
+
+
+	/**
+	 * Return the link to make a payment on the frontend
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_payment_overview_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if ($registration instanceof EE_Registration
+			&& $transaction->status_ID() !== EEM_Transaction::complete_status_code
+			&& $registration->owes_monies_and_can_pay()
+		) {
+			return '
             <li>
                 <a title="' . esc_attr__('Make Payment from the Frontend.', 'event_espresso') . '"'
-                   . ' target="_blank" href="' . $registration->payment_overview_url(true) . '"'
-                   . ' class="tiny-text">
+				   . ' target="_blank" href="' . $registration->payment_overview_url(true) . '"'
+				   . ' class="tiny-text">
                     <span class="dashicons dashicons-money ee-icon-size-18"></span>
                 </a>
             </li>
             ';
-        }
-        return '';
-    }
+		}
+		return '';
+	}
 }

core/services/assets/AssetCollection.php

Spacing +2 added lines, -2 removed lines

@@ -75,7 +75,7 @@ 
             /** @var Asset $asset */
             $asset = $this->current();
             if ($asset->type() === $type) {
-                $files[ $asset->handle() ] = $asset;
+                $files[$asset->handle()] = $asset;
             }
             $this->next();
         }
@@ -96,7 +96,7 @@ 
             /** @var JavascriptAsset $asset */
             $asset = $this->current();
             if ($asset->type() === Asset::TYPE_JS && $asset->hasInlineData()) {
-                $files[ $asset->handle() ] = $asset;
+                $files[$asset->handle()] = $asset;
             }
             $this->next();
         }

Indentation +197 added lines, -197 removed lines

@@ -21,201 +21,201 @@
 {
 
 
-    /**
-     * AssetCollection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct('EventEspresso\core\domain\values\assets\Asset');
-    }
-
-
-    /**
-     * @return StylesheetAsset[]
-     * @since 4.9.62.p
-     */
-    public function getStylesheetAssets()
-    {
-        return $this->getAssetsOfType(Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * @return JavascriptAsset[]
-     * @since 4.9.62.p
-     */
-    public function getJavascriptAssets()
-    {
-        return $this->getAssetsOfType(Asset::TYPE_JS);
-    }
-
-
-    /**
-     * @return ManifestFile[]
-     * @since 4.9.62.p
-     */
-    public function getManifestFiles()
-    {
-        return $this->getAssetsOfType(Asset::TYPE_MANIFEST);
-    }
-
-
-    /**
-     * @param $type
-     * @return JavascriptAsset[]|StylesheetAsset[]|ManifestFile[]
-     * @since 4.9.62.p
-     */
-    protected function getAssetsOfType($type)
-    {
-        $files = array();
-        $this->rewind();
-        while ($this->valid()) {
-            /** @var Asset $asset */
-            $asset = $this->current();
-            if ($asset->type() === $type) {
-                $files[ $asset->handle() ] = $asset;
-            }
-            $this->next();
-        }
-        $this->rewind();
-        return $files;
-    }
-
-
-    /**
-     * @return JavascriptAsset[]
-     * @since 4.9.62.p
-     */
-    public function getJavascriptAssetsWithData()
-    {
-        $files = array();
-        $this->rewind();
-        while ($this->valid()) {
-            /** @var JavascriptAsset $asset */
-            $asset = $this->current();
-            if ($asset->type() === Asset::TYPE_JS && $asset->hasInlineData()) {
-                $files[ $asset->handle() ] = $asset;
-            }
-            $this->next();
-        }
-        $this->rewind();
-        return $files;
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the object is within the Collection
-     * based on the supplied $identifier and type
-     *
-     * @param  mixed $identifier
-     * @param string $type
-     * @return bool
-     * @since $VID:$
-     */
-    public function hasAssetOfType($identifier, $type = Asset::TYPE_JS)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->getInfo() === $identifier && $this->current()->type() === $type) {
-                $this->rewind();
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the Stylesheet Asset is within the Collection
-     * based on the supplied $identifier
-     *
-     * @param  mixed $identifier
-     * @return bool
-     * @since $VID:$
-     */
-    public function hasStylesheetAsset($identifier)
-    {
-        return $this->hasAssetOfType($identifier, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the Javascript Asset is within the Collection
-     * based on the supplied $identifier
-     *
-     * @param  mixed $identifier
-     * @return bool
-     * @since $VID:$
-     */
-    public function hasJavascriptAsset($identifier)
-    {
-        return $this->hasAssetOfType($identifier, Asset::TYPE_JS);
-    }
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the object is within the Collection
-     * based on the supplied $identifier and type
-     *
-     * @param  mixed $identifier
-     * @param string $type
-     * @return JavascriptAsset|StylesheetAsset
-     * @since $VID:$
-     */
-    public function getAssetOfType($identifier, $type = Asset::TYPE_JS)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->getInfo() === $identifier && $this->current()->type() === $type) {
-                /** @var JavascriptAsset|StylesheetAsset $object */
-                $object = $this->current();
-                $this->rewind();
-                return $object;
-            }
-            $this->next();
-        }
-        return null;
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the Stylesheet Asset is within the Collection
-     * based on the supplied $identifier
-     *
-     * @param  mixed $identifier
-     * @return StylesheetAsset
-     * @since $VID:$
-     */
-    public function getStylesheetAsset($identifier)
-    {
-        return $this->getAssetOfType($identifier, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the Javascript Asset is within the Collection
-     * based on the supplied $identifier
-     *
-     * @param  mixed $identifier
-     * @return JavascriptAsset
-     * @since $VID:$
-     */
-    public function getJavascriptAsset($identifier)
-    {
-        return $this->getAssetOfType($identifier, Asset::TYPE_JS);
-    }
+	/**
+	 * AssetCollection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct('EventEspresso\core\domain\values\assets\Asset');
+	}
+
+
+	/**
+	 * @return StylesheetAsset[]
+	 * @since 4.9.62.p
+	 */
+	public function getStylesheetAssets()
+	{
+		return $this->getAssetsOfType(Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * @return JavascriptAsset[]
+	 * @since 4.9.62.p
+	 */
+	public function getJavascriptAssets()
+	{
+		return $this->getAssetsOfType(Asset::TYPE_JS);
+	}
+
+
+	/**
+	 * @return ManifestFile[]
+	 * @since 4.9.62.p
+	 */
+	public function getManifestFiles()
+	{
+		return $this->getAssetsOfType(Asset::TYPE_MANIFEST);
+	}
+
+
+	/**
+	 * @param $type
+	 * @return JavascriptAsset[]|StylesheetAsset[]|ManifestFile[]
+	 * @since 4.9.62.p
+	 */
+	protected function getAssetsOfType($type)
+	{
+		$files = array();
+		$this->rewind();
+		while ($this->valid()) {
+			/** @var Asset $asset */
+			$asset = $this->current();
+			if ($asset->type() === $type) {
+				$files[ $asset->handle() ] = $asset;
+			}
+			$this->next();
+		}
+		$this->rewind();
+		return $files;
+	}
+
+
+	/**
+	 * @return JavascriptAsset[]
+	 * @since 4.9.62.p
+	 */
+	public function getJavascriptAssetsWithData()
+	{
+		$files = array();
+		$this->rewind();
+		while ($this->valid()) {
+			/** @var JavascriptAsset $asset */
+			$asset = $this->current();
+			if ($asset->type() === Asset::TYPE_JS && $asset->hasInlineData()) {
+				$files[ $asset->handle() ] = $asset;
+			}
+			$this->next();
+		}
+		$this->rewind();
+		return $files;
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the object is within the Collection
+	 * based on the supplied $identifier and type
+	 *
+	 * @param  mixed $identifier
+	 * @param string $type
+	 * @return bool
+	 * @since $VID:$
+	 */
+	public function hasAssetOfType($identifier, $type = Asset::TYPE_JS)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->getInfo() === $identifier && $this->current()->type() === $type) {
+				$this->rewind();
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the Stylesheet Asset is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @param  mixed $identifier
+	 * @return bool
+	 * @since $VID:$
+	 */
+	public function hasStylesheetAsset($identifier)
+	{
+		return $this->hasAssetOfType($identifier, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the Javascript Asset is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @param  mixed $identifier
+	 * @return bool
+	 * @since $VID:$
+	 */
+	public function hasJavascriptAsset($identifier)
+	{
+		return $this->hasAssetOfType($identifier, Asset::TYPE_JS);
+	}
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the object is within the Collection
+	 * based on the supplied $identifier and type
+	 *
+	 * @param  mixed $identifier
+	 * @param string $type
+	 * @return JavascriptAsset|StylesheetAsset
+	 * @since $VID:$
+	 */
+	public function getAssetOfType($identifier, $type = Asset::TYPE_JS)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->getInfo() === $identifier && $this->current()->type() === $type) {
+				/** @var JavascriptAsset|StylesheetAsset $object */
+				$object = $this->current();
+				$this->rewind();
+				return $object;
+			}
+			$this->next();
+		}
+		return null;
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the Stylesheet Asset is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @param  mixed $identifier
+	 * @return StylesheetAsset
+	 * @since $VID:$
+	 */
+	public function getStylesheetAsset($identifier)
+	{
+		return $this->getAssetOfType($identifier, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the Javascript Asset is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @param  mixed $identifier
+	 * @return JavascriptAsset
+	 * @since $VID:$
+	 */
+	public function getJavascriptAsset($identifier)
+	{
+		return $this->getAssetOfType($identifier, Asset::TYPE_JS);
+	}
 }

core/services/assets/Registry.php

Indentation +548 added lines, -548 removed lines

@@ -23,559 +23,559 @@
 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();
-
-
-    /**
-     * Registry constructor.
-     * Hooking into WP actions for script registry.
-     *
-     * @param AssetCollection $assets
-     * @param I18nRegistry    $i18n_registry
-     */
-    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 && defined('EE_DEBUG') && EE_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 appended to the end of an 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, then
-     * this will throw an exception.
-     *
-     * @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 ])
-        ) {
-            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();
+
+
+	/**
+	 * Registry constructor.
+	 * Hooking into WP actions for script registry.
+	 *
+	 * @param AssetCollection $assets
+	 * @param I18nRegistry    $i18n_registry
+	 */
+	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 && defined('EE_DEBUG') && EE_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 appended to the end of an 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, then
+	 * this will throw an exception.
+	 *
+	 * @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 ])
+		) {
+			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__
-                )
-            );
-        }
-        $this->jsdata[ $key ][] = $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 ])) {
-            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 (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__
+				)
+			);
+		}
+		$this->jsdata[ $key ][] = $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 ])) {
+			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 (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);
-    }
-
-
-    /**
-     * @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
-            );
-        }
-    }
-
-
-    /**
-     * 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.
-     * @throws InvalidArgumentException
-     * @throws InvalidFilePathException
-     * @since 4.9.59.p
-     */
-    public function registerManifestFile($namespace, $url_base, $manifest_file)
-    {
-        if (isset($this->manifest_data[ $namespace ])) {
-            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);
-        }
-    }
-
-
-    /**
-     * 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);
+	}
+
+
+	/**
+	 * @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
+			);
+		}
+	}
+
+
+	/**
+	 * 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.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFilePathException
+	 * @since 4.9.59.p
+	 */
+	public function registerManifestFile($namespace, $url_base, $manifest_file)
+	{
+		if (isset($this->manifest_data[ $namespace ])) {
+			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);
+		}
+	}
+
+
+	/**
+	 * 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);
-    }
+	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);
+	}
 }

core/services/assets/I18nRegistry.php

Indentation +234 added lines, -234 removed lines

@@ -14,238 +14,238 @@
  */
 class I18nRegistry
 {
-    /**
-     * @var DomainInterface
-     */
-    private $domain;
-
-    /**
-     * Will hold all registered i18n scripts.  Prevents script handles from being registered more than once.
-     *
-     * @var array
-     */
-    private $registered_i18n = array();
-
-
-    /**
-     * Used to hold queued translations for the chunks loading in a view.
-     *
-     * @var array
-     */
-    private $queued_handle_translations = array();
-
-    /**
-     * Used to track script handles queued for adding translation strings as inline data in the dom.
-     *
-     * @var array
-     */
-    private $queued_scripts = array();
-
-
-    /**
-     * Obtained from the generated json file from the all javascript using wp.i18n with a map of script handle names to
-     * translation strings.
-     *
-     * @var array
-     */
-    private $i18n_map;
-
-
-    /**
-     * I18nRegistry constructor.
-     *
-     * @param array() $i18n_map  An array of script handle names and the strings translated for those handles.  If not
-     *                            provided, the class will look for map in root of plugin with filename of
-     *                            'translation-map.json'.
-     * @param DomainInterface $domain
-     */
-    public function __construct(array $i18n_map = array(), DomainInterface $domain)
-    {
-        $this->domain = $domain;
-        $this->setI18nMap($i18n_map);
-        add_filter('print_scripts_array', array($this, 'queueI18n'));
-    }
-
-
-    /**
-     * Used to register a script that has i18n strings for its $handle
-     *
-     * @param string $handle The script handle reference.
-     * @param string $domain The i18n domain for the strings.
-     */
-    public function registerScriptI18n($handle, $domain = 'event_espresso')
-    {
-        if(! isset($this->registered_i18n[$handle])) {
-            $this->registered_i18n[ $handle ] = 1;
-            $this->queued_scripts[ $handle ] = $domain;
-        }
-    }
-
-
-
-    /**
-     * Callback on print_scripts_array to listen for scripts enqueued and handle setting up the localized data.
-     *
-     * @param array $handles Array of registered script handles.
-     * @return array
-     */
-    public function queueI18n(array $handles)
-    {
-        if (empty($this->queued_scripts)) {
-            return $handles;
-        }
-        foreach ($handles as $handle) {
-            $this->queueI18nTranslationsForHandle($handle);
-        }
-        if ($this->queued_handle_translations) {
-            foreach ($this->queued_handle_translations as $handle => $translations_for_domain) {
-                $this->registerInlineScript(
-                    $handle,
-                    $translations_for_domain['translations'],
-                    $translations_for_domain['domain']
-                );
-            }
-        }
-        return $handles;
-    }
-
-
-    /**
-     * Registers inline script with translations for given handle and domain.
-     *
-     * @param string $handle       Handle used to register javascript file containing translations.
-     * @param array  $translations Array of string translations.
-     * @param string $domain       Domain for translations.  If left empty then strings are registered with the default
-     *                             domain for the javascript.
-     */
-    protected function registerInlineScript($handle, array $translations, $domain)
-    {
-        $script = $domain ?
-            'eejs.i18n.setLocaleData( ' . wp_json_encode($translations) . ', "' . $domain . '" );' :
-            'eejs.i18n.setLocaleData( ' . wp_json_encode($translations) . ' );';
-        wp_add_inline_script($handle, $script, 'before');
-    }
-
-
-    /**
-     * Queues up the translation strings for the given handle.
-     *
-     * @param string $handle The script handle being queued up.
-     */
-    private function queueI18nTranslationsForHandle($handle)
-    {
-        if (isset($this->queued_scripts[$handle])) {
-            $domain = $this->queued_scripts[$handle];
-            $translations = $this->getJedLocaleDataForDomainAndChunk($handle, $domain);
-            if (count($translations) > 0) {
-                $this->queued_handle_translations[$handle] = array(
-                    'domain'       => $domain,
-                    'translations' => $translations,
-                );
-            }
-            unset($this->queued_scripts[$handle]);
-        }
-    }
-
-
-    /**
-     * Sets the internal i18n_map property.
-     * If $chunk_map is empty or not an array, will attempt to load a chunk map from a default named map.
-     *
-     * @param array $i18n_map  If provided, an array of translation strings indexed by script handle names they
-     *                         correspond to.
-     */
-    private function setI18nMap(array $i18n_map)
-    {
-        if (empty($i18n_map)) {
-            $i18n_map = file_exists($this->domain->pluginPath() . 'translation-map.json')
-                ? json_decode(
-                        file_get_contents($this->domain->pluginPath() . 'translation-map.json'),
-                        true
-                    )
-                : array();
-        }
-        $this->i18n_map = $i18n_map;
-    }
-
-
-    /**
-     * Get the jed locale data for a given $handle and domain
-     *
-     * @param string $handle The name for the script handle we want strings returned for.
-     * @param string $domain The i18n domain.
-     * @return array
-     */
-    protected function getJedLocaleDataForDomainAndChunk($handle, $domain)
-    {
-        $translations = $this->getJedLocaleData($domain);
-        // get index for adding back after extracting strings for this $chunk.
-        $index = $translations[''];
-        $translations = $this->getLocaleDataMatchingMap(
-            $this->getOriginalStringsForHandleFromMap($handle),
-            $translations
-        );
-        $translations[''] = $index;
-        return $translations;
-    }
-
-
-    /**
-     * Get locale data for given strings from given translations
-     *
-     * @param array $string_set   This is the subset of strings (msgIds) we want to extract from the translations array.
-     * @param array $translations Translation data to extra strings from.
-     * @return array
-     */
-    protected function getLocaleDataMatchingMap(array $string_set, array $translations)
-    {
-        if (empty($string_set)) {
-            return array();
-        }
-        // some strings with quotes in them will break on the array_flip, so making sure quotes in the string are
-        // slashed also filter falsey values.
-        $string_set = array_unique(array_filter(wp_slash($string_set)));
-        return array_intersect_key($translations, array_flip($string_set));
-    }
-
-
-    /**
-     * Get original strings to translate for the given chunk from the map
-     *
-     * @param string $handle The script handle name to get strings from the map for.
-     * @return array
-     */
-    protected function getOriginalStringsForHandleFromMap($handle)
-    {
-        return isset($this->i18n_map[$handle]) ? $this->i18n_map[$handle] : array();
-    }
-
-
-    /**
-     * Returns Jed-formatted localization data.
-     *
-     * @param  string $domain Translation domain.
-     * @return array
-     */
-    private function getJedLocaleData($domain)
-    {
-        $translations = get_translations_for_domain($domain);
-
-        $locale = array(
-            '' => array(
-                'domain' => $domain,
-                'lang'   => is_admin() ? get_user_locale() : get_locale(),
-            ),
-        );
-
-        if (! empty($translations->headers['Plural-Forms'])) {
-            $locale['']['plural_forms'] = $translations->headers['Plural-Forms'];
-        }
-
-        foreach ($translations->entries as $msgid => $entry) {
-            $locale[$msgid] = $entry->translations;
-        }
-
-        return $locale;
-    }
+	/**
+	 * @var DomainInterface
+	 */
+	private $domain;
+
+	/**
+	 * Will hold all registered i18n scripts.  Prevents script handles from being registered more than once.
+	 *
+	 * @var array
+	 */
+	private $registered_i18n = array();
+
+
+	/**
+	 * Used to hold queued translations for the chunks loading in a view.
+	 *
+	 * @var array
+	 */
+	private $queued_handle_translations = array();
+
+	/**
+	 * Used to track script handles queued for adding translation strings as inline data in the dom.
+	 *
+	 * @var array
+	 */
+	private $queued_scripts = array();
+
+
+	/**
+	 * Obtained from the generated json file from the all javascript using wp.i18n with a map of script handle names to
+	 * translation strings.
+	 *
+	 * @var array
+	 */
+	private $i18n_map;
+
+
+	/**
+	 * I18nRegistry constructor.
+	 *
+	 * @param array() $i18n_map  An array of script handle names and the strings translated for those handles.  If not
+	 *                            provided, the class will look for map in root of plugin with filename of
+	 *                            'translation-map.json'.
+	 * @param DomainInterface $domain
+	 */
+	public function __construct(array $i18n_map = array(), DomainInterface $domain)
+	{
+		$this->domain = $domain;
+		$this->setI18nMap($i18n_map);
+		add_filter('print_scripts_array', array($this, 'queueI18n'));
+	}
+
+
+	/**
+	 * Used to register a script that has i18n strings for its $handle
+	 *
+	 * @param string $handle The script handle reference.
+	 * @param string $domain The i18n domain for the strings.
+	 */
+	public function registerScriptI18n($handle, $domain = 'event_espresso')
+	{
+		if(! isset($this->registered_i18n[$handle])) {
+			$this->registered_i18n[ $handle ] = 1;
+			$this->queued_scripts[ $handle ] = $domain;
+		}
+	}
+
+
+
+	/**
+	 * Callback on print_scripts_array to listen for scripts enqueued and handle setting up the localized data.
+	 *
+	 * @param array $handles Array of registered script handles.
+	 * @return array
+	 */
+	public function queueI18n(array $handles)
+	{
+		if (empty($this->queued_scripts)) {
+			return $handles;
+		}
+		foreach ($handles as $handle) {
+			$this->queueI18nTranslationsForHandle($handle);
+		}
+		if ($this->queued_handle_translations) {
+			foreach ($this->queued_handle_translations as $handle => $translations_for_domain) {
+				$this->registerInlineScript(
+					$handle,
+					$translations_for_domain['translations'],
+					$translations_for_domain['domain']
+				);
+			}
+		}
+		return $handles;
+	}
+
+
+	/**
+	 * Registers inline script with translations for given handle and domain.
+	 *
+	 * @param string $handle       Handle used to register javascript file containing translations.
+	 * @param array  $translations Array of string translations.
+	 * @param string $domain       Domain for translations.  If left empty then strings are registered with the default
+	 *                             domain for the javascript.
+	 */
+	protected function registerInlineScript($handle, array $translations, $domain)
+	{
+		$script = $domain ?
+			'eejs.i18n.setLocaleData( ' . wp_json_encode($translations) . ', "' . $domain . '" );' :
+			'eejs.i18n.setLocaleData( ' . wp_json_encode($translations) . ' );';
+		wp_add_inline_script($handle, $script, 'before');
+	}
+
+
+	/**
+	 * Queues up the translation strings for the given handle.
+	 *
+	 * @param string $handle The script handle being queued up.
+	 */
+	private function queueI18nTranslationsForHandle($handle)
+	{
+		if (isset($this->queued_scripts[$handle])) {
+			$domain = $this->queued_scripts[$handle];
+			$translations = $this->getJedLocaleDataForDomainAndChunk($handle, $domain);
+			if (count($translations) > 0) {
+				$this->queued_handle_translations[$handle] = array(
+					'domain'       => $domain,
+					'translations' => $translations,
+				);
+			}
+			unset($this->queued_scripts[$handle]);
+		}
+	}
+
+
+	/**
+	 * Sets the internal i18n_map property.
+	 * If $chunk_map is empty or not an array, will attempt to load a chunk map from a default named map.
+	 *
+	 * @param array $i18n_map  If provided, an array of translation strings indexed by script handle names they
+	 *                         correspond to.
+	 */
+	private function setI18nMap(array $i18n_map)
+	{
+		if (empty($i18n_map)) {
+			$i18n_map = file_exists($this->domain->pluginPath() . 'translation-map.json')
+				? json_decode(
+						file_get_contents($this->domain->pluginPath() . 'translation-map.json'),
+						true
+					)
+				: array();
+		}
+		$this->i18n_map = $i18n_map;
+	}
+
+
+	/**
+	 * Get the jed locale data for a given $handle and domain
+	 *
+	 * @param string $handle The name for the script handle we want strings returned for.
+	 * @param string $domain The i18n domain.
+	 * @return array
+	 */
+	protected function getJedLocaleDataForDomainAndChunk($handle, $domain)
+	{
+		$translations = $this->getJedLocaleData($domain);
+		// get index for adding back after extracting strings for this $chunk.
+		$index = $translations[''];
+		$translations = $this->getLocaleDataMatchingMap(
+			$this->getOriginalStringsForHandleFromMap($handle),
+			$translations
+		);
+		$translations[''] = $index;
+		return $translations;
+	}
+
+
+	/**
+	 * Get locale data for given strings from given translations
+	 *
+	 * @param array $string_set   This is the subset of strings (msgIds) we want to extract from the translations array.
+	 * @param array $translations Translation data to extra strings from.
+	 * @return array
+	 */
+	protected function getLocaleDataMatchingMap(array $string_set, array $translations)
+	{
+		if (empty($string_set)) {
+			return array();
+		}
+		// some strings with quotes in them will break on the array_flip, so making sure quotes in the string are
+		// slashed also filter falsey values.
+		$string_set = array_unique(array_filter(wp_slash($string_set)));
+		return array_intersect_key($translations, array_flip($string_set));
+	}
+
+
+	/**
+	 * Get original strings to translate for the given chunk from the map
+	 *
+	 * @param string $handle The script handle name to get strings from the map for.
+	 * @return array
+	 */
+	protected function getOriginalStringsForHandleFromMap($handle)
+	{
+		return isset($this->i18n_map[$handle]) ? $this->i18n_map[$handle] : array();
+	}
+
+
+	/**
+	 * Returns Jed-formatted localization data.
+	 *
+	 * @param  string $domain Translation domain.
+	 * @return array
+	 */
+	private function getJedLocaleData($domain)
+	{
+		$translations = get_translations_for_domain($domain);
+
+		$locale = array(
+			'' => array(
+				'domain' => $domain,
+				'lang'   => is_admin() ? get_user_locale() : get_locale(),
+			),
+		);
+
+		if (! empty($translations->headers['Plural-Forms'])) {
+			$locale['']['plural_forms'] = $translations->headers['Plural-Forms'];
+		}
+
+		foreach ($translations->entries as $msgid => $entry) {
+			$locale[$msgid] = $entry->translations;
+		}
+
+		return $locale;
+	}
 }
\ No newline at end of file

core/services/assets/AssetManager.php

Indentation +138 added lines, -138 removed lines

@@ -21,142 +21,142 @@
 abstract class AssetManager implements AssetManagerInterface
 {
 
-    /**
-     * @var AssetCollection $assets
-     */
-    protected $assets;
-
-    /**
-     * @var DomainInterface
-     */
-    protected $domain;
-
-    /**
-     * @var Registry $registry
-     */
-    protected $registry;
-
-
-    /**
-     * AssetRegister constructor.
-     *
-     * @param DomainInterface $domain
-     * @param AssetCollection $assets
-     * @param Registry        $registry
-     */
-    public function __construct(DomainInterface $domain, AssetCollection $assets, Registry $registry)
-    {
-        $this->domain = $domain;
-        $this->assets = $assets;
-        $this->registry = $registry;
-        add_action('wp_enqueue_scripts', array($this, 'addManifestFile'), 0);
-        add_action('admin_enqueue_scripts', array($this, 'addManifestFile'), 0);
-        add_action('wp_enqueue_scripts', array($this, 'addAssets'), 2);
-        add_action('admin_enqueue_scripts', array($this, 'addAssets'), 2);
-    }
-
-
-    /**
-     * @return void
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.62.p
-     */
-    public function addManifestFile()
-    {
-        // if a manifest file has already been added for this domain, then just return that one
-        if ($this->assets->has($this->domain->assetNamespace())) {
-            return;
-        }
-        $asset = new ManifestFile($this->domain);
-        $this->assets->add($asset, $this->domain->assetNamespace());
-    }
-
-
-    /**
-     * @return ManifestFile[]
-     * @since 4.9.62.p
-     */
-    public function getManifestFile()
-    {
-        return $this->assets->getManifestFiles();
-    }
-
-
-    /**
-     * @param string $handle
-     * @param string $source
-     * @param array  $dependencies
-     * @param bool   $load_in_footer
-     * @return JavascriptAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.62.p
-     */
-    public function addJavascript(
-        $handle,
-        $source,
-        array $dependencies = array(),
-        $load_in_footer = true
-    ) {
-        $asset = new JavascriptAsset(
-            $handle,
-            $source,
-            $dependencies,
-            $load_in_footer,
-            $this->domain
-        );
-        $this->assets->add($asset, $handle);
-        return $asset;
-    }
-
-
-
-    /**
-     * @param string $handle
-     * @param string $source
-     * @param array  $dependencies
-     * @param string $media
-     * @return StylesheetAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.62.p
-     */
-    public function addStylesheet(
-        $handle,
-        $source,
-        array $dependencies = array(),
-        $media = 'all'
-    ) {
-        $asset = new StylesheetAsset(
-            $handle,
-            $source,
-            $dependencies,
-            $this->domain,
-            $media
-        );
-        $this->assets->add($asset, $handle);
-        return $asset;
-    }
-
-
-    /**
-     * @param string $handle
-     * @return bool
-     * @since 4.9.62.p
-     */
-    public function enqueueAsset($handle)
-    {
-        if ($this->assets->has($handle)) {
-            $asset = $this->assets->get($handle);
-            if ($asset->isRegistered()) {
-                $asset->enqueueAsset();
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * @var AssetCollection $assets
+	 */
+	protected $assets;
+
+	/**
+	 * @var DomainInterface
+	 */
+	protected $domain;
+
+	/**
+	 * @var Registry $registry
+	 */
+	protected $registry;
+
+
+	/**
+	 * AssetRegister constructor.
+	 *
+	 * @param DomainInterface $domain
+	 * @param AssetCollection $assets
+	 * @param Registry        $registry
+	 */
+	public function __construct(DomainInterface $domain, AssetCollection $assets, Registry $registry)
+	{
+		$this->domain = $domain;
+		$this->assets = $assets;
+		$this->registry = $registry;
+		add_action('wp_enqueue_scripts', array($this, 'addManifestFile'), 0);
+		add_action('admin_enqueue_scripts', array($this, 'addManifestFile'), 0);
+		add_action('wp_enqueue_scripts', array($this, 'addAssets'), 2);
+		add_action('admin_enqueue_scripts', array($this, 'addAssets'), 2);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.62.p
+	 */
+	public function addManifestFile()
+	{
+		// if a manifest file has already been added for this domain, then just return that one
+		if ($this->assets->has($this->domain->assetNamespace())) {
+			return;
+		}
+		$asset = new ManifestFile($this->domain);
+		$this->assets->add($asset, $this->domain->assetNamespace());
+	}
+
+
+	/**
+	 * @return ManifestFile[]
+	 * @since 4.9.62.p
+	 */
+	public function getManifestFile()
+	{
+		return $this->assets->getManifestFiles();
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @param string $source
+	 * @param array  $dependencies
+	 * @param bool   $load_in_footer
+	 * @return JavascriptAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.62.p
+	 */
+	public function addJavascript(
+		$handle,
+		$source,
+		array $dependencies = array(),
+		$load_in_footer = true
+	) {
+		$asset = new JavascriptAsset(
+			$handle,
+			$source,
+			$dependencies,
+			$load_in_footer,
+			$this->domain
+		);
+		$this->assets->add($asset, $handle);
+		return $asset;
+	}
+
+
+
+	/**
+	 * @param string $handle
+	 * @param string $source
+	 * @param array  $dependencies
+	 * @param string $media
+	 * @return StylesheetAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.62.p
+	 */
+	public function addStylesheet(
+		$handle,
+		$source,
+		array $dependencies = array(),
+		$media = 'all'
+	) {
+		$asset = new StylesheetAsset(
+			$handle,
+			$source,
+			$dependencies,
+			$this->domain,
+			$media
+		);
+		$this->assets->add($asset, $handle);
+		return $asset;
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @return bool
+	 * @since 4.9.62.p
+	 */
+	public function enqueueAsset($handle)
+	{
+		if ($this->assets->has($handle)) {
+			$asset = $this->assets->get($handle);
+			if ($asset->isRegistered()) {
+				$asset->enqueueAsset();
+				return true;
+			}
+		}
+		return false;
+	}
 }

core/services/assets/AssetManagerInterface.php

Indentation +57 added lines, -57 removed lines

@@ -20,72 +20,72 @@
 interface AssetManagerInterface
 {
 
-    /**
-     * @since 4.9.62.p
-     */
-    public function addAssets();
+	/**
+	 * @since 4.9.62.p
+	 */
+	public function addAssets();
 
 
-    /**
-     * @return ManifestFile
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.62.p
-     */
-    public function addManifestFile();
+	/**
+	 * @return ManifestFile
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.62.p
+	 */
+	public function addManifestFile();
 
 
-    /**
-     * @return ManifestFile[]
-     * @since 4.9.62.p
-     */
-    public function getManifestFile();
+	/**
+	 * @return ManifestFile[]
+	 * @since 4.9.62.p
+	 */
+	public function getManifestFile();
 
 
-    /**
-     * @param string $handle
-     * @param string $source
-     * @param array  $dependencies
-     * @param bool   $load_in_footer
-     * @return JavascriptAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.62.p
-     */
-    public function addJavascript(
-        $handle,
-        $source,
-        array $dependencies = array(),
-        $load_in_footer = true
-    );
+	/**
+	 * @param string $handle
+	 * @param string $source
+	 * @param array  $dependencies
+	 * @param bool   $load_in_footer
+	 * @return JavascriptAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.62.p
+	 */
+	public function addJavascript(
+		$handle,
+		$source,
+		array $dependencies = array(),
+		$load_in_footer = true
+	);
 
 
 
-    /**
-     * @param string $handle
-     * @param string $source
-     * @param array  $dependencies
-     * @param string $media
-     * @return StylesheetAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.62.p
-     */
-    public function addStylesheet(
-        $handle,
-        $source,
-        array $dependencies = array(),
-        $media = 'all'
-    );
+	/**
+	 * @param string $handle
+	 * @param string $source
+	 * @param array  $dependencies
+	 * @param string $media
+	 * @return StylesheetAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.62.p
+	 */
+	public function addStylesheet(
+		$handle,
+		$source,
+		array $dependencies = array(),
+		$media = 'all'
+	);
 
 
-    /**
-     * @param string $handle
-     * @return bool
-     * @since 4.9.62.p
-     */
-    public function enqueueAsset($handle);
+	/**
+	 * @param string $handle
+	 * @return bool
+	 * @since 4.9.62.p
+	 */
+	public function enqueueAsset($handle);
 }

core/CPTs/CptQueryModifier.php

Indentation +565 added lines, -565 removed lines

@@ -28,569 +28,569 @@
 class CptQueryModifier
 {
 
-    /**
-     * @var string $post_type
-     */
-    protected $post_type = '';
-
-    /**
-     * CPT details from CustomPostTypeDefinitions for specific post type
-     *
-     * @var array $cpt_details
-     */
-    protected $cpt_details = array();
-
-    /**
-     * @var EE_Table_Base[] $model_tables
-     */
-    protected $model_tables = array();
-
-    /**
-     * @var array $taxonomies
-     */
-    protected $taxonomies = array();
-
-    /**
-     * meta table for the related CPT
-     *
-     * @var EE_Secondary_Table $meta_table
-     */
-    protected $meta_table;
-
-    /**
-     * EEM_CPT_Base model for the related CPT
-     *
-     * @var EEM_CPT_Base $model
-     */
-    protected $model;
-
-    /**
-     * @var EE_Request_Handler $request_handler
-     */
-    protected $request_handler;
-
-    /**
-     * @var WP_Query $wp_query
-     */
-    protected $wp_query;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-
-    /**
-     * CptQueryModifier constructor
-     *
-     * @param string             $post_type
-     * @param array              $cpt_details
-     * @param WP_Query           $WP_Query
-     * @param EE_Request_Handler $request_handler
-     * @param RequestInterface   $request
-     * @param LoaderInterface    $loader
-     * @throws EE_Error
-     */
-    public function __construct(
-        $post_type,
-        array $cpt_details,
-        WP_Query $WP_Query,
-        EE_Request_Handler $request_handler,
-        RequestInterface $request,
-        LoaderInterface $loader
-    ) {
-        $this->loader = $loader;
-        $this->request = $request;
-        $this->request_handler = $request_handler;
-        $this->setWpQuery($WP_Query);
-        $this->setPostType($post_type);
-        $this->setCptDetails($cpt_details);
-        $this->init();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function postType()
-    {
-        return $this->post_type;
-    }
-
-
-    /**
-     * @param string $post_type
-     */
-    protected function setPostType($post_type)
-    {
-        $this->post_type = $post_type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function cptDetails()
-    {
-        return $this->cpt_details;
-    }
-
-
-    /**
-     * @param array $cpt_details
-     */
-    protected function setCptDetails($cpt_details)
-    {
-        $this->cpt_details = $cpt_details;
-    }
-
-
-    /**
-     * @return EE_Table_Base[]
-     */
-    public function modelTables()
-    {
-        return $this->model_tables;
-    }
-
-
-    /**
-     * @param EE_Table_Base[] $model_tables
-     */
-    protected function setModelTables($model_tables)
-    {
-        $this->model_tables = $model_tables;
-    }
-
-
-    /**
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function taxonomies()
-    {
-        if (empty($this->taxonomies)) {
-            $this->initializeTaxonomies();
-        }
-        return $this->taxonomies;
-    }
-
-
-    /**
-     * @param array $taxonomies
-     */
-    protected function setTaxonomies(array $taxonomies)
-    {
-        $this->taxonomies = $taxonomies;
-    }
-
-
-    /**
-     * @return EE_Secondary_Table
-     */
-    public function metaTable()
-    {
-        return $this->meta_table;
-    }
-
-
-    /**
-     * @param EE_Secondary_Table $meta_table
-     */
-    public function setMetaTable(EE_Secondary_Table $meta_table)
-    {
-        $this->meta_table = $meta_table;
-    }
-
-
-    /**
-     * @return EEM_Base
-     */
-    public function model()
-    {
-        return $this->model;
-    }
-
-
-    /**
-     * @param EEM_Base $CPT_model
-     */
-    protected function setModel(EEM_Base $CPT_model)
-    {
-        $this->model = $CPT_model;
-    }
-
-
-    /**
-     * @deprecated $VID:$
-     * @return EE_Request_Handler
-     */
-    public function request()
-    {
-        return $this->request_handler;
-    }
-
-
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-
-    /**
-     * @return WP_Query
-     */
-    public function WpQuery()
-    {
-        return $this->wp_query;
-    }
-    // phpcs:enable
-
-
-    /**
-     * @param WP_Query $wp_query
-     */
-    public function setWpQuery(WP_Query $wp_query)
-    {
-        $this->wp_query = $wp_query;
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function initializeTaxonomies()
-    {
-        // check if taxonomies have already been set and that this CPT has taxonomies registered for it
-        if (empty($this->taxonomies)
-            && isset($this->cpt_details['args']['taxonomies'])
-        ) {
-            // if so then grab them, but we want the taxonomy name as the key
-            $taxonomies = array_flip($this->cpt_details['args']['taxonomies']);
-            // then grab the list of ALL taxonomies
-            /** @var \EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions
-             * $taxonomy_definitions
-             */
-            $taxonomy_definitions = $this->loader->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'
-            );
-            $all_taxonomies = $taxonomy_definitions->getCustomTaxonomyDefinitions();
-            foreach ($taxonomies as $taxonomy => &$details) {
-                // add details to our taxonomies if they exist
-                $details = isset($all_taxonomies[ $taxonomy ])
-                    ? $all_taxonomies[ $taxonomy ]
-                    : array();
-            }
-            // ALWAYS unset() variables that were passed by reference
-            unset($details);
-            $this->setTaxonomies($taxonomies);
-        }
-    }
-
-
-    /**
-     * @since $VID:$
-     * @throws EE_Error
-     */
-    protected function init()
-    {
-        $this->setAdditionalCptDetails();
-        $this->setRequestVarsIfCpt();
-        // convert post_type to model name
-        $model_name = str_replace('EE_', '', $this->cpt_details['class_name']);
-        // load all tables related to CPT
-        $this->setupModelsAndTables($model_name);
-        // load and instantiate CPT_*_Strategy
-        $CPT_Strategy = $this->cptStrategyClass($model_name);
-        // !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
-        // here's the list of available filters in the WP_Query object
-        // 'posts_where_paged'
-        // 'posts_groupby'
-        // 'posts_join_paged'
-        // 'posts_orderby'
-        // 'posts_distinct'
-        // 'post_limits'
-        // 'posts_fields'
-        // 'posts_join'
-        add_filter('posts_fields', array($this, 'postsFields'));
-        add_filter('posts_join', array($this, 'postsJoin'));
-        add_filter(
-            'get_' . $this->post_type . '_metadata',
-            array($CPT_Strategy, 'get_EE_post_type_metadata'),
-            1,
-            4
-        );
-        add_filter('the_posts', array($this, 'thePosts'), 1, 1);
-        if ($this->wp_query->is_main_query()) {
-            add_filter('get_edit_post_link', array($this, 'getEditPostLink'), 10, 2);
-            $this->addTemplateFilters();
-        }
-    }
-
-
-    /**
-     * sets some basic query vars that pertain to the CPT
-     *
-     * @access protected
-     * @return void
-     */
-    protected function setAdditionalCptDetails()
-    {
-        // the post or category or term that is triggering EE
-        $this->cpt_details['espresso_page'] = $this->request_handler->is_espresso_page();
-        // requested post name
-        $this->cpt_details['post_name'] = $this->request->getRequestParam('post_name');
-        // add support for viewing 'private', 'draft', or 'pending' posts
-        if (isset($this->wp_query->query_vars['p'])
-            && $this->wp_query->query_vars['p'] !== 0
-            && is_user_logged_in()
-            && current_user_can('edit_post', $this->wp_query->query_vars['p'])
-        ) {
-            // we can just inject directly into the WP_Query object
-            $this->wp_query->query['post_status'] = array('publish', 'private', 'draft', 'pending');
-            // now set the main 'ee' request var so that the appropriate module can load the appropriate template(s)
-            $this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
-        }
-    }
-
-
-    /**
-     * Checks if we're on a EE-CPT archive-or-single page, and if we've never set the EE request var.
-     * If so, sets the 'ee' request variable
-     * so other parts of EE can know what CPT is getting queried.
-     * To Mike's knowledge, this must be called from during or after the pre_get_posts hook
-     * in order for is_archive() and is_single() methods to work properly.
-     *
-     * @return void
-     */
-    public function setRequestVarsIfCpt()
-    {
-        // check if ee action var has been set
-        if (! $this->request->requestParamIsSet('ee')) {
-            // check that route exists for CPT archive slug
-            if (is_archive() && EE_Config::get_route($this->cpt_details['plural_slug'])) {
-                // ie: set "ee" to "events"
-                $this->request->setRequestParam('ee', $this->cpt_details['plural_slug']);
-                // or does it match a single page CPT like /event/
-            } elseif (is_single() && EE_Config::get_route($this->cpt_details['singular_slug'])) {
-                // ie: set "ee" to "event"
-                $this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
-            }
-        }
-    }
-
-
-    /**
-     * setupModelsAndTables
-     *
-     * @access protected
-     * @param string $model_name
-     * @throws EE_Error
-     */
-    protected function setupModelsAndTables($model_name)
-    {
-        // get CPT table data via CPT Model
-        $full_model_name = strpos($model_name, 'EEM_') !== 0
-            ? 'EEM_' . $model_name
-            : $model_name;
-        $model = $this->loader->getShared($full_model_name);
-        if (! $model instanceof EEM_Base) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The "%1$s" model could not be loaded.',
-                        'event_espresso'
-                    ),
-                    $full_model_name
-                )
-            );
-        }
-        $this->setModel($model);
-        $this->setModelTables($this->model->get_tables());
-        $meta_model = $model_name . '_Meta';
-        // is there a Meta Table for this CPT?
-        if (isset($this->cpt_details['tables'][ $meta_model ])
-            && $this->cpt_details['tables'][ $meta_model ] instanceof EE_Secondary_Table
-        ) {
-            $this->setMetaTable($this->cpt_details['tables'][ $meta_model ]);
-        }
-    }
-
-
-    /**
-     * cptStrategyClass
-     *
-     * @access protected
-     * @param  string $model_name
-     * @return string
-     */
-    protected function cptStrategyClass($model_name)
-    {
-        // creates classname like:  CPT_Event_Strategy
-        $CPT_Strategy_class_name = 'EE_CPT_' . $model_name . '_Strategy';
-        // load and instantiate
-        $CPT_Strategy = $this->loader->getShared(
-            $CPT_Strategy_class_name,
-            array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
-        );
-        if ($CPT_Strategy === null) {
-            $CPT_Strategy = $this->loader->getShared(
-                'EE_CPT_Default_Strategy',
-                array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
-            );
-        }
-        return $CPT_Strategy;
-    }
-
-
-    /**
-     * postsFields
-     *
-     * @access public
-     * @param  $SQL
-     * @return string
-     */
-    public function postsFields($SQL)
-    {
-        // does this CPT have a meta table ?
-        if ($this->meta_table instanceof EE_Secondary_Table) {
-            // adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
-            $SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
-        }
-        remove_filter('posts_fields', array($this, 'postsFields'));
-        return $SQL;
-    }
-
-
-    /**
-     * postsJoin
-     *
-     * @access public
-     * @param  $SQL
-     * @return string
-     */
-    public function postsJoin($SQL)
-    {
-        // does this CPT have a meta table ?
-        if ($this->meta_table instanceof EE_Secondary_Table) {
-            global $wpdb;
-            // adds something like " LEFT JOIN wp_esp_event_meta ON ( wp_esp_event_meta.EVT_ID = wp_posts.ID ) " to WP Query JOIN statement
-            $SQL .= ' LEFT JOIN '
-                    . $this->meta_table->get_table_name()
-                    . ' ON ( '
-                    . $this->meta_table->get_table_name()
-                    . '.'
-                    . $this->meta_table->get_fk_on_table()
-                    . ' = '
-                    . $wpdb->posts
-                    . '.ID ) ';
-        }
-        remove_filter('posts_join', array($this, 'postsJoin'));
-        return $SQL;
-    }
-
-
-    /**
-     * thePosts
-     *
-     * @access public
-     * @param  WP_Post[] $posts
-     * @return WP_Post[]
-     */
-    public function thePosts($posts)
-    {
-        $CPT_class = $this->cpt_details['class_name'];
-        // loop thru posts
-        if (is_array($posts) && $this->model instanceof EEM_CPT_Base) {
-            foreach ($posts as $key => $post) {
-                if ($post->post_type === $this->post_type) {
-                    $post->{$CPT_class} = $this->model->instantiate_class_from_post_object($post);
-                }
-            }
-        }
-        remove_filter('the_posts', array($this, 'thePosts'), 1);
-        return $posts;
-    }
-
-
-    /**
-     * @param $url
-     * @param $ID
-     * @return string
-     */
-    public function getEditPostLink($url, $ID)
-    {
-        // need to make sure we only edit links if our cpt
-        global $post;
-        // notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
-        // for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
-        if (! $post instanceof WP_Post
-            || $post->post_type !== $this->post_type
-            || (
-                isset($this->cpt_details['args']['show_ee_ui'])
-                && ! $this->cpt_details['args']['show_ee_ui']
-            )
-        ) {
-            return $url;
-        }
-        // k made it here so all is good.
-        return wp_nonce_url(
-            add_query_arg(
-                array('page' => $this->post_type, 'post' => $ID, 'action' => 'edit'),
-                admin_url('admin.php')
-            ),
-            'edit',
-            'edit_nonce'
-        );
-    }
-
-
-    /**
-     * Execute any template filters.
-     * This method is only called if in main query.
-     *
-     * @return void
-     */
-    public function addTemplateFilters()
-    {
-        // if requested cpt supports page_templates and it's the main query
-        if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
-            // then let's hook into the appropriate query_template hook
-            add_filter('single_template', array($this, 'singleCptTemplate'));
-        }
-    }
-
-
-    /**
-     * Callback for single_template wp filter.
-     * This is used to load the set page_template for a single ee cpt if its set.  If "default" then we load the normal
-     * hierarchy.
-     *
-     * @access public
-     * @param string $current_template Existing default template path derived for this page call.
-     * @return string the path to the full template file.
-     */
-    public function singleCptTemplate($current_template)
-    {
-        $object = get_queried_object();
-        // does this called object HAVE a page template set that is something other than the default.
-        $template = get_post_meta($object->ID, '_wp_page_template', true);
-        // exit early if default or not set or invalid path (accounts for theme changes)
-        if ($template === 'default'
-            || empty($template)
-            || ! is_readable(get_stylesheet_directory() . '/' . $template)
-        ) {
-            return $current_template;
-        }
-        // made it here so we SHOULD be able to just locate the template and then return it.
-        return locate_template(array($template));
-    }
+	/**
+	 * @var string $post_type
+	 */
+	protected $post_type = '';
+
+	/**
+	 * CPT details from CustomPostTypeDefinitions for specific post type
+	 *
+	 * @var array $cpt_details
+	 */
+	protected $cpt_details = array();
+
+	/**
+	 * @var EE_Table_Base[] $model_tables
+	 */
+	protected $model_tables = array();
+
+	/**
+	 * @var array $taxonomies
+	 */
+	protected $taxonomies = array();
+
+	/**
+	 * meta table for the related CPT
+	 *
+	 * @var EE_Secondary_Table $meta_table
+	 */
+	protected $meta_table;
+
+	/**
+	 * EEM_CPT_Base model for the related CPT
+	 *
+	 * @var EEM_CPT_Base $model
+	 */
+	protected $model;
+
+	/**
+	 * @var EE_Request_Handler $request_handler
+	 */
+	protected $request_handler;
+
+	/**
+	 * @var WP_Query $wp_query
+	 */
+	protected $wp_query;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+
+	/**
+	 * CptQueryModifier constructor
+	 *
+	 * @param string             $post_type
+	 * @param array              $cpt_details
+	 * @param WP_Query           $WP_Query
+	 * @param EE_Request_Handler $request_handler
+	 * @param RequestInterface   $request
+	 * @param LoaderInterface    $loader
+	 * @throws EE_Error
+	 */
+	public function __construct(
+		$post_type,
+		array $cpt_details,
+		WP_Query $WP_Query,
+		EE_Request_Handler $request_handler,
+		RequestInterface $request,
+		LoaderInterface $loader
+	) {
+		$this->loader = $loader;
+		$this->request = $request;
+		$this->request_handler = $request_handler;
+		$this->setWpQuery($WP_Query);
+		$this->setPostType($post_type);
+		$this->setCptDetails($cpt_details);
+		$this->init();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function postType()
+	{
+		return $this->post_type;
+	}
+
+
+	/**
+	 * @param string $post_type
+	 */
+	protected function setPostType($post_type)
+	{
+		$this->post_type = $post_type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function cptDetails()
+	{
+		return $this->cpt_details;
+	}
+
+
+	/**
+	 * @param array $cpt_details
+	 */
+	protected function setCptDetails($cpt_details)
+	{
+		$this->cpt_details = $cpt_details;
+	}
+
+
+	/**
+	 * @return EE_Table_Base[]
+	 */
+	public function modelTables()
+	{
+		return $this->model_tables;
+	}
+
+
+	/**
+	 * @param EE_Table_Base[] $model_tables
+	 */
+	protected function setModelTables($model_tables)
+	{
+		$this->model_tables = $model_tables;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function taxonomies()
+	{
+		if (empty($this->taxonomies)) {
+			$this->initializeTaxonomies();
+		}
+		return $this->taxonomies;
+	}
+
+
+	/**
+	 * @param array $taxonomies
+	 */
+	protected function setTaxonomies(array $taxonomies)
+	{
+		$this->taxonomies = $taxonomies;
+	}
+
+
+	/**
+	 * @return EE_Secondary_Table
+	 */
+	public function metaTable()
+	{
+		return $this->meta_table;
+	}
+
+
+	/**
+	 * @param EE_Secondary_Table $meta_table
+	 */
+	public function setMetaTable(EE_Secondary_Table $meta_table)
+	{
+		$this->meta_table = $meta_table;
+	}
+
+
+	/**
+	 * @return EEM_Base
+	 */
+	public function model()
+	{
+		return $this->model;
+	}
+
+
+	/**
+	 * @param EEM_Base $CPT_model
+	 */
+	protected function setModel(EEM_Base $CPT_model)
+	{
+		$this->model = $CPT_model;
+	}
+
+
+	/**
+	 * @deprecated $VID:$
+	 * @return EE_Request_Handler
+	 */
+	public function request()
+	{
+		return $this->request_handler;
+	}
+
+
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+
+	/**
+	 * @return WP_Query
+	 */
+	public function WpQuery()
+	{
+		return $this->wp_query;
+	}
+	// phpcs:enable
+
+
+	/**
+	 * @param WP_Query $wp_query
+	 */
+	public function setWpQuery(WP_Query $wp_query)
+	{
+		$this->wp_query = $wp_query;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function initializeTaxonomies()
+	{
+		// check if taxonomies have already been set and that this CPT has taxonomies registered for it
+		if (empty($this->taxonomies)
+			&& isset($this->cpt_details['args']['taxonomies'])
+		) {
+			// if so then grab them, but we want the taxonomy name as the key
+			$taxonomies = array_flip($this->cpt_details['args']['taxonomies']);
+			// then grab the list of ALL taxonomies
+			/** @var \EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions
+			 * $taxonomy_definitions
+			 */
+			$taxonomy_definitions = $this->loader->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'
+			);
+			$all_taxonomies = $taxonomy_definitions->getCustomTaxonomyDefinitions();
+			foreach ($taxonomies as $taxonomy => &$details) {
+				// add details to our taxonomies if they exist
+				$details = isset($all_taxonomies[ $taxonomy ])
+					? $all_taxonomies[ $taxonomy ]
+					: array();
+			}
+			// ALWAYS unset() variables that were passed by reference
+			unset($details);
+			$this->setTaxonomies($taxonomies);
+		}
+	}
+
+
+	/**
+	 * @since $VID:$
+	 * @throws EE_Error
+	 */
+	protected function init()
+	{
+		$this->setAdditionalCptDetails();
+		$this->setRequestVarsIfCpt();
+		// convert post_type to model name
+		$model_name = str_replace('EE_', '', $this->cpt_details['class_name']);
+		// load all tables related to CPT
+		$this->setupModelsAndTables($model_name);
+		// load and instantiate CPT_*_Strategy
+		$CPT_Strategy = $this->cptStrategyClass($model_name);
+		// !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
+		// here's the list of available filters in the WP_Query object
+		// 'posts_where_paged'
+		// 'posts_groupby'
+		// 'posts_join_paged'
+		// 'posts_orderby'
+		// 'posts_distinct'
+		// 'post_limits'
+		// 'posts_fields'
+		// 'posts_join'
+		add_filter('posts_fields', array($this, 'postsFields'));
+		add_filter('posts_join', array($this, 'postsJoin'));
+		add_filter(
+			'get_' . $this->post_type . '_metadata',
+			array($CPT_Strategy, 'get_EE_post_type_metadata'),
+			1,
+			4
+		);
+		add_filter('the_posts', array($this, 'thePosts'), 1, 1);
+		if ($this->wp_query->is_main_query()) {
+			add_filter('get_edit_post_link', array($this, 'getEditPostLink'), 10, 2);
+			$this->addTemplateFilters();
+		}
+	}
+
+
+	/**
+	 * sets some basic query vars that pertain to the CPT
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function setAdditionalCptDetails()
+	{
+		// the post or category or term that is triggering EE
+		$this->cpt_details['espresso_page'] = $this->request_handler->is_espresso_page();
+		// requested post name
+		$this->cpt_details['post_name'] = $this->request->getRequestParam('post_name');
+		// add support for viewing 'private', 'draft', or 'pending' posts
+		if (isset($this->wp_query->query_vars['p'])
+			&& $this->wp_query->query_vars['p'] !== 0
+			&& is_user_logged_in()
+			&& current_user_can('edit_post', $this->wp_query->query_vars['p'])
+		) {
+			// we can just inject directly into the WP_Query object
+			$this->wp_query->query['post_status'] = array('publish', 'private', 'draft', 'pending');
+			// now set the main 'ee' request var so that the appropriate module can load the appropriate template(s)
+			$this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
+		}
+	}
+
+
+	/**
+	 * Checks if we're on a EE-CPT archive-or-single page, and if we've never set the EE request var.
+	 * If so, sets the 'ee' request variable
+	 * so other parts of EE can know what CPT is getting queried.
+	 * To Mike's knowledge, this must be called from during or after the pre_get_posts hook
+	 * in order for is_archive() and is_single() methods to work properly.
+	 *
+	 * @return void
+	 */
+	public function setRequestVarsIfCpt()
+	{
+		// check if ee action var has been set
+		if (! $this->request->requestParamIsSet('ee')) {
+			// check that route exists for CPT archive slug
+			if (is_archive() && EE_Config::get_route($this->cpt_details['plural_slug'])) {
+				// ie: set "ee" to "events"
+				$this->request->setRequestParam('ee', $this->cpt_details['plural_slug']);
+				// or does it match a single page CPT like /event/
+			} elseif (is_single() && EE_Config::get_route($this->cpt_details['singular_slug'])) {
+				// ie: set "ee" to "event"
+				$this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
+			}
+		}
+	}
+
+
+	/**
+	 * setupModelsAndTables
+	 *
+	 * @access protected
+	 * @param string $model_name
+	 * @throws EE_Error
+	 */
+	protected function setupModelsAndTables($model_name)
+	{
+		// get CPT table data via CPT Model
+		$full_model_name = strpos($model_name, 'EEM_') !== 0
+			? 'EEM_' . $model_name
+			: $model_name;
+		$model = $this->loader->getShared($full_model_name);
+		if (! $model instanceof EEM_Base) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The "%1$s" model could not be loaded.',
+						'event_espresso'
+					),
+					$full_model_name
+				)
+			);
+		}
+		$this->setModel($model);
+		$this->setModelTables($this->model->get_tables());
+		$meta_model = $model_name . '_Meta';
+		// is there a Meta Table for this CPT?
+		if (isset($this->cpt_details['tables'][ $meta_model ])
+			&& $this->cpt_details['tables'][ $meta_model ] instanceof EE_Secondary_Table
+		) {
+			$this->setMetaTable($this->cpt_details['tables'][ $meta_model ]);
+		}
+	}
+
+
+	/**
+	 * cptStrategyClass
+	 *
+	 * @access protected
+	 * @param  string $model_name
+	 * @return string
+	 */
+	protected function cptStrategyClass($model_name)
+	{
+		// creates classname like:  CPT_Event_Strategy
+		$CPT_Strategy_class_name = 'EE_CPT_' . $model_name . '_Strategy';
+		// load and instantiate
+		$CPT_Strategy = $this->loader->getShared(
+			$CPT_Strategy_class_name,
+			array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
+		);
+		if ($CPT_Strategy === null) {
+			$CPT_Strategy = $this->loader->getShared(
+				'EE_CPT_Default_Strategy',
+				array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
+			);
+		}
+		return $CPT_Strategy;
+	}
+
+
+	/**
+	 * postsFields
+	 *
+	 * @access public
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function postsFields($SQL)
+	{
+		// does this CPT have a meta table ?
+		if ($this->meta_table instanceof EE_Secondary_Table) {
+			// adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
+			$SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
+		}
+		remove_filter('posts_fields', array($this, 'postsFields'));
+		return $SQL;
+	}
+
+
+	/**
+	 * postsJoin
+	 *
+	 * @access public
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function postsJoin($SQL)
+	{
+		// does this CPT have a meta table ?
+		if ($this->meta_table instanceof EE_Secondary_Table) {
+			global $wpdb;
+			// adds something like " LEFT JOIN wp_esp_event_meta ON ( wp_esp_event_meta.EVT_ID = wp_posts.ID ) " to WP Query JOIN statement
+			$SQL .= ' LEFT JOIN '
+					. $this->meta_table->get_table_name()
+					. ' ON ( '
+					. $this->meta_table->get_table_name()
+					. '.'
+					. $this->meta_table->get_fk_on_table()
+					. ' = '
+					. $wpdb->posts
+					. '.ID ) ';
+		}
+		remove_filter('posts_join', array($this, 'postsJoin'));
+		return $SQL;
+	}
+
+
+	/**
+	 * thePosts
+	 *
+	 * @access public
+	 * @param  WP_Post[] $posts
+	 * @return WP_Post[]
+	 */
+	public function thePosts($posts)
+	{
+		$CPT_class = $this->cpt_details['class_name'];
+		// loop thru posts
+		if (is_array($posts) && $this->model instanceof EEM_CPT_Base) {
+			foreach ($posts as $key => $post) {
+				if ($post->post_type === $this->post_type) {
+					$post->{$CPT_class} = $this->model->instantiate_class_from_post_object($post);
+				}
+			}
+		}
+		remove_filter('the_posts', array($this, 'thePosts'), 1);
+		return $posts;
+	}
+
+
+	/**
+	 * @param $url
+	 * @param $ID
+	 * @return string
+	 */
+	public function getEditPostLink($url, $ID)
+	{
+		// need to make sure we only edit links if our cpt
+		global $post;
+		// notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
+		// for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
+		if (! $post instanceof WP_Post
+			|| $post->post_type !== $this->post_type
+			|| (
+				isset($this->cpt_details['args']['show_ee_ui'])
+				&& ! $this->cpt_details['args']['show_ee_ui']
+			)
+		) {
+			return $url;
+		}
+		// k made it here so all is good.
+		return wp_nonce_url(
+			add_query_arg(
+				array('page' => $this->post_type, 'post' => $ID, 'action' => 'edit'),
+				admin_url('admin.php')
+			),
+			'edit',
+			'edit_nonce'
+		);
+	}
+
+
+	/**
+	 * Execute any template filters.
+	 * This method is only called if in main query.
+	 *
+	 * @return void
+	 */
+	public function addTemplateFilters()
+	{
+		// if requested cpt supports page_templates and it's the main query
+		if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
+			// then let's hook into the appropriate query_template hook
+			add_filter('single_template', array($this, 'singleCptTemplate'));
+		}
+	}
+
+
+	/**
+	 * Callback for single_template wp filter.
+	 * This is used to load the set page_template for a single ee cpt if its set.  If "default" then we load the normal
+	 * hierarchy.
+	 *
+	 * @access public
+	 * @param string $current_template Existing default template path derived for this page call.
+	 * @return string the path to the full template file.
+	 */
+	public function singleCptTemplate($current_template)
+	{
+		$object = get_queried_object();
+		// does this called object HAVE a page template set that is something other than the default.
+		$template = get_post_meta($object->ID, '_wp_page_template', true);
+		// exit early if default or not set or invalid path (accounts for theme changes)
+		if ($template === 'default'
+			|| empty($template)
+			|| ! is_readable(get_stylesheet_directory() . '/' . $template)
+		) {
+			return $current_template;
+		}
+		// made it here so we SHOULD be able to just locate the template and then return it.
+		return locate_template(array($template));
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -285,8 +285,8 @@ 
             $all_taxonomies = $taxonomy_definitions->getCustomTaxonomyDefinitions();
             foreach ($taxonomies as $taxonomy => &$details) {
                 // add details to our taxonomies if they exist
-                $details = isset($all_taxonomies[ $taxonomy ])
-                    ? $all_taxonomies[ $taxonomy ]
+                $details = isset($all_taxonomies[$taxonomy])
+                    ? $all_taxonomies[$taxonomy]
                     : array();
             }
             // ALWAYS unset() variables that were passed by reference
@@ -323,7 +323,7 @@ 
         add_filter('posts_fields', array($this, 'postsFields'));
         add_filter('posts_join', array($this, 'postsJoin'));
         add_filter(
-            'get_' . $this->post_type . '_metadata',
+            'get_'.$this->post_type.'_metadata',
             array($CPT_Strategy, 'get_EE_post_type_metadata'),
             1,
             4
@@ -374,7 +374,7 @@ 
     public function setRequestVarsIfCpt()
     {
         // check if ee action var has been set
-        if (! $this->request->requestParamIsSet('ee')) {
+        if ( ! $this->request->requestParamIsSet('ee')) {
             // check that route exists for CPT archive slug
             if (is_archive() && EE_Config::get_route($this->cpt_details['plural_slug'])) {
                 // ie: set "ee" to "events"
@@ -399,10 +399,10 @@ 
     {
         // get CPT table data via CPT Model
         $full_model_name = strpos($model_name, 'EEM_') !== 0
-            ? 'EEM_' . $model_name
+            ? 'EEM_'.$model_name
             : $model_name;
         $model = $this->loader->getShared($full_model_name);
-        if (! $model instanceof EEM_Base) {
+        if ( ! $model instanceof EEM_Base) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -415,12 +415,12 @@ 
         }
         $this->setModel($model);
         $this->setModelTables($this->model->get_tables());
-        $meta_model = $model_name . '_Meta';
+        $meta_model = $model_name.'_Meta';
         // is there a Meta Table for this CPT?
-        if (isset($this->cpt_details['tables'][ $meta_model ])
-            && $this->cpt_details['tables'][ $meta_model ] instanceof EE_Secondary_Table
+        if (isset($this->cpt_details['tables'][$meta_model])
+            && $this->cpt_details['tables'][$meta_model] instanceof EE_Secondary_Table
         ) {
-            $this->setMetaTable($this->cpt_details['tables'][ $meta_model ]);
+            $this->setMetaTable($this->cpt_details['tables'][$meta_model]);
         }
     }
 
@@ -435,7 +435,7 @@ 
     protected function cptStrategyClass($model_name)
     {
         // creates classname like:  CPT_Event_Strategy
-        $CPT_Strategy_class_name = 'EE_CPT_' . $model_name . '_Strategy';
+        $CPT_Strategy_class_name = 'EE_CPT_'.$model_name.'_Strategy';
         // load and instantiate
         $CPT_Strategy = $this->loader->getShared(
             $CPT_Strategy_class_name,
@@ -463,7 +463,7 @@ 
         // does this CPT have a meta table ?
         if ($this->meta_table instanceof EE_Secondary_Table) {
             // adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
-            $SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
+            $SQL .= ', '.$this->meta_table->get_table_name().'.* ';
         }
         remove_filter('posts_fields', array($this, 'postsFields'));
         return $SQL;
@@ -532,7 +532,7 @@ 
         global $post;
         // notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
         // for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
-        if (! $post instanceof WP_Post
+        if ( ! $post instanceof WP_Post
             || $post->post_type !== $this->post_type
             || (
                 isset($this->cpt_details['args']['show_ee_ui'])
@@ -562,7 +562,7 @@ 
     public function addTemplateFilters()
     {
         // if requested cpt supports page_templates and it's the main query
-        if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
+        if ( ! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
             // then let's hook into the appropriate query_template hook
             add_filter('single_template', array($this, 'singleCptTemplate'));
         }
@@ -586,7 +586,7 @@ 
         // exit early if default or not set or invalid path (accounts for theme changes)
         if ($template === 'default'
             || empty($template)
-            || ! is_readable(get_stylesheet_directory() . '/' . $template)
+            || ! is_readable(get_stylesheet_directory().'/'.$template)
         ) {
             return $current_template;
         }

core/CPTs/EE_CPT_Strategy.core.php

Indentation +445 added lines, -445 removed lines

@@ -16,449 +16,449 @@
 class EE_CPT_Strategy extends EE_Base
 {
 
-    /**
-     * @var EE_CPT_Strategy $_instance
-     */
-    private static $_instance;
-
-    /**
-     * the current page, if it utilizes CPTs
-     *
-     * @var array $CPT
-     */
-    protected $CPT;
-
-    /**
-     * return value from CustomPostTypeDefinitions::getDefinitions()
-     *
-     * @var array $_CPTs
-     */
-    protected $_CPTs = array();
-
-    /**
-     * @var array $_CPT_taxonomies
-     */
-    protected $_CPT_taxonomies = array();
-
-    /**
-     * @var array $_CPT_terms
-     */
-    protected $_CPT_terms = array();
-
-    /**
-     * @var array $_CPT_endpoints
-     */
-    protected $_CPT_endpoints = array();
-
-    /**
-     * @var EEM_Base $CPT_model
-     */
-    protected $CPT_model;
-
-    /**
-     * @var EventEspresso\Core\CPTs\CptQueryModifier $query_modifier
-     */
-    protected $query_modifier;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param CustomPostTypeDefinitions|null $custom_post_types
-     * @param CustomTaxonomyDefinitions|null $taxonomies
-     * @return EE_CPT_Strategy
-     */
-    public static function instance(
-        CustomPostTypeDefinitions $custom_post_types = null,
-        CustomTaxonomyDefinitions $taxonomies = null
-    ) {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_CPT_Strategy
-            && $custom_post_types instanceof CustomPostTypeDefinitions
-            && $taxonomies instanceof CustomTaxonomyDefinitions
-        ) {
-            self::$_instance = new self($custom_post_types, $taxonomies);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param CustomPostTypeDefinitions $custom_post_types
-     * @param CustomTaxonomyDefinitions $taxonomies
-     */
-    protected function __construct(
-        CustomPostTypeDefinitions $custom_post_types,
-        CustomTaxonomyDefinitions $taxonomies
-    ) {
-        // get CPT data
-        $this->_CPTs = $custom_post_types->getDefinitions();
-        $this->_CPT_endpoints = $this->_set_CPT_endpoints();
-        $this->_CPT_taxonomies = $taxonomies->getCustomTaxonomyDefinitions();
-        add_action('pre_get_posts', array($this, 'pre_get_posts'), 5);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_CPT_endpoints()
-    {
-        return $this->_CPT_endpoints;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_CPT_taxonomies()
-    {
-        return $this->_CPT_taxonomies;
-    }
-
-
-    /**
-     * add CPT "slugs" to array of default espresso "pages"
-     *
-     * @return array
-     */
-    private function _set_CPT_endpoints()
-    {
-        $_CPT_endpoints = array();
-        if (is_array($this->_CPTs)) {
-            foreach ($this->_CPTs as $CPT_type => $CPT) {
-                $_CPT_endpoints [ $CPT['plural_slug'] ] = $CPT_type;
-            }
-        }
-        return $_CPT_endpoints;
-    }
-
-
-    /**
-     * If this query (not just "main" queries (ie, for WP's infamous "loop")) is for an EE CPT, then we want to
-     * supercharge the get_posts query to add our EE stuff (like joining to our tables, selecting extra columns, and
-     * adding EE objects to the post to facilitate further querying of related data etc)
-     *
-     * @param WP_Query $WP_Query
-     * @return void
-     * @throws \EE_Error
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function pre_get_posts($WP_Query)
-    {
-        // check that post-type is set
-        if (! $WP_Query instanceof WP_Query) {
-            return;
-        }
-        // add our conditionals
-        $this->_set_EE_tags_on_WP_Query($WP_Query);
-        // check for terms
-        $this->_set_post_type_for_terms($WP_Query);
-        // make sure paging is always set
-        $this->_set_paging($WP_Query);
-        // is a taxonomy set ?
-        $this->_set_CPT_taxonomies_on_WP_Query($WP_Query);
-        // loop thru post_types if set
-        $this->_process_WP_Query_post_types($WP_Query);
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return void
-     */
-    private function _set_EE_tags_on_WP_Query(WP_Query $WP_Query)
-    {
-        $WP_Query->is_espresso_event_single = false;
-        $WP_Query->is_espresso_event_archive = false;
-        $WP_Query->is_espresso_event_taxonomy = false;
-        $WP_Query->is_espresso_venue_single = false;
-        $WP_Query->is_espresso_venue_archive = false;
-        $WP_Query->is_espresso_venue_taxonomy = false;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_CPT_terms()
-    {
-        if (empty($this->_CPT_terms)) {
-            $terms = EEM_Term::instance()->get_all_CPT_post_tags();
-            foreach ($terms as $term) {
-                if ($term instanceof EE_Term) {
-                    $this->_CPT_terms[ $term->slug() ] = $term;
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_post_type_for_terms(WP_Query $WP_Query)
-    {
-        // is a tag set ?
-        if (isset($WP_Query->query['tag'])) {
-            // set post_tags
-            $this->_set_CPT_terms();
-            // is this tag archive term in the list of terms used by our CPTs ?
-            $term = isset($this->_CPT_terms[ $WP_Query->query['tag'] ])
-                ? $this->_CPT_terms[ $WP_Query->query['tag'] ]
-                : null;
-            // verify the term
-            if ($term instanceof EE_Term) {
-                $term->post_type = array_merge(array('post', 'page'), (array) $term->post_type);
-                $term->post_type = apply_filters(
-                    'FHEE__EE_CPT_Strategy___set_post_type_for_terms__term_post_type',
-                    $term->post_type,
-                    $term
-                );
-                // if a post type is already set
-                if (isset($WP_Query->query_vars['post_type'])) {
-                    // add to existing array
-                    $term->post_type = array_merge((array) $WP_Query->query_vars['post_type'], $term->post_type);
-                }
-                // just set post_type to our CPT
-                $WP_Query->set('post_type', array_unique($term->post_type));
-            }
-        }
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return void
-     */
-    public function _set_paging($WP_Query)
-    {
-        if ($WP_Query->is_main_query() && apply_filters('FHEE__EE_CPT_Strategy___set_paging', true)) {
-            $page = get_query_var('page') ? get_query_var('page') : null;
-            $paged = get_query_var('paged') ? get_query_var('paged') : $page;
-            $WP_Query->set('paged', $paged);
-        }
-    }
-
-
-    /**
-     * @param \WP_Query $WP_Query
-     */
-    protected function _set_CPT_taxonomies_on_WP_Query(WP_Query $WP_Query)
-    {
-        // is a taxonomy set ?
-        if ($WP_Query->is_tax) {
-            // loop thru our taxonomies
-            foreach ($this->_CPT_taxonomies as $CPT_taxonomy => $CPT_taxonomy_details) {
-                // check if one of our taxonomies is set as a query var
-                if (isset($WP_Query->query[ $CPT_taxonomy ])) {
-                    // but which CPT does that correspond to??? hmmm... guess we gotta go looping
-                    foreach ($this->_CPTs as $post_type => $CPT) {
-                        // verify our CPT has args, is public and has taxonomies set
-                        if (isset($CPT['args']['public'])
-                            && $CPT['args']['public']
-                            && ! empty($CPT['args']['taxonomies'])
-                            && in_array($CPT_taxonomy, $CPT['args']['taxonomies'], true)
-                        ) {
-                            // if so, then add this CPT post_type to the current query's array of post_types'
-                            $WP_Query->query_vars['post_type'] = isset($WP_Query->query_vars['post_type'])
-                                ? (array) $WP_Query->query_vars['post_type']
-                                : array();
-                            $WP_Query->query_vars['post_type'][] = $post_type;
-                            switch ($post_type) {
-                                case 'espresso_events':
-                                    $WP_Query->is_espresso_event_taxonomy = true;
-                                    break;
-                                case 'espresso_venues':
-                                    $WP_Query->is_espresso_venue_taxonomy = true;
-                                    break;
-                                default:
-                                    do_action(
-                                        'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_' . $post_type . '_post_type',
-                                        $WP_Query,
-                                        $this
-                                    );
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param \WP_Query $WP_Query
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_WP_Query_post_types(WP_Query $WP_Query)
-    {
-        if (isset($WP_Query->query_vars['post_type'])) {
-            // loop thru post_types as array
-            foreach ((array) $WP_Query->query_vars['post_type'] as $post_type) {
-                // is current query for an EE CPT ?
-                if (isset($this->_CPTs[ $post_type ])) {
-                    // is EE on or off ?
-                    if (EE_Maintenance_Mode::instance()->level()) {
-                        // reroute CPT template view to maintenance_mode.template.php
-                        if (! has_filter('template_include', array('EE_Maintenance_Mode', 'template_include'))) {
-                            add_filter('template_include', array('EE_Maintenance_Mode', 'template_include'), 99999);
-                        }
-                        if (has_filter('the_content', array(EE_Maintenance_Mode::instance(), 'the_content'))) {
-                            add_filter('the_content', array($this, 'inject_EE_shortcode_placeholder'), 1);
-                        }
-                        return;
-                    }
-                    $this->_generate_CptQueryModifier($WP_Query, $post_type);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param \WP_Query $WP_Query
-     * @param string    $post_type
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _generate_CptQueryModifier(WP_Query $WP_Query, $post_type)
-    {
-        $this->query_modifier = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\CPTs\CptQueryModifier',
-            array(
-                $post_type,
-                $this->_CPTs[ $post_type ],
-                $WP_Query,
-            )
-        );
-        $this->_CPT_taxonomies = $this->query_modifier->taxonomies();
-    }
-
-
-    /**
-     * inject_EE_shortcode_placeholder
-     * in order to display the M-Mode notice on our CPT routes,
-     * we need to first inject what looks like one of our shortcodes,
-     * so that it can be replaced with the actual M-Mode notice
-     *
-     * @return string
-     */
-    public function inject_EE_shortcode_placeholder()
-    {
-        return '[ESPRESSO_';
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @return void
-     */
-    public function _possibly_set_ee_request_var()
-    {
-        $this->query_modifier->setRequestVarsIfCpt();
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param  $SQL
-     * @return string
-     */
-    public function posts_fields($SQL)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            return $this->query_modifier->postsFields($SQL);
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param  $SQL
-     * @return string
-     */
-    public function posts_join($SQL)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            return $this->query_modifier->postsJoin($SQL);
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param  \WP_Post[] $posts
-     * @return \WP_Post[]
-     */
-    public function the_posts($posts)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            $this->query_modifier->thePosts($posts);
-        }
-        return $posts;
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param $url
-     * @param $ID
-     * @return string
-     */
-    public function get_edit_post_link($url, $ID)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            return $this->query_modifier->getEditPostLink($url, $ID);
-        }
-        return '';
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param null $WP_Query
-     */
-    protected function _do_template_filters($WP_Query = null)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            $this->query_modifier->addTemplateFilters();
-        }
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param string $current_template Existing default template path derived for this page call.
-     * @return string the path to the full template file.
-     */
-    public function single_cpt_template($current_template)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            return $this->query_modifier->singleCptTemplate($current_template);
-        }
-        return $current_template;
-    }
+	/**
+	 * @var EE_CPT_Strategy $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * the current page, if it utilizes CPTs
+	 *
+	 * @var array $CPT
+	 */
+	protected $CPT;
+
+	/**
+	 * return value from CustomPostTypeDefinitions::getDefinitions()
+	 *
+	 * @var array $_CPTs
+	 */
+	protected $_CPTs = array();
+
+	/**
+	 * @var array $_CPT_taxonomies
+	 */
+	protected $_CPT_taxonomies = array();
+
+	/**
+	 * @var array $_CPT_terms
+	 */
+	protected $_CPT_terms = array();
+
+	/**
+	 * @var array $_CPT_endpoints
+	 */
+	protected $_CPT_endpoints = array();
+
+	/**
+	 * @var EEM_Base $CPT_model
+	 */
+	protected $CPT_model;
+
+	/**
+	 * @var EventEspresso\Core\CPTs\CptQueryModifier $query_modifier
+	 */
+	protected $query_modifier;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param CustomPostTypeDefinitions|null $custom_post_types
+	 * @param CustomTaxonomyDefinitions|null $taxonomies
+	 * @return EE_CPT_Strategy
+	 */
+	public static function instance(
+		CustomPostTypeDefinitions $custom_post_types = null,
+		CustomTaxonomyDefinitions $taxonomies = null
+	) {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_CPT_Strategy
+			&& $custom_post_types instanceof CustomPostTypeDefinitions
+			&& $taxonomies instanceof CustomTaxonomyDefinitions
+		) {
+			self::$_instance = new self($custom_post_types, $taxonomies);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param CustomPostTypeDefinitions $custom_post_types
+	 * @param CustomTaxonomyDefinitions $taxonomies
+	 */
+	protected function __construct(
+		CustomPostTypeDefinitions $custom_post_types,
+		CustomTaxonomyDefinitions $taxonomies
+	) {
+		// get CPT data
+		$this->_CPTs = $custom_post_types->getDefinitions();
+		$this->_CPT_endpoints = $this->_set_CPT_endpoints();
+		$this->_CPT_taxonomies = $taxonomies->getCustomTaxonomyDefinitions();
+		add_action('pre_get_posts', array($this, 'pre_get_posts'), 5);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_CPT_endpoints()
+	{
+		return $this->_CPT_endpoints;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_CPT_taxonomies()
+	{
+		return $this->_CPT_taxonomies;
+	}
+
+
+	/**
+	 * add CPT "slugs" to array of default espresso "pages"
+	 *
+	 * @return array
+	 */
+	private function _set_CPT_endpoints()
+	{
+		$_CPT_endpoints = array();
+		if (is_array($this->_CPTs)) {
+			foreach ($this->_CPTs as $CPT_type => $CPT) {
+				$_CPT_endpoints [ $CPT['plural_slug'] ] = $CPT_type;
+			}
+		}
+		return $_CPT_endpoints;
+	}
+
+
+	/**
+	 * If this query (not just "main" queries (ie, for WP's infamous "loop")) is for an EE CPT, then we want to
+	 * supercharge the get_posts query to add our EE stuff (like joining to our tables, selecting extra columns, and
+	 * adding EE objects to the post to facilitate further querying of related data etc)
+	 *
+	 * @param WP_Query $WP_Query
+	 * @return void
+	 * @throws \EE_Error
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function pre_get_posts($WP_Query)
+	{
+		// check that post-type is set
+		if (! $WP_Query instanceof WP_Query) {
+			return;
+		}
+		// add our conditionals
+		$this->_set_EE_tags_on_WP_Query($WP_Query);
+		// check for terms
+		$this->_set_post_type_for_terms($WP_Query);
+		// make sure paging is always set
+		$this->_set_paging($WP_Query);
+		// is a taxonomy set ?
+		$this->_set_CPT_taxonomies_on_WP_Query($WP_Query);
+		// loop thru post_types if set
+		$this->_process_WP_Query_post_types($WP_Query);
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return void
+	 */
+	private function _set_EE_tags_on_WP_Query(WP_Query $WP_Query)
+	{
+		$WP_Query->is_espresso_event_single = false;
+		$WP_Query->is_espresso_event_archive = false;
+		$WP_Query->is_espresso_event_taxonomy = false;
+		$WP_Query->is_espresso_venue_single = false;
+		$WP_Query->is_espresso_venue_archive = false;
+		$WP_Query->is_espresso_venue_taxonomy = false;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_CPT_terms()
+	{
+		if (empty($this->_CPT_terms)) {
+			$terms = EEM_Term::instance()->get_all_CPT_post_tags();
+			foreach ($terms as $term) {
+				if ($term instanceof EE_Term) {
+					$this->_CPT_terms[ $term->slug() ] = $term;
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_post_type_for_terms(WP_Query $WP_Query)
+	{
+		// is a tag set ?
+		if (isset($WP_Query->query['tag'])) {
+			// set post_tags
+			$this->_set_CPT_terms();
+			// is this tag archive term in the list of terms used by our CPTs ?
+			$term = isset($this->_CPT_terms[ $WP_Query->query['tag'] ])
+				? $this->_CPT_terms[ $WP_Query->query['tag'] ]
+				: null;
+			// verify the term
+			if ($term instanceof EE_Term) {
+				$term->post_type = array_merge(array('post', 'page'), (array) $term->post_type);
+				$term->post_type = apply_filters(
+					'FHEE__EE_CPT_Strategy___set_post_type_for_terms__term_post_type',
+					$term->post_type,
+					$term
+				);
+				// if a post type is already set
+				if (isset($WP_Query->query_vars['post_type'])) {
+					// add to existing array
+					$term->post_type = array_merge((array) $WP_Query->query_vars['post_type'], $term->post_type);
+				}
+				// just set post_type to our CPT
+				$WP_Query->set('post_type', array_unique($term->post_type));
+			}
+		}
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return void
+	 */
+	public function _set_paging($WP_Query)
+	{
+		if ($WP_Query->is_main_query() && apply_filters('FHEE__EE_CPT_Strategy___set_paging', true)) {
+			$page = get_query_var('page') ? get_query_var('page') : null;
+			$paged = get_query_var('paged') ? get_query_var('paged') : $page;
+			$WP_Query->set('paged', $paged);
+		}
+	}
+
+
+	/**
+	 * @param \WP_Query $WP_Query
+	 */
+	protected function _set_CPT_taxonomies_on_WP_Query(WP_Query $WP_Query)
+	{
+		// is a taxonomy set ?
+		if ($WP_Query->is_tax) {
+			// loop thru our taxonomies
+			foreach ($this->_CPT_taxonomies as $CPT_taxonomy => $CPT_taxonomy_details) {
+				// check if one of our taxonomies is set as a query var
+				if (isset($WP_Query->query[ $CPT_taxonomy ])) {
+					// but which CPT does that correspond to??? hmmm... guess we gotta go looping
+					foreach ($this->_CPTs as $post_type => $CPT) {
+						// verify our CPT has args, is public and has taxonomies set
+						if (isset($CPT['args']['public'])
+							&& $CPT['args']['public']
+							&& ! empty($CPT['args']['taxonomies'])
+							&& in_array($CPT_taxonomy, $CPT['args']['taxonomies'], true)
+						) {
+							// if so, then add this CPT post_type to the current query's array of post_types'
+							$WP_Query->query_vars['post_type'] = isset($WP_Query->query_vars['post_type'])
+								? (array) $WP_Query->query_vars['post_type']
+								: array();
+							$WP_Query->query_vars['post_type'][] = $post_type;
+							switch ($post_type) {
+								case 'espresso_events':
+									$WP_Query->is_espresso_event_taxonomy = true;
+									break;
+								case 'espresso_venues':
+									$WP_Query->is_espresso_venue_taxonomy = true;
+									break;
+								default:
+									do_action(
+										'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_' . $post_type . '_post_type',
+										$WP_Query,
+										$this
+									);
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param \WP_Query $WP_Query
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_WP_Query_post_types(WP_Query $WP_Query)
+	{
+		if (isset($WP_Query->query_vars['post_type'])) {
+			// loop thru post_types as array
+			foreach ((array) $WP_Query->query_vars['post_type'] as $post_type) {
+				// is current query for an EE CPT ?
+				if (isset($this->_CPTs[ $post_type ])) {
+					// is EE on or off ?
+					if (EE_Maintenance_Mode::instance()->level()) {
+						// reroute CPT template view to maintenance_mode.template.php
+						if (! has_filter('template_include', array('EE_Maintenance_Mode', 'template_include'))) {
+							add_filter('template_include', array('EE_Maintenance_Mode', 'template_include'), 99999);
+						}
+						if (has_filter('the_content', array(EE_Maintenance_Mode::instance(), 'the_content'))) {
+							add_filter('the_content', array($this, 'inject_EE_shortcode_placeholder'), 1);
+						}
+						return;
+					}
+					$this->_generate_CptQueryModifier($WP_Query, $post_type);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param \WP_Query $WP_Query
+	 * @param string    $post_type
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _generate_CptQueryModifier(WP_Query $WP_Query, $post_type)
+	{
+		$this->query_modifier = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\CPTs\CptQueryModifier',
+			array(
+				$post_type,
+				$this->_CPTs[ $post_type ],
+				$WP_Query,
+			)
+		);
+		$this->_CPT_taxonomies = $this->query_modifier->taxonomies();
+	}
+
+
+	/**
+	 * inject_EE_shortcode_placeholder
+	 * in order to display the M-Mode notice on our CPT routes,
+	 * we need to first inject what looks like one of our shortcodes,
+	 * so that it can be replaced with the actual M-Mode notice
+	 *
+	 * @return string
+	 */
+	public function inject_EE_shortcode_placeholder()
+	{
+		return '[ESPRESSO_';
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @return void
+	 */
+	public function _possibly_set_ee_request_var()
+	{
+		$this->query_modifier->setRequestVarsIfCpt();
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function posts_fields($SQL)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			return $this->query_modifier->postsFields($SQL);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function posts_join($SQL)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			return $this->query_modifier->postsJoin($SQL);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param  \WP_Post[] $posts
+	 * @return \WP_Post[]
+	 */
+	public function the_posts($posts)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			$this->query_modifier->thePosts($posts);
+		}
+		return $posts;
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param $url
+	 * @param $ID
+	 * @return string
+	 */
+	public function get_edit_post_link($url, $ID)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			return $this->query_modifier->getEditPostLink($url, $ID);
+		}
+		return '';
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param null $WP_Query
+	 */
+	protected function _do_template_filters($WP_Query = null)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			$this->query_modifier->addTemplateFilters();
+		}
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param string $current_template Existing default template path derived for this page call.
+	 * @return string the path to the full template file.
+	 */
+	public function single_cpt_template($current_template)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			return $this->query_modifier->singleCptTemplate($current_template);
+		}
+		return $current_template;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -72,7 +72,7 @@ 
         CustomTaxonomyDefinitions $taxonomies = null
     ) {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_CPT_Strategy
+        if ( ! self::$_instance instanceof EE_CPT_Strategy
             && $custom_post_types instanceof CustomPostTypeDefinitions
             && $taxonomies instanceof CustomTaxonomyDefinitions
         ) {
@@ -126,7 +126,7 @@ 
         $_CPT_endpoints = array();
         if (is_array($this->_CPTs)) {
             foreach ($this->_CPTs as $CPT_type => $CPT) {
-                $_CPT_endpoints [ $CPT['plural_slug'] ] = $CPT_type;
+                $_CPT_endpoints [$CPT['plural_slug']] = $CPT_type;
             }
         }
         return $_CPT_endpoints;
@@ -148,7 +148,7 @@ 
     public function pre_get_posts($WP_Query)
     {
         // check that post-type is set
-        if (! $WP_Query instanceof WP_Query) {
+        if ( ! $WP_Query instanceof WP_Query) {
             return;
         }
         // add our conditionals
@@ -192,7 +192,7 @@ 
             $terms = EEM_Term::instance()->get_all_CPT_post_tags();
             foreach ($terms as $term) {
                 if ($term instanceof EE_Term) {
-                    $this->_CPT_terms[ $term->slug() ] = $term;
+                    $this->_CPT_terms[$term->slug()] = $term;
                 }
             }
         }
@@ -214,8 +214,8 @@ 
             // set post_tags
             $this->_set_CPT_terms();
             // is this tag archive term in the list of terms used by our CPTs ?
-            $term = isset($this->_CPT_terms[ $WP_Query->query['tag'] ])
-                ? $this->_CPT_terms[ $WP_Query->query['tag'] ]
+            $term = isset($this->_CPT_terms[$WP_Query->query['tag']])
+                ? $this->_CPT_terms[$WP_Query->query['tag']]
                 : null;
             // verify the term
             if ($term instanceof EE_Term) {
@@ -261,7 +261,7 @@ 
             // loop thru our taxonomies
             foreach ($this->_CPT_taxonomies as $CPT_taxonomy => $CPT_taxonomy_details) {
                 // check if one of our taxonomies is set as a query var
-                if (isset($WP_Query->query[ $CPT_taxonomy ])) {
+                if (isset($WP_Query->query[$CPT_taxonomy])) {
                     // but which CPT does that correspond to??? hmmm... guess we gotta go looping
                     foreach ($this->_CPTs as $post_type => $CPT) {
                         // verify our CPT has args, is public and has taxonomies set
@@ -284,7 +284,7 @@ 
                                     break;
                                 default:
                                     do_action(
-                                        'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_' . $post_type . '_post_type',
+                                        'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_'.$post_type.'_post_type',
                                         $WP_Query,
                                         $this
                                     );
@@ -309,11 +309,11 @@ 
             // loop thru post_types as array
             foreach ((array) $WP_Query->query_vars['post_type'] as $post_type) {
                 // is current query for an EE CPT ?
-                if (isset($this->_CPTs[ $post_type ])) {
+                if (isset($this->_CPTs[$post_type])) {
                     // is EE on or off ?
                     if (EE_Maintenance_Mode::instance()->level()) {
                         // reroute CPT template view to maintenance_mode.template.php
-                        if (! has_filter('template_include', array('EE_Maintenance_Mode', 'template_include'))) {
+                        if ( ! has_filter('template_include', array('EE_Maintenance_Mode', 'template_include'))) {
                             add_filter('template_include', array('EE_Maintenance_Mode', 'template_include'), 99999);
                         }
                         if (has_filter('the_content', array(EE_Maintenance_Mode::instance(), 'the_content'))) {
@@ -341,7 +341,7 @@ 
             'EventEspresso\core\CPTs\CptQueryModifier',
             array(
                 $post_type,
-                $this->_CPTs[ $post_type ],
+                $this->_CPTs[$post_type],
                 $WP_Query,
             )
         );

core/CPTs/EE_CPT_Event_Strategy.core.php

Indentation +226 added lines, -226 removed lines

@@ -13,252 +13,252 @@
 class EE_CPT_Event_Strategy
 {
 
-    /**
-     * the current page, if it utilizes CPTs
-     *
-     * @var object $CPT
-     */
-    protected $CPT;
+	/**
+	 * the current page, if it utilizes CPTs
+	 *
+	 * @var object $CPT
+	 */
+	protected $CPT;
 
 
-    /**
-     * @param WP_Query $wp_query
-     * @param array    $CPT
-     */
-    public function __construct($wp_query, $CPT = array())
-    {
-        if ($wp_query instanceof WP_Query) {
-            $WP_Query = $wp_query;
-            $this->CPT = $CPT;
-        } else {
-            $WP_Query = isset($wp_query['WP_Query']) ? $wp_query['WP_Query'] : null;
-            $this->CPT = isset($wp_query['CPT']) ? $wp_query['CPT'] : null;
-        }
-        // !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
-        // here's the list of available filters in the WP_Query object
-        // 'posts_where'
-        // 'posts_where_paged'
-        // 'posts_groupby'
-        // 'posts_join_paged'
-        // 'posts_orderby'
-        // 'posts_distinct'
-        // 'post_limits'
-        // 'posts_fields'
-        // 'posts_join'
-        $this->_add_filters();
-        if ($WP_Query instanceof WP_Query) {
-            $WP_Query->is_espresso_event_single = is_singular()
-                                                  && isset($WP_Query->query->post_type)
-                                                  && $WP_Query->query->post_type === 'espresso_events';
-            $WP_Query->is_espresso_event_archive = is_post_type_archive('espresso_events');
-            $WP_Query->is_espresso_event_taxonomy = is_tax('espresso_event_categories');
-        }
-    }
+	/**
+	 * @param WP_Query $wp_query
+	 * @param array    $CPT
+	 */
+	public function __construct($wp_query, $CPT = array())
+	{
+		if ($wp_query instanceof WP_Query) {
+			$WP_Query = $wp_query;
+			$this->CPT = $CPT;
+		} else {
+			$WP_Query = isset($wp_query['WP_Query']) ? $wp_query['WP_Query'] : null;
+			$this->CPT = isset($wp_query['CPT']) ? $wp_query['CPT'] : null;
+		}
+		// !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
+		// here's the list of available filters in the WP_Query object
+		// 'posts_where'
+		// 'posts_where_paged'
+		// 'posts_groupby'
+		// 'posts_join_paged'
+		// 'posts_orderby'
+		// 'posts_distinct'
+		// 'post_limits'
+		// 'posts_fields'
+		// 'posts_join'
+		$this->_add_filters();
+		if ($WP_Query instanceof WP_Query) {
+			$WP_Query->is_espresso_event_single = is_singular()
+												  && isset($WP_Query->query->post_type)
+												  && $WP_Query->query->post_type === 'espresso_events';
+			$WP_Query->is_espresso_event_archive = is_post_type_archive('espresso_events');
+			$WP_Query->is_espresso_event_taxonomy = is_tax('espresso_event_categories');
+		}
+	}
 
 
-    /**
-     * When an instance of this class is created, we add our filters
-     * (which will get removed in case the next call to get_posts ISN'T
-     * for event CPTs)
-     */
-    protected function _add_filters()
-    {
-        add_filter('posts_fields', array($this, 'posts_fields'), 1, 2);
-        add_filter('posts_join', array($this, 'posts_join'), 1, 2);
-        add_filter('posts_where', array($this, 'posts_where'), 10, 2);
-        // add_filter( 'the_posts', array( $this, 'the_posts' ), 1, 2 );
-        add_filter('posts_orderby', array($this, 'posts_orderby'), 1, 2);
-        add_filter('posts_groupby', array($this, 'posts_groupby'), 1, 2);
-        add_action('posts_selection', array($this, 'remove_filters'));
-    }
+	/**
+	 * When an instance of this class is created, we add our filters
+	 * (which will get removed in case the next call to get_posts ISN'T
+	 * for event CPTs)
+	 */
+	protected function _add_filters()
+	{
+		add_filter('posts_fields', array($this, 'posts_fields'), 1, 2);
+		add_filter('posts_join', array($this, 'posts_join'), 1, 2);
+		add_filter('posts_where', array($this, 'posts_where'), 10, 2);
+		// add_filter( 'the_posts', array( $this, 'the_posts' ), 1, 2 );
+		add_filter('posts_orderby', array($this, 'posts_orderby'), 1, 2);
+		add_filter('posts_groupby', array($this, 'posts_groupby'), 1, 2);
+		add_action('posts_selection', array($this, 'remove_filters'));
+	}
 
 
-    /**
-     * public access to _remove_filters()
-     *
-     * @since $VID:$
-     */
-    public function remove_filters()
-    {
-        $this->_remove_filters();
-    }
+	/**
+	 * public access to _remove_filters()
+	 *
+	 * @since $VID:$
+	 */
+	public function remove_filters()
+	{
+		$this->_remove_filters();
+	}
 
 
-    /**
-     * Should eb called when the last filter or hook is fired for this CPT strategy.
-     * This is to avoid applying this CPT strategy for other posts or CPTs (eg,
-     * we don't want to join to the datetime table when querying for venues, do we!?)
-     */
-    protected function _remove_filters()
-    {
-        remove_filter('posts_fields', array($this, 'posts_fields'), 1);
-        remove_filter('posts_join', array($this, 'posts_join'), 1);
-        remove_filter('posts_where', array($this, 'posts_where'), 10);
-        // remove_filter( 'the_posts', array( $this, 'the_posts' ), 1 );
-        remove_filter('posts_orderby', array($this, 'posts_orderby'), 1);
-        remove_filter('posts_groupby', array($this, 'posts_groupby'), 1);
-        remove_action('posts_selection', array($this, 'remove_filters'));
-    }
+	/**
+	 * Should eb called when the last filter or hook is fired for this CPT strategy.
+	 * This is to avoid applying this CPT strategy for other posts or CPTs (eg,
+	 * we don't want to join to the datetime table when querying for venues, do we!?)
+	 */
+	protected function _remove_filters()
+	{
+		remove_filter('posts_fields', array($this, 'posts_fields'), 1);
+		remove_filter('posts_join', array($this, 'posts_join'), 1);
+		remove_filter('posts_where', array($this, 'posts_where'), 10);
+		// remove_filter( 'the_posts', array( $this, 'the_posts' ), 1 );
+		remove_filter('posts_orderby', array($this, 'posts_orderby'), 1);
+		remove_filter('posts_groupby', array($this, 'posts_groupby'), 1);
+		remove_action('posts_selection', array($this, 'remove_filters'));
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return    string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function posts_fields($SQL, WP_Query $wp_query)
-    {
-        if ($wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_single
-                || $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            // adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-            $SQL .= ', ' . EEM_Datetime::instance()->table() . '.* ';
-            if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
-                // because we only want to retrieve the next upcoming datetime for each event:
-                // add something like:
-                // ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
-                // to WP Query SELECT statement
-                $SQL .= ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
-            }
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function posts_fields($SQL, WP_Query $wp_query)
+	{
+		if ($wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_single
+				|| $wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			// adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
+			$SQL .= ', ' . EEM_Datetime::instance()->table() . '.* ';
+			if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
+				// because we only want to retrieve the next upcoming datetime for each event:
+				// add something like:
+				// ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
+				// to WP Query SELECT statement
+				$SQL .= ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+			}
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function posts_join($SQL, WP_Query $wp_query)
-    {
-        if ($wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_single
-                || $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            // adds something like:
-            // " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
-            // to WP Query JOIN statement
-            $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . EEM_Event::instance()->table()
-                    . '.ID = ' . EEM_Datetime::instance()->table() . '.'
-                    . EEM_Event::instance()->primary_key_name() . ' ) ';
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function posts_join($SQL, WP_Query $wp_query)
+	{
+		if ($wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_single
+				|| $wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			// adds something like:
+			// " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
+			// to WP Query JOIN statement
+			$SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . EEM_Event::instance()->table()
+					. '.ID = ' . EEM_Datetime::instance()->table() . '.'
+					. EEM_Event::instance()->primary_key_name() . ' ) ';
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function posts_where($SQL, WP_Query $wp_query)
-    {
-        if ($wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            if (! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive)
-                || ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events)
-                || ! EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events
-            ) {
-                $SQL .= ' AND ' . EEM_Datetime::instance()->table() . ".DTT_EVT_end > '"
-                        . current_time('mysql', true) . "' ";
-            }
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function posts_where($SQL, WP_Query $wp_query)
+	{
+		if ($wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			if (! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive)
+				|| ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events)
+				|| ! EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events
+			) {
+				$SQL .= ' AND ' . EEM_Datetime::instance()->table() . ".DTT_EVT_end > '"
+						. current_time('mysql', true) . "' ";
+			}
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     */
-    public function posts_orderby($SQL, WP_Query $wp_query)
-    {
-        if ($wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            $SQL = ' event_start_date ASC ';
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 */
+	public function posts_orderby($SQL, WP_Query $wp_query)
+	{
+		if ($wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			$SQL = ' event_start_date ASC ';
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     */
-    public function posts_groupby($SQL, WP_Query $wp_query)
-    {
-        if ($wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            // TODO: add event list option for displaying ALL datetimes in event list or only primary datetime (default)
-            // we're joining to the datetimes table, where there can be MANY datetimes for a single event,
-            // but we want to only show each event only once
-            // (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
-            global $wpdb;
-            $SQL = $wpdb->posts . '.ID ';
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 */
+	public function posts_groupby($SQL, WP_Query $wp_query)
+	{
+		if ($wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			// TODO: add event list option for displaying ALL datetimes in event list or only primary datetime (default)
+			// we're joining to the datetimes table, where there can be MANY datetimes for a single event,
+			// but we want to only show each event only once
+			// (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
+			global $wpdb;
+			$SQL = $wpdb->posts . '.ID ';
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param array    $posts
-     * @param WP_Query $wp_query
-     * @return array
-     */
-    public function the_posts($posts, WP_Query $wp_query)
-    {
-        return $posts;
-    }
+	/**
+	 * @param array    $posts
+	 * @param WP_Query $wp_query
+	 * @return array
+	 */
+	public function the_posts($posts, WP_Query $wp_query)
+	{
+		return $posts;
+	}
 
 
-    /**
-     * @param null $meta_value
-     * @param      $post_id
-     * @param      $meta_key
-     * @param      $single
-     * @return    string
-     */
-    public function get_EE_post_type_metadata($meta_value = null, $post_id, $meta_key, $single)
-    {
-        return $meta_value;
-    }
+	/**
+	 * @param null $meta_value
+	 * @param      $post_id
+	 * @param      $meta_key
+	 * @param      $single
+	 * @return    string
+	 */
+	public function get_EE_post_type_metadata($meta_value = null, $post_id, $meta_key, $single)
+	{
+		return $meta_value;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -121,13 +121,13 @@ 
             )
         ) {
             // adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-            $SQL .= ', ' . EEM_Datetime::instance()->table() . '.* ';
+            $SQL .= ', '.EEM_Datetime::instance()->table().'.* ';
             if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
                 // because we only want to retrieve the next upcoming datetime for each event:
                 // add something like:
                 // ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
                 // to WP Query SELECT statement
-                $SQL .= ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+                $SQL .= ', MIN( '.EEM_Datetime::instance()->table().'.DTT_EVT_start ) as event_start_date ';
             }
         }
         return $SQL;
@@ -156,9 +156,9 @@ 
             // adds something like:
             // " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
             // to WP Query JOIN statement
-            $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . EEM_Event::instance()->table()
-                    . '.ID = ' . EEM_Datetime::instance()->table() . '.'
-                    . EEM_Event::instance()->primary_key_name() . ' ) ';
+            $SQL .= ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.EEM_Event::instance()->table()
+                    . '.ID = '.EEM_Datetime::instance()->table().'.'
+                    . EEM_Event::instance()->primary_key_name().' ) ';
         }
         return $SQL;
     }
@@ -182,12 +182,12 @@ 
                 || $wp_query->is_espresso_event_taxonomy
             )
         ) {
-            if (! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive)
+            if ( ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive)
                 || ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events)
                 || ! EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events
             ) {
-                $SQL .= ' AND ' . EEM_Datetime::instance()->table() . ".DTT_EVT_end > '"
-                        . current_time('mysql', true) . "' ";
+                $SQL .= ' AND '.EEM_Datetime::instance()->table().".DTT_EVT_end > '"
+                        . current_time('mysql', true)."' ";
             }
         }
         return $SQL;
@@ -233,7 +233,7 @@ 
             // but we want to only show each event only once
             // (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
             global $wpdb;
-            $SQL = $wpdb->posts . '.ID ';
+            $SQL = $wpdb->posts.'.ID ';
         }
         return $SQL;
     }