eventespresso / event-espresso-core

core/libraries/shortcodes/EE_Primary_Registration_List_Shortcodes.lib.php

Indentation +200 added lines, -200 removed lines

@@ -18,204 +18,204 @@
  */
 class EE_Primary_Registration_List_Shortcodes extends EE_Shortcodes
 {
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Primary Registrant List Shortcodes', 'event_espresso');
-        $this->description = esc_html__(
-            'All shortcodes specific primary registrant recipients list type data.',
-            'event_espresso'
-        );
-        $this->_shortcodes = array(
-            '[PRIMARY_REGISTRANT_TICKET_LIST]' => esc_html__(
-                'Will output a list of tickets that the primary registration received.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_DATETIME_LIST]' => esc_html__(
-                'Will output a list of datetimes that the primary registrant for the transaction has been registered for.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_TICKET_LIST]':
-                return $this->_get_recipient_ticket_list(true);
-
-            case '[PRIMARY_REGISTRANT_DATETIME_LIST]':
-                return $this->_get_recipient_datetime_list(true);
-        }
-        return '';
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value
-     *
-     * @param  boolean $primary whether we're getting the primary registrant ticket_list.
-     * @return string
-     */
-    private function _get_recipient_ticket_list($primary = false)
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_ticket_list_parsed($this->_data['data'], $primary);
-        } elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_ticket_list_parsed($this->_extra_data['data'], $primary);
-        } else {
-            return '';
-        }
-    }
-
-
-    private function _get_recipient_ticket_list_parsed(EE_Messages_Addressee $data, $primary = false)
-    {
-        $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
-            return '';
-        }
-        // setup valid shortcodes depending on what the status of the $this->_data property is
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            $valid_shortcodes = array(
-                'ticket',
-                'event_list',
-                'attendee_list',
-                'datetime_list',
-                'registration_details',
-                'attendee',
-            );
-            $template = $this->_data['template'];
-            $tkts = array($data->registrations[ $registration->ID() ]['tkt_obj']);
-            $data = $this->_data;
-        } elseif ($this->_data['data'] instanceof EE_Event) {
-            $valid_shortcodes = array('ticket', 'attendee_list', 'datetime_list', 'attendee');
-            $template = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
-                ? $this->_data['template']['ticket_list'] : $this->_extra_data['template']['ticket_list'];
-            // let's remove any existing [EVENT_LIST] shortcode from the ticket list template so that we don't get recursion.
-            $template = str_replace('[EVENT_LIST]', '', $template);
-            // data will be tickets for this event for this recipient.
-            $tkts = $this->_get_tickets_from_event($this->_data['data'], $registration);
-            $data = $this->_extra_data;
-        } else {
-            return '';
-        }
-
-        $tktparsed = '';
-        foreach ($tkts as $ticket) {
-            $tktparsed .= $this->_shortcode_helper->parse_ticket_list_template(
-                $template,
-                $ticket,
-                $valid_shortcodes,
-                $data
-            );
-        }
-        return $tktparsed;
-    }
-
-
-    private function _get_tickets_from_event(EE_Event $event, $reg = null)
-    {
-        $evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['tkt_objs'] : array();
-
-        if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            $adj_tkts = array();
-            // return only tickets for the given attendee
-            foreach ($evt_tkts as $tkt) {
-                if (
-                    isset($this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj'])
-                    && $this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj']->ID() == $tkt->ID()
-                ) {
-                    $adj_tkts[] = $tkt;
-                }
-            }
-            $evt_tkts = $adj_tkts;
-        }
-        return $evt_tkts;
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value
-     *
-     * @param  boolean $primary whether we're getting the primary registrant ticket_list.
-     * @return string
-     */
-    private function _get_recipient_datetime_list($primary = false)
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
-        } elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_datetime_list_parsed($this->_extra_data['data'], $primary);
-        } else {
-            return '';
-        }
-
-        return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
-    }
-
-
-    private function _get_recipient_datetime_list_parsed(EE_Messages_Addressee $data, $primary = false)
-    {
-        $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
-            return '';
-        }
-        // setup valid shortcodes depending on what the status of the $this->_data property is
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            $valid_shortcodes = array('datetime', 'attendee');
-            $template = $this->_data['template'];
-            $dtts = $data->registrations[ $registration->ID() ]['dtt_objs'];
-            $data = $this->_data;
-        } elseif ($this->_data['data'] instanceof EE_Event) {
-            $valid_shortcodes = array('datetime', 'attendee');
-            $template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
-                ? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list'];
-            $dtts = $this->_get_datetimes_from_event($this->_data['data'], $registration);
-            $data = $this->_extra_data;
-        } else {
-            return '';
-        }
-
-        $dtt_parsed = '';
-        foreach ($dtts as $datetime) {
-            $dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
-                $template,
-                $datetime,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-        return $dtt_parsed;
-    }
-
-
-    private function _get_datetimes_from_event(EE_Event $event, $reg = null)
-    {
-        $evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['dtt_objs'] : array();
-
-        if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            $adj_dtts = array();
-            // return only dtts for the given attendee
-            foreach ($evt_dtts as $dtt) {
-                if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['dtt_objs'][ $dtt->ID() ])) {
-                    $adj_dtts[] = $dtt;
-                }
-            }
-            $evt_dtts = $adj_dtts;
-        }
-        return $evt_dtts;
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Primary Registrant List Shortcodes', 'event_espresso');
+		$this->description = esc_html__(
+			'All shortcodes specific primary registrant recipients list type data.',
+			'event_espresso'
+		);
+		$this->_shortcodes = array(
+			'[PRIMARY_REGISTRANT_TICKET_LIST]' => esc_html__(
+				'Will output a list of tickets that the primary registration received.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_DATETIME_LIST]' => esc_html__(
+				'Will output a list of datetimes that the primary registrant for the transaction has been registered for.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_TICKET_LIST]':
+				return $this->_get_recipient_ticket_list(true);
+
+			case '[PRIMARY_REGISTRANT_DATETIME_LIST]':
+				return $this->_get_recipient_datetime_list(true);
+		}
+		return '';
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value
+	 *
+	 * @param  boolean $primary whether we're getting the primary registrant ticket_list.
+	 * @return string
+	 */
+	private function _get_recipient_ticket_list($primary = false)
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_ticket_list_parsed($this->_data['data'], $primary);
+		} elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_ticket_list_parsed($this->_extra_data['data'], $primary);
+		} else {
+			return '';
+		}
+	}
+
+
+	private function _get_recipient_ticket_list_parsed(EE_Messages_Addressee $data, $primary = false)
+	{
+		$registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
+		if (! $registration instanceof EE_Registration) {
+			return '';
+		}
+		// setup valid shortcodes depending on what the status of the $this->_data property is
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			$valid_shortcodes = array(
+				'ticket',
+				'event_list',
+				'attendee_list',
+				'datetime_list',
+				'registration_details',
+				'attendee',
+			);
+			$template = $this->_data['template'];
+			$tkts = array($data->registrations[ $registration->ID() ]['tkt_obj']);
+			$data = $this->_data;
+		} elseif ($this->_data['data'] instanceof EE_Event) {
+			$valid_shortcodes = array('ticket', 'attendee_list', 'datetime_list', 'attendee');
+			$template = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
+				? $this->_data['template']['ticket_list'] : $this->_extra_data['template']['ticket_list'];
+			// let's remove any existing [EVENT_LIST] shortcode from the ticket list template so that we don't get recursion.
+			$template = str_replace('[EVENT_LIST]', '', $template);
+			// data will be tickets for this event for this recipient.
+			$tkts = $this->_get_tickets_from_event($this->_data['data'], $registration);
+			$data = $this->_extra_data;
+		} else {
+			return '';
+		}
+
+		$tktparsed = '';
+		foreach ($tkts as $ticket) {
+			$tktparsed .= $this->_shortcode_helper->parse_ticket_list_template(
+				$template,
+				$ticket,
+				$valid_shortcodes,
+				$data
+			);
+		}
+		return $tktparsed;
+	}
+
+
+	private function _get_tickets_from_event(EE_Event $event, $reg = null)
+	{
+		$evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
+		) ]['tkt_objs'] : array();
+
+		if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			$adj_tkts = array();
+			// return only tickets for the given attendee
+			foreach ($evt_tkts as $tkt) {
+				if (
+					isset($this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj'])
+					&& $this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj']->ID() == $tkt->ID()
+				) {
+					$adj_tkts[] = $tkt;
+				}
+			}
+			$evt_tkts = $adj_tkts;
+		}
+		return $evt_tkts;
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value
+	 *
+	 * @param  boolean $primary whether we're getting the primary registrant ticket_list.
+	 * @return string
+	 */
+	private function _get_recipient_datetime_list($primary = false)
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
+		} elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_datetime_list_parsed($this->_extra_data['data'], $primary);
+		} else {
+			return '';
+		}
+
+		return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
+	}
+
+
+	private function _get_recipient_datetime_list_parsed(EE_Messages_Addressee $data, $primary = false)
+	{
+		$registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
+		if (! $registration instanceof EE_Registration) {
+			return '';
+		}
+		// setup valid shortcodes depending on what the status of the $this->_data property is
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			$valid_shortcodes = array('datetime', 'attendee');
+			$template = $this->_data['template'];
+			$dtts = $data->registrations[ $registration->ID() ]['dtt_objs'];
+			$data = $this->_data;
+		} elseif ($this->_data['data'] instanceof EE_Event) {
+			$valid_shortcodes = array('datetime', 'attendee');
+			$template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
+				? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list'];
+			$dtts = $this->_get_datetimes_from_event($this->_data['data'], $registration);
+			$data = $this->_extra_data;
+		} else {
+			return '';
+		}
+
+		$dtt_parsed = '';
+		foreach ($dtts as $datetime) {
+			$dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
+				$template,
+				$datetime,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+		return $dtt_parsed;
+	}
+
+
+	private function _get_datetimes_from_event(EE_Event $event, $reg = null)
+	{
+		$evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
+		) ]['dtt_objs'] : array();
+
+		if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			$adj_dtts = array();
+			// return only dtts for the given attendee
+			foreach ($evt_dtts as $dtt) {
+				if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['dtt_objs'][ $dtt->ID() ])) {
+					$adj_dtts[] = $dtt;
+				}
+			}
+			$evt_dtts = $adj_dtts;
+		}
+		return $evt_dtts;
+	}
 }

