eventespresso / event-espresso-core

core/libraries/messages/message_type/EE_Receipt_message_type.class.php

Spacing +3 added lines, -3 removed lines

@@ -53,7 +53,7 @@ 
 
     protected function _set_admin_pages()
     {
-        $this->admin_registered_pages = array( 'events_edit' => true );
+        $this->admin_registered_pages = array('events_edit' => true);
     }
 
 
@@ -68,7 +68,7 @@ 
     protected function _set_with_messengers()
     {
         $this->_with_messengers = array(
-            'html' => array( 'pdf' )
+            'html' => array('pdf')
         );
     }
 
@@ -79,7 +79,7 @@ 
         // receipt message type data handler is 'Gateways' and it expects a transaction object.
         $transaction = $registration->transaction();
         if ($transaction instanceof EE_Transaction) {
-            return array( $transaction );
+            return array($transaction);
         }
         return array();
     }

Indentation +132 added lines, -132 removed lines

@@ -13,142 +13,142 @@
 class EE_Receipt_message_type extends EE_message_type
 {
 
-    public function __construct()
-    {
-        $this->name = 'receipt';
-        $this->description = esc_html__('The receipt message type is triggered via a url on the thank you page and via at url generated by the [RECEIPT_URL] shortcode.', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('receipt', 'event_espresso'),
-            'plural' => esc_html__('receipts', 'event_espresso')
-        );
-        $this->_master_templates = array();
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		$this->name = 'receipt';
+		$this->description = esc_html__('The receipt message type is triggered via a url on the thank you page and via at url generated by the [RECEIPT_URL] shortcode.', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('receipt', 'event_espresso'),
+			'plural' => esc_html__('receipts', 'event_espresso')
+		);
+		$this->_master_templates = array();
+		parent::__construct();
+	}
 
 
 
-    /**
-     * @see parent::get_priority() for documentation.
-     * @return int
-     */
-    public function get_priority()
-    {
-        return EEM_Message::priority_high;
-    }
-
-
-
-    /**
-     * This method returns whether this message type should always generate a new copy
-     * when requested, or if links can be to the already generated copy.
-     * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table.
-     * Receipts always generate
-     * @return bool     false means can link to generated EE_Message.  true must regenerate.
-     */
-    public function always_generate()
-    {
-        return true;
-    }
-
-
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array( 'events_edit' => true );
-    }
-
-
-
-    protected function _set_data_handler()
-    {
-        $this->_data_handler = 'Gateways';
-    }
-
-
-
-    protected function _set_with_messengers()
-    {
-        $this->_with_messengers = array(
-            'html' => array( 'pdf' )
-        );
-    }
-
-
-
-    protected function _get_data_for_context($context, EE_Registration $registration, $id)
-    {
-        // receipt message type data handler is 'Gateways' and it expects a transaction object.
-        $transaction = $registration->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            return array( $transaction );
-        }
-        return array();
-    }
-
-
-
-    protected function _set_admin_settings_fields()
-    {
-        $this->_admin_settings_fields = array();
-    }
-
-
-
-    protected function _set_contexts()
-    {
-        $this->_context_label = array(
-            'label' => esc_html__('recipient', 'event_espresso'),
-            'plural' => esc_html__('recipients', 'event_espresso'),
-            'description' => esc_html__('Recipient\'s are who will view the receipt.', 'event_espresso')
-        );
-
-        $this->_contexts = array(
-            'purchaser' => array(
-                'label' => esc_html__('Purchaser', 'event_espresso'),
-                'description' => esc_html__('This template goes to the person who conducted the transaction.', 'event_espresso')
-            )
-        );
-    }
-
-
-
-
-    /**
-    * used to set the valid shortcodes for the receipt message type
-    *
-    * @since   4.5.0
-    *
-    * @return  void
-    */
-    protected function _set_valid_shortcodes()
-    {
-        $this->_valid_shortcodes['purchaser'] = array(
-            'attendee_list',
-            'attendee',
-            'datetime_list',
-            'datetime',
-            'event_list',
-            'event',
-            'event_meta',
-            'messenger',
-            'organization',
-            'primary_registration_list',
-            'primary_registration_details',
-            'ticket_list',
-            'ticket',
-            'transaction',
-            'venue',
-            'line_item_list',
-            'payment_list',
-            'line_item',
-            'payment'
-        );
-    }
-
+	/**
+	 * @see parent::get_priority() for documentation.
+	 * @return int
+	 */
+	public function get_priority()
+	{
+		return EEM_Message::priority_high;
+	}
+
+
+
+	/**
+	 * This method returns whether this message type should always generate a new copy
+	 * when requested, or if links can be to the already generated copy.
+	 * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table.
+	 * Receipts always generate
+	 * @return bool     false means can link to generated EE_Message.  true must regenerate.
+	 */
+	public function always_generate()
+	{
+		return true;
+	}
+
+
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array( 'events_edit' => true );
+	}
+
+
+
+	protected function _set_data_handler()
+	{
+		$this->_data_handler = 'Gateways';
+	}
+
+
+
+	protected function _set_with_messengers()
+	{
+		$this->_with_messengers = array(
+			'html' => array( 'pdf' )
+		);
+	}
+
+
+
+	protected function _get_data_for_context($context, EE_Registration $registration, $id)
+	{
+		// receipt message type data handler is 'Gateways' and it expects a transaction object.
+		$transaction = $registration->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			return array( $transaction );
+		}
+		return array();
+	}
+
+
+
+	protected function _set_admin_settings_fields()
+	{
+		$this->_admin_settings_fields = array();
+	}
+
+
+
+	protected function _set_contexts()
+	{
+		$this->_context_label = array(
+			'label' => esc_html__('recipient', 'event_espresso'),
+			'plural' => esc_html__('recipients', 'event_espresso'),
+			'description' => esc_html__('Recipient\'s are who will view the receipt.', 'event_espresso')
+		);
+
+		$this->_contexts = array(
+			'purchaser' => array(
+				'label' => esc_html__('Purchaser', 'event_espresso'),
+				'description' => esc_html__('This template goes to the person who conducted the transaction.', 'event_espresso')
+			)
+		);
+	}
+
+
+
+
+	/**
+	 * used to set the valid shortcodes for the receipt message type
+	 *
+	 * @since   4.5.0
+	 *
+	 * @return  void
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$this->_valid_shortcodes['purchaser'] = array(
+			'attendee_list',
+			'attendee',
+			'datetime_list',
+			'datetime',
+			'event_list',
+			'event',
+			'event_meta',
+			'messenger',
+			'organization',
+			'primary_registration_list',
+			'primary_registration_details',
+			'ticket_list',
+			'ticket',
+			'transaction',
+			'venue',
+			'line_item_list',
+			'payment_list',
+			'line_item',
+			'payment'
+		);
+	}
+
 
 
 
-    protected function _purchaser_addressees()
-    {
-        return parent::_primary_attendee_addressees();
-    }
+	protected function _purchaser_addressees()
+	{
+		return parent::_primary_attendee_addressees();
+	}
 }

core/libraries/messages/EE_Message_To_Generate_From_Queue.php

Spacing +1 added lines, -1 removed lines

@@ -62,7 +62,7 @@
      */
     protected function _get_subject($custom_subject = '')
     {
-        if (! empty($custom_subject)) {
+        if ( ! empty($custom_subject)) {
             return $custom_subject;
         }
         $this->queue->get_message_repository()->rewind();

Indentation +77 added lines, -77 removed lines

@@ -13,90 +13,90 @@
 {
 
 
-    /**
-     * Will hold an EE_Messages_Queue object
-     * @type EE_Messages_Queue
-     */
-    public $queue = array();
+	/**
+	 * Will hold an EE_Messages_Queue object
+	 * @type EE_Messages_Queue
+	 */
+	public $queue = array();
 
-    /**
-     * @param string            $messenger_name  The messenger being used to send the message
-     * @param string            $message_type_name  The message type being used to grab variations etc.
-     * @param EE_Messages_Queue $queue
-     * @param string            $custom_subject  Used if a custom subject is desired for the generated aggregate EE_Message object
-     */
-    public function __construct($messenger_name, $message_type_name, EE_Messages_Queue $queue, $custom_subject = '')
-    {
-        $this->queue = $queue;
-        parent::__construct($messenger_name, $message_type_name, array(), '', false, EEM_Message::status_idle);
-        if ($this->valid()) {
-            $this->_message->set_content($this->_get_content());
-            $this->_message->set_subject($this->_get_subject($custom_subject));
-            $this->_message->set_GRP_ID($this->getGroupIdFromMessageRepo());
-        }
-    }
+	/**
+	 * @param string            $messenger_name  The messenger being used to send the message
+	 * @param string            $message_type_name  The message type being used to grab variations etc.
+	 * @param EE_Messages_Queue $queue
+	 * @param string            $custom_subject  Used if a custom subject is desired for the generated aggregate EE_Message object
+	 */
+	public function __construct($messenger_name, $message_type_name, EE_Messages_Queue $queue, $custom_subject = '')
+	{
+		$this->queue = $queue;
+		parent::__construct($messenger_name, $message_type_name, array(), '', false, EEM_Message::status_idle);
+		if ($this->valid()) {
+			$this->_message->set_content($this->_get_content());
+			$this->_message->set_subject($this->_get_subject($custom_subject));
+			$this->_message->set_GRP_ID($this->getGroupIdFromMessageRepo());
+		}
+	}
 
 
 
-    /**
-     * Uses the EE_Messages_Queue currently set on this object to generate the content
-     * for the single EE_Message aggregate object returned by get_EE_Message
-     * @return string;
-     */
-    protected function _get_content()
-    {
-        $content = '';
-        $this->queue->get_message_repository()->rewind();
-        while ($this->queue->get_message_repository()->valid()) {
-            $content .= $this->queue->get_message_repository()->current()->content();
-            $this->queue->get_message_repository()->next();
-        }
-        return $content;
-    }
+	/**
+	 * Uses the EE_Messages_Queue currently set on this object to generate the content
+	 * for the single EE_Message aggregate object returned by get_EE_Message
+	 * @return string;
+	 */
+	protected function _get_content()
+	{
+		$content = '';
+		$this->queue->get_message_repository()->rewind();
+		while ($this->queue->get_message_repository()->valid()) {
+			$content .= $this->queue->get_message_repository()->current()->content();
+			$this->queue->get_message_repository()->next();
+		}
+		return $content;
+	}
 
 
-    /**
-     * Return a subject string to use for `MSG_Subject` in the aggregate EE_Message object.
-     * @param string $custom_subject
-     *
-     * @return string
-     */
-    protected function _get_subject($custom_subject = '')
-    {
-        if (! empty($custom_subject)) {
-            return $custom_subject;
-        }
-        $this->queue->get_message_repository()->rewind();
-        $count_of_items = $this->queue->get_message_repository()->count();
+	/**
+	 * Return a subject string to use for `MSG_Subject` in the aggregate EE_Message object.
+	 * @param string $custom_subject
+	 *
+	 * @return string
+	 */
+	protected function _get_subject($custom_subject = '')
+	{
+		if (! empty($custom_subject)) {
+			return $custom_subject;
+		}
+		$this->queue->get_message_repository()->rewind();
+		$count_of_items = $this->queue->get_message_repository()->count();
 
-        // if $count of items in queue == 1, then let's just return the subject for that item.
-        if ($count_of_items === 1) {
-            return $this->queue->get_message_repository()->current()->subject();
-        }
-        // phpcs:disable WordPress.WP.I18n.MissingSingularPlaceholder
-        return sprintf(
-            _n(
-                'Showing Aggregate output for 1 result',
-                'Showing Aggregate output for %d items',
-                $count_of_items,
-                'event_espresso'
-            ),
-            $count_of_items
-        );
-        // phpcs:enable
-    }
+		// if $count of items in queue == 1, then let's just return the subject for that item.
+		if ($count_of_items === 1) {
+			return $this->queue->get_message_repository()->current()->subject();
+		}
+		// phpcs:disable WordPress.WP.I18n.MissingSingularPlaceholder
+		return sprintf(
+			_n(
+				'Showing Aggregate output for 1 result',
+				'Showing Aggregate output for %d items',
+				$count_of_items,
+				'event_espresso'
+			),
+			$count_of_items
+		);
+		// phpcs:enable
+	}
 
 
-    /**
-     * Uses the EE_Messages_Queue currently set on this object to set the GRP_ID
-     * for the single EE_Message aggregate object returned by get_EE_Message
-     * @return int;
-     */
-    protected function getGroupIdFromMessageRepo()
-    {
-        $this->queue->get_message_repository()->rewind();
-        if ($this->queue->get_message_repository()->valid()) {
-            return $this->queue->get_message_repository()->current()->GRP_ID();
-        }
-    }
+	/**
+	 * Uses the EE_Messages_Queue currently set on this object to set the GRP_ID
+	 * for the single EE_Message aggregate object returned by get_EE_Message
+	 * @return int;
+	 */
+	protected function getGroupIdFromMessageRepo()
+	{
+		$this->queue->get_message_repository()->rewind();
+		if ($this->queue->get_message_repository()->valid()) {
+			return $this->queue->get_message_repository()->current()->GRP_ID();
+		}
+	}
 }

core/libraries/shortcodes/EE_Line_Item_List_Shortcodes.lib.php

Spacing +10 added lines, -10 removed lines

@@ -74,7 +74,7 @@ 
     {
         $this->_validate_list_requirements();
 
-        if (! $this->_data['data'] instanceof EE_Ticket) {
+        if ( ! $this->_data['data'] instanceof EE_Ticket) {
             return '';
         }
 
@@ -85,10 +85,10 @@ 
         $addressee_obj = $this->_extra_data['data'];
 
         // made it here so we have an EE_Ticket, so we should have what we need.
-        $ticket_line_item = isset($addressee_obj->tickets[ $ticket->ID() ]['line_item'])
-            ? $addressee_obj->tickets[ $ticket->ID() ]['line_item'] : null;
-        $sub_line_items = isset($addressee_obj->tickets[ $ticket->ID() ]['sub_line_items'])
-            ? $addressee_obj->tickets[ $ticket->ID() ]['sub_line_items'] : array();
+        $ticket_line_item = isset($addressee_obj->tickets[$ticket->ID()]['line_item'])
+            ? $addressee_obj->tickets[$ticket->ID()]['line_item'] : null;
+        $sub_line_items = isset($addressee_obj->tickets[$ticket->ID()]['sub_line_items'])
+            ? $addressee_obj->tickets[$ticket->ID()]['sub_line_items'] : array();
 
         $template = count($sub_line_items) < 2 ? $templates['ticket_line_item_no_pms']
             : $templates['ticket_line_item_pms'];
@@ -119,7 +119,7 @@ 
 
         $this->_validate_list_requirements();
 
-        if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
+        if ( ! $this->_data['data'] instanceof EE_Messages_Addressee) {
             return '';
         }
 
@@ -153,7 +153,7 @@ 
 
         $this->_validate_list_requirements();
 
-        if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
+        if ( ! $this->_data['data'] instanceof EE_Messages_Addressee) {
             return '';
         }
 
@@ -189,7 +189,7 @@ 
     {
         $this->_validate_list_requirements();
 
-        if (! $this->_data['data'] instanceof EE_Line_Item) {
+        if ( ! $this->_data['data'] instanceof EE_Line_Item) {
             return '';
         }
 
@@ -202,8 +202,8 @@ 
 
         $main_line_item_id = $main_line_item->ID();
 
-        $price_mod_line_items = ! empty($addressee_obj->line_items_with_children[ $main_line_item_id ]['children'])
-            ? $addressee_obj->line_items_with_children[ $main_line_item_id ]['children'] : array();
+        $price_mod_line_items = ! empty($addressee_obj->line_items_with_children[$main_line_item_id]['children'])
+            ? $addressee_obj->line_items_with_children[$main_line_item_id]['children'] : array();
 
         $line_item_list = '';
 

Indentation +198 added lines, -198 removed lines

@@ -20,202 +20,202 @@
 {
 
 
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Line Item List Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to line item lists', 'event_espresso');
-        $this->_shortcodes = array(
-            '[TICKET_LINE_ITEM_LIST]'         => esc_html__('Outputs a list of ticket line items.', 'event_espresso'),
-            '[TAX_LINE_ITEM_LIST]'            => esc_html__('Outputs a list of tax line items.', 'event_espresso'),
-            '[ADDITIONAL_LINE_ITEM_LIST]'     => esc_html__(
-                'Outputs a list of additional line items (other charges or discounts)',
-                'event_espresso'
-            ),
-            '[PRICE_MODIFIER_LINE_ITEM_LIST]' => esc_html__('Outputs a list of price modifier line items', 'event_espresso'),
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-
-        switch ($shortcode) {
-            case '[TICKET_LINE_ITEM_LIST]':
-                return $this->_get_ticket_line_item_list();
-                break;
-
-            case '[TAX_LINE_ITEM_LIST]':
-                return $this->_get_tax_line_item_list();
-                break;
-
-            case '[PRICE_MODIFIER_LINE_ITEM_LIST]':
-                return $this->_get_price_mod_line_item_list();
-                break;
-
-            case '[ADDITIONAL_LINE_ITEM_LIST]':
-                return $this->_get_additional_line_item_list();
-                break;
-
-            default:
-                return '';
-                break;
-        }
-    }
-
-
-    /**
-     * verify incoming data contains what is needed for retrieving and parsing each ticket line item for an event.
-     *
-     * @since 4.5.0
-     *
-     * @return string parsed ticket line item list.
-     */
-    private function _get_ticket_line_item_list()
-    {
-        $this->_validate_list_requirements();
-
-        if (! $this->_data['data'] instanceof EE_Ticket) {
-            return '';
-        }
-
-        $valid_shortcodes = array('line_item', 'line_item_list', 'ticket');
-
-        $ticket = $this->_data['data'];
-        $templates = $this->_extra_data['template'];
-        $addressee_obj = $this->_extra_data['data'];
-
-        // made it here so we have an EE_Ticket, so we should have what we need.
-        $ticket_line_item = isset($addressee_obj->tickets[ $ticket->ID() ]['line_item'])
-            ? $addressee_obj->tickets[ $ticket->ID() ]['line_item'] : null;
-        $sub_line_items = isset($addressee_obj->tickets[ $ticket->ID() ]['sub_line_items'])
-            ? $addressee_obj->tickets[ $ticket->ID() ]['sub_line_items'] : array();
-
-        $template = count($sub_line_items) < 2 ? $templates['ticket_line_item_no_pms']
-            : $templates['ticket_line_item_pms'];
-
-        if (empty($ticket_line_item) || empty($sub_line_items)) {
-            return '';
-        }
-
-        // now we just return the appropriate template parsed for each ticket.
-        return $this->_shortcode_helper->parse_line_item_list_template(
-            $template,
-            $ticket_line_item,
-            $valid_shortcodes,
-            $this->_extra_data
-        );
-    }
-
-
-    /**
-     * Verify incoming data contains what is needed for retrieving and parsing each tax line item for a transaction.
-     *
-     * @since 4.5.0
-     *
-     * @return string  parsed tax line item list.
-     */
-    private function _get_tax_line_item_list()
-    {
-
-        $this->_validate_list_requirements();
-
-        if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
-            return '';
-        }
-
-        // made it here so we're good to go.
-        $valid_shortcodes = array('line_item');
-        $templates = $this->_data['template'];
-
-        $tax_line_items = $this->_data['data']->tax_line_items;
-        $line_item_list = '';
-        foreach ($tax_line_items as $line_item) {
-            $line_item_list .= $this->_shortcode_helper->parse_line_item_list_template(
-                $templates['tax_line_item_list'],
-                $line_item,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $line_item_list;
-    }
-
-    /**
-     * Verify incoming data contains what is needed for retrieving and parsing each other line item for a transaction.
-     *
-     * @since 4.5.0
-     *
-     * @return string  parsed other line item list.
-     */
-    private function _get_additional_line_item_list()
-    {
-
-        $this->_validate_list_requirements();
-
-        if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
-            return '';
-        }
-
-        // made it here so we're good to go.
-        $valid_shortcodes = array('line_item');
-        $templates = $this->_data['template'];
-
-        $additional_line_items = $this->_data['data']->additional_line_items;
-        $line_item_list = '';
-        foreach ($additional_line_items as $line_item) {
-            $line_item_list .= $this->_shortcode_helper->parse_line_item_list_template(
-                $templates['additional_line_item_list'],
-                $line_item,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-
-        return $line_item_list;
-    }
-
-
-    /**
-     * Verify incoming data contains what is needed for retrieving and parsing each price modifier line item for a
-     * parent ticket line item.
-     *
-     * @since 4.5.0
-     *
-     * @return string parsed price modifier line item list.
-     */
-    private function _get_price_mod_line_item_list()
-    {
-        $this->_validate_list_requirements();
-
-        if (! $this->_data['data'] instanceof EE_Line_Item) {
-            return '';
-        }
-
-        // made it here so we're good to go.
-        $main_line_item = $this->_data['data'];
-        $templates = $this->_extra_data['template'];
-        $addressee_obj = $this->_extra_data['data'];
-
-        $valid_shortcodes = array('line_item');
-
-        $main_line_item_id = $main_line_item->ID();
-
-        $price_mod_line_items = ! empty($addressee_obj->line_items_with_children[ $main_line_item_id ]['children'])
-            ? $addressee_obj->line_items_with_children[ $main_line_item_id ]['children'] : array();
-
-        $line_item_list = '';
-
-        foreach ($price_mod_line_items as $line_item) {
-            $line_item_list .= $this->_shortcode_helper->parse_line_item_list_template(
-                $templates['price_modifier_line_item_list'],
-                $line_item,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $line_item_list;
-    }
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Line Item List Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to line item lists', 'event_espresso');
+		$this->_shortcodes = array(
+			'[TICKET_LINE_ITEM_LIST]'         => esc_html__('Outputs a list of ticket line items.', 'event_espresso'),
+			'[TAX_LINE_ITEM_LIST]'            => esc_html__('Outputs a list of tax line items.', 'event_espresso'),
+			'[ADDITIONAL_LINE_ITEM_LIST]'     => esc_html__(
+				'Outputs a list of additional line items (other charges or discounts)',
+				'event_espresso'
+			),
+			'[PRICE_MODIFIER_LINE_ITEM_LIST]' => esc_html__('Outputs a list of price modifier line items', 'event_espresso'),
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+
+		switch ($shortcode) {
+			case '[TICKET_LINE_ITEM_LIST]':
+				return $this->_get_ticket_line_item_list();
+				break;
+
+			case '[TAX_LINE_ITEM_LIST]':
+				return $this->_get_tax_line_item_list();
+				break;
+
+			case '[PRICE_MODIFIER_LINE_ITEM_LIST]':
+				return $this->_get_price_mod_line_item_list();
+				break;
+
+			case '[ADDITIONAL_LINE_ITEM_LIST]':
+				return $this->_get_additional_line_item_list();
+				break;
+
+			default:
+				return '';
+				break;
+		}
+	}
+
+
+	/**
+	 * verify incoming data contains what is needed for retrieving and parsing each ticket line item for an event.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string parsed ticket line item list.
+	 */
+	private function _get_ticket_line_item_list()
+	{
+		$this->_validate_list_requirements();
+
+		if (! $this->_data['data'] instanceof EE_Ticket) {
+			return '';
+		}
+
+		$valid_shortcodes = array('line_item', 'line_item_list', 'ticket');
+
+		$ticket = $this->_data['data'];
+		$templates = $this->_extra_data['template'];
+		$addressee_obj = $this->_extra_data['data'];
+
+		// made it here so we have an EE_Ticket, so we should have what we need.
+		$ticket_line_item = isset($addressee_obj->tickets[ $ticket->ID() ]['line_item'])
+			? $addressee_obj->tickets[ $ticket->ID() ]['line_item'] : null;
+		$sub_line_items = isset($addressee_obj->tickets[ $ticket->ID() ]['sub_line_items'])
+			? $addressee_obj->tickets[ $ticket->ID() ]['sub_line_items'] : array();
+
+		$template = count($sub_line_items) < 2 ? $templates['ticket_line_item_no_pms']
+			: $templates['ticket_line_item_pms'];
+
+		if (empty($ticket_line_item) || empty($sub_line_items)) {
+			return '';
+		}
+
+		// now we just return the appropriate template parsed for each ticket.
+		return $this->_shortcode_helper->parse_line_item_list_template(
+			$template,
+			$ticket_line_item,
+			$valid_shortcodes,
+			$this->_extra_data
+		);
+	}
+
+
+	/**
+	 * Verify incoming data contains what is needed for retrieving and parsing each tax line item for a transaction.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string  parsed tax line item list.
+	 */
+	private function _get_tax_line_item_list()
+	{
+
+		$this->_validate_list_requirements();
+
+		if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
+			return '';
+		}
+
+		// made it here so we're good to go.
+		$valid_shortcodes = array('line_item');
+		$templates = $this->_data['template'];
+
+		$tax_line_items = $this->_data['data']->tax_line_items;
+		$line_item_list = '';
+		foreach ($tax_line_items as $line_item) {
+			$line_item_list .= $this->_shortcode_helper->parse_line_item_list_template(
+				$templates['tax_line_item_list'],
+				$line_item,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $line_item_list;
+	}
+
+	/**
+	 * Verify incoming data contains what is needed for retrieving and parsing each other line item for a transaction.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string  parsed other line item list.
+	 */
+	private function _get_additional_line_item_list()
+	{
+
+		$this->_validate_list_requirements();
+
+		if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
+			return '';
+		}
+
+		// made it here so we're good to go.
+		$valid_shortcodes = array('line_item');
+		$templates = $this->_data['template'];
+
+		$additional_line_items = $this->_data['data']->additional_line_items;
+		$line_item_list = '';
+		foreach ($additional_line_items as $line_item) {
+			$line_item_list .= $this->_shortcode_helper->parse_line_item_list_template(
+				$templates['additional_line_item_list'],
+				$line_item,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+
+		return $line_item_list;
+	}
+
+
+	/**
+	 * Verify incoming data contains what is needed for retrieving and parsing each price modifier line item for a
+	 * parent ticket line item.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string parsed price modifier line item list.
+	 */
+	private function _get_price_mod_line_item_list()
+	{
+		$this->_validate_list_requirements();
+
+		if (! $this->_data['data'] instanceof EE_Line_Item) {
+			return '';
+		}
+
+		// made it here so we're good to go.
+		$main_line_item = $this->_data['data'];
+		$templates = $this->_extra_data['template'];
+		$addressee_obj = $this->_extra_data['data'];
+
+		$valid_shortcodes = array('line_item');
+
+		$main_line_item_id = $main_line_item->ID();
+
+		$price_mod_line_items = ! empty($addressee_obj->line_items_with_children[ $main_line_item_id ]['children'])
+			? $addressee_obj->line_items_with_children[ $main_line_item_id ]['children'] : array();
+
+		$line_item_list = '';
+
+		foreach ($price_mod_line_items as $line_item) {
+			$line_item_list .= $this->_shortcode_helper->parse_line_item_list_template(
+				$templates['price_modifier_line_item_list'],
+				$line_item,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $line_item_list;
+	}
 }

core/libraries/shortcodes/EE_Line_Item_Shortcodes.lib.php

Spacing +2 added lines, -2 removed lines

@@ -42,7 +42,7 @@ 
     protected function _parser($shortcode)
     {
         // ensure that the incoming object IS a line item.  If it isn't then bail early.
-        if (! $this->_data instanceof EE_Line_Item) {
+        if ( ! $this->_data instanceof EE_Line_Item) {
             return '';
         }
 
@@ -62,7 +62,7 @@ 
                 break;
 
             case '[LINE_ITEM_AMOUNT]':
-                return $line_item->is_percent() ? $line_item->percent() . '%' : $line_item->unit_price_no_code();
+                return $line_item->is_percent() ? $line_item->percent().'%' : $line_item->unit_price_no_code();
                 break;
 
             case '[LINE_ITEM_TOTAL]':

Indentation +51 added lines, -51 removed lines

@@ -18,65 +18,65 @@
 {
 
 
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Line Item Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to line items', 'event_espresso');
-        $this->_shortcodes = array(
-            '[LINE_ITEM_NAME]' => esc_html__('Outputs the line item name.', 'event_espresso'),
-            '[LINE_ITEM_DESCRIPTION]' => esc_html__('Outputs a the description for the line item.', 'event_espresso'),
-            '[LINE_ITEM_QUANTITY]' => esc_html__('Outputs the quantity for this line item.', 'event_espresso'),
-            '[LINE_ITEM_AMOUNT]' => esc_html__(
-                'This will either output the unit price for a line item if its not a percent, or the percent of the line item (if it is percent).',
-                'event_espresso'
-            ),
-            '[LINE_ITEM_TOTAL]' => esc_html__('This outputs the line item total.', 'event_espresso'),
-            '[LINE_ITEM_TAXABLE_*]' => esc_html__(
-                'This attribute type shortcode allows users to indicate what to output if a line item is taxable or not.  One can use the key "symbol=" with the shortcode to indicate what they\'d like to represent a taxable line item.  So doing something like <code>[LINE_ITEM_TAXABLE_* symbol="*"]</code> means that when the line item is parsed, if it\'s taxable the "*" symbol will be returned.  The default symbol if no attribute is included is the "*" symbol.',
-                'event_espresso'
-            ),
-        );
-    }
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Line Item Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to line items', 'event_espresso');
+		$this->_shortcodes = array(
+			'[LINE_ITEM_NAME]' => esc_html__('Outputs the line item name.', 'event_espresso'),
+			'[LINE_ITEM_DESCRIPTION]' => esc_html__('Outputs a the description for the line item.', 'event_espresso'),
+			'[LINE_ITEM_QUANTITY]' => esc_html__('Outputs the quantity for this line item.', 'event_espresso'),
+			'[LINE_ITEM_AMOUNT]' => esc_html__(
+				'This will either output the unit price for a line item if its not a percent, or the percent of the line item (if it is percent).',
+				'event_espresso'
+			),
+			'[LINE_ITEM_TOTAL]' => esc_html__('This outputs the line item total.', 'event_espresso'),
+			'[LINE_ITEM_TAXABLE_*]' => esc_html__(
+				'This attribute type shortcode allows users to indicate what to output if a line item is taxable or not.  One can use the key "symbol=" with the shortcode to indicate what they\'d like to represent a taxable line item.  So doing something like <code>[LINE_ITEM_TAXABLE_* symbol="*"]</code> means that when the line item is parsed, if it\'s taxable the "*" symbol will be returned.  The default symbol if no attribute is included is the "*" symbol.',
+				'event_espresso'
+			),
+		);
+	}
 
 
-    protected function _parser($shortcode)
-    {
-        // ensure that the incoming object IS a line item.  If it isn't then bail early.
-        if (! $this->_data instanceof EE_Line_Item) {
-            return '';
-        }
+	protected function _parser($shortcode)
+	{
+		// ensure that the incoming object IS a line item.  If it isn't then bail early.
+		if (! $this->_data instanceof EE_Line_Item) {
+			return '';
+		}
 
-        $line_item = $this->_data;
+		$line_item = $this->_data;
 
-        switch ($shortcode) {
-            case '[LINE_ITEM_NAME]':
-                return $line_item->name();
-                break;
+		switch ($shortcode) {
+			case '[LINE_ITEM_NAME]':
+				return $line_item->name();
+				break;
 
-            case '[LINE_ITEM_DESCRIPTION]':
-                return $line_item->desc();
-                break;
+			case '[LINE_ITEM_DESCRIPTION]':
+				return $line_item->desc();
+				break;
 
-            case '[LINE_ITEM_QUANTITY]':
-                return $line_item->quantity();
-                break;
+			case '[LINE_ITEM_QUANTITY]':
+				return $line_item->quantity();
+				break;
 
-            case '[LINE_ITEM_AMOUNT]':
-                return $line_item->is_percent() ? $line_item->percent() . '%' : $line_item->unit_price_no_code();
-                break;
+			case '[LINE_ITEM_AMOUNT]':
+				return $line_item->is_percent() ? $line_item->percent() . '%' : $line_item->unit_price_no_code();
+				break;
 
-            case '[LINE_ITEM_TOTAL]':
-                return $line_item->total_no_code();
-                break;
-        }
+			case '[LINE_ITEM_TOTAL]':
+				return $line_item->total_no_code();
+				break;
+		}
 
-        if (strpos($shortcode, '[LINE_ITEM_TAXABLE_*') !== false) {
-            $attrs = $this->_get_shortcode_attrs($shortcode);
-            if ($line_item->is_taxable()) {
-                return ! empty($attrs['symbol']) ? $attrs['symbol'] : '*';
-            }
-        }
+		if (strpos($shortcode, '[LINE_ITEM_TAXABLE_*') !== false) {
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+			if ($line_item->is_taxable()) {
+				return ! empty($attrs['symbol']) ? $attrs['symbol'] : '*';
+			}
+		}
 
-        return '';
-    }
+		return '';
+	}
 }

core/libraries/shortcodes/EE_Datetime_Shortcodes.lib.php

Spacing +2 added lines, -2 removed lines

@@ -54,7 +54,7 @@ 
     protected function _parser($shortcode)
     {
 
-        if (! $this->_data instanceof EE_Datetime) {
+        if ( ! $this->_data instanceof EE_Datetime) {
             return ''; // get out cause we can only parse with the datetime object.
         }
 
@@ -92,7 +92,7 @@ 
 
             $URL = add_query_arg(array('ee' => 'download_ics_file', 'ics_id' => $this->_data->ID()), site_url());
 
-            return '<a class="ee-ical" href="' . $URL . '">' . $link_text . '</a>';
+            return '<a class="ee-ical" href="'.$URL.'">'.$link_text.'</a>';
         }
 
         return '';

Indentation +68 added lines, -68 removed lines

@@ -18,83 +18,83 @@
 class EE_Datetime_Shortcodes extends EE_Shortcodes
 {
 
-    /**
-     * _init_props
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Datetime Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to datetime related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[DATETIME_START]' => esc_html__('The start date and time.', 'event_espresso'),
-            '[DATETIME_END]' => esc_html__('The end date and time.', 'event_espresso'),
-            '[DATETIME_TIMEZONE]' => esc_html__('The timezone for the date and time', 'event_espresso'),
-            '[DATE_START]' => esc_html__('The datetime start date.', 'event_espresso'),
-            '[DATE_END]' => esc_html__('The datetime end date.', 'event_espresso'),
-            '[TIME_START]' => esc_html__('The datetime start time.', 'event_espresso'),
-            '[TIME_END]' => esc_html__('The datetime end time.', 'event_espresso'),
-            '[ICAL_LINK_*]' => esc_html__(
-                'The datetime iCal link. The optional "link_text" attribute can be used to set custom text within the link (Default is "Add to iCal Calendar").',
-                'event_espresso'
-            ),
-        );
-    }
+	/**
+	 * _init_props
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Datetime Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to datetime related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[DATETIME_START]' => esc_html__('The start date and time.', 'event_espresso'),
+			'[DATETIME_END]' => esc_html__('The end date and time.', 'event_espresso'),
+			'[DATETIME_TIMEZONE]' => esc_html__('The timezone for the date and time', 'event_espresso'),
+			'[DATE_START]' => esc_html__('The datetime start date.', 'event_espresso'),
+			'[DATE_END]' => esc_html__('The datetime end date.', 'event_espresso'),
+			'[TIME_START]' => esc_html__('The datetime start time.', 'event_espresso'),
+			'[TIME_END]' => esc_html__('The datetime end time.', 'event_espresso'),
+			'[ICAL_LINK_*]' => esc_html__(
+				'The datetime iCal link. The optional "link_text" attribute can be used to set custom text within the link (Default is "Add to iCal Calendar").',
+				'event_espresso'
+			),
+		);
+	}
 
 
-    /**
-     * _parser
-     *
-     * @access protected
-     * @param string $shortcode
-     * @return string
-     */
-    protected function _parser($shortcode)
-    {
+	/**
+	 * _parser
+	 *
+	 * @access protected
+	 * @param string $shortcode
+	 * @return string
+	 */
+	protected function _parser($shortcode)
+	{
 
-        if (! $this->_data instanceof EE_Datetime) {
-            return ''; // get out cause we can only parse with the datetime object.
-        }
+		if (! $this->_data instanceof EE_Datetime) {
+			return ''; // get out cause we can only parse with the datetime object.
+		}
 
-        switch ($shortcode) {
-            case '[DATETIME_START]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_start');
-                break;
+		switch ($shortcode) {
+			case '[DATETIME_START]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_start');
+				break;
 
-            case '[DATETIME_END]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_end');
-                break;
+			case '[DATETIME_END]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_end');
+				break;
 
-            case '[DATETIME_TIMEZONE]':
-                return $this->_data->get_timezone();
-                break;
-            case '[DATE_START]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('date_format'));
-                break;
-            case '[DATE_END]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('date_format'));
-                break;
-            case '[TIME_START]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('time_format'));
-                break;
-            case '[TIME_END]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('time_format'));
-                break;
-        }
+			case '[DATETIME_TIMEZONE]':
+				return $this->_data->get_timezone();
+				break;
+			case '[DATE_START]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('date_format'));
+				break;
+			case '[DATE_END]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('date_format'));
+				break;
+			case '[TIME_START]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('time_format'));
+				break;
+			case '[TIME_END]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('time_format'));
+				break;
+		}
 
-        if (strpos($shortcode, '[ICAL_LINK_*') !== false) {
-            $attrs = $this->_get_shortcode_attrs($shortcode);
+		if (strpos($shortcode, '[ICAL_LINK_*') !== false) {
+			$attrs = $this->_get_shortcode_attrs($shortcode);
 
-            $link_text = empty($attrs['link_text']) ? esc_html__('Add to iCal Calendar', 'event_espresso')
-                : $attrs['link_text'];
+			$link_text = empty($attrs['link_text']) ? esc_html__('Add to iCal Calendar', 'event_espresso')
+				: $attrs['link_text'];
 
-            $URL = add_query_arg(array('ee' => 'download_ics_file', 'ics_id' => $this->_data->ID()), site_url());
+			$URL = add_query_arg(array('ee' => 'download_ics_file', 'ics_id' => $this->_data->ID()), site_url());
 
-            return '<a class="ee-ical" href="' . $URL . '">' . $link_text . '</a>';
-        }
+			return '<a class="ee-ical" href="' . $URL . '">' . $link_text . '</a>';
+		}
 
-        return '';
-    }
+		return '';
+	}
 }

core/libraries/shortcodes/EE_Transaction_Shortcodes.lib.php

Indentation +775 added lines, -775 removed lines

@@ -17,783 +17,783 @@
 class EE_Transaction_Shortcodes extends EE_Shortcodes
 {
 
-    /**
-     * @var EE_Payment_Method $_invoice_pm the invoice payment method for use in invoices etc
-     */
-    protected $_invoice_pm;
-
-
-    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 = array(
-            '[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',
-                'event_espresso'
-            ),
-            '[INVOICE_URL]'                     => esc_html__(
-                'This is just the url for the invoice',
-                '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',
-                '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;
-        // 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;
-        if (! $transaction instanceof EE_Transaction) {
-            return '';
-        }
-        switch ($shortcode) {
-            case '[TXN_ID]':
-                return $transaction->ID();
-                break;
-            case '[PAYMENT_URL]':
-                $payment_url = $transaction->payment_overview_url();
-                return empty($payment_url)
-                    ? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
-                    : $payment_url;
-                break;
-            case '[INVOICE_LINK]':
-                $invoice_url = $transaction->invoice_url();
-                $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>'
-                );
-                break;
-            case '[INVOICE_URL]':
-                $invoice_url = $transaction->invoice_url();
-                return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
-                break;
-            case '[INVOICE_LOGO_URL]':
-                return $this->_get_invoice_logo();
-                break;
-            case '[INVOICE_LOGO]':
-                return $this->_get_invoice_logo(true);
-                break;
-            case '[INVOICE_PAYEE_NAME]':
-                return $this->_get_invoice_payee_name();
-                break;
-            case '[INVOICE_PAYEE_ADDRESS]':
-                return $this->_get_invoice_payee_address();
-                break;
-            case '[INVOICE_PAYMENT_INSTRUCTIONS]':
-                return $this->_get_invoice_payment_instructions();
-                break;
-            case '[INVOICE_PAYEE_EMAIL]':
-                return $this->_get_invoice_payee_email();
-                break;
-            case '[TOTAL_COST]':
-                $total = $transaction->total();
-                return ! empty($total) ? EEH_Template::format_currency($total) : '';
-                break;
-            case '[PAYMENT_STATUS]':
-                $status = $transaction->pretty_status();
-                return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
-                break; /**/
-            // 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 '[TXN_STATUS]':
-                $status = $transaction->pretty_status();
-                return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
-                break;
-            case '[TXN_STATUS_ID]':
-                return $transaction->status_ID();
-                break;
-            case '[PAYMENT_GATEWAY]':
-                return $this->_get_payment_gateway($transaction);
-                break;
-            case '[AMOUNT_PAID]':
-                return $payment instanceof EE_Payment
-                    ? EEH_Template::format_currency($payment->amount())
-                    : EEH_Template::format_currency(0);
-                break;
-            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());
-                break;
-            case '[TOTAL_OWING]':
-                $total_owing = $transaction->remaining();
-                return EEH_Template::format_currency($total_owing);
-                break;
-            case '[TXN_SUBTOTAL]':
-                return EEH_Template::format_currency($this->_get_subtotal());
-                break;
-            case '[TXN_TAX_SUBTOTAL]':
-                return EEH_Template::format_currency($this->_get_subtotal(true));
-                break;
-            case '[TKT_QTY_PURCHASED]':
-            case '[TXN_TOTAL_TICKETS]':
-                return $this->_data->total_ticket_count;
-                break;
-            case '[TRANSACTION_ADMIN_URL]':
-                require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
-                $query_args = array(
-                    'page'   => 'espresso_transactions',
-                    'action' => 'view_transaction',
-                    'TXN_ID' => $transaction->ID(),
-                );
-                $url = EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
-                return $url;
-                break;
-            case '[RECEIPT_URL]':
-                // get primary_registration
-                $reg = $this->_data->primary_reg_obj;
-                if (! $reg instanceof EE_Registration) {
-                    return '';
-                }
-                return $reg->receipt_url();
-                break;
-            case '[INVOICE_RECEIPT_SWITCHER_URL]':
-                return $this->_get_invoice_receipt_switcher(false);
-                break;
-            case '[INVOICE_RECEIPT_SWITCHER_BUTTON]':
-                return $this->_get_invoice_receipt_switcher();
-                break;
-            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;
-                break;
-        }
-        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
-     *
-     * @since 4.5.0
-     * @param string $shortcode the incoming shortcode
-     * @return string parsed.
-     * @throws EE_Error
-     */
-    private function _get_custom_total_owing($shortcode)
-    {
-        $valid_shortcodes = array('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
-     */
-    private function _get_payment_gateway($transaction)
-    {
-        if ($transaction instanceof EE_Transaction) {
-            $pm = $transaction->payment_method();
-        } else {
-            $pm = null;
-        }
-        return $pm instanceof EE_Payment_Method ? $pm->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).
-     *
-     * @since 4.5.0
-     * @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
-     */
-    private function _get_invoice_logo($img_tags = false)
-    {
-        $invoice_logo_url = '';
-        // try to get the invoice payment method's logo for this transaction image first
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $invoice_logo_url = $pm->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;
-        }
-        // image tags have been requested.
-        $image_size = getimagesize($invoice_logo_url);
-        // if image is wider than 300px, set the width to 300
-        if ($image_size[0] > 300) {
-            $image_width = 300;
-        } else {
-            $image_width = $image_size[0];
-        }
-        return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />';
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee name shortcode
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_name()
-    {
-        $payee_name = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_name = $pm->get_extra_meta('pdf_payee_name', true);
-        }
-        $payee_name = empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name;
-        return $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
-     */
-    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
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_email()
-    {
-        $payee_email = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_email = $pm->get_extra_meta('pdf_payee_email', true);
-        }
-        $payee_email = empty($payee_email) ? EE_Registry::instance()->CFG->organization->get_pretty('email')
-            : $payee_email;
-        return $payee_email;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee tax number shortcode
-     *
-     * @since 4.5.0
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_tax_number($shortcode)
-    {
-        $payee_tax_number = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_tax_number = $pm->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 = isset($attrs['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.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_address()
-    {
-        $payee_address = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_address = $pm->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.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payment_instructions()
-    {
-        $instructions = null;
-        $pm = $this->_get_invoice_payment_method();
-        return ($pm instanceof EE_Payment_Method) ? $pm->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
-     * @throws EE_Error
-     */
-    protected function _get_invoice_receipt_switcher($button = true)
-    {
-        $reg = $this->_data->primary_reg_obj;
-        $message_type = isset($this->_extra_data['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 ? true : false;
-        $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 $_invoice_pm the invoice payment method for use in invoices etc
+	 */
+	protected $_invoice_pm;
+
+
+	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 = array(
+			'[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',
+				'event_espresso'
+			),
+			'[INVOICE_URL]'                     => esc_html__(
+				'This is just the url for the invoice',
+				'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',
+				'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;
+		// 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;
+		if (! $transaction instanceof EE_Transaction) {
+			return '';
+		}
+		switch ($shortcode) {
+			case '[TXN_ID]':
+				return $transaction->ID();
+				break;
+			case '[PAYMENT_URL]':
+				$payment_url = $transaction->payment_overview_url();
+				return empty($payment_url)
+					? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
+					: $payment_url;
+				break;
+			case '[INVOICE_LINK]':
+				$invoice_url = $transaction->invoice_url();
+				$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>'
+				);
+				break;
+			case '[INVOICE_URL]':
+				$invoice_url = $transaction->invoice_url();
+				return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
+				break;
+			case '[INVOICE_LOGO_URL]':
+				return $this->_get_invoice_logo();
+				break;
+			case '[INVOICE_LOGO]':
+				return $this->_get_invoice_logo(true);
+				break;
+			case '[INVOICE_PAYEE_NAME]':
+				return $this->_get_invoice_payee_name();
+				break;
+			case '[INVOICE_PAYEE_ADDRESS]':
+				return $this->_get_invoice_payee_address();
+				break;
+			case '[INVOICE_PAYMENT_INSTRUCTIONS]':
+				return $this->_get_invoice_payment_instructions();
+				break;
+			case '[INVOICE_PAYEE_EMAIL]':
+				return $this->_get_invoice_payee_email();
+				break;
+			case '[TOTAL_COST]':
+				$total = $transaction->total();
+				return ! empty($total) ? EEH_Template::format_currency($total) : '';
+				break;
+			case '[PAYMENT_STATUS]':
+				$status = $transaction->pretty_status();
+				return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
+				break; /**/
+			// 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 '[TXN_STATUS]':
+				$status = $transaction->pretty_status();
+				return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
+				break;
+			case '[TXN_STATUS_ID]':
+				return $transaction->status_ID();
+				break;
+			case '[PAYMENT_GATEWAY]':
+				return $this->_get_payment_gateway($transaction);
+				break;
+			case '[AMOUNT_PAID]':
+				return $payment instanceof EE_Payment
+					? EEH_Template::format_currency($payment->amount())
+					: EEH_Template::format_currency(0);
+				break;
+			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());
+				break;
+			case '[TOTAL_OWING]':
+				$total_owing = $transaction->remaining();
+				return EEH_Template::format_currency($total_owing);
+				break;
+			case '[TXN_SUBTOTAL]':
+				return EEH_Template::format_currency($this->_get_subtotal());
+				break;
+			case '[TXN_TAX_SUBTOTAL]':
+				return EEH_Template::format_currency($this->_get_subtotal(true));
+				break;
+			case '[TKT_QTY_PURCHASED]':
+			case '[TXN_TOTAL_TICKETS]':
+				return $this->_data->total_ticket_count;
+				break;
+			case '[TRANSACTION_ADMIN_URL]':
+				require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
+				$query_args = array(
+					'page'   => 'espresso_transactions',
+					'action' => 'view_transaction',
+					'TXN_ID' => $transaction->ID(),
+				);
+				$url = EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
+				return $url;
+				break;
+			case '[RECEIPT_URL]':
+				// get primary_registration
+				$reg = $this->_data->primary_reg_obj;
+				if (! $reg instanceof EE_Registration) {
+					return '';
+				}
+				return $reg->receipt_url();
+				break;
+			case '[INVOICE_RECEIPT_SWITCHER_URL]':
+				return $this->_get_invoice_receipt_switcher(false);
+				break;
+			case '[INVOICE_RECEIPT_SWITCHER_BUTTON]':
+				return $this->_get_invoice_receipt_switcher();
+				break;
+			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;
+				break;
+		}
+		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
+	 *
+	 * @since 4.5.0
+	 * @param string $shortcode the incoming shortcode
+	 * @return string parsed.
+	 * @throws EE_Error
+	 */
+	private function _get_custom_total_owing($shortcode)
+	{
+		$valid_shortcodes = array('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
+	 */
+	private function _get_payment_gateway($transaction)
+	{
+		if ($transaction instanceof EE_Transaction) {
+			$pm = $transaction->payment_method();
+		} else {
+			$pm = null;
+		}
+		return $pm instanceof EE_Payment_Method ? $pm->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).
+	 *
+	 * @since 4.5.0
+	 * @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
+	 */
+	private function _get_invoice_logo($img_tags = false)
+	{
+		$invoice_logo_url = '';
+		// try to get the invoice payment method's logo for this transaction image first
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$invoice_logo_url = $pm->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;
+		}
+		// image tags have been requested.
+		$image_size = getimagesize($invoice_logo_url);
+		// if image is wider than 300px, set the width to 300
+		if ($image_size[0] > 300) {
+			$image_width = 300;
+		} else {
+			$image_width = $image_size[0];
+		}
+		return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />';
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee name shortcode
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_name()
+	{
+		$payee_name = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_name = $pm->get_extra_meta('pdf_payee_name', true);
+		}
+		$payee_name = empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name;
+		return $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
+	 */
+	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
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_email()
+	{
+		$payee_email = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_email = $pm->get_extra_meta('pdf_payee_email', true);
+		}
+		$payee_email = empty($payee_email) ? EE_Registry::instance()->CFG->organization->get_pretty('email')
+			: $payee_email;
+		return $payee_email;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee tax number shortcode
+	 *
+	 * @since 4.5.0
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_tax_number($shortcode)
+	{
+		$payee_tax_number = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_tax_number = $pm->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 = isset($attrs['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.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_address()
+	{
+		$payee_address = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_address = $pm->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.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payment_instructions()
+	{
+		$instructions = null;
+		$pm = $this->_get_invoice_payment_method();
+		return ($pm instanceof EE_Payment_Method) ? $pm->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
+	 * @throws EE_Error
+	 */
+	protected function _get_invoice_receipt_switcher($button = true)
+	{
+		$reg = $this->_data->primary_reg_obj;
+		$message_type = isset($this->_extra_data['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 ? true : false;
+		$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
-     */
-    private function _get_subtotal($tax = false)
-    {
-        $grand_total = isset($this->_data->grand_total_line_item) ? $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
-     *
-     * @since 4.7.0
-     * @param string $shortcode the incoming shortcode
-     * @return string parsed.
-     * @throws EE_Error
-     */
-    private function _get_payment_link_if_needed($shortcode)
-    {
-        $valid_shortcodes = array('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 = isset($attrs['class']) ? $attrs['class'] : 'callout';
-            $custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
-            $container_tag = isset($attrs['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
-     *
-     * @since 4.8.28.rc.011
-     * @param string         $shortcode The shortcode being parsed.
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    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 = isset($attrs['format']) ? $attrs['format'] : get_option('date_format');
-        $days_until_due = isset($attrs['days_until_due']) ? (int) $attrs['days_until_due'] : 30;
-        $prefix_text = isset($attrs['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
+	 */
+	private function _get_subtotal($tax = false)
+	{
+		$grand_total = isset($this->_data->grand_total_line_item) ? $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
+	 *
+	 * @since 4.7.0
+	 * @param string $shortcode the incoming shortcode
+	 * @return string parsed.
+	 * @throws EE_Error
+	 */
+	private function _get_payment_link_if_needed($shortcode)
+	{
+		$valid_shortcodes = array('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 = isset($attrs['class']) ? $attrs['class'] : 'callout';
+			$custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
+			$container_tag = isset($attrs['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
+	 *
+	 * @since 4.8.28.rc.011
+	 * @param string         $shortcode The shortcode being parsed.
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	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 = isset($attrs['format']) ? $attrs['format'] : get_option('date_format');
+		$days_until_due = isset($attrs['days_until_due']) ? (int) $attrs['days_until_due'] : 30;
+		$prefix_text = isset($attrs['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 +24 added lines, -24 removed lines

@@ -269,7 +269,7 @@ 
                    && isset($this->_extra_data['data'])
                    && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment
             : $payment;
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             return '';
         }
         switch ($shortcode) {
@@ -287,7 +287,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>'
                 );
                 break;
@@ -361,7 +361,7 @@ 
                 return $this->_data->total_ticket_count;
                 break;
             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 = array(
                     'page'   => 'espresso_transactions',
                     'action' => 'view_transaction',
@@ -373,7 +373,7 @@ 
             case '[RECEIPT_URL]':
                 // get primary_registration
                 $reg = $this->_data->primary_reg_obj;
-                if (! $reg instanceof EE_Registration) {
+                if ( ! $reg instanceof EE_Registration) {
                     return '';
                 }
                 return $reg->receipt_url();
@@ -492,7 +492,7 @@ 
         if (empty($invoice_logo_url)) {
             return '';
         }
-        if (! $img_tags) {
+        if ( ! $img_tags) {
             return $invoice_logo_url;
         }
         // image tags have been requested.
@@ -503,7 +503,7 @@ 
         } else {
             $image_width = $image_size[0];
         }
-        return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />';
+        return '<img class="logo screen" src="'.$invoice_logo_url.'" width="'.$image_width.'" alt="logo" />';
     }
 
 
@@ -540,7 +540,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)
@@ -608,7 +608,7 @@ 
         $attrs = $this->_get_shortcode_attrs($shortcode);
         // prefix?
         $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
-        return $prefix . $payee_tax_number;
+        return $prefix.$payee_tax_number;
     }
 
 
@@ -632,16 +632,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);
             $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;
@@ -677,7 +677,7 @@ 
     {
         $reg = $this->_data->primary_reg_obj;
         $message_type = isset($this->_extra_data['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 ? true : false;
@@ -685,13 +685,13 @@ 
             ? 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) {
+        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>
 			';
         }
@@ -709,7 +709,7 @@ 
     private function _get_subtotal($tax = false)
     {
         $grand_total = isset($this->_data->grand_total_line_item) ? $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();
@@ -736,11 +736,11 @@ 
             $class = isset($attrs['class']) ? $attrs['class'] : 'callout';
             $custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
             $container_tag = isset($attrs['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,
@@ -782,7 +782,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();
@@ -794,6 +794,6 @@ 
                 'event_espresso'
             );
         }
-        return $prefix_text . $date_due;
+        return $prefix_text.$date_due;
     }
 }

core/libraries/shortcodes/EE_Venue_Shortcodes.lib.php

Indentation +311 added lines, -311 removed lines

@@ -17,315 +17,315 @@
 {
 
 
-    /**
-     * Will hold the EE_Event if available
-     *
-     * @var EE_Event
-     */
-    protected $_event;
-
-    /**
-     * Will hold the EE_Venue if available
-     *
-     * @var EE_Venue
-     */
-    protected $_venue;
-
-
-    /**
-     * Initialize properties
-     */
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Venue Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to venue related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[VENUE_TITLE]'             => esc_html__('The title for the event venue', 'event_espresso'),
-            '[VENUE_DESCRIPTION]'       => esc_html__('The description for the event venue', 'event_espresso'),
-            '[VENUE_URL]'               => esc_html__('A url to a webpage for the venue', 'event_espresso'),
-            '[VENUE_DETAILS_URL]'       => sprintf(
-                esc_html__(
-                    'This shortcode outputs the url or website address to the venue details page on this website. This differs from %s which outputs what is entered in the "url" field in the venue details page.',
-                    'event_espresso'
-                ),
-                '[VENUE_URL]'
-            ),
-            '[VENUE_IMAGE]'             => esc_html__('An image representing the event venue', 'event_espresso'),
-            '[VENUE_PHONE]'             => esc_html__('The phone number for the venue', 'event_espresso'),
-            '[VENUE_ADDRESS]'           => esc_html__('The address for the venue', 'event_espresso'),
-            '[VENUE_ADDRESS2]'          => esc_html__('Address 2 for the venue', 'event_espresso'),
-            '[VENUE_CITY]'              => esc_html__('The city the venue is in', 'event_espresso'),
-            '[VENUE_STATE]'             => esc_html__('The state the venue is located in', 'event_espresso'),
-            '[VENUE_COUNTRY]'           => esc_html__('The country the venue is located in', 'event_espresso'),
-            '[VENUE_FORMATTED_ADDRESS]' => esc_html__(
-                'This just outputs the venue address in a semantic address format.',
-                'event_espresso'
-            ),
-            '[VENUE_ZIP]'               => esc_html__('The zip code for the venue address', 'event_espresso'),
-            '[VENUE_META_*]'            => esc_html__(
-                'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the venue then it will be output in place of this shortcode.',
-                'event_espresso'
-            ),
-            '[GOOGLE_MAP_URL]'          => esc_html__(
-                'URL for the google map associated with the venue.',
-                'event_espresso'
-            ),
-            '[GOOGLE_MAP_LINK]'         => esc_html__('Link to a google map for the venue', 'event_espresso'),
-            '[GOOGLE_MAP_IMAGE]'        => esc_html__('Google map for venue wrapped in image tags', 'event_espresso'),
-        );
-    }
-
-
-    /**
-     * Parse incoming shortcode
-     *
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    protected function _parser($shortcode)
-    {
-        $this->_venue = $this->_get_venue();
-        // If there is no venue object by now then get out.
-        if (! $this->_venue instanceof EE_Venue) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[VENUE_TITLE]':
-                return $this->_venue('title');
-                break;
-
-            case '[VENUE_DESCRIPTION]':
-                return $this->_venue('description');
-                break;
-
-            case '[VENUE_URL]':
-                return $this->_venue('url');
-                break;
-
-            case '[VENUE_IMAGE]':
-                return $this->_venue('image');
-                break;
-
-            case '[VENUE_PHONE]':
-                return $this->_venue('phone');
-                break;
-
-            case '[VENUE_ADDRESS]':
-                return $this->_venue('address');
-                break;
-
-            case '[VENUE_ADDRESS2]':
-                return $this->_venue('address2');
-                break;
-
-            case '[VENUE_CITY]':
-                return $this->_venue('city');
-                break;
-
-            case '[VENUE_COUNTRY]':
-                return $this->_venue('country');
-                break;
-
-            case '[VENUE_STATE]':
-                return $this->_venue('state');
-                break;
-
-            case '[VENUE_ZIP]':
-                return $this->_venue('zip');
-                break;
-
-            case '[VENUE_FORMATTED_ADDRESS]':
-                return $this->_venue('formatted_address');
-                break;
-
-            case '[GOOGLE_MAP_URL]':
-                return $this->_venue('gmap_url');
-                break;
-
-            case '[GOOGLE_MAP_LINK]':
-                return $this->_venue('gmap_link');
-                break;
-
-            case '[GOOGLE_MAP_IMAGE]':
-                return $this->_venue('gmap_link_img');
-                break;
-
-            case '[VENUE_DETAILS_URL]':
-                return $this->_venue('permalink');
-                break;
-        }
-
-        if (strpos($shortcode, '[VENUE_META_*') !== false) {
-            $shortcode = str_replace('[VENUE_META_*', '', $shortcode);
-            $shortcode = trim(str_replace(']', '', $shortcode));
-
-            // pull the meta value from the venue post
-            $venue_meta = $this->_venue->get_post_meta($shortcode, true);
-
-            return ! empty($venue_meta) ? $venue_meta : '';
-        }
-    }
-
-    /**
-     * This retrieves the EE_Venue from the available data object.
-     *
-     * @return EE_Venue|null
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    private function _get_venue()
-    {
-
-        // we need the EE_Event object to get the venue.
-        $this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
-
-        // if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the
-        // reg_obj instead.
-        if (! $this->_event instanceof EE_Event) {
-            $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-            $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
-
-            $this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
-                ? $aee->reg_obj->event()
-                : null;
-
-            // if still empty do we have a ticket data item?
-            $this->_event = ! $this->_event instanceof EE_Event
-                            && $this->_data instanceof EE_Ticket
-                            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->tickets[ $this->_data->ID() ]['EE_Event']
-                : $this->_event;
-
-            // if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee
-            // and use that.
-            $this->_event = ! $this->_event instanceof EE_Event && $aee instanceof EE_Messages_Addressee
-                ? reset($aee->events)
-                : $this->_event;
-        }
-
-        // If we have an event object use it to pull the venue.
-        if ($this->_event instanceof EE_Event) {
-            return $this->_event->get_first_related('Venue');
-        }
-
-        return null;
-    }
-
-    /**
-     * This retrieves the specified venue information
-     *
-     * @param string $field What Venue field to retrieve
-     * @return string What was retrieved!
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    private function _venue($field)
-    {
-
-        if (! $this->_venue instanceof EE_Venue) {
-            return '';
-        } //no venue so get out.
-
-        switch ($field) {
-            case 'title':
-                return $this->_venue->get('VNU_name');
-                break;
-
-            case 'description':
-                return $this->_venue->get('VNU_desc');
-                break;
-
-            case 'url':
-                $url = $this->_venue->get('VNU_url');
-                return empty($url) ? $this->_venue->get_permalink() : $url;
-                break;
-
-            case 'permalink':
-                return $this->_venue->get_permalink();
-                break;
-
-            case 'image':
-                return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
-                           esc_attr__('%s Feature Image', 'event_espresso'),
-                           $this->_venue->get('VNU_name')
-                       ) . '" />';
-                break;
-
-            case 'phone':
-                return $this->_venue->get('VNU_phone');
-                break;
-
-            case 'address':
-                return $this->_venue->get('VNU_address');
-                break;
-
-            case 'address2':
-                return $this->_venue->get('VNU_address2');
-                break;
-
-            case 'city':
-                return $this->_venue->get('VNU_city');
-                break;
-
-            case 'state':
-                $state = $this->_venue->state_obj();
-                return is_object($state) ? $state->get('STA_name') : '';
-                break;
-
-            case 'country':
-                $country = $this->_venue->country_obj();
-                return is_object($country) ? $country->get('CNT_name') : '';
-                break;
-
-            case 'zip':
-                return $this->_venue->get('VNU_zip');
-                break;
-
-            case 'formatted_address':
-                return EEH_Address::format($this->_venue);
-                break;
-
-            case 'gmap_link':
-            case 'gmap_url':
-            case 'gmap_link_img':
-                $atts = $this->get_map_attributes($this->_venue, $field);
-                return EEH_Maps::google_map_link($atts);
-                break;
-        }
-        return '';
-    }
-
-
-    /**
-     * Generates the attributes for retrieving a google_map artifact.
-     *
-     * @param EE_Venue $venue
-     * @param string   $field
-     * @return array
-     * @throws EE_Error
-     */
-    protected function get_map_attributes(EE_Venue $venue, $field = 'gmap_link')
-    {
-        $state = $venue->state_obj();
-        $country = $venue->country_obj();
-        $atts = array(
-            'id'      => $venue->ID(),
-            'address' => $venue->get('VNU_address'),
-            'city'    => $venue->get('VNU_city'),
-            'state'   => is_object($state) ? $state->get('STA_name') : '',
-            'zip'     => $venue->get('VNU_zip'),
-            'country' => is_object($country) ? $country->get('CNT_name') : '',
-            'type'    => $field === 'gmap_link' ? 'url' : 'map',
-            'map_w'   => 200,
-            'map_h'   => 200,
-        );
-        if ($field === 'gmap_url') {
-            $atts['type'] = 'url_only';
-        }
-        return $atts;
-    }
+	/**
+	 * Will hold the EE_Event if available
+	 *
+	 * @var EE_Event
+	 */
+	protected $_event;
+
+	/**
+	 * Will hold the EE_Venue if available
+	 *
+	 * @var EE_Venue
+	 */
+	protected $_venue;
+
+
+	/**
+	 * Initialize properties
+	 */
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Venue Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to venue related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[VENUE_TITLE]'             => esc_html__('The title for the event venue', 'event_espresso'),
+			'[VENUE_DESCRIPTION]'       => esc_html__('The description for the event venue', 'event_espresso'),
+			'[VENUE_URL]'               => esc_html__('A url to a webpage for the venue', 'event_espresso'),
+			'[VENUE_DETAILS_URL]'       => sprintf(
+				esc_html__(
+					'This shortcode outputs the url or website address to the venue details page on this website. This differs from %s which outputs what is entered in the "url" field in the venue details page.',
+					'event_espresso'
+				),
+				'[VENUE_URL]'
+			),
+			'[VENUE_IMAGE]'             => esc_html__('An image representing the event venue', 'event_espresso'),
+			'[VENUE_PHONE]'             => esc_html__('The phone number for the venue', 'event_espresso'),
+			'[VENUE_ADDRESS]'           => esc_html__('The address for the venue', 'event_espresso'),
+			'[VENUE_ADDRESS2]'          => esc_html__('Address 2 for the venue', 'event_espresso'),
+			'[VENUE_CITY]'              => esc_html__('The city the venue is in', 'event_espresso'),
+			'[VENUE_STATE]'             => esc_html__('The state the venue is located in', 'event_espresso'),
+			'[VENUE_COUNTRY]'           => esc_html__('The country the venue is located in', 'event_espresso'),
+			'[VENUE_FORMATTED_ADDRESS]' => esc_html__(
+				'This just outputs the venue address in a semantic address format.',
+				'event_espresso'
+			),
+			'[VENUE_ZIP]'               => esc_html__('The zip code for the venue address', 'event_espresso'),
+			'[VENUE_META_*]'            => esc_html__(
+				'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the venue then it will be output in place of this shortcode.',
+				'event_espresso'
+			),
+			'[GOOGLE_MAP_URL]'          => esc_html__(
+				'URL for the google map associated with the venue.',
+				'event_espresso'
+			),
+			'[GOOGLE_MAP_LINK]'         => esc_html__('Link to a google map for the venue', 'event_espresso'),
+			'[GOOGLE_MAP_IMAGE]'        => esc_html__('Google map for venue wrapped in image tags', 'event_espresso'),
+		);
+	}
+
+
+	/**
+	 * Parse incoming shortcode
+	 *
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	protected function _parser($shortcode)
+	{
+		$this->_venue = $this->_get_venue();
+		// If there is no venue object by now then get out.
+		if (! $this->_venue instanceof EE_Venue) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[VENUE_TITLE]':
+				return $this->_venue('title');
+				break;
+
+			case '[VENUE_DESCRIPTION]':
+				return $this->_venue('description');
+				break;
+
+			case '[VENUE_URL]':
+				return $this->_venue('url');
+				break;
+
+			case '[VENUE_IMAGE]':
+				return $this->_venue('image');
+				break;
+
+			case '[VENUE_PHONE]':
+				return $this->_venue('phone');
+				break;
+
+			case '[VENUE_ADDRESS]':
+				return $this->_venue('address');
+				break;
+
+			case '[VENUE_ADDRESS2]':
+				return $this->_venue('address2');
+				break;
+
+			case '[VENUE_CITY]':
+				return $this->_venue('city');
+				break;
+
+			case '[VENUE_COUNTRY]':
+				return $this->_venue('country');
+				break;
+
+			case '[VENUE_STATE]':
+				return $this->_venue('state');
+				break;
+
+			case '[VENUE_ZIP]':
+				return $this->_venue('zip');
+				break;
+
+			case '[VENUE_FORMATTED_ADDRESS]':
+				return $this->_venue('formatted_address');
+				break;
+
+			case '[GOOGLE_MAP_URL]':
+				return $this->_venue('gmap_url');
+				break;
+
+			case '[GOOGLE_MAP_LINK]':
+				return $this->_venue('gmap_link');
+				break;
+
+			case '[GOOGLE_MAP_IMAGE]':
+				return $this->_venue('gmap_link_img');
+				break;
+
+			case '[VENUE_DETAILS_URL]':
+				return $this->_venue('permalink');
+				break;
+		}
+
+		if (strpos($shortcode, '[VENUE_META_*') !== false) {
+			$shortcode = str_replace('[VENUE_META_*', '', $shortcode);
+			$shortcode = trim(str_replace(']', '', $shortcode));
+
+			// pull the meta value from the venue post
+			$venue_meta = $this->_venue->get_post_meta($shortcode, true);
+
+			return ! empty($venue_meta) ? $venue_meta : '';
+		}
+	}
+
+	/**
+	 * This retrieves the EE_Venue from the available data object.
+	 *
+	 * @return EE_Venue|null
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	private function _get_venue()
+	{
+
+		// we need the EE_Event object to get the venue.
+		$this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
+
+		// if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the
+		// reg_obj instead.
+		if (! $this->_event instanceof EE_Event) {
+			$aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+			$aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
+
+			$this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
+				? $aee->reg_obj->event()
+				: null;
+
+			// if still empty do we have a ticket data item?
+			$this->_event = ! $this->_event instanceof EE_Event
+							&& $this->_data instanceof EE_Ticket
+							&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']->tickets[ $this->_data->ID() ]['EE_Event']
+				: $this->_event;
+
+			// if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee
+			// and use that.
+			$this->_event = ! $this->_event instanceof EE_Event && $aee instanceof EE_Messages_Addressee
+				? reset($aee->events)
+				: $this->_event;
+		}
+
+		// If we have an event object use it to pull the venue.
+		if ($this->_event instanceof EE_Event) {
+			return $this->_event->get_first_related('Venue');
+		}
+
+		return null;
+	}
+
+	/**
+	 * This retrieves the specified venue information
+	 *
+	 * @param string $field What Venue field to retrieve
+	 * @return string What was retrieved!
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	private function _venue($field)
+	{
+
+		if (! $this->_venue instanceof EE_Venue) {
+			return '';
+		} //no venue so get out.
+
+		switch ($field) {
+			case 'title':
+				return $this->_venue->get('VNU_name');
+				break;
+
+			case 'description':
+				return $this->_venue->get('VNU_desc');
+				break;
+
+			case 'url':
+				$url = $this->_venue->get('VNU_url');
+				return empty($url) ? $this->_venue->get_permalink() : $url;
+				break;
+
+			case 'permalink':
+				return $this->_venue->get_permalink();
+				break;
+
+			case 'image':
+				return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
+					   . '" alt="' . sprintf(
+						   esc_attr__('%s Feature Image', 'event_espresso'),
+						   $this->_venue->get('VNU_name')
+					   ) . '" />';
+				break;
+
+			case 'phone':
+				return $this->_venue->get('VNU_phone');
+				break;
+
+			case 'address':
+				return $this->_venue->get('VNU_address');
+				break;
+
+			case 'address2':
+				return $this->_venue->get('VNU_address2');
+				break;
+
+			case 'city':
+				return $this->_venue->get('VNU_city');
+				break;
+
+			case 'state':
+				$state = $this->_venue->state_obj();
+				return is_object($state) ? $state->get('STA_name') : '';
+				break;
+
+			case 'country':
+				$country = $this->_venue->country_obj();
+				return is_object($country) ? $country->get('CNT_name') : '';
+				break;
+
+			case 'zip':
+				return $this->_venue->get('VNU_zip');
+				break;
+
+			case 'formatted_address':
+				return EEH_Address::format($this->_venue);
+				break;
+
+			case 'gmap_link':
+			case 'gmap_url':
+			case 'gmap_link_img':
+				$atts = $this->get_map_attributes($this->_venue, $field);
+				return EEH_Maps::google_map_link($atts);
+				break;
+		}
+		return '';
+	}
+
+
+	/**
+	 * Generates the attributes for retrieving a google_map artifact.
+	 *
+	 * @param EE_Venue $venue
+	 * @param string   $field
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function get_map_attributes(EE_Venue $venue, $field = 'gmap_link')
+	{
+		$state = $venue->state_obj();
+		$country = $venue->country_obj();
+		$atts = array(
+			'id'      => $venue->ID(),
+			'address' => $venue->get('VNU_address'),
+			'city'    => $venue->get('VNU_city'),
+			'state'   => is_object($state) ? $state->get('STA_name') : '',
+			'zip'     => $venue->get('VNU_zip'),
+			'country' => is_object($country) ? $country->get('CNT_name') : '',
+			'type'    => $field === 'gmap_link' ? 'url' : 'map',
+			'map_w'   => 200,
+			'map_h'   => 200,
+		);
+		if ($field === 'gmap_url') {
+			$atts['type'] = 'url_only';
+		}
+		return $atts;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -88,7 +88,7 @@ 
     {
         $this->_venue = $this->_get_venue();
         // If there is no venue object by now then get out.
-        if (! $this->_venue instanceof EE_Venue) {
+        if ( ! $this->_venue instanceof EE_Venue) {
             return '';
         }
 
@@ -184,7 +184,7 @@ 
 
         // if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the
         // reg_obj instead.
-        if (! $this->_event instanceof EE_Event) {
+        if ( ! $this->_event instanceof EE_Event) {
             $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
             $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
 
@@ -196,7 +196,7 @@ 
             $this->_event = ! $this->_event instanceof EE_Event
                             && $this->_data instanceof EE_Ticket
                             && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->tickets[ $this->_data->ID() ]['EE_Event']
+                ? $this->_extra_data['data']->tickets[$this->_data->ID()]['EE_Event']
                 : $this->_event;
 
             // if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee
@@ -225,7 +225,7 @@ 
     private function _venue($field)
     {
 
-        if (! $this->_venue instanceof EE_Venue) {
+        if ( ! $this->_venue instanceof EE_Venue) {
             return '';
         } //no venue so get out.
 
@@ -248,11 +248,11 @@ 
                 break;
 
             case 'image':
-                return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
+                return '<img src="'.$this->_venue->feature_image_url(array(200, 200,))
+                       . '" alt="'.sprintf(
                            esc_attr__('%s Feature Image', 'event_espresso'),
                            $this->_venue->get('VNU_name')
-                       ) . '" />';
+                       ).'" />';
                 break;
 
             case 'phone':

core/libraries/shortcodes/EE_Organization_Shortcodes.lib.php

Spacing +2 added lines, -2 removed lines

@@ -104,7 +104,7 @@ 
                 return '<img src="'
                        . EE_Registry::instance()->CFG->organization->get_pretty(
                            'logo_url'
-                       ) . '" id="headerImage" />';
+                       ).'" id="headerImage" />';
                 break;
 
             case '[CO_LOGO_URL]':
@@ -149,7 +149,7 @@ 
 
             // set custom attrs if present (or default)
             $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
-            return $prefix . $tax_number;
+            return $prefix.$tax_number;
         }
 
         return '';

Indentation +135 added lines, -135 removed lines

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

core/libraries/shortcodes/EE_Payment_Shortcodes.lib.php

Spacing +1 added lines, -1 removed lines

@@ -49,7 +49,7 @@
     protected function _parser($shortcode)
     {
         // ensure that the incoming object is an EE_Payment object.  If it isn't then bail early.
-        if (! $this->_data instanceof EE_Payment) {
+        if ( ! $this->_data instanceof EE_Payment) {
             return '';
         }
 

Indentation +89 added lines, -89 removed lines

@@ -18,93 +18,93 @@
 {
 
 
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Payment Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to payments.', 'event_espresso');
-        $this->_shortcodes = array(
-            '[PAYMENT_TIMESTAMP]' => esc_html__(
-                'Outputs the date of the payment (using the default date format).',
-                'event_espresso'
-            ),
-            '[PAYMENT_METHOD]' => esc_html__('Outputs a the payment method.', 'event_espresso'),
-            '[PAYMENT_AMOUNT]' => esc_html__('Outputs the payment amount (with currency symbol).', 'event_espresso'),
-            '[PAYMENT_GATEWAY]' => esc_html__('Outputs the gateway used for the payment.', 'event_espresso'),
-            '[PAYMENT_GATEWAY_RESPONSE]' => esc_html__('Outputs the payment gateway response.', 'event_espresso'),
-            '[PAYMENT_GATEWAY_TXN_ID]' => esc_html__(
-                'This will either be the gateway transaction ID, or the manual ID added with payment applied via the admin.',
-                'event_espresso'
-            ),
-            '[PAYMENT_PO_NUMBER]' => esc_html__('Purchase Order number (if present)', 'event_espresso'),
-            '[PAYMENT_EXTRA_ACCOUNTING]' => esc_html__(
-                'Any extra accounting messages. Typically added with payments made via the admin.',
-                'event_espresso'
-            ),
-            '[PAYMENT_STATUS]' => esc_html__('The status of the payment.', 'event_espresso'),
-            // '[PAYMENT_STATUS_WITH_ICONS]' => esc_html__('The status of the payment including icons representing the status.', 'event_espresso')
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-        // ensure that the incoming object is an EE_Payment object.  If it isn't then bail early.
-        if (! $this->_data instanceof EE_Payment) {
-            return '';
-        }
-
-        $payment = $this->_data;
-
-        switch ($shortcode) {
-            case '[PAYMENT_TIMESTAMP]':
-                return $payment->timestamp();
-                break;
-
-            case '[PAYMENT_METHOD]':
-                // previously the column 'PAY_source' was known as 'PAY_method'
-                return $payment->source();
-                break;
-
-            case '[PAYMENT_AMOUNT]':
-                return $payment->amount_no_code();
-                break;
-
-            case '[PAYMENT_GATEWAY]':
-                // previously teh column 'PMD_ID' was more-or-less 'PAY_gateway'
-                if ($payment->payment_method() instanceof EE_Payment_Method) {
-                    return $payment->payment_method()->name();
-                } else {
-                    return esc_html__('Unknown', 'event_espresso');
-                }
-                break;
-
-            case '[PAYMENT_GATEWAY_RESPONSE]':
-                return $payment->gateway_response();
-                break;
-
-            case '[PAYMENT_GATEWAY_TXN_ID]':
-                return $payment->txn_id_chq_nmbr();
-                break;
-
-            case '[PAYMENT_PO_NUMBER]':
-                return $payment->po_number();
-                break;
-
-            case '[PAYMENT_EXTRA_ACCOUNTING]':
-                return $payment->extra_accntng();
-                break;
-
-            case '[PAYMENT_STATUS]':
-                return $payment->pretty_status();
-                break;
-
-            case '[PAYMENT_STATUS_WITH_ICONS]':
-                return $payment->pretty_status(true);
-                break;
-
-            default:
-                return '';
-                break;
-        }
-    }
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Payment Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to payments.', 'event_espresso');
+		$this->_shortcodes = array(
+			'[PAYMENT_TIMESTAMP]' => esc_html__(
+				'Outputs the date of the payment (using the default date format).',
+				'event_espresso'
+			),
+			'[PAYMENT_METHOD]' => esc_html__('Outputs a the payment method.', 'event_espresso'),
+			'[PAYMENT_AMOUNT]' => esc_html__('Outputs the payment amount (with currency symbol).', 'event_espresso'),
+			'[PAYMENT_GATEWAY]' => esc_html__('Outputs the gateway used for the payment.', 'event_espresso'),
+			'[PAYMENT_GATEWAY_RESPONSE]' => esc_html__('Outputs the payment gateway response.', 'event_espresso'),
+			'[PAYMENT_GATEWAY_TXN_ID]' => esc_html__(
+				'This will either be the gateway transaction ID, or the manual ID added with payment applied via the admin.',
+				'event_espresso'
+			),
+			'[PAYMENT_PO_NUMBER]' => esc_html__('Purchase Order number (if present)', 'event_espresso'),
+			'[PAYMENT_EXTRA_ACCOUNTING]' => esc_html__(
+				'Any extra accounting messages. Typically added with payments made via the admin.',
+				'event_espresso'
+			),
+			'[PAYMENT_STATUS]' => esc_html__('The status of the payment.', 'event_espresso'),
+			// '[PAYMENT_STATUS_WITH_ICONS]' => esc_html__('The status of the payment including icons representing the status.', 'event_espresso')
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+		// ensure that the incoming object is an EE_Payment object.  If it isn't then bail early.
+		if (! $this->_data instanceof EE_Payment) {
+			return '';
+		}
+
+		$payment = $this->_data;
+
+		switch ($shortcode) {
+			case '[PAYMENT_TIMESTAMP]':
+				return $payment->timestamp();
+				break;
+
+			case '[PAYMENT_METHOD]':
+				// previously the column 'PAY_source' was known as 'PAY_method'
+				return $payment->source();
+				break;
+
+			case '[PAYMENT_AMOUNT]':
+				return $payment->amount_no_code();
+				break;
+
+			case '[PAYMENT_GATEWAY]':
+				// previously teh column 'PMD_ID' was more-or-less 'PAY_gateway'
+				if ($payment->payment_method() instanceof EE_Payment_Method) {
+					return $payment->payment_method()->name();
+				} else {
+					return esc_html__('Unknown', 'event_espresso');
+				}
+				break;
+
+			case '[PAYMENT_GATEWAY_RESPONSE]':
+				return $payment->gateway_response();
+				break;
+
+			case '[PAYMENT_GATEWAY_TXN_ID]':
+				return $payment->txn_id_chq_nmbr();
+				break;
+
+			case '[PAYMENT_PO_NUMBER]':
+				return $payment->po_number();
+				break;
+
+			case '[PAYMENT_EXTRA_ACCOUNTING]':
+				return $payment->extra_accntng();
+				break;
+
+			case '[PAYMENT_STATUS]':
+				return $payment->pretty_status();
+				break;
+
+			case '[PAYMENT_STATUS_WITH_ICONS]':
+				return $payment->pretty_status(true);
+				break;
+
+			default:
+				return '';
+				break;
+		}
+	}
 }