eventespresso / event-espresso-core

core/libraries/line_item_display/EE_SPCO_Line_Item_Display_Strategy.strategy.php

Indentation +659 added lines, -659 removed lines

@@ -12,663 +12,663 @@
 class EE_SPCO_Line_Item_Display_Strategy implements EEI_Line_Item_Display
 {
 
-    /**
-     * array of events
-     *
-     * @type EE_Line_Item[] $_events
-     */
-    private $_events = array();
-
-    /**
-     * whether to display the taxes row or not
-     *
-     * @type bool $_show_taxes
-     */
-    private $_show_taxes = false;
-
-    /**
-     * html for any tax rows
-     *
-     * @type string $_show_taxes
-     */
-    private $_taxes_html = '';
-
-    /**
-     * total amount including tax we can bill for at this time
-     *
-     * @type float $_grand_total
-     */
-    private $_grand_total = 0.00;
-
-    /**
-     * total number of items being billed for
-     *
-     * @type int $_total_items
-     */
-    private $_total_items = 0;
-
-
-
-    /**
-     * @return float
-     */
-    public function grand_total()
-    {
-        return $this->_grand_total;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function total_items()
-    {
-        return $this->_total_items;
-    }
-
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @param EE_Line_Item $parent_line_item
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function display_line_item(
-        EE_Line_Item $line_item,
-        $options = array(),
-        EE_Line_Item $parent_line_item = null
-    ) {
-        $html = '';
-        // set some default options and merge with incoming
-        $default_options = array(
-            'show_desc' => true,  //    true        false
-            'odd'       => false,
-        );
-        $options = array_merge($default_options, (array) $options);
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_line_item:
-                $this->_show_taxes = $line_item->is_taxable() ? true : $this->_show_taxes;
-                if ($line_item->OBJ_type() === 'Ticket') {
-                    // item row
-                    $html .= $this->_ticket_row($line_item, $options);
-                } else {
-                    // item row
-                    $html .= $this->_item_row($line_item, $options);
-                }
-                if (
-                    apply_filters(
-                        'FHEE__EE_SPCO_Line_Item_Display_Strategy__display_line_item__display_sub_line_items',
-                        true
-                    )
-                ) {
-                    // got any kids?
-                    foreach ($line_item->children() as $child_line_item) {
-                        $html .= $this->display_line_item($child_line_item, $options, $line_item);
-                    }
-                }
-                break;
-            case EEM_Line_Item::type_sub_line_item:
-                $html .= $this->_sub_item_row($line_item, $options, $parent_line_item);
-                break;
-            case EEM_Line_Item::type_sub_total:
-                static $sub_total = 0;
-                $event_sub_total = 0;
-                $text = esc_html__('Sub-Total', 'event_espresso');
-                if ($line_item->OBJ_type() === 'Event') {
-                    $options['event_id'] = $event_id = $line_item->OBJ_ID();
-                    if (! isset($this->_events[ $options['event_id'] ])) {
-                        $event = EEM_Event::instance()->get_one_by_ID($options['event_id']);
-                        // if event has default reg status of Not Approved, then don't display info on it
-                        if (
-                            $event instanceof EE_Event
-                            && $event->default_registration_status() === EEM_Registration::status_id_not_approved
-                        ) {
-                            $display_event = false;
-                            // unless there are registrations for it that are returning to pay
-                            if (isset($options['registrations']) && is_array($options['registrations'])) {
-                                foreach ($options['registrations'] as $registration) {
-                                    if (! $registration instanceof EE_Registration) {
-                                        continue;
-                                    }
-                                    $display_event = $registration->event_ID() === $options['event_id']
-                                                     && $registration->status_ID() !== EEM_Registration::status_id_not_approved
-                                        ? true
-                                        : $display_event;
-                                }
-                            }
-                            if (! $display_event) {
-                                return '';
-                            }
-                        }
-                        $this->_events[ $options['event_id'] ] = 0;
-                        $html .= $this->_event_row($line_item);
-                        $text = esc_html__('Event Sub-Total', 'event_espresso');
-                    }
-                }
-                $child_line_items = $line_item->children();
-                // loop thru children
-                foreach ($child_line_items as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options, $line_item);
-                }
-                $event_sub_total += isset($options['event_id']) ? $this->_events[ $options['event_id'] ] : 0;
-                $sub_total += $event_sub_total;
-                if (
-                    (
-                        // event subtotals
-                        $line_item->code() !== 'pre-tax-subtotal' && count($child_line_items) > 1
-                    )
-                    || (
-                        // pre-tax subtotals
-                        $line_item->code() === 'pre-tax-subtotal' && count($this->_events) > 1
-                    )
-                ) {
-                    $options['sub_total'] = $line_item->OBJ_type() === 'Event' ? $event_sub_total : $sub_total;
-                    $html .= $this->_sub_total_row($line_item, $text, $options);
-                }
-                break;
-            case EEM_Line_Item::type_tax:
-                if ($this->_show_taxes) {
-                    $this->_taxes_html .= $this->_tax_row($line_item, $options);
-                }
-                break;
-            case EEM_Line_Item::type_tax_sub_total:
-                if ($this->_show_taxes) {
-                    $child_line_items = $line_item->children();
-                    // loop thru children
-                    foreach ($child_line_items as $child_line_item) {
-                        // recursively feed children back into this method
-                        $html .= $this->display_line_item($child_line_item, $options, $line_item);
-                    }
-                    if (count($child_line_items) > 1) {
-                        $this->_taxes_html .= $this->_total_tax_row($line_item, esc_html__('Tax Total', 'event_espresso'));
-                    }
-                }
-                break;
-            case EEM_Line_Item::type_total:
-                // get all child line items
-                $children = $line_item->children();
-                // loop thru all non-tax child line items
-                foreach ($children as $child_line_item) {
-                    if ($child_line_item->type() !== EEM_Line_Item::type_tax_sub_total) {
-                        // recursively feed children back into this method
-                        $html .= $this->display_line_item($child_line_item, $options, $line_item);
-                    }
-                }
-                // now loop thru  tax child line items
-                foreach ($children as $child_line_item) {
-                    if ($child_line_item->type() === EEM_Line_Item::type_tax_sub_total) {
-                        // recursively feed children back into this method
-                        $html .= $this->display_line_item($child_line_item, $options, $line_item);
-                    }
-                }
-                $html .= $this->_taxes_html;
-                $html .= $this->_total_row($line_item, esc_html__('Total', 'event_espresso'));
-                $html .= $this->_payments_and_amount_owing_rows($line_item, $options);
-                break;
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * _event_row - basically a Heading row displayed once above each event's ticket rows
-     *
-     * @param EE_Line_Item $line_item
-     * @return mixed
-     */
-    private function _event_row(EE_Line_Item $line_item)
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'event-cart-total-row', 'total_tr odd');
-        // event name td
-        $html .= EEH_HTML::td(
-            EEH_HTML::strong($line_item->name()),
-            '',
-            'event-header',
-            '',
-            ' colspan="4"'
-        );
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     * _ticket_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _ticket_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html = EEH_HTML::tr('', '', $row_class);
-        // name && desc
-        $name_and_desc = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
-            $line_item->name(),
-            $line_item
-        );
-        $name_and_desc .= apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
-            (
-                $options['show_desc']
-                    ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
-                    : ''
-            ),
-            $line_item,
-            $options
-        );
-        $name_and_desc .= $line_item->is_taxable() ? ' * ' : '';
-        $name_and_desc = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy___ticket_row__name_and_desc',
-            $name_and_desc,
-            $line_item,
-            $options
-        );
-
-        // name td
-        $html .= EEH_HTML::td( /*__FUNCTION__ .*/
-            $name_and_desc,
-            '',
-            'item_l'
-        );
-        // price td
-        $price = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy___ticket_row__price',
-            $line_item->unit_price_no_code(),
-            $line_item
-        );
-        $html .= EEH_HTML::td($price, '', 'item_c jst-rght');
-        // quantity td
-        $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
-        $this->_total_items += $line_item->quantity();
-        // determine total for line item
-        $total = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy___ticket_row__total',
-            $line_item->total(),
-            $line_item
-        );
-        $this->_events[ $options['event_id'] ] += $total;
-        // total td
-        $html .= EEH_HTML::td(
-            EEH_Template::format_currency($total, false, false),
-            '',
-            'item_r jst-rght'
-        );
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     * _item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _item_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html = EEH_HTML::tr('', '', $row_class);
-        $obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() . ': ' : '';
-        // name && desc
-        $name_and_desc = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
-            $obj_name . $line_item->name(),
-            $line_item
-        );
-        $name_and_desc .= apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
-            (
-                $options['show_desc']
-                ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
-                : ''
-            ),
-            $line_item,
-            $options
-        );
-        $name_and_desc .= $line_item->is_taxable() ? ' * ' : '';
-        $name_and_desc = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy___item_row__name_and_desc',
-            $name_and_desc,
-            $line_item,
-            $options
-        );
-
-        // name td
-        $html .= EEH_HTML::td($name_and_desc, '', 'item_l');
-        // price td
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c jst-rght');
-        } else {
-            $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
-        }
-        // quantity td
-        $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
-        // $total = $line_item->total() * $line_item->quantity();
-        $total = $line_item->total();
-        if (isset($options['event_id'], $this->_events[ $options['event_id'] ])) {
-            $this->_events[ $options['event_id'] ] += $total;
-        }
-        // total td
-        $html .= EEH_HTML::td(
-            EEH_Template::format_currency($total, false, false),
-            '',
-            'item_r jst-rght'
-        );
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     * _sub_item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @param EE_Line_Item $parent_line_item
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _sub_item_row(EE_Line_Item $line_item, $options = array(), EE_Line_Item $parent_line_item = null)
-    {
-        if (
-            $parent_line_item instanceof  EE_Line_Item
-            && $line_item->children() === array()
-            && $line_item->name() === $parent_line_item->name()
-            && apply_filters(
-                'FHEE__EE_SPCO_Line_Item_Display_Strategy___sub_item_row__hide_main_sub_line_item',
-                true
-            )
-        ) {
-            return '';
-        }
-        // start of row
-        $html = EEH_HTML::tr('', '', 'item sub-item-row');
-        // name && desc
-        $name_and_desc = EEH_HTML::span('', '', 'sub-item-row-bullet dashicons dashicons-arrow-right')
-                         . $line_item->name();
-        $name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: '
-                                                  . $line_item->desc()
-                                                  . '</span>' : '';
-        // name td
-        $html .= EEH_HTML::td($name_and_desc, '', 'item_l sub-item');
-        $qty = $parent_line_item instanceof EE_Line_Item ? $parent_line_item->quantity() : 1;
-        // discount/surcharge td
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td(
-                EEH_Template::format_currency(
-                    $line_item->total() / $qty,
-                    false,
-                    false
-                ),
-                '',
-                'item_c jst-rght'
-            );
-        } else {
-            $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
-        }
-        // no quantity td
-        $html .= EEH_HTML::td();
-        // no total td
-        $html .= EEH_HTML::td();
-        // end of row
-        $html .= EEH_HTML::trx();
-        $html = apply_filters(
-            'FHEE__EE_SPCO_Line_Item_Display_Strategy___sub_item_row__html',
-            $html,
-            $line_item,
-            $options,
-            $parent_line_item
-        );
-        return $html;
-    }
-
-
-
-    /**
-     * _tax_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _tax_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'item sub-item tax-total');
-        // name && desc
-        $name_and_desc = $line_item->name();
-        $name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">'
-                          . esc_html__(' * taxable items', 'event_espresso') . '</span>';
-        $name_and_desc .= $options['show_desc'] ? '<br/>' . $line_item->desc() : '';
-        // name td
-        $html .= EEH_HTML::td( /*__FUNCTION__ .*/
-            $name_and_desc,
-            '',
-            'item_l sub-item'
-        );
-        // percent td
-        $html .= EEH_HTML::td($line_item->percent() . '%', '', ' jst-rght', '');
-        // empty td (price)
-        $html .= EEH_HTML::td(EEH_HTML::nbsp());
-        // total td
-        $html .= EEH_HTML::td(
-            EEH_Template::format_currency(
-                $line_item->total(),
-                false,
-                false
-            ),
-            '',
-            'item_r jst-rght'
-        );
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     * _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param string       $text
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _total_tax_row(EE_Line_Item $line_item, $text = '')
-    {
-        $html = '';
-        if ($line_item->total()) {
-            // start of row
-            $html = EEH_HTML::tr('', '', 'total_tr odd');
-            // total td
-            $html .= EEH_HTML::td(
-                $text,
-                '',
-                'total_currency total jst-rght',
-                '',
-                ' colspan="2"'
-            );
-            // empty td (price)
-            $html .= EEH_HTML::td(EEH_HTML::nbsp());
-            // total td
-            $html .= EEH_HTML::td(
-                EEH_Template::format_currency($line_item->total(), false, false),
-                '',
-                'total jst-rght'
-            );
-            // end of row
-            $html .= EEH_HTML::trx();
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param string       $text
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _sub_total_row(EE_Line_Item $line_item, $text = '', $options = array())
-    {
-        $html = '';
-        if ($line_item->total()) {
-            // start of row
-            $html = EEH_HTML::tr('', '', 'total_tr odd');
-            // total td
-            $html .= EEH_HTML::td(
-                $text,
-                '',
-                'total_currency total jst-rght',
-                '',
-                ' colspan="3"'
-            );
-            // total td
-            $html .= EEH_HTML::td(
-                EEH_Template::format_currency($options['sub_total'], false, false),
-                '',
-                'total jst-rght'
-            );
-            // end of row
-            $html .= EEH_HTML::trx();
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param string       $text
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _total_row(EE_Line_Item $line_item, $text = '')
-    {
-        // start of row
-        $html = EEH_HTML::tr('', '', 'spco-grand-total total_tr odd');
-        // total td
-        $html .= EEH_HTML::td($text, '', 'total_currency total jst-rght', '', ' colspan="3"');
-        // total td
-        $html .= EEH_HTML::td(
-            EEH_Template::format_currency($line_item->total(), false, false),
-            '',
-            'total jst-rght'
-        );
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     * _payments_and_amount_owing_rows
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     */
-    private function _payments_and_amount_owing_rows(EE_Line_Item $line_item, $options = array())
-    {
-        $html = '';
-        $owing = $line_item->total();
-        $transaction = EEM_Transaction::instance()->get_one_by_ID($line_item->TXN_ID());
-        if ($transaction instanceof EE_Transaction) {
-            $registration_payments = array();
-            $registrations = ! empty($options['registrations'])
-                ? $options['registrations']
-                : $transaction->registrations();
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
-                    $registration_payments += $registration->registration_payments();
-                }
-            }
-            if (! empty($registration_payments)) {
-                foreach ($registration_payments as $registration_payment) {
-                    if ($registration_payment instanceof EE_Registration_Payment) {
-                        $owing -= $registration_payment->amount();
-                        $payment = $registration_payment->payment();
-                        $payment_desc = '';
-                        if ($payment instanceof EE_Payment) {
-                            $payment_desc = sprintf(
-                                esc_html__('Payment%1$s Received: %2$s', 'event_espresso'),
-                                $payment->txn_id_chq_nmbr() !== ''
-                                    ? ' <span class="small-text">(#' . $payment->txn_id_chq_nmbr() . ')</span> '
-                                    : '',
-                                $payment->timestamp()
-                            );
-                        }
-                        // start of row
-                        $html .= EEH_HTML::tr('', '', 'total_tr odd');
-                        // payment desc
-                        $html .= EEH_HTML::td($payment_desc, '', '', '', ' colspan="3"');
-                        // total td
-                        $html .= EEH_HTML::td(
-                            EEH_Template::format_currency(
-                                $registration_payment->amount(),
-                                false,
-                                false
-                            ),
-                            '',
-                            'total jst-rght'
-                        );
-                        // end of row
-                        $html .= EEH_HTML::trx();
-                    }
-                }
-                if ($line_item->total()) {
-                    // start of row
-                    $html .= EEH_HTML::tr('', '', 'total_tr odd');
-                    // total td
-                    $html .= EEH_HTML::td(
-                        esc_html__('Amount Owing', 'event_espresso'),
-                        '',
-                        'total_currency total jst-rght',
-                        '',
-                        ' colspan="3"'
-                    );
-                    // total td
-                    $html .= EEH_HTML::td(
-                        EEH_Template::format_currency($owing, false, false),
-                        '',
-                        'total jst-rght'
-                    );
-                    // end of row
-                    $html .= EEH_HTML::trx();
-                }
-            }
-        }
-        $this->_grand_total = $owing;
-        return $html;
-    }
+	/**
+	 * array of events
+	 *
+	 * @type EE_Line_Item[] $_events
+	 */
+	private $_events = array();
+
+	/**
+	 * whether to display the taxes row or not
+	 *
+	 * @type bool $_show_taxes
+	 */
+	private $_show_taxes = false;
+
+	/**
+	 * html for any tax rows
+	 *
+	 * @type string $_show_taxes
+	 */
+	private $_taxes_html = '';
+
+	/**
+	 * total amount including tax we can bill for at this time
+	 *
+	 * @type float $_grand_total
+	 */
+	private $_grand_total = 0.00;
+
+	/**
+	 * total number of items being billed for
+	 *
+	 * @type int $_total_items
+	 */
+	private $_total_items = 0;
+
+
+
+	/**
+	 * @return float
+	 */
+	public function grand_total()
+	{
+		return $this->_grand_total;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function total_items()
+	{
+		return $this->_total_items;
+	}
+
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @param EE_Line_Item $parent_line_item
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function display_line_item(
+		EE_Line_Item $line_item,
+		$options = array(),
+		EE_Line_Item $parent_line_item = null
+	) {
+		$html = '';
+		// set some default options and merge with incoming
+		$default_options = array(
+			'show_desc' => true,  //    true        false
+			'odd'       => false,
+		);
+		$options = array_merge($default_options, (array) $options);
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_line_item:
+				$this->_show_taxes = $line_item->is_taxable() ? true : $this->_show_taxes;
+				if ($line_item->OBJ_type() === 'Ticket') {
+					// item row
+					$html .= $this->_ticket_row($line_item, $options);
+				} else {
+					// item row
+					$html .= $this->_item_row($line_item, $options);
+				}
+				if (
+					apply_filters(
+						'FHEE__EE_SPCO_Line_Item_Display_Strategy__display_line_item__display_sub_line_items',
+						true
+					)
+				) {
+					// got any kids?
+					foreach ($line_item->children() as $child_line_item) {
+						$html .= $this->display_line_item($child_line_item, $options, $line_item);
+					}
+				}
+				break;
+			case EEM_Line_Item::type_sub_line_item:
+				$html .= $this->_sub_item_row($line_item, $options, $parent_line_item);
+				break;
+			case EEM_Line_Item::type_sub_total:
+				static $sub_total = 0;
+				$event_sub_total = 0;
+				$text = esc_html__('Sub-Total', 'event_espresso');
+				if ($line_item->OBJ_type() === 'Event') {
+					$options['event_id'] = $event_id = $line_item->OBJ_ID();
+					if (! isset($this->_events[ $options['event_id'] ])) {
+						$event = EEM_Event::instance()->get_one_by_ID($options['event_id']);
+						// if event has default reg status of Not Approved, then don't display info on it
+						if (
+							$event instanceof EE_Event
+							&& $event->default_registration_status() === EEM_Registration::status_id_not_approved
+						) {
+							$display_event = false;
+							// unless there are registrations for it that are returning to pay
+							if (isset($options['registrations']) && is_array($options['registrations'])) {
+								foreach ($options['registrations'] as $registration) {
+									if (! $registration instanceof EE_Registration) {
+										continue;
+									}
+									$display_event = $registration->event_ID() === $options['event_id']
+													 && $registration->status_ID() !== EEM_Registration::status_id_not_approved
+										? true
+										: $display_event;
+								}
+							}
+							if (! $display_event) {
+								return '';
+							}
+						}
+						$this->_events[ $options['event_id'] ] = 0;
+						$html .= $this->_event_row($line_item);
+						$text = esc_html__('Event Sub-Total', 'event_espresso');
+					}
+				}
+				$child_line_items = $line_item->children();
+				// loop thru children
+				foreach ($child_line_items as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options, $line_item);
+				}
+				$event_sub_total += isset($options['event_id']) ? $this->_events[ $options['event_id'] ] : 0;
+				$sub_total += $event_sub_total;
+				if (
+					(
+						// event subtotals
+						$line_item->code() !== 'pre-tax-subtotal' && count($child_line_items) > 1
+					)
+					|| (
+						// pre-tax subtotals
+						$line_item->code() === 'pre-tax-subtotal' && count($this->_events) > 1
+					)
+				) {
+					$options['sub_total'] = $line_item->OBJ_type() === 'Event' ? $event_sub_total : $sub_total;
+					$html .= $this->_sub_total_row($line_item, $text, $options);
+				}
+				break;
+			case EEM_Line_Item::type_tax:
+				if ($this->_show_taxes) {
+					$this->_taxes_html .= $this->_tax_row($line_item, $options);
+				}
+				break;
+			case EEM_Line_Item::type_tax_sub_total:
+				if ($this->_show_taxes) {
+					$child_line_items = $line_item->children();
+					// loop thru children
+					foreach ($child_line_items as $child_line_item) {
+						// recursively feed children back into this method
+						$html .= $this->display_line_item($child_line_item, $options, $line_item);
+					}
+					if (count($child_line_items) > 1) {
+						$this->_taxes_html .= $this->_total_tax_row($line_item, esc_html__('Tax Total', 'event_espresso'));
+					}
+				}
+				break;
+			case EEM_Line_Item::type_total:
+				// get all child line items
+				$children = $line_item->children();
+				// loop thru all non-tax child line items
+				foreach ($children as $child_line_item) {
+					if ($child_line_item->type() !== EEM_Line_Item::type_tax_sub_total) {
+						// recursively feed children back into this method
+						$html .= $this->display_line_item($child_line_item, $options, $line_item);
+					}
+				}
+				// now loop thru  tax child line items
+				foreach ($children as $child_line_item) {
+					if ($child_line_item->type() === EEM_Line_Item::type_tax_sub_total) {
+						// recursively feed children back into this method
+						$html .= $this->display_line_item($child_line_item, $options, $line_item);
+					}
+				}
+				$html .= $this->_taxes_html;
+				$html .= $this->_total_row($line_item, esc_html__('Total', 'event_espresso'));
+				$html .= $this->_payments_and_amount_owing_rows($line_item, $options);
+				break;
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * _event_row - basically a Heading row displayed once above each event's ticket rows
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return mixed
+	 */
+	private function _event_row(EE_Line_Item $line_item)
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'event-cart-total-row', 'total_tr odd');
+		// event name td
+		$html .= EEH_HTML::td(
+			EEH_HTML::strong($line_item->name()),
+			'',
+			'event-header',
+			'',
+			' colspan="4"'
+		);
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 * _ticket_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _ticket_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html = EEH_HTML::tr('', '', $row_class);
+		// name && desc
+		$name_and_desc = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
+			$line_item->name(),
+			$line_item
+		);
+		$name_and_desc .= apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
+			(
+				$options['show_desc']
+					? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
+					: ''
+			),
+			$line_item,
+			$options
+		);
+		$name_and_desc .= $line_item->is_taxable() ? ' * ' : '';
+		$name_and_desc = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy___ticket_row__name_and_desc',
+			$name_and_desc,
+			$line_item,
+			$options
+		);
+
+		// name td
+		$html .= EEH_HTML::td( /*__FUNCTION__ .*/
+			$name_and_desc,
+			'',
+			'item_l'
+		);
+		// price td
+		$price = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy___ticket_row__price',
+			$line_item->unit_price_no_code(),
+			$line_item
+		);
+		$html .= EEH_HTML::td($price, '', 'item_c jst-rght');
+		// quantity td
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
+		$this->_total_items += $line_item->quantity();
+		// determine total for line item
+		$total = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy___ticket_row__total',
+			$line_item->total(),
+			$line_item
+		);
+		$this->_events[ $options['event_id'] ] += $total;
+		// total td
+		$html .= EEH_HTML::td(
+			EEH_Template::format_currency($total, false, false),
+			'',
+			'item_r jst-rght'
+		);
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 * _item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _item_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html = EEH_HTML::tr('', '', $row_class);
+		$obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() . ': ' : '';
+		// name && desc
+		$name_and_desc = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
+			$obj_name . $line_item->name(),
+			$line_item
+		);
+		$name_and_desc .= apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
+			(
+				$options['show_desc']
+				? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
+				: ''
+			),
+			$line_item,
+			$options
+		);
+		$name_and_desc .= $line_item->is_taxable() ? ' * ' : '';
+		$name_and_desc = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy___item_row__name_and_desc',
+			$name_and_desc,
+			$line_item,
+			$options
+		);
+
+		// name td
+		$html .= EEH_HTML::td($name_and_desc, '', 'item_l');
+		// price td
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c jst-rght');
+		} else {
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
+		}
+		// quantity td
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
+		// $total = $line_item->total() * $line_item->quantity();
+		$total = $line_item->total();
+		if (isset($options['event_id'], $this->_events[ $options['event_id'] ])) {
+			$this->_events[ $options['event_id'] ] += $total;
+		}
+		// total td
+		$html .= EEH_HTML::td(
+			EEH_Template::format_currency($total, false, false),
+			'',
+			'item_r jst-rght'
+		);
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 * _sub_item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @param EE_Line_Item $parent_line_item
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _sub_item_row(EE_Line_Item $line_item, $options = array(), EE_Line_Item $parent_line_item = null)
+	{
+		if (
+			$parent_line_item instanceof  EE_Line_Item
+			&& $line_item->children() === array()
+			&& $line_item->name() === $parent_line_item->name()
+			&& apply_filters(
+				'FHEE__EE_SPCO_Line_Item_Display_Strategy___sub_item_row__hide_main_sub_line_item',
+				true
+			)
+		) {
+			return '';
+		}
+		// start of row
+		$html = EEH_HTML::tr('', '', 'item sub-item-row');
+		// name && desc
+		$name_and_desc = EEH_HTML::span('', '', 'sub-item-row-bullet dashicons dashicons-arrow-right')
+						 . $line_item->name();
+		$name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: '
+												  . $line_item->desc()
+												  . '</span>' : '';
+		// name td
+		$html .= EEH_HTML::td($name_and_desc, '', 'item_l sub-item');
+		$qty = $parent_line_item instanceof EE_Line_Item ? $parent_line_item->quantity() : 1;
+		// discount/surcharge td
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td(
+				EEH_Template::format_currency(
+					$line_item->total() / $qty,
+					false,
+					false
+				),
+				'',
+				'item_c jst-rght'
+			);
+		} else {
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
+		}
+		// no quantity td
+		$html .= EEH_HTML::td();
+		// no total td
+		$html .= EEH_HTML::td();
+		// end of row
+		$html .= EEH_HTML::trx();
+		$html = apply_filters(
+			'FHEE__EE_SPCO_Line_Item_Display_Strategy___sub_item_row__html',
+			$html,
+			$line_item,
+			$options,
+			$parent_line_item
+		);
+		return $html;
+	}
+
+
+
+	/**
+	 * _tax_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _tax_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'item sub-item tax-total');
+		// name && desc
+		$name_and_desc = $line_item->name();
+		$name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">'
+						  . esc_html__(' * taxable items', 'event_espresso') . '</span>';
+		$name_and_desc .= $options['show_desc'] ? '<br/>' . $line_item->desc() : '';
+		// name td
+		$html .= EEH_HTML::td( /*__FUNCTION__ .*/
+			$name_and_desc,
+			'',
+			'item_l sub-item'
+		);
+		// percent td
+		$html .= EEH_HTML::td($line_item->percent() . '%', '', ' jst-rght', '');
+		// empty td (price)
+		$html .= EEH_HTML::td(EEH_HTML::nbsp());
+		// total td
+		$html .= EEH_HTML::td(
+			EEH_Template::format_currency(
+				$line_item->total(),
+				false,
+				false
+			),
+			'',
+			'item_r jst-rght'
+		);
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 * _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param string       $text
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _total_tax_row(EE_Line_Item $line_item, $text = '')
+	{
+		$html = '';
+		if ($line_item->total()) {
+			// start of row
+			$html = EEH_HTML::tr('', '', 'total_tr odd');
+			// total td
+			$html .= EEH_HTML::td(
+				$text,
+				'',
+				'total_currency total jst-rght',
+				'',
+				' colspan="2"'
+			);
+			// empty td (price)
+			$html .= EEH_HTML::td(EEH_HTML::nbsp());
+			// total td
+			$html .= EEH_HTML::td(
+				EEH_Template::format_currency($line_item->total(), false, false),
+				'',
+				'total jst-rght'
+			);
+			// end of row
+			$html .= EEH_HTML::trx();
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param string       $text
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _sub_total_row(EE_Line_Item $line_item, $text = '', $options = array())
+	{
+		$html = '';
+		if ($line_item->total()) {
+			// start of row
+			$html = EEH_HTML::tr('', '', 'total_tr odd');
+			// total td
+			$html .= EEH_HTML::td(
+				$text,
+				'',
+				'total_currency total jst-rght',
+				'',
+				' colspan="3"'
+			);
+			// total td
+			$html .= EEH_HTML::td(
+				EEH_Template::format_currency($options['sub_total'], false, false),
+				'',
+				'total jst-rght'
+			);
+			// end of row
+			$html .= EEH_HTML::trx();
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param string       $text
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _total_row(EE_Line_Item $line_item, $text = '')
+	{
+		// start of row
+		$html = EEH_HTML::tr('', '', 'spco-grand-total total_tr odd');
+		// total td
+		$html .= EEH_HTML::td($text, '', 'total_currency total jst-rght', '', ' colspan="3"');
+		// total td
+		$html .= EEH_HTML::td(
+			EEH_Template::format_currency($line_item->total(), false, false),
+			'',
+			'total jst-rght'
+		);
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 * _payments_and_amount_owing_rows
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	private function _payments_and_amount_owing_rows(EE_Line_Item $line_item, $options = array())
+	{
+		$html = '';
+		$owing = $line_item->total();
+		$transaction = EEM_Transaction::instance()->get_one_by_ID($line_item->TXN_ID());
+		if ($transaction instanceof EE_Transaction) {
+			$registration_payments = array();
+			$registrations = ! empty($options['registrations'])
+				? $options['registrations']
+				: $transaction->registrations();
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
+					$registration_payments += $registration->registration_payments();
+				}
+			}
+			if (! empty($registration_payments)) {
+				foreach ($registration_payments as $registration_payment) {
+					if ($registration_payment instanceof EE_Registration_Payment) {
+						$owing -= $registration_payment->amount();
+						$payment = $registration_payment->payment();
+						$payment_desc = '';
+						if ($payment instanceof EE_Payment) {
+							$payment_desc = sprintf(
+								esc_html__('Payment%1$s Received: %2$s', 'event_espresso'),
+								$payment->txn_id_chq_nmbr() !== ''
+									? ' <span class="small-text">(#' . $payment->txn_id_chq_nmbr() . ')</span> '
+									: '',
+								$payment->timestamp()
+							);
+						}
+						// start of row
+						$html .= EEH_HTML::tr('', '', 'total_tr odd');
+						// payment desc
+						$html .= EEH_HTML::td($payment_desc, '', '', '', ' colspan="3"');
+						// total td
+						$html .= EEH_HTML::td(
+							EEH_Template::format_currency(
+								$registration_payment->amount(),
+								false,
+								false
+							),
+							'',
+							'total jst-rght'
+						);
+						// end of row
+						$html .= EEH_HTML::trx();
+					}
+				}
+				if ($line_item->total()) {
+					// start of row
+					$html .= EEH_HTML::tr('', '', 'total_tr odd');
+					// total td
+					$html .= EEH_HTML::td(
+						esc_html__('Amount Owing', 'event_espresso'),
+						'',
+						'total_currency total jst-rght',
+						'',
+						' colspan="3"'
+					);
+					// total td
+					$html .= EEH_HTML::td(
+						EEH_Template::format_currency($owing, false, false),
+						'',
+						'total jst-rght'
+					);
+					// end of row
+					$html .= EEH_HTML::trx();
+				}
+			}
+		}
+		$this->_grand_total = $owing;
+		return $html;
+	}
 }

Spacing +19 added lines, -19 removed lines

@@ -84,7 +84,7 @@ 
         $html = '';
         // set some default options and merge with incoming
         $default_options = array(
-            'show_desc' => true,  //    true        false
+            'show_desc' => true, //    true        false
             'odd'       => false,
         );
         $options = array_merge($default_options, (array) $options);
@@ -119,7 +119,7 @@ 
                 $text = esc_html__('Sub-Total', 'event_espresso');
                 if ($line_item->OBJ_type() === 'Event') {
                     $options['event_id'] = $event_id = $line_item->OBJ_ID();
-                    if (! isset($this->_events[ $options['event_id'] ])) {
+                    if ( ! isset($this->_events[$options['event_id']])) {
                         $event = EEM_Event::instance()->get_one_by_ID($options['event_id']);
                         // if event has default reg status of Not Approved, then don't display info on it
                         if (
@@ -130,7 +130,7 @@ 
                             // unless there are registrations for it that are returning to pay
                             if (isset($options['registrations']) && is_array($options['registrations'])) {
                                 foreach ($options['registrations'] as $registration) {
-                                    if (! $registration instanceof EE_Registration) {
+                                    if ( ! $registration instanceof EE_Registration) {
                                         continue;
                                     }
                                     $display_event = $registration->event_ID() === $options['event_id']
@@ -139,11 +139,11 @@ 
                                         : $display_event;
                                 }
                             }
-                            if (! $display_event) {
+                            if ( ! $display_event) {
                                 return '';
                             }
                         }
-                        $this->_events[ $options['event_id'] ] = 0;
+                        $this->_events[$options['event_id']] = 0;
                         $html .= $this->_event_row($line_item);
                         $text = esc_html__('Event Sub-Total', 'event_espresso');
                     }
@@ -154,7 +154,7 @@ 
                     // recursively feed children back into this method
                     $html .= $this->display_line_item($child_line_item, $options, $line_item);
                 }
-                $event_sub_total += isset($options['event_id']) ? $this->_events[ $options['event_id'] ] : 0;
+                $event_sub_total += isset($options['event_id']) ? $this->_events[$options['event_id']] : 0;
                 $sub_total += $event_sub_total;
                 if (
                     (
@@ -263,7 +263,7 @@ 
             'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
             (
                 $options['show_desc']
-                    ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
+                    ? '<span class="line-item-desc-spn smaller-text">: '.$line_item->desc().'</span>'
                     : ''
             ),
             $line_item,
@@ -299,7 +299,7 @@ 
             $line_item->total(),
             $line_item
         );
-        $this->_events[ $options['event_id'] ] += $total;
+        $this->_events[$options['event_id']] += $total;
         // total td
         $html .= EEH_HTML::td(
             EEH_Template::format_currency($total, false, false),
@@ -326,18 +326,18 @@ 
         // start of row
         $row_class = $options['odd'] ? 'item odd' : 'item';
         $html = EEH_HTML::tr('', '', $row_class);
-        $obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() . ': ' : '';
+        $obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n().': ' : '';
         // name && desc
         $name_and_desc = apply_filters(
             'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
-            $obj_name . $line_item->name(),
+            $obj_name.$line_item->name(),
             $line_item
         );
         $name_and_desc .= apply_filters(
             'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
             (
                 $options['show_desc']
-                ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>'
+                ? '<span class="line-item-desc-spn smaller-text">: '.$line_item->desc().'</span>'
                 : ''
             ),
             $line_item,
@@ -355,7 +355,7 @@ 
         $html .= EEH_HTML::td($name_and_desc, '', 'item_l');
         // price td
         if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c jst-rght');
+            $html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c jst-rght');
         } else {
             $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
         }
@@ -363,8 +363,8 @@ 
         $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
         // $total = $line_item->total() * $line_item->quantity();
         $total = $line_item->total();
-        if (isset($options['event_id'], $this->_events[ $options['event_id'] ])) {
-            $this->_events[ $options['event_id'] ] += $total;
+        if (isset($options['event_id'], $this->_events[$options['event_id']])) {
+            $this->_events[$options['event_id']] += $total;
         }
         // total td
         $html .= EEH_HTML::td(
@@ -459,8 +459,8 @@ 
         // name && desc
         $name_and_desc = $line_item->name();
         $name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">'
-                          . esc_html__(' * taxable items', 'event_espresso') . '</span>';
-        $name_and_desc .= $options['show_desc'] ? '<br/>' . $line_item->desc() : '';
+                          . esc_html__(' * taxable items', 'event_espresso').'</span>';
+        $name_and_desc .= $options['show_desc'] ? '<br/>'.$line_item->desc() : '';
         // name td
         $html .= EEH_HTML::td( /*__FUNCTION__ .*/
             $name_and_desc,
@@ -468,7 +468,7 @@ 
             'item_l sub-item'
         );
         // percent td
-        $html .= EEH_HTML::td($line_item->percent() . '%', '', ' jst-rght', '');
+        $html .= EEH_HTML::td($line_item->percent().'%', '', ' jst-rght', '');
         // empty td (price)
         $html .= EEH_HTML::td(EEH_HTML::nbsp());
         // total td
@@ -613,7 +613,7 @@ 
                     $registration_payments += $registration->registration_payments();
                 }
             }
-            if (! empty($registration_payments)) {
+            if ( ! empty($registration_payments)) {
                 foreach ($registration_payments as $registration_payment) {
                     if ($registration_payment instanceof EE_Registration_Payment) {
                         $owing -= $registration_payment->amount();
@@ -623,7 +623,7 @@ 
                             $payment_desc = sprintf(
                                 esc_html__('Payment%1$s Received: %2$s', 'event_espresso'),
                                 $payment->txn_id_chq_nmbr() !== ''
-                                    ? ' <span class="small-text">(#' . $payment->txn_id_chq_nmbr() . ')</span> '
+                                    ? ' <span class="small-text">(#'.$payment->txn_id_chq_nmbr().')</span> '
                                     : '',
                                 $payment->timestamp()
                             );

core/libraries/rest_api/Capabilities.php

Spacing +11 added lines, -11 removed lines

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

Indentation +177 added lines, -177 removed lines

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

core/libraries/rest_api/RestIncomingQueryParamMetadata.php

Indentation +701 added lines, -701 removed lines

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

Spacing +13 added lines, -13 removed lines

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

core/libraries/rest_api/changes/ChangesIn40834.php

Indentation +33 added lines, -33 removed lines

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

core/libraries/rest_api/RestException.php

Indentation +41 added lines, -41 removed lines

@@ -15,55 +15,55 @@
 class RestException extends \EE_Error
 {
 
-    /**
-     * @var array
-     */
-    protected $wp_error_data = array();
+	/**
+	 * @var array
+	 */
+	protected $wp_error_data = array();
 
-    protected $wp_error_code = '';
+	protected $wp_error_code = '';
 
 
 
-    public function __construct($string_code, $message, $wp_error_data = array(), $previous = null)
-    {
-        if (
-            is_array($wp_error_data)
-            && isset($wp_error_data['status'])
-        ) {
-            $http_status_number = $wp_error_data['status'];
-        } else {
-            $http_status_number = 500;
-        }
-        parent::__construct(
-            $message,
-            $http_status_number,
-            $previous
-        );
-        $this->wp_error_data = $wp_error_data;
-        $this->wp_error_code = $string_code;
-    }
+	public function __construct($string_code, $message, $wp_error_data = array(), $previous = null)
+	{
+		if (
+			is_array($wp_error_data)
+			&& isset($wp_error_data['status'])
+		) {
+			$http_status_number = $wp_error_data['status'];
+		} else {
+			$http_status_number = 500;
+		}
+		parent::__construct(
+			$message,
+			$http_status_number,
+			$previous
+		);
+		$this->wp_error_data = $wp_error_data;
+		$this->wp_error_code = $string_code;
+	}
 
 
 
-    /**
-     * Array of data that may have been set during the constructor, intended for WP_Error's data
-     *
-     * @return array
-     */
-    public function getData()
-    {
-        return $this->wp_error_data;
-    }
+	/**
+	 * Array of data that may have been set during the constructor, intended for WP_Error's data
+	 *
+	 * @return array
+	 */
+	public function getData()
+	{
+		return $this->wp_error_data;
+	}
 
 
 
-    /**
-     * Gets the error string
-     *
-     * @return string
-     */
-    public function getStringCode()
-    {
-        return $this->wp_error_code;
-    }
+	/**
+	 * Gets the error string
+	 *
+	 * @return string
+	 */
+	public function getStringCode()
+	{
+		return $this->wp_error_code;
+	}
 }

core/libraries/rest_api/calculations/Registration.php

Spacing +1 added lines, -1 removed lines

@@ -96,7 +96,7 @@
                     $status_pretty = 'NEVER';
                     break;
             }
-            $checkin_stati[ $datetime_id ] = $status_pretty;
+            $checkin_stati[$datetime_id] = $status_pretty;
         }
         return $checkin_stati;
     }

Indentation +101 added lines, -101 removed lines

@@ -24,109 +24,109 @@
  */
 class Registration extends RegistrationCalculationBase
 {
-    /**
-     * @var EEM_Registration
-     */
-    protected $registration_model;
+	/**
+	 * @var EEM_Registration
+	 */
+	protected $registration_model;
 
-    /**
-     * Registration constructor.
-     * @param EEM_Registration $registration_model
-     */
-    public function __construct(EEM_Registration $registration_model)
-    {
-        $this->registration_model = $registration_model;
-    }
+	/**
+	 * Registration constructor.
+	 * @param EEM_Registration $registration_model
+	 */
+	public function __construct(EEM_Registration $registration_model)
+	{
+		$this->registration_model = $registration_model;
+	}
 
-    /**
-     * Calculates the checkin status for each datetime this registration has access to
-     *
-     * @param array            $wpdb_row
-     * @param WP_REST_Request $request
-     * @param RegistrationControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function datetimeCheckinStati($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) {
-            $reg = $this->registration_model->get_one_by_ID($wpdb_row['Registration.REG_ID']);
-        } else {
-            $reg = null;
-        }
-        if (
-            ! $reg instanceof EE_Registration
-        ) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $wpdb_row['Registration.REG_ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $datetime_ids = EEM_Datetime::instance()->get_col(
-            [
-                [
-                    'Ticket.TKT_ID' => $reg->ticket_ID(),
-                ],
-                'default_where_conditions' => EEM_Base::default_where_conditions_minimum_all,
-            ]
-        );
-        $checkin_stati = array();
-        foreach ($datetime_ids as $datetime_id) {
-            $status = $reg->check_in_status_for_datetime($datetime_id);
-            switch ($status) {
-                case EE_Checkin::status_checked_out:
-                    $status_pretty = 'OUT';
-                    break;
-                case EE_Checkin::status_checked_in:
-                    $status_pretty = 'IN';
-                    break;
-                case EE_Checkin::status_checked_never:
-                default:
-                    $status_pretty = 'NEVER';
-                    break;
-            }
-            $checkin_stati[ $datetime_id ] = $status_pretty;
-        }
-        return $checkin_stati;
-    }
+	/**
+	 * Calculates the checkin status for each datetime this registration has access to
+	 *
+	 * @param array            $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param RegistrationControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function datetimeCheckinStati($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) {
+			$reg = $this->registration_model->get_one_by_ID($wpdb_row['Registration.REG_ID']);
+		} else {
+			$reg = null;
+		}
+		if (
+			! $reg instanceof EE_Registration
+		) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$wpdb_row['Registration.REG_ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$datetime_ids = EEM_Datetime::instance()->get_col(
+			[
+				[
+					'Ticket.TKT_ID' => $reg->ticket_ID(),
+				],
+				'default_where_conditions' => EEM_Base::default_where_conditions_minimum_all,
+			]
+		);
+		$checkin_stati = array();
+		foreach ($datetime_ids as $datetime_id) {
+			$status = $reg->check_in_status_for_datetime($datetime_id);
+			switch ($status) {
+				case EE_Checkin::status_checked_out:
+					$status_pretty = 'OUT';
+					break;
+				case EE_Checkin::status_checked_in:
+					$status_pretty = 'IN';
+					break;
+				case EE_Checkin::status_checked_never:
+				default:
+					$status_pretty = 'NEVER';
+					break;
+			}
+			$checkin_stati[ $datetime_id ] = $status_pretty;
+		}
+		return $checkin_stati;
+	}
 
 
-    /**
-     * Provides an array for all the calculations possible that outlines a json schema for those calculations.
-     * Array is indexed by calculation (snake case) and value is the schema for that calculation.
-     *
-     * @since 4.9.68.p
-     * @return array
-     */
-    public function schemaForCalculations()
-    {
-        return array(
-            'datetime_checkin_stati' => array(
-                'description' => esc_html__(
-                    'Returns the checkin status for each datetime this registration has access to.',
-                    'event_espresso'
-                ),
-                'type' => 'object',
-                'properties' => array(),
-                'additionalProperties' => array(
-                    'description' => esc_html__(
-                        'Keys are date-time ids and values are the check-in status',
-                        'event_espresso'
-                    ),
-                    'type' => 'string'
-                ),
-            ),
-        );
-    }
+	/**
+	 * Provides an array for all the calculations possible that outlines a json schema for those calculations.
+	 * Array is indexed by calculation (snake case) and value is the schema for that calculation.
+	 *
+	 * @since 4.9.68.p
+	 * @return array
+	 */
+	public function schemaForCalculations()
+	{
+		return array(
+			'datetime_checkin_stati' => array(
+				'description' => esc_html__(
+					'Returns the checkin status for each datetime this registration has access to.',
+					'event_espresso'
+				),
+				'type' => 'object',
+				'properties' => array(),
+				'additionalProperties' => array(
+					'description' => esc_html__(
+						'Keys are date-time ids and values are the check-in status',
+						'event_espresso'
+					),
+					'type' => 'string'
+				),
+			),
+		);
+	}
 }

core/libraries/rest_api/CalculatedModelFields.php

Spacing +12 added lines, -12 removed lines

@@ -57,7 +57,7 @@ 
      */
     public function mapping($refresh = false)
     {
-        if (! $this->mapping || $refresh) {
+        if ( ! $this->mapping || $refresh) {
             $this->mapping = $this->generateNewMapping();
         }
         return $this->mapping;
@@ -81,7 +81,7 @@ 
         foreach ($models_with_calculated_fields as $model_name) {
             $calculator = $this->factory->createFromModel($model_name);
             foreach (array_keys(call_user_func(array($calculator, 'schemaForCalculations'))) as $field_name) {
-                $mapping[ $model_name ][ $field_name ] = get_class($calculator);
+                $mapping[$model_name][$field_name] = get_class($calculator);
             }
         }
         return apply_filters(
@@ -108,8 +108,8 @@ 
             foreach ($map_for_model as $calculation_index => $calculations_class) {
                 $calculator = $this->factory->createFromClassname($calculations_class);
                 $schema = call_user_func(array($calculator, 'schemaForCalculation'), $calculation_index);
-                if (! empty($schema)) {
-                    $schema_map[ $map_model ][ $calculation_index ] = $schema;
+                if ( ! empty($schema)) {
+                    $schema_map[$map_model][$calculation_index] = $schema;
                 }
             }
         }
@@ -126,8 +126,8 @@ 
     public function retrieveCalculatedFieldsForModel(EEM_Base $model)
     {
         $mapping = $this->mapping();
-        if (isset($mapping[ $model->get_this_model_name() ])) {
-            return array_keys($mapping[ $model->get_this_model_name() ]);
+        if (isset($mapping[$model->get_this_model_name()])) {
+            return array_keys($mapping[$model->get_this_model_name()]);
         }
         return array();
     }
@@ -140,7 +140,7 @@ 
      */
     public function getJsonSchemaForModel(EEM_Base $model)
     {
-        if (! $this->mapping_schema) {
+        if ( ! $this->mapping_schema) {
             $this->mapping_schema = $this->generateNewMappingSchema();
         }
         return array(
@@ -149,8 +149,8 @@ 
                 'event_espresso'
             ),
             'type' => 'object',
-            'properties' => isset($this->mapping_schema[ $model->get_this_model_name() ])
-                ? $this->mapping_schema[ $model->get_this_model_name() ]
+            'properties' => isset($this->mapping_schema[$model->get_this_model_name()])
+                ? $this->mapping_schema[$model->get_this_model_name()]
                 : array(),
             'additionalProperties' => false,
             'readonly' => true,
@@ -179,10 +179,10 @@ 
     ) {
         $mapping = $this->mapping();
         if (
-            isset($mapping[ $model->get_this_model_name() ])
-            && isset($mapping[ $model->get_this_model_name() ][ $field_name ])
+            isset($mapping[$model->get_this_model_name()])
+            && isset($mapping[$model->get_this_model_name()][$field_name])
         ) {
-            $classname = $mapping[ $model->get_this_model_name() ][ $field_name ];
+            $classname = $mapping[$model->get_this_model_name()][$field_name];
             $calculator = $this->factory->createFromClassname($classname);
             $class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
             return call_user_func(array($calculator, $class_method_name), $wpdb_row, $rest_request, $controller);

Indentation +174 added lines, -174 removed lines

@@ -22,178 +22,178 @@
 class CalculatedModelFields
 {
 
-    /**
-     * @var array
-     */
-    protected $mapping;
-
-    /**
-     * @var array
-     */
-    protected $mapping_schema;
-
-    /**
-     * @var CalculatedModelFieldsFactory
-     */
-    private $factory;
-
-    /**
-     * CalculatedModelFields constructor.
-     * @param CalculatedModelFieldsFactory $factory
-     */
-    public function __construct(CalculatedModelFieldsFactory $factory)
-    {
-        $this->factory = $factory;
-    }
-    /**
-     * @param bool $refresh
-     * @return array top-level-keys are model names (eg "Event")
-     * next-level are the calculated field names AND method names on classes
-     * which perform calculations, values are the fully qualified classnames which do the calculations
-     * These callbacks should accept as arguments:
-     * the wpdb row results,
-     * the WP_Request object,
-     * the controller object
-     */
-    public function mapping($refresh = false)
-    {
-        if (! $this->mapping || $refresh) {
-            $this->mapping = $this->generateNewMapping();
-        }
-        return $this->mapping;
-    }
-
-
-    /**
-     * Generates a new mapping between model calculated fields and their callbacks
-     *
-     * @return array
-     */
-    protected function generateNewMapping()
-    {
-        $mapping = array();
-        $models_with_calculated_fields = array(
-            'Attendee',
-            'Datetime',
-            'Event',
-            'Registration'
-        );
-        foreach ($models_with_calculated_fields as $model_name) {
-            $calculator = $this->factory->createFromModel($model_name);
-            foreach (array_keys(call_user_func(array($calculator, 'schemaForCalculations'))) as $field_name) {
-                $mapping[ $model_name ][ $field_name ] = get_class($calculator);
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping',
-            $mapping
-        );
-    }
-
-
-    /**
-     * Generates the schema for each calculation index in the calculation map.
-     *
-     * @return array
-     * @throws UnexpectedEntityException
-     */
-    protected function generateNewMappingSchema()
-    {
-        $schema_map = array();
-        foreach ($this->mapping() as $map_model => $map_for_model) {
-            /**
-             * @var string $calculation_index
-             * @var string $calculations_class
-             */
-            foreach ($map_for_model as $calculation_index => $calculations_class) {
-                $calculator = $this->factory->createFromClassname($calculations_class);
-                $schema = call_user_func(array($calculator, 'schemaForCalculation'), $calculation_index);
-                if (! empty($schema)) {
-                    $schema_map[ $map_model ][ $calculation_index ] = $schema;
-                }
-            }
-        }
-        return $schema_map;
-    }
-
-
-    /**
-     * Gets the known calculated fields for model
-     *
-     * @param EEM_Base $model
-     * @return array allowable values for this field
-     */
-    public function retrieveCalculatedFieldsForModel(EEM_Base $model)
-    {
-        $mapping = $this->mapping();
-        if (isset($mapping[ $model->get_this_model_name() ])) {
-            return array_keys($mapping[ $model->get_this_model_name() ]);
-        }
-        return array();
-    }
-
-
-    /**
-     * Returns the JsonSchema for the calculated fields on the given model.
-     * @param EEM_Base $model
-     * @return array
-     */
-    public function getJsonSchemaForModel(EEM_Base $model)
-    {
-        if (! $this->mapping_schema) {
-            $this->mapping_schema = $this->generateNewMappingSchema();
-        }
-        return array(
-            'description' => esc_html__(
-                'Available calculated fields for this model.  Fields are only present in the response if explicitly requested',
-                'event_espresso'
-            ),
-            'type' => 'object',
-            'properties' => isset($this->mapping_schema[ $model->get_this_model_name() ])
-                ? $this->mapping_schema[ $model->get_this_model_name() ]
-                : array(),
-            'additionalProperties' => false,
-            'readonly' => true,
-        );
-    }
-
-
-    /**
-     * Retrieves the value for this calculation
-     *
-     * @param EEM_Base $model
-     * @param string $field_name
-     * @param array $wpdb_row
-     * @param $rest_request
-     * @param BaseController $controller
-     * @return mixed|null
-     * @throws RestException
-     * @throws UnexpectedEntityException
-     */
-    public function retrieveCalculatedFieldValue(
-        EEM_Base $model,
-        $field_name,
-        $wpdb_row,
-        $rest_request,
-        Base $controller
-    ) {
-        $mapping = $this->mapping();
-        if (
-            isset($mapping[ $model->get_this_model_name() ])
-            && isset($mapping[ $model->get_this_model_name() ][ $field_name ])
-        ) {
-            $classname = $mapping[ $model->get_this_model_name() ][ $field_name ];
-            $calculator = $this->factory->createFromClassname($classname);
-            $class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
-            return call_user_func(array($calculator, $class_method_name), $wpdb_row, $rest_request, $controller);
-        }
-        throw new RestException(
-            'calculated_field_does_not_exist',
-            sprintf(
-                esc_html__('There is no calculated field %1$s on resource %2$s', 'event_espresso'),
-                $field_name,
-                $model->get_this_model_name()
-            )
-        );
-    }
+	/**
+	 * @var array
+	 */
+	protected $mapping;
+
+	/**
+	 * @var array
+	 */
+	protected $mapping_schema;
+
+	/**
+	 * @var CalculatedModelFieldsFactory
+	 */
+	private $factory;
+
+	/**
+	 * CalculatedModelFields constructor.
+	 * @param CalculatedModelFieldsFactory $factory
+	 */
+	public function __construct(CalculatedModelFieldsFactory $factory)
+	{
+		$this->factory = $factory;
+	}
+	/**
+	 * @param bool $refresh
+	 * @return array top-level-keys are model names (eg "Event")
+	 * next-level are the calculated field names AND method names on classes
+	 * which perform calculations, values are the fully qualified classnames which do the calculations
+	 * These callbacks should accept as arguments:
+	 * the wpdb row results,
+	 * the WP_Request object,
+	 * the controller object
+	 */
+	public function mapping($refresh = false)
+	{
+		if (! $this->mapping || $refresh) {
+			$this->mapping = $this->generateNewMapping();
+		}
+		return $this->mapping;
+	}
+
+
+	/**
+	 * Generates a new mapping between model calculated fields and their callbacks
+	 *
+	 * @return array
+	 */
+	protected function generateNewMapping()
+	{
+		$mapping = array();
+		$models_with_calculated_fields = array(
+			'Attendee',
+			'Datetime',
+			'Event',
+			'Registration'
+		);
+		foreach ($models_with_calculated_fields as $model_name) {
+			$calculator = $this->factory->createFromModel($model_name);
+			foreach (array_keys(call_user_func(array($calculator, 'schemaForCalculations'))) as $field_name) {
+				$mapping[ $model_name ][ $field_name ] = get_class($calculator);
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping',
+			$mapping
+		);
+	}
+
+
+	/**
+	 * Generates the schema for each calculation index in the calculation map.
+	 *
+	 * @return array
+	 * @throws UnexpectedEntityException
+	 */
+	protected function generateNewMappingSchema()
+	{
+		$schema_map = array();
+		foreach ($this->mapping() as $map_model => $map_for_model) {
+			/**
+			 * @var string $calculation_index
+			 * @var string $calculations_class
+			 */
+			foreach ($map_for_model as $calculation_index => $calculations_class) {
+				$calculator = $this->factory->createFromClassname($calculations_class);
+				$schema = call_user_func(array($calculator, 'schemaForCalculation'), $calculation_index);
+				if (! empty($schema)) {
+					$schema_map[ $map_model ][ $calculation_index ] = $schema;
+				}
+			}
+		}
+		return $schema_map;
+	}
+
+
+	/**
+	 * Gets the known calculated fields for model
+	 *
+	 * @param EEM_Base $model
+	 * @return array allowable values for this field
+	 */
+	public function retrieveCalculatedFieldsForModel(EEM_Base $model)
+	{
+		$mapping = $this->mapping();
+		if (isset($mapping[ $model->get_this_model_name() ])) {
+			return array_keys($mapping[ $model->get_this_model_name() ]);
+		}
+		return array();
+	}
+
+
+	/**
+	 * Returns the JsonSchema for the calculated fields on the given model.
+	 * @param EEM_Base $model
+	 * @return array
+	 */
+	public function getJsonSchemaForModel(EEM_Base $model)
+	{
+		if (! $this->mapping_schema) {
+			$this->mapping_schema = $this->generateNewMappingSchema();
+		}
+		return array(
+			'description' => esc_html__(
+				'Available calculated fields for this model.  Fields are only present in the response if explicitly requested',
+				'event_espresso'
+			),
+			'type' => 'object',
+			'properties' => isset($this->mapping_schema[ $model->get_this_model_name() ])
+				? $this->mapping_schema[ $model->get_this_model_name() ]
+				: array(),
+			'additionalProperties' => false,
+			'readonly' => true,
+		);
+	}
+
+
+	/**
+	 * Retrieves the value for this calculation
+	 *
+	 * @param EEM_Base $model
+	 * @param string $field_name
+	 * @param array $wpdb_row
+	 * @param $rest_request
+	 * @param BaseController $controller
+	 * @return mixed|null
+	 * @throws RestException
+	 * @throws UnexpectedEntityException
+	 */
+	public function retrieveCalculatedFieldValue(
+		EEM_Base $model,
+		$field_name,
+		$wpdb_row,
+		$rest_request,
+		Base $controller
+	) {
+		$mapping = $this->mapping();
+		if (
+			isset($mapping[ $model->get_this_model_name() ])
+			&& isset($mapping[ $model->get_this_model_name() ][ $field_name ])
+		) {
+			$classname = $mapping[ $model->get_this_model_name() ][ $field_name ];
+			$calculator = $this->factory->createFromClassname($classname);
+			$class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
+			return call_user_func(array($calculator, $class_method_name), $wpdb_row, $rest_request, $controller);
+		}
+		throw new RestException(
+			'calculated_field_does_not_exist',
+			sprintf(
+				esc_html__('There is no calculated field %1$s on resource %2$s', 'event_espresso'),
+				$field_name,
+				$model->get_this_model_name()
+			)
+		);
+	}
 }

core/libraries/rest_api/ModelVersionInfo.php

Spacing +12 added lines, -12 removed lines

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

Indentation +437 added lines, -437 removed lines

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

core/libraries/messages/EE_Messages_Base.lib.php

Spacing +9 added lines, -9 removed lines

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

Indentation +265 added lines, -265 removed lines

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