core/libraries/shortcodes/EE_Attendee_Shortcodes.lib.php

Indentation +197 added lines, -197 removed lines

@@ -15,201 +15,201 @@
  */
 class EE_Attendee_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * hold all extra data.
-     *
-     * @var array|stdClass|null
-     */
-    protected $_extra;
-
-
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Attendee Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to attendee related data', 'event_espresso');
-        $this->_shortcodes = [
-            '[FNAME]'                          => esc_html__('First Name of an attendee.', 'event_espresso'),
-            '[LNAME]'                          => esc_html__('Last Name of an attendee.', 'event_espresso'),
-            '[ATTENDEE_EMAIL]'                 => esc_html__('Email address for the attendee.', 'event_espresso'),
-            '[EDIT_ATTENDEE_LINK]'             => esc_html__(
-                'Edit Registration Link (typically you\'d only use this for messages going to event administrators)',
-                'event_espresso'
-            ),
-            '[REGISTRATION_ID]'                => esc_html__(
-                'Unique Registration ID for the registration',
-                'event_espresso'
-            ),
-            '[REGISTRATION_CODE]'              => esc_html__(
-                'Unique Registration Code for the registration',
-                'event_espresso'
-            ),
-            '[REGISTRATION_STATUS_ID]'         => esc_html__(
-                'Parses to the registration status for the attendee',
-                'event_espresso'
-            ),
-            '[REGISTRATION_STATUS_LABEL]'      => esc_html__(
-                'Parses to the status label for the registrant',
-                'event_espresso'
-            ),
-            '[REGISTRATION_TOTAL_AMOUNT_PAID]' => esc_html__(
-                'Parses to the total amount paid for this registration.',
-                'event_espresso'
-            ),
-            '[FRONTEND_EDIT_REG_LINK]'         => esc_html__(
-                'Generates a link for the given registration to edit this registration details on the frontend.',
-                'event_espresso'
-            ),
-            '[PHONE_NUMBER]'                   => esc_html__(
-                'The Phone Number for the Registration.',
-                'event_espresso'
-            ),
-            '[ADDRESS]'                        => esc_html__('The Address for the Registration', 'event_espresso'),
-            '[ADDRESS2]'                       => esc_html__(
-                'Whatever was in the address 2 field for the registration.',
-                'event_espresso'
-            ),
-            '[CITY]'                           => esc_html__('The city for the registration.', 'event_espresso'),
-            '[ZIP_PC]'                         => esc_html__(
-                'The ZIP (or Postal) Code for the Registration.',
-                'event_espresso'
-            ),
-            '[ADDRESS_STATE]'                  => esc_html__(
-                'The state/province for the registration.',
-                'event_espresso'
-            ),
-            '[COUNTRY]'                        => esc_html__('The country for the registration.', 'event_espresso'),
-        ];
-    }
-
-
-    /**
-     * handles shortcode parsing
-     *
-     * @param string $shortcode the shortcode to be parsed.
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        $this->_extra = ! empty($this->_extra_data) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data']
-            : null;
-
-        $registration = $this->getRegistration();
-        $attendee     = $this->getAttendee($registration);
-
-        switch ($shortcode) {
-            case '[FNAME]':
-                return $attendee->fname();
-
-            case '[LNAME]':
-                return $attendee->lname();
-
-            case '[ATTENDEE_EMAIL]':
-                return $attendee->email();
-
-            case '[EDIT_ATTENDEE_LINK]':
-                return $registration->get_admin_edit_url();
-
-            case '[REGISTRATION_CODE]':
-                return $registration->reg_code();
-
-            case '[REGISTRATION_ID]':
-                return $registration->ID();
-
-            case '[FRONTEND_EDIT_REG_LINK]':
-                return $registration->edit_attendee_information_url();
-
-            case '[PHONE_NUMBER]':
-                return $attendee->phone();
-
-            case '[ADDRESS]':
-                return $attendee->address();
-
-            case '[ADDRESS2]':
-                return $attendee->address2();
-
-            case '[CITY]':
-                return $attendee->city();
-
-            case '[ZIP_PC]':
-                return $attendee->zip();
-
-            case '[ADDRESS_STATE]':
-                $state_obj = $attendee->state_obj();
-                return $state_obj instanceof EE_State ? $state_obj->name() : '';
-
-            case '[COUNTRY]':
-                $country_obj = $attendee->country_obj();
-                return $country_obj instanceof EE_Country ? $country_obj->name() : '';
-
-            case '[REGISTRATION_STATUS_ID]':
-                return $registration->status_ID();
-
-            case '[REGISTRATION_STATUS_LABEL]':
-                return $registration->pretty_status();
-
-            case '[REGISTRATION_TOTAL_AMOUNT_PAID]':
-                return $registration->pretty_paid();
-        }
-
-        return '';
-    }
-
-
-    /**
-     * @return EE_Registration
-     * @throws EE_Error
-     * @since 5.0.20.p
-     */
-    private function getRegistration(): EE_Registration
-    {
-        // incoming object should only be a registration object.
-        if ($this->_data instanceof EE_Registration) {
-            return $this->_data;
-        }
-        // let's attempt to get the txn_id for the error message.
-        $txn_id  = isset($this->_extra->txn) && $this->_extra->txn instanceof EE_Transaction
-            ? $this->_extra->txn->ID()
-            : esc_html__('Unknown', 'event_espresso');
-        $msg     = esc_html__(
-            'There is no EE_Registration object in the data sent to the EE_Attendee Shortcode Parser for the messages system.',
-            'event_espresso'
-        );
-        $dev_msg = sprintf(
-            esc_html__('The transaction ID for this request is: %s', 'event_espresso'),
-            $txn_id
-        );
-        throw new EE_Error("$msg||$msg $dev_msg");
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return EE_Attendee
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.20.p
-     */
-    private function getAttendee(EE_Registration $registration): EE_Attendee
-    {
-        // attendee obj for this registration
-        if (
-            isset($this->_extra->registrations[ $registration->ID() ]['att_obj'])
-            && $this->_extra->registrations[ $registration->ID() ]['att_obj'] instanceof EE_Attendee
-        ) {
-            return $this->_extra->registrations[ $registration->ID() ]['att_obj'];
-        }
-
-        $msg     = esc_html__(
-            'There is no EE_Attendee object in the data sent to the EE_Attendee_Shortcode parser for the messages system.',
-            'event_espresso'
-        );
-        $dev_msg = sprintf(
-            esc_html__('The registration ID for this request is: %s', 'event_espresso'),
-            $registration->ID()
-        );
-        throw new EE_Error("$msg||$msg $dev_msg");
-    }
+	/**
+	 * hold all extra data.
+	 *
+	 * @var array|stdClass|null
+	 */
+	protected $_extra;
+
+
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Attendee Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to attendee related data', 'event_espresso');
+		$this->_shortcodes = [
+			'[FNAME]'                          => esc_html__('First Name of an attendee.', 'event_espresso'),
+			'[LNAME]'                          => esc_html__('Last Name of an attendee.', 'event_espresso'),
+			'[ATTENDEE_EMAIL]'                 => esc_html__('Email address for the attendee.', 'event_espresso'),
+			'[EDIT_ATTENDEE_LINK]'             => esc_html__(
+				'Edit Registration Link (typically you\'d only use this for messages going to event administrators)',
+				'event_espresso'
+			),
+			'[REGISTRATION_ID]'                => esc_html__(
+				'Unique Registration ID for the registration',
+				'event_espresso'
+			),
+			'[REGISTRATION_CODE]'              => esc_html__(
+				'Unique Registration Code for the registration',
+				'event_espresso'
+			),
+			'[REGISTRATION_STATUS_ID]'         => esc_html__(
+				'Parses to the registration status for the attendee',
+				'event_espresso'
+			),
+			'[REGISTRATION_STATUS_LABEL]'      => esc_html__(
+				'Parses to the status label for the registrant',
+				'event_espresso'
+			),
+			'[REGISTRATION_TOTAL_AMOUNT_PAID]' => esc_html__(
+				'Parses to the total amount paid for this registration.',
+				'event_espresso'
+			),
+			'[FRONTEND_EDIT_REG_LINK]'         => esc_html__(
+				'Generates a link for the given registration to edit this registration details on the frontend.',
+				'event_espresso'
+			),
+			'[PHONE_NUMBER]'                   => esc_html__(
+				'The Phone Number for the Registration.',
+				'event_espresso'
+			),
+			'[ADDRESS]'                        => esc_html__('The Address for the Registration', 'event_espresso'),
+			'[ADDRESS2]'                       => esc_html__(
+				'Whatever was in the address 2 field for the registration.',
+				'event_espresso'
+			),
+			'[CITY]'                           => esc_html__('The city for the registration.', 'event_espresso'),
+			'[ZIP_PC]'                         => esc_html__(
+				'The ZIP (or Postal) Code for the Registration.',
+				'event_espresso'
+			),
+			'[ADDRESS_STATE]'                  => esc_html__(
+				'The state/province for the registration.',
+				'event_espresso'
+			),
+			'[COUNTRY]'                        => esc_html__('The country for the registration.', 'event_espresso'),
+		];
+	}
+
+
+	/**
+	 * handles shortcode parsing
+	 *
+	 * @param string $shortcode the shortcode to be parsed.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		$this->_extra = ! empty($this->_extra_data) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data']
+			: null;
+
+		$registration = $this->getRegistration();
+		$attendee     = $this->getAttendee($registration);
+
+		switch ($shortcode) {
+			case '[FNAME]':
+				return $attendee->fname();
+
+			case '[LNAME]':
+				return $attendee->lname();
+
+			case '[ATTENDEE_EMAIL]':
+				return $attendee->email();
+
+			case '[EDIT_ATTENDEE_LINK]':
+				return $registration->get_admin_edit_url();
+
+			case '[REGISTRATION_CODE]':
+				return $registration->reg_code();
+
+			case '[REGISTRATION_ID]':
+				return $registration->ID();
+
+			case '[FRONTEND_EDIT_REG_LINK]':
+				return $registration->edit_attendee_information_url();
+
+			case '[PHONE_NUMBER]':
+				return $attendee->phone();
+
+			case '[ADDRESS]':
+				return $attendee->address();
+
+			case '[ADDRESS2]':
+				return $attendee->address2();
+
+			case '[CITY]':
+				return $attendee->city();
+
+			case '[ZIP_PC]':
+				return $attendee->zip();
+
+			case '[ADDRESS_STATE]':
+				$state_obj = $attendee->state_obj();
+				return $state_obj instanceof EE_State ? $state_obj->name() : '';
+
+			case '[COUNTRY]':
+				$country_obj = $attendee->country_obj();
+				return $country_obj instanceof EE_Country ? $country_obj->name() : '';
+
+			case '[REGISTRATION_STATUS_ID]':
+				return $registration->status_ID();
+
+			case '[REGISTRATION_STATUS_LABEL]':
+				return $registration->pretty_status();
+
+			case '[REGISTRATION_TOTAL_AMOUNT_PAID]':
+				return $registration->pretty_paid();
+		}
+
+		return '';
+	}
+
+
+	/**
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 * @since 5.0.20.p
+	 */
+	private function getRegistration(): EE_Registration
+	{
+		// incoming object should only be a registration object.
+		if ($this->_data instanceof EE_Registration) {
+			return $this->_data;
+		}
+		// let's attempt to get the txn_id for the error message.
+		$txn_id  = isset($this->_extra->txn) && $this->_extra->txn instanceof EE_Transaction
+			? $this->_extra->txn->ID()
+			: esc_html__('Unknown', 'event_espresso');
+		$msg     = esc_html__(
+			'There is no EE_Registration object in the data sent to the EE_Attendee Shortcode Parser for the messages system.',
+			'event_espresso'
+		);
+		$dev_msg = sprintf(
+			esc_html__('The transaction ID for this request is: %s', 'event_espresso'),
+			$txn_id
+		);
+		throw new EE_Error("$msg||$msg $dev_msg");
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.20.p
+	 */
+	private function getAttendee(EE_Registration $registration): EE_Attendee
+	{
+		// attendee obj for this registration
+		if (
+			isset($this->_extra->registrations[ $registration->ID() ]['att_obj'])
+			&& $this->_extra->registrations[ $registration->ID() ]['att_obj'] instanceof EE_Attendee
+		) {
+			return $this->_extra->registrations[ $registration->ID() ]['att_obj'];
+		}
+
+		$msg     = esc_html__(
+			'There is no EE_Attendee object in the data sent to the EE_Attendee_Shortcode parser for the messages system.',
+			'event_espresso'
+		);
+		$dev_msg = sprintf(
+			esc_html__('The registration ID for this request is: %s', 'event_espresso'),
+			$registration->ID()
+		);
+		throw new EE_Error("$msg||$msg $dev_msg");
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -196,13 +196,13 @@
     {
         // attendee obj for this registration
         if (
-            isset($this->_extra->registrations[ $registration->ID() ]['att_obj'])
-            && $this->_extra->registrations[ $registration->ID() ]['att_obj'] instanceof EE_Attendee
+            isset($this->_extra->registrations[$registration->ID()]['att_obj'])
+            && $this->_extra->registrations[$registration->ID()]['att_obj'] instanceof EE_Attendee
         ) {
-            return $this->_extra->registrations[ $registration->ID() ]['att_obj'];
+            return $this->_extra->registrations[$registration->ID()]['att_obj'];
         }
 
-        $msg     = esc_html__(
+        $msg = esc_html__(
             'There is no EE_Attendee object in the data sent to the EE_Attendee_Shortcode parser for the messages system.',
             'event_espresso'
         );

core/libraries/shortcodes/EE_Datetime_Shortcodes.lib.php

Indentation +72 added lines, -72 removed lines

@@ -15,76 +15,76 @@
  */
 class EE_Datetime_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * @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'
-            ),
-        );
-    }
-
-
-    /**
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        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');
-
-            case '[DATETIME_END]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_end');
-
-            case '[DATETIME_TIMEZONE]':
-                return $this->_data->get_timezone();
-
-            case '[DATE_START]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('date_format'));
-
-            case '[DATE_END]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('date_format'));
-
-            case '[TIME_START]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('time_format'));
-
-            case '[TIME_END]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('time_format'));
-
-        }
-
-        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'];
-
-            $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 '';
-    }
+	/**
+	 * @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'
+			),
+		);
+	}
+
+
+	/**
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		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');
+
+			case '[DATETIME_END]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_end');
+
+			case '[DATETIME_TIMEZONE]':
+				return $this->_data->get_timezone();
+
+			case '[DATE_START]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('date_format'));
+
+			case '[DATE_END]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('date_format'));
+
+			case '[TIME_START]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('time_format'));
+
+			case '[TIME_END]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('time_format'));
+
+		}
+
+		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'];
+
+			$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 '';
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -46,7 +46,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.
         }
 
@@ -82,7 +82,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 '';

core/libraries/shortcodes/EE_Ticket_List_Shortcodes.lib.php

Indentation +199 added lines, -199 removed lines

@@ -18,203 +18,203 @@
  */
 class EE_Ticket_List_Shortcodes extends EE_Shortcodes
 {
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Ticket List Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to ticket lists', 'event_espresso');
-        $this->_shortcodes = [
-            '[TICKET_LIST]' => esc_html__('Will output a list of tickets', 'event_espresso'),
-        ];
-    }
-
-
-    /**
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        if ($shortcode == '[TICKET_LIST]') {
-            return $this->_get_ticket_list();
-        }
-        return '';
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_ticket_list()
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_ticket_list_for_main();
-        }
-        if ($this->_data['data'] instanceof EE_Registration) {
-            return $this->_get_ticket_list_for_attendee();
-        }
-        if ($this->_data['data'] instanceof EE_Event) {
-            return $this->_get_ticket_list_for_event();
-        }
-        // prevent recursive loop
-        return '';
-    }
-
-
-    /**
-     * This returns the parsed ticket list for main template;
-     */
-    private function _get_ticket_list_for_main()
-    {
-        $valid_shortcodes = [
-            'ticket',
-            'event_list',
-            'attendee_list',
-            'datetime_list',
-            'attendee',
-            'line_item_list',
-            'primary_registration_details',
-            'recipient_details',
-        ];
-        $template         = $this->_data['template'];
-        $data             = $this->_data['data'];
-        $ticket_list      = '';
-
-
-        // now we need to loop through the ticket list and send data to the EE_Parser helper.
-        foreach ($data->tickets as $ticket) {
-            $ticket_list .= $this->_shortcode_helper->parse_ticket_list_template(
-                $template,
-                $ticket['ticket'],
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $ticket_list;
-    }
-
-
-    /**
-     * return parsed list of tickets for an event
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_ticket_list_for_event()
-    {
-        $valid_shortcodes = [
-            'ticket',
-            'attendee_list',
-            'datetime_list',
-            'attendee',
-            'venue',
-            'line_item_list',
-            'primary_registration_details',
-            'recipient_details',
-        ];
-        $template         = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
-            ? $this->_data['template']['ticket_list']
-            : $this->_extra_data['template']['ticket_list'];
-        $event            = $this->_data['data'];
-
-        // let's remove any existing [EVENT_LIST] shortcodes from the ticket list template so that we don't get recursion.
-        $template = str_replace('[EVENT_LIST]', '', $template);
-
-        // here we're setting up the tickets for the ticket list template for THIS event.
-        $tkt_parsed = '';
-        $tickets    = $this->_get_tickets_from_event($event);
-
-        // each ticket in this case should be an ticket object.
-        foreach ($tickets as $ticket) {
-            $tkt_parsed .= $this->_shortcode_helper->parse_ticket_list_template(
-                $template,
-                $ticket,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $tkt_parsed;
-    }
-
-
-    /**
-     * return parsed list of tickets for an attendee
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_ticket_list_for_attendee()
-    {
-        $valid_shortcodes = [
-            'ticket',
-            'event_list',
-            'datetime_list',
-            'attendee',
-            'primary_registration_details',
-            'recipient_details',
-        ];
-
-        $template     = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
-            ? $this->_data['template']['ticket_list']
-            : $this->_extra_data['template']['ticket_list'];
-        $registration = $this->_data['data'];
-
-        // let's remove any existing [ATTENDEE_LIST] shortcode from the ticket list template so that we don't get recursion.
-        $template = str_replace('[ATTENDEE_LIST]', '', $template);
-
-        // here we're setting up the tickets for the ticket list template for THIS attendee.
-        $tkt_parsed = '';
-        $tickets    = $this->_get_ticket_list_from_registration($registration);
-
-        // each ticket in this case should be an ticket object.
-        foreach ($tickets as $ticket) {
-            $tkt_parsed .= $this->_shortcode_helper->parse_ticket_list_template(
-                $template,
-                $ticket,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $tkt_parsed;
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return array|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_tickets_from_event(EE_Event $event)
-    {
-        return isset($this->_extra_data['data']->events)
-            ? $this->_extra_data['data']->events[ $event->ID() ]['tkt_objs']
-            : [];
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_ticket_list_from_registration(EE_Registration $registration)
-    {
-        return isset($this->_extra_data['data']->registrations)
-            ? [$this->_extra_data['data']->registrations[ $registration->ID() ]['tkt_obj']]
-            : [];
-    }
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Ticket List Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to ticket lists', 'event_espresso');
+		$this->_shortcodes = [
+			'[TICKET_LIST]' => esc_html__('Will output a list of tickets', 'event_espresso'),
+		];
+	}
+
+
+	/**
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		if ($shortcode == '[TICKET_LIST]') {
+			return $this->_get_ticket_list();
+		}
+		return '';
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_ticket_list()
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_ticket_list_for_main();
+		}
+		if ($this->_data['data'] instanceof EE_Registration) {
+			return $this->_get_ticket_list_for_attendee();
+		}
+		if ($this->_data['data'] instanceof EE_Event) {
+			return $this->_get_ticket_list_for_event();
+		}
+		// prevent recursive loop
+		return '';
+	}
+
+
+	/**
+	 * This returns the parsed ticket list for main template;
+	 */
+	private function _get_ticket_list_for_main()
+	{
+		$valid_shortcodes = [
+			'ticket',
+			'event_list',
+			'attendee_list',
+			'datetime_list',
+			'attendee',
+			'line_item_list',
+			'primary_registration_details',
+			'recipient_details',
+		];
+		$template         = $this->_data['template'];
+		$data             = $this->_data['data'];
+		$ticket_list      = '';
+
+
+		// now we need to loop through the ticket list and send data to the EE_Parser helper.
+		foreach ($data->tickets as $ticket) {
+			$ticket_list .= $this->_shortcode_helper->parse_ticket_list_template(
+				$template,
+				$ticket['ticket'],
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $ticket_list;
+	}
+
+
+	/**
+	 * return parsed list of tickets for an event
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_ticket_list_for_event()
+	{
+		$valid_shortcodes = [
+			'ticket',
+			'attendee_list',
+			'datetime_list',
+			'attendee',
+			'venue',
+			'line_item_list',
+			'primary_registration_details',
+			'recipient_details',
+		];
+		$template         = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
+			? $this->_data['template']['ticket_list']
+			: $this->_extra_data['template']['ticket_list'];
+		$event            = $this->_data['data'];
+
+		// let's remove any existing [EVENT_LIST] shortcodes from the ticket list template so that we don't get recursion.
+		$template = str_replace('[EVENT_LIST]', '', $template);
+
+		// here we're setting up the tickets for the ticket list template for THIS event.
+		$tkt_parsed = '';
+		$tickets    = $this->_get_tickets_from_event($event);
+
+		// each ticket in this case should be an ticket object.
+		foreach ($tickets as $ticket) {
+			$tkt_parsed .= $this->_shortcode_helper->parse_ticket_list_template(
+				$template,
+				$ticket,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $tkt_parsed;
+	}
+
+
+	/**
+	 * return parsed list of tickets for an attendee
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_ticket_list_for_attendee()
+	{
+		$valid_shortcodes = [
+			'ticket',
+			'event_list',
+			'datetime_list',
+			'attendee',
+			'primary_registration_details',
+			'recipient_details',
+		];
+
+		$template     = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
+			? $this->_data['template']['ticket_list']
+			: $this->_extra_data['template']['ticket_list'];
+		$registration = $this->_data['data'];
+
+		// let's remove any existing [ATTENDEE_LIST] shortcode from the ticket list template so that we don't get recursion.
+		$template = str_replace('[ATTENDEE_LIST]', '', $template);
+
+		// here we're setting up the tickets for the ticket list template for THIS attendee.
+		$tkt_parsed = '';
+		$tickets    = $this->_get_ticket_list_from_registration($registration);
+
+		// each ticket in this case should be an ticket object.
+		foreach ($tickets as $ticket) {
+			$tkt_parsed .= $this->_shortcode_helper->parse_ticket_list_template(
+				$template,
+				$ticket,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $tkt_parsed;
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return array|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_tickets_from_event(EE_Event $event)
+	{
+		return isset($this->_extra_data['data']->events)
+			? $this->_extra_data['data']->events[ $event->ID() ]['tkt_objs']
+			: [];
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_ticket_list_from_registration(EE_Registration $registration)
+	{
+		return isset($this->_extra_data['data']->registrations)
+			? [$this->_extra_data['data']->registrations[ $registration->ID() ]['tkt_obj']]
+			: [];
+	}
 }

core/libraries/shortcodes/EE_Ticket_Shortcodes.lib.php

Indentation +118 added lines, -118 removed lines

@@ -15,133 +15,133 @@
  */
 class EE_Ticket_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * Will hold the EE_Ticket if available
-     *
-     * @var EE_Ticket|null
-     */
-    protected ?EE_Ticket $_ticket = null;
-
-
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Ticket Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to ticket related data', 'event_espresso');
-        $this->_shortcodes = [
-            '[TICKET_ID]'               => esc_html__(
-                'Will be replaced by the ticket ID of a ticket',
-                'event_espresso'
-            ),
-            '[TICKET_NAME]'             => esc_html__('The name of the ticket', 'event_espresso'),
-            '[TICKET_DESCRIPTION]'      => esc_html__('The description of the ticket', 'event_espresso'),
-            '[TICKET_PRICE]'            => esc_html__('The price of the ticket', 'event_espresso'),
-            '[TICKET_PRICE_WITH_TAXES]' => esc_html__(
-                'The price of the ticket including any taxes that might be on the ticket',
-                'event_espresso'
-            ),
-            '[TKT_QTY_PURCHASED]'       => esc_html__(
-                'The total quantity of the current ticket in the list that has been purchased in this transaction',
-                'event_espresso'
-            ),
-            '[TKT_USES_*]'              => esc_html__(
-                    'This attribute based shortcode parses to show the number of uses the ticket has.  The optional "schema" attribute can be used to indicate what schema is used when the uses is infinite.  Options are:',
-                    'event_espresso'
-                ) . '
+	/**
+	 * Will hold the EE_Ticket if available
+	 *
+	 * @var EE_Ticket|null
+	 */
+	protected ?EE_Ticket $_ticket = null;
+
+
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Ticket Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to ticket related data', 'event_espresso');
+		$this->_shortcodes = [
+			'[TICKET_ID]'               => esc_html__(
+				'Will be replaced by the ticket ID of a ticket',
+				'event_espresso'
+			),
+			'[TICKET_NAME]'             => esc_html__('The name of the ticket', 'event_espresso'),
+			'[TICKET_DESCRIPTION]'      => esc_html__('The description of the ticket', 'event_espresso'),
+			'[TICKET_PRICE]'            => esc_html__('The price of the ticket', 'event_espresso'),
+			'[TICKET_PRICE_WITH_TAXES]' => esc_html__(
+				'The price of the ticket including any taxes that might be on the ticket',
+				'event_espresso'
+			),
+			'[TKT_QTY_PURCHASED]'       => esc_html__(
+				'The total quantity of the current ticket in the list that has been purchased in this transaction',
+				'event_espresso'
+			),
+			'[TKT_USES_*]'              => esc_html__(
+					'This attribute based shortcode parses to show the number of uses the ticket has.  The optional "schema" attribute can be used to indicate what schema is used when the uses is infinite.  Options are:',
+					'event_espresso'
+				) . '
         <ul>
             <li>
                 <strong>symbol</strong>:' . esc_html__(
-                    'This returns the &infin; symbol.',
-                    'event_espresso'
-                ) . '
+					'This returns the &infin; symbol.',
+					'event_espresso'
+				) . '
             </li>
             <li>
                 <strong>text</strong>:' . esc_html__(
-                    'This returns the word, "Unlimited". This is also the default if the "schema" attribute is not used.',
-                    'event_espresso'
-                ) . '
+					'This returns the word, "Unlimited". This is also the default if the "schema" attribute is not used.',
+					'event_espresso'
+				) . '
             </li>
             <li>
                 <strong>{custom}</strong>:' . esc_html__(
-                    'You can put anything you want as a string instead and that will be used.  So you could have the world "any" and whenever uses for a ticket is infinity, this shortcode will parse to "any".',
-                    'event_espresso'
-                ) . '
+					'You can put anything you want as a string instead and that will be used.  So you could have the world "any" and whenever uses for a ticket is infinity, this shortcode will parse to "any".',
+					'event_espresso'
+				) . '
             </li>
         </ul>',
-        ];
-    }
-
-
-    /**
-     * @param $shortcode
-     * @return int|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        $this->_ticket = $this->_data instanceof EE_Ticket ? $this->_data : null;
-
-        $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $aee = ! $aee instanceof EE_Messages_Addressee
-        && is_array($this->_extra_data)
-        && isset($this->_extra_data['data'])
-        && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data']
-            : $aee;
-
-
-        // possible EE_Line_Item may be incoming data
-        $this->_ticket = empty($this->_ticket)
-        && $this->_data instanceof EE_Line_Item
-        && $aee instanceof EE_Messages_Addressee
-        && ! empty($aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'])
-        && $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'] instanceof EE_Ticket
-            ? $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket']
-            : $this->_ticket;
-
-        // if still no ticket, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the ticket from the reg_obj instead.
-        if (empty($this->_ticket)) {
-            $this->_ticket = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
-                ? $aee->reg_obj->ticket() : null;
-        }
-
-
-        // If there is no event object by now then get out.
-        if (! $this->_ticket instanceof EE_Ticket) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[TICKET_ID]':
-                return $this->_ticket->ID();
-
-            case '[TICKET_NAME]':
-                return $this->_ticket->get('TKT_name');
-
-            case '[TICKET_DESCRIPTION]':
-                return $this->_ticket->get('TKT_description');
-
-            case '[TICKET_PRICE]':
-                return EEH_Template::format_currency($this->_ticket->get('TKT_price'));
-
-            case '[TICKET_PRICE_WITH_TAXES]':
-                return EEH_Template::format_currency($this->_ticket->get_ticket_total_with_taxes());
-
-            case '[TKT_QTY_PURCHASED]':
-                return $aee instanceof EE_Messages_Addressee ? $aee->tickets[ $this->_ticket->ID() ]['count'] : '';
-        }
-
-        if (strpos($shortcode, '[TKT_USES_*') !== false) {
-            $attrs  = $this->_get_shortcode_attrs($shortcode);
-            $schema = empty($attrs['schema']) ? null : $attrs['schema'];
-            return $this->_ticket->get_pretty('TKT_uses', $schema);
-        }
-        return '';
-    }
-
-
-    public function get_ticket_set(): ?EE_Ticket
-    {
-        return $this->_ticket;
-    }
+		];
+	}
+
+
+	/**
+	 * @param $shortcode
+	 * @return int|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		$this->_ticket = $this->_data instanceof EE_Ticket ? $this->_data : null;
+
+		$aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$aee = ! $aee instanceof EE_Messages_Addressee
+		&& is_array($this->_extra_data)
+		&& isset($this->_extra_data['data'])
+		&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data']
+			: $aee;
+
+
+		// possible EE_Line_Item may be incoming data
+		$this->_ticket = empty($this->_ticket)
+		&& $this->_data instanceof EE_Line_Item
+		&& $aee instanceof EE_Messages_Addressee
+		&& ! empty($aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'])
+		&& $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'] instanceof EE_Ticket
+			? $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket']
+			: $this->_ticket;
+
+		// if still no ticket, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the ticket from the reg_obj instead.
+		if (empty($this->_ticket)) {
+			$this->_ticket = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
+				? $aee->reg_obj->ticket() : null;
+		}
+
+
+		// If there is no event object by now then get out.
+		if (! $this->_ticket instanceof EE_Ticket) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[TICKET_ID]':
+				return $this->_ticket->ID();
+
+			case '[TICKET_NAME]':
+				return $this->_ticket->get('TKT_name');
+
+			case '[TICKET_DESCRIPTION]':
+				return $this->_ticket->get('TKT_description');
+
+			case '[TICKET_PRICE]':
+				return EEH_Template::format_currency($this->_ticket->get('TKT_price'));
+
+			case '[TICKET_PRICE_WITH_TAXES]':
+				return EEH_Template::format_currency($this->_ticket->get_ticket_total_with_taxes());
+
+			case '[TKT_QTY_PURCHASED]':
+				return $aee instanceof EE_Messages_Addressee ? $aee->tickets[ $this->_ticket->ID() ]['count'] : '';
+		}
+
+		if (strpos($shortcode, '[TKT_USES_*') !== false) {
+			$attrs  = $this->_get_shortcode_attrs($shortcode);
+			$schema = empty($attrs['schema']) ? null : $attrs['schema'];
+			return $this->_ticket->get_pretty('TKT_uses', $schema);
+		}
+		return '';
+	}
+
+
+	public function get_ticket_set(): ?EE_Ticket
+	{
+		return $this->_ticket;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -46,25 +46,25 @@ 
             '[TKT_USES_*]'              => esc_html__(
                     'This attribute based shortcode parses to show the number of uses the ticket has.  The optional "schema" attribute can be used to indicate what schema is used when the uses is infinite.  Options are:',
                     'event_espresso'
-                ) . '
+                ).'
         <ul>
             <li>
                 <strong>symbol</strong>:' . esc_html__(
                     'This returns the &infin; symbol.',
                     'event_espresso'
-                ) . '
+                ).'
             </li>
             <li>
                 <strong>text</strong>:' . esc_html__(
                     'This returns the word, "Unlimited". This is also the default if the "schema" attribute is not used.',
                     'event_espresso'
-                ) . '
+                ).'
             </li>
             <li>
                 <strong>{custom}</strong>:' . esc_html__(
                     'You can put anything you want as a string instead and that will be used.  So you could have the world "any" and whenever uses for a ticket is infinity, this shortcode will parse to "any".',
                     'event_espresso'
-                ) . '
+                ).'
             </li>
         </ul>',
         ];
@@ -94,9 +94,9 @@ 
         $this->_ticket = empty($this->_ticket)
         && $this->_data instanceof EE_Line_Item
         && $aee instanceof EE_Messages_Addressee
-        && ! empty($aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'])
-        && $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'] instanceof EE_Ticket
-            ? $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket']
+        && ! empty($aee->line_items_with_children[$this->_data->ID()]['EE_Ticket'])
+        && $aee->line_items_with_children[$this->_data->ID()]['EE_Ticket'] instanceof EE_Ticket
+            ? $aee->line_items_with_children[$this->_data->ID()]['EE_Ticket']
             : $this->_ticket;
 
         // if still no ticket, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the ticket from the reg_obj instead.
@@ -107,7 +107,7 @@ 
 
 
         // If there is no event object by now then get out.
-        if (! $this->_ticket instanceof EE_Ticket) {
+        if ( ! $this->_ticket instanceof EE_Ticket) {
             return '';
         }
 
@@ -128,7 +128,7 @@ 
                 return EEH_Template::format_currency($this->_ticket->get_ticket_total_with_taxes());
 
             case '[TKT_QTY_PURCHASED]':
-                return $aee instanceof EE_Messages_Addressee ? $aee->tickets[ $this->_ticket->ID() ]['count'] : '';
+                return $aee instanceof EE_Messages_Addressee ? $aee->tickets[$this->_ticket->ID()]['count'] : '';
         }
 
         if (strpos($shortcode, '[TKT_USES_*') !== false) {

core/libraries/shortcodes/EE_Organization_Shortcodes.lib.php

Indentation +124 added lines, -124 removed lines

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

Spacing +2 added lines, -2 removed lines

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

core/libraries/shortcodes/EE_Line_Item_List_Shortcodes.lib.php

Indentation +200 added lines, -200 removed lines

@@ -20,204 +20,204 @@
  */
 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'),
