eventespresso / event-espresso-core

core/libraries/shortcodes/EE_Event_Author_Shortcodes.lib.php

Indentation +99 added lines, -99 removed lines

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

Spacing +6 added lines, -6 removed lines

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

core/libraries/shortcodes/EE_Payment_List_Shortcodes.lib.php

Indentation +84 added lines, -84 removed lines

@@ -20,88 +20,88 @@
 {
 
 
-    protected function _init_props()
-    {
-        $this->label = __('Payment List Shortcodes', 'event_espresso');
-        $this->description = __('All shortcodes specific to payment lists', 'event_espresso');
-        $this->_shortcodes = array(
-            '[PAYMENT_LIST_*]' => __(
-                'Outputs a list of payment items. Note, this is a dynamic shortcode in that it accepts some attributes for setting certain defaults.  Attributes that are available are:',
-                'event_espresso'
-            )
-                                  . '<p><ul>' .
-                                  '<li><strong>no_payments</strong>:' . sprintf(
-                                      __(
-                                          'Indicate with this attribute what will be used if there are no payments present.  Default is: "%sNo approved payments have been received.%s"',
-                                          'event_espresso'
-                                      ),
-                                      htmlspecialchars('<td class="aln-cntr" colspan="6">'),
-                                      htmlspecialchars('</td>')
-                                  ) . '</li>' .
-                                  '</ul></p>',
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-
-        if (strpos($shortcode, '[PAYMENT_LIST_*') !== false) {
-            return $this->_get_payment_list($shortcode);
-        }
-        return '';
-    }
-
-
-    /**
-     * verify incoming data contains what is needed for retrieving and parsing each payment for transaction.
-     *
-     * @since 4.5.0
-     *
-     * @param string $shortcode The incoming shortcode.
-     *
-     * @return string parsed ticket line item list.
-     */
-    private function _get_payment_list($shortcode)
-    {
-        $this->_validate_list_requirements();
-
-
-        if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
-            return '';
-        }
-
-        $valid_shortcodes = array('payment');
-
-        $addressee_obj = $this->_data['data'];
-        $templates = $this->_extra_data['template'];
-        $payments = apply_filters(
-            'FHEE__Payment_List_Shortcodes___get_payments_list__payments',
-            $addressee_obj->payments
-        );
-
-        // let's get any attributes that may be present and set the defaults.
-        $atts = $this->_get_shortcode_attrs($shortcode);
-
-        $no_payments_msg = empty($atts['no_payments']) ? __(
-            'No approved payments have been received.',
-            'event_espresso'
-        ) : $atts['no_payments'];
-
-        // made it here so we have an array of paymnets, so we should have what we need.
-        $payment_content = empty($payments) ? $no_payments_msg : '';
-
-        $payments = (array) $payments;
-
-        foreach ($payments as $payment) {
-            $payment_content .= $this->_shortcode_helper->parse_payment_list_template(
-                $templates['payment_list'],
-                $payment,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $payment_content;
-    }
+	protected function _init_props()
+	{
+		$this->label = __('Payment List Shortcodes', 'event_espresso');
+		$this->description = __('All shortcodes specific to payment lists', 'event_espresso');
+		$this->_shortcodes = array(
+			'[PAYMENT_LIST_*]' => __(
+				'Outputs a list of payment items. Note, this is a dynamic shortcode in that it accepts some attributes for setting certain defaults.  Attributes that are available are:',
+				'event_espresso'
+			)
+								  . '<p><ul>' .
+								  '<li><strong>no_payments</strong>:' . sprintf(
+									  __(
+										  'Indicate with this attribute what will be used if there are no payments present.  Default is: "%sNo approved payments have been received.%s"',
+										  'event_espresso'
+									  ),
+									  htmlspecialchars('<td class="aln-cntr" colspan="6">'),
+									  htmlspecialchars('</td>')
+								  ) . '</li>' .
+								  '</ul></p>',
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+
+		if (strpos($shortcode, '[PAYMENT_LIST_*') !== false) {
+			return $this->_get_payment_list($shortcode);
+		}
+		return '';
+	}
+
+
+	/**
+	 * verify incoming data contains what is needed for retrieving and parsing each payment for transaction.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $shortcode The incoming shortcode.
+	 *
+	 * @return string parsed ticket line item list.
+	 */
+	private function _get_payment_list($shortcode)
+	{
+		$this->_validate_list_requirements();
+
+
+		if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
+			return '';
+		}
+
+		$valid_shortcodes = array('payment');
+
+		$addressee_obj = $this->_data['data'];
+		$templates = $this->_extra_data['template'];
+		$payments = apply_filters(
+			'FHEE__Payment_List_Shortcodes___get_payments_list__payments',
+			$addressee_obj->payments
+		);
+
+		// let's get any attributes that may be present and set the defaults.
+		$atts = $this->_get_shortcode_attrs($shortcode);
+
+		$no_payments_msg = empty($atts['no_payments']) ? __(
+			'No approved payments have been received.',
+			'event_espresso'
+		) : $atts['no_payments'];
+
+		// made it here so we have an array of paymnets, so we should have what we need.
+		$payment_content = empty($payments) ? $no_payments_msg : '';
+
+		$payments = (array) $payments;
+
+		foreach ($payments as $payment) {
+			$payment_content .= $this->_shortcode_helper->parse_payment_list_template(
+				$templates['payment_list'],
+				$payment,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $payment_content;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -29,15 +29,15 @@ 
                 'Outputs a list of payment items. Note, this is a dynamic shortcode in that it accepts some attributes for setting certain defaults.  Attributes that are available are:',
                 'event_espresso'
             )
-                                  . '<p><ul>' .
-                                  '<li><strong>no_payments</strong>:' . sprintf(
+                                  . '<p><ul>'.
+                                  '<li><strong>no_payments</strong>:'.sprintf(
                                       __(
                                           'Indicate with this attribute what will be used if there are no payments present.  Default is: "%sNo approved payments have been received.%s"',
                                           'event_espresso'
                                       ),
                                       htmlspecialchars('<td class="aln-cntr" colspan="6">'),
                                       htmlspecialchars('</td>')
-                                  ) . '</li>' .
+                                  ).'</li>'.
                                   '</ul></p>',
         );
     }
@@ -67,7 +67,7 @@ 
         $this->_validate_list_requirements();
 
 
-        if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
+        if ( ! $this->_data['data'] instanceof EE_Messages_Addressee) {
             return '';
         }
 

core/libraries/shortcodes/EE_Attendee_Shortcodes.lib.php

Indentation +204 added lines, -204 removed lines

@@ -18,208 +18,208 @@
 class EE_Attendee_Shortcodes extends EE_Shortcodes
 {
 
-    /**
-     * hold all extra data.
-     *
-     * @var array
-     */
-    protected $_xtra;
-
-
-    /**
-     * EE_Attendee_Shortcodes constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    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 = array(
-            '[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
-     *
-     * @access protected
-     * @param  string $shortcode the shortcode to be parsed.
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _parser($shortcode)
-    {
-
-
-        $this->_xtra = ! empty($this->_extra_data) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data']
-            : null;
-
-        // incoming object should only be a registration object.
-        $registration = ! $this->_data instanceof EE_Registration
-            ? null
-            : $this->_data;
-
-        if (! $registration instanceof EE_Registration) {
-            // let's attempt to get the txn_id for the error message.
-            $txn_id = isset($this->_xtra->txn) && $this->_xtra->txn instanceof EE_Transaction
-                ? $this->_xtra->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}");
-        }
-
-        // attendee obj for this registration
-        $attendee = isset($this->_xtra->registrations[ $registration->ID() ]['att_obj'])
-            ? $this->_xtra->registrations[ $registration->ID() ]['att_obj']
-            : null;
-
-        if (! $attendee instanceof EE_Attendee) {
-            $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}");
-        }
-
-        switch ($shortcode) {
-            case '[FNAME]':
-                return $attendee->fname();
-                break;
-
-            case '[LNAME]':
-                return $attendee->lname();
-                break;
-
-            case '[ATTENDEE_EMAIL]':
-                return $attendee->email();
-                break;
-
-            case '[EDIT_ATTENDEE_LINK]':
-                return $registration->get_admin_edit_url();
-                break;
-
-            case '[REGISTRATION_CODE]':
-                return $registration->reg_code();
-                break;
-
-            case '[REGISTRATION_ID]':
-                return $registration->ID();
-                break;
-
-            case '[FRONTEND_EDIT_REG_LINK]':
-                return $registration->edit_attendee_information_url();
-                break;
-
-            case '[PHONE_NUMBER]':
-                return $attendee->phone();
-                break;
-
-            case '[ADDRESS]':
-                return $attendee->address();
-                break;
-
-            case '[ADDRESS2]':
-                return $attendee->address2();
-                break;
-
-            case '[CITY]':
-                return $attendee->city();
-                break;
-
-            case '[ZIP_PC]':
-                return $attendee->zip();
-                break;
-
-            case '[ADDRESS_STATE]':
-                $state_obj = $attendee->state_obj();
-                return $state_obj instanceof EE_State ? $state_obj->name() : '';
-                break;
-
-            case '[COUNTRY]':
-                $country_obj = $attendee->country_obj();
-                return $country_obj instanceof EE_Country ? $country_obj->name() : '';
-                break;
-
-            case '[REGISTRATION_STATUS_ID]':
-                return $registration->status_ID();
-                break;
-
-            case '[REGISTRATION_STATUS_LABEL]':
-                return $registration->pretty_status();
-                break;
-
-            case '[REGISTRATION_TOTAL_AMOUNT_PAID]':
-                return $registration->pretty_paid();
-                break;
-        }
-
-        return '';
-    }
+	/**
+	 * hold all extra data.
+	 *
+	 * @var array
+	 */
+	protected $_xtra;
+
+
+	/**
+	 * EE_Attendee_Shortcodes constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	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 = array(
+			'[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
+	 *
+	 * @access protected
+	 * @param  string $shortcode the shortcode to be parsed.
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _parser($shortcode)
+	{
+
+
+		$this->_xtra = ! empty($this->_extra_data) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data']
+			: null;
+
+		// incoming object should only be a registration object.
+		$registration = ! $this->_data instanceof EE_Registration
+			? null
+			: $this->_data;
+
+		if (! $registration instanceof EE_Registration) {
+			// let's attempt to get the txn_id for the error message.
+			$txn_id = isset($this->_xtra->txn) && $this->_xtra->txn instanceof EE_Transaction
+				? $this->_xtra->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}");
+		}
+
+		// attendee obj for this registration
+		$attendee = isset($this->_xtra->registrations[ $registration->ID() ]['att_obj'])
+			? $this->_xtra->registrations[ $registration->ID() ]['att_obj']
+			: null;
+
+		if (! $attendee instanceof EE_Attendee) {
+			$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}");
+		}
+
+		switch ($shortcode) {
+			case '[FNAME]':
+				return $attendee->fname();
+				break;
+
+			case '[LNAME]':
+				return $attendee->lname();
+				break;
+
+			case '[ATTENDEE_EMAIL]':
+				return $attendee->email();
+				break;
+
+			case '[EDIT_ATTENDEE_LINK]':
+				return $registration->get_admin_edit_url();
+				break;
+
+			case '[REGISTRATION_CODE]':
+				return $registration->reg_code();
+				break;
+
+			case '[REGISTRATION_ID]':
+				return $registration->ID();
+				break;
+
+			case '[FRONTEND_EDIT_REG_LINK]':
+				return $registration->edit_attendee_information_url();
+				break;
+
+			case '[PHONE_NUMBER]':
+				return $attendee->phone();
+				break;
+
+			case '[ADDRESS]':
+				return $attendee->address();
+				break;
+
+			case '[ADDRESS2]':
+				return $attendee->address2();
+				break;
+
+			case '[CITY]':
+				return $attendee->city();
+				break;
+
+			case '[ZIP_PC]':
+				return $attendee->zip();
+				break;
+
+			case '[ADDRESS_STATE]':
+				$state_obj = $attendee->state_obj();
+				return $state_obj instanceof EE_State ? $state_obj->name() : '';
+				break;
+
+			case '[COUNTRY]':
+				$country_obj = $attendee->country_obj();
+				return $country_obj instanceof EE_Country ? $country_obj->name() : '';
+				break;
+
+			case '[REGISTRATION_STATUS_ID]':
+				return $registration->status_ID();
+				break;
+
+			case '[REGISTRATION_STATUS_LABEL]':
+				return $registration->pretty_status();
+				break;
+
+			case '[REGISTRATION_TOTAL_AMOUNT_PAID]':
+				return $registration->pretty_paid();
+				break;
+		}
+
+		return '';
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -115,7 +115,7 @@ 
             ? null
             : $this->_data;
 
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             // let's attempt to get the txn_id for the error message.
             $txn_id = isset($this->_xtra->txn) && $this->_xtra->txn instanceof EE_Transaction
                 ? $this->_xtra->txn->ID()
@@ -132,11 +132,11 @@ 
         }
 
         // attendee obj for this registration
-        $attendee = isset($this->_xtra->registrations[ $registration->ID() ]['att_obj'])
-            ? $this->_xtra->registrations[ $registration->ID() ]['att_obj']
+        $attendee = isset($this->_xtra->registrations[$registration->ID()]['att_obj'])
+            ? $this->_xtra->registrations[$registration->ID()]['att_obj']
             : null;
 
-        if (! $attendee instanceof EE_Attendee) {
+        if ( ! $attendee instanceof EE_Attendee) {
             $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_Email_Shortcodes.lib.php

Indentation +163 added lines, -163 removed lines

@@ -19,167 +19,167 @@
 {
 
 
-    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'
-            ),
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-
-        switch ($shortcode) {
-            case '[SITE_ADMIN_EMAIL]':
-                return $this->_get_site_admin_email();
-                break;
-
-            case '[EVENT_AUTHOR_FORMATTED_EMAIL]':
-                return $this->_get_event_admin_emails();
-                break;
-
-            case '[EVENT_AUTHOR_EMAIL]':
-                return $this->_get_event_admin_emails(false);
-                break;
-
-            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') . '>';
-                break;
-
-            case '[CO_EMAIL]':
-            case '[ESPRESSO_ADMIN_EMAIL]':
-                return EE_Registry::instance()->CFG->organization->get_pretty('email');
-                break;
-
-            default:
-                return '';
-                break;
-        }
-    }
-
-
-    /**
-     * 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'
+			),
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+
+		switch ($shortcode) {
+			case '[SITE_ADMIN_EMAIL]':
+				return $this->_get_site_admin_email();
+				break;
+
+			case '[EVENT_AUTHOR_FORMATTED_EMAIL]':
+				return $this->_get_event_admin_emails();
+				break;
+
+			case '[EVENT_AUTHOR_EMAIL]':
+				return $this->_get_event_admin_emails(false);
+				break;
+
+			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') . '>';
+				break;
+
+			case '[CO_EMAIL]':
+			case '[ESPRESSO_ADMIN_EMAIL]':
+				return EE_Registry::instance()->CFG->organization->get_pretty('email');
+				break;
+
+			default:
+				return '';
+				break;
+		}
+	}
+
+
+	/**
+	 * 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

@@ -87,8 +87,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').'>';
                 break;
 
             case '[CO_EMAIL]':
@@ -118,15 +118,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!.
@@ -146,10 +146,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++;
         }
 
@@ -169,14 +169,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);

core/libraries/shortcodes/EE_Messenger_Shortcodes.lib.php

Indentation +146 added lines, -146 removed lines

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

Spacing +5 added lines, -5 removed lines

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

core/libraries/form_sections/form_handlers/FormHandlerInterface.php

Indentation +136 added lines, -136 removed lines

@@ -19,206 +19,206 @@
 interface FormHandlerInterface
 {
 
-    /**
-     * the absolute top level form section being used on the page
-     *
-     * @return \EE_Form_Section_Proper
-     */
-    public function form();
+	/**
+	 * the absolute top level form section being used on the page
+	 *
+	 * @return \EE_Form_Section_Proper
+	 */
+	public function form();
 
 
 
-    /**
-     * @param \EE_Form_Section_Proper $form
-     */
-    public function setForm(\EE_Form_Section_Proper $form);
+	/**
+	 * @param \EE_Form_Section_Proper $form
+	 */
+	public function setForm(\EE_Form_Section_Proper $form);
 
 
 
-    /**
-     * if set to false, then this form has no displayable content,
-     * and will only be used for processing data sent passed via GET or POST
-     *
-     * @return boolean
-     */
-    public function displayable();
+	/**
+	 * if set to false, then this form has no displayable content,
+	 * and will only be used for processing data sent passed via GET or POST
+	 *
+	 * @return boolean
+	 */
+	public function displayable();
 
 
 
-    /**
-     * @param boolean $displayable
-     */
-    public function setDisplayable($displayable = false);
+	/**
+	 * @param boolean $displayable
+	 */
+	public function setDisplayable($displayable = false);
 
 
 
-    /**
-     * a public name for the form that can be displayed on the frontend of a site
-     *
-     * @return string
-     */
-    public function formName();
+	/**
+	 * a public name for the form that can be displayed on the frontend of a site
+	 *
+	 * @return string
+	 */
+	public function formName();
 
 
 
-    /**
-     * a public name for the form that can be displayed, but only in the admin
-     *
-     * @return string
-     */
-    public function adminName();
+	/**
+	 * a public name for the form that can be displayed, but only in the admin
+	 *
+	 * @return string
+	 */
+	public function adminName();
 
 
 
-    /**
-     * a URL friendly string that can be used for identifying the form
-     *
-     * @return string
-     */
-    public function slug();
+	/**
+	 * a URL friendly string that can be used for identifying the form
+	 *
+	 * @return string
+	 */
+	public function slug();
 
 
 
-    /**
-     * @return string
-     */
-    public function submitBtnText();
+	/**
+	 * @return string
+	 */
+	public function submitBtnText();
 
 
 
-    /**
-     * @param string $submit_btn_text
-     */
-    public function setSubmitBtnText($submit_btn_text);
+	/**
+	 * @param string $submit_btn_text
+	 */
+	public function setSubmitBtnText($submit_btn_text);
 
 
 
-    /**
-     * @return string
-     */
-    public function formAction();
+	/**
+	 * @return string
+	 */
+	public function formAction();
 
 
 
-    /**
-     * @param string $form_action
-     */
-    public function setFormAction($form_action);
+	/**
+	 * @param string $form_action
+	 */
+	public function setFormAction($form_action);
 
 
 
-    /**
-     * @param array $form_args
-     */
-    public function addFormActionArgs($form_args = array());
+	/**
+	 * @param array $form_args
+	 */
+	public function addFormActionArgs($form_args = array());
 
 
 
-    /**
-     * if data regarding the form's state needs to be persisted,
-     * then this method can be used to retrieve that data
-     *
-     * @return string
-     */
-    public function formConfig();
+	/**
+	 * if data regarding the form's state needs to be persisted,
+	 * then this method can be used to retrieve that data
+	 *
+	 * @return string
+	 */
+	public function formConfig();
 
 
 
-    /**
-     * if data regarding the form's state needs to be persisted,
-     * the this method can be used for setting the persisted data locally
-     *
-     * @param string $form_config
-     */
-    public function setFormConfig($form_config);
+	/**
+	 * if data regarding the form's state needs to be persisted,
+	 * the this method can be used for setting the persisted data locally
+	 *
+	 * @param string $form_config
+	 */
+	public function setFormConfig($form_config);
 
 
 
-    /**
-     * called after the form is instantiated
-     * and used for performing any logic that needs to occur early
-     * before any of the other methods are called.
-     * returns true if everything is ok to proceed,
-     * and false if no further form logic should be implemented
-     *
-     * @return boolean
-     */
-    public function initialize();
+	/**
+	 * called after the form is instantiated
+	 * and used for performing any logic that needs to occur early
+	 * before any of the other methods are called.
+	 * returns true if everything is ok to proceed,
+	 * and false if no further form logic should be implemented
+	 *
+	 * @return boolean
+	 */
+	public function initialize();
 
 
 
-    /**
-     * used for setting up css and js
-     *
-     * @return void
-     */
-    public function enqueueStylesAndScripts();
+	/**
+	 * used for setting up css and js
+	 *
+	 * @return void
+	 */
+	public function enqueueStylesAndScripts();
 
 
 
-    /**
-     * creates and returns the actual form
-     *
-     * @return EE_Form_Section_Proper
-     */
-    public function generate();
+	/**
+	 * creates and returns the actual form
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	public function generate();
 
 
 
-    /**
-     * takes the generated form and displays it along with ony other non-form HTML that may be required
-     * returns a string of HTML that can be directly echoed in a template
-     *
-     * @return string
-     */
-    public function display();
+	/**
+	 * takes the generated form and displays it along with ony other non-form HTML that may be required
+	 * returns a string of HTML that can be directly echoed in a template
+	 *
+	 * @return string
+	 */
+	public function display();
 
 
 
-    /**
-     * handles processing the form submission
-     * returns true or false depending on whether the form was processed successfully or not
-     *
-     * @param array $submitted_form_data
-     * @return bool
-     */
-    public function process($submitted_form_data = array());
+	/**
+	 * handles processing the form submission
+	 * returns true or false depending on whether the form was processed successfully or not
+	 *
+	 * @param array $submitted_form_data
+	 * @return bool
+	 */
+	public function process($submitted_form_data = array());
 
 
 
-    /**
-     * creates and returns an EE_Submit_Input labeled "Submit"
-     *
-     * @param string $text
-     * @return \EE_Submit_Input
-     */
-    public function generateSubmitButton($text = '');
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Submit"
+	 *
+	 * @param string $text
+	 * @return \EE_Submit_Input
+	 */
+	public function generateSubmitButton($text = '');
 
 
 
-    /**
-     * calls generateSubmitButton() and appends it onto the form along with a float clearing div
-     *
-     * @return void
-     */
-    public function appendSubmitButton();
+	/**
+	 * calls generateSubmitButton() and appends it onto the form along with a float clearing div
+	 *
+	 * @return void
+	 */
+	public function appendSubmitButton();
 
 
 
-    /**
-     * creates and returns an EE_Submit_Input labeled "Cancel"
-     *
-     * @param string $text
-     * @return \EE_Submit_Input
-     */
-    public function generateCancelButton($text = '');
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Cancel"
+	 *
+	 * @param string $text
+	 * @return \EE_Submit_Input
+	 */
+	public function generateCancelButton($text = '');
 
 
 
-    /**
-     * appends a float clearing div onto end of form
-     *
-     * @return void
-     */
-    public function clearFormButtonFloats();
+	/**
+	 * appends a float clearing div onto end of form
+	 *
+	 * @return void
+	 */
+	public function clearFormButtonFloats();
 }

core/libraries/form_sections/form_handlers/SequentialStepFormInterface.php

Indentation +33 added lines, -33 removed lines

@@ -16,55 +16,55 @@
 {
 
 
-    /**
-     * @return int
-     */
-    public function order();
+	/**
+	 * @return int
+	 */
+	public function order();
 
 
 
-    /**
-     * @param int $order
-     * @throws InvalidArgumentException
-     */
-    public function setOrder($order);
+	/**
+	 * @param int $order
+	 * @throws InvalidArgumentException
+	 */
+	public function setOrder($order);
 
 
 
-    /**
-     * @return string
-     */
-    public function redirectUrl();
+	/**
+	 * @return string
+	 */
+	public function redirectUrl();
 
 
 
-    /**
-     * @param string $redirect_url
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function setRedirectUrl($redirect_url);
+	/**
+	 * @param string $redirect_url
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function setRedirectUrl($redirect_url);
 
 
 
-    /**
-     * @param array $redirect_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function addRedirectArgs($redirect_args = array());
+	/**
+	 * @param array $redirect_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function addRedirectArgs($redirect_args = array());
 
 
 
-    /**
-     * @return string
-     */
-    public function redirectTo();
+	/**
+	 * @return string
+	 */
+	public function redirectTo();
 
 
 
-    /**
-     * @param string $redirect_to
-     */
-    public function setRedirectTo($redirect_to);
+	/**
+	 * @param string $redirect_to
+	 */
+	public function setRedirectTo($redirect_to);
 }

core/libraries/form_sections/form_handlers/SequentialStepForm.php

Indentation +221 added lines, -221 removed lines

@@ -19,227 +19,227 @@
 abstract class SequentialStepForm extends FormHandler implements SequentialStepFormInterface
 {
 
-    const REDIRECT_TO_NEXT_STEP    = 'redirect_to_next_step';
-
-    const REDIRECT_TO_CURRENT_STEP = 'redirect_to_current_step';
-
-    const REDIRECT_TO_PREV_STEP    = 'redirect_to_prev_step';
-
-    const REDIRECT_TO_OTHER        = 'redirect_to_other';
-
-    /**
-     * numerical value used for sorting form steps
-     *
-     * @var int $order
-     */
-    private $order = 1;
-
-    /**
-     * a final URL with all form related parameters added
-     * that will be used to advance to the next step
-     *
-     * @var string $redirect_url
-     */
-    private $redirect_url = '';
-
-    /**
-     * URL params in key value pairs
-     *
-     * @var array $redirect_args
-     */
-    private $redirect_args = array();
-
-    /**
-     * Which step should be redirected to after form processing.
-     * Usually after successfully processing this value would be REDIRECT_TO_NEXT_STEP
-     * If a form is invalid and requires errors to be corrected,
-     * then this value would be REDIRECT_TO_CURRENT_STEP so that form can be resubmitted
-     * Some form handlers do not have a form that is displayable,
-     * and only perform data processing, but if an error occurs,
-     * then this value needs to be set to REDIRECT_TO_PREV_STEP
-     * since the current step has no displayable content.
-     * if the form is completely finished, and needs to redirect to somewhere
-     * completely different, then this value will be REDIRECT_TO_OTHER
-     *
-     * @var string $redirect_to
-     */
-    private $redirect_to = SequentialStepForm::REDIRECT_TO_CURRENT_STEP;
-
-
-
-    /**
-     * SequentialStepForm constructor
-     *
-     * @param int         $order
-     * @param string      $form_name
-     * @param string      $admin_name
-     * @param string      $slug
-     * @param string      $form_action
-     * @param string      $form_config
-     * @param EE_Registry $registry
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     */
-    public function __construct(
-        $order,
-        $form_name,
-        $admin_name,
-        $slug,
-        $form_action = '',
-        $form_config = 'add_form_tags_and_submit',
-        EE_Registry $registry
-    ) {
-        $this->setOrder($order);
-        parent::__construct($form_name, $admin_name, $slug, $form_action, $form_config, $registry);
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function order()
-    {
-        return $this->order;
-    }
-
-
-
-    /**
-     * @param int $order
-     * @throws InvalidArgumentException
-     */
-    public function setOrder($order)
-    {
-        $order = absint($order);
-        if (! $order > 0) {
-            throw new InvalidArgumentException(
-                esc_html__('The form order property must be a positive integer.', 'event_espresso')
-            );
-        }
-        $this->order = $order;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function redirectUrl()
-    {
-        return ! empty($this->redirect_args)
-            ? add_query_arg($this->redirect_args, $this->redirect_url)
-            : $this->redirect_url;
-    }
-
-
-
-    /**
-     * @param string $redirect_url
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function setRedirectUrl($redirect_url)
-    {
-        if (! is_string($redirect_url)) {
-            throw new InvalidDataTypeException('$redirect_url', $redirect_url, 'string');
-        }
-        if (empty($redirect_url)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect URL can not be an empty string.', 'event_espresso')
-            );
-        }
-        $this->redirect_url = $redirect_url;
-    }
-
-
-
-    /**
-     * @param array $redirect_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function addRedirectArgs($redirect_args = array())
-    {
-        if (is_object($redirect_args)) {
-            throw new InvalidDataTypeException(
-                '$redirect_args',
-                $redirect_args,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($redirect_args)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect argument can not be an empty array.', 'event_espresso')
-            );
-        }
-        $this->redirect_args = array_merge($this->redirect_args, (array) $redirect_args);
-    }
-
-
-
-    /**
-     * @param array $redirect_arg_keys_to_remove
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function removeRedirectArgs($redirect_arg_keys_to_remove = array())
-    {
-        if (is_object($redirect_arg_keys_to_remove)) {
-            throw new InvalidDataTypeException(
-                '$redirect_arg_keys_to_remove',
-                $redirect_arg_keys_to_remove,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($redirect_arg_keys_to_remove)) {
-            throw new InvalidArgumentException(
-                esc_html__('The $redirect_arg_keys_to_remove argument can not be an empty array.', 'event_espresso')
-            );
-        }
-        foreach ($redirect_arg_keys_to_remove as $redirect_arg_key) {
-            unset($this->redirect_args[ $redirect_arg_key ]);
-        }
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function redirectTo()
-    {
-        return $this->redirect_to;
-    }
-
-
-
-    /**
-     * @param string $redirect_to
-     * @throws InvalidDataTypeException
-     */
-    public function setRedirectTo($redirect_to)
-    {
-        if (! in_array(
-            $redirect_to,
-            array(
-                    SequentialStepForm::REDIRECT_TO_NEXT_STEP,
-                    SequentialStepForm::REDIRECT_TO_CURRENT_STEP,
-                    SequentialStepForm::REDIRECT_TO_PREV_STEP,
-                    SequentialStepForm::REDIRECT_TO_OTHER,
-                ),
-            true
-        )
-        ) {
-            throw new InvalidDataTypeException(
-                'setRedirectTo()',
-                $redirect_to,
-                'one of the SequentialStepForm class constants was expected.'
-            );
-        }
-        $this->redirect_to = $redirect_to;
-    }
+	const REDIRECT_TO_NEXT_STEP    = 'redirect_to_next_step';
+
+	const REDIRECT_TO_CURRENT_STEP = 'redirect_to_current_step';
+
+	const REDIRECT_TO_PREV_STEP    = 'redirect_to_prev_step';
+
+	const REDIRECT_TO_OTHER        = 'redirect_to_other';
+
+	/**
+	 * numerical value used for sorting form steps
+	 *
+	 * @var int $order
+	 */
+	private $order = 1;
+
+	/**
+	 * a final URL with all form related parameters added
+	 * that will be used to advance to the next step
+	 *
+	 * @var string $redirect_url
+	 */
+	private $redirect_url = '';
+
+	/**
+	 * URL params in key value pairs
+	 *
+	 * @var array $redirect_args
+	 */
+	private $redirect_args = array();
+
+	/**
+	 * Which step should be redirected to after form processing.
+	 * Usually after successfully processing this value would be REDIRECT_TO_NEXT_STEP
+	 * If a form is invalid and requires errors to be corrected,
+	 * then this value would be REDIRECT_TO_CURRENT_STEP so that form can be resubmitted
+	 * Some form handlers do not have a form that is displayable,
+	 * and only perform data processing, but if an error occurs,
+	 * then this value needs to be set to REDIRECT_TO_PREV_STEP
+	 * since the current step has no displayable content.
+	 * if the form is completely finished, and needs to redirect to somewhere
+	 * completely different, then this value will be REDIRECT_TO_OTHER
+	 *
+	 * @var string $redirect_to
+	 */
+	private $redirect_to = SequentialStepForm::REDIRECT_TO_CURRENT_STEP;
+
+
+
+	/**
+	 * SequentialStepForm constructor
+	 *
+	 * @param int         $order
+	 * @param string      $form_name
+	 * @param string      $admin_name
+	 * @param string      $slug
+	 * @param string      $form_action
+	 * @param string      $form_config
+	 * @param EE_Registry $registry
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 */
+	public function __construct(
+		$order,
+		$form_name,
+		$admin_name,
+		$slug,
+		$form_action = '',
+		$form_config = 'add_form_tags_and_submit',
+		EE_Registry $registry
+	) {
+		$this->setOrder($order);
+		parent::__construct($form_name, $admin_name, $slug, $form_action, $form_config, $registry);
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->order;
+	}
+
+
+
+	/**
+	 * @param int $order
+	 * @throws InvalidArgumentException
+	 */
+	public function setOrder($order)
+	{
+		$order = absint($order);
+		if (! $order > 0) {
+			throw new InvalidArgumentException(
+				esc_html__('The form order property must be a positive integer.', 'event_espresso')
+			);
+		}
+		$this->order = $order;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function redirectUrl()
+	{
+		return ! empty($this->redirect_args)
+			? add_query_arg($this->redirect_args, $this->redirect_url)
+			: $this->redirect_url;
+	}
+
+
+
+	/**
+	 * @param string $redirect_url
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function setRedirectUrl($redirect_url)
+	{
+		if (! is_string($redirect_url)) {
+			throw new InvalidDataTypeException('$redirect_url', $redirect_url, 'string');
+		}
+		if (empty($redirect_url)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect URL can not be an empty string.', 'event_espresso')
+			);
+		}
+		$this->redirect_url = $redirect_url;
+	}
+
+
+
+	/**
+	 * @param array $redirect_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function addRedirectArgs($redirect_args = array())
+	{
+		if (is_object($redirect_args)) {
+			throw new InvalidDataTypeException(
+				'$redirect_args',
+				$redirect_args,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($redirect_args)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect argument can not be an empty array.', 'event_espresso')
+			);
+		}
+		$this->redirect_args = array_merge($this->redirect_args, (array) $redirect_args);
+	}
+
+
+
+	/**
+	 * @param array $redirect_arg_keys_to_remove
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function removeRedirectArgs($redirect_arg_keys_to_remove = array())
+	{
+		if (is_object($redirect_arg_keys_to_remove)) {
+			throw new InvalidDataTypeException(
+				'$redirect_arg_keys_to_remove',
+				$redirect_arg_keys_to_remove,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($redirect_arg_keys_to_remove)) {
+			throw new InvalidArgumentException(
+				esc_html__('The $redirect_arg_keys_to_remove argument can not be an empty array.', 'event_espresso')
+			);
+		}
+		foreach ($redirect_arg_keys_to_remove as $redirect_arg_key) {
+			unset($this->redirect_args[ $redirect_arg_key ]);
+		}
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function redirectTo()
+	{
+		return $this->redirect_to;
+	}
+
+
+
+	/**
+	 * @param string $redirect_to
+	 * @throws InvalidDataTypeException
+	 */
+	public function setRedirectTo($redirect_to)
+	{
+		if (! in_array(
+			$redirect_to,
+			array(
+					SequentialStepForm::REDIRECT_TO_NEXT_STEP,
+					SequentialStepForm::REDIRECT_TO_CURRENT_STEP,
+					SequentialStepForm::REDIRECT_TO_PREV_STEP,
+					SequentialStepForm::REDIRECT_TO_OTHER,
+				),
+			true
+		)
+		) {
+			throw new InvalidDataTypeException(
+				'setRedirectTo()',
+				$redirect_to,
+				'one of the SequentialStepForm class constants was expected.'
+			);
+		}
+		$this->redirect_to = $redirect_to;
+	}
 }
 // End of file SequentialStepForm.php
 // Location: /SequentialStepForm.php

Spacing +4 added lines, -4 removed lines

@@ -113,7 +113,7 @@ 
     public function setOrder($order)
     {
         $order = absint($order);
-        if (! $order > 0) {
+        if ( ! $order > 0) {
             throw new InvalidArgumentException(
                 esc_html__('The form order property must be a positive integer.', 'event_espresso')
             );
@@ -142,7 +142,7 @@ 
      */
     public function setRedirectUrl($redirect_url)
     {
-        if (! is_string($redirect_url)) {
+        if ( ! is_string($redirect_url)) {
             throw new InvalidDataTypeException('$redirect_url', $redirect_url, 'string');
         }
         if (empty($redirect_url)) {
@@ -199,7 +199,7 @@ 
             );
         }
         foreach ($redirect_arg_keys_to_remove as $redirect_arg_key) {
-            unset($this->redirect_args[ $redirect_arg_key ]);
+            unset($this->redirect_args[$redirect_arg_key]);
         }
     }
 
@@ -221,7 +221,7 @@ 
      */
     public function setRedirectTo($redirect_to)
     {
-        if (! in_array(
+        if ( ! in_array(
             $redirect_to,
             array(
                     SequentialStepForm::REDIRECT_TO_NEXT_STEP,

core/libraries/form_sections/inputs/EE_Checkbox_Dropdown_Selector_Input.input.php

Indentation +57 added lines, -57 removed lines

@@ -12,68 +12,68 @@
 class EE_Checkbox_Dropdown_Selector_Input extends EE_Form_Input_With_Options_Base
 {
 
-    /**
-     * @var string text to display on the select button itself
-     */
-    protected $_select_button_text;
+	/**
+	 * @var string text to display on the select button itself
+	 */
+	protected $_select_button_text;
 
-    /**
-     * @param array $answer_options
-     * @param array $input_settings
-     */
-    public function __construct($answer_options, $input_settings = array())
-    {
-        $this->_select_button_text = EEH_Array::is_set(
-            $input_settings,
-            'select_button_text',
-            esc_html__('Select', 'event_espresso')
-        );
-        $display_strategy = new EE_Checkbox_Dropdown_Selector_Display_Strategy();
-        $this->_set_display_strategy($display_strategy);
-        $this->load_iframe_assets($display_strategy);
-        $this->_add_validation_strategy(
-            new EE_Many_Valued_Validation_Strategy(
-                array(
-                    new EE_Enum_Validation_Strategy(
-                        isset($input_settings['validation_error_message'])
-                            ? $input_settings['validation_error_message']
-                            : null
-                    ),
-                )
-            )
-        );
-        $this->_multiple_selections = true;
-        parent::__construct($answer_options, $input_settings);
-    }
+	/**
+	 * @param array $answer_options
+	 * @param array $input_settings
+	 */
+	public function __construct($answer_options, $input_settings = array())
+	{
+		$this->_select_button_text = EEH_Array::is_set(
+			$input_settings,
+			'select_button_text',
+			esc_html__('Select', 'event_espresso')
+		);
+		$display_strategy = new EE_Checkbox_Dropdown_Selector_Display_Strategy();
+		$this->_set_display_strategy($display_strategy);
+		$this->load_iframe_assets($display_strategy);
+		$this->_add_validation_strategy(
+			new EE_Many_Valued_Validation_Strategy(
+				array(
+					new EE_Enum_Validation_Strategy(
+						isset($input_settings['validation_error_message'])
+							? $input_settings['validation_error_message']
+							: null
+					),
+				)
+			)
+		);
+		$this->_multiple_selections = true;
+		parent::__construct($answer_options, $input_settings);
+	}
 
-    /*
+	/*
      * Returns the text to display in the select button
      */
-    public function select_button_text()
-    {
-        return $this->_select_button_text;
-    }
+	public function select_button_text()
+	{
+		return $this->_select_button_text;
+	}
 
-    /*
+	/*
      * add css and js for iframes
      */
-    protected function load_iframe_assets(EE_Checkbox_Dropdown_Selector_Display_Strategy $display_strategy)
-    {
-        add_filter(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
-            array($display_strategy, 'iframe_css')
-        );
-        add_filter(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            array($display_strategy, 'iframe_js')
-        );
-        add_filter(
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-            array($display_strategy, 'iframe_css')
-        );
-        add_filter(
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-            array($display_strategy, 'iframe_js')
-        );
-    }
+	protected function load_iframe_assets(EE_Checkbox_Dropdown_Selector_Display_Strategy $display_strategy)
+	{
+		add_filter(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
+			array($display_strategy, 'iframe_css')
+		);
+		add_filter(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			array($display_strategy, 'iframe_js')
+		);
+		add_filter(
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+			array($display_strategy, 'iframe_css')
+		);
+		add_filter(
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+			array($display_strategy, 'iframe_js')
+		);
+	}
 }