eventespresso / event-espresso-core

core/libraries/messages/messenger/EE_Email_messenger.class.php

Spacing +9 added lines, -9 removed lines

@@ -56,7 +56,7 @@ 
             ),
             '<code>wp_mail</code>'
         );
-        $this->label               = array(
+        $this->label = array(
             'singular' => esc_html__('email', 'event_espresso'),
             'plural'   => esc_html__('emails', 'event_espresso'),
         );
@@ -438,7 +438,7 @@ 
             $this->_body(),
             $this->_headers()
         );
-        if (! $success) {
+        if ( ! $success) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -482,8 +482,8 @@ 
         $this->_ensure_has_from_email_address();
         $from    = $this->_from;
         $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
+            'From:'.$from,
+            'Reply-To:'.$from,
             'Content-Type:text/html; charset=utf-8',
         );
 
@@ -492,8 +492,8 @@ 
          * cover back compat where there may be users who have saved cc values in their db for the newsletter message
          * type which they are no longer able to change.
          */
-        if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
-            $headers[] = 'cc: ' . $this->_cc;
+        if ( ! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
+            $headers[] = 'cc: '.$this->_cc;
         }
 
         // but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
@@ -600,7 +600,7 @@ 
             'from'      => $this->_from,
             'main_body' => wpautop($this->_content),
         );
-        $body                 = $this->_get_main_template($preview);
+        $body = $this->_get_main_template($preview);
 
         /**
          * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
@@ -610,10 +610,10 @@ 
          */
         if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
             // require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+            require_once EE_THIRD_PARTY.'cssinliner/vendor/autoload.php';
 
             // now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