-        );
-    }
-
-
-    /**
-     * @param string $shortcode
-     * @throws EE_Error
-     */
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[TICKET_LINE_ITEM_LIST]':
-                return $this->_get_ticket_line_item_list();
-
-            case '[TAX_LINE_ITEM_LIST]':
-                return $this->_get_tax_line_item_list();
-
-            case '[PRICE_MODIFIER_LINE_ITEM_LIST]':
-                return $this->_get_price_mod_line_item_list();
-
-            case '[ADDITIONAL_LINE_ITEM_LIST]':
-                return $this->_get_additional_line_item_list();
-
-            default:
-                return '';
-        }
-    }
-
-
-    /**
-     * 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.
-     *
-     * @return string  parsed tax line item list.
-     * @throws EE_Error
-     * @since 4.5.0
-     */
-    private function _get_tax_line_item_list()
-    {
-        /** @var EE_Admin_Config $admin_config */
-        $admin_config = LoaderFactory::getShared(EE_Admin_Config::class);
-        if ($admin_config->useAdvancedEditor()) {
-            return '';
-        }
-        $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'),
+		);
+	}
+
+
+	/**
+	 * @param string $shortcode
+	 * @throws EE_Error
+	 */
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[TICKET_LINE_ITEM_LIST]':
+				return $this->_get_ticket_line_item_list();
+
+			case '[TAX_LINE_ITEM_LIST]':
+				return $this->_get_tax_line_item_list();
+
+			case '[PRICE_MODIFIER_LINE_ITEM_LIST]':
+				return $this->_get_price_mod_line_item_list();
+
+			case '[ADDITIONAL_LINE_ITEM_LIST]':
+				return $this->_get_additional_line_item_list();
+
+			default:
+				return '';
+		}
+	}
+
+
+	/**
+	 * 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.
+	 *
+	 * @return string  parsed tax line item list.
+	 * @throws EE_Error
+	 * @since 4.5.0
+	 */
+	private function _get_tax_line_item_list()
+	{
+		/** @var EE_Admin_Config $admin_config */
+		$admin_config = LoaderFactory::getShared(EE_Admin_Config::class);
+		if ($admin_config->useAdvancedEditor()) {
+			return '';
+		}
+		$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_Datetime_List_Shortcodes.lib.php

Indentation +164 added lines, -164 removed lines

@@ -18,168 +18,168 @@
  */
 class EE_Datetime_List_Shortcodes extends EE_Shortcodes
 {
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Datetime List Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to datetime lists', 'event_espresso');
-        $this->_shortcodes = [
-            '[DATETIME_LIST]' => esc_html__(
-                'Will output a list of datetimes according to the layout specified in the datetime list field.',
-                'event_espresso'
-            ),
-        ];
-    }
-
-
-    /**
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        if ($shortcode == '[DATETIME_LIST]') {
-            return $this->_get_datetime_list();
-        }
-        return '';
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_datetime_list()
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Ticket) {
-            return $this->_get_datetime_list_for_ticket();
-        }
-        if ($this->_data['data'] instanceof EE_Event) {
-            return $this->_get_datetime_list_for_event();
-        }
-        if (
-            $this->_data['data'] instanceof EE_Messages_Addressee
-            && $this->_data['data']->reg_obj instanceof EE_Registration
-        ) {
-            return $this->_get_datetime_list_for_registration();
-        }
-        // prevent recursive loop
-        return '';
-    }
-
-
-    /**
-     * return parsed list of datetimes for an event
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_datetime_list_for_event()
-    {
-        $event            = $this->_data['data'];
-        $valid_shortcodes = ['datetime', 'attendee'];
-        $template         = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
-            ? $this->_data['template']['datetime_list']
-            : $this->_extra_data['template']['datetime_list'];
-
-        // here we're setting up the datetimes for the datetime list template for THIS event.
-        $dtt_parsed = '';
-        $datetimes  = $this->_get_datetimes_from_event($event);
-
-        // each datetime in this case should be an datetime object.
-        foreach ($datetimes as $datetime) {
-            $dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
-                $template,
-                $datetime,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $dtt_parsed;
-    }
-
-
-    /**
-     * return parsed list of datetimes for an ticket
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    private function _get_datetime_list_for_ticket()
-    {
-        $valid_shortcodes = ['datetime', 'attendee'];
-
-        $template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
-            ? $this->_data['template']['datetime_list']
-            : $this->_extra_data['template']['datetime_list'];
-        $ticket   = $this->_data['data'];
-
-        // here we're setting up the datetimes for the datetime list template for THIS ticket.
-        $dtt_parsed = '';
-        $datetimes  = $this->_get_datetimes_from_ticket($ticket);
-
-        // each datetime in this case should be an datetime object.
-        foreach ($datetimes as $datetime) {
-            $dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
-                $template,
-                $datetime,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $dtt_parsed;
-    }
-
-
-    /**
-     * return parsed list of datetimes from a given registration.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    private function _get_datetime_list_for_registration()
-    {
-        $registration = $this->_data['data']->reg_obj;
-
-        // now let's just get the ticket, set $this->_data['data'] to the ticket and then call _get_datetime_list_for__ticket();
-        $this->_data['data'] = $registration->ticket();
-        return $this->_get_datetime_list_for_ticket();
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return array|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_datetimes_from_event(EE_Event $event)
-    {
-        return isset($this->_extra_data['data']->events)
-            ? $this->_extra_data['data']->events[ $event->ID() ]['dtt_objs']
-            : [];
-    }
-
-
-    /**
-     * @param EE_Ticket $ticket
-     * @return array|mixed
-     * @throws EE_Error
-     */
-    private function _get_datetimes_from_ticket(EE_Ticket $ticket)
-    {
-        return isset($this->_extra_data['data']->tickets)
-            ? $this->_extra_data['data']->tickets[ $ticket->ID() ]['dtt_objs']
-            : [];
-    }
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Datetime List Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to datetime lists', 'event_espresso');
+		$this->_shortcodes = [
+			'[DATETIME_LIST]' => esc_html__(
+				'Will output a list of datetimes according to the layout specified in the datetime list field.',
+				'event_espresso'
+			),
+		];
+	}
+
+
+	/**
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		if ($shortcode == '[DATETIME_LIST]') {
+			return $this->_get_datetime_list();
+		}
+		return '';
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_datetime_list()
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Ticket) {
+			return $this->_get_datetime_list_for_ticket();
+		}
+		if ($this->_data['data'] instanceof EE_Event) {
+			return $this->_get_datetime_list_for_event();
+		}
+		if (
+			$this->_data['data'] instanceof EE_Messages_Addressee
+			&& $this->_data['data']->reg_obj instanceof EE_Registration
+		) {
+			return $this->_get_datetime_list_for_registration();
+		}
+		// prevent recursive loop
+		return '';
+	}
+
+
+	/**
+	 * return parsed list of datetimes for an event
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_datetime_list_for_event()
+	{
+		$event            = $this->_data['data'];
+		$valid_shortcodes = ['datetime', 'attendee'];
+		$template         = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
+			? $this->_data['template']['datetime_list']
+			: $this->_extra_data['template']['datetime_list'];
+
+		// here we're setting up the datetimes for the datetime list template for THIS event.
+		$dtt_parsed = '';
+		$datetimes  = $this->_get_datetimes_from_event($event);
+
+		// each datetime in this case should be an datetime object.
+		foreach ($datetimes as $datetime) {
+			$dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
+				$template,
+				$datetime,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $dtt_parsed;
+	}
+
+
+	/**
+	 * return parsed list of datetimes for an ticket
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _get_datetime_list_for_ticket()
+	{
+		$valid_shortcodes = ['datetime', 'attendee'];
+
+		$template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
+			? $this->_data['template']['datetime_list']
+			: $this->_extra_data['template']['datetime_list'];
+		$ticket   = $this->_data['data'];
+
+		// here we're setting up the datetimes for the datetime list template for THIS ticket.
+		$dtt_parsed = '';
+		$datetimes  = $this->_get_datetimes_from_ticket($ticket);
+
+		// each datetime in this case should be an datetime object.
+		foreach ($datetimes as $datetime) {
+			$dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
+				$template,
+				$datetime,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $dtt_parsed;
+	}
+
+
+	/**
+	 * return parsed list of datetimes from a given registration.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	private function _get_datetime_list_for_registration()
+	{
+		$registration = $this->_data['data']->reg_obj;
+
+		// now let's just get the ticket, set $this->_data['data'] to the ticket and then call _get_datetime_list_for__ticket();
+		$this->_data['data'] = $registration->ticket();
+		return $this->_get_datetime_list_for_ticket();
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return array|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_datetimes_from_event(EE_Event $event)
+	{
+		return isset($this->_extra_data['data']->events)
+			? $this->_extra_data['data']->events[ $event->ID() ]['dtt_objs']
+			: [];
+	}
+
+
+	/**
+	 * @param EE_Ticket $ticket
+	 * @return array|mixed
+	 * @throws EE_Error
+	 */
+	private function _get_datetimes_from_ticket(EE_Ticket $ticket)
+	{
+		return isset($this->_extra_data['data']->tickets)
+			? $this->_extra_data['data']->tickets[ $ticket->ID() ]['dtt_objs']
+			: [];
+	}
 }

