eventespresso / event-espresso-core

core/libraries/shortcodes/EE_Transaction_Shortcodes.lib.php

Indentation +798 added lines, -798 removed lines

@@ -16,806 +16,806 @@
  */
 class EE_Transaction_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * @var EE_Payment_Method|null $_invoice_pm the invoice payment method for use in invoices etc
-     */
-    protected ?EE_Payment_Method $_invoice_pm = null;
-
-
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Transaction Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to transaction related data', 'event_espresso');
-        $this->_shortcodes = [
-            '[TXN_ID]'                          => esc_html__('The transaction id for the purchase.', 'event_espresso'),
-            '[PAYMENT_URL]'                     => esc_html__(
-                'This is a link to make a payment for the event',
-                'event_espresso'
-            ),
-            '[PAYMENT_LINK_IF_NEEDED_*]'        => esc_html__(
-                    'This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:',
-                    'event_espresso'
-                )
-                . '<ul>'
-                . '<li>'
-                . sprintf(
-                    esc_html__(
-                        '%sclass:%s This can be used to indicate css class is given to the containing css element (default is "callout").',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>'
-                )
-                . '</li>'
-                . '<li>'
-                . sprintf(
-                    esc_html__(
-                        '%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>'
-                )
-                . '</li>'
-                . '<li>'
-                . sprintf(
-                    esc_html__(
-                        '%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>'
-                )
-                . '</li>'
-                . '</ul>',
-            '[PAYMENT_DUE_DATE_*]'              => esc_html__(
-                    'This is a special dynamic shortcode that allows one to output a payment due date.  It will only result in a date shown if there is money owing.  Three parameters are available on this shortcode:',
-                    'event_espresso'
-                )
-                . '<ul>'
-                . '<li>'
-                . sprintf(
-                    esc_html__(
-                        '%sformat:%s This is used to indicate what format the date is in.  Default is whatever is set as date formats for your website.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>'
-                )
-                . '</li>'
-                . '<li>'
-                . sprintf(
-                    esc_html__(
-                        '%sdays_until_due:%s This is the number of days form the transaction creation date that the payment is due.  Defaults to 30.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>'
-                )
-                . '</li>'
-                . '<li>'
-                . sprintf(
-                    esc_html__(
-                        '%sprefix_text:%s You can use this to indicate what text will prefix the date string.  Defaults to "Payment in full due by:"',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>'
-                )
-                . '</li>',
-            '[INVOICE_LINK]'                    => esc_html__(
-                'This is a full html link to the invoice. Add download=true to link directly to download.',
-                'event_espresso'
-            ),
-            '[INVOICE_URL]'                     => esc_html__(
-                'This is just the url for the invoice. Add download=true to link directly to download.',
-                'event_espresso'
-            ),
-            '[INVOICE_LOGO_URL]'                => esc_html__(
-                'This returns the url for the logo uploaded via the invoice settings page.',
-                'event_espresso'
-            ),
-            '[INVOICE_LOGO]'                    => esc_html__(
-                'This returns the logo uploaded via the invoice settings page wrapped in img_tags and with a "logo screen" classes. The image size is also set in the img tags automatically to match the uploaded logo.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_NAME]'              => esc_html__(
-                'This will parse to either: the value of the "Company Name" field in the invoice payment method settings; if that is blank, then the value of the Company Name in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_ADDRESS]'           => esc_html__(
-                'This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYMENT_INSTRUCTIONS]'    => esc_html__(
-                'This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_EMAIL]'             => esc_html__(
-                'This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_TAX_NUMBER_*]'      => sprintf(
-                esc_html__(
-                    'This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number.  It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: %1$s[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]%2$s and that will output: GST: 12345t56.  If you have no tax number in your settings, then no prefix will be output either.',
-                    'event_espresso'
-                ),
-                '<code>',
-                '</code>'
-            ),
-            '[TOTAL_COST]'                      => esc_html__('The total cost for the transaction', 'event_espresso'),
-            '[TXN_STATUS]'                      => esc_html__(
-                'The transaction status for the transaction.',
-                'event_espresso'
-            ),
-            '[TXN_STATUS_ID]'                   => esc_html__(
-                'The ID representing the transaction status as saved in the db.  This tends to be useful for including with css classes for styling certain statuses differently from others.',
-                'event_espresso'
-            ),
-            '[PAYMENT_STATUS]'                  => esc_html__(
-                'The transaction status for the transaction. This parses to the same value as the [TXN_STATUS] shortcode and still remains here for legacy support.',
-                'event_espresso'
-            ),
-            '[PAYMENT_GATEWAY]'                 => esc_html__(
-                'The payment gateway used for the transaction',
-                'event_espresso'
-            ),
-            '[AMOUNT_PAID]'                     => esc_html__(
-                'The amount paid or refunded.  This will only have a value if there was a payment or refund at the time of generating the message.',
-                'event_espresso'
-            ),
-            '[LAST_AMOUNT_PAID]'                => esc_html__(
-                'This is the last payment or refund made on the transaction related to the message being generated.',
-                'event_espresso'
-            ),
-            '[TOTAL_AMOUNT_PAID]'               => esc_html__(
-                'This parses to the total amount paid over all payments',
-                'event_espresso'
-            ),
-            '[TOTAL_OWING]'                     => esc_html__(
-                'The total owing on a transaction with no attributes.',
-                'event_espresso'
-            ),
-            '[TXN_SUBTOTAL]'                    => esc_html__('The subtotal for all txn line items.', 'event_espresso'),
-            '[TXN_TAX_SUBTOTAL]'                => esc_html__('The subtotal for all tax line items.', 'event_espresso'),
-            '[OWING_STATUS_MESSAGE_*]'          => esc_html__(
-                    'A dynamic shortcode for adjusting how total owing gets shown. The acceptable attributes on the shortcode are:',
-                    'event_espresso'
-                )
-                . '<p></ul>'
-                . '<li><strong>still_owing</strong>:'
-                . esc_html__(
-                    'If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount owing). The default is:',
-                    'event_espresso'
-                )
-                . sprintf(
-                    esc_html__('%sPlease make a payment.%s', 'event_espresso'),
-                    '<a href="[PAYMENT_URL]" class="noPrint">',
-                    '</a>'
-                )
-                . '</li>'
-                .
-                '<li><strong>none_owing</strong>:'
-                . esc_html__(
-                    'If the transaction is paid in full, then you can indicate how this gets displayed.  Note, that it defaults to just be the total owing.',
-                    'event_espresso'
-                )
-                . '</li></ul></p>',
-            '[TXN_TOTAL_TICKETS]'               => esc_html__(
-                'The total number of all tickets purchased in a transaction',
-                'event_espresso'
-            ),
-            '[TKT_QTY_PURCHASED]'               => sprintf(
-                esc_html__(
-                    'The total number of all tickets purchased in a transaction. %1$sNOTE: This shortcode is good to use in the "[TICKET_LIST]" field but has been deprecated from all other contexts in favor of the more explicit [TXN_TOTAL_TICKETS] shortcode.%2$s',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>'
-            ),
-            '[TRANSACTION_ADMIN_URL]'           => esc_html__(
-                'The url to the admin page for this transaction',
-                'event_espresso'
-            ),
-            '[RECEIPT_URL]'                     => esc_html__(
-                'This parses to the generated url for retrieving the receipt for the transaction. Add download=true to link directly to download.',
-                'event_espresso'
-            ),
-            '[INVOICE_RECEIPT_SWITCHER_URL]'    => esc_html__(
-                'This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active  then will parse to an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf(
-                esc_html__(
-                    'The same as %1$s%2$s except this returns the html for a button linked to the invoice or receipt.',
-                    'event_espresso'
-                ),
-                '<code>[INVOICE_RECEIPT_SWITCHER_URL]',
-                '</code>'
-            ),
-            '[LAST_PAYMENT_TRANSACTION_ID]'     => esc_html__(
-                'This will output the value of the payment transaction id for the last payment made on the transaction. Note, if a specific payment was included for message generation, that will be used when parsing the shortcode.',
-                'event_espresso'
-            ),
-        ];
-    }
-
-
-    /**
-     * @param string $shortcode the shortcode to be parsed.
-     * @return string parsed shortcode
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _parser($shortcode)
-    {
-        // attempt to get the transaction.  Since this is potentially used in more fields, we may have to look in the
-        // _extra_data for the transaction.
-        $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
-        $transaction = ! $transaction instanceof EE_Transaction
-            && is_array($this->_extra_data)
-            && isset($this->_extra_data['data'])
-            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->txn
-                : $transaction;
-        if (! $transaction instanceof EE_Transaction) {
-            return '';
-        }
-        // payment
-        $payment = $this->_data->payment instanceof EE_Payment ? $this->_data->payment : null;
-        $payment = ! $payment instanceof EE_Payment
-            && is_array($this->_extra_data)
-            && isset($this->_extra_data['data'])
-            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->payment
-                : $payment;
-
-        switch ($shortcode) {
-            case '[TXN_ID]':
-                return $transaction->ID();
-
-            case '[PAYMENT_URL]':
-                $payment_url = $transaction->payment_overview_url();
-                return empty($payment_url)
-                    ? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
-                    : $payment_url;
-
-            case strpos($shortcode, '[INVOICE_LINK') !== false :
-                // any attributes?
-                $attrs = $this->_get_shortcode_attrs($shortcode);
-                // downloading PDF or HTML?
-                $messenger = isset($attrs['download']) ? 'pdf' : 'html';
-                $invoice_url = $transaction->invoice_url($messenger);
-                $invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
-                return sprintf(
-                    esc_html__('%sClick here for Invoice%s', 'event_espresso'),
-                    '<a href="' . $invoice_url . '">',
-                    '</a>'
-                );
-
-            case strpos($shortcode, '[INVOICE_URL') !== false :
-                // any attributes?
-                $attrs = $this->_get_shortcode_attrs($shortcode);
-                // downloading PDF or HTML?
-                $messenger = isset($attrs['download']) ? 'pdf' : 'html';
-                $invoice_url = $transaction->invoice_url($messenger);
-                return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
-
-            case '[INVOICE_LOGO_URL]':
-                return $this->_get_invoice_logo();
-
-            case '[INVOICE_LOGO]':
-                return $this->_get_invoice_logo(true);
-
-            case '[INVOICE_PAYEE_NAME]':
-                return $this->_get_invoice_payee_name();
-
-            case '[INVOICE_PAYEE_ADDRESS]':
-                return $this->_get_invoice_payee_address();
-
-            case '[INVOICE_PAYMENT_INSTRUCTIONS]':
-                return $this->_get_invoice_payment_instructions();
-
-            case '[INVOICE_PAYEE_EMAIL]':
-                return $this->_get_invoice_payee_email();
-
-            case '[TOTAL_COST]':
-                $total = $transaction->total();
-                return ! empty($total) ? EEH_Template::format_currency($total) : '';
-
-            // note the [payment_status] shortcode is kind of misleading because payment status might be different
-            // from txn status so I'm adding this here for clarity.
-            case '[PAYMENT_STATUS]':
-            case '[TXN_STATUS]':
-                $status = $transaction->pretty_status();
-                return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
-
-            case '[TXN_STATUS_ID]':
-                return $transaction->status_ID();
-
-            case '[PAYMENT_GATEWAY]':
-                return $this->_get_payment_gateway($transaction);
-
-            case '[AMOUNT_PAID]':
-                return $payment instanceof EE_Payment
-                    ? EEH_Template::format_currency($payment->amount())
-                    : EEH_Template::format_currency(0);
-
-            case '[LAST_AMOUNT_PAID]':
-                $last_payment = $transaction->last_payment();
-                return $last_payment instanceof EE_Payment
-                    ? EEH_Template::format_currency($last_payment->amount())
-                    : EEH_Template::format_currency(0);
-
-            case '[TOTAL_AMOUNT_PAID]':
-                return EEH_Template::format_currency($transaction->paid());
-
-            case '[TOTAL_OWING]':
-                $total_owing = $transaction->remaining();
-                return EEH_Template::format_currency($total_owing);
-
-            case '[TXN_SUBTOTAL]':
-                return EEH_Template::format_currency($this->_get_subtotal());
-
-            case '[TXN_TAX_SUBTOTAL]':
-                return EEH_Template::format_currency($this->_get_subtotal(true));
-
-            case '[TKT_QTY_PURCHASED]':
-            case '[TXN_TOTAL_TICKETS]':
-                return $this->_data->total_ticket_count;
-
-            case '[TRANSACTION_ADMIN_URL]':
-                require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
-                $query_args = [
-                    'page'   => 'espresso_transactions',
-                    'action' => 'view_transaction',
-                    'TXN_ID' => $transaction->ID(),
-                ];
-                return EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
-
-            case strpos($shortcode, '[RECEIPT_URL') !== false :
-                // get primary_registration
-                $reg = $this->_data->primary_reg_obj;
-                if (! $reg instanceof EE_Registration) {
-                    return '';
-                }
-                // any attributes?
-                $attrs = $this->_get_shortcode_attrs($shortcode);
-                // downloading PDF or HTML?
-                $messenger = isset($attrs['download']) ? 'pdf' : 'html';
-                return $reg->receipt_url($messenger);
-
-            case '[INVOICE_RECEIPT_SWITCHER_URL]':
-                return $this->_get_invoice_receipt_switcher(false);
-
-            case '[INVOICE_RECEIPT_SWITCHER_BUTTON]':
-                return $this->_get_invoice_receipt_switcher();
-
-            case '[LAST_PAYMENT_TRANSACTION_ID]':
-                $id      = '';
-                $payment = $payment instanceof EE_Payment && $payment->ID() !== 0
-                    ? $payment
-                    : $transaction->last_payment();
-                if ($payment instanceof EE_Payment) {
-                    $id = $payment->txn_id_chq_nmbr();
-                }
-                return $id;
-        }
-
-
-        if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) {
-            return $this->_get_custom_total_owing($shortcode);
-        }
-        if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) {
-            return $this->_get_invoice_payee_tax_number($shortcode);
-        }
-        if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) {
-            return $this->_get_payment_link_if_needed($shortcode);
-        }
-        if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) {
-            return $this->_get_payment_due_date($shortcode, $transaction);
-        }
-        return '';
-    }
-
-
-    /**
-     * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode
-     *
-     * @param string $shortcode the incoming shortcode
-     * @return string parsed.
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    private function _get_custom_total_owing($shortcode)
-    {
-        $valid_shortcodes = ['transaction'];
-        $attrs            = $this->_get_shortcode_attrs($shortcode);
-        // ensure default is set.
-        $addressee   = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
-            ? $addressee->txn->remaining()
-            : 0;
-        if ($total_owing > 0) {
-            $owing_content = ! empty($attrs['still_owing'])
-                ? $attrs['still_owing']
-                : sprintf(
-                    esc_html__('%sPlease make a payment.%s', 'event_espresso'),
-                    '<a href="[PAYMENT_URL]" class="noPrint">',
-                    '</a>'
-                );
-            $owing_content = $this->_shortcode_helper->parse_message_template(
-                $owing_content,
-                $addressee,
-                $valid_shortcodes,
-                $this->_message_type,
-                $this->_messenger,
-                $this->_message
-            );
-        } else {
-            $owing_content = ! empty($attrs['none_owing']) ? $attrs['none_owing'] : '';
-        }
-        return $owing_content;
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_payment_gateway($transaction)
-    {
-        $payment_method = $transaction instanceof EE_Transaction ? $transaction->payment_method() : null;
-        return $payment_method instanceof EE_Payment_Method ? $payment_method->name() : '';
-    }
-
-
-    /**
-     * This retrieves a logo to be used for the invoice from whatever is set on the invoice logo settings page.  If its
-     * not present then the organization logo is used if its found (set on the organization settings page).
-     *
-     * @param bool $img_tags TRUE means to return with the img tag wrappers.  False just returns the url to the image.
-     * @return string url or html
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    private function _get_invoice_logo(bool $img_tags = false): string
-    {
-        $invoice_logo_url = '';
-        // try to get the invoice payment method's logo for this transaction image first
-        $payment_method = $this->_get_invoice_payment_method();
-        if ($payment_method instanceof EE_Payment_Method) {
-            $invoice_logo_url = $payment_method->get_extra_meta('pdf_logo_image', true);
-        }
-        if (empty($invoice_logo_url)) {
-            $invoice_logo_url = EE_Registry::instance()->CFG->organization->logo_url;
-        }
-        if (empty($invoice_logo_url)) {
-            return '';
-        }
-        if (! $img_tags) {
-            return $invoice_logo_url;
-        }
-        $invoice_logo_url = esc_url_raw($invoice_logo_url);
-        // image tags have been requested.
-        $image_size       = @getimagesize($invoice_logo_url);
-        $image_width_attr = '';
-        // if image is wider than 300px, set the width to 300
-        if ($image_size !== false) {
-            $image_width      = min($image_size[0], 300);
-            $image_width      = esc_attr($image_width);
-            $image_width_attr = " width='$image_width'";
-        }
-        return '<img class="logo screen" src="' . $invoice_logo_url . '"' . $image_width_attr . ' alt="logo" />';
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee name shortcode
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    private function _get_invoice_payee_name()
-    {
-        $payment_method = $this->_get_invoice_payment_method();
-        $payee_name = $payment_method instanceof EE_Payment_Method
-            ? $payment_method->get_extra_meta('pdf_payee_name', true)
-            : null;
-        return empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name;
-    }
-
-
-    /**
-     * gets the default invoice payment method, but has a filter so it can be overridden
-     *
-     * @return EE_Payment_Method|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _get_invoice_payment_method()
-    {
-        if (! $this->_invoice_pm instanceof EE_Payment_Method) {
-            $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
-            $transaction = ! $transaction instanceof EE_Transaction
-                && is_array($this->_extra_data)
-                && isset($this->_extra_data['data'])
-                && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                    ? $this->_extra_data['data']->txn
-                    : $transaction;
-            // get the invoice payment method, and remember it for the next call too
-            $this->_invoice_pm = apply_filters(
-                'FHEE__EE_Transaction_Shortcodes__get_payment_method__default',
-                EEM_Payment_Method::instance()->get_one_of_type('Invoice'),
-                $transaction
-            );
-        }
-        return $this->_invoice_pm;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee email shortcode
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    private function _get_invoice_payee_email()
-    {
-        $payment_method = $this->_get_invoice_payment_method();
-        $payee_email    = $payment_method instanceof EE_Payment_Method
-            ? $payment_method->get_extra_meta('pdf_payee_email', true)
-            : null;
-        return empty($payee_email)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('email')
-            : $payee_email;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee tax number shortcode
-     *
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    private function _get_invoice_payee_tax_number($shortcode)
-    {
-        $payee_tax_number = null;
-        $payment_method   = $this->_get_invoice_payment_method();
-        if ($payment_method instanceof EE_Payment_Method) {
-            $payee_tax_number = $payment_method->get_extra_meta('pdf_payee_tax_number', true);
-        }
-        $payee_tax_number = empty($payee_tax_number) ? EE_Registry::instance()->CFG->organization->vat
-            : $payee_tax_number;
-        if (empty($payee_tax_number)) {
-            return '';
-        }
-        // any attributes?
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        // prefix?
-        $prefix = $attrs['prefix'] ?? esc_html__('VAT/Tax Number: ', 'event_espresso');
-        return $prefix . $payee_tax_number;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee address shortcode.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.5.0
-     */
-    private function _get_invoice_payee_address()
-    {
-        $payee_address  = null;
-        $payment_method = $this->_get_invoice_payment_method();
-        if ($payment_method instanceof EE_Payment_Method) {
-            $payee_address = $payment_method->get_extra_meta('pdf_payee_address', true);
-        }
-        if (empty($payee_address)) {
-            $organization  = EE_Registry::instance()->CFG->organization;
-            $payee_address = $organization->get_pretty('address_1') . '<br>';
-            $payee_address .= ! empty($organization->address_2)
-                ? $organization->get_pretty('address_2') . '<br>'
-                : '';
-            $payee_address .= $organization->get_pretty('city') . '<br>';
-            // state
-            $state         = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
-            $payee_address .= $state instanceof EE_State ? $state->name() : '';
-            // Country
-            $payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
-            $payee_address .= ! empty($organization->zip) ? $organization->zip : '';
-        }
-        return $payee_address;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payment instructions shortcode.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    private function _get_invoice_payment_instructions()
-    {
-        $payment_method = $this->_get_invoice_payment_method();
-        return ($payment_method instanceof EE_Payment_Method)
-            ? $payment_method->get_extra_meta('pdf_instructions', true)
-            : '';
-    }
-
-
-    /**
-     * get invoice/receipt switch button or url.
-     *
-     * @param bool $button true (default) returns the html for a button, false just returns the url.
-     * @return string
-     */
-    protected function _get_invoice_receipt_switcher($button = true)
-    {
-        $reg          = $this->_data->primary_reg_obj;
-        $message_type = $this->_extra_data['message_type'] ?? '';
-        if (! $reg instanceof EE_Registration || empty($message_type)) {
-            return '';
-        }
-        $switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type;
-        $switch_to_label   = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type
-            ? esc_html__('View Invoice', 'event_espresso')
-            : esc_html__('Switch to Invoice', 'event_espresso');
-        $switch_to_label   =
-            ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
-        $switch_to_url     = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
-        if (! $button) {
-            return $switch_to_url;
-        }
-        if (! empty($switch_to_url)) {
-            return '
+	/**
+	 * @var EE_Payment_Method|null $_invoice_pm the invoice payment method for use in invoices etc
+	 */
+	protected ?EE_Payment_Method $_invoice_pm = null;
+
+
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Transaction Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to transaction related data', 'event_espresso');
+		$this->_shortcodes = [
+			'[TXN_ID]'                          => esc_html__('The transaction id for the purchase.', 'event_espresso'),
+			'[PAYMENT_URL]'                     => esc_html__(
+				'This is a link to make a payment for the event',
+				'event_espresso'
+			),
+			'[PAYMENT_LINK_IF_NEEDED_*]'        => esc_html__(
+					'This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:',
+					'event_espresso'
+				)
+				. '<ul>'
+				. '<li>'
+				. sprintf(
+					esc_html__(
+						'%sclass:%s This can be used to indicate css class is given to the containing css element (default is "callout").',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>'
+				)
+				. '</li>'
+				. '<li>'
+				. sprintf(
+					esc_html__(
+						'%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>'
+				)
+				. '</li>'
+				. '<li>'
+				. sprintf(
+					esc_html__(
+						'%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>'
+				)
+				. '</li>'
+				. '</ul>',
+			'[PAYMENT_DUE_DATE_*]'              => esc_html__(
+					'This is a special dynamic shortcode that allows one to output a payment due date.  It will only result in a date shown if there is money owing.  Three parameters are available on this shortcode:',
+					'event_espresso'
+				)
+				. '<ul>'
+				. '<li>'
+				. sprintf(
+					esc_html__(
+						'%sformat:%s This is used to indicate what format the date is in.  Default is whatever is set as date formats for your website.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>'
+				)
+				. '</li>'
+				. '<li>'
+				. sprintf(
+					esc_html__(
+						'%sdays_until_due:%s This is the number of days form the transaction creation date that the payment is due.  Defaults to 30.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>'
+				)
+				. '</li>'
+				. '<li>'
+				. sprintf(
+					esc_html__(
+						'%sprefix_text:%s You can use this to indicate what text will prefix the date string.  Defaults to "Payment in full due by:"',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>'
+				)
+				. '</li>',
+			'[INVOICE_LINK]'                    => esc_html__(
+				'This is a full html link to the invoice. Add download=true to link directly to download.',
+				'event_espresso'
+			),
+			'[INVOICE_URL]'                     => esc_html__(
+				'This is just the url for the invoice. Add download=true to link directly to download.',
+				'event_espresso'
+			),
+			'[INVOICE_LOGO_URL]'                => esc_html__(
+				'This returns the url for the logo uploaded via the invoice settings page.',
+				'event_espresso'
+			),
+			'[INVOICE_LOGO]'                    => esc_html__(
+				'This returns the logo uploaded via the invoice settings page wrapped in img_tags and with a "logo screen" classes. The image size is also set in the img tags automatically to match the uploaded logo.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_NAME]'              => esc_html__(
+				'This will parse to either: the value of the "Company Name" field in the invoice payment method settings; if that is blank, then the value of the Company Name in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_ADDRESS]'           => esc_html__(
+				'This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYMENT_INSTRUCTIONS]'    => esc_html__(
+				'This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_EMAIL]'             => esc_html__(
+				'This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_TAX_NUMBER_*]'      => sprintf(
+				esc_html__(
+					'This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number.  It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: %1$s[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]%2$s and that will output: GST: 12345t56.  If you have no tax number in your settings, then no prefix will be output either.',
+					'event_espresso'
+				),
+				'<code>',
+				'</code>'
+			),
+			'[TOTAL_COST]'                      => esc_html__('The total cost for the transaction', 'event_espresso'),
+			'[TXN_STATUS]'                      => esc_html__(
+				'The transaction status for the transaction.',
+				'event_espresso'
+			),
+			'[TXN_STATUS_ID]'                   => esc_html__(
+				'The ID representing the transaction status as saved in the db.  This tends to be useful for including with css classes for styling certain statuses differently from others.',
+				'event_espresso'
+			),
+			'[PAYMENT_STATUS]'                  => esc_html__(
+				'The transaction status for the transaction. This parses to the same value as the [TXN_STATUS] shortcode and still remains here for legacy support.',
+				'event_espresso'
+			),
+			'[PAYMENT_GATEWAY]'                 => esc_html__(
+				'The payment gateway used for the transaction',
+				'event_espresso'
+			),
+			'[AMOUNT_PAID]'                     => esc_html__(
+				'The amount paid or refunded.  This will only have a value if there was a payment or refund at the time of generating the message.',
+				'event_espresso'
+			),
+			'[LAST_AMOUNT_PAID]'                => esc_html__(
+				'This is the last payment or refund made on the transaction related to the message being generated.',
+				'event_espresso'
+			),
+			'[TOTAL_AMOUNT_PAID]'               => esc_html__(
+				'This parses to the total amount paid over all payments',
+				'event_espresso'
+			),
+			'[TOTAL_OWING]'                     => esc_html__(
+				'The total owing on a transaction with no attributes.',
+				'event_espresso'
+			),
+			'[TXN_SUBTOTAL]'                    => esc_html__('The subtotal for all txn line items.', 'event_espresso'),
+			'[TXN_TAX_SUBTOTAL]'                => esc_html__('The subtotal for all tax line items.', 'event_espresso'),
+			'[OWING_STATUS_MESSAGE_*]'          => esc_html__(
+					'A dynamic shortcode for adjusting how total owing gets shown. The acceptable attributes on the shortcode are:',
+					'event_espresso'
+				)
+				. '<p></ul>'
+				. '<li><strong>still_owing</strong>:'
+				. esc_html__(
+					'If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount owing). The default is:',
+					'event_espresso'
+				)
+				. sprintf(
+					esc_html__('%sPlease make a payment.%s', 'event_espresso'),
+					'<a href="[PAYMENT_URL]" class="noPrint">',
+					'</a>'
+				)
+				. '</li>'
+				.
+				'<li><strong>none_owing</strong>:'
+				. esc_html__(
+					'If the transaction is paid in full, then you can indicate how this gets displayed.  Note, that it defaults to just be the total owing.',
+					'event_espresso'
+				)
+				. '</li></ul></p>',
+			'[TXN_TOTAL_TICKETS]'               => esc_html__(
+				'The total number of all tickets purchased in a transaction',
+				'event_espresso'
+			),
+			'[TKT_QTY_PURCHASED]'               => sprintf(
+				esc_html__(
+					'The total number of all tickets purchased in a transaction. %1$sNOTE: This shortcode is good to use in the "[TICKET_LIST]" field but has been deprecated from all other contexts in favor of the more explicit [TXN_TOTAL_TICKETS] shortcode.%2$s',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>'
+			),
+			'[TRANSACTION_ADMIN_URL]'           => esc_html__(
+				'The url to the admin page for this transaction',
+				'event_espresso'
+			),
+			'[RECEIPT_URL]'                     => esc_html__(
+				'This parses to the generated url for retrieving the receipt for the transaction. Add download=true to link directly to download.',
+				'event_espresso'
+			),
+			'[INVOICE_RECEIPT_SWITCHER_URL]'    => esc_html__(
+				'This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active  then will parse to an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf(
+				esc_html__(
+					'The same as %1$s%2$s except this returns the html for a button linked to the invoice or receipt.',
+					'event_espresso'
+				),
+				'<code>[INVOICE_RECEIPT_SWITCHER_URL]',
+				'</code>'
+			),
+			'[LAST_PAYMENT_TRANSACTION_ID]'     => esc_html__(
+				'This will output the value of the payment transaction id for the last payment made on the transaction. Note, if a specific payment was included for message generation, that will be used when parsing the shortcode.',
+				'event_espresso'
+			),
+		];
+	}
+
+
+	/**
+	 * @param string $shortcode the shortcode to be parsed.
+	 * @return string parsed shortcode
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _parser($shortcode)
+	{
+		// attempt to get the transaction.  Since this is potentially used in more fields, we may have to look in the
+		// _extra_data for the transaction.
+		$transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
+		$transaction = ! $transaction instanceof EE_Transaction
+			&& is_array($this->_extra_data)
+			&& isset($this->_extra_data['data'])
+			&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']->txn
+				: $transaction;
+		if (! $transaction instanceof EE_Transaction) {
+			return '';
+		}
+		// payment
+		$payment = $this->_data->payment instanceof EE_Payment ? $this->_data->payment : null;
+		$payment = ! $payment instanceof EE_Payment
+			&& is_array($this->_extra_data)
+			&& isset($this->_extra_data['data'])
+			&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']->payment
+				: $payment;
+
+		switch ($shortcode) {
+			case '[TXN_ID]':
+				return $transaction->ID();
+
+			case '[PAYMENT_URL]':
+				$payment_url = $transaction->payment_overview_url();
+				return empty($payment_url)
+					? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
+					: $payment_url;
+
+			case strpos($shortcode, '[INVOICE_LINK') !== false :
+				// any attributes?
+				$attrs = $this->_get_shortcode_attrs($shortcode);
+				// downloading PDF or HTML?
+				$messenger = isset($attrs['download']) ? 'pdf' : 'html';
+				$invoice_url = $transaction->invoice_url($messenger);
+				$invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
+				return sprintf(
+					esc_html__('%sClick here for Invoice%s', 'event_espresso'),
+					'<a href="' . $invoice_url . '">',
+					'</a>'
+				);
+
+			case strpos($shortcode, '[INVOICE_URL') !== false :
+				// any attributes?
+				$attrs = $this->_get_shortcode_attrs($shortcode);
+				// downloading PDF or HTML?
+				$messenger = isset($attrs['download']) ? 'pdf' : 'html';
+				$invoice_url = $transaction->invoice_url($messenger);
+				return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
+
+			case '[INVOICE_LOGO_URL]':
+				return $this->_get_invoice_logo();
+
+			case '[INVOICE_LOGO]':
+				return $this->_get_invoice_logo(true);
+
+			case '[INVOICE_PAYEE_NAME]':
+				return $this->_get_invoice_payee_name();
+
+			case '[INVOICE_PAYEE_ADDRESS]':
+				return $this->_get_invoice_payee_address();
+
+			case '[INVOICE_PAYMENT_INSTRUCTIONS]':
+				return $this->_get_invoice_payment_instructions();
+
+			case '[INVOICE_PAYEE_EMAIL]':
+				return $this->_get_invoice_payee_email();
+
+			case '[TOTAL_COST]':
+				$total = $transaction->total();
+				return ! empty($total) ? EEH_Template::format_currency($total) : '';
+
+			// note the [payment_status] shortcode is kind of misleading because payment status might be different
+			// from txn status so I'm adding this here for clarity.
+			case '[PAYMENT_STATUS]':
+			case '[TXN_STATUS]':
+				$status = $transaction->pretty_status();
+				return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
+
+			case '[TXN_STATUS_ID]':
+				return $transaction->status_ID();
+
+			case '[PAYMENT_GATEWAY]':
+				return $this->_get_payment_gateway($transaction);
+
+			case '[AMOUNT_PAID]':
+				return $payment instanceof EE_Payment
+					? EEH_Template::format_currency($payment->amount())
+					: EEH_Template::format_currency(0);
+
+			case '[LAST_AMOUNT_PAID]':
+				$last_payment = $transaction->last_payment();
+				return $last_payment instanceof EE_Payment
+					? EEH_Template::format_currency($last_payment->amount())
+					: EEH_Template::format_currency(0);
+
+			case '[TOTAL_AMOUNT_PAID]':
+				return EEH_Template::format_currency($transaction->paid());
+
+			case '[TOTAL_OWING]':
+				$total_owing = $transaction->remaining();
+				return EEH_Template::format_currency($total_owing);
+
+			case '[TXN_SUBTOTAL]':
+				return EEH_Template::format_currency($this->_get_subtotal());
+
+			case '[TXN_TAX_SUBTOTAL]':
+				return EEH_Template::format_currency($this->_get_subtotal(true));
+
+			case '[TKT_QTY_PURCHASED]':
+			case '[TXN_TOTAL_TICKETS]':
+				return $this->_data->total_ticket_count;
+
+			case '[TRANSACTION_ADMIN_URL]':
+				require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
+				$query_args = [
+					'page'   => 'espresso_transactions',
+					'action' => 'view_transaction',
+					'TXN_ID' => $transaction->ID(),
+				];
+				return EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
+
+			case strpos($shortcode, '[RECEIPT_URL') !== false :
+				// get primary_registration
+				$reg = $this->_data->primary_reg_obj;
+				if (! $reg instanceof EE_Registration) {
+					return '';
+				}
+				// any attributes?
+				$attrs = $this->_get_shortcode_attrs($shortcode);
+				// downloading PDF or HTML?
+				$messenger = isset($attrs['download']) ? 'pdf' : 'html';
+				return $reg->receipt_url($messenger);
+
+			case '[INVOICE_RECEIPT_SWITCHER_URL]':
+				return $this->_get_invoice_receipt_switcher(false);
+
+			case '[INVOICE_RECEIPT_SWITCHER_BUTTON]':
+				return $this->_get_invoice_receipt_switcher();
+
+			case '[LAST_PAYMENT_TRANSACTION_ID]':
+				$id      = '';
+				$payment = $payment instanceof EE_Payment && $payment->ID() !== 0
+					? $payment
+					: $transaction->last_payment();
+				if ($payment instanceof EE_Payment) {
+					$id = $payment->txn_id_chq_nmbr();
+				}
+				return $id;
+		}
+
+
+		if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) {
+			return $this->_get_custom_total_owing($shortcode);
+		}
+		if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) {
+			return $this->_get_invoice_payee_tax_number($shortcode);
+		}
+		if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) {
+			return $this->_get_payment_link_if_needed($shortcode);
+		}
+		if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) {
+			return $this->_get_payment_due_date($shortcode, $transaction);
+		}
+		return '';
+	}
+
+
+	/**
+	 * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode
+	 *
+	 * @param string $shortcode the incoming shortcode
+	 * @return string parsed.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	private function _get_custom_total_owing($shortcode)
+	{
+		$valid_shortcodes = ['transaction'];
+		$attrs            = $this->_get_shortcode_attrs($shortcode);
+		// ensure default is set.
+		$addressee   = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
+			? $addressee->txn->remaining()
+			: 0;
+		if ($total_owing > 0) {
+			$owing_content = ! empty($attrs['still_owing'])
+				? $attrs['still_owing']
+				: sprintf(
+					esc_html__('%sPlease make a payment.%s', 'event_espresso'),
+					'<a href="[PAYMENT_URL]" class="noPrint">',
+					'</a>'
+				);
+			$owing_content = $this->_shortcode_helper->parse_message_template(
+				$owing_content,
+				$addressee,
+				$valid_shortcodes,
+				$this->_message_type,
+				$this->_messenger,
+				$this->_message
+			);
+		} else {
+			$owing_content = ! empty($attrs['none_owing']) ? $attrs['none_owing'] : '';
+		}
+		return $owing_content;
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_payment_gateway($transaction)
+	{
+		$payment_method = $transaction instanceof EE_Transaction ? $transaction->payment_method() : null;
+		return $payment_method instanceof EE_Payment_Method ? $payment_method->name() : '';
+	}
+
+
+	/**
+	 * This retrieves a logo to be used for the invoice from whatever is set on the invoice logo settings page.  If its
+	 * not present then the organization logo is used if its found (set on the organization settings page).
+	 *
+	 * @param bool $img_tags TRUE means to return with the img tag wrappers.  False just returns the url to the image.
+	 * @return string url or html
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	private function _get_invoice_logo(bool $img_tags = false): string
+	{
+		$invoice_logo_url = '';
+		// try to get the invoice payment method's logo for this transaction image first
+		$payment_method = $this->_get_invoice_payment_method();
+		if ($payment_method instanceof EE_Payment_Method) {
+			$invoice_logo_url = $payment_method->get_extra_meta('pdf_logo_image', true);
+		}
+		if (empty($invoice_logo_url)) {
+			$invoice_logo_url = EE_Registry::instance()->CFG->organization->logo_url;
+		}
+		if (empty($invoice_logo_url)) {
+			return '';
+		}
+		if (! $img_tags) {
+			return $invoice_logo_url;
+		}
+		$invoice_logo_url = esc_url_raw($invoice_logo_url);
+		// image tags have been requested.
+		$image_size       = @getimagesize($invoice_logo_url);
+		$image_width_attr = '';
+		// if image is wider than 300px, set the width to 300
+		if ($image_size !== false) {
+			$image_width      = min($image_size[0], 300);
+			$image_width      = esc_attr($image_width);
+			$image_width_attr = " width='$image_width'";
+		}
+		return '<img class="logo screen" src="' . $invoice_logo_url . '"' . $image_width_attr . ' alt="logo" />';
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee name shortcode
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	private function _get_invoice_payee_name()
+	{
+		$payment_method = $this->_get_invoice_payment_method();
+		$payee_name = $payment_method instanceof EE_Payment_Method
+			? $payment_method->get_extra_meta('pdf_payee_name', true)
+			: null;
+		return empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name;
+	}
+
+
+	/**
+	 * gets the default invoice payment method, but has a filter so it can be overridden
+	 *
+	 * @return EE_Payment_Method|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _get_invoice_payment_method()
+	{
+		if (! $this->_invoice_pm instanceof EE_Payment_Method) {
+			$transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
+			$transaction = ! $transaction instanceof EE_Transaction
+				&& is_array($this->_extra_data)
+				&& isset($this->_extra_data['data'])
+				&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+					? $this->_extra_data['data']->txn
+					: $transaction;
+			// get the invoice payment method, and remember it for the next call too
+			$this->_invoice_pm = apply_filters(
+				'FHEE__EE_Transaction_Shortcodes__get_payment_method__default',
+				EEM_Payment_Method::instance()->get_one_of_type('Invoice'),
+				$transaction
+			);
+		}
+		return $this->_invoice_pm;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee email shortcode
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	private function _get_invoice_payee_email()
+	{
+		$payment_method = $this->_get_invoice_payment_method();
+		$payee_email    = $payment_method instanceof EE_Payment_Method
+			? $payment_method->get_extra_meta('pdf_payee_email', true)
+			: null;
+		return empty($payee_email)
+			? EE_Registry::instance()->CFG->organization->get_pretty('email')
+			: $payee_email;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee tax number shortcode
+	 *
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	private function _get_invoice_payee_tax_number($shortcode)
+	{
+		$payee_tax_number = null;
+		$payment_method   = $this->_get_invoice_payment_method();
+		if ($payment_method instanceof EE_Payment_Method) {
+			$payee_tax_number = $payment_method->get_extra_meta('pdf_payee_tax_number', true);
+		}
+		$payee_tax_number = empty($payee_tax_number) ? EE_Registry::instance()->CFG->organization->vat
+			: $payee_tax_number;
+		if (empty($payee_tax_number)) {
+			return '';
+		}
+		// any attributes?
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		// prefix?
+		$prefix = $attrs['prefix'] ?? esc_html__('VAT/Tax Number: ', 'event_espresso');
+		return $prefix . $payee_tax_number;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee address shortcode.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.5.0
+	 */
+	private function _get_invoice_payee_address()
+	{
+		$payee_address  = null;
+		$payment_method = $this->_get_invoice_payment_method();
+		if ($payment_method instanceof EE_Payment_Method) {
+			$payee_address = $payment_method->get_extra_meta('pdf_payee_address', true);
+		}
+		if (empty($payee_address)) {
+			$organization  = EE_Registry::instance()->CFG->organization;
+			$payee_address = $organization->get_pretty('address_1') . '<br>';
+			$payee_address .= ! empty($organization->address_2)
+				? $organization->get_pretty('address_2') . '<br>'
+				: '';
+			$payee_address .= $organization->get_pretty('city') . '<br>';
+			// state
+			$state         = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
+			$payee_address .= $state instanceof EE_State ? $state->name() : '';
+			// Country
+			$payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
+			$payee_address .= ! empty($organization->zip) ? $organization->zip : '';
+		}
+		return $payee_address;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payment instructions shortcode.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	private function _get_invoice_payment_instructions()
+	{
+		$payment_method = $this->_get_invoice_payment_method();
+		return ($payment_method instanceof EE_Payment_Method)
+			? $payment_method->get_extra_meta('pdf_instructions', true)
+			: '';
+	}
+
+
+	/**
+	 * get invoice/receipt switch button or url.
+	 *
+	 * @param bool $button true (default) returns the html for a button, false just returns the url.
+	 * @return string
+	 */
+	protected function _get_invoice_receipt_switcher($button = true)
+	{
+		$reg          = $this->_data->primary_reg_obj;
+		$message_type = $this->_extra_data['message_type'] ?? '';
+		if (! $reg instanceof EE_Registration || empty($message_type)) {
+			return '';
+		}
+		$switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type;
+		$switch_to_label   = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type
+			? esc_html__('View Invoice', 'event_espresso')
+			: esc_html__('Switch to Invoice', 'event_espresso');
+		$switch_to_label   =
+			! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
+		$switch_to_url     = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
+		if (! $button) {
+			return $switch_to_url;
+		}
+		if (! empty($switch_to_url)) {
+			return '
 	<form method="post" action="' . $switch_to_url . '" >
 		<input class="print_button" type="submit" value="' . $switch_to_label . '" />
 	</form>
 			';
-        }
-        return '';
-    }
-
-
-    /**
-     * This returns a subtotal.
-     *
-     * @param bool $tax if true then return the subtotal for tax otherwise return subtotal.
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_subtotal($tax = false)
-    {
-        $grand_total = $this->_data->grand_total_line_item ?? null;
-        if (! $grand_total instanceof EE_Line_Item) {
-            return 0;
-        }
-        return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
-    }
-
-
-    /**
-     * parser for the [PAYMENT_LINK_IF_NEEDED_*] attribute type shortcode
-     *
-     * @param string $shortcode the incoming shortcode
-     * @return string parsed.
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.7.0
-     */
-    private function _get_payment_link_if_needed($shortcode)
-    {
-        $valid_shortcodes = ['transaction'];
-        $attrs            = $this->_get_shortcode_attrs($shortcode);
-        // ensure default is set.
-        $addressee   = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
-            ? $addressee->txn->remaining()
-            : 0;
-        if ($total_owing > 0) {
-            $class         = $attrs['class'] ?? 'callout';
-            $custom_text   =
-                $attrs['custom_text'] ?? 'You can %smake a payment here »%s.';
-            $container_tag = $attrs['container_tag'] ?? 'p';
-            $opening_tag   = ! empty($container_tag) ? '<' . $container_tag : '';
-            $opening_tag   .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
-            $opening_tag   .= ! empty($opening_tag) ? '>' : $opening_tag;
-            $closing_tag   = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
-            $content       = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
-            // we need to re-run this string through the parser to catch any shortcodes that are in it.
-            $owing_content = $this->_shortcode_helper->parse_message_template(
-                $content,
-                $addressee,
-                $valid_shortcodes,
-                $this->_message_type,
-                $this->_messenger,
-                $this->_message
-            );
-        } else {
-            return '';
-        }
-        return $owing_content;
-    }
-
-
-    /**
-     * Parser for the [PAYMENT_DUE_DATE_*] attribute type shortcode
-     *
-     * @param string         $shortcode The shortcode being parsed.
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.8.28.rc.011
-     */
-    protected function _get_payment_due_date($shortcode, EE_Transaction $transaction)
-    {
-        // if transaction is paid in full then we can just return an empty string
-        if ($transaction->remaining() == 0) {
-            return '';
-        }
-        $attrs               = $this->_get_shortcode_attrs($shortcode);
-        $format              = $attrs['format'] ?? get_option('date_format');
-        $days_until_due      = isset($attrs['days_until_due']) ? (int) $attrs['days_until_due'] : 30;
-        $prefix_text         = $attrs['prefix_text'] ?? esc_html__('Payment in full due by: ', 'event_espresso');
-        $transaction_created = $transaction->get_DateTime_object('TXN_timestamp');
-        // setup date due:
-        try {
-            if ($transaction_created instanceof DateTime) {
-                $date_due = $transaction_created->add(
-                    new DateInterval('P' . $days_until_due . 'D')
-                )->format($format);
-            } else {
-                throw new Exception();
-            }
-        } catch (Exception $e) {
-            // format was likely invalid.
-            $date_due = esc_html__(
-                'Unable to calculate date due, likely the format string is invalid.',
-                'event_espresso'
-            );
-        }
-        return $prefix_text . $date_due;
-    }
+		}
+		return '';
+	}
+
+
+	/**
+	 * This returns a subtotal.
+	 *
+	 * @param bool $tax if true then return the subtotal for tax otherwise return subtotal.
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_subtotal($tax = false)
+	{
+		$grand_total = $this->_data->grand_total_line_item ?? null;
+		if (! $grand_total instanceof EE_Line_Item) {
+			return 0;
+		}
+		return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
+	}
+
+
+	/**
+	 * parser for the [PAYMENT_LINK_IF_NEEDED_*] attribute type shortcode
+	 *
+	 * @param string $shortcode the incoming shortcode
+	 * @return string parsed.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.7.0
+	 */
+	private function _get_payment_link_if_needed($shortcode)
+	{
+		$valid_shortcodes = ['transaction'];
+		$attrs            = $this->_get_shortcode_attrs($shortcode);
+		// ensure default is set.
+		$addressee   = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
+			? $addressee->txn->remaining()
+			: 0;
+		if ($total_owing > 0) {
+			$class         = $attrs['class'] ?? 'callout';
+			$custom_text   =
+				$attrs['custom_text'] ?? 'You can %smake a payment here »%s.';
+			$container_tag = $attrs['container_tag'] ?? 'p';
+			$opening_tag   = ! empty($container_tag) ? '<' . $container_tag : '';
+			$opening_tag   .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
+			$opening_tag   .= ! empty($opening_tag) ? '>' : $opening_tag;
+			$closing_tag   = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
+			$content       = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
+			// we need to re-run this string through the parser to catch any shortcodes that are in it.
+			$owing_content = $this->_shortcode_helper->parse_message_template(
+				$content,
+				$addressee,
+				$valid_shortcodes,
+				$this->_message_type,
+				$this->_messenger,
+				$this->_message
+			);
+		} else {
+			return '';
+		}
+		return $owing_content;
+	}
+
+
+	/**
+	 * Parser for the [PAYMENT_DUE_DATE_*] attribute type shortcode
+	 *
+	 * @param string         $shortcode The shortcode being parsed.
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.8.28.rc.011
+	 */
+	protected function _get_payment_due_date($shortcode, EE_Transaction $transaction)
+	{
+		// if transaction is paid in full then we can just return an empty string
+		if ($transaction->remaining() == 0) {
+			return '';
+		}
+		$attrs               = $this->_get_shortcode_attrs($shortcode);
+		$format              = $attrs['format'] ?? get_option('date_format');
+		$days_until_due      = isset($attrs['days_until_due']) ? (int) $attrs['days_until_due'] : 30;
+		$prefix_text         = $attrs['prefix_text'] ?? esc_html__('Payment in full due by: ', 'event_espresso');
+		$transaction_created = $transaction->get_DateTime_object('TXN_timestamp');
+		// setup date due:
+		try {
+			if ($transaction_created instanceof DateTime) {
+				$date_due = $transaction_created->add(
+					new DateInterval('P' . $days_until_due . 'D')
+				)->format($format);
+			} else {
+				throw new Exception();
+			}
+		} catch (Exception $e) {
+			// format was likely invalid.
+			$date_due = esc_html__(
+				'Unable to calculate date due, likely the format string is invalid.',
+				'event_espresso'
+			);
+		}
+		return $prefix_text . $date_due;
+	}
 }

Spacing +25 added lines, -25 removed lines

@@ -261,7 +261,7 @@ 
             && $this->_extra_data['data'] instanceof EE_Messages_Addressee
                 ? $this->_extra_data['data']->txn
                 : $transaction;
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             return '';
         }
         // payment
@@ -292,7 +292,7 @@ 
                 $invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
                 return sprintf(
                     esc_html__('%sClick here for Invoice%s', 'event_espresso'),
-                    '<a href="' . $invoice_url . '">',
+                    '<a href="'.$invoice_url.'">',
                     '</a>'
                 );
 
@@ -368,7 +368,7 @@ 
                 return $this->_data->total_ticket_count;
 
             case '[TRANSACTION_ADMIN_URL]':
-                require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
+                require_once EE_CORE.'admin/EE_Admin_Page.core.php';
                 $query_args = [
                     'page'   => 'espresso_transactions',
                     'action' => 'view_transaction',
@@ -379,7 +379,7 @@ 
             case strpos($shortcode, '[RECEIPT_URL') !== false :
                 // get primary_registration
                 $reg = $this->_data->primary_reg_obj;
-                if (! $reg instanceof EE_Registration) {
+                if ( ! $reg instanceof EE_Registration) {
                     return '';
                 }
                 // any attributes?
@@ -503,7 +503,7 @@ 
         if (empty($invoice_logo_url)) {
             return '';
         }
-        if (! $img_tags) {
+        if ( ! $img_tags) {
             return $invoice_logo_url;
         }
         $invoice_logo_url = esc_url_raw($invoice_logo_url);
@@ -516,7 +516,7 @@ 
             $image_width      = esc_attr($image_width);
             $image_width_attr = " width='$image_width'";
         }
-        return '<img class="logo screen" src="' . $invoice_logo_url . '"' . $image_width_attr . ' alt="logo" />';
+        return '<img class="logo screen" src="'.$invoice_logo_url.'"'.$image_width_attr.' alt="logo" />';
     }
 
 
@@ -553,7 +553,7 @@ 
      */
     private function _get_invoice_payment_method()
     {
-        if (! $this->_invoice_pm instanceof EE_Payment_Method) {
+        if ( ! $this->_invoice_pm instanceof EE_Payment_Method) {
             $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
             $transaction = ! $transaction instanceof EE_Transaction
                 && is_array($this->_extra_data)
@@ -623,7 +623,7 @@ 
         $attrs = $this->_get_shortcode_attrs($shortcode);
         // prefix?
         $prefix = $attrs['prefix'] ?? esc_html__('VAT/Tax Number: ', 'event_espresso');
-        return $prefix . $payee_tax_number;
+        return $prefix.$payee_tax_number;
     }
 
 
@@ -647,16 +647,16 @@ 
         }
         if (empty($payee_address)) {
             $organization  = EE_Registry::instance()->CFG->organization;
-            $payee_address = $organization->get_pretty('address_1') . '<br>';
+            $payee_address = $organization->get_pretty('address_1').'<br>';
             $payee_address .= ! empty($organization->address_2)
-                ? $organization->get_pretty('address_2') . '<br>'
+                ? $organization->get_pretty('address_2').'<br>'
                 : '';
-            $payee_address .= $organization->get_pretty('city') . '<br>';
+            $payee_address .= $organization->get_pretty('city').'<br>';
             // state
-            $state         = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
+            $state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
             $payee_address .= $state instanceof EE_State ? $state->name() : '';
             // Country
-            $payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
+            $payee_address .= ! empty($organization->CNT_ISO) ? ', '.$organization->CNT_ISO.'<br>' : '';
             $payee_address .= ! empty($organization->zip) ? $organization->zip : '';
         }
         return $payee_address;
@@ -693,7 +693,7 @@ 
     {
         $reg          = $this->_data->primary_reg_obj;
         $message_type = $this->_extra_data['message_type'] ?? '';
-        if (! $reg instanceof EE_Registration || empty($message_type)) {
+        if ( ! $reg instanceof EE_Registration || empty($message_type)) {
             return '';
         }
         $switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type;
@@ -703,13 +703,13 @@ 
         $switch_to_label   =
             ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
         $switch_to_url     = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
-        if (! $button) {
+        if ( ! $button) {
             return $switch_to_url;
         }
-        if (! empty($switch_to_url)) {
+        if ( ! empty($switch_to_url)) {
             return '
-	<form method="post" action="' . $switch_to_url . '" >
-		<input class="print_button" type="submit" value="' . $switch_to_label . '" />
+	<form method="post" action="' . $switch_to_url.'" >
+		<input class="print_button" type="submit" value="' . $switch_to_label.'" />
 	</form>
 			';
         }
@@ -728,7 +728,7 @@ 
     private function _get_subtotal($tax = false)
     {
         $grand_total = $this->_data->grand_total_line_item ?? null;
-        if (! $grand_total instanceof EE_Line_Item) {
+        if ( ! $grand_total instanceof EE_Line_Item) {
             return 0;
         }
         return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
@@ -758,11 +758,11 @@ 
             $custom_text   =
                 $attrs['custom_text'] ?? 'You can %smake a payment here »%s.';
             $container_tag = $attrs['container_tag'] ?? 'p';
-            $opening_tag   = ! empty($container_tag) ? '<' . $container_tag : '';
-            $opening_tag   .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
+            $opening_tag   = ! empty($container_tag) ? '<'.$container_tag : '';
+            $opening_tag   .= ! empty($opening_tag) && ! empty($class) ? ' class="'.$class.'"' : $opening_tag;
             $opening_tag   .= ! empty($opening_tag) ? '>' : $opening_tag;
-            $closing_tag   = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
-            $content       = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
+            $closing_tag   = ! empty($container_tag) ? '</'.$container_tag.'>' : '';
+            $content       = $opening_tag.sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>').$closing_tag;
             // we need to re-run this string through the parser to catch any shortcodes that are in it.
             $owing_content = $this->_shortcode_helper->parse_message_template(
                 $content,
@@ -804,7 +804,7 @@ 
         try {
             if ($transaction_created instanceof DateTime) {
                 $date_due = $transaction_created->add(
-                    new DateInterval('P' . $days_until_due . 'D')
+                    new DateInterval('P'.$days_until_due.'D')
                 )->format($format);
             } else {
                 throw new Exception();
@@ -816,6 +816,6 @@ 
                 'event_espresso'
             );
         }
-        return $prefix_text . $date_due;
+        return $prefix_text.$date_due;
     }
 }

core/libraries/shortcodes/EE_Shortcodes.lib.php

Indentation +478 added lines, -478 removed lines

@@ -15,482 +15,482 @@
  */
 abstract class EE_Shortcodes extends EE_Base
 {
-    /**
-     * matches a full shortcode including shortcodes with attributes or dynamic shortcodes
-     * examples:
-     *  [RECIPIENT_LNAME]
-     *  [RECEIPT_URL download=true]
-     *  [PAYMENT_LINK_IF_NEEDED_* custom_text='pay me now man!']
-     */
-    public const REGEX_SHORTCODE_FULL = '/(\[.+?])/';
-
-    /**
-     * matches the opening [ plus the shortcode name, but nothing else
-     * examples:
-     *  [RECIPIENT_LNAME] matches as [RECIPIENT_LNAME
-     *  [RECEIPT_URL download=true] matches as [RECEIPT_URL
-     *  [PAYMENT_LINK_IF_NEEDED_* custom_text='pay me now man!'] matches as [PAYMENT_LINK_IF_NEEDED_*
-     */
-    public const REGEX_SHORTCODE_NAME_ONLY = '/\[[A-Z_*]+/';
-
-    /**
-     * matches the opening [ plus the dynamic shortcode name including _*, but nothing else
-     * examples:
-     *  [RECIPIENT_LNAME] does not match
-     *  [RECEIPT_URL download=true] does not match
-     *  [PAYMENT_LINK_IF_NEEDED_* custom_text='pay me now man!'] matches as [PAYMENT_LINK_IF_NEEDED_*
-     */
-    public const REGEX_SHORTCODE_DYNAMIC = '/(\[[A-Z_]+_\*)/';
-
-
-
-    /**
-     * holds label for library
-     * This is used for referencing the library label
-     *
-     * @var string
-     */
-    public string $label;
-
-
-    public string $name;
-
-
-    /**
-     * This property is used for referencing a short description of the library
-     *
-     * @var string
-     */
-    public string $description;
-
-
-    /**
-     * This will hold an array of shortcodes with the key as the shortcode ([shortcode]) and the value as a
-     * label/description for the shortcode.
-     *
-     * @var array
-     */
-    protected array $_shortcodes = [];
-
-
-    /**
-     * This will hold the incoming data item sent to the parser method
-     *
-     * @var array|object
-     */
-    protected $_data;
-
-
-    /**
-     * some shortcodes may require extra data to parse.  This property is provided for that.
-     *
-     * @var array|EE_Messages_Addressee
-     */
-    protected $_extra_data;
-
-
-    /**
-     * EE_messenger used to generate the template being parsed.
-     *
-     * @since 4.5.0
-     * @var EE_messenger
-     */
-    protected EE_messenger $_messenger;
-
-
-    /**
-     * message type used to generate the template being parsed.
-     *
-     * @since 4.5.0
-     * @var EE_message_type|null
-     */
-    protected ?EE_message_type $_message_type = null;
-
-
-    /**
-     * context used for the template being parsed
-     *
-     * @since 4.5.0
-     * @var string
-     */
-    protected string $_context;
-
-
-    /**
-     * Specific Message Template Group ID
-     *
-     * @since 4.5.0
-     * @var int
-     */
-    protected int $_GRP_ID;
-
-
-    /**
-     * @since 4.9.0
-     * @type EE_Message|null
-     */
-    protected ?EE_Message $_message = null;
-
-
-    /**
-     * This will hold an instance of the EEH_Parse_Shortcodes helper that will be used when handling list type
-     * shortcodes
-     *
-     * @var EEH_Parse_Shortcodes
-     */
-    protected EEH_Parse_Shortcodes $_shortcode_helper;
-
-
-    public function __construct()
-    {
-        $this->_set_defaults();
-        $this->_set_shortcode_helper();
-        $this->_init_props();
-    }
-
-
-    /**
-     * This sets the defaults for the properties.  Child classes will override these properties in their _init_props
-     * method
-     */
-    private function _set_defaults()
-    {
-        $this->name        = $this->description = '';
-        $this->_shortcodes = [];
-    }
-
-
-    /**
-     * loads an instance of the EE_Shortcode_Parser helper when requested
-     */
-    protected function _set_shortcode_helper()
-    {
-        // get shortcode_replace instance - set when _get_messages is called in child...
-        $this->_shortcode_helper = new EEH_Parse_Shortcodes();
-    }
-
-
-    public function get_shortcode_helper(): EEH_Parse_Shortcodes
-    {
-        return $this->_shortcode_helper;
-    }
-
-
-    /**
-     * This is the public method for kicking of the parser included with each child.  It can be overridden by child
-     * classes if necessary (see EE_Questions_Answers for example)
-     *
-     * @param string       $shortcode  incoming shortcode to be parsed
-     * @param object|array $data       incoming data to be used for parsing
-     * @param object|array $extra_data extra incoming data (usually EE_Messages_Addressee)
-     * @return string            parsed shortcode.
-     */
-    public function parser(string $shortcode, $data, $extra_data = []): string
-    {
-        // filter setup shortcodes
-        $this->_shortcodes = $this->get_shortcodes();
-
-        // we need to set up any dynamic shortcodes so that they work with the array_key_exists
-        preg_match_all(EE_Shortcodes::REGEX_SHORTCODE_NAME_ONLY, $shortcode, $matches);
-        $shortcode_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
-
-        // first we want to make sure this is a valid shortcode
-        if (! array_key_exists($shortcode_to_verify, $this->_shortcodes)) {
-            // get out, this parser doesn't handle the incoming shortcode.
-            return '';
-        }
-        $this->_data       = $data;
-        $this->_extra_data = $extra_data;
-        $this->_set_messages_properties();
-        $parsed = (string) apply_filters(
-            'FHEE__' . get_class($this) . '__parser_after',
-            $this->_parser($shortcode),
-            $shortcode,
-            $data,
-            $extra_data,
-            $this
-        );
-
-        // note the below filter applies to ALL shortcode parsers... be careful!
-        return (string) apply_filters(
-            'FHEE__EE_Shortcodes__parser_after',
-            $parsed,
-            $shortcode,
-            $data,
-            $extra_data,
-            $this
-        );
-    }
-
-
-    /**
-     * This method just returns the shortcodes in the $_shortcodes array property.
-     *
-     * @return array array of shortcodes => description pairs
-     */
-    public function get_shortcodes(): array
-    {
-        $this->_shortcodes = (array) apply_filters(
-            'FHEE__' . get_class($this) . '__shortcodes',
-            $this->_shortcodes,
-            $this
-        );
-
-        // note the below filter applies to ALL shortcode parsers... be careful!
-        return (array) apply_filters('FHEE__EE_Shortcodes__shortcodes', $this->_shortcodes, $this);
-    }
-
-
-    /**
-     * Child classes use this method to set the $name, $description, and $_shortcodes properties.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _init_props();
-
-
-    /**
-     * This method will give parsing instructions for each shortcode defined in the _shortcodes array.  Child methods
-     * will have to take care of handling.
-     *
-     * @abstract
-     * @param string $shortcode    the shortcode to be parsed.
-     * @return string parsed shortcode
-     */
-    abstract protected function _parser($shortcode);
-
-
-    /**
-     * This just validates incoming data for list type shortcode parsers (and they call this method) to make sure it
-     * meets their requirements
-     *
-     * @return void If validation fails we'll throw an exception.
-     * @throws EE_Error
-     */
-    protected function _validate_list_requirements()
-    {
-        // first test to make sure we've got an array!
-        if (! is_array($this->_data)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Expecting an array for the data sent to %s. Instead it was %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    gettype($this->_data)
-                )
-            );
-        }
-
-        // next test to make sure we've got the required template in the index!
-        if (! isset($this->_data['template'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'The incoming data does not have the required template index in its array',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // next test to make sure we've got a data index in the incoming data array
-        if (! isset($this->_data['data'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'The incoming data does not have the required data index in its array',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // all is well let's make sure _extra_data always has the values needed.
-        // let's make sure that extra_data includes all templates (for later parsing if necessary)
-        if (empty($this->_extra_data) || (empty($this->_extra_data['data']) && empty($this->_extra_data['template']))) {
-            $this->_extra_data['data']     = $this->_data['data'];
-            $this->_extra_data['template'] = $this->_data['template'];
-        }
-    }
-
-
-    /**
-     * This returns any attributes that may be existing on an EE_Shortcode
-     *
-     * @param string $shortcode incoming shortcode
-     * @return array An array with the attributes
-     * @since 4.5.0
-     */
-    protected function _get_shortcode_attrs(string $shortcode): array
-    {
-        // make sure the required wp helper function is present
-        // require the shortcode file if necessary
-        if (! function_exists('shortcode_parse_atts')) {
-            require_once(ABSPATH . WPINC . '/shortcodes.php');
-        }
-
-        // let's get any attributes that may be present and set the defaults.
-        $shortcode_to_parse = str_replace(['[', ']'], '', $shortcode);
-        return shortcode_parse_atts($shortcode_to_parse);
-    }
-
-
-    /**
-     * Conditional blocks are shortcode patterns with an opening conditional tag `[IF_*]` and a corresponding
-     * closing tag (eg `[/IF_*]`).  The content within the tags will be displayed/hidden depending on whatever
-     * conditions existed in the opening tag.  This method handles parsing the actual template to show/hide this
-     * conditional content.
-     *
-     * @param string $shortcode This should be the original shortcode as used in the template and passed to the parser.
-     * @param bool   $show      true means the opening and closing tags are removed and the content is left showing,
-     *                          false means the opening and closing tags and the contained content are removed.
-     * @return string     The template for the shortcode is returned.
-     * @since 4.9.32
-     *
-     */
-    protected function _mutate_conditional_block_in_template(string $shortcode, bool $show = true): string
-    {
-        // first let's get all the matches in the template for this particular shortcode.
-        preg_match_all('~' . $this->_get_conditional_block_regex($shortcode) . '~', $this->_data['template'], $matches);
-
-        if ($matches && is_array($matches[0]) && ! empty($matches[0])) {
-            // we need to hide all instances of the matches
-            foreach ($matches[0] as $index => $content_to_show_or_hide) {
-                $content_to_show_or_hide = preg_quote($content_to_show_or_hide);
-                $replacement             = $show ? $matches[4][ $index ] : '';
-                $this->_data['template'] = preg_replace(
-                    '~' . $content_to_show_or_hide . '~',
-                    $replacement,
-                    $this->_data['template']
-                );
-            }
-        }
-        // return $template
-        return $this->_data['template'];
-    }
-
-
-    /**
-     * This returns the regex pattern to use for conditional shortcodes parsing.
-     *
-     * Note: regex comes in part from the WP `get_shortcode_regex` expression in \wp-includes\shortcodes.php
-     *
-     * @param string $shortcode
-     * @return string
-     * @since 4.9.32
-     */
-    private function _get_conditional_block_regex(string $shortcode): string
-    {
-        // get just the shortcode tag for the match
-        preg_match('@\[([^<>&/\[\]\x00-\x20=]++)@', $shortcode, $shortcode_tag_matches);
-        if (empty($shortcode_tag_matches[1])) {
-            return $this->_data['template'];
-        }
-
-        $shortcode_tag = $shortcode_tag_matches[1];
-        // get attributes_part_of_tag
-        $attributes_part = preg_quote(str_replace([$shortcode_tag, '[', ']'], '', $shortcode));
-        // escape
-        $shortcode_tag = preg_quote($shortcode_tag);
-
-        return
-            '\['                                  // Opening Bracket
-            . "($shortcode_tag)$attributes_part"    // 1: Shortcode Name
-            . '(?![\w-])'                           // Not followed by word character or hyphen
-            . '('                                   // 2: Unroll the loop: Inside the opening shortcode tag
-            . '[^\]\/]*'                          // Not a closing bracket or forward slash
-            . '(?:'
-            . '\/(?!\])'                      // A forward slash not followed by a closing bracket
-            . '[^\]\/]*'                      // Not a closing bracket or forward slash.
-            . ')*?'
-            . ')'
-            . '(?:'
-            . '(\/)'                              // 3. Self closing tag ...
-            . '\]'                                // ... and closing bracket
-            . '|'
-            . '\]'                                // Closing bracket
-            . '(?:'
-            . '('                             // 4: Unroll the loop: Optionally, anything between the opening and closing brackets
-            . '[^\[]*+'                   // Not an opening bracket
-            . '(?:'
-            . '\[(?!\/\1\])'          // An opening bracket not followed by the closing shortcode tag.
-            . '[^\[]*+'               // Not an opening bracket
-            . ')*+'
-            . ')'
-            . '\[\/\1\]'                      // Closing shortcode tag
-            . ')?'
-            . ')';
-    }
-
-
-    /**
-     * This sets the properties related to the messages system
-     *
-     * @return void
-     * @since 4.5.0
-     */
-    protected function _set_messages_properties()
-    {
-        // should be in _extra_data
-        if (isset($this->_extra_data['messenger'])) {
-            $this->_messenger    = $this->_extra_data['messenger'];
-            $this->_message_type = $this->_extra_data['message_type'];
-            $this->_context      = $this->_extra_data['message'] instanceof EE_Message
-                ? $this->_extra_data['message']->context()
-                : '';
-            $this->_GRP_ID       = $this->_extra_data['message'] instanceof EE_Message
-                ? $this->_extra_data['message']->GRP_ID()
-                : 0;
-            $this->_message      = $this->_extra_data['message'] instanceof EE_Message
-                ? $this->_extra_data['message']
-                : null;
-        }
-    }
-
-
-    /**
-     * This returns whatever the set message type object is that was set on this shortcode parser.
-     *
-     * @return EE_message_type|null
-     * @since 4.5.0
-     */
-    public function get_set_message_type(): ?EE_message_type
-    {
-        return $this->_message_type;
-    }
-
-
-    /**
-     * This returns whatever the set messenger object is that was set on this shortcode parser
-     *
-     * @return EE_messenger
-     * @since 4.5.0
-     */
-    public function get_set_messenger(): EE_messenger
-    {
-        return $this->_messenger;
-    }
-
-
-    /**
-     * This returns whatever the set context string is on this shortcode parser.
-     *
-     * @return string
-     * @since 4.5.0
-     */
-    public function get_set_context(): string
-    {
-        return $this->_context;
-    }
-
-
-    /**
-     * This returns whatever the set EE_Message object is on this shortcode.
-     *
-     * @return EE_Message|null
-     * @since 4.9.0
-     */
-    public function get_set_message(): ?EE_Message
-    {
-        return $this->_message;
-    }
+	/**
+	 * matches a full shortcode including shortcodes with attributes or dynamic shortcodes
+	 * examples:
+	 *  [RECIPIENT_LNAME]
+	 *  [RECEIPT_URL download=true]
+	 *  [PAYMENT_LINK_IF_NEEDED_* custom_text='pay me now man!']
+	 */
+	public const REGEX_SHORTCODE_FULL = '/(\[.+?])/';
+
+	/**
+	 * matches the opening [ plus the shortcode name, but nothing else
+	 * examples:
+	 *  [RECIPIENT_LNAME] matches as [RECIPIENT_LNAME
+	 *  [RECEIPT_URL download=true] matches as [RECEIPT_URL
+	 *  [PAYMENT_LINK_IF_NEEDED_* custom_text='pay me now man!'] matches as [PAYMENT_LINK_IF_NEEDED_*
+	 */
+	public const REGEX_SHORTCODE_NAME_ONLY = '/\[[A-Z_*]+/';
+
+	/**
+	 * matches the opening [ plus the dynamic shortcode name including _*, but nothing else
+	 * examples:
+	 *  [RECIPIENT_LNAME] does not match
+	 *  [RECEIPT_URL download=true] does not match
+	 *  [PAYMENT_LINK_IF_NEEDED_* custom_text='pay me now man!'] matches as [PAYMENT_LINK_IF_NEEDED_*
+	 */
+	public const REGEX_SHORTCODE_DYNAMIC = '/(\[[A-Z_]+_\*)/';
+
+
+
+	/**
+	 * holds label for library
+	 * This is used for referencing the library label
+	 *
+	 * @var string
+	 */
+	public string $label;
+
+
+	public string $name;
+
+
+	/**
+	 * This property is used for referencing a short description of the library
+	 *
+	 * @var string
+	 */
+	public string $description;
+
+
+	/**
+	 * This will hold an array of shortcodes with the key as the shortcode ([shortcode]) and the value as a
+	 * label/description for the shortcode.
+	 *
+	 * @var array
+	 */
+	protected array $_shortcodes = [];
+
+
+	/**
+	 * This will hold the incoming data item sent to the parser method
+	 *
+	 * @var array|object
+	 */
+	protected $_data;
+
+
+	/**
+	 * some shortcodes may require extra data to parse.  This property is provided for that.
+	 *
+	 * @var array|EE_Messages_Addressee
+	 */
+	protected $_extra_data;
+
+
+	/**
+	 * EE_messenger used to generate the template being parsed.
+	 *
+	 * @since 4.5.0
+	 * @var EE_messenger
+	 */
+	protected EE_messenger $_messenger;
+
+
+	/**
+	 * message type used to generate the template being parsed.
+	 *
+	 * @since 4.5.0
+	 * @var EE_message_type|null
+	 */
+	protected ?EE_message_type $_message_type = null;
+
+
+	/**
+	 * context used for the template being parsed
+	 *
+	 * @since 4.5.0
+	 * @var string
+	 */
+	protected string $_context;
+
+
+	/**
+	 * Specific Message Template Group ID
+	 *
+	 * @since 4.5.0
+	 * @var int
+	 */
+	protected int $_GRP_ID;
+
+
+	/**
+	 * @since 4.9.0
+	 * @type EE_Message|null
+	 */
+	protected ?EE_Message $_message = null;
+
+
+	/**
+	 * This will hold an instance of the EEH_Parse_Shortcodes helper that will be used when handling list type
+	 * shortcodes
+	 *
+	 * @var EEH_Parse_Shortcodes
+	 */
+	protected EEH_Parse_Shortcodes $_shortcode_helper;
+
+
+	public function __construct()
+	{
+		$this->_set_defaults();
+		$this->_set_shortcode_helper();
+		$this->_init_props();
+	}
+
+
+	/**
+	 * This sets the defaults for the properties.  Child classes will override these properties in their _init_props
+	 * method
+	 */
+	private function _set_defaults()
+	{
+		$this->name        = $this->description = '';
+		$this->_shortcodes = [];
+	}
+
+
+	/**
+	 * loads an instance of the EE_Shortcode_Parser helper when requested
+	 */
+	protected function _set_shortcode_helper()
+	{
+		// get shortcode_replace instance - set when _get_messages is called in child...
+		$this->_shortcode_helper = new EEH_Parse_Shortcodes();
+	}
+
+
+	public function get_shortcode_helper(): EEH_Parse_Shortcodes
+	{
+		return $this->_shortcode_helper;
+	}
+
+
+	/**
+	 * This is the public method for kicking of the parser included with each child.  It can be overridden by child
+	 * classes if necessary (see EE_Questions_Answers for example)
+	 *
+	 * @param string       $shortcode  incoming shortcode to be parsed
+	 * @param object|array $data       incoming data to be used for parsing
+	 * @param object|array $extra_data extra incoming data (usually EE_Messages_Addressee)
+	 * @return string            parsed shortcode.
+	 */
+	public function parser(string $shortcode, $data, $extra_data = []): string
+	{
+		// filter setup shortcodes
+		$this->_shortcodes = $this->get_shortcodes();
+
+		// we need to set up any dynamic shortcodes so that they work with the array_key_exists
+		preg_match_all(EE_Shortcodes::REGEX_SHORTCODE_NAME_ONLY, $shortcode, $matches);
+		$shortcode_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+
+		// first we want to make sure this is a valid shortcode
+		if (! array_key_exists($shortcode_to_verify, $this->_shortcodes)) {
+			// get out, this parser doesn't handle the incoming shortcode.
+			return '';
+		}
+		$this->_data       = $data;
+		$this->_extra_data = $extra_data;
+		$this->_set_messages_properties();
+		$parsed = (string) apply_filters(
+			'FHEE__' . get_class($this) . '__parser_after',
+			$this->_parser($shortcode),
+			$shortcode,
+			$data,
+			$extra_data,
+			$this
+		);
+
+		// note the below filter applies to ALL shortcode parsers... be careful!
+		return (string) apply_filters(
+			'FHEE__EE_Shortcodes__parser_after',
+			$parsed,
+			$shortcode,
+			$data,
+			$extra_data,
+			$this
+		);
+	}
+
+
+	/**
+	 * This method just returns the shortcodes in the $_shortcodes array property.
+	 *
+	 * @return array array of shortcodes => description pairs
+	 */
+	public function get_shortcodes(): array
+	{
+		$this->_shortcodes = (array) apply_filters(
+			'FHEE__' . get_class($this) . '__shortcodes',
+			$this->_shortcodes,
+			$this
+		);
+
+		// note the below filter applies to ALL shortcode parsers... be careful!
+		return (array) apply_filters('FHEE__EE_Shortcodes__shortcodes', $this->_shortcodes, $this);
+	}
+
+
+	/**
+	 * Child classes use this method to set the $name, $description, and $_shortcodes properties.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _init_props();
+
+
+	/**
+	 * This method will give parsing instructions for each shortcode defined in the _shortcodes array.  Child methods
+	 * will have to take care of handling.
+	 *
+	 * @abstract
+	 * @param string $shortcode    the shortcode to be parsed.
+	 * @return string parsed shortcode
+	 */
+	abstract protected function _parser($shortcode);
+
+
+	/**
+	 * This just validates incoming data for list type shortcode parsers (and they call this method) to make sure it
+	 * meets their requirements
+	 *
+	 * @return void If validation fails we'll throw an exception.
+	 * @throws EE_Error
+	 */
+	protected function _validate_list_requirements()
+	{
+		// first test to make sure we've got an array!
+		if (! is_array($this->_data)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Expecting an array for the data sent to %s. Instead it was %s',
+						'event_espresso'
+					),
+					get_class($this),
+					gettype($this->_data)
+				)
+			);
+		}
+
+		// next test to make sure we've got the required template in the index!
+		if (! isset($this->_data['template'])) {
+			throw new EE_Error(
+				esc_html__(
+					'The incoming data does not have the required template index in its array',
+					'event_espresso'
+				)
+			);
+		}
+
+		// next test to make sure we've got a data index in the incoming data array
+		if (! isset($this->_data['data'])) {
+			throw new EE_Error(
+				esc_html__(
+					'The incoming data does not have the required data index in its array',
+					'event_espresso'
+				)
+			);
+		}
+
+		// all is well let's make sure _extra_data always has the values needed.
+		// let's make sure that extra_data includes all templates (for later parsing if necessary)
+		if (empty($this->_extra_data) || (empty($this->_extra_data['data']) && empty($this->_extra_data['template']))) {
+			$this->_extra_data['data']     = $this->_data['data'];
+			$this->_extra_data['template'] = $this->_data['template'];
+		}
+	}
+
+
+	/**
+	 * This returns any attributes that may be existing on an EE_Shortcode
+	 *
+	 * @param string $shortcode incoming shortcode
+	 * @return array An array with the attributes
+	 * @since 4.5.0
+	 */
+	protected function _get_shortcode_attrs(string $shortcode): array
+	{
+		// make sure the required wp helper function is present
+		// require the shortcode file if necessary
+		if (! function_exists('shortcode_parse_atts')) {
+			require_once(ABSPATH . WPINC . '/shortcodes.php');
+		}
+
+		// let's get any attributes that may be present and set the defaults.
+		$shortcode_to_parse = str_replace(['[', ']'], '', $shortcode);
+		return shortcode_parse_atts($shortcode_to_parse);
+	}
+
+
+	/**
+	 * Conditional blocks are shortcode patterns with an opening conditional tag `[IF_*]` and a corresponding
+	 * closing tag (eg `[/IF_*]`).  The content within the tags will be displayed/hidden depending on whatever
+	 * conditions existed in the opening tag.  This method handles parsing the actual template to show/hide this
+	 * conditional content.
+	 *
+	 * @param string $shortcode This should be the original shortcode as used in the template and passed to the parser.
+	 * @param bool   $show      true means the opening and closing tags are removed and the content is left showing,
+	 *                          false means the opening and closing tags and the contained content are removed.
+	 * @return string     The template for the shortcode is returned.
+	 * @since 4.9.32
+	 *
+	 */
+	protected function _mutate_conditional_block_in_template(string $shortcode, bool $show = true): string
+	{
+		// first let's get all the matches in the template for this particular shortcode.
+		preg_match_all('~' . $this->_get_conditional_block_regex($shortcode) . '~', $this->_data['template'], $matches);
+
+		if ($matches && is_array($matches[0]) && ! empty($matches[0])) {
+			// we need to hide all instances of the matches
+			foreach ($matches[0] as $index => $content_to_show_or_hide) {
+				$content_to_show_or_hide = preg_quote($content_to_show_or_hide);
+				$replacement             = $show ? $matches[4][ $index ] : '';
+				$this->_data['template'] = preg_replace(
+					'~' . $content_to_show_or_hide . '~',
+					$replacement,
+					$this->_data['template']
+				);
+			}
+		}
+		// return $template
+		return $this->_data['template'];
+	}
+
+
+	/**
+	 * This returns the regex pattern to use for conditional shortcodes parsing.
+	 *
+	 * Note: regex comes in part from the WP `get_shortcode_regex` expression in \wp-includes\shortcodes.php
+	 *
+	 * @param string $shortcode
+	 * @return string
+	 * @since 4.9.32
+	 */
+	private function _get_conditional_block_regex(string $shortcode): string
+	{
+		// get just the shortcode tag for the match
+		preg_match('@\[([^<>&/\[\]\x00-\x20=]++)@', $shortcode, $shortcode_tag_matches);
+		if (empty($shortcode_tag_matches[1])) {
+			return $this->_data['template'];
+		}
+
+		$shortcode_tag = $shortcode_tag_matches[1];
+		// get attributes_part_of_tag
+		$attributes_part = preg_quote(str_replace([$shortcode_tag, '[', ']'], '', $shortcode));
+		// escape
+		$shortcode_tag = preg_quote($shortcode_tag);
+
+		return
+			'\['                                  // Opening Bracket
+			. "($shortcode_tag)$attributes_part"    // 1: Shortcode Name
+			. '(?![\w-])'                           // Not followed by word character or hyphen
+			. '('                                   // 2: Unroll the loop: Inside the opening shortcode tag
+			. '[^\]\/]*'                          // Not a closing bracket or forward slash
+			. '(?:'
+			. '\/(?!\])'                      // A forward slash not followed by a closing bracket
+			. '[^\]\/]*'                      // Not a closing bracket or forward slash.
+			. ')*?'
+			. ')'
+			. '(?:'
+			. '(\/)'                              // 3. Self closing tag ...
+			. '\]'                                // ... and closing bracket
+			. '|'
+			. '\]'                                // Closing bracket
+			. '(?:'
+			. '('                             // 4: Unroll the loop: Optionally, anything between the opening and closing brackets
+			. '[^\[]*+'                   // Not an opening bracket
+			. '(?:'
+			. '\[(?!\/\1\])'          // An opening bracket not followed by the closing shortcode tag.
+			. '[^\[]*+'               // Not an opening bracket
+			. ')*+'
+			. ')'
+			. '\[\/\1\]'                      // Closing shortcode tag
+			. ')?'
+			. ')';
+	}
+
+
+	/**
+	 * This sets the properties related to the messages system
+	 *
+	 * @return void
+	 * @since 4.5.0
+	 */
+	protected function _set_messages_properties()
+	{
+		// should be in _extra_data
+		if (isset($this->_extra_data['messenger'])) {
+			$this->_messenger    = $this->_extra_data['messenger'];
+			$this->_message_type = $this->_extra_data['message_type'];
+			$this->_context      = $this->_extra_data['message'] instanceof EE_Message
+				? $this->_extra_data['message']->context()
+				: '';
+			$this->_GRP_ID       = $this->_extra_data['message'] instanceof EE_Message
+				? $this->_extra_data['message']->GRP_ID()
+				: 0;
+			$this->_message      = $this->_extra_data['message'] instanceof EE_Message
+				? $this->_extra_data['message']
+				: null;
+		}
+	}
+
+
+	/**
+	 * This returns whatever the set message type object is that was set on this shortcode parser.
+	 *
+	 * @return EE_message_type|null
+	 * @since 4.5.0
+	 */
+	public function get_set_message_type(): ?EE_message_type
+	{
+		return $this->_message_type;
+	}
+
+
+	/**
+	 * This returns whatever the set messenger object is that was set on this shortcode parser
+	 *
+	 * @return EE_messenger
+	 * @since 4.5.0
+	 */
+	public function get_set_messenger(): EE_messenger
+	{
+		return $this->_messenger;
+	}
+
+
+	/**
+	 * This returns whatever the set context string is on this shortcode parser.
+	 *
+	 * @return string
+	 * @since 4.5.0
+	 */
+	public function get_set_context(): string
+	{
+		return $this->_context;
+	}
+
+
+	/**
+	 * This returns whatever the set EE_Message object is on this shortcode.
+	 *
+	 * @return EE_Message|null
+	 * @since 4.9.0
+	 */
+	public function get_set_message(): ?EE_Message
+	{
+		return $this->_message;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -192,10 +192,10 @@ 
 
         // we need to set up any dynamic shortcodes so that they work with the array_key_exists
         preg_match_all(EE_Shortcodes::REGEX_SHORTCODE_NAME_ONLY, $shortcode, $matches);
-        $shortcode_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+        $shortcode_to_verify = ! empty($matches[0]) ? $matches[0][0].']' : $shortcode;
 
         // first we want to make sure this is a valid shortcode
-        if (! array_key_exists($shortcode_to_verify, $this->_shortcodes)) {
+        if ( ! array_key_exists($shortcode_to_verify, $this->_shortcodes)) {
             // get out, this parser doesn't handle the incoming shortcode.
             return '';
         }
@@ -203,7 +203,7 @@ 
         $this->_extra_data = $extra_data;
         $this->_set_messages_properties();
         $parsed = (string) apply_filters(
-            'FHEE__' . get_class($this) . '__parser_after',
+            'FHEE__'.get_class($this).'__parser_after',
             $this->_parser($shortcode),
             $shortcode,
             $data,
@@ -231,7 +231,7 @@ 
     public function get_shortcodes(): array
     {
         $this->_shortcodes = (array) apply_filters(
-            'FHEE__' . get_class($this) . '__shortcodes',
+            'FHEE__'.get_class($this).'__shortcodes',
             $this->_shortcodes,
             $this
         );
@@ -271,7 +271,7 @@ 
     protected function _validate_list_requirements()
     {
         // first test to make sure we've got an array!
-        if (! is_array($this->_data)) {
+        if ( ! is_array($this->_data)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -285,7 +285,7 @@ 
         }
 
         // next test to make sure we've got the required template in the index!
-        if (! isset($this->_data['template'])) {
+        if ( ! isset($this->_data['template'])) {
             throw new EE_Error(
                 esc_html__(
                     'The incoming data does not have the required template index in its array',
@@ -295,7 +295,7 @@ 
         }
 
         // next test to make sure we've got a data index in the incoming data array
-        if (! isset($this->_data['data'])) {
+        if ( ! isset($this->_data['data'])) {
             throw new EE_Error(
                 esc_html__(
                     'The incoming data does not have the required data index in its array',
@@ -324,8 +324,8 @@ 
     {
         // make sure the required wp helper function is present
         // require the shortcode file if necessary
-        if (! function_exists('shortcode_parse_atts')) {
-            require_once(ABSPATH . WPINC . '/shortcodes.php');
+        if ( ! function_exists('shortcode_parse_atts')) {
+            require_once(ABSPATH.WPINC.'/shortcodes.php');
         }
 
         // let's get any attributes that may be present and set the defaults.
@@ -350,15 +350,15 @@ 
     protected function _mutate_conditional_block_in_template(string $shortcode, bool $show = true): string
     {
         // first let's get all the matches in the template for this particular shortcode.
-        preg_match_all('~' . $this->_get_conditional_block_regex($shortcode) . '~', $this->_data['template'], $matches);
+        preg_match_all('~'.$this->_get_conditional_block_regex($shortcode).'~', $this->_data['template'], $matches);
 
         if ($matches && is_array($matches[0]) && ! empty($matches[0])) {
             // we need to hide all instances of the matches
             foreach ($matches[0] as $index => $content_to_show_or_hide) {
                 $content_to_show_or_hide = preg_quote($content_to_show_or_hide);
-                $replacement             = $show ? $matches[4][ $index ] : '';
+                $replacement             = $show ? $matches[4][$index] : '';
                 $this->_data['template'] = preg_replace(
-                    '~' . $content_to_show_or_hide . '~',
+                    '~'.$content_to_show_or_hide.'~',
                     $replacement,
                     $this->_data['template']
                 );

core/libraries/messages/validators/EE_Messages_Validator.core.php

Indentation +598 added lines, -598 removed lines

@@ -15,602 +15,602 @@
  */
 abstract class EE_Messages_Validator extends EE_Base
 {
-    /**
-     * These properties just hold the name for the Messenger and Message Type (defined by child classes).
-     * These are used for retrieving objects etc.
-     *
-     * @var string
-     */
-    protected string $_m_name = '';
-
-    protected string $_mt_name = '';
-
-
-    /**
-     * This will hold any error messages from the validation process.
-     * The _errors property holds an associative array of error messages
-     * listing the field as the key and the message as the value.
-     *
-     * @var array
-     */
-    private array $_errors = [];
-
-
-    /**
-     * holds an array of fields being validated
-     *
-     * @var array
-     */
-    protected array $_fields = [];
-
-
-    /**
-     * this will hold the incoming context
-     *
-     * @var string
-     */
-    protected string $_context = '';
-
-
-    /**
-     * this holds an array of fields and the relevant validation information
-     * that the incoming fields data get validated against.
-     * This gets setup in the _set_props() method.
-     *
-     * @var array
-     */
-    protected array $_validators = [];
-
-    protected EE_messenger $_messenger;
-
-
-    protected EE_message_type $_message_type;
-
-
-    /**
-     * will hold any valid_shortcode modifications made by the _modify_validator() method.
-     *
-     * @var array
-     */
-    protected array $_valid_shortcodes_modifier = [];
-
-
-    /**
-     * There may be times when a message type wants to include a shortcode group but exclude specific
-     * shortcodes.  If that's the case then it can set this property as an array of shortcodes to exclude and
-     * they will not be allowed.
-     * Array should be indexed by field and values are an array of specific shortcodes to exclude.
-     *
-     * @var array
-     */
-    protected array $_specific_shortcode_excludes = [];
-
-
-    /**
-     * Runs the validator using the incoming fields array as the fields/values to check.
-     *
-     * @param array  $fields The fields sent by the EEM object.
-     * @param string $context
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($fields, $context)
-    {
-        // checks that child class has set _m_name and _mt_name, otherwise we get out.
-        if (empty($this->_m_name) || empty($this->_mt_name)) {
-            throw new EE_Error(
-                esc_html__(
-                    'EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->_fields  = (array) $fields;
-        $this->_context = (string) $context;
-
-        $this->loadMessengerAndMessageType();
-        // modify any messenger/message_type specific validation instructions.  This is what child classes define.
-        $this->_modify_validator();
-        // let's set validators property
-        $this->setValidators();
-    }
-
-
-    /**
-     * Child classes instantiate this and use it to modify the _validator_config array property
-     * for the messenger using messengers set_validate_config() method.
-     * This is so we can specify specific validation instructions for a messenger/message_type combo
-     * that aren't handled by the defaults setup in the messenger.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _modify_validator();
-
-
-    /**
-     * loads all objects used by validator
-     *
-     * @throws EE_Error
-     */
-    private function loadMessengerAndMessageType()
-    {
-        // load messenger
-        $messenger = ucwords(str_replace('_', ' ', $this->_m_name));
-        $messenger = str_replace(' ', '_', $messenger);
-        $messenger = 'EE_' . $messenger . '_messenger';
-
-        if (! class_exists($messenger)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
-                    $this->_m_name
-                )
-            );
-        }
-
-        $this->_messenger = new $messenger();
-
-        // load message type
-        $message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
-        $message_type = str_replace(' ', '_', $message_type);
-        $message_type = 'EE_' . $message_type . '_message_type';
-
-        if (! class_exists($message_type)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
-                    $this->_mt_name
-                )
-            );
-        }
-
-        $this->_message_type = new $message_type();
-    }
-
-
-    /**
-     * used to set the $_validators property
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function setValidators()
-    {
-        // let's get all valid shortcodes from mt and message type
-        // (messenger will have its set in the _validator_config property for the messenger)
-        $mt_codes = $this->_message_type->get_valid_shortcodes();
-        // get messenger validator_config
-        $msgr_validator = $this->_messenger->get_validator_config();
-        // we only want the valid shortcodes for the given context!
-        $context  = $this->_context;
-        $mt_codes = $mt_codes[ $context ];
-        // in this first loop we're just getting all shortcode group indexes from the msgr_validator
-        // into a single array (so we can get the appropriate shortcode objects for the groups)
-        $shortcode_groups = $mt_codes;
-        $groups_per_field = [];
-
-        foreach ($msgr_validator as $field => $config) {
-            if (! isset($config['shortcodes'])) {
-                continue;
-            }  //Nothing to see here.
-            $groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
-            $shortcode_groups           = array_merge($config['shortcodes'], $shortcode_groups);
-        }
-        $shortcode_groups = array_unique($shortcode_groups);
-
-        // okay now we've got our groups.
-        // Let's get the codes from the objects into an array indexed by group for easy retrieval later.
-        $codes_from_objs = [];
-
-        foreach ($shortcode_groups as $group) {
-            $ref       = ucwords(str_replace('_', ' ', $group));
-            $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
-            if (class_exists($classname)) {
-                $a                         = new ReflectionClass($classname);
-                $obj                       = $a->newInstance();
-                $codes_from_objs[ $group ] = $obj->get_shortcodes();
-            }
-        }
-
-        // let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
-        $final_mt_codes = [];
-        foreach ($mt_codes as $group) {
-            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
-        }
-        $mt_codes = $final_mt_codes;
-
-        // k now in this next loop we're going to loop through $msgr_validator again
-        // and set up the _validators property from the data we've setup so far.
-        foreach ($msgr_validator as $field => $config) {
-            // if required shortcode is not in our list of codes for the given field, then we skip this field.
-            $required = isset($config['required'])
-                ? array_intersect($config['required'], array_keys($mt_codes))
-                : true;
-            if (empty($required)) {
-                continue;
-            }
-
-            if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
-                // If we have an override then we use it to indicate the codes we want.
-                $this->_validators[ $field ]['shortcodes'] = $this->reassembleValidShortcodesFromGroup(
-                    $this->_valid_shortcodes_modifier[ $context ][ $field ],
-                    $codes_from_objs
-                );
-            } elseif (isset($groups_per_field[ $field ])) {
-                // we have specific shortcodes for a field so we need to use them
-                $this->_validators[ $field ]['shortcodes'] = $this->reassembleValidShortcodesFromGroup(
-                    $groups_per_field[ $field ],
-                    $codes_from_objs
-                );
-            } elseif (empty($config)) {
-                // no config so we're assuming we're just going to use the shortcodes from the message type context
-                $this->_validators[ $field ]['shortcodes'] = $mt_codes;
-            } elseif (isset($config['specific_shortcodes'])) {
-                // we have specific shortcodes so we need to use them
-                $this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
-            } else {
-                // otherwise the shortcodes are what is set by the messenger for that field
-                foreach ($config['shortcodes'] as $group) {
-                    $this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
-                        ? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
-                        : $codes_from_objs[ $group ];
-                }
-            }
-
-            // now let's just make sure that any excluded specific shortcodes are removed.
-            $specific_excludes = $this->get_specific_shortcode_excludes();
-            if (isset($specific_excludes[ $field ])) {
-                foreach ($specific_excludes[ $field ] as $sex) {
-                    if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
-                        unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
-                    }
-                }
-            }
-
-            // hey! don't forget to include the type if present!
-            $this->_validators[ $field ]['type'] = $config['type'] ?? null;
-        }
-    }
-
-
-    /**
-     * This just returns the validators property that contains information
-     * about the various shortcodes and their availability with each field
-     *
-     * @return array
-     */
-    public function get_validators(): array
-    {
-        return $this->_validators;
-    }
-
-
-    /**
-     * This simply returns the specific shortcode_excludes property that is set.
-     *
-     * @return array
-     * @since 4.5.0
-     */
-    public function get_specific_shortcode_excludes(): array
-    {
-        // specific validator filter
-        $shortcode_excludes = (array) apply_filters(
-            'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
-            $this->_specific_shortcode_excludes,
-            $this->_context
-        );
-        // global filter
-        return (array) apply_filters(
-            'FHEE__EE_Messages_Validator__get_specific_shortcode_excludes',
-            $shortcode_excludes,
-            $this->_context,
-            $this
-        );
-    }
-
-
-    /**
-     * This is the main method that handles validation
-     * What it does is loop through the _fields (the ones that get validated)
-     * and checks them against the shortcodes array for the field and the 'type' indicated by the
-     *
-     * @return array|bool if errors present we return the array otherwise true
-     */
-    public function validate()
-    {
-        // some defaults
-        $template_fields = $this->_messenger->get_template_fields();
-        // loop through the fields and check!
-        foreach ($this->_fields as $field => $value) {
-            $this->_errors[ $field ] = [];
-            $err_msg                 = '';
-            $field_label             = '';
-            // if field is not present in the _validators array then we continue
-            if (! isset($this->_validators[ $field ])) {
-                unset($this->_errors[ $field ]);
-                continue;
-            }
-
-            // get the translated field label!
-            // first check if it's in the main fields list
-            if (isset($template_fields[ $field ])) {
-                // most likely the field is found in the 'extra' array.
-                $field_label = ! empty($template_fields[ $field ])
-                    ? $template_fields[ $field ]['label']
-                    : $field;
-            }
-
-            // if field label is empty OR is equal to the current field
-            // then we need to loop through the 'extra' fields in the template_fields config (if present)
-            if (isset($template_fields['extra']) && (empty($field_label) || $field_label === $field)) {
-                foreach ($template_fields['extra'] as $main_field => $secondary_field) {
-                    foreach ($secondary_field as $name => $values) {
-                        if ($name === $field) {
-                            $field_label = $values['label'];
-                        }
-
-                        // if we've got a 'main' secondary field, let's see if that matches what field we're on
-                        // which means it contains the label for this field.
-                        if ($name === 'main' && $main_field === $field_label) {
-                            $field_label = $values['label'];
-                        }
-                    }
-                }
-            }
-
-            // field is present. Let's validate shortcodes first (but only if shortcodes present).
-            if (
-                isset($this->_validators[ $field ]['shortcodes'])
-                && ! empty($this->_validators[ $field ]['shortcodes'])
-            ) {
-                $valid_shortcodes   = array_keys((array) $this->_validators[ $field ]['shortcodes']);
-                $invalid_shortcodes = $this->findInvalidShortcodes((string) $value, $valid_shortcodes);
-                // if true then that means there is a returned error message
-                // that we'll need to add to the _errors array for this field.
-                if ($invalid_shortcodes) {
-                    $v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
-                    $err_msg = sprintf(
-                        esc_html__(
-                            '%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
-                            'event_espresso'
-                        ),
-                        '<strong>' . $field_label . '</strong>',
-                        $invalid_shortcodes,
-                        '<p>',
-                        '</p >'
-                    );
-                    $err_msg .= sprintf(
-                        esc_html__('%2$sValid shortcodes for this field are: %1$s%3$s', 'event_espresso'),
-                        implode(', ', $v_s),
-                        '<strong>',
-                        '</strong>'
-                    );
-                }
-            }
-
-            // if there's a "type" to be validated then let's do that too.
-            if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
-                switch ($this->_validators[ $field ]['type']) {
-                    case 'number':
-                        if (! is_numeric($value)) {
-                            $err_msg .= sprintf(
-                                esc_html__(
-                                    '%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
-                                    'event_espresso'
-                                ),
-                                $field_label,
-                                $value,
-                                '<p>',
-                                '</p >'
-                            );
-                        }
-                        break;
-                    case 'email':
-                        $valid_email = $this->_validate_email((string) $value);
-                        if (! $valid_email) {
-                            $err_msg .= htmlentities(
-                                sprintf(
-                                    esc_html__(
-                                        'The %1$s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.',
-                                        'event_espresso'
-                                    ),
-                                    $field_label
-                                )
-                            );
-                        }
-                        break;
-                    default:
-                        break;
-                }
-            }
-
-            // if $err_msg isn't empty, let's set up the _errors array for this field.
-            if (! empty($err_msg)) {
-                $this->_errors[ $field ]['msg'] = $err_msg;
-            } else {
-                unset($this->_errors[ $field ]);
-            }
-        }
-
-        // if we have ANY errors, then we want to make sure we return the values
-        // for ALL the fields so the user doesn't have to retype them all.
-        if (! empty($this->_errors)) {
-            foreach ($this->_fields as $field => $value) {
-                $this->_errors[ $field ]['value'] = stripslashes($value);
-            }
-        }
-
-        // return any errors or just TRUE if everything validates
-        return empty($this->_errors)
-            ? true
-            : $this->_errors;
-    }
-
-
-    /**
-     * Reassembles and returns an array of valid shortcodes
-     * given the array of groups and array of shortcodes indexed by group.
-     *
-     * @param array $groups          array of shortcode groups that we want shortcodes for
-     * @param array $codes_from_objs All the codes available.
-     * @return array                   an array of actual shortcodes (that will be used for validation).
-     */
-    private function reassembleValidShortcodesFromGroup(array $groups, array $codes_from_objs): array
-    {
-        $shortcodes = [];
-        foreach ($groups as $group) {
-            $shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
-        }
-        return $shortcodes;
-    }
-
-
-    /**
-     * Validates a string against a list of accepted shortcodes
-     * This function takes in an array of shortcodes
-     * and makes sure that the given string ONLY contains shortcodes in that array.
-     *
-     * @param string $value            string to evaluate
-     * @param array  $valid_shortcodes array of shortcodes that are acceptable.
-     * @return bool|string  return either a list of invalid shortcodes OR false if the shortcodes validate.
-     * @deprecated 5.0.48
-     */
-    protected function _invalid_shortcodes(string $value, array $valid_shortcodes)
-    {
-        return $this->findInvalidShortcodes($value, $valid_shortcodes) ?: false;
-    }
-
-
-    /**
-     * Validates a string against a list of accepted shortcodes
-     * This function takes in an array of shortcodes
-     * and makes sure that the given string ONLY contains shortcodes in that array.
-     *
-     * @param string $incoming_text    string to evaluate
-     * @param array  $valid_shortcodes array of shortcodes that are acceptable.
-     * @return string  return either a list of invalid shortcodes OR false if the shortcodes validate.
-     */
-    protected function findInvalidShortcodes(string $incoming_text, array $valid_shortcodes): string
-    {
-        // first we need to go through the string and get ALL the shortcodes in the string
-        // matches the opening [ plus the shortcode name, but nothing else
-        // examples:
-        //  [RECIPIENT_LNAME] matches as [RECIPIENT_LNAME
-        //  [RECEIPT_URL download=true] matches as [RECEIPT_URL
-        //  [PAYMENT_LINK_IF_NEEDED_* custom_text='pay me now man!'] matches as [PAYMENT_LINK_IF_NEEDED_*
-        preg_match_all(EE_Shortcodes::REGEX_SHORTCODE_NAME_ONLY, $incoming_text, $matches);
-        $shortcodes_in_text = $matches[0];
-        // now all we need to do is add the closing ] to each shortcode to make them "valid"
-        $shortcodes_in_text = array_map(fn($shortcode) => rtrim($shortcode) . ']', $shortcodes_in_text);
-        // get a diff of the shortcodes in the string vs the valid shortcodes
-        $invalid_shortcodes = array_diff($shortcodes_in_text, $valid_shortcodes);
-        if (empty($invalid_shortcodes)) {
-            return '';
-        }
-        // made it here? then let's assemble the error message
-        return '<strong>' . implode('</strong>,<strong>', $invalid_shortcodes) . '</strong>';
-    }
-
-
-    /**
-     * Validates an incoming string and makes sure we have valid emails in the string.
-     *
-     * @param string $value incoming value to validate
-     * @return bool        true if the string validates, false if it doesn't
-     */
-    protected function _validate_email(string $value): bool
-    {
-        $or_val = $value;
-
-        // empty strings will validate because this is how a message template
-        // for a particular context can be "turned off" (if there is no email then no message)
-        if (empty($value)) {
-            return true;
-        }
-
-        // first determine if there ARE any shortcodes.
-        // If there are shortcodes and then later we find that there were no other valid emails
-        // but the field isn't empty...
-        // that means we've got extra commas that were left after stripping out shortcodes so probably still valid.
-        $has_shortcodes = preg_match(EE_Shortcodes::REGEX_SHORTCODE_FULL, $value);
-
-        // first we need to strip out all the shortcodes!
-        $value = preg_replace(EE_Shortcodes::REGEX_SHORTCODE_FULL, '', $value);
-
-        // if original value is not empty and new value is, then we've parsed out a shortcode
-        // and we now have an empty string which DOES validate.
-        // We also validate complete empty field for email because
-        // it's possible that this message is being "turned off" for a particular context
-
-
-        if (! empty($or_val) && empty($value)) {
-            return true;
-        }
-
-        // trim any commas from beginning and end of string ( after whitespace trimmed );
-        $value = trim(trim($value), ',');
-
-        // next we need to split up the string if it's comma-delimited.
-        $emails = explode(',', $value);
-        $empty  = false; // used to indicate that there is an empty comma.
-        // now let's loop through the emails and do our checks
-        foreach ($emails as $email) {
-            if (empty($email)) {
-                $empty = true;
-                continue;
-            }
-
-            // trim whitespace
-            $email = trim($email);
-            // either its of type "bob@whatever.com", or its of type "fname lname <few@few.few>"
-            if (is_email($email)) {
-                continue;
-            }
-            $matches  = [];
-            $validate = (bool) preg_match('/(.*)<(.+)>/', $email, $matches);
-            if ($validate && is_email($matches[2])) {
-                continue;
-            }
-            return false;
-        }
-
-        return ! ($empty && ! $has_shortcodes);
-    }
-
-
-    /**
-     * Magic getter
-     * Using this to provide back compat with add-ons referencing deprecated properties.
-     *
-     * @param string $property Property being requested
-     * @return mixed
-     * @throws Exception
-     */
-    public function __get($property)
-    {
-        $expected_properties_map = [
-            /**
-             * @deprecated 4.9.0
-             */
-            '_MSGR'   => '_messenger',
-            /**
-             * @deprecated 4.9.0
-             */
-            '_MSGTYP' => '_message_type',
-        ];
-
-        if (isset($expected_properties_map[ $property ])) {
-            return $this->{$expected_properties_map[ $property ]};
-        }
-
-        throw new Exception(
-            sprintf(
-                esc_html__('The property %1$s being requested on %2$s does not exist', 'event_espresso'),
-                $property,
-                get_class($this)
-            )
-        );
-    }
+	/**
+	 * These properties just hold the name for the Messenger and Message Type (defined by child classes).
+	 * These are used for retrieving objects etc.
+	 *
+	 * @var string
+	 */
+	protected string $_m_name = '';
+
+	protected string $_mt_name = '';
+
+
+	/**
+	 * This will hold any error messages from the validation process.
+	 * The _errors property holds an associative array of error messages
+	 * listing the field as the key and the message as the value.
+	 *
+	 * @var array
+	 */
+	private array $_errors = [];
+
+
+	/**
+	 * holds an array of fields being validated
+	 *
+	 * @var array
+	 */
+	protected array $_fields = [];
+
+
+	/**
+	 * this will hold the incoming context
+	 *
+	 * @var string
+	 */
+	protected string $_context = '';
+
+
+	/**
+	 * this holds an array of fields and the relevant validation information
+	 * that the incoming fields data get validated against.
+	 * This gets setup in the _set_props() method.
+	 *
+	 * @var array
+	 */
+	protected array $_validators = [];
+
+	protected EE_messenger $_messenger;
+
+
+	protected EE_message_type $_message_type;
+
+
+	/**
+	 * will hold any valid_shortcode modifications made by the _modify_validator() method.
+	 *
+	 * @var array
+	 */
+	protected array $_valid_shortcodes_modifier = [];
+
+
+	/**
+	 * There may be times when a message type wants to include a shortcode group but exclude specific
+	 * shortcodes.  If that's the case then it can set this property as an array of shortcodes to exclude and
+	 * they will not be allowed.
+	 * Array should be indexed by field and values are an array of specific shortcodes to exclude.
+	 *
+	 * @var array
+	 */
+	protected array $_specific_shortcode_excludes = [];
+
+
+	/**
+	 * Runs the validator using the incoming fields array as the fields/values to check.
+	 *
+	 * @param array  $fields The fields sent by the EEM object.
+	 * @param string $context
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($fields, $context)
+	{
+		// checks that child class has set _m_name and _mt_name, otherwise we get out.
+		if (empty($this->_m_name) || empty($this->_mt_name)) {
+			throw new EE_Error(
+				esc_html__(
+					'EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this',
+					'event_espresso'
+				)
+			);
+		}
+		$this->_fields  = (array) $fields;
+		$this->_context = (string) $context;
+
+		$this->loadMessengerAndMessageType();
+		// modify any messenger/message_type specific validation instructions.  This is what child classes define.
+		$this->_modify_validator();
+		// let's set validators property
+		$this->setValidators();
+	}
+
+
+	/**
+	 * Child classes instantiate this and use it to modify the _validator_config array property
+	 * for the messenger using messengers set_validate_config() method.
+	 * This is so we can specify specific validation instructions for a messenger/message_type combo
+	 * that aren't handled by the defaults setup in the messenger.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _modify_validator();
+
+
+	/**
+	 * loads all objects used by validator
+	 *
+	 * @throws EE_Error
+	 */
+	private function loadMessengerAndMessageType()
+	{
+		// load messenger
+		$messenger = ucwords(str_replace('_', ' ', $this->_m_name));
+		$messenger = str_replace(' ', '_', $messenger);
+		$messenger = 'EE_' . $messenger . '_messenger';
+
+		if (! class_exists($messenger)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
+					$this->_m_name
+				)
+			);
+		}
+
+		$this->_messenger = new $messenger();
+
+		// load message type
+		$message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
+		$message_type = str_replace(' ', '_', $message_type);
+		$message_type = 'EE_' . $message_type . '_message_type';
+
+		if (! class_exists($message_type)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
+					$this->_mt_name
+				)
+			);
+		}
+
+		$this->_message_type = new $message_type();
+	}
+
+
+	/**
+	 * used to set the $_validators property
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function setValidators()
+	{
+		// let's get all valid shortcodes from mt and message type
+		// (messenger will have its set in the _validator_config property for the messenger)
+		$mt_codes = $this->_message_type->get_valid_shortcodes();
+		// get messenger validator_config
+		$msgr_validator = $this->_messenger->get_validator_config();
+		// we only want the valid shortcodes for the given context!
+		$context  = $this->_context;
+		$mt_codes = $mt_codes[ $context ];
+		// in this first loop we're just getting all shortcode group indexes from the msgr_validator
+		// into a single array (so we can get the appropriate shortcode objects for the groups)
+		$shortcode_groups = $mt_codes;
+		$groups_per_field = [];
+
+		foreach ($msgr_validator as $field => $config) {
+			if (! isset($config['shortcodes'])) {
+				continue;
+			}  //Nothing to see here.
+			$groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
+			$shortcode_groups           = array_merge($config['shortcodes'], $shortcode_groups);
+		}
+		$shortcode_groups = array_unique($shortcode_groups);
+
+		// okay now we've got our groups.
+		// Let's get the codes from the objects into an array indexed by group for easy retrieval later.
+		$codes_from_objs = [];
+
+		foreach ($shortcode_groups as $group) {
+			$ref       = ucwords(str_replace('_', ' ', $group));
+			$ref       = str_replace(' ', '_', $ref);
+			$classname = 'EE_' . $ref . '_Shortcodes';
+			if (class_exists($classname)) {
+				$a                         = new ReflectionClass($classname);
+				$obj                       = $a->newInstance();
+				$codes_from_objs[ $group ] = $obj->get_shortcodes();
+			}
+		}
+
+		// let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
+		$final_mt_codes = [];
+		foreach ($mt_codes as $group) {
+			$final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
+		}
+		$mt_codes = $final_mt_codes;
+
+		// k now in this next loop we're going to loop through $msgr_validator again
+		// and set up the _validators property from the data we've setup so far.
+		foreach ($msgr_validator as $field => $config) {
+			// if required shortcode is not in our list of codes for the given field, then we skip this field.
+			$required = isset($config['required'])
+				? array_intersect($config['required'], array_keys($mt_codes))
+				: true;
+			if (empty($required)) {
+				continue;
+			}
+
+			if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
+				// If we have an override then we use it to indicate the codes we want.
+				$this->_validators[ $field ]['shortcodes'] = $this->reassembleValidShortcodesFromGroup(
+					$this->_valid_shortcodes_modifier[ $context ][ $field ],
+					$codes_from_objs
+				);
+			} elseif (isset($groups_per_field[ $field ])) {
+				// we have specific shortcodes for a field so we need to use them
+				$this->_validators[ $field ]['shortcodes'] = $this->reassembleValidShortcodesFromGroup(
+					$groups_per_field[ $field ],
+					$codes_from_objs
+				);
+			} elseif (empty($config)) {
+				// no config so we're assuming we're just going to use the shortcodes from the message type context
+				$this->_validators[ $field ]['shortcodes'] = $mt_codes;
+			} elseif (isset($config['specific_shortcodes'])) {
+				// we have specific shortcodes so we need to use them
+				$this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
+			} else {
+				// otherwise the shortcodes are what is set by the messenger for that field
+				foreach ($config['shortcodes'] as $group) {
+					$this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
+						? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
+						: $codes_from_objs[ $group ];
+				}
+			}
+
+			// now let's just make sure that any excluded specific shortcodes are removed.
+			$specific_excludes = $this->get_specific_shortcode_excludes();
+			if (isset($specific_excludes[ $field ])) {
+				foreach ($specific_excludes[ $field ] as $sex) {
+					if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
+						unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
+					}
+				}
+			}
+
+			// hey! don't forget to include the type if present!
+			$this->_validators[ $field ]['type'] = $config['type'] ?? null;
+		}
+	}
+
+
+	/**
+	 * This just returns the validators property that contains information
+	 * about the various shortcodes and their availability with each field
+	 *
+	 * @return array
+	 */
+	public function get_validators(): array
+	{
+		return $this->_validators;
+	}
+
+
+	/**
+	 * This simply returns the specific shortcode_excludes property that is set.
+	 *
+	 * @return array
+	 * @since 4.5.0
+	 */
+	public function get_specific_shortcode_excludes(): array
+	{
+		// specific validator filter
+		$shortcode_excludes = (array) apply_filters(
+			'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
+			$this->_specific_shortcode_excludes,
+			$this->_context
+		);
+		// global filter
+		return (array) apply_filters(
+			'FHEE__EE_Messages_Validator__get_specific_shortcode_excludes',
+			$shortcode_excludes,
+			$this->_context,
+			$this
+		);
+	}
+
+
+	/**
+	 * This is the main method that handles validation
+	 * What it does is loop through the _fields (the ones that get validated)
+	 * and checks them against the shortcodes array for the field and the 'type' indicated by the
+	 *
+	 * @return array|bool if errors present we return the array otherwise true
+	 */
+	public function validate()
+	{
+		// some defaults
+		$template_fields = $this->_messenger->get_template_fields();
+		// loop through the fields and check!
+		foreach ($this->_fields as $field => $value) {
+			$this->_errors[ $field ] = [];
+			$err_msg                 = '';
+			$field_label             = '';
+			// if field is not present in the _validators array then we continue
+			if (! isset($this->_validators[ $field ])) {
+				unset($this->_errors[ $field ]);
+				continue;
+			}
+
+			// get the translated field label!
+			// first check if it's in the main fields list
+			if (isset($template_fields[ $field ])) {
+				// most likely the field is found in the 'extra' array.
+				$field_label = ! empty($template_fields[ $field ])
+					? $template_fields[ $field ]['label']
+					: $field;
+			}
+
+			// if field label is empty OR is equal to the current field
+			// then we need to loop through the 'extra' fields in the template_fields config (if present)
+			if (isset($template_fields['extra']) && (empty($field_label) || $field_label === $field)) {
+				foreach ($template_fields['extra'] as $main_field => $secondary_field) {
+					foreach ($secondary_field as $name => $values) {
+						if ($name === $field) {
+							$field_label = $values['label'];
+						}
+
+						// if we've got a 'main' secondary field, let's see if that matches what field we're on
+						// which means it contains the label for this field.
+						if ($name === 'main' && $main_field === $field_label) {
+							$field_label = $values['label'];
+						}
+					}
+				}
+			}
+
+			// field is present. Let's validate shortcodes first (but only if shortcodes present).
+			if (
+				isset($this->_validators[ $field ]['shortcodes'])
+				&& ! empty($this->_validators[ $field ]['shortcodes'])
+			) {
+				$valid_shortcodes   = array_keys((array) $this->_validators[ $field ]['shortcodes']);
+				$invalid_shortcodes = $this->findInvalidShortcodes((string) $value, $valid_shortcodes);
+				// if true then that means there is a returned error message
+				// that we'll need to add to the _errors array for this field.
+				if ($invalid_shortcodes) {
+					$v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
+					$err_msg = sprintf(
+						esc_html__(
+							'%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
+							'event_espresso'
+						),
+						'<strong>' . $field_label . '</strong>',
+						$invalid_shortcodes,
+						'<p>',
+						'</p >'
+					);
+					$err_msg .= sprintf(
+						esc_html__('%2$sValid shortcodes for this field are: %1$s%3$s', 'event_espresso'),
+						implode(', ', $v_s),
+						'<strong>',
+						'</strong>'
+					);
+				}
+			}
+
+			// if there's a "type" to be validated then let's do that too.
+			if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
+				switch ($this->_validators[ $field ]['type']) {
+					case 'number':
+						if (! is_numeric($value)) {
+							$err_msg .= sprintf(
+								esc_html__(
+									'%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
+									'event_espresso'
+								),
+								$field_label,
+								$value,
+								'<p>',
+								'</p >'
+							);
+						}
+						break;
+					case 'email':
+						$valid_email = $this->_validate_email((string) $value);
+						if (! $valid_email) {
+							$err_msg .= htmlentities(
+								sprintf(
+									esc_html__(
+										'The %1$s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.',
+										'event_espresso'
+									),
+									$field_label
+								)
+							);
+						}
+						break;
+					default:
+						break;
+				}
+			}
+
+			// if $err_msg isn't empty, let's set up the _errors array for this field.
+			if (! empty($err_msg)) {
+				$this->_errors[ $field ]['msg'] = $err_msg;
+			} else {
+				unset($this->_errors[ $field ]);
+			}
+		}
+
+		// if we have ANY errors, then we want to make sure we return the values
+		// for ALL the fields so the user doesn't have to retype them all.
+		if (! empty($this->_errors)) {
+			foreach ($this->_fields as $field => $value) {
+				$this->_errors[ $field ]['value'] = stripslashes($value);
+			}
+		}
+
+		// return any errors or just TRUE if everything validates
+		return empty($this->_errors)
+			? true
+			: $this->_errors;
+	}
+
+
+	/**
+	 * Reassembles and returns an array of valid shortcodes
+	 * given the array of groups and array of shortcodes indexed by group.
+	 *
+	 * @param array $groups          array of shortcode groups that we want shortcodes for
+	 * @param array $codes_from_objs All the codes available.
+	 * @return array                   an array of actual shortcodes (that will be used for validation).
+	 */
+	private function reassembleValidShortcodesFromGroup(array $groups, array $codes_from_objs): array
+	{
+		$shortcodes = [];
+		foreach ($groups as $group) {
+			$shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
+		}
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Validates a string against a list of accepted shortcodes
+	 * This function takes in an array of shortcodes
+	 * and makes sure that the given string ONLY contains shortcodes in that array.
+	 *
+	 * @param string $value            string to evaluate
+	 * @param array  $valid_shortcodes array of shortcodes that are acceptable.
+	 * @return bool|string  return either a list of invalid shortcodes OR false if the shortcodes validate.
+	 * @deprecated 5.0.48
+	 */
+	protected function _invalid_shortcodes(string $value, array $valid_shortcodes)
+	{
+		return $this->findInvalidShortcodes($value, $valid_shortcodes) ?: false;
+	}
+
+
+	/**
+	 * Validates a string against a list of accepted shortcodes
+	 * This function takes in an array of shortcodes
+	 * and makes sure that the given string ONLY contains shortcodes in that array.
+	 *
+	 * @param string $incoming_text    string to evaluate
+	 * @param array  $valid_shortcodes array of shortcodes that are acceptable.
+	 * @return string  return either a list of invalid shortcodes OR false if the shortcodes validate.
+	 */
+	protected function findInvalidShortcodes(string $incoming_text, array $valid_shortcodes): string
+	{
+		// first we need to go through the string and get ALL the shortcodes in the string
+		// matches the opening [ plus the shortcode name, but nothing else
+		// examples:
+		//  [RECIPIENT_LNAME] matches as [RECIPIENT_LNAME
+		//  [RECEIPT_URL download=true] matches as [RECEIPT_URL
+		//  [PAYMENT_LINK_IF_NEEDED_* custom_text='pay me now man!'] matches as [PAYMENT_LINK_IF_NEEDED_*
+		preg_match_all(EE_Shortcodes::REGEX_SHORTCODE_NAME_ONLY, $incoming_text, $matches);
+		$shortcodes_in_text = $matches[0];
+		// now all we need to do is add the closing ] to each shortcode to make them "valid"
+		$shortcodes_in_text = array_map(fn($shortcode) => rtrim($shortcode) . ']', $shortcodes_in_text);
+		// get a diff of the shortcodes in the string vs the valid shortcodes
+		$invalid_shortcodes = array_diff($shortcodes_in_text, $valid_shortcodes);
+		if (empty($invalid_shortcodes)) {
+			return '';
+		}
+		// made it here? then let's assemble the error message
+		return '<strong>' . implode('</strong>,<strong>', $invalid_shortcodes) . '</strong>';
+	}
+
+
+	/**
+	 * Validates an incoming string and makes sure we have valid emails in the string.
+	 *
+	 * @param string $value incoming value to validate
+	 * @return bool        true if the string validates, false if it doesn't
+	 */
+	protected function _validate_email(string $value): bool
+	{
+		$or_val = $value;
+
+		// empty strings will validate because this is how a message template
+		// for a particular context can be "turned off" (if there is no email then no message)
+		if (empty($value)) {
+			return true;
+		}
+
+		// first determine if there ARE any shortcodes.
+		// If there are shortcodes and then later we find that there were no other valid emails
+		// but the field isn't empty...
+		// that means we've got extra commas that were left after stripping out shortcodes so probably still valid.
+		$has_shortcodes = preg_match(EE_Shortcodes::REGEX_SHORTCODE_FULL, $value);
+
+		// first we need to strip out all the shortcodes!
+		$value = preg_replace(EE_Shortcodes::REGEX_SHORTCODE_FULL, '', $value);
+
+		// if original value is not empty and new value is, then we've parsed out a shortcode
+		// and we now have an empty string which DOES validate.
+		// We also validate complete empty field for email because
+		// it's possible that this message is being "turned off" for a particular context
+
+
+		if (! empty($or_val) && empty($value)) {
+			return true;
+		}
+
+		// trim any commas from beginning and end of string ( after whitespace trimmed );
+		$value = trim(trim($value), ',');
+
+		// next we need to split up the string if it's comma-delimited.
+		$emails = explode(',', $value);
+		$empty  = false; // used to indicate that there is an empty comma.
+		// now let's loop through the emails and do our checks
+		foreach ($emails as $email) {
+			if (empty($email)) {
+				$empty = true;
+				continue;
+			}
+
+			// trim whitespace
+			$email = trim($email);
+			// either its of type "bob@whatever.com", or its of type "fname lname <few@few.few>"
+			if (is_email($email)) {
+				continue;
+			}
+			$matches  = [];
+			$validate = (bool) preg_match('/(.*)<(.+)>/', $email, $matches);
+			if ($validate && is_email($matches[2])) {
+				continue;
+			}
+			return false;
+		}
+
+		return ! ($empty && ! $has_shortcodes);
+	}
+
+
+	/**
+	 * Magic getter
+	 * Using this to provide back compat with add-ons referencing deprecated properties.
+	 *
+	 * @param string $property Property being requested
+	 * @return mixed
+	 * @throws Exception
+	 */
+	public function __get($property)
+	{
+		$expected_properties_map = [
+			/**
+			 * @deprecated 4.9.0
+			 */
+			'_MSGR'   => '_messenger',
+			/**
+			 * @deprecated 4.9.0
+			 */
+			'_MSGTYP' => '_message_type',
+		];
+
+		if (isset($expected_properties_map[ $property ])) {
+			return $this->{$expected_properties_map[ $property ]};
+		}
+
+		throw new Exception(
+			sprintf(
+				esc_html__('The property %1$s being requested on %2$s does not exist', 'event_espresso'),
+				$property,
+				get_class($this)
+			)
+		);
+	}
 }

Spacing +53 added lines, -53 removed lines

@@ -138,9 +138,9 @@ 
         // load messenger
         $messenger = ucwords(str_replace('_', ' ', $this->_m_name));
         $messenger = str_replace(' ', '_', $messenger);
-        $messenger = 'EE_' . $messenger . '_messenger';
+        $messenger = 'EE_'.$messenger.'_messenger';
 
-        if (! class_exists($messenger)) {
+        if ( ! class_exists($messenger)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
@@ -154,9 +154,9 @@ 
         // load message type
         $message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
         $message_type = str_replace(' ', '_', $message_type);
-        $message_type = 'EE_' . $message_type . '_message_type';
+        $message_type = 'EE_'.$message_type.'_message_type';
 
-        if (! class_exists($message_type)) {
+        if ( ! class_exists($message_type)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
@@ -184,17 +184,17 @@ 
         $msgr_validator = $this->_messenger->get_validator_config();
         // we only want the valid shortcodes for the given context!
         $context  = $this->_context;
-        $mt_codes = $mt_codes[ $context ];
+        $mt_codes = $mt_codes[$context];
         // in this first loop we're just getting all shortcode group indexes from the msgr_validator
         // into a single array (so we can get the appropriate shortcode objects for the groups)
         $shortcode_groups = $mt_codes;
         $groups_per_field = [];
 
         foreach ($msgr_validator as $field => $config) {
-            if (! isset($config['shortcodes'])) {
+            if ( ! isset($config['shortcodes'])) {
                 continue;
             }  //Nothing to see here.
-            $groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
+            $groups_per_field[$field] = array_intersect($config['shortcodes'], $mt_codes);
             $shortcode_groups           = array_merge($config['shortcodes'], $shortcode_groups);
         }
         $shortcode_groups = array_unique($shortcode_groups);
@@ -206,18 +206,18 @@ 
         foreach ($shortcode_groups as $group) {
             $ref       = ucwords(str_replace('_', ' ', $group));
             $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
+            $classname = 'EE_'.$ref.'_Shortcodes';
             if (class_exists($classname)) {
                 $a                         = new ReflectionClass($classname);
                 $obj                       = $a->newInstance();
-                $codes_from_objs[ $group ] = $obj->get_shortcodes();
+                $codes_from_objs[$group] = $obj->get_shortcodes();
             }
         }
 
         // let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
         $final_mt_codes = [];
         foreach ($mt_codes as $group) {
-            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
+            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[$group]);
         }
         $mt_codes = $final_mt_codes;
 
@@ -232,45 +232,45 @@ 
                 continue;
             }
 
-            if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
+            if (isset($this->_valid_shortcodes_modifier[$context][$field])) {
                 // If we have an override then we use it to indicate the codes we want.
-                $this->_validators[ $field ]['shortcodes'] = $this->reassembleValidShortcodesFromGroup(
-                    $this->_valid_shortcodes_modifier[ $context ][ $field ],
+                $this->_validators[$field]['shortcodes'] = $this->reassembleValidShortcodesFromGroup(
+                    $this->_valid_shortcodes_modifier[$context][$field],
                     $codes_from_objs
                 );
-            } elseif (isset($groups_per_field[ $field ])) {
+            } elseif (isset($groups_per_field[$field])) {
                 // we have specific shortcodes for a field so we need to use them
-                $this->_validators[ $field ]['shortcodes'] = $this->reassembleValidShortcodesFromGroup(
-                    $groups_per_field[ $field ],
+                $this->_validators[$field]['shortcodes'] = $this->reassembleValidShortcodesFromGroup(
+                    $groups_per_field[$field],
                     $codes_from_objs
                 );
             } elseif (empty($config)) {
                 // no config so we're assuming we're just going to use the shortcodes from the message type context
-                $this->_validators[ $field ]['shortcodes'] = $mt_codes;
+                $this->_validators[$field]['shortcodes'] = $mt_codes;
             } elseif (isset($config['specific_shortcodes'])) {
                 // we have specific shortcodes so we need to use them
-                $this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
+                $this->_validators[$field]['shortcodes'] = $config['specific_shortcodes'];
             } else {
                 // otherwise the shortcodes are what is set by the messenger for that field
                 foreach ($config['shortcodes'] as $group) {
-                    $this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
-                        ? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
-                        : $codes_from_objs[ $group ];
+                    $this->_validators[$field]['shortcodes'] = isset($this->_validators[$field]['shortcodes'])
+                        ? array_merge($this->_validators[$field]['shortcodes'], $codes_from_objs[$group])
+                        : $codes_from_objs[$group];
                 }
             }
 
             // now let's just make sure that any excluded specific shortcodes are removed.
             $specific_excludes = $this->get_specific_shortcode_excludes();
-            if (isset($specific_excludes[ $field ])) {
-                foreach ($specific_excludes[ $field ] as $sex) {
-                    if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
-                        unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
+            if (isset($specific_excludes[$field])) {
+                foreach ($specific_excludes[$field] as $sex) {
+                    if (isset($this->_validators[$field]['shortcodes'][$sex])) {
+                        unset($this->_validators[$field]['shortcodes'][$sex]);
                     }
                 }
             }
 
             // hey! don't forget to include the type if present!
-            $this->_validators[ $field ]['type'] = $config['type'] ?? null;
+            $this->_validators[$field]['type'] = $config['type'] ?? null;
         }
     }
 
@@ -297,7 +297,7 @@ 
     {
         // specific validator filter
         $shortcode_excludes = (array) apply_filters(
-            'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
+            'FHEE__'.get_class($this).'__get_specific_shortcode_excludes;',
             $this->_specific_shortcode_excludes,
             $this->_context
         );
@@ -324,21 +324,21 @@ 
         $template_fields = $this->_messenger->get_template_fields();
         // loop through the fields and check!
         foreach ($this->_fields as $field => $value) {
-            $this->_errors[ $field ] = [];
+            $this->_errors[$field] = [];
             $err_msg                 = '';
             $field_label             = '';
             // if field is not present in the _validators array then we continue
-            if (! isset($this->_validators[ $field ])) {
-                unset($this->_errors[ $field ]);
+            if ( ! isset($this->_validators[$field])) {
+                unset($this->_errors[$field]);
                 continue;
             }
 
             // get the translated field label!
             // first check if it's in the main fields list
-            if (isset($template_fields[ $field ])) {
+            if (isset($template_fields[$field])) {
                 // most likely the field is found in the 'extra' array.
-                $field_label = ! empty($template_fields[ $field ])
-                    ? $template_fields[ $field ]['label']
+                $field_label = ! empty($template_fields[$field])
+                    ? $template_fields[$field]['label']
                     : $field;
             }
 
@@ -362,21 +362,21 @@ 
 
             // field is present. Let's validate shortcodes first (but only if shortcodes present).
             if (
-                isset($this->_validators[ $field ]['shortcodes'])
-                && ! empty($this->_validators[ $field ]['shortcodes'])
+                isset($this->_validators[$field]['shortcodes'])
+                && ! empty($this->_validators[$field]['shortcodes'])
             ) {
-                $valid_shortcodes   = array_keys((array) $this->_validators[ $field ]['shortcodes']);
+                $valid_shortcodes   = array_keys((array) $this->_validators[$field]['shortcodes']);
                 $invalid_shortcodes = $this->findInvalidShortcodes((string) $value, $valid_shortcodes);
                 // if true then that means there is a returned error message
                 // that we'll need to add to the _errors array for this field.
                 if ($invalid_shortcodes) {
-                    $v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
+                    $v_s     = array_keys($this->_validators[$field]['shortcodes']);
                     $err_msg = sprintf(
                         esc_html__(
                             '%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
                             'event_espresso'
                         ),
-                        '<strong>' . $field_label . '</strong>',
+                        '<strong>'.$field_label.'</strong>',
                         $invalid_shortcodes,
                         '<p>',
                         '</p >'
@@ -391,10 +391,10 @@ 
             }
 
             // if there's a "type" to be validated then let's do that too.
-            if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
-                switch ($this->_validators[ $field ]['type']) {
+            if (isset($this->_validators[$field]['type']) && ! empty($this->_validators[$field]['type'])) {
+                switch ($this->_validators[$field]['type']) {
                     case 'number':
-                        if (! is_numeric($value)) {
+                        if ( ! is_numeric($value)) {
                             $err_msg .= sprintf(
                                 esc_html__(
                                     '%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
@@ -409,7 +409,7 @@ 
                         break;
                     case 'email':
                         $valid_email = $this->_validate_email((string) $value);
-                        if (! $valid_email) {
+                        if ( ! $valid_email) {
                             $err_msg .= htmlentities(
                                 sprintf(
                                     esc_html__(
@@ -427,18 +427,18 @@ 
             }
 
             // if $err_msg isn't empty, let's set up the _errors array for this field.
-            if (! empty($err_msg)) {
-                $this->_errors[ $field ]['msg'] = $err_msg;
+            if ( ! empty($err_msg)) {
+                $this->_errors[$field]['msg'] = $err_msg;
             } else {
-                unset($this->_errors[ $field ]);
+                unset($this->_errors[$field]);
             }
         }
 
         // if we have ANY errors, then we want to make sure we return the values
         // for ALL the fields so the user doesn't have to retype them all.
-        if (! empty($this->_errors)) {
+        if ( ! empty($this->_errors)) {
             foreach ($this->_fields as $field => $value) {
-                $this->_errors[ $field ]['value'] = stripslashes($value);
+                $this->_errors[$field]['value'] = stripslashes($value);
             }
         }
 
@@ -461,7 +461,7 @@ 
     {
         $shortcodes = [];
         foreach ($groups as $group) {
-            $shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
+            $shortcodes = array_merge($shortcodes, $codes_from_objs[$group]);
         }
         return $shortcodes;
     }
@@ -503,14 +503,14 @@ 
         preg_match_all(EE_Shortcodes::REGEX_SHORTCODE_NAME_ONLY, $incoming_text, $matches);
         $shortcodes_in_text = $matches[0];
         // now all we need to do is add the closing ] to each shortcode to make them "valid"
-        $shortcodes_in_text = array_map(fn($shortcode) => rtrim($shortcode) . ']', $shortcodes_in_text);
+        $shortcodes_in_text = array_map(fn($shortcode) => rtrim($shortcode).']', $shortcodes_in_text);
         // get a diff of the shortcodes in the string vs the valid shortcodes
         $invalid_shortcodes = array_diff($shortcodes_in_text, $valid_shortcodes);
         if (empty($invalid_shortcodes)) {
             return '';
         }
         // made it here? then let's assemble the error message
-        return '<strong>' . implode('</strong>,<strong>', $invalid_shortcodes) . '</strong>';
+        return '<strong>'.implode('</strong>,<strong>', $invalid_shortcodes).'</strong>';
     }
 
 
@@ -545,7 +545,7 @@ 
         // it's possible that this message is being "turned off" for a particular context
 
 
-        if (! empty($or_val) && empty($value)) {
+        if ( ! empty($or_val) && empty($value)) {
             return true;
         }
 
@@ -601,8 +601,8 @@ 
             '_MSGTYP' => '_message_type',
         ];
 
-        if (isset($expected_properties_map[ $property ])) {
-            return $this->{$expected_properties_map[ $property ]};
+        if (isset($expected_properties_map[$property])) {
+            return $this->{$expected_properties_map[$property]};
         }
 
         throw new Exception(

core/helpers/EEH_Parse_Shortcodes.helper.php

Indentation +261 added lines, -261 removed lines

@@ -10,265 +10,265 @@
  */
 class EEH_Parse_Shortcodes
 {
-    /**
-     * holds the template
-     *
-     * @access private
-     * @var mixed (string|array)
-     */
-    private $_template;
-
-
-    /**
-     * holds the incoming data object
-     *
-     * @access private
-     * @var object
-     */
-    private $_data;
-
-
-    /**
-     * will hold an array of EE_Shortcodes library objects.
-     *
-     * @access private
-     * @var EE_Shortcodes[]
-     */
-    private $_shortcode_objs = array();
-
-
-    /**
-     * This kicks off the parsing of shortcodes in message templates
-     *
-     * @param  string                $template         This is the incoming string to be parsed
-     * @param  EE_Messages_Addressee $data             This is the incoming data object
-     * @param  array                 $valid_shortcodes An array of strings that correspond to EE_Shortcode libraries
-     * @param EE_message_type        $message_type     The message type that called the parser
-     * @param EE_messenger           $messenger        The active messenger for this parsing session.
-     * @param EE_Message             $message
-     * @return string                   The parsed template string
-     */
-    public function parse_message_template(
-        $template,
-        EE_Messages_Addressee $data,
-        $valid_shortcodes,
-        EE_message_type $message_type,
-        EE_messenger $messenger,
-        EE_Message $message
-    ) {
-        $extra_data = array(
-            'messenger'    => $messenger,
-            'message_type' => $message_type,
-            'message'      => $message,
-        );
-        $this->_init_data($template, $data, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['main'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_attendee_list_template(
-        $template,
-        EE_Registration $registration,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $registration, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['attendee_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-    public function parse_event_list_template($template, EE_Event $event, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_init_data($template, $event, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['event_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_ticket_list_template($template, EE_Ticket $ticket, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_init_data($template, $ticket, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['ticket_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_line_item_list_template(
-        $template,
-        EE_Line_Item $line_item,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $line_item, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['ticket_line_item_no_pms'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_payment_list_template(
-        $template,
-        EE_Payment $payment_item,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $payment_item, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['payment_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_datetime_list_template(
-        $template,
-        EE_Datetime $datetime,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $datetime, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['datetime_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_question_list_template($template, EE_Answer $answer, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_init_data($template, $answer, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['question_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    private function _init_data($template, $data, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_reset_props();
-        $this->_data['template']   = $template;
-        $this->_data['data']       = $data;
-        $this->_data['extra_data'] = $extra_data;
-        $this->_set_shortcodes($valid_shortcodes);
-    }
-
-
-    private function _reset_props()
-    {
-        $this->_template       = $this->_data = null;
-        $this->_shortcode_objs = array();
-    }
-
-
-    /**
-     * takes the given template and parses it with the $_shortcodes property
-     *
-     * @return string
-     */
-    private function _parse_message_template(): string
-    {
-        // now let's get a list of shortcodes that are found in the given template
-        preg_match_all(EE_Shortcodes::REGEX_SHORTCODE_FULL, $this->_template, $matches);
-        $shortcodes = $matches[0]; // this should be an array of shortcodes in the template string.
-
-        $matched_code = array();
-        $sc_values    = array();
-
-        $list_type_shortcodes = array(
-            '[ATTENDEE_LIST]',
-            '[EVENT_LIST]',
-            '[TICKET_LIST]',
-            '[DATETIME_LIST]',
-            '[QUESTION_LIST]',
-            '[RECIPIENT_QUESTION_LIST]',
-            '[PRIMARY_REGISTRANT_QUESTION_LIST]',
-            '[RECIPIENT_TICKET_LIST]',
-            '[PRIMARY_REGISTRANT_TICKET_LIST]',
-            '[RECIPIENT_DATETIME_LIST]',
-            '[PRIMARY_REGISTRANT_DATETIME_LIST]',
-            '[TICKET_LINE_ITEM_LIST]',
-            '[TAX_LINE_ITEM_LIST]',
-            '[ADDITIONAL_LINE_ITEM_LIST]',
-            '[PRICE_MODIFIER_LINE_ITEM_LIST]',
-            '[PAYMENT_LIST_*]',
-        );
-
-        $list_type_shortcodes = apply_filters(
-            'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
-            $list_type_shortcodes
-        );
-
-        // now lets go ahead and loop through our parsers for each shortcode and set up the values
-        foreach ($shortcodes as $shortcode) {
-            // truncate full shortcode to shortcode name only (ie: remove attributes and dynamic portions)
-            preg_match_all(EE_Shortcodes::REGEX_SHORTCODE_NAME_ONLY, $shortcode, $matches);
-            // ensure shortcode ends with closing ]
-            $short_code_name = rtrim(reset($matches[0]), ']') . ']';
-
-            foreach ($this->_shortcode_objs as $sc_obj) {
-                if (! $sc_obj instanceof EE_Shortcodes) {
-                    continue;
-                }
-                // check if the given shortcode is in this object, if not, move on
-                if (! array_key_exists($short_code_name, $sc_obj->get_shortcodes())) {
-                    continue;
-                }
-
-                // if this isn't  a "list" type shortcode then we'll send along the data vanilla instead of in an array.
-                if (! in_array($shortcode, $list_type_shortcodes)) {
-                    $data_send = ! is_object($this->_data) && isset($this->_data['data']) ? $this->_data['data'] : $this->_data;
-                } else {
-                    $data_send = $this->_data;
-                }
-
-                // is this a conditional type shortcode?  If it is then we actually parse the template here.
-                if ($this->_is_conditional_shortcode($shortcode)) {
-                    // most shortcode parsers are not going to have a match for this shortcode
-                    // and will return an empty string so we need to make sure that we're only replacing
-                    // the template when there is a non-empty string.
-                    $parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
-                    if ($parsed) {
-                        $this->_template = $parsed;
-                    }
-                }
-
-                $parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
-
-                $matched_code[] = $shortcode;
-                $sc_values[]    = $parsed;
-            }
-        }
-
-        // now we've got parsed values for all the shortcodes in the template so we can go ahead and swap the shortcodes out.
-        return str_replace(array_values($matched_code), array_values($sc_values), $this->_template);
-    }
-
-
-    /**
-     * Simply returns whether the given shortcode matches the structure for a conditional shortcode.
-     *
-     * Does it match this format: `[IF_`
-     *
-     * @param $shortcode
-     * @return bool
-     */
-    protected function _is_conditional_shortcode($shortcode): bool
-    {
-        return strpos($shortcode, '[IF_') === 0;
-    }
-
-
-    /**
-     * This sets the shortcodes property from the incoming array of valid shortcodes that corresponds to names of
-     * various EE_Shortcode library objects
-     *
-     * @param array $valid_shortcodes an array of strings corresponding to EE_Shortcode Library objects
-     * @return void
-     */
-    private function _set_shortcodes(array $valid_shortcodes)
-    {
-        foreach ($valid_shortcodes as $shortcode_ref) {
-            $ref       = ucwords(str_replace('_', ' ', $shortcode_ref));
-            $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
-            if (class_exists($classname) && ! isset($this->_shortcode_objs[ $classname ])) {
-                $this->_shortcode_objs[ $classname ] = new $classname();
-            }
-        }
-    }
+	/**
+	 * holds the template
+	 *
+	 * @access private
+	 * @var mixed (string|array)
+	 */
+	private $_template;
+
+
+	/**
+	 * holds the incoming data object
+	 *
+	 * @access private
+	 * @var object
+	 */
+	private $_data;
+
+
+	/**
+	 * will hold an array of EE_Shortcodes library objects.
+	 *
+	 * @access private
+	 * @var EE_Shortcodes[]
+	 */
+	private $_shortcode_objs = array();
+
+
+	/**
+	 * This kicks off the parsing of shortcodes in message templates
+	 *
+	 * @param  string                $template         This is the incoming string to be parsed
+	 * @param  EE_Messages_Addressee $data             This is the incoming data object
+	 * @param  array                 $valid_shortcodes An array of strings that correspond to EE_Shortcode libraries
+	 * @param EE_message_type        $message_type     The message type that called the parser
+	 * @param EE_messenger           $messenger        The active messenger for this parsing session.
+	 * @param EE_Message             $message
+	 * @return string                   The parsed template string
+	 */
+	public function parse_message_template(
+		$template,
+		EE_Messages_Addressee $data,
+		$valid_shortcodes,
+		EE_message_type $message_type,
+		EE_messenger $messenger,
+		EE_Message $message
+	) {
+		$extra_data = array(
+			'messenger'    => $messenger,
+			'message_type' => $message_type,
+			'message'      => $message,
+		);
+		$this->_init_data($template, $data, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['main'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_attendee_list_template(
+		$template,
+		EE_Registration $registration,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $registration, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['attendee_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+	public function parse_event_list_template($template, EE_Event $event, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_init_data($template, $event, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['event_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_ticket_list_template($template, EE_Ticket $ticket, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_init_data($template, $ticket, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['ticket_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_line_item_list_template(
+		$template,
+		EE_Line_Item $line_item,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $line_item, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['ticket_line_item_no_pms'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_payment_list_template(
+		$template,
+		EE_Payment $payment_item,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $payment_item, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['payment_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_datetime_list_template(
+		$template,
+		EE_Datetime $datetime,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $datetime, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['datetime_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_question_list_template($template, EE_Answer $answer, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_init_data($template, $answer, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['question_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	private function _init_data($template, $data, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_reset_props();
+		$this->_data['template']   = $template;
+		$this->_data['data']       = $data;
+		$this->_data['extra_data'] = $extra_data;
+		$this->_set_shortcodes($valid_shortcodes);
+	}
+
+
+	private function _reset_props()
+	{
+		$this->_template       = $this->_data = null;
+		$this->_shortcode_objs = array();
+	}
+
+
+	/**
+	 * takes the given template and parses it with the $_shortcodes property
+	 *
+	 * @return string
+	 */
+	private function _parse_message_template(): string
+	{
+		// now let's get a list of shortcodes that are found in the given template
+		preg_match_all(EE_Shortcodes::REGEX_SHORTCODE_FULL, $this->_template, $matches);
+		$shortcodes = $matches[0]; // this should be an array of shortcodes in the template string.
+
+		$matched_code = array();
+		$sc_values    = array();
+
+		$list_type_shortcodes = array(
+			'[ATTENDEE_LIST]',
+			'[EVENT_LIST]',
+			'[TICKET_LIST]',
+			'[DATETIME_LIST]',
+			'[QUESTION_LIST]',
+			'[RECIPIENT_QUESTION_LIST]',
+			'[PRIMARY_REGISTRANT_QUESTION_LIST]',
+			'[RECIPIENT_TICKET_LIST]',
+			'[PRIMARY_REGISTRANT_TICKET_LIST]',
+			'[RECIPIENT_DATETIME_LIST]',
+			'[PRIMARY_REGISTRANT_DATETIME_LIST]',
+			'[TICKET_LINE_ITEM_LIST]',
+			'[TAX_LINE_ITEM_LIST]',
+			'[ADDITIONAL_LINE_ITEM_LIST]',
+			'[PRICE_MODIFIER_LINE_ITEM_LIST]',
+			'[PAYMENT_LIST_*]',
+		);
+
+		$list_type_shortcodes = apply_filters(
+			'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
+			$list_type_shortcodes
+		);
+
+		// now lets go ahead and loop through our parsers for each shortcode and set up the values
+		foreach ($shortcodes as $shortcode) {
+			// truncate full shortcode to shortcode name only (ie: remove attributes and dynamic portions)
+			preg_match_all(EE_Shortcodes::REGEX_SHORTCODE_NAME_ONLY, $shortcode, $matches);
+			// ensure shortcode ends with closing ]
+			$short_code_name = rtrim(reset($matches[0]), ']') . ']';
+
+			foreach ($this->_shortcode_objs as $sc_obj) {
+				if (! $sc_obj instanceof EE_Shortcodes) {
+					continue;
+				}
+				// check if the given shortcode is in this object, if not, move on
+				if (! array_key_exists($short_code_name, $sc_obj->get_shortcodes())) {
+					continue;
+				}
+
+				// if this isn't  a "list" type shortcode then we'll send along the data vanilla instead of in an array.
+				if (! in_array($shortcode, $list_type_shortcodes)) {
+					$data_send = ! is_object($this->_data) && isset($this->_data['data']) ? $this->_data['data'] : $this->_data;
+				} else {
+					$data_send = $this->_data;
+				}
+
+				// is this a conditional type shortcode?  If it is then we actually parse the template here.
+				if ($this->_is_conditional_shortcode($shortcode)) {
+					// most shortcode parsers are not going to have a match for this shortcode
+					// and will return an empty string so we need to make sure that we're only replacing
+					// the template when there is a non-empty string.
+					$parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
+					if ($parsed) {
+						$this->_template = $parsed;
+					}
+				}
+
+				$parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
+
+				$matched_code[] = $shortcode;
+				$sc_values[]    = $parsed;
+			}
+		}
+
+		// now we've got parsed values for all the shortcodes in the template so we can go ahead and swap the shortcodes out.
+		return str_replace(array_values($matched_code), array_values($sc_values), $this->_template);
+	}
+
+
+	/**
+	 * Simply returns whether the given shortcode matches the structure for a conditional shortcode.
+	 *
+	 * Does it match this format: `[IF_`
+	 *
+	 * @param $shortcode
+	 * @return bool
+	 */
+	protected function _is_conditional_shortcode($shortcode): bool
+	{
+		return strpos($shortcode, '[IF_') === 0;
+	}
+
+
+	/**
+	 * This sets the shortcodes property from the incoming array of valid shortcodes that corresponds to names of
+	 * various EE_Shortcode library objects
+	 *
+	 * @param array $valid_shortcodes an array of strings corresponding to EE_Shortcode Library objects
+	 * @return void
+	 */
+	private function _set_shortcodes(array $valid_shortcodes)
+	{
+		foreach ($valid_shortcodes as $shortcode_ref) {
+			$ref       = ucwords(str_replace('_', ' ', $shortcode_ref));
+			$ref       = str_replace(' ', '_', $ref);
+			$classname = 'EE_' . $ref . '_Shortcodes';
+			if (class_exists($classname) && ! isset($this->_shortcode_objs[ $classname ])) {
+				$this->_shortcode_objs[ $classname ] = new $classname();
+			}
+		}
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -198,19 +198,19 @@ 
             // truncate full shortcode to shortcode name only (ie: remove attributes and dynamic portions)
             preg_match_all(EE_Shortcodes::REGEX_SHORTCODE_NAME_ONLY, $shortcode, $matches);
             // ensure shortcode ends with closing ]
-            $short_code_name = rtrim(reset($matches[0]), ']') . ']';
+            $short_code_name = rtrim(reset($matches[0]), ']').']';
 
             foreach ($this->_shortcode_objs as $sc_obj) {
-                if (! $sc_obj instanceof EE_Shortcodes) {
+                if ( ! $sc_obj instanceof EE_Shortcodes) {
                     continue;
                 }
                 // check if the given shortcode is in this object, if not, move on
-                if (! array_key_exists($short_code_name, $sc_obj->get_shortcodes())) {
+                if ( ! array_key_exists($short_code_name, $sc_obj->get_shortcodes())) {
                     continue;
                 }
 
                 // if this isn't  a "list" type shortcode then we'll send along the data vanilla instead of in an array.
-                if (! in_array($shortcode, $list_type_shortcodes)) {
+                if ( ! in_array($shortcode, $list_type_shortcodes)) {
                     $data_send = ! is_object($this->_data) && isset($this->_data['data']) ? $this->_data['data'] : $this->_data;
                 } else {
                     $data_send = $this->_data;
@@ -265,9 +265,9 @@ 
         foreach ($valid_shortcodes as $shortcode_ref) {
             $ref       = ucwords(str_replace('_', ' ', $shortcode_ref));
             $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
-            if (class_exists($classname) && ! isset($this->_shortcode_objs[ $classname ])) {
-                $this->_shortcode_objs[ $classname ] = new $classname();
+            $classname = 'EE_'.$ref.'_Shortcodes';
+            if (class_exists($classname) && ! isset($this->_shortcode_objs[$classname])) {
+                $this->_shortcode_objs[$classname] = new $classname();
             }
         }
     }