+            if ( ! $preview || ($preview && defined('DOING_AJAX'))) {
                 $style = file_get_contents(
                     $this->get_variation(
                         $this->_tmp_pack,

Indentation +644 added lines, -644 removed lines

@@ -5,648 +5,648 @@
  */
 class EE_Email_messenger extends EE_messenger
 {
-    /**
-     * To field for email
-     * @var string
-     */
-    protected $_to = '';
-
-
-    /**
-     * CC field for email.
-     * @var string
-     */
-    protected $_cc = '';
-
-    /**
-     * From field for email
-     * @var string
-     */
-    protected $_from = '';
-
-
-    /**
-     * Subject field for email
-     * @var string
-     */
-    protected $_subject = '';
-
-
-    /**
-     * Content field for email
-     * @var string
-     */
-    protected $_content = '';
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
-        // set name and description properties
-        $this->name                = 'email';
-        $this->description         = sprintf(
-            esc_html__(
-                'This messenger delivers messages via email using the built-in %s function included with WordPress',
-                'event_espresso'
-            ),
-            '<code>wp_mail</code>'
-        );
-        $this->label               = array(
-            'singular' => esc_html__('email', 'event_espresso'),
-            'plural'   => esc_html__('emails', 'event_espresso'),
-        );
-        $this->activate_on_install = true;
-
-        // we're using defaults so let's call parent constructor that will take care of setting up all the other
-        // properties
-        parent::__construct();
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(
-            'events_edit' => true,
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     */
-    protected function _set_valid_shortcodes()
-    {
-        // remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
-        // message type.
-        $this->_valid_shortcodes = array(
-            'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_validator_config()
-    {
-        $valid_shortcodes = $this->get_valid_shortcodes();
-
-        $this->_validator_config = array(
-            'to'            => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type'       => 'email',
-            ),
-            'cc' => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type' => 'email',
-            ),
-            'from'          => array(
-                'shortcodes' => $valid_shortcodes['from'],
-                'type'       => 'email',
-            ),
-            'subject'       => array(
-                'shortcodes' => array(
-                    'organization',
-                    'primary_registration_details',
-                    'event_author',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-            ),
-            'content'       => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket_list',
-                    'organization',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                    'transaction',
-                    'messenger',
-                ),
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
-                'required'   => array('[ATTENDEE_LIST]'),
-            ),
-            'event_list'    => array(
-                'shortcodes' => array(
-                    'event',
-                    'attendee_list',
-                    'ticket_list',
-                    'venue',
-                    'datetime_list',
-                    'attendee',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                ),
-                'required'   => array('[EVENT_LIST]'),
-            ),
-            'ticket_list'   => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-                'required'   => array('[TICKET_LIST]'),
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required'   => array('[DATETIME_LIST]'),
-            ),
-        );
-    }
-
-
-    /**
-     * @see   parent EE_messenger class for docs
-     * @since 4.5.0
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name === 'html') {
-            add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        }
-    }
-
-
-    public function add_email_css(
-        $variation_path,
-        $messenger,
-        $message_type,
-        $type,
-        $variation,
-        $file_extension,
-        $url,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        // prevent recursion on this callback.
-        remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
-        $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
-
-        add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        return $variation;
-    }
-
-
-    /**
-     * See parent for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_test_settings_fields()
-    {
-        $this->_test_settings_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html__('Send a test email to', 'event_espresso'),
-                'type'       => 'email',
-                'required'   => false,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-                'default'    => get_bloginfo('admin_email'),
-            ),
-            'subject' => array(
-                'input'      => 'hidden',
-                'label'      => '',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => false,
-                'format'     => '%s',
-                'value'      => sprintf(esc_html__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
-                'default'    => '',
-                'css_class'  => '',
-            ),
-        );
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger but will get used by a messenger field for
-        // shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
-        // they relate to.  This is important for the Messages_admin to know what fields to display to the user.
-        //  Also, notice that the "values" are equal to the field type that messages admin will use to know what
-        // kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
-        // indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
-        // displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
-        // will not be displayed/parsed.
-        $this->_template_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'To',
-                    'Label for the "To" field for email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'cc'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'CC',
-                    'Label for the "Carbon Copy" field used for additional email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'from'    => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'From',
-                    'Label for the "From" field for email addresses.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'subject' => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'Subject',
-                    'Label for the "Subject" field (short description of contents) for emails.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'content' => '',
-            // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra'   => array(
-                'content' => array(
-                    'main'          => array(
-                        'input'      => 'wp_editor',
-                        'label'      => esc_html__('Main Content', 'event_espresso'),
-                        'type'       => 'string',
-                        'required'   => true,
-                        'validation' => true,
-                        'format'     => '%s',
-                        'rows'       => '15',
-                    ),
-                    'event_list'    => array(
-                        'input'               => 'wp_editor',
-                        'label'               => '[EVENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'rows'                => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]'),
-                    ),
-                    'attendee_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[ATTENDEE_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]'),
-                    ),
-                    'ticket_list'   => array(
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]'),
-                    ),
-                    'datetime_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[DATETIME_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[DATETIME_LIST]'),
-                    ),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * See definition of this class in parent
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = array(
-            'payment',
-            'payment_refund',
-            'registration',
-            'not_approved_registration',
-            'pending_approval',
-        );
-    }
-
-
-    /**
-     * @see   definition of this class in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array(
-            'payment',
-            'registration',
-            'not_approved_registration',
-            'declined_registration',
-            'cancelled_registration',
-            'pending_approval',
-            'registration_summary',
-            'payment_reminder',
-            'payment_declined',
-            'payment_refund',
-        );
-    }
-
-
-    /**
-     * setting up admin_settings_fields for messenger.
-     */
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-    /**
-     * We just deliver the messages don't kill us!!
-     *
-     * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
-     *              present.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _send_message()
-    {
-        $success = wp_mail(
-            $this->_to,
-            // some old values for subject may be expecting HTML entities to be decoded in the subject
-            // and subjects aren't interpreted as HTML, so there should be no HTML in them
-            wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)),
-            $this->_body(),
-            $this->_headers()
-        );
-        if (! $success) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
-                        'event_espresso'
-                    ),
-                    $this->_to,
-                    $this->_from,
-                    '<br />'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     * see parent for definition
-     *
-     * @return string html body of the message content and the related css.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _preview()
-    {
-        return $this->_body(true);
-    }
-
-
-    /**
-     * Setup headers for email
-     *
-     * @access protected
-     * @return string formatted header for email
-     */
-    protected function _headers()
-    {
-        $this->_ensure_has_from_email_address();
-        $from    = $this->_from;
-        $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
-            'Content-Type:text/html; charset=utf-8',
-        );
-
-        /**
-         * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to
-         * cover back compat where there may be users who have saved cc values in their db for the newsletter message
-         * type which they are no longer able to change.
-         */
-        if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
-            $headers[] = 'cc: ' . $this->_cc;
-        }
-
-        // but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
-        // header.
-        add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
-        add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
-        return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
-    }
-
-
-    /**
-     * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
-     * address for the from address to avoid problems with sending emails.
-     */
-    protected function _ensure_has_from_email_address()
-    {
-        if (empty($this->_from)) {
-            $this->_from = get_bloginfo('admin_email');
-        }
-    }
-
-
-    /**
-     * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
-     * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
-     * be empty
-     *
-     * @since 4.3.1
-     * @return array
-     */
-    private function _parse_from()
-    {
-        if (strpos($this->_from, '<') !== false) {
-            $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
-            $from_name = str_replace('"', '', $from_name);
-            $from_name = trim($from_name);
-
-            $from_email = substr($this->_from, strpos($this->_from, '<') + 1);
-            $from_email = str_replace('>', '', $from_email);
-            $from_email = trim($from_email);
-        } elseif (trim($this->_from) !== '') {
-            $from_name  = '';
-            $from_email = trim($this->_from);
-        } else {
-            $from_name = $from_email = '';
-        }
-        return array($from_name, $from_email);
-    }
-
-
-    /**
-     * Callback for the wp_mail_from filter.
-     *
-     * @since 4.3.1
-     * @param string $from_email What the original from_email is.
-     * @return string
-     */
-    public function set_from_address($from_email)
-    {
-        $parsed_from = $this->_parse_from();
-        // includes fallback if the parsing failed.
-        $from_email = is_array($parsed_from) && ! empty($parsed_from[1])
-            ? $parsed_from[1]
-            : get_bloginfo('admin_email');
-        return $from_email;
-    }
-
-
-    /**
-     * Callback fro the wp_mail_from_name filter.
-     *
-     * @since 4.3.1
-     * @param string $from_name The original from_name.
-     * @return string
-     */
-    public function set_from_name($from_name)
-    {
-        $parsed_from = $this->_parse_from();
-        if (is_array($parsed_from) && ! empty($parsed_from[0])) {
-            $from_name = $parsed_from[0];
-        }
-
-        // if from name is "WordPress" let's sub in the site name instead (more friendly!)
-        // but realize the default name is HTML entity-encoded
-        $from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name;
-
-        return $from_name;
-    }
-
-
-    /**
-     * setup body for email
-     *
-     * @param bool $preview will determine whether this is preview template or not.
-     * @return string formatted body for email.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _body($preview = false)
-    {
-        // setup template args!
-        $this->_template_args = array(
-            'subject'   => $this->_subject,
-            'from'      => $this->_from,
-            'main_body' => wpautop($this->_content),
-        );
-        $body                 = $this->_get_main_template($preview);
-
-        /**
-         * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
-         *
-         * @type    bool $preview Indicates whether a preview is being generated or not.
-         * @return  bool    true  indicates to use the inliner, false bypasses it.
-         */
-        if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
-            // require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
-
-            // now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
-                $style = file_get_contents(
-                    $this->get_variation(
-                        $this->_tmp_pack,
-                        $this->_incoming_message_type->name,
-                        false,
-                        'main',
-                        $this->_variation
-                    ),
-                    true
-                );
-                $CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
-                // for some reason the library has a bracket and new line at the beginning.  This takes care of that.
-                $body  = ltrim($CSS->convert(true), ">\n");
-                // see https://events.codebasehq.com/projects/event-espresso/tickets/8609
-                $body  = ltrim($body, "<?");
-            }
-        }
-        return $body;
-    }
-
-
-    /**
-     * This just returns any existing test settings that might be saved in the database
-     *
-     * @access public
-     * @return array
-     */
-    public function get_existing_test_settings()
-    {
-        $settings = parent::get_existing_test_settings();
-        // override subject if present because we always want it to be fresh.
-        if (is_array($settings) && ! empty($settings['subject'])) {
-            $settings['subject'] = sprintf(esc_html__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
-        }
-        return $settings;
-    }
+	/**
+	 * To field for email
+	 * @var string
+	 */
+	protected $_to = '';
+
+
+	/**
+	 * CC field for email.
+	 * @var string
+	 */
+	protected $_cc = '';
+
+	/**
+	 * From field for email
+	 * @var string
+	 */
+	protected $_from = '';
+
+
+	/**
+	 * Subject field for email
+	 * @var string
+	 */
+	protected $_subject = '';
+
+
+	/**
+	 * Content field for email
+	 * @var string
+	 */
+	protected $_content = '';
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
+		// set name and description properties
+		$this->name                = 'email';
+		$this->description         = sprintf(
+			esc_html__(
+				'This messenger delivers messages via email using the built-in %s function included with WordPress',
+				'event_espresso'
+			),
+			'<code>wp_mail</code>'
+		);
+		$this->label               = array(
+			'singular' => esc_html__('email', 'event_espresso'),
+			'plural'   => esc_html__('emails', 'event_espresso'),
+		);
+		$this->activate_on_install = true;
+
+		// we're using defaults so let's call parent constructor that will take care of setting up all the other
+		// properties
+		parent::__construct();
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true,
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		// remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
+		// message type.
+		$this->_valid_shortcodes = array(
+			'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_validator_config()
+	{
+		$valid_shortcodes = $this->get_valid_shortcodes();
+
+		$this->_validator_config = array(
+			'to'            => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type'       => 'email',
+			),
+			'cc' => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type' => 'email',
+			),
+			'from'          => array(
+				'shortcodes' => $valid_shortcodes['from'],
+				'type'       => 'email',
+			),
+			'subject'       => array(
+				'shortcodes' => array(
+					'organization',
+					'primary_registration_details',
+					'event_author',
+					'primary_registration_details',
+					'recipient_details',
+				),
+			),
+			'content'       => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket_list',
+					'organization',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+					'transaction',
+					'messenger',
+				),
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
+				'required'   => array('[ATTENDEE_LIST]'),
+			),
+			'event_list'    => array(
+				'shortcodes' => array(
+					'event',
+					'attendee_list',
+					'ticket_list',
+					'venue',
+					'datetime_list',
+					'attendee',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+				),
+				'required'   => array('[EVENT_LIST]'),
+			),
+			'ticket_list'   => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'recipient_details',
+				),
+				'required'   => array('[TICKET_LIST]'),
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required'   => array('[DATETIME_LIST]'),
+			),
+		);
+	}
+
+
+	/**
+	 * @see   parent EE_messenger class for docs
+	 * @since 4.5.0
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name === 'html') {
+			add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		}
+	}
+
+
+	public function add_email_css(
+		$variation_path,
+		$messenger,
+		$message_type,
+		$type,
+		$variation,
+		$file_extension,
+		$url,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		// prevent recursion on this callback.
+		remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
+		$variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
+
+		add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		return $variation;
+	}
+
+
+	/**
+	 * See parent for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_test_settings_fields()
+	{
+		$this->_test_settings_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html__('Send a test email to', 'event_espresso'),
+				'type'       => 'email',
+				'required'   => false,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+				'default'    => get_bloginfo('admin_email'),
+			),
+			'subject' => array(
+				'input'      => 'hidden',
+				'label'      => '',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => false,
+				'format'     => '%s',
+				'value'      => sprintf(esc_html__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
+				'default'    => '',
+				'css_class'  => '',
+			),
+		);
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for
+		// shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
+		// they relate to.  This is important for the Messages_admin to know what fields to display to the user.
+		//  Also, notice that the "values" are equal to the field type that messages admin will use to know what
+		// kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
+		// indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
+		// displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
+		// will not be displayed/parsed.
+		$this->_template_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'To',
+					'Label for the "To" field for email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'cc'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'CC',
+					'Label for the "Carbon Copy" field used for additional email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'from'    => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'From',
+					'Label for the "From" field for email addresses.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'subject' => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'Subject',
+					'Label for the "Subject" field (short description of contents) for emails.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'content' => '',
+			// left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra'   => array(
+				'content' => array(
+					'main'          => array(
+						'input'      => 'wp_editor',
+						'label'      => esc_html__('Main Content', 'event_espresso'),
+						'type'       => 'string',
+						'required'   => true,
+						'validation' => true,
+						'format'     => '%s',
+						'rows'       => '15',
+					),
+					'event_list'    => array(
+						'input'               => 'wp_editor',
+						'label'               => '[EVENT_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'rows'                => '15',
+						'shortcodes_required' => array('[EVENT_LIST]'),
+					),
+					'attendee_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[ATTENDEE_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]'),
+					),
+					'ticket_list'   => array(
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[TICKET_LIST]'),
+					),
+					'datetime_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[DATETIME_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[DATETIME_LIST]'),
+					),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * See definition of this class in parent
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = array(
+			'payment',
+			'payment_refund',
+			'registration',
+			'not_approved_registration',
+			'pending_approval',
+		);
+	}
+
+
+	/**
+	 * @see   definition of this class in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array(
+			'payment',
+			'registration',
+			'not_approved_registration',
+			'declined_registration',
+			'cancelled_registration',
+			'pending_approval',
+			'registration_summary',
+			'payment_reminder',
+			'payment_declined',
+			'payment_refund',
+		);
+	}
+
+
+	/**
+	 * setting up admin_settings_fields for messenger.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+	/**
+	 * We just deliver the messages don't kill us!!
+	 *
+	 * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
+	 *              present.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _send_message()
+	{
+		$success = wp_mail(
+			$this->_to,
+			// some old values for subject may be expecting HTML entities to be decoded in the subject
+			// and subjects aren't interpreted as HTML, so there should be no HTML in them
+			wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)),
+			$this->_body(),
+			$this->_headers()
+		);
+		if (! $success) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
+						'event_espresso'
+					),
+					$this->_to,
+					$this->_from,
+					'<br />'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 * see parent for definition
+	 *
+	 * @return string html body of the message content and the related css.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _preview()
+	{
+		return $this->_body(true);
+	}
+
+
+	/**
+	 * Setup headers for email
+	 *
+	 * @access protected
+	 * @return string formatted header for email
+	 */
+	protected function _headers()
+	{
+		$this->_ensure_has_from_email_address();
+		$from    = $this->_from;
+		$headers = array(
+			'From:' . $from,
+			'Reply-To:' . $from,
+			'Content-Type:text/html; charset=utf-8',
+		);
+
+		/**
+		 * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to
+		 * cover back compat where there may be users who have saved cc values in their db for the newsletter message
+		 * type which they are no longer able to change.
+		 */
+		if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
+			$headers[] = 'cc: ' . $this->_cc;
+		}
+
+		// but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
+		// header.
+		add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
+		add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
+		return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
+	}
+
+
+	/**
+	 * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
+	 * address for the from address to avoid problems with sending emails.
+	 */
+	protected function _ensure_has_from_email_address()
+	{
+		if (empty($this->_from)) {
+			$this->_from = get_bloginfo('admin_email');
+		}
+	}
+
+
+	/**
+	 * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
+	 * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
+	 * be empty
+	 *
+	 * @since 4.3.1
+	 * @return array
+	 */
+	private function _parse_from()
+	{
+		if (strpos($this->_from, '<') !== false) {
+			$from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
+			$from_name = str_replace('"', '', $from_name);
+			$from_name = trim($from_name);
+
+			$from_email = substr($this->_from, strpos($this->_from, '<') + 1);
+			$from_email = str_replace('>', '', $from_email);
+			$from_email = trim($from_email);
+		} elseif (trim($this->_from) !== '') {
+			$from_name  = '';
+			$from_email = trim($this->_from);
+		} else {
+			$from_name = $from_email = '';
+		}
+		return array($from_name, $from_email);
+	}
+
+
+	/**
+	 * Callback for the wp_mail_from filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_email What the original from_email is.
+	 * @return string
+	 */
+	public function set_from_address($from_email)
+	{
+		$parsed_from = $this->_parse_from();
+		// includes fallback if the parsing failed.
+		$from_email = is_array($parsed_from) && ! empty($parsed_from[1])
+			? $parsed_from[1]
+			: get_bloginfo('admin_email');
+		return $from_email;
+	}
+
+
+	/**
+	 * Callback fro the wp_mail_from_name filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_name The original from_name.
+	 * @return string
+	 */
+	public function set_from_name($from_name)
+	{
+		$parsed_from = $this->_parse_from();
+		if (is_array($parsed_from) && ! empty($parsed_from[0])) {
+			$from_name = $parsed_from[0];
+		}
+
+		// if from name is "WordPress" let's sub in the site name instead (more friendly!)
+		// but realize the default name is HTML entity-encoded
+		$from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name;
+
+		return $from_name;
+	}
+
+
+	/**
+	 * setup body for email
+	 *
+	 * @param bool $preview will determine whether this is preview template or not.
+	 * @return string formatted body for email.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _body($preview = false)
+	{
+		// setup template args!
+		$this->_template_args = array(
+			'subject'   => $this->_subject,
+			'from'      => $this->_from,
+			'main_body' => wpautop($this->_content),
+		);
+		$body                 = $this->_get_main_template($preview);
+
+		/**
+		 * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
+		 *
+		 * @type    bool $preview Indicates whether a preview is being generated or not.
+		 * @return  bool    true  indicates to use the inliner, false bypasses it.
+		 */
+		if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
+			// require CssToInlineStyles library and its dependencies via composer autoloader
+			require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+
+			// now if this isn't a preview, let's setup the body so it has inline styles
+			if (! $preview || ($preview && defined('DOING_AJAX'))) {
+				$style = file_get_contents(
+					$this->get_variation(
+						$this->_tmp_pack,
+						$this->_incoming_message_type->name,
+						false,
+						'main',
+						$this->_variation
+					),
+					true
+				);
+				$CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
+				// for some reason the library has a bracket and new line at the beginning.  This takes care of that.
+				$body  = ltrim($CSS->convert(true), ">\n");
+				// see https://events.codebasehq.com/projects/event-espresso/tickets/8609
+				$body  = ltrim($body, "<?");
+			}
+		}
+		return $body;
+	}
+
+
+	/**
+	 * This just returns any existing test settings that might be saved in the database
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_existing_test_settings()
+	{
+		$settings = parent::get_existing_test_settings();
+		// override subject if present because we always want it to be fresh.
+		if (is_array($settings) && ! empty($settings['subject'])) {
+			$settings['subject'] = sprintf(esc_html__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
+		}
+		return $settings;
+	}
 }

core/libraries/messages/EE_Messages_Data_Handler_Collection.lib.php

Spacing +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
      */
     public function get_key($classname, $data)
     {
-        return md5($classname . serialize($data));
+        return md5($classname.serialize($data));
     }
 
 