core/libraries/shortcodes/EE_Email_Shortcodes.lib.php

Indentation +160 added lines, -160 removed lines

@@ -17,164 +17,164 @@
  */
 class EE_Email_Shortcodes extends EE_Shortcodes
 {
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Email Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes related to emails', 'event_espresso');
-        $this->_shortcodes = array(
-            '[SITE_ADMIN_EMAIL]'               => esc_html__(
-                'Will be replaced with the admin email for the site that Event Espresso is installed on',
-                'event_espresso'
-            ),
-            '[EVENT_AUTHOR_FORMATTED_EMAIL]'   => sprintf(
-                esc_html__(
-                    'This will be replaced with a properly formatted list of Event Creator emails for the events in a registration. %1$sNOTE:%2$s If the event author has not filled out their WordPress user profile then the organization name will be used as the "From" name.',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>'
-            ),
-            '[EVENT_AUTHOR_EMAIL]'             => sprintf(
-                esc_html__(
-                    'This is the same as %1$s shortcode except it is just a list of emails (not fancy headers).',
-                    'event_espresso'
-                ),
-                '[EVENT_AUTHOR_FORMATTED_EMAIL]'
-            ),
-            '[CO_FORMATTED_EMAIL]'             => esc_html__(
-                'This parses to the formatted email address of the organization name set in Your Organization Settings. "My Organization &lt;myorg@email.com&gt;"',
-                'event_espresso'
-            ),
-            '[CO_EMAIL]'                       => esc_html__(
-                'This will parse to the email address only for the organization set in Your Organization Settings.',
-                'event_espresso'
-            ),
-            '[ESPRESSO_ADMIN_FORMATTED_EMAIL]' => esc_html__(
-                'This parses to the formatted email address of the organization name set in Your Organization Settings. "My Organization &lt;myorg@email.com&gt;"',
-                'event_espresso'
-            ),
-            '[ESPRESSO_ADMIN_EMAIL]'           => esc_html__(
-                'This parses to the email address only for the organization set in Your Organization Settings page.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    /**
-     * @param string $shortcode
-     * @throws EE_Error
-     */
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[SITE_ADMIN_EMAIL]':
-                return $this->_get_site_admin_email();
-
-            case '[EVENT_AUTHOR_FORMATTED_EMAIL]':
-                return $this->_get_event_admin_emails();
-
-            case '[EVENT_AUTHOR_EMAIL]':
-                return $this->_get_event_admin_emails(false);
-
-            case '[CO_FORMATTED_EMAIL]':
-            case '[ESPRESSO_ADMIN_FORMATTED_EMAIL]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('name') . ' <'
-                       . EE_Registry::instance()->CFG->organization->get_pretty('email') . '>';
-
-            case '[CO_EMAIL]':
-            case '[ESPRESSO_ADMIN_EMAIL]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('email');
-
-            default:
-                return '';
-        }
-    }
-
-
-    /**
-     * This simply returns the site admin email (result for parsing "[SITE_ADMIN_EMAIL]" shortcode)
-     *
-     * @access private
-     * @return string email address of site admin
-     */
-    private function _get_site_admin_email()
-    {
-        return get_bloginfo('admin_email');
-    }
-
-
-    private function _get_event_admin_emails($fancy_headers = true)
-    {
-
-        if (! empty($this->_data->admin_email)) {
-            if (! $fancy_headers) {
-                return $this->_data->admin_email;
-            }
-            return ! empty($this->_data->fname)
-                ? $this->_data->fname . ' ' . $this->_data->lname . ' <' . $this->_data->admin_email . '>'
-                : EE_Registry::instance()->CFG->organization->get_pretty(
-                    'name'
-                ) . ' <' . $this->_data->admin_email . '>';
-        }
-
-        // k this shortcode has been used else where.  Since we don't know what particular event this is for, let's loop through the events and get an array of event admins for the events.  We'll return the formatted list of admin emails and let the messenger make sure we only pick one if this is for a field that can only have ONE!.
-
-        $admin_email = array();
-
-        // loop through events and set the list of event_ids to retrieve so we can do ONE query.
-        foreach ($this->_data->events as $event) {
-            $ids[] = $event['ID'];
-        }
-
-        // get all the events
-        $events = EE_Registry::instance()->load_model('Event')->get_all(array(array('EVT_ID' => array('IN', $ids))));
-
-        // now loop through each event and setup the details
-        $admin_details = array();
-        $cnt = 0;
-        foreach ($events as $event) {
-            $user = get_userdata($event->get('EVT_wp_user'));
-            $admin_details[ $cnt ] = new stdClass();
-            $admin_details[ $cnt ]->email = $user->user_email;
-            $admin_details[ $cnt ]->first_name = $user->user_firstname;
-            $admin_details[ $cnt ]->last_name = $user->user_lastname;
-            $cnt++;
-        }
-
-        // results?
-        if (empty($admin_details) || ! is_array($admin_details)) {
-            $msg[] = esc_html__('The admin details could not be retrieved from the database.', 'event_espresso');
-            $msg[] = sprintf(esc_html__('Query: %s', 'event_espresso'), $sql);
-            $msg[] = sprintf(esc_html__('Events Data: %s', 'event_espresso'), var_export($this->_data->events, true));
-            $msg[] = sprintf(esc_html__('Event IDS: %s', 'event_espresso'), var_export($ids, true));
-            $msg[] = sprintf(esc_html__('Query Results: %s', 'event_espresso'), var_export($admin_details));
-            do_action('AHEE_log', __FILE__, __FUNCTION__, implode(PHP_EOL, $msg), 'shortcode_parser');
-        }
-
-        foreach ($admin_details as $admin) {
-            // only add an admin email if it is present.
-            if (empty($admin->email) || $admin->email == '') {
-                continue;
-            }
-
-            if (! $fancy_headers) {
-                $admin_email[] = $admin->email;
-                continue;
-            }
-
-            $admin_email[] = ! empty($admin->first_name)
-                ? $admin->first_name . ' ' . $admin->last_name . ' <' . $admin->email . '>'
-                : EE_Registry::instance()->CFG->organization->get_pretty('name') . ' <' . $admin->email . '>';
-        }
-
-        $admin_email = implode(',', $admin_email);
-        return $admin_email;
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Email Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes related to emails', 'event_espresso');
+		$this->_shortcodes = array(
+			'[SITE_ADMIN_EMAIL]'               => esc_html__(
+				'Will be replaced with the admin email for the site that Event Espresso is installed on',
+				'event_espresso'
+			),
+			'[EVENT_AUTHOR_FORMATTED_EMAIL]'   => sprintf(
+				esc_html__(
+					'This will be replaced with a properly formatted list of Event Creator emails for the events in a registration. %1$sNOTE:%2$s If the event author has not filled out their WordPress user profile then the organization name will be used as the "From" name.',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>'
+			),
+			'[EVENT_AUTHOR_EMAIL]'             => sprintf(
+				esc_html__(
+					'This is the same as %1$s shortcode except it is just a list of emails (not fancy headers).',
+					'event_espresso'
+				),
+				'[EVENT_AUTHOR_FORMATTED_EMAIL]'
+			),
+			'[CO_FORMATTED_EMAIL]'             => esc_html__(
+				'This parses to the formatted email address of the organization name set in Your Organization Settings. "My Organization &lt;myorg@email.com&gt;"',
+				'event_espresso'
+			),
+			'[CO_EMAIL]'                       => esc_html__(
+				'This will parse to the email address only for the organization set in Your Organization Settings.',
+				'event_espresso'
+			),
+			'[ESPRESSO_ADMIN_FORMATTED_EMAIL]' => esc_html__(
+				'This parses to the formatted email address of the organization name set in Your Organization Settings. "My Organization &lt;myorg@email.com&gt;"',
+				'event_espresso'
+			),
+			'[ESPRESSO_ADMIN_EMAIL]'           => esc_html__(
+				'This parses to the email address only for the organization set in Your Organization Settings page.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	/**
+	 * @param string $shortcode
+	 * @throws EE_Error
+	 */
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[SITE_ADMIN_EMAIL]':
+				return $this->_get_site_admin_email();
+
+			case '[EVENT_AUTHOR_FORMATTED_EMAIL]':
+				return $this->_get_event_admin_emails();
+
+			case '[EVENT_AUTHOR_EMAIL]':
+				return $this->_get_event_admin_emails(false);
+
+			case '[CO_FORMATTED_EMAIL]':
+			case '[ESPRESSO_ADMIN_FORMATTED_EMAIL]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('name') . ' <'
+					   . EE_Registry::instance()->CFG->organization->get_pretty('email') . '>';
+
+			case '[CO_EMAIL]':
+			case '[ESPRESSO_ADMIN_EMAIL]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('email');
+
+			default:
+				return '';
+		}
+	}
+
+
+	/**
+	 * This simply returns the site admin email (result for parsing "[SITE_ADMIN_EMAIL]" shortcode)
+	 *
+	 * @access private
+	 * @return string email address of site admin
+	 */
+	private function _get_site_admin_email()
+	{
+		return get_bloginfo('admin_email');
+	}
+
+
+	private function _get_event_admin_emails($fancy_headers = true)
+	{
+
+		if (! empty($this->_data->admin_email)) {
+			if (! $fancy_headers) {
+				return $this->_data->admin_email;
+			}
+			return ! empty($this->_data->fname)
+				? $this->_data->fname . ' ' . $this->_data->lname . ' <' . $this->_data->admin_email . '>'
+				: EE_Registry::instance()->CFG->organization->get_pretty(
+					'name'
+				) . ' <' . $this->_data->admin_email . '>';
+		}
+
+		// k this shortcode has been used else where.  Since we don't know what particular event this is for, let's loop through the events and get an array of event admins for the events.  We'll return the formatted list of admin emails and let the messenger make sure we only pick one if this is for a field that can only have ONE!.
+
+		$admin_email = array();
+
+		// loop through events and set the list of event_ids to retrieve so we can do ONE query.
+		foreach ($this->_data->events as $event) {
+			$ids[] = $event['ID'];
+		}
+
+		// get all the events
+		$events = EE_Registry::instance()->load_model('Event')->get_all(array(array('EVT_ID' => array('IN', $ids))));
+
+		// now loop through each event and setup the details
+		$admin_details = array();
+		$cnt = 0;
+		foreach ($events as $event) {
+			$user = get_userdata($event->get('EVT_wp_user'));
+			$admin_details[ $cnt ] = new stdClass();
+			$admin_details[ $cnt ]->email = $user->user_email;
+			$admin_details[ $cnt ]->first_name = $user->user_firstname;
+			$admin_details[ $cnt ]->last_name = $user->user_lastname;
+			$cnt++;
+		}
+
+		// results?
+		if (empty($admin_details) || ! is_array($admin_details)) {
+			$msg[] = esc_html__('The admin details could not be retrieved from the database.', 'event_espresso');
+			$msg[] = sprintf(esc_html__('Query: %s', 'event_espresso'), $sql);
+			$msg[] = sprintf(esc_html__('Events Data: %s', 'event_espresso'), var_export($this->_data->events, true));
+			$msg[] = sprintf(esc_html__('Event IDS: %s', 'event_espresso'), var_export($ids, true));
+			$msg[] = sprintf(esc_html__('Query Results: %s', 'event_espresso'), var_export($admin_details));
+			do_action('AHEE_log', __FILE__, __FUNCTION__, implode(PHP_EOL, $msg), 'shortcode_parser');
+		}
+
+		foreach ($admin_details as $admin) {
+			// only add an admin email if it is present.
+			if (empty($admin->email) || $admin->email == '') {
+				continue;
+			}
+
+			if (! $fancy_headers) {
+				$admin_email[] = $admin->email;
+				continue;
+			}
+
+			$admin_email[] = ! empty($admin->first_name)
+				? $admin->first_name . ' ' . $admin->last_name . ' <' . $admin->email . '>'
+				: EE_Registry::instance()->CFG->organization->get_pretty('name') . ' <' . $admin->email . '>';
+		}
+
+		$admin_email = implode(',', $admin_email);
+		return $admin_email;
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -85,8 +85,8 @@ 
 
             case '[CO_FORMATTED_EMAIL]':
             case '[ESPRESSO_ADMIN_FORMATTED_EMAIL]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('name') . ' <'
-                       . EE_Registry::instance()->CFG->organization->get_pretty('email') . '>';
+                return EE_Registry::instance()->CFG->organization->get_pretty('name').' <'
+                       . EE_Registry::instance()->CFG->organization->get_pretty('email').'>';
 
             case '[CO_EMAIL]':
             case '[ESPRESSO_ADMIN_EMAIL]':
@@ -113,15 +113,15 @@ 
     private function _get_event_admin_emails($fancy_headers = true)
     {
 
-        if (! empty($this->_data->admin_email)) {
-            if (! $fancy_headers) {
+        if ( ! empty($this->_data->admin_email)) {
+            if ( ! $fancy_headers) {
                 return $this->_data->admin_email;
             }
             return ! empty($this->_data->fname)
-                ? $this->_data->fname . ' ' . $this->_data->lname . ' <' . $this->_data->admin_email . '>'
+                ? $this->_data->fname.' '.$this->_data->lname.' <'.$this->_data->admin_email.'>'
                 : EE_Registry::instance()->CFG->organization->get_pretty(
                     'name'
-                ) . ' <' . $this->_data->admin_email . '>';
+                ).' <'.$this->_data->admin_email.'>';
         }
 
         // k this shortcode has been used else where.  Since we don't know what particular event this is for, let's loop through the events and get an array of event admins for the events.  We'll return the formatted list of admin emails and let the messenger make sure we only pick one if this is for a field that can only have ONE!.
@@ -141,10 +141,10 @@ 
         $cnt = 0;
         foreach ($events as $event) {
             $user = get_userdata($event->get('EVT_wp_user'));
-            $admin_details[ $cnt ] = new stdClass();
-            $admin_details[ $cnt ]->email = $user->user_email;
-            $admin_details[ $cnt ]->first_name = $user->user_firstname;
-            $admin_details[ $cnt ]->last_name = $user->user_lastname;
+            $admin_details[$cnt] = new stdClass();
+            $admin_details[$cnt]->email = $user->user_email;
+            $admin_details[$cnt]->first_name = $user->user_firstname;
+            $admin_details[$cnt]->last_name = $user->user_lastname;
             $cnt++;
         }
 
@@ -164,14 +164,14 @@ 
                 continue;
             }
 
-            if (! $fancy_headers) {
+            if ( ! $fancy_headers) {
                 $admin_email[] = $admin->email;
                 continue;
             }
 
             $admin_email[] = ! empty($admin->first_name)
-                ? $admin->first_name . ' ' . $admin->last_name . ' <' . $admin->email . '>'
-                : EE_Registry::instance()->CFG->organization->get_pretty('name') . ' <' . $admin->email . '>';
+                ? $admin->first_name.' '.$admin->last_name.' <'.$admin->email.'>'
+                : EE_Registry::instance()->CFG->organization->get_pretty('name').' <'.$admin->email.'>';
         }
 
         $admin_email = implode(',', $admin_email);