eventespresso / event-espresso-core

core/admin/EE_Help_Tour.core.php

Spacing +3 added lines, -3 removed lines

@@ -256,8 +256,8 @@ 
     public function get_stops()
     {
         foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+            if ( ! isset($stop['button_text'])) {
+                $this->_stops[$ind]['button_text'] = $this->_options['button_text'];
             }
         }
         return $this->_stops;
@@ -277,6 +277,6 @@ 
                 $this->_options['pauseAfter'][] = $ind;
             }
         }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+        return apply_filters('FHEE__'.get_class($this).'__get_options', $this->_options, $this);
     }
 }

Indentation +267 added lines, -267 removed lines

@@ -17,271 +17,271 @@
  */
 abstract class EE_Help_Tour extends EE_Base
 {
-    /**
-     * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
-     * constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_label = '';
-
-
-    /**
-     * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
-     * cookies for the tour. Set this in the constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_slug = '';
-
-
-    /**
-     * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
-     * setting up a tour on a given page. format for array is: array(
-     *        0 => array(
-     *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
-     *            precendence even if you also set class.
-     *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
-     *            this param. The first element for that class is the anchor. If the class or the id are empty then the
-     *            stop will be a modal on the page anchored to the main body.
-     *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
-     *            'button_text' => 'custom text for button', //optional
-     *            'content' => 'The content for the stop', //required
-     *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
-     *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
-     *            when this tour has been set to run on timer.
-     *            'options' => array(
-     *                //override any of the global options set via the help_tour "option_callback" for the joyride
-     *                instance on this specific stop.
-     *                )
-     *            )
-     *        );
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_stops = array();
-
-
-    /**
-     * This contains any stop specific options for the tour.
-     * defaults are set but child classes can override.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_options = array();
-
-
-    /**
-     * holds anything found in the request object (however we override any _gets with _post data).
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_req_data = array();
-
-
-    /**
-     * a flag that is set on init for whether this help_tour is happening on a caf install or not.
-     *
-     * @var boolean
-     */
-    protected $_is_caf = false;
-
-
-    /**
-     * _constructor
-     * initialized the tour object and sets up important properties required to setup the tour.
-     *
-     * @access public
-     * @param boolean $caf used to indicate if this tour is happening on caf install or not.
-     * @return void
-     */
-    public function __construct($caf = false)
-    {
-        $this->_is_caf = $caf;
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $this->_req_data = $request->requestParams();
-        $this->_set_tour_properties();
-        $this->_set_tour_stops();
-        $this->_set_tour_options();
-
-        // make sure the last tour stop has "end tour" for its button
-        $end = array_pop($this->_stops);
-        $end['button_text'] = esc_html__('End Tour', 'event_espresso');
-        // add back to stops
-        $this->_stops[] = $end;
-    }
-
-
-    /**
-     * required method that has the sole purpose of setting up the tour $_label and $_slug properties
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_properties();
-
-
-    /**
-     * required method that's sole purpose is to setup the $_stops property
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_stops();
-
-
-    /**
-     * The method can optionally be overridden by child classes to set the _options array if there are any default
-     * options the child wishes to override for a this tour. See property definition for more info
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_tour_options($options = array())
-    {
-        $defaults = array(
-            'tipLocation'           => 'bottom',
-            // 'top', 'bottom', 'right', 'left' in relation to parent
-            'nubPosition'           => 'auto',
-            // override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
-            'tipAdjustmentY'        => 0,
-            // allow for adjustment of tip
-            'tipAdjustmentX'        => 0,
-            // allow for adjustment of tip
-            'scroll'                => true,
-            // whether to scrollTo the next step or not
-            'scrollSpeed'           => 300,
-            // Page scrolling speed in ms
-            'timer'                 => 0,
-            // 0 = off, all other numbers = time(ms)
-            'autoStart'             => true,
-            // true or false - false tour starts when restart called
-            'startTimerOnClick'     => true,
-            // true/false to start timer on first click
-            'nextButton'            => true,
-            // true/false for next button visibility
-            'button_text'           => esc_html__('Next', 'event_espresso'),
-            'tipAnimation'          => 'fade',
-            // 'pop' or 'fade' in each tip
-            'pauseAfter'            => array(),
-            // array of indexes where to pause the tour after
-            'tipAnimationFadeSpeed' => 300,
-            // if 'fade'- speed in ms of transition
-            'cookieMonster'         => true,
-            // true/false for whether cookies are used
-            'cookieName'            => $this->get_slug(),
-            // choose your own cookie name (setup will add the prefix for the specific page joyride)
-            // set to false or yoursite.com
-            'cookieDomain'          => false,
-            // Where the tip be attached if not inline
-            // 'tipContainer' => 'body',
-            'modal'                 => false,
-            // Whether to cover page with modal during the tour
-            'expose'                => false,
-            // Whether to expose the elements at each step in the tour (requires modal:true),
-            'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
-            // A method to call after an element has been exposed
-            'preRideCallback'       => 'EEHelpTour_preRideCallback',
-            // A method to call before the tour starts (passed index, tip, and cloned exposed element)
-            'postRideCallback'      => 'EEHelpTour_postRideCallback',
-            // a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
-            'preStepCallback'       => 'EEHelpTour_preStepCallback',
-            // A method to call before each step
-            'postStepCallback'      => 'EEHelpTour_postStepCallback',
-            // A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
-        );
-
-        $options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
-        $this->_options = $options;
-    }
-
-
-    /**
-     * getter functions to return all the properties for the tour.
-     */
-
-
-    /**
-     * get_slug
-     *
-     * @return string slug for the tour
-     */
-    public function get_slug()
-    {
-        if (empty($this->_slug)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_slug;
-    }
-
-
-    /**
-     * get_label
-     *
-     * @return string
-     */
-    public function get_label()
-    {
-        if (empty($this->_label)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_label;
-    }
-
-
-    /**
-     * get_stops
-     *
-     * @return array
-     */
-    public function get_stops()
-    {
-        foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
-            }
-        }
-        return $this->_stops;
-    }
-
-
-    /**
-     * get options
-     *
-     * @return array
-     */
-    public function get_options()
-    {
-        // let's make sure there are not pauses set
-        foreach ($this->_stops as $ind => $stop) {
-            if (isset($stop['pause_after']) && $stop['pause_after']) {
-                $this->_options['pauseAfter'][] = $ind;
-            }
-        }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
-    }
+	/**
+	 * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
+	 * constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_label = '';
+
+
+	/**
+	 * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
+	 * cookies for the tour. Set this in the constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_slug = '';
+
+
+	/**
+	 * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
+	 * setting up a tour on a given page. format for array is: array(
+	 *        0 => array(
+	 *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
+	 *            precendence even if you also set class.
+	 *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
+	 *            this param. The first element for that class is the anchor. If the class or the id are empty then the
+	 *            stop will be a modal on the page anchored to the main body.
+	 *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
+	 *            'button_text' => 'custom text for button', //optional
+	 *            'content' => 'The content for the stop', //required
+	 *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
+	 *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
+	 *            when this tour has been set to run on timer.
+	 *            'options' => array(
+	 *                //override any of the global options set via the help_tour "option_callback" for the joyride
+	 *                instance on this specific stop.
+	 *                )
+	 *            )
+	 *        );
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_stops = array();
+
+
+	/**
+	 * This contains any stop specific options for the tour.
+	 * defaults are set but child classes can override.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_options = array();
+
+
+	/**
+	 * holds anything found in the request object (however we override any _gets with _post data).
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_req_data = array();
+
+
+	/**
+	 * a flag that is set on init for whether this help_tour is happening on a caf install or not.
+	 *
+	 * @var boolean
+	 */
+	protected $_is_caf = false;
+
+
+	/**
+	 * _constructor
+	 * initialized the tour object and sets up important properties required to setup the tour.
+	 *
+	 * @access public
+	 * @param boolean $caf used to indicate if this tour is happening on caf install or not.
+	 * @return void
+	 */
+	public function __construct($caf = false)
+	{
+		$this->_is_caf = $caf;
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$this->_req_data = $request->requestParams();
+		$this->_set_tour_properties();
+		$this->_set_tour_stops();
+		$this->_set_tour_options();
+
+		// make sure the last tour stop has "end tour" for its button
+		$end = array_pop($this->_stops);
+		$end['button_text'] = esc_html__('End Tour', 'event_espresso');
+		// add back to stops
+		$this->_stops[] = $end;
+	}
+
+
+	/**
+	 * required method that has the sole purpose of setting up the tour $_label and $_slug properties
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_properties();
+
+
+	/**
+	 * required method that's sole purpose is to setup the $_stops property
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_stops();
+
+
+	/**
+	 * The method can optionally be overridden by child classes to set the _options array if there are any default
+	 * options the child wishes to override for a this tour. See property definition for more info
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_tour_options($options = array())
+	{
+		$defaults = array(
+			'tipLocation'           => 'bottom',
+			// 'top', 'bottom', 'right', 'left' in relation to parent
+			'nubPosition'           => 'auto',
+			// override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
+			'tipAdjustmentY'        => 0,
+			// allow for adjustment of tip
+			'tipAdjustmentX'        => 0,
+			// allow for adjustment of tip
+			'scroll'                => true,
+			// whether to scrollTo the next step or not
+			'scrollSpeed'           => 300,
+			// Page scrolling speed in ms
+			'timer'                 => 0,
+			// 0 = off, all other numbers = time(ms)
+			'autoStart'             => true,
+			// true or false - false tour starts when restart called
+			'startTimerOnClick'     => true,
+			// true/false to start timer on first click
+			'nextButton'            => true,
+			// true/false for next button visibility
+			'button_text'           => esc_html__('Next', 'event_espresso'),
+			'tipAnimation'          => 'fade',
+			// 'pop' or 'fade' in each tip
+			'pauseAfter'            => array(),
+			// array of indexes where to pause the tour after
+			'tipAnimationFadeSpeed' => 300,
+			// if 'fade'- speed in ms of transition
+			'cookieMonster'         => true,
+			// true/false for whether cookies are used
+			'cookieName'            => $this->get_slug(),
+			// choose your own cookie name (setup will add the prefix for the specific page joyride)
+			// set to false or yoursite.com
+			'cookieDomain'          => false,
+			// Where the tip be attached if not inline
+			// 'tipContainer' => 'body',
+			'modal'                 => false,
+			// Whether to cover page with modal during the tour
+			'expose'                => false,
+			// Whether to expose the elements at each step in the tour (requires modal:true),
+			'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
+			// A method to call after an element has been exposed
+			'preRideCallback'       => 'EEHelpTour_preRideCallback',
+			// A method to call before the tour starts (passed index, tip, and cloned exposed element)
+			'postRideCallback'      => 'EEHelpTour_postRideCallback',
+			// a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
+			'preStepCallback'       => 'EEHelpTour_preStepCallback',
+			// A method to call before each step
+			'postStepCallback'      => 'EEHelpTour_postStepCallback',
+			// A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
+		);
+
+		$options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
+		$this->_options = $options;
+	}
+
+
+	/**
+	 * getter functions to return all the properties for the tour.
+	 */
+
+
+	/**
+	 * get_slug
+	 *
+	 * @return string slug for the tour
+	 */
+	public function get_slug()
+	{
+		if (empty($this->_slug)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_slug;
+	}
+
+
+	/**
+	 * get_label
+	 *
+	 * @return string
+	 */
+	public function get_label()
+	{
+		if (empty($this->_label)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_label;
+	}
+
+
+	/**
+	 * get_stops
+	 *
+	 * @return array
+	 */
+	public function get_stops()
+	{
+		foreach ($this->_stops as $ind => $stop) {
+			if (! isset($stop['button_text'])) {
+				$this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+			}
+		}
+		return $this->_stops;
+	}
+
+
+	/**
+	 * get options
+	 *
+	 * @return array
+	 */
+	public function get_options()
+	{
+		// let's make sure there are not pauses set
+		foreach ($this->_stops as $ind => $stop) {
+			if (isset($stop['pause_after']) && $stop['pause_after']) {
+				$this->_options['pauseAfter'][] = $ind;
+			}
+		}
+		return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+	}
 }

core/libraries/messages/data_class/EE_Messages_Registrations_incoming_data.class.php

Spacing +4 added lines, -4 removed lines

@@ -28,7 +28,7 @@ 
     {
 
         // validate that the first element in the array is an EE_Registration object.
-        if (! reset($data) instanceof EE_Registration) {
+        if ( ! reset($data) instanceof EE_Registration) {
             throw new EE_Error(
                 esc_html__(
                     'The EE_Message_Registrations_incoming_data class expects an array of EE_Registration objects.',
@@ -77,7 +77,7 @@ 
             if ($registration instanceof EE_Registration) {
                 $transaction = $registration->transaction();
                 if ($transaction instanceof EE_Transaction) {
-                    $transactions[ $transaction->ID() ] = $transaction;
+                    $transactions[$transaction->ID()] = $transaction;
                 }
             }
         }
@@ -97,7 +97,7 @@ 
      */
     public static function convert_data_for_persistent_storage($registrations)
     {
-        if (! self::validateRegistrationsForConversion($registrations)) {
+        if ( ! self::validateRegistrationsForConversion($registrations)) {
             return array();
         }
 
@@ -110,7 +110,7 @@ 
         // k nope so let's pull from the registrations
         $registration_ids = array_filter(
             array_map(
-                function ($registration) {
+                function($registration) {
                     if ($registration instanceof EE_Registration) {
                         return $registration->ID();
                     }

Indentation +168 added lines, -168 removed lines

@@ -15,172 +15,172 @@
  */
 class EE_Messages_Registrations_incoming_data extends EE_Messages_incoming_data
 {
-    /**
-     * Constructor.
-     *
-     * @param  EE_Registration[] $data expecting an array of EE_Registration objects.
-     * @throws EE_Error
-     * @access protected
-     */
-    public function __construct($data = array())
-    {
-
-        // validate that the first element in the array is an EE_Registration object.
-        if (! reset($data) instanceof EE_Registration) {
-            throw new EE_Error(
-                esc_html__(
-                    'The EE_Message_Registrations_incoming_data class expects an array of EE_Registration objects.',
-                    'event_espresso'
-                )
-            );
-        }
-        parent::__construct($data);
-    }
-
-
-    /**
-     * setup the data.
-     * Sets up the expected data object for the messages prep using incoming registration objects.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @access protected
-     */
-    protected function _setup_data()
-    {
-        // we'll loop through each contact and setup the data needed.  Note that many properties will just be set as
-        // empty because this data handler is for a very specific set of data (i.e. just what's related to the
-        // registration).
-
-        $this->reg_objs = $this->data();
-        $this->txn      = $this->_maybe_get_transaction();
-        $this->_assemble_data();
-    }
-
-
-    /**
-     * If the incoming registrations all share the same transaction then this will return the transaction object shared
-     * among the registrations. Otherwise the transaction object is set to null because its intended to only represent
-     * one transaction.
-     *
-     * @return EE_Transaction|null
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    protected function _maybe_get_transaction()
-    {
-        $transactions = array();
-        foreach ($this->reg_objs as $registration) {
-            if ($registration instanceof EE_Registration) {
-                $transaction = $registration->transaction();
-                if ($transaction instanceof EE_Transaction) {
-                    $transactions[ $transaction->ID() ] = $transaction;
-                }
-            }
-        }
-        return count($transactions) === 1 ? reset($transactions) : null;
-    }
-
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param array $registrations The incoming data to be prepped.
-     * @return EE_Registration[] The data being prepared for the db
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function convert_data_for_persistent_storage($registrations)
-    {
-        if (! self::validateRegistrationsForConversion($registrations)) {
-            return array();
-        }
-
-        // is this an array of ints?
-        $first_item = reset($registrations);
-        if (is_int($first_item)) {
-            return $registrations;
-        }
-
-        // k nope so let's pull from the registrations
-        $registration_ids = array_filter(
-            array_map(
-                function ($registration) {
-                    if ($registration instanceof EE_Registration) {
-                        return $registration->ID();
-                    }
-                    return false;
-                },
-                $registrations
-            )
-        );
-
-        return $registration_ids;
-    }
-
-
-    /**
-     * This validates incoming registrations (considers whether they are ids or EE_Registration objects.
-     *
-     * @param array $registrations Could be EE_Registration[] or int[]
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function validateRegistrationsForConversion($registrations)
-    {
-        if (is_array($registrations)) {
-            $first_item = reset($registrations);
-            if ($first_item instanceof EE_Registration) {
-                return true;
-            }
-            if (is_int($first_item)) {
-                // k let's some basic validation here.  This isn't foolproof but better than nothing.
-                // the purpose of this validation is to verify that the ids sent in match valid registrations existing
-                // in the db.  If the count is different, then we know they aren't valid.
-                $count_for_ids = EEM_Registration::instance()->count(
-                    array(
-                        array(
-                            'REG_ID' => array('IN', $registrations)
-                        )
-                    )
-                );
-                return $count_for_ids === count($registrations);
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param array $data
-     * @return EE_Registration[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function convert_data_from_persistent_storage($data)
-    {
-        // since this was added later, we need to account of possible back compat issues where data already queued for
-        // generation is in the old format, which is an array of EE_Registration objects.  So if that's the case, then
-        // let's just return them
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/10127
-        if (is_array($data) && reset($data) instanceof EE_Registration) {
-            return $data;
-        }
-
-        $registrations = is_array($data)
-            ? EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $data))))
-            : array();
-        return $registrations;
-    }
+	/**
+	 * Constructor.
+	 *
+	 * @param  EE_Registration[] $data expecting an array of EE_Registration objects.
+	 * @throws EE_Error
+	 * @access protected
+	 */
+	public function __construct($data = array())
+	{
+
+		// validate that the first element in the array is an EE_Registration object.
+		if (! reset($data) instanceof EE_Registration) {
+			throw new EE_Error(
+				esc_html__(
+					'The EE_Message_Registrations_incoming_data class expects an array of EE_Registration objects.',
+					'event_espresso'
+				)
+			);
+		}
+		parent::__construct($data);
+	}
+
+
+	/**
+	 * setup the data.
+	 * Sets up the expected data object for the messages prep using incoming registration objects.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @access protected
+	 */
+	protected function _setup_data()
+	{
+		// we'll loop through each contact and setup the data needed.  Note that many properties will just be set as
+		// empty because this data handler is for a very specific set of data (i.e. just what's related to the
+		// registration).
+
+		$this->reg_objs = $this->data();
+		$this->txn      = $this->_maybe_get_transaction();
+		$this->_assemble_data();
+	}
+
+
+	/**
+	 * If the incoming registrations all share the same transaction then this will return the transaction object shared
+	 * among the registrations. Otherwise the transaction object is set to null because its intended to only represent
+	 * one transaction.
+	 *
+	 * @return EE_Transaction|null
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	protected function _maybe_get_transaction()
+	{
+		$transactions = array();
+		foreach ($this->reg_objs as $registration) {
+			if ($registration instanceof EE_Registration) {
+				$transaction = $registration->transaction();
+				if ($transaction instanceof EE_Transaction) {
+					$transactions[ $transaction->ID() ] = $transaction;
+				}
+			}
+		}
+		return count($transactions) === 1 ? reset($transactions) : null;
+	}
+
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param array $registrations The incoming data to be prepped.
+	 * @return EE_Registration[] The data being prepared for the db
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function convert_data_for_persistent_storage($registrations)
+	{
+		if (! self::validateRegistrationsForConversion($registrations)) {
+			return array();
+		}
+
+		// is this an array of ints?
+		$first_item = reset($registrations);
+		if (is_int($first_item)) {
+			return $registrations;
+		}
+
+		// k nope so let's pull from the registrations
+		$registration_ids = array_filter(
+			array_map(
+				function ($registration) {
+					if ($registration instanceof EE_Registration) {
+						return $registration->ID();
+					}
+					return false;
+				},
+				$registrations
+			)
+		);
+
+		return $registration_ids;
+	}
+
+
+	/**
+	 * This validates incoming registrations (considers whether they are ids or EE_Registration objects.
+	 *
+	 * @param array $registrations Could be EE_Registration[] or int[]
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function validateRegistrationsForConversion($registrations)
+	{
+		if (is_array($registrations)) {
+			$first_item = reset($registrations);
+			if ($first_item instanceof EE_Registration) {
+				return true;
+			}
+			if (is_int($first_item)) {
+				// k let's some basic validation here.  This isn't foolproof but better than nothing.
+				// the purpose of this validation is to verify that the ids sent in match valid registrations existing
+				// in the db.  If the count is different, then we know they aren't valid.
+				$count_for_ids = EEM_Registration::instance()->count(
+					array(
+						array(
+							'REG_ID' => array('IN', $registrations)
+						)
+					)
+				);
+				return $count_for_ids === count($registrations);
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param array $data
+	 * @return EE_Registration[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function convert_data_from_persistent_storage($data)
+	{
+		// since this was added later, we need to account of possible back compat issues where data already queued for
+		// generation is in the old format, which is an array of EE_Registration objects.  So if that's the case, then
+		// let's just return them
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/10127
+		if (is_array($data) && reset($data) instanceof EE_Registration) {
+			return $data;
+		}
+
+		$registrations = is_array($data)
+			? EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $data))))
+			: array();
+		return $registrations;
+	}
 }

core/libraries/messages/validators/email/EE_Messages_Email_Payment_Refund_Validator.class.php

Spacing +3 added lines, -3 removed lines

@@ -32,18 +32,18 @@
 
         // modify just event_list
         $new_config['event_list'] = array(
-            'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization','recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list')
+            'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list')
             );
         $new_config['ticket_list'] = array(
             'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction')
             );
         $new_config['content'] = array(
-            'shortcodes' => array('event_list','attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger')
+            'shortcodes' => array('event_list', 'attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger')
             );
         $this->_messenger->set_validator_config($new_config);
 
         if ($this->_context != 'admin') {
-            $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
+            $this->_valid_shortcodes_modifier[$this->_context]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
         }
 
         $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');

Indentation +28 added lines, -28 removed lines

@@ -13,37 +13,37 @@
  */
 class EE_Messages_Email_Payment_Refund_Validator extends EE_Messages_Validator
 {
-    public function __construct($fields, $context)
-    {
-        $this->_m_name = 'email';
-        $this->_mt_name = 'payment_refund';
+	public function __construct($fields, $context)
+	{
+		$this->_m_name = 'email';
+		$this->_mt_name = 'payment_refund';
 
-        parent::__construct($fields, $context);
-    }
+		parent::__construct($fields, $context);
+	}
 
-    /**
-     * at this point no custom validation needed for this messenger/message_type combo.
-     */
-    protected function _modify_validator()
-    {
-        $new_config = $this->_messenger->get_validator_config();
+	/**
+	 * at this point no custom validation needed for this messenger/message_type combo.
+	 */
+	protected function _modify_validator()
+	{
+		$new_config = $this->_messenger->get_validator_config();
 
-        // modify just event_list
-        $new_config['event_list'] = array(
-            'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization','recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list')
-            );
-        $new_config['ticket_list'] = array(
-            'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction')
-            );
-        $new_config['content'] = array(
-            'shortcodes' => array('event_list','attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger')
-            );
-        $this->_messenger->set_validator_config($new_config);
+		// modify just event_list
+		$new_config['event_list'] = array(
+			'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization','recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list')
+			);
+		$new_config['ticket_list'] = array(
+			'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction')
+			);
+		$new_config['content'] = array(
+			'shortcodes' => array('event_list','attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger')
+			);
+		$this->_messenger->set_validator_config($new_config);
 
-        if ($this->_context != 'admin') {
-            $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
-        }
+		if ($this->_context != 'admin') {
+			$this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
+		}
 
-        $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');
-    }
+		$this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');
+	}
 }

core/libraries/messages/validators/email/EE_Messages_Email_Registration_Summary_Validator.class.php

Spacing +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
         $this->_messenger->set_validator_config($new_config);
 
         if ($this->_context != 'admin') {
-            $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
+            $this->_valid_shortcodes_modifier[$this->_context]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
         }
 
         $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');

Indentation +23 added lines, -23 removed lines

@@ -14,31 +14,31 @@
  */
 class EE_Messages_Email_Registration_Summary_Validator extends EE_Messages_Validator
 {
-    public function __construct($fields, $context)
-    {
-        $this->_m_name = 'email';
-        $this->_mt_name = 'registration_summary';
+	public function __construct($fields, $context)
+	{
+		$this->_m_name = 'email';
+		$this->_mt_name = 'registration_summary';
 
-        parent::__construct($fields, $context);
-    }
+		parent::__construct($fields, $context);
+	}
 
-    /**
-     * custom validator (restricting what was originally set by the messenger)
-     */
-    protected function _modify_validator()
-    {
-        $new_config = $this->_messenger->get_validator_config();
-        // modify just event_list
-        $new_config['event_list'] = array(
-            'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'),
-            'required' => array('[EVENT_LIST]')
-            );
-        $this->_messenger->set_validator_config($new_config);
+	/**
+	 * custom validator (restricting what was originally set by the messenger)
+	 */
+	protected function _modify_validator()
+	{
+		$new_config = $this->_messenger->get_validator_config();
+		// modify just event_list
+		$new_config['event_list'] = array(
+			'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'),
+			'required' => array('[EVENT_LIST]')
+			);
+		$this->_messenger->set_validator_config($new_config);
 
-        if ($this->_context != 'admin') {
-            $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
-        }
+		if ($this->_context != 'admin') {
+			$this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
+		}
 
-        $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');
-    }
+		$this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');
+	}
 }

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_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 +295 added lines, -295 removed lines

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