Indentation +52 added lines, -52 removed lines

@@ -9,69 +9,69 @@
  */
 class EE_Messages_Data_Handler_Collection extends EE_Object_Collection
 {
-    public function __construct()
-    {
-        $this->interface = 'EE_Messages_incoming_data';
-    }
+	public function __construct()
+	{
+		$this->interface = 'EE_Messages_incoming_data';
+	}
 
 
-    /**
-     * This adds the EE_Messages_incoming_data data handler object to the collection.
-     *
-     * @param EE_Messages_incoming_data  $data_handler
-     * @param mixed                      $data           Usually an array of data used in combination with the $data_handler
-     *                                                   classname to create an alternative index for retrieving data_handlers.
-     * @return bool
-     */
-    public function add($data_handler, $data = ''): bool
-    {
-        $data = $data === null ? array() : (array) $data;
-        $info['key'] = $this->get_key(get_class($data_handler), $data);
-        return parent::add($data_handler, $info);
-    }
+	/**
+	 * This adds the EE_Messages_incoming_data data handler object to the collection.
+	 *
+	 * @param EE_Messages_incoming_data  $data_handler
+	 * @param mixed                      $data           Usually an array of data used in combination with the $data_handler
+	 *                                                   classname to create an alternative index for retrieving data_handlers.
+	 * @return bool
+	 */
+	public function add($data_handler, $data = ''): bool
+	{
+		$data = $data === null ? array() : (array) $data;
+		$info['key'] = $this->get_key(get_class($data_handler), $data);
+		return parent::add($data_handler, $info);
+	}
 
 
 
 
 
-    /**
-     * This returns a key for retrieving data for the given references used to generate the key.
-     * Data handlers are cached to the repository along with a md5() generated key using known references.
-     * @param string    $classname      The classname of the datahandler being checked for.
-     * @param mixed     $data           The data that was used to instantiate the data_handler.
-     *
-     * @return  string      md5 hash using provided info.
-     */
-    public function get_key($classname, $data)
-    {
-        return md5($classname . serialize($data));
-    }
+	/**
+	 * This returns a key for retrieving data for the given references used to generate the key.
+	 * Data handlers are cached to the repository along with a md5() generated key using known references.
+	 * @param string    $classname      The classname of the datahandler being checked for.
+	 * @param mixed     $data           The data that was used to instantiate the data_handler.
+	 *
+	 * @return  string      md5 hash using provided info.
+	 */
+	public function get_key($classname, $data)
+	{
+		return md5($classname . serialize($data));
+	}
 
 
 
 
 
 
-    /**
-     * This returns a saved EE_Messages_incoming_data object if there is one in the repository indexed by a key matching
-     * the given string.
-     *
-     * @param string  $key  @see EE_Messages_Data_Handler_Collection::get_key() to setup a key formatted for searching.
-     *
-     * @return null|EE_Messages_incoming_data
-     */
-    public function get_by_key($key)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $data = $this->getInfo();
-            if (isset($data['key']) && $data['key'] === $key) {
-                $handler = $this->current();
-                $this->rewind();
-                return $handler;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	/**
+	 * This returns a saved EE_Messages_incoming_data object if there is one in the repository indexed by a key matching
+	 * the given string.
+	 *
+	 * @param string  $key  @see EE_Messages_Data_Handler_Collection::get_key() to setup a key formatted for searching.
+	 *
+	 * @return null|EE_Messages_incoming_data
+	 */
+	public function get_by_key($key)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$data = $this->getInfo();
+			if (isset($data['key']) && $data['key'] === $key) {
+				$handler = $this->current();
+				$this->rewind();
+				return $handler;
+			}
+			$this->next();
+		}
+		return null;
+	}
 }

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

Spacing +3 added lines, -3 removed lines

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

Indentation +88 added lines, -88 removed lines

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

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

Spacing +3 added lines, -3 removed lines

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

Indentation +132 added lines, -132 removed lines

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

core/libraries/messages/EE_Message_To_Generate_From_Queue.php

Spacing +1 added lines, -1 removed lines

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

Indentation +77 added lines, -77 removed lines

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

core/libraries/shortcodes/EE_Line_Item_List_Shortcodes.lib.php

Spacing +10 added lines, -10 removed lines

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

Indentation +198 added lines, -198 removed lines

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

core/libraries/shortcodes/EE_Line_Item_Shortcodes.lib.php

Spacing +2 added lines, -2 removed lines

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

Indentation +51 added lines, -51 removed lines

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

core/libraries/shortcodes/EE_Datetime_Shortcodes.lib.php

Spacing +2 added lines, -2 removed lines

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

Indentation +68 added lines, -68 removed lines

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

core/libraries/shortcodes/EE_Venue_Shortcodes.lib.php

Spacing +7 added lines, -7 removed lines

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

Indentation +311 added lines, -311 removed lines

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