eventespresso / event-espresso-core

core/libraries/shortcodes/EE_Shortcodes.lib.php

Indentation +448 added lines, -448 removed lines

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

Spacing +12 added lines, -12 removed lines

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

core/libraries/shortcodes/EE_Event_Author_Shortcodes.lib.php

Indentation +103 added lines, -103 removed lines

@@ -19,120 +19,120 @@
  */
 class EE_Event_Author_Shortcodes extends EE_Shortcodes
 {
-    public function __construct()
-    {
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
 
 
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Event Author Details Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to event_author data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[EVENT_AUTHOR_FNAME]' => esc_html__('Parses to the first name of the event author.', 'event_espresso'),
-            '[EVENT_AUTHOR_LNAME]' => esc_html__('Parses to the last name of the event author.', 'event_espresso'),
-            '[EVENT_AUTHOR_FORMATTED_EMAIL]' => esc_html__(
-                'Parses to a formatted email address of the event author (fname lname &lt;email@address.com&gt;).  <strong>NOTE:</strong> If the event author has not filled out their WordPress user profile then the organization name will be used as the "From" name.',
-                'event_espresso'
-            ),
-            '[EVENT_AUTHOR_EMAIL]' => esc_html__(
-                'Parses to the unformatted email address of the event author',
-                'event_espresso'
-            ),
-        );
-    }
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Event Author Details Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to event_author data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[EVENT_AUTHOR_FNAME]' => esc_html__('Parses to the first name of the event author.', 'event_espresso'),
+			'[EVENT_AUTHOR_LNAME]' => esc_html__('Parses to the last name of the event author.', 'event_espresso'),
+			'[EVENT_AUTHOR_FORMATTED_EMAIL]' => esc_html__(
+				'Parses to a formatted email address of the event author (fname lname &lt;email@address.com&gt;).  <strong>NOTE:</strong> If the event author has not filled out their WordPress user profile then the organization name will be used as the "From" name.',
+				'event_espresso'
+			),
+			'[EVENT_AUTHOR_EMAIL]' => esc_html__(
+				'Parses to the unformatted email address of the event author',
+				'event_espresso'
+			),
+		);
+	}
 
 
-    /**
-     * @param string $shortcode
-     * @throws EE_Error
-     */
-    protected function _parser($shortcode)
-    {
-        // make sure we end up with a copy of the EE_Messages_Addressee object
-        $recipient = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee
-            && is_array($this->_data)
-            && isset($this->_data['data'])
-            && $this->_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_data['data']
-                : $recipient;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee
-            && ! empty($this->_extra_data['data'])
-            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']
-                : $recipient;
+	/**
+	 * @param string $shortcode
+	 * @throws EE_Error
+	 */
+	protected function _parser($shortcode)
+	{
+		// make sure we end up with a copy of the EE_Messages_Addressee object
+		$recipient = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee
+			&& is_array($this->_data)
+			&& isset($this->_data['data'])
+			&& $this->_data['data'] instanceof EE_Messages_Addressee
+				? $this->_data['data']
+				: $recipient;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee
+			&& ! empty($this->_extra_data['data'])
+			&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']
+				: $recipient;
 
-        // now it's possible that $recipient is not an instance of EE_Messages_Addressee in which case we need to see if $this->_data is an instance of $event.
-        $event = $this->_data instanceof EE_Event ? $this->_data : null;
+		// now it's possible that $recipient is not an instance of EE_Messages_Addressee in which case we need to see if $this->_data is an instance of $event.
+		$event = $this->_data instanceof EE_Event ? $this->_data : null;
 
-        if (! $recipient instanceof EE_Messages_Addressee && ! $event instanceof EE_Event) {
-            return '';
-        }
+		if (! $recipient instanceof EE_Messages_Addressee && ! $event instanceof EE_Event) {
+			return '';
+		}
 
-        switch ($shortcode) {
-            case '[EVENT_AUTHOR_FNAME]':
-                $fname = ! empty($recipient) ? $recipient->fname : null;
-                if (empty($fname) && ! empty($event)) {
-                    $user = $this->_get_author_for_event($event);
-                    $fname = $user->first_name;
-                }
-                return $fname;
+		switch ($shortcode) {
+			case '[EVENT_AUTHOR_FNAME]':
+				$fname = ! empty($recipient) ? $recipient->fname : null;
+				if (empty($fname) && ! empty($event)) {
+					$user = $this->_get_author_for_event($event);
+					$fname = $user->first_name;
+				}
+				return $fname;
 
-            case '[EVENT_AUTHOR_LNAME]':
-                $lname = ! empty($recipient) ? $recipient->lname : null;
-                if (empty($lname) && ! empty($event)) {
-                    $user = $this->_get_author_for_event($event);
-                    $lname = $user->last_name;
-                }
-                return $lname;
+			case '[EVENT_AUTHOR_LNAME]':
+				$lname = ! empty($recipient) ? $recipient->lname : null;
+				if (empty($lname) && ! empty($event)) {
+					$user = $this->_get_author_for_event($event);
+					$lname = $user->last_name;
+				}
+				return $lname;
 
-            case '[EVENT_AUTHOR_FORMATTED_EMAIL]':
-                if (! empty($recipient)) {
-                    $email = ! empty($recipient->fname)
-                        ? $recipient->fname . ' ' . $recipient->lname . '<' . $recipient->admin_email . '>'
-                        : EE_Registry::instance()->CFG->organization->get_pretty(
-                            'name'
-                        ) . '<' . $recipient->admin_email . '>';
-                } else {
-                    $email = null;
-                }
-                if (empty($email) && ! empty($event)) {
-                    $user = $this->_get_author_for_event($event);
-                    $email = ! empty($user->first_name)
-                        ? $user->first_name . ' ' . $user->last_name . '<' . $user->user_email . '>'
-                        : EE_Registry::instance()->CFG->organization->get_pretty(
-                            'name'
-                        ) . '<' . $user->user_email . '>';
-                }
-                return $email;
+			case '[EVENT_AUTHOR_FORMATTED_EMAIL]':
+				if (! empty($recipient)) {
+					$email = ! empty($recipient->fname)
+						? $recipient->fname . ' ' . $recipient->lname . '<' . $recipient->admin_email . '>'
+						: EE_Registry::instance()->CFG->organization->get_pretty(
+							'name'
+						) . '<' . $recipient->admin_email . '>';
+				} else {
+					$email = null;
+				}
+				if (empty($email) && ! empty($event)) {
+					$user = $this->_get_author_for_event($event);
+					$email = ! empty($user->first_name)
+						? $user->first_name . ' ' . $user->last_name . '<' . $user->user_email . '>'
+						: EE_Registry::instance()->CFG->organization->get_pretty(
+							'name'
+						) . '<' . $user->user_email . '>';
+				}
+				return $email;
 
-            case '[EVENT_AUTHOR_EMAIL]':
-                $email = ! empty($recipient) ? $recipient->admin_email : null;
-                if (empty($email) && ! empty($event)) {
-                    $user = $this->_get_author_for_event($event);
-                    $email = $user->user_email;
-                }
-                return $email;
+			case '[EVENT_AUTHOR_EMAIL]':
+				$email = ! empty($recipient) ? $recipient->admin_email : null;
+				if (empty($email) && ! empty($event)) {
+					$user = $this->_get_author_for_event($event);
+					$email = $user->user_email;
+				}
+				return $email;
 
-            default:
-                return '';
-        }
-    }
+			default:
+				return '';
+		}
+	}
 
 
-    /**
-     * Helper method to return the user object for the author of the given EE_Event
-     *
-     * @param EE_Event $event
-     *
-     * @return WP_User
-     */
-    private function _get_author_for_event(EE_Event $event)
-    {
-        $author_id = $event->wp_user();
-        $user_data = get_userdata((int) $author_id);
-        return $user_data;
-    }
+	/**
+	 * Helper method to return the user object for the author of the given EE_Event
+	 *
+	 * @param EE_Event $event
+	 *
+	 * @return WP_User
+	 */
+	private function _get_author_for_event(EE_Event $event)
+	{
+		$author_id = $event->wp_user();
+		$user_data = get_userdata((int) $author_id);
+		return $user_data;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -67,7 +67,7 @@ 
         // now it's possible that $recipient is not an instance of EE_Messages_Addressee in which case we need to see if $this->_data is an instance of $event.
         $event = $this->_data instanceof EE_Event ? $this->_data : null;
 
-        if (! $recipient instanceof EE_Messages_Addressee && ! $event instanceof EE_Event) {
+        if ( ! $recipient instanceof EE_Messages_Addressee && ! $event instanceof EE_Event) {
             return '';
         }
 
@@ -89,22 +89,22 @@ 
                 return $lname;
 
             case '[EVENT_AUTHOR_FORMATTED_EMAIL]':
-                if (! empty($recipient)) {
+                if ( ! empty($recipient)) {
                     $email = ! empty($recipient->fname)
-                        ? $recipient->fname . ' ' . $recipient->lname . '<' . $recipient->admin_email . '>'
+                        ? $recipient->fname.' '.$recipient->lname.'<'.$recipient->admin_email.'>'
                         : EE_Registry::instance()->CFG->organization->get_pretty(
                             'name'
-                        ) . '<' . $recipient->admin_email . '>';
+                        ).'<'.$recipient->admin_email.'>';
                 } else {
                     $email = null;
                 }
                 if (empty($email) && ! empty($event)) {
                     $user = $this->_get_author_for_event($event);
                     $email = ! empty($user->first_name)
-                        ? $user->first_name . ' ' . $user->last_name . '<' . $user->user_email . '>'
+                        ? $user->first_name.' '.$user->last_name.'<'.$user->user_email.'>'
                         : EE_Registry::instance()->CFG->organization->get_pretty(
                             'name'
-                        ) . '<' . $user->user_email . '>';
+                        ).'<'.$user->user_email.'>';
                 }
                 return $email;
 

core/libraries/shortcodes/EE_Primary_Registration_Details_Shortcodes.lib.php

Indentation +194 added lines, -194 removed lines

@@ -15,199 +15,199 @@
  */
 class EE_Primary_Registration_Details_Shortcodes extends EE_Shortcodes
 {
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Primary_Registration Details Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific primary registrant data', 'event_espresso');
-        $this->_shortcodes = [
-            '[PRIMARY_REGISTRANT_FNAME]'                  => esc_html__(
-                'Parses to the first name of the primary registration for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_LNAME]'                  => esc_html__(
-                'Parses to the last name of the primary registration for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_EMAIL]'                  => esc_html__(
-                'Parses to the email address of the primary registration for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_REGISTRATION_ID]'        => esc_html__(
-                'Parses to the registration ID of the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_REGISTRATION_CODE]'      => esc_html__(
-                'Parses to the registration code of the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_PHONE_NUMBER]'           => esc_html__(
-                'The Phone Number for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ADDRESS]'                => esc_html__(
-                'The Address for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ADDRESS2]'               => esc_html__(
-                'Whatever was in the address 2 field for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_CITY]'                   => esc_html__(
-                'The city for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ZIP_PC]'                 => esc_html__(
-                'The ZIP (or Postal) Code for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ADDRESS_STATE]'          => esc_html__(
-                'The state/province for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_COUNTRY]'                => esc_html__(
-                'The country for the primary registrant for the transaction.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_REGISTRATION_DATE]'      => esc_html__(
-                'The date the registration occured for the primary registration.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]' => esc_html__(
-                'Generates a link for the given registration to edit this registration details on the frontend.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_ANSWER_*]'               => esc_html__(
-                'This is a special dynamic shortcode.  After the "*", add the exact text of an existing question, and if there is an answer for that question for this primary registrant, then it will be output in place of this shortcode.',
-                'event_espresso'
-            ),
-        ];
-    }
-
-
-    /**
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.20.p
-     */
-    protected function _parser($shortcode)
-    {
-        // make sure we end up with a copy of the EE_Messages_Addressee object
-        $primary_registration = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $primary_registration = ! $primary_registration instanceof EE_Messages_Addressee
-        && is_array($this->_data)
-        && isset($this->_data['data'])
-        && $this->_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_data['data']
-            : $primary_registration;
-        $primary_registration = ! $primary_registration instanceof EE_Messages_Addressee
-        && ! empty($this->_extra_data['data'])
-        && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data']
-            : $primary_registration;
-
-        if (! $primary_registration instanceof EE_Messages_Addressee) {
-            return '';
-        }
-
-        $attendee    = $primary_registration->primary_att_obj;
-        $primary_reg = $primary_registration->primary_reg_obj;
-
-        if (! $attendee instanceof EE_Attendee || ! $primary_reg instanceof EE_Registration) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_FNAME]':
-                return $attendee->fname();
-
-            case '[PRIMARY_REGISTRANT_LNAME]':
-                return $attendee->lname();
-
-            case '[PRIMARY_REGISTRANT_EMAIL]':
-                return $attendee->email();
-
-            case '[PRIMARY_REGISTRANT_REGISTRATION_ID]':
-                return $primary_reg->ID();
-
-            case '[PRIMARY_REGISTRANT_REGISTRATION_CODE]':
-                return $primary_reg->reg_code();
-
-            case '[PRIMARY_REGISTRANT_PHONE_NUMBER]':
-                return $attendee->phone();
-
-            case '[PRIMARY_REGISTRANT_ADDRESS]':
-                return $attendee->address();
-
-            case '[PRIMARY_REGISTRANT_ADDRESS2]':
-                return $attendee->address2();
-
-            case '[PRIMARY_REGISTRANT_CITY]':
-                return $attendee->city();
-
-            case '[PRIMARY_REGISTRANT_ZIP_PC]':
-                return $attendee->zip();
-
-            case '[PRIMARY_REGISTRANT_ADDRESS_STATE]':
-                $state_obj = $attendee->state_obj();
-                return $state_obj instanceof EE_State ? $state_obj->name() : '';
-
-            case '[PRIMARY_REGISTRANT_COUNTRY]':
-                $country_obj = $attendee->country_obj();
-                return $country_obj instanceof EE_Country ? $country_obj->name() : '';
-
-            case '[PRIMARY_REGISTRANT_REGISTRATION_DATE]':
-                if (! $primary_registration->primary_reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                return $primary_registration->primary_reg_obj->get_i18n_datetime('REG_date', get_option('date_format'));
-
-            case '[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]':
-                return $primary_reg->edit_attendee_information_url();
-        }
-
-        if (strpos($shortcode, '[PRIMARY_REGISTRANT_ANSWER_*') !== false) {
-            $shortcode = str_replace('[PRIMARY_REGISTRANT_ANSWER_*', '', $shortcode);
-            $shortcode = trim(str_replace(']', '', $shortcode));
-
-
-            // now let's figure out what question has this text
-            if (empty($primary_registration->questions)) {
-                return '';
-            }
-
-            foreach ($primary_registration->questions as $ansid => $question) {
-                if (
-                    $question instanceof EE_Question
-                    && trim($question->get('QST_display_text')) === trim($shortcode)
-                    && isset($primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ])
-                ) {
-                    /** @var EE_Answer $primary_reg_ansid */
-                    $primary_reg_ansid = $primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ];
-
-                    // what we show for the answer depends on the question type!
-                    switch ($question->get('QST_type')) {
-                        case EEM_Question::QST_type_state:
-                            $state  = EEM_State::instance()->get_one_by_ID($primary_reg_ansid->get('ANS_value'));
-                            $answer = $state instanceof EE_State ? $state->name() : '';
-                            break;
-
-                        case EEM_Question::QST_type_country:
-                            $country = EEM_Country::instance()->get_one_by_ID($primary_reg_ansid->get('ANS_value'));
-                            $answer  = $country instanceof EE_Country ? $country->name() : '';
-                            break;
-
-                        default:
-                            $answer = (string) $primary_reg_ansid->get_pretty('ANS_value', 'no_wpautop');
-                            break;
-                    }
-
-                    return $answer;
-                }
-            }
-        }
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Primary_Registration Details Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific primary registrant data', 'event_espresso');
+		$this->_shortcodes = [
+			'[PRIMARY_REGISTRANT_FNAME]'                  => esc_html__(
+				'Parses to the first name of the primary registration for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_LNAME]'                  => esc_html__(
+				'Parses to the last name of the primary registration for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_EMAIL]'                  => esc_html__(
+				'Parses to the email address of the primary registration for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_REGISTRATION_ID]'        => esc_html__(
+				'Parses to the registration ID of the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_REGISTRATION_CODE]'      => esc_html__(
+				'Parses to the registration code of the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_PHONE_NUMBER]'           => esc_html__(
+				'The Phone Number for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ADDRESS]'                => esc_html__(
+				'The Address for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ADDRESS2]'               => esc_html__(
+				'Whatever was in the address 2 field for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_CITY]'                   => esc_html__(
+				'The city for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ZIP_PC]'                 => esc_html__(
+				'The ZIP (or Postal) Code for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ADDRESS_STATE]'          => esc_html__(
+				'The state/province for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_COUNTRY]'                => esc_html__(
+				'The country for the primary registrant for the transaction.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_REGISTRATION_DATE]'      => esc_html__(
+				'The date the registration occured for the primary registration.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]' => esc_html__(
+				'Generates a link for the given registration to edit this registration details on the frontend.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_ANSWER_*]'               => esc_html__(
+				'This is a special dynamic shortcode.  After the "*", add the exact text of an existing question, and if there is an answer for that question for this primary registrant, then it will be output in place of this shortcode.',
+				'event_espresso'
+			),
+		];
+	}
+
+
+	/**
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.20.p
+	 */
+	protected function _parser($shortcode)
+	{
+		// make sure we end up with a copy of the EE_Messages_Addressee object
+		$primary_registration = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$primary_registration = ! $primary_registration instanceof EE_Messages_Addressee
+		&& is_array($this->_data)
+		&& isset($this->_data['data'])
+		&& $this->_data['data'] instanceof EE_Messages_Addressee
+			? $this->_data['data']
+			: $primary_registration;
+		$primary_registration = ! $primary_registration instanceof EE_Messages_Addressee
+		&& ! empty($this->_extra_data['data'])
+		&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data']
+			: $primary_registration;
+
+		if (! $primary_registration instanceof EE_Messages_Addressee) {
+			return '';
+		}
+
+		$attendee    = $primary_registration->primary_att_obj;
+		$primary_reg = $primary_registration->primary_reg_obj;
+
+		if (! $attendee instanceof EE_Attendee || ! $primary_reg instanceof EE_Registration) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_FNAME]':
+				return $attendee->fname();
+
+			case '[PRIMARY_REGISTRANT_LNAME]':
+				return $attendee->lname();
+
+			case '[PRIMARY_REGISTRANT_EMAIL]':
+				return $attendee->email();
+
+			case '[PRIMARY_REGISTRANT_REGISTRATION_ID]':
+				return $primary_reg->ID();
+
+			case '[PRIMARY_REGISTRANT_REGISTRATION_CODE]':
+				return $primary_reg->reg_code();
+
+			case '[PRIMARY_REGISTRANT_PHONE_NUMBER]':
+				return $attendee->phone();
+
+			case '[PRIMARY_REGISTRANT_ADDRESS]':
+				return $attendee->address();
+
+			case '[PRIMARY_REGISTRANT_ADDRESS2]':
+				return $attendee->address2();
+
+			case '[PRIMARY_REGISTRANT_CITY]':
+				return $attendee->city();
+
+			case '[PRIMARY_REGISTRANT_ZIP_PC]':
+				return $attendee->zip();
+
+			case '[PRIMARY_REGISTRANT_ADDRESS_STATE]':
+				$state_obj = $attendee->state_obj();
+				return $state_obj instanceof EE_State ? $state_obj->name() : '';
+
+			case '[PRIMARY_REGISTRANT_COUNTRY]':
+				$country_obj = $attendee->country_obj();
+				return $country_obj instanceof EE_Country ? $country_obj->name() : '';
+
+			case '[PRIMARY_REGISTRANT_REGISTRATION_DATE]':
+				if (! $primary_registration->primary_reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				return $primary_registration->primary_reg_obj->get_i18n_datetime('REG_date', get_option('date_format'));
+
+			case '[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]':
+				return $primary_reg->edit_attendee_information_url();
+		}
+
+		if (strpos($shortcode, '[PRIMARY_REGISTRANT_ANSWER_*') !== false) {
+			$shortcode = str_replace('[PRIMARY_REGISTRANT_ANSWER_*', '', $shortcode);
+			$shortcode = trim(str_replace(']', '', $shortcode));
+
+
+			// now let's figure out what question has this text
+			if (empty($primary_registration->questions)) {
+				return '';
+			}
+
+			foreach ($primary_registration->questions as $ansid => $question) {
+				if (
+					$question instanceof EE_Question
+					&& trim($question->get('QST_display_text')) === trim($shortcode)
+					&& isset($primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ])
+				) {
+					/** @var EE_Answer $primary_reg_ansid */
+					$primary_reg_ansid = $primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ];
+
+					// what we show for the answer depends on the question type!
+					switch ($question->get('QST_type')) {
+						case EEM_Question::QST_type_state:
+							$state  = EEM_State::instance()->get_one_by_ID($primary_reg_ansid->get('ANS_value'));
+							$answer = $state instanceof EE_State ? $state->name() : '';
+							break;
+
+						case EEM_Question::QST_type_country:
+							$country = EEM_Country::instance()->get_one_by_ID($primary_reg_ansid->get('ANS_value'));
+							$answer  = $country instanceof EE_Country ? $country->name() : '';
+							break;
+
+						default:
+							$answer = (string) $primary_reg_ansid->get_pretty('ANS_value', 'no_wpautop');
+							break;
+					}
+
+					return $answer;
+				}
+			}
+		}
 
-        return '';
-    }
+		return '';
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -107,14 +107,14 @@ 
             ? $this->_extra_data['data']
             : $primary_registration;
 
-        if (! $primary_registration instanceof EE_Messages_Addressee) {
+        if ( ! $primary_registration instanceof EE_Messages_Addressee) {
             return '';
         }
 
         $attendee    = $primary_registration->primary_att_obj;
         $primary_reg = $primary_registration->primary_reg_obj;
 
-        if (! $attendee instanceof EE_Attendee || ! $primary_reg instanceof EE_Registration) {
+        if ( ! $attendee instanceof EE_Attendee || ! $primary_reg instanceof EE_Registration) {
             return '';
         }
 
@@ -158,7 +158,7 @@ 
                 return $country_obj instanceof EE_Country ? $country_obj->name() : '';
 
             case '[PRIMARY_REGISTRANT_REGISTRATION_DATE]':
-                if (! $primary_registration->primary_reg_obj instanceof EE_Registration) {
+                if ( ! $primary_registration->primary_reg_obj instanceof EE_Registration) {
                     return '';
                 }
                 return $primary_registration->primary_reg_obj->get_i18n_datetime('REG_date', get_option('date_format'));
@@ -181,10 +181,10 @@ 
                 if (
                     $question instanceof EE_Question
                     && trim($question->get('QST_display_text')) === trim($shortcode)
-                    && isset($primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ])
+                    && isset($primary_registration->registrations[$primary_reg->ID()]['ans_objs'][$ansid])
                 ) {
                     /** @var EE_Answer $primary_reg_ansid */
-                    $primary_reg_ansid = $primary_registration->registrations[ $primary_reg->ID() ]['ans_objs'][ $ansid ];
+                    $primary_reg_ansid = $primary_registration->registrations[$primary_reg->ID()]['ans_objs'][$ansid];
 
                     // what we show for the answer depends on the question type!
                     switch ($question->get('QST_type')) {

core/libraries/shortcodes/EE_Attendee_List_Shortcodes.lib.php

Indentation +162 added lines, -162 removed lines

@@ -18,166 +18,166 @@
  */
 class EE_Attendee_List_Shortcodes extends EE_Shortcodes
 {
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Attendee List Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to attendee lists', 'event_espresso');
-        $this->_shortcodes = [
-            '[ATTENDEE_LIST]' => esc_html__('Will output a list of attendees', 'event_espresso'),
-        ];
-    }
-
-
-    /**
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        if ($shortcode == '[ATTENDEE_LIST]') {
-            return $this->_get_attendee_list();
-        }
-        return '';
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_attendee_list()
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_attendee_list_for_main();
-        }
-        if ($this->_data['data'] instanceof EE_Event) {
-            return $this->_get_attendee_list_for_event();
-        }
-        if ($this->_data['data'] instanceof EE_Ticket) {
-            return $this->_get_registration_list_for_ticket();
-        }
-        // prevent recursive loop
-        return '';
-    }
-
-
-    /**
-     * This returns the parsed attendee list for main template;
-     */
-    private function _get_attendee_list_for_main()
-    {
-        $valid_shortcodes = ['attendee', 'event_list', 'ticket_list', 'question_list', 'recipient_details'];
-        $template         = $this->_data['template'];
-        $data             = $this->_data['data'];
-        $attendees        = '';
-
-
-        // now we need to loop through the attendee list and send data to the EE_Parser helper.
-        foreach ($data->reg_objs as $registration) {
-            $attendees .= $this->_shortcode_helper->parse_attendee_list_template(
-                $template,
-                $registration,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $attendees;
-    }
-
-
-    /**
-     * return parsed list of attendees for an event
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_attendee_list_for_event()
-    {
-        $valid_shortcodes = ['attendee', 'ticket_list', 'question_list', 'recipient_details'];
-        $template         = is_array($this->_data['template']) && isset($this->_data['template']['attendee_list'])
-            ? $this->_data['template']['attendee_list']
-            : $this->_extra_data['template']['attendee_list'];
-        $event            = $this->_data['data'];
-
-        // let's remove any existing [EVENT_LIST] shortcode from the attendee list template so that we don't get recursion.
-        $template = str_replace('[EVENT_LIST]', '', $template);
-
-        // here we're setting up the attendees for the attendee_list template for THIS event.
-        $att_result    = '';
-        $registrations = $this->_get_registrations_from_event($event);
-
-        // each attendee in this case should be an attendee object.
-        foreach ($registrations as $registration) {
-            $att_result .= $this->_shortcode_helper->parse_attendee_list_template(
-                $template,
-                $registration,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $att_result;
-    }
-
-
-    /**
-     * return parsed list of attendees for a ticket
-     *
-     * @return string
-     */
-    private function _get_registration_list_for_ticket()
-    {
-        $valid_shortcodes = ['attendee', 'event_list', 'question_list', 'recipient_details'];
-        $template         = is_array($this->_data['template']) && isset($this->_data['template']['attendee_list'])
-            ? $this->_data['template']['attendee_list']
-            : $this->_extra_data['template']['attendee_list'];
-        $ticket           = $this->_data['data'];
-
-        // let's remove any existing [TICKET_LIST] (or related) shortcode from the attendee list template so that we don't get recursion.
-        $template = str_replace('[TICKET_LIST]', '', $template);
-        $template = str_replace('[RECIPIENT_TICKET_LIST]', '', $template);
-        $template = str_replace('[PRIMARY_REGISTRANT_TICKET_LIST]', '', $template);
-
-        // here we're setting up the attendees for the attendee_list template for THIS ticket.
-        $att_result    = '';
-        $registrations =
-            isset($this->_extra_data['data']->tickets)
-                ? $this->_extra_data['data']->tickets[ $ticket->ID() ]['reg_objs']
-                : [];
-
-        // each attendee in this case should be an attendee object.
-        foreach ($registrations as $registration) {
-            $att_result .= $this->_shortcode_helper->parse_attendee_list_template(
-                $template,
-                $registration,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $att_result;
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return array|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_registrations_from_event(EE_Event $event)
-    {
-        return isset($this->_extra_data['data']->events)
-            ? $this->_extra_data['data']->events[ $event->ID() ]['reg_objs']
-            : [];
-    }
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Attendee List Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to attendee lists', 'event_espresso');
+		$this->_shortcodes = [
+			'[ATTENDEE_LIST]' => esc_html__('Will output a list of attendees', 'event_espresso'),
+		];
+	}
+
+
+	/**
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		if ($shortcode == '[ATTENDEE_LIST]') {
+			return $this->_get_attendee_list();
+		}
+		return '';
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_attendee_list()
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_attendee_list_for_main();
+		}
+		if ($this->_data['data'] instanceof EE_Event) {
+			return $this->_get_attendee_list_for_event();
+		}
+		if ($this->_data['data'] instanceof EE_Ticket) {
+			return $this->_get_registration_list_for_ticket();
+		}
+		// prevent recursive loop
+		return '';
+	}
+
+
+	/**
+	 * This returns the parsed attendee list for main template;
+	 */
+	private function _get_attendee_list_for_main()
+	{
+		$valid_shortcodes = ['attendee', 'event_list', 'ticket_list', 'question_list', 'recipient_details'];
+		$template         = $this->_data['template'];
+		$data             = $this->_data['data'];
+		$attendees        = '';
+
+
+		// now we need to loop through the attendee list and send data to the EE_Parser helper.
+		foreach ($data->reg_objs as $registration) {
+			$attendees .= $this->_shortcode_helper->parse_attendee_list_template(
+				$template,
+				$registration,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $attendees;
+	}
+
+
+	/**
+	 * return parsed list of attendees for an event
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_attendee_list_for_event()
+	{
+		$valid_shortcodes = ['attendee', 'ticket_list', 'question_list', 'recipient_details'];
+		$template         = is_array($this->_data['template']) && isset($this->_data['template']['attendee_list'])
+			? $this->_data['template']['attendee_list']
+			: $this->_extra_data['template']['attendee_list'];
+		$event            = $this->_data['data'];
+
+		// let's remove any existing [EVENT_LIST] shortcode from the attendee list template so that we don't get recursion.
+		$template = str_replace('[EVENT_LIST]', '', $template);
+
+		// here we're setting up the attendees for the attendee_list template for THIS event.
+		$att_result    = '';
+		$registrations = $this->_get_registrations_from_event($event);
+
+		// each attendee in this case should be an attendee object.
+		foreach ($registrations as $registration) {
+			$att_result .= $this->_shortcode_helper->parse_attendee_list_template(
+				$template,
+				$registration,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $att_result;
+	}
+
+
+	/**
+	 * return parsed list of attendees for a ticket
+	 *
+	 * @return string
+	 */
+	private function _get_registration_list_for_ticket()
+	{
+		$valid_shortcodes = ['attendee', 'event_list', 'question_list', 'recipient_details'];
+		$template         = is_array($this->_data['template']) && isset($this->_data['template']['attendee_list'])
+			? $this->_data['template']['attendee_list']
+			: $this->_extra_data['template']['attendee_list'];
+		$ticket           = $this->_data['data'];
+
+		// let's remove any existing [TICKET_LIST] (or related) shortcode from the attendee list template so that we don't get recursion.
+		$template = str_replace('[TICKET_LIST]', '', $template);
+		$template = str_replace('[RECIPIENT_TICKET_LIST]', '', $template);
+		$template = str_replace('[PRIMARY_REGISTRANT_TICKET_LIST]', '', $template);
+
+		// here we're setting up the attendees for the attendee_list template for THIS ticket.
+		$att_result    = '';
+		$registrations =
+			isset($this->_extra_data['data']->tickets)
+				? $this->_extra_data['data']->tickets[ $ticket->ID() ]['reg_objs']
+				: [];
+
+		// each attendee in this case should be an attendee object.
+		foreach ($registrations as $registration) {
+			$att_result .= $this->_shortcode_helper->parse_attendee_list_template(
+				$template,
+				$registration,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $att_result;
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return array|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_registrations_from_event(EE_Event $event)
+	{
+		return isset($this->_extra_data['data']->events)
+			? $this->_extra_data['data']->events[ $event->ID() ]['reg_objs']
+			: [];
+	}
 }

core/libraries/shortcodes/EE_Recipient_Details_Shortcodes.lib.php

Indentation +339 added lines, -339 removed lines

@@ -18,343 +18,343 @@
  */
 class EE_Recipient_Details_Shortcodes extends EE_Shortcodes
 {
-    protected $_recipient;
-
-    protected $_registrations_for_recipient;
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Recipient Details Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to recipient registration data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[RECIPIENT_FNAME]'                  => esc_html__(
-                'Parses to the first name of the recipient for the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_LNAME]'                  => esc_html__(
-                'Parses to the last name of the recipient for the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_EMAIL]'                  => esc_html__(
-                'Parses to the email address of the recipient for the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_REGISTRATION_ID]'        => esc_html__(
-                'Parses to the registration ID of the recipient for the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_REGISTRATION_CODE]'      => esc_html__(
-                'Parses to the registration code of the recipient for the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_EDIT_REGISTRATION_LINK]' => esc_html__(
-                'Parses to a link for frontend editing of the registration for the recipient.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_PHONE_NUMBER]'           => esc_html__(
-                'The Phone Number for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_ADDRESS]'                => esc_html__(
-                'The Address for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_ADDRESS2]'               => esc_html__(
-                'Whatever was in the address 2 field for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_CITY]'                   => esc_html__(
-                'The city for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_ZIP_PC]'                 => esc_html__(
-                'The ZIP (or Postal) Code for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_ADDRESS_STATE]'          => esc_html__(
-                'The state/province for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_COUNTRY]'                => esc_html__(
-                'The country for the recipient of the message.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_ANSWER_*]'               => esc_html__(
-                'This is a special dynamic shortcode.  After the "*", add the exact text of an existing question, and if there is an answer for that question for this recipient, then it will be output in place of this shortcode.',
-                'event_espresso'
-            ),
-            '[RECIPIENT_TOTAL_AMOUNT_PAID]'      => esc_html__(
-                'If a single registration related to the recipient is available, that is used to retrieve the total amount that has been paid for this recipient.  Otherwise the value of 0 is printed.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    /**
-     * @access protected
-     * @param string $shortcode the shortcode to be parsed.
-     * @return string parsed shortcode
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-
-        // make sure we end up with a copy of the EE_Messages_Addressee object
-        $this->_recipient = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $this->_recipient = ! $this->_recipient instanceof EE_Messages_Addressee
-                            && is_array($this->_data)
-                            && isset($this->_data['data'])
-                            && $this->_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_data['data']
-            :
-            $this->_recipient;
-        $this->_recipient = ! $this->_recipient instanceof EE_Messages_Addressee
-                            && ! empty($this->_extra_data['data'])
-                            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data']
-            : $this->_recipient;
-
-        if (! $this->_recipient instanceof EE_Messages_Addressee) {
-            return '';
-        }
-
-        $attendee = $this->_recipient->att_obj;
-        if (! $attendee instanceof EE_Attendee) {
-            return '';
-        }
-
-        $this->_registrations_for_recipient = isset($this->_recipient->attendees[ $attendee->ID() ]['reg_objs'])
-            ? $this->_recipient->attendees[ $attendee->ID() ]['reg_objs']
-            : array();
-
-        switch ($shortcode) {
-            case '[RECIPIENT_FNAME]':
-                return $attendee->fname();
-
-            case '[RECIPIENT_LNAME]':
-                return $attendee->lname();
-
-            case '[RECIPIENT_EMAIL]':
-                return $attendee->email();
-
-            case '[RECIPIENT_REGISTRATION_ID]':
-                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                return $this->_get_reg_id();
-
-            case '[RECIPIENT_REGISTRATION_CODE]':
-                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                return $this->_get_reg_code();
-
-            case '[RECIPIENT_EDIT_REGISTRATION_LINK]':
-                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                return $this->_recipient->reg_obj->edit_attendee_information_url();
-
-            case '[RECIPIENT_PHONE_NUMBER]':
-                return $attendee->phone();
-
-            case '[RECIPIENT_ADDRESS]':
-                return $attendee->address();
-
-            case '[RECIPIENT_ADDRESS2]':
-                return $attendee->address2();
-
-            case '[RECIPIENT_CITY]':
-                return $attendee->city();
-
-            case '[RECIPIENT_ZIP_PC]':
-                return $attendee->zip();
-
-            case '[RECIPIENT_ADDRESS_STATE]':
-                $state_obj = $attendee->state_obj();
-                return $state_obj instanceof EE_State ? $state_obj->name() : '';
-
-            case '[RECIPIENT_COUNTRY]':
-                $country_obj = $attendee->country_obj();
-                return $country_obj instanceof EE_Country ? $country_obj->name() : '';
-
-            case '[RECIPIENT_TOTAL_AMOUNT_PAID]':
-                return $this->_recipient->reg_obj instanceof EE_Registration
-                    ? $this->_recipient->reg_obj->pretty_paid()
-                    : 0;
-        }
-
-        if (strpos($shortcode, '[RECIPIENT_ANSWER_*') !== false) {
-            $shortcode = str_replace('[RECIPIENT_ANSWER_*', '', $shortcode);
-            $shortcode = trim(str_replace(']', '', $shortcode));
-
-
-            // now let's figure out what question has this text
-            if (empty($this->_recipient->questions) || ! $this->_recipient->reg_obj instanceof EE_Registration) {
-                return '';
-            }
-
-            foreach ($this->_recipient->questions as $ansid => $question) {
-                if (
-                    $question instanceof EE_Question
-                    && trim($question->display_text()) === trim($shortcode)
-                    && isset($this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ])
-                ) {
-                    $recipient_ansid = $this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ];
-
-                    // what we show for the answer depends on the question type!
-                    switch ($question->get('QST_type')) {
-                        case EEM_Question::QST_type_state:
-                            $state = EEM_State::instance()->get_one_by_ID($recipient_ansid->get('ANS_value'));
-                            $answer = $state instanceof EE_State ? $state->name() : '';
-                            break;
-
-                        case EEM_Question::QST_type_country:
-                            $country = EEM_Country::instance()->get_one_by_ID($recipient_ansid->get('ANS_value'));
-                            $answer = $country instanceof EE_Country ? $country->name() : '';
-                            break;
-
-                        default:
-                            $answer = $recipient_ansid->get_pretty('ANS_value', 'no_wpautop');
-                            break;
-                    }
-
-                    return $answer;
-                }
-            }
-        }
-
-        return '';
-    }
-
-
-    /**
-     * Returns the EE_Messages_Addressee object for the recipient.
-     *
-     * @since 4.5.0
-     *
-     * @return EE_Messages_Addressee
-     */
-    public function get_recipient()
-    {
-        return $this->_recipient;
-    }
-
-
-    /**
-     * returns the reg code for the recipient depending on the context and whether the recipient has multiple
-     * registrations or not.
-     *
-     * @return string
-     */
-    protected function _get_reg_code()
-    {
-
-        // if only one related registration for the recipient then just return that reg code.
-        if (count($this->_registrations_for_recipient) <= 1) {
-            return $this->_recipient->reg_obj->reg_code();
-        }
-
-        // k more than one registration so let's see if we can get specific to context
-        // are we parsing event_list?
-        if ($this->_data instanceof EE_Event) {
-            $reg_code = array();
-            // loop through registrations for recipient and see if there is a match for this event
-            foreach ($this->_registrations_for_recipient as $reg) {
-                if ($reg instanceof EE_Registration && $reg->event_ID() == $this->_data->ID()) {
-                    $reg_code[] = $reg->reg_code();
-                }
-            }
-            return implode(', ', $reg_code);
-        }
-
-        // are we parsing ticket list?
-        if ($this->_data instanceof EE_Ticket) {
-            $reg_code = array();
-            // loop through each registration for recipient and see if there is a match for this ticket
-            foreach ($this->_registrations_for_recipient as $reg) {
-                if ($reg instanceof EE_Registration && $reg->ticket_ID() == $this->_data->ID()) {
-                    $reg_code[] = $reg->reg_code();
-                }
-            }
-            return implode(', ', $reg_code);
-        }
-
-        // do we have a specific reg_obj?  Let's use it
-        if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
-            return $this->_data->reg_obj->reg_code();
-        }
-
-        // do we have a specific reg_obj?  Let's use it
-        if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
-            return $this->_data->reg_obj->reg_code();
-        }
-
-        // not able to determine the single reg code so let's return a comma delimited list of reg codes.
-        $reg_code = array();
-        foreach ($this->_registrations_for_recipient as $reg) {
-            if ($reg instanceof EE_Registration) {
-                $reg_code[] = $reg->reg_code();
-            }
-        }
-        return implode(', ', $reg_code);
-    }
-
-
-    /**
-     * returns the reg ID for the recipient depending on the context and whether the recipient has multiple
-     * registrations or not.
-     *
-     * @return int|string
-     */
-    protected function _get_reg_id()
-    {
-
-        // if only one related registration for the recipient then just return that reg code.
-        if (count($this->_registrations_for_recipient) <= 1) {
-            return $this->_recipient->reg_obj->ID();
-        }
-
-        // k more than one registration so let's see if we can get specific to context
-        // are we parsing event_list?
-        if ($this->_data instanceof EE_Event) {
-            $registration_ids = array();
-            // loop through registrations for recipient and see if there is a match for this event
-            foreach ($this->_registrations_for_recipient as $reg) {
-                if ($reg instanceof EE_Registration && $reg->event_ID() == $this->_data->ID()) {
-                    $registration_ids[] = $reg->ID();
-                }
-            }
-            return implode(', ', $registration_ids);
-        }
-
-        // are we parsing ticket list?
-        if ($this->_data instanceof EE_Ticket) {
-            $registration_ids = array();
-            // loop through each registration for recipient and see if there is a match for this ticket
-            foreach ($this->_registrations_for_recipient as $reg) {
-                if ($reg instanceof EE_Registration && $reg->ticket_ID() == $this->_data->ID()) {
-                    $registration_ids = $reg->ID();
-                }
-            }
-            return implode(', ', $registration_ids);
-        }
-
-        // do we have a specific reg_obj?  Let's use it
-        if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
-            return $this->_data->reg_obj->ID();
-        }
-
-        // not able to determine the single reg code so let's return a comma delimited list of reg codes.
-        $registration_ids = array();
-        foreach ($this->_registrations_for_recipient as $reg) {
-            if ($reg instanceof EE_Registration) {
-                $registration_ids[] = $reg->ID();
-            }
-        }
-        return implode(', ', $registration_ids);
-    }
+	protected $_recipient;
+
+	protected $_registrations_for_recipient;
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Recipient Details Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to recipient registration data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[RECIPIENT_FNAME]'                  => esc_html__(
+				'Parses to the first name of the recipient for the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_LNAME]'                  => esc_html__(
+				'Parses to the last name of the recipient for the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_EMAIL]'                  => esc_html__(
+				'Parses to the email address of the recipient for the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_REGISTRATION_ID]'        => esc_html__(
+				'Parses to the registration ID of the recipient for the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_REGISTRATION_CODE]'      => esc_html__(
+				'Parses to the registration code of the recipient for the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_EDIT_REGISTRATION_LINK]' => esc_html__(
+				'Parses to a link for frontend editing of the registration for the recipient.',
+				'event_espresso'
+			),
+			'[RECIPIENT_PHONE_NUMBER]'           => esc_html__(
+				'The Phone Number for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_ADDRESS]'                => esc_html__(
+				'The Address for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_ADDRESS2]'               => esc_html__(
+				'Whatever was in the address 2 field for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_CITY]'                   => esc_html__(
+				'The city for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_ZIP_PC]'                 => esc_html__(
+				'The ZIP (or Postal) Code for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_ADDRESS_STATE]'          => esc_html__(
+				'The state/province for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_COUNTRY]'                => esc_html__(
+				'The country for the recipient of the message.',
+				'event_espresso'
+			),
+			'[RECIPIENT_ANSWER_*]'               => esc_html__(
+				'This is a special dynamic shortcode.  After the "*", add the exact text of an existing question, and if there is an answer for that question for this recipient, then it will be output in place of this shortcode.',
+				'event_espresso'
+			),
+			'[RECIPIENT_TOTAL_AMOUNT_PAID]'      => esc_html__(
+				'If a single registration related to the recipient is available, that is used to retrieve the total amount that has been paid for this recipient.  Otherwise the value of 0 is printed.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $shortcode the shortcode to be parsed.
+	 * @return string parsed shortcode
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+
+		// make sure we end up with a copy of the EE_Messages_Addressee object
+		$this->_recipient = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$this->_recipient = ! $this->_recipient instanceof EE_Messages_Addressee
+							&& is_array($this->_data)
+							&& isset($this->_data['data'])
+							&& $this->_data['data'] instanceof EE_Messages_Addressee
+			? $this->_data['data']
+			:
+			$this->_recipient;
+		$this->_recipient = ! $this->_recipient instanceof EE_Messages_Addressee
+							&& ! empty($this->_extra_data['data'])
+							&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data']
+			: $this->_recipient;
+
+		if (! $this->_recipient instanceof EE_Messages_Addressee) {
+			return '';
+		}
+
+		$attendee = $this->_recipient->att_obj;
+		if (! $attendee instanceof EE_Attendee) {
+			return '';
+		}
+
+		$this->_registrations_for_recipient = isset($this->_recipient->attendees[ $attendee->ID() ]['reg_objs'])
+			? $this->_recipient->attendees[ $attendee->ID() ]['reg_objs']
+			: array();
+
+		switch ($shortcode) {
+			case '[RECIPIENT_FNAME]':
+				return $attendee->fname();
+
+			case '[RECIPIENT_LNAME]':
+				return $attendee->lname();
+
+			case '[RECIPIENT_EMAIL]':
+				return $attendee->email();
+
+			case '[RECIPIENT_REGISTRATION_ID]':
+				if (! $this->_recipient->reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				return $this->_get_reg_id();
+
+			case '[RECIPIENT_REGISTRATION_CODE]':
+				if (! $this->_recipient->reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				return $this->_get_reg_code();
+
+			case '[RECIPIENT_EDIT_REGISTRATION_LINK]':
+				if (! $this->_recipient->reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				return $this->_recipient->reg_obj->edit_attendee_information_url();
+
+			case '[RECIPIENT_PHONE_NUMBER]':
+				return $attendee->phone();
+
+			case '[RECIPIENT_ADDRESS]':
+				return $attendee->address();
+
+			case '[RECIPIENT_ADDRESS2]':
+				return $attendee->address2();
+
+			case '[RECIPIENT_CITY]':
+				return $attendee->city();
+
+			case '[RECIPIENT_ZIP_PC]':
+				return $attendee->zip();
+
+			case '[RECIPIENT_ADDRESS_STATE]':
+				$state_obj = $attendee->state_obj();
+				return $state_obj instanceof EE_State ? $state_obj->name() : '';
+
+			case '[RECIPIENT_COUNTRY]':
+				$country_obj = $attendee->country_obj();
+				return $country_obj instanceof EE_Country ? $country_obj->name() : '';
+
+			case '[RECIPIENT_TOTAL_AMOUNT_PAID]':
+				return $this->_recipient->reg_obj instanceof EE_Registration
+					? $this->_recipient->reg_obj->pretty_paid()
+					: 0;
+		}
+
+		if (strpos($shortcode, '[RECIPIENT_ANSWER_*') !== false) {
+			$shortcode = str_replace('[RECIPIENT_ANSWER_*', '', $shortcode);
+			$shortcode = trim(str_replace(']', '', $shortcode));
+
+
+			// now let's figure out what question has this text
+			if (empty($this->_recipient->questions) || ! $this->_recipient->reg_obj instanceof EE_Registration) {
+				return '';
+			}
+
+			foreach ($this->_recipient->questions as $ansid => $question) {
+				if (
+					$question instanceof EE_Question
+					&& trim($question->display_text()) === trim($shortcode)
+					&& isset($this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ])
+				) {
+					$recipient_ansid = $this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ];
+
+					// what we show for the answer depends on the question type!
+					switch ($question->get('QST_type')) {
+						case EEM_Question::QST_type_state:
+							$state = EEM_State::instance()->get_one_by_ID($recipient_ansid->get('ANS_value'));
+							$answer = $state instanceof EE_State ? $state->name() : '';
+							break;
+
+						case EEM_Question::QST_type_country:
+							$country = EEM_Country::instance()->get_one_by_ID($recipient_ansid->get('ANS_value'));
+							$answer = $country instanceof EE_Country ? $country->name() : '';
+							break;
+
+						default:
+							$answer = $recipient_ansid->get_pretty('ANS_value', 'no_wpautop');
+							break;
+					}
+
+					return $answer;
+				}
+			}
+		}
+
+		return '';
+	}
+
+
+	/**
+	 * Returns the EE_Messages_Addressee object for the recipient.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return EE_Messages_Addressee
+	 */
+	public function get_recipient()
+	{
+		return $this->_recipient;
+	}
+
+
+	/**
+	 * returns the reg code for the recipient depending on the context and whether the recipient has multiple
+	 * registrations or not.
+	 *
+	 * @return string
+	 */
+	protected function _get_reg_code()
+	{
+
+		// if only one related registration for the recipient then just return that reg code.
+		if (count($this->_registrations_for_recipient) <= 1) {
+			return $this->_recipient->reg_obj->reg_code();
+		}
+
+		// k more than one registration so let's see if we can get specific to context
+		// are we parsing event_list?
+		if ($this->_data instanceof EE_Event) {
+			$reg_code = array();
+			// loop through registrations for recipient and see if there is a match for this event
+			foreach ($this->_registrations_for_recipient as $reg) {
+				if ($reg instanceof EE_Registration && $reg->event_ID() == $this->_data->ID()) {
+					$reg_code[] = $reg->reg_code();
+				}
+			}
+			return implode(', ', $reg_code);
+		}
+
+		// are we parsing ticket list?
+		if ($this->_data instanceof EE_Ticket) {
+			$reg_code = array();
+			// loop through each registration for recipient and see if there is a match for this ticket
+			foreach ($this->_registrations_for_recipient as $reg) {
+				if ($reg instanceof EE_Registration && $reg->ticket_ID() == $this->_data->ID()) {
+					$reg_code[] = $reg->reg_code();
+				}
+			}
+			return implode(', ', $reg_code);
+		}
+
+		// do we have a specific reg_obj?  Let's use it
+		if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
+			return $this->_data->reg_obj->reg_code();
+		}
+
+		// do we have a specific reg_obj?  Let's use it
+		if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
+			return $this->_data->reg_obj->reg_code();
+		}
+
+		// not able to determine the single reg code so let's return a comma delimited list of reg codes.
+		$reg_code = array();
+		foreach ($this->_registrations_for_recipient as $reg) {
+			if ($reg instanceof EE_Registration) {
+				$reg_code[] = $reg->reg_code();
+			}
+		}
+		return implode(', ', $reg_code);
+	}
+
+
+	/**
+	 * returns the reg ID for the recipient depending on the context and whether the recipient has multiple
+	 * registrations or not.
+	 *
+	 * @return int|string
+	 */
+	protected function _get_reg_id()
+	{
+
+		// if only one related registration for the recipient then just return that reg code.
+		if (count($this->_registrations_for_recipient) <= 1) {
+			return $this->_recipient->reg_obj->ID();
+		}
+
+		// k more than one registration so let's see if we can get specific to context
+		// are we parsing event_list?
+		if ($this->_data instanceof EE_Event) {
+			$registration_ids = array();
+			// loop through registrations for recipient and see if there is a match for this event
+			foreach ($this->_registrations_for_recipient as $reg) {
+				if ($reg instanceof EE_Registration && $reg->event_ID() == $this->_data->ID()) {
+					$registration_ids[] = $reg->ID();
+				}
+			}
+			return implode(', ', $registration_ids);
+		}
+
+		// are we parsing ticket list?
+		if ($this->_data instanceof EE_Ticket) {
+			$registration_ids = array();
+			// loop through each registration for recipient and see if there is a match for this ticket
+			foreach ($this->_registrations_for_recipient as $reg) {
+				if ($reg instanceof EE_Registration && $reg->ticket_ID() == $this->_data->ID()) {
+					$registration_ids = $reg->ID();
+				}
+			}
+			return implode(', ', $registration_ids);
+		}
+
+		// do we have a specific reg_obj?  Let's use it
+		if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
+			return $this->_data->reg_obj->ID();
+		}
+
+		// not able to determine the single reg code so let's return a comma delimited list of reg codes.
+		$registration_ids = array();
+		foreach ($this->_registrations_for_recipient as $reg) {
+			if ($reg instanceof EE_Registration) {
+				$registration_ids[] = $reg->ID();
+			}
+		}
+		return implode(', ', $registration_ids);
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -117,17 +117,17 @@ 
             ? $this->_extra_data['data']
             : $this->_recipient;
 
-        if (! $this->_recipient instanceof EE_Messages_Addressee) {
+        if ( ! $this->_recipient instanceof EE_Messages_Addressee) {
             return '';
         }
 
         $attendee = $this->_recipient->att_obj;
-        if (! $attendee instanceof EE_Attendee) {
+        if ( ! $attendee instanceof EE_Attendee) {
             return '';
         }
 
-        $this->_registrations_for_recipient = isset($this->_recipient->attendees[ $attendee->ID() ]['reg_objs'])
-            ? $this->_recipient->attendees[ $attendee->ID() ]['reg_objs']
+        $this->_registrations_for_recipient = isset($this->_recipient->attendees[$attendee->ID()]['reg_objs'])
+            ? $this->_recipient->attendees[$attendee->ID()]['reg_objs']
             : array();
 
         switch ($shortcode) {
@@ -141,19 +141,19 @@ 
                 return $attendee->email();
 
             case '[RECIPIENT_REGISTRATION_ID]':
-                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
+                if ( ! $this->_recipient->reg_obj instanceof EE_Registration) {
                     return '';
                 }
                 return $this->_get_reg_id();
 
             case '[RECIPIENT_REGISTRATION_CODE]':
-                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
+                if ( ! $this->_recipient->reg_obj instanceof EE_Registration) {
                     return '';
                 }
                 return $this->_get_reg_code();
 
             case '[RECIPIENT_EDIT_REGISTRATION_LINK]':
-                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
+                if ( ! $this->_recipient->reg_obj instanceof EE_Registration) {
                     return '';
                 }
                 return $this->_recipient->reg_obj->edit_attendee_information_url();
@@ -201,9 +201,9 @@ 
                 if (
                     $question instanceof EE_Question
                     && trim($question->display_text()) === trim($shortcode)
-                    && isset($this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ])
+                    && isset($this->_recipient->registrations[$this->_recipient->reg_obj->ID()]['ans_objs'][$ansid])
                 ) {
-                    $recipient_ansid = $this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ];
+                    $recipient_ansid = $this->_recipient->registrations[$this->_recipient->reg_obj->ID()]['ans_objs'][$ansid];
 
                     // what we show for the answer depends on the question type!
                     switch ($question->get('QST_type')) {

core/libraries/shortcodes/EE_Payment_Shortcodes.lib.php

Indentation +69 added lines, -69 removed lines

@@ -16,87 +16,87 @@
  */
 class EE_Payment_Shortcodes extends EE_Shortcodes
 {
-    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 _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')
+		);
+	}
 
 
-    /**
-     * @param string $shortcode
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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 '';
-        }
+	/**
+	 * @param string $shortcode
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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;
+		$payment = $this->_data;
 
-        switch ($shortcode) {
-            case '[PAYMENT_TIMESTAMP]':
-                return $payment->timestamp();
+		switch ($shortcode) {
+			case '[PAYMENT_TIMESTAMP]':
+				return $payment->timestamp();
 
-            case '[PAYMENT_METHOD]':
-                // previously the column 'PAY_source' was known as 'PAY_method'
-                return $payment->source();
+			case '[PAYMENT_METHOD]':
+				// previously the column 'PAY_source' was known as 'PAY_method'
+				return $payment->source();
 
-            case '[PAYMENT_AMOUNT]':
-                return $payment->amount_no_code();
+			case '[PAYMENT_AMOUNT]':
+				return $payment->amount_no_code();
 
-            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');
-                }
+			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');
+				}
 
-            case '[PAYMENT_GATEWAY_RESPONSE]':
-                return $payment->gateway_response();
+			case '[PAYMENT_GATEWAY_RESPONSE]':
+				return $payment->gateway_response();
 
-            case '[PAYMENT_GATEWAY_TXN_ID]':
-                return $payment->txn_id_chq_nmbr();
+			case '[PAYMENT_GATEWAY_TXN_ID]':
+				return $payment->txn_id_chq_nmbr();
 
-            case '[PAYMENT_PO_NUMBER]':
-                return $payment->po_number();
+			case '[PAYMENT_PO_NUMBER]':
+				return $payment->po_number();
 
-            case '[PAYMENT_EXTRA_ACCOUNTING]':
-                return $payment->extra_accntng();
+			case '[PAYMENT_EXTRA_ACCOUNTING]':
+				return $payment->extra_accntng();
 
-            case '[PAYMENT_STATUS]':
-                return $payment->pretty_status();
+			case '[PAYMENT_STATUS]':
+				return $payment->pretty_status();
 
-            case '[PAYMENT_STATUS_WITH_ICONS]':
-                return $payment->pretty_status(true);
+			case '[PAYMENT_STATUS_WITH_ICONS]':
+				return $payment->pretty_status(true);
 
-            default:
-                return '';
-        }
-    }
+			default:
+				return '';
+		}
+	}
 }

core/libraries/shortcodes/EE_Transaction_Shortcodes.lib.php

Indentation +775 added lines, -775 removed lines

@@ -16,783 +16,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();
-
-            case '[PAYMENT_URL]':
-                $payment_url = $transaction->payment_overview_url();
-                return empty($payment_url)
-                    ? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
-                    : $payment_url;
-
-            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>'
-                );
-
-            case '[INVOICE_URL]':
-                $invoice_url = $transaction->invoice_url();
-                return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
-
-            case '[INVOICE_LOGO_URL]':
-                return $this->_get_invoice_logo();
-
-            case '[INVOICE_LOGO]':
-                return $this->_get_invoice_logo(true);
-
-            case '[INVOICE_PAYEE_NAME]':
-                return $this->_get_invoice_payee_name();
-
-            case '[INVOICE_PAYEE_ADDRESS]':
-                return $this->_get_invoice_payee_address();
-
-            case '[INVOICE_PAYMENT_INSTRUCTIONS]':
-                return $this->_get_invoice_payment_instructions();
-
-            case '[INVOICE_PAYEE_EMAIL]':
-                return $this->_get_invoice_payee_email();
-                break;
-            case '[TOTAL_COST]':
-                $total = $transaction->total();
-                return ! empty($total) ? EEH_Template::format_currency($total) : '';
-
-            // note the [payment_status] shortcode is kind of misleading because payment status might be different
-            // from txn status so I'm adding this here for clarity.
-            case '[PAYMENT_STATUS]':
-            case '[TXN_STATUS]':
-                $status = $transaction->pretty_status();
-                return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
-
-            case '[TXN_STATUS_ID]':
-                return $transaction->status_ID();
-
-            case '[PAYMENT_GATEWAY]':
-                return $this->_get_payment_gateway($transaction);
-
-            case '[AMOUNT_PAID]':
-                return $payment instanceof EE_Payment
-                    ? EEH_Template::format_currency($payment->amount())
-                    : EEH_Template::format_currency(0);
-
-            case '[LAST_AMOUNT_PAID]':
-                $last_payment = $transaction->last_payment();
-                return $last_payment instanceof EE_Payment
-                    ? EEH_Template::format_currency($last_payment->amount())
-                    : EEH_Template::format_currency(0);
-
-            case '[TOTAL_AMOUNT_PAID]':
-                return EEH_Template::format_currency($transaction->paid());
-
-            case '[TOTAL_OWING]':
-                $total_owing = $transaction->remaining();
-                return EEH_Template::format_currency($total_owing);
-
-            case '[TXN_SUBTOTAL]':
-                return EEH_Template::format_currency($this->_get_subtotal());
-
-            case '[TXN_TAX_SUBTOTAL]':
-                return EEH_Template::format_currency($this->_get_subtotal(true));
-
-            case '[TKT_QTY_PURCHASED]':
-            case '[TXN_TOTAL_TICKETS]':
-                return $this->_data->total_ticket_count;
-
-            case '[TRANSACTION_ADMIN_URL]':
-                require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
-                $query_args = array(
-                    'page'   => 'espresso_transactions',
-                    'action' => 'view_transaction',
-                    'TXN_ID' => $transaction->ID(),
-                );
-                return EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
-
-            case '[RECEIPT_URL]':
-                // get primary_registration
-                $reg = $this->_data->primary_reg_obj;
-                if (! $reg instanceof EE_Registration) {
-                    return '';
-                }
-                return $reg->receipt_url();
-
-            case '[INVOICE_RECEIPT_SWITCHER_URL]':
-                return $this->_get_invoice_receipt_switcher(false);
-
-            case '[INVOICE_RECEIPT_SWITCHER_BUTTON]':
-                return $this->_get_invoice_receipt_switcher();
-
-            case '[LAST_PAYMENT_TRANSACTION_ID]':
-                $id = '';
-                $payment = $payment instanceof EE_Payment && $payment->ID() !== 0
-                    ? $payment
-                    : $transaction->last_payment();
-                if ($payment instanceof EE_Payment) {
-                    $id = $payment->txn_id_chq_nmbr();
-                }
-                return $id;
-        }
-
-        if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) {
-            return $this->_get_custom_total_owing($shortcode);
-        }
-        if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) {
-            return $this->_get_invoice_payee_tax_number($shortcode);
-        }
-        if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) {
-            return $this->_get_payment_link_if_needed($shortcode);
-        }
-        if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) {
-            return $this->_get_payment_due_date($shortcode, $transaction);
-        }
-        return '';
-    }
-
-
-    /**
-     * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode
-     *
-     * @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).
-     *
-     * @param bool $img_tags TRUE means to return with the img tag wrappers.  False just returns the url to the image.
-     * @return string url or html
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    private function _get_invoice_logo(bool $img_tags = false): string
-    {
-        $invoice_logo_url = '';
-        // try to get the invoice payment method's logo for this transaction image first
-        $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;
-        }
-        $invoice_logo_url = esc_url_raw($invoice_logo_url);
-        // image tags have been requested.
-        $image_size = @getimagesize($invoice_logo_url);
-        $image_width_attr = '';
-        // if image is wider than 300px, set the width to 300
-        if ($image_size !== false) {
-            $image_width = min($image_size[0], 300);
-            $image_width = esc_attr($image_width);
-            $image_width_attr = " width='$image_width'";
-        }
-        return '<img class="logo screen" src="' . $invoice_logo_url . '"' . $image_width_attr . ' alt="logo" />';
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee name shortcode
-     *
-     * @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();
+
+			case '[PAYMENT_URL]':
+				$payment_url = $transaction->payment_overview_url();
+				return empty($payment_url)
+					? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
+					: $payment_url;
+
+			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>'
+				);
+
+			case '[INVOICE_URL]':
+				$invoice_url = $transaction->invoice_url();
+				return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
+
+			case '[INVOICE_LOGO_URL]':
+				return $this->_get_invoice_logo();
+
+			case '[INVOICE_LOGO]':
+				return $this->_get_invoice_logo(true);
+
+			case '[INVOICE_PAYEE_NAME]':
+				return $this->_get_invoice_payee_name();
+
+			case '[INVOICE_PAYEE_ADDRESS]':
+				return $this->_get_invoice_payee_address();
+
+			case '[INVOICE_PAYMENT_INSTRUCTIONS]':
+				return $this->_get_invoice_payment_instructions();
+
+			case '[INVOICE_PAYEE_EMAIL]':
+				return $this->_get_invoice_payee_email();
+				break;
+			case '[TOTAL_COST]':
+				$total = $transaction->total();
+				return ! empty($total) ? EEH_Template::format_currency($total) : '';
+
+			// note the [payment_status] shortcode is kind of misleading because payment status might be different
+			// from txn status so I'm adding this here for clarity.
+			case '[PAYMENT_STATUS]':
+			case '[TXN_STATUS]':
+				$status = $transaction->pretty_status();
+				return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
+
+			case '[TXN_STATUS_ID]':
+				return $transaction->status_ID();
+
+			case '[PAYMENT_GATEWAY]':
+				return $this->_get_payment_gateway($transaction);
+
+			case '[AMOUNT_PAID]':
+				return $payment instanceof EE_Payment
+					? EEH_Template::format_currency($payment->amount())
+					: EEH_Template::format_currency(0);
+
+			case '[LAST_AMOUNT_PAID]':
+				$last_payment = $transaction->last_payment();
+				return $last_payment instanceof EE_Payment
+					? EEH_Template::format_currency($last_payment->amount())
+					: EEH_Template::format_currency(0);
+
+			case '[TOTAL_AMOUNT_PAID]':
+				return EEH_Template::format_currency($transaction->paid());
+
+			case '[TOTAL_OWING]':
+				$total_owing = $transaction->remaining();
+				return EEH_Template::format_currency($total_owing);
+
+			case '[TXN_SUBTOTAL]':
+				return EEH_Template::format_currency($this->_get_subtotal());
+
+			case '[TXN_TAX_SUBTOTAL]':
+				return EEH_Template::format_currency($this->_get_subtotal(true));
+
+			case '[TKT_QTY_PURCHASED]':
+			case '[TXN_TOTAL_TICKETS]':
+				return $this->_data->total_ticket_count;
+
+			case '[TRANSACTION_ADMIN_URL]':
+				require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
+				$query_args = array(
+					'page'   => 'espresso_transactions',
+					'action' => 'view_transaction',
+					'TXN_ID' => $transaction->ID(),
+				);
+				return EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
+
+			case '[RECEIPT_URL]':
+				// get primary_registration
+				$reg = $this->_data->primary_reg_obj;
+				if (! $reg instanceof EE_Registration) {
+					return '';
+				}
+				return $reg->receipt_url();
+
+			case '[INVOICE_RECEIPT_SWITCHER_URL]':
+				return $this->_get_invoice_receipt_switcher(false);
+
+			case '[INVOICE_RECEIPT_SWITCHER_BUTTON]':
+				return $this->_get_invoice_receipt_switcher();
+
+			case '[LAST_PAYMENT_TRANSACTION_ID]':
+				$id = '';
+				$payment = $payment instanceof EE_Payment && $payment->ID() !== 0
+					? $payment
+					: $transaction->last_payment();
+				if ($payment instanceof EE_Payment) {
+					$id = $payment->txn_id_chq_nmbr();
+				}
+				return $id;
+		}
+
+		if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) {
+			return $this->_get_custom_total_owing($shortcode);
+		}
+		if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) {
+			return $this->_get_invoice_payee_tax_number($shortcode);
+		}
+		if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) {
+			return $this->_get_payment_link_if_needed($shortcode);
+		}
+		if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) {
+			return $this->_get_payment_due_date($shortcode, $transaction);
+		}
+		return '';
+	}
+
+
+	/**
+	 * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode
+	 *
+	 * @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).
+	 *
+	 * @param bool $img_tags TRUE means to return with the img tag wrappers.  False just returns the url to the image.
+	 * @return string url or html
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	private function _get_invoice_logo(bool $img_tags = false): string
+	{
+		$invoice_logo_url = '';
+		// try to get the invoice payment method's logo for this transaction image first
+		$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;
+		}
+		$invoice_logo_url = esc_url_raw($invoice_logo_url);
+		// image tags have been requested.
+		$image_size = @getimagesize($invoice_logo_url);
+		$image_width_attr = '';
+		// if image is wider than 300px, set the width to 300
+		if ($image_size !== false) {
+			$image_width = min($image_size[0], 300);
+			$image_width = esc_attr($image_width);
+			$image_width_attr = " width='$image_width'";
+		}
+		return '<img class="logo screen" src="' . $invoice_logo_url . '"' . $image_width_attr . ' alt="logo" />';
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee name shortcode
+	 *
+	 * @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

@@ -268,7 +268,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) {
@@ -286,7 +286,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>'
                 );
 
@@ -358,7 +358,7 @@ 
                 return $this->_data->total_ticket_count;
 
             case '[TRANSACTION_ADMIN_URL]':
-                require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
+                require_once EE_CORE.'admin/EE_Admin_Page.core.php';
                 $query_args = array(
                     'page'   => 'espresso_transactions',
                     'action' => 'view_transaction',
@@ -369,7 +369,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();
@@ -489,7 +489,7 @@ 
         if (empty($invoice_logo_url)) {
             return '';
         }
-        if (! $img_tags) {
+        if ( ! $img_tags) {
             return $invoice_logo_url;
         }
         $invoice_logo_url = esc_url_raw($invoice_logo_url);
@@ -502,7 +502,7 @@ 
             $image_width = esc_attr($image_width);
             $image_width_attr = " width='$image_width'";
         }
-        return '<img class="logo screen" src="' . $invoice_logo_url . '"' . $image_width_attr . ' alt="logo" />';
+        return '<img class="logo screen" src="'.$invoice_logo_url.'"'.$image_width_attr.' alt="logo" />';
     }
 
 
@@ -539,7 +539,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)
@@ -607,7 +607,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;
     }
 
 
@@ -631,16 +631,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;
@@ -676,7 +676,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;
@@ -684,13 +684,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>
 			';
         }
@@ -708,7 +708,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();
@@ -735,11 +735,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,
@@ -781,7 +781,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();
@@ -793,6 +793,6 @@ 
                 'event_espresso'
             );
         }
-        return $prefix_text . $date_due;
+        return $prefix_text.$date_due;
     }
 }

core/libraries/shortcodes/EE_Messenger_Shortcodes.lib.php

Indentation +157 added lines, -157 removed lines

@@ -22,165 +22,165 @@
  */
 class EE_Messenger_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * Hold array of active messengers indexed by messenger name.
-     *
-     * @since 4.5.0
-     *
-     * @var EE_messenger[]
-     */
-    protected $_active_messengers = array();
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Messenger Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes that are messenger specific.', 'event_espresso');
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        // add messages about what happens  when the messenger is active.
-        $this->_active_messengers = $message_resource_manager->active_messengers();
-
-        $this->_shortcodes['[DISPLAY_HTML_URL]'] = esc_html__(
-            'This will return a link to view the template in a browser if the html messenger is active.',
-            'event_espresso'
-        );
-        $this->_shortcodes['[DISPLAY_PDF_URL]'] = esc_html__(
-            'This will return a link to generate a pdf for the template if the pdf messenger is active.',
-            'event_espresso'
-        );
-        $this->_shortcodes['[DISPLAY_PDF_BUTTON]'] = esc_html__(
-            'This will return html for a download pdf button trigger if the pdf messenger is active.',
-            'event_espresso'
-        );
-
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $action = $request->getRequestParam('action');
-        // show error message about buttons/urls not working as expected if messenger deactivated.
-        if ($action === 'update_message_template' && is_admin()) {
-            if (! isset($this->_active_messengers['pdf'])) {
-                EE_Error::add_attention(
-                    esc_html__(
-                        'Be aware that the pdf messenger is inactive.  This means that any pdf related shortcodes will parse to an empty string.',
-                        'event_espresso'
-                    )
-                );
-            }
-
-            if (! isset($this->_active_messengers['html'])) {
-                EE_Error::add_attention(
-                    esc_html__(
-                        'Be aware that the html messenger is inactive. This means that any html related shortcodes will parse to an empty string.',
-                        'event_espresso'
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * @param string $shortcode
-     * @throws EE_Error
-     */
-    protected function _parser($shortcode)
-    {
-        // make sure we end up with a copy of the EE_Messages_Addressee object
-        $recipient = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee
-            && is_array($this->_data)
-            && isset($this->_data['data'])
-            && $this->_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_data['data']
-                : $recipient;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee
-            && ! empty($this->_extra_data['data'])
-            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']
-                : $recipient;
-
-        if (! $recipient instanceof EE_Messages_Addressee) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[DISPLAY_HTML_URL]':
-                return isset($this->_active_messengers['html']) ? $this->_get_url($recipient, 'html') : '';
-
-            case '[DISPLAY_PDF_URL]':
-                return isset($this->_active_messengers['pdf']) ? $this->_get_url($recipient, 'pdf') : '';
-
-            case '[DISPLAY_PDF_BUTTON]':
-                return isset($this->_active_messengers['pdf']) ? $this->_get_button($recipient, 'pdf') : '';
-        }
-        return '';
-    }
-
-
-    /**
-     * This method takes the incoming data and figures out from it what the message type is and evt_id/grp_id and uses
-     * that to generate the html for a button in the template.
-     *
-     * @since 4.5.0
-     *
-     * @param EE_Messages_Addressee $recipient
-     * @param string                $sending_messenger 'html' or 'pdf'
-     *
-     * @return string                Generated html
-     */
-    private function _get_button(EE_Messages_Addressee $recipient, $sending_messenger)
-    {
-        $download_text = $sending_messenger == 'pdf'
-            ? esc_html__('Download PDF', 'event_espresso')
-            : esc_html__(
-                'Show HTML',
-                'event_espresso'
-            );
-        $content = '
+	/**
+	 * Hold array of active messengers indexed by messenger name.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var EE_messenger[]
+	 */
+	protected $_active_messengers = array();
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Messenger Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes that are messenger specific.', 'event_espresso');
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		// add messages about what happens  when the messenger is active.
+		$this->_active_messengers = $message_resource_manager->active_messengers();
+
+		$this->_shortcodes['[DISPLAY_HTML_URL]'] = esc_html__(
+			'This will return a link to view the template in a browser if the html messenger is active.',
+			'event_espresso'
+		);
+		$this->_shortcodes['[DISPLAY_PDF_URL]'] = esc_html__(
+			'This will return a link to generate a pdf for the template if the pdf messenger is active.',
+			'event_espresso'
+		);
+		$this->_shortcodes['[DISPLAY_PDF_BUTTON]'] = esc_html__(
+			'This will return html for a download pdf button trigger if the pdf messenger is active.',
+			'event_espresso'
+		);
+
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$action = $request->getRequestParam('action');
+		// show error message about buttons/urls not working as expected if messenger deactivated.
+		if ($action === 'update_message_template' && is_admin()) {
+			if (! isset($this->_active_messengers['pdf'])) {
+				EE_Error::add_attention(
+					esc_html__(
+						'Be aware that the pdf messenger is inactive.  This means that any pdf related shortcodes will parse to an empty string.',
+						'event_espresso'
+					)
+				);
+			}
+
+			if (! isset($this->_active_messengers['html'])) {
+				EE_Error::add_attention(
+					esc_html__(
+						'Be aware that the html messenger is inactive. This means that any html related shortcodes will parse to an empty string.',
+						'event_espresso'
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $shortcode
+	 * @throws EE_Error
+	 */
+	protected function _parser($shortcode)
+	{
+		// make sure we end up with a copy of the EE_Messages_Addressee object
+		$recipient = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee
+			&& is_array($this->_data)
+			&& isset($this->_data['data'])
+			&& $this->_data['data'] instanceof EE_Messages_Addressee
+				? $this->_data['data']
+				: $recipient;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee
+			&& ! empty($this->_extra_data['data'])
+			&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']
+				: $recipient;
+
+		if (! $recipient instanceof EE_Messages_Addressee) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[DISPLAY_HTML_URL]':
+				return isset($this->_active_messengers['html']) ? $this->_get_url($recipient, 'html') : '';
+
+			case '[DISPLAY_PDF_URL]':
+				return isset($this->_active_messengers['pdf']) ? $this->_get_url($recipient, 'pdf') : '';
+
+			case '[DISPLAY_PDF_BUTTON]':
+				return isset($this->_active_messengers['pdf']) ? $this->_get_button($recipient, 'pdf') : '';
+		}
+		return '';
+	}
+
+
+	/**
+	 * This method takes the incoming data and figures out from it what the message type is and evt_id/grp_id and uses
+	 * that to generate the html for a button in the template.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param EE_Messages_Addressee $recipient
+	 * @param string                $sending_messenger 'html' or 'pdf'
+	 *
+	 * @return string                Generated html
+	 */
+	private function _get_button(EE_Messages_Addressee $recipient, $sending_messenger)
+	{
+		$download_text = $sending_messenger == 'pdf'
+			? esc_html__('Download PDF', 'event_espresso')
+			: esc_html__(
+				'Show HTML',
+				'event_espresso'
+			);
+		$content = '
 <form method="post" action="' . $this->_get_url($recipient, $sending_messenger) . '" >
 	<input class="print_button" type="submit" value="' . $download_text . '" />
 </form>
 		';
-        return $content;
-    }
-
-
-    /**
-     * This method takes the incoming data and figures out from it what the message type is and
-     * evt_id/grp_id and uses that to generate the url for displaying the template in a browser.
-     *
-     * @since 4.5.0
-     *
-     * @param EE_Messages_Addressee $recipient
-     * @param string                $sending_messenger
-     *
-     * @return string The generated url for displaying the link.
-     * @throws EE_Error
-     */
-    private function _get_url(EE_Messages_Addressee $recipient, $sending_messenger)
-    {
-
-        $reg = $recipient->reg_obj;
-        $reg = ! $reg instanceof EE_Registration ? $recipient->primary_reg_obj : $reg;
-
-
-        if ($this->_message_type instanceof EE_message_type && $this->_message instanceof EE_Message) {
-            EE_Registry::instance()->load_helper('MSG_Template');
-            try {
-                return EEH_MSG_Template::get_url_trigger(
-                    $this->_message_type,
-                    $this->_message,
-                    $reg,
-                    $sending_messenger
-                );
-            } catch (EE_Error $e) {
-                if (WP_DEBUG) {
-                    $e->get_error();
-                }
-            }
-        }
-
-        return '';
-    }
+		return $content;
+	}
+
+
+	/**
+	 * This method takes the incoming data and figures out from it what the message type is and
+	 * evt_id/grp_id and uses that to generate the url for displaying the template in a browser.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param EE_Messages_Addressee $recipient
+	 * @param string                $sending_messenger
+	 *
+	 * @return string The generated url for displaying the link.
+	 * @throws EE_Error
+	 */
+	private function _get_url(EE_Messages_Addressee $recipient, $sending_messenger)
+	{
+
+		$reg = $recipient->reg_obj;
+		$reg = ! $reg instanceof EE_Registration ? $recipient->primary_reg_obj : $reg;
+
+
+		if ($this->_message_type instanceof EE_message_type && $this->_message instanceof EE_Message) {
+			EE_Registry::instance()->load_helper('MSG_Template');
+			try {
+				return EEH_MSG_Template::get_url_trigger(
+					$this->_message_type,
+					$this->_message,
+					$reg,
+					$sending_messenger
+				);
+			} catch (EE_Error $e) {
+				if (WP_DEBUG) {
+					$e->get_error();
+				}
+			}
+		}
+
+		return '';
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -59,7 +59,7 @@ 
         $action = $request->getRequestParam('action');
         // show error message about buttons/urls not working as expected if messenger deactivated.
         if ($action === 'update_message_template' && is_admin()) {
-            if (! isset($this->_active_messengers['pdf'])) {
+            if ( ! isset($this->_active_messengers['pdf'])) {
                 EE_Error::add_attention(
                     esc_html__(
                         'Be aware that the pdf messenger is inactive.  This means that any pdf related shortcodes will parse to an empty string.',
@@ -68,7 +68,7 @@ 
                 );
             }
 
-            if (! isset($this->_active_messengers['html'])) {
+            if ( ! isset($this->_active_messengers['html'])) {
                 EE_Error::add_attention(
                     esc_html__(
                         'Be aware that the html messenger is inactive. This means that any html related shortcodes will parse to an empty string.',
@@ -100,7 +100,7 @@ 
                 ? $this->_extra_data['data']
                 : $recipient;
 
-        if (! $recipient instanceof EE_Messages_Addressee) {
+        if ( ! $recipient instanceof EE_Messages_Addressee) {
             return '';
         }
 
@@ -138,8 +138,8 @@ 
                 'event_espresso'
             );
         $content = '
-<form method="post" action="' . $this->_get_url($recipient, $sending_messenger) . '" >
-	<input class="print_button" type="submit" value="' . $download_text . '" />
+<form method="post" action="' . $this->_get_url($recipient, $sending_messenger).'" >
+	<input class="print_button" type="submit" value="' . $download_text.'" />
 </form>
 		';
         return $content;

core/libraries/shortcodes/EE_Venue_Shortcodes.lib.php

Indentation +295 added lines, -295 removed lines

@@ -15,299 +15,299 @@
  */
 class EE_Venue_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * 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');
-
-            case '[VENUE_DESCRIPTION]':
-                return $this->_venue('description');
-
-            case '[VENUE_URL]':
-                return $this->_venue('url');
-
-            case '[VENUE_IMAGE]':
-                return $this->_venue('image');
-
-            case '[VENUE_PHONE]':
-                return $this->_venue('phone');
-
-            case '[VENUE_ADDRESS]':
-                return $this->_venue('address');
-
-            case '[VENUE_ADDRESS2]':
-                return $this->_venue('address2');
-
-            case '[VENUE_CITY]':
-                return $this->_venue('city');
-
-            case '[VENUE_COUNTRY]':
-                return $this->_venue('country');
-
-            case '[VENUE_STATE]':
-                return $this->_venue('state');
-
-            case '[VENUE_ZIP]':
-                return $this->_venue('zip');
-
-            case '[VENUE_FORMATTED_ADDRESS]':
-                return $this->_venue('formatted_address');
-
-            case '[GOOGLE_MAP_URL]':
-                return $this->_venue('gmap_url');
-
-            case '[GOOGLE_MAP_LINK]':
-                return $this->_venue('gmap_link');
-
-            case '[GOOGLE_MAP_IMAGE]':
-                return $this->_venue('gmap_link_img');
-
-            case '[VENUE_DETAILS_URL]':
-                return $this->_venue('permalink');
-        }
-
-        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');
+
+			case '[VENUE_DESCRIPTION]':
+				return $this->_venue('description');
+
+			case '[VENUE_URL]':
+				return $this->_venue('url');
+
+			case '[VENUE_IMAGE]':
+				return $this->_venue('image');
+
+			case '[VENUE_PHONE]':
+				return $this->_venue('phone');
+
+			case '[VENUE_ADDRESS]':
+				return $this->_venue('address');
+
+			case '[VENUE_ADDRESS2]':
+				return $this->_venue('address2');
+
+			case '[VENUE_CITY]':
+				return $this->_venue('city');
+
+			case '[VENUE_COUNTRY]':
+				return $this->_venue('country');
+
+			case '[VENUE_STATE]':
+				return $this->_venue('state');
+
+			case '[VENUE_ZIP]':
+				return $this->_venue('zip');
+
+			case '[VENUE_FORMATTED_ADDRESS]':
+				return $this->_venue('formatted_address');
+
+			case '[GOOGLE_MAP_URL]':
+				return $this->_venue('gmap_url');
+
+			case '[GOOGLE_MAP_LINK]':
+				return $this->_venue('gmap_link');
+
+			case '[GOOGLE_MAP_IMAGE]':
+				return $this->_venue('gmap_link_img');
+
+			case '[VENUE_DETAILS_URL]':
+				return $this->_venue('permalink');
+		}
+
+		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;
+	}